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

コマンドライン インターフェース

このモジュールには、スレッド スタックの実行を制御する関数が含まれています。

概要

Typedef

otCliOutputCallback)(void *aContext, const char *aFormat, va_list aArguments) typedef
int(*
この関数ポインタは、コンソール出力について通知するために呼び出されます。

関数

otCliAppendResult(otError aError)
void
CLI コンソールにエラーコードを書き込みます。
otCliInit(otInstance *aInstance, otCliOutputCallback aCallback, void *aContext)
void
CLI モジュールを初期化します。
otCliInputLine(char *aBuf)
void
このメソッドは、コンソールの入力行にフィードを送るために使用されます。
otCliOutputBytes(const uint8_t *aBytes, uint8_t aLength)
void
CLI コンソールに指定したバイト数を 16 進数の文字列で書き込みます。
otCliOutputFormat(const char *aFmt, ...)
void
フォーマットされた文字列を CLI コンソールに書き込みます。
otCliPlatLogv(otLogLevel aLogLevel, otLogRegion aLogRegion, const char *aFormat, va_list aArgs)
void
OpenThread ログを CLI コンソールに書き込むためのコールバック。
otCliSetUserCommands(const otCliCommand *aUserCommands, uint8_t aLength, void *aContext)
void
ユーザー コマンド テーブルを設定します。

Typedef

otCliOutputCallback

int(* otCliOutputCallback)(void *aContext, const char *aFormat, va_list aArguments)

この関数ポインタは、コンソール出力について通知するために呼び出されます。

詳細
パラメータ
[out] aContext
ユーザー コンテキスト ポインタ。
[in] aFormat
形式設定文字列。
[in] aArguments
形式設定文字列の引数。
戻り値
コールバックによって書き込まれたバイト数。

関数

otCliAppendResult(OTCliAppendResult)

void otCliAppendResult(
  otError aError
)

CLI コンソールにエラーコードを書き込みます。

aErrorOT_ERROR_PENDING の場合、何も出力されません。

詳細
パラメータ
[in] aError
エラーコード値です。

OTCliInit

void otCliInit(
  otInstance *aInstance,
  otCliOutputCallback aCallback,
  void *aContext
)

CLI モジュールを初期化します。

詳細
パラメータ
[in] aInstance
OpenThread インスタンス構造。
[in] aCallback
CLI 出力を処理するために呼び出されるコールバック メソッド。
[in] aContext
ユーザー コンテキスト ポインタ。

otCliInputLine

void otCliInputLine(
  char *aBuf
)

このメソッドは、コンソールの入力行にフィードを送るために使用されます。

詳細
パラメータ
[in] aBuf
null で終わる文字列へのポインタ。

otCliOutputBytes

void otCliOutputBytes(
  const uint8_t *aBytes,
  uint8_t aLength
)

CLI コンソールに指定したバイト数を 16 進数の文字列で書き込みます。

詳細
パラメータ
[in] aBytes
出力するデータへのポインタ。
[in] aLength
長さは aBytes です。

otCliOutputFormat

void otCliOutputFormat(
  const char *aFmt,
  ...
)

フォーマットされた文字列を CLI コンソールに書き込みます。

詳細
パラメータ
[in] aFmt
形式設定文字列へのポインタ。
[in] ...
一致する引数のリスト。

otCliPlatLogv

void otCliPlatLogv(
  otLogLevel aLogLevel,
  otLogRegion aLogRegion,
  const char *aFormat,
  va_list aArgs
)

OpenThread ログを CLI コンソールに書き込むためのコールバック。

詳細
パラメータ
[in] aLogLevel
ログレベル。
[in] aLogRegion
ログのリージョン。
[in] aFormat
形式設定文字列へのポインタ。
[in] aArgs
va_list が aFormat と一致する。

otCliSetUserCommands(OTCliSetUserCommands)

void otCliSetUserCommands(
  const otCliCommand *aUserCommands,
  uint8_t aLength,
  void *aContext
)

ユーザー コマンド テーブルを設定します。

詳細
パラメータ
[in] aUserCommands
ユーザー コマンドを含む配列へのポインタ。
[in] aLength
長さは aUserCommands です。
[in] aContext
ハンドラに渡される The コンテキスト。

リソース

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