EZ Mode Commissioning#

API and Callbacks for the EZ Mode Commissioning Component.

This component provides a function set for implementing EZ Mode commissioning.

Modules#

API#

EmberStatus

emberAfEzmodeClientCommission(uint8_t endpoint, EmberAfEzModeCommissioningDirection direction, const uint16_t *clusterIds, uint8_t clusterIdsLength)

Start EZ Mode client commissioning.

EmberStatus

emberAfEzmodeServerCommission(uint8_t endpoint)

Begin EZ Mode server commissioning.

EmberStatus

emberAfEzmodeServerCommissionWithTimeout(uint8_t endpoint, uint16_t identifyTimeoutSeconds)

Begin EZ Mode server commissioning with a given timeout.

Enumerations#

enum

EmberAfEzModeCommissioningDirection {

EMBER_AF_EZMODE_COMMISSIONING_SERVER_TO_CLIENT = 0

EMBER_AF_EZMODE_COMMISSIONING_CLIENT_TO_SERVER = 1

}

API Documentation#

emberAfEzmodeClientCommission#

EmberStatus emberAfEzmodeClientCommission (uint8_t endpoint, EmberAfEzModeCommissioningDirection direction, const uint16_t *clusterIds, uint8_t clusterIdsLength)

Start EZ Mode client commissioning.

Parameters

N/A	endpoint	The endpoint to send the identify query command from
N/A	direction	The side of the cluster IDs given either client or server
N/A	clusterIds	An array of clusters against which to match. NOTE The API only keeps the pointer to to the data structure. The data is expected to exist throughout the EZ-Mode-commissioning calls.
N/A	clusterIdsLength	The number of cluster IDs passed for the match.

Kicks off the EZ Mode commissioning process by sending out an identify query command to the given endpoint. Endpoints that return an identify query response are interrogated for the given cluster IDs in the given direction (client or server).

Definition at line 64 of file app/framework/plugin/ezmode-commissioning/ez-mode.h

emberAfEzmodeServerCommission#

EmberStatus emberAfEzmodeServerCommission (uint8_t endpoint)

Begin EZ Mode server commissioning.

Parameters

N/A

endpoint

The endpoint on which to begin identifying.

Kicks of the server side of EZ Mode commissioning by putting the device into identify mode.

Definition at line 77 of file app/framework/plugin/ezmode-commissioning/ez-mode.h

emberAfEzmodeServerCommissionWithTimeout#

EmberStatus emberAfEzmodeServerCommissionWithTimeout (uint8_t endpoint, uint16_t identifyTimeoutSeconds)

Begin EZ Mode server commissioning with a given timeout.

Parameters

N/A	endpoint	The endpoint on which to begin identifying
N/A	identifyTimeoutSeconds	The number of seconds to identify for before stopping identify mode.

Kicks of the server side of EZ Mode commissioning by putting the device into identify mode for a given time.

Definition at line 89 of file app/framework/plugin/ezmode-commissioning/ez-mode.h

Enumeration Documentation#

EmberAfEzModeCommissioningDirection#

EmberAfEzModeCommissioningDirection

Enumerator
EMBER_AF_EZMODE_COMMISSIONING_SERVER_TO_CLIENT
EMBER_AF_EZMODE_COMMISSIONING_CLIENT_TO_SERVER

Definition at line 33 of file app/framework/plugin/ezmode-commissioning/ez-mode.h