Green Power Common#

API and Callbacks for the Green Power Common Component.

A component that provides common functionalities between client and server sides of the Green Power components.

API#

uint16_t
emberAfFillCommandGreenPowerClusterGpNotificationSmart(uint16_t options, uint32_t gpdSrcId, uint8_t *gpdIeee, uint8_t gpdEndpoint, uint32_t gpdSecurityFrameCounter, uint8_t gpdCommandId, uint8_t gpdCommandPayloadLength, const uint8_t *gpdCommandPayload, uint16_t gppShortAddress, uint8_t gppDistance)

Prepare a GP notification command buffer.

uint16_t
emberAfFillCommandGreenPowerClusterGpPairingSearchSmart(uint16_t options, uint32_t gpdSrcId, uint8_t *gpdIeee, uint8_t gpdEndpoint)

Prepare a GP pairing search command buffer.

uint16_t
emberAfFillCommandGreenPowerClusterGpTunnelingStopSmart(uint8_t options, uint32_t gpdSrcId, uint8_t *gpdIeee, uint8_t gpdEndpoint, uint32_t gpdSecurityFrameCounter, uint16_t gppShortAddress, int8_t gppDistance)

Prepare a GP tunneling stop command buffer.

uint16_t
emberAfFillCommandGreenPowerClusterGpCommissioningNotificationSmart(uint16_t options, uint32_t gpdSrcId, uint8_t *gpdIeee, uint8_t gpdEndpoint, uint8_t sequenceNumber, EmberGpSecurityLevel gpdfSecurityLevel, EmberGpSecurityFrameCounter gpdSecurityFrameCounter, uint8_t gpdCommandId, uint8_t gpdCommandPayloadLength, const uint8_t *gpdCommandPayload, EmberNodeId gppShortAddress, uint8_t gppLink, EmberGpMic mic)

Prepare a GP commissioning notification command buffer.

uint16_t
emberAfFillCommandGreenPowerClusterGpTranslationTableUpdateSmart(uint16_t options, uint32_t gpdSrcId, uint8_t *gpdIeee, uint8_t gpdEndpoint, uint8_t translationsLength, GpTranslationTableUpdateTranslation *translations, EmberGpTranslationTableAdditionalInfoBlockOptionRecordField *additionnalInfoBlock)

Prepare a GP translation table update command buffer.

uint16_t
emberAfFillCommandGreenPowerClusterGpPairingConfigurationSmart(uint8_t actions, uint16_t options, uint32_t gpdSrcId, uint8_t *gpdIeee, uint8_t gpdEndpoint, uint8_t gpdDeviceId, uint8_t groupListCount, uint8_t *groupList, uint16_t gpdAssignedAlias, uint8_t groupcastRadius, uint8_t securityOptions, uint32_t gpdSecurityFrameCounter, uint8_t *gpdSecurityKey, uint8_t numberOfPairedEndpoints, uint8_t *pairedEndpoints, uint8_t applicationInformation, uint16_t manufacturerId, uint16_t modeId, uint8_t numberOfGpdCommands, uint8_t *gpdCommandIdList, uint8_t clusterIdListCount, uint16_t *clusterListServer, uint16_t *clusterListClient, uint8_t switchInformationLength, uint8_t genericSwitchConfiguration, uint8_t currentContactStatus, uint8_t totalNumberOfReports, uint8_t numberOfReports, uint8_t *reportDescriptor)

Prepare a GP pairing configuration command buffer.

uint16_t
emberAfFillCommandGreenPowerClusterGpSinkTableRequestSmart(uint8_t options, uint32_t gpdSrcId, uint8_t *gpdIeee, uint8_t gpdEndpoint, uint8_t index)

Prepare a GP sink table request command buffer.

uint32_t
emberAfFillCommandGreenPowerClusterGpNotificationResponseSmart(uint8_t options, uint32_t gpdSrcId, uint8_t *gpdIeee, uint8_t gpdEndpoint, uint32_t gpdSecurityFrameCounter)

Prepare a GP notification response command buffer.

uint16_t
emberAfFillCommandGreenPowerClusterGpPairingSmart(uint32_t options, uint32_t gpdSrcId, uint8_t *gpdIeee, uint8_t gpdEndpoint, uint8_t *sinkIeeeAddress, uint16_t sinkNwkAddress, uint16_t sinkGroupId, uint8_t deviceId, uint32_t gpdSecurityFrameCounter, uint8_t *gpdKey, uint16_t assignedAlias, uint8_t groupcastRadius)

Prepare a GP pairing command buffer.

uint16_t
emberAfFillCommandGreenPowerClusterGpProxyCommissioningModeSmart(uint8_t options, uint16_t commissioningWindow, uint8_t channel)

Prepare a GP proxy commissioning mode command buffer.

uint16_t
emberAfFillCommandGreenPowerClusterGpResponseSmart(uint8_t options, uint16_t tempMasterShortAddress, uint8_t tempMasterTxChannel, uint32_t gpdSrcId, uint8_t *gpdIeee, uint8_t gpdEndpoint, uint8_t gpdCommandId, uint8_t gpdCommandPayloadLength, uint8_t *gpdCommandPayload)

Prepare a GP response command buffer.

uint16_t
emberAfFillCommandGreenPowerClusterGpProxyTableRequestSmart(uint8_t options, uint32_t gpdSrcId, uint8_t *gpdIeee, uint8_t gpdEndpoint, uint8_t index)

Prepare a GP proxy table request command buffer.

bool
emberAfGreenPowerCommonGpAddrCompare(const EmberGpAddress *a1, const EmberGpAddress *a2)

Compare two GP Addresses.

#define
emberAfFillCommandGreenPowerClusterGpProxyTableResponseSmart (status, totalNumberOfNonEmptyProxyTableEntries, startIndex, entriesCount)

Prepare a GP proxy commissioning mode command buffer.

#define
emberAfFillCommandGreenPowerClusterGpSinkTableResponseSmart (status, totalNumberofNonEmptySinkTableEntries, startIndex, sinkTableEntriesCount)

Prepare a GP sink table response command buffer.

#define
emberAfFillCommandGreenPowerClusterGpTranslationTableResponseSmart (status, options, totalNumberOfEntries, startIndex, entriesCount, translationTableList, translationTableListLen)

