ZCL Thermostat

Zigbee Cluster Library (ZCL) thermostat cluster usage definition for ESP Zigbee SDK.

Header File

Functions

esp_err_t esp_zb_zcl_thermostat_weekly_schedule_start(void)

Start thermostat weekly schedule.

Returns

  • ESP_OK: On success, otherwise, failure.

esp_err_t esp_zb_zcl_thermostat_weekly_schedule_stop(void)

Stop thermostat weekly schedule.

Returns

  • ESP_OK: On success, otherwise, failure.

esp_err_t esp_zb_zcl_thermostat_weekly_schedule_get_next_record(uint16_t *iterator, esp_zb_zcl_thermostat_weekly_schedule_record_t *record)

Get the next scheduled record from the thermostat weekly schedule table.

Parameters

  • iterator – [in] An iterator used to iterate through the thermostat weekly schedule table

  • record – [out] The next record in the thermostat weekly schedule table, refer to esp_zb_zcl_thermostat_weekly_schedule_record_t

Returns

  • ESP_OK: On success

  • ESP_ERR_INVALID_ARG: Invalid arguments

  • ESP_ERR_NOT_FOUND: End of the table reached

  • Otherwise: Failure

Structures

struct esp_zb_zcl_thermostat_weekly_schedule_transition_s

Structure for Thermostat Weekly Schedule Transition field.

Public Members

uint16_t transition_time

This field represents the start time of the schedule transition during the associated day.

uint16_t heat_setpoint

This field represents the heat setpoint to be applied at this associated transition start time.

uint16_t cool_setpoint

this field represents the cool setpoint to be applied at this associated transition start time.

struct esp_zb_zcl_thermostat_weekly_schedule_record_s

Structure for the record in Thermostat Weekly Schedule Table.

Public Members

uint8_t day_of_week

Day of week, refer to esp_zb_zcl_thermostat_day_of_week_t

uint8_t mode_for_seq

Mode for Sequence, refer to esp_zb_zcl_thermostat_weekly_schedule_mode_for_seq_t

uint16_t transition_time

Transition time in minutes after midnight

uint16_t heat_setpoint

Heat Set Point

uint16_t cool_setpoint

Cool Set Point

Macros

ESP_ZB_ZCL_THERMOSTAT_START_OF_WEEK_DEFAULT_VALUE
ESP_ZB_ZCL_THERMOSTAT_LOCAL_TEMPERATURE_MIN_VALUE

Min value for Local Temperature attribute.

ESP_ZB_ZCL_THERMOSTAT_LOCAL_TEMPERATURE_MAX_VALUE

Max value for Local Temperature attribute.

ESP_ZB_ZCL_THERMOSTAT_OUTDOOR_TEMPERATURE_MIN_VALUE

Min value for Outdoor Temperature attribute.

ESP_ZB_ZCL_THERMOSTAT_OUTDOOR_TEMPERATURE_MAX_VALUE

Max value for Outdoor Temperature attribute.

ESP_ZB_ZCL_THERMOSTAT_LOCAL_TEMPERATURE_INVALID

Invalid value for Local Temperature attribute.

ESP_ZB_ZCL_THERMOSTAT_LOCAL_TEMPERATURE_DEFAULT_VALUE

Default value for Local Temperature attribute.

ESP_ZB_ZCL_THERMOSTAT_LOCAL_TEMPERATURE_CALIBRATION_MIN_VALUE

Min value for Local Temperature Calibration attribute.

ESP_ZB_ZCL_THERMOSTAT_LOCAL_TEMPERATURE_CALIBRATION_MAX_VALUE

Max value for Local Temperature Calibration attribute.

ESP_ZB_ZCL_THERMOSTAT_OCCUPIED_COOLING_SETPOINT_DEFAULT_VALUE

Default value for Occupied Cooling Setpoint attribute.

ESP_ZB_ZCL_THERMOSTAT_OCCUPIED_COOLING_SETPOINT_MIN_VALUE

Min value for Occupied Cooling Setpoint attribute.

ESP_ZB_ZCL_THERMOSTAT_OCCUPIED_COOLING_SETPOINT_MAX_VALUE

Max value for Occupied Cooling Setpoint attribute.

ESP_ZB_ZCL_THERMOSTAT_OCCUPIED_HEATING_SETPOINT_DEFAULT_VALUE

Default value for Occupied Heating Setpoint attribute.

ESP_ZB_ZCL_THERMOSTAT_OCCUPIED_HEATING_SETPOINT_MIN_VALUE

Min value for Occupied Heating Setpoint attribute.

ESP_ZB_ZCL_THERMOSTAT_OCCUPIED_HEATING_SETPOINT_MAX_VALUE

Max value for Occupied Heating Setpoint attribute.

ESP_ZB_ZCL_THERMOSTAT_MIN_SETPOINT_DEAD_BAND_MIN_VALUE

Min value for Min Setpoint Dead Band attribute.

ESP_ZB_ZCL_THERMOSTAT_MIN_SETPOINT_DEAD_BAND_MAX_VALUE

Max value for Min Setpoint Dead Band attribute.

ESP_ZB_ZCL_THERMOSTAT_REMOTE_SENSING_LOCAL_TEMPERATURE_SENSED_REMOTELY_BIT

Local Temperature Sensed Remotely bit of Remote Sensing attribute.

ESP_ZB_ZCL_THERMOSTAT_REMOTE_SENSING_OUTDOOR_TEMPERATURE_SENSED_REMOTELY_BIT

