5.2.6.3.4. ZCL HVAC Clusters

This section provides the HVAC clusters implementations in ZCL of ESP Zigbee Core.

5.2.6.3.4.1. Thermostat

5.2.6.3.4.1.1. Header File

5.2.6.3.4.1.2. Functions

ezb_err_t ezb_zcl_thermostat_cluster_desc_add_attr(ezb_zcl_cluster_desc_t cluster_desc, uint16_t attr_id, const void *value)

Add an attribute to an thermostat cluster descriptor.

Parameters:

  • cluster_desc -- [in] The thermostat cluster descriptor.

  • attr_id -- [in] The identifier of the attribute to be added to cluster_desc.

  • value -- [in] The pointer to the initial value of the attribute.

Returns:

Error code.

ezb_zcl_cluster_desc_t ezb_zcl_thermostat_create_cluster_desc(const void *cluster_cfg, uint8_t role_mask)

Create an thermostat cluster descriptor.

Parameters:

  • cluster_cfg -- [in] The pointer to the thermostat cluster configuration structure. Use ezb_zcl_thermostat_cluster_server_config_t for EZB_ZCL_CLUSTER_SERVER, use ezb_zcl_thermostat_cluster_client_config_t for EZB_ZCL_CLUSTER_CLIENT, or use NULL for default configuration of the stack based on the role_mask.

  • role_mask -- [in] The role of the cluster to create.

Returns:

Created cluster descriptor.

void ezb_zcl_thermostat_cluster_client_init(uint8_t ep_id)

Initialize the Thermostat cluster client role for a given endpoint.

Parameters:

ep_id -- [in] The identifier of the endpoint hosting the cluster that needs initialization.

void ezb_zcl_thermostat_cluster_server_init(uint8_t ep_id)

Initialize the Thermostat cluster server role for a given endpoint.

Parameters:

ep_id -- [in] The identifier of the endpoint hosting the cluster that needs de-initialization.

5.2.6.3.4.1.3. Structures

struct ezb_zcl_thermostat_cluster_server_config_s

Configuration mandatory attributes for the Thermostat server cluster.

Public Members

int16_t local_temperature

Configurable mandatory LocalTemperature attribute

uint8_t control_sequence_of_operation

Configurable mandatory ControlSequenceOfOperation attribute

uint8_t system_mode

Configurable mandatory SystemMode attribute

5.2.6.3.4.1.4. Macros

EZB_ZCL_THERMOSTAT_CLUSTER_REVISION

Cluster Revision of the thermostat cluster implementation.

EZB_ZCL_THERMOSTAT_LOCAL_TEMPERATURE_DEFAULT_VALUE

Default value of LocalTemperature in Thermostat cluster.

EZB_ZCL_THERMOSTAT_LOCAL_TEMPERATURE_MIN_VALUE

Minimum value of LocalTemperature in Thermostat cluster.

EZB_ZCL_THERMOSTAT_LOCAL_TEMPERATURE_MAX_VALUE

Maximum value of LocalTemperature in Thermostat cluster.

EZB_ZCL_THERMOSTAT_OUTDOOR_TEMPERATURE_DEFAULT_VALUE

Default value of OutdoorTemperature in Thermostat cluster.

EZB_ZCL_THERMOSTAT_OUTDOOR_TEMPERATURE_MIN_VALUE

Minimum value of OutdoorTemperature in Thermostat cluster.

EZB_ZCL_THERMOSTAT_OUTDOOR_TEMPERATURE_MAX_VALUE

Maximum value of OutdoorTemperature in Thermostat cluster.

EZB_ZCL_THERMOSTAT_OCCUPANCY_DEFAULT_VALUE

Default value of Occupancy in Thermostat cluster.

EZB_ZCL_THERMOSTAT_ABS_MIN_HEAT_SETPOINT_LIMIT_DEFAULT_VALUE

Default value of AbsMinHeatSetpointLimit in Thermostat cluster.

EZB_ZCL_THERMOSTAT_ABS_MIN_HEAT_SETPOINT_LIMIT_MIN_VALUE

Minimum value of AbsMinHeatSetpointLimit in Thermostat cluster.

EZB_ZCL_THERMOSTAT_ABS_MIN_HEAT_SETPOINT_LIMIT_MAX_VALUE

Maximum value of AbsMinHeatSetpointLimit in Thermostat cluster.

EZB_ZCL_THERMOSTAT_ABS_MAX_HEAT_SETPOINT_LIMIT_DEFAULT_VALUE

Default value of AbsMaxHeatSetpointLimit in Thermostat cluster.

EZB_ZCL_THERMOSTAT_ABS_MAX_HEAT_SETPOINT_LIMIT_MIN_VALUE

Minimum value of AbsMaxHeatSetpointLimit in Thermostat cluster.

EZB_ZCL_THERMOSTAT_ABS_MAX_HEAT_SETPOINT_LIMIT_MAX_VALUE

Maximum value of AbsMaxHeatSetpointLimit in Thermostat cluster.

EZB_ZCL_THERMOSTAT_ABS_MIN_COOL_SETPOINT_LIMIT_DEFAULT_VALUE

Default value of AbsMinCoolSetpointLimit in Thermostat cluster.

EZB_ZCL_THERMOSTAT_ABS_MIN_COOL_SETPOINT_LIMIT_MIN_VALUE

Minimum value of AbsMinCoolSetpointLimit in Thermostat cluster.

EZB_ZCL_THERMOSTAT_ABS_MIN_COOL_SETPOINT_LIMIT_MAX_VALUE

Maximum value of AbsMinCoolSetpointLimit in Thermostat cluster.

EZB_ZCL_THERMOSTAT_ABS_MAX_COOL_SETPOINT_LIMIT_DEFAULT_VALUE

Default value of AbsMaxCoolSetpointLimit in Thermostat cluster.

EZB_ZCL_THERMOSTAT_ABS_MAX_COOL_SETPOINT_LIMIT_MIN_VALUE

Minimum value of AbsMaxCoolSetpointLimit in Thermostat cluster.

EZB_ZCL_THERMOSTAT_ABS_MAX_COOL_SETPOINT_LIMIT_MAX_VALUE

Maximum value of AbsMaxCoolSetpointLimit in Thermostat cluster.

EZB_ZCL_THERMOSTAT_PI_COOLING_DEMAND_MIN_VALUE

Minimum value of PICoolingDemand in Thermostat cluster.

EZB_ZCL_THERMOSTAT_PI_COOLING_DEMAND_MAX_VALUE

Maximum value of PICoolingDemand in Thermostat cluster.

EZB_ZCL_THERMOSTAT_PI_HEATING_DEMAND_MIN_VALUE

Minimum value of PIHeatingDemand in Thermostat cluster.

EZB_ZCL_THERMOSTAT_PI_HEATING_DEMAND_MAX_VALUE

Maximum value of PIHeatingDemand in Thermostat cluster.

EZB_ZCL_THERMOSTAT_HVAC_SYSTEM_TYPE_CONFIGURATION_DEFAULT_VALUE

Default value of HVACSystemTypeConfiguration in Thermostat cluster.

EZB_ZCL_THERMOSTAT_LOCAL_TEMPERATURE_CALIBRATION_DEFAULT_VALUE

Default value of LocalTemperatureCalibration in Thermostat cluster.

EZB_ZCL_THERMOSTAT_LOCAL_TEMPERATURE_CALIBRATION_MIN_VALUE

Minimum value of LocalTemperatureCalibration in Thermostat cluster.

EZB_ZCL_THERMOSTAT_LOCAL_TEMPERATURE_CALIBRATION_MAX_VALUE

Maximum value of LocalTemperatureCalibration in Thermostat cluster.

EZB_ZCL_THERMOSTAT_OCCUPIED_COOLING_SETPOINT_DEFAULT_VALUE

Default value of OccupiedCoolingSetpoint in Thermostat cluster.

EZB_ZCL_THERMOSTAT_OCCUPIED_COOLING_SETPOINT_MIN_VALUE

Minimum value of OccupiedCoolingSetpoint in Thermostat cluster.

EZB_ZCL_THERMOSTAT_OCCUPIED_COOLING_SETPOINT_MAX_VALUE

Maximum value of OccupiedCoolingSetpoint in Thermostat cluster.

EZB_ZCL_THERMOSTAT_OCCUPIED_HEATING_SETPOINT_DEFAULT_VALUE

Default value of OccupiedHeatingSetpoint in Thermostat cluster.

EZB_ZCL_THERMOSTAT_OCCUPIED_HEATING_SETPOINT_MIN_VALUE

Minimum value of OccupiedHeatingSetpoint in Thermostat cluster.

EZB_ZCL_THERMOSTAT_OCCUPIED_HEATING_SETPOINT_MAX_VALUE

Maximum value of OccupiedHeatingSetpoint in Thermostat cluster.

EZB_ZCL_THERMOSTAT_UNOCCUPIED_COOLING_SETPOINT_DEFAULT_VALUE

Default value of UnoccupiedCoolingSetpoint in Thermostat cluster.

EZB_ZCL_THERMOSTAT_UNOCCUPIED_COOLING_SETPOINT_MIN_VALUE

Minimum value of UnoccupiedCoolingSetpoint in Thermostat cluster.

EZB_ZCL_THERMOSTAT_UNOCCUPIED_COOLING_SETPOINT_MAX_VALUE

Maximum value of UnoccupiedCoolingSetpoint in Thermostat cluster.

EZB_ZCL_THERMOSTAT_UNOCCUPIED_HEATING_SETPOINT_DEFAULT_VALUE

Default value of UnoccupiedHeatingSetpoint in Thermostat cluster.

EZB_ZCL_THERMOSTAT_UNOCCUPIED_HEATING_SETPOINT_MIN_VALUE

Minimum value of UnoccupiedHeatingSetpoint in Thermostat cluster.

EZB_ZCL_THERMOSTAT_UNOCCUPIED_HEATING_SETPOINT_MAX_VALUE

Maximum value of UnoccupiedHeatingSetpoint in Thermostat cluster.

EZB_ZCL_THERMOSTAT_MIN_HEAT_SETPOINT_LIMIT_DEFAULT_VALUE

Default value of MinHeatSetpointLimit in Thermostat cluster.

EZB_ZCL_THERMOSTAT_MIN_HEAT_SETPOINT_LIMIT_MIN_VALUE

Minimum value of MinHeatSetpointLimit in Thermostat cluster.

EZB_ZCL_THERMOSTAT_MIN_HEAT_SETPOINT_LIMIT_MAX_VALUE

