透過集合功能整理內容 你可以依據偏好儲存及分類內容。

主席

這個模組包含「執行緒委員」角色的功能。

總結

列舉

otCommissionerJoinerEvent 列舉
此列舉會定義在 Operator 上的聯結事件。
otCommissionerState{
  OT_COMMISSIONER_STATE_DISABLED = 0,
  OT_COMMISSIONER_STATE_PETITION = 1,
  OT_COMMISSIONER_STATE_ACTIVE = 2
}
列舉
此列舉定義了調度員的狀態。
otJoinerInfoType{
  OT_JOINER_INFO_TYPE_ANY = 0,
  OT_JOINER_INFO_TYPE_EUI64 = 1,
  OT_JOINER_INFO_TYPE_DISCERNER = 2
}
列舉
此列舉定義了會員資訊類型。

Typedefs

otCommissionerEnergyReportCallback)(uint32_t aChannelMask, const uint8_t *aEnergyList, uint8_t aEnergyListLength, void *aContext) typedef
void(*
當委員會收到能源報告時,就會呼叫此函式指標。
otCommissionerJoinerCallback)(otCommissionerJoinerEvent aEvent, const otJoinerInfo *aJoinerInfo, const otExtAddress *aJoinerId, void *aContext) typedef
void(*
此聯結指標會在結合狀態變更時呼叫。
otCommissionerJoinerEvent typedef
此列舉會定義在 Operator 上的聯結事件。
otCommissionerPanIdConflictCallback)(uint16_t aPanId, uint32_t aChannelMask, void *aContext) typedef
void(*
當委員收到 PAN ID 衝突訊息時,就會呼叫此函式指標。
otCommissionerState typedef
此列舉定義了調度員的狀態。
otCommissionerStateCallback)(otCommissionerState aState, void *aContext) typedef
void(*
分派狀態變更時,系統會呼叫此函式指標。
otCommissioningDataset typedef
這個結構代表了佣金資料集。
otJoinerInfo typedef
struct otJoinerInfo
這個結構代表了「會員資訊」。
otJoinerInfoType typedef
此列舉定義了會員資訊類型。
otJoinerPskd typedef
struct otJoinerPskd
這個結構代表著 PSKd。
otSteeringData typedef
這個結構代表轉向資料。

函式

otCommissionerAddJoiner(otInstance *aInstance, const otExtAddress *aEui64, const char *aPskd, uint32_t aTimeout)
此函式會新增「joiner」項目。
otCommissionerAddJoinerWithDiscerner(otInstance *aInstance, const otJoinerDiscerner *aDiscerner, const char *aPskd, uint32_t aTimeout)
這個函式會新增具有指定「離散器」值的「彙整者」項目。
otCommissionerAnnounceBegin(otInstance *aInstance, uint32_t aChannelMask, uint8_t aCount, uint16_t aPeriod, const otIp6Address *aAddress)
這個函式會傳送公告「開始」訊息。
otCommissionerEnergyScan(otInstance *aInstance, uint32_t aChannelMask, uint8_t aCount, uint16_t aPeriod, uint16_t aScanDuration, const otIp6Address *aAddress, otCommissionerEnergyReportCallback aCallback, void *aContext)
這個函式會傳送能源掃描查詢訊息。
otCommissionerGetId(otInstance *aInstance)
const char *
此函式會傳回佣金 ID。
otCommissionerGetNextJoinerInfo(otInstance *aInstance, uint16_t *aIterator, otJoinerInfo *aJoiner)
此方法可取得疊代位置的結合器資訊。
otCommissionerGetProvisioningUrl(otInstance *aInstance)
const char *
這個函式會取得帳戶管理網址。
otCommissionerGetSessionId(otInstance *aInstance)
uint16_t
此函式會傳回佣金工作階段 ID。
otCommissionerGetState(otInstance *aInstance)
此函式會傳回佣金狀態。
otCommissionerPanIdQuery(otInstance *aInstance, uint16_t aPanId, uint32_t aChannelMask, const otIp6Address *aAddress, otCommissionerPanIdConflictCallback aCallback, void *aContext)
這個函式會傳送 PAN ID 查詢訊息。
otCommissionerRemoveJoiner(otInstance *aInstance, const otExtAddress *aEui64)
這個函式會移除「先決條件」項目。
otCommissionerRemoveJoinerWithDiscerner(otInstance *aInstance, const otJoinerDiscerner *aDiscerner)
這個函式會移除「先決條件」項目。
otCommissionerSendMgmtGet(otInstance *aInstance, const uint8_t *aTlvs, uint8_t aLength)
此函式會傳送 MGMT_COMMISSIONER_GET。
otCommissionerSendMgmtSet(otInstance *aInstance, const otCommissioningDataset *aDataset, const uint8_t *aTlvs, uint8_t aLength)
這個函式會傳送 MGMT_COMMISSIONER_SET。
otCommissionerSetId(otInstance *aInstance, const char *aId)
這個函式會設定佣金 ID。
otCommissionerSetProvisioningUrl(otInstance *aInstance, const char *aProvisioningUrl)
這個函式會設定帳戶管理網址。
otCommissionerStart(otInstance *aInstance, otCommissionerStateCallback aStateCallback, otCommissionerJoinerCallback aJoinerCallback, void *aCallbackContext)
這個函式會啟用「Thread 佣金」角色。
otCommissionerStop(otInstance *aInstance)
這個函式會停用 Thread 操作者角色。

結構

otCommissioningDataset

這個結構代表了佣金資料集。

otjoinerInfo

這個結構代表了「會員資訊」。

otjoinerPskd

這個結構代表著 PSKd。

otSteeringData

這個結構代表轉向資料。

列舉

otCommissionerjoinerEvent

 otCommissionerJoinerEvent

此列舉會定義在 Operator 上的聯結事件。

OtCommissionerState

 otCommissionerState

此列舉定義了調度員的狀態。

屬性
OT_COMMISSIONER_STATE_ACTIVE

已啟用「佣金」角色。

OT_COMMISSIONER_STATE_DISABLED

已停用經銷商角色。

OT_COMMISSIONER_STATE_PETITION

目前已經請他擔任委員。

otjoinerInfoType

 otJoinerInfoType

此列舉定義了會員資訊類型。

屬性
OT_JOINER_INFO_TYPE_ANY

接受任何結合者 (未指定 EUI64 或 Discerner)。

OT_JOINER_INFO_TYPE_DISCERNER

已指定呼叫者 (otJoinerInfo中的 mSharedId.mDiscerner)。

OT_JOINER_INFO_TYPE_EUI64

已指定歐盟 II-64 連接線 (位於 otJoinerInfo 中的 mSharedId.mEui64)。

Typedefs

otCommissionerEnergyReport 回電

void(* otCommissionerEnergyReportCallback)(uint32_t aChannelMask, const uint8_t *aEnergyList, uint8_t aEnergyListLength, void *aContext)

當委員會收到能源報告時,就會呼叫此函式指標。

詳情
參數總數
[in] aChannelMask
管道遮罩值。
[in] aEnergyList
能量評估清單的指標。
[in] aEnergyListLength
aEnergyListLength中的項目數量。
[in] aContext
應用程式專屬背景資訊。

otCommissionerjoinerCallback

void(* otCommissionerJoinerCallback)(otCommissionerJoinerEvent aEvent, const otJoinerInfo *aJoinerInfo, const otExtAddress *aJoinerId, void *aContext)

此聯結指標會在結合狀態變更時呼叫。

詳情
參數總數
[in] aEvent
結合事件事件類型。
[in] aJoinerInfo
「參與者資訊」指標。
[in] aJoinerId
會員 ID 的指示 (如果不明,則為 NULL)。
[in] aContext
應用程式專屬背景資訊。

otCommissionerjoinerEvent

enum otCommissionerJoinerEvent otCommissionerJoinerEvent

此列舉會定義在 Operator 上的聯結事件。

otCommissionerPanIddevguideCallback

void(* otCommissionerPanIdConflictCallback)(uint16_t aPanId, uint32_t aChannelMask, void *aContext)

當委員收到 PAN ID 衝突訊息時,就會呼叫此函式指標。

詳情
參數總數
[in] aPanId
永久帳號 ID 值。
[in] aChannelMask
管道遮罩值。
[in] aContext
應用程式專屬背景資訊。

OtCommissionerState

enum otCommissionerState otCommissionerState

此列舉定義了調度員的狀態。

otCommissionerStateCallback

void(* otCommissionerStateCallback)(otCommissionerState aState, void *aContext)

分派狀態變更時,系統會呼叫此函式指標。

詳情
參數總數
[in] aState
委員會狀況。
[in] aContext
應用程式專屬背景資訊。

otCommissioningDataset

struct otCommissioningDataset otCommissioningDataset

這個結構代表了佣金資料集。

otjoinerInfo

struct otJoinerInfo otJoinerInfo

這個結構代表了「會員資訊」。

otjoinerInfoType

enum otJoinerInfoType otJoinerInfoType

此列舉定義了會員資訊類型。

OjoinerPskd

struct otJoinerPskd otJoinerPskd

這個結構代表著 PSKd。

otSteeringData

struct otSteeringData otSteeringData

這個結構代表轉向資料。

函式

otCommissionerAddAdder

otError otCommissionerAddJoiner(
  otInstance *aInstance,
  const otExtAddress *aEui64,
  const char *aPskd,
  uint32_t aTimeout
)

此函式會新增「joiner」項目。

詳情
參數總數
[in] aInstance
指向 OpenThread 執行個體的指標。
[in] aEui64
適用於 erEE 的 IEEE EUI-64 或 NULL,這是任何 erer 的指標。
[in] aPskd
PSKd 的指標。
[in] aTimeout
系統會在多久後自動移除彙整器,以秒為單位。
傳回值
OT_ERROR_NONE
已成功新增彙整工具。
OT_ERROR_NO_BUFS
沒有可新增加入的緩衝區。
OT_ERROR_INVALID_ARGS
aEui64」或「aPskd」無效。
OT_ERROR_INVALID_STATE
該佣金無效。

otCommissionerAddAdderWithDiscerner

otError otCommissionerAddJoinerWithDiscerner(
  otInstance *aInstance,
  const otJoinerDiscerner *aDiscerner,
  const char *aPskd,
  uint32_t aTimeout
)

這個函式會新增具有指定「離散器」值的「彙整者」項目。

詳情
參數總數
[in] aInstance
指向 OpenThread 執行個體的指標。
[in] aDiscerner
「離合器」指標。
[in] aPskd
PSKd 的指標。
[in] aTimeout
系統會在多久後自動移除彙整器,以秒為單位。
傳回值
OT_ERROR_NONE
已成功新增彙整工具。
OT_ERROR_NO_BUFS
沒有可新增加入的緩衝區。
OT_ERROR_INVALID_ARGS
aDiscerner」或「aPskd」無效。
OT_ERROR_INVALID_STATE
該佣金無效。

otCommissioner 宣布開始

otError otCommissionerAnnounceBegin(
  otInstance *aInstance,
  uint32_t aChannelMask,
  uint8_t aCount,
  uint16_t aPeriod,
  const otIp6Address *aAddress
)

這個函式會傳送公告「開始」訊息。

詳情
參數總數
[in] aInstance
指向 OpenThread 執行個體的指標。
[in] aChannelMask
管道遮罩值。
[in] aCount
每個頻道的公告訊息數量。
[in] aPeriod
連續兩項 MLE 宣布傳輸之間的間隔時間 (以毫秒為單位)。
[in] aAddress
IPv6 目的地的指標。
傳回值
OT_ERROR_NONE
已成功將「公告開始」訊息加入佇列。
OT_ERROR_NO_BUFS
緩衝區不足以產生「起始」訊息。
OT_ERROR_INVALID_STATE
該佣金無效。

otCommissionerEnergyScan

otError otCommissionerEnergyScan(
  otInstance *aInstance,
  uint32_t aChannelMask,
  uint8_t aCount,
  uint16_t aPeriod,
  uint16_t aScanDuration,
  const otIp6Address *aAddress,
  otCommissionerEnergyReportCallback aCallback,
  void *aContext
)

這個函式會傳送能源掃描查詢訊息。

詳情
參數總數
[in] aInstance
指向 OpenThread 執行個體的指標。
[in] aChannelMask
管道遮罩值。
[in] aCount
每個管道的能源測量數量。
[in] aPeriod
能源測量的間隔時間 (毫秒)。
[in] aScanDuration
每次能源測量的掃描時間長度 (毫秒)。
[in] aAddress
IPv6 目的地的指標。
[in] aCallback
指向接收能源報告訊息的函式指標。
[in] aContext
應用程式專屬背景資訊。
傳回值
OT_ERROR_NONE
已成功將能源掃描查詢訊息排入佇列。
OT_ERROR_NO_BUFS
緩衝區不足以產生能源掃描查詢訊息。
OT_ERROR_INVALID_STATE
該佣金無效。

otCommissionerGetId

const char * otCommissionerGetId(
  otInstance *aInstance
)

此函式會傳回佣金 ID。

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

otCommissionerGetNextjoinerInfo

otError otCommissionerGetNextJoinerInfo(
  otInstance *aInstance,
  uint16_t *aIterator,
  otJoinerInfo *aJoiner
)

此方法可取得疊代位置的結合器資訊。

詳情
參數總數
[in] aInstance
指向執行個體的指標。
[in,out] aIterator
「結合者資訊」疊代器的內容。
[out] aJoiner
「參與者資訊」的參考資料。
傳回值
OT_ERROR_NONE
成功取得參與者資訊。
OT_ERROR_NOT_FOUND
找不到下一位加入者。

otCommissionerGetProvisioningUrl

const char * otCommissionerGetProvisioningUrl(
  otInstance *aInstance
)

這個函式會取得帳戶管理網址。

詳情
參數總數
[in] aInstance
指向 OpenThread 執行個體的指標。
傳回
網址字串的遊標。

otCommissionerGetSessionId

uint16_t otCommissionerGetSessionId(
  otInstance *aInstance
)

此函式會傳回佣金工作階段 ID。

詳情
參數總數
[in] aInstance
指向 OpenThread 執行個體的指標。
傳回
目前的佣金工作階段 ID。

otCommissionerGetState

otCommissionerState otCommissionerGetState(
  otInstance *aInstance
)

此函式會傳回佣金狀態。

詳情
參數總數
[in] aInstance
指向 OpenThread 執行個體的指標。
傳回值
OT_COMMISSIONER_STATE_DISABLED
已停用佣金。
OT_COMMISSIONER_STATE_PETITION
成為委員。
OT_COMMISSIONER_STATE_ACTIVE
已啟用佣金。

otCommissionerPanIdQuery

otError otCommissionerPanIdQuery(
  otInstance *aInstance,
  uint16_t aPanId,
  uint32_t aChannelMask,
  const otIp6Address *aAddress,
  otCommissionerPanIdConflictCallback aCallback,
  void *aContext
)

這個函式會傳送 PAN ID 查詢訊息。

詳情
參數總數
[in] aInstance
指向 OpenThread 執行個體的指標。
[in] aPanId
要查詢的 PAN ID。
[in] aChannelMask
管道遮罩值。
[in] aAddress
IPv6 目的地的指標。
[in] aCallback
這個指標指向接收 PAN ID 衝突訊息的函式。
[in] aContext
應用程式專屬背景資訊。
傳回值
OT_ERROR_NONE
已成功將 PAN ID 查詢訊息排入佇列。
OT_ERROR_NO_BUFS
緩衝區不足以產生 PAN ID 查詢訊息。
OT_ERROR_INVALID_STATE
該佣金無效。

otCommissioner 移除加入者

otError otCommissionerRemoveJoiner(
  otInstance *aInstance,
  const otExtAddress *aEui64
)

這個函式會移除「先決條件」項目。

詳情
參數總數
[in] aInstance
指向 OpenThread 執行個體的指標。
[in] aEui64
適用於 erEE 的 IEEE EUI-64 或 NULL,這是任何 erer 的指標。
傳回值
OT_ERROR_NONE
已成功移除彙整工具。
OT_ERROR_NOT_FOUND
找不到 aEui64 指定的加入者。
OT_ERROR_INVALID_ARGS
aEui64」無效。
OT_ERROR_INVALID_STATE
該佣金無效。

otCommissioner 移除加入者和 Discerner

otError otCommissionerRemoveJoinerWithDiscerner(
  otInstance *aInstance,
  const otJoinerDiscerner *aDiscerner
)

這個函式會移除「先決條件」項目。

詳情
參數總數
[in] aInstance
指向 OpenThread 執行個體的指標。
[in] aDiscerner
「離合器」指標。
傳回值
OT_ERROR_NONE
已成功移除彙整工具。
OT_ERROR_NOT_FOUND
找不到 aEui64 指定的加入者。
OT_ERROR_INVALID_ARGS
aDiscerner」無效。
OT_ERROR_INVALID_STATE
該佣金無效。

otCommissionerSendMgmtGet

otError otCommissionerSendMgmtGet(
  otInstance *aInstance,
  const uint8_t *aTlvs,
  uint8_t aLength
)

此函式會傳送 MGMT_COMMISSIONER_GET。

詳情
參數總數
[in] aInstance
指向 OpenThread 執行個體的指標。
[in] aTlvs
指向 TLV 的指標。
[in] aLength
TLV 的長度。
傳回值
OT_ERROR_NONE
成功傳送 Meshcop 資料集指令。
OT_ERROR_NO_BUFS
緩衝空間空間不足,無法傳送。
OT_ERROR_INVALID_STATE
該佣金無效。

otCommissionerSendMgmtSet

otError otCommissionerSendMgmtSet(
  otInstance *aInstance,
  const otCommissioningDataset *aDataset,
  const uint8_t *aTlvs,
  uint8_t aLength
)

這個函式會傳送 MGMT_COMMISSIONER_SET。

詳情
參數總數
[in] aInstance
指向 OpenThread 執行個體的指標。
[in] aDataset
指向資料集的指標。
[in] aTlvs
指向 TLV 的指標。
[in] aLength
TLV 的長度。
傳回值
OT_ERROR_NONE
成功傳送 Meshcop 資料集指令。
OT_ERROR_NO_BUFS
緩衝空間空間不足,無法傳送。
OT_ERROR_INVALID_STATE
該佣金無效。

otCommissionerSetId

otError otCommissionerSetId(
  otInstance *aInstance,
  const char *aId
)

這個函式會設定佣金 ID。

詳情
參數總數
[in] aInstance
指向 OpenThread 執行個體的指標。
[in] aId
字串字元陣列的指標。必須為空值。
傳回值
OT_ERROR_NONE
已成功設定佣金 ID。
OT_ERROR_INVALID_ARGS
名字過長。
OT_ERROR_INVALID_STATE
調度員已啟用,且無法變更 ID。

otCommissionerSetProvisioningUrl

otError otCommissionerSetProvisioningUrl(
  otInstance *aInstance,
  const char *aProvisioningUrl
)

這個函式會設定帳戶管理網址。

詳情
參數總數
[in] aInstance
指向 OpenThread 執行個體的指標。
[in] aProvisioningUrl
指向帳戶管理網址 (可能是 NULL 設定為空白字串)。
傳回值
OT_ERROR_NONE
已成功設定帳戶管理網址。
OT_ERROR_INVALID_ARGS
aProvisioningUrl」無效 (過長)。

otCommissionerStart

otError otCommissionerStart(
  otInstance *aInstance,
  otCommissionerStateCallback aStateCallback,
  otCommissionerJoinerCallback aJoinerCallback,
  void *aCallbackContext
)

這個函式會啟用「Thread 佣金」角色。

詳情
參數總數
[in] aInstance
指向 OpenThread 執行個體的指標。
[in] aStateCallback
對經銷商狀態變更時呼叫的函式指標。
[in] aJoinerCallback
有一個指標指向擁有聯結事件所呼叫的函式。
[in] aCallbackContext
應用程式專屬背景資訊。
傳回值
OT_ERROR_NONE
已成功啟動調度員服務。
OT_ERROR_ALREADY
系統已啟動過。
OT_ERROR_INVALID_STATE
裝置目前未連接至網路。

otCommissionerStop

otError otCommissionerStop(
  otInstance *aInstance
)

這個函式會停用 Thread 操作者角色。

詳情
參數總數
[in] aInstance
指向 OpenThread 執行個體的指標。
傳回值
OT_ERROR_NONE
已成功停止調度員服務。
OT_ERROR_ALREADY

巨集

OT_COMMISSIONING_PASSPHRASE_MAX_SIZE

 OT_COMMISSIONING_PASSPHRASE_MAX_SIZE 255

佣金通關密語的大小上限。

OT_COMMISSIONING_PASSPHRASE_MIN_SIZE

 OT_COMMISSIONING_PASSPHRASE_MIN_SIZE 6

佣金通關密語的最小大小。

OT_JOINER_MAX_PSKD_LENGTH

 OT_JOINER_MAX_PSKD_LENGTH 32

加入式 PSKd 的字串長度上限 (不包含空值)。

OT_PROVISIONING_URL_MAX_SIZE

 OT_PROVISIONING_URL_MAX_SIZE 64

佈建網址字串中的字元數上限 (字元數除外) (不包含空值)。

OT_STEERING_DATA_MAX_LENGTH

 OT_STEERING_DATA_MAX_LENGTH 16

最大轉向資料長度 (位元組數)

資源

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