運用データセット

Operational Dataset API 用の関数が含まれます。

概要

FTD ビルドの場合のみ、Dataset Updater にはデータセットの更新を管理する関数が含まれています。

FTD ビルドと MTD ビルドの場合、Operational Dataset API には、アクティブおよび保留中のデータセットとデータセットの TLV を管理する関数が含まれています。

列挙型
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
} 		enum
メッシュコップ 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
メッシュコップ 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
このデータ型は PSKc に対する KeyRef を表します。
otSecurityPolicy typedef
セキュリティ ポリシーを表す。
otTimestamp typedef
struct otTimestamp
スレッド データセットのタイムスタンプ コンポーネントを表します。

変数
OT_TOOL_PACKED_END

関数
otDatasetConvertToTlvs(const otOperationalDataset *aDataset, otOperationalDatasetTlvs *aDatasetTlvs)
指定されたオペレーショナル データセットを otOperationalDatasetTlvs に変換します。
otDatasetCreateNewNetwork(otInstance *aInstance, otOperationalDataset *aDataset)
FTD の場合のみ、新しいネットワークを形成するときに使用する新しいオペレーション データセットを作成します。
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
FTD の場合のみ、最小遅延タイマーを取得します。
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)
FTD の場合のみ、最小遅延タイマーを設定します。
otDatasetSetPending(otInstance *aInstance, const otOperationalDataset *aDataset)
保留中の運用データセットを設定します。
otDatasetSetPendingTlvs(otInstance *aInstance, const otOperationalDatasetTlvs *aDataset)
保留中の運用データセットを設定します。
otDatasetUpdateTlvs(const otOperationalDataset *aDataset, otOperationalDatasetTlvs *aDatasetTlvs)
指定されたオペレーショナル データセットを更新します。
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

セキュリティ ポリシーを表す。
otTimestamp

スレッド データセットのタイムスタンプ コンポーネントを表します。

列挙型

otMeshcopTlvType

 otMeshcopTlvType

メッシュコップ TLV タイプを表します。

プロパティ
OT_MESHCOP_TLV_ACTIVETIMESTAMP

meshcop アクティブ タイムスタンプ TLV
OT_MESHCOP_TLV_BORDER_AGENT_RLOC

meshcop Border Agent Locator TLV

OT_MESHCOP_TLV_CHANNEL

meshcop チャンネル TLV
OT_MESHCOP_TLV_CHANNELMASK

meshcop チャンネル マスク 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 Commissioner Session ID TLV

OT_MESHCOP_TLV_COUNT

meshcop カウント TLV
OT_MESHCOP_TLV_DELAYTIMER

meshcop 遅延タイマー TLV
OT_MESHCOP_TLV_DISCOVERYREQUEST

meshcop 調査リクエスト TLV
OT_MESHCOP_TLV_DISCOVERYRESPONSE

meshcop ディスカバリー レスポンスの TLV
OT_MESHCOP_TLV_ENERGY_LIST

meshcop エネルギーリスト TLV
OT_MESHCOP_TLV_EXTPANID

meshcop 拡張パン ID TLV
OT_MESHCOP_TLV_GET

meshcop TLV の取得
OT_MESHCOP_TLV_IPV6_ADDRESS_TLV

meshcop IPv6 アドレス TLV
OT_MESHCOP_TLV_JOINERADVERTISEMENT

meshcop ジョイナー アドバタイズメント TLV
OT_MESHCOP_TLV_JOINER_DTLS

meshcop Joiner DTLS Encapsulation TLV

OT_MESHCOP_TLV_JOINER_IID

meshcop Joiner IID TLV

OT_MESHCOP_TLV_JOINER_RLOC

meshcop ジョイナー ルーター ロケーター TLV
OT_MESHCOP_TLV_JOINER_ROUTER_KEK

meshcop ジョイナー ルーター KEK TLV
OT_MESHCOP_TLV_JOINER_UDP_PORT

