Gas Proxy Function#

Callbacks for Gas Proxy Function Component.

Callbacks#

void
emberAfPluginGasProxyFunctionNonTapOffMessageHandlerCompletedCallback(uint8_t *gbzCommandsResponse, uint16_t gbzCommandsResponseLength)

Notify the application that the Non Tap Off Message (Non-TOM) has been handled by the mirror endpoint.

void
emberAfPluginGasProxyFunctionAlertWANCallback(uint16_t alertCode, uint8_t *gbzAlert, uint16_t gbzAlertLength)

Notify the application of an Alert that should be sent to the WAN.

void
emberAfPluginGasProxyFunctionTapOffMessageFutureCommandIgnoredCallback(const EmberAfGpfMessage *gpfMessage, const EmberAfClusterCommand *zclClusterCommand)

Notify the application that an elemental ZCL command, embedded within the Tap Off Message (TOM), has been ignored by the GPF as it is a future dated command.

bool
emberAfPluginGasProxyFunctionDataLogAccessRequestCallback(const EmberAfGpfMessage *gpfMessage, const EmberAfClusterCommand *zclClusterCommand)

Query the application regarding the processing of the current GBCS-specific command.

EmberAfGpfZclCommandPermission
emberAfPluginGasProxyFunctionValidateIncomingZclCommandCallback(const EmberAfClusterCommand *cmd, uint16_t messageCode)

Validate the incoming ZCL command.

void
emberAfPluginGasProxyFunctionUnknownSeasonWeekIdCallback(uint32_t issuerCalendarId, uint8_t *seasonEntries, uint8_t seasonEntriesLength, uint8_t unknownWeekIdSeasonsMask)

Called when the GPF receives a PublishSeasons command with an unknown week ID in one of the seasons.

void
emberAfPluginGasProxyFunctionUnknownSpecialDaysDayIdCallback(uint32_t issuerCalendarId, uint8_t *specialDayEntries, uint8_t specialDayEntriesLength, uint8_t unknownDayIdMask)

Called when the GPF receives a PublishSpecialDays command with an unknown day ID for one of the special days.

Callbacks Documentation#

emberAfPluginGasProxyFunctionNonTapOffMessageHandlerCompletedCallback#

void emberAfPluginGasProxyFunctionNonTapOffMessageHandlerCompletedCallback (uint8_t * gbzCommandsResponse, uint16_t gbzCommandsResponseLength)

Notify the application that the Non Tap Off Message (Non-TOM) has been handled by the mirror endpoint.

Parameters
N/AgbzCommandsResponse

Ver.: always

N/AgbzCommandsResponseLength

Ver.: always

This callback is invoked when the the Non Tap Off Message have been processed. The first argument is a pointer to the GBZ commands response buffer. The application is responsible for freeing this buffer.


Definition at line 121 of file app/framework/plugin/gas-proxy-function/gas-proxy-function.h

emberAfPluginGasProxyFunctionAlertWANCallback#

void emberAfPluginGasProxyFunctionAlertWANCallback (uint16_t alertCode, uint8_t * gbzAlert, uint16_t gbzAlertLength)

Notify the application of an Alert that should be sent to the WAN.

Parameters
N/AalertCode

The 16 bit alert code as defined by GBCS Ver.: always

N/AgbzAlert

Buffer containing the GBZ formatted Alert Ver.: always

N/AgbzAlertLength

The length in octets of the GBZ formatted Alert Ver.: always

The second argument is a pointer to the BGZ alert buffer. The application is responsible for freeing this buffer.


Definition at line 133 of file app/framework/plugin/gas-proxy-function/gas-proxy-function.h

emberAfPluginGasProxyFunctionTapOffMessageFutureCommandIgnoredCallback#

void emberAfPluginGasProxyFunctionTapOffMessageFutureCommandIgnoredCallback (const EmberAfGpfMessage * gpfMessage, const EmberAfClusterCommand * zclClusterCommand)

Notify the application that an elemental ZCL command, embedded within the Tap Off Message (TOM), has been ignored by the GPF as it is a future dated command.

