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

運用データセット

このモジュールには、データセット更新ツールの関数が含まれています。

概要

このモジュールの関数は、Dataset Updater 機能が有効な場合(つまり OPENTHREAD_CONFIG_DATASET_UPDATER_ENABLE が 1 に設定されている場合)に使用できます。また、この機能は FTD のビルドでのみ利用できます。

列挙型

otMeshcopTlvType{
  OT_MESHCOP_TLV_CHANNEL = 0,
  OT_MESHCOP_TLV_PANID = 1,
  OT_MESHCOP_TLV_EXTPANID = 2,
  OT_MESHCOP_TLV_NETWORKNAME = 3,
  OT_MESHCOP_TLV_PSKC = 4,
  OT_MESHCOP_TLV_NETWORKKEY = 5,
  OT_MESHCOP_TLV_NETWORK_KEY_SEQUENCE = 6,
  OT_MESHCOP_TLV_MESHLOCALPREFIX = 7,
  OT_MESHCOP_TLV_STEERING_DATA = 8,
  OT_MESHCOP_TLV_BORDER_AGENT_RLOC = 9,
  OT_MESHCOP_TLV_COMMISSIONER_ID = 10,
  OT_MESHCOP_TLV_COMM_SESSION_ID = 11,
  OT_MESHCOP_TLV_SECURITYPOLICY = 12,
  OT_MESHCOP_TLV_GET = 13,
  OT_MESHCOP_TLV_ACTIVETIMESTAMP = 14,
  OT_MESHCOP_TLV_COMMISSIONER_UDP_PORT = 15,
  OT_MESHCOP_TLV_STATE = 16,
  OT_MESHCOP_TLV_JOINER_DTLS = 17,
  OT_MESHCOP_TLV_JOINER_UDP_PORT = 18,
  OT_MESHCOP_TLV_JOINER_IID = 19,
  OT_MESHCOP_TLV_JOINER_RLOC = 20,
  OT_MESHCOP_TLV_JOINER_ROUTER_KEK = 21,
  OT_MESHCOP_TLV_PROVISIONING_URL = 32,
  OT_MESHCOP_TLV_VENDOR_NAME_TLV = 33,
  OT_MESHCOP_TLV_VENDOR_MODEL_TLV = 34,
  OT_MESHCOP_TLV_VENDOR_SW_VERSION_TLV = 35,
  OT_MESHCOP_TLV_VENDOR_DATA_TLV = 36,
  OT_MESHCOP_TLV_VENDOR_STACK_VERSION_TLV = 37,
  OT_MESHCOP_TLV_UDP_ENCAPSULATION_TLV = 48,
  OT_MESHCOP_TLV_IPV6_ADDRESS_TLV = 49,
  OT_MESHCOP_TLV_PENDINGTIMESTAMP = 51,
  OT_MESHCOP_TLV_DELAYTIMER = 52,
  OT_MESHCOP_TLV_CHANNELMASK = 53,
  OT_MESHCOP_TLV_COUNT = 54,
  OT_MESHCOP_TLV_PERIOD = 55,
  OT_MESHCOP_TLV_SCAN_DURATION = 56,
  OT_MESHCOP_TLV_ENERGY_LIST = 57,
  OT_MESHCOP_TLV_DISCOVERYREQUEST = 128,
  OT_MESHCOP_TLV_DISCOVERYRESPONSE = 129,
  OT_MESHCOP_TLV_JOINERADVERTISEMENT = 241
}
列挙型
この列挙型は、 MeshCop TLV のタイプを表します。

Typedef

