Class HaDiscoverableManager

constructor

• new HaDiscoverableManager(
      client: MqttClient,
      mqttSettings?: HaDiscoverableMqttSettings,
      manualAvailability?: boolean,
      logger?: DiscoverableLogger,
  ): HaDiscoverableManager

  Parameters

  • client: MqttClient
  • mqttSettings: HaDiscoverableMqttSettings = ...
  • manualAvailability: boolean = false
  • logger: DiscoverableLogger = noopLogger

  Returns HaDiscoverableManager

Readonlyclient

Readonlylogger

ReadonlymanualAvailability

ReadonlymqttSettings

addCommandCallback

• addCommandCallback<
      T extends
          Subscriber<
              EntityInfo,
              unknown,
              Discoverable<EntityInfo, DiscoverableEvents>,
              SubscriberEvents<
                  unknown,
                  Discoverable<EntityInfo, DiscoverableEvents>,
                  EntityInfo,
              >,
          >,
  >(
      topic: string,
      subscriber: T,
  ): void
  Internal

  This method adds a message callback to the manager Internally, our message callback listens to all messages, and ignores the ones that are not registered.

  Type Parameters

  • T extends Subscriber<
        EntityInfo,
        unknown,
        Discoverable<EntityInfo, DiscoverableEvents>,
        SubscriberEvents<
            unknown,
            Discoverable<EntityInfo, DiscoverableEvents>,
            EntityInfo,
        >,
    >

  Parameters

  • topic: string
  • subscriber: T

  Returns void

addConnectCallback

• addConnectCallback(callback: (client: MqttClient) => unknown): void

  This method adds a connect callback to the manager It will be called when the client connects to the broker. If the client is already connected, it will be called immediately, and a potential error will be emitted as error event on the client. This is not an elegant solution, but async constructors don't exist in JS.

  Parameters

  • callback: (client: MqttClient) => unknown

  Returns void

getEntities

• getEntities(): Discoverable<EntityInfo, DiscoverableEvents>[]

  Get all currently registered discoverable entities

  Returns Discoverable<EntityInfo, DiscoverableEvents>[]

register

• register(discoverable: Discoverable<EntityInfo, any>): void
  Internal

  This method registers a discoverable entity. It's called in Discoverable constructor, and not intended to be called by the user.

  Parameters

  • discoverable: Discoverable<EntityInfo, any>

  Returns void

unregisterAll

• unregisterAll(): Promise<void>

  Delete all discoverable from Home Assistant You need to call this method before disconnecting from the broker. AggregateError will be thrown if any of the unregistering fails.

  Returns Promise<void>

StaticwithSettings

• withSettings(
      properties: HaDiscoverableGlobalSettingsProperties,
  ): HaDiscoverableManager

  Creates a new instance of the HaDiscoverableManager from properties.

  Parameters

  • properties: HaDiscoverableGlobalSettingsProperties

  Returns HaDiscoverableManager