ZCL Analog Output

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

Header File

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

Functions

void esp_zb_zcl_analog_output_init_server(void)

void esp_zb_zcl_analog_output_init_client(void)

Macros

ESP_ZB_ZCL_AO_GROUP_ID

Analog Output 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 Output clusters have Group = 0x01.

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_AO_SET_APP_TYPE_WITH_ID(_type, _id)

ESP_ZB_ZCL_ANALOG_OUTPUT_DESCRIPTION_DEFAULT_VALUE: Default value for Description attribute.

ESP_ZB_ZCL_ANALOG_OUTPUT_OUT_OF_SERVICE_DEFAULT_VALUE: Default value for OutOfService attribute.

ESP_ZB_ZCL_ANALOG_OUTPUT_STATUS_FLAG_DEFAULT_VALUE: Default value for StatusFlags attribute.

ESP_ZB_ZCL_ANALOG_OUTPUT_STATUS_FLAGS_MIN_VALUE: StatusFlags attribute minimum value.

ESP_ZB_ZCL_ANALOG_OUTPUT_STATUS_FLAGS_MAX_VALUE: StatusFlags attribute maximum value.

ESP_ZB_ZCL_ANALOG_OUTPUT_REPORT_ATTR_COUNT: Number of attributes mandatory for reporting in Analog Output cluster

ESP_ZB_ZCL_CLUSTER_ID_ANALOG_OUTPUT_SERVER_ROLE_INIT

ESP_ZB_ZCL_CLUSTER_ID_ANALOG_OUTPUT_CLIENT_ROLE_INIT

Enumerations

enum esp_zb_zcl_analog_output_attr_t

Analog Output cluster attribute identifiers.

Values:

enumerator ESP_ZB_ZCL_ATTR_ANALOG_OUTPUT_DESCRIPTION_ID: Description attribute

enumerator ESP_ZB_ZCL_ATTR_ANALOG_OUTPUT_MAX_PRESENT_VALUE_ID: MaxPresentValue attribute

enumerator ESP_ZB_ZCL_ATTR_ANALOG_OUTPUT_MIN_PRESENT_VALUE_ID: MinPresentValue attribute

enumerator ESP_ZB_ZCL_ATTR_ANALOG_OUTPUT_OUT_OF_SERVICE_ID: OutOfService attribute

enumerator ESP_ZB_ZCL_ATTR_ANALOG_OUTPUT_PRESENT_VALUE_ID: PresentValue attribute

enumerator ESP_ZB_ZCL_ATTR_ANALOG_OUTPUT_PRIORITY_ARRAY_ID: PriorityArray attribute

enumerator ESP_ZB_ZCL_ATTR_ANALOG_OUTPUT_RELIABILITY_ID: Reliability attribute

enumerator ESP_ZB_ZCL_ATTR_ANALOG_OUTPUT_RELINQUISH_DEFAULT_ID: RelinquishDefault attribute

enumerator ESP_ZB_ZCL_ATTR_ANALOG_OUTPUT_RESOLUTION_ID: Resolution attribute

enumerator ESP_ZB_ZCL_ATTR_ANALOG_OUTPUT_STATUS_FLAGS_ID: StatusFlags attribute

enumerator ESP_ZB_ZCL_ATTR_ANALOG_OUTPUT_ENGINEERING_UNITS_ID: EngineeringUnits attribute

enumerator ESP_ZB_ZCL_ATTR_ANALOG_OUTPUT_APPLICATION_TYPE_ID: ApplicationType attribute

enum esp_zb_zcl_analog_output_status_flags_value_t

Values for StatusFlags attribute.

Values:

enumerator ESP_ZB_ZCL_ANALOG_OUTPUT_STATUS_FLAG_NORMAL: Normal (default) state

enumerator ESP_ZB_ZCL_ANALOG_OUTPUT_STATUS_FLAG_IN_ALARM: In alarm bit

enumerator ESP_ZB_ZCL_ANALOG_OUTPUT_STATUS_FLAG_FAULT: Fault bit

enumerator ESP_ZB_ZCL_ANALOG_OUTPUT_STATUS_FLAG_OVERRIDDEN: Overridden bit

enumerator ESP_ZB_ZCL_ANALOG_OUTPUT_STATUS_FLAG_OUT_OF_SERVICE: Out of service bit

enum esp_zb_zcl_analog_output_reliability_value_t

