nRF5 SDK for Thread and Zigbee v1.0.0
 All Data Structures Functions Variables Typedefs Enumerations Enumerator Groups Pages
ZCL Power Configuration cluster

Functions

zb_void_t zb_zcl_power_config_write_attr_hook (zb_uint8_t endpoint, zb_uint16_t attr_id, zb_uint8_t *new_value)
 Hook on Write attribute. More...
 

Power Configuration cluster attributes

enum  zb_zcl_power_config_attr_e {
  ZB_ZCL_ATTR_POWER_CONFIG_BATTERY_VOLTAGE_ID = 0x0020, ZB_ZCL_ATTR_POWER_CONFIG_BATTERY_SIZE_ID = 0x0031, ZB_ZCL_ATTR_POWER_CONFIG_BATTERY_QUANTITY_ID = 0x0033, ZB_ZCL_ATTR_POWER_CONFIG_BATTERY_RATED_VOLTAGE_ID = 0x0034,
  ZB_ZCL_ATTR_POWER_CONFIG_BATTERY_ALARM_MASK_ID = 0x0035, ZB_ZCL_ATTR_POWER_CONFIG_BATTERY_VOLTAGE_MIN_THRESHOLD_ID = 0x0036, ZB_ZCL_ATTR_POWER_CONFIG_CUSTOM_BATTERY_VOLTAGE_SHARP_ID = 0x8020
}
 Power Configuration cluster attribute identifiers. More...
 
enum  zb_zcl_power_config_battery_size_e {
  ZB_ZCL_POWER_CONFIG_BATTERY_SIZE_NO_BATTERY = 0, ZB_ZCL_POWER_CONFIG_BATTERY_SIZE_BUILT_IN = 1, ZB_ZCL_POWER_CONFIG_BATTERY_SIZE_OTHER = 2, ZB_ZCL_POWER_CONFIG_BATTERY_SIZE_AA = 3,
  ZB_ZCL_POWER_CONFIG_BATTERY_SIZE_AAA = 4, ZB_ZCL_POWER_CONFIG_BATTERY_SIZE_C = 5, ZB_ZCL_POWER_CONFIG_BATTERY_SIZE_D = 6, ZB_ZCL_POWER_CONFIG_BATTERY_SIZE_UNKNOWN = 0xff
}
 Power Configuration BatterySize value see ZCL spec 3.3.2.2.4.2. More...
 
enum  zb_zcl_power_config_battery_alarm_mask_e { ZB_ZCL_POWER_CONFIG_BATTERY_ALARM_MASK_VOLTAGE_LOW = 0 }
 Power Configuration BatteryAlarmMask value see ZCL spec 3.3.2.2.4.7. More...
 
#define ZB_ZCL_POWER_CONFIG_BATTERY_VOLTAGE_INVALID   0xff
 BatteryVoltage attribute invalid value.
 
#define ZB_ZCL_POWER_CONFIG_BATTERY_SIZE_DEF_VALUE   0xff
 BatterySize attribute default value.
 
#define ZB_ZCL_POWER_CONFIG_BATTERY_ALARM_MASK_DEF_VALUE   0x00
 BatteryAlarmMask attribute default value.
 
#define ZB_SET_ATTR_DESCR_WITH_ZB_ZCL_ATTR_POWER_CONFIG_BATTERY_VOLTAGE_ID(data_ptr)
 
#define ZB_SET_ATTR_DESCR_WITH_ZB_ZCL_ATTR_POWER_CONFIG_BATTERY_SIZE_ID(data_ptr)
 
#define ZB_SET_ATTR_DESCR_WITH_ZB_ZCL_ATTR_POWER_CONFIG_BATTERY_QUANTITY_ID(data_ptr)
 
#define ZB_SET_ATTR_DESCR_WITH_ZB_ZCL_ATTR_POWER_CONFIG_BATTERY_RATED_VOLTAGE_ID(data_ptr)
 
#define ZB_SET_ATTR_DESCR_WITH_ZB_ZCL_ATTR_POWER_CONFIG_BATTERY_ALARM_MASK_ID(data_ptr)
 
#define ZB_SET_ATTR_DESCR_WITH_ZB_ZCL_ATTR_POWER_CONFIG_BATTERY_VOLTAGE_MIN_THRESHOLD_ID(data_ptr)
 
#define ZB_ZCL_DECLARE_POWER_CONFIG_ATTRIB_LIST(attr_list,voltage, size, quantity, rated_voltage, alarm_mask, voltage_min_threshold)
 
