細木工

這個模組包含「執行緒彙整工具」角色的功能。

摘要

列舉

otJoinerState 列舉
此列舉定義了「會員狀態」。

Typedefs

otJoinerCallback)(otError aError, void *aContext) typedef
void(*
系統會呼叫這個函式指標來通知「加入」作業的完成。
otJoinerDiscerner typedef
這個結構代表了「聯合細胞」。
otJoinerState typedef
此列舉定義了「會員狀態」。

函式

otJoinerGetDiscerner(otInstance *aInstance)
取得「細微分解器」。
otJoinerGetId(otInstance *aInstance)
const otExtAddress *
取得會員 ID。
otJoinerGetState(otInstance *aInstance)
取得彙整狀態。
otJoinerSetDiscerner(otInstance *aInstance, otJoinerDiscerner *aDiscerner)
設定「聯結器」。
otJoinerStart(otInstance *aInstance, const char *aPskd, const char *aProvisioningUrl, const char *aVendorName, const char *aVendorModel, const char *aVendorSwVersion, const char *aVendorData, otJoinerCallback aCallback, void *aContext)
啟用 Thread 合併器角色。
otJoinerStateToString(otJoinerState aState)
const char *
這個函式會將指定的聯結狀態列舉值轉換為使用者可理解的字串。
otJoinerStop(otInstance *aInstance)
void
停用 Thread 的加入者角色。

結構

otjoinerDiscerner

這個結構代表了「聯合細胞」。

列舉

OtjoinerState

 otJoinerState

此列舉定義了「會員狀態」。

Typedefs

otjoinerCallback

void(* otJoinerCallback)(otError aError, void *aContext)

系統會呼叫這個函式指標來通知「加入」作業的完成。

詳情
參數
[in] aError
如果彙整程序成功,則傳回 OT_ERROR_NONE。如果加入程序因安全性憑證而無法執行,請 OT_ERROR_SECURITY。如果未找到可連接的網路,則 OT_ERROR_NOT_FOUND。如果回應逾時,OT_ERROR_RESPONSE_TIMEOUT。
[in] aContext
應用程式專屬背景資訊。

OjoinerDiscerner

struct otJoinerDiscerner otJoinerDiscerner

這個結構代表了「聯合細胞」。

OtjoinerState

enum otJoinerState otJoinerState

此列舉定義了「會員狀態」。

函式

otjoinerGetDiscerner

const otJoinerDiscerner * otJoinerGetDiscerner(
  otInstance *aInstance
)

取得「細微分解器」。

詳情請參閱 otjoinerSetDiscerner

詳情
參數
[in] aInstance
指向 OpenThread 執行個體的指標。
傳回
指向「Diser Discerner」的指標;如果未設定,則指向「NULL」。

otjoinerGetId

const otExtAddress * otJoinerGetId(
  otInstance *aInstance
)

取得會員 ID。

如果未設定接合機,接合器 ID 是工廠分配的 IEEE EUI-64 的計算 SHA-256 的前 64 位。否則「彙整者 ID」的計算公式是「結合細項」。

加入數據包也被用作設備的 IEEE 802.15.4 擴展地址。

詳情
參數
[in] aInstance
指向 OpenThread 執行個體的指標。
傳回
會員 ID 的指標。

otjoinerGetState

otJoinerState otJoinerGetState(
  otInstance *aInstance
)

取得彙整狀態。

詳情
參數
[in] aInstance
指向 OpenThread 執行個體的指標。
傳回值
OT_JOINER_STATE_IDLE
OT_JOINER_STATE_DISCOVER
OT_JOINER_STATE_CONNECT
OT_JOINER_STATE_CONNECTED
OT_JOINER_STATE_ENTRUST
OT_JOINER_STATE_JOINED

otjoinerSetDiscerner

otError otJoinerSetDiscerner(
  otInstance *aInstance,
  otJoinerDiscerner *aDiscerner
)

設定「聯結器」。

在「執行緒委任」程序中,系統會使用「細胞細胞器」來計算彙整者 ID。詳情請參閱 otjoinerGetId

詳情
參數
[in] aInstance
指向 OpenThread 執行個體的指標。
[in] aDiscerner
「離婚者」指標。如果 NULL 清除先前設定的任何離題值,
傳回值
OT_ERROR_NONE
已成功更新「主辦者 Disner」。
OT_ERROR_INVALID_ARGS
aDiscerner 無效 (指定長度不在有效範圍內)。
OT_ERROR_INVALID_STATE
有一項彙整的加入程序,因此無法變更 「包含細碎器」。

otjoinerStart

otError otJoinerStart(
  otInstance *aInstance,
  const char *aPskd,
  const char *aProvisioningUrl,
  const char *aVendorName,
  const char *aVendorModel,
  const char *aVendorSwVersion,
  const char *aVendorData,
  otJoinerCallback aCallback,
  void *aContext
)

啟用 Thread 合併器角色。

詳情
參數
[in] aInstance
指向 OpenThread 執行個體的指標。
[in] aPskd
PSKd 的指標。
[in] aProvisioningUrl
佈建網址指向 (可能是 NULL)。
[in] aVendorName
「供應商名稱」(可能是 NULL) 的指標。
[in] aVendorModel
供應商模型的指向點 (可以是 NULL)。
[in] aVendorSwVersion
供應商 SW 版本的指標 (可能是 NULL)。
[in] aVendorData
供應商資料的指標 (可能是 NULL)。
[in] aCallback
指向彙整作業時呼叫的函式。
[in] aContext
應用程式專屬背景資訊。
傳回值
OT_ERROR_NONE
已成功啟動加入者角色。
OT_ERROR_BUSY
先前的嘗試仍在進行中。
OT_ERROR_INVALID_ARGS
aPskd」或「aProvisioningUrl」無效。
OT_ERROR_INVALID_STATE
IPv6 堆疊未啟用,或是 Thread 堆疊完全啟用。

otjoinerStateToString

const char * otJoinerStateToString(
  otJoinerState aState
)

這個函式會將指定的聯結狀態列舉值轉換為使用者可理解的字串。

詳情
參數
[in] aState
結合狀態。
傳回
以使用者可理解的字串表示 aState

TonererStop

void otJoinerStop(
  otInstance *aInstance
)

停用 Thread 的加入者角色。

詳情
參數
[in] aInstance
指向 OpenThread 執行個體的指標。

巨集

OT_JOINER_MAX_DISCERNER_LENGTH

 OT_JOINER_MAX_DISCERNER_LENGTH 64

「結合細胞」的單位長度上限 (以位元為單位)。

資源

OpenThread API 參考主題源自原始碼,可從 GitHub 取得。如要瞭解詳情或參閱說明文件,請參閱資源