Gas Proxy Function#

API and Callbacks for the Gas Proxy Function Component.

Silicon Labs implementation of the Gas Proxy Function (GPF). This component receives and processes GBZ Top Off Messages. NOTE: This component uses malloc and should only be used in a non-SoC setup.

Modules#

Gas Proxy Function

Handlers#

EmberStatus
emberAfPluginGasProxyFunctionNonTapOffMessageHandler(uint8_t *gbzCommands, uint16_t gbzCommandsLength, uint16_t messageCode)
EmberStatus
emberAfPluginGasProxyFunctionTapOffMessageHandler(uint8_t *gbzCommand, uint16_t gbzCommandLength, uint8_t *gbzCommandResponse, uint16_t gbzCommandResponseLength, uint16_t messageCode)

API#

bool
emberAfPluginGasProxyFunctionIgnoreFutureCommand(uint32_t startTime)

Ignore future commands. Per GBCS v0.8.1, section 10.3.4.2 Step 12/13, it is inferred that per elemental ZCL command, future commands ( startTime greater than now ) will be discarded and the application will be notified.

Handlers Documentation#

emberAfPluginGasProxyFunctionNonTapOffMessageHandler#

EmberStatus emberAfPluginGasProxyFunctionNonTapOffMessageHandler (uint8_t * gbzCommands, uint16_t gbzCommandsLength, uint16_t messageCode)
Parameters
N/AgbzCommands
N/AgbzCommandsLength
N/AmessageCode

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

emberAfPluginGasProxyFunctionTapOffMessageHandler#

EmberStatus emberAfPluginGasProxyFunctionTapOffMessageHandler (uint8_t * gbzCommand, uint16_t gbzCommandLength, uint8_t * gbzCommandResponse, uint16_t gbzCommandResponseLength, uint16_t messageCode)
Parameters
N/AgbzCommand
N/AgbzCommandLength
N/AgbzCommandResponse
N/AgbzCommandResponseLength
N/AmessageCode

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

API Documentation#

emberAfPluginGasProxyFunctionIgnoreFutureCommand#

bool emberAfPluginGasProxyFunctionIgnoreFutureCommand (uint32_t startTime)

Ignore future commands. Per GBCS v0.8.1, section 10.3.4.2 Step 12/13, it is inferred that per elemental ZCL command, future commands ( startTime greater than now ) will be discarded and the application will be notified.

Parameters
N/AstartTime

Returns

  • true - if future dated current command are ignored, false - otherwise.


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