To provide GPD Command Translation Table content.

Enumerations#

enum
EMBER_ZCL_GP_GPD_GPP_LINK_QUALITY_POOR = 0x00
EMBER_ZCL_GP_GPD_GPP_LINK_QUALITY_MODERATE = 0x01
EMBER_ZCL_GP_GPD_GPP_LINK_QUALITY_HIGH = 0x02
EMBER_ZCL_GP_GPD_GPP_LINK_QUALITY_EXCELLENT = 0x03
}
enum
EMBER_ZCL_GP_UNKNOWN_SWITCH_TYPE = 0x00
EMBER_ZCL_GP_BUTTON_SWITCH_TYPE = 0x01
EMBER_ZCL_GP_ROCKER_SWITCH_TYPE = 0x02
EMBER_ZCL_GP_RESERVED_SWITCH_TYPE = 0x03
}

new enum for enum.h

enum
EMBER_GP_DEVICE_ID_GPD_SIMPLE_GENERIC_ONE_STATE_SWITCH = 0x00
EMBER_GP_DEVICE_ID_GPD_SIMPLE_GENERIC_TWO_STATE_SWITCH = 0x01
EMBER_GP_DEVICE_ID_GPD_ON_OFF_SWITCH = 0x02
EMBER_GP_DEVICE_ID_GPD_LEVEL_CONTROL_SWITCH = 0x03
EMBER_GP_DEVICE_ID_GPD_SIMPLE_SENSOR_SWITCH = 0x04
EMBER_GP_DEVICE_ID_GPD_ADVANCED_GENERIC_ONE_STATE_SWITCH = 0x05
EMBER_GP_DEVICE_ID_GPD_ADVANCED_GENERIC_TWO_STATE_SWITCH = 0x06
EMBER_GP_DEVICE_ID_GPD_GENERIC_SWITCH = 0x07
EMBER_GP_DEVICE_ID_GPD_COLOR_DIMMER_SWITCH = 0x10
EMBER_GP_DEVICE_ID_GPD_LIGHT_SENSOR_SWITCH = 0x11
EMBER_GP_DEVICE_ID_GPD_OCCUPANCY_SENSOR_SWITCH = 0x12
EMBER_GP_DEVICE_ID_GPD_DOOR_LOCK_CONTROLLER_SWITCH = 0x20
EMBER_GP_DEVICE_ID_GPD_TEMPERATURE_SENSOR_SWITCH = 0x30
EMBER_GP_DEVICE_ID_GPD_PRESSURE_SENSOR_SWITCH = 0x31
EMBER_GP_DEVICE_ID_GPD_FLOW_SENSOR_SWITCH = 0x32
EMBER_GP_DEVICE_ID_GPD_INDOOR_ENVIRONMENT_SENSOR = 0x33
EMBER_GP_DEVICE_ID_GPD_SCENCES = 0xFE
EMBER_GP_DEVICE_ID_GPD_UNDEFINED = 0xFE
}

enum: EmberAfGpGpdDeviceId

Macros#

#define
#define
IS_GPD_SRC_ID_ZERO (appId, srcId)

API Documentation#

emberAfFillCommandGreenPowerClusterGpNotificationSmart#

uint16_t emberAfFillCommandGreenPowerClusterGpNotificationSmart (uint16_t options, uint32_t gpdSrcId, uint8_t * gpdIeee, uint8_t gpdEndpoint, uint32_t gpdSecurityFrameCounter, uint8_t gpdCommandId, uint8_t gpdCommandPayloadLength, const uint8_t * gpdCommandPayload, uint16_t gppShortAddress, uint8_t gppDistance)

Prepare a GP notification command buffer.

Parameters
N/Aoptions

Options Ver.: always

N/AgpdSrcId

GPD Source Id Ver.: always

N/AgpdIeee

GPD IEEE address Ver.: always

N/AgpdEndpoint

GPD endpoint Ver.: always

N/AgpdSecurityFrameCounter

GPD security frame counter Ver.: always

N/AgpdCommandId

GPD command Id Ver.: always

N/AgpdCommandPayloadLength

Command payload length Ver.: always

N/AgpdCommandPayload

GPD command payload Ver.: always

N/AgppShortAddress

GP Proxy short address Ver.: always

N/AgppDistance

GP Proxy distance Ver.: always

This function prepares an application framework ZCL command buffer for the GP notification command with supplied arguments and returns the buffer length.

Returns

  • Length of the constructed command buffer


Definition at line 272 of file app/framework/plugin/green-power-common/green-power-common.h

emberAfFillCommandGreenPowerClusterGpPairingSearchSmart#

uint16_t emberAfFillCommandGreenPowerClusterGpPairingSearchSmart (uint16_t options, uint32_t gpdSrcId, uint8_t * gpdIeee, uint8_t gpdEndpoint)

Prepare a GP pairing search command buffer.

Parameters
N/Aoptions

Options Ver.: always

N/AgpdSrcId

GPD Source Id Ver.: always

N/AgpdIeee

GPD IEEE address Ver.: always

N/AgpdEndpoint

GPD endpoint Ver.: always

This function prepares an application framework ZCL command buffer for the GP pairing search command with supplied arguments and returns the buffer length.

Returns

  • Length of the constructed command buffer


Definition at line 294 of file app/framework/plugin/green-power-common/green-power-common.h

emberAfFillCommandGreenPowerClusterGpTunnelingStopSmart#

uint16_t emberAfFillCommandGreenPowerClusterGpTunnelingStopSmart (uint8_t options, uint32_t gpdSrcId, uint8_t * gpdIeee, uint8_t gpdEndpoint, uint32_t gpdSecurityFrameCounter, uint16_t gppShortAddress, int8_t gppDistance)

Prepare a GP tunneling stop command buffer.

Parameters
N/Aoptions

Options Ver.: always

N/AgpdSrcId

GPD Source Id Ver.: always

N/AgpdIeee

GPD IEEE address Ver.: always

N/AgpdEndpoint

GPD endpoint Ver.: always

N/AgpdSecurityFrameCounter

GPD security frame counter Ver.: always

N/AgppShortAddress

GP Proxy short address Ver.: always