Maximum value of MinHeatSetpointLimit in Thermostat cluster.

EZB_ZCL_THERMOSTAT_MAX_HEAT_SETPOINT_LIMIT_DEFAULT_VALUE

Default value of MaxHeatSetpointLimit in Thermostat cluster.

EZB_ZCL_THERMOSTAT_MAX_HEAT_SETPOINT_LIMIT_MIN_VALUE

Minimum value of MaxHeatSetpointLimit in Thermostat cluster.

EZB_ZCL_THERMOSTAT_MAX_HEAT_SETPOINT_LIMIT_MAX_VALUE

Maximum value of MaxHeatSetpointLimit in Thermostat cluster.

EZB_ZCL_THERMOSTAT_MIN_COOL_SETPOINT_LIMIT_DEFAULT_VALUE

Default value of MinCoolSetpointLimit in Thermostat cluster.

EZB_ZCL_THERMOSTAT_MIN_COOL_SETPOINT_LIMIT_MIN_VALUE

Minimum value of MinCoolSetpointLimit in Thermostat cluster.

EZB_ZCL_THERMOSTAT_MIN_COOL_SETPOINT_LIMIT_MAX_VALUE

Maximum value of MinCoolSetpointLimit in Thermostat cluster.

EZB_ZCL_THERMOSTAT_MAX_COOL_SETPOINT_LIMIT_DEFAULT_VALUE

Default value of MaxCoolSetpointLimit in Thermostat cluster.

EZB_ZCL_THERMOSTAT_MAX_COOL_SETPOINT_LIMIT_MIN_VALUE

Minimum value of MaxCoolSetpointLimit in Thermostat cluster.

EZB_ZCL_THERMOSTAT_MAX_COOL_SETPOINT_LIMIT_MAX_VALUE

Maximum value of MaxCoolSetpointLimit in Thermostat cluster.

EZB_ZCL_THERMOSTAT_MIN_SETPOINT_DEAD_BAND_DEFAULT_VALUE

Default value of MinSetpointDeadBand in Thermostat cluster.

EZB_ZCL_THERMOSTAT_MIN_SETPOINT_DEAD_BAND_MIN_VALUE

Minimum value of MinSetpointDeadBand in Thermostat cluster.

EZB_ZCL_THERMOSTAT_MIN_SETPOINT_DEAD_BAND_MAX_VALUE

Maximum value of MinSetpointDeadBand in Thermostat cluster.

EZB_ZCL_THERMOSTAT_REMOTE_SENSING_DEFAULT_VALUE

Default value of RemoteSensing in Thermostat cluster.

EZB_ZCL_THERMOSTAT_REMOTE_SENSING_MIN_VALUE

Minimum value of RemoteSensing in Thermostat cluster.

EZB_ZCL_THERMOSTAT_REMOTE_SENSING_MAX_VALUE

Maximum value of RemoteSensing in Thermostat cluster.

EZB_ZCL_THERMOSTAT_CONTROL_SEQUENCE_OF_OPERATION_DEFAULT_VALUE

Default value of ControlSequenceOfOperation in Thermostat cluster.

EZB_ZCL_THERMOSTAT_SYSTEM_MODE_DEFAULT_VALUE

Default value of SystemMode in Thermostat cluster.

EZB_ZCL_THERMOSTAT_ALARM_MASK_DEFAULT_VALUE

Default value of AlarmMask in Thermostat cluster.

EZB_ZCL_THERMOSTAT_THERMOSTAT_RUNNING_MODE_DEFAULT_VALUE

Default value of ThermostatRunningMode in Thermostat cluster.

EZB_ZCL_THERMOSTAT_NUMBER_OF_WEEKLY_TRANSITIONS_DEFAULT_VALUE

Default value of NumberOfWeeklyTransitions in Thermostat cluster.

EZB_ZCL_THERMOSTAT_NUMBER_OF_WEEKLY_TRANSITIONS_MIN_VALUE

Minimum value of NumberOfWeeklyTransitions in Thermostat cluster.

EZB_ZCL_THERMOSTAT_NUMBER_OF_WEEKLY_TRANSITIONS_MAX_VALUE

Maximum value of NumberOfWeeklyTransitions in Thermostat cluster.

EZB_ZCL_THERMOSTAT_NUMBER_OF_DAILY_TRANSITIONS_DEFAULT_VALUE

Default value of NumberOfDailyTransitions in Thermostat cluster.

EZB_ZCL_THERMOSTAT_NUMBER_OF_DAILY_TRANSITIONS_MIN_VALUE

Minimum value of NumberOfDailyTransitions in Thermostat cluster.

EZB_ZCL_THERMOSTAT_NUMBER_OF_DAILY_TRANSITIONS_MAX_VALUE

Maximum value of NumberOfDailyTransitions in Thermostat cluster.

EZB_ZCL_THERMOSTAT_TEMPERATURE_SETPOINT_HOLD_DEFAULT_VALUE

Default value of TemperatureSetpointHold in Thermostat cluster.

EZB_ZCL_THERMOSTAT_TEMPERATURE_SETPOINT_HOLD_DURATION_DEFAULT_VALUE

Default value of TemperatureSetpointHoldDuration in Thermostat cluster.

EZB_ZCL_THERMOSTAT_TEMPERATURE_SETPOINT_HOLD_DURATION_MIN_VALUE

Minimum value of TemperatureSetpointHoldDuration in Thermostat cluster.

EZB_ZCL_THERMOSTAT_TEMPERATURE_SETPOINT_HOLD_DURATION_MAX_VALUE

Maximum value of TemperatureSetpointHoldDuration in Thermostat cluster.

EZB_ZCL_THERMOSTAT_THERMOSTAT_PROGRAMMING_OPERATION_MODE_DEFAULT_VALUE

Default value of ThermostatProgrammingOperationMode in Thermostat cluster.

EZB_ZCL_THERMOSTAT_SETPOINT_CHANGE_SOURCE_DEFAULT_VALUE

Default value of SetpointChangeSource in Thermostat cluster.

EZB_ZCL_THERMOSTAT_SETPOINT_CHANGE_SOURCE_MIN_VALUE

Minimum value of SetpointChangeSource in Thermostat cluster.

EZB_ZCL_THERMOSTAT_SETPOINT_CHANGE_SOURCE_MAX_VALUE

Maximum value of SetpointChangeSource in Thermostat cluster.

EZB_ZCL_THERMOSTAT_SETPOINT_CHANGE_AMOUNT_DEFAULT_VALUE

Default value of SetpointChangeAmount in Thermostat cluster.

EZB_ZCL_THERMOSTAT_SETPOINT_CHANGE_AMOUNT_MIN_VALUE

Minimum value of SetpointChangeAmount in Thermostat cluster.

EZB_ZCL_THERMOSTAT_SETPOINT_CHANGE_AMOUNT_MAX_VALUE

Maximum value of SetpointChangeAmount in Thermostat cluster.

EZB_ZCL_THERMOSTAT_SETPOINT_CHANGE_SOURCE_TIMESTAMP_DEFAULT_VALUE

Default value of SetpointChangeSourceTimestamp in Thermostat cluster.

EZB_ZCL_THERMOSTAT_SETPOINT_CHANGE_SOURCE_TIMESTAMP_MIN_VALUE

Minimum value of SetpointChangeSourceTimestamp in Thermostat cluster.

EZB_ZCL_THERMOSTAT_SETPOINT_CHANGE_SOURCE_TIMESTAMP_MAX_VALUE

Maximum value of SetpointChangeSourceTimestamp in Thermostat cluster.

EZB_ZCL_THERMOSTAT_OCCUPIED_SETBACK_DEFAULT_VALUE

Default value of OccupiedSetback in Thermostat cluster.

EZB_ZCL_THERMOSTAT_OCCUPIED_SETBACK_MIN_VALUE

Minimum value of OccupiedSetback in Thermostat cluster.

EZB_ZCL_THERMOSTAT_OCCUPIED_SETBACK_MAX_VALUE

Maximum value of OccupiedSetback in Thermostat cluster.

EZB_ZCL_THERMOSTAT_OCCUPIED_SETBACK_MIN_DEFAULT_VALUE

Default value of OccupiedSetbackMin in Thermostat cluster.

EZB_ZCL_THERMOSTAT_OCCUPIED_SETBACK_MIN_MIN_VALUE

Minimum value of OccupiedSetbackMin in Thermostat cluster.

EZB_ZCL_THERMOSTAT_OCCUPIED_SETBACK_MIN_MAX_VALUE

Maximum value of OccupiedSetbackMin in Thermostat cluster.

EZB_ZCL_THERMOSTAT_OCCUPIED_SETBACK_MAX_DEFAULT_VALUE

Default value of OccupiedSetbackMax in Thermostat cluster.

EZB_ZCL_THERMOSTAT_OCCUPIED_SETBACK_MAX_MIN_VALUE

Minimum value of OccupiedSetbackMax in Thermostat cluster.

EZB_ZCL_THERMOSTAT_OCCUPIED_SETBACK_MAX_MAX_VALUE

Maximum value of OccupiedSetbackMax in Thermostat cluster.

EZB_ZCL_THERMOSTAT_UNOCCUPIED_SETBACK_DEFAULT_VALUE

Default value of UnoccupiedSetback in Thermostat cluster.

EZB_ZCL_THERMOSTAT_UNOCCUPIED_SETBACK_MIN_VALUE

Minimum value of UnoccupiedSetback in Thermostat cluster.

EZB_ZCL_THERMOSTAT_UNOCCUPIED_SETBACK_MAX_VALUE

Maximum value of UnoccupiedSetback in Thermostat cluster.

EZB_ZCL_THERMOSTAT_UNOCCUPIED_SETBACK_MIN_DEFAULT_VALUE

Default value of UnoccupiedSetbackMin in Thermostat cluster.

EZB_ZCL_THERMOSTAT_UNOCCUPIED_SETBACK_MIN_MIN_VALUE

Minimum value of UnoccupiedSetbackMin in Thermostat cluster.

EZB_ZCL_THERMOSTAT_UNOCCUPIED_SETBACK_MIN_MAX_VALUE

Maximum value of UnoccupiedSetbackMin in Thermostat cluster.

EZB_ZCL_THERMOSTAT_UNOCCUPIED_SETBACK_MAX_DEFAULT_VALUE

Default value of UnoccupiedSetbackMax in Thermostat cluster.

EZB_ZCL_THERMOSTAT_UNOCCUPIED_SETBACK_MAX_MIN_VALUE

