mqtt2ha
    Preparing search index...

    Class WaterHeater

    Represents a water heater in Home Assistant.

    Hierarchy (View Summary)

    Index
    attributesTopic: string

    MQTT topic for entity attributes

    availabilityTopic: string

    MQTT topic for entity availability status

    baseTopicName: string

    Base MQTT topic name for this entity

    commandTopics: CommandTopicConfiguration[] = []

    List of MQTT topics for entity commands.

    component: WaterHeaterInfo

    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

    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

    • get currentMode(): string | undefined

      Returns string | undefined

      The active operation mode. Setting a mode other than off also records it as the last "on" mode used to restore power, and publishes the value on the mode_state_topic.

    • set currentMode(mode: string | undefined): void

      Parameters

      • mode: string | undefined

      Returns void

    • get currentTemperature(): number | undefined

      Returns number | undefined

      The measured current temperature. Setting it publishes the value on the current_temperature_topic; setting undefined publishes "None" to reset it.

    • set currentTemperature(temperature: number | undefined): void

      Parameters

      • temperature: number | undefined

      Returns void

    • get targetTemperature(): number | undefined

      Returns number | undefined

      The target temperature. Setting it publishes the value on the temperature_state_topic; setting undefined publishes "None" to reset it.

    • set targetTemperature(temperature: number | undefined): void

      Parameters

      • temperature: number | undefined

      Returns void

    • Clears the entity's retained discovery configuration, causing Home Assistant to remove the entity.

      Use this when an entity that may have been published by a previous run should no longer exist. Because writeConfig retains its payload, simply not calling it leaves the entity in place indefinitely.

      Returns Promise<void>

    • 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 keyof StateTopicMap

      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 keyof StateTopicMap

      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>