This module includes functions that control the OpenThread Instance. More...
Typedefs | |
typedef struct otInstance | otInstance |
typedef uint32_t | otChangedFlags |
typedef void(* | otStateChangedCallback )(otChangedFlags aFlags, void *aContext) |
Functions | |
otInstance * | otInstanceInit (void *aInstanceBuffer, size_t *aInstanceBufferSize) |
otInstance * | otInstanceInitSingle (void) |
bool | otInstanceIsInitialized (otInstance *aInstance) |
void | otInstanceFinalize (otInstance *aInstance) |
otError | otSetStateChangedCallback (otInstance *aInstance, otStateChangedCallback aCallback, void *aContext) |
void | otRemoveStateChangeCallback (otInstance *aInstance, otStateChangedCallback aCallback, void *aContext) |
void | otInstanceReset (otInstance *aInstance) |
void | otInstanceFactoryReset (otInstance *aInstance) |
otError | otInstanceErasePersistentInfo (otInstance *aInstance) |
const char * | otGetVersionString (void) |
const char * | otGetRadioVersionString (otInstance *aInstance) |
This module includes functions that control the OpenThread Instance.
typedef uint32_t otChangedFlags |
This type represents a bit-field indicating specific state/configuration that has changed. See OT_CHANGED_*
definitions.
typedef struct otInstance otInstance |
This structure represents the OpenThread instance structure.
typedef void(* otStateChangedCallback)(otChangedFlags aFlags, void *aContext) |
This function pointer is called to notify certain configuration or state changes within OpenThread.
[in] | aFlags | A bit-field indicating specific state that has changed. See OT_CHANGED_* definitions. |
[in] | aContext | A pointer to application-specific context. |
anonymous enum |
This enumeration defines flags that are passed as part of otStateChangedCallback
.
const char* otGetRadioVersionString | ( | otInstance * | aInstance | ) |
This function gets the OpenThread radio version string.
[in] | aInstance | A pointer to an OpenThread instance. |
const char* otGetVersionString | ( | void | ) |
This function gets the OpenThread version string.
otError otInstanceErasePersistentInfo | ( | otInstance * | aInstance | ) |
This function erases all the OpenThread persistent info (network settings) stored on non-volatile memory. Erase is successful only if the device is in disabled
state/role.
[in] | aInstance | A pointer to an OpenThread instance. |
OT_ERROR_NONE | All persistent info/state was erased successfully. |
OT_ERROR_INVALID_STATE | Device is not in disabled state/role. |
void otInstanceFactoryReset | ( | otInstance * | aInstance | ) |
This method deletes all the settings stored on non-volatile memory, and then triggers platform reset.
[in] | aInstance | A pointer to an OpenThread instance. |
void otInstanceFinalize | ( | otInstance * | aInstance | ) |
This function disables the OpenThread library.
Call this function when OpenThread is no longer in use.
[in] | aInstance | A pointer to an OpenThread instance. |
otInstance* otInstanceInit | ( | void * | aInstanceBuffer, |
size_t * | aInstanceBufferSize | ||
) |
This function initializes the OpenThread library.
This function initializes OpenThread and prepares it for subsequent OpenThread API calls. This function must be called before any other calls to OpenThread.
This function is available and can only be used when support for multiple OpenThread instances is enabled.
[in] | aInstanceBuffer | The buffer for OpenThread to use for allocating the otInstance structure. |
[in,out] | aInstanceBufferSize | On input, the size of aInstanceBuffer. On output, if not enough space for otInstance, the number of bytes required for otInstance. |
otInstance* otInstanceInitSingle | ( | void | ) |
This function initializes the static single instance of the OpenThread library.
This function initializes OpenThread and prepares it for subsequent OpenThread API calls. This function must be called before any other calls to OpenThread.
This function is available and can only be used when support for multiple OpenThread instances is disabled.
bool otInstanceIsInitialized | ( | otInstance * | aInstance | ) |
This function indicates whether or not the instance is valid/initialized.
The instance is considered valid if it is acquired and initialized using either otInstanceInitSingle()
(in single instance case) or otInstanceInit()
(in multi instance case). A subsequent call to otInstanceFinalize()
causes the instance to be considered as uninitialized.
[in] | aInstance | A pointer to an OpenThread instance. |
void otInstanceReset | ( | otInstance * | aInstance | ) |
This method triggers a platform reset.
The reset process ensures that all the OpenThread state/info (stored in volatile memory) is erased. Note that the otPlatformReset
does not erase any persistent state/info saved in non-volatile memory.
[in] | aInstance | A pointer to an OpenThread instance. |
void otRemoveStateChangeCallback | ( | otInstance * | aInstance, |
otStateChangedCallback | aCallback, | ||
void * | aContext | ||
) |
This function removes a callback to indicate when certain configuration or state changes within OpenThread.
[in] | aInstance | A pointer to an OpenThread instance. |
[in] | aCallback | A pointer to a function that is called with certain configuration or state changes. |
[in] | aContext | A pointer to application-specific context. |
otError otSetStateChangedCallback | ( | otInstance * | aInstance, |
otStateChangedCallback | aCallback, | ||
void * | aContext | ||
) |
This function registers a callback to indicate when certain configuration or state changes within OpenThread.
[in] | aInstance | A pointer to an OpenThread instance. |
[in] | aCallback | A pointer to a function that is called with certain configuration or state changes. |
[in] | aContext | A pointer to application-specific context. |
OT_ERROR_NONE | Added the callback to the list of callbacks. |
OT_ERROR_ALREADY | The callback was already registered. |
OT_ERROR_NO_BUFS | Could not add the callback due to resource constraints. |