N/AgppDistance

GP Proxy distance Ver.: always

This function prepares an application framework ZCL command buffer for the GP tunneling stop command with supplied arguments and returns the buffer length.

Returns

  • Length of the constructed command buffer


Definition at line 313 of file app/framework/plugin/green-power-common/green-power-common.h

emberAfFillCommandGreenPowerClusterGpCommissioningNotificationSmart#

uint16_t emberAfFillCommandGreenPowerClusterGpCommissioningNotificationSmart (uint16_t options, uint32_t gpdSrcId, uint8_t * gpdIeee, uint8_t gpdEndpoint, uint8_t sequenceNumber, EmberGpSecurityLevel gpdfSecurityLevel, EmberGpSecurityFrameCounter gpdSecurityFrameCounter, uint8_t gpdCommandId, uint8_t gpdCommandPayloadLength, const uint8_t * gpdCommandPayload, EmberNodeId gppShortAddress, uint8_t gppLink, EmberGpMic mic)

Prepare a GP commissioning notification command buffer.

Parameters
N/Aoptions

Options Ver.: always

N/AgpdSrcId

GPD Source Id Ver.: always

N/AgpdIeee

GPD IEEE address Ver.: always

N/AgpdEndpoint

GPD endpoint Ver.: always

N/AsequenceNumber

MAC Sequence to be used in security counter field for GPD security level 0 Ver.: always

N/AgpdfSecurityLevel

GPD security level Ver.: always

N/AgpdSecurityFrameCounter

GPD security frame counter Ver.: always

N/AgpdCommandId

GPD command Id Ver.: always

N/AgpdCommandPayloadLength

Command payload length Ver.: always

N/AgpdCommandPayload

GPD command payload Ver.: always

N/AgppShortAddress

GP Proxy short address Ver.: always

N/AgppLink

GPD-GP Proxy link Ver.: always

N/Amic

Message Integrity Code when security level is 2 or 3 Ver.: always

This function prepares an application framework ZCL command buffer for the GP commissioning notification command with supplied arguments and returns the buffer length.

Returns

  • Length of the constructed command buffer


Definition at line 342 of file app/framework/plugin/green-power-common/green-power-common.h

emberAfFillCommandGreenPowerClusterGpTranslationTableUpdateSmart#

uint16_t emberAfFillCommandGreenPowerClusterGpTranslationTableUpdateSmart (uint16_t options, uint32_t gpdSrcId, uint8_t * gpdIeee, uint8_t gpdEndpoint, uint8_t translationsLength, GpTranslationTableUpdateTranslation * translations, EmberGpTranslationTableAdditionalInfoBlockOptionRecordField * additionnalInfoBlock)

Prepare a GP translation table update command buffer.

Parameters
N/Aoptions

Options Ver.: always

N/AgpdSrcId

GPD Source Id Ver.: always

N/AgpdIeee

GPD IEEE address Ver.: always

N/AgpdEndpoint

GPD endpoint Ver.: always

N/AtranslationsLength

Length of the translations packet Ver.: always

N/Atranslations

On or more number of translations Ver.: always

N/AadditionnalInfoBlock

Additional Information block used along with the translations Ver.: always

This function prepares an application framework ZCL command buffer for the GP translation table update command with supplied arguments and returns the buffer length.

Returns

  • Length of the constructed command buffer


Definition at line 371 of file app/framework/plugin/green-power-common/green-power-common.h

emberAfFillCommandGreenPowerClusterGpPairingConfigurationSmart#

uint16_t emberAfFillCommandGreenPowerClusterGpPairingConfigurationSmart (uint8_t actions, uint16_t options, uint32_t gpdSrcId, uint8_t * gpdIeee, uint8_t gpdEndpoint, uint8_t gpdDeviceId, uint8_t groupListCount, uint8_t * groupList, uint16_t gpdAssignedAlias, uint8_t groupcastRadius, uint8_t securityOptions, uint32_t gpdSecurityFrameCounter, uint8_t * gpdSecurityKey, uint8_t numberOfPairedEndpoints, uint8_t * pairedEndpoints, uint8_t applicationInformation, uint16_t manufacturerId, uint16_t modeId, uint8_t numberOfGpdCommands, uint8_t * gpdCommandIdList, uint8_t clusterIdListCount, uint16_t * clusterListServer, uint16_t * clusterListClient, uint8_t switchInformationLength, uint8_t genericSwitchConfiguration, uint8_t currentContactStatus, uint8_t totalNumberOfReports, uint8_t numberOfReports, uint8_t * reportDescriptor)

Prepare a GP pairing configuration command buffer.

Parameters
N/Aactions

GP Pairing actions field Ver.: always

N/Aoptions

Options Ver.: always

N/AgpdSrcId

GPD Source Id Ver.: always

N/AgpdIeee

GPD IEEE address Ver.: always

N/AgpdEndpoint

GPD endpoint Ver.: always

N/AgpdDeviceId

GPD Device Id Ver.: always

N/AgroupListCount

Group list count Ver.: always

N/AgroupList

Group list Ver.: always

N/AgpdAssignedAlias

GPD assigned alias Ver.: always

N/AgroupcastRadius

Group cast radius Ver.: always

N/AsecurityOptions

Security options Ver.: always

N/AgpdSecurityFrameCounter

Security frame counter Ver.: always

N/AgpdSecurityKey

Security key Ver.: always

N/AnumberOfPairedEndpoints

Number of paired endpoints Ver.: always

N/ApairedEndpoints

Paired endpoint list Ver.: always

N/AapplicationInformation

Application information field Ver.: always

N/AmanufacturerId

GPD Manufacture Id Ver.: always

N/AmodeId

GPD Model Id Ver.: always

N/AnumberOfGpdCommands

Number of GPD commands Ver.: always

N/AgpdCommandIdList

GPD commands list Ver.: always

N/AclusterIdListCount

Cluster List count Ver.: always

N/AclusterListServer

Server cluster list Ver.: always

N/AclusterListClient

Client cluster list Ver.: always

N/AswitchInformationLength

Generic switch information length Ver.: always

N/AgenericSwitchConfiguration

GGeneric switch configuration Ver.: always

N/AcurrentContactStatus

Current contact status Ver.: always