Outdoor Temperature Sensed Remotely bit of Remote Sensing attribute.

ESP_ZB_ZCL_THERMOSTAT_REMOTE_SENSING_OCCUPANCY_SENSED_REMOTELY_BIT

Occupancy Sensed Sensed Remotely bit of Remote Sensing attribute

ESP_ZB_ZCL_THERMOSTAT_CONTROL_SEQ_OF_OPERATION_DEFAULT_VALUE

Default value for Control Sequence Of Operation attribute.

ESP_ZB_ZCL_THERMOSTAT_CONTROL_SYSTEM_MODE_DEFAULT_VALUE

Default value for System Mode attribute.

ESP_ZB_ZCL_THERMOSTAT_OCCUPANCY_DEFAULT_VALUE

Default value for Occupancy attribute.

ESP_ZB_ZCL_THERMOSTAT_OCCUPANCY_BITMASK

Bitmask for Occupancy attribute.

ESP_ZB_ZCL_THERMOSTAT_ABS_MIN_HEAT_SETPOINT_LIMIT_DEFAULT_VALUE

Default value for AbsMinHeatSetpointLimit attribute.

ESP_ZB_ZCL_THERMOSTAT_ABS_MAX_HEAT_SETPOINT_LIMIT_DEFAULT_VALUE

Default value for AbsMaxHeatSetpointLimit attribute.

ESP_ZB_ZCL_THERMOSTAT_ABS_MIN_COOL_SETPOINT_LIMIT_DEFAULT_VALUE

Default value for AbsMinCoolSetpointLimit attribute.

ESP_ZB_ZCL_THERMOSTAT_ABS_MAX_COOL_SETPOINT_LIMIT_DEFAULT_VALUE

Default value for AbsMaxCoolSetpointLimit attribute.

ESP_ZB_ZCL_THERMOSTAT_PI_COOLING_DEMAND_MIN_VALUE

Min value for PICoolingDemand attribute.

ESP_ZB_ZCL_THERMOSTAT_PI_COOLING_DEMAND_MAX_VALUE

Max value for PICoolingDemand attribute.

ESP_ZB_ZCL_THERMOSTAT_PI_HEATING_DEMAND_MIN_VALUE

Min value for PIHeatingDemand attribute.

ESP_ZB_ZCL_THERMOSTAT_PI_HEATING_DEMAND_MAX_VALUE

Max value for PIHeatingDemand attribute.

ESP_ZB_ZCL_THERMOSTAT_HVAC_SYSTEM_TYPE_CONFIGURATION_DEFAULT_VALUE

Default value for HVACSystemTypeConfiguration attribute.

ESP_ZB_ZCL_THERMOSTAT_LOCAL_TEMPERATURE_CALIBRATION_DEFAULT_VALUE

Default value for LocalTemperatureCalibration attribute.

ESP_ZB_ZCL_THERMOSTAT_UNOCCUPIED_COOLING_SETPOINT_DEFAULT_VALUE

Default value for UnoccupiedCoolingSetpoint attribute.

ESP_ZB_ZCL_THERMOSTAT_UNOCCUPIED_HEATING_SETPOINT_DEFAULT_VALUE

Default value for UnoccupiedHeatingSetpoint attribute.

ESP_ZB_ZCL_THERMOSTAT_MIN_HEAT_SETPOINT_LIMIT_DEFAULT_VALUE

Default value for MinHeatSetpointLimit attribute.

ESP_ZB_ZCL_THERMOSTAT_MAX_HEAT_SETPOINT_LIMIT_DEFAULT_VALUE

Default value for MaxHeatSetpointLimit attribute.

ESP_ZB_ZCL_THERMOSTAT_MIN_COOL_SETPOINT_LIMIT_DEFAULT_VALUE

Default value for MinCoolSetpointLimit attribute.

ESP_ZB_ZCL_THERMOSTAT_MAX_COOL_SETPOINT_LIMIT_DEFAULT_VALUE

Default value for MaxCoolSetpointLimit attribute.

ESP_ZB_ZCL_THERMOSTAT_MIN_SETPOINT_DEAD_BAND_DEFAULT_VALUE

Default value for MinSetpointDeadBand attribute.

ESP_ZB_ZCL_THERMOSTAT_REMOTE_SENSING_DEFAULT_VALUE

Default value for RemoteSensing attribute.

ESP_ZB_ZCL_THERMOSTAT_CONTROL_SEQUENCE_OF_OPERATION_DEFAULT_VALUE

Default value for ControlSequenceOfOperation attribute.

ESP_ZB_ZCL_THERMOSTAT_SYSTEM_MODE_DEFAULT_VALUE

Default value for SystemMode attribute.

ESP_ZB_ZCL_THERMOSTAT_ALARM_MASK_DEFAULT_VALUE

Default value for AlarmMask attribute.

ESP_ZB_ZCL_THERMOSTAT_RUNNING_MODE_DEFAULT_VALUE

Default value for RunningMode attribute.

ESP_ZB_ZCL_THERMOSTAT_RUNNING_MODE_OFF_VALUE

Off value for RunningMode attribute.

ESP_ZB_ZCL_THERMOSTAT_RUNNING_MODE_COOL_VALUE

Cool value for RunningMode attribute.

ESP_ZB_ZCL_THERMOSTAT_RUNNING_MODE_HEAT_VALUE

Heat value for RunningMode attribute.

ESP_ZB_ZCL_THERMOSTAT_TEMPERATURE_SETPOINT_HOLD_DEFAULT_VALUE

