Developing with ZBOSS for Zigbee
|
Macros | |
#define | ZB_ZCL_CLUSTER_ID_METERING_SERVER_ROLE_GENERATED_CMD_LIST |
#define | ZB_ZCL_CLUSTER_ID_METERING_CLIENT_ROLE_RECEIVED_CMD_LIST ZB_ZCL_CLUSTER_ID_METERING_SERVER_ROLE_GENERATED_CMD_LIST |
#define | ZB_ZCL_CLUSTER_ID_METERING_CLIENT_ROLE_GENERATED_CMD_LIST |
#define | ZB_ZCL_CLUSTER_ID_METERING_SERVER_ROLE_RECEIVED_CMD_LIST ZB_ZCL_CLUSTER_ID_METERING_CLIENT_ROLE_GENERATED_CMD_LIST |
#define | ZB_ZCL_METERING_GET_PROFILE_PAYLOAD_SIZE_IS_VALID(current_size) ((current_size == sizeof(zb_zcl_metering_get_profile_payload_t) ? ZB_TRUE : ZB_FALSE)) |
#define | ZB_ZCL_METERING_SEND_CMD_GET_SNAPSHOT(_param, _dst_addr, _addr_mode, _dst_ep, _src_ep, _payload, cb) |
#define | ZB_ZCL_METERING_SEND_CMD_GET_SAMPLED_DATA(_param, _dst_addr, _addr_mode, _dst_ep, _src_ep, _payload, cb) |
#define | ZB_ZCL_METERING_SEND_CMD_REQUEST_FAST_POLL_MODE(_param, _dst_addr, _addr_mode, _dst_ep, _src_ep, _payload, cb) |
#define | ZB_ZCL_METERING_SEND_CMD_GET_PROFILE(_param, _dst_addr, _addr_mode, _dst_ep, _src_ep, _payload, cb) |
#define | ZB_ZCL_METERING_SEND_CMD_PUBLISH_SNAPSHOT(_param, _dst_addr, _addr_mode, _dst_ep, _src_ep, _payload, cb) |
#define | ZB_ZCL_METERING_SEND_CMD_REQUEST_FAST_POLL_MODE_RESPONSE(_param, _dst_addr, _addr_mode, _dst_ep, _src_ep, _payload, cb) |
#define | ZB_ZCL_METERING_SEND_CMD_GET_PROFILE_RESPONSE(_param, _dst_addr, _addr_mode, _dst_ep, _src_ep, _payload, _pl_size, cb) |
#define | ZB_ZCL_METERING_SEND_CMD_GET_SAMPLED_DATA_RESPONSE(_param, _dst_addr, _addr_mode, _dst_ep, _src_ep, _payload, _pl_size, cb) |
#define ZB_ZCL_CLUSTER_ID_METERING_CLIENT_ROLE_GENERATED_CMD_LIST |
#define ZB_ZCL_CLUSTER_ID_METERING_SERVER_ROLE_GENERATED_CMD_LIST |
#define ZB_ZCL_METERING_SEND_CMD_GET_PROFILE | ( | _param, | |
_dst_addr, | |||
_addr_mode, | |||
_dst_ep, | |||
_src_ep, | |||
_payload, | |||
cb | |||
) |
Macro for call zb_zcl_metering_send_cmd_get_profile function
#define ZB_ZCL_METERING_SEND_CMD_GET_PROFILE_RESPONSE | ( | _param, | |
_dst_addr, | |||
_addr_mode, | |||
_dst_ep, | |||
_src_ep, | |||
_payload, | |||
_pl_size, | |||
cb | |||
) |
Macro for call zb_zcl_metering_send_cmd_get_profile_response function
#define ZB_ZCL_METERING_SEND_CMD_GET_SAMPLED_DATA | ( | _param, | |
_dst_addr, | |||
_addr_mode, | |||
_dst_ep, | |||
_src_ep, | |||
_payload, | |||
cb | |||
) |
Macro for call zb_zcl_metering_send_cmd_get_sampled_data function
#define ZB_ZCL_METERING_SEND_CMD_GET_SAMPLED_DATA_RESPONSE | ( | _param, | |
_dst_addr, | |||
_addr_mode, | |||
_dst_ep, | |||
_src_ep, | |||
_payload, | |||
_pl_size, | |||
cb | |||
) |
Macro for call zb_zcl_metering_send_cmd_get_sampled_data_response function
#define ZB_ZCL_METERING_SEND_CMD_GET_SNAPSHOT | ( | _param, | |
_dst_addr, | |||
_addr_mode, | |||
_dst_ep, | |||
_src_ep, | |||
_payload, | |||
cb | |||
) |
Macro for call zb_zcl_metering_send_cmd_get_snapshot function
#define ZB_ZCL_METERING_SEND_CMD_PUBLISH_SNAPSHOT | ( | _param, | |
_dst_addr, | |||
_addr_mode, | |||
_dst_ep, | |||
_src_ep, | |||
_payload, | |||
cb | |||
) |
Macro for call zb_zcl_metering_send_cmd_publish_snapshot function
#define ZB_ZCL_METERING_SEND_CMD_REQUEST_FAST_POLL_MODE | ( | _param, | |
_dst_addr, | |||
_addr_mode, | |||
_dst_ep, | |||
_src_ep, | |||
_payload, | |||
cb | |||
) |
Macro for call zb_zcl_metering_send_cmd_request_fast_poll_mode function
#define ZB_ZCL_METERING_SEND_CMD_REQUEST_FAST_POLL_MODE_RESPONSE | ( | _param, | |
_dst_addr, | |||
_addr_mode, | |||
_dst_ep, | |||
_src_ep, | |||
_payload, | |||
cb | |||
) |
Macro for call zb_zcl_metering_send_cmd_request_fast_poll_mode_response function
SnapshotPayloadType 2 = Block Information Delivered Set
SnapshotPayloadType 3 = Block Information Received Set
typedef struct zb_zcl_metering_block_tier_delivered_no_billing_payload_s zb_zcl_metering_block_tier_delivered_no_billing_payload_t |
SnapshotPayloadType 6 = Block Tier Information Set Delivered (No Billing)
typedef struct zb_zcl_metering_block_tier_received_no_billing_payload_s zb_zcl_metering_block_tier_received_no_billing_payload_t |
SnapshotPayloadType 7 = Block Tier Information Set Received (No Billing)
typedef enum zb_zcl_metering_cli_cmd_e zb_zcl_metering_cli_cmd_t |
Metering cluster client command identifiers.
GetProfile command payload
typedef struct zb_zcl_metering_get_profile_response_payload_s zb_zcl_metering_get_profile_response_payload_t |
GetProfileResponse command payload
typedef struct zb_zcl_metering_get_sampled_data_payload_s zb_zcl_metering_get_sampled_data_payload_t |
GetSampledData command payload
typedef struct zb_zcl_metering_get_sampled_data_response_payload_s zb_zcl_metering_get_sampled_data_response_payload_t |
GetSampledDataResponse command payload
GetSnapshot command payload
typedef struct zb_zcl_metering_publish_snapshot_payload_s zb_zcl_metering_publish_snapshot_payload_t |
PublishSnapshot command payload
typedef struct zb_zcl_metering_request_fast_poll_mode_payload_s zb_zcl_metering_request_fast_poll_mode_payload_t |
RequestFastPollMode command payload
typedef struct zb_zcl_metering_request_fast_poll_mode_response_payload_s zb_zcl_metering_request_fast_poll_mode_response_payload_t |
RequestFastPollModeResponse command payload
The format of the Snapshot Sub-Payload differs depending on the SnapshotPayloadType
typedef enum zb_zcl_metering_srv_cmd_e zb_zcl_metering_srv_cmd_t |
Metering cluster server command identifiers.
typedef struct zb_zcl_metering_tou_delivered_no_billing_payload_s zb_zcl_metering_tou_delivered_no_billing_payload_t |
SnapshotPayloadType 4 = TOU Information Set Delivered (No Billing)
SnapshotPayloadType 0 = TOU Information Delivered Set
typedef struct zb_zcl_metering_tou_received_no_billing_payload_s zb_zcl_metering_tou_received_no_billing_payload_t |
SnapshotPayloadType 5 = TOU Information Set Received (No Billing)
SnapshotPayloadType 1 = TOU Information Received Set
Metering cluster client command identifiers.
Interval Channel Values
Profile Interval Period
Sample Type Enumerations
Snapshot Cause BitMap
Snapshot Payload Type
Metering cluster server command identifiers.
Status Field Values
void zb_zcl_metering_send_cmd_get_profile | ( | zb_uint8_t | param, |
zb_addr_u * | dst_addr, | ||
zb_aps_addr_mode_t | dst_addr_mode, | ||
zb_uint8_t | dst_ep, | ||
zb_uint8_t | src_ep, | ||
zb_zcl_metering_get_profile_payload_t * | payload, | ||
zb_callback_t | cb | ||
) |
Function for send GetProfile command. On receiver's side callback ZCL device callback ZB_ZCL_REGISTER_DEVICE_CB will be called with ZB_ZCL_METERING_GET_PROFILE_CB_ID
param | - Reference to buffer. |
dst_addr | - Address of the device to send command to. |
dst_addr_mode | - Address mode for dst_addr. |
dst_ep | - Destination endpoint. |
src_ep | - Current endpoint. |
payload | - Packet payload (ref to zb_zcl_metering_get_profile_payload_t). |
cb | - Callback which should be called when the ZCL stack receives APS ack. |
void zb_zcl_metering_send_cmd_get_profile_response | ( | zb_uint8_t | param, |
const zb_addr_u * | dst_addr, | ||
zb_aps_addr_mode_t | dst_addr_mode, | ||
zb_uint8_t | dst_ep, | ||
zb_uint8_t | src_ep, | ||
const zb_zcl_metering_get_profile_response_payload_t * | pl, | ||
zb_uint8_t | pl_size, | ||
zb_uint8_t | tsn, | ||
zb_callback_t | cb | ||
) |
Function for send GetProfileResponse command. On receiver's side callback ZCL device callback ZB_ZCL_REGISTER_DEVICE_CB will be called with ZB_ZCL_METERING_GET_PROFILE_RESPONSE_CB_ID
param | - Reference to buffer. |
dst_addr | - Address of the device to send command to. |
dst_addr_mode | - Address mode for dst_addr. |
dst_ep | - Destination endpoint. |
src_ep | - Current endpoint. |
pl | - Packet payload (ref to zb_zcl_metering_get_profile_response_payload_t). |
pl_size | - size in bytes of input payload. Stack can calculate actual payload size. Set pl_size to 0 for it. |
tsn | - transaction sequence number of response |
cb | - Callback which should be called when the ZCL stack receives APS ack. |
void zb_zcl_metering_send_cmd_get_sampled_data | ( | zb_uint8_t | param, |
zb_addr_u * | dst_addr, | ||
zb_aps_addr_mode_t | dst_addr_mode, | ||
zb_uint8_t | dst_ep, | ||
zb_uint8_t | src_ep, | ||
zb_zcl_metering_get_sampled_data_payload_t * | payload, | ||
zb_callback_t | cb | ||
) |
Function for send GetSampledData command. On receiver's side callback ZCL device callback ZB_ZCL_REGISTER_DEVICE_CB will be called with ZB_ZCL_METERING_GET_SAMPLED_DATA_CB_ID
param | - Reference to buffer. |
dst_addr | - Address of the device to send command to. |
dst_addr_mode | - Address mode for dst_addr. |
dst_ep | - Destination endpoint. |
src_ep | - Current endpoint. |
payload | - Packet payload (ref to zb_zcl_metering_get_sampled_data_payload_t). |
cb | - Callback which should be called when the ZCL stack receives APS ack. |
void zb_zcl_metering_send_cmd_get_sampled_data_response | ( | zb_uint8_t | param, |
const zb_addr_u * | dst_addr, | ||
zb_aps_addr_mode_t | dst_addr_mode, | ||
zb_uint8_t | dst_ep, | ||
zb_uint8_t | src_ep, | ||
const zb_zcl_metering_get_sampled_data_response_payload_t * | pl, | ||
zb_uint8_t | pl_size, | ||
zb_uint8_t | tsn, | ||
zb_callback_t | cb | ||
) |
Function for send GetSampledDataResponse command. On receiver's side callback ZCL device callback ZB_ZCL_REGISTER_DEVICE_CB will be called with ZB_ZCL_METERING_GET_SAMPLED_DATA_RESPONSE_CB_ID
param | - Reference to buffer. |
dst_addr | - Address of the device to send command to. |
dst_addr_mode | - Address mode for dst_addr. |
dst_ep | - Destination endpoint. |
src_ep | - Current endpoint. |
pl | - Packet payload (ref to zb_zcl_metering_get_sampled_data_response_payload_t). |
pl_size | - size in bytes of input payload. Stack can calculate actual payload size. Set pl_size to 0 for it. |
tsn | - transaction sequence number of response |
cb | - Callback which should be called when the ZCL stack receives APS ack. |
void zb_zcl_metering_send_cmd_get_snapshot | ( | zb_uint8_t | param, |
zb_addr_u * | dst_addr, | ||
zb_aps_addr_mode_t | dst_addr_mode, | ||
zb_uint8_t | dst_ep, | ||
zb_uint8_t | src_ep, | ||
zb_zcl_metering_get_snapshot_payload_t * | payload, | ||
zb_callback_t | cb | ||
) |
Function for send GetSnapshot command. On receiver's side callback ZCL device callback ZB_ZCL_REGISTER_DEVICE_CB will be called with ZB_ZCL_METERING_GET_SNAPSHOT_CB_ID
param | - Reference to buffer. |
dst_addr | - Address of the device to send command to. |
dst_addr_mode | - Address mode for dst_addr. |
dst_ep | - Destination endpoint. |
src_ep | - Current endpoint. |
payload | - Packet payload (ref to zb_zcl_metering_get_snapshot_payload_t). |
cb | - Callback which should be called when the ZCL stack receives APS ack. |
void zb_zcl_metering_send_cmd_publish_snapshot | ( | zb_uint8_t | param, |
const zb_addr_u * | dst_addr, | ||
zb_aps_addr_mode_t | dst_addr_mode, | ||
zb_uint8_t | dst_ep, | ||
zb_uint8_t | src_ep, | ||
const zb_zcl_metering_publish_snapshot_payload_t * | pl, | ||
zb_callback_t | cb | ||
) |
Function for send PublishSnapshot command. On receiver's side callback ZCL device callback ZB_ZCL_REGISTER_DEVICE_CB will be called with ZB_ZCL_METERING_PUBLISH_SNAPSHOT_CB_ID
param | - Reference to buffer. |
dst_addr | - Address of the device to send command to. |
dst_addr_mode | - Address mode for dst_addr. |
dst_ep | - Destination endpoint. |
src_ep | - Current endpoint. |
pl | - Packet payload (ref to zb_zcl_metering_publish_snapshot_payload_t). |
cb | - Callback which should be called when the ZCL stack receives APS ack. |
void zb_zcl_metering_send_cmd_request_fast_poll_mode | ( | zb_uint8_t | param, |
zb_addr_u * | dst_addr, | ||
zb_aps_addr_mode_t | dst_addr_mode, | ||
zb_uint8_t | dst_ep, | ||
zb_uint8_t | src_ep, | ||
zb_zcl_metering_request_fast_poll_mode_payload_t * | payload, | ||
zb_callback_t | cb | ||
) |
Function for send RequestFastPollMode command. On receiver's side callback ZCL device callback ZB_ZCL_REGISTER_DEVICE_CB will be called with ZB_ZCL_METERING_REQUEST_FAST_POLL_MODE_CB_ID
param | - Reference to buffer. |
dst_addr | - Address of the device to send command to. |
dst_addr_mode | - Address mode for dst_addr. |
dst_ep | - Destination endpoint. |
src_ep | - Current endpoint. |
payload | - Packet payload (ref to zb_zcl_metering_request_fast_poll_mode_payload_t). |
cb | - Callback which should be called when the ZCL stack receives APS ack. |
void zb_zcl_metering_send_cmd_request_fast_poll_mode_response | ( | zb_uint8_t | param, |
const zb_addr_u * | dst_addr, | ||
zb_aps_addr_mode_t | dst_addr_mode, | ||
zb_uint8_t | dst_ep, | ||
zb_uint8_t | src_ep, | ||
const zb_zcl_metering_request_fast_poll_mode_response_payload_t * | pl, | ||
zb_uint8_t | pl_size, | ||
zb_uint8_t | tsn, | ||
zb_callback_t | cb | ||
) |
Function for send RequestFastPollMode command. On receiver's side callback ZCL device callback ZB_ZCL_REGISTER_DEVICE_CB will be called with ZB_ZCL_METERING_REQUEST_FAST_POLL_MODE_CB_ID
param | - Reference to buffer. |
dst_addr | - Address of the device to send command to. |
dst_addr_mode | - Address mode for dst_addr. |
dst_ep | - Destination endpoint. |
src_ep | - Current endpoint. |
pl | - Packet payload (ref to zb_zcl_metering_request_fast_poll_mode_response_payload_t). |
pl_size | - size in bytes of input payload. Stack can calculate actual payload size. Set pl_size to 0 for it. |
tsn | - transaction sequence number of response |
cb | - Callback which should be called when the ZCL stack receives APS ack. |