主席
這個模組包含「執行緒委員」角色的功能。
總結
列舉 |
|
---|---|
otCommissionerJoinerEvent
|
列舉 此列舉會定義在 Operator 上的聯結事件。 |
otCommissionerState{
|
列舉 此列舉定義了調度員的狀態。 |
otJoinerInfoType{
|
列舉 此列舉定義了會員資訊類型。 |
Typedefs |
|
---|---|
otCommissionerEnergyReportCallback)(uint32_t aChannelMask, const uint8_t *aEnergyList, uint8_t aEnergyListLength, void *aContext)
|
typedefvoid(*
當委員會收到能源報告時,就會呼叫此函式指標。 |
otCommissionerJoinerCallback)(otCommissionerJoinerEvent aEvent, const otJoinerInfo *aJoinerInfo, const otExtAddress *aJoinerId, void *aContext)
|
typedefvoid(*
此聯結指標會在結合狀態變更時呼叫。 |
otCommissionerJoinerEvent
|
typedef 此列舉會定義在 Operator 上的聯結事件。 |
otCommissionerPanIdConflictCallback)(uint16_t aPanId, uint32_t aChannelMask, void *aContext)
|
typedefvoid(*
當委員收到 PAN ID 衝突訊息時,就會呼叫此函式指標。 |
otCommissionerState
|
typedefenum otCommissionerState
此列舉定義了調度員的狀態。 |
otCommissionerStateCallback)(otCommissionerState aState, void *aContext)
|
typedefvoid(*
分派狀態變更時,系統會呼叫此函式指標。 |
otCommissioningDataset
|
typedefstruct otCommissioningDataset
這個結構代表了佣金資料集。 |
otJoinerInfo
|
typedefstruct otJoinerInfo
這個結構代表了「會員資訊」。 |
otJoinerInfoType
|
typedefenum otJoinerInfoType
此列舉定義了會員資訊類型。 |
otJoinerPskd
|
typedefstruct otJoinerPskd
這個結構代表著 PSKd。 |
otSteeringData
|
typedefstruct 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)
|
這個函式會新增具有指定「離散器」值的「彙整者」項目。
|
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
|
已指定呼叫者 ( |
OT_JOINER_INFO_TYPE_EUI64
|
已指定歐盟 II-64 連接線 (位於 |
Typedefs
otCommissionerEnergyReport 回電
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
此列舉會定義在 Operator 上的聯結事件。
otCommissionerPanIddevguideCallback
void(* otCommissionerPanIdConflictCallback)(uint16_t aPanId, uint32_t aChannelMask, void *aContext)
當委員收到 PAN ID 衝突訊息時,就會呼叫此函式指標。
詳情 | |||||||
---|---|---|---|---|---|---|---|
參數總數 |
|
otCommissionerStateCallback
void(* otCommissionerStateCallback)(otCommissionerState aState, void *aContext)
分派狀態變更時,系統會呼叫此函式指標。
詳情 | |||||
---|---|---|---|---|---|
參數總數 |
|
函式
otCommissionerAddAdder
otError otCommissionerAddJoiner( otInstance *aInstance, const otExtAddress *aEui64, const char *aPskd, uint32_t aTimeout )
此函式會新增「joiner」項目。
詳情 | |||||||||
---|---|---|---|---|---|---|---|---|---|
參數總數 |
|
||||||||
傳回值 |
|
otCommissionerAddAdderWithDiscerner
otError otCommissionerAddJoinerWithDiscerner( otInstance *aInstance, const otJoinerDiscerner *aDiscerner, const char *aPskd, uint32_t aTimeout )
這個函式會新增具有指定「離散器」值的「彙整者」項目。
詳情 | |||||||||
---|---|---|---|---|---|---|---|---|---|
參數總數 |
|
||||||||
傳回值 |
|
otCommissioner 宣布開始
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 )
這個函式會傳送能源掃描查詢訊息。
詳情 | |||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
參數總數 |
|
||||||||||||||||
傳回值 |
|
otCommissionerGetId
const char * otCommissionerGetId( otInstance *aInstance )
此函式會傳回佣金 ID。
詳情 | |||
---|---|---|---|
參數總數 |
|
||
傳回 |
佣金 ID。
|
otCommissionerGetNextjoinerInfo
otError otCommissionerGetNextJoinerInfo( otInstance *aInstance, uint16_t *aIterator, otJoinerInfo *aJoiner )
此方法可取得疊代位置的結合器資訊。
詳情 | |||||||
---|---|---|---|---|---|---|---|
參數總數 |
|
||||||
傳回值 |
|
otCommissionerGetProvisioningUrl
const char * otCommissionerGetProvisioningUrl( otInstance *aInstance )
這個函式會取得帳戶管理網址。
詳情 | |||
---|---|---|---|
參數總數 |
|
||
傳回 |
網址字串的遊標。
|
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 查詢訊息。
詳情 | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
參數總數 |
|
||||||||||||
傳回值 |
|
otCommissioner 移除加入者
otError otCommissionerRemoveJoiner( otInstance *aInstance, const otExtAddress *aEui64 )
這個函式會移除「先決條件」項目。
詳情 | |||||||||
---|---|---|---|---|---|---|---|---|---|
參數總數 |
|
||||||||
傳回值 |
|
otCommissioner 移除加入者和 Discerner
otError otCommissionerRemoveJoinerWithDiscerner( otInstance *aInstance, const otJoinerDiscerner *aDiscerner )
這個函式會移除「先決條件」項目。
詳情 | |||||||||
---|---|---|---|---|---|---|---|---|---|
參數總數 |
|
||||||||
傳回值 |
|
otCommissionerSendMgmtGet
otError otCommissionerSendMgmtGet( otInstance *aInstance, const uint8_t *aTlvs, uint8_t aLength )
此函式會傳送 MGMT_COMMISSIONER_GET。
詳情 | |||||||
---|---|---|---|---|---|---|---|
參數總數 |
|
||||||
傳回值 |
|
otCommissionerSendMgmtSet
otError otCommissionerSendMgmtSet( otInstance *aInstance, const otCommissioningDataset *aDataset, const uint8_t *aTlvs, uint8_t aLength )
這個函式會傳送 MGMT_COMMISSIONER_SET。
詳情 | |||||||||
---|---|---|---|---|---|---|---|---|---|
參數總數 |
|
||||||||
傳回值 |
|
otCommissionerSetId
otError otCommissionerSetId( otInstance *aInstance, const char *aId )
這個函式會設定佣金 ID。
詳情 | |||||||
---|---|---|---|---|---|---|---|
參數總數 |
|
||||||
傳回值 |
|
otCommissionerSetProvisioningUrl
otError otCommissionerSetProvisioningUrl( otInstance *aInstance, const char *aProvisioningUrl )
這個函式會設定帳戶管理網址。
詳情 | |||||
---|---|---|---|---|---|
參數總數 |
|
||||
傳回值 |
|
otCommissionerStart
otError otCommissionerStart( otInstance *aInstance, otCommissionerStateCallback aStateCallback, otCommissionerJoinerCallback aJoinerCallback, void *aCallbackContext )
這個函式會啟用「Thread 佣金」角色。
詳情 | |||||||||
---|---|---|---|---|---|---|---|---|---|
參數總數 |
|
||||||||
傳回值 |
|
otCommissionerStop
otError otCommissionerStop( otInstance *aInstance )
這個函式會停用 Thread 操作者角色。
詳情 | |||||
---|---|---|---|---|---|
參數總數 |
|
||||
傳回值 |
|
巨集
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
最大轉向資料長度 (位元組數)