インスタンス
このモジュールには、OpenThread インスタンスを制御する関数が含まれています。
まとめ
Typedef |
|
---|---|
otChangedFlags
|
typedefuint32_t
この型は、変更された特定の状態/構成を示すビット フィールドを表します。 |
otInstance
|
typedefstruct otInstance
この構造は OpenThread インスタンス構造を表します。 |
otStateChangedCallback)(otChangedFlags aFlags, void *aContext)
|
typedefvoid(*
この関数ポインタは、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
の一部として渡されるフラグを定義します。
Typedef
otChangedFlags
uint32_t otChangedFlags
この型は、変更された特定の状態/構成を示すビット フィールドを表します。
OT_CHANGED_*
の定義を参照してください。
otStateChangedCallback
void(* otStateChangedCallback)(otChangedFlags aFlags, void *aContext)
この関数ポインタは、OpenThread 内の特定の構成や状態の変化を通知するために呼び出されます。
詳細 | |||||
---|---|---|---|---|---|
パラメータ |
|
関数
otGetRadioVersionString
const char * otGetRadioVersionString( otInstance *aInstance )
この関数は、OpenThread ラジオ バージョンの文字列を取得します。
詳細 | |||
---|---|---|---|
パラメータ |
|
||
戻り値 |
OpenThread ラジオ バージョンへのポインタ。
|
otGetVersionString
const char * otGetVersionString( void )
この関数は、OpenThread バージョン文字列を取得します。
詳細 | |
---|---|
戻り値 |
OpenThread バージョンへのポインタ。
|
otInstanceErasePersistentInfo
otError otInstanceErasePersistentInfo( otInstance *aInstance )
この関数は、不揮発性メモリに保存されているすべての OpenThread 永続情報(ネットワーク設定)を消去します。
デバイスが disabled
状態/ロールの場合にのみ、消去が成功します。
詳細 | |||||
---|---|---|---|---|---|
パラメータ |
|
||||
戻り値 |
|
otInstanceFactoryReset
void otInstanceFactoryReset( otInstance *aInstance )
不揮発性メモリに保存されているすべての設定を削除し、プラットフォームのリセットをトリガーします。
詳細 | |||
---|---|---|---|
パラメータ |
|
otInstanceFinalize
void otInstanceFinalize( otInstance *aInstance )
この関数は、OpenThread ライブラリを無効にします。
OpenThread が使用されなくなったときに、この関数を呼び出します。
詳細 | |||
---|---|---|---|
パラメータ |
|
otInstanceGetUptime
uint64_t otInstanceGetUptime( otInstance *aInstance )
この関数は、現在のインスタンスの稼働時間(ミリ秒単位)を返します。
この機能を使用するには、OPENTHREAD_CONFIG_UPTIME_ENABLE
を有効にする必要があります。
稼働時間は、OpenThread インスタンスが初期化されてからのミリ秒数で表されます。
詳細 | |||
---|---|---|---|
パラメータ |
|
||
戻り値 |
稼働時間(ミリ秒)。
|
otInstanceGetUptimeAsString
void otInstanceGetUptimeAsString( otInstance *aInstance, char *aBuffer, uint16_t aSize )
この関数は、現在のインスタンスの稼働時間を人間が読める文字列として返します。
この機能を使用するには、OPENTHREAD_CONFIG_UPTIME_ENABLE
を有効にする必要があります。
文字列は「
生成される文字列が aBuffer
(aSize
文字以内)に収まらない場合、文字列は切り捨てられますが、出力文字列は常に null で終了します。
詳細 | |||||||
---|---|---|---|---|---|---|---|
パラメータ |
|
otInstanceInit
otInstance * otInstanceInit( void *aInstanceBuffer, size_t *aInstanceBufferSize )
この関数は OpenThread ライブラリを初期化します。
この関数は OpenThread を初期化し、後続の OpenThread API 呼び出し用に準備します。この関数は、OpenThread の他の呼び出しの前に呼び出す必要があります。
この機能は、複数の OpenThread インスタンスのサポートが有効にされている場合にのみ使用できます。
詳細 | |||||
---|---|---|---|---|---|
パラメータ |
|
||||
戻り値 |
新しい OpenThread インスタンスへのポインタ。
|
otInstanceFinalize
otInstanceInitSingle
otInstance * otInstanceInitSingle( void )
この関数は、OpenThread ライブラリの静的単一インスタンスを初期化します。
この関数は OpenThread を初期化し、後続の OpenThread API 呼び出し用に準備します。この関数は、OpenThread の他の呼び出しの前に呼び出す必要があります。
この機能は、複数の OpenThread インスタンスのサポートが無効にされている場合にのみ使用できます。
詳細 | |
---|---|
戻り値 |
単一の OpenThread インスタンスへのポインタ。
|
otInstanceIsInitialized
bool otInstanceIsInitialized( otInstance *aInstance )
この関数は、インスタンスが有効/初期化されているかどうかを示します。
インスタンスは、otInstanceInitSingle()
(単一インスタンスの場合)または otInstanceInit()
(マルチインスタンスの場合)を使用して取得、初期化された場合に有効とみなされます。その後の otInstanceFinalize()
の呼び出しでは、インスタンスは初期化されていないと見なされます。
詳細 | |||
---|---|---|---|
パラメータ |
|
||
戻り値 |
指定されたインスタンスが有効な場合、または初期化されている場合は TRUE、そうでない場合は FALSE。
|
otInstanceReset
void otInstanceReset( otInstance *aInstance )
このメソッドは、プラットフォームのリセットをトリガーします。
リセット プロセスにより、OpenThread の状態/情報(揮発性メモリに格納されている)がすべて消去されます。otPlatformReset
は、不揮発性メモリに保存されている永続的な状態/情報を消去しないことに注意してください。
詳細 | |||
---|---|---|---|
パラメータ |
|
otInstanceResetRadioStack
void otInstanceResetRadioStack( otInstance *aInstance )
このメソッドは OpenThread 無線スタックの内部状態をリセットします。
コールバックと設定は保持されます。
この API はラジオビルド(OPENTHREAD_RADIO = 1
)でのみ使用できます。
詳細 | |||
---|---|---|---|
パラメータ |
|
otRemoveStateChangeCallback
void otRemoveStateChangeCallback( otInstance *aInstance, otStateChangedCallback aCallback, void *aContext )
この関数は、OpenThread 内で特定の構成または状態が変化したときを示すコールバックを削除します。
詳細 | |||||||
---|---|---|---|---|---|---|---|
パラメータ |
|
otSetStateChangedCallback
otError otSetStateChangedCallback( otInstance *aInstance, otStateChangedCallback aCallback, void *aContext )
この関数は、OpenThread 内で特定の構成または状態が変化したときを示すコールバックを登録します。
詳細 | |||||||
---|---|---|---|---|---|---|---|
パラメータ |
|
||||||
戻り値 |
|
マクロ
OT_UPTIME_STRING_SIZE
OT_UPTIME_STRING_SIZE 24
稼働時間を表す文字列表現の推奨サイズ。
リソース
OpenThread API リファレンスのトピックは、GitHub から入手できるソースコードから生成されます。詳細やドキュメントの作成方法については、リソースをご覧ください。