Logo
Developing with ZBOSS for Zigbee
ZB_ZCL_ANALOG_VALUE

Modules

 Analog Value cluster application types
 

Analog Value cluster attributes

enum  zb_zcl_analog_value_attr_e {
  ZB_ZCL_ATTR_ANALOG_VALUE_DESCRIPTION_ID = 0x001c, ZB_ZCL_ATTR_ANALOG_VALUE_OUT_OF_SERVICE_ID = 0x0051, ZB_ZCL_ATTR_ANALOG_VALUE_PRESENT_VALUE_ID = 0x0055, ZB_ZCL_ATTR_ANALOG_VALUE_RELIABILITY_ID = 0x0067,
  ZB_ZCL_ATTR_ANALOG_VALUE_RELINQUISH_DEFAULT_ID = 0x0068, ZB_ZCL_ATTR_ANALOG_VALUE_STATUS_FLAGS_ID = 0x006f, ZB_ZCL_ATTR_ANALOG_VALUE_ENGINEERING_UNITS_ID = 0x0075, ZB_ZCL_ATTR_ANALOG_VALUE_APPLICATION_TYPE_ID = 0x0100
}
 Analog Value cluster attribute identifiers. More...
 
enum  zb_zcl_analog_value_status_flags_value_e {
  ZB_ZCL_ANALOG_VALUE_STATUS_FLAG_NORMAL = 0x00, ZB_ZCL_ANALOG_VALUE_STATUS_FLAG_IN_ALARM = 0x01, ZB_ZCL_ANALOG_VALUE_STATUS_FLAG_FAULT = 0x02, ZB_ZCL_ANALOG_VALUE_STATUS_FLAG_OVERRIDDEN = 0x04,
  ZB_ZCL_ANALOG_VALUE_STATUS_FLAG_OUT_OF_SERVICE = 0x08
}
 StatusFlags attribute values. More...
 
enum  zb_zcl_analog_value_reliability_value_e {
  ZB_ZCL_ANALOG_VALUE_RELIABILITY_NO_FAULT_DETECTED = 0x00, ZB_ZCL_ANALOG_VALUE_RELIABILITY_NO_SENSOR = 0x01, ZB_ZCL_ANALOG_VALUE_RELIABILITY_OVER_RANGE = 0x02, ZB_ZCL_ANALOG_VALUE_RELIABILITY_UNDER_RANGE = 0x03,
  ZB_ZCL_ANALOG_VALUE_RELIABILITY_OPEN_LOOP = 0x04, ZB_ZCL_ANALOG_VALUE_RELIABILITY_SHORTED_LOOP = 0x05, ZB_ZCL_ANALOG_VALUE_RELIABILITY_NO_OUTPUT = 0x06, ZB_ZCL_ANALOG_VALUE_RELIABILITY_UNRELIABLE_OTHER = 0x07,
  ZB_ZCL_ANALOG_VALUE_RELIABILITY_PROCESS_ERROR = 0x08, ZB_ZCL_ANALOG_VALUE_RELIABILITY_CONFIGURATION_ERROR = 0x0a
}
 Reliability attribute values. More...
 

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.
enum  zb_zcl_av_application_types_e {
  ZB_ZCL_AV_APP_TYPE_TEMPERATURE = 0x00, ZB_ZCL_AV_APP_TYPE_AREA = 0x01, ZB_ZCL_AV_APP_TYPE_MULTIPLIER = 0x02, ZB_ZCL_AV_APP_TYPE_FLOW = 0x03,
  ZB_ZCL_AV_APP_TYPE_OTHER = 0xff
}
 Type values for Analog Value cluster applications. More...
 
#define ZB_ZCL_AV_GROUP_ID   0x02
 
#define ZB_ZCL_AV_SET_APP_TYPE_WITH_ID(_type, _id)   ((ZB_ZCL_AV_GROUP_ID << 24) | ((_type & 0xff) << 16) | (_id & 0xffff))
 

Analog Value cluster representing flow

enum  zb_zcl_av_flow_in_liters_per_second_e {
  ZB_ZCL_AV_FLOW_MINIMUM_AIR_FLOW = ZB_ZCL_AV_SET_APP_TYPE_WITH_ID(ZB_ZCL_AV_APP_TYPE_FLOW, 0x0000), ZB_ZCL_AV_FLOW_MAXIMUM_AIR_FLOW, ZB_ZCL_AV_FLOW_HEATING_MINIMUM_AIR_FLOW, ZB_ZCL_AV_FLOW_HEATING_MAXIMUM_AIR_FLOW,
  ZB_ZCL_AV_FLOW_STANDBY_MINIMUM_AIR_FLOW, ZB_ZCL_AV_FLOW_STANDBY_MAXIMUM_AIR_FLOW, ZB_ZCL_AV_FLOW_OTHER = ZB_ZCL_AV_SET_APP_TYPE_WITH_ID(ZB_ZCL_AV_APP_TYPE_FLOW, 0xffff)
}
 Values for 'Flow in Litres per Second' type of Analog Value cluster. More...
 

Detailed Description

The Analog Value (Basic) cluster provides an interface for setting an analog value, typically used as a control system parameter, and accessing various characteristics of that value.

