Modules#
EmberGpTranslationTableAdditionalInfoBlockOptionRecordField
Green Power Data Types#
This file defines data types relevant to the Green Power implementation.
See gp-types.h for source code.
GP Types#
Options to use when sending a message.
Options to use when sending a message.
Options to use when sending a message.
GP proxy table entry status.
GP sink table entry status.
Options to use when sending a message.
GP sink table entry status.
Addressing modes for sending and receiving a message.
Options to use when sending a message.
Options to use when sending a message.
Options to use when sending a message.
Options to use when sending a message.
Options to use when sending a message.
Options to use when sending a message.
Options to use when sending a message.
Options to use when sending a message.
Options to use when sending a message.
Options to use when sending a message.
Options to use when sending a message.
Options to use when sending a message.
Options to use when sending a message.
Options to use when sending a message.
Options to use when sending a message.
Options to use when sending a message.
Options to use when sending a message.
Options to use when sending a message.
Options to use when sending a message.
Options to use when sending a message.
Options to use when sending a message.
Options to use when sending a message.
Options to use when sending a message.
Options to use when sending a message.
Options to use when sending a message.
Options to use when sending a message.
Options to use when sending a message.
Options to use when sending a message.
Options to use when sending a message.
Options to use when sending a message.
Options to use when sending a message.
Options to use when sending a message.
Options to use when sending a message.
Options to use when sending a message.
Options to use when sending a message.
Options to use when sending a message.
Options to use when sending a message.
Options to use when sending a message.
Options to use when sending a message.
Options to use when sending a message.
Options to use when sending a message.
Variables#
Macros#
GP Types Documentation#
EmberGpSecurityLevel#
EmberGpSecurityLevel
Options to use when sending a message.
Enumerator | |
---|---|
EMBER_GP_SECURITY_LEVEL_NONE | None |
EMBER_GP_SECURITY_LEVEL_RESERVED | reserved |
EMBER_GP_SECURITY_LEVEL_FC_MIC | 4 Byte Frame Counter + 4 Byte MIC |
EMBER_GP_SECURITY_LEVEL_FC_MIC_ENCRYPTED | 4 Byte Frame Counter + 4 Byte MIC + encryption |
EmberGpKeyType#
EmberGpKeyType
Options to use when sending a message.
Enumerator | |
---|---|
EMBER_GP_SECURITY_KEY_NONE | None |
EMBER_GP_SECURITY_KEY_NWK | reserved |
EMBER_GP_SECURITY_KEY_GPD_GROUP | |
EMBER_GP_SECURITY_KEY_NWK_DERIVED | |
EMBER_GP_SECURITY_KEY_GPD_OOB | |
EMBER_GP_SECURITY_KEY_GPD_DERIVED |
EmberGpApplicationId#
EmberGpApplicationId
Options to use when sending a message.
Enumerator | |
---|---|
EMBER_GP_APPLICATION_SOURCE_ID | Source identifier. |
EMBER_GP_APPLICATION_IEEE_ADDRESS | IEEE address. |
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. |
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. |
EmberGpSinkType#
EmberGpSinkType
Options to use when sending a message.
Enumerator | |
---|---|
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_SINK_GROUPLIST | |
EMBER_GP_SINK_TYPE_UNUSED |
EmberCGpTxOption#
EmberCGpTxOption
GP sink table entry status.
GP sink table entry status. TODO R E M O V E
Options to use when sending a message.
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. |
EmberCGpAddressMode#
EmberCGpAddressMode
Addressing modes for sending and receiving a message.
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. |
EmberDGpTxOption#
EmberDGpTxOption
Options to use when sending a message.
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. |
EmberGpSecurityFrameCounter#
typedef uint32_t EmberGpSecurityFrameCounter
32-bit security frame counter
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)
Options to use when sending a message.
Type | Direction | Argument Name | Description |
---|---|---|---|
bool | N/A | action | |
bool | N/A | useCca | |
EmberGpAddress * | N/A | addr | |
uint8_t | N/A | gpdCommandId | |
uint8_t | N/A | gpdAsduLength | |
uint8_t const * | N/A | gpdAsdu | |
uint8_t | N/A | gpepHandle | |
uint16_t | N/A | gpTxQueueEntryLifetimeMs |
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)
Options to use when sending a message.
Type | Direction | Argument Name | Description |
---|---|---|---|
uint32_t | N/A | options | |
EmberGpAddress * | N/A | addr | |
uint8_t | N/A | commMode | |
uint16_t | N/A | sinkNwkAddress | |
uint16_t | N/A | sinkGroupId | |
uint16_t | N/A | assignedAlias | |
uint8_t * | N/A | sinkIeeeAddress | |
EmberKeyData * | N/A | gpdKey | |
uint32_t | N/A | gpdSecurityFrameCounter | |
uint8_t | N/A | forwardingRadius |
emberGpProxyTableLookup#
uint8_t emberGpProxyTableLookup (EmberGpAddress * addr)
Options to use when sending a message.
Type | Direction | Argument Name | Description |
---|---|---|---|
EmberGpAddress * | N/A | addr |
emberGpProxyTableGetEntry#
EmberStatus emberGpProxyTableGetEntry (uint8_t proxyIndex, EmberGpProxyTableEntry * entry)
Options to use when sending a message.
Type | Direction | Argument Name | Description |
---|---|---|---|
uint8_t | N/A | proxyIndex | |
EmberGpProxyTableEntry * | N/A | entry |
emberGpSinkTableGetEntry#
EmberStatus emberGpSinkTableGetEntry (uint8_t sinkIndex, EmberGpSinkTableEntry * entry)
Options to use when sending a message.
Type | Direction | Argument Name | Description |
---|---|---|---|
uint8_t | N/A | sinkIndex | |
EmberGpSinkTableEntry * | N/A | entry |
emberGpSinkTableLookup#
uint8_t emberGpSinkTableLookup (EmberGpAddress * addr)
Options to use when sending a message.
Type | Direction | Argument Name | Description |
---|---|---|---|
EmberGpAddress * | N/A | addr |
emberGpSinkTableClearAll#
void emberGpSinkTableClearAll (void )
Options to use when sending a message.
Type | Direction | Argument Name | Description |
---|---|---|---|
void | N/A |
emberGpSinkTableSetEntry#
EmberStatus emberGpSinkTableSetEntry (uint8_t sinkTableIndex, EmberGpSinkTableEntry * entry)
Options to use when sending a message.
Type | Direction | Argument Name | Description |
---|---|---|---|
uint8_t | N/A | sinkTableIndex | |
EmberGpSinkTableEntry * | N/A | entry |
emberGpSinkTableFindOrAllocateEntry#
uint8_t emberGpSinkTableFindOrAllocateEntry (EmberGpAddress * addr)
Options to use when sending a message.
Type | Direction | Argument Name | Description |
---|---|---|---|
EmberGpAddress * | N/A | addr |
emberGpSinkTableRemoveEntry#
void emberGpSinkTableRemoveEntry (uint8_t index)
Options to use when sending a message.
Type | Direction | Argument Name | Description |
---|---|---|---|
uint8_t | N/A | index |
emberGpSinkTableInit#
void emberGpSinkTableInit (void )
Options to use when sending a message.
Type | Direction | Argument Name | Description |
---|---|---|---|
void | N/A |
emberGpSinkTableSetSecurityFrameCounter#
void emberGpSinkTableSetSecurityFrameCounter (uint8_t index, uint32_t sfc)
Options to use when sending a message.
Type | Direction | Argument Name | Description |
---|---|---|---|
uint8_t | N/A | index | |
uint32_t | N/A | sfc |
emberGpGetTxQueueHead#
MessageBufferQueue* emberGpGetTxQueueHead (void )
Options to use when sending a message.
Type | Direction | Argument Name | Description |
---|---|---|---|
void | N/A |
emberGpSetMaxTxQueueEntry#
void emberGpSetMaxTxQueueEntry (uint16_t maxEntries)
Options to use when sending a message.
Type | Direction | Argument Name | Description |
---|---|---|---|
uint16_t | N/A | maxEntries |
emberGetGpMaxTxQListCount#
uint16_t emberGetGpMaxTxQListCount (void )
Options to use when sending a message.
Type | Direction | Argument Name | Description |
---|---|---|---|
void | N/A |
emberGetGpTxQListCount#
uint16_t emberGetGpTxQListCount (void )
Options to use when sending a message.
Type | Direction | Argument Name | Description |
---|---|---|---|
void | N/A |
emberGpGetTxQueueEntryFromQueue#
EmberMessageBuffer emberGpGetTxQueueEntryFromQueue (EmberGpTxQueueEntry * txQueue, uint8_t * data, uint16_t * dataLength, uint16_t allocatedDataLength)
Options to use when sending a message.
Type | Direction | Argument Name | Description |
---|---|---|---|
EmberGpTxQueueEntry * | N/A | txQueue | |
uint8_t * | N/A | data | |
uint16_t * | N/A | dataLength | |
uint16_t | N/A | allocatedDataLength |
emberGpAddGpTxQueueEntryWithPayload#
EmberMessageBuffer emberGpAddGpTxQueueEntryWithPayload (EmberGpTxQueueEntry * txQueue, uint8_t * data, uint16_t dataLength)
Options to use when sending a message.
Type | Direction | Argument Name | Description |
---|---|---|---|
EmberGpTxQueueEntry * | N/A | txQueue | |
uint8_t * | N/A | data | |
uint16_t | N/A | dataLength |
emberGpRemoveFromTxQueue#
bool emberGpRemoveFromTxQueue (EmberGpTxQueueEntry * txQueue)
Options to use when sending a message.
Type | Direction | Argument Name | Description |
---|---|---|---|
EmberGpTxQueueEntry * | N/A | txQueue |
emberGpClearTxQueue#
void emberGpClearTxQueue (void )
Options to use when sending a message.
Type | Direction | Argument Name | Description |
---|---|---|---|
void | N/A |
Variable Documentation#
gpdIeeeAddress#
EmberEUI64 EmberGpAddress::gpdIeeeAddress
The IEEE address is used when the application identifier is EMBER_GP_APPLICATION_IEEE_ADDRESS.
gpdIeeeAddress#
EmberEUI64 EmberGpAddress::@0::gpdIeeeAddress
The IEEE address is used when the application identifier is EMBER_GP_APPLICATION_IEEE_ADDRESS.
sourceId#
EmberGpSourceId EmberGpAddress::sourceId
The 32-bit source identifier is used when the application identifier is EMBER_GP_APPLICATION_SOURCE_ID.
sourceId#
EmberGpSourceId EmberGpAddress::@0::sourceId
The 32-bit source identifier is used when the application identifier is EMBER_GP_APPLICATION_SOURCE_ID.
status#
EmberGpProxyTableEntryStatus EmberGpProxyTableEntry::status
Internal status. Defines if the entry is unused or used as a proxy entry
options#
uint32_t EmberGpProxyTableEntry::options
The tunneling options (this contains both options and extendedOptions from the spec)
gpdSecurityFrameCounter#
EmberGpSecurityFrameCounter EmberGpProxyTableEntry::gpdSecurityFrameCounter
The SFC of the GPD
sinkList#
EmberGpSinkListEntry EmberGpProxyTableEntry::sinkList[GP_SINK_LIST_ENTRIES]
The list of sinks (hardcoded to 2 which is the spec minimum) (maybe we should indirect this?)
status#
EmberGpSinkTableEntryStatus EmberGpSinkTableEntry::status
Internal status. Defines if the entry is unused or used as a sink table entry
options#
uint16_t EmberGpSinkTableEntry::options
The tunneling options (this contains both options and extendedOptions from the spec)
sinkList#
EmberGpSinkListEntry EmberGpSinkTableEntry::sinkList[GP_SINK_LIST_ENTRIES]
The list of sinks (hardcoded to 2 which is the spec minimum) (maybe we should indirect this?)
gpdSecurityFrameCounter#
EmberGpSecurityFrameCounter EmberGpSinkTableEntry::gpdSecurityFrameCounter
The SFC of the GPD
shortId#
EmberNodeId EmberCGpAddress::shortId
The 16-bit short address is used when the mode is EMBER_CGP_ADDRESS_MODE_SHORT.
shortId#
EmberNodeId EmberCGpAddress::@2::shortId
The 16-bit short address is used when the mode is EMBER_CGP_ADDRESS_MODE_SHORT.
extendedId#
EmberEUI64 EmberCGpAddress::extendedId
The 64-bit extended address is used when the mode is EMBER_CGP_ADDRESS_MODE_EXTENDED.
extendedId#
EmberEUI64 EmberCGpAddress::@2::extendedId
The 64-bit extended address is used when the mode is EMBER_CGP_ADDRESS_MODE_EXTENDED.
panId#
EmberPanId EmberCGpAddress::panId
The PAN identifier is used when the mode is not EMBER_CGP_ADDRESS_MODE_NONE.
totalLengthOfAddInfoBlock#
uint8_t EmberGpTranslationTableAdditionalInfoBlockOptionRecordField::totalLengthOfAddInfoBlock
reportIdentifier#
uint8_t EmberGpTranslationTableAdditionalInfoBlockOptionRecordField::reportIdentifier
reportIdentifier#
uint8_t EmberGpTranslationTableAdditionalInfoBlockOptionRecordField::@3::@4::reportIdentifier
attrOffsetWithinReport#
uint8_t EmberGpTranslationTableAdditionalInfoBlockOptionRecordField::attrOffsetWithinReport
attrOffsetWithinReport#
uint8_t EmberGpTranslationTableAdditionalInfoBlockOptionRecordField::@3::@4::attrOffsetWithinReport
attributeID#
uint16_t EmberGpTranslationTableAdditionalInfoBlockOptionRecordField::@3::@4::attributeID
attributeDataType#
uint8_t EmberGpTranslationTableAdditionalInfoBlockOptionRecordField::attributeDataType
attributeDataType#
uint8_t EmberGpTranslationTableAdditionalInfoBlockOptionRecordField::@3::@4::attributeDataType
attributeOptions#
uint8_t EmberGpTranslationTableAdditionalInfoBlockOptionRecordField::attributeOptions
attributeOptions#
uint8_t EmberGpTranslationTableAdditionalInfoBlockOptionRecordField::@3::@4::attributeOptions
manufacturerID#
uint16_t EmberGpTranslationTableAdditionalInfoBlockOptionRecordField::@3::@4::manufacturerID
compactAttr#
struct EmberGpTranslationTableAdditionalInfoBlockOptionRecordField::@3::@4 EmberGpTranslationTableAdditionalInfoBlockOptionRecordField::compactAttr
compactAttr#
struct EmberGpTranslationTableAdditionalInfoBlockOptionRecordField::@3::@4 EmberGpTranslationTableAdditionalInfoBlockOptionRecordField::@3::compactAttr
contactStatus#
uint8_t EmberGpTranslationTableAdditionalInfoBlockOptionRecordField::@3::@5::contactStatus
contactBitmask#
uint8_t EmberGpTranslationTableAdditionalInfoBlockOptionRecordField::@3::@5::contactBitmask
genericSwitch#
struct EmberGpTranslationTableAdditionalInfoBlockOptionRecordField::@3::@5 EmberGpTranslationTableAdditionalInfoBlockOptionRecordField::genericSwitch
genericSwitch#
struct EmberGpTranslationTableAdditionalInfoBlockOptionRecordField::@3::@5 EmberGpTranslationTableAdditionalInfoBlockOptionRecordField::@3::genericSwitch
optionData#
union EmberGpTranslationTableAdditionalInfoBlockOptionRecordField::@3 EmberGpTranslationTableAdditionalInfoBlockOptionRecordField::optionData