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.

MessageBufferQueue *

emberGpGetTxQueueHead(void)

Gets tx queue head.

void

emberGpSetMaxTxQueueEntry(uint16_t maxEntries)

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

uint16_t

emberGetGpMaxTxQListCount(void)

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

uint16_t

emberGetGpTxQListCount(void)

Gets the number of entries in the tx queue.

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.

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.

bool

emberGpRemoveFromTxQueue(EmberGpTxQueueEntry *txQueue)

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

void

emberGpClearTxQueue(void)

Purges Tx Queue This function purges the tx queue.

Macros#

#define

EMBER_GP_BIDIRECTION_INFO_RX_AFTER_TX_MASK 0x01

#define

EMBER_GP_BIDIRECTION_INFO_TX_QUEUE_AVAILABLE_MASK 0x02

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

Definition at line 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

Definition at line 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.

Definition at line 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.

Definition at line 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.

Definition at line 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

Definition at line 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.

Definition at line 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.

Definition at line 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.

Definition at line 388 of file stack/include/gp-types.h

EmberGpSourceId#

typedef uint32_t EmberGpSourceId

32-bit GPD source identifier

Definition at line 41 of file stack/include/gp-types.h

EmberGpSecurityFrameCounter#

typedef uint32_t EmberGpSecurityFrameCounter

32-bit security frame counter

Definition at line 43 of file stack/include/gp-types.h

EmberGpMic#

typedef uint32_t EmberGpMic

32-bit MIC code

Definition at line 45 of file stack/include/gp-types.h

EMBER_GP_APPLICATION_ID_MASK#

#define EMBER_GP_APPLICATION_ID_MASK

Value:

0x03

Number of GP sink list entries. Minimum is 2 sink list entries.

Definition at line 105 of file stack/include/gp-types.h

GP_SINK_LIST_ENTRIES#

#define GP_SINK_LIST_ENTRIES

Value:

Number of GP sink list entries. Minimum is 2 sink list entries.

Definition at line 225 of file stack/include/gp-types.h

GP_SIZE_OF_SINK_LIST_ENTRIES_OCTET_STRING#

#define GP_SIZE_OF_SINK_LIST_ENTRIES_OCTET_STRING

Value:

(1 + (GP_SINK_LIST_ENTRIES * (sizeof(EmberGpSinkGroup))))

Number of GP sink list entries. Minimum is 2 sink list entries.

Definition at line 228 of file stack/include/gp-types.h

GP_PARAMS#

#define GP_PARAMS

Value:

EmberStatus status, \

uint8_t gpdLink, \

uint8_t sequenceNumber, \

EmberGpAddress * addr, \

EmberGpSecurityLevel gpdfSecurityLevel, \

EmberGpKeyType gpdfSecurityKeyType, \

bool autoCommissioning, \

uint8_t bidirectionalInfo, \

uint32_t gpdSecurityFrameCounter, \

uint8_t gpdCommandId, \

uint32_t mic, \

uint8_t proxyTableIndex, \

uint8_t gpdCommandPayloadLength, \

uint8_t * gpdCommandPayload

Number of GP sink list entries. Minimum is 2 sink list entries.

Definition at line 434 of file stack/include/gp-types.h

GP_ARGS#

#define GP_ARGS

Value:

status, \

gpdLink, \

sequenceNumber, \

addr, \

gpdfSecurityLevel, \

gpdfSecurityKeyType, \

autoCommissioning, \

bidirectionalInfo, \

gpdSecurityFrameCounter, \

gpdCommandId, \

mic, \

proxyTableIndex, \

gpdCommandPayloadLength, \

gpdCommandPayload

Number of GP sink list entries. Minimum is 2 sink list entries.

Definition at line 450 of file stack/include/gp-types.h

GP_UNUSED_ARGS#

#define GP_UNUSED_ARGS

Value:

(void)status; \

(void)gpdLink; \

(void)sequenceNumber; \

(void)addr; \

(void)gpdfSecurityLevel; \

(void)gpdfSecurityKeyType; \

(void)autoCommissioning; \

(void)rxAfterTx; \

(void)gpdSecurityFrameCounter; \

(void)gpdCommandId; \

(void)mic; \

(void)proxyTableIndex; \

(void)gpdCommandPayloadLength; \

(void)gpdCommandPayload;

Number of GP sink list entries. Minimum is 2 sink list entries.

Definition at line 466 of file stack/include/gp-types.h

GP_PROXY_TABLE_OPTIONS_IN_RANGE#

#define GP_PROXY_TABLE_OPTIONS_IN_RANGE

Value:

(BIT(10))

Number of GP sink list entries. Minimum is 2 sink list entries.

Definition at line 482 of file stack/include/gp-types.h

GP_COMMISSIONING_MAX_BYTES#

#define GP_COMMISSIONING_MAX_BYTES

Value:

(55 - 3)

Number of GP sink list entries. Minimum is 2 sink list entries.

Definition at line 485 of file stack/include/gp-types.h

TT_NB_MAX_OPTION_RECORD#

#define TT_NB_MAX_OPTION_RECORD

Value:

(8)

Number of maximum option record entries in translation table.

Definition at line 610 of file stack/include/gp-types.h

GP_GPD_SRC_ID_FOR_CAHNNEL_CONFIG#

#define GP_GPD_SRC_ID_FOR_CAHNNEL_CONFIG

Value:

0x00000000

Number of GP sink list entries. Minimum is 2 sink list entries.

Definition at line 659 of file stack/include/gp-types.h

GP_GPD_SRC_ID_WILDCARD#

#define GP_GPD_SRC_ID_WILDCARD