Values for Reliability attribute

Values:

enumerator ESP_ZB_ZCL_ANALOG_OUTPUT_RELIABILITY_NO_FAULT_DETECTED: No fault detected

enumerator ESP_ZB_ZCL_ANALOG_OUTPUT_RELIABILITY_NO_SENSOR: No sensor

enumerator ESP_ZB_ZCL_ANALOG_OUTPUT_RELIABILITY_OVER_RANGE: Over range

enumerator ESP_ZB_ZCL_ANALOG_OUTPUT_RELIABILITY_UNDER_RANGE: Under range

enumerator ESP_ZB_ZCL_ANALOG_OUTPUT_RELIABILITY_OPEN_LOOP: Open loop

enumerator ESP_ZB_ZCL_ANALOG_OUTPUT_RELIABILITY_SHORTED_LOOP: Shorted loop

enumerator ESP_ZB_ZCL_ANALOG_OUTPUT_RELIABILITY_NO_OUTPUT: No output

enumerator ESP_ZB_ZCL_ANALOG_OUTPUT_RELIABILITY_UNRELIABLE_OTHER: Unreliable other

enumerator ESP_ZB_ZCL_ANALOG_OUTPUT_RELIABILITY_PROCESS_ERROR: Process error

enumerator ESP_ZB_ZCL_ANALOG_OUTPUT_RELIABILITY_CONFIGURATION_ERROR: Configuration error

enum esp_zb_zcl_ao_application_types_t

Values for Analog Input cluster applications type.

Values:

enumerator ESP_ZB_ZCL_AO_APP_TYPE_TEMPERATURE: Temperature

enumerator ESP_ZB_ZCL_AO_APP_TYPE_HUMIDITY: Humidity

enumerator ESP_ZB_ZCL_AO_APP_TYPE_PRESSURE: Pressure

enumerator ESP_ZB_ZCL_AO_APP_TYPE_FLOW: Flow

enumerator ESP_ZB_ZCL_AO_APP_TYPE_PERCENTAGE: Percentage

enumerator ESP_ZB_ZCL_AO_APP_TYPE_PPM: Ppm

enumerator ESP_ZB_ZCL_AO_APP_TYPE_RPM: Rpm

enumerator ESP_ZB_ZCL_AO_APP_TYPE_CURRENT_IN_AMPS: Current in amps

enumerator ESP_ZB_ZCL_AO_APP_TYPE_FREQUENCY: Frequency

enumerator ESP_ZB_ZCL_AO_APP_TYPE_POWER_IN_WATTS: Power in watts

enumerator ESP_ZB_ZCL_AO_APP_TYPE_POWER_IN_KILOWATTS: Power in kilowatts

enumerator ESP_ZB_ZCL_AO_APP_TYPE_ENERGY: Energy

enumerator ESP_ZB_ZCL_AO_APP_TYPE_COUNT_UNITLESS: Count unitless

enumerator ESP_ZB_ZCL_AO_APP_TYPE_ENTHALPY: Enthalpy

enumerator ESP_ZB_ZCL_AO_APP_TYPE_TIME: Time

enumerator ESP_ZB_ZCL_AO_APP_TYPE_OTHER: Other

enum esp_zb_zcl_ao_temperature_in_degrees_celsius_t

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

Values:

enumerator ESP_ZB_ZCL_AO_TEMPERATURE_BOILER: Boiler

enumerator ESP_ZB_ZCL_AO_TEMPERATURE_BOILER_SETPOINT: Boiler setpoint

enumerator ESP_ZB_ZCL_AO_TEMPERATURE_COLD_DECK: Cold deck

enumerator ESP_ZB_ZCL_AO_TEMPERATURE_CHILLER_SETPOINT_0: Chiller setpoint 0. Note: Chiller Setpoint is duplicated in spec

enumerator ESP_ZB_ZCL_AO_TEMPERATURE_CHILLER_SETPOINT_1: Chiller setpoint 1

enumerator ESP_ZB_ZCL_AO_TEMPERATURE_HOT_DECK: Hot deck

enumerator ESP_ZB_ZCL_AO_TEMPERATURE_COOLING_VALVE: Cooling valve

enumerator ESP_ZB_ZCL_AO_TEMPERATURE_ZONE_TEMPERATURE_SETPOINT: Zone temperature setpoint