#define ZB_ZCL_POWER_CONFIG_REPORT_ATTR_COUNT   1
 
#define ZB_ZCL_POWER_CONFIG_ALARM_CODE   0x10
 

Detailed Description

Macro Definition Documentation

#define ZB_SET_ATTR_DESCR_WITH_ZB_ZCL_ATTR_POWER_CONFIG_BATTERY_ALARM_MASK_ID (   data_ptr)
Value:
{ \
(zb_voidp_t) data_ptr \
}
void * zb_voidp_t
Project-local "pointer to void" type.
Definition: zb_types.h:293
Definition: zb_zcl_common.h:491
Definition: zb_zcl_common.h:447
BatteryAlarmMask attribute, ZCL spec 3.3.2.2.4.6.
Definition: zb_zcl_power_config.h:86
#define ZB_SET_ATTR_DESCR_WITH_ZB_ZCL_ATTR_POWER_CONFIG_BATTERY_QUANTITY_ID (   data_ptr)
Value:
{ \
(zb_voidp_t) data_ptr \
}
BatteryQuantity attribute, ZCL spec 3.3.2.2.4.4.
Definition: zb_zcl_power_config.h:82
void * zb_voidp_t
Project-local "pointer to void" type.
Definition: zb_types.h:293
Definition: zb_zcl_common.h:455
Definition: zb_zcl_common.h:491
#define ZB_SET_ATTR_DESCR_WITH_ZB_ZCL_ATTR_POWER_CONFIG_BATTERY_RATED_VOLTAGE_ID (   data_ptr)
Value:
{ \
(zb_voidp_t) data_ptr \
}
BatteryRatedVoltage attribute, ZCL spec 3.3.2.2.4.5.
Definition: zb_zcl_power_config.h:84
void * zb_voidp_t
Project-local "pointer to void" type.
Definition: zb_types.h:293
Definition: zb_zcl_common.h:455
Definition: zb_zcl_common.h:491
#define ZB_SET_ATTR_DESCR_WITH_ZB_ZCL_ATTR_POWER_CONFIG_BATTERY_SIZE_ID (   data_ptr)
Value:
{ \
(zb_voidp_t) data_ptr \
}
Definition: zb_zcl_common.h:470
void * zb_voidp_t
Project-local "pointer to void" type.
Definition: zb_types.h:293
BatterySize attribute, ZCL spec 3.3.2.2.4.2.
Definition: zb_zcl_power_config.h:80
Definition: zb_zcl_common.h:491
#define ZB_SET_ATTR_DESCR_WITH_ZB_ZCL_ATTR_POWER_CONFIG_BATTERY_VOLTAGE_ID (   data_ptr)
Value:
{ \
(zb_voidp_t) data_ptr \
}
Definition: zb_zcl_common.h:492
BatteryVoltage attribute, ZCL spec 3.3.2.2.3.1.
Definition: zb_zcl_power_config.h:77
Definition: zb_zcl_common.h:490
void * zb_voidp_t
Project-local "pointer to void" type.
Definition: zb_types.h:293
Definition: zb_zcl_common.h:455
#define ZB_SET_ATTR_DESCR_WITH_ZB_ZCL_ATTR_POWER_CONFIG_BATTERY_VOLTAGE_MIN_THRESHOLD_ID (   data_ptr)
Value:
{ \
(zb_voidp_t) data_ptr \
}
void * zb_voidp_t
Project-local "pointer to void" type.
Definition: zb_types.h:293
Definition: zb_zcl_common.h:455
Definition: zb_zcl_common.h:491
BatteryVoltageMinThreshold attribute, ZCL spec 3.3.2.2.4.7.
Definition: zb_zcl_power_config.h:88
#define ZB_ZCL_DECLARE_POWER_CONFIG_ATTRIB_LIST (   attr_list,
  voltage,
  size,
  quantity,
  rated_voltage,
  alarm_mask,
  voltage_min_threshold 
)
Value:
ZB_ZCL_START_DECLARE_ATTRIB_LIST(attr_list) \
ZB_ZCL_SET_ATTR_DESC(ZB_ZCL_ATTR_POWER_CONFIG_BATTERY_VOLTAGE_ID, (voltage)) \
ZB_ZCL_SET_ATTR_DESC(ZB_ZCL_ATTR_POWER_CONFIG_BATTERY_SIZE_ID, (size)) \
ZB_ZCL_SET_ATTR_DESC(ZB_ZCL_ATTR_POWER_CONFIG_BATTERY_QUANTITY_ID, (quantity)) \
ZB_ZCL_SET_ATTR_DESC(ZB_ZCL_ATTR_POWER_CONFIG_BATTERY_RATED_VOLTAGE_ID, (rated_voltage)) \
ZB_ZCL_SET_ATTR_DESC(ZB_ZCL_ATTR_POWER_CONFIG_BATTERY_ALARM_MASK_ID, (alarm_mask )) \
ZB_ZCL_SET_ATTR_DESC(ZB_ZCL_ATTR_POWER_CONFIG_BATTERY_VOLTAGE_MIN_THRESHOLD_ID, (voltage_min_threshold)) \
ZB_ZCL_FINISH_DECLARE_ATTRIB_LIST
BatteryQuantity attribute, ZCL spec 3.3.2.2.4.4.
Definition: zb_zcl_power_config.h:82
BatteryVoltage attribute, ZCL spec 3.3.2.2.3.1.
Definition: zb_zcl_power_config.h:77
BatteryRatedVoltage attribute, ZCL spec 3.3.2.2.4.5.
Definition: zb_zcl_power_config.h:84
BatterySize attribute, ZCL spec 3.3.2.2.4.2.
Definition: zb_zcl_power_config.h:80
BatteryVoltageMinThreshold attribute, ZCL spec 3.3.2.2.4.7.
Definition: zb_zcl_power_config.h:88
BatteryAlarmMask attribute, ZCL spec 3.3.2.2.4.6.
Definition: zb_zcl_power_config.h:86

