Class BinarySensor

Implements an MQTT binary sensor for Home Assistant discovery

Hierarchy (View Summary)

Discoverable<BinarySensorInfo | SwitchInfo>
- BinarySensor

Constructors

constructor

new BinarySensor(
entity: BinarySensorInfo,
globalSettings: HaDiscoverableManager,
): BinarySensor
Parameters
- entity: BinarySensorInfo
- globalSettings: HaDiscoverableManager
Returns BinarySensor
Overrides Discoverable.constructor
- Defined in sensors/binary-sensor/binary-sensor.ts:30

Properties

`Protected`attributesTopic

attributesTopic: string

`Protected` `Optional`availabilityTopic

availabilityTopic?: string

`Protected`configTopic

configTopic: string

`Readonly`entity

entity: BinarySensorInfo

`Protected`entityTopic

entityTopic: string

`Protected` `Readonly`settings

settings: HaDiscoverableManager

`Protected`stateTopic

stateTopic: string

`Protected`wroteConfiguration

wroteConfiguration: boolean = false

Accessors

`Protected`logger

get logger(): DiscoverableLogger
Returns DiscoverableLogger
Inherited from Discoverable.logger
- Defined in discoverable.ts:57

`Protected`mqtt

get mqtt(): MqttClient
Returns MqttClient
Inherited from Discoverable.mqtt
- Defined in discoverable.ts:53

Methods

`Protected`_state_helper

_state_helper(
    state?: null | string | number | Buffer<ArrayBufferLike>,
    topic?: null | string,
    last_reset?: null | string,
    retain?: boolean,
): Promise<undefined | Packet>
Parameters
- state: null | string | number | Buffer<ArrayBufferLike> = null
- topic: null | string = null
- last_reset: null | string = null
- retain: boolean = true
Returns Promise<undefined | Packet>
Inherited from Discoverable._state_helper
- Defined in discoverable.ts:147

addListener

addListener<EventName extends KeyOf<DiscoverableEvents>>(
event: EventName,
listener: Callback<DiscoverableEvents[EventName]>,
): this
Type Parameters
- EventName extends KeyOf<DiscoverableEvents>
Parameters
- event: EventName
- listener: Callback<DiscoverableEvents[EventName]>
Returns this
Inherited from Discoverable.addListener
- Defined in custom-event-emitter.ts:20

`Protected`debugInfo

debugInfo(): { type: string }
Returns { type: string }
Inherited from Discoverable.debugInfo
- Defined in discoverable.ts:193

emit

emit<EventName extends KeyOf<DiscoverableEvents>>(
event: EventName,
...args: DiscoverableEvents[EventName],
): boolean
Type Parameters
- EventName extends KeyOf<DiscoverableEvents>
Parameters
- event: EventName
- ...args: DiscoverableEvents[EventName]
Returns boolean
Inherited from Discoverable.emit
- Defined in custom-event-emitter.ts:59

emitVoid

emitVoid<EventName extends KeyOf<DiscoverableEvents>>(
event: EventName,
...args: DiscoverableEvents[EventName],
): void
Emits an event without waiting for the listeners to finish.
Type Parameters
- EventName extends KeyOf<DiscoverableEvents>
Parameters
- event: EventName
- ...args: DiscoverableEvents[EventName]
Returns void
Inherited from Discoverable.emitVoid
- Defined in custom-event-emitter.ts:68

eventNames

eventNames(): PropertyKey[]
Returns PropertyKey[]
Inherited from Discoverable.eventNames
- Defined in custom-event-emitter.ts:95

`Protected`generateConfig

generateConfig(): {
    availability_topic?: string;
    json_attributes_topic: string;
    state_topic: string;
}
Returns {
    availability_topic?: string;
    json_attributes_topic: string;
    state_topic: string;
}
Inherited from Discoverable.generateConfig
- Defined in discoverable.ts:133

getMaxListeners

getMaxListeners(): number
Returns number
Inherited from Discoverable.getMaxListeners
- Defined in custom-event-emitter.ts:50

`Protected`initTopics

initTopics(): void
Returns void
Inherited from Discoverable.initTopics
- Defined in discoverable.ts:178

