專員
該模塊包括線程專員角色的功能。
概要
枚舉 | |
---|---|
otCommissionerJoinerEvent | 枚舉 該枚舉定義了專員上的Joiner事件。 |
otCommissionerState { | 枚舉 此枚舉定義了專員國。 |
otJoinerInfoType { | 枚舉 該枚舉定義了一個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 | 類型定義enum otCommissionerState 此枚舉定義了專員國。 |
otCommissionerStateCallback )(otCommissionerState aState, void *aContext) | 類型定義void(* 每當調試器狀態更改時,都會調用此函數指針。 |
otCommissioningDataset | 類型定義struct otCommissioningDataset 該結構表示調試數據集。 |
otJoinerInfo | 類型定義struct otJoinerInfo 該結構表示Joiner Info。 |
otJoinerInfoType | 類型定義enum otJoinerInfoType 該枚舉定義了一個Joiner Info Typer。 |
otJoinerPskd | 類型定義struct otJoinerPskd 此結構表示Joiner PSKd。 |
otSteeringData | 類型定義struct 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
otJoinerInfoType
otJoinerInfoType
該枚舉定義了一個Joiner Info Typer。
物產 | |
---|---|
OT_JOINER_INFO_TYPE_ANY | 接受任何Joiner(未指定EUI64或Discerner)。 |
OT_JOINER_INFO_TYPE_DISCERNER | 指定了Joiner |
OT_JOINER_INFO_TYPE_EUI64 | 指定了Joiner EUI-64( |
類型定義
otCommissionerEnergyReportCallback
void(* otCommissionerEnergyReportCallback)(uint32_t aChannelMask, const uint8_t *aEnergyList, uint8_t aEnergyListLength, void *aContext)
當專員收到能源報告時,將調用此函數指針。
細節 | |||||||||
---|---|---|---|---|---|---|---|---|---|
參量 |
|
otCommissionerJoinerCallback
void(* otCommissionerJoinerCallback)(otCommissionerJoinerEvent aEvent, const otJoinerInfo *aJoinerInfo, const otExtAddress *aJoinerId, void *aContext)
每當連接器狀態更改時,都會調用此函數指針。
細節 | |||||||||
---|---|---|---|---|---|---|---|---|---|
參量 |
|
otCommissionerJoinerEvent
enum otCommissionerJoinerEvent otCommissionerJoinerEvent
該枚舉定義了專員上的Joiner事件。
otCommissionerPanIdConflictCallback
void(* otCommissionerPanIdConflictCallback)(uint16_t aPanId, uint32_t aChannelMask, void *aContext)
當專員收到PAN ID衝突消息時,將調用此函數指針。
細節 | |||||||
---|---|---|---|---|---|---|---|
參量 |
|
otCommissionerStateCallback
void(* otCommissionerStateCallback)(otCommissionerState aState, void *aContext)
每當調試器狀態更改時,都會調用此函數指針。
細節 | |||||||||
---|---|---|---|---|---|---|---|---|---|
參量 |
|
職能
otCommissionerAddJoiner
otError otCommissionerAddJoiner( otInstance *aInstance, const otExtAddress *aEui64, const char *aPskd, uint32_t aTimeout )
此函數添加一個Joiner條目。
細節 | |||||||||
---|---|---|---|---|---|---|---|---|---|
參量 |
| ||||||||
返回值 |
|
otCommissionerAddJoinerWithDiscerner
otError otCommissionerAddJoinerWithDiscerner( otInstance *aInstance, const otJoinerDiscerner *aDiscerner, const char *aPskd, uint32_t aTimeout )
此函數添加具有給定Joiner Discerner值的Joiner條目。
細節 | |||||||||
---|---|---|---|---|---|---|---|---|---|
參量 |
| ||||||||
返回值 |
|
otCommissionerAnnounceBegin
otError otCommissionerAnnounceBegin( otInstance *aInstance, uint32_t aChannelMask, uint8_t aCount, uint16_t aPeriod, const otIp6Address *aAddress )
此功能發送一個“宣布開始”消息。
細節 | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
參量 |
| ||||||||||
返回值 |
|
otCommissionerEnergyScan
otError otCommissionerEnergyScan( otInstance *aInstance, uint32_t aChannelMask, uint8_t aCount, uint16_t aPeriod, uint16_t aScanDuration, const otIp6Address *aAddress, otCommissionerEnergyReportCallback aCallback, void *aContext )
此功能發送能量掃描查詢消息。
細節 | |||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
參量 |
| ||||||||||||||||
返回值 |
|
otCommissionerGetNextJoinerInfo
otError otCommissionerGetNextJoinerInfo( otInstance *aInstance, uint16_t *aIterator, otJoinerInfo *aJoiner )
此方法在aIterator位置獲取連接器信息。
細節 | |||||||
---|---|---|---|---|---|---|---|
參量 |
| ||||||
返回值 |
|
otCommissionerGetProvisioningUrl
const char * otCommissionerGetProvisioningUrl( otInstance *aInstance )
此函數獲取配置URL。
細節 | |||
---|---|---|---|
參量 |
| ||
退貨 | 指向URL字符串的指針。 |
otCommissionerGetSessionId
uint16_t otCommissionerGetSessionId( otInstance *aInstance )
此函數返回專員會話ID。
細節 | |||
---|---|---|---|
參量 |
| ||
退貨 | 當前的專員會話ID。 |
otCommissionerGetState
otCommissionerState otCommissionerGetState( otInstance *aInstance )
此函數返回專員狀態。
細節 | |||||||
---|---|---|---|---|---|---|---|
參量 |
| ||||||
返回值 |
|
otCommissionerPanIdQuery
otError otCommissionerPanIdQuery( otInstance *aInstance, uint16_t aPanId, uint32_t aChannelMask, const otIp6Address *aAddress, otCommissionerPanIdConflictCallback aCallback, void *aContext )
此功能發送PAN ID查詢消息。
細節 | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
參量 |
| ||||||||||||
返回值 |
|
otCommissionerRemoveJoiner
otError otCommissionerRemoveJoiner( otInstance *aInstance, const otExtAddress *aEui64 )
此功能刪除Joiner條目。
細節 | |||||||||
---|---|---|---|---|---|---|---|---|---|
參量 |
| ||||||||
返回值 |
|
otCommissionerRemoveJoinerWithDiscerner
otError otCommissionerRemoveJoinerWithDiscerner( otInstance *aInstance, const otJoinerDiscerner *aDiscerner )
此功能刪除Joiner條目。
細節 | |||||||||
---|---|---|---|---|---|---|---|---|---|
參量 |
| ||||||||
返回值 |
|
otCommissionerSendMgmtGet
0967FEC230該函數發送MGMT_COMMISSIONER_GET。
細節 | |||||||
---|---|---|---|---|---|---|---|
參量 |
| ||||||
返回值 |
|
otCommissionerSendMgmtSet
otError otCommissionerSendMgmtSet( otInstance *aInstance, const otCommissioningDataset *aDataset, const uint8_t *aTlvs, uint8_t aLength )
該函數發送MGMT_COMMISSIONER_SET。
細節 | |||||||||
---|---|---|---|---|---|---|---|---|---|
參量 |
| ||||||||
返回值 |
|
otCommissionerSetProvisioningUrl
otError otCommissionerSetProvisioningUrl( otInstance *aInstance, const char *aProvisioningUrl )
此功能設置供應URL。
細節 | |||||
---|---|---|---|---|---|
參量 |
| ||||
返回值 |
|
otCommissionerStart
otError otCommissionerStart( otInstance *aInstance, otCommissionerStateCallback aStateCallback, otCommissionerJoinerCallback aJoinerCallback, void *aCallbackContext )
此功能啟用線程專員角色。
細節 | |||||||||
---|---|---|---|---|---|---|---|---|---|
參量 |
| ||||||||
返回值 |
|
otCommissionerStop
otError otCommissionerStop( otInstance *aInstance )
此功能禁用線程專員角色。
細節 | |||||
---|---|---|---|---|---|
參量 |
| ||||
返回值 |
|
巨集
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
最大引導數據長度(字節)