Default value for TemperatureSetpointHold attribute.

ESP_ZB_ZCL_THERMOSTAT_TEMPERATURE_SETPOINT_HOLD_DURATION_DEFAULT_VALUE

Default value for TemperatureSetpointHoldDuration attribute.

ESP_ZB_ZCL_THERMOSTAT_TEMPERATURE_SETPOINT_HOLD_DURATION_MIN_VALUE

Min value for TemperatureSetpointHoldDuration attribute.

ESP_ZB_ZCL_THERMOSTAT_TEMPERATURE_SETPOINT_HOLD_DURATION_MAX_VALUE

Max value for TemperatureSetpointHoldDuration attribute.

ESP_ZB_ZCL_THERMOSTAT_THERMOSTAT_PROGRAMMING_OPERATION_MODE_DEFAULT_VALUE

Default value for ThermostatProgrammingOperationMode attribute.

ESP_ZB_ZCL_THERMOSTAT_SETPOINT_CHANGE_SOURCE_DEFAULT_VALUE

Default value for SetpointChangeSource attribute.

ESP_ZB_ZCL_THERMOSTAT_SETPOINT_CHANGE_AMOUNT_DEFAULT_VALUE

Default value for SetpointChangeAmount attribute.

ESP_ZB_ZCL_THERMOSTAT_SETPOINT_CHANGE_SOURCE_TIMESTAMP_DEFAULT_VALUE

Default value for SetpointChangeSourceTimestamp attribute.

ESP_ZB_ZCL_THERMOSTAT_OCCUPIED_SETBACK_DEFAULT_VALUE

Default value for OccupiedSetback attribute.

ESP_ZB_ZCL_THERMOSTAT_OCCUPIED_SETBACK_MIN_DEFAULT_VALUE

Default value for OccupiedSetbackMin attribute.

ESP_ZB_ZCL_THERMOSTAT_OCCUPIED_SETBACK_MAX_DEFAULT_VALUE

Default value for OccupiedSetbackMax attribute.

ESP_ZB_ZCL_THERMOSTAT_UNOCCUPIED_SETBACK_DEFAULT_VALUE

Default value for UnoccupiedSetback attribute.

ESP_ZB_ZCL_THERMOSTAT_UNOCCUPIED_SETBACK_MIN_DEFAULT_VALUE

Default value for UnoccupiedSetbackMin attribute.

ESP_ZB_ZCL_THERMOSTAT_UNOCCUPIED_SETBACK_MAX_DEFAULT_VALUE

Default value for UnoccupiedSetbackMax attribute.

ESP_ZB_ZCL_THERMOSTAT_EMERGENCY_HEAT_DELTA_DEFAULT_VALUE

Default value for EmergencyHeatDelta attribute.

ESP_ZB_ZCL_THERMOSTAT_AC_TYPE_DEFAULT_VALUE

Default value for ACType attribute.

ESP_ZB_ZCL_THERMOSTAT_AC_TYPE_UNKNOWN_VALUE

Unknown value for ACType attribute.

ESP_ZB_ZCL_THERMOSTAT_AC_TYPE_COOLING_AND_FIXED_SPEED_VALUE

Cooling and Fixed Speed value for ACType attribute.

ESP_ZB_ZCL_THERMOSTAT_AC_TYPE_HEAT_PUMP_AND_FIXED_SPEED_VALUE

Heat Pump and Fixed Speed value for ACType attribute.

ESP_ZB_ZCL_THERMOSTAT_AC_TYPE_COOLING_AND_INVERTER_VALUE

Cooling and Inverter value for ACType attribute.

ESP_ZB_ZCL_THERMOSTAT_AC_TYPE_HEAT_PUMP_AND_INVERTER_VALUE

Heat Pump and Inverter value value for ACType attribute.

ESP_ZB_ZCL_THERMOSTAT_AC_CAPACITY_DEFAULT_VALUE

Default value for ACCapacity attribute.

ESP_ZB_ZCL_THERMOSTAT_AC_REFRIGERANT_TYPE_DEFAULT_VALUE

Default value for ACRefrigerantType attribute.

ESP_ZB_ZCL_THERMOSTAT_AC_REFRIGERANT_TYPE_UNKNOWN_VALUE

Unknown value for ACRefrigerantType attribute.

ESP_ZB_ZCL_THERMOSTAT_AC_REFRIGERANT_TYPE_R22_VALUE

R22 value for ACRefrigerantType attribute.

ESP_ZB_ZCL_THERMOSTAT_AC_REFRIGERANT_TYPE_R410A_VALUE

R410a value for ACRefrigerantType attribute.

ESP_ZB_ZCL_THERMOSTAT_AC_REFRIGERANT_TYPE_R407C_VALUE

R407c value for ACRefrigerantType attribute.

ESP_ZB_ZCL_THERMOSTAT_AC_COMPRESSOR_TYPE_DEFAULT_VALUE

Default value for ACCompressorType attribute.

ESP_ZB_ZCL_THERMOSTAT_AC_COMPRESSOR_TYPE_UNKNOWN_VALUE

Unknown value for ACCompressorType attribute.

ESP_ZB_ZCL_THERMOSTAT_AC_COMPRESSOR_TYPE_T1_VALUE

T1(Max working ambient 43 ºC) value for ACCompressorType attribute.

ESP_ZB_ZCL_THERMOSTAT_AC_COMPRESSOR_TYPE_T2_VALUE

T2(Max working ambient 35 ºC) value for ACCompressorType attribute.