Minimum value of UnoccupiedSetbackMax in Thermostat cluster.

EZB_ZCL_THERMOSTAT_UNOCCUPIED_SETBACK_MAX_MAX_VALUE

Maximum value of UnoccupiedSetbackMax in Thermostat cluster.

EZB_ZCL_THERMOSTAT_EMERGENCY_HEAT_DELTA_DEFAULT_VALUE

Default value of EmergencyHeatDelta in Thermostat cluster.

EZB_ZCL_THERMOSTAT_EMERGENCY_HEAT_DELTA_MIN_VALUE

Minimum value of EmergencyHeatDelta in Thermostat cluster.

EZB_ZCL_THERMOSTAT_EMERGENCY_HEAT_DELTA_MAX_VALUE

Maximum value of EmergencyHeatDelta in Thermostat cluster.

EZB_ZCL_THERMOSTAT_AC_TYPE_DEFAULT_VALUE

Default value of ACType in Thermostat cluster.

EZB_ZCL_THERMOSTAT_AC_CAPACITY_DEFAULT_VALUE

Default value of ACCapacity in Thermostat cluster.

EZB_ZCL_THERMOSTAT_AC_CAPACITY_MIN_VALUE

Minimum value of ACCapacity in Thermostat cluster.

EZB_ZCL_THERMOSTAT_AC_CAPACITY_MAX_VALUE

Maximum value of ACCapacity in Thermostat cluster.

EZB_ZCL_THERMOSTAT_AC_REFRIGERANT_TYPE_DEFAULT_VALUE

Default value of ACRefrigerantType in Thermostat cluster.

EZB_ZCL_THERMOSTAT_AC_COMPRESSOR_TYPE_DEFAULT_VALUE

Default value of ACCompressorType in Thermostat cluster.

EZB_ZCL_THERMOSTAT_AC_ERROR_CODE_DEFAULT_VALUE

Default value of ACErrorCode in Thermostat cluster.

EZB_ZCL_THERMOSTAT_AC_ERROR_CODE_MIN_VALUE

Minimum value of ACErrorCode in Thermostat cluster.

EZB_ZCL_THERMOSTAT_AC_ERROR_CODE_MAX_VALUE

Maximum value of ACErrorCode in Thermostat cluster.

EZB_ZCL_THERMOSTAT_AC_LOUVER_POSITION_DEFAULT_VALUE

Default value of ACLouverPosition in Thermostat cluster.

EZB_ZCL_THERMOSTAT_AC_COIL_TEMPERATURE_DEFAULT_VALUE

Default value of ACCoilTemperature in Thermostat cluster.

EZB_ZCL_THERMOSTAT_AC_COIL_TEMPERATURE_MIN_VALUE

Minimum value of ACCoilTemperature in Thermostat cluster.

EZB_ZCL_THERMOSTAT_AC_COIL_TEMPERATURE_MAX_VALUE

Maximum value of ACCoilTemperature in Thermostat cluster.

EZB_ZCL_THERMOSTAT_AC_CAPACITY_FORMAT_DEFAULT_VALUE

Default value of ACCapacityFormat in Thermostat cluster.

EZB_ZCL_CLUSTER_ID_THERMOSTAT_CLIENT_ROLE_INIT
EZB_ZCL_CLUSTER_ID_THERMOSTAT_SERVER_ROLE_INIT

5.2.6.3.4.1.5. Type Definitions

typedef struct ezb_zcl_thermostat_cluster_server_config_s ezb_zcl_thermostat_cluster_server_config_t

Configuration mandatory attributes for the Thermostat server cluster.

typedef ezb_zcl_thermostat_cluster_server_config_t ezb_zcl_thermostat_cluster_config_t

5.2.6.3.4.1.6. Enumerations

enum ezb_zcl_thermostat_server_attr_t

Attribute identifiers for the thermostat server cluster.

Values:

enumerator EZB_ZCL_ATTR_THERMOSTAT_LOCAL_TEMPERATURE_ID

LocalTemperature attribute.

enumerator EZB_ZCL_ATTR_THERMOSTAT_OUTDOOR_TEMPERATURE_ID

OutdoorTemperature attribute.

enumerator EZB_ZCL_ATTR_THERMOSTAT_OCCUPANCY_ID

Occupancy attribute.

enumerator EZB_ZCL_ATTR_THERMOSTAT_ABS_MIN_HEAT_SETPOINT_LIMIT_ID

AbsMinHeatSetpointLimit attribute.

enumerator EZB_ZCL_ATTR_THERMOSTAT_ABS_MAX_HEAT_SETPOINT_LIMIT_ID

AbsMaxHeatSetpointLimit attribute.

enumerator EZB_ZCL_ATTR_THERMOSTAT_ABS_MIN_COOL_SETPOINT_LIMIT_ID

AbsMinCoolSetpointLimit attribute.

enumerator EZB_ZCL_ATTR_THERMOSTAT_ABS_MAX_COOL_SETPOINT_LIMIT_ID

AbsMaxCoolSetpointLimit attribute.

enumerator EZB_ZCL_ATTR_THERMOSTAT_PI_COOLING_DEMAND_ID

PICoolingDemand attribute.

enumerator EZB_ZCL_ATTR_THERMOSTAT_PI_HEATING_DEMAND_ID

PIHeatingDemand attribute.

enumerator EZB_ZCL_ATTR_THERMOSTAT_HVAC_SYSTEM_TYPE_CONFIGURATION_ID

HVACSystemTypeConfiguration attribute.

enumerator EZB_ZCL_ATTR_THERMOSTAT_LOCAL_TEMPERATURE_CALIBRATION_ID

LocalTemperatureCalibration attribute.

enumerator EZB_ZCL_ATTR_THERMOSTAT_OCCUPIED_COOLING_SETPOINT_ID

OccupiedCoolingSetpoint attribute.

enumerator EZB_ZCL_ATTR_THERMOSTAT_OCCUPIED_HEATING_SETPOINT_ID

OccupiedHeatingSetpoint attribute.

enumerator EZB_ZCL_ATTR_THERMOSTAT_UNOCCUPIED_COOLING_SETPOINT_ID

UnoccupiedCoolingSetpoint attribute.

enumerator EZB_ZCL_ATTR_THERMOSTAT_UNOCCUPIED_HEATING_SETPOINT_ID

UnoccupiedHeatingSetpoint attribute.

enumerator EZB_ZCL_ATTR_THERMOSTAT_MIN_HEAT_SETPOINT_LIMIT_ID

MinHeatSetpointLimit attribute.

enumerator EZB_ZCL_ATTR_THERMOSTAT_MAX_HEAT_SETPOINT_LIMIT_ID

MaxHeatSetpointLimit attribute.

enumerator EZB_ZCL_ATTR_THERMOSTAT_MIN_COOL_SETPOINT_LIMIT_ID

MinCoolSetpointLimit attribute.

enumerator EZB_ZCL_ATTR_THERMOSTAT_MAX_COOL_SETPOINT_LIMIT_ID

MaxCoolSetpointLimit attribute.

enumerator EZB_ZCL_ATTR_THERMOSTAT_MIN_SETPOINT_DEAD_BAND_ID

MinSetpointDeadBand attribute.

enumerator EZB_ZCL_ATTR_THERMOSTAT_REMOTE_SENSING_ID

RemoteSensing attribute.

enumerator EZB_ZCL_ATTR_THERMOSTAT_CONTROL_SEQUENCE_OF_OPERATION_ID

ControlSequenceOfOperation attribute.

enumerator EZB_ZCL_ATTR_THERMOSTAT_SYSTEM_MODE_ID

SystemMode attribute.

enumerator EZB_ZCL_ATTR_THERMOSTAT_ALARM_MASK_ID

AlarmMask attribute.

enumerator EZB_ZCL_ATTR_THERMOSTAT_THERMOSTAT_RUNNING_MODE_ID

ThermostatRunningMode attribute.

enumerator EZB_ZCL_ATTR_THERMOSTAT_START_OF_WEEK_ID

StartOfWeek attribute.

enumerator EZB_ZCL_ATTR_THERMOSTAT_NUMBER_OF_WEEKLY_TRANSITIONS_ID

NumberOfWeeklyTransitions attribute.

enumerator EZB_ZCL_ATTR_THERMOSTAT_NUMBER_OF_DAILY_TRANSITIONS_ID

NumberOfDailyTransitions attribute.

enumerator EZB_ZCL_ATTR_THERMOSTAT_TEMPERATURE_SETPOINT_HOLD_ID

TemperatureSetpointHold attribute.

enumerator EZB_ZCL_ATTR_THERMOSTAT_TEMPERATURE_SETPOINT_HOLD_DURATION_ID

TemperatureSetpointHoldDuration attribute.

enumerator EZB_ZCL_ATTR_THERMOSTAT_THERMOSTAT_PROGRAMMING_OPERATION_MODE_ID

ThermostatProgrammingOperationMode attribute.

enumerator EZB_ZCL_ATTR_THERMOSTAT_THERMOSTAT_RUNNING_STATE_ID

ThermostatRunningState attribute.

enumerator EZB_ZCL_ATTR_THERMOSTAT_SETPOINT_CHANGE_SOURCE_ID

SetpointChangeSource attribute.

enumerator EZB_ZCL_ATTR_THERMOSTAT_SETPOINT_CHANGE_AMOUNT_ID

SetpointChangeAmount attribute.

enumerator EZB_ZCL_ATTR_THERMOSTAT_SETPOINT_CHANGE_SOURCE_TIMESTAMP_ID

SetpointChangeSourceTimestamp attribute.

enumerator EZB_ZCL_ATTR_THERMOSTAT_OCCUPIED_SETBACK_ID

OccupiedSetback attribute.

enumerator EZB_ZCL_ATTR_THERMOSTAT_OCCUPIED_SETBACK_MIN_ID

OccupiedSetbackMin attribute.

enumerator EZB_ZCL_ATTR_THERMOSTAT_OCCUPIED_SETBACK_MAX_ID

OccupiedSetbackMax attribute.

enumerator EZB_ZCL_ATTR_THERMOSTAT_UNOCCUPIED_SETBACK_ID

UnoccupiedSetback attribute.

enumerator EZB_ZCL_ATTR_THERMOSTAT_UNOCCUPIED_SETBACK_MIN_ID

UnoccupiedSetbackMin attribute.

enumerator EZB_ZCL_ATTR_THERMOSTAT_UNOCCUPIED_SETBACK_MAX_ID

UnoccupiedSetbackMax attribute.

