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.
Enumerations#
Variables#
Macros#
API Documentation#
emberAfGreenPowerServerFindCommissioningGpdInstance#
GpCommDataSaved* emberAfGreenPowerServerFindCommissioningGpdInstance (EmberGpAddress * gpdAddr)
Get a GPD commissioning instance in a multiple GPD commissioning session.
Type | Direction | Argument Name | Description |
---|---|---|---|
EmberGpAddress * | 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.
emberAfGreenPowerServerDeleteCommissioningGpdInstance#
void emberAfGreenPowerServerDeleteCommissioningGpdInstance (EmberGpAddress * gpdAddr)
Delete a GPD commissioning instance in a multiple GPD commissioning session.
Type | Direction | Argument Name | Description |
---|---|---|---|
EmberGpAddress * | 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.
emberAfGreenPowerClusterGpSinkCommissioningWindowExtend#
void emberAfGreenPowerClusterGpSinkCommissioningWindowExtend (uint16_t commissioningWindow)
Extend the commissioning window of a commissioning session.
Type | Direction | Argument Name | Description |
---|---|---|---|
uint16_t | 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.
emberAfGreenPowerClusterGetServerCommissioningSate#
EmberAfGreenPowerServerCommissioningState* emberAfGreenPowerClusterGetServerCommissioningSate (void )
Get the commissioning state of the green power server.
Type | Direction | Argument Name | Description |
---|---|---|---|
void | 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
emberAfGreenPowerServerDeriveSharedKeyFromSinkAttribute
EmberAfStatus emberAfGreenPowerServerDeriveSharedKeyFromSinkAttribute (uint8_t * gpsSecurityKeyTypeAtrribute, EmberKeyData * gpSharedKeyAttribute, EmberGpAddress * gpdAddr)
Derive the shared key from the sink attributes.
Type | Direction | Argument Name | Description |
---|---|---|---|
uint8_t * | N/A | gpsSecurityKeyTypeAtrribute | Security key type attribute as input |
EmberKeyData * | N/A | gpSharedKeyAttribute | Security key attribute as output |
EmberGpAddress * | 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
Enumeration Documentation#
GreenPowerServerGPSNodeState#
GreenPowerServerGPSNodeState
Enumerator | |
---|---|
GREEN_POWER_SERVER_GPS_NODE_STATE_NOT_IN_NETWORK | |
GREEN_POWER_SERVER_GPS_NODE_STATE_IN_NETWORK |
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 |
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 |
CommissioningTimeoutType#
CommissioningTimeoutType
Enumerator | |
---|---|
COMMISSIONING_TIMEOUT_TYPE_GENERIC_SWITCH | |
COMMISSIONING_TIMEOUT_TYPE_MULTI_SENSOR | |
COMMISSIONING_TIMEOUT_TYPE_COMMISSIONING_WINDOW_TIMEOUT |
Typedef Documentation#
Variable Documentation#
emberAfPluginGreenPowerServerGenericSwitchCommissioningTimeoutEvent#
sl_zigbee_event_t emberAfPluginGreenPowerServerGenericSwitchCommissioningTimeoutEvent
emberAfPluginGreenPowerServerMultiSensorCommissioningTimeoutEvent#
sl_zigbee_event_t emberAfPluginGreenPowerServerMultiSensorCommissioningTimeoutEvent
emberAfPluginGreenPowerServerCommissioningWindowTimeoutEvent#
sl_zigbee_event_t emberAfPluginGreenPowerServerCommissioningWindowTimeoutEvent
Function Documentation#
emberAfPluginGreenPowerServerGenericSwitchCommissioningTimeoutEventHandler#
void emberAfPluginGreenPowerServerGenericSwitchCommissioningTimeoutEventHandler (SLXU_UC_EVENT )
Type | Direction | Argument Name | Description |
---|---|---|---|
SLXU_UC_EVENT | N/A |
emberAfPluginGreenPowerServerMultiSensorCommissioningTimeoutEventHandler#
void emberAfPluginGreenPowerServerMultiSensorCommissioningTimeoutEventHandler (SLXU_UC_EVENT )
Type | Direction | Argument Name | Description |
---|---|---|---|
SLXU_UC_EVENT | N/A |
emberAfPluginGreenPowerServerCommissioningWindowTimeoutEventHandler#
void emberAfPluginGreenPowerServerCommissioningWindowTimeoutEventHandler (SLXU_UC_EVENT )
Type | Direction | Argument Name | Description |
---|---|---|---|
SLXU_UC_EVENT | N/A |