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

コミッショナー

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

概要

列挙

otCommissionerJoinerEvent列挙型
この列挙は、コミッショナーのジョイナーイベントを定義します。
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
}		列挙型
この列挙は、ジョイナー情報タイプを定義します。

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(*
この関数ポインタは、ジョイナの状態が変化するたびに呼び出されます。
otCommissionerJoinerEvent typedef
この列挙は、コミッショナーのジョイナーイベントを定義します。
otCommissionerPanIdConflictCallback )(uint16_t aPanId, uint32_t aChannelMask, void *aContext) typedef
void(*
この関数ポインタは、コミッショナーがPANIDの競合メッセージを受信したときに呼び出されます。
otCommissionerState typedef
この列挙は、コミッショナーの状態を定義します。
otCommissionerStateCallback )(otCommissionerState aState, void *aContext) typedef
void(*
この関数ポインタは、コミッショナーの状態が変化するたびに呼び出されます。
otCommissioningDataset typedef
この構造は、試運転データセットを表します。
otJoinerInfo typedef
struct otJoinerInfo
この構造は、ジョイナー情報を表します。
otJoinerInfoType typedef
この列挙は、ジョイナー情報タイプを定義します。
otJoinerPskd typedef
struct otJoinerPskd
この構造は、ジョイナPSKdを表します。
otSteeringData typedef
この構造は、ステアリングデータを表します。

関数

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)
この関数は、指定されたJoinerDiscerner値を持つ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)
この関数は、PANIDクエリメッセージを送信します。
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

この構造は、ジョイナー情報を表します。

otJoinerPskd

この構造は、ジョイナPSKdを表します。

otSteeringData

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

列挙

otCommissionerJoinerEvent

 otCommissionerJoinerEvent

この列挙は、コミッショナーのジョイナーイベントを定義します。

otCommissionerState

 otCommissionerState

この列挙は、コミッショナーの状態を定義します。

プロパティ
OT_COMMISSIONER_STATE_ACTIVE

コミッショナーの役割がアクティブです。

OT_COMMISSIONER_STATE_DISABLED

コミッショナーの役割は無効になっています。

OT_COMMISSIONER_STATE_PETITION

現在、コミッショナーになることを申請しています。

otJoinerInfoType

 otJoinerInfoType

この列挙は、ジョイナー情報タイプを定義します。

プロパティ
OT_JOINER_INFO_TYPE_ANY

すべてのJoinerを受け入れます（EUI64またはDiscernerは指定されていません）。

OT_JOINER_INFO_TYPE_DISCERNER

ジョイナーディサーナは（指定されているmSharedId.mDiscernerでotJoinerInfo ）。

OT_JOINER_INFO_TYPE_EUI64

ジョイナーEUI-64は、（指定されmSharedId.mEui64でotJoinerInfo ）。

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)

この関数ポインタは、ジョイナの状態が変化するたびに呼び出されます。

詳細
パラメーター
[in] aEvent
ジョイナーイベントタイプ。
[in] aJoinerInfo
ジョイナ情報へのポインタ。
[in] aJoinerId
ジョイナIDへのポインタ（不明な場合はNULLになります）。
[in] aContext
アプリケーション固有のコンテキストへのポインタ。

otCommissionerJoinerEvent

enum otCommissionerJoinerEvent otCommissionerJoinerEvent

この列挙は、コミッショナーのジョイナーイベントを定義します。

otCommissionerPanIdConflictCallback

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

この関数ポインタは、コミッショナーがPANIDの競合メッセージを受信したときに呼び出されます。

詳細
パラメーター
[in] aPanId
PANID値。
[in] aChannelMask
チャネルマスク値。
[in] aContext
アプリケーション固有のコンテキストへのポインタ。

otCommissionerState

enum otCommissionerState otCommissionerState

この列挙は、コミッショナーの状態を定義します。

otCommissionerStateCallback

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

この関数ポインタは、コミッショナーの状態が変化するたびに呼び出されます。

詳細
パラメーター
[in] aChannelMask
チャネルマスク値。
[in] aEnergyList
エネルギー測定リストへのポインタ。
[in] aEnergyListLength
内のエントリ数aEnergyListLength 。
[in] aContext
アプリケーション固有のコンテキストへのポインタ。

otCommissioningDataset

struct otCommissioningDataset otCommissioningDataset

この構造は、試運転データセットを表します。

otJoinerInfo

struct otJoinerInfo otJoinerInfo

この構造は、ジョイナー情報を表します。

otJoinerInfoType

enum otJoinerInfoType otJoinerInfoType

この列挙は、ジョイナー情報タイプを定義します。