ESP_ZB_ZCL_THERMOSTAT_AC_COMPRESSOR_TYPE_T3_VALUE

T3(Max working ambient 52 ºC) value for ACCompressorType attribute.

ESP_ZB_ZCL_THERMOSTAT_AC_ERROR_CODE_DEFAULT_VALUE

Default value for ACErrorCode attribute.

ESP_ZB_ZCL_THERMOSTAT_AC_ERROR_CODE_COMPRESSOR_FAILURE_OR_REFRIGERANT_LEAKAGE_BIT

Compressor Failure or Refrigerant Leakage bit of AC Error Code attribute

ESP_ZB_ZCL_THERMOSTAT_AC_ERROR_CODE_ROOM_TEMPERATURE_SENSOR_FAILURE_BIT

Room Temperature Sensor Failure bit of AC Error Code attribute

ESP_ZB_ZCL_THERMOSTAT_AC_ERROR_CODE_OUTDOOR_TEMPERATURE_SENSOR_FAILURE_BIT

Outdoor Temperature Sensor Failure bit of AC Error Code attribute

ESP_ZB_ZCL_THERMOSTAT_AC_ERROR_CODE_INDOOR_COIL_TEMPERATURE_SENSOR_FAILURE_BIT

Indoor Coil Temperature Sensor Failure bit of AC Error Code attribute

ESP_ZB_ZCL_THERMOSTAT_AC_ERROR_CODE_FAN_FAILURE_BIT

Fan Failure bit of AC Error Code attribute

ESP_ZB_ZCL_THERMOSTAT_AC_LOUVER_POSITION_DEFAULT_VALUE

Default value for ACLouverPosition attribute.

ESP_ZB_ZCL_THERMOSTAT_AC_LOUVER_POSITION_FULLY_CLOSED_VALUE

Fully Closed value for ACLouverPosition attribute.

ESP_ZB_ZCL_THERMOSTAT_AC_LOUVER_POSITION_FULLY_OPEN_VALUE

Fully Open value for ACLouverPosition attribute.

ESP_ZB_ZCL_THERMOSTAT_AC_LOUVER_POSITION_QUARTER_OPEN_VALUE

Quarter Open value for ACLouverPosition attribute.

ESP_ZB_ZCL_THERMOSTAT_AC_LOUVER_POSITION_THREE_QUARTERS_OPEN_VALUE

Three Quarters Open value for ACLouverPosition attribute.

ESP_ZB_ZCL_THERMOSTAT_AC_LOUVER_POSITION_HALF_OPEN_VALUE

Half Open value for ACLouverPosition attribute.

ESP_ZB_ZCL_THERMOSTAT_AC_COIL_TEMPERATURE_MIN_VALUE

Min value for AC Coil Temperature attribute.

ESP_ZB_ZCL_THERMOSTAT_AC_COIL_TEMPERATURE_MAX_VALUE

Max value for AC Coil Temperature attribute.

ESP_ZB_ZCL_THERMOSTAT_AC_CAPACITY_FORMAT_DEFAULT_VALUE

Default value for AC Capacity Format attribute.

ESP_ZB_ZCL_THERMOSTAT_AC_CAPACITY_FORMAT_BTUH_VALUE

BTUh value for AC Capacity Format attribute.

ESP_ZB_ZCL_THERMOSTAT_ALARM_MASK_INITIALIZATION_FAILURE_BIT

Initialization failure bit of Alarm Mask attribute

ESP_ZB_ZCL_THERMOSTAT_ALARM_MASK_HARDWARE_FAILURE_BIT

Hardware Failure bit of Alarm Mask attribute

ESP_ZB_ZCL_THERMOSTAT_ALARM_MASK_SELFCALIBRATION_FAILURE_BIT

Self-Calibration Failure bit of Alarm Mask attribute

ESP_ZB_ZCL_THERMOSTAT_PROGRAMMING_OPERATION_MODE_SIMPLE_SETPOINT_OR_PROGRAMMING_MODE_BIT

Simple/Setpoint(0) or Schedule_Programming(1) mode bit of Thermostat Programming Operation Mode attribute

ESP_ZB_ZCL_THERMOSTAT_PROGRAMMING_OPERATION_MODE_AUTO_RECOVERY_MODE_BIT

Auto/recovery mode bit of Thermostat Programming Operation Mode attribute

ESP_ZB_ZCL_THERMOSTAT_PROGRAMMING_OPERATION_MODE_ECONOMY_ENERGY_STAR_MODE_BIT

Economy/EnergyStar mode bit of Thermostat Programming Operation Mode attribute

ESP_ZB_ZCL_THERMOSTAT_RUNNNING_STATE_HEAT_STATE_ON_BIT

Heat State On bit of Thermostat Running State attribute

ESP_ZB_ZCL_THERMOSTAT_RUNNNING_STATE_COOL_STATE_ON_BIT

Cool State On bit of Thermostat Running State attribute

ESP_ZB_ZCL_THERMOSTAT_RUNNNING_STATE_FAN_STATE_ON_BIT

Fan State On bit of Thermostat Running State attribute

ESP_ZB_ZCL_THERMOSTAT_RUNNNING_STATE_HEAT_2ND_STAGE_STATE_ON_BIT

Heat 2nd Stage State On bit of Thermostat Running State attribute

ESP_ZB_ZCL_THERMOSTAT_RUNNNING_STATE_COOL_2ND_STAGE_STATE_ON_BIT

Cool 2nd Stage State On bit of Thermostat Running State attribute

