コミッショナー
このモジュールには、Thread コミッショナー ロールの関数が含まれています。
まとめ
列挙型 |
|
---|---|
otCommissionerJoinerEvent
|
列挙型 この列挙は、コミッショナーの Joiner イベントを定義します。 |
otCommissionerState{
|
列挙型 この列挙は、コミッショナー状態を定義します。 |
otJoinerInfoType{
|
列挙型 この列挙型は Joiner 情報タイプを定義します。 |
Typedef |
|
---|---|
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(*
この関数は、Joiner の状態が変更されるたびに呼び出されます。 |
otCommissionerJoinerEvent
|
typedef この列挙は、コミッショナーの Joiner イベントを定義します。 |
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
この構造体は Joiner 情報を表します。 |
otJoinerInfoType
|
typedefenum otJoinerInfoType
この列挙型は Joiner 情報タイプを定義します。 |
otJoinerPskd
|
typedefstruct otJoinerPskd
この構造は、Joiner PSKd を表します。 |
otSteeringData
|
typedefstruct otSteeringData
この構造はステアリングデータを表します。 |
Functions |
|
---|---|
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)
|
この関数は、Announce Begin メッセージを送信します。
|
otCommissionerEnergyScan(otInstance *aInstance, uint32_t aChannelMask, uint8_t aCount, uint16_t aPeriod, uint16_t aScanDuration, const otIp6Address *aAddress, otCommissionerEnergyReportCallback aCallback, void *aContext)
|
この関数は、Energy Scan Query メッセージを送信します。
|
otCommissionerGetId(otInstance *aInstance)
|
const char *
この関数はコミッショナー ID を返します。
|
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 を送信します。
|
otCommissionerSetId(otInstance *aInstance, const char *aId)
|
この関数は、コミッショナー ID を設定します。
|
otCommissionerSetProvisioningUrl(otInstance *aInstance, const char *aProvisioningUrl)
|
プロビジョニング URL を設定します。
|
otCommissionerStart(otInstance *aInstance, otCommissionerStateCallback aStateCallback, otCommissionerJoinerCallback aJoinerCallback, void *aCallbackContext)
|
この関数により、Thread コミッショナーのロールが有効になります。
|
otCommissionerStop(otInstance *aInstance)
|
この関数は、Thread コミッショナーのロールを無効にします。
|
構造体 |
|
---|---|
otCommissioningDataset |
この構造はコミッショニング データセットを表します。 |
otJoinerInfo |
この構造体は Joiner 情報を表します。 |
otJoinerPskd |
この構造は、Joiner PSKd を表します。 |
otSteeringData |
この構造はステアリングデータを表します。 |
列挙型
otCommissionerJoinerEvent
otCommissionerJoinerEvent
この列挙は、コミッショナーの Joiner イベントを定義します。
otCommissionerState
otCommissionerState
この列挙は、コミッショナー状態を定義します。
Properties | |
---|---|
OT_COMMISSIONER_STATE_ACTIVE
|
コミッショナーのロールが有効です。 |
OT_COMMISSIONER_STATE_DISABLED
|
コミッショナーのロールが無効です。 |
OT_COMMISSIONER_STATE_PETITION
|
現在、コミッショナーになることを申請しています。 |
otJoinerInfoType 型
otJoinerInfoType
この列挙型は Joiner 情報タイプを定義します。
Properties | |
---|---|
OT_JOINER_INFO_TYPE_ANY
|
Joiner を受け入れます(EUI64 または Discerner は指定しません)。 |
OT_JOINER_INFO_TYPE_DISCERNER
|
Joiner Discerner が指定されている( |
OT_JOINER_INFO_TYPE_EUI64
|
ジョイナー EUI-64 が指定されています( |
Typedef
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)
この関数は、Joiner の状態が変更されるたびに呼び出されます。
詳細 | |||||||||
---|---|---|---|---|---|---|---|---|---|
パラメータ |
|
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)
コミッショナーの状態が変更されるたびに、この関数ポインタが呼び出されます。
詳細 | |||||
---|---|---|---|---|---|
パラメータ |
|
otCommissioningDataset
struct otCommissioningDataset otCommissioningDataset
この構造はコミッショニング データセットを表します。
Functions
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 エントリを追加します。
詳細 | |||||||||
---|---|---|---|---|---|---|---|---|---|
パラメータ |
|
||||||||
戻り値 |
|
otCommissionerAnnounce 開始
otError otCommissionerAnnounceBegin( otInstance *aInstance, uint32_t aChannelMask, uint8_t aCount, uint16_t aPeriod, const otIp6Address *aAddress )
この関数は、Announce Begin メッセージを送信します。
詳細 | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
パラメータ |
|
||||||||||
戻り値 |
|
otCommissionerEnergyScan
otError otCommissionerEnergyScan( otInstance *aInstance, uint32_t aChannelMask, uint8_t aCount, uint16_t aPeriod, uint16_t aScanDuration, const otIp6Address *aAddress, otCommissionerEnergyReportCallback aCallback, void *aContext )
この関数は、Energy Scan Query メッセージを送信します。
詳細 | |||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
パラメータ |
|
||||||||||||||||
戻り値 |
|
otCommissionerGetId
const char * otCommissionerGetId( otInstance *aInstance )
この関数はコミッショナー ID を返します。
詳細 | |||
---|---|---|---|
パラメータ |
|
||
戻り値 |
コミッショナー ID。
|
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
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 )
プロビジョニング URL を設定します。
詳細 | |||||
---|---|---|---|---|---|
パラメータ |
|
||||
戻り値 |
|
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
Joiner PSKd の最大文字列長(null 文字は含まれません)。
OT_PROVISIONING_URL_MAX_SIZE
OT_PROVISIONING_URL_MAX_SIZE 64
プロビジョニング URL 文字列の最大サイズ(文字数)。null 文字は含まれません。
OT_STEERING_DATA_MAX_LENGTH
OT_STEERING_DATA_MAX_LENGTH 16
最大ステアリング データ長(バイト)
リソース
OpenThread API リファレンスのトピックは、GitHub で入手可能なソースコードから作成されています。詳細やドキュメントについては、リソースをご覧ください。