Enumeration Type Documentation

§ zb_zcl_analog_value_attr_e

Analog Value cluster attribute identifiers.

See also
ZCL spec, Analog Value (Basic) Cluster 3.14.4.4.2
Enumerator
ZB_ZCL_ATTR_ANALOG_VALUE_DESCRIPTION_ID 

Description attribute, ZCL spec 3.14.11.4.

ZB_ZCL_ATTR_ANALOG_VALUE_OUT_OF_SERVICE_ID 

OutOfService attribute, ZCL spec 3.14.11.1.

ZB_ZCL_ATTR_ANALOG_VALUE_PRESENT_VALUE_ID 

PresentValue attribute, ZCL spec 3.14.11.2.

ZB_ZCL_ATTR_ANALOG_VALUE_RELIABILITY_ID 

Reliability attribute, ZCL spec 3.14.11.9.

ZB_ZCL_ATTR_ANALOG_VALUE_RELINQUISH_DEFAULT_ID 

RelinquishDefault attribute, ZCL spec 3.14.11.7.

ZB_ZCL_ATTR_ANALOG_VALUE_STATUS_FLAGS_ID 

StatusFlags attribute, ZCL spec 3.14.11.3.

ZB_ZCL_ATTR_ANALOG_VALUE_ENGINEERING_UNITS_ID 

EngineeringUnits attribute, ZCL spec 3.14.11.10.

ZB_ZCL_ATTR_ANALOG_VALUE_APPLICATION_TYPE_ID 

ApplicationType attribute, ZCL spec 3.14.11.19.

§ zb_zcl_analog_value_reliability_value_e

Reliability attribute values.

See also
ZCL spec 3.14.11.9 for details.
Enumerator
ZB_ZCL_ANALOG_VALUE_RELIABILITY_NO_FAULT_DETECTED 

No fault detected

ZB_ZCL_ANALOG_VALUE_RELIABILITY_NO_SENSOR 

No sensor

ZB_ZCL_ANALOG_VALUE_RELIABILITY_OVER_RANGE 

Over range

ZB_ZCL_ANALOG_VALUE_RELIABILITY_UNDER_RANGE 

Under range

ZB_ZCL_ANALOG_VALUE_RELIABILITY_OPEN_LOOP 

Open loop

ZB_ZCL_ANALOG_VALUE_RELIABILITY_SHORTED_LOOP 

Shorted loop

ZB_ZCL_ANALOG_VALUE_RELIABILITY_NO_OUTPUT 

No output

ZB_ZCL_ANALOG_VALUE_RELIABILITY_UNRELIABLE_OTHER 

Unreliable other

ZB_ZCL_ANALOG_VALUE_RELIABILITY_PROCESS_ERROR 

Process error

ZB_ZCL_ANALOG_VALUE_RELIABILITY_CONFIGURATION_ERROR 

Configuration error

§ zb_zcl_analog_value_status_flags_value_e

StatusFlags attribute values.

See also
ZCL spec 3.14.11.3 for details.
Enumerator
ZB_ZCL_ANALOG_VALUE_STATUS_FLAG_NORMAL 

Normal (default) state.

ZB_ZCL_ANALOG_VALUE_STATUS_FLAG_IN_ALARM 

In alarm bit.

ZB_ZCL_ANALOG_VALUE_STATUS_FLAG_FAULT 

Fault bit.

ZB_ZCL_ANALOG_VALUE_STATUS_FLAG_OVERRIDDEN 

Overridden bit.

ZB_ZCL_ANALOG_VALUE_STATUS_FLAG_OUT_OF_SERVICE 

Out of service bit.

§ zb_zcl_av_application_types_e

Type values for Analog Value cluster applications.

See also
ZCL spec 3.14.11.19.3
Enumerator
ZB_ZCL_AV_APP_TYPE_TEMPERATURE 

Temperature

ZB_ZCL_AV_APP_TYPE_AREA 

Area

ZB_ZCL_AV_APP_TYPE_MULTIPLIER 

Multiplier

ZB_ZCL_AV_APP_TYPE_FLOW 

Flow

ZB_ZCL_AV_APP_TYPE_OTHER 

Other

§ zb_zcl_av_flow_in_liters_per_second_e

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

See also
ZCL spec 3.14.11.19.3.4
Enumerator
ZB_ZCL_AV_FLOW_MINIMUM_AIR_FLOW 

Minimum Air Flow

ZB_ZCL_AV_FLOW_MAXIMUM_AIR_FLOW 

Maximum Air Flow

ZB_ZCL_AV_FLOW_HEATING_MINIMUM_AIR_FLOW 

Heating Minimum Air Flow

ZB_ZCL_AV_FLOW_HEATING_MAXIMUM_AIR_FLOW 

Heating Maximum Air Flow

ZB_ZCL_AV_FLOW_STANDBY_MINIMUM_AIR_FLOW 

Standby Minimum Air Flow

ZB_ZCL_AV_FLOW_STANDBY_MAXIMUM_AIR_FLOW 

Standby Maximum Air Flow

ZB_ZCL_AV_FLOW_OTHER 

Other