meshcop Joiner UDP ポート 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

meshcop パン ID TLV
OT_MESHCOP_TLV_PENDINGTIMESTAMP

meshcop Pending Timestamp TLV

OT_MESHCOP_TLV_PERIOD

meshcop 期間 TLV
OT_MESHCOP_TLV_PROVISIONING_URL

meshcop プロビジョニング URL TLV
OT_MESHCOP_TLV_PSKC

meshcop PSKc TLV

OT_MESHCOP_TLV_SCAN_DURATION

meshcop スキャン時間の TLV
OT_MESHCOP_TLV_SECURITYPOLICY

meshcop セキュリティ ポリシーの TLV
OT_MESHCOP_TLV_STATE

メッシュコップ ステート TLV
OT_MESHCOP_TLV_STEERING_DATA

meshcop ステアリング データ 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)

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

OPENTHREAD_CONFIG_DATASET_UPDATER_ENABLE が有効な場合に利用可能です。

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

メッシュコップ TLV タイプを表します。

otNetworkKey

struct otNetworkKey otNetworkKey

スレッド ネットワーク キーを表します。

otNetworkKeyRef

otCryptoKeyRef otNetworkKeyRef

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

キーへの参照

otNetworkName

struct otNetworkName otNetworkName

ネットワーク名を表します。

otNetworkName は null で終端された C 文字列です（m8 文字配列の末尾は null 文字 \0 でなければなりません）。

otOperationalDataset

struct otOperationalDataset otOperationalDataset

アクティブまたは保留中のオペレーション データセットを表します。

データセット内のコンポーネントは省略可能です。mComponents 構造は、データセットに存在するコンポーネントを指定します。

otOperationalDatasetComponents

struct otOperationalDatasetComponents otOperationalDatasetComponents

アクティブまたは保留中のオペレーション データセットにさまざまなコンポーネントが存在することを表します。

otOperationalDatasetTlvs

struct otOperationalDatasetTlvs otOperationalDatasetTlvs

アクティブまたは保留中のオペレーション データセットを表します。

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

otPskc

struct otPskc otPskc

PSKc を表します。

otPskcRef

otCryptoKeyRef otPskcRef

このデータ型は PSKc に対する KeyRef を表します。

キーへの参照

otSecurityPolicy

struct otSecurityPolicy otSecurityPolicy

セキュリティ ポリシーを表す。

otTimestamp

struct otTimestamp otTimestamp

スレッド データセットのタイムスタンプ コンポーネントを表します。

変数

OT_TOOL_PACKED_END

OT_TOOL_PACKED_BEGIN struct otNetworkKey OT_TOOL_PACKED_END

関数

otDatasetConvertToTlvs

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

指定されたオペレーショナル データセットを otOperationalDatasetTlvs に変換します。

詳細
パラメータ
[in] aDataset
TLV に変換する運用データセット。
[out] aDatasetTlvs
結果を返すデータセット TLV へのポインタ。
戻り値
OT_ERROR_NONE
aDataset を変換し、aDatasetTlvs を更新しました。
OT_ERROR_INVALID_ARGS
「aDataset」は無効です。有効なタイムスタンプまたは保留中のタイムスタンプが含まれていません。

otDatasetCreateNewNetwork

otError otDatasetCreateNewNetwork(
  otInstance *aInstance,
  otOperationalDataset *aDataset
)

FTD の場合のみ、新しいネットワークを形成するときに使用する新しいオペレーション データセットを作成します。

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

FTD の場合のみ、最小遅延タイマーを取得します。

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

otDatasetGetPending

otError otDatasetGetPending(
  otInstance *aInstance,
  otOperationalDataset *aDataset
)

保留中の運用データセットを取得します。

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

otDatasetGetPendingTlvs

otError otDatasetGetPendingTlvs(
  otInstance *aInstance,
  otOperationalDatasetTlvs *aDataset
)

