Class Button

Implements an MQTT button for Home Assistant discovery

Hierarchy (View Summary)

Subscriber<ButtonInfo, "PRESS">
- Button

Constructors

constructor

new Button(entityInfo: ButtonInfo, settings: HaDiscoverableManager): Button
Parameters
- entityInfo: ButtonInfo
- settings: HaDiscoverableManager
Returns Button
Overrides Subscriber.constructor
- Defined in sensors/button/button.ts:9

Properties

`Protected`attributesTopic

attributesTopic: string

`Protected` `Optional`availabilityTopic

availabilityTopic?: string

`Protected`configTopic

configTopic: string

`Readonly`entity

entity: ButtonInfo

`Protected`entityTopic

entityTopic: string

isBuffer

isBuffer: boolean = false

parseJson

parseJson: boolean = true

`Protected` `Readonly`settings

settings: HaDiscoverableManager

`Protected`stateTopic

stateTopic: string

`Protected`wroteConfiguration

wroteConfiguration: boolean = false

Accessors

commandTopic

get commandTopic(): string
Returns string
Inherited from Subscriber.commandTopic
- Defined in subscriber.ts:41

`Protected`logger

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

`Protected`mqtt

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

addListener

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

`Protected`debugInfo

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

emit

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

emitVoid

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

eventNames

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

generateConfig

generateConfig(): {
    availability_topic?: string;
    command_topic: string;
    json_attributes_topic: string;
    state_topic: string;
}
Override base config to add the command topic of this switch

Returns {
    availability_topic?: string;
    command_topic: string;
    json_attributes_topic: string;
    state_topic: string;
}
Inherited from Subscriber.generateConfig
- Defined in subscriber.ts:60

getMaxListeners

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

`Protected`initTopics

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

listenerCount

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

listeners

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

off

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

on

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

once

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

prependListener

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

prependOnceListener

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

`Protected`publish

publish(
topic: string,
payload: string | Buffer<ArrayBufferLike>,
): Promise<undefined | Packet>
Parameters
- topic: string
- payload: string | Buffer<ArrayBufferLike>
Returns Promise<undefined | Packet>
Inherited from Subscriber.publish
- Defined in subscriber.ts:67

rawListeners

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

register

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

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

removeAllListeners

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

removeListener

removeListener<
    EventName extends
        KeyOf<
            SubscriberEvents<
                "PRESS",
                Discoverable<ButtonInfo, DiscoverableEvents>,
                ButtonInfo,
            >,
        >,
>(
    event: EventName,
    listener: Callback<
        SubscriberEvents<
            "PRESS",
            Discoverable<ButtonInfo, DiscoverableEvents>,
            ButtonInfo,
        >[EventName],
    >,
): this
Type Parameters
- EventName extends KeyOf<
      SubscriberEvents<
          "PRESS",
          Discoverable<ButtonInfo, DiscoverableEvents>,
          ButtonInfo,
      >,
  >
Parameters
- event: EventName
- listener: Callback<
      SubscriberEvents<
          "PRESS",
          Discoverable<ButtonInfo, DiscoverableEvents>,
          ButtonInfo,
      >[EventName],
  >
Returns this
Inherited from Subscriber.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 Subscriber.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 Subscriber.setAvailability
- Defined in discoverable.ts:124

setMaxListeners

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

subscribe(): Promise<void>
Returns Promise<void>
Inherited from Subscriber.subscribe
- Defined in subscriber.ts:45

unregister

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

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

withCommand

withCommand(
    cb: (
        ...args: [
            json: "PRESS",
            sensor: Discoverable<ButtonInfo, DiscoverableEvents>,
            topic: string,
            details: MessageDetails<ButtonInfo>,
        ],
    ) => unknown,
): Button
Parameters
- cb: (
      ...args: [
          json: "PRESS",
          sensor: Discoverable<ButtonInfo, DiscoverableEvents>,
          topic: string,
          details: MessageDetails<ButtonInfo>,
      ],
  ) => unknown
Returns Button
Inherited from Subscriber.withCommand
- Defined in subscriber.ts:54

writeConfig

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

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

Class Button

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Button

Properties

ProtectedattributesTopic

Protected OptionalavailabilityTopic

ProtectedconfigTopic

Readonlyentity

ProtectedentityTopic

isBuffer

parseJson

Protected Readonlysettings

ProtectedstateTopic

ProtectedwroteConfiguration

Accessors

commandTopic

Returns string

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[]

generateConfig

Returns { availability_topic?: string; command_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

`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

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

`Protected`initTopics

`Protected`publish