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.

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.

EMBER_GP_BIDIRECTION_INFO_RX_AFTER_TX_MASK#

#define EMBER_GP_BIDIRECTION_INFO_RX_AFTER_TX_MASK

0x01

Mask used in the green power endpoint incoming message handler to pass bidirectional information. Incoming GPDF has rxAfterTx bit set.

EMBER_GP_BIDIRECTION_INFO_TX_QUEUE_AVAILABLE_MASK#

#define EMBER_GP_BIDIRECTION_INFO_TX_QUEUE_AVAILABLE_MASK

0x02

Mask to test if transmit queue is available at green power stub layer to hold an outgoing GPDF.

GP_SINK_LIST_ENTRIES#

#define GP_SINK_LIST_ENTRIES

2

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

GP_SIZE_OF_SINK_LIST_ENTRIES_OCTET_STRING#

#define GP_SIZE_OF_SINK_LIST_ENTRIES_OCTET_STRING

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

The size of the SinkList entries in sink table in form of octet string that has a format of [<1 byte length>, <n bytes for sink groups>].

GP_PARAMS#

#define GP_PARAMS

GP parameters list represented as a macro for GP endpoint incoming message handler and callbacks prototypes.

GP_ARGS#

#define GP_ARGS

GP arguments list represented as a macro while calling GP endpoint incoming message handler and callbacks.

GP_UNUSED_ARGS#

#define GP_UNUSED_ARGS

GP arguments list with void type cast represented as a macro to be used in callback stubs.

GP_PROXY_TABLE_OPTIONS_IN_RANGE#

#define GP_PROXY_TABLE_OPTIONS_IN_RANGE

(BIT(10))

Bit mask for the proxy table ebtry option bit representing in-range bit field.

GP_COMMISSIONING_MAX_BYTES#

#define GP_COMMISSIONING_MAX_BYTES

(55 - 3)

Maximum number of bytes in a green power commissioning frame excluding 3 bytes for device ID, option and application information fields.

GP_GPD_SRC_ID_FOR_CAHNNEL_CONFIG#

#define GP_GPD_SRC_ID_FOR_CAHNNEL_CONFIG

0x00000000

GPD Source ID when requesting channel request.

GP_GPD_SRC_ID_WILDCARD#

#define GP_GPD_SRC_ID_WILDCARD

0xFFFFFFFF

GPD wildcard Source ID.

GP_GPD_SRC_ID_RESERVED_0#

#define GP_GPD_SRC_ID_RESERVED_0

0x00000000

GPD Reserved Source ID. Used in maintenance frame.

GP_GPD_SRC_ID_RESERVED_FFFFFF9#

#define GP_GPD_SRC_ID_RESERVED_FFFFFF9

0xFFFFFFF9

GPD Reserved Source ID. All addresses between 0xFFFFFFF9 and 0xFFFFFFFE are reserved.

GP_GPD_SRC_ID_RESERVED_FFFFFFE#

#define GP_GPD_SRC_ID_RESERVED_FFFFFFE

0xFFFFFFFE

GPD Reserved Source ID. All addresses between 0xFFFFFFF9 and 0xFFFFFFFE are reserved.

GP_DERIVED_GROUP_ALIAS_NOT_USED#

#define GP_DERIVED_GROUP_ALIAS_NOT_USED

0xffff

Default value for derived group ID when alias is not used.

GP_DMIN_B#

#define GP_DMIN_B

32

Tunneling delay constant Dmin_b in milliseconds. Ref green power specification for more information on this constant.

GP_DMIN_U#

#define GP_DMIN_U

5

Tunneling delay constant Dmin_u in milliseconds. Ref green power specification for more information on this constant.

GP_DMAX#

#define GP_DMAX

100

Tunneling delay constant Dmax in milliseconds. Ref green power specification for more information on this constant.