Additional properties to serialize as part of the configuration payload. Typically used for command and state topics.
Optionalaction_A template to render the value received on the action_topic with.
OptionalavailabilityConfigures the availability settings of the entity.
The type of component, constrained to valid component types
Optionalcurrent_A template with which the value received on current_humidity_topic will be rendered.
Optionalcurrent_A template with which the value received on current_temperature_topic will be rendered.
OptionaldeviceInformation 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.
Optionaldevice_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.
Optionalenabled_Flag which defines if the entity should be enabled when first added. Default is true.
Optionalentity_The category of the entity
Optionalexpire_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.
Optionalfan_A template to render the value sent to the fan_mode_command_topic with.
Optionalfan_A template to render the value received on the fan_mode_state_topic with.
Optionalfan_A list of supported fan modes. Default: ["auto", "low", "medium", "high"]
Optionalforce_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).
OptionaliconIcon to use for the entity in the frontend. Should be a Material Design Icon (format: mdi:icon-name).
OptionalinitialSet the initial target temperature. The default value depends on the temperature unit and will be 21° or 69.8°F.
Optionaljson_Template to extract the JSON dictionary from the json_attributes_topic.
Optionalmax_The maximum target humidity percentage that can be set. Default: 99
Optionalmax_Maximum set point available. The default value depends on the temperature unit, and will be 35°C or 95°F.
Optionalmin_The minimum target humidity percentage that can be set. Default: 30
Optionalmin_Minimum set point available. The default value depends on the temperature unit, and will be 7°C or 44.6°F.
Optionalmode_A template to render the value sent to the mode_command_topic with.
Optionalmode_A template to render the value received on the mode_state_topic with.
OptionalmodesA list of supported modes. Needs to be a subset of the default values. Default: ["auto", "off", "cool", "heat", "dry", "fan_only"]
OptionalnameThe 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.
Optionalobject_Used instead of name for automatic generation of entity_id.
OptionaloptimisticFlag that defines if the climate works in optimistic mode. Default: true if no state topic defined, else false.
OptionaloriginInformation about the application that is the origin of the component.
Optionalpayload_The payload sent to turn off the device. Default: "OFF"
Optionalpayload_The payload sent to turn the device on. Default: "ON"
Optionalpower_A template to render the value sent to the power_command_topic with. The value parameter is the payload set for
payload_on or payload_off.
OptionalprecisionThe desired precision for this device. Can be used to match your actual thermostat's precision. Supported values
are 0.1, 0.5 and 1.0. Default: 0.1 for Celsius and 1.0 for Fahrenheit.
Optionalpreset_Defines a template to generate the payload to send to preset_mode_command_topic.
Optionalpreset_Defines a template to extract the preset_mode value from the payload received on preset_mode_state_topic.
Optionalpreset_List of preset modes this climate is supporting. Common examples include eco, away, boost, comfort, home,
sleep and activity. Default: []
OptionalqosThe maximum QoS level to be used when receiving and publishing messages. Default is 0.
OptionalretainDefines if published messages should have the retain flag set. Default: false
Optionalswing_A template to render the value sent to the swing_horizontal_mode_command_topic with.
Optionalswing_A template to render the value received on the swing_horizontal_mode_state_topic with.
Optionalswing_A list of supported swing horizontal modes. Default: ["on", "off"]
Optionalswing_A template to render the value sent to the swing_mode_command_topic with.
Optionalswing_A template to render the value received on the swing_mode_state_topic with.
Optionalswing_A list of supported swing modes. Default: ["on", "off"]
Optionaltarget_Defines a template to generate the payload to send to target_humidity_command_topic.
Optionaltarget_Defines a template to extract a value for the climate target_humidity state.
Optionaltemp_Step size for temperature set point. Default: 1
Optionaltemperature_A template to render the value sent to the temperature_command_topic with.
Optionaltemperature_A template to render the value sent to the temperature_high_command_topic with.
Optionaltemperature_A template to render the value received on the temperature_high_state_topic with. A "None" value received will
reset the temperature high set point. Empty values ( '') will be ignored.
Optionaltemperature_A template to render the value sent to the temperature_low_command_topic with.
Optionaltemperature_A template to render the value received on the temperature_low_state_topic with. A "None" value received will
reset the temperature low set point. Empty values ( '') will be ignored.
Optionaltemperature_A template to render the value received on the temperature_state_topic with.
Optionaltemperature_Defines the temperature unit of the device, C or F. If this is not set, the temperature unit is set to the
system temperature unit.
Optionalunique_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.
Optionalvalue_Defines a template to extract the value from the payload. Useful when the payload isn't a simple value.
Configuration interface for a climate component.