Green Power Data Types#

This file defines data types relevant to the Green Power implementation.

See gp-types.h for source code.

Modules#

EmberGpAddress

EmberGpSinkAddress

EmberGpSinkGroup

EmberGpSinkListEntry

EmberGpProxyTableEntry

EmberGpSinkTableEntry

EmberCGpAddress

EmberGpProxyClusterAttributes

EmberGpTxQueueEntry

EmberGpApplicationInfo

EmberGpAttributeRecord

EmberGpDataPointDescriptor

EmberGpReportDescriptor

EmberGpSwitchInformation

EmberGpGenericSwitchData

EmberGpTranslationTableAdditionalInfoBlockOptionRecordField

GP Types#

enum
EMBER_GP_SECURITY_LEVEL_NONE = 0x00
EMBER_GP_SECURITY_LEVEL_RESERVED = 0x01
EMBER_GP_SECURITY_LEVEL_FC_MIC = 0x02
EMBER_GP_SECURITY_LEVEL_FC_MIC_ENCRYPTED = 0x03
}

Green Power Security Level.

enum
EMBER_GP_SECURITY_KEY_NONE = 0x00
EMBER_GP_SECURITY_KEY_NWK = 0x01
EMBER_GP_SECURITY_KEY_GPD_GROUP = 0x02
EMBER_GP_SECURITY_KEY_NWK_DERIVED = 0x03
EMBER_GP_SECURITY_KEY_GPD_OOB = 0x04
EMBER_GP_SECURITY_KEY_GPD_DERIVED = 0x07
}

Green Power Security Security Key Type.

enum
EMBER_GP_APPLICATION_SOURCE_ID = 0x00
EMBER_GP_APPLICATION_IEEE_ADDRESS = 0x02
}

Green Power Application ID.

enum
EMBER_GP_PROXY_TABLE_ENTRY_STATUS_ACTIVE = 0x01
EMBER_GP_PROXY_TABLE_ENTRY_STATUS_UNUSED = 0xFF
}

GP proxy table entry status.

enum
EMBER_GP_SINK_TABLE_ENTRY_STATUS_ACTIVE = 0x01
EMBER_GP_SINK_TABLE_ENTRY_STATUS_UNUSED = 0xFF
}

GP sink table entry status.

enum
EMBER_GP_SINK_TYPE_FULL_UNICAST
EMBER_GP_SINK_TYPE_D_GROUPCAST
EMBER_GP_SINK_TYPE_GROUPCAST
EMBER_GP_SINK_TYPE_LW_UNICAST
EMBER_GP_SINK_TYPE_UNUSED = 0xFF
}

GP Sink Type.

enum
EMBER_CGP_TX_OPTION_NONE = 0x00
EMBER_CGP_TX_OPTION_USE_CSMA_CA = 0x01
EMBER_CGP_TX_OPTION_USE_MAC_ACK = 0x02
EMBER_CGP_TX_OPTION_RESERVED = 0xFC
}

CGp Transmit options.

enum
EMBER_CGP_ADDRESS_MODE_NONE = 0x00
EMBER_CGP_ADDRESS_MODE_RESERVED = 0x01
EMBER_CGP_ADDRESS_MODE_SHORT = 0x02
EMBER_CGP_ADDRESS_MODE_EXTENDED = 0x03
}

Addressing modes for CGp messages.

enum
EMBER_DGP_TX_OPTION_NONE = 0x00
EMBER_DGP_TX_OPTION_USE_GP_TX_QUEUE = 0x01
EMBER_DGP_TX_OPTION_USE_CSMA_CA = 0x02
EMBER_DGP_TX_OPTION_USE_MAC_ACK = 0x04
EMBER_DGP_TX_OPTION_FRAME_TYPE_DATA = 0x00
EMBER_DGP_TX_OPTION_FRAME_TYPE_MAINTENANCE = 0x08
EMBER_DGP_TX_OPTION_RESERVED = 0xE0
}

Transmit options for DGp messages.

typedef uint32_t
typedef uint32_t

API#

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.

Gets tx queue head.

void
emberGpSetMaxTxQueueEntry(uint16_t maxEntries)

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

