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

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

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)

OTAPI otError OTCALL	otJoinerStop (otInstance *aInstance)

Detailed Description

This module includes functions for the Thread Joiner role.

Typedef Documentation

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

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

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.

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.

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.

OTAPI otError OTCALL otJoinerStop ( otInstance * aInstance )

This function disables the Thread Joiner role.

Parameters

[in] aInstance A pointer to an OpenThread instance.