N/AtotalNumberOfReports

Total number of reports configured Ver.: always

N/AnumberOfReports

Number of reports in the report present in descriptor Ver.: always

N/AreportDescriptor

Report descriptors list Ver.: always

This function prepares an application framework ZCL command buffer for the GP pairing configuration command with supplied arguments and returns the buffer length.

Returns

  • Length of the constructed command buffer


Definition at line 416 of file app/framework/plugin/green-power-common/green-power-common.h

emberAfFillCommandGreenPowerClusterGpSinkTableRequestSmart#

uint16_t emberAfFillCommandGreenPowerClusterGpSinkTableRequestSmart (uint8_t options, uint32_t gpdSrcId, uint8_t * gpdIeee, uint8_t gpdEndpoint, uint8_t index)

Prepare a GP sink table request command buffer.

Parameters
N/Aoptions

Options Ver.: always

N/AgpdSrcId

GPD Source Id Ver.: always

N/AgpdIeee

GPD IEEE address Ver.: always

N/AgpdEndpoint

GPD endpoint Ver.: always

N/Aindex

Requested table index to start Ver.: always

This function prepares an application framework ZCL command buffer for the GP sink table request command with supplied arguments and returns the buffer length.

Returns

  • Length of the constructed command buffer


Definition at line 459 of file app/framework/plugin/green-power-common/green-power-common.h

emberAfFillCommandGreenPowerClusterGpNotificationResponseSmart#

uint32_t emberAfFillCommandGreenPowerClusterGpNotificationResponseSmart (uint8_t options, uint32_t gpdSrcId, uint8_t * gpdIeee, uint8_t gpdEndpoint, uint32_t gpdSecurityFrameCounter)

Prepare a GP notification response command buffer.

Parameters
N/Aoptions

Options Ver.: always

N/AgpdSrcId

GPD Source Id Ver.: always

N/AgpdIeee

GPD IEEE address Ver.: always

N/AgpdEndpoint

GPD endpoint Ver.: always

N/AgpdSecurityFrameCounter

GPD security frame counter Ver.: always

This function prepares an application framework ZCL command buffer for the GP notification response command with supplied arguments and returns the buffer length.

Returns

  • Length of the constructed command buffer


Definition at line 478 of file app/framework/plugin/green-power-common/green-power-common.h

emberAfFillCommandGreenPowerClusterGpPairingSmart#

uint16_t emberAfFillCommandGreenPowerClusterGpPairingSmart (uint32_t options, uint32_t gpdSrcId, uint8_t * gpdIeee, uint8_t gpdEndpoint, uint8_t * sinkIeeeAddress, uint16_t sinkNwkAddress, uint16_t sinkGroupId, uint8_t deviceId, uint32_t gpdSecurityFrameCounter, uint8_t * gpdKey, uint16_t assignedAlias, uint8_t groupcastRadius)

Prepare a GP pairing command buffer.

Parameters
N/Aoptions

Options Ver.: always

N/AgpdSrcId

GPD Source Id Ver.: always

N/AgpdIeee

GPD IEEE address Ver.: always

N/AgpdEndpoint

GPD endpoint Ver.: always

N/AsinkIeeeAddress

Sink IEEE address Ver.: always

N/AsinkNwkAddress

Sink network address Ver.: always

N/AsinkGroupId

Sink group Id Ver.: always

N/AdeviceId

GPD Device Id Ver.: always

N/AgpdSecurityFrameCounter

GPD security frame counter Ver.: always

N/AgpdKey

GPD security key Ver.: always

N/AassignedAlias

GPD assigned alias Ver.: always

N/AgroupcastRadius

Group cast radius of this message Ver.: always

This function prepares an application framework ZCL command buffer for the GP pairing command with supplied arguments and returns the buffer length.

Returns

  • Length of the constructed command buffer


Definition at line 503 of file app/framework/plugin/green-power-common/green-power-common.h

emberAfFillCommandGreenPowerClusterGpProxyCommissioningModeSmart#

uint16_t emberAfFillCommandGreenPowerClusterGpProxyCommissioningModeSmart (uint8_t options, uint16_t commissioningWindow, uint8_t channel)

Prepare a GP proxy commissioning mode command buffer.

Parameters
N/Aoptions

Options Ver.: always

N/AcommissioningWindow

Commissioning window in seconds Ver.: always

N/Achannel

Proxy channel field Ver.: always

This function prepares an application framework ZCL command buffer for the GP proxy commissioning mode command with supplied arguments and returns the buffer length.

Returns

  • Length of the constructed command buffer


Definition at line 526 of file app/framework/plugin/green-power-common/green-power-common.h

emberAfFillCommandGreenPowerClusterGpResponseSmart#

uint16_t emberAfFillCommandGreenPowerClusterGpResponseSmart (uint8_t options, uint16_t tempMasterShortAddress, uint8_t tempMasterTxChannel, uint32_t gpdSrcId, uint8_t * gpdIeee, uint8_t gpdEndpoint, uint8_t gpdCommandId, uint8_t gpdCommandPayloadLength, uint8_t * gpdCommandPayload)

Prepare a GP response command buffer.

Parameters
N/Aoptions

Options Ver.: always

N/AtempMasterShortAddress

Proxy Temp Master short address Ver.: always

N/AtempMasterTxChannel

Proxy Temp Master transmit channel Ver.: always

N/AgpdSrcId

GPD Source Id Ver.: always

N/AgpdIeee

GPD IEEE address Ver.: always

N/AgpdEndpoint

GPD endpoint Ver.: always

N/AgpdCommandId

GPD command id Ver.: always

N/AgpdCommandPayloadLength

GPD command length Ver.: always

N/AgpdCommandPayload

GPD command payload Ver.: always

This function prepares an application framework ZCL command buffer for the GP response command with supplied arguments and returns the buffer length.

Returns

  • Length of the constructed command buffer


Definition at line 546 of file app/framework/plugin/green-power-common/green-power-common.h

emberAfFillCommandGreenPowerClusterGpProxyTableRequestSmart#

uint16_t emberAfFillCommandGreenPowerClusterGpProxyTableRequestSmart (uint8_t options, uint32_t gpdSrcId, uint8_t * gpdIeee, uint8_t gpdEndpoint, uint8_t index)