listenerCount

listenerCount<EventName extends KeyOf<DiscoverableEvents>>(
event: EventName,
): number
Type Parameters
- EventName extends KeyOf<DiscoverableEvents>
Parameters
- event: EventName
Returns number
Inherited from Discoverable.listenerCount
- Defined in custom-event-emitter.ts:80

listeners

listeners<EventName extends KeyOf<DiscoverableEvents>>(
event: EventName,
): Function[]
Type Parameters
- EventName extends KeyOf<DiscoverableEvents>
Parameters
- event: EventName
Returns Function[]
Inherited from Discoverable.listeners
- Defined in custom-event-emitter.ts:53

off

off<EventName extends "error" | "connected" | "write-config">(
event: EventName,
listener: Callback<DiscoverableEvents[EventName]>,
): this
Type Parameters
- EventName extends "error" | "connected" | "write-config"
Parameters
- event: EventName
- listener: Callback<DiscoverableEvents[EventName]>
Returns this
Inherited from Discoverable.off
- Defined in custom-event-emitter.ts:38

on

on<EventName extends KeyOf<DiscoverableEvents>>(
event: EventName,
listener: (...args: DiscoverableEvents[EventName]) => void,
): this
Type Parameters
- EventName extends KeyOf<DiscoverableEvents>
Parameters
- event: EventName
- listener: (...args: DiscoverableEvents[EventName]) => void
Returns this
Inherited from Discoverable.on
- Defined in custom-event-emitter.ts:99

once

once<EventName extends KeyOf<DiscoverableEvents>>(
event: EventName,
listener: Callback<DiscoverableEvents[EventName]>,
): this
Type Parameters
- EventName extends KeyOf<DiscoverableEvents>
Parameters
- event: EventName
- listener: Callback<DiscoverableEvents[EventName]>
Returns this
Inherited from Discoverable.once
- Defined in custom-event-emitter.ts:26

prependListener

prependListener<EventName extends KeyOf<DiscoverableEvents>>(
event: EventName,
listener: Callback<DiscoverableEvents[EventName]>,
): this
Type Parameters
- EventName extends KeyOf<DiscoverableEvents>
Parameters
- event: EventName
- listener: Callback<DiscoverableEvents[EventName]>
Returns this
Inherited from Discoverable.prependListener
- Defined in custom-event-emitter.ts:83

prependOnceListener

prependOnceListener<EventName extends KeyOf<DiscoverableEvents>>(
event: EventName,
listener: Callback<DiscoverableEvents[EventName]>,
): this
Type Parameters
- EventName extends KeyOf<DiscoverableEvents>
Parameters
- event: EventName
- listener: Callback<DiscoverableEvents[EventName]>
Returns this
Inherited from Discoverable.prependOnceListener
- Defined in custom-event-emitter.ts:89

rawListeners

rawListeners<EventName extends KeyOf<DiscoverableEvents>>(
event: EventName,
): Function[]
Type Parameters
- EventName extends KeyOf<DiscoverableEvents>
Parameters
- event: EventName
Returns Function[]
Inherited from Discoverable.rawListeners
- Defined in custom-event-emitter.ts:56

register

register(): Promise<void>
Register the entity within Home Assistant

Returns Promise<void>
Inherited from Discoverable.register
- Defined in discoverable.ts:64

removeAllListeners

removeAllListeners<EventName extends KeyOf<DiscoverableEvents>>(
event?: EventName,
): this
Type Parameters
- EventName extends KeyOf<DiscoverableEvents>
Parameters
- Optionalevent: EventName
Returns this
Inherited from Discoverable.removeAllListeners
- Defined in custom-event-emitter.ts:44

removeListener

removeListener<EventName extends KeyOf<DiscoverableEvents>>(
event: EventName,
listener: Callback<DiscoverableEvents[EventName]>,
): this
Type Parameters
- EventName extends KeyOf<DiscoverableEvents>
Parameters
- event: EventName
- listener: Callback<DiscoverableEvents[EventName]>
Returns this
Inherited from Discoverable.removeListener
- Defined in custom-event-emitter.ts:32