uint16_t

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

uint16_t

Gets the number of entries in the tx queue.

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.

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

Purges Tx Queue This function purges the tx queue.

Macros#

#define

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

#define

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

#define

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

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

#define
GP_PARAMS undefined

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

#define
GP_ARGS undefined

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

#define
GP_UNUSED_ARGS undefined

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

#define

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

#define

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

#define

GPD Source ID when requesting channel request.

#define

GPD wildcard Source ID.

#define

GPD Reserved Source ID. Used in maintenance frame.

#define

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

#define

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

#define

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

#define

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

#define

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

#define

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

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 179 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 198 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 221 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 237 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 257 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 298 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 445 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 465 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 507 of file stack/include/gp-types.h

EmberGpSourceId#

typedef uint32_t EmberGpSourceId

32-bit GPD source identifier


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

EmberGpSecurityFrameCounter#

typedef uint32_t EmberGpSecurityFrameCounter

32-bit security frame counter


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

EmberGpMic#

typedef uint32_t EmberGpMic

32-bit MIC code


Definition at line 173 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/Aaction

Action to add (true) or remove (false)

N/AuseCca

Use CCA for GPDF transmission.

N/Aaddr

The gpd address EmberGpAddress.

N/AgpdCommandId

GPD Command ID

N/AgpdAsduLength

ASDU Length.

N/AgpdAsdu

The ASDU buffer that holds the outgoing GPDF as payload.

N/AgpepHandle

Handle for the asdu.

N/AgpTxQueueEntryLifetimeMs

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


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


Definition at line 767 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/AmaxEntries

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


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

Parameters
N/AtxQueue

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/Adata

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/AdataLength

A pointer to hold the length of the gpd command payload when an entry is found and the data collector is non-NULL.

N/AallocatedDataLength

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 804 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/AtxQueue

EmberGpTxQueueEntry A pointer to an allocated memory holding the entry with all the members of the structure assigned as needed.

N/Adata

A pointer holding the data payload. Can be supplied as NULL if there is no data payload.

N/AdataLength

Length of the data.

Returns


Definition at line 817 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/AtxQueue

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 827 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 833 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

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


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

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


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

GP_SINK_LIST_ENTRIES#

#define GP_SINK_LIST_ENTRIES
Value:
2

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


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

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


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

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


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

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


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

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


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

GP_PROXY_TABLE_OPTIONS_IN_RANGE#

#define GP_PROXY_TABLE_OPTIONS_IN_RANGE
Value:
(BIT(10))

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


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

GP_COMMISSIONING_MAX_BYTES#

#define GP_COMMISSIONING_MAX_BYTES
Value:
(55 - 3)

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


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

GP_GPD_SRC_ID_FOR_CAHNNEL_CONFIG#

#define GP_GPD_SRC_ID_FOR_CAHNNEL_CONFIG
Value:
0x00000000

GPD Source ID when requesting channel request.


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

GP_GPD_SRC_ID_WILDCARD#

#define GP_GPD_SRC_ID_WILDCARD
Value:
0xFFFFFFFF

GPD wildcard Source ID.


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

GP_GPD_SRC_ID_RESERVED_0#

#define GP_GPD_SRC_ID_RESERVED_0
Value:
0x00000000

GPD Reserved Source ID. Used in maintenance frame.


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

GP_GPD_SRC_ID_RESERVED_FFFFFF9#

#define GP_GPD_SRC_ID_RESERVED_FFFFFF9
Value:
0xFFFFFFF9

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


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

GP_GPD_SRC_ID_RESERVED_FFFFFFE#

#define GP_GPD_SRC_ID_RESERVED_FFFFFFE
Value:
0xFFFFFFFE

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


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

GP_DERIVED_GROUP_ALIAS_NOT_USED#

#define GP_DERIVED_GROUP_ALIAS_NOT_USED
Value:
0xffff

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


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

GP_DMIN_B#

#define GP_DMIN_B
Value:
32

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


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

GP_DMIN_U#

#define GP_DMIN_U
Value:
5

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


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

GP_DMAX#

#define GP_DMAX
Value:
100

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


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