Skip to main content

Thermostat — thermostat

Capabilities​

Declared in the driver manifest under [[proxy]] capabilities. Anything not declared takes the default below.

CapabilityTypeDefaultMeaning
fan_modesstring[]["auto","on"]
has_autoboolfalseDual setpoint auto-changeover
has_coolbooltrue
has_fan_controlbooltrue
has_heatbooltrue
has_holdboolfalseCan override a schedule until cancelled
has_humidityboolfalse
has_humidity_controlboolfalse
setpoint_max_cf3235.0
setpoint_min_cf324.0
setpoint_step_cf320.5
stage_countu81

Commands​

set_cool_setpoint​

Only present when has_cool is declared true.

ParameterTypeNotes
celsiusf32

set_fan_mode​

Only present when has_fan_control is declared true.

ParameterTypeNotes
modestring

set_heat_setpoint​

Only present when has_heat is declared true.

ParameterTypeNotes
celsiusf32

set_hold​

Only present when has_hold is declared true.

ParameterTypeNotes
holdbool

set_mode​

ParameterTypeNotes
modeone of off · heat · cool · auto

Notifications​

humidity_changed​

Only present when has_humidity is declared true.

ParameterTypeNotes
percentf32 0–100

hvac_state_changed​

What the equipment is actually doing right now

ParameterTypeNotes
stateone of idle · heating · cooling · fan

mode_changed​

ParameterTypeNotes
modestring

online_changed​

ParameterTypeNotes
onlinebool

setpoint_changed​

ParameterTypeNotes
celsiusf32
whichone of heat · cool

temperature_changed​

ParameterTypeNotes
celsiusf32

State​

Last-known values core keeps for a binding of this proxy.

KeyTypeMeaning
cool_setpoint_cf32
display_unitstring
heat_setpoint_cf32
humidityf32
hvac_statestring
modestring
onlinebool
setpoint_cf32
temperature_cf32