otChannelMask typedef
uint32_t
このタイプはチャンネル マスクを表します。
otDatasetMgmtSetCallback)(otError aResult, void *aContext) typedef
void(*
この関数ポインタは、MGMT_SET リクエストに対するレスポンスが受信されたとき、またはタイムアウトしたときに呼び出されます。
otDatasetUpdaterCallback)(otError aError, void *aContext) typedef
void(*
このコールバック関数ポインタは、データセット更新リクエストが終了したときに呼び出され、データセット更新リクエストの成功または失敗のステータスを報告します。
otExtendedPanId typedef
この構造は、拡張 PAN ID を表します。
otMeshLocalPrefix typedef
この構造は、メッシュ ローカル プレフィックスを表します。
otMeshcopTlvType typedef
この列挙型は、 MeshCop TLV のタイプを表します。
otNetworkKey typedef
struct otNetworkKey
この構造体は、スレッド ネットワーク キーを表します。
otNetworkKeyRef typedef
このデータ型は KeyRef から NetworkKey を表します。
otNetworkName typedef
struct otNetworkName
この構造はネットワーク名を表します。
otOperationalDataset typedef
この構造は、有効または保留中の運用データセットを表します。
otOperationalDatasetComponents typedef
この構造は、運用データセットまたは保留中の運用データセットにさまざまなコンポーネントが存在することを表します。
otOperationalDatasetTlvs typedef
この構造は、有効または保留中の運用データセットを表します。
otPskc typedef
struct otPskc
この構造体は PSKc を表します。
otPskcRef typedef
このデータ型は KeyPS、PSKc を表します。
otSecurityPolicy typedef
この構造はセキュリティ ポリシーを表します。

変数

OT_TOOL_PACKED_END

関数

otDatasetCreateNewNetwork(otInstance *aInstance, otOperationalDataset *aDataset)
このメソッドは、新しいネットワークを形成するときに使用する新しいオペレーショナル データセットを作成します。
otDatasetGeneratePskc(const char *aPassPhrase, const otNetworkName *aNetworkName, const otExtendedPanId *aExtPanId, otPskc *aPskc)
この関数は、指定されたパスフレーズ、ネットワーク名、拡張 PAN ID から PSKc を生成します。
otDatasetGetActive(otInstance *aInstance, otOperationalDataset *aDataset)
この関数は、有効な運用データセットを取得します。
otDatasetGetActiveTlvs(otInstance *aInstance, otOperationalDatasetTlvs *aDataset)
この関数は、有効な運用データセットを取得します。
otDatasetGetDelayTimerMinimal(otInstance *aInstance)
uint32_t
遅延タイマーを最小にする。
otDatasetGetPending(otInstance *aInstance, otOperationalDataset *aDataset)
この関数は、保留中の運用データセットを取得します。
otDatasetGetPendingTlvs(otInstance *aInstance, otOperationalDatasetTlvs *aDataset)
この関数は、保留中の運用データセットを取得します。
otDatasetIsCommissioned(otInstance *aInstance)
bool
この関数は、有効な運用データセットに有効なネットワークが存在するかどうかを示します。
otDatasetParseTlvs(const otOperationalDatasetTlvs *aDatasetTlvs, otOperationalDataset *aDataset)
この関数は、otOperationalDatasetTlvs からオペレーショナル データセットを解析します。
otDatasetSendMgmtActiveGet(otInstance *aInstance, const otOperationalDatasetComponents *aDatasetComponents, const uint8_t *aTlvTypes, uint8_t aLength, const otIp6Address *aAddress)
この関数は MGMT_ACTIVE_GET を送信します。
otDatasetSendMgmtActiveSet(otInstance *aInstance, const otOperationalDataset *aDataset, const uint8_t *aTlvs, uint8_t aLength, otDatasetMgmtSetCallback aCallback, void *aContext)
この関数は MGMT_ACTIVE_SET を送信します。
otDatasetSendMgmtPendingGet(otInstance *aInstance, const otOperationalDatasetComponents *aDatasetComponents, const uint8_t *aTlvTypes, uint8_t aLength, const otIp6Address *aAddress)
この関数は MGMT_PENDING_GET を送信します。
otDatasetSendMgmtPendingSet(otInstance *aInstance, const otOperationalDataset *aDataset, const uint8_t *aTlvs, uint8_t aLength, otDatasetMgmtSetCallback aCallback, void *aContext)
この関数は MGMT_PENDING_SET を送信します。
otDatasetSetActive(otInstance *aInstance, const otOperationalDataset *aDataset)
この関数は、有効な運用データセットを設定します。
otDatasetSetActiveTlvs(otInstance *aInstance, const otOperationalDatasetTlvs *aDataset)
この関数は、有効な運用データセットを設定します。
otDatasetSetDelayTimerMinimal(otInstance *aInstance, uint32_t aDelayTimerMinimal)
遅延タイマーを最小にする。
otDatasetSetPending(otInstance *aInstance, const otOperationalDataset *aDataset)
この関数は、Pending Operational Dataset を設定します。
otDatasetSetPendingTlvs(otInstance *aInstance, const otOperationalDatasetTlvs *aDataset)
この関数は、Pending Operational Dataset を設定します。
otDatasetUpdaterCancelUpdate(otInstance *aInstance)
void
この関数は、進行中のオペレーション データセット更新リクエスト(ある場合)をキャンセルします。
otDatasetUpdaterIsUpdateOngoing(otInstance *aInstance)
bool
この関数は、オペレーション データセットの更新リクエストが進行中かどうかを示します。
otDatasetUpdaterRequestUpdate(otInstance *aInstance, const otOperationalDataset *aDataset, otDatasetUpdaterCallback aCallback, void *aContext)
この関数は、運用データセットの更新をリクエストします。
otNetworkNameFromString(otNetworkName *aNetworkName, const char *aNameString)
この関数は、指定された null で終わる C 文字列から otNetworkName インスタンスを設定します。

構造体

otExtendedPanId

この構造は、拡張 PAN ID を表します。

otNetworkKey

この構造体は、スレッド ネットワーク キーを表します。

otNetworkName

この構造はネットワーク名を表します。

otOperationalDataset

この構造は、有効または保留中の運用データセットを表します。

otOperationalDatasetComponents

この構造は、運用データセットまたは保留中の運用データセットにさまざまなコンポーネントが存在することを表します。

otOperationalDatasetTlvs

この構造は、有効または保留中の運用データセットを表します。

otPskc

この構造体は PSKc を表します。

otSecurityPolicy

この構造はセキュリティ ポリシーを表します。

列挙型

otMeshcopTlvType

 otMeshcopTlvType

この列挙型は、 MeshCop TLV のタイプを表します。

プロパティ
OT_MESHCOP_TLV_ACTIVETIMESTAMP

Meshcop のアクティブなタイムスタンプ TLV

OT_MESHCOP_TLV_BORDER_AGENT_RLOC

Meshcop Border Agent Locator TLV

OT_MESHCOP_TLV_CHANNEL

メッシュコップ チャンネル TLV

OT_MESHCOP_TLV_CHANNELMASK

メッシュコップのチャンネル マスク TLV

OT_MESHCOP_TLV_COMMISSIONER_ID

Meshcop コミッショナー ID TLV

OT_MESHCOP_TLV_COMMISSIONER_UDP_PORT

Meshcop コミッショナーの UDP ポート TLV

OT_MESHCOP_TLV_COMM_SESSION_ID

Meshcop コミッショナー セッション ID TLV

OT_MESHCOP_TLV_COUNT

MeshCop Count TLV

OT_MESHCOP_TLV_DELAYTIMER

メッシュコップ遅延タイマー TLV

OT_MESHCOP_TLV_DISCOVERYREQUEST

Meshcop の Discovery Request TLV

OT_MESHCOP_TLV_DISCOVERYRESPONSE

Meshcop の Discovery Response TLV

OT_MESHCOP_TLV_ENERGY_LIST

メッシュコップ エネルギー リスト TLV

OT_MESHCOP_TLV_EXTPANID

Meshcop Extended Pan Id TLV

OT_MESHCOP_TLV_GET

Meshcop TLV の取得

OT_MESHCOP_TLV_IPV6_ADDRESS_TLV

MeshCop IPv6 アドレス TLV

OT_MESHCOP_TLV_JOINERADVERTISEMENT

Meshcop の Joiner Advertising TLV

OT_MESHCOP_TLV_JOINER_DTLS

Meshcop Joiner の DTLS カプセル化 TLV

OT_MESHCOP_TLV_JOINER_IID

メッシュコップ ジョイナー IID TLV

OT_MESHCOP_TLV_JOINER_RLOC

MeshCop の Joiner Router Locator TLV

OT_MESHCOP_TLV_JOINER_ROUTER_KEK

MeshCop の Joiner Router KEK TLV

OT_MESHCOP_TLV_JOINER_UDP_PORT

Meshcop の Joiner UDP Port TLV

OT_MESHCOP_TLV_MESHLOCALPREFIX

Meshcop メッシュ ローカル プレフィックス TLV

OT_MESHCOP_TLV_NETWORKKEY

Meshcop ネットワーク キー TLV

OT_MESHCOP_TLV_NETWORKNAME

Meshcop ネットワーク名 TLV

OT_MESHCOP_TLV_NETWORK_KEY_SEQUENCE

Meshcop ネットワーク キーシーケンス TLV

OT_MESHCOP_TLV_PANID

メッシュ コップのパン ID TLV

OT_MESHCOP_TLV_PENDINGTIMESTAMP

Meshcop が保留中のタイムスタンプ TLV

OT_MESHCOP_TLV_PERIOD

メッシュコップ期間 TLV

OT_MESHCOP_TLV_PROVISIONING_URL

Meshcop のプロビジョニング URL TLV

OT_MESHCOP_TLV_PSKC

メッシュコップ PSKc TLV

OT_MESHCOP_TLV_SCAN_DURATION

メッシュコップのスキャン時間(TLV)

OT_MESHCOP_TLV_SECURITYPOLICY

Meshcop セキュリティ ポリシー TLV

OT_MESHCOP_TLV_STATE

メッシュコップ状態 TLV

OT_MESHCOP_TLV_STEERING_DATA

メッシュコップ ステアリング データ TLV

OT_MESHCOP_TLV_UDP_ENCAPSULATION_TLV

Meshcop UDP カプセル化 TLV

OT_MESHCOP_TLV_VENDOR_DATA_TLV

Meshcop ベンダーデータ TLV

OT_MESHCOP_TLV_VENDOR_MODEL_TLV

Meshcop ベンダーモデル TLV

OT_MESHCOP_TLV_VENDOR_NAME_TLV

Meshcop ベンダー名 TLV

OT_MESHCOP_TLV_VENDOR_STACK_VERSION_TLV

Meshcop ベンダー スタック バージョン TLV

OT_MESHCOP_TLV_VENDOR_SW_VERSION_TLV

Meshcop ベンダー SW バージョン TLV

Typedef

OTChannelMask

uint32_t otChannelMask

このタイプはチャンネル マスクを表します。

otDatasetMgmtSetCallback

void(* otDatasetMgmtSetCallback)(otError aResult, void *aContext)

この関数ポインタは、MGMT_SET リクエストに対するレスポンスが受信されたとき、またはタイムアウトしたときに呼び出されます。

詳細
パラメータ
[in] aResult
オペレーションの結果。
[in] aContext
アプリ固有のコンテキストへのポインタ。
戻り値
OT_ERROR_NONE
リクエストはリーダーによって承認されました。
OT_ERROR_REJECTED
リクエストはリーダーによって拒否されました。
OT_ERROR_PARSE
レスポンスの解析中にエラーが発生しました。
OT_ERROR_ABORT
リクエストがピアによってリセットされました。
OT_ERROR_RESPONSE_TIMEOUT
タイムアウト中にレスポンスや確認応答を受信しませんでした。

otDatasetUpdaterCallback

void(* otDatasetUpdaterCallback)(otError aError, void *aContext)

このコールバック関数ポインタは、データセット更新リクエストが終了したときに呼び出され、データセット更新リクエストの成功または失敗のステータスを報告します。

詳細
パラメータ
[in] aError
エラーのステータス。OT_ERROR_NONE は、データセットの更新が成功したことを示します。OT_ERROR_INVALID_STATE は、無効な状態(MLE が無効な状態)による失敗を示します。OT_ERROR_ALREADY は、競合するデータセットの更新をネットワーク内の別のデバイスがリクエストしたため、失敗したことを示します。
[in] aContext
ユーザーが任意のコンテキスト(otDatasetUpdaterRequestUpdate() で指定)へのポインタ。

otExtendedPanId

struct otExtendedPanId otExtendedPanId

この構造は、拡張 PAN ID を表します。

otMeshLocalPrefix

otIp6NetworkPrefix otMeshLocalPrefix

この構造は、メッシュ ローカル プレフィックスを表します。

otMeshcopTlvType

enum otMeshcopTlvType otMeshcopTlvType

この列挙型は、 MeshCop TLV のタイプを表します。

otNetworkKey

struct otNetworkKey otNetworkKey

この構造体は、スレッド ネットワーク キーを表します。

otNetworkKeyRef(OTNetworkKeyRef)

otCryptoKeyRef otNetworkKeyRef

このデータ型は KeyRef から NetworkKey を表します。

キーへの参照

otNetworkName

struct otNetworkName otNetworkName

この構造はネットワーク名を表します。

otNetworkName は null で終わる C 文字列(つまり、 m8 文字配列の末尾は null 文字 \0 でなければなりません。

otOperationalDataset

struct otOperationalDataset otOperationalDataset

この構造は、有効または保留中の運用データセットを表します。

データセット内のコンポーネントはオプションです。mComponets 構造体は、データセット内に存在するコンポーネントを指定します。

otOperationalDatasetComponents のセット

struct otOperationalDatasetComponents otOperationalDatasetComponents

この構造は、運用データセットまたは保留中の運用データセットにさまざまなコンポーネントが存在することを表します。

otOperationalDatasetTlvs

struct otOperationalDatasetTlvs otOperationalDatasetTlvs

この構造は、有効または保留中の運用データセットを表します。

運用データセットは、Thread で指定された TLV エンコードです。

OTPSKC

struct otPskc otPskc

この構造体は PSKc を表します。

OTPSKCRef

otCryptoKeyRef otPskcRef

このデータ型は KeyPS、PSKc を表します。

キーへの参照

otSecurityPolicy

struct otSecurityPolicy otSecurityPolicy

この構造はセキュリティ ポリシーを表します。

変数

OT_TOOL_PACKED_END

OT_TOOL_PACKED_BEGIN struct otNetworkKey OT_TOOL_PACKED_END

関数

otDatasetCreateNewNetwork(新規作成)

otError otDatasetCreateNewNetwork(
  otInstance *aInstance,
  otOperationalDataset *aDataset
)

このメソッドは、新しいネットワークを形成するときに使用する新しいオペレーショナル データセットを作成します。

詳細
パラメータ
[in] aInstance
OpenThread インスタンスへのポインタ。
[out] aDataset
運用データセット
戻り値
OT_ERROR_NONE
新しいオペレーショナル データセットが正常に作成されました。
OT_ERROR_FAILED
新しいパラメータのランダムな値を生成できませんでした。

otDatasetGeneratePskc

otError otDatasetGeneratePskc(
  const char *aPassPhrase,
  const otNetworkName *aNetworkName,
  const otExtendedPanId *aExtPanId,
  otPskc *aPskc
)

この関数は、指定されたパスフレーズ、ネットワーク名、拡張 PAN ID から PSKc を生成します。

PSKc は、コミッショナー セッションを確立するために使用されます。

詳細
パラメータ
[in] aPassPhrase
コミッショニング パスフレーズ。
[in] aNetworkName
PSKc 計算のネットワーク名。
[in] aExtPanId
PSKc 計算用の拡張 PAN ID。
[out] aPskc
生成された PSKc を出力する変数へのポインタ。
戻り値
OT_ERROR_NONE
PSKc を生成しました。
OT_ERROR_INVALID_ARGS
入力引数のいずれかが無効な場合。

otDatasetGetActive

otError otDatasetGetActive(
  otInstance *aInstance,
  otOperationalDataset *aDataset
)

この関数は、有効な運用データセットを取得します。

詳細
パラメータ
[in] aInstance
OpenThread インスタンスへのポインタ。
[out] aDataset
アクティブ オペレーショナル データセットが配置される場所を指すポインタ。
戻り値
OT_ERROR_NONE
アクティブなオペレーショナル データセットを正常に取得しました。
OT_ERROR_NOT_FOUND
設定ストアに対応する値がありません。

otDatasetGetActiveTlvs

otError otDatasetGetActiveTlvs(
  otInstance *aInstance,
  otOperationalDatasetTlvs *aDataset
)

この関数は、有効な運用データセットを取得します。

詳細
パラメータ
[in] aInstance
OpenThread インスタンスへのポインタ。
[out] aDataset
アクティブ オペレーショナル データセットが配置される場所を指すポインタ。
戻り値
OT_ERROR_NONE
アクティブなオペレーショナル データセットを正常に取得しました。
OT_ERROR_NOT_FOUND
設定ストアに対応する値がありません。

otDatasetGetDelayTimerMinimal

uint32_t otDatasetGetDelayTimerMinimal(
  otInstance *aInstance
)

遅延タイマーを最小にする。

詳細
パラメータ
[in] aInstance
OpenThread インスタンスへのポインタ。
戻り値
the
最小遅延タイマーの値(ミリ秒)。

otDatasetGetPending

otError otDatasetGetPending(
  otInstance *aInstance,
  otOperationalDataset *aDataset
)

この関数は、保留中の運用データセットを取得します。

詳細
パラメータ
[in] aInstance
OpenThread インスタンスへのポインタ。
[out] aDataset
Pending Operational Dataset を配置する場所を示すポインタ。
戻り値
OT_ERROR_NONE
保留中の運用データセットが正常に取得されました。
OT_ERROR_NOT_FOUND
設定ストアに対応する値がありません。

otDatasetGetPendingTlvs

otError otDatasetGetPendingTlvs(
  otInstance *aInstance,
  otOperationalDatasetTlvs *aDataset
)

この関数は、保留中の運用データセットを取得します。

詳細
パラメータ
[in] aInstance
OpenThread インスタンスへのポインタ。
[out] aDataset
Pending Operational Dataset を配置する場所を示すポインタ。
戻り値
OT_ERROR_NONE
保留中の運用データセットが正常に取得されました。
OT_ERROR_NOT_FOUND
設定ストアに対応する値がありません。

otDatasetIsCommissioned

bool otDatasetIsCommissioned(
  otInstance *aInstance
)

この関数は、有効な運用データセットに有効なネットワークが存在するかどうかを示します。

詳細
パラメータ
[in] aInstance
OpenThread インスタンスへのポインタ。
戻り値
有効な運用データセットに有効なネットワークが存在する場合は TRUE、それ以外の場合は FALSE。

otDatasetParseTlvs

otError otDatasetParseTlvs(
  const otOperationalDatasetTlvs *aDatasetTlvs,
  otOperationalDataset *aDataset
)

この関数は、otOperationalDatasetTlvs からオペレーショナル データセットを解析します。

詳細
パラメータ
[in] aDatasetTlvs
データセット TLV を指すポインタ。
[out] aDataset
データセットが配置される場所を指すポインタ。
戻り値
OT_ERROR_NONE
aDatasetTlvsaDataset を設定しました。
OT_ERROR_INVALID_ARGS
aDatasetTlvs は無効です。

otDatasetSendMgmtActiveGet

otError otDatasetSendMgmtActiveGet(
  otInstance *aInstance,
  const otOperationalDatasetComponents *aDatasetComponents,
  const uint8_t *aTlvTypes,
  uint8_t aLength,
  const otIp6Address *aAddress
)

この関数は MGMT_ACTIVE_GET を送信します。

詳細
パラメータ
[in] aInstance
OpenThread インスタンスへのポインタ。
[in] aDatasetComponents
リクエストするコンポーネントを指定するデータセット コンポーネント構造へのポインタ。
[in] aTlvTypes
リクエストするその他の未加工の TLV 型を含む配列へのポインタ。
[in] aLength
aTlvTypes の長さ。
[in] aAddress
IPv6 の宛先へのポインタが NULL の場合、デフォルトでリーダー ALOC が使用されます。
戻り値
OT_ERROR_NONE
Meshcop データセット コマンドを正常に送信しました。
OT_ERROR_NO_BUFS
送信するためのバッファ容量が不足しています。

otDatasetSendMgmtActiveSet

otError otDatasetSendMgmtActiveSet(
  otInstance *aInstance,
  const otOperationalDataset *aDataset,
  const uint8_t *aTlvs,
  uint8_t aLength,
  otDatasetMgmtSetCallback aCallback,
  void *aContext
)

この関数は MGMT_ACTIVE_SET を送信します。

詳細
パラメータ
[in] aInstance
OpenThread インスタンスへのポインタ。
[in] aDataset
運用データセットへのポインタ。
[in] aTlvs
TLV へのポインタ。
[in] aLength
TLV の長さ。
[in] aCallback
レスポンスの受信時またはタイムアウト時に呼び出される関数へのポインタ。
[in] aContext
aCallback のアプリケーション固有のコンテキストへのポインタ。
戻り値
OT_ERROR_NONE
Meshcop データセット コマンドを正常に送信しました。
OT_ERROR_NO_BUFS
送信するためのバッファ容量が不足しています。
OT_ERROR_BUSY
以前のリクエストが引き続き送信されています。

otDatasetSendMgmtPendingGet

otError otDatasetSendMgmtPendingGet(
  otInstance *aInstance,
  const otOperationalDatasetComponents *aDatasetComponents,
  const uint8_t *aTlvTypes,
  uint8_t aLength,
  const otIp6Address *aAddress
)

この関数は MGMT_PENDING_GET を送信します。

詳細
パラメータ
[in] aInstance
OpenThread インスタンスへのポインタ。
[in] aDatasetComponents
リクエストするコンポーネントを指定するデータセット コンポーネント構造へのポインタ。
[in] aTlvTypes
リクエストするその他の未加工の TLV 型を含む配列へのポインタ。
[in] aLength
aTlvTypes の長さ。
[in] aAddress
IPv6 の宛先へのポインタが NULL の場合、デフォルトでリーダー ALOC が使用されます。
戻り値
OT_ERROR_NONE
Meshcop データセット コマンドを正常に送信しました。
OT_ERROR_NO_BUFS
送信するためのバッファ容量が不足しています。

otDatasetSendMgmtPendingSet

otError otDatasetSendMgmtPendingSet(
  otInstance *aInstance,
  const otOperationalDataset *aDataset,
  const uint8_t *aTlvs,
  uint8_t aLength,
  otDatasetMgmtSetCallback aCallback,
  void *aContext
)

この関数は MGMT_PENDING_SET を送信します。

詳細
パラメータ
[in] aInstance
OpenThread インスタンスへのポインタ。
[in] aDataset
運用データセットへのポインタ。
[in] aTlvs
TLV へのポインタ。
[in] aLength
TLV の長さ。
[in] aCallback
レスポンスの受信時またはタイムアウト時に呼び出される関数へのポインタ。
[in] aContext
aCallback のアプリケーション固有のコンテキストへのポインタ。
戻り値
OT_ERROR_NONE
Meshcop データセット コマンドを正常に送信しました。
OT_ERROR_NO_BUFS
送信するためのバッファ容量が不足しています。
OT_ERROR_BUSY
以前のリクエストが引き続き送信されています。

otDatasetSetActive

otError otDatasetSetActive(
  otInstance *aInstance,
  const otOperationalDataset *aDataset
)

この関数は、有効な運用データセットを設定します。

データセットにアクティブなタイムスタンプが含まれていない場合、データセットは部分的にしか完成していません。

部分的に完了したアクティブなデータセットがあるデバイスで Thread が有効になっている場合、そのデバイスはデータセット内の既存の情報を使用して既存の Thread ネットワークへの接続を試みます。ネットワークに接続するには、Thread ネットワークキーのみが必要です。

チャネルがデータセットに含まれていない場合、デバイスはさまざまなチャネルで MLE Announce メッセージを送信して、他のチャネルで隣接するものを探します。

デバイスが Thread ネットワークに正常に接続されると、デバイスは親からアクティブ データセット全体を取得します。ルーター対応デバイスは、完全なアクティブ データセットになるまでルーターまたはリーダーのロールに移行しません。

詳細
パラメータ
[in] aInstance
OpenThread インスタンスへのポインタ。
[in] aDataset
アクティブなオペレーショナル データセットへのポインタ。
戻り値
OT_ERROR_NONE
Active Operational Dataset を正常に設定しました。
OT_ERROR_NO_BUFS
アクティブ オペレーショナル データセットを設定するためのバッファ容量が不足しています。
OT_ERROR_NOT_IMPLEMENTED
プラットフォームには設定機能が実装されていません。

otDatasetSetActiveTlvs

otError otDatasetSetActiveTlvs(
  otInstance *aInstance,
  const otOperationalDatasetTlvs *aDataset
)

この関数は、有効な運用データセットを設定します。

データセットにアクティブなタイムスタンプが含まれていない場合、データセットは部分的にしか完成していません。

部分的に完了したアクティブなデータセットがあるデバイスで Thread が有効になっている場合、そのデバイスはデータセット内の既存の情報を使用して既存の Thread ネットワークへの接続を試みます。ネットワークに接続するには、Thread ネットワークキーのみが必要です。

チャネルがデータセットに含まれていない場合、デバイスはさまざまなチャネルで MLE Announce メッセージを送信して、他のチャネルで隣接するものを探します。

デバイスが Thread ネットワークに正常に接続されると、デバイスは親からアクティブ データセット全体を取得します。ルーター対応デバイスは、完全なアクティブ データセットになるまでルーターまたはリーダーのロールに移行しません。

詳細
パラメータ
[in] aInstance
OpenThread インスタンスへのポインタ。
[in] aDataset
アクティブなオペレーショナル データセットへのポインタ。
戻り値
OT_ERROR_NONE
Active Operational Dataset を正常に設定しました。
OT_ERROR_NO_BUFS
アクティブ オペレーショナル データセットを設定するためのバッファ容量が不足しています。
OT_ERROR_NOT_IMPLEMENTED
プラットフォームには設定機能が実装されていません。

otDatasetSetDelayTimerMinimal

otError otDatasetSetDelayTimerMinimal(
  otInstance *aInstance,
  uint32_t aDelayTimerMinimal
)

遅延タイマーを最小にする。

詳細
パラメータ
[in] aInstance
OpenThread インスタンスへのポインタ。
[in] aDelayTimerMinimal
最小遅延タイマーの値(ミリ秒)。
戻り値
OT_ERROR_NONE
最小遅延タイマーが正常に設定されました。
OT_ERROR_INVALID_ARGS
aDelayTimerMinimal が有効でない場合。

otDatasetSetPending

otError otDatasetSetPending(
  otInstance *aInstance,
  const otOperationalDataset *aDataset
)

この関数は、Pending Operational Dataset を設定します。

詳細
パラメータ
[in] aInstance
OpenThread インスタンスへのポインタ。
[in] aDataset
Pending Operational Dataset へのポインタです。
戻り値
OT_ERROR_NONE
保留中のオペレーション データセットを設定しました。
OT_ERROR_NO_BUFS
保留中のオペレーション データセットを設定するためのバッファ容量が不足しています。
OT_ERROR_NOT_IMPLEMENTED
プラットフォームには設定機能が実装されていません。

otDatasetSetPendingTlvs

otError otDatasetSetPendingTlvs(
  otInstance *aInstance,
  const otOperationalDatasetTlvs *aDataset
)

この関数は、Pending Operational Dataset を設定します。

詳細
パラメータ
[in] aInstance
OpenThread インスタンスへのポインタ。
[in] aDataset
Pending Operational Dataset へのポインタです。
戻り値
OT_ERROR_NONE
保留中のオペレーション データセットを設定しました。
OT_ERROR_NO_BUFS
保留中のオペレーション データセットを設定するためのバッファ容量が不足しています。
OT_ERROR_NOT_IMPLEMENTED
プラットフォームには設定機能が実装されていません。

otDatasetUpdaterCancelUpdate

void otDatasetUpdaterCancelUpdate(
  otInstance *aInstance
)

この関数は、進行中のオペレーション データセット更新リクエスト(ある場合)をキャンセルします。

詳細
パラメータ
[in] aInstance
OpenThread インスタンスへのポインタ。

otDatasetUpdaterIsUpdateOngoing(英語)

bool otDatasetUpdaterIsUpdateOngoing(
  otInstance *aInstance
)

この関数は、オペレーション データセットの更新リクエストが進行中かどうかを示します。

詳細
パラメータ
[in] aInstance
OpenThread インスタンスへのポインタ。
戻り値
TRUE
進行中の更新があります。
FALSE
進行中の更新はありません。

otDatasetUpdaterRequestUpdate

otError otDatasetUpdaterRequestUpdate(
  otInstance *aInstance,
  const otOperationalDataset *aDataset,
  otDatasetUpdaterCallback aCallback,
  void *aContext
)

この関数は、運用データセットの更新をリクエストします。

aDataset には、更新するフィールドとその新しい値を含める必要があります。このフィールドには、有効なタイムスタンプ フィールドや保留中のタイムスタンプ フィールドを含めることはできません。遅延フィールドは省略できます。省略すると、デフォルト値(1, 000 ミリ秒)が使用されます。

詳細
パラメータ
[in] aInstance
OpenThread インスタンスへのポインタ。
[in] aDataset
変更するフィールドを含むデータセットへのポインタ。
[in] aCallback
データセット更新リクエストの終了を示すコールバック。
[in] aContext
コールバックに渡される任意のコンテキスト。
戻り値
OT_ERROR_NONE
データセットの更新が正常に開始しました(完了時に aCallback が呼び出されます)。
OT_ERROR_INVALID_STATE
デバイスが無効になっている(MLE が無効になっている)。
OT_ERROR_INVALID_ARGS
aDataset が無効です(アクティブまたは保留中のタイムスタンプを含む)。
OT_ERROR_BUSY
更新を開始できません。前の更新が進行中です。
OT_ERROR_NO_BUFS
データセットを保存するバッファを割り当てられませんでした。

otNetworkNameFromString

otError otNetworkNameFromString(
  otNetworkName *aNetworkName,
  const char *aNameString
)

この関数は、指定された null で終わる C 文字列から otNetworkName インスタンスを設定します。

また、この関数は、指定された aNameString が UTF-8 エンコードに従っていることと、その長さが OT_NETWORK_NAME_MAX_SIZE 以下であることも検証します。

詳細
パラメータ
[out] aNetworkName
設定する otNetworkName へのポインタ。
[in] aNameString
名前 C の文字列。
戻り値
OT_ERROR_NONE
aNameStringaNetworkName を設定しました。
OT_ERROR_INVALID_ARGS
aNameStrng が無効です(長すぎるか、UTF-8 エンコードではありません)。

マクロ

チャネル 10_MASK

 OT_CHANNEL_10_MASK (1 << 10)

チャンネル 10.

チャネル_11_MASK

 OT_CHANNEL_11_MASK (1 << 11)

チャンネル 11.

チャネル_12_MASK

 OT_CHANNEL_12_MASK (1 << 12)

チャンネル 12.

チャネル_13_MASK

 OT_CHANNEL_13_MASK (1 << 13)

チャンネル 13.

チャネル_14_MASK

 OT_CHANNEL_14_MASK (1 << 14)

チャンネル 14.

チャネル_15_マスク

 OT_CHANNEL_15_MASK (1 << 15)

チャンネル 15.

チャネル_16_MASK

 OT_CHANNEL_16_MASK (1 << 16)

チャンネル 16.

チャネル_17_MASK

 OT_CHANNEL_17_MASK (1 << 17)

チャンネル 17.

チャネル_18_MASK

 OT_CHANNEL_18_MASK (1 << 18)

チャンネル 18.

チャネル_19_マスク

 OT_CHANNEL_19_MASK (1 << 19)

チャンネル 19.

チャネル_1_マスク

 OT_CHANNEL_1_MASK (1 << 1)

チャンネル 1.

チャネル 20_MASK

 OT_CHANNEL_20_MASK (1 << 20)

チャンネル 20.

チャネル_21_MASK

 OT_CHANNEL_21_MASK (1 << 21)

チャンネル 21.

チャネル_22_MASK

 OT_CHANNEL_22_MASK (1 << 22)

チャンネル 22.

チャネル_23_MASK

 OT_CHANNEL_23_MASK (1 << 23)

チャンネル 23.

[OT_CHANNEL_24_MASK]

 OT_CHANNEL_24_MASK (1 << 24)

チャンネル 24.

チャネル_25_マスク

 OT_CHANNEL_25_MASK (1 << 25)

チャンネル 25.

チャネル_26_MASK

 OT_CHANNEL_26_MASK (1 << 26)

チャンネル 26.

チャネル_2_マスク

 OT_CHANNEL_2_MASK (1 << 2)

チャンネル 2.

チャネル_3_マスク

 OT_CHANNEL_3_MASK (1 << 3)

チャンネル 3.

チャネル_4_マスク

 OT_CHANNEL_4_MASK (1 << 4)

チャンネル 4.

チャネル_5_マスク

 OT_CHANNEL_5_MASK (1 << 5)

チャンネル 5.

チャネル_6_マスク

 OT_CHANNEL_6_MASK (1 << 6)

チャンネル 6.

チャネル_7_マスク

 OT_CHANNEL_7_MASK (1 << 7)

チャンネル 7.

チャネル_8_マスク

 OT_CHANNEL_8_MASK (1 << 8)

チャンネル 8:

チャネル_9_マスク

 OT_CHANNEL_9_MASK (1 << 9)

チャンネル 9:

OT_EXT_PAN_ID_SIZE

 OT_EXT_PAN_ID_SIZE 8

スレッドの PAN ID のサイズ(バイト)

OT_MESH_LOCAL_PREFIX_SIZE の場合

 OT_MESH_LOCAL_PREFIX_SIZE OT_IP6_PREFIX_SIZE

メッシュ ローカル プレフィックスのサイズ(バイト)

OT_NETWORK_KEY_SIZE

 OT_NETWORK_KEY_SIZE 16

スレッド ネットワーク キーのサイズ(バイト)

OT_NETWORK_NAME_MAX_SIZE

 OT_NETWORK_NAME_MAX_SIZE 16

Thread Network Name フィールドの最大サイズ(バイト)

OT_OPERATIONAL_DATASET_MAX_LENGTH

 OT_OPERATIONAL_DATASET_MAX_LENGTH 254

オペレーショナル データセットの最大文字数(バイト単位)。

OT_PSKC_MAX_SIZE

 OT_PSKC_MAX_SIZE 16

PSKc の最大サイズ(バイト)

リソース

OpenThread API リファレンスのトピックは、GitHub で入手可能なソースコードに基づいています。 詳細またはドキュメントへの投稿については、リソースをご覧ください。