enumerator EZB_ZCL_ATTR_THERMOSTAT_EMERGENCY_HEAT_DELTA_ID

EmergencyHeatDelta attribute.

enumerator EZB_ZCL_ATTR_THERMOSTAT_AC_TYPE_ID

ACType attribute.

enumerator EZB_ZCL_ATTR_THERMOSTAT_AC_CAPACITY_ID

ACCapacity attribute.

enumerator EZB_ZCL_ATTR_THERMOSTAT_AC_REFRIGERANT_TYPE_ID

ACRefrigerantType attribute.

enumerator EZB_ZCL_ATTR_THERMOSTAT_AC_COMPRESSOR_TYPE_ID

ACCompressorType attribute.

enumerator EZB_ZCL_ATTR_THERMOSTAT_AC_ERROR_CODE_ID

ACErrorCode attribute.

enumerator EZB_ZCL_ATTR_THERMOSTAT_AC_LOUVER_POSITION_ID

ACLouverPosition attribute.

enumerator EZB_ZCL_ATTR_THERMOSTAT_AC_COIL_TEMPERATURE_ID

ACCoilTemperature attribute.

enumerator EZB_ZCL_ATTR_THERMOSTAT_AC_CAPACITY_FORMAT_ID

ACCapacityFormat attribute.

enumerator EZB_ZCL_ATTR_THERMOSTAT_SCHEDULE_CONTEXT_ID

ScheduleContext attribute.

enum ezb_zcl_thermostat_server_control_sequence_of_operation_t

Enumeration for ZCL ControlSequenceOfOperation attribute of Thermostat.

Values:

enumerator EZB_ZCL_THERMOSTAT_CONTROL_SEQUENCE_OF_OPERATION_COOLING_ONLY

CoolingOnly

enumerator EZB_ZCL_THERMOSTAT_CONTROL_SEQUENCE_OF_OPERATION_COOLING_WITH_REHEAT

CoolingWithReheat

enumerator EZB_ZCL_THERMOSTAT_CONTROL_SEQUENCE_OF_OPERATION_HEATING_ONLY

HeatingOnly

enumerator EZB_ZCL_THERMOSTAT_CONTROL_SEQUENCE_OF_OPERATION_HEATING_WITH_REHEAT

HeatingWithReheat

enumerator EZB_ZCL_THERMOSTAT_CONTROL_SEQUENCE_OF_OPERATION_COOLING_AND_HEATING4_PIPES

CoolingAndHeating4Pipes

enumerator EZB_ZCL_THERMOSTAT_CONTROL_SEQUENCE_OF_OPERATION_COOLING_AND_HEATING4_PIPES_WITH_REHEAT

CoolingAndHeating4PipesWithReheat

enum ezb_zcl_thermostat_server_system_mode_t

Enumeration for ZCL SystemMode attribute of Thermostat.

Values:

enumerator EZB_ZCL_THERMOSTAT_SYSTEM_MODE_OFF

Off

enumerator EZB_ZCL_THERMOSTAT_SYSTEM_MODE_AUTO

Auto

enumerator EZB_ZCL_THERMOSTAT_SYSTEM_MODE_COOL

Cool

enumerator EZB_ZCL_THERMOSTAT_SYSTEM_MODE_HEAT

Heat

enumerator EZB_ZCL_THERMOSTAT_SYSTEM_MODE_EMERGENCY_HEATING

EmergencyHeating

enumerator EZB_ZCL_THERMOSTAT_SYSTEM_MODE_PRECOOLING

Precooling

enumerator EZB_ZCL_THERMOSTAT_SYSTEM_MODE_FAN_ONLY

FanOnly

enumerator EZB_ZCL_THERMOSTAT_SYSTEM_MODE_DRY

Dry

enumerator EZB_ZCL_THERMOSTAT_SYSTEM_MODE_SLEEP

Sleep

enum ezb_zcl_thermostat_server_thermostat_running_mode_t

Enumeration for ZCL ThermostatRunningMode attribute of Thermostat.

Values:

enumerator EZB_ZCL_THERMOSTAT_THERMOSTAT_RUNNING_MODE_OFF

Off

enumerator EZB_ZCL_THERMOSTAT_THERMOSTAT_RUNNING_MODE_COOL

Cool

enumerator EZB_ZCL_THERMOSTAT_THERMOSTAT_RUNNING_MODE_HEAT

Heat

enum ezb_zcl_thermostat_server_start_of_week_t

Enumeration for ZCL StartOfWeek attribute of Thermostat.

Values:

enumerator EZB_ZCL_THERMOSTAT_START_OF_WEEK_SUNDAY

Sunday

enumerator EZB_ZCL_THERMOSTAT_START_OF_WEEK_MONDAY

Monday

enumerator EZB_ZCL_THERMOSTAT_START_OF_WEEK_TUESDAY

Tuesday

enumerator EZB_ZCL_THERMOSTAT_START_OF_WEEK_WEDNESDAY

Wednesday

enumerator EZB_ZCL_THERMOSTAT_START_OF_WEEK_THURSDAY

Thursday

enumerator EZB_ZCL_THERMOSTAT_START_OF_WEEK_FRIDAY

Friday

enumerator EZB_ZCL_THERMOSTAT_START_OF_WEEK_SATURDAY

Saturday

enum ezb_zcl_thermostat_server_temperature_setpoint_hold_t

Enumeration for ZCL TemperatureSetpointHold attribute of Thermostat.

Values:

enumerator EZB_ZCL_THERMOSTAT_TEMPERATURE_SETPOINT_HOLD_SETPOINT_HOLD_OFF

SetpointHoldOff

enumerator EZB_ZCL_THERMOSTAT_TEMPERATURE_SETPOINT_HOLD_SETPOINT_HOLD_ON

SetpointHoldOn

enum ezb_zcl_thermostat_server_setpoint_change_source_t

Enumeration for ZCL SetpointChangeSource attribute of Thermostat.

Values:

enumerator EZB_ZCL_THERMOSTAT_SETPOINT_CHANGE_SOURCE_MANUAL

Manual

enumerator EZB_ZCL_THERMOSTAT_SETPOINT_CHANGE_SOURCE_SCHEDULE_OR_INTERNAL_PROGRAMMING

ScheduleOrInternalProgramming

enumerator EZB_ZCL_THERMOSTAT_SETPOINT_CHANGE_SOURCE_EXTERNAL

External

enum ezb_zcl_thermostat_server_ac_type_t

Enumeration for ZCL ACType attribute of Thermostat.

Values:

enumerator EZB_ZCL_THERMOSTAT_AC_TYPE_COOLING_AND_FIXED_SPEED

CoolingAndFixedSpeed

enumerator EZB_ZCL_THERMOSTAT_AC_TYPE_HEAT_PUMP_AND_FIXED_SPEED

HeatPumpAndFixedSpeed

enumerator EZB_ZCL_THERMOSTAT_AC_TYPE_COOLING_AND_INVERTER

CoolingAndInverter

enumerator EZB_ZCL_THERMOSTAT_AC_TYPE_HEAT_PUMP_AND_INVERTER

HeatPumpAndInverter

enum ezb_zcl_thermostat_server_ac_refrigerant_type_t

Enumeration for ZCL ACRefrigerantType attribute of Thermostat.

Values:

enumerator EZB_ZCL_THERMOSTAT_AC_REFRIGERANT_TYPE_R22

R22

enumerator EZB_ZCL_THERMOSTAT_AC_REFRIGERANT_TYPE_R410A

R410a

enumerator EZB_ZCL_THERMOSTAT_AC_REFRIGERANT_TYPE_R407C

R407c

enum ezb_zcl_thermostat_server_ac_compressor_type_t

Enumeration for ZCL ACCompressorType attribute of Thermostat.

Values:

enumerator EZB_ZCL_THERMOSTAT_AC_COMPRESSOR_TYPE_T1

T1

enumerator EZB_ZCL_THERMOSTAT_AC_COMPRESSOR_TYPE_T2

T2

enumerator EZB_ZCL_THERMOSTAT_AC_COMPRESSOR_TYPE_T3

T3

enum ezb_zcl_thermostat_server_ac_louver_position_t

Enumeration for ZCL ACLouverPosition attribute of Thermostat.

Values:

enumerator EZB_ZCL_THERMOSTAT_AC_LOUVER_POSITION_FULLY_CLOSED

FullyClosed

enumerator EZB_ZCL_THERMOSTAT_AC_LOUVER_POSITION_FULLY_OPEN

FullyOpen

enumerator EZB_ZCL_THERMOSTAT_AC_LOUVER_POSITION_QUARTER_OPEN

QuarterOpen

enumerator EZB_ZCL_THERMOSTAT_AC_LOUVER_POSITION_HALF_OPEN

HalfOpen

enumerator EZB_ZCL_THERMOSTAT_AC_LOUVER_POSITION_THREE_QUARTERS_OPEN

ThreeQuartersOpen

enum ezb_zcl_thermostat_server_ac_capacity_format_t

Enumeration for ZCL ACCapacityFormat attribute of Thermostat.

Values:

enumerator EZB_ZCL_THERMOSTAT_AC_CAPACITY_FORMAT_BT_UH

BTUh

enum ezb_zcl_thermostat_server_occupancy_t

Bitmap for ZCL Occupancy attribute of Thermostat.

Values:

enumerator EZB_ZCL_THERMOSTAT_OCCUPANCY_OCCUPIED

Occupied

enum ezb_zcl_thermostat_server_hvac_system_type_configuration_t

Bitmap for ZCL HVACSystemTypeConfiguration attribute of Thermostat.

Values:

enumerator EZB_ZCL_THERMOSTAT_HVAC_SYSTEM_TYPE_CONFIGURATION_COOLING_SYSTEM_STAGE

CoolingSystemStage

enumerator EZB_ZCL_THERMOSTAT_HVAC_SYSTEM_TYPE_CONFIGURATION_HEATING_SYSTEM_STAGE

HeatingSystemStage

enumerator EZB_ZCL_THERMOSTAT_HVAC_SYSTEM_TYPE_CONFIGURATION_HEATING_SYSTEM_TYPE

HeatingSystemType

enumerator EZB_ZCL_THERMOSTAT_HVAC_SYSTEM_TYPE_CONFIGURATION_HEATING_FUEL_SOURCE

HeatingFuelSource

enum ezb_zcl_thermostat_server_remote_sensing_t

Bitmap for ZCL RemoteSensing attribute of Thermostat.

Values:

enumerator EZB_ZCL_THERMOSTAT_REMOTE_SENSING_LOCAL_TEMPERATURE_REMOTE