enumerator ESP_ZB_ZCL_AO_TEMPERATURE_SETPOINT_OFFSET: Setpoint offset

enumerator ESP_ZB_ZCL_AO_TEMPERATURE_SETPOINT_SHIFT: Setpoint shift

enumerator ESP_ZB_ZCL_AO_TEMPERATURE_OTHER: Other

enum esp_zb_zcl_ao_relative_humidity_in_percent_t

Values for ‘Relative Humidity in ‘ type of Analog Output cluster.

Values:

enumerator ESP_ZB_ZCL_AO_HUMIDITY_HUMIDIFICATION: Humidification

enumerator ESP_ZB_ZCL_AO_HUMIDITY_ZONE_RELATIVE_HUMIDITY: Zone relative humidity

enumerator ESP_ZB_ZCL_AO_HUMIDITY_OTHER: Other

enum esp_zb_zcl_ao_percentage_t

Values for ‘Percentage ‘ type of Analog Output cluster.

Values:

enumerator ESP_ZB_ZCL_AO_PERCENTAGE_FACE_BYPASS_DAMPER: Face bypass damper

enumerator ESP_ZB_ZCL_AO_PERCENTAGE_HEAT_RECOVERY_VALVE: Heat recovery valve

enumerator ESP_ZB_ZCL_AO_PERCENTAGE_HEAT_RECOVERY_WHELL: Heat recovery whell

enumerator ESP_ZB_ZCL_AO_PERCENTAGE_HEATING_VALVE: Heating valve

enumerator ESP_ZB_ZCL_AO_PERCENTAGE_HOT_DECK_DAMPER: Hot deck damper

enumerator ESP_ZB_ZCL_AO_PERCENTAGE_2_PIPE_DAMPER: 2 pipe damper

enumerator ESP_ZB_ZCL_AO_PERCENTAGE_2_PIPE_VALVE: 2 pipe valve

enumerator ESP_ZB_ZCL_AO_PERCENTAGE_BOILER_MIXING_VALVE: Boiler mixing valve

enumerator ESP_ZB_ZCL_AO_PERCENTAGE_BOX_COOLING_VALVE: Box cooling valve

enumerator ESP_ZB_ZCL_AO_PERCENTAGE_BOX_HEATING_VALVE: Box heating valve

enumerator ESP_ZB_ZCL_AO_PERCENTAGE_CHILLED_WATER_BYPASS_VALVE: Chilled water bypass valve

enumerator ESP_ZB_ZCL_AO_PERCENTAGE_COLD_DECK_DAMPER: Cold deck damper

enumerator ESP_ZB_ZCL_AO_PERCENTAGE_COOLING_DAMPER: Cooling damper

enumerator ESP_ZB_ZCL_AO_PERCENTAGE_COOLING_VALVE: Cooling valve

enumerator ESP_ZB_ZCL_AO_PERCENTAGE_DAMPER: Damper

enumerator ESP_ZB_ZCL_AO_PERCENTAGE_EXHAUST_AIR_DAMPER: Exhaust air damper

enumerator ESP_ZB_ZCL_AO_PERCENTAGE_EXHAUST_DAMPER: Exhaust damper

enumerator ESP_ZB_ZCL_AO_PERCENTAGE_HOT_WATER_BYPASS_VALVE: Hot water bypass valve

enumerator ESP_ZB_ZCL_AO_PERCENTAGE_HOT_WATER_MIXING_VALVE: Hot water mixing valve

enumerator ESP_ZB_ZCL_AO_PERCENTAGE_MINIMUM_OUTSIDE_AIR_DAMPER: Minimum outside air damper

enumerator ESP_ZB_ZCL_AO_PERCENTAGE_MINIMUM_OUTSIDE_AIR_FAN: Minimum outside air fan

enumerator ESP_ZB_ZCL_AO_PERCENTAGE_MIXED_AIR_DAMPER: Mixed air damper

enumerator ESP_ZB_ZCL_AO_PERCENTAGE_MIXING_VALVE: Mixing valve

enumerator ESP_ZB_ZCL_AO_PERCENTAGE_OUTSIDE_AIR_DAMPER: Ourside air damper

enumerator ESP_ZB_ZCL_AO_PERCENTAGE_PRIMARY_CHILLED_WATER_PUMP: Primary chilled water pump

enumerator ESP_ZB_ZCL_AO_PERCENTAGE_PRIMARY_HOT_WATER_PUMP: Primary hot water pump