Prepare a GP proxy table request command buffer.

Parameters
N/Aoptions

Options Ver.: always

N/AgpdSrcId

GPD Source Id Ver.: always

N/AgpdIeee

GPD IEEE address Ver.: always

N/AgpdEndpoint

GPD endpoint Ver.: always

N/Aindex

Requested table index to start Ver.: always

This function prepares an application framework ZCL command buffer for the GP proxy table request command with supplied arguments and returns the buffer length.

Returns

  • Length of the constructed command buffer


Definition at line 568 of file app/framework/plugin/green-power-common/green-power-common.h

emberAfGreenPowerCommonGpAddrCompare#

bool emberAfGreenPowerCommonGpAddrCompare (const EmberGpAddress * a1, const EmberGpAddress * a2)

Compare two GP Addresses.

Parameters
N/Aa1

First address to compare Ver.: always

N/Aa2

Second address to compare Ver.: always

This function compares two GP Addresses and returns true if they are the same.

Returns

  • True if the address are same


Definition at line 582 of file app/framework/plugin/green-power-common/green-power-common.h

emberAfFillCommandGreenPowerClusterGpProxyTableResponseSmart#

#define emberAfFillCommandGreenPowerClusterGpProxyTableResponseSmart
Value:
emberAfFillExternalBuffer((ZCL_CLUSTER_SPECIFIC_COMMAND \
| ZCL_DISABLE_DEFAULT_RESPONSE_MASK \
| ZCL_FRAME_CONTROL_CLIENT_TO_SERVER), \
ZCL_GREEN_POWER_CLUSTER_ID, \
ZCL_GP_PROXY_TABLE_RESPONSE_COMMAND_ID, \
"uuuu", \
status, \
totalNumberOfNonEmptyProxyTableEntries, \
startIndex, \
entriesCount)

Prepare a GP proxy commissioning mode command buffer.

This function prepares an application framework ZCL command buffer for the GP proxy commissioning mode command with supplied arguments and returns the buffer length.

Returns

  • Length of the constructed command buffer


Definition at line 184 of file app/framework/plugin/green-power-common/green-power-common.h

emberAfFillCommandGreenPowerClusterGpSinkTableResponseSmart#

#define emberAfFillCommandGreenPowerClusterGpSinkTableResponseSmart
Value:
emberAfFillExternalBuffer((ZCL_CLUSTER_SPECIFIC_COMMAND \
| ZCL_DISABLE_DEFAULT_RESPONSE_MASK \
| ZCL_FRAME_CONTROL_SERVER_TO_CLIENT), \
ZCL_GREEN_POWER_CLUSTER_ID, \
ZCL_GP_SINK_TABLE_RESPONSE_COMMAND_ID, \
"uuuu", \
status, \
totalNumberofNonEmptySinkTableEntries, \
startIndex, \
sinkTableEntriesCount)

Prepare a GP sink table response command buffer.

This function prepares an application framework ZCL command buffer for the GP sink table response command with supplied arguments and returns the buffer length.

Returns

  • Length of the constructed command buffer


Definition at line 211 of file app/framework/plugin/green-power-common/green-power-common.h

emberAfFillCommandGreenPowerClusterGpTranslationTableResponseSmart#

#define emberAfFillCommandGreenPowerClusterGpTranslationTableResponseSmart
Value:
emberAfFillExternalBuffer((ZCL_CLUSTER_SPECIFIC_COMMAND \
| ZCL_DISABLE_DEFAULT_RESPONSE_MASK \
| ZCL_FRAME_CONTROL_SERVER_TO_CLIENT), \
ZCL_GREEN_POWER_CLUSTER_ID, \
ZCL_GP_TRANSLATION_TABLE_RESPONSE_COMMAND_ID, \
"uuuuub", \
status, \
options, \
totalNumberOfEntries, \
startIndex, \
entriesCount, \
translationTableList, \
translationTableListLen)

To provide GPD Command Translation Table content.

Cluster: Green Power, The Green Power cluster defines the format of the commands exchanged when handling GPDs. Command: GpTranslationTableResponse


Definition at line 241 of file app/framework/plugin/green-power-common/green-power-common.h

Enumeration Documentation#

EmberAfGPGpdGppLinkQuality#

EmberAfGPGpdGppLinkQuality
Enumerator
EMBER_ZCL_GP_GPD_GPP_LINK_QUALITY_POOR
EMBER_ZCL_GP_GPD_GPP_LINK_QUALITY_MODERATE
EMBER_ZCL_GP_GPD_GPP_LINK_QUALITY_HIGH
EMBER_ZCL_GP_GPD_GPP_LINK_QUALITY_EXCELLENT

Definition at line 122 of file app/framework/plugin/green-power-common/green-power-common.h

EmberAfGPGenericSwSwitchType#

EmberAfGPGenericSwSwitchType

new enum for enum.h

Enumerator
EMBER_ZCL_GP_UNKNOWN_SWITCH_TYPE
EMBER_ZCL_GP_BUTTON_SWITCH_TYPE
EMBER_ZCL_GP_ROCKER_SWITCH_TYPE
EMBER_ZCL_GP_RESERVED_SWITCH_TYPE

Definition at line 132 of file app/framework/plugin/green-power-common/green-power-common.h

EmberAfGpDeviceIdGpd#

EmberAfGpDeviceIdGpd

enum: EmberAfGpGpdDeviceId

