Modules#
EmberAfGreenPowerServerCommissioningState
Green Power Server#
API and Callbacks for the Green Power Cluster Server Component.
A component implementing the server-side functionality of the Green Power cluster.
API#
Get a GPD commissioning instance in a multiple GPD commissioning session.
Delete a GPD commissioning instance in a multiple GPD commissioning session.
Extend the commissioning window of a commissioning session.
Get the commissioning state of the green power server.
Derive the shared key from the sink attributes.
Clears the entry for a GPD in sink table.
Enumerations#
Variables#
Functions#
Macros#
API Documentation#
emberAfGreenPowerServerFindCommissioningGpdInstance#
EmberCommissioningGpd * emberAfGreenPowerServerFindCommissioningGpdInstance (EmberGpAddress * gpdAddr)
Get a GPD commissioning instance in a multiple GPD commissioning session.
N/A | gpdAddr | GPD address Ver.: always |
The green power server can be configured to allow multiple GPDs to commission within a commissioning session. Given a GPD instance address, this function will find the currently-commissioning GPD instance. This is a helpful indicator of the commissioning progress of a given GPD when multi GPDS are commissioning in a commissioning window.
Returns
Information on the commissioning pointed by a structure GpCommDataSaved type about the GPD.
227
of file app/framework/plugin/green-power-server/green-power-server.h
emberAfGreenPowerServerDeleteCommissioningGpdInstance#
void emberAfGreenPowerServerDeleteCommissioningGpdInstance (EmberGpAddress * gpdAddr)
Delete a GPD commissioning instance in a multiple GPD commissioning session.
N/A | gpdAddr | GPD address Ver.: always |
The green power server can be configured to allow multiple GPDs to commission within a commissioning session. Given a GPD instance address, this function will find and delete the currently-commissioning GPD instance. This is a helpful way to remove unwanted GPD instances in a multiple GPD commissioning session.
240
of file app/framework/plugin/green-power-server/green-power-server.h
emberAfGreenPowerClusterGpSinkCommissioningWindowExtend#
void emberAfGreenPowerClusterGpSinkCommissioningWindowExtend (uint16_t commissioningWindow)
Extend the commissioning window of a commissioning session.
N/A | commissioningWindow | Commissioning window to be extended from this point in time in seconds Ver.: always |
This is a helper function that sends out a proxy commissioning mode from the server side to all proxies in the network. It internally uses the same parameters used previously in the proxy commissioning mode with action = enter.
252
of file app/framework/plugin/green-power-server/green-power-server.h
emberAfGreenPowerClusterGetServerCommissioningSate#
EmberAfGreenPowerServerCommissioningState * emberAfGreenPowerClusterGetServerCommissioningSate (void )
Get the commissioning state of the green power server.
N/A |
This function gets the commissioning state of the green power server.
Returns
Server commissioning state and related parameters pointed by structure EmberAfGreenPowerServerCommissioningState Ver.: always
262
of file app/framework/plugin/green-power-server/green-power-server.h
emberAfGreenPowerServerDeriveSharedKeyFromSinkAttribute
EmberAfStatus emberAfGreenPowerServerDeriveSharedKeyFromSinkAttribute (uint8_t * gpsSecurityKeyTypeAtrribute, EmberKeyData * gpSharedKeyAttribute, EmberGpAddress * gpdAddr)
Derive the shared key from the sink attributes.
N/A | gpsSecurityKeyTypeAtrribute | Security key type attribute as input |
N/A | gpSharedKeyAttribute | Security key attribute as output |
N/A | gpdAddr | GPD address |
This function derives the shared key used in green power server side using the respective security attribute values.
Returns
Status of the key derivation Ver.: always
276
of file app/framework/plugin/green-power-server/green-power-server.h
emberAfGreenPowerServerRemoveSinkEntry#
void emberAfGreenPowerServerRemoveSinkEntry (EmberGpAddress * gpdAddr)
Clears the entry for a GPD in sink table.
N/A | gpdAddr | GPD address Ver.: always |
This function clears the entries in the sink table for a given gpd. In a sink table, there is unique entry for each GPD based on its addressing. When the GPD addressing uses application id=0b000 with 32 bit sourceId, there is just one entry for each GPD. But, when the GPD addressing with application Id=0b010 that is EUI64 with endpoint id, for each unique endpoint, there can be an entry in sink table. Hence, when this function is called with application Id=0b010,EUI64 with endpoint id=0xff(all endpoints), it clears all the entry for that GPD with supplied EUI64. With clear up the gpd from sink table it also clears the translation table for that GPD.
294
of file app/framework/plugin/green-power-server/green-power-server.h
Enumeration Documentation#
GreenPowerServerGPSNodeState#
GreenPowerServerGPSNodeState
Enumerator | |
---|---|
GREEN_POWER_SERVER_GPS_NODE_STATE_NOT_IN_NETWORK | |
GREEN_POWER_SERVER_GPS_NODE_STATE_IN_NETWORK |
69
of file app/framework/plugin/green-power-server/green-power-server.h
GreenPowerServerSinkTableAccessType#
GreenPowerServerSinkTableAccessType
Enumerator | |
---|---|
GREEN_POWER_SERVER_SINK_TABLE_ACCESS_TYPE_REMOVE_GPD | |
GREEN_POWER_SERVER_SINK_TABLE_ACCESS_TYPE_ADD_GPD | |
GREEN_POWER_SERVER_SINK_TABLE_ACCESS_TYPE_UNKNOWN |
80
of file app/framework/plugin/green-power-server/green-power-server.h
GPSinkCommState#
GPSinkCommState
Enumerator | |
---|---|
GP_SINK_COMM_STATE_IDLE | |
GP_SINK_COMM_STATE_COLLECT_REPORTS | |
GP_SINK_COMM_STATE_SEND_COMM_REPLY | |
GP_SINK_COMM_STATE_WAIT_FOR_SUCCESS | |
GP_SINK_COMM_STATE_FINALISE_PAIRING | |
GP_SINK_COMM_STATE_PAIRING_DONE |
93
of file app/framework/plugin/green-power-server/green-power-server.h
CommissioningTimeoutType#
CommissioningTimeoutType
Enumerator | |
---|---|
COMMISSIONING_TIMEOUT_TYPE_GENERIC_SWITCH | |
COMMISSIONING_TIMEOUT_TYPE_MULTI_SENSOR | |
COMMISSIONING_TIMEOUT_TYPE_COMMISSIONING_WINDOW_TIMEOUT |
108
of file app/framework/plugin/green-power-server/green-power-server.h
PairingStatus#
PairingStatus
Enumerator | |
---|---|
SINK_PAIRING_STATUS_SUCCESS | |
SINK_PAIRING_STATUS_FAILURE | |
SINK_PAIRING_STATUS_IN_PROGRESS | |
SINK_PAIRING_STATUS_FAIL_NO_MATCHING_FUNCTIONALITY | |
SINK_PAIRING_STATUS_FAIL_ADDING_TRANSLATION | |
SINK_PAIRING_STATUS_FAIL_NO_SPACE_IN_SINK_TABLE | |
SINK_PAIRING_STATUS_FAIL_ENTRY_CORRUPTED |
120
of file app/framework/plugin/green-power-server/green-power-server.h
Typedef Documentation#
GpsNetworkState#
typedef uint8_t GpsNetworkState
67
of file app/framework/plugin/green-power-server/green-power-server.h
EmberAfGpServerSinkTableAccessType#
typedef uint8_t EmberAfGpServerSinkTableAccessType
78
of file app/framework/plugin/green-power-server/green-power-server.h
EmberSinkCommissionState#
typedef uint8_t EmberSinkCommissionState
91
of file app/framework/plugin/green-power-server/green-power-server.h
EmberSinkCommissioningTimeoutType#
typedef uint8_t EmberSinkCommissioningTimeoutType
106
of file app/framework/plugin/green-power-server/green-power-server.h
EmberSinkPairingStatus#
typedef uint8_t EmberSinkPairingStatus
118
of file app/framework/plugin/green-power-server/green-power-server.h
EmberCommissioningGpd#
typedef GpCommDataSaved EmberCommissioningGpd
196
of file app/framework/plugin/green-power-server/green-power-server.h
Variable Documentation#
emberAfPluginGreenPowerServerGenericSwitchCommissioningTimeoutEvent#
sl_zigbee_event_t emberAfPluginGreenPowerServerGenericSwitchCommissioningTimeoutEvent
198
of file app/framework/plugin/green-power-server/green-power-server.h
emberAfPluginGreenPowerServerMultiSensorCommissioningTimeoutEvent#
sl_zigbee_event_t emberAfPluginGreenPowerServerMultiSensorCommissioningTimeoutEvent
200
of file app/framework/plugin/green-power-server/green-power-server.h
emberAfPluginGreenPowerServerCommissioningWindowTimeoutEvent#
sl_zigbee_event_t emberAfPluginGreenPowerServerCommissioningWindowTimeoutEvent
202
of file app/framework/plugin/green-power-server/green-power-server.h
Function Documentation#
emberAfPluginGreenPowerServerGenericSwitchCommissioningTimeoutEventHandler#
void emberAfPluginGreenPowerServerGenericSwitchCommissioningTimeoutEventHandler (sl_zigbee_event_t * event)
N/A | event |
199
of file app/framework/plugin/green-power-server/green-power-server.h
emberAfPluginGreenPowerServerMultiSensorCommissioningTimeoutEventHandler#
void emberAfPluginGreenPowerServerMultiSensorCommissioningTimeoutEventHandler (sl_zigbee_event_t * event)
N/A | event |
201
of file app/framework/plugin/green-power-server/green-power-server.h
emberAfPluginGreenPowerServerCommissioningWindowTimeoutEventHandler#
void emberAfPluginGreenPowerServerCommissioningWindowTimeoutEventHandler (sl_zigbee_event_t * event)
N/A | event |
203
of file app/framework/plugin/green-power-server/green-power-server.h
Macro Definition Documentation#
EMBER_AF_GREEN_POWER_GP_SHARED_KEY
#define EMBER_AF_GREEN_POWER_GP_SHARED_KEYValue:
0
36
of file app/framework/plugin/green-power-server/green-power-server.h
EMBER_AF_GREEN_POWER_GP_INDIVIDUAL_KEY#
#define EMBER_AF_GREEN_POWER_GP_INDIVIDUAL_KEYValue:
1
37
of file app/framework/plugin/green-power-server/green-power-server.h
GREEN_POWER_SERVER_NO_PAIRED_ENDPOINTS#
#define GREEN_POWER_SERVER_NO_PAIRED_ENDPOINTSValue:
0x00
39
of file app/framework/plugin/green-power-server/green-power-server.h
GREEN_POWER_SERVER_RESERVED_ENDPOINTS#
#define GREEN_POWER_SERVER_RESERVED_ENDPOINTSValue:
0xFD
40
of file app/framework/plugin/green-power-server/green-power-server.h
GREEN_POWER_SERVER_SINK_DERIVES_ENDPOINTS#
#define GREEN_POWER_SERVER_SINK_DERIVES_ENDPOINTSValue:
0xFE
41
of file app/framework/plugin/green-power-server/green-power-server.h
GREEN_POWER_SERVER_ALL_SINK_ENDPOINTS#
#define GREEN_POWER_SERVER_ALL_SINK_ENDPOINTSValue:
0xFF
42
of file app/framework/plugin/green-power-server/green-power-server.h
GREEN_POWER_SERVER_MIN_VALID_APP_ENDPOINT#
#define GREEN_POWER_SERVER_MIN_VALID_APP_ENDPOINTValue:
1
44
of file app/framework/plugin/green-power-server/green-power-server.h
GREEN_POWER_SERVER_MAX_VALID_APP_ENDPOINT#
#define GREEN_POWER_SERVER_MAX_VALID_APP_ENDPOINTValue:
240
45
of file app/framework/plugin/green-power-server/green-power-server.h
GREEN_POWER_SERVER_GPS_SECURITY_LEVEL_ATTRIBUTE_FIELD_INVOLVE_TC#
#define GREEN_POWER_SERVER_GPS_SECURITY_LEVEL_ATTRIBUTE_FIELD_INVOLVE_TCValue:
0x08
47
of file app/framework/plugin/green-power-server/green-power-server.h
GP_DEVICE_ANNOUNCE_SIZE#
#define GP_DEVICE_ANNOUNCE_SIZEValue:
12
49
of file app/framework/plugin/green-power-server/green-power-server.h
SIZE_OF_REPORT_STORAGE#
#define SIZE_OF_REPORT_STORAGEValue:
82
51
of file app/framework/plugin/green-power-server/green-power-server.h
COMM_REPLY_PAYLOAD_SIZE#
#define COMM_REPLY_PAYLOAD_SIZEValue:
30
52
of file app/framework/plugin/green-power-server/green-power-server.h
GP_SINK_TABLE_RESPONSE_ENTRIES_OFFSET#
#define GP_SINK_TABLE_RESPONSE_ENTRIES_OFFSETValue:
(3)
53
of file app/framework/plugin/green-power-server/green-power-server.h
EMBER_AF_ZCL_CLUSTER_GP_GPS_COMMISSIONING_WINDOWS_DEFAULT_TIME_S#
#define EMBER_AF_ZCL_CLUSTER_GP_GPS_COMMISSIONING_WINDOWS_DEFAULT_TIME_SValue:
(180)
54
of file app/framework/plugin/green-power-server/green-power-server.h
GP_ADDR_SRC_ID_WILDCARD#
#define GP_ADDR_SRC_ID_WILDCARDValue:
(0xFFFFFFFF)
55
of file app/framework/plugin/green-power-server/green-power-server.h
GPS_ATTRIBUTE_KEY_TYPE_MASK#
#define GPS_ATTRIBUTE_KEY_TYPE_MASKValue:
(0x07)
56
of file app/framework/plugin/green-power-server/green-power-server.h
GP_PAIRING_CONFIGURATION_FIXED_FLAG#
#define GP_PAIRING_CONFIGURATION_FIXED_FLAGValue:
(0x230)
57
of file app/framework/plugin/green-power-server/green-power-server.h
GREEN_POWER_SERVER_MIN_REPORT_LENGTH#
#define GREEN_POWER_SERVER_MIN_REPORT_LENGTHValue:
(10)
59
of file app/framework/plugin/green-power-server/green-power-server.h
FIX_SHIFT_REPORTING_DATA_POSITION_CONVERT_TO_PAYLOAD_INDEX#
#define FIX_SHIFT_REPORTING_DATA_POSITION_CONVERT_TO_PAYLOAD_INDEXValue:
(3)
62
of file app/framework/plugin/green-power-server/green-power-server.h
CAR_DATA_POINT_OFFSET#
#define CAR_DATA_POINT_OFFSETValue:
1
64
of file app/framework/plugin/green-power-server/green-power-server.h
GP_DEFAULT_LINK_KEY#
#define GP_DEFAULT_LINK_KEYValue:
{ 0x5A, 0x69, 0x67, 0x42, 0x65, 0x65, 0x41, 0x6C, 0x6C, 0x69, 0x61, 0x6E, 0x63, 0x65, 0x30, 0x39 }
65
of file app/framework/plugin/green-power-server/green-power-server.h
genericSwitchCommissioningTimeout#
#define genericSwitchCommissioningTimeoutValue:
(&emberAfPluginGreenPowerServerGenericSwitchCommissioningTimeoutEvent)
204
of file app/framework/plugin/green-power-server/green-power-server.h
multiSensorCommissioningTimeout#
#define multiSensorCommissioningTimeoutValue:
(&emberAfPluginGreenPowerServerMultiSensorCommissioningTimeoutEvent)
205
of file app/framework/plugin/green-power-server/green-power-server.h
commissioningWindowTimeout#
#define commissioningWindowTimeoutValue:
(&emberAfPluginGreenPowerServerCommissioningWindowTimeoutEvent)
206
of file app/framework/plugin/green-power-server/green-power-server.h