Google は、黒人コミュニティのための人種的公平の促進に取り組んでいます。詳細をご覧ください。
コレクションでコンテンツを整理 必要に応じて、コンテンツの保存と分類を行います。

インスタンス

このモジュールには、OpenThread インスタンスを制御する関数が含まれています。

まとめ

列挙型

anonymous enum{
  OT_CHANGED_IP6_ADDRESS_ADDED = 1 << 0,
  OT_CHANGED_IP6_ADDRESS_REMOVED = 1 << 1,
  OT_CHANGED_THREAD_ROLE = 1 << 2,
  OT_CHANGED_THREAD_LL_ADDR = 1 << 3,
  OT_CHANGED_THREAD_ML_ADDR = 1 << 4,
  OT_CHANGED_THREAD_RLOC_ADDED = 1 << 5,
  OT_CHANGED_THREAD_RLOC_REMOVED = 1 << 6,
  OT_CHANGED_THREAD_PARTITION_ID = 1 << 7,
  OT_CHANGED_THREAD_KEY_SEQUENCE_COUNTER = 1 << 8,
  OT_CHANGED_THREAD_NETDATA = 1 << 9,
  OT_CHANGED_THREAD_CHILD_ADDED = 1 << 10,
  OT_CHANGED_THREAD_CHILD_REMOVED = 1 << 11,
  OT_CHANGED_IP6_MULTICAST_SUBSCRIBED = 1 << 12,
  OT_CHANGED_IP6_MULTICAST_UNSUBSCRIBED = 1 << 13,
  OT_CHANGED_THREAD_CHANNEL = 1 << 14,
  OT_CHANGED_THREAD_PANID = 1 << 15,
  OT_CHANGED_THREAD_NETWORK_NAME = 1 << 16,
  OT_CHANGED_THREAD_EXT_PANID = 1 << 17,
  OT_CHANGED_NETWORK_KEY = 1 << 18,
  OT_CHANGED_PSKC = 1 << 19,
  OT_CHANGED_SECURITY_POLICY = 1 << 20,
  OT_CHANGED_CHANNEL_MANAGER_NEW_CHANNEL = 1 << 21,
  OT_CHANGED_SUPPORTED_CHANNEL_MASK = 1 << 22,
  OT_CHANGED_COMMISSIONER_STATE = 1 << 23,
  OT_CHANGED_THREAD_NETIF_STATE = 1 << 24,
  OT_CHANGED_THREAD_BACKBONE_ROUTER_STATE = 1 << 25,
  OT_CHANGED_THREAD_BACKBONE_ROUTER_LOCAL = 1 << 26,
  OT_CHANGED_JOINER_STATE = 1 << 27,
  OT_CHANGED_ACTIVE_DATASET = 1 << 28,
  OT_CHANGED_PENDING_DATASET = 1 << 29,
  OT_CHANGED_NAT64_TRANSLATOR_STATE = 1 << 30
}
enum
この列挙型は、otStateChangedCallback の一部として渡されるフラグを定義します。

Typedef

