Logo
Developing with ZBOSS for Zigbee
Analog Input cluster attributes

Modules

 Analog Input cluster application types
 

Macros

#define ZB_ZCL_ANALOG_INPUT_CLUSTER_REVISION_DEFAULT   ((zb_uint16_t)0x0001u)
 Default value for Analog Input cluster revision global attribute.
 
#define ZB_ZCL_ANALOG_INPUT_DESCRIPTION_DEFAULT_VALUE   {0}
 Default value for Description attribute.
 
#define ZB_ZCL_ANALOG_INPUT_OUT_OF_SERVICE_DEFAULT_VALUE   ZB_FALSE
 Default value for OutOfService attribute.
 
#define ZB_ZCL_ANALOG_INPUT_RELIABILITY_DEFAULT_VALUE   ZB_ZCL_ANALOG_INPUT_RELIABILITY_NO_FAULT_DETECTED
 Default value for Reliability attribute.
 
#define ZB_ZCL_ANALOG_INPUT_STATUS_FLAG_DEFAULT_VALUE   ZB_ZCL_ANALOG_INPUT_STATUS_FLAG_NORMAL
 Default value for StatusFlags attribute.
 
#define ZB_ZCL_ANALOG_INPUT_STATUS_FLAGS_MIN_VALUE   0
 StatusFlags attribute minimum value.
 
#define ZB_ZCL_ANALOG_INPUT_STATUS_FLAGS_MAX_VALUE   0x0f
 StatusFlags attribute maximum value.
 
#define ZB_ZCL_DECLARE_ANALOG_INPUT_ATTRIB_LIST( attr_list, description, max_present_value, min_present_value, out_of_service, present_value, reliability, resolution, status_flags, engineering_units, app_type)
 Declare attribute list for Analog Input cluster. More...
 

Enumerations

enum  zb_zcl_analog_input_attr_e {
  ZB_ZCL_ATTR_ANALOG_INPUT_DESCRIPTION_ID = 0x001c, ZB_ZCL_ATTR_ANALOG_INPUT_MAX_PRESENT_VALUE_ID = 0x0041, ZB_ZCL_ATTR_ANALOG_INPUT_MIN_PRESENT_VALUE_ID = 0x0045, ZB_ZCL_ATTR_ANALOG_INPUT_OUT_OF_SERVICE_ID = 0x0051,
  ZB_ZCL_ATTR_ANALOG_INPUT_PRESENT_VALUE_ID = 0x0055, ZB_ZCL_ATTR_ANALOG_INPUT_RELIABILITY_ID = 0x0067, ZB_ZCL_ATTR_ANALOG_INPUT_RESOLUTION_ID = 0x006a, ZB_ZCL_ATTR_ANALOG_INPUT_STATUS_FLAGS_ID = 0x006f,
  ZB_ZCL_ATTR_ANALOG_INPUT_ENGINEERING_UNITS_ID = 0x0075, ZB_ZCL_ATTR_ANALOG_INPUT_APPLICATION_TYPE_ID = 0x0100
}
 Analog Input cluster attribute identifiers. More...
 
enum  zb_zcl_analog_input_status_flags_value_e {
  ZB_ZCL_ANALOG_INPUT_STATUS_FLAG_NORMAL = 0x00, ZB_ZCL_ANALOG_INPUT_STATUS_FLAG_IN_ALARM = 0x01, ZB_ZCL_ANALOG_INPUT_STATUS_FLAG_FAULT = 0x02, ZB_ZCL_ANALOG_INPUT_STATUS_FLAG_OVERRIDDEN = 0x04,
  ZB_ZCL_ANALOG_INPUT_STATUS_FLAG_OUT_OF_SERVICE = 0x08
}
 StatusFlags attribute values. More...
 
