ZCL Analog value

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

Header File

components/esp-zigbee-lib/include/zcl/esp_zigbee_zcl_analog_value.h

Functions

void esp_zb_zcl_analog_value_init_server(void)

void esp_zb_zcl_analog_value_init_client(void)

Macros

ESP_ZB_ZCL_AV_GROUP_ID

Analog Value cluster application types The ApplicationType attribute indicates the specific application usage for the cluster. ApplicationType is subdivided into Group, Type and an Index number, as follows:

Group = Bits 24 to 31 An indication of the cluster this attribute is part of. Analog Value clusters have Group = 0x02.
Type = Bits 16 to 23 The physical quantity that the PresentValue attribute of the cluster represents.
Index = Bits 0 to 15 The specific application usage of the cluster.

ESP_ZB_ZCL_AV_SET_APP_TYPE_WITH_ID(_type, _id)

ESP_ZB_ZCL_ANALOG_VALUE_DESCRIPTION_DEFAULT_VALUE: Default value for Description attribute.

ESP_ZB_ZCL_ANALOG_VALUE_OUT_OF_SERVICE_DEFAULT_VALUE: Default value for OutOfService attribute.

ESP_ZB_ZCL_ANALOG_VALUE_RELIABILITY_DEFAULT_VALUE: Default value for Reliability attribute.

ESP_ZB_ZCL_ANALOG_VALUE_STATUS_FLAGS_DEFAULT_VALUE: Default value for StatusFlags attribute.

ESP_ZB_ZCL_ANALOG_VALUE_STATUS_FLAGS_MIN_VALUE: StatusFlags attribute minimum value.

ESP_ZB_ZCL_ANALOG_VALUE_STATUS_FLAGS_MAX_VALUE: StatusFlags attribute maximum value.

ESP_ZB_ZCL_CLUSTER_ID_ANALOG_VALUE_SERVER_ROLE_INIT

ESP_ZB_ZCL_CLUSTER_ID_ANALOG_VALUE_CLIENT_ROLE_INIT

Enumerations

enum esp_zb_zcl_analog_value_attr_t

Analog Value cluster attribute identifiers.

Values:

enumerator ESP_ZB_ZCL_ATTR_ANALOG_VALUE_DESCRIPTION_ID: Description attribute

enumerator ESP_ZB_ZCL_ATTR_ANALOG_VALUE_OUT_OF_SERVICE_ID: OutOfService attribute

enumerator ESP_ZB_ZCL_ATTR_ANALOG_VALUE_PRESENT_VALUE_ID: PresentValue attribute

enumerator ESP_ZB_ZCL_ATTR_ANALOG_VALUE_PRIORITY_ARRAY_ID: PriorityArray attribute

enumerator ESP_ZB_ZCL_ATTR_ANALOG_VALUE_RELIABILITY_ID: Reliability attribute

enumerator ESP_ZB_ZCL_ATTR_ANALOG_VALUE_RELINQUISH_DEFAULT_ID: RelinquishDefault attribute

enumerator ESP_ZB_ZCL_ATTR_ANALOG_VALUE_STATUS_FLAGS_ID: StatusFlags attribute

enumerator ESP_ZB_ZCL_ATTR_ANALOG_VALUE_ENGINEERING_UNITS_ID: EngineeringUnits attribute

enumerator ESP_ZB_ZCL_ATTR_ANALOG_VALUE_APPLICATION_TYPE_ID: ApplicationType attribute

enum esp_zb_zcl_analog_value_status_flags_value_t

Values for StatusFlags attribute.

Values:

enumerator ESP_ZB_ZCL_ANALOG_VALUE_STATUS_FLAG_NORMAL: Normal (default) state.

enumerator ESP_ZB_ZCL_ANALOG_VALUE_STATUS_FLAG_IN_ALARM: In alarm bit.

enumerator ESP_ZB_ZCL_ANALOG_VALUE_STATUS_FLAG_FAULT: Fault bit.

enumerator ESP_ZB_ZCL_ANALOG_VALUE_STATUS_FLAG_OVERRIDDEN: Overridden bit.

enumerator ESP_ZB_ZCL_ANALOG_VALUE_STATUS_FLAG_OUT_OF_SERVICE: Out of service bit.

enum esp_zb_zcl_analog_value_reliability_value_t

Values for Reliability attribute.

Values:

enumerator ESP_ZB_ZCL_ANALOG_VALUE_RELIABILITY_NO_FAULT_DETECTED: No fault detected

enumerator ESP_ZB_ZCL_ANALOG_VALUE_RELIABILITY_NO_SENSOR: No sensor

enumerator ESP_ZB_ZCL_ANALOG_VALUE_RELIABILITY_OVER_RANGE: Over range

enumerator ESP_ZB_ZCL_ANALOG_VALUE_RELIABILITY_UNDER_RANGE: Under range

enumerator ESP_ZB_ZCL_ANALOG_VALUE_RELIABILITY_OPEN_LOOP: Open loop

enumerator ESP_ZB_ZCL_ANALOG_VALUE_RELIABILITY_SHORTED_LOOP: Shorted loop

enumerator ESP_ZB_ZCL_ANALOG_VALUE_RELIABILITY_NO_OUTPUT: No output

enumerator ESP_ZB_ZCL_ANALOG_VALUE_RELIABILITY_UNRELIABLE_OTHER: Unreliable other

