Instance#

@2#

@2

This enumeration defines flags that are passed as part of otStateChangedCallback.

otInstance#

typedef struct otInstance otInstance

This structure represents the OpenThread instance structure.

otChangedFlags#

typedef uint32_t otChangedFlags

This type represents a bit-field indicating specific state/configuration that has changed.

See OT_CHANGED_* definitions.

otStateChangedCallback#

typedef void(* otStateChangedCallback) (otChangedFlags aFlags, void *aContext) )(otChangedFlags aFlags, void *aContext)

This function pointer is called to notify certain configuration or state changes within OpenThread.

otInstanceInit#

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.

Returns

• A pointer to the new OpenThread instance.

See Also

• otInstanceFinalize

otInstanceInitSingle#

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.

Returns

• A pointer to the single OpenThread instance.

otInstanceIsInitialized#

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.

Returns

• TRUE if the given instance is valid/initialized, FALSE otherwise.

otInstanceFinalize#

void otInstanceFinalize (otInstance *aInstance)

This function disables the OpenThread library.

Call this function when OpenThread is no longer in use.

otInstanceGetUptime#

uint64_t otInstanceGetUptime (otInstance *aInstance)

This function returns the current instance uptime (in msec).

This function requires OPENTHREAD_CONFIG_UPTIME_ENABLE to be enabled.

The uptime is given as number of milliseconds since OpenThread instance was initialized.

Returns

• The uptime (number of milliseconds).

otInstanceGetUptimeAsString#

void otInstanceGetUptimeAsString (otInstance *aInstance, char *aBuffer, uint16_t aSize)

This function returns the current instance uptime as a human-readable string.

This function requires OPENTHREAD_CONFIG_UPTIME_ENABLE to be enabled.

The string follows the format "<hh>:<mm>:<ss>.<mmmm>" for hours, minutes, seconds and millisecond (if uptime is shorter than one day) or "<dd>d.<hh>:<mm>:<ss>.<mmmm>" (if longer than a day).

If the resulting string does not fit in aBuffer (within its aSize characters), the string will be truncated but the outputted string is always null-terminated.

otSetStateChangedCallback#

otError otSetStateChangedCallback (otInstance *aInstance, otStateChangedCallback aCallback, void *aContext)

This function registers a callback to indicate when certain configuration or state changes within OpenThread.

otRemoveStateChangeCallback#

void otRemoveStateChangeCallback (otInstance *aInstance, otStateChangedCallback aCallback, void *aContext)

This function removes a callback to indicate when certain configuration or state changes within OpenThread.

otInstanceReset#

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.

otInstanceFactoryReset#

void otInstanceFactoryReset (otInstance *aInstance)

Deletes all the settings stored on non-volatile memory, and then triggers a platform reset.

otInstanceResetRadioStack#

void otInstanceResetRadioStack (otInstance *aInstance)

This method resets the internal states of the OpenThread radio stack.

Callbacks and configurations are preserved.

This API is only available under radio builds (OPENTHREAD_RADIO = 1).

otInstanceErasePersistentInfo#

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.

otGetVersionString#

const char * otGetVersionString (void)

This function gets the OpenThread version string.

Returns

• A pointer to the OpenThread version.

otGetRadioVersionString#

const char * otGetRadioVersionString (otInstance *aInstance)

This function gets the OpenThread radio version string.

Returns

• A pointer to the OpenThread radio version.

OT_UPTIME_STRING_SIZE#

#define OT_UPTIME_STRING_SIZE

24

Recommended size for string representation of uptime.