Google is committed to advancing racial equity for Black communities. See how.
本頁面由 Cloud Translation API 翻譯而成。
Switch to English

專員

該模塊包括線程專員角色的功能。

概要

枚舉

otCommissionerJoinerEvent枚舉
該枚舉定義了專員上的Joiner事件。
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
}
枚舉
該枚舉定義了一個Joiner Info Typer。

類型定義

otCommissionerEnergyReportCallback )(uint32_t aChannelMask, const uint8_t *aEnergyList, uint8_t aEnergyListLength, void *aContext)類型定義
void(*
當專員收到能源報告時,將調用此函數指針。
otCommissionerJoinerCallback )(otCommissionerJoinerEvent aEvent, const otJoinerInfo *aJoinerInfo, const otExtAddress *aJoinerId, void *aContext)類型定義
void(*
每當連接器狀態更改時,都會調用此函數指針。
otCommissionerJoinerEvent類型定義
該枚舉定義了專員上的Joiner事件。
otCommissionerPanIdConflictCallback )(uint16_t aPanId, uint32_t aChannelMask, void *aContext)類型定義
void(*
當專員收到PAN ID衝突消息時,將調用此函數指針。
otCommissionerState類型定義
此枚舉定義了專員國。
otCommissionerStateCallback )(otCommissionerState aState, void *aContext)類型定義
void(*
每當調試器狀態更改時,都會調用此函數指針。
otCommissioningDataset類型定義
該結構表示調試數據集。
otJoinerInfo類型定義
該結構表示Joiner Info。
otJoinerInfoType類型定義
該枚舉定義了一個Joiner Info Typer。
otJoinerPskd類型定義
此結構表示Joiner PSKd。
otSteeringData類型定義
該結構表示轉向數據。

職能

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)
此函數添加具有給定Joiner Discerner值的Joiner條目。
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)
此功能發送能量掃描查詢消息。
otCommissionerGetNextJoinerInfo ( otInstance *aInstance, uint16_t *aIterator, otJoinerInfo *aJoiner)
此方法在aIterator位置獲取連接器信息。
otCommissionerGetProvisioningUrl ( otInstance *aInstance)
const char *
此函數獲取配置URL。
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)
此功能刪除Joiner條目。
otCommissionerRemoveJoinerWithDiscerner ( otInstance *aInstance, const otJoinerDiscerner *aDiscerner)
此功能刪除Joiner條目。
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。
otCommissionerSetProvisioningUrl ( otInstance *aInstance, const char *aProvisioningUrl)
此功能設置供應URL。
otCommissionerStart ( otInstance *aInstance, otCommissionerStateCallback aStateCallback, otCommissionerJoinerCallback aJoinerCallback, void *aCallbackContext)
此功能啟用線程專員角色。
otCommissionerStop ( otInstance *aInstance)
此功能禁用線程專員角色。

結構

otCommissioningDataset

該結構表示調試數據集。

otJoinerInfo

該結構表示Joiner Info。

otJoinerPskd

此結構表示Joiner PSKd。

otSteeringData

該結構表示轉向數據。

枚舉

otCommissionerJoinerEvent

 otCommissionerJoinerEvent

該枚舉定義了專員上的Joiner事件。

otCommissionerState

 otCommissionerState

此枚舉定義了專員國。

物產
OT_COMMISSIONER_STATE_ACTIVE

專員角色是活躍的。

OT_COMMISSIONER_STATE_DISABLED

專員角色已禁用。

OT_COMMISSIONER_STATE_PETITION

目前請願成為專員。

otJoinerInfoType

 otJoinerInfoType

該枚舉定義了一個Joiner Info Typer。

物產
OT_JOINER_INFO_TYPE_ANY

接受任何Joiner(未指定EUI64或Discerner)。

OT_JOINER_INFO_TYPE_DISCERNER

指定了Joiner mSharedId.mDiscernermSharedId.mDiscerner中的otJoinerInfo )。

OT_JOINER_INFO_TYPE_EUI64

指定了Joiner EUI-64( mSharedId.mEui64中的otJoinerInfo )。

類型定義

otCommissionerEnergyReportCallback

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

當專員收到能源報告時,將調用此函數指針。

細節
參量
[in] aChannelMask
通道掩碼值。
[in] aEnergyList
指向能量測量列表的指針。
[in] aEnergyListLength
aEnergyListLength的條目aEnergyListLength
[in] aContext
指向特定於應用程序的上下文的指針。

otCommissionerJoinerCallback

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

每當連接器狀態更改時,都會調用此函數指針。

細節
參量
[in] aEvent
Joiner事件類型。
[in] aJoinerInfo
指向Joiner信息的指針。
[in] aJoinerId
指向Joiner ID的指針(如果未知,它將為NULL)。
[in] aContext
指向特定於應用程序的上下文的指針。

otCommissionerJoinerEvent

enum otCommissionerJoinerEvent otCommissionerJoinerEvent

該枚舉定義了專員上的Joiner事件。

otCommissionerPanIdConflictCallback

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

當專員收到PAN ID衝突消息時,將調用此函數指針。

細節
參量
[in] aPanId
PAN ID值。
[in] aChannelMask
通道掩碼值。
[in] aContext
指向特定於應用程序的上下文的指針。

otCommissionerState

enum otCommissionerState otCommissionerState

此枚舉定義了專員國。

otCommissionerStateCallback

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

每當調試器狀態更改時,都會調用此函數指針。