Enumerator
EMBER_GP_DEVICE_ID_GPD_SIMPLE_GENERIC_ONE_STATE_SWITCH
EMBER_GP_DEVICE_ID_GPD_SIMPLE_GENERIC_TWO_STATE_SWITCH
EMBER_GP_DEVICE_ID_GPD_ON_OFF_SWITCH
EMBER_GP_DEVICE_ID_GPD_LEVEL_CONTROL_SWITCH
EMBER_GP_DEVICE_ID_GPD_SIMPLE_SENSOR_SWITCH
EMBER_GP_DEVICE_ID_GPD_ADVANCED_GENERIC_ONE_STATE_SWITCH
EMBER_GP_DEVICE_ID_GPD_ADVANCED_GENERIC_TWO_STATE_SWITCH
EMBER_GP_DEVICE_ID_GPD_GENERIC_SWITCH
EMBER_GP_DEVICE_ID_GPD_COLOR_DIMMER_SWITCH
EMBER_GP_DEVICE_ID_GPD_LIGHT_SENSOR_SWITCH
EMBER_GP_DEVICE_ID_GPD_OCCUPANCY_SENSOR_SWITCH
EMBER_GP_DEVICE_ID_GPD_DOOR_LOCK_CONTROLLER_SWITCH
EMBER_GP_DEVICE_ID_GPD_TEMPERATURE_SENSOR_SWITCH
EMBER_GP_DEVICE_ID_GPD_PRESSURE_SENSOR_SWITCH
EMBER_GP_DEVICE_ID_GPD_FLOW_SENSOR_SWITCH
EMBER_GP_DEVICE_ID_GPD_INDOOR_ENVIRONMENT_SENSOR
EMBER_GP_DEVICE_ID_GPD_SCENCES
EMBER_GP_DEVICE_ID_GPD_UNDEFINED

Definition at line 142 of file app/framework/plugin/green-power-common/green-power-common.h

Macro Definition Documentation#

GREEN_POWER_SERVER_NO_PAIRED_ENDPOINTS#

#define GREEN_POWER_SERVER_NO_PAIRED_ENDPOINTS
Value:
0x00

Definition at line 35 of file app/framework/plugin/green-power-common/green-power-common.h

GREEN_POWER_SERVER_RAW_GPD_PROCESS_IN_APP_ENDPOINTS#

#define GREEN_POWER_SERVER_RAW_GPD_PROCESS_IN_APP_ENDPOINTS
Value:
0xFD

Definition at line 36 of file app/framework/plugin/green-power-common/green-power-common.h

GREEN_POWER_SERVER_RESERVED_ENDPOINTS#

#define GREEN_POWER_SERVER_RESERVED_ENDPOINTS
Value:
0xFD

Definition at line 37 of file app/framework/plugin/green-power-common/green-power-common.h

GREEN_POWER_SERVER_SINK_DERIVES_ENDPOINTS#

#define GREEN_POWER_SERVER_SINK_DERIVES_ENDPOINTS
Value:
0xFE

Definition at line 38 of file app/framework/plugin/green-power-common/green-power-common.h

GREEN_POWER_SERVER_ALL_SINK_ENDPOINTS#

#define GREEN_POWER_SERVER_ALL_SINK_ENDPOINTS
Value:
0xFF

Definition at line 39 of file app/framework/plugin/green-power-common/green-power-common.h

GREEN_POWER_SERVER_MIN_VALID_APP_ENDPOINT#

#define GREEN_POWER_SERVER_MIN_VALID_APP_ENDPOINT
Value:
1

Definition at line 41 of file app/framework/plugin/green-power-common/green-power-common.h

GREEN_POWER_SERVER_MAX_VALID_APP_ENDPOINT#

#define GREEN_POWER_SERVER_MAX_VALID_APP_ENDPOINT
Value:
240

Definition at line 42 of file app/framework/plugin/green-power-common/green-power-common.h

EMBER_AF_GP_GPD_CHANNEL_REQUEST_CHANNEL_TOGGLING_BEHAVIOR_RX_CHANNEL_NEXT_ATTEMPT#

#define EMBER_AF_GP_GPD_CHANNEL_REQUEST_CHANNEL_TOGGLING_BEHAVIOR_RX_CHANNEL_NEXT_ATTEMPT
Value:
(0x0F)

Definition at line 44 of file app/framework/plugin/green-power-common/green-power-common.h

EMBER_AF_GP_GPD_CHANNEL_REQUEST_CHANNEL_TOGGLING_BEHAVIOR_RX_CHANNEL_SECOND_NEXT_ATTEMPT#

#define EMBER_AF_GP_GPD_CHANNEL_REQUEST_CHANNEL_TOGGLING_BEHAVIOR_RX_CHANNEL_SECOND_NEXT_ATTEMPT
Value:
(0xF0)

Definition at line 45 of file app/framework/plugin/green-power-common/green-power-common.h

EMBER_AF_GP_GPD_CHANNEL_REQUEST_CHANNEL_TOGGLING_BEHAVIOR_RX_CHANNEL_SECOND_NEXT_ATTEMPT_OFFSET#

#define EMBER_AF_GP_GPD_CHANNEL_REQUEST_CHANNEL_TOGGLING_BEHAVIOR_RX_CHANNEL_SECOND_NEXT_ATTEMPT_OFFSET
Value:
(4)

Definition at line 46 of file app/framework/plugin/green-power-common/green-power-common.h

EMBER_AF_GP_GPD_APPLICATION_DESCRIPTION_COMMAND_REPORT_OPTIONS_TIMEOUT_PERIOD_PRESENT#

#define EMBER_AF_GP_GPD_APPLICATION_DESCRIPTION_COMMAND_REPORT_OPTIONS_TIMEOUT_PERIOD_PRESENT
Value:
(0x01)

Definition at line 48 of file app/framework/plugin/green-power-common/green-power-common.h

EMBER_AF_GP_TRANSLATION_TABLE_ZB_ENDPOINT_PASS_FRAME_TO_APLLICATION#

#define EMBER_AF_GP_TRANSLATION_TABLE_ZB_ENDPOINT_PASS_FRAME_TO_APLLICATION
Value:
(0xFC)

Definition at line 49 of file app/framework/plugin/green-power-common/green-power-common.h

EMBER_AF_GP_SINK_TABLE_ENTRY_OPTIONS_MASK#

#define EMBER_AF_GP_SINK_TABLE_ENTRY_OPTIONS_MASK
Value:
(0x03FF)

Definition at line 51 of file app/framework/plugin/green-power-common/green-power-common.h

GP_TRANSLATION_TABLE_SCAN_LEVEL_GPD_ID#

#define GP_TRANSLATION_TABLE_SCAN_LEVEL_GPD_ID
Value:
(0x01)

Definition at line 55 of file app/framework/plugin/green-power-common/green-power-common.h

GP_TRANSLATION_TABLE_SCAN_LEVEL_GPD_CMD_ID#