ESP_ZB_ZCL_THERMOSTAT_RUNNNING_STATE_FAN_2ND_STAGE_STATE_ON_BIT

Fan 2nd Stage State On bit of Thermostat Running State attribute

ESP_ZB_ZCL_THERMOSTAT_RUNNNING_STATE_FAN_3RD_STAGE_STATE_ON_BIT

Fan 3rd Stage State On bit of Thermostat Running State attribute

Type Definitions

typedef struct esp_zb_zcl_thermostat_weekly_schedule_transition_s esp_zb_zcl_thermostat_weekly_schedule_transition_t

Structure for Thermostat Weekly Schedule Transition field.

typedef struct esp_zb_zcl_thermostat_weekly_schedule_record_s esp_zb_zcl_thermostat_weekly_schedule_record_t

Structure for the record in Thermostat Weekly Schedule Table.

Enumerations

enum esp_zb_zcl_thermostat_attr_t

Thermostat cluster attribute identifiers.

Values:

enumerator ESP_ZB_ZCL_ATTR_THERMOSTAT_LOCAL_TEMPERATURE_ID

Local Temperature attribute

enumerator ESP_ZB_ZCL_ATTR_THERMOSTAT_OUTDOOR_TEMPERATURE_ID

Outdoor Temperature attribute

enumerator ESP_ZB_ZCL_ATTR_THERMOSTAT_OCCUPANCY_ID

Occupancy attribute

enumerator ESP_ZB_ZCL_ATTR_THERMOSTAT_ABS_MIN_HEAT_SETPOINT_LIMIT_ID

The AbsMinHeatSetpointLimit attribute specifies the absolute minimum level that the heating setpoint MAY be set to

enumerator ESP_ZB_ZCL_ATTR_THERMOSTAT_ABS_MAX_HEAT_SETPOINT_LIMIT_ID

The AbsMaxHeatSetpointLimit attribute specifies the absolute maximum level that the heating setpoint MAY be set to

enumerator ESP_ZB_ZCL_ATTR_THERMOSTAT_ABS_MIN_COOL_SETPOINT_LIMIT_ID

The AbsMinCoolSetpointLimit attribute specifies the absolute minimum level that the cooling setpoint MAY be set to

enumerator ESP_ZB_ZCL_ATTR_THERMOSTAT_ABS_MAX_COOL_SETPOINT_LIMIT_ID

The AbsMaxCoolSetpointLimit attribute specifies the absolute maximum level that the cooling setpoint MAY be set to

enumerator ESP_ZB_ZCL_ATTR_THERMOSTAT_PI_COOLING_DEMAND_ID

The PICoolingDemand attribute is 8 bits in length and specifies the level of cooling demanded by the PI (proportional integral) control loop in use by the thermostat (if any), in percent

enumerator ESP_ZB_ZCL_ATTR_THERMOSTAT_PI_HEATING_DEMAND_ID

The PIHeatingDemand attribute is 8 bits in length and specifies the level of heating demanded by the PI loop in percent

enumerator ESP_ZB_ZCL_ATTR_THERMOSTAT_HVAC_SYSTEM_TYPE_CONFIGURATION_ID

The HVACSystemTypeConfiguration attribute specifies the HVAC system type controlled by the thermostat

enumerator ESP_ZB_ZCL_ATTR_THERMOSTAT_LOCAL_TEMPERATURE_CALIBRATION_ID

Local Temperature Calibration

enumerator ESP_ZB_ZCL_ATTR_THERMOSTAT_OCCUPIED_COOLING_SETPOINT_ID

Occupied Cooling Setpoint attribute

enumerator ESP_ZB_ZCL_ATTR_THERMOSTAT_OCCUPIED_HEATING_SETPOINT_ID

Occupied Heating Setpoint attribute

enumerator ESP_ZB_ZCL_ATTR_THERMOSTAT_UNOCCUPIED_COOLING_SETPOINT_ID

Unoccupied Cooling Setpoint attribute

enumerator ESP_ZB_ZCL_ATTR_THERMOSTAT_UNOCCUPIED_HEATING_SETPOINT_ID

Unoccupied Heating Setpoint attribute

enumerator ESP_ZB_ZCL_ATTR_THERMOSTAT_MIN_HEAT_SETPOINT_LIMIT_ID

The MinHeatSetpointLimit attribute specifies the minimum level that the heating setpoint MAY be set to

enumerator ESP_ZB_ZCL_ATTR_THERMOSTAT_MAX_HEAT_SETPOINT_LIMIT_ID

The MaxHeatSetpointLimit attribute specifies the maximum level that the heating setpoint MAY be set to

enumerator ESP_ZB_ZCL_ATTR_THERMOSTAT_MIN_COOL_SETPOINT_LIMIT_ID

The MinCoolSetpointLimit attribute specifies the minimum level that the cooling setpoint MAY be set to

enumerator ESP_ZB_ZCL_ATTR_THERMOSTAT_MAX_COOL_SETPOINT_LIMIT_ID

The MaxCoolSetpointLimit attribute specifies the maximum level that the cooling setpoint MAY be set to

enumerator ESP_ZB_ZCL_ATTR_THERMOSTAT_MIN_SETPOINT_DEAD_BAND_ID

The MinSetpointDeadBand attribute specifies the minimum difference between the Heat Setpoint and the Cool SetPoint, in steps of 0.1C

enumerator ESP_ZB_ZCL_ATTR_THERMOSTAT_REMOTE_SENSING_ID

The RemoteSensing attribute is an 8-bit bitmap that specifies whether the local temperature, outdoor temperature and occupancy are being sensed by internal sensors or remote networked sensors

