joiner.h File Reference

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

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

Go to the source code of this file.

Typedefs
typedef enum otJoinerState	otJoinerState
	This enumeration defines the Joiner State.
typedef void(OTCALL *	otJoinerCallback) (otError aError, void *aContext)
	This function pointer is called to notify the completion of a join operation. More...

Enumerations
enum	otJoinerState {   OT_JOINER_STATE_IDLE = 0,   OT_JOINER_STATE_DISCOVER = 1,   OT_JOINER_STATE_CONNECT = 2,   OT_JOINER_STATE_CONNECTED = 3,   OT_JOINER_STATE_ENTRUST = 4,   OT_JOINER_STATE_JOINED = 5 }
	This enumeration defines the Joiner State.

Functions
OTAPI otError OTCALL	otJoinerStart (otInstance *aInstance, const char *aPSKd, const char *aProvisioningUrl, const char *aVendorName, const char *aVendorModel, const char *aVendorSwVersion, const char *aVendorData, otJoinerCallback aCallback, void *aContext)
	This function enables the Thread Joiner role. More...
OTAPI otError OTCALL	otJoinerStop (otInstance *aInstance)
	This function disables the Thread Joiner role. More...
OTAPI otJoinerState OTCALL	otJoinerGetState (otInstance *aInstance)
	This function returns the Joiner State. More...
OTAPI otError OTCALL	otJoinerGetId (otInstance *aInstance, otExtAddress *aJoinerId)
	Get the Joiner ID. More...

Detailed Description

This file includes functions for the Thread Joiner role.