#define GP_TRANSLATION_TABLE_SCAN_LEVEL_GPD_CMD_ID
Value:
(0x02)

Definition at line 56 of file app/framework/plugin/green-power-common/green-power-common.h

GP_TRANSLATION_TABLE_SCAN_LEVEL_GPD_PAYLOAD#

#define GP_TRANSLATION_TABLE_SCAN_LEVEL_GPD_PAYLOAD
Value:
(0x04)

Definition at line 57 of file app/framework/plugin/green-power-common/green-power-common.h

GP_TRANSLATION_TABLE_SCAN_LEVEL_ZB_ENDPOINT#

#define GP_TRANSLATION_TABLE_SCAN_LEVEL_ZB_ENDPOINT
Value:
(0x08)

Definition at line 58 of file app/framework/plugin/green-power-common/green-power-common.h

GP_TRANSLATION_TABLE_SCAN_LEVEL_ADDITIONAL_INFO_BLOCK#

#define GP_TRANSLATION_TABLE_SCAN_LEVEL_ADDITIONAL_INFO_BLOCK
Value:
(0x10)

Definition at line 59 of file app/framework/plugin/green-power-common/green-power-common.h

EMBER_GP_NOTIFICATION_COMMISSIONED_GROUPCAST_SEQUENCE_NUMBER_OFFSET#

#define EMBER_GP_NOTIFICATION_COMMISSIONED_GROUPCAST_SEQUENCE_NUMBER_OFFSET
Value:
(9)

Definition at line 61 of file app/framework/plugin/green-power-common/green-power-common.h

EMBER_GP_NOTIFICATION_COMMISSIONED_GROUPCAST_SEQUENCE_NUMBER_OFFSET#

#define EMBER_GP_NOTIFICATION_COMMISSIONED_GROUPCAST_SEQUENCE_NUMBER_OFFSET
Value:
(9)

Definition at line 84 of file app/framework/plugin/green-power-common/green-power-common.h

EMBER_AF_GP_GPP_GPD_LINK_RSSI#

#define EMBER_AF_GP_GPP_GPD_LINK_RSSI
Value:
(0x3F)

Definition at line 63 of file app/framework/plugin/green-power-common/green-power-common.h

EMBER_AF_GP_GPP_GPD_LINK_LINK_QUALITY#

#define EMBER_AF_GP_GPP_GPD_LINK_LINK_QUALITY
Value:
(0xC0)

Definition at line 64 of file app/framework/plugin/green-power-common/green-power-common.h

EMBER_AF_GP_GPP_GPD_LINK_LINK_QUALITY_OFFSET#

#define EMBER_AF_GP_GPP_GPD_LINK_LINK_QUALITY_OFFSET
Value:
(6)

Definition at line 65 of file app/framework/plugin/green-power-common/green-power-common.h

EMBER_AF_GP_PAIRING_CONFIGURATION_ACTIONS_MASK#

#define EMBER_AF_GP_PAIRING_CONFIGURATION_ACTIONS_MASK
Value:
(0x0F)

Definition at line 67 of file app/framework/plugin/green-power-common/green-power-common.h

EMBER_AF_GP_PAIRING_CONFIGURATION_OPTION_MASK#

#define EMBER_AF_GP_PAIRING_CONFIGURATION_OPTION_MASK
Value:
(0x07FF)

Definition at line 68 of file app/framework/plugin/green-power-common/green-power-common.h

EMBER_AF_GP_PAIRING_CONFIGURATION_OPTION_MASK#

#define EMBER_AF_GP_PAIRING_CONFIGURATION_OPTION_MASK
Value:
(0x07FF)

Definition at line 69 of file app/framework/plugin/green-power-common/green-power-common.h

EMBER_AF_GP_APPLICATION_INFORMATION_CLUSTER_LIST_NUMBER_OF_SERVER_CLUSTER_MASK#

#define EMBER_AF_GP_APPLICATION_INFORMATION_CLUSTER_LIST_NUMBER_OF_SERVER_CLUSTER_MASK
Value:
(0x0F)

Definition at line 71 of file app/framework/plugin/green-power-common/green-power-common.h

EMBER_AF_GP_APPLICATION_INFORMATION_CLUSTER_LIST_NUMBER_OF_CLIENT_CLUSTER_MASK#

#define EMBER_AF_GP_APPLICATION_INFORMATION_CLUSTER_LIST_NUMBER_OF_CLIENT_CLUSTER_MASK
Value:
(0xF0)

Definition at line 72 of file app/framework/plugin/green-power-common/green-power-common.h

EMBER_AF_GP_APPLICATION_INFORMATION_CLUSTER_LIST_NUMBER_OF_CLIENT_CLUSTER_MASK_OFFSET#

#define EMBER_AF_GP_APPLICATION_INFORMATION_CLUSTER_LIST_NUMBER_OF_CLIENT_CLUSTER_MASK_OFFSET
Value:
(4)

Definition at line 73 of file app/framework/plugin/green-power-common/green-power-common.h

EMBER_AF_GP_APPLICATION_INFORMATION_GPD_APPLICATION_DESCRIPTION_COMMAND_FOLLOWS#

#define EMBER_AF_GP_APPLICATION_INFORMATION_GPD_APPLICATION_DESCRIPTION_COMMAND_FOLLOWS
Value:
(0x20)

Definition at line 75 of file app/framework/plugin/green-power-common/green-power-common.h

EMBER_AF_GP_APPLICATION_INFORMATION_GPD_APPLICATION_DESCRIPTION_COMMAND_FOLLOWS_OFFSET#

#define EMBER_AF_GP_APPLICATION_INFORMATION_GPD_APPLICATION_DESCRIPTION_COMMAND_FOLLOWS_OFFSET
Value:
(5)

Definition at line 76 of file app/framework/plugin/green-power-common/green-power-common.h

EMBER_AF_GP_APPLICATION_INFORMATION_SWITCH_INFORMATION_CONFIGURATION_NB_OF_CONTACT#

#define EMBER_AF_GP_APPLICATION_INFORMATION_SWITCH_INFORMATION_CONFIGURATION_NB_OF_CONTACT
Value:
(0x0F)

Definition at line 78 of file app/framework/plugin/green-power-common/green-power-common.h

