mqtt2ha
    Preparing search index...

    Class BinarySensor

    Represents a binary sensor in Home Assistant. A binary sensor can only be in one of two states: ON/active or OFF/inactive.

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    attributesTopic availabilityTopic baseTopicName component configTopic identifier logger mqttClient settings stateChangedHandler stateTopics wroteConfiguration

    Accessors

    isOn

    Methods

    getConfig off on setAttributes setAvailability setState setStateSync toggle writeConfig

    Constructors

    Properties

    attributesTopic: string

    MQTT topic for entity attributes

    availabilityTopic: string

    MQTT topic for entity availability status

    baseTopicName: string

    Base MQTT topic name for this entity

    component: BinarySensorInfo

    The component configuration containing entity-specific settings

    configTopic: string

    MQTT topic for entity configuration

    identifier: string

    Unique identifier for this entity

    logger: Logger

    Logger instance for debugging and error reporting

    mqttClient: MqttClient

    The MQTT client instance used for communication

    settings: ComponentSettings<BinarySensorInfo>

    The component settings including MQTT configuration

    stateChangedHandler: StateChangedHandler<StateTopicMap>

    Callback function to handle state changes

    stateTopics: StateTopicConfiguration[]

    List of MQTT topics for entity state

    wroteConfiguration: boolean = false

    Flag indicating whether configuration has been written to MQTT

    Accessors

    Methods

    • Sets additional attributes for the entity

      Parameters

      • attributes: Record<string, unknown>

        Key-value pairs of attributes to set

      Returns Promise<void>

    • Sets the availability state of the entity

      Parameters

      • availability: boolean

        True if the entity is available, false otherwise

      Returns Promise<void>

    • Sets the state of the entity

      Type Parameters

      • K extends "state_topic"

      Parameters

      • topicName: K

        The name of the MQTT topic to publish the state to

      • state: StateTopicMap[K]

        The new state to set

      Returns Promise<void>

    • Sets the state of the entity

      Type Parameters

      • K extends "state_topic"

      Parameters

      • topicName: K

        The name of the MQTT topic to publish the state to

      • state: StateTopicMap[K]

        The new state to set

      Returns 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>

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods