Green Power Data Types#
This file defines data types relevant to the Green Power implementation.
See gp-types.h for source code.
Modules#
EmberGpTranslationTableAdditionalInfoBlockOptionRecordField
GP Types#
Green Power Security Level.
Green Power Security Security Key Type.
Green Power Application Id.
GP proxy table entry status.
GP sink table entry status.
GP Sink Type.
CGp Transmit options.
Addressing modes for CGp messages.
Transmit options for DGp messages.
Number of GP sink list entries. Minimum is 2 sink list entries.
Number of GP sink list entries. Minimum is 2 sink list entries.
Number of GP sink list entries. Minimum is 2 sink list entries.
Number of GP sink list entries. Minimum is 2 sink list entries.
Number of GP sink list entries. Minimum is 2 sink list entries.
Number of GP sink list entries. Minimum is 2 sink list entries.
Number of GP sink list entries. Minimum is 2 sink list entries.
Number of GP sink list entries. Minimum is 2 sink list entries.
Number of maximum option record entries in translation table.
Number of GP sink list entries. Minimum is 2 sink list entries.
Number of GP sink list entries. Minimum is 2 sink list entries.
Number of GP sink list entries. Minimum is 2 sink list entries.
Number of GP sink list entries. Minimum is 2 sink list entries.
Number of GP sink list entries. Minimum is 2 sink list entries.
Number of GP sink list entries. Minimum is 2 sink list entries.
Number of GP sink list entries. Minimum is 2 sink list entries.
Number of GP sink list entries. Minimum is 2 sink list entries.
Number of GP sink list entries. Minimum is 2 sink list entries.
Number of GP sink list entries. Minimum is 2 sink list entries.
Number of GP sink list entries. Minimum is 2 sink list entries.
Number of GP sink list entries. Minimum is 2 sink list entries.
Number of GP sink list entries. Minimum is 2 sink list entries.
API#
DGp Send.
Gets tx queue head.
Sets maximum limit for number of entries in the tx queue.
Gets the limit set for maximum number of entries in the tx queue.
Gets the number of entries in the tx queue.
Gets an entry from Tx Queue The function searches the tx queue using gpd address pointed by supplied in the input/output argument txQueue and returns the message buffer that currently holding the outgoing gpdf information, returns EMBER_NULL_MESSAGE_BUFFER if not found.
Adds an entry to Tx Queue This function adds an entry along with supplied payload data to the Buffer queue. Returns the buffer handle if success else null message buffer upon failure.
Remove an entry from Tx Queue This function searches and removes the entry provided.
Purges Tx Queue This function purges the tx queue.
Macros#
GP Types Documentation#
EmberGpSecurityLevel#
EmberGpSecurityLevel
Green Power Security Level.
Enumerator | |
---|---|
EMBER_GP_SECURITY_LEVEL_NONE | No Security |
EMBER_GP_SECURITY_LEVEL_RESERVED | Reserved |
EMBER_GP_SECURITY_LEVEL_FC_MIC | 4 Byte Frame Counter and 4 Byte MIC |
EMBER_GP_SECURITY_LEVEL_FC_MIC_ENCRYPTED | 4 Byte Frame Counter and 4 Byte MIC with encryption |
51
of file stack/include/gp-types.h
EmberGpKeyType#
EmberGpKeyType
Green Power Security Security Key Type.
Enumerator | |
---|---|
EMBER_GP_SECURITY_KEY_NONE | No Key |
EMBER_GP_SECURITY_KEY_NWK | GP Security Key Type is Zigbee Network Key |
EMBER_GP_SECURITY_KEY_GPD_GROUP | GP Security Key Type is Group Key |
EMBER_GP_SECURITY_KEY_NWK_DERIVED | GP Security Key Type is Derived Network Key |
EMBER_GP_SECURITY_KEY_GPD_OOB | GP Security Key Type is Out Of Box Key |
EMBER_GP_SECURITY_KEY_GPD_DERIVED | GP Security Key Type is GPD Derived Key |
70
of file stack/include/gp-types.h
EmberGpApplicationId#
EmberGpApplicationId
Green Power Application Id.
Enumerator | |
---|---|
EMBER_GP_APPLICATION_SOURCE_ID | Source identifier. |
EMBER_GP_APPLICATION_IEEE_ADDRESS | IEEE address. |
93
of file stack/include/gp-types.h
EmberGpProxyTableEntryStatus#
EmberGpProxyTableEntryStatus
GP proxy table entry status.
Enumerator | |
---|---|
EMBER_GP_PROXY_TABLE_ENTRY_STATUS_ACTIVE | The GP table entry is in use for a Proxy Table Entry. |
EMBER_GP_PROXY_TABLE_ENTRY_STATUS_UNUSED | The proxy table entry is not in use. |
110
of file stack/include/gp-types.h
EmberGpSinkTableEntryStatus#
EmberGpSinkTableEntryStatus
GP sink table entry status.
Enumerator | |
---|---|
EMBER_GP_SINK_TABLE_ENTRY_STATUS_ACTIVE | The GP table entry is in use for a Sink Table Entry. |
EMBER_GP_SINK_TABLE_ENTRY_STATUS_UNUSED | The proxy table entry is not in use. |
130
of file stack/include/gp-types.h
EmberGpSinkType#
EmberGpSinkType
GP Sink Type.
Enumerator | |
---|---|
EMBER_GP_SINK_TYPE_FULL_UNICAST | Sink Type is Full Unicast |
EMBER_GP_SINK_TYPE_D_GROUPCAST | Sink Type is Derived groupcast, the group ID is derived from the GpdId during commissioning. The sink is added to the APS group with that groupId. |
EMBER_GP_SINK_TYPE_GROUPCAST | Sink type EMBER_GP_SINK_TYPE_GROUPCAST, the groupId can be obtained from the APS group table or from the sink table. |
EMBER_GP_SINK_TYPE_LW_UNICAST | Sink Type is Light Weight Unicast. |
EMBER_GP_SINK_TYPE_UNUSED | Unused sink type |
171
of file stack/include/gp-types.h
EmberCGpTxOption#
EmberCGpTxOption
CGp Transmit options.
Enumerator | |
---|---|
EMBER_CGP_TX_OPTION_NONE | No options. |
EMBER_CGP_TX_OPTION_USE_CSMA_CA | Use CSMA/CA. |
EMBER_CGP_TX_OPTION_USE_MAC_ACK | Use MAC ACK. |
EMBER_CGP_TX_OPTION_RESERVED | Reserved. |
326
of file stack/include/gp-types.h
EmberCGpAddressMode#
EmberCGpAddressMode
Addressing modes for CGp messages.
Enumerator | |
---|---|
EMBER_CGP_ADDRESS_MODE_NONE | No address (PAN identifier and address omitted). |
EMBER_CGP_ADDRESS_MODE_RESERVED | Reserved. |
EMBER_CGP_ADDRESS_MODE_SHORT | 16-bit short address. |
EMBER_CGP_ADDRESS_MODE_EXTENDED | 64-bit extended address. |
346
of file stack/include/gp-types.h
EmberDGpTxOption#
EmberDGpTxOption
Transmit options for DGp messages.
Enumerator | |
---|---|
EMBER_DGP_TX_OPTION_NONE | No options. |
EMBER_DGP_TX_OPTION_USE_GP_TX_QUEUE | Use gpTxQueue. |
EMBER_DGP_TX_OPTION_USE_CSMA_CA | Use CSMA/CA. |
EMBER_DGP_TX_OPTION_USE_MAC_ACK | Use MAC ACK. |
EMBER_DGP_TX_OPTION_FRAME_TYPE_DATA | Data frame. |
EMBER_DGP_TX_OPTION_FRAME_TYPE_MAINTENANCE | Maintenance frame. |
EMBER_DGP_TX_OPTION_RESERVED | Reserved. |
388
of file stack/include/gp-types.h
EmberGpSourceId#
typedef uint32_t EmberGpSourceId
32-bit GPD source identifier
41
of file stack/include/gp-types.h
EmberGpSecurityFrameCounter#
typedef uint32_t EmberGpSecurityFrameCounter
32-bit security frame counter
43
of file stack/include/gp-types.h
EmberGpMic#
typedef uint32_t EmberGpMic
32-bit MIC code
45
of file stack/include/gp-types.h
API Documentation#
emberDGpSend#
EmberStatus emberDGpSend (bool action, bool useCca, EmberGpAddress * addr, uint8_t gpdCommandId, uint8_t gpdAsduLength, uint8_t const * gpdAsdu, uint8_t gpepHandle, uint16_t gpTxQueueEntryLifetimeMs)
DGp Send.
Type | Direction | Argument Name | Description |
---|---|---|---|
bool | N/A | action | Action to add (true) or remove (false) |
bool | N/A | useCca | Use CCA for GPDF transmission. |
EmberGpAddress * | N/A | addr | The gpd address EmberGpAddress. |
uint8_t | N/A | gpdCommandId | GPD Command ID |
uint8_t | N/A | gpdAsduLength | ASDU Length. |
uint8_t const * | N/A | gpdAsdu | The ASDU buffer that holds the outgoing GPDF as payload. |
uint8_t | N/A | gpepHandle | Handle for the asdu. |
uint16_t | N/A | gpTxQueueEntryLifetimeMs | Life time in milliseconds in Tx queue after which it gets cleared. |
This API adds or removes an outgoing GPDF (passed as ASDU) in the GP stub layer. As part of Gp Response command processing by green power client cluster, this API submits a outgoing a channel configuration or a commissioning reply GPDF. Similarly, it is called with appropriate action to clear the Tx queue upon channel request timeout.
Returns
An EmberStatus as status.
704
of file stack/include/gp-types.h
emberGpGetTxQueueHead#
MessageBufferQueue * emberGpGetTxQueueHead (void )
Gets tx queue head.
Type | Direction | Argument Name | Description |
---|---|---|---|
void | N/A |
This function gets the head pointer of the tx queue. Note : since it returns a pointer to memory the head, it 'll not be useful on host.
Returns
pointer to head of tx queue MessageBufferQueue
722
of file stack/include/gp-types.h
emberGpSetMaxTxQueueEntry#
void emberGpSetMaxTxQueueEntry (uint16_t maxEntries)
Sets maximum limit for number of entries in the tx queue.
Type | Direction | Argument Name | Description |
---|---|---|---|
uint16_t | N/A | maxEntries |
This function sets the maximum number of entries the tx queue is supposed to grow.
728
of file stack/include/gp-types.h
emberGetGpMaxTxQListCount#
uint16_t emberGetGpMaxTxQListCount (void )
Gets the limit set for maximum number of entries in the tx queue.
Type | Direction | Argument Name | Description |
---|---|---|---|
void | N/A |
This function gets the limit set for the maximum number of entries the tx queue is supposed to hold.
Returns
limit to the maximum number of entries.
736
of file stack/include/gp-types.h
emberGetGpTxQListCount#
uint16_t emberGetGpTxQListCount (void )
Gets the number of entries in the tx queue.
Type | Direction | Argument Name | Description |
---|---|---|---|
void | N/A |
This function gets the number of entries present in tx queue.
Returns
number of entries.
744
of file stack/include/gp-types.h
emberGpGetTxQueueEntryFromQueue#
EmberMessageBuffer emberGpGetTxQueueEntryFromQueue (EmberGpTxQueueEntry * txQueue, uint8_t * data, uint16_t * dataLength, uint16_t allocatedDataLength)
Gets an entry from Tx Queue The function searches the tx queue using gpd address pointed by supplied in the input/output argument txQueue and returns the message buffer that currently holding the outgoing gpdf information, returns EMBER_NULL_MESSAGE_BUFFER if not found.
Type | Direction | Argument Name | Description |
---|---|---|---|
EmberGpTxQueueEntry * | N/A | txQueue | EmberGpTxQueueEntry A pointer to an allocated memory to get a copy of the tx queue entry from the buffer queue. The caller populates the addr field of this parameter which is used as a search key. |
uint8_t * | N/A | data | A pointer to an allocated memory to get a copy of the gpd command payload if an entry is found. This can be passed as NULL if payload is not required by caller. |
uint16_t * | N/A | dataLength | A pointer to hold the length of the gpd command payload when an entry is found and the data collector is non-NULL. |
uint16_t | N/A | allocatedDataLength | Size in bytes for the allocated memory for the data collector. If this value is smaller compared to length of the data in the queue, no data gets copied out. |
Returns
Buffer EmberMessageBuffer that holds the entry if found, null message buffer if not found.
759
of file stack/include/gp-types.h
emberGpAddGpTxQueueEntryWithPayload#
EmberMessageBuffer emberGpAddGpTxQueueEntryWithPayload (EmberGpTxQueueEntry * txQueue, uint8_t * data, uint16_t dataLength)
Adds an entry to Tx Queue This function adds an entry along with supplied payload data to the Buffer queue. Returns the buffer handle if success else null message buffer upon failure.
Type | Direction | Argument Name | Description |
---|---|---|---|
EmberGpTxQueueEntry * | N/A | txQueue | EmberGpTxQueueEntry A pointer to an allocated memory holding the entry with all the members of the structure assigned as needed. |
uint8_t * | N/A | data | A pointer holding the data payload. Can be supplied as NULL if there is no data payload. |
uint16_t | N/A | dataLength | Length of the data. |
Returns
Buffer EmberMessageBuffer that holds the entry upon success else null message buffer.
772
of file stack/include/gp-types.h
emberGpRemoveFromTxQueue#
bool emberGpRemoveFromTxQueue (EmberGpTxQueueEntry * txQueue)
Remove an entry from Tx Queue This function searches and removes the entry provided.
Type | Direction | Argument Name | Description |
---|---|---|---|
EmberGpTxQueueEntry * | N/A | txQueue | EmberGpTxQueueEntry A pointer to an allocated memory holding the entry with gpd addr field assigned, which is used as for searching the tx queue. NOTE : Use of wildcard gpd addr (AppId = 0,SrcId = 0xFFFFFFFF) , removes all the entries of the tx queue. |
Returns
True upon success else false.
782
of file stack/include/gp-types.h
emberGpClearTxQueue#
void emberGpClearTxQueue (void )
Purges Tx Queue This function purges the tx queue.
Type | Direction | Argument Name | Description |
---|---|---|---|
void | N/A |
788
of file stack/include/gp-types.h