enumerator ESP_ZB_ZCL_ANALOG_VALUE_RELIABILITY_PROCESS_ERROR: Process error

enumerator ESP_ZB_ZCL_ANALOG_VALUE_RELIABILITY_CONFIGURATION_ERROR: Configuration error

enum esp_zb_zcl_av_application_types_t

Values for Analog Value cluster applications type.

Values:

enumerator ESP_ZB_ZCL_AV_APP_TYPE_TEMPERATURE: Temperature

enumerator ESP_ZB_ZCL_AV_APP_TYPE_AREA: Area

enumerator ESP_ZB_ZCL_AV_APP_TYPE_MULTIPLIER: Multiplier

enumerator ESP_ZB_ZCL_AV_APP_TYPE_FLOW: Flow

enumerator ESP_ZB_ZCL_AV_APP_TYPE_OTHER: Other

enum esp_zb_zcl_av_temperature_in_degrees_celsius_t

Values for ‘Temperature in degrees Celsius’ type of Analog Value cluster.

Values:

enumerator ESP_ZB_ZCL_AV_TEMPERATURE_SETPOINT_OFFSET_0: Setpoint Offset

enumerator ESP_ZB_ZCL_AV_TEMPERATURE_TEMP_DEADBAND: Temp deadband

enumerator ESP_ZB_ZCL_AV_TEMPERATURE_OCCUPIED_HEATING_SETPOINT: Occupied heating setpoint

enumerator ESP_ZB_ZCL_AV_TEMPERATURE_UNOCCUPIED_HEATING_SETPOINT: Unoccupied heating setpoint

enumerator ESP_ZB_ZCL_AV_TEMPERATURE_OCCUPIED_COOLING_SETPOINT: Occupied cooling setpoint

enumerator ESP_ZB_ZCL_AV_TEMPERATURE_UNOCCUPIED_COOLING_SETPOINT: Unoccupied cooling setpoint

enumerator ESP_ZB_ZCL_AV_TEMPERATURE_STANDBY_HEAT_SETPOINT: Standby heat setpoint

enumerator ESP_ZB_ZCL_AV_TEMPERATURE_STANDBY_COOLING_SETPOINT: Standby cooling setpoint

enumerator ESP_ZB_ZCL_AV_TEMPERATURE_EFFECTIVE_OCCUPIED_HEATING_SETPOINT: Effective occupied heating setpoint

enumerator ESP_ZB_ZCL_AV_TEMPERATURE_EFFECTIVE_UNOCCUPIED_HEATING_SETPOINT: Effective unoccupied heating setpoint

enumerator ESP_ZB_ZCL_AV_TEMPERATURE_EFFECTIVE_OCCUPIED_COOLING_SETPOINT: Effective occupied cooling setpoint

enumerator ESP_ZB_ZCL_AV_TEMPERATURE_EFFECTIVE_UNOCCUPIED_COOLING_SETPOINT: Effective unoccupied cooling setpoint

enumerator ESP_ZB_ZCL_AV_TEMPERATURE_EFFECTIVE_STANDBY_HEAT_SETPOINT: Effective standby heat setpoint

enumerator ESP_ZB_ZCL_AV_TEMPERATURE_EFFECTIVE_STANDBY_COOLING_SETPOINT: Effective standby cooling setpoint

enumerator ESP_ZB_ZCL_AV_TEMPERATURE_SETPOINT_OFFSET_2: Setpoint offset 2

enumerator ESP_ZB_ZCL_AV_TEMPERATURE_SETPOINT_SHIFT: Setpoint shift

enumerator ESP_ZB_ZCL_AV_TEMPERATURE_OTHER: Other

enum esp_zb_zcl_av_area_in_squares_meters_t

Values for ‘Area in Square Metres’ type of Analog Value cluster.

Values:

enumerator ESP_ZB_ZCL_AV_AREA_DUCT_AREA: Duct Area

enumerator ESP_ZB_ZCL_AV_AREA_OTHER: Other

enum esp_zb_zcl_av_multiplier_number_t

Values for ‘Multiplier - Number’ type of Analog Value cluster.

Values:

enumerator ESP_ZB_ZCL_AV_MULTIPLIER_DUCT_MULTIPLIER: Duct Area

enumerator ESP_ZB_ZCL_AV_MULTIPLIER_OTHER: Other

enum esp_zb_zcl_av_flow_in_liters_per_second_t

Values for ‘Flow in Litres per Second’ type of Analog Value cluster.

Values:

enumerator ESP_ZB_ZCL_AV_FLOW_MINIMUM_AIR_FLOW: Minimum Air Flow

enumerator ESP_ZB_ZCL_AV_FLOW_MAXIMUM_AIR_FLOW: Maximum Air Flow

enumerator ESP_ZB_ZCL_AV_FLOW_HEATING_MINIMUM_AIR_FLOW: Heating Minimum Air Flow

enumerator ESP_ZB_ZCL_AV_FLOW_HEATING_MAXIMUM_AIR_FLOW: Heating Maximum Air Flow

enumerator ESP_ZB_ZCL_AV_FLOW_STANDBY_MINIMUM_AIR_FLOW: Standby Minimum Air Flow

enumerator ESP_ZB_ZCL_AV_FLOW_STANDBY_MAXIMUM_AIR_FLOW: Standby Maximum Air Flow

enumerator ESP_ZB_ZCL_AV_FLOW_OTHER: Other