保留中の運用データセットを取得します。

詳細
パラメータ
[in] aInstance
OpenThread インスタンスへのポインタ。
[out] aDataset
保留中のオペレーション データセットが配置される場所へのポインタ。
戻り値
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
aDatasetTlvs から aDataset を設定しました。
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 dataset コマンドを正常に送信しました。
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 dataset コマンドを正常に送信しました。
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 dataset コマンドを正常に送信しました。
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 dataset コマンドを正常に送信しました。
OT_ERROR_NO_BUFS
送信に必要なバッファ領域が不足しています。
OT_ERROR_BUSY
前のリクエストが進行中です。

otDatasetSetActive

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

有効な運用データセットを設定します。

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

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

チャネルがデータセットに含まれていない場合、デバイスは異なるチャネルにわたって MLE アナウンス メッセージを送信して、他のチャネルで近傍を検出します。

デバイスが Thread ネットワークに正常にアタッチされると、デバイスは親から完全なアクティブ データセットを取得します。ルーター対応デバイスは、完全なアクティブ データセットが表示されるまで、ルーターまたはリーダーのロールに移行しないことに注意してください。

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

otDatasetSetActiveTlvs

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

有効な運用データセットを設定します。

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

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

チャネルがデータセットに含まれていない場合、デバイスは異なるチャネルにわたって MLE アナウンス メッセージを送信して、他のチャネルで近傍を検出します。

デバイスが Thread ネットワークに正常にアタッチされると、デバイスは親から完全なアクティブ データセットを取得します。ルーター対応デバイスは、完全なアクティブ データセットが表示されるまで、ルーターまたはリーダーのロールに移行しないことに注意してください。

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

otDatasetSetDelayTimerMinimal

otError otDatasetSetDelayTimerMinimal(
  otInstance *aInstance,
  uint32_t aDelayTimerMinimal
)

FTD の場合のみ、最小遅延タイマーを設定します。

詳細
パラメータ
[in] aInstance
OpenThread インスタンスへのポインタ。
[in] aDelayTimerMinimal
最小遅延タイマーの値（ミリ秒単位）。
戻り値
OT_ERROR_NONE
最小遅延タイマーを設定しました。
OT_ERROR_INVALID_ARGS
aDelayTimerMinimal が有効でない場合。

otDatasetSetPending

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

保留中の運用データセットを設定します。

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

otDatasetSetPendingTlvs

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

保留中の運用データセットを設定します。

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

otDatasetUpdateTlvs

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

指定されたオペレーショナル データセットを更新します。

aDataset には、更新するフィールドとその新しい値が含まれます。

詳細
パラメータ
[in] aDataset
更新する型と値のセットを指定します。
[in,out] aDatasetTlvs
更新するデータセットの TLV へのポインタ。
戻り値
OT_ERROR_NONE
aDatasetTlvs を更新しました。
OT_ERROR_INVALID_ARGS
aDataset に無効な値が含まれています。
OT_ERROR_NO_BUFS
aDatasetTlvs にアップデートを適用するための十分な空き容量がありません。

otDatasetUpdaterCancelUpdate

void otDatasetUpdaterCancelUpdate(
  otInstance *aInstance
)

進行中のオペレーション データセットの更新リクエストをキャンセルします（存在する場合）。

OPENTHREAD_CONFIG_DATASET_UPDATER_ENABLE が有効な場合に利用可能です。

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

otDatasetUpdaterIsUpdateOngoing

bool otDatasetUpdaterIsUpdateOngoing(
  otInstance *aInstance
)

進行中のオペレーション データセット更新リクエストがあるかどうかを表します。

OPENTHREAD_CONFIG_DATASET_UPDATER_ENABLE が有効な場合に利用可能です。

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

otDatasetUpdaterRequestUpdate

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

オペレーショナル データセットの更新をリクエストします。

