Green Power Server#

sl_zigbee_af_green_power_server_find_commissioning_gpd_instance#

sl_zigbee_commissioning_gpd_t * sl_zigbee_af_green_power_server_find_commissioning_gpd_instance (sl_zigbee_gp_address_t * gpdAddr)

Get a GPD commissioning instance in a multiple GPD commissioning session.

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 sli_zigbee_gp_comm_data_saved_t type about the GPD.

sl_zigbee_af_green_power_server_delete_commissioning_gpd_instance#

void sl_zigbee_af_green_power_server_delete_commissioning_gpd_instance (sl_zigbee_gp_address_t * gpdAddr)

Delete a GPD commissioning instance in a multiple GPD commissioning session.

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.

sl_zigbee_af_green_power_cluster_gp_sink_commissioning_window_extend#

void sl_zigbee_af_green_power_cluster_gp_sink_commissioning_window_extend (uint16_t commissioningWindow)

Extend the commissioning window of a commissioning session.

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.

sl_zigbee_af_green_power_cluster_get_server_commissioning_sate#

sl_zigbee_af_green_power_server_commissioning_state_t * sl_zigbee_af_green_power_cluster_get_server_commissioning_sate (void )

Get the commissioning state of the green power server.

This function gets the commissioning state of the green power server.

Returns

• Server commissioning state and related parameters pointed by structure sl_zigbee_af_green_power_server_commissioning_state_t

sl_zigbee_af_green_power_server_derive_shared_key_from_sink_attribute#

sl_zigbee_af_status_t sl_zigbee_af_green_power_server_derive_shared_key_from_sink_attribute (uint8_t * gpsSecurityKeyTypeAtrribute, sl_zigbee_key_data_t * gpSharedKeyAttribute, sl_zigbee_gp_address_t * gpdAddr)

Derive the shared key from the sink attributes.

This function derives the shared key used in green power server side using the respective security attribute values.

Returns

• Status of the key derivation

sl_zigbee_af_green_power_server_remove_sink_entry#

void sl_zigbee_af_green_power_server_remove_sink_entry (sl_zigbee_gp_address_t * gpdAddr)

Clears the entry for a GPD in sink table.

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.

sl_zigbee_af_green_power_cluster_gp_sink_close_commissioning_window#

bool sl_zigbee_af_green_power_cluster_gp_sink_close_commissioning_window (void )

Close the commissioning window of current commissioning session.

This is a helper function that closes a commissioning session if there is no active GPD commissioning in progress. If the commissioning session started with "InvolveProxy" option, then it also sends out a proxy commissioning mode message with action to exit commissioning from the server side to all proxies in the network. It internally uses the same parameters used previously in the proxy commissioning mode entered but with action as "exit".

Returns

• Status of the command as true when success or there is no open commissioning window. Returns false for failure of the command for any reason or there is any GPD that is still undergoing commissioning process or a failure.

GreenPowerServerGPSNodeState#

GreenPowerServerGPSNodeState

GreenPowerServerSinkTableAccessType#

GreenPowerServerSinkTableAccessType

GPSinkCommState#

GPSinkCommState

CommissioningTimeoutType#

CommissioningTimeoutType

PairingStatus#

PairingStatus

PreSinkPairingCallbackSource#

PreSinkPairingCallbackSource

sli_zigbee_gps_network_state_t#

typedef uint8_t sli_zigbee_gps_network_state_t

GP Server network state.

sl_zigbee_af_gp_server_sink_table_access_type_t#

typedef uint8_t sl_zigbee_af_gp_server_sink_table_access_type_t

Describes how the GP server accesses or updates the sink table.

sl_zigbee_sink_commission_state_t#

typedef uint8_t sl_zigbee_sink_commission_state_t

Represents the current state of GP sink commissioning.

sl_zigbee_sink_commissioning_timeout_type_t#

typedef uint8_t sl_zigbee_sink_commissioning_timeout_type_t

Specifies the type of timeout used during GP sink commissioning.

sl_zigbee_sink_pairing_status_t#

typedef uint8_t sl_zigbee_sink_pairing_status_t

Indicates the result or status of a GP sink pairing attempt.

sl_zigbee_pre_sink_pairing_callback_source_t#

typedef uint8_t sl_zigbee_pre_sink_pairing_callback_source_t

Identifies the source that triggered the pre-sink-pairing callback.

sl_zigbee_commissioning_gpd_t#

typedef sli_zigbee_gp_comm_data_saved_t sl_zigbee_commissioning_gpd_t

Cached commissioning information for a Green Power Device (GPD).

sl_zigbee_af_green_power_server_generic_switch_commissioning_timeout_event#

sl_zigbee_af_event_t sl_zigbee_af_green_power_server_generic_switch_commissioning_timeout_event

sl_zigbee_af_green_power_server_multi_sensor_commissioning_timeout_event#

sl_zigbee_af_event_t sl_zigbee_af_green_power_server_multi_sensor_commissioning_timeout_event

sl_zigbee_af_green_power_server_commissioning_window_timeout_event#

sl_zigbee_af_event_t sl_zigbee_af_green_power_server_commissioning_window_timeout_event

sl_zigbee_af_green_power_server_generic_switch_commissioning_timeout_event_handler#

void sl_zigbee_af_green_power_server_generic_switch_commissioning_timeout_event_handler (sl_zigbee_af_event_t * event)

sl_zigbee_af_green_power_server_multi_sensor_commissioning_timeout_event_handler#

void sl_zigbee_af_green_power_server_multi_sensor_commissioning_timeout_event_handler (sl_zigbee_af_event_t * event)

sl_zigbee_af_green_power_server_commissioning_window_timeout_event_handler#

void sl_zigbee_af_green_power_server_commissioning_window_timeout_event_handler (sl_zigbee_af_event_t * event)