LocalTemperatureRemote

enumerator EZB_ZCL_THERMOSTAT_REMOTE_SENSING_OUTDOOR_TEMPERATURE_REMOTE

OutdoorTemperatureRemote

enumerator EZB_ZCL_THERMOSTAT_REMOTE_SENSING_OCCUPANCY_REMOTE

OccupancyRemote

enum ezb_zcl_thermostat_server_alarm_mask_t

Bitmap for ZCL AlarmMask attribute of Thermostat.

Values:

enumerator EZB_ZCL_THERMOSTAT_ALARM_MASK_INITIALIZATION_FAILURE

InitializationFailure

enumerator EZB_ZCL_THERMOSTAT_ALARM_MASK_HARDWARE_FAILURE

HardwareFailure

enumerator EZB_ZCL_THERMOSTAT_ALARM_MASK_SELF_CALIBRATION_FAILURE

SelfCalibrationFailure

enum ezb_zcl_thermostat_server_thermostat_programming_operation_mode_t

Bitmap for ZCL ThermostatProgrammingOperationMode attribute of Thermostat.

Values:

enumerator EZB_ZCL_THERMOSTAT_THERMOSTAT_PROGRAMMING_OPERATION_MODE_PROGRAMMING_MODE

ProgrammingMode

enumerator EZB_ZCL_THERMOSTAT_THERMOSTAT_PROGRAMMING_OPERATION_MODE_AUTO_OR_RECOVERY

AutoOrRecovery

enumerator EZB_ZCL_THERMOSTAT_THERMOSTAT_PROGRAMMING_OPERATION_MODE_ECONOMY_OR_ENERGY_STAR

EconomyOrEnergyStar

enum ezb_zcl_thermostat_server_thermostat_running_state_t

Bitmap for ZCL ThermostatRunningState attribute of Thermostat.

Values:

enumerator EZB_ZCL_THERMOSTAT_THERMOSTAT_RUNNING_STATE_HEAT_ON

HeatOn

enumerator EZB_ZCL_THERMOSTAT_THERMOSTAT_RUNNING_STATE_COOL_ON

CoolOn

enumerator EZB_ZCL_THERMOSTAT_THERMOSTAT_RUNNING_STATE_FAN_ON

FanOn

enumerator EZB_ZCL_THERMOSTAT_THERMOSTAT_RUNNING_STATE_HEAT_SECOND_STAGE_ON

HeatSecondStageOn

enumerator EZB_ZCL_THERMOSTAT_THERMOSTAT_RUNNING_STATE_COOL_SECOND_STAGE_ON

CoolSecondStageOn

enumerator EZB_ZCL_THERMOSTAT_THERMOSTAT_RUNNING_STATE_FAN_SECOND_STAGE_ON

FanSecondStageOn

enumerator EZB_ZCL_THERMOSTAT_THERMOSTAT_RUNNING_STATE_FAN_THIRD_STAGE_ON

FanThirdStageOn

enum ezb_zcl_thermostat_server_ac_error_code_t

Bitmap for ZCL ACErrorCode attribute of Thermostat.

Values:

enumerator EZB_ZCL_THERMOSTAT_AC_ERROR_CODE_COMPRESSOR_FAILURE_OR_REFRIGERANT_LEAKAGE

CompressorFailureOrRefrigerantLeakage

enumerator EZB_ZCL_THERMOSTAT_AC_ERROR_CODE_ROOM_TEMPERATURE_SENSOR_FAILURE

RoomTemperatureSensorFailure

enumerator EZB_ZCL_THERMOSTAT_AC_ERROR_CODE_OUTDOOR_TEMPERATURE_SENSOR_FAILURE

OutdoorTemperatureSensorFailure

enumerator EZB_ZCL_THERMOSTAT_AC_ERROR_CODE_INDOOR_COIL_TEMPERATURE_SENSOR_FAILURE

IndoorCoilTemperatureSensorFailure

enumerator EZB_ZCL_THERMOSTAT_AC_ERROR_CODE_FAN_FAILURE

FanFailure

enum ezb_zcl_thermostat_server_cmd_id_t

Received Command identifiers for the Thermostat cluster.

Values:

enumerator EZB_ZCL_CMD_THERMOSTAT_SETPOINT_RAISE_OR_LOWER_ID

SetpointRaiseOrLower command.

enumerator EZB_ZCL_CMD_THERMOSTAT_SET_WEEKLY_SCHEDULE_ID

SetWeeklySchedule command.

enumerator EZB_ZCL_CMD_THERMOSTAT_GET_WEEKLY_SCHEDULE_ID

GetWeeklySchedule command.

enumerator EZB_ZCL_CMD_THERMOSTAT_CLEAR_WEEKLY_SCHEDULE_ID

ClearWeeklySchedule command.

enumerator EZB_ZCL_CMD_THERMOSTAT_GET_RELAY_STATUS_LOG_ID

GetRelayStatusLog command.

enum ezb_zcl_thermostat_client_cmd_id_t

Received Command identifiers for the Thermostat cluster.

Values:

enumerator EZB_ZCL_CMD_THERMOSTAT_GET_WEEKLY_SCHEDULE_RESPONSE_ID

GetWeeklyScheduleResponse command.

enumerator EZB_ZCL_CMD_THERMOSTAT_GET_RELAY_STATUS_LOG_RESPONSE_ID

GetRelayStatusLogResponse command.

5.2.6.3.4.1.7. Header File

5.2.6.3.4.1.8. Functions

ezb_err_t ezb_zcl_thermostat_setpoint_raise_or_lower_cmd_req(const ezb_zcl_thermostat_setpoint_raise_or_lower_cmd_t *cmd_req)

Send ZCL Thermostat SetpointRaiseOrLower command request.

Parameters:

cmd_req -- Pointer to the SetpointRaiseOrLower command request structure, ezb_zcl_thermostat_setpoint_raise_or_lower_cmd_s.

Returns:

Error code.

ezb_err_t ezb_zcl_thermostat_set_weekly_schedule_cmd_req(const ezb_zcl_thermostat_set_weekly_schedule_cmd_t *cmd_req)

Send ZCL Thermostat SetWeeklySchedule command request.

Parameters:

cmd_req -- Pointer to the SetWeeklySchedule command request structure, ezb_zcl_thermostat_set_weekly_schedule_cmd_s.

Returns:

Error code.

ezb_err_t ezb_zcl_thermostat_get_weekly_schedule_cmd_req(const ezb_zcl_thermostat_get_weekly_schedule_cmd_t *cmd_req)

Send ZCL Thermostat GetWeeklySchedule command request.

Parameters:

cmd_req -- Pointer to the GetWeeklySchedule command request structure, ezb_zcl_thermostat_get_weekly_schedule_cmd_s.

Returns:

Error code.

ezb_err_t ezb_zcl_thermostat_clear_weekly_schedule_cmd_req(const ezb_zcl_thermostat_clear_weekly_schedule_cmd_t *cmd_req)

Send ZCL Thermostat ClearWeeklySchedule command request.

Parameters:

cmd_req -- Pointer to the ClearWeeklySchedule command request structure, ezb_zcl_thermostat_clear_weekly_schedule_cmd_s.

Returns:

Error code.

void ezb_zcl_thermostat_weekly_schedule_loop_start(uint8_t ep_id)

Start the weekly schedule loop.

Parameters:

ep_id -- Endpoint ID of the thermostat.

void ezb_zcl_thermostat_weekly_schedule_loop_stop(uint8_t ep_id)

Stop the weekly schedule loop.

Parameters:

ep_id -- Endpoint ID of the thermostat.

const ezb_zcl_thermostat_weekly_schedule_entry_t *ezb_zcl_thermostat_get_weekly_schedule_entry(uint8_t ep_id, uint8_t day_of_week)

Get the weekly schedule entry for a given day of week.

Parameters:

  • ep_id -- Endpoint ID of the thermostat.

  • day_of_week -- Day of week to get the entry for.

Returns:

Pointer to the weekly schedule entry for day_of_week, NULL if not found.

5.2.6.3.4.1.9. Structures

struct ezb_zcl_thermostat_setpoint_raise_or_lower_payload_s

Payload for the ZCL Thermostat SetpointRaiseOrLower command.

Public Members

uint8_t mode

Which setpoint to configure (HEAT/COOL/BOTH). see ezb_zcl_thermostat_setpoint_mode_t

int8_t amount

Amount to increase/decrease setpoint(s), in steps of 0.1°C.

struct ezb_zcl_thermostat_setpoint_raise_or_lower_cmd_s

Structure for the ZCL Thermostat SetpointRaiseOrLower command request.

Public Members

ezb_zcl_cluster_cmd_ctrl_t cmd_ctrl

Control information for the ZCL command.

ezb_zcl_thermostat_setpoint_raise_or_lower_payload_t payload

Payload of the command.

struct ezb_zcl_thermostat_weekly_schedule_transition_s

Structure for ZCL Thermostat WeeklySchedule transition.

Public Members

uint16_t start_time

Start time of the schedule transition for the day.

int16_t heat_setpoint

Heat setpoint (0.01°C resolution), if heat bit set in mode.

int16_t cool_setpoint

Cool setpoint (0.01°C resolution), if cool bit set in mode.

struct ezb_zcl_thermostat_set_weekly_schedule_payload_s

Payload for the ZCL Thermostat SetWeeklySchedule command.

Public Members

uint8_t num_of_trans

Number of transitions in this sequence.

uint8_t day_of_week

Day of week for all transitions in this payload.

uint8_t mode_for_req

How to decode setpoint fields of each transition.

ezb_zcl_thermostat_weekly_schedule_transition_t *transitions

Sequence of transitions to apply.

struct ezb_zcl_thermostat_weekly_schedule_entry_s

Structure for the entry of Thermostat Weekly Schedule.

Public Members

uint8_t mode_of_transition

Mode of the transition.

uint8_t num_of_transition

Number of transitions in the entry.

ezb_zcl_thermostat_weekly_schedule_transition_t *transitions

Transitions in the entry.

struct ezb_zcl_thermostat_set_weekly_schedule_cmd_s

Structure for the ZCL Thermostat SetWeeklySchedule command request.

Public Members

ezb_zcl_cluster_cmd_ctrl_t cmd_ctrl

Control information for the ZCL command.

ezb_zcl_thermostat_set_weekly_schedule_payload_t payload

Payload of the command.

struct ezb_zcl_thermostat_get_weekly_schedule_payload_s

