彙整器

這個模組包含了 Thread 彙整器角色的函式。

摘要

列舉
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_回應_TIMEOUT。
[in] aContext
指向應用程式特定背景資訊的指標。

otJoinerDiscerner

struct otJoinerDiscerner otJoinerDiscerner

代表合併器。

otJoinerState

enum otJoinerState otJoinerState

定義彙整器狀態。

函式

otJoinerGetDiscerner

const otJoinerDiscerner * otJoinerGetDiscerner(
  otInstance *aInstance
)

取得彙整器。

詳情請參閱 otJoinerSetDiscerner。

詳細說明
參數
[in] aInstance
指向 OpenThread 執行個體的指標。
傳回
如果未設定，則指標會指向彙整切割器或 NULL。

otJoinerGetId

const otExtAddress * otJoinerGetId(
  otInstance *aInstance
)

取得彙整器 ID。

如果未設定合併器缺少符號，彙整器 ID 就是透過工廠指派的 IEEE EUI-64 計算 SHA-256 結果的前 64 位元。否則，彙整器 ID 將由彙整器失蹤器值計算得出。

在調試期間，彙整者 ID 也會用做裝置的 IEEE 802.15.4 延伸地址。

詳細說明
參數
[in] aInstance
指向 OpenThread 執行個體的指標。
傳回
指向加入者 ID 的指標。

otJoinerGetState

otJoinerState otJoinerGetState(
  otInstance *aInstance
)

取得彙整器狀態。

詳細說明
參數
[in] aInstance
指向 OpenThread 執行個體的指標。
傳回
加入者狀態。

otJoinerSetDiscerner

otError otJoinerSetDiscerner(
  otInstance *aInstance,
  otJoinerDiscerner *aDiscerner
)

設定彙整器消化器。

彙整器缺點會用於在執行緒調解過程中計算加入器 ID。詳情請參閱 otJoinerGetId。

詳細說明
參數
[in] aInstance
指向 OpenThread 執行個體的指標。
[in] aDiscerner
指向捲線器的指標。如果 NULL 清除先前設定的任何偏離器，
傳回值
OT_ERROR_NONE
已成功更新聯結器。
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
指向供應商軟體版本的指標 (可能是 NULL)。
[in] aVendorData
供應商資料的指標 (可以是空值)。
[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 字串表示法。

otJoinerStop

void otJoinerStop(
  otInstance *aInstance
)

停用「Thread 加入者」角色。

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

巨集

OT_JOINER_MAX_DISCERNER_LENGTH

 OT_JOINER_MAX_DISCERNER_LENGTH 64

聚合器時段長度上限 (以位元為單位)。

資源

OpenThread API 參考資料主題源自原始碼，請前往 GitHub 取得。如要瞭解詳情或對說明文件做出貢獻，請參閱資源。