otChangedFlags typedef
uint32_t
この型は、変更された特定の状態/構成を示すビット フィールドを表します。
otInstance typedef
struct otInstance
この構造は OpenThread インスタンス構造を表します。
otStateChangedCallback)(otChangedFlags aFlags, void *aContext) typedef
void(*
この関数ポインタは、OpenThread 内の特定の構成や状態の変化を通知するために呼び出されます。

関数

otGetRadioVersionString(otInstance *aInstance)
const char *
この関数は、OpenThread ラジオ バージョンの文字列を取得します。
otGetVersionString(void)
const char *
この関数は、OpenThread バージョン文字列を取得します。
otInstanceErasePersistentInfo(otInstance *aInstance)
この関数は、不揮発性メモリに保存されているすべての OpenThread 永続情報(ネットワーク設定)を消去します。
otInstanceFactoryReset(otInstance *aInstance)
void
不揮発性メモリに保存されているすべての設定を削除し、プラットフォームのリセットをトリガーします。
otInstanceFinalize(otInstance *aInstance)
void
この関数は、OpenThread ライブラリを無効にします。
otInstanceGetUptime(otInstance *aInstance)
uint64_t
この関数は、現在のインスタンスの稼働時間(ミリ秒単位)を返します。
otInstanceGetUptimeAsString(otInstance *aInstance, char *aBuffer, uint16_t aSize)
void
この関数は、現在のインスタンスの稼働時間を人間が読める文字列として返します。
otInstanceInit(void *aInstanceBuffer, size_t *aInstanceBufferSize)
この関数は OpenThread ライブラリを初期化します。
otInstanceInitSingle(void)
この関数は、OpenThread ライブラリの静的単一インスタンスを初期化します。
otInstanceIsInitialized(otInstance *aInstance)
bool
この関数は、インスタンスが有効/初期化されているかどうかを示します。
otInstanceReset(otInstance *aInstance)
void
このメソッドは、プラットフォームのリセットをトリガーします。
otInstanceResetRadioStack(otInstance *aInstance)
void
このメソッドは OpenThread 無線スタックの内部状態をリセットします。
otRemoveStateChangeCallback(otInstance *aInstance, otStateChangedCallback aCallback, void *aContext)
void
この関数は、OpenThread 内で特定の構成または状態が変化したときを示すコールバックを削除します。
otSetStateChangedCallback(otInstance *aInstance, otStateChangedCallback aCallback, void *aContext)
この関数は、OpenThread 内で特定の構成または状態が変化したときを示すコールバックを登録します。

列挙型

匿名列挙型

 anonymous enum

この列挙型は、otStateChangedCallback の一部として渡されるフラグを定義します。

プロパティ
OT_CHANGED_ACTIVE_DATASET

アクティブな運用データセットが変更されました。

OT_CHANGED_CHANNEL_MANAGER_NEW_CHANNEL

チャンネル マネージャーの新しい保留中の Thread チャンネルが変更されました。

OT_CHANGED_COMMISSIONER_STATE

コミッター状態が変更されました。

OT_CHANGED_IP6_ADDRESS_ADDED

IPv6 アドレスが追加されました。

OT_CHANGED_IP6_ADDRESS_REMOVED

IPv6 アドレスが削除されました。

OT_CHANGED_IP6_MULTICAST_SUBSCRIBED

IPv6 マルチキャスト アドレスに登録されています。

OT_CHANGED_IP6_MULTICAST_UNSUBSCRIBED

IPv6 マルチキャスト アドレスから登録解除しました。

OT_CHANGED_JOINER_STATE

ジョイナーの状態が変更されました。

OT_CHANGED_NAT64_TRANSLATOR_STATE

NAT64 トランスレータの状態が変更されました。

OT_CHANGED_NETWORK_KEY

ネットワーク キーが変更されました。

OT_CHANGED_PENDING_DATASET

保留中の運用データセットが変更されました。

OT_CHANGED_PSKC

PSKc が変更されました。

OT_CHANGED_SECURITY_POLICY

セキュリティ ポリシーを変更しました。

OT_CHANGED_SUPPORTED_CHANNEL_MASK

サポートされているチャンネル マスクが変更されました。

OT_CHANGED_THREAD_BACKBONE_ROUTER_LOCAL

ローカル バックボーン ルーターの構成が変更されました。

OT_CHANGED_THREAD_BACKBONE_ROUTER_STATE

バックボーン ルーターの状態が変更されました。

OT_CHANGED_THREAD_CHANNEL

スレッド ネットワーク チャンネルが変更されました。

OT_CHANGED_THREAD_CHILD_ADDED

お子様を追加しました。

OT_CHANGED_THREAD_CHILD_REMOVED

お子様を削除しました。

OT_CHANGED_THREAD_EXT_PANID

Thread ネットワーク拡張 PAN ID が変更されました。

OT_CHANGED_THREAD_KEY_SEQUENCE_COUNTER

スレッドキー シーケンスが変更されました。

OT_CHANGED_THREAD_LL_ADDR

リンクローカル アドレスが変更されました。

OT_CHANGED_THREAD_ML_ADDR

メッシュ ローカル アドレスが変更されました。

OT_CHANGED_THREAD_NETDATA

Thread ネットワーク データが変更されました。

OT_CHANGED_THREAD_NETIF_STATE

スレッド ネットワーク インターフェースの状態が変更されました。

OT_CHANGED_THREAD_NETWORK_NAME

スレッド ネットワーク名が変更されました。

OT_CHANGED_THREAD_PANID

スレッド ネットワークの PAN ID が変更されました。

OT_CHANGED_THREAD_PARTITION_ID

パーティション ID が変更されました。

OT_CHANGED_THREAD_RLOC_ADDED

RLOC が追加されました。

OT_CHANGED_THREAD_RLOC_REMOVED

RLOC が削除されました。

OT_CHANGED_THREAD_ROLE

ロール(無効、切断、子、ルーター、リーダー)が変更されました。

Typedef

otChangedFlags

uint32_t otChangedFlags

この型は、変更された特定の状態/構成を示すビット フィールドを表します。

OT_CHANGED_* の定義を参照してください。

otInstance

struct otInstance otInstance

この構造は OpenThread インスタンス構造を表します。

otStateChangedCallback

void(* otStateChangedCallback)(otChangedFlags aFlags, void *aContext)

この関数ポインタは、OpenThread 内の特定の構成や状態の変化を通知するために呼び出されます。

詳細
パラメータ
[in] aFlags
変更された特定の状態を示すビット フィールド。OT_CHANGED_* の定義を参照してください。
[in] aContext
アプリケーション固有のコンテキストへのポインタ。

関数

otGetRadioVersionString

const char * otGetRadioVersionString(
  otInstance *aInstance
)

この関数は、OpenThread ラジオ バージョンの文字列を取得します。

詳細
パラメータ
[in] aInstance
OpenThread インスタンスへのポインタ。
戻り値
OpenThread ラジオ バージョンへのポインタ。

otGetVersionString

const char * otGetVersionString(
  void
)

この関数は、OpenThread バージョン文字列を取得します。

詳細
戻り値
OpenThread バージョンへのポインタ。

otInstanceErasePersistentInfo

otError otInstanceErasePersistentInfo(
  otInstance *aInstance
)

この関数は、不揮発性メモリに保存されているすべての OpenThread 永続情報(ネットワーク設定)を消去します。

デバイスが disabled 状態/ロールの場合にのみ、消去が成功します。

詳細
パラメータ
[in] aInstance
OpenThread インスタンスへのポインタ。
戻り値
OT_ERROR_NONE
すべての永続情報(または状態)が正常に消去されました。
OT_ERROR_INVALID_STATE
デバイスは disabled 状態/ロールではありません。

otInstanceFactoryReset

void otInstanceFactoryReset(
  otInstance *aInstance
)

不揮発性メモリに保存されているすべての設定を削除し、プラットフォームのリセットをトリガーします。

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

otInstanceFinalize

void otInstanceFinalize(
  otInstance *aInstance
)

この関数は、OpenThread ライブラリを無効にします。

OpenThread が使用されなくなったときに、この関数を呼び出します。

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

otInstanceGetUptime

uint64_t otInstanceGetUptime(
  otInstance *aInstance
)

この関数は、現在のインスタンスの稼働時間(ミリ秒単位)を返します。

この機能を使用するには、OPENTHREAD_CONFIG_UPTIME_ENABLE を有効にする必要があります。

稼働時間は、OpenThread インスタンスが初期化されてからのミリ秒数で表されます。

詳細
パラメータ
[in] aInstance
OpenThread インスタンスへのポインタ。
戻り値
稼働時間(ミリ秒)。

otInstanceGetUptimeAsString

void otInstanceGetUptimeAsString(
  otInstance *aInstance,
  char *aBuffer,
  uint16_t aSize
)

この関数は、現在のインスタンスの稼働時間を人間が読める文字列として返します。

この機能を使用するには、OPENTHREAD_CONFIG_UPTIME_ENABLE を有効にする必要があります。

文字列は「::の形式をとり、時間、分、秒、ミリ秒(稼働時間が 1 日未満の場合)または

d.: :(1 日以上の場合)。

生成される文字列が aBufferaSize 文字以内)に収まらない場合、文字列は切り捨てられますが、出力文字列は常に null で終了します。