Value:

0xFFFFFFFF

Number of GP sink list entries. Minimum is 2 sink list entries.

Definition at line 660 of file stack/include/gp-types.h

GP_GPD_SRC_ID_RESERVED_0#

#define GP_GPD_SRC_ID_RESERVED_0

Value:

0x00000000

Number of GP sink list entries. Minimum is 2 sink list entries.

Definition at line 663 of file stack/include/gp-types.h

GP_GPD_SRC_ID_RESERVED_FFFFFF9#

#define GP_GPD_SRC_ID_RESERVED_FFFFFF9

Value:

0xFFFFFFF9

Number of GP sink list entries. Minimum is 2 sink list entries.

Definition at line 664 of file stack/include/gp-types.h

GP_GPD_SRC_ID_RESERVED_FFFFFFA#

#define GP_GPD_SRC_ID_RESERVED_FFFFFFA

Value:

0xFFFFFFFA

Number of GP sink list entries. Minimum is 2 sink list entries.

Definition at line 665 of file stack/include/gp-types.h

GP_GPD_SRC_ID_RESERVED_FFFFFFB#

#define GP_GPD_SRC_ID_RESERVED_FFFFFFB

Value:

0xFFFFFFFB

Number of GP sink list entries. Minimum is 2 sink list entries.

Definition at line 666 of file stack/include/gp-types.h

GP_GPD_SRC_ID_RESERVED_FFFFFFC#

#define GP_GPD_SRC_ID_RESERVED_FFFFFFC

Value:

0xFFFFFFFC

Number of GP sink list entries. Minimum is 2 sink list entries.

Definition at line 667 of file stack/include/gp-types.h

GP_GPD_SRC_ID_RESERVED_FFFFFFD#

#define GP_GPD_SRC_ID_RESERVED_FFFFFFD

Value:

0xFFFFFFFD

Number of GP sink list entries. Minimum is 2 sink list entries.

Definition at line 668 of file stack/include/gp-types.h

GP_GPD_SRC_ID_RESERVED_FFFFFFE#

#define GP_GPD_SRC_ID_RESERVED_FFFFFFE

Value:

0xFFFFFFFE

Number of GP sink list entries. Minimum is 2 sink list entries.

Definition at line 669 of file stack/include/gp-types.h

GP_DERIVED_GROUP_ALIAS_NOT_USED#

#define GP_DERIVED_GROUP_ALIAS_NOT_USED

Value:

0xffff

Number of GP sink list entries. Minimum is 2 sink list entries.

Definition at line 671 of file stack/include/gp-types.h

GP_DMIN_B#

#define GP_DMIN_B

Value:

Number of GP sink list entries. Minimum is 2 sink list entries.

Definition at line 673 of file stack/include/gp-types.h

GP_DMIN_U#

#define GP_DMIN_U

Value:

Number of GP sink list entries. Minimum is 2 sink list entries.

Definition at line 674 of file stack/include/gp-types.h

GP_DMAX#

#define GP_DMAX

Value:

Number of GP sink list entries. Minimum is 2 sink list entries.

Definition at line 675 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.

Parameters

N/A	action	Action to add (true) or remove (false)
N/A	useCca	Use CCA for GPDF transmission.
N/A	addr	The gpd address EmberGpAddress.
N/A	gpdCommandId	GPD Command ID
N/A	gpdAsduLength	ASDU Length.
N/A	gpdAsdu	The ASDU buffer that holds the outgoing GPDF as payload.
N/A	gpepHandle	Handle for the asdu.
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.

Definition at line 704 of file stack/include/gp-types.h

emberGpGetTxQueueHead#

MessageBufferQueue * emberGpGetTxQueueHead (void )

Gets tx queue head.

Parameters

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

Definition at line 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.

Parameters

N/A maxEntries

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

Definition at line 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.

Parameters

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.

Definition at line 736 of file stack/include/gp-types.h

emberGetGpTxQListCount#

uint16_t emberGetGpTxQListCount (void )

Gets the number of entries in the tx queue.

Parameters

N/A

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

Returns

number of entries.

Definition at line 744 of file stack/include/gp-types.h

emberGpGetTxQueueEntryFromQueue#

EmberMessageBuffer emberGpGetTxQueueEntryFromQueue (EmberGpTxQueueEntry * txQueue, uint8_t * data, uint16_t * dataLength, uint16_t allocatedDataLength)

Parameters

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.
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.
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.
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.

Definition at line 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.

Parameters

N/A	txQueue	EmberGpTxQueueEntry A pointer to an allocated memory holding the entry with all the members of the structure assigned as needed.
N/A	data	A pointer holding the data payload. Can be supplied as NULL if there is no data payload.
N/A	dataLength	Length of the data.

Returns

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

Definition at line 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.

Parameters

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.

Definition at line 782 of file stack/include/gp-types.h

emberGpClearTxQueue#

void emberGpClearTxQueue (void )

Purges Tx Queue This function purges the tx queue.

Parameters

N/A

Definition at line 788 of file stack/include/gp-types.h

Macro Definition Documentation#

EMBER_GP_BIDIRECTION_INFO_RX_AFTER_TX_MASK#

#define EMBER_GP_BIDIRECTION_INFO_RX_AFTER_TX_MASK

Value:

0x01

Definition at line 33 of file stack/include/gp-types.h

EMBER_GP_BIDIRECTION_INFO_TX_QUEUE_AVAILABLE_MASK#

#define EMBER_GP_BIDIRECTION_INFO_TX_QUEUE_AVAILABLE_MASK

Value:

0x02

Definition at line 35 of file stack/include/gp-types.h