OPENTHREAD_CONFIG_DATASET_UPDATER_ENABLE が有効な場合に利用可能です。

aDataset には、更新するフィールドとその新しい値を含める必要があります。Active または Pending Timestamp フィールドを含めることはできません。[Delay] フィールドはオプションです。指定しない場合はデフォルト値（1, 000 ms）が使用されます。

詳細
パラメータ
[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
aNameString から aNetworkName を設定しました。
OT_ERROR_INVALID_ARGS
aNameStrng は無効です（長すぎるか、UTF-8 エンコードに従っていません）。

マクロ

OT_CHANNEL_10_MASK

 OT_CHANNEL_10_MASK (1 << 10)

チャンネル 10。

OT_CHANNEL_11_MASK

 OT_CHANNEL_11_MASK (1 << 11)

チャンネル 11。

OT_CHANNEL_12_MASK

 OT_CHANNEL_12_MASK (1 << 12)

チャンネル 12。

OT_CHANNEL_13_MASK

 OT_CHANNEL_13_MASK (1 << 13)

チャンネル 13。

OT_CHANNEL_14_MASK

 OT_CHANNEL_14_MASK (1 << 14)

チャンネル 14

OT_CHANNEL_15_MASK

 OT_CHANNEL_15_MASK (1 << 15)

チャンネル 15。

OT_CHANNEL_16_MASK

 OT_CHANNEL_16_MASK (1 << 16)

チャンネル 16。

OT_CHANNEL_17_MASK

 OT_CHANNEL_17_MASK (1 << 17)

チャンネル 17。

OT_CHANNEL_18_MASK

 OT_CHANNEL_18_MASK (1 << 18)

チャンネル 18。

OT_CHANNEL_19_MASK

 OT_CHANNEL_19_MASK (1 << 19)

チャンネル 19。

OT_CHANNEL_1_MASK

 OT_CHANNEL_1_MASK (1 << 1)

チャネル 1。

OT_CHANNEL_20_MASK

 OT_CHANNEL_20_MASK (1 << 20)

チャンネル 20。

OT_CHANNEL_21_MASK

 OT_CHANNEL_21_MASK (1 << 21)

チャンネル 21。

OT_CHANNEL_22_MASK

 OT_CHANNEL_22_MASK (1 << 22)

チャンネル 22。

OT_CHANNEL_23_MASK

 OT_CHANNEL_23_MASK (1 << 23)

チャンネル 23。

OT_CHANNEL_24_MASK

 OT_CHANNEL_24_MASK (1 << 24)

チャンネル 24。

OT_CHANNEL_25_MASK

 OT_CHANNEL_25_MASK (1 << 25)

チャンネル 25。

OT_CHANNEL_26_MASK

 OT_CHANNEL_26_MASK (1 << 26)

チャンネル 26。

OT_CHANNEL_2_MASK

 OT_CHANNEL_2_MASK (1 << 2)

チャネル 2。

OT_CHANNEL_3_MASK

 OT_CHANNEL_3_MASK (1 << 3)

チャネル 3。

OT_CHANNEL_4_MASK

 OT_CHANNEL_4_MASK (1 << 4)

チャネル 4。

OT_CHANNEL_5_MASK

 OT_CHANNEL_5_MASK (1 << 5)

チャネル 5。

OT_CHANNEL_6_MASK

 OT_CHANNEL_6_MASK (1 << 6)

チャネル 6。

OT_CHANNEL_7_MASK

 OT_CHANNEL_7_MASK (1 << 7)

チャンネル 7

OT_CHANNEL_8_MASK

 OT_CHANNEL_8_MASK (1 << 8)

チャンネル 8。

OT_CHANNEL_9_MASK

 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

Thread ネットワーク キーのサイズ（バイト）

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 で入手できるソースコードに由来しています。 詳細について、またはドキュメントへの投稿については、リソースをご覧ください。