詳細
パラメータ
[in] aInstance
OpenThread インスタンスへのポインタ。
[out] aBuffer
文字列を出力する文字配列へのポインタ。
[in] aSize
aBuffer のサイズ(バイト単位)。OT_UPTIME_STRING_SIZE を使用することをおすすめします。

otInstanceInit

otInstance * otInstanceInit(
  void *aInstanceBuffer,
  size_t *aInstanceBufferSize
)

この関数は OpenThread ライブラリを初期化します。

この関数は OpenThread を初期化し、後続の OpenThread API 呼び出し用に準備します。この関数は、OpenThread の他の呼び出しの前に呼び出す必要があります。

この機能は、複数の OpenThread インスタンスのサポートが有効にされている場合にのみ使用できます。

詳細
パラメータ
[in] aInstanceBuffer
otInstance 構造の割り当てに使用する OpenThread のバッファ。
[in,out] aInstanceBufferSize
入力時に、InstanceInstanceBuffer のサイズ。出力時に、otInstance に十分なスペースがない場合、otInstance に必要なバイト数。
戻り値
新しい OpenThread インスタンスへのポインタ。
関連情報:
otInstanceFinalize

otInstanceInitSingle

otInstance * otInstanceInitSingle(
  void
)

この関数は、OpenThread ライブラリの静的単一インスタンスを初期化します。

