GBZ Message Controller#

emberAfPluginGbzMessageControllerCreatorAssemble#

EmberAfGbzMessageCreatorResult* emberAfPluginGbzMessageControllerCreatorAssemble (EmberAfGbzMessageCreatorState * state)

Assemble appended ZCL responses into 1 big chunk of memory.

emberAfPluginGbzMessageControllerGetZclDefaultResponse#

EmberAfStatus emberAfPluginGbzMessageControllerGetZclDefaultResponse (EmberAfGbzZclCommand * cmd)

Get the default response byte from the GBZ ZCL Command.

emberAfPluginGbzMessageControllerHasNextCommand#

bool emberAfPluginGbzMessageControllerHasNextCommand (EmberAfGbzMessageParserState * state)

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

emberAfPluginGbzMessageControllerParserCleanup#

void emberAfPluginGbzMessageControllerParserCleanup (EmberAfGbzMessageParserState * state)

Clean any resources allocated during the parsing of GBZ message.

emberAfPluginGbzMessageControllerParserInit#

bool emberAfPluginGbzMessageControllerParserInit (EmberAfGbzMessageParserState * state, EmberAfGbzMessageType 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, emberAfPluginGbzMessageControllerHasNextCommand() and emberAfPluginGbzMessageControllerNextCommand() are used to iterate through each of the embedded ZCL functions.

emberAfPluginGbzMessageControllerAppendCommand#

uint16_t emberAfPluginGbzMessageControllerAppendCommand (EmberAfGbzMessageCreatorState * state, EmberAfGbzZclCommand * 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.

emberAfPluginGbzMessageControllerCreatorInit#

uint16_t emberAfPluginGbzMessageControllerCreatorInit (EmberAfGbzMessageCreatorState * state, EmberAfGbzMessageType 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. emberAfPluginGbzMessageControllerCreatorInit() - create

2. emberAfPluginGbzMessageControllerAppendCommand() - append

3. emberAfPluginGbzMessageControllerCreatorAssemble() - assemble result.

4. emberAfPluginGbzMessageControllerCreatorCleanup() - memory clean up

emberAfPluginGbzMessageControllerGetComponentSize#

uint8_t emberAfPluginGbzMessageControllerGetComponentSize (EmberAfGbzMessageParserState * state)

Return the command size of the given parser structure.

emberAfPluginGbzMessageControllerCreatorCleanup#

void emberAfPluginGbzMessageControllerCreatorCleanup (EmberAfGbzMessageCreatorState * state)

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

emberAfPluginGbzMessageControllerNextCommand#

void emberAfPluginGbzMessageControllerNextCommand (EmberAfGbzMessageParserState * state, EmberAfGbzZclCommand * 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.

emberAfPluginGbzMessageControllerPrintCommandInfo#

void emberAfPluginGbzMessageControllerPrintCommandInfo (EmberAfGbzZclCommand * gbzZclCommand)

Print out all information retained in a EmberAfGbzZclCommand structure.

emAfPluginGbzMessageControllerGetLength#

uint16_t emAfPluginGbzMessageControllerGetLength (EmberAfGbzZclCommand * cmd, EmberAfGbzMessageData * msg)

Get the length of the overall GBZ message.

emberAfPluginGbzMessageControllerGetEncryptPayloadFlag#

bool emberAfPluginGbzMessageControllerGetEncryptPayloadFlag (EmberAfGbzMessageCreatorState * state, EmberAfGbzZclCommand * resp)

Indicate whether the ZCL payload will be encrypted.

GBCSUseCaseMessageCode#

GBCSUseCaseMessageCode

EmberAfGbzExtendedHeaderControlField#

EmberAfGbzExtendedHeaderControlField

EmberAfGbzMessageType#

EmberAfGbzMessageType

EmAfGbzUseCaseSpecificComponent#

typedef struct EmAfGbzUseCaseSpecificComponent EmAfGbzUseCaseSpecificComponent

emberAfClusterSpecificCommandParse#

EmberAfStatus emberAfClusterSpecificCommandParse (EmberAfClusterCommand * cmd)

emberAfPluginGbzMessageControllerPrint#

#define emberAfPluginGbzMessageControllerPrint

(...)

emberAfPluginGbzMessageControllerPrintln#

#define emberAfPluginGbzMessageControllerPrintln

(...)

emberAfPluginGbzMessageControllerDebugExec#

#define emberAfPluginGbzMessageControllerDebugExec

(x)

emberAfPluginGbzMessageControllerPrintBuffer#

#define emberAfPluginGbzMessageControllerPrintBuffer

(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)