enumerator ESP_ZB_ZCL_ATTR_THERMOSTAT_CONTROL_SEQUENCE_OF_OPERATION_ID

Control Sequence Of Operation attribute

enumerator ESP_ZB_ZCL_ATTR_THERMOSTAT_SYSTEM_MODE_ID

System Mode attribute

enumerator ESP_ZB_ZCL_ATTR_THERMOSTAT_ALARM_MASK_ID

The AlarmMask attribute specifies whether each of the alarms is enabled

enumerator ESP_ZB_ZCL_ATTR_THERMOSTAT_RUNNING_MODE_ID

Thermostat Running Mode attribute

enumerator ESP_ZB_ZCL_ATTR_THERMOSTAT_START_OF_WEEK_ID

Start of Week attribute

enumerator ESP_ZB_ZCL_ATTR_THERMOSTAT_NUMBER_OF_WEEKLY_TRANSITIONS_ID

NumberOfWeeklyTransitions attribute determines how many weekly schedule transitions the thermostat is capable of handling

enumerator ESP_ZB_ZCL_ATTR_THERMOSTAT_NUMBER_OF_DAILY_TRANSITIONS_ID

NumberOfDailyTransitions attribute determines how many daily schedule transitions the thermostat is capable of handling

enumerator ESP_ZB_ZCL_ATTR_THERMOSTAT_TEMPERATURE_SETPOINT_HOLD_ID

TemperatureSetpointHold specifies the temperature hold status on the thermostat

enumerator ESP_ZB_ZCL_ATTR_THERMOSTAT_TEMPERATURE_SETPOINT_HOLD_DURATION_ID

TemperatureSetpointHoldDuration sets the period in minutes for which a setpoint hold is active

enumerator ESP_ZB_ZCL_ATTR_THERMOSTAT_THERMOSTAT_PROGRAMMING_OPERATION_MODE_ID

The ThermostatProgrammingOperationMode attribute determines the operational state of the thermostats programming

enumerator ESP_ZB_ZCL_ATTR_THERMOSTAT_THERMOSTAT_RUNNING_STATE_ID

ThermostatRunningState represents the current relay state of the heat, cool, and fan relays

enumerator ESP_ZB_ZCL_ATTR_THERMOSTAT_SETPOINT_CHANGE_SOURCE_ID

The SetpointChangeSource attribute specifies the source of the current active OccupiedCoolingSetpoint or OccupiedHeatingSetpoint (i.e., who or what determined the current setpoint)

enumerator ESP_ZB_ZCL_ATTR_THERMOSTAT_SETPOINT_CHANGE_AMOUNT_ID

The SetpointChangeAmount attribute specifies the delta between the current active OccupiedCoolingSetpoint or OccupiedHeatingSetpoint and the previous active setpoint

enumerator ESP_ZB_ZCL_ATTR_THERMOSTAT_SETPOINT_CHANGE_SOURCE_TIMESTAMP_ID

The SetpointChangeSourceTimestamp attribute specifies the time in UTC at which the SetpointChangeSourceAmount attribute change was recorded

enumerator ESP_ZB_ZCL_ATTR_THERMOSTAT_OCCUPIED_SETBACK_ID

Specifies the degrees Celsius, in 0.1 degree increments, the Thermostat server will allow the LocalTemperature attribute to float above the OccupiedCooling setpoint or below the OccupiedHeating setpoint before initiating a state change to bring the temperature back to the users desired setpoint

enumerator ESP_ZB_ZCL_ATTR_THERMOSTAT_OCCUPIED_SETBACK_MIN_ID

Specifies the minimum degrees Celsius, in 0.1 degree increments, the Thermostat server will allow the OccupiedSetback attribute to be configured by a user

enumerator ESP_ZB_ZCL_ATTR_THERMOSTAT_OCCUPIED_SETBACK_MAX_ID

Specifies the maximum degrees Celsius, in 0.1 degree increments, the Thermostat server will allow the OccupiedSetback attribute to be configured by a user

enumerator ESP_ZB_ZCL_ATTR_THERMOSTAT_UNOCCUPIED_SETBACK_ID

Specifies the degrees Celsius, in 0.1 degree increments, the Thermostat server will allow the LocalTemperature attribute to float above the UnoccupiedCooling setpoint or below the UnoccupiedHeating setpoint before initiating a state change to bring the temperature back to the users desired setpoint

enumerator ESP_ZB_ZCL_ATTR_THERMOSTAT_UNOCCUPIED_SETBACK_MIN_ID

Specifies the minimum degrees Celsius, in 0.1 degree increments, the Thermostat server will allow the UnoccupiedSetback attribute to be configured by a user

enumerator ESP_ZB_ZCL_ATTR_THERMOSTAT_UNOCCUPIED_SETBACK_MAX_ID

Specifies the maximum degrees Celsius, in 0.1 degree increments, the Thermostat server will allow the UnoccupiedSetback attribute to be configured by a user.

enumerator ESP_ZB_ZCL_ATTR_THERMOSTAT_EMERGENCY_HEAT_DELTA_ID

Specifies the delta, in 0.1 degrees Celsius, between LocalTemperature and the OccupiedHeatingSetpoint or UnoccupiedHeatingSetpoint attributes at which the Thermostat server will operate in emergency heat mode

enumerator ESP_ZB_ZCL_ATTR_THERMOSTAT_AC_TYPE_ID