enum  zb_zcl_analog_input_reliability_value_e {
  ZB_ZCL_ANALOG_INPUT_RELIABILITY_NO_FAULT_DETECTED = 0x00, ZB_ZCL_ANALOG_INPUT_RELIABILITY_NO_SENSOR = 0x01, ZB_ZCL_ANALOG_INPUT_RELIABILITY_OVER_RANGE = 0x02, ZB_ZCL_ANALOG_INPUT_RELIABILITY_UNDER_RANGE = 0x03,
  ZB_ZCL_ANALOG_INPUT_RELIABILITY_OPEN_LOOP = 0x04, ZB_ZCL_ANALOG_INPUT_RELIABILITY_SHORTED_LOOP = 0x05, ZB_ZCL_ANALOG_INPUT_RELIABILITY_NO_OUTPUT = 0x06, ZB_ZCL_ANALOG_INPUT_RELIABILITY_UNRELIABLE_OTHER = 0x07,
  ZB_ZCL_ANALOG_INPUT_RELIABILITY_PROCESS_ERROR = 0x08, ZB_ZCL_ANALOG_INPUT_RELIABILITY_CONFIGURATION_ERROR = 0x0a
}
 Reliability attribute values. More...
 

Detailed Description

Macro Definition Documentation

§ ZB_ZCL_DECLARE_ANALOG_INPUT_ATTRIB_LIST

#define ZB_ZCL_DECLARE_ANALOG_INPUT_ATTRIB_LIST (   attr_list,
  description,
  max_present_value,
  min_present_value,
  out_of_service,
  present_value,
  reliability,
  resolution,
  status_flags,
  engineering_units,
  app_type 
)
Value:
ZB_ZCL_START_DECLARE_ATTRIB_LIST_CLUSTER_REVISION(attr_list, ZB_ZCL_ANALOG_INPUT) \
ZB_ZCL_SET_ATTR_DESC(ZB_ZCL_ATTR_ANALOG_INPUT_DESCRIPTION_ID, (description)) \
ZB_ZCL_SET_ATTR_DESC(ZB_ZCL_ATTR_ANALOG_INPUT_MAX_PRESENT_VALUE_ID, (max_present_value)) \
ZB_ZCL_SET_ATTR_DESC(ZB_ZCL_ATTR_ANALOG_INPUT_MIN_PRESENT_VALUE_ID, (min_present_value)) \
ZB_ZCL_SET_ATTR_DESC(ZB_ZCL_ATTR_ANALOG_INPUT_OUT_OF_SERVICE_ID, (out_of_service)) \
ZB_ZCL_SET_ATTR_DESC(ZB_ZCL_ATTR_ANALOG_INPUT_PRESENT_VALUE_ID, (present_value)) \
ZB_ZCL_SET_ATTR_DESC(ZB_ZCL_ATTR_ANALOG_INPUT_RELIABILITY_ID, (reliability)) \
ZB_ZCL_SET_ATTR_DESC(ZB_ZCL_ATTR_ANALOG_INPUT_RESOLUTION_ID, (resolution)) \
ZB_ZCL_SET_ATTR_DESC(ZB_ZCL_ATTR_ANALOG_INPUT_STATUS_FLAGS_ID, (status_flags)) \
ZB_ZCL_SET_ATTR_DESC(ZB_ZCL_ATTR_ANALOG_INPUT_ENGINEERING_UNITS_ID, (engineering_units)) \
ZB_ZCL_SET_ATTR_DESC(ZB_ZCL_ATTR_ANALOG_INPUT_APPLICATION_TYPE_ID, (app_type)) \
ZB_ZCL_FINISH_DECLARE_ATTRIB_LIST
OutOfService attribute, ZCL spec 3.14.11.1.
Definition: zb_zcl_analog_input.h:60
Description attribute, ZCL spec 3.14.11.4.
Definition: zb_zcl_analog_input.h:54
MaxPresentValue attribute, ZCL spec 3.14.11.5.
Definition: zb_zcl_analog_input.h:56
ApplicationType attribute, ZCL spec 3.14.11.19.
Definition: zb_zcl_analog_input.h:72
MinPresentValue attribute, ZCL spec 3.14.11.8.
Definition: zb_zcl_analog_input.h:58
Reliability attribute, ZCL spec 3.14.11.9.
Definition: zb_zcl_analog_input.h:64
EngineeringUnits attribute, ZCL spec 3.14.11.10.
Definition: zb_zcl_analog_input.h:70
PresentValue attribute, ZCL spec 3.14.11.2.
Definition: zb_zcl_analog_input.h:62
Resolution attribute, ZCL spec 3.14.11.11.
Definition: zb_zcl_analog_input.h:66
StatusFlags attribute, ZCL spec 3.14.11.3.
Definition: zb_zcl_analog_input.h:68