Payload for the ZCL Thermostat GetWeeklySchedule command.

Public Members

uint8_t days_to_return

Number of days to return in the response.

uint8_t mode_to_return

Mode to return in the response. see ezb_zcl_thermostat_setpoint_mode_t

struct ezb_zcl_thermostat_get_weekly_schedule_cmd_s

Structure for the ZCL Thermostat GetWeeklySchedule command request.

Public Members

ezb_zcl_cluster_cmd_ctrl_t cmd_ctrl

Control information for the ZCL command.

ezb_zcl_thermostat_get_weekly_schedule_payload_t payload

Payload of the command.

struct ezb_zcl_thermostat_clear_weekly_schedule_cmd_s

Structure for the ZCL Thermostat ClearWeeklySchedule command request.

Public Members

ezb_zcl_cluster_cmd_ctrl_t cmd_ctrl

Control information for the ZCL command.

struct ezb_zcl_thermostat_setpoint_message_s

Message for ZCL Thermostat setpoint (heat/cool).

Public Members

ezb_zcl_message_info_t info

Basic information about the ZCL message.

uint8_t mode

Which setpoint is configured (HEAT/COOL/BOTH). see ezb_zcl_thermostat_setpoint_mode_t

int16_t setpoint_cool

Cool setpoint (0.01°C resolution) to apply.

int16_t setpoint_heat

Heat setpoint (0.01°C resolution) to apply.

struct ezb_zcl_thermostat_setpoint_message_s in

Input: parsed fields from the request.

ezb_zcl_status_t result

Status of processing in application.

struct ezb_zcl_thermostat_setpoint_message_s out

Output: result to send back.

struct ezb_zcl_thermostat_set_weekly_schedule_message_s

Message for ZCL Thermostat SetWeeklySchedule.

Public Members

ezb_zcl_message_info_t info

Basic information about the ZCL message.

const ezb_zcl_cmd_hdr_t *header

Header of the command.

ezb_zcl_thermostat_set_weekly_schedule_payload_t *payload

Payload of the command.

struct ezb_zcl_thermostat_set_weekly_schedule_message_s in

Input: parsed fields from the request.

ezb_zcl_status_t result

Status of processing in application.

struct ezb_zcl_thermostat_set_weekly_schedule_message_s out

Output: result to send back.

struct ezb_zcl_thermostat_get_weekly_schedule_rsp_message_s

Message for ZCL Thermostat GetWeeklySchedule response.

Public Members

ezb_zcl_message_info_t info

Common information for Zigbee device callback.

const ezb_zcl_cmd_hdr_t *header

Header of the command.

ezb_zcl_thermostat_get_weekly_schedule_rsp_payload_t *payload

Response payload.

struct ezb_zcl_thermostat_get_weekly_schedule_rsp_message_s in

Input: parsed fields from the response.

ezb_zcl_status_t result

Status of processing in application.

struct ezb_zcl_thermostat_get_weekly_schedule_rsp_message_s out

Output: result to send back.

5.2.6.3.4.1.10. Macros

EZB_ZCL_THERMOSTAT_WEEKLY_SCHEDULE_MAX_TRANSITION_NUM

Maximum number of transitions for weekly schedule of ZCL Thermostat cluster.

EZB_ZCL_THERMOSTAT_SETPOINT_RAISE_LOWER_AMOUNT_UNIT

Unit of setpoint raise or lower amount of ZCL Thermostat cluster.

5.2.6.3.4.1.11. Type Definitions

typedef struct ezb_zcl_thermostat_setpoint_raise_or_lower_payload_s ezb_zcl_thermostat_setpoint_raise_or_lower_payload_t

Payload for the ZCL Thermostat SetpointRaiseOrLower command.

typedef struct ezb_zcl_thermostat_setpoint_raise_or_lower_cmd_s ezb_zcl_thermostat_setpoint_raise_or_lower_cmd_t

Structure for the ZCL Thermostat SetpointRaiseOrLower command request.

typedef struct ezb_zcl_thermostat_weekly_schedule_transition_s ezb_zcl_thermostat_weekly_schedule_transition_t

Structure for ZCL Thermostat WeeklySchedule transition.

typedef struct ezb_zcl_thermostat_set_weekly_schedule_payload_s ezb_zcl_thermostat_set_weekly_schedule_payload_t

Payload for the ZCL Thermostat SetWeeklySchedule command.

typedef struct ezb_zcl_thermostat_weekly_schedule_entry_s ezb_zcl_thermostat_weekly_schedule_entry_t

Structure for the entry of Thermostat Weekly Schedule.

typedef ezb_zcl_thermostat_set_weekly_schedule_payload_t ezb_zcl_thermostat_get_weekly_schedule_rsp_payload_t

Payload for the ZCL Thermostat GetWeeklySchedule response.

typedef struct ezb_zcl_thermostat_set_weekly_schedule_cmd_s ezb_zcl_thermostat_set_weekly_schedule_cmd_t

Structure for the ZCL Thermostat SetWeeklySchedule command request.

typedef struct ezb_zcl_thermostat_get_weekly_schedule_payload_s ezb_zcl_thermostat_get_weekly_schedule_payload_t

Payload for the ZCL Thermostat GetWeeklySchedule command.

typedef struct ezb_zcl_thermostat_get_weekly_schedule_cmd_s ezb_zcl_thermostat_get_weekly_schedule_cmd_t

Structure for the ZCL Thermostat GetWeeklySchedule command request.

typedef struct ezb_zcl_thermostat_clear_weekly_schedule_cmd_s ezb_zcl_thermostat_clear_weekly_schedule_cmd_t

Structure for the ZCL Thermostat ClearWeeklySchedule command request.

typedef struct ezb_zcl_thermostat_setpoint_message_s ezb_zcl_thermostat_setpoint_message_t

Message for ZCL Thermostat setpoint (heat/cool).

typedef struct ezb_zcl_thermostat_set_weekly_schedule_message_s ezb_zcl_thermostat_set_weekly_schedule_message_t

Message for ZCL Thermostat SetWeeklySchedule.

typedef struct ezb_zcl_thermostat_get_weekly_schedule_rsp_message_s ezb_zcl_thermostat_get_weekly_schedule_rsp_message_t

Message for ZCL Thermostat GetWeeklySchedule response.

5.2.6.3.4.1.12. Enumerations

enum ezb_zcl_thermostat_setpoint_mode_t

Enumeration for setpoint mode of ZCL Thermostat cluster. .

Values:

enumerator EZB_ZCL_THERMOSTAT_SETPOINT_MODE_HEAT

Heat mode

enumerator EZB_ZCL_THERMOSTAT_SETPOINT_MODE_COOL

Cool mode

enumerator EZB_ZCL_THERMOSTAT_SETPOINT_MODE_BOTH

Both mode

enum ezb_zcl_thermostat_set_weekly_schedule_mode_t

Mode for the SetWeeklySchedule command. .

Values:

enumerator EZB_ZCL_THERMOSTAT_SET_WEEKLY_SCHEDULE_MODE_HEAT_SETPOINT

Heat setpoint mode for sequence

enumerator EZB_ZCL_THERMOSTAT_SET_WEEKLY_SCHEDULE_MODE_COOL_SETPOINT

Cool setpoint mode for sequence

5.2.6.3.4.2. Thermostat UI Config

5.2.6.3.4.2.1. Header File

5.2.6.3.4.2.2. Functions

ezb_err_t ezb_zcl_thermostat_ui_config_cluster_desc_add_attr(ezb_zcl_cluster_desc_t cluster_desc, uint16_t attr_id, const void *value)

Add an attribute to an thermostat_ui_config cluster descriptor.

Parameters:

  • cluster_desc -- [in] The thermostat_ui_config cluster descriptor.

  • attr_id -- [in] The identifier of the attribute to be added to cluster_desc.

  • value -- [in] The pointer to the initial value of the attribute.

Returns:

Error code.

ezb_zcl_cluster_desc_t ezb_zcl_thermostat_ui_config_create_cluster_desc(const void *cluster_cfg, uint8_t role_mask)

Create an thermostat_ui_config cluster descriptor.

Parameters:

  • cluster_cfg -- [in] The pointer to the thermostat_ui_config cluster configuration structure. Use ezb_zcl_thermostat_ui_config_cluster_server_config_t for EZB_ZCL_CLUSTER_SERVER, use ezb_zcl_thermostat_ui_config_cluster_client_config_t for EZB_ZCL_CLUSTER_CLIENT, or use NULL for default configuration of the stack based on the role_mask.

  • role_mask -- [in] The role of the cluster to create.

Returns:

Created cluster descriptor.

void ezb_zcl_thermostat_ui_config_cluster_client_init(uint8_t ep_id)

Initialize the ThermostatUiConfig cluster client role for a given endpoint.

Parameters:

ep_id -- [in] The identifier of the endpoint hosting the cluster that needs initialization.

void ezb_zcl_thermostat_ui_config_cluster_server_init(uint8_t ep_id)

Initialize the ThermostatUiConfig cluster server role for a given endpoint.

Parameters:

ep_id -- [in] The identifier of the endpoint hosting the cluster that needs de-initialization.

5.2.6.3.4.2.3. Structures

struct ezb_zcl_thermostat_ui_config_cluster_server_config_s

Configuration mandatory attributes for the ThermostatUiConfig server cluster.

Public Members

uint8_t temperature_display_mode

Configurable mandatory TemperatureDisplayMode attribute

uint8_t keypad_lockout

Configurable mandatory KeypadLockout attribute

5.2.6.3.4.2.4. Macros

EZB_ZCL_THERMOSTAT_UI_CONFIG_CLUSTER_REVISION

Cluster Revision of the thermostat_ui_config cluster implementation.

EZB_ZCL_THERMOSTAT_UI_CONFIG_TEMPERATURE_DISPLAY_MODE_DEFAULT_VALUE

Default value of TemperatureDisplayMode in ThermostatUiConfig cluster.

EZB_ZCL_THERMOSTAT_UI_CONFIG_TEMPERATURE_DISPLAY_MODE_MIN_VALUE

Minimum value of TemperatureDisplayMode in ThermostatUiConfig cluster.

EZB_ZCL_THERMOSTAT_UI_CONFIG_TEMPERATURE_DISPLAY_MODE_MAX_VALUE

Maximum value of TemperatureDisplayMode in ThermostatUiConfig cluster.

EZB_ZCL_THERMOSTAT_UI_CONFIG_KEYPAD_LOCKOUT_DEFAULT_VALUE

Default value of KeypadLockout in ThermostatUiConfig cluster.

