commissioner.h File Reference

This file includes functions for the Thread Commissioner role. More...

#include <openthread/types.h>
#include <openthread/platform/toolchain.h>

Go to the source code of this file.

Typedefs
typedef enum otCommissionerState	otCommissionerState
	This enumeration defines the Commissioner State.
typedef void(OTCALL *	otCommissionerEnergyReportCallback) (uint32_t aChannelMask, const uint8_t *aEnergyList, uint8_t aEnergyListLength, void *aContext)
	This function pointer is called when the Commissioner receives an Energy Report. More...
typedef void(OTCALL *	otCommissionerPanIdConflictCallback) (uint16_t aPanId, uint32_t aChannelMask, void *aContext)
	This function pointer is called when the Commissioner receives a PAN ID Conflict message. More...

Enumerations
enum	otCommissionerState {   OT_COMMISSIONER_STATE_DISABLED = 0,   OT_COMMISSIONER_STATE_PETITION = 1,   OT_COMMISSIONER_STATE_ACTIVE = 2 }
	This enumeration defines the Commissioner State. More...

Functions
OTAPI otError OTCALL	otCommissionerStart (otInstance *aInstance)
	This function enables the Thread Commissioner role. More...
OTAPI otError OTCALL	otCommissionerStop (otInstance *aInstance)
	This function disables the Thread Commissioner role. More...
OTAPI otError OTCALL	otCommissionerAddJoiner (otInstance *aInstance, const otExtAddress *aEui64, const char *aPSKd, uint32_t aTimeout)
	This function adds a Joiner entry. More...
OTAPI otError OTCALL	otCommissionerRemoveJoiner (otInstance *aInstance, const otExtAddress *aEui64)
	This function removes a Joiner entry. More...
OTAPI otError OTCALL	otCommissionerSetProvisioningUrl (otInstance *aInstance, const char *aProvisioningUrl)
	This function sets the Provisioning URL. More...
OTAPI otError OTCALL	otCommissionerAnnounceBegin (otInstance *aInstance, uint32_t aChannelMask, uint8_t aCount, uint16_t aPeriod, const otIp6Address *aAddress)
	This function sends an Announce Begin message. More...
OTAPI otError OTCALL	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. More...
OTAPI otError OTCALL	otCommissionerPanIdQuery (otInstance *aInstance, uint16_t aPanId, uint32_t aChannelMask, const otIp6Address *aAddress, otCommissionerPanIdConflictCallback aCallback, void *aContext)
	This function sends a PAN ID Query message. More...
OTAPI otError OTCALL	otCommissionerSendMgmtGet (otInstance *aInstance, const uint8_t *aTlvs, uint8_t aLength)
	This function sends MGMT_COMMISSIONER_GET. More...
OTAPI otError OTCALL	otCommissionerSendMgmtSet (otInstance *aInstance, const otCommissioningDataset *aDataset, const uint8_t *aTlvs, uint8_t aLength)
	This function sends MGMT_COMMISSIONER_SET. More...
OTAPI uint16_t OTCALL	otCommissionerGetSessionId (otInstance *aInstance)
	This function returns the Commissioner Session ID. More...
OTAPI otCommissionerState OTCALL	otCommissionerGetState (otInstance *aInstance)
	This function returns the Commissioner State. More...
OTAPI otError OTCALL	otCommissionerGeneratePSKc (otInstance *aInstance, const char *aPassPhrase, const char *aNetworkName, const uint8_t *aExtPanId, uint8_t *aPSKc)
	This method generates PSKc. More...

Detailed Description

This file includes functions for the Thread Commissioner role.