指令列介面

這個模組包含可控制 Thread 堆疊執行作業的函式。

摘要

Typedefs
otCliOutputCallback)(void *aContext, const char *aFormat, va_list aArguments) typedef
int(*
系統會呼叫 Pointer 來通知主控台的輸出內容。

執行作業
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
以十六進位字串的形式，將位元組數寫入的主控台主控台。
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
回呼，允許將供應商專屬指令加進使用者指令資料表。

Typedefs

otCliOutputCallback

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

系統會呼叫 Pointer 來通知主控台的輸出內容。

詳細說明
參數
[out] aContext
使用者情境指標。
[in] aFormat
格式字串。
[in] aArguments
格式字串引數。
傳回
回呼寫入的位元組數。

執行作業

otCliAttachResult

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
指向空值終止字串的指標。

otCliOutputBytes

void otCliOutputBytes(
  const uint8_t *aBytes,
  uint8_t aLength
)

以十六進位字串的形式，將位元組數寫入的主控台主控台。

詳細說明
參數
[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
符合 ava 格式的 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 取得。如需更多資訊或為說明文件貢獻心力，請參閱資源。