EZB_ZCL_THERMOSTAT_UI_CONFIG_KEYPAD_LOCKOUT_MIN_VALUE

Minimum value of KeypadLockout in ThermostatUiConfig cluster.

EZB_ZCL_THERMOSTAT_UI_CONFIG_KEYPAD_LOCKOUT_MAX_VALUE

Maximum value of KeypadLockout in ThermostatUiConfig cluster.

EZB_ZCL_THERMOSTAT_UI_CONFIG_SCHEDULE_PROGRAMMING_VISIBILITY_DEFAULT_VALUE

Default value of ScheduleProgrammingVisibility in ThermostatUiConfig cluster.

EZB_ZCL_THERMOSTAT_UI_CONFIG_SCHEDULE_PROGRAMMING_VISIBILITY_MIN_VALUE

Minimum value of ScheduleProgrammingVisibility in ThermostatUiConfig cluster.

EZB_ZCL_THERMOSTAT_UI_CONFIG_SCHEDULE_PROGRAMMING_VISIBILITY_MAX_VALUE

Maximum value of ScheduleProgrammingVisibility in ThermostatUiConfig cluster.

EZB_ZCL_CLUSTER_ID_THERMOSTAT_UI_CONFIG_CLIENT_ROLE_INIT
EZB_ZCL_CLUSTER_ID_THERMOSTAT_UI_CONFIG_SERVER_ROLE_INIT

5.2.6.3.4.2.5. Type Definitions

typedef struct ezb_zcl_thermostat_ui_config_cluster_server_config_s ezb_zcl_thermostat_ui_config_cluster_server_config_t

Configuration mandatory attributes for the ThermostatUiConfig server cluster.

typedef ezb_zcl_thermostat_ui_config_cluster_server_config_t ezb_zcl_thermostat_ui_config_cluster_config_t

5.2.6.3.4.2.6. Enumerations

enum ezb_zcl_thermostat_ui_config_server_attr_t

Attribute identifiers for the thermostat_ui_config server cluster.

Values:

enumerator EZB_ZCL_ATTR_THERMOSTAT_UI_CONFIG_TEMPERATURE_DISPLAY_MODE_ID

TemperatureDisplayMode attribute.

enumerator EZB_ZCL_ATTR_THERMOSTAT_UI_CONFIG_KEYPAD_LOCKOUT_ID

KeypadLockout attribute.

enumerator EZB_ZCL_ATTR_THERMOSTAT_UI_CONFIG_SCHEDULE_PROGRAMMING_VISIBILITY_ID

ScheduleProgrammingVisibility attribute.

enum ezb_zcl_thermostat_ui_config_server_temperature_display_mode_t

Enumeration for ZCL TemperatureDisplayMode attribute of ThermostatUiConfig.

Values:

enumerator EZB_ZCL_THERMOSTAT_UI_CONFIG_TEMPERATURE_DISPLAY_MODE_CELSIUS

Celsius

enumerator EZB_ZCL_THERMOSTAT_UI_CONFIG_TEMPERATURE_DISPLAY_MODE_FAHRENHEIT

Fahrenheit

enum ezb_zcl_thermostat_ui_config_server_keypad_lockout_t

Enumeration for ZCL KeypadLockout attribute of ThermostatUiConfig.

Values:

enumerator EZB_ZCL_THERMOSTAT_UI_CONFIG_KEYPAD_LOCKOUT_NONE

None

enumerator EZB_ZCL_THERMOSTAT_UI_CONFIG_KEYPAD_LOCKOUT_LEVEL1

Level1

enumerator EZB_ZCL_THERMOSTAT_UI_CONFIG_KEYPAD_LOCKOUT_LEVEL2

Level2

enumerator EZB_ZCL_THERMOSTAT_UI_CONFIG_KEYPAD_LOCKOUT_LEVEL3

Level3

enumerator EZB_ZCL_THERMOSTAT_UI_CONFIG_KEYPAD_LOCKOUT_LEVEL4

Level4

enumerator EZB_ZCL_THERMOSTAT_UI_CONFIG_KEYPAD_LOCKOUT_LEVEL5

Level5

enum ezb_zcl_thermostat_ui_config_server_schedule_programming_visibility_t

Enumeration for ZCL ScheduleProgrammingVisibility attribute of ThermostatUiConfig.

Values:

enumerator EZB_ZCL_THERMOSTAT_UI_CONFIG_SCHEDULE_PROGRAMMING_VISIBILITY_LOCAL_ENABLED

LocalEnabled

enumerator EZB_ZCL_THERMOSTAT_UI_CONFIG_SCHEDULE_PROGRAMMING_VISIBILITY_LOCAL_DISABLED

LocalDisabled

5.2.6.3.4.2.7. Header File

5.2.6.3.4.3. Fan Control

5.2.6.3.4.3.1. Header File

5.2.6.3.4.3.2. Functions

ezb_err_t ezb_zcl_fan_control_cluster_desc_add_attr(ezb_zcl_cluster_desc_t cluster_desc, uint16_t attr_id, const void *value)

Add an attribute to an fan_control cluster descriptor.

Parameters:

  • cluster_desc -- [in] The fan_control cluster descriptor.

  • attr_id -- [in] The identifier of the attribute to be added to cluster_desc.

  • value -- [in] The pointer to the initial value of the attribute.

Returns:

Error code.

ezb_zcl_cluster_desc_t ezb_zcl_fan_control_create_cluster_desc(const void *cluster_cfg, uint8_t role_mask)

Create an fan_control cluster descriptor.

Parameters:

  • cluster_cfg -- [in] The pointer to the fan_control cluster configuration structure. Use ezb_zcl_fan_control_cluster_server_config_t for EZB_ZCL_CLUSTER_SERVER, use ezb_zcl_fan_control_cluster_client_config_t for EZB_ZCL_CLUSTER_CLIENT, or use NULL for default configuration of the stack based on the role_mask.

  • role_mask -- [in] The role of the cluster to create.

Returns:

Created cluster descriptor.

void ezb_zcl_fan_control_cluster_client_init(uint8_t ep_id)

Initialize the FanControl cluster client role for a given endpoint.

Parameters:

ep_id -- [in] The identifier of the endpoint hosting the cluster that needs initialization.

void ezb_zcl_fan_control_cluster_server_init(uint8_t ep_id)

Initialize the FanControl cluster server role for a given endpoint.

Parameters:

ep_id -- [in] The identifier of the endpoint hosting the cluster that needs de-initialization.

5.2.6.3.4.3.3. Structures

struct ezb_zcl_fan_control_cluster_server_config_s

Configuration mandatory attributes for the FanControl server cluster.

Public Members

uint8_t fan_mode

Configurable mandatory FanMode attribute

uint8_t fan_mode_sequence

Configurable mandatory FanModeSequence attribute

5.2.6.3.4.3.4. Macros

EZB_ZCL_FAN_CONTROL_CLUSTER_REVISION

Cluster Revision of the fan_control cluster implementation.

EZB_ZCL_FAN_CONTROL_FAN_MODE_DEFAULT_VALUE

Default value of FanMode in FanControl cluster.

EZB_ZCL_FAN_CONTROL_FAN_MODE_MIN_VALUE

Minimum value of FanMode in FanControl cluster.

EZB_ZCL_FAN_CONTROL_FAN_MODE_MAX_VALUE

Maximum value of FanMode in FanControl cluster.

EZB_ZCL_FAN_CONTROL_FAN_MODE_SEQUENCE_DEFAULT_VALUE

Default value of FanModeSequence in FanControl cluster.

EZB_ZCL_FAN_CONTROL_FAN_MODE_SEQUENCE_MIN_VALUE

Minimum value of FanModeSequence in FanControl cluster.

EZB_ZCL_FAN_CONTROL_FAN_MODE_SEQUENCE_MAX_VALUE

Maximum value of FanModeSequence in FanControl cluster.

EZB_ZCL_CLUSTER_ID_FAN_CONTROL_CLIENT_ROLE_INIT
EZB_ZCL_CLUSTER_ID_FAN_CONTROL_SERVER_ROLE_INIT

5.2.6.3.4.3.5. Type Definitions

typedef struct ezb_zcl_fan_control_cluster_server_config_s ezb_zcl_fan_control_cluster_server_config_t

Configuration mandatory attributes for the FanControl server cluster.

typedef ezb_zcl_fan_control_cluster_server_config_t ezb_zcl_fan_control_cluster_config_t

5.2.6.3.4.3.6. Enumerations

enum ezb_zcl_fan_control_server_attr_t

Attribute identifiers for the fan_control server cluster.

Values:

enumerator EZB_ZCL_ATTR_FAN_CONTROL_FAN_MODE_ID

FanMode attribute.

enumerator EZB_ZCL_ATTR_FAN_CONTROL_FAN_MODE_SEQUENCE_ID

FanModeSequence attribute.

enum ezb_zcl_fan_control_server_fan_mode_t

Enumeration for ZCL FanMode attribute of FanControl.

Values:

enumerator EZB_ZCL_FAN_CONTROL_FAN_MODE_OFF

Off

enumerator EZB_ZCL_FAN_CONTROL_FAN_MODE_LOW

Low

enumerator EZB_ZCL_FAN_CONTROL_FAN_MODE_MEDIUM

Medium

enumerator EZB_ZCL_FAN_CONTROL_FAN_MODE_HIGH

High

enumerator EZB_ZCL_FAN_CONTROL_FAN_MODE_ON

On

enumerator EZB_ZCL_FAN_CONTROL_FAN_MODE_AUTO

Auto

enumerator EZB_ZCL_FAN_CONTROL_FAN_MODE_SMART

Smart

enum ezb_zcl_fan_control_server_fan_mode_sequence_t

Enumeration for ZCL FanModeSequence attribute of FanControl.

Values:

enumerator EZB_ZCL_FAN_CONTROL_FAN_MODE_SEQUENCE_LOW_MED_HIGH

LowMedHigh

enumerator EZB_ZCL_FAN_CONTROL_FAN_MODE_SEQUENCE_LOW_HIGH

LowHigh

enumerator EZB_ZCL_FAN_CONTROL_FAN_MODE_SEQUENCE_LOW_MED_HIGH_AUTO

LowMedHighAuto

enumerator EZB_ZCL_FAN_CONTROL_FAN_MODE_SEQUENCE_LOW_HIGH_AUTO

LowHighAuto

enumerator EZB_ZCL_FAN_CONTROL_FAN_MODE_SEQUENCE_ON_AUTO

OnAuto

