Class Discoverable<E, Events>`Abstract`

Base class for making MQTT discoverable objects

Type Parameters

E extends EntityInfo
Events extends DiscoverableEvents = DiscoverableEvents

Hierarchy (View Summary)

CustomEventEmitter<Events>
- Discoverable

Constructors

constructor

new Discoverable<
    E extends EntityInfo,
    Events extends DiscoverableEvents = DiscoverableEvents,
>(
    settings: HaDiscoverableManager,
    entityInfo: E,
    onConnect?: (client: MqttClient) => void,
): Discoverable<E, Events>
Type Parameters
- E extends EntityInfo
- Events extends DiscoverableEvents = DiscoverableEvents
Parameters
- settings: HaDiscoverableManager
- entityInfo: E
- OptionalonConnect: (client: MqttClient) => void
Returns Discoverable<E, Events>
Overrides CustomEventEmitter<Events>.constructor
- Defined in discoverable.ts:32

Properties

`Protected`attributesTopic

attributesTopic: string

`Protected` `Optional`availabilityTopic

availabilityTopic?: string

`Protected`configTopic

configTopic: string

`Readonly`entity

entity: E

`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
- Defined in discoverable.ts:57

`Protected`mqtt

get mqtt(): MqttClient
Returns MqttClient
- 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>
- Defined in discoverable.ts:147

addListener

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

`Protected`debugInfo

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

emit

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

emitVoid

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

eventNames

eventNames(): (PropertyKey | keyof Events & string)[]
Returns (PropertyKey | keyof Events & string)[]
Inherited from CustomEventEmitter.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;
}
- Defined in discoverable.ts:133

getMaxListeners

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

`Protected`initTopics

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

listenerCount

listenerCount<EventName extends string>(event: EventName): number
Type Parameters
- EventName extends string
Parameters
- event: EventName
Returns number
Inherited from CustomEventEmitter.listenerCount
- Defined in custom-event-emitter.ts:80

listeners

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

off

off<EventName extends string>(
event: EventName,
listener: Callback<Events[EventName]>,
): this
Type Parameters
- EventName extends string
Parameters
- event: EventName
- listener: Callback<Events[EventName]>
Returns this
Inherited from CustomEventEmitter.off
- Defined in custom-event-emitter.ts:38

on

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

once

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

prependListener

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

prependOnceListener

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

rawListeners

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

register

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

Returns Promise<void>
- Defined in discoverable.ts:64

removeAllListeners

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

removeListener

removeListener<EventName extends string>(
event: EventName,
listener: Callback<Events[EventName]>,
): this
Type Parameters
- EventName extends string
Parameters
- event: EventName
- listener: Callback<Events[EventName]>
Returns this
Inherited from CustomEventEmitter.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>
- 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>
- Defined in discoverable.ts:124

setMaxListeners

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

unregister

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

Returns Promise<void>
- Defined in discoverable.ts:71

writeConfig

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

Returns Promise<undefined | Packet>
- Defined in discoverable.ts:85

Class Discoverable<E, Events>Abstract

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns Discoverable<E, Events>

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 | keyof Events & string)[]

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

Class Discoverable<E, Events>`Abstract`

`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