enumerator ESP_ZB_ZCL_AO_PERCENTAGE_PRIMARY_HEAT_EXCHANGE_PUMP: Primary heat exchange pump

enumerator ESP_ZB_ZCL_AO_PERCENTAGE_PREHEAT_DAMPER: Preheat damper

enumerator ESP_ZB_ZCL_AO_PERCENTAGE_PREHEAT_VALVE: Preheat valve

enumerator ESP_ZB_ZCL_AO_PERCENTAGE_REHEAT_VALVE_0: Reheat valve 0. Note: Reheat valve is duplicated in spec

enumerator ESP_ZB_ZCL_AO_PERCENTAGE_REHEAT_VALVE_1: Reheat valve 1

enumerator ESP_ZB_ZCL_AO_PERCENTAGE_RETURN_AIR_DAMPER: Return air damper

enumerator ESP_ZB_ZCL_AO_PERCENTAGE_SECONDARY_CHILLED_WATER_PUMP: Secondary chilled water pump

enumerator ESP_ZB_ZCL_AO_PERCENTAGE_SEQUENCED_VALVE: Sequenced valve

enumerator ESP_ZB_ZCL_AO_PERCENTAGE_SECONDARY_HOT_WATER_PUMP: Secondary hot water pump

enumerator ESP_ZB_ZCL_AO_PERCENTAGE_SECONDARY_HEAT_EXCHANGE_PUMP: Secondary heat exchange pump

enumerator ESP_ZB_ZCL_AO_PERCENTAGE_SIDELOOP: Sideloop

enumerator ESP_ZB_ZCL_AO_PERCENTAGE_SUPPLY_HEATING_VALVE: Supply heating valve

enumerator ESP_ZB_ZCL_AO_PERCENTAGE_SUPPLY_DAMPER: Supply damper

enumerator ESP_ZB_ZCL_AO_PERCENTAGE_TOWER_BYPASS_VALVE: Tower bypass valve

enumerator ESP_ZB_ZCL_AO_PERCENTAGE_TOWER_FAN: Tower fan

enumerator ESP_ZB_ZCL_AO_PERCENTAGE_VALVE: Value

enumerator ESP_ZB_ZCL_AO_PERCENTAGE_ZONE_1_DAMPER: Zone 1 damper

enumerator ESP_ZB_ZCL_AO_PERCENTAGE_ZONE_1_HEATING_VALVE: Zone 1 heating valve

enumerator ESP_ZB_ZCL_AO_PERCENTAGE_HEAT_RECOVERY_EXHAUST_BYPASS_DAMPER: Heat recovery exhaust bypass damper

enumerator ESP_ZB_ZCL_AO_PERCENTAGE_HEAT_RECOVERY_OUTSIDE_AIR_BYPASS_DAMPER: Heat recovery outside air bypass damper

enumerator ESP_ZB_ZCL_AO_PERCENTAGE_OTHER: Other

enum esp_zb_zcl_ao_ppm_t

Values for ‘Parts per Million PPM’ type of Analog Output cluster.

Values:

enumerator ESP_ZB_ZCL_AO_PPM_SPACE_CARBON_DIOXIDE_LIMIT: Space carbon dioxide limit

enumerator ESP_ZB_ZCL_AO_PPM_OTHER: Other

enum esp_zb_zcl_ao_rpm_t

Values for ‘Rotational Speed in RPM’ type of Analog Output cluster.

Values:

enumerator ESP_ZB_ZCL_AO_RPM_EXHAUST_FAN_SPEED: Exhaust fan speed

enumerator ESP_ZB_ZCL_AO_RPM_FAN_SPEED: Fan speed

enumerator ESP_ZB_ZCL_AO_RPM_RELIEF_FAN_SPEED: Relief fan speed

enumerator ESP_ZB_ZCL_AO_RPM_RETURN_FAN_SPEED: Return fan speed

enumerator ESP_ZB_ZCL_AO_RPM_SUPPLY_FAN_SPEED: Supply fan speed

enumerator ESP_ZB_ZCL_AO_RPM_OTHER: Other

enum esp_zb_zcl_ao_time_t

Values for ‘Time in Seconds’ type of Analog Output cluster.

Values:

enumerator ESP_ZB_ZCL_AO_TIME_RELATIVE: Relative

enumerator ESP_ZB_ZCL_AO_TIME_OTHER: Other