5.2.6.3.4.3.7. Header File

5.2.6.3.4.4. Dehumidification Control

5.2.6.3.4.4.1. Header File

5.2.6.3.4.4.2. Functions

ezb_err_t ezb_zcl_dehumidification_control_cluster_desc_add_attr(ezb_zcl_cluster_desc_t cluster_desc, uint16_t attr_id, const void *value)

Add an attribute to an dehumidification_control cluster descriptor.

Parameters:

  • cluster_desc -- [in] The dehumidification_control cluster descriptor.

  • attr_id -- [in] The identifier of the attribute to be added to cluster_desc.

  • value -- [in] The pointer to the initial value of the attribute.

Returns:

Error code.

ezb_zcl_cluster_desc_t ezb_zcl_dehumidification_control_create_cluster_desc(const void *cluster_cfg, uint8_t role_mask)

Create an dehumidification_control cluster descriptor.

Parameters:

  • cluster_cfg -- [in] The pointer to the dehumidification_control cluster configuration structure. Use ezb_zcl_dehumidification_control_cluster_server_config_t for EZB_ZCL_CLUSTER_SERVER, use ezb_zcl_dehumidification_control_cluster_client_config_t for EZB_ZCL_CLUSTER_CLIENT, or use NULL for default configuration of the stack based on the role_mask.

  • role_mask -- [in] The role of the cluster to create.

Returns:

Created cluster descriptor.

void ezb_zcl_dehumidification_control_cluster_client_init(uint8_t ep_id)

Initialize the DehumidificationControl cluster client role for a given endpoint.

Parameters:

ep_id -- [in] The identifier of the endpoint hosting the cluster that needs initialization.

void ezb_zcl_dehumidification_control_cluster_server_init(uint8_t ep_id)

Initialize the DehumidificationControl cluster server role for a given endpoint.

Parameters:

ep_id -- [in] The identifier of the endpoint hosting the cluster that needs de-initialization.

5.2.6.3.4.4.3. Structures

struct ezb_zcl_dehumidification_control_cluster_server_config_s

Configuration mandatory attributes for the DehumidificationControl server cluster.

Public Members

uint8_t cooling

Configurable mandatory Cooling attribute

uint8_t set_point

Configurable mandatory SetPoint attribute

uint8_t hysteresis

Configurable mandatory Hysteresis attribute

uint8_t max_cool

Configurable mandatory MaxCool attribute

5.2.6.3.4.4.4. Macros

EZB_ZCL_DEHUMIDIFICATION_CONTROL_CLUSTER_REVISION

Cluster Revision of the dehumidification_control cluster implementation.

EZB_ZCL_DEHUMIDIFICATION_CONTROL_RELATIVE_HUMIDITY_MIN_VALUE

Minimum value of RelativeHumidity in DehumidificationControl cluster.

EZB_ZCL_DEHUMIDIFICATION_CONTROL_RELATIVE_HUMIDITY_MAX_VALUE

Maximum value of RelativeHumidity in DehumidificationControl cluster.

EZB_ZCL_DEHUMIDIFICATION_CONTROL_COOLING_MIN_VALUE

Minimum value of Cooling in DehumidificationControl cluster.

EZB_ZCL_DEHUMIDIFICATION_CONTROL_SET_POINT_DEFAULT_VALUE

Default value of SetPoint in DehumidificationControl cluster.

EZB_ZCL_DEHUMIDIFICATION_CONTROL_SET_POINT_MIN_VALUE

Minimum value of SetPoint in DehumidificationControl cluster.

EZB_ZCL_DEHUMIDIFICATION_CONTROL_SET_POINT_MAX_VALUE

Maximum value of SetPoint in DehumidificationControl cluster.

EZB_ZCL_DEHUMIDIFICATION_CONTROL_RELATIVE_HUMIDITY_MODE_DEFAULT_VALUE

Default value of RelativeHumidityMode in DehumidificationControl cluster.

EZB_ZCL_DEHUMIDIFICATION_CONTROL_RELATIVE_HUMIDITY_MODE_MIN_VALUE

Minimum value of RelativeHumidityMode in DehumidificationControl cluster.

EZB_ZCL_DEHUMIDIFICATION_CONTROL_RELATIVE_HUMIDITY_MODE_MAX_VALUE

Maximum value of RelativeHumidityMode in DehumidificationControl cluster.

EZB_ZCL_DEHUMIDIFICATION_CONTROL_DEHUMIDIFICATION_LOCKOUT_DEFAULT_VALUE

Default value of DehumidificationLockout in DehumidificationControl cluster.

EZB_ZCL_DEHUMIDIFICATION_CONTROL_DEHUMIDIFICATION_LOCKOUT_MIN_VALUE

Minimum value of DehumidificationLockout in DehumidificationControl cluster.

EZB_ZCL_DEHUMIDIFICATION_CONTROL_DEHUMIDIFICATION_LOCKOUT_MAX_VALUE

Maximum value of DehumidificationLockout in DehumidificationControl cluster.

EZB_ZCL_DEHUMIDIFICATION_CONTROL_HYSTERESIS_DEFAULT_VALUE

Default value of Hysteresis in DehumidificationControl cluster.

EZB_ZCL_DEHUMIDIFICATION_CONTROL_HYSTERESIS_MIN_VALUE

Minimum value of Hysteresis in DehumidificationControl cluster.

EZB_ZCL_DEHUMIDIFICATION_CONTROL_HYSTERESIS_MAX_VALUE

Maximum value of Hysteresis in DehumidificationControl cluster.

EZB_ZCL_DEHUMIDIFICATION_CONTROL_MAX_COOL_DEFAULT_VALUE

Default value of MaxCool in DehumidificationControl cluster.

EZB_ZCL_DEHUMIDIFICATION_CONTROL_MAX_COOL_MIN_VALUE

Minimum value of MaxCool in DehumidificationControl cluster.

EZB_ZCL_DEHUMIDIFICATION_CONTROL_MAX_COOL_MAX_VALUE

Maximum value of MaxCool in DehumidificationControl cluster.

EZB_ZCL_DEHUMIDIFICATION_CONTROL_RELATIVE_HUMIDITY_DISPLAY_DEFAULT_VALUE

Default value of RelativeHumidityDisplay in DehumidificationControl cluster.

EZB_ZCL_DEHUMIDIFICATION_CONTROL_RELATIVE_HUMIDITY_DISPLAY_MIN_VALUE

Minimum value of RelativeHumidityDisplay in DehumidificationControl cluster.

EZB_ZCL_DEHUMIDIFICATION_CONTROL_RELATIVE_HUMIDITY_DISPLAY_MAX_VALUE

Maximum value of RelativeHumidityDisplay in DehumidificationControl cluster.

EZB_ZCL_CLUSTER_ID_DEHUMIDIFICATION_CONTROL_CLIENT_ROLE_INIT
EZB_ZCL_CLUSTER_ID_DEHUMIDIFICATION_CONTROL_SERVER_ROLE_INIT

5.2.6.3.4.4.5. Type Definitions

typedef struct ezb_zcl_dehumidification_control_cluster_server_config_s ezb_zcl_dehumidification_control_cluster_server_config_t

Configuration mandatory attributes for the DehumidificationControl server cluster.

typedef ezb_zcl_dehumidification_control_cluster_server_config_t ezb_zcl_dehumidification_control_cluster_config_t

5.2.6.3.4.4.6. Enumerations

enum ezb_zcl_dehumidification_control_server_attr_t

Attribute identifiers for the dehumidification_control server cluster.

Values:

enumerator EZB_ZCL_ATTR_DEHUMIDIFICATION_CONTROL_RELATIVE_HUMIDITY_ID

RelativeHumidity attribute.

enumerator EZB_ZCL_ATTR_DEHUMIDIFICATION_CONTROL_COOLING_ID

Cooling attribute.

enumerator EZB_ZCL_ATTR_DEHUMIDIFICATION_CONTROL_SET_POINT_ID

SetPoint attribute.

enumerator EZB_ZCL_ATTR_DEHUMIDIFICATION_CONTROL_RELATIVE_HUMIDITY_MODE_ID

RelativeHumidityMode attribute.

enumerator EZB_ZCL_ATTR_DEHUMIDIFICATION_CONTROL_DEHUMIDIFICATION_LOCKOUT_ID

DehumidificationLockout attribute.

enumerator EZB_ZCL_ATTR_DEHUMIDIFICATION_CONTROL_HYSTERESIS_ID

Hysteresis attribute.

enumerator EZB_ZCL_ATTR_DEHUMIDIFICATION_CONTROL_MAX_COOL_ID

MaxCool attribute.

enumerator EZB_ZCL_ATTR_DEHUMIDIFICATION_CONTROL_RELATIVE_HUMIDITY_DISPLAY_ID

RelativeHumidityDisplay attribute.

enum ezb_zcl_dehumidification_control_server_relative_humidity_mode_t

Enumeration for ZCL RelativeHumidityMode attribute of DehumidificationControl.

Values:

enumerator EZB_ZCL_DEHUMIDIFICATION_CONTROL_RELATIVE_HUMIDITY_MODE_MEASURED_LOCALLY

MeasuredLocally

enumerator EZB_ZCL_DEHUMIDIFICATION_CONTROL_RELATIVE_HUMIDITY_MODE_UPDATED_OVER_THE_NETWORK

UpdatedOverTheNetwork

enum ezb_zcl_dehumidification_control_server_dehumidification_lockout_t

Enumeration for ZCL DehumidificationLockout attribute of DehumidificationControl.

Values:

enumerator EZB_ZCL_DEHUMIDIFICATION_CONTROL_DEHUMIDIFICATION_LOCKOUT_DEHUMIDIFICATION_NOT_ALLOWED

DehumidificationNotAllowed

enumerator EZB_ZCL_DEHUMIDIFICATION_CONTROL_DEHUMIDIFICATION_LOCKOUT_DEHUMIDIFICATION_ALLOWED

DehumidificationAllowed

enum ezb_zcl_dehumidification_control_server_relative_humidity_display_t

Enumeration for ZCL RelativeHumidityDisplay attribute of DehumidificationControl.

Values:

enumerator EZB_ZCL_DEHUMIDIFICATION_CONTROL_RELATIVE_HUMIDITY_DISPLAY_NOT_DISPLAYED

NotDisplayed

enumerator EZB_ZCL_DEHUMIDIFICATION_CONTROL_RELATIVE_HUMIDITY_DISPLAY_DISPLAYED

Displayed

5.2.6.3.4.4.7. Header File