この関数は OpenThread を初期化し、後続の OpenThread API 呼び出し用に準備します。この関数は、OpenThread の他の呼び出しの前に呼び出す必要があります。

この機能は、複数の OpenThread インスタンスのサポートが無効にされている場合にのみ使用できます。

詳細
戻り値
単一の OpenThread インスタンスへのポインタ。

otInstanceIsInitialized

bool otInstanceIsInitialized(
  otInstance *aInstance
)

この関数は、インスタンスが有効/初期化されているかどうかを示します。

インスタンスは、otInstanceInitSingle()(単一インスタンスの場合)または otInstanceInit()(マルチインスタンスの場合)を使用して取得、初期化された場合に有効とみなされます。その後の otInstanceFinalize() の呼び出しでは、インスタンスは初期化されていないと見なされます。

詳細
パラメータ
[in] aInstance
OpenThread インスタンスへのポインタ。
戻り値
指定されたインスタンスが有効な場合、または初期化されている場合は TRUE、そうでない場合は FALSE。

otInstanceReset

void otInstanceReset(
  otInstance *aInstance
)

このメソッドは、プラットフォームのリセットをトリガーします。

リセット プロセスにより、OpenThread の状態/情報(揮発性メモリに格納されている)がすべて消去されます。otPlatformReset は、不揮発性メモリに保存されている永続的な状態/情報を消去しないことに注意してください。

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

otInstanceResetRadioStack

void otInstanceResetRadioStack(
  otInstance *aInstance
)

このメソッドは OpenThread 無線スタックの内部状態をリセットします。

コールバックと設定は保持されます。

この API はラジオビルド(OPENTHREAD_RADIO = 1)でのみ使用できます。

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

otRemoveStateChangeCallback

void otRemoveStateChangeCallback(
  otInstance *aInstance,
  otStateChangedCallback aCallback,
  void *aContext
)

この関数は、OpenThread 内で特定の構成または状態が変化したときを示すコールバックを削除します。

詳細
パラメータ
[in] aInstance
OpenThread インスタンスへのポインタ。
[in] aCallback
特定の構成または状態の変化で呼び出される関数へのポインタ。
[in] aContext
アプリケーション固有のコンテキストへのポインタ。

otSetStateChangedCallback

otError otSetStateChangedCallback(
  otInstance *aInstance,
  otStateChangedCallback aCallback,
  void *aContext
)

この関数は、OpenThread 内で特定の構成または状態が変化したときを示すコールバックを登録します。

詳細
パラメータ
[in] aInstance
OpenThread インスタンスへのポインタ。
[in] aCallback
特定の構成または状態の変化で呼び出される関数へのポインタ。
[in] aContext
アプリケーション固有のコンテキストへのポインタ。
戻り値
OT_ERROR_NONE
コールバックの一覧にコールバックを追加しました。
OT_ERROR_ALREADY
このコールバックはすでに登録されています。
OT_ERROR_NO_BUFS
リソースの制約により、コールバックを追加できませんでした。

マクロ

OT_UPTIME_STRING_SIZE

 OT_UPTIME_STRING_SIZE 24

稼働時間を表す文字列表現の推奨サイズ。

リソース

OpenThread API リファレンスのトピックは、GitHub から入手できるソースコードから生成されます。詳細やドキュメントの作成方法については、リソースをご覧ください。