Green Power Data Types#

EmberGpSecurityLevel#

EmberGpSecurityLevel

Green Power Security Level.

EmberGpKeyType#

EmberGpKeyType

Green Power Security Security Key Type.

EmberGpApplicationId#

EmberGpApplicationId

Green Power Application Id.

EmberGpProxyTableEntryStatus#

EmberGpProxyTableEntryStatus

GP proxy table entry status.

EmberGpSinkTableEntryStatus#

EmberGpSinkTableEntryStatus

GP sink table entry status.

EmberGpSinkType#

EmberGpSinkType

GP Sink Type.

EmberCGpTxOption#

EmberCGpTxOption

CGp Transmit options.

EmberCGpAddressMode#

EmberCGpAddressMode

Addressing modes for CGp messages.

EmberDGpTxOption#

EmberDGpTxOption

Transmit options for DGp messages.

EmberGpSourceId#

typedef uint32_t EmberGpSourceId

32-bit GPD source identifier

EmberGpSecurityFrameCounter#

typedef uint32_t EmberGpSecurityFrameCounter

32-bit security frame counter

EmberGpMic#

typedef uint32_t EmberGpMic

32-bit MIC code

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.

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.

emberGpProxyTableProcessGpPairing#

bool emberGpProxyTableProcessGpPairing (uint32_t options, EmberGpAddress * addr, uint8_t commMode, uint16_t sinkNwkAddress, uint16_t sinkGroupId, uint16_t assignedAlias, uint8_t * sinkIeeeAddress, EmberKeyData * gpdKey, uint32_t gpdSecurityFrameCounter, uint8_t forwardingRadius)

Process Gp Pairing.

This function adds or updates the entry in the proxy table as part of Gp Pairing command processing. All the input arguments for this API is derived directly from the incoming GP Pairing command

Returns

• true on success and false for failure.

emberGpProxyTableLookup#

uint8_t emberGpProxyTableLookup (EmberGpAddress * addr)

Proxy table look up.

This function looks up a gpd address in the Gp Proxy Table and returns index of the entry.

Returns

• a valid index to the entry in proxy table and 0xFF in case of not found.

emberGpProxyTableGetEntry#

EmberStatus emberGpProxyTableGetEntry (uint8_t proxyIndex, EmberGpProxyTableEntry * entry)

Get Proxy table entry.

This function gets an entry from proxy table at the supplied index.

Returns

• An EmberStatus as status.

emberGpSinkTableGetEntry#

EmberStatus emberGpSinkTableGetEntry (uint8_t sinkIndex, EmberGpSinkTableEntry * entry)

Get Sink table entry.

This function gets an entry from sink table at the supplied index.

Returns

• An EmberStatus as status.

emberGpSinkTableLookup#

uint8_t emberGpSinkTableLookup (EmberGpAddress * addr)

Sink table look up.

This function looks up a gpd address in the Gp Sink Table and returns index of the entry.

Returns

• a valid index to the entry in proxy table and 0xFF in case of not found.

emberGpSinkTableClearAll#

void emberGpSinkTableClearAll (void )

Clear sink table.

This function clears all entries in the sink table.

emberGpSinkTableSetEntry#

EmberStatus emberGpSinkTableSetEntry (uint8_t sinkTableIndex, EmberGpSinkTableEntry * entry)

Get Sink table entry.

This function gets an entry from sink table at the supplied index.

Returns

• An EmberStatus as status.

emberGpSinkTableFindOrAllocateEntry#

uint8_t emberGpSinkTableFindOrAllocateEntry (EmberGpAddress * addr)

Allocates an entry in sink able.

This function looks up a gpd address in sink table. Returns the index of the entry if exists. If the entry is not found but there are space available in the table, allocates an entry and returns the index. If no space available returns 0xFF.

Returns

• a valid index to the entry in proxy table and 0xFF in case of no space.

emberGpSinkTableRemoveEntry#

void emberGpSinkTableRemoveEntry (uint8_t index)

Remove an entry in sink table.

This function removes an entry at the index provided.

emberGpSinkTableInit#

void emberGpSinkTableInit (void )

Initialize sink table.

This function initializes the sink table in RAM. It copies the non-volatile sink table entries to a RAM table which is used during operation. By design,the non-volatile token entry for the sink table are compressed and does not hold the data that can be derived. This function is only called during initialization of the green power stack to initialize the entire table with derived data.

emberGpSinkTableSetSecurityFrameCounter#

void emberGpSinkTableSetSecurityFrameCounter (uint8_t index, uint32_t sfc)

Sets security frame counter in sink table entry.

This function sets the security frame counter for a sink table entry at an index.

emberGpGetTxQueueHead#

MessageBufferQueue * emberGpGetTxQueueHead (void )

Gets tx queue head.

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

emberGpSetMaxTxQueueEntry#

void emberGpSetMaxTxQueueEntry (uint16_t maxEntries)

Sets maximum limit for number of entries in the tx queue.

This function sets the maximum number of entries the tx queue is supposed to grow.

emberGetGpMaxTxQListCount#

uint16_t emberGetGpMaxTxQListCount (void )

Gets the limit set for maximum number of entries in the tx queue.

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.

emberGetGpTxQListCount#

uint16_t emberGetGpTxQListCount (void )

Gets the number of entries in the tx queue.

This function gets the number of entries present in tx queue.

Returns

• number of entries.

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.

Returns

• Buffer EmberMessageBuffer that holds the entry if found, null message buffer if not found.

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.

Returns

• Buffer EmberMessageBuffer that holds the entry upon success else null message buffer.

emberGpRemoveFromTxQueue#

bool emberGpRemoveFromTxQueue (EmberGpTxQueueEntry * txQueue)

Remove an entry from Tx Queue This function searches and removes the entry provided.

Returns

• True upon success else false.

emberGpClearTxQueue#

void emberGpClearTxQueue (void )

Purges Tx Queue This function purges the tx queue.