GBZ Message Controller#

sl_zigbee_af_gbz_message_controller_creator_assemble#

sl_zigbee_af_gbz_message_creator_result_t * sl_zigbee_af_gbz_message_controller_creator_assemble (sl_zigbee_af_gbz_message_creator_state_t * state)

Assemble appended ZCL responses into 1 big chunk of memory.

sl_zigbee_af_gbz_message_controller_get_zcl_default_response#

sl_zigbee_af_status_t sl_zigbee_af_gbz_message_controller_get_zcl_default_response (sl_zigbee_af_gbz_zcl_command_t * cmd)

Get the default response byte from the GBZ ZCL Command.

sl_zigbee_af_gbz_message_controller_has_next_command#

bool sl_zigbee_af_gbz_message_controller_has_next_command (sl_zigbee_af_gbz_message_parser_state_t * state)

Check the GBZ parser structure for any non-parsed commands.

sl_zigbee_af_gbz_message_controller_parser_cleanup#

void sl_zigbee_af_gbz_message_controller_parser_cleanup (sl_zigbee_af_gbz_message_parser_state_t * state)

Clean any resources allocated during the parsing of GBZ message.

sl_zigbee_af_gbz_message_controller_parser_init#

bool sl_zigbee_af_gbz_message_controller_parser_init (sl_zigbee_af_gbz_message_parser_state_t * state, sl_zigbee_af_gbz_message_type_t type, uint8_t * gbzCommand, uint16_t gbzCommandLength, bool copyGbzCommand, uint16_t messageCode)

Initialize proper parsing states for decoding GBZ messages.

The GBZ message payload and payload length are passed in as arguments. Iterator functions, sl_zigbee_af_gbz_message_controller_has_next_command() and sl_zigbee_af_gbz_message_controller_next_command() are used to iterate through each of the embedded ZCL functions.

sl_zigbee_af_gbz_message_controller_append_command#

uint16_t sl_zigbee_af_gbz_message_controller_append_command (sl_zigbee_af_gbz_message_creator_state_t * state, sl_zigbee_af_gbz_zcl_command_t * zclCmd)

Append a ZCL command to a given GBZ creator structure.

Returns

• 0 - if the appending operation did not succeed else - number of appended bytes.

sl_zigbee_af_gbz_message_controller_creator_init#

uint16_t sl_zigbee_af_gbz_message_controller_creator_init (sl_zigbee_af_gbz_message_creator_state_t * state, sl_zigbee_af_gbz_message_type_t type, uint16_t alertCode, uint32_t timestamp, uint16_t messageCode, uint8_t * gbzCommand, uint16_t gbzCommandLength)

Initialize proper states for construction of GBZ messages.

Depending on the value of the argument (gbzCommand), the creator behaves differently. If a NULL value is passed, the creator assumes you want the API to allocate memory to store the appended responses. Otherwise, the creator uses the provided buffer as the destination for storing responses.

Below is a general flow to make ZCL messages into a GBZ message.

1. sl_zigbee_af_gbz_message_controller_creator_init() - create

2. sl_zigbee_af_gbz_message_controller_append_command() - append

3. sl_zigbee_af_gbz_message_controller_creator_assemble() - assemble result.

4. sl_zigbee_af_gbz_message_controller_creator_cleanup() - memory clean up

sl_zigbee_af_gbz_message_controller_get_component_size#

uint8_t sl_zigbee_af_gbz_message_controller_get_component_size (sl_zigbee_af_gbz_message_parser_state_t * state)

Return the command size of the given parser structure.

sl_zigbee_af_gbz_message_controller_creator_cleanup#

void sl_zigbee_af_gbz_message_controller_creator_cleanup (sl_zigbee_af_gbz_message_creator_state_t * state)

Clean up/free all allocated memory used to store the overall GBZ response.

sl_zigbee_af_gbz_message_controller_next_command#

void sl_zigbee_af_gbz_message_controller_next_command (sl_zigbee_af_gbz_message_parser_state_t * state, sl_zigbee_af_gbz_zcl_command_t * gbzZclCommand)

Get the next available ZCL command from the given GBZ parser structure.

If any payload is encrypted, the decrypted data will overwrite the old data.

sl_zigbee_af_gbz_message_controller_print_command_info#

void sl_zigbee_af_gbz_message_controller_print_command_info (sl_zigbee_af_gbz_zcl_command_t * gbzZclCommand)

Print out all information retained in a sl_zigbee_af_gbz_zcl_command_t structure.

sl_zigbee_af_gbz_message_controller_get_encrypt_payload_flag#

bool sl_zigbee_af_gbz_message_controller_get_encrypt_payload_flag (sl_zigbee_af_gbz_message_creator_state_t * state, sl_zigbee_af_gbz_zcl_command_t * resp)

Indicate whether the ZCL payload will be encrypted.

sli_zigbee_gbcs_use_case_message_code_t#

sli_zigbee_gbcs_use_case_message_code_t

sl_zigbee_af_gbz_extended_header_control_field_t#

sl_zigbee_af_gbz_extended_header_control_field_t

sl_zigbee_af_gbz_message_type_t#

sl_zigbee_af_gbz_message_type_t

sli_zigbee_af_gbz_use_case_specific_component#

typedef struct sli_zigbee_af_gbz_use_case_specific_component sli_zigbee_af_gbz_use_case_specific_component

sl_zigbee_af_cluster_specific_command_parse#

