執行個體
這個模組包含用來控制 OpenThread 執行個體的函式。
摘要
Typedefs |
|
---|---|
otChangedFlags
|
typedefuint32_t
此類型代表一個位元欄位,代表已變更的特定狀態/設定。 |
otInstance
|
typedefstruct otInstance
此結構代表 OpenThread 執行個體結構。 |
otStateChangedCallback)(otChangedFlags aFlags, void *aContext)
|
typedefvoid(*
這個函式指標會呼叫,以通知 OpenThread 中的某些設定或狀態變更。 |
Functions |
|
---|---|
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
的一部分傳送的標記。
Typedefs
otChangedFlags
uint32_t otChangedFlags
此類型代表一個位元欄位,代表已變更的特定狀態/設定。
查看「OT_CHANGED_*
」的定義。
otStateChangedCallback
void(* otStateChangedCallback)(otChangedFlags aFlags, void *aContext)
這個函式指標會呼叫,以通知 OpenThread 中的某些設定或狀態變更。
詳細資料 | |||||
---|---|---|---|---|---|
參數 |
|
Functions
otGetRadioVersionString
const char * otGetRadioVersionString( otInstance *aInstance )
這個函式會取得 OpenThread 無線電版本字串。
詳細資料 | |||
---|---|---|---|
參數 |
|
||
傳回 |
指向 OpenThread 無線電版本的指標。
|
otGetVersionString
const char * otGetVersionString( void )
這個函式會取得 OpenThread 版本字串。
詳細資料 | |
---|---|
傳回 |
指向 OpenThread 版本的指標。
|
otInstance 清除永久資訊
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 執行個體初始化後的毫秒數提供。
詳細資料 | |||
---|---|---|---|
參數 |
|
||
傳回 |
運作時間 (毫秒數)。
|
otInstanceGetUptimeAs 字串
void otInstanceGetUptimeAsString( otInstance *aInstance, char *aBuffer, uint16_t aSize )
此函式會以使用者可理解的字串傳回目前的執行個體運作時間。
您必須啟用 OPENTHREAD_CONFIG_UPTIME_ENABLE
,才能使用這個函式。
字串的格式為「
如果產生的字串不適合在 aBuffer
中 (在其 aSize
字元內),系統會截斷字串,但輸出的字串一律會是空值的結尾。
詳細資料 | |||||||
---|---|---|---|---|---|---|---|
參數 |
|
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 僅適用於無線電版本 (OPENTHREAD_RADIO = 1
)。
詳細資料 | |||
---|---|---|---|
參數 |
|
otRemoveStateChangeCallback
void otRemoveStateChangeCallback( otInstance *aInstance, otStateChangedCallback aCallback, void *aContext )
此函式會移除回呼,以指出在 OpenThread 中某些設定或狀態何時變更。
詳細資料 | |||||||
---|---|---|---|---|---|---|---|
參數 |
|
otSetStateChangedCallback
otError otSetStateChangedCallback( otInstance *aInstance, otStateChangedCallback aCallback, void *aContext )
這個函式會註冊回呼,以指出 OpenThread 中的特定設定或狀態何時變更。
詳細資料 | |||||||
---|---|---|---|---|---|---|---|
參數 |
|
||||||
回傳值 |
|
巨集
OT_UPTIME_STRING_SIZE
OT_UPTIME_STRING_SIZE 24
運作時間字串表示的建議大小。
資源
OpenThread API 參考資料主題來自原始碼,可在 GitHub 取得。如需詳細資訊或為說明文件貢獻一己之力,請參閱資源。