細節
參量
[in] aChannelMask
通道掩碼值。
[in] aEnergyList
指向能量測量列表的指針。
[in] aEnergyListLength
aEnergyListLength的條目aEnergyListLength
[in] aContext
指向特定於應用程序的上下文的指針。

otCommissioningDataset

struct otCommissioningDataset otCommissioningDataset

該結構表示調試數據集。

otJoinerInfo

struct otJoinerInfo otJoinerInfo

該結構表示Joiner Info。

otJoinerInfoType

enum otJoinerInfoType otJoinerInfoType

該枚舉定義了一個Joiner Info Typer。

otJoinerPskd

struct otJoinerPskd otJoinerPskd

此結構表示Joiner PSKd。

otSteeringData

struct otSteeringData otSteeringData

該結構表示轉向數據。

職能

otCommissionerAddJoiner

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

此函數添加一個Joiner條目。

細節
參量
[in] aInstance
指向OpenThread實例的指針。
[in] aEui64
指向Joiner的IEEE EUI-64的指針或任何Joiner的NULL。
[in] aPskd
指向PSKd的指針。
[in] aTimeout
刪除Joiner的時間,以秒為單位。
返回值
OT_ERROR_NONE
成功添加了Joiner。
OT_ERROR_NO_BUFS
沒有可用於添加Joiner的緩衝區。
OT_ERROR_INVALID_ARGS
aEui64aPskd無效。
OT_ERROR_INVALID_STATE
專員未激活。

otCommissionerAddJoinerWithDiscerner

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

此函數添加具有給定Joiner Discerner值的Joiner條目。

細節
參量
[in] aInstance
指向OpenThread實例的指針。
[in] aDiscerner
指向Joiner Discerner的指針。
[in] aPskd
指向PSKd的指針。
[in] aTimeout
刪除Joiner的時間,以秒為單位。
返回值
OT_ERROR_NONE
成功添加了Joiner。
OT_ERROR_NO_BUFS
沒有可用於添加Joiner的緩衝區。
OT_ERROR_INVALID_ARGS
aDiscerneraPskd無效。
OT_ERROR_INVALID_STATE
專員未激活。

otCommissionerAnnounceBegin

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
專員未激活。

otCommissionerGetNextJoinerInfo

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

此方法在aIterator位置獲取連接器信息。

細節
參量
[in] aInstance
指向實例的指針。
[in,out] aIterator
指向Joiner Info迭代器上下文的指針。
[out] aJoiner
對Joiner信息的引用。
返回值
OT_ERROR_NONE
成功獲取Joiner信息。
OT_ERROR_NOT_FOUND
找不到下一個Joiner。

otCommissionerGetProvisioningUrl

const char * otCommissionerGetProvisioningUrl(
  otInstance *aInstance
)

此函數獲取配置URL。

細節
參量
[in] aInstance
指向OpenThread實例的指針。
退貨
指向URL字符串的指針。

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
專員未激活。

otCommissionerRemoveJoiner

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

此功能刪除Joiner條目。

細節
參量
[in] aInstance
指向OpenThread實例的指針。
[in] aEui64
指向Joiner的IEEE EUI-64的指針或任何Joiner的NULL。
返回值
OT_ERROR_NONE
成功刪除了Joiner。
OT_ERROR_NOT_FOUND
找不到由aEui64指定的Joiner。
OT_ERROR_INVALID_ARGS
aEui64無效。
OT_ERROR_INVALID_STATE
專員未激活。

otCommissionerRemoveJoinerWithDiscerner

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

此功能刪除Joiner條目。

細節
參量
[in] aInstance
指向OpenThread實例的指針。
[in] aEui64
指向Joiner Discerner的指針。
返回值
OT_ERROR_NONE
成功刪除了Joiner。
OT_ERROR_NOT_FOUND
找不到由aEui64指定的Joiner。
OT_ERROR_INVALID_ARGS
aDiscerner無效。
OT_ERROR_INVALID_STATE
專員未激活。

otCommissionerSendMgmtGet

0967FEC230

該函數發送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
專員未激活。

otCommissionerSetProvisioningUrl

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

此功能設置供應URL。

細節
參量
[in] aInstance
指向OpenThread實例的指針。
[in] aProvisioningUrl
指向預配置URL的指針(可以為NULL以設置為空字符串)。
返回值
OT_ERROR_NONE
成功設置預配置URL。
OT_ERROR_INVALID_ARGS
aProvisioningUrl無效(太長)。

otCommissionerStart

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

此功能啟用線程專員角色。

細節
參量
[in] aInstance
指向OpenThread實例的指針。
[in] aStateCallback
指向在調試器狀態更改時調用的函數的指針。
[in] aJoinerCallback
出現指向通過Joiner事件調用的函數的指針。
[in] aCallbackContext
指向特定於應用程序的上下文的指針。
返回值
OT_ERROR_NONE
成功啟動了專員服務。
OT_ERROR_ALREADY
專員已經開始。
OT_ERROR_INVALID_STATE
設備當前未連接到網絡。

otCommissionerStop

otError otCommissionerStop(
  otInstance *aInstance
)

此功能禁用線程專員角色。

細節
參量
[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

Joiner PSKd的最大字符串長度(不包含空字符)。

OT_PROVISIONING_URL_MAX_SIZE

 OT_PROVISIONING_URL_MAX_SIZE 64

供應URL字符串中的最大大小(字符數)(不包括空字符)。

OT_STEERING_DATA_MAX_LENGTH

 OT_STEERING_DATA_MAX_LENGTH 16

最大引導數據長度(字節)