sl_zigbee_af_status_t sl_zigbee_af_cluster_specific_command_parse (sl_zigbee_af_cluster_command_t * cmd)

sl_zigbee_af_gbz_message_controller_print#

#define sl_zigbee_af_gbz_message_controller_print

(...)

sl_zigbee_af_gbz_message_controller_println#

#define sl_zigbee_af_gbz_message_controller_println

(...)

sl_zigbee_af_gbz_message_controller_debug_exec#

#define sl_zigbee_af_gbz_message_controller_debug_exec

(x)

sl_zigbee_af_gbz_message_controller_print_buffer#

#define sl_zigbee_af_gbz_message_controller_print_buffer

(buffer, len, withSpace)

GAS_PROXY_FUNCTION_GBZ_COMPONENT_EXT_HEADER_CONTROL_FIELD_OFFSET#

#define GAS_PROXY_FUNCTION_GBZ_COMPONENT_EXT_HEADER_CONTROL_FIELD_OFFSET

(0)

GAS_PROXY_FUNCTION_GBZ_COMPONENT_EXT_HEADER_CLUSTER_ID_OFFSET#

#define GAS_PROXY_FUNCTION_GBZ_COMPONENT_EXT_HEADER_CLUSTER_ID_OFFSET

(2)

GAS_PROXY_FUNCTION_GBZ_COMPONENT_EXT_HEADER_GBZ_CMD_LENGTH_OFFSET#

#define GAS_PROXY_FUNCTION_GBZ_COMPONENT_EXT_HEADER_GBZ_CMD_LENGTH_OFFSET

(3)

GAS_PROXY_FUNCTION_GBZ_MESSAGE_COMMAND_HEADER_LENGTH#

#define GAS_PROXY_FUNCTION_GBZ_MESSAGE_COMMAND_HEADER_LENGTH

(3)

GAS_PROXY_FUNCTION_GBZ_MESSAGE_RESPONSE_HEADER_LENGTH#

#define GAS_PROXY_FUNCTION_GBZ_MESSAGE_RESPONSE_HEADER_LENGTH

(3)

GAS_PROXY_FUNCTION_GBZ_MESSAGE_ALERT_HEADER_LENGTH#

#define GAS_PROXY_FUNCTION_GBZ_MESSAGE_ALERT_HEADER_LENGTH

(9)

GAS_PROXY_FUNCTION_GBZ_COMPONENT_EXT_HEADER_FIELDS_LENGTH#

#define GAS_PROXY_FUNCTION_GBZ_COMPONENT_EXT_HEADER_FIELDS_LENGTH

(5)

GAS_PROXY_FUNCTION_GBZ_COMPONENT_EXT_HEADER_FIELDS_LENGTH#

#define GAS_PROXY_FUNCTION_GBZ_COMPONENT_EXT_HEADER_FIELDS_LENGTH

(5)

GAS_PROXY_FUNCTION_GBZ_COMPONENT_ZCL_HEADER_LENGTH#

#define GAS_PROXY_FUNCTION_GBZ_COMPONENT_ZCL_HEADER_LENGTH

(3)

GAS_PROXY_FUNCTION_GBZ_COMPONENT_FROM_DATE_TIME_LENGTH#

#define GAS_PROXY_FUNCTION_GBZ_COMPONENT_FROM_DATE_TIME_LENGTH

(4)

GAS_PROXY_FUNCTION_GBZ_COMPONENT_FROM_DATE_TIME_LENGTH#

#define GAS_PROXY_FUNCTION_GBZ_COMPONENT_FROM_DATE_TIME_LENGTH

(4)

GAS_PROXY_FUNCTION_GBZ_COMPONENT_ENCRYPTION_HEADER_FIELDS_LENGTH#

#define GAS_PROXY_FUNCTION_GBZ_COMPONENT_ENCRYPTION_HEADER_FIELDS_LENGTH

(2)

GAS_PROXY_FUNCTION_GBZ_COMPONENT_ENCRYPTION_HEADER_FIELDS_LENGTH#

#define GAS_PROXY_FUNCTION_GBZ_COMPONENT_ENCRYPTION_HEADER_FIELDS_LENGTH

(2)

GAS_PROXY_FUNCTION_GBZ_COMPONENT_ENCRYPTION_CIPHERED_INFO_LENGTH#

#define GAS_PROXY_FUNCTION_GBZ_COMPONENT_ENCRYPTION_CIPHERED_INFO_LENGTH

(2)

GAS_PROXY_FUNCTION_GBZ_COMPONENT_ENCRYPTION_CIPHERED_INFO_LENGTH#

#define GAS_PROXY_FUNCTION_GBZ_COMPONENT_ENCRYPTION_CIPHERED_INFO_LENGTH

(2)

GAS_PROXY_FUNCTION_GBZ_COMPONENT_LAST_MSG_MASK#

#define GAS_PROXY_FUNCTION_GBZ_COMPONENT_LAST_MSG_MASK

(0x01)

GAS_PROXY_FUNCTION_GBZ_COMPONENT_ENCRYPTED_MSG_MASK#

#define GAS_PROXY_FUNCTION_GBZ_COMPONENT_ENCRYPTED_MSG_MASK

(0x02)

GAS_PROXY_FUNCTION_GBZ_COMPONENT_FROM_DATE_TIME_MASK#

#define GAS_PROXY_FUNCTION_GBZ_COMPONENT_FROM_DATE_TIME_MASK

(0x10)