otJoinerPskd

struct otJoinerPskd otJoinerPskd

この構造は、ジョイナ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
ジョイナのIEEEEUI-64へのポインタ、または任意のジョイナの場合はNULL。
[in] aPskd
PSKdへのポインタ。
[in] aTimeout
ジョイナーが自動的に削除されるまでの時間（秒単位）。
戻り値
OT_ERROR_NONE
ジョイナーが正常に追加されました。
OT_ERROR_NO_BUFS
ジョイナを追加するために使用できるバッファがありません。
OT_ERROR_INVALID_ARGS
aEui64またはaPskd無効です。
OT_ERROR_INVALID_STATE
コミッショナーはアクティブではありません。

otCommissionerAddJoinerWithDiscerner

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

この関数は、指定されたJoinerDiscerner値を持つJoinerエントリを追加します。

詳細
パラメーター
[in] aInstance
OpenThreadインスタンスへのポインタ。
[in] aDiscerner
JoinerDiscernerへのポインタ。
[in] aPskd
PSKdへのポインタ。
[in] aTimeout
ジョイナーが自動的に削除されるまでの時間（秒単位）。
戻り値
OT_ERROR_NONE
ジョイナーが正常に追加されました。
OT_ERROR_NO_BUFS
ジョイナを追加するために使用できるバッファがありません。
OT_ERROR_INVALID_ARGS
aDiscernerまたはaPskd無効です。
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
2つの連続する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
Energy ScanQueryメッセージを正常にキューに入れました。
OT_ERROR_NO_BUFS
エネルギースキャンクエリメッセージを生成するにはバッファが不十分です。
OT_ERROR_INVALID_STATE
コミッショナーはアクティブではありません。

otCommissionerGetNextJoinerInfo

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

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

詳細
パラメーター
[in] aInstance
インスタンスへのポインタ。
[in,out] aIterator
ジョイナ情報イテレータコンテキストへのポインタ。
[out] aJoiner
ジョイナー情報への参照。
戻り値
OT_ERROR_NONE
ジョイナー情報を正常に取得します。
OT_ERROR_NOT_FOUND
次のジョイナーが見つかりません。

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
)

この関数は、PANIDクエリメッセージを送信します。

詳細
パラメーター
[in] aInstance
OpenThreadインスタンスへのポインタ。
[in] aPanId
照会するPANID。
[in] aChannelMask
チャネルマスク値。
[in] aAddress
IPv6宛先へのポインター。
[in] aCallback
PAN IDConflictメッセージの受信時に呼び出される関数へのポインター。
[in] aContext
アプリケーション固有のコンテキストへのポインタ。
戻り値
OT_ERROR_NONE
PANIDクエリメッセージを正常にキューに入れました。
OT_ERROR_NO_BUFS
PANIDクエリメッセージを生成するためのバッファが不十分です。
OT_ERROR_INVALID_STATE
コミッショナーはアクティブではありません。

otCommissionerRemoveJoiner

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

この関数は、Joinerエントリを削除します。

詳細
パラメーター
[in] aInstance
OpenThreadインスタンスへのポインタ。
[in] aEui64
ジョイナのIEEEEUI-64へのポインタ、または任意のジョイナの場合はNULL。
戻り値
OT_ERROR_NONE
ジョイナーが正常に削除されました。
OT_ERROR_NOT_FOUND
で指定されたジョイナーaEui64見つかりませんでした。
OT_ERROR_INVALID_ARGS
aEui64無効です。
OT_ERROR_INVALID_STATE
コミッショナーはアクティブではありません。

otCommissionerRemoveJoinerWithDiscerner

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

この関数は、Joinerエントリを削除します。

詳細
パラメーター
[in] aInstance
OpenThreadインスタンスへのポインタ。
[in] aEui64
JoinerDiscernerへのポインタ。
戻り値
OT_ERROR_NONE
ジョイナーが正常に削除されました。
OT_ERROR_NOT_FOUND
で指定されたジョイナーaEui64見つかりませんでした。
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
meshcopdatasetコマンドを正常に送信します。
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
meshcopdatasetコマンドを正常に送信します。
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
ジョイナイベントで呼び出される関数へのポインタが発生します。
[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

ジョイナPSKdの最大文字列長（ヌル文字は含まれません）。

OT_PROVISIONING_URL_MAX_SIZE

 OT_PROVISIONING_URL_MAX_SIZE 64

プロビジョニングURL文字列の最大サイズ（文字数）（ヌル文字を除く）。

OT_STEERING_DATA_MAX_LENGTH

 OT_STEERING_DATA_MAX_LENGTH 16

最大ステアリングデータ長（バイト）