Parameters
N/AgpfMessage

Ver.: always

N/AzclClusterCommand

Ver.: always

The application can use the callback to store the discarded command for later retrieval. When the future dated command becomes active on the GSME, it will inform the CommsHub about the activation via an Alert message. The CommsHub should be able to correlate the matching messages and pass the previously stored ZCL commands to the TOM message handler for processing.


Definition at line 150 of file app/framework/plugin/gas-proxy-function/gas-proxy-function.h

emberAfPluginGasProxyFunctionDataLogAccessRequestCallback#

bool emberAfPluginGasProxyFunctionDataLogAccessRequestCallback (const EmberAfGpfMessage * gpfMessage, const EmberAfClusterCommand * zclClusterCommand)

Query the application regarding the processing of the current GBCS-specific command.

Parameters
N/AgpfMessage

Ver.: always

N/AzclClusterCommand

Ver.: always

Depending on the vendor-specific information, such as the Tenancy attribute in the Device Management Cluster, the callback's return value determines whether the current command gets processed or not. With a return value of true, the plugin will process the message. Otherwise, the plugin will reject the message.


Definition at line 164 of file app/framework/plugin/gas-proxy-function/gas-proxy-function.h

emberAfPluginGasProxyFunctionValidateIncomingZclCommandCallback#

EmberAfGpfZclCommandPermission emberAfPluginGasProxyFunctionValidateIncomingZclCommandCallback (const EmberAfClusterCommand * cmd, uint16_t messageCode)

Validate the incoming ZCL command.

Parameters
N/Acmd

Ver.: always

N/AmessageCode

Ver.: always

Query the application to check if a specific ZCL command should be processed given the UseCase # and ZCL command payload information. This function should capture the behavior detailed by the GBCS Use Case documentation. See EmberAfGpfZclCommandPermission enum for specific return data types.


Definition at line 177 of file app/framework/plugin/gas-proxy-function/gas-proxy-function.h

emberAfPluginGasProxyFunctionUnknownSeasonWeekIdCallback#

void emberAfPluginGasProxyFunctionUnknownSeasonWeekIdCallback (uint32_t issuerCalendarId, uint8_t * seasonEntries, uint8_t seasonEntriesLength, uint8_t unknownWeekIdSeasonsMask)

Called when the GPF receives a PublishSeasons command with an unknown week ID in one of the seasons.

Parameters
N/AissuerCalendarId

The calendar ID associated with these seasons. Ver.: always

N/AseasonEntries

The season entries for this publish command. Ver.: always

N/AseasonEntriesLength

The length of the season entries. Ver.: always

N/AunknownWeekIdSeasonsMask

A mask where bit N indicates that the Nth season entry contains an unknown week ID reference. Ver.: always

The callback contains a mask, unknownWeekIdSeasonsMask, with bits set corresponding to season entries that were not published because of an unknown week ID reference.


Definition at line 194 of file app/framework/plugin/gas-proxy-function/gas-proxy-function.h

emberAfPluginGasProxyFunctionUnknownSpecialDaysDayIdCallback#

void emberAfPluginGasProxyFunctionUnknownSpecialDaysDayIdCallback (uint32_t issuerCalendarId, uint8_t * specialDayEntries, uint8_t specialDayEntriesLength, uint8_t unknownDayIdMask)

Called when the GPF receives a PublishSpecialDays command with an unknown day ID for one of the special days.

Parameters
N/AissuerCalendarId

The calendar ID associated with these special days. Ver.: always

N/AspecialDayEntries

The special day entries for this publish command. Ver.: always

N/AspecialDayEntriesLength

The length of the special day entries. Ver.: always

N/AunknownDayIdMask

A mask where bit N indicates that the Nth special day entry contains an unknown day ID reference. Ver.: always

The callback contains a mask, unknownDayIdMask, with bits set corresponding to special day entries that were not published because of an unknown day ID reference.


Definition at line 214 of file app/framework/plugin/gas-proxy-function/gas-proxy-function.h