Indicates the type of Mini Split ACType of Mini Split AC is defined depending on how Cooling and Heating condition is achieved by Mini Split AC

enumerator ESP_ZB_ZCL_ATTR_THERMOSTAT_AC_CAPACITY_ID

Indicates capacity of Mini Split AC in terms of the format defined by the ACCapacityFormat attribute

enumerator ESP_ZB_ZCL_ATTR_THERMOSTAT_AC_REFRIGERANT_TYPE_ID

Indicates type of refrigerant used within the Mini Split AC

enumerator ESP_ZB_ZCL_ATTR_THERMOSTAT_AC_COMPRESSOR_TYPE_ID

This indicates type of Compressor used within the Mini Split AC

enumerator ESP_ZB_ZCL_ATTR_THERMOSTAT_AC_ERROR_CODE_ID

This indicates the type of errors encountered within the Mini Split AC

enumerator ESP_ZB_ZCL_ATTR_THERMOSTAT_AC_LOUVER_POSITION_ID

AC Louver position attribute

enumerator ESP_ZB_ZCL_ATTR_THERMOSTAT_AC_COIL_TEMPERATURE_ID

ACCoilTemperature represents the temperature in degrees Celsius, as measured locally or remotely (over the network)

enumerator ESP_ZB_ZCL_ATTR_THERMOSTAT_AC_CAPACITY_FORMAT_ID

This is the format for the ACCapacity attribute

enum esp_zb_zcl_thermostat_cmd_id_t

Thermostat cluster command identifiers.

Values:

enumerator ESP_ZB_ZCL_CMD_THERMOSTAT_SETPOINT_RAISE_LOWER

Setpoint Raise/Lower command

enumerator ESP_ZB_ZCL_CMD_THERMOSTAT_SET_WEEKLY_SCHEDULE

Set Weekly Schedule command

enumerator ESP_ZB_ZCL_CMD_THERMOSTAT_GET_WEEKLY_SCHEDULE

Get Weekly Schedule command

enumerator ESP_ZB_ZCL_CMD_THERMOSTAT_CLEAR_WEEKLY_SCHEDULE

Clear Weekly Schedule command

enumerator ESP_ZB_ZCL_CMD_THERMOSTAT_GET_RELAY_STATUS_LOG

Get Relay Status Log command

enum esp_zb_zcl_thermostat_cmd_resp_id_t

Thermostat cluster command identifiers.

Values:

enumerator ESP_ZB_ZCL_CMD_THERMOSTAT_GET_WEEKLY_SCHEDULE_RESP

Get Weekly Schedule response command

enumerator ESP_ZB_ZCL_CMD_THERMOSTAT_GET_RELAY_STATUS_LOG_RESP

Get Relay Status Log response command

enum esp_zb_zcl_thermostat_control_sequence_of_operation_t

Values for Control Sequence Of Operation attribute.

Values:

enumerator ESP_ZB_ZCL_THERMOSTAT_CONTROL_SEQ_OF_OPERATION_COOLING_ONLY

Cooling Only value

enumerator ESP_ZB_ZCL_THERMOSTAT_CONTROL_SEQ_OF_OPERATION_COOLING_WITH_REHEAT

Cooling With Reheat value

enumerator ESP_ZB_ZCL_THERMOSTAT_CONTROL_SEQ_OF_OPERATION_HEATING_ONLY

Heating Only value

enumerator ESP_ZB_ZCL_THERMOSTAT_CONTROL_SEQ_OF_OPERATION_HEATING_WITH_REHEAT

Heating With Reheat value

enumerator ESP_ZB_ZCL_THERMOSTAT_CONTROL_SEQ_OF_OPERATION_COOLING_AND_HEATING_4_PIPES

Cooling and Heating 4-pipes value

enumerator ESP_ZB_ZCL_THERMOSTAT_CONTROL_SEQ_OF_OPERATION_COOLING_AND_HEATING_4_PIPES_WITH_REHEAT

Cooling and Heating 4-pipes with Reheat value

enum esp_zb_zcl_thermostat_system_mode_t

Values for System Mode attribute.

Values:

enumerator ESP_ZB_ZCL_THERMOSTAT_SYSTEM_MODE_OFF

Off value

enumerator ESP_ZB_ZCL_THERMOSTAT_SYSTEM_MODE_AUTO

Auto value

enumerator ESP_ZB_ZCL_THERMOSTAT_SYSTEM_MODE_COOL

Cool value

enumerator ESP_ZB_ZCL_THERMOSTAT_SYSTEM_MODE_HEAT

Heat value

enumerator ESP_ZB_ZCL_THERMOSTAT_SYSTEM_MODE_EMERGENCY_HEATING

Emergency Heating value

enumerator ESP_ZB_ZCL_THERMOSTAT_SYSTEM_MODE_PRECOOLING

Precooling value

enumerator ESP_ZB_ZCL_THERMOSTAT_SYSTEM_MODE_FAN_ONLY

Fan Only value

enumerator ESP_ZB_ZCL_THERMOSTAT_SYSTEM_MODE_DRY

Dry value

enumerator ESP_ZB_ZCL_THERMOSTAT_SYSTEM_MODE_SLEEP

Sleep value

enum esp_zb_zcl_thermostat_ac_louver_position_t

Values for AC Louver position attribute.

Values:

enumerator ESP_ZB_ZCL_THERMOSTAT_LOUVER_FULLY_CLOSED

Fully close

enumerator ESP_ZB_ZCL_THERMOSTAT_LOUVER_FULLY_OPEN

Fully open

