//

Green Power Frames#


Name: gpProxyTableProcessGpPairing	ID: 0x00C9
Description: Update the GP Proxy table based on a GP pairing.
Command Parameters:
uint32_t options	The options field of the GP Pairing command.
sl_zigbee_gp_address_t addr	The target GPD.
uint8_t commMode	The communication mode of the GP Sink.
uint16_t sinkNetworkAddress	The network address of the GP Sink.
uint16_t sinkGroupId	The group ID of the GP Sink.
uint16_t assignedAlias	The alias assigned to the GPD.
uint8_t[8] sinkIeeeAddress	The IEEE address of the GP Sink.
sl_zigbee_key_data_t gpdKey	The key to use for the target GPD.
uint32_t gpdSecurityFrameCounter	The GPD security frame counter.
uint8_t forwardingRadius	The forwarding radius.
Response Parameters:
bool gpPairingAdded	Whether a GP Pairing has been created or not.


Name: dGpSend	ID: 0x00C6
Description: Adds/removes an entry from the GP Tx Queue.
Command Parameters:
bool action	The action to perform on the GP TX queue (true to add, false to remove).
bool useCca	Whether to use ClearChannelAssessment when transmitting the GPDF.
sl_zigbee_gp_address_t addr	The Address of the destination GPD.
uint8_t gpdCommandId	The GPD command ID to send.
uint8_t gpdAsduLength	The length of the GP command payload.
uint8_t[] gpdAsdu	The GP command payload.
uint8_t gpepHandle	The handle to refer to the GPDF.
uint16_t gpTxQueueEntryLifetimeMs	How long to keep the GPDF in the TX Queue.
Response Parameters:
sl_status_t status	An sl_status_t value indicating success or the reason for failure.


Name: dGpSentHandler	ID: 0x00C7
Description: A callback to the GP endpoint to indicate the result of the GPDF transmission. This frame is a response to the callback command.
Response Parameters:
sl_status_t status	An sl_status_t value indicating success or the reason for failure.
uint8_t gpepHandle	The handle of the GPDF.


Name: gpepIncomingMessageHandler	ID: 0x00C5
Description: A callback invoked by the ZigBee GP stack when a GPDF is received. This frame is a response to the callback command.
Response Parameters:
sl_zigbee_gp_status_t gp_status	The status of the GPDF receive.
uint8_t gpdLink	The gpdLink value of the received GPDF.
uint8_t sequenceNumber	The GPDF sequence number.
sl_zigbee_gp_address_t addr	The address of the source GPD.
sl_zigbee_gp_security_level_t gpdfSecurityLevel	The security level of the received GPDF.
sl_zigbee_gp_key_type_t gpdfSecurityKeyType	The securityKeyType used to decrypt/authenticate the incoming GPDF.
bool autoCommissioning	Whether the incoming GPDF had the auto-commissioning bit set.
uint8_t bidirectionalInfo	Bidirectional information represented in bitfields, where bit0 holds the rxAfterTx of incoming gpdf and bit1 holds if tx queue is available for outgoing gpdf.
uint32_t gpdSecurityFrameCounter	The security frame counter of the incoming GDPF.
uint8_t gpdCommandId	The gpdCommandId of the incoming GPDF.
uint32_t mic	The received MIC of the GPDF.
uint8_t proxyTableIndex	The proxy table index of the corresponding proxy table entry to the incoming GPDF.
uint8_t gpdCommandPayloadLength	The length of the GPD command payload.
uint8_t[] gpdCommandPayload	The GPD command payload.
sl_zigbee_rx_packet_info_t packetInfo	Rx packet information.


Name: gpProxyTableGetEntry	ID: 0x00C8
Description: Retrieves the proxy table entry stored at the passed index.
Command Parameters:
uint8_t proxyIndex	The index of the requested proxy table entry.
Response Parameters:
sl_status_t status	An sl_status_t value indicating success or the reason for failure.
sl_zigbee_gp_proxy_table_entry_t entry	An sl_zigbee_gp_proxy_table_entry_t struct containing a copy of the requested proxy entry.


Name: gpProxyTableLookup	ID: 0x00C0
Description: Finds the index of the passed address in the gp table.
Command Parameters:
sl_zigbee_gp_address_t addr	The address to search for
Response Parameters:
uint8_t index	The index, or 0x00FF for not found


Name: gpSinkTableGetEntry	ID: 0x00DD
Description: Retrieves the sink table entry stored at the passed index.
Command Parameters:
uint8_t sinkIndex	The index of the requested sink table entry.
Response Parameters:
sl_status_t status	An sl_status_t value indicating success or the reason for failure.
sl_zigbee_gp_sink_table_entry_t entry	An sl_zigbee_gp_sink_table_entry_t struct containing a copy of the requested sink entry.


Name: gpSinkTableLookup	ID: 0x00DE
Description: Finds the index of the passed address in the gp table.
Command Parameters:
sl_zigbee_gp_address_t addr	The address to search for.
Response Parameters:
uint8_t index	The index, or 0xFF for not found


Name: gpSinkTableSetEntry	ID: 0x00DF
Description: Retrieves the sink table entry stored at the passed index.
Command Parameters:
uint8_t sinkIndex	The index of the requested sink table entry.
sl_zigbee_gp_sink_table_entry_t entry	An sl_zigbee_gp_sink_table_entry_t struct containing a copy of the sink entry to be updated.
Response Parameters:
sl_status_t status	An sl_status_t value indicating success or the reason for failure.


Name: gpSinkTableRemoveEntry	ID: 0x00E0
Description: Removes the sink table entry stored at the passed index.
Command Parameters:
uint8_t sinkIndex	The index of the requested sink table entry.
Response Parameters: None


Name: gpSinkTableFindOrAllocateEntry	ID: 0x00E1
Description: Finds or allocates a sink entry.
Command Parameters:
sl_zigbee_gp_address_t addr	An sl_zigbee_gp_address_t struct containing a copy of the gpd address to be found.
Response Parameters:
uint8_t index	An index of found or allocated sink or 0xFF if failed.


Name: gpSinkTableClearAll	ID: 0x00E2
Description: Clear the entire sink table.
Command Parameters: None
Response Parameters: None


Name: gpSinkTableInit	ID: 0x0070
Description: Initializes Sink Table.
Command Parameters: None
Response Parameters: None


Name: gpSinkTableSetSecurityFrameCounter	ID: 0x00F5
Description: Sets security framecounter in the sink table.
Command Parameters:
uint8_t index	Index to the Sink table
uint32_t sfc	Security Frame Counter
Response Parameters: None


Name: gpSinkCommission	ID: 0x010A
Description: Puts the GPS in commissioning mode.
Command Parameters:
uint8_t options	commissioning options
uint16_t gpmAddrForSecurity	gpm address for security.
uint16_t gpmAddrForPairing	gpm address for pairing.
uint8_t sinkEndpoint	sink endpoint.
Response Parameters:
sl_status_t status	An sl_status_t value indicating success or the reason for failure.


Name: gpTranslationTableClear	ID: 0x010B
Description: Clears all entries within the translation table.
Command Parameters: None
Response Parameters: None


Name: gpSinkTableGetNumberOfActiveEntries	ID: 0x0118
Description: Return number of active entries in sink table.
Command Parameters: None
Response Parameters:
Uint_t number_of_entries	Number of active entries in sink table.