实例
此模块包含用于控制 OpenThread 实例的函数。
总结
类型定义符 |
|
---|---|
otChangedFlags
|
typedefuint32_t
此类型表示位字段,指示已更改的特定状态/配置。 |
otInstance
|
typedefstruct otInstance
此结构表示 OpenThread 实例结构。 |
otStateChangedCallback)(otChangedFlags aFlags, void *aContext)
|
typedefvoid(*
可调用此函数指针来通知 OpenThread 中的某些配置或状态更改。 |
函数 |
|
---|---|
otGetRadioVersionString(otInstance *aInstance)
|
const char *
此函数用于获取 OpenThread 无线装置版本字符串。
|
otGetVersionString(void)
|
const char *
此函数会获取 OpenThread 版本字符串。
|
otInstanceErasePersistentInfo(otInstance *aInstance)
|
此函数会清除存储在非易失性内存中的所有 OpenThread 持久信息(网络设置)。
|
otInstanceFactoryReset(otInstance *aInstance)
|
void
删除存储在非易失性内存中的所有设置,然后触发平台重置。
|
otInstanceFinalize(otInstance *aInstance)
|
void
此函数会停用 OpenThread 库。
|
otInstanceGetUptime(otInstance *aInstance)
|
uint64_t
此函数会返回当前实例的正常运行时间(以毫秒为单位)。
|
otInstanceGetUptimeAsString(otInstance *aInstance, char *aBuffer, uint16_t aSize)
|
void
此函数以人类可读的字符串形式返回当前实例的正常运行时间。
|
otInstanceInit(void *aInstanceBuffer, size_t *aInstanceBufferSize)
|
此函数会初始化 OpenThread 库。
|
otInstanceInitSingle(void)
|
此函数用于初始化 OpenThread 库的静态单实例。
|
otInstanceIsInitialized(otInstance *aInstance)
|
bool
此函数用于指示实例是否有效/已初始化。
|
otInstanceReset(otInstance *aInstance)
|
void
此方法会触发平台重置。
|
otInstanceResetRadioStack(otInstance *aInstance)
|
void
此方法会重置 OpenThread 无线装置堆栈的内部状态。
|
otRemoveStateChangeCallback(otInstance *aInstance, otStateChangedCallback aCallback, void *aContext)
|
void
此函数会移除回调,以指示 OpenThread 中的特定配置或状态何时发生变化。
|
otSetStateChangedCallback(otInstance *aInstance, otStateChangedCallback aCallback, void *aContext)
|
此函数会注册一个回调,以指示 OpenThread 中的特定配置或状态何时发生变化。
|
枚举
匿名枚举
anonymous enum
此枚举定义作为 otStateChangedCallback
的一部分传递的标志。
类型定义符
otChangedFlags
uint32_t otChangedFlags
此类型表示位字段,指示已更改的特定状态/配置。
请参阅 OT_CHANGED_*
定义。
otStateChangedCallback
void(* otStateChangedCallback)(otChangedFlags aFlags, void *aContext)
可调用此函数指针来通知 OpenThread 中的某些配置或状态更改。
详细信息 | |||||
---|---|---|---|---|---|
参数 |
|
函数
otGetRadioVersionString
const char * otGetRadioVersionString( otInstance *aInstance )
此函数用于获取 OpenThread 无线装置版本字符串。
详细信息 | |||
---|---|---|---|
参数 |
|
||
返回 |
指向 OpenThread 无线装置版本的指针。
|
otGetVersionString
const char * otGetVersionString( void )
此函数会获取 OpenThread 版本字符串。
详细信息 | |
---|---|
返回 |
指向 OpenThread 版本的指针。
|
otInstanceErasePersistentInfo
otError otInstanceErasePersistentInfo( otInstance *aInstance )
此函数会清除存储在非易失性内存中的所有 OpenThread 持久信息(网络设置)。
只有当设备处于 disabled
状态/角色时,才能成功执行清空操作。
详细信息 | |||||
---|---|---|---|---|---|
参数 |
|
||||
返回值 |
|
otInstanceFactoryReset
void otInstanceFactoryReset( otInstance *aInstance )
删除存储在非易失性内存中的所有设置,然后触发平台重置。
详细信息 | |||
---|---|---|---|
参数 |
|
otInstanceFinalize
void otInstanceFinalize( otInstance *aInstance )
此函数会停用 OpenThread 库。
当 OpenThread 不再处于使用状态时,调用此函数。
详细信息 | |||
---|---|---|---|
参数 |
|
otInstanceGetUptime
uint64_t otInstanceGetUptime( otInstance *aInstance )
此函数会返回当前实例的正常运行时间(以毫秒为单位)。
该函数需要启用 OPENTHREAD_CONFIG_UPTIME_ENABLE
。
正常运行时间的单位为毫秒(自 OpenThread 实例初始化以来)。
详细信息 | |||
---|---|---|---|
参数 |
|
||
返回 |
正常运行时间(毫秒)。
|
otInstanceGetUptimeAsString
void otInstanceGetUptimeAsString( otInstance *aInstance, char *aBuffer, uint16_t aSize )
此函数以人类可读的字符串形式返回当前实例的正常运行时间。
该函数需要启用 OPENTHREAD_CONFIG_UPTIME_ENABLE
。
该字符串遵循“
如果生成的字符串不适合 aBuffer
(在其 aSize
个字符内),则字符串会被截断,但输出字符串始终以 null 终止。
详细信息 | |||||||
---|---|---|---|---|---|---|---|
参数 |
|
otInstanceInit
otInstance * otInstanceInit( void *aInstanceBuffer, size_t *aInstanceBufferSize )
此函数会初始化 OpenThread 库。
此函数会初始化 OpenThread,并使其为后续 OpenThread API 调用做好准备。必须在对 OpenThread 进行任何其他调用之前调用此函数。
此函数可用,并且只有在启用了对多个 OpenThread 实例的支持时才能使用。
详细信息 | |||||
---|---|---|---|---|---|
参数 |
|
||||
返回 |
指向新 OpenThread 实例的指针。
|
otInstanceFinalize
otInstanceInitSingle
otInstance * otInstanceInitSingle( void )
此函数用于初始化 OpenThread 库的静态单实例。
此函数会初始化 OpenThread,并使其为后续 OpenThread API 调用做好准备。必须在对 OpenThread 进行任何其他调用之前调用此函数。
此函数可用,只有在停用对多个 OpenThread 实例的支持时才能使用。
详细信息 | |
---|---|
返回 |
指向单个 OpenThread 实例的指针。
|
otInstanceIsInitialized
bool otInstanceIsInitialized( otInstance *aInstance )
此函数用于指示实例是否有效/已初始化。
如果使用 otInstanceInitSingle()
(在单实例中)或 otInstanceInit()
(在多实例中)获取并初始化该实例,则该实例被视为有效。对 otInstanceFinalize()
的后续调用会导致实例被视为未初始化。
详细信息 | |||
---|---|---|---|
参数 |
|
||
返回 |
如果指定实例有效/初始化,则为 TRUE,否则为 FALSE。
|
otInstanceReset
void otInstanceReset( otInstance *aInstance )
此方法会触发平台重置。
重置过程可确保清空所有 OpenThread 状态/信息(存储在易失性内存中)。请注意,otPlatformReset
不会清空保存在非易失性内存中的任何持久状态/信息。
详细信息 | |||
---|---|---|---|
参数 |
|
otInstanceResetRadioStack
void otInstanceResetRadioStack( otInstance *aInstance )
此方法会重置 OpenThread 无线装置堆栈的内部状态。
回调和配置会保留。
此 API 仅适用于无线装置 build (OPENTHREAD_RADIO = 1
)。
详细信息 | |||
---|---|---|---|
参数 |
|
otRemoveStateChangeCallback
void otRemoveStateChangeCallback( otInstance *aInstance, otStateChangedCallback aCallback, void *aContext )
此函数会移除回调,以指示 OpenThread 中的特定配置或状态何时发生变化。
详细信息 | |||||||
---|---|---|---|---|---|---|---|
参数 |
|
otSetStateChangedCallback
otError otSetStateChangedCallback( otInstance *aInstance, otStateChangedCallback aCallback, void *aContext )
此函数会注册一个回调,以指示 OpenThread 中的特定配置或状态何时发生变化。
详细信息 | |||||||
---|---|---|---|---|---|---|---|
参数 |
|
||||||
返回值 |
|
宏
第 UP_UPTIME_STRING_SIZE 次加时赛
OT_UPTIME_STRING_SIZE 24
建议以字符串形式表示的正常运行时间。
资源
OpenThread API 参考主题源自 GitHub 上提供的源代码。 如需了解详情或为我们的文档做出贡献,请参阅资源。