This module includes functions for configuration. More...

Modules
	General
	This module includes functions that manage configuration parameters for the Thread Child, Router, and Leader roles.

	Router/Leader
	This module includes functions that manage configuration parameters for the Thread Router and Leader roles.

	Test
	This module includes functions that manage configuration parameters required for Thread Certification testing.

	Border Router
	This module includes functions that manage configuration parameters that apply to the Thread Border Router role.

Functions
OTAPI ThreadError OTCALL	otThreadSetEnabled (otInstance *aInstance, bool aEnabled)

OTAPI bool OTCALL	otThreadGetAutoStart (otInstance *aInstance)

OTAPI ThreadError OTCALL	otThreadSetAutoStart (otInstance *aInstance, bool aStartAutomatically)

OTAPI bool OTCALL	otThreadIsSingleton (otInstance *aInstance)

OTAPI ThreadError OTCALL	otThreadDiscover (otInstance aInstance, uint32_t aScanChannels, uint16_t aPanid, otHandleActiveScanResult aCallback, void aCallbackContext)

OTAPI bool OTCALL	otThreadIsDiscoverInProgress (otInstance *aInstance)

Detailed Description

This module includes functions for configuration.

Function Documentation

OTAPI ThreadError OTCALL otThreadDiscover	(	otInstance *	aInstance,
		uint32_t	aScanChannels,
		uint16_t	aPanid,
		otHandleActiveScanResult	aCallback,
		void *	aCallbackContext
	)

This function starts a Thread Discovery scan.

Parameters

[in]	aInstance	A pointer to an OpenThread instance.
[in]	aScanChannels	A bit vector indicating which channels to scan (e.g. OT_CHANNEL_11_MASK).
[in]	aPanId	The PAN ID filter (set to Broadcast PAN to disable filter).
[in]	aCallback	A pointer to a function called on receiving an MLE Discovery Response or scan completes.
[in]	aCallbackContext	A pointer to application-specific context.

Return values

kThreadError_None	Accepted the Thread Discovery request.
kThreadError_Busy	Already performing an Thread Discovery.

OTAPI bool OTCALL otThreadGetAutoStart ( otInstance * aInstance )

This function queries if the Thread stack is configured to automatically start on reinitialization.

Parameters

[in] aInstance A pointer to an OpenThread instance.

Return values

TRUE	It is configured to automatically start.
FALSE	It is not configured to automatically start.

OTAPI bool OTCALL otThreadIsDiscoverInProgress ( otInstance * aInstance )

This function determines if an MLE Thread Discovery is currently in progress.

Parameters

[in] aInstance A pointer to an OpenThread instance.

OTAPI bool OTCALL otThreadIsSingleton ( otInstance * aInstance )

This function indicates whether a node is the only router on the network.

Parameters

[in] aInstance A pointer to an OpenThread instance.

Return values

TRUE	It is the only router in the network.
FALSE	It is a child or is not a single router in the network.

OTAPI ThreadError OTCALL otThreadSetAutoStart	(	otInstance *	aInstance,
		bool	aStartAutomatically
	)

This function configures the Thread stack to automatically start on reinitialization. It has no effect on the current Thread state.

Parameters

[in]	aInstance	A pointer to an OpenThread instance.
[in]	aStartAutomatically	TRUE to automatically start; FALSE to not automatically start.

OTAPI ThreadError OTCALL otThreadSetEnabled	(	otInstance *	aInstance,
		bool	aEnabled
	)

This function starts Thread protocol operation.

The interface must be up when calling this function.

Parameters

[in]	aInstance	A pointer to an OpenThread instance.
[in]	aEnabled	TRUE if Thread is enabled, FALSE otherwise.

Return values

kThreadError_None	Successfully started Thread protocol operation.
kThreadError_InvalidState	The network interface was not not up.