Data Structures | |
struct | zb_zcl_drlc_lce_payload_s |
struct | zb_zcl_drlc_cancel_lce_payload_s |
struct | zb_zcl_drlc_cancel_alce_payload_s |
struct | zb_zcl_drlc_report_event_status_payload_s |
struct | zb_zcl_drlc_get_scheduled_events_payload_s |
Macros | |
#define | ZB_ZCL_DRLC_SRV_CMD_LOAD_CONTROL_EVENT_IS_VALID(size) ((size) >= sizeof(zb_zcl_drlc_lce_payload_t)) |
#define | ZB_ZCL_DRLC_SRV_CMD_CANCEL_LOAD_CONTROL_EVENT_IS_VALID(size) ((size) >= sizeof(zb_zcl_drlc_cancel_lce_payload_t)) |
#define | ZB_ZCL_DRLC_SRV_CMD_CANCEL_ALL_LOAD_CONTROL_EVENTS_IS_VALID(size) ((size) >= sizeof(zb_zcl_drlc_cancel_alce_payload_t)) |
#define | ZB_ZCL_DRLC_CLI_CMD_REPORT_EVENT_STATUS_IS_VALID(size) ((size) >= sizeof(zb_zcl_drlc_report_event_status_payload_t)) |
#define | ZB_ZCL_DRLC_LCE_PAYLOAD_INIT |
#define | ZB_ZCL_DRLC_CANCEL_LCE_PAYLOAD_INIT (zb_zcl_drlc_cancel_lce_payload_t) {0} |
#define | ZB_ZCL_DRLC_CANCEL_ALCE_PAYLOAD_INIT (zb_zcl_drlc_cancel_alce_payload_t) {0} |
#define | ZB_ZCL_DRLC_REPORT_EVENT_STATUS_PAYLOAD_INIT |
#define | ZB_ZCL_DRLC_GET_SCHEDULED_EVENTS_PAYLOAD_SIZE_IS_VALID(size) |
#define | ZB_ZCL_DRLC_CMD_GET_SCHEDULED_EVENTS_PAYLOAD_INIT |
#define | ZB_ZCL_DRLC_SEND_CMD_LOAD_CONTROL_EVENT(_param, _dst_addr, _dst_addr_mode, _dst_ep, _src_ep, _payload) |
#define | ZB_ZCL_DRLC_SEND_CMD_CANCEL_LCE(_param, _dst_addr, _dst_addr_mode, _dst_ep, _src_ep, _payload) |
#define | ZB_ZCL_DRLC_SEND_CMD_CANCEL_ALL_LCE(_param, _dst_addr, _dst_addr_mode, _dst_ep, _src_ep, _payload) |
#define | ZB_ZCL_DRLC_SEND_CMD_GET_SCHEDULED_EVENTS(_param, _dst_addr, _dst_addr_mode, _dst_ep, _src_ep, _payload) |
#define | ZB_ZCL_DRLC_SEND_CMD_REPORT_EVENT_STATUS(_param, _dst_addr, _dst_addr_mode, _dst_ep, _src_ep, _payload) |
Typedefs | |
typedef enum zb_zcl_drlc_srv_cmd_e | zb_zcl_drlc_srv_cmd_t |
typedef enum zb_zcl_drlc_cli_cmd_e | zb_zcl_drlc_cli_cmd_t |
typedef struct zb_zcl_drlc_lce_payload_s | zb_zcl_drlc_lce_payload_t |
typedef struct zb_zcl_drlc_cancel_lce_payload_s | zb_zcl_drlc_cancel_lce_payload_t |
typedef struct zb_zcl_drlc_cancel_alce_payload_s | zb_zcl_drlc_cancel_alce_payload_t |
typedef struct zb_zcl_drlc_report_event_status_payload_s | zb_zcl_drlc_report_event_status_payload_t |
typedef struct zb_zcl_drlc_get_scheduled_events_payload_s | zb_zcl_drlc_get_scheduled_events_payload_t |
Enumerations | |
enum | zb_zcl_drlc_srv_cmd_e { ZB_ZCL_DRLC_SRV_CMD_LOAD_CONTROL_EVENT = 0x00, ZB_ZCL_DRLC_SRV_CMD_CANCEL_LOAD_CONTROL_EVENT = 0x01, ZB_ZCL_DRLC_SRV_CMD_CANCEL_ALL_LOAD_CONTROL_EVENTS = 0x02 } |
enum | zb_zcl_drlc_cli_cmd_e { ZB_ZCL_DRLC_CLI_CMD_REPORT_EVENT_STATUS = 0x00, ZB_ZCL_DRLC_CLI_CMD_GET_SCHEDULED_EVENTS = 0x01 } |
This section describes all commands structures and data payloads.
#define ZB_ZCL_DRLC_CANCEL_ALCE_PAYLOAD_INIT (zb_zcl_drlc_cancel_alce_payload_t) {0} |
Initialize CancelAllLoadControlEvents command zb_zcl_drlc_cancel_alce_payload_t payload
#define ZB_ZCL_DRLC_CANCEL_LCE_PAYLOAD_INIT (zb_zcl_drlc_cancel_lce_payload_t) {0} |
Initialize CancelLoadControlEvent command zb_zcl_drlc_cancel_lce_payload_t payload
#define ZB_ZCL_DRLC_CMD_GET_SCHEDULED_EVENTS_PAYLOAD_INIT |
Initialize GetScheduledEvents command zb_zcl_drlc_get_scheduled_events_payload_t payload
#define ZB_ZCL_DRLC_GET_SCHEDULED_EVENTS_PAYLOAD_SIZE_IS_VALID | ( | size | ) |
Check if some size in range of variable size of specified payload.
#define ZB_ZCL_DRLC_LCE_PAYLOAD_INIT |
Initialize LoadControlEvent command zb_zcl_drlc_lce_payload_t payload
#define ZB_ZCL_DRLC_REPORT_EVENT_STATUS_PAYLOAD_INIT |
Initialize ReportEventStatus command zb_zcl_drlc_report_event_status_payload_t payload
#define ZB_ZCL_DRLC_SEND_CMD_CANCEL_ALL_LCE | ( | _param, | |
_dst_addr, | |||
_dst_addr_mode, | |||
_dst_ep, | |||
_src_ep, | |||
_payload | |||
) |
Macro for call zb_drlc_server_send_cancel_all_load_control_events function
#define ZB_ZCL_DRLC_SEND_CMD_CANCEL_LCE | ( | _param, | |
_dst_addr, | |||
_dst_addr_mode, | |||
_dst_ep, | |||
_src_ep, | |||
_payload | |||
) |
Macro for call zb_drlc_server_send_cancel_load_control_event function
#define ZB_ZCL_DRLC_SEND_CMD_GET_SCHEDULED_EVENTS | ( | _param, | |
_dst_addr, | |||
_dst_addr_mode, | |||
_dst_ep, | |||
_src_ep, | |||
_payload | |||
) |
Macro for call zb_drlc_client_send_get_scheduled_events function
#define ZB_ZCL_DRLC_SEND_CMD_LOAD_CONTROL_EVENT | ( | _param, | |
_dst_addr, | |||
_dst_addr_mode, | |||
_dst_ep, | |||
_src_ep, | |||
_payload | |||
) |
Macro for call zb_drlc_server_send_load_control_event function
#define ZB_ZCL_DRLC_SEND_CMD_REPORT_EVENT_STATUS | ( | _param, | |
_dst_addr, | |||
_dst_addr_mode, | |||
_dst_ep, | |||
_src_ep, | |||
_payload | |||
) |
Macro for call zb_drlc_client_send_report_event_status function
CancelAllLoadControlEvents command payload
typedef struct zb_zcl_drlc_cancel_lce_payload_s zb_zcl_drlc_cancel_lce_payload_t |
CancelLoadControlEvent command payload
typedef enum zb_zcl_drlc_cli_cmd_e zb_zcl_drlc_cli_cmd_t |
Commands are generated by DRLC Client.
typedef struct zb_zcl_drlc_get_scheduled_events_payload_s zb_zcl_drlc_get_scheduled_events_payload_t |
GetScheduledEvents command payload
typedef struct zb_zcl_drlc_lce_payload_s zb_zcl_drlc_lce_payload_t |
LoadControlEvent command payload.
ReportEventStatus command payload
typedef enum zb_zcl_drlc_srv_cmd_e zb_zcl_drlc_srv_cmd_t |
Commands are generated by DRLC Server.
Commands are generated by DRLC Client.
Commands are generated by DRLC Server.
Enumerator | |
---|---|
ZB_ZCL_DRLC_SRV_CMD_LOAD_CONTROL_EVENT |
LoadControlEvent is generated when the ESI wants to control one or more load control devices usually as the result of an energy curtailment command from the Smart Energy Network.
|
ZB_ZCL_DRLC_SRV_CMD_CANCEL_LOAD_CONTROL_EVENT |
CancelLoadControlEvent is generated when the ESI wants to cancel previously scheduled control of one or more load control devices, usually as the result of an energy curtailment command from the Smart Energy Network
|
ZB_ZCL_DRLC_SRV_CMD_CANCEL_ALL_LOAD_CONTROL_EVENTS |
CancellAllLoadControlEvents is generated when the ESI wants to cancel all events for control device(s) |
void zb_drlc_client_send_get_scheduled_events | ( | 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_drlc_get_scheduled_events_payload_t * | payload, | ||
zb_callback_t | cb | ||
) |
Function for send GetScheduledEvents command. On receiver's side callback ZCL device callback ZB_ZCL_REGISTER_DEVICE_CB will be called with ZB_ZCL_DRLC_GET_SCHEDULED_EVENTS_CB_ID callback 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 (zb_zcl_drlc_get_scheduled_events_payload_t). |
cb | - Callback which should be called when the ZCL stack receives APS ack. |
void zb_drlc_client_send_report_event_status | ( | 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_drlc_report_event_status_payload_t * | payload, | ||
zb_callback_t | cb | ||
) |
Function for send ReportEventStatus command. On sender's side callback ZCL device callback ZB_ZCL_REGISTER_DEVICE_CB will be called with one of ZB_ZCL_DRLC_LOAD_CONTROL_EVENT_CB_ID, ZB_ZCL_DRLC_CANCEL_LOAD_CONTROL_EVENT_CB_ID, ZB_ZCL_DRLC_CANCEL_ALL_LOAD_CONTROL_EVENTS_CB_ID callback ids on reception of LoadControlEvent, CancelLoadControlEvent, CancellAllLoadControlEvents commands respectively.
On receiver's side callback ZCL device callback ZB_ZCL_REGISTER_DEVICE_CB will be called with ZB_ZCL_DRLC_REPORT_EVENT_STATUS_CB_ID callback 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 (zb_zcl_drlc_report_event_status_payload_t). |
cb | - Callback which should be called when the ZCL stack receives APS ack. |
void zb_drlc_server_send_cancel_all_load_control_events | ( | 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_uint8_t * | payload, | ||
zb_callback_t | cb | ||
) |
Function for send CancellAllLoadControlEvents command. On receiver's side callback ZCL device callback ZB_ZCL_REGISTER_DEVICE_CB will be called with ZB_ZCL_DRLC_CANCEL_ALL_LOAD_CONTROL_EVENTS_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: pointer to zb_uint8_t, where "Cancel Control" field value is placed (see SE spec, D.2.2.3.3.1). |
cb | - Callback which should be called when the ZCL stack receives APS ack. |
void zb_drlc_server_send_cancel_load_control_event | ( | 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_drlc_cancel_lce_payload_t * | payload, | ||
zb_callback_t | cb | ||
) |
Function for send CancelLoadControlEvent command. On receiver's side callback ZCL device callback ZB_ZCL_REGISTER_DEVICE_CB will be called with ZB_ZCL_DRLC_CANCEL_LOAD_CONTROL_EVENT_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 (zb_zcl_drlc_cancel_lce_payload_t). |
cb | - Callback which should be called when the ZCL stack receives APS ack. |
void zb_drlc_server_send_load_control_event | ( | 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_drlc_lce_payload_t * | payload, | ||
zb_callback_t | cb | ||
) |
Function for send LoadControlEvent command. On sender's side callback ZCL device callback ZB_ZCL_REGISTER_DEVICE_CB will be called with ZB_ZCL_DRLC_GET_SCHEDULED_EVENTS_CB_ID callback id on reception of GetScheduledEvents command.
On receiver's side callback ZCL device callback ZB_ZCL_REGISTER_DEVICE_CB will be called with ZB_ZCL_DRLC_LOAD_CONTROL_EVENT_CB_ID callback 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 (zb_zcl_drlc_lce_payload_t). |
cb | - Callback which should be called when the ZCL stack receives APS ack. |