Class Subscriber<TComponentConfiguration, TStateMap, TCommandMap>

A base class for Home Assistant MQTT entities that can receive commands. Extends Discoverable to add command handling capabilities.

Type Param: TCommandMessage

Type of command messages this component can receive

Type Parameters

TComponentConfiguration extends BaseComponentConfiguration
The configuration type specific to this component
TStateMap extends Record<string, unknown>
The type of state data this component can handle
TCommandMap extends Record<string, unknown>

Hierarchy (View Summary)

Discoverable<TComponentConfiguration, TStateMap>
- Subscriber

Constructors

constructor

new Subscriber<
    TComponentConfiguration extends BaseComponentConfiguration,
    TStateMap extends Record<string, unknown>,
    TCommandMap extends Record<string, unknown>,
>(
    settings: ComponentSettings<TComponentConfiguration>,
    stateTopicNames: Extract<keyof TStateMap, string>[],
    onStateChange: StateChangedHandler<TStateMap>,
    commandTopicNames: Extract<keyof TCommandMap, string>[],
    commandCallback: CommandCallback<TCommandMap>,
): Subscriber<TComponentConfiguration, TStateMap, TCommandMap>
Creates a new subscribable entity
Type Parameters
- TComponentConfiguration extends BaseComponentConfiguration
- TStateMap extends Record<string, unknown>
- TCommandMap extends Record<string, unknown>
Parameters
- settings: ComponentSettings<TComponentConfiguration>
  The component settings including MQTT configuration
- stateTopicNames: Extract<keyof TStateMap, string>[]
  Array of state topic names
- onStateChange: StateChangedHandler<TStateMap>
  Callback function to handle state changes
- commandTopicNames: Extract<keyof TCommandMap, string>[]
  Array of command topic names
- commandCallback: CommandCallback<TCommandMap>
  Callback function to handle received commands
Returns Subscriber<TComponentConfiguration, TStateMap, TCommandMap>
Overrides Discoverable.constructor
- Defined in api/subscriber.ts:84

Properties

`Protected`attributesTopic

attributesTopic: string

MQTT topic for entity attributes

`Protected`availabilityTopic

availabilityTopic: string

MQTT topic for entity availability status

`Protected`baseTopicName

baseTopicName: string

Base MQTT topic name for this entity

`Protected`commandTopics

commandTopics: CommandTopicConfiguration[] = []

List of MQTT topics for entity commands.

`Protected`component

component: TComponentConfiguration

The component configuration containing entity-specific settings

`Protected`configTopic

configTopic: string

MQTT topic for entity configuration

`Protected`identifier

identifier: string

Unique identifier for this entity

`Protected`logger

logger: Logger

Logger instance for debugging and error reporting

`Protected`mqttClient

mqttClient: MqttClient

The MQTT client instance used for communication

`Protected`settings

settings: ComponentSettings<TComponentConfiguration>

The component settings including MQTT configuration

`Protected`stateChangedHandler

stateChangedHandler: StateChangedHandler<TStateMap>

Callback function to handle state changes

`Protected`stateTopics

stateTopics: StateTopicConfiguration[]

List of MQTT topics for entity state

`Protected`wroteConfiguration

wroteConfiguration: boolean = false

Flag indicating whether configuration has been written to MQTT

Methods

`Protected`getConfig

getConfig(): ResolvedComponentConfiguration
Gets the complete configuration for this entity including command topic

Returns ResolvedComponentConfiguration
The resolved component configuration with all required MQTT topics
Overrides Discoverable.getConfig
- Defined in api/subscriber.ts:66

setAttributes

setAttributes(attributes: Record<string, unknown>): Promise<void>
Sets additional attributes for the entity
Parameters
- attributes: Record<string, unknown>
  Key-value pairs of attributes to set
Returns Promise<void>
Inherited from Discoverable.setAttributes
- Defined in api/discoverable.ts:193

setAvailability

setAvailability(availability: boolean): Promise<void>
Sets the availability state of the entity
Parameters
- availability: boolean
  True if the entity is available, false otherwise
Returns Promise<void>
Inherited from Discoverable.setAvailability
- Defined in api/discoverable.ts:203

setState

setState<K extends string>(topicName: K, state: TStateMap[K]): Promise<void>
Sets the state of the entity
Type Parameters
- K extends string
Parameters
- topicName: K
  The name of the MQTT topic to publish the state to
- state: TStateMap[K]
  The new state to set
Returns Promise<void>
Inherited from Discoverable.setState
- Defined in api/discoverable.ts:244

setStateSync

setStateSync<K extends string>(topicName: K, state: TStateMap[K]): void
Sets the state of the entity
Type Parameters
- K extends string
Parameters
- topicName: K
  The name of the MQTT topic to publish the state to
- state: TStateMap[K]
  The new state to set
Returns void
Inherited from Discoverable.setStateSync
- Defined in api/discoverable.ts:220

writeConfig

writeConfig(): Promise<void>
Writes the entity's configuration to MQTT for Home Assistant discovery Also sets the entity's initial availability state if not manually managed

Returns Promise<void>
Inherited from Discoverable.writeConfig
- Defined in api/discoverable.ts:178

Class Subscriber<TComponentConfiguration, TStateMap, TCommandMap>

Type Param: TCommandMessage

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns Subscriber<TComponentConfiguration, TStateMap, TCommandMap>

Properties

ProtectedattributesTopic

ProtectedavailabilityTopic

ProtectedbaseTopicName

ProtectedcommandTopics

Protectedcomponent

ProtectedconfigTopic

Protectedidentifier

Protectedlogger

ProtectedmqttClient

Protectedsettings

ProtectedstateChangedHandler

ProtectedstateTopics

ProtectedwroteConfiguration

Methods

ProtectedgetConfig

Returns ResolvedComponentConfiguration

setAttributes

Parameters

Returns Promise<void>

setAvailability

Parameters

Returns Promise<void>

setState

Type Parameters

Parameters

Returns Promise<void>

setStateSync

Type Parameters

Parameters

Returns void

writeConfig

Returns Promise<void>

Settings

On This Page

`Protected`attributesTopic

`Protected`availabilityTopic

`Protected`baseTopicName

`Protected`commandTopics

`Protected`component

`Protected`configTopic

`Protected`identifier

`Protected`logger

`Protected`mqttClient

`Protected`settings

`Protected`stateChangedHandler

`Protected`stateTopics

`Protected`wroteConfiguration

`Protected`getConfig