Declare attribute list for Analog Input cluster.

Parameters
attr_list- attribute list name
description- pointer to variable storing Description attribute value
max_present_value- pointer to variable storing MaxPresentValue attribute value
min_present_value- pointer to variable storing MinPresentValue attribute value
out_of_service- pointer to variable storing OutOfService attribute value
present_value- pointer to variable storing PresentValue attribute value
reliability- pointer to variable storing Reliability attribute value
resolution- pointer to variable storing Resolution attribute value
status_flags- pointer to variable storing StatusFlags attribute value
engineering_units- pointer to variable storing EngineeringUnits attribute value
app_type- pointer to variable storing ApplicationType attribute value

Enumeration Type Documentation

§ zb_zcl_analog_input_attr_e

Analog Input cluster attribute identifiers.

See also
ZCL spec, Analog Input (Basic) Cluster 3.14.2.4.1
Enumerator
ZB_ZCL_ATTR_ANALOG_INPUT_DESCRIPTION_ID 

Description attribute, ZCL spec 3.14.11.4.

ZB_ZCL_ATTR_ANALOG_INPUT_MAX_PRESENT_VALUE_ID 

MaxPresentValue attribute, ZCL spec 3.14.11.5.

ZB_ZCL_ATTR_ANALOG_INPUT_MIN_PRESENT_VALUE_ID 

MinPresentValue attribute, ZCL spec 3.14.11.8.

ZB_ZCL_ATTR_ANALOG_INPUT_OUT_OF_SERVICE_ID 

OutOfService attribute, ZCL spec 3.14.11.1.

ZB_ZCL_ATTR_ANALOG_INPUT_PRESENT_VALUE_ID 

PresentValue attribute, ZCL spec 3.14.11.2.

ZB_ZCL_ATTR_ANALOG_INPUT_RELIABILITY_ID 

Reliability attribute, ZCL spec 3.14.11.9.

ZB_ZCL_ATTR_ANALOG_INPUT_RESOLUTION_ID 

Resolution attribute, ZCL spec 3.14.11.11.

ZB_ZCL_ATTR_ANALOG_INPUT_STATUS_FLAGS_ID 

StatusFlags attribute, ZCL spec 3.14.11.3.

ZB_ZCL_ATTR_ANALOG_INPUT_ENGINEERING_UNITS_ID 

EngineeringUnits attribute, ZCL spec 3.14.11.10.

ZB_ZCL_ATTR_ANALOG_INPUT_APPLICATION_TYPE_ID 

ApplicationType attribute, ZCL spec 3.14.11.19.

§ zb_zcl_analog_input_reliability_value_e

Reliability attribute values.

See also
ZCL spec 3.14.11.9 for details.

§ zb_zcl_analog_input_status_flags_value_e

StatusFlags attribute values.

See also
ZCL spec 3.14.11.3 for details.
Enumerator
ZB_ZCL_ANALOG_INPUT_STATUS_FLAG_NORMAL 

Normal (default) state.

ZB_ZCL_ANALOG_INPUT_STATUS_FLAG_IN_ALARM 

In alarm bit.

ZB_ZCL_ANALOG_INPUT_STATUS_FLAG_FAULT 

Fault bit.

ZB_ZCL_ANALOG_INPUT_STATUS_FLAG_OVERRIDDEN 

Overridden bit.

ZB_ZCL_ANALOG_INPUT_STATUS_FLAG_OUT_OF_SERVICE 

Out of service bit.