setAttributes

setAttributes(attributes: Record<string, unknown>): Promise<undefined | Packet>
Parameters
- attributes: Record<string, unknown>
Returns Promise<undefined | Packet>
Inherited from Discoverable.setAttributes
- Defined in discoverable.ts:108

setAvailability

setAvailability(available: boolean): Promise<undefined | Packet>
This method will throw an error if the availability topic is not set
Parameters
- available: boolean
Returns Promise<undefined | Packet>
Inherited from Discoverable.setAvailability
- Defined in discoverable.ts:124

setMaxListeners

setMaxListeners(n: number): this
Parameters
- n: number
Returns this
Inherited from Discoverable.setMaxListeners
- Defined in custom-event-emitter.ts:47

switchOff

switchOff(this: Pick<BinarySensor, "updateState">): Promise<undefined | Packet>
Set binary sensor to off *
Parameters
- this: Pick<BinarySensor, "updateState">
Returns Promise<undefined | Packet>
- Defined in sensors/binary-sensor/binary-sensor.ts:38

switchOn

switchOn(this: Pick<BinarySensor, "updateState">): Promise<undefined | Packet>
Set binary sensor to on *
Parameters
- this: Pick<BinarySensor, "updateState">
Returns Promise<undefined | Packet>
- Defined in sensors/binary-sensor/binary-sensor.ts:45

unregister

unregister(): Promise<void>
Unregister the entity from Home Assistant

Returns Promise<void>
Inherited from Discoverable.unregister
- Defined in discoverable.ts:71

updateState

updateState(state: boolean): Promise<undefined | Packet>
Update MQTT sensor state
Parameters
- state: boolean
Returns Promise<undefined | Packet>
- Defined in sensors/binary-sensor/binary-sensor.ts:50

writeConfig

writeConfig(): Promise<undefined | Packet>
Writes the configuration to the MQTT broker

Returns Promise<undefined | Packet>
Inherited from Discoverable.writeConfig
- Defined in discoverable.ts:85

`Static`[hasInstance]

"[hasInstance]"(val: unknown): val is BinarySensor
Parameters
- val: unknown
Returns val is BinarySensor
- Defined in sensors/binary-sensor/binary-sensor.ts:10

Class BinarySensor

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns BinarySensor

Properties

ProtectedattributesTopic

Protected OptionalavailabilityTopic

ProtectedconfigTopic

Readonlyentity

ProtectedentityTopic

Protected Readonlysettings

ProtectedstateTopic

ProtectedwroteConfiguration

Accessors

Protectedlogger

Returns DiscoverableLogger

Protectedmqtt

Returns MqttClient

Methods

Protected_state_helper

Parameters

Returns Promise<undefined | Packet>

addListener

Type Parameters

Parameters

Returns this

ProtecteddebugInfo

Returns { type: string }

emit

Type Parameters

Parameters

Returns boolean

emitVoid

Type Parameters

Parameters

Returns void

eventNames

Returns PropertyKey[]

ProtectedgenerateConfig

Returns { availability_topic?: string; json_attributes_topic: string; state_topic: string;}

getMaxListeners

Returns number

ProtectedinitTopics

Returns void

listenerCount

Type Parameters

Parameters

Returns number

listeners

Type Parameters

Parameters

Returns Function[]

off

Type Parameters

Parameters

Returns this

on

Type Parameters

Parameters

Returns this

once

Type Parameters

Parameters

Returns this

prependListener

Type Parameters

Parameters

Returns this

prependOnceListener

Type Parameters

Parameters

Returns this

rawListeners

`Protected`attributesTopic

`Protected` `Optional`availabilityTopic

`Protected`configTopic

`Readonly`entity

`Protected`entityTopic

`Protected` `Readonly`settings

`Protected`stateTopic

`Protected`wroteConfiguration

`Protected`logger

`Protected`mqtt

`Protected`_state_helper

`Protected`debugInfo

`Protected`generateConfig

Returns {
availability_topic?: string;
json_attributes_topic: string;
state_topic: string;
}

`Protected`initTopics

`Static`[hasInstance]