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

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

まとめ

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)
ユーザー コマンド テーブルを設定します。
otCliVendorSetUserCommands(void)
void
ベンダー固有のコマンドをユーザー コマンド テーブルに追加するためのコールバック。

Typedef

otCliOutputCallback

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

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

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

関数

otCliAppendResult

void otCliAppendResult(
  otError aError
)

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

aError が OT_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
aFormat に一致する va_list

otCliSetUserCommands

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

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

詳細
パラメータ
[in] aUserCommands
ユーザー コマンドを含む配列へのポインタ。
[in] aLength
aUserCommands レングス。
[in] aContext
The ハンドラに渡されるコンテキスト。
戻り値
OT_ERROR_NONE
aUserCommands のコマンドでコマンド テーブルを更新しました。
OT_ERROR_FAILED
コマンドエントリ数がすでに上限に達しています。

otCliVendorSetUserCommands

void otCliVendorSetUserCommands(
  void
)

ベンダー固有のコマンドをユーザー コマンド テーブルに追加するためのコールバック。

OPENTHREAD_CONFIG_CLI_VENDOR_COMMANDS_ENABLE が有効で、OPENTHREAD_CONFIG_CLI_MAX_USER_CMD_ENTRIES が 1 より大きい場合に利用可能です。

リソース

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