指令列介面

這個模組包含函式,用於控制 Thread 堆疊的執行。

摘要

類型

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 主控台。
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
設定使用者指令表格。

類型

otCliOutputCallback

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

系統會呼叫此函式指標來通知主控台輸出內容。

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

函式

otCliAttachResult

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

otCliOutputBytes

void otCliOutputBytes(
  const uint8_t *aBytes,
  uint8_t aLength
)

將多個位元組數寫入 CLI 主控台。

說明
參數
[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

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

設定使用者指令表格。

說明
參數
[in] aUserCommands
指向具有使用者指令的陣列。
[in] aLength
長度為 aUserCommands
[in] aContext
The 結構定義傳送至處理常式。

資源

OpenThread API 參照主題來自原始碼,位於 GitHub。 如需更多資訊或參閱我們的說明文件,請參閱資源