mqtt2ha
    Preparing search index...

    Interface WaterHeaterInfo

    Configuration interface for a water heater component.

    interface WaterHeaterInfo {
        availability?: AvailabilityConfiguration;
        component: "water_heater";
        current_temperature_template?: string;
        device?: DeviceConfiguration;
        device_class?: string;
        enabled_by_default?: boolean;
        entity_category?: "config" | "diagnostic" | "system";
        expire_after?: number;
        force_update?: boolean;
        icon?: string;
        initial?: number;
        json_attributes_template?: string;
        max_temp?: number;
        min_temp?: number;
        mode_command_template?: string;
        mode_state_template?: string;
        modes?: string[];
        name?: string;
        object_id?: string;
        optimistic?: boolean;
        origin?: OriginConfiguration;
        payload_off?: string;
        payload_on?: string;
        power_command_template?: string;
        precision?: number;
        qos?: number;
        retain?: boolean;
        temperature_command_template?: string;
        temperature_state_template?: string;
        temperature_unit?: string;
        unique_id?: string;
        value_template?: string;
        [key: string]: unknown;
    }

    Hierarchy (View Summary)

    Indexable

    • [key: string]: unknown

      Additional properties to serialize as part of the configuration payload. Typically used for command and state topics.

    Index
    availability? component current_temperature_template? device? device_class? enabled_by_default? entity_category? expire_after? force_update? icon? initial? json_attributes_template? max_temp? min_temp? mode_command_template? mode_state_template? modes? name? object_id? optimistic? origin? payload_off? payload_on? power_command_template? precision? qos? retain? temperature_command_template? temperature_state_template? temperature_unit? unique_id? value_template?
    availability?: AvailabilityConfiguration

    Configures the availability settings of the entity.

    component: "water_heater"

    The type of component, constrained to valid component types

    current_temperature_template?: string

    A template to render the value received on current_temperature_topic.

    device?: DeviceConfiguration

    Information about the device this component is a part of to tie it into the device registry. Only works when unique_id is set. At least one of identifiers or connections must be present to identify the device.

    device_class?: string

    Sets the class of the device, changing the device state and icon that is displayed on the frontend. The device_class can be null. Different components have different valid device classes.

    enabled_by_default?: boolean

    Flag which defines if the entity should be enabled when first added. Default is true.

    entity_category?: "config" | "diagnostic" | "system"

    The category of the entity

    • "config": For configuration related entities.
    • "diagnostic": For read-only diagnostic entities.
    • "system": For system related entities.
    expire_after?: number

    If set, it defines the number of seconds after the sensor’s state expires, if it’s not updated. After expiry, the sensor’s state becomes unavailable. Default the sensors state never expires.

    force_update?: boolean

    Sends update events (which results in update of state object’s last_changed) even if the sensor’s state hasn’t changed. Useful if you want to have meaningful value graphs in history or want to create an automation that triggers on every incoming state message (not only when the sensor’s new state is different to the current one).

    icon?: string

    Icon to use for the entity in the frontend. Should be a Material Design Icon (format: mdi:icon-name).

    initial?: number

    Set the initial target temperature. The default value depends on the temperature unit.

    json_attributes_template?: string

    Template to extract the JSON dictionary from the json_attributes_topic.

    max_temp?: number

    Maximum set point available. Default: 60°C or 140°F.

    min_temp?: number

    Minimum set point available. Default: 43.3°C or 110°F.

    mode_command_template?: string

    A template to render the value sent to mode_command_topic.

    mode_state_template?: string

    A template to render the value received on mode_state_topic.

    modes?: string[]

    A list of supported operation modes. Needs to be a subset of the default modes: off, eco, electric, gas, heat_pump, high_demand and performance.

    name?: string

    The name of the entity. This will be used for the entity name in the Home Assistant UI. Can be set to null if only the device name is relevant.

    object_id?: string

    Used instead of name for automatic generation of entity_id.

    optimistic?: boolean

    Flag that defines if the water heater works in optimistic mode. Default: true if no state topic defined, else false.

    origin?: OriginConfiguration

    Information about the application that is the origin of the component.

    payload_off?: string

    The payload sent to turn the device off. Default: "OFF".

    payload_on?: string

    The payload sent to turn the device on. Default: "ON".

    power_command_template?: string

    A template to render the value sent to power_command_topic.

    precision?: number

    The desired precision for this device. Supported values are 0.1, 0.5 and 1.0.

    qos?: number

    The maximum QoS level to be used when receiving and publishing messages. Default is 0.

    retain?: boolean

    Defines if published messages should have the retain flag set. Default: false.

    temperature_command_template?: string

    A template to render the value sent to temperature_command_topic.

    temperature_state_template?: string

    A template to render the value received on temperature_state_topic.

    temperature_unit?: string

    Defines the temperature unit of the device, C or F.

    unique_id?: string

    An ID that uniquely identifies this entity. If two entities have the same unique ID, Home Assistant will raise an exception. Required when used with device-based discovery.

    value_template?: string

    Defines a template to extract the value from the payload. Useful when the payload isn't a simple value.

    Settings
    Member Visibility

    On This Page
    Properties