EMBER_AF_GP_APPLICATION_INFORMATION_SWITCH_INFORMATION_CONFIGURATION_SWITCH_TYPE#

#define EMBER_AF_GP_APPLICATION_INFORMATION_SWITCH_INFORMATION_CONFIGURATION_SWITCH_TYPE
Value:
(0x30)

Definition at line 79 of file app/framework/plugin/green-power-common/green-power-common.h

EMBER_AF_GP_APPLICATION_INFORMATION_SWITCH_INFORMATION_CONFIGURATION_SWITCH_TYPE_OFFSET#

#define EMBER_AF_GP_APPLICATION_INFORMATION_SWITCH_INFORMATION_CONFIGURATION_SWITCH_TYPE_OFFSET
Value:
(4)

Definition at line 80 of file app/framework/plugin/green-power-common/green-power-common.h

GP_COMMISSIONING_SECURITY_LEVEL_TO_OPTIONS_SHIFT#

#define GP_COMMISSIONING_SECURITY_LEVEL_TO_OPTIONS_SHIFT
Value:
(4)

Definition at line 82 of file app/framework/plugin/green-power-common/green-power-common.h

GP_COMMISSIONING_SECURITY_KEY_TYPE_TO_OPTIONS_SHIFT#

#define GP_COMMISSIONING_SECURITY_KEY_TYPE_TO_OPTIONS_SHIFT
Value:
(6)

Definition at line 83 of file app/framework/plugin/green-power-common/green-power-common.h

EMBER_GP_COMMISSIONING_NOTIFICATION_SEQUENCE_NUMBER_OFFSET#

#define EMBER_GP_COMMISSIONING_NOTIFICATION_SEQUENCE_NUMBER_OFFSET
Value:
(12)

Definition at line 85 of file app/framework/plugin/green-power-common/green-power-common.h

EMBER_AF_GREEN_POWER_SERVER_GPDF_SCENE_DERIVED_GROUP_ID#

#define EMBER_AF_GREEN_POWER_SERVER_GPDF_SCENE_DERIVED_GROUP_ID
Value:
(0xFFFF)

Definition at line 87 of file app/framework/plugin/green-power-common/green-power-common.h

GP_DEVICE_ANNOUNCE_SPOOF_MSG_SIZE#

#define GP_DEVICE_ANNOUNCE_SPOOF_MSG_SIZE
Value:
12

Definition at line 89 of file app/framework/plugin/green-power-common/green-power-common.h

IS_RESERVED_GPD_SRC_ID#

#define IS_RESERVED_GPD_SRC_ID
Value:
(((srcId) >= GP_GPD_SRC_ID_RESERVED_FFFFFF9) \
&& ((srcId) <= GP_GPD_SRC_ID_RESERVED_FFFFFFE))

Definition at line 92 of file app/framework/plugin/green-power-common/green-power-common.h

IS_GPD_SRC_ID_ZERO#

#define IS_GPD_SRC_ID_ZERO
Value:
(((appId) == EMBER_GP_APPLICATION_SOURCE_ID) \
&& ((srcId) == GP_GPD_SRC_ID_RESERVED_0))

Definition at line 96 of file app/framework/plugin/green-power-common/green-power-common.h

emberAfGreenPowerTTGetAdditionalInfoBlockPresent#

#define emberAfGreenPowerTTGetAdditionalInfoBlockPresent
Value:
(options)

Definition at line 100 of file app/framework/plugin/green-power-common/green-power-common.h

emberAfGreenPowerTTUpdateGetAdditionalInfoBlockPresent#

#define emberAfGreenPowerTTUpdateGetAdditionalInfoBlockPresent
Value:
(options)

Definition at line 102 of file app/framework/plugin/green-power-common/green-power-common.h

emberAfGreenPowerPairingConfigGetApplicationInfoPresent#

#define emberAfGreenPowerPairingConfigGetApplicationInfoPresent
Value:
(options)

Definition at line 104 of file app/framework/plugin/green-power-common/green-power-common.h

emberAfGreenPowerPairingOptionsGetCommMode#

#define emberAfGreenPowerPairingOptionsGetCommMode
Value:
(options)

Definition at line 105 of file app/framework/plugin/green-power-common/green-power-common.h

emberAfGreenPowerPairingOptionsGetAddSink#

#define emberAfGreenPowerPairingOptionsGetAddSink
Value:
(options)

Definition at line 106 of file app/framework/plugin/green-power-common/green-power-common.h

emberAfGreenPowerGetApplicationId#

#define emberAfGreenPowerGetApplicationId
Value:
(options)

Definition at line 107 of file app/framework/plugin/green-power-common/green-power-common.h

emberAfGreenPowerGpdSeqNumCap#

#define emberAfGreenPowerGpdSeqNumCap
Value:
(entry)

Definition at line 108 of file app/framework/plugin/green-power-common/green-power-common.h

emberAfGreenPowerSecurityLevel#

#define emberAfGreenPowerSecurityLevel
Value:
(entry)

Definition at line 109 of file app/framework/plugin/green-power-common/green-power-common.h

emberAfGreenPowerFixedDuringOperation#

#define emberAfGreenPowerFixedDuringOperation
Value:
(options)

Definition at line 112 of file app/framework/plugin/green-power-common/green-power-common.h

emberAfGreenPowerMobileCap#

#define emberAfGreenPowerMobileCap
Value:
(options)

Definition at line 113 of file app/framework/plugin/green-power-common/green-power-common.h

emberAfGreenPowerPortableCap#

#define emberAfGreenPowerPortableCap
Value:
(options)

Definition at line 114 of file app/framework/plugin/green-power-common/green-power-common.h

emberAfGreenPowerSecurityKeyType#

#define emberAfGreenPowerSecurityKeyType
Value:
(options)

Definition at line 115 of file app/framework/plugin/green-power-common/green-power-common.h

emberAfGreenPowerCheckReturnOfPutDataInResponse#

#define emberAfGreenPowerCheckReturnOfPutDataInResponse
Value:
({ if ((ret) == NULL) { \
return 0; \
} \
}) \
/** @brief as the proxy table response status present in enum.h, this is for the sink
*
*/

Definition at line 118 of file app/framework/plugin/green-power-common/green-power-common.h