Joiner

This module includes functions for the Thread Joiner role.

Summary

Enumerations

otJoinerState enum
This enumeration defines the Joiner State.

Typedefs

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

Functions

otJoinerGetId(otInstance *aInstance, otExtAddress *aJoinerId)
Get the Joiner ID.
otJoinerGetState(otInstance *aInstance)
This function returns the Joiner State.
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.
otJoinerStop(otInstance *aInstance)
This function disables the Thread Joiner role.

Enumerations

otJoinerState

 otJoinerState

This enumeration defines the Joiner State.

Typedefs

otJoinerCallback

void(OTCALL * otJoinerCallback)(otError aError, void *aContext)

This function pointer is called to notify the completion of a join operation.

Details
Parameters
[in] aError
OT_ERROR_NONE if the join process succeeded. OT_ERROR_SECURITY if the join process failed due to security credentials. OT_ERROR_NOT_FOUND if no joinable network was discovered. OT_ERROR_RESPONSE_TIMEOUT if a response timed out.
[in] aContext
A pointer to application-specific context.

otJoinerState

enum otJoinerState otJoinerState

This enumeration defines the Joiner State.

Functions

otJoinerGetId

OTAPI otError OTCALL otJoinerGetId(
  otInstance *aInstance,
  otExtAddress *aJoinerId
)

Get the Joiner ID.

Joiner ID is the first 64 bits of the result of computing SHA-256 over factory-assigned IEEE EUI-64, which is used as IEEE 802.15.4 Extended Address during commissioning process.

Details
Parameters
[in] aInstance
A pointer to the OpenThread instance.
[out] aJoinerId
A pointer to where the Joiner ID is placed.
Return Values
OT_ERROR_NONE
Successfully retrieved the Joiner ID.
OT_ERROR_DISABLED_FEATURE
The Joiner feature is not enabled in this build.

otJoinerGetState

OTAPI otJoinerStateOTCALL otJoinerGetState(
  otInstance *aInstance
)

This function returns the Joiner State.

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.
Return Values
OT_JOINER_STATE_IDLE
OT_JOINER_STATE_DISCOVER
OT_JOINER_STATE_CONNECT
OT_JOINER_STATE_CONNECTED
OT_JOINER_STATE_ENTRUST
OT_JOINER_STATE_JOINED

otJoinerStart

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.

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.
[in] aPSKd
A pointer to the PSKd.
[in] aProvisioningUrl
A pointer to the Provisioning URL (may be NULL).
[in] aVendorName
A pointer to the Vendor Name (must be static).
[in] aVendorModel
A pointer to the Vendor Model (must be static).
[in] aVendorSwVersion
A pointer to the Vendor SW Version (must be static).
[in] aVendorData
A pointer to the Vendor Data (must be static).
[in] aCallback
A pointer to a function that is called when the join operation completes.
[in] aContext
A pointer to application-specific context.
Return Values
OT_ERROR_NONE
Successfully started the Commissioner role.
OT_ERROR_INVALID_ARGS
aPSKd or aProvisioningUrl is invalid.
OT_ERROR_DISABLED_FEATURE
The Joiner feature is not enabled in this build.

otJoinerStop

OTAPI otError OTCALL otJoinerStop(
  otInstance *aInstance
)

This function disables the Thread Joiner role.

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.
Return Values
OT_ERROR_NONE
Successfully disabled the Joiner role.
OT_ERROR_DISABLED_FEATURE
The Joiner feature is not enabled in this build.