enumerator ESP_ZB_ZCL_THERMOSTAT_LOUVER_QUARTER_OPEN

Qyarter open

enumerator ESP_ZB_ZCL_THERMOSTAT_LOUVER_HALF_OPEN

Half open

enumerator ESP_ZB_ZCL_THERMOSTAT_LOUVER_THREE_QUARTERS_OPEN

Three quaters open

enum esp_zb_zcl_thermostat_start_of_week_t

Values for Start of Week attribute.

Values:

enumerator ESP_ZB_ZCL_THERMOSTAT_START_OF_WEEK_SUNDAY

Sunday value

enumerator ESP_ZB_ZCL_THERMOSTAT_START_OF_WEEK_MONDAY

Monday value

enumerator ESP_ZB_ZCL_THERMOSTAT_START_OF_WEEK_TUESDAY

Tuesday value

enumerator ESP_ZB_ZCL_THERMOSTAT_START_OF_WEEK_WEDNESDAY

Wednesday value

enumerator ESP_ZB_ZCL_THERMOSTAT_START_OF_WEEK_THURSDAY

Thursday value

enumerator ESP_ZB_ZCL_THERMOSTAT_START_OF_WEEK_FRIDAY

Friday value

enumerator ESP_ZB_ZCL_THERMOSTAT_START_OF_WEEK_SATURDAY

Saturday value

enum esp_zb_zcl_thermostat_temperature_setpoint_hold_t

Values for Temperature Setpoint Hold attribute.

Values:

enumerator ESP_ZB_ZCL_THERMOSTAT_TEMPERATURE_SETPOINT_HOLD_OFF

Off value

enumerator ESP_ZB_ZCL_THERMOSTAT_TEMPERATURE_SETPOINT_HOLD_ON

On value

enum esp_zb_zcl_thermostat_alarm_code_t

Values for AlarmMask attribute.

Values:

enumerator ESP_ZB_ZCL_THERMOSTAT_ALARM_CODE_INITIALIZATION_FAILURE

MainsVoltageAlarmCode - MainsVoltageMinThreshold reached for Mains Voltage

enumerator ESP_ZB_ZCL_THERMOSTAT_ALARM_CODE_HARDWARE_FAILURE

MainsVoltageAlarmCode - MainsVoltageMaxThreshold reached for Mains Voltage

enumerator ESP_ZB_ZCL_THERMOSTAT_ALARM_CODE_SELFCALIBRATION_FAILURE

BatteryAlarmCode - BatteryVoltageMinThreshold or BatteryPercentageMinThreshold reached for Battery Source 1

enum esp_zb_zcl_thermostat_programming_operation_mode_bit_t

Bits of ThermostatProgrammingOperationMode.

Values:

enumerator ESP_ZB_ZCL_THERMOSTAT_SCHEDULE_PROGRAMMING_MODE_BIT

Schedule programming bit

enumerator ESP_ZB_ZCL_THERMOSTAT_AUTO_RECOVERY_PROGRAMMING_MODE_BIT

Auto/recovery bit

enumerator ESP_ZB_ZCL_THERMOSTAT_ECONOMY_ENERGY_START_PROGRAMMING_MODE_BIT

Economy/energy star bit

enum esp_zb_zcl_thermostat_setpoint_raise_lower_mode_t

Values for Mode field for SetpointRaiseLower.

Values:

enumerator ESP_ZB_ZCL_THERMOSTAT_SETPOINT_RAISE_LOWER_MODE_HEAT

Heat value

enumerator ESP_ZB_ZCL_THERMOSTAT_SETPOINT_RAISE_LOWER_MODE_COOL

Cool value

enumerator ESP_ZB_ZCL_THERMOSTAT_SETPOINT_RAISE_LOWER_MODE_BOTH

Both (Heat and Cool) value

enum esp_zb_zcl_thermostat_weekly_schedule_mode_for_seq_t

Values for Mode for Sequence field.

Values:

enumerator ESP_ZB_ZCL_THERMOSTAT_WEEKLY_SCHEDULE_MODE_FOR_SEQ_HEAT

Heat value

enumerator ESP_ZB_ZCL_THERMOSTAT_WEEKLY_SCHEDULE_MODE_FOR_SEQ_COOL

Cool value

enumerator ESP_ZB_ZCL_THERMOSTAT_WEEKLY_SCHEDULE_MODE_FOR_SEQ_BOTH

Both (Heat and Cool) value

enum esp_zb_zcl_thermostat_day_of_week_t

Value for Day of Week.

Values:

enumerator ESP_ZB_ZCL_THERMOSTAT_DAY_OF_WEEK_SUNDAY

SUNDAY

enumerator ESP_ZB_ZCL_THERMOSTAT_DAY_OF_WEEK_MONDAY

MONDAY

enumerator ESP_ZB_ZCL_THERMOSTAT_DAY_OF_WEEK_TUESDAY

TUESDAY

enumerator ESP_ZB_ZCL_THERMOSTAT_DAY_OF_WEEK_WEDNESDAY

WEDNESDAY

enumerator ESP_ZB_ZCL_THERMOSTAT_DAY_OF_WEEK_THURSDAY

THURSDAY

enumerator ESP_ZB_ZCL_THERMOSTAT_DAY_OF_WEEK_FRIDAY

FRIDAY

enumerator ESP_ZB_ZCL_THERMOSTAT_DAY_OF_WEEK_SATURDAY

SATURDAY

enumerator ESP_ZB_ZCL_THERMOSTAT_DAY_OF_WEEK_VACATION

VACATION