Google は、黒人コミュニティのための人種的公平の促進に取り組んでいます。詳細をご覧ください。

コミッショナー

このモジュールには、Thread コミッショナー ロールの関数が含まれています。

まとめ

列挙型

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 情報タイプを定義します。

Typedef

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(*
この関数は、Joiner の状態が変更されるたびに呼び出されます。
otCommissionerJoinerEvent typedef
この列挙は、コミッショナーの Joiner イベントを定義します。
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
この構造体は Joiner 情報を表します。
otJoinerInfoType typedef
この列挙型は Joiner 情報タイプを定義します。
otJoinerPskd typedef
struct otJoinerPskd
この構造は、Joiner PSKd を表します。
otSteeringData typedef
この構造はステアリングデータを表します。

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 が指定されている(otJoinerInfomSharedId.mDiscerner)。

OT_JOINER_INFO_TYPE_EUI64

ジョイナー EUI-64 が指定されています(otJoinerInfomSharedId.mEui64)。

Typedef

otCommissionerEnergyReportCallback

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)

この関数は、Joiner の状態が変更されるたびに呼び出されます。

詳細
パラメータ
[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] aState
コミッショナーの都道府県。
[in] aContext
アプリケーション固有のコンテキストへのポインタ。

otCommissioningDataset

struct otCommissioningDataset otCommissioningDataset

この構造はコミッショニング データセットを表します。

otJoiner 情報

struct otJoinerInfo otJoinerInfo

この構造体は Joiner 情報を表します。

otJoinerInfoType 型

enum otJoinerInfoType otJoinerInfoType

この列挙型は Joiner 情報タイプを定義します。

otJoinerPskd

struct otJoinerPskd otJoinerPskd

この構造は、Joiner PSKd を表します。

otSteeringData

struct otSteeringData otSteeringData

この構造はステアリングデータを表します。

Functions

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。
[in] aPskd
PSKd へのポインタ。
[in] aTimeout
Joiner が自動的に削除されるまでの時間(秒)。
戻り値
OT_ERROR_NONE
Joiner を追加しました。
OT_ERROR_NO_BUFS
Joiner を追加できるバッファがありません。
OT_ERROR_INVALID_ARGS
aEui64 または aPskd が無効です。
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
aDiscerner または aPskd が無効です。
OT_ERROR_INVALID_STATE
コミッショナーがアクティブではありません。

otCommissionerAnnounce 開始

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

この関数は、Announce Begin メッセージを送信します。

詳細
パラメータ
[in] aInstance
OpenThread インスタンスへのポインタ。
[in] aChannelMask
チャンネルのマスク値。
[in] aCount
チャンネルあたりのお知らせメッセージ数。
[in] aPeriod
MLE アナウンス送信が連続する 2 回の時間間隔(ミリ秒単位)。
[in] aAddress
IPv6 の宛先へのポインタ。
戻り値
OT_ERROR_NONE
Announce Begin メッセージをキューに登録しました。
OT_ERROR_NO_BUFS
Announce Begin メッセージを生成するためのバッファが不足しています。
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
)

この関数は、Energy Scan Query メッセージを送信します。

詳細
パラメータ
[in] aInstance
OpenThread インスタンスへのポインタ。
[in] aChannelMask
チャンネルのマスク値。
[in] aCount
チャンネルあたりのエネルギー測定値の数。
[in] aPeriod
エネルギー測定の時間間隔(ミリ秒)。
[in] aScanDuration
各エネルギー測定のスキャン時間(ミリ秒)。
[in] aAddress
IPv6 の宛先へのポインタ。
[in] aCallback
エネルギー レポート メッセージを受信したときに呼び出される関数へのポインタ。
[in] aContext
アプリケーション固有のコンテキストへのポインタ。
戻り値
OT_ERROR_NONE
Energy Scan Query メッセージをキューに登録しました。
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
)

このメソッドは、aIterator 位置のジョイナ情報を取得します。

詳細
パラメータ
[in] aInstance
インスタンスへのポインタ。
[in,out] aIterator
Joiner 情報のイテレータ コンテキストへのポインタ。
[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。
戻り値
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] aDiscerner
Joiner Discerner へのポインタ。
戻り値
OT_ERROR_NONE
Joiner を削除しました。
OT_ERROR_NOT_FOUND
aEui64 で指定された Joiner が見つかりませんでした。
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
文字列文字配列へのポインタ。null で終了する必要があります。
戻り値
OT_ERROR_NONE
コミッショナー ID を設定しました。
OT_ERROR_INVALID_ARGS
名が長すぎます。
OT_ERROR_INVALID_STATE
コミッショナーがアクティブになっているため、ID は変更できません。

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
)

この関数により、Thread コミッショナーのロールが有効になります。

詳細
パラメータ
[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
)

この関数は、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

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 で入手可能なソースコードから作成されています。詳細やドキュメントについては、リソースをご覧ください。