Enumeration Type Documentation

Power Configuration cluster attribute identifiers.

See also
ZCL spec, Power Configuration Cluster 3.3.2.2
Enumerator
ZB_ZCL_ATTR_POWER_CONFIG_BATTERY_VOLTAGE_ID 

BatteryVoltage attribute, ZCL spec 3.3.2.2.3.1.

ZB_ZCL_ATTR_POWER_CONFIG_BATTERY_SIZE_ID 

BatterySize attribute, ZCL spec 3.3.2.2.4.2.

ZB_ZCL_ATTR_POWER_CONFIG_BATTERY_QUANTITY_ID 

BatteryQuantity attribute, ZCL spec 3.3.2.2.4.4.

ZB_ZCL_ATTR_POWER_CONFIG_BATTERY_RATED_VOLTAGE_ID 

BatteryRatedVoltage attribute, ZCL spec 3.3.2.2.4.5.

ZB_ZCL_ATTR_POWER_CONFIG_BATTERY_ALARM_MASK_ID 

BatteryAlarmMask attribute, ZCL spec 3.3.2.2.4.6.

ZB_ZCL_ATTR_POWER_CONFIG_BATTERY_VOLTAGE_MIN_THRESHOLD_ID 

BatteryVoltageMinThreshold attribute, ZCL spec 3.3.2.2.4.7.

Power Configuration BatteryAlarmMask value see ZCL spec 3.3.2.2.4.7.

Enumerator
ZB_ZCL_POWER_CONFIG_BATTERY_ALARM_MASK_VOLTAGE_LOW 

BatteryAlarmMask - Battery voltage too low.

Power Configuration BatterySize value see ZCL spec 3.3.2.2.4.2.

Enumerator
ZB_ZCL_POWER_CONFIG_BATTERY_SIZE_NO_BATTERY 

BatterySize - no battery.

ZB_ZCL_POWER_CONFIG_BATTERY_SIZE_BUILT_IN 

BatterySize - built in.

ZB_ZCL_POWER_CONFIG_BATTERY_SIZE_OTHER 

BatterySize - other.

ZB_ZCL_POWER_CONFIG_BATTERY_SIZE_AA 

BatterySize - AA.

ZB_ZCL_POWER_CONFIG_BATTERY_SIZE_AAA 

BatterySize - AAA.

ZB_ZCL_POWER_CONFIG_BATTERY_SIZE_C 

BatterySize - C.

ZB_ZCL_POWER_CONFIG_BATTERY_SIZE_D 

BatterySize - D.

ZB_ZCL_POWER_CONFIG_BATTERY_SIZE_UNKNOWN 

BatterySize - unknown.

Function Documentation

zb_void_t zb_zcl_power_config_write_attr_hook ( zb_uint8_t  endpoint,
zb_uint16_t  attr_id,
zb_uint8_t new_value 
)

Hook on Write attribute.

Parameters
endpoint- endpoint number
attr_id- ID of attribute being written
new_value- pointer to new value of attribute