Commissioner#

otCommissionerState#

otCommissionerState

This enumeration defines the Commissioner State.

otCommissionerJoinerEvent#

otCommissionerJoinerEvent

This enumeration defines a Joiner Event on the Commissioner.

otJoinerInfoType#

otJoinerInfoType

This enumeration defines a Joiner Info Type.

otCommissionerState#

typedef enum otCommissionerState otCommissionerState

This enumeration defines the Commissioner State.

otCommissionerJoinerEvent#

typedef enum otCommissionerJoinerEvent otCommissionerJoinerEvent

This enumeration defines a Joiner Event on the Commissioner.

otSteeringData#

typedef struct otSteeringData otSteeringData

This structure represents the steering data.

otCommissioningDataset#

typedef struct otCommissioningDataset otCommissioningDataset

This structure represents a Commissioning Dataset.

otJoinerPskd#

typedef struct otJoinerPskd otJoinerPskd

This structure represents a Joiner PSKd.

otJoinerInfoType#

typedef enum otJoinerInfoType otJoinerInfoType

This enumeration defines a Joiner Info Type.

otJoinerInfo#

typedef struct otJoinerInfo otJoinerInfo

This structure represents a Joiner Info.

otCommissionerStateCallback#

typedef void(* otCommissionerStateCallback) (otCommissionerState aState, void *aContext) )(otCommissionerState aState, void *aContext)

This function pointer is called whenever the commissioner state changes.

otCommissionerJoinerCallback#

typedef void(* otCommissionerJoinerCallback) (otCommissionerJoinerEvent aEvent, const otJoinerInfo *aJoinerInfo, const otExtAddress *aJoinerId, void *aContext) )(otCommissionerJoinerEvent aEvent, const otJoinerInfo *aJoinerInfo, const otExtAddress *aJoinerId, void *aContext)

This function pointer is called whenever the joiner state changes.

otCommissionerEnergyReportCallback#

typedef void(* otCommissionerEnergyReportCallback) (uint32_t aChannelMask, const uint8_t *aEnergyList, uint8_t aEnergyListLength, void *aContext) )(uint32_t aChannelMask, const uint8_t *aEnergyList, uint8_t aEnergyListLength, void *aContext)

This function pointer is called when the Commissioner receives an Energy Report.

otCommissionerPanIdConflictCallback#

typedef void(* otCommissionerPanIdConflictCallback) (uint16_t aPanId, uint32_t aChannelMask, void *aContext) )(uint16_t aPanId, uint32_t aChannelMask, void *aContext)

This function pointer is called when the Commissioner receives a PAN ID Conflict message.

otCommissionerStart#

otError otCommissionerStart (otInstance * aInstance, otCommissionerStateCallback aStateCallback, otCommissionerJoinerCallback aJoinerCallback, void * aCallbackContext)

This function enables the Thread Commissioner role.

otCommissionerStop#

otError otCommissionerStop (otInstance * aInstance)

This function disables the Thread Commissioner role.

otCommissionerGetId#

const char * otCommissionerGetId (otInstance * aInstance)

This function returns the Commissioner Id.

Returns

• The Commissioner Id.

otCommissionerSetId#

otError otCommissionerSetId (otInstance * aInstance, const char * aId)

This function sets the Commissioner Id.

otCommissionerAddJoiner#

otError otCommissionerAddJoiner (otInstance * aInstance, const otExtAddress * aEui64, const char * aPskd, uint32_t aTimeout)

This function adds a Joiner entry.

Note

• Only use this after successfully starting the Commissioner role with otCommissionerStart().

otCommissionerAddJoinerWithDiscerner#

otError otCommissionerAddJoinerWithDiscerner (otInstance * aInstance, const otJoinerDiscerner * aDiscerner, const char * aPskd, uint32_t aTimeout)

This function adds a Joiner entry with a given Joiner Discerner value.

Note

• Only use this after successfully starting the Commissioner role with otCommissionerStart().

otCommissionerGetNextJoinerInfo#

otError otCommissionerGetNextJoinerInfo (otInstance * aInstance, uint16_t * aIterator, otJoinerInfo * aJoiner)

This method get joiner info at aIterator position.

otCommissionerRemoveJoiner#

otError otCommissionerRemoveJoiner (otInstance * aInstance, const otExtAddress * aEui64)

This function removes a Joiner entry.

Note

• Only use this after successfully starting the Commissioner role with otCommissionerStart().

otCommissionerRemoveJoinerWithDiscerner#

otError otCommissionerRemoveJoinerWithDiscerner (otInstance * aInstance, const otJoinerDiscerner * aDiscerner)

This function removes a Joiner entry.

Note

• Only use this after successfully starting the Commissioner role with otCommissionerStart().

otCommissionerGetProvisioningUrl#

const char * otCommissionerGetProvisioningUrl (otInstance * aInstance)

This function gets the Provisioning URL.

Returns

• A pointer to the URL string.

otCommissionerSetProvisioningUrl#

otError otCommissionerSetProvisioningUrl (otInstance * aInstance, const char * aProvisioningUrl)

This function sets the Provisioning URL.

otCommissionerAnnounceBegin#

otError otCommissionerAnnounceBegin (otInstance * aInstance, uint32_t aChannelMask, uint8_t aCount, uint16_t aPeriod, const otIp6Address * aAddress)

This function sends an Announce Begin message.

Note

• Only use this after successfully starting the Commissioner role with otCommissionerStart().

otCommissionerEnergyScan#

otError otCommissionerEnergyScan (otInstance * aInstance, uint32_t aChannelMask, uint8_t aCount, uint16_t aPeriod, uint16_t aScanDuration, const otIp6Address * aAddress, otCommissionerEnergyReportCallback aCallback, void * aContext)

This function sends an Energy Scan Query message.

Note

• Only use this after successfully starting the Commissioner role with otCommissionerStart().

otCommissionerPanIdQuery#

otError otCommissionerPanIdQuery (otInstance * aInstance, uint16_t aPanId, uint32_t aChannelMask, const otIp6Address * aAddress, otCommissionerPanIdConflictCallback aCallback, void * aContext)

This function sends a PAN ID Query message.

Note

• Only use this after successfully starting the Commissioner role with otCommissionerStart().

otCommissionerSendMgmtGet#

otError otCommissionerSendMgmtGet (otInstance * aInstance, const uint8_t * aTlvs, uint8_t aLength)

This function sends MGMT_COMMISSIONER_GET.

otCommissionerSendMgmtSet#

otError otCommissionerSendMgmtSet (otInstance * aInstance, const otCommissioningDataset * aDataset, const uint8_t * aTlvs, uint8_t aLength)

This function sends MGMT_COMMISSIONER_SET.

otCommissionerGetSessionId#

uint16_t otCommissionerGetSessionId (otInstance * aInstance)

This function returns the Commissioner Session ID.

Returns

• The current commissioner session id.

otCommissionerGetState#

otCommissionerState otCommissionerGetState (otInstance * aInstance)

This function returns the Commissioner State.

OT_COMMISSIONING_PASSPHRASE_MIN_SIZE#

#define OT_COMMISSIONING_PASSPHRASE_MIN_SIZE

6

Minimum size of the Commissioning Passphrase.

OT_COMMISSIONING_PASSPHRASE_MAX_SIZE#

#define OT_COMMISSIONING_PASSPHRASE_MAX_SIZE

255

Maximum size of the Commissioning Passphrase.

OT_PROVISIONING_URL_MAX_SIZE#

#define OT_PROVISIONING_URL_MAX_SIZE

64

Max size (number of chars) in Provisioning URL string (excludes null char).

OT_STEERING_DATA_MAX_LENGTH#

#define OT_STEERING_DATA_MAX_LENGTH

16

Max steering data length (bytes)

OT_JOINER_MAX_PSKD_LENGTH#

#define OT_JOINER_MAX_PSKD_LENGTH

32

Maximum string length of a Joiner PSKd (does not include null char).