命令行界面

該模塊包括控制線程堆棧的執行的功能。

概要

類型定義
`otCliConsoleOutputCallback )(const char aBuf, uint16_t aBufLength, void aContext)`	類型定義 `int(*` 調用此函數指針以通知控制台輸出。

職能
`otCliAppendResult ( otError aError)`	`void` 將錯誤代碼寫入CLI控制台。
`otCliConsoleInit ( otInstance aInstance, otCliConsoleOutputCallback aCallback, void aContext)`	`void` 初始化CLI CONSOLE模塊。
`otCliConsoleInputLine (char *aBuf, uint16_t aBufLength)`	`void` 調用此方法以輸入控制台輸入行。
`otCliOutput (const char *aString, uint16_t aLength)`	`void` 將字符串寫入CLI控制台。
`otCliOutputBytes (const uint8_t *aBytes, uint8_t aLength)`	`void` 將多個字節作為十六進製字符串寫入CLI控制台。
`otCliOutputFormat (const char *aFmt, ...)`	`void` 將格式化的字符串寫入CLI控制台。
`otCliPlatLogLine ( otLogLevel aLogLevel, otLogRegion aLogRegion, const char *aLogLine)`	`void` 將OpenThread日誌寫入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` 設置用戶命令表。
`otCliUartInit ( otInstance *aInstance)`	`void` 初始化CLI UART模塊。

類型定義

otCliConsoleOutputCallback

int(* otCliConsoleOutputCallback)(const char *aBuf, uint16_t aBufLength, void *aContext)

調用此函數指針以通知控制台輸出。

細節

參量

`[in] aBuf`	指向帶有輸出的緩衝區的指針。
`[in] aBufLength`	存儲在緩衝區中的輸出數據的長度。
`[out] aContext`	用戶上下文指針。

退貨

回調處理的字節數。

職能

otCliAppendResult

void otCliAppendResult(
  otError aError
)

將錯誤代碼寫入CLI控制台。

如果aError為OT_ERROR_PENDING則不會輸出任何內容。

細節

參量

[in] aError

錯誤代碼值。

otCliConsoleInit

void otCliConsoleInit(
  otInstance *aInstance,
  otCliConsoleOutputCallback aCallback,
  void *aContext
)

初始化CLI CONSOLE模塊。

細節

參量

`[in] aInstance`	OpenThread實例結構。
`[in] aCallback`	回調方法，用於處理控制台輸出。
`[in] aContext`	用戶上下文指針。

otCliConsoleInputLine

void otCliConsoleInputLine(
  char *aBuf,
  uint16_t aBufLength
)

調用此方法以輸入控制台輸入行。

細節

參量

`[in] aBuf`	指向帶有輸入的緩衝區的指針。
`[in] aBufLength`	存儲在緩衝區中的輸入數據的長度。

otCliOutput

void otCliOutput(
  const char *aString,
  uint16_t aLength
)

將字符串寫入CLI控制台。

細節

參量

`[in] aString`	指向字符串的指針，該字符串不能為空值。
`[in] aLength`	字節數。

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] ...`	匹配的參數列表。

otCliPlatLogLine

void otCliPlatLogLine(
  otLogLevel aLogLevel,
  otLogRegion aLogRegion,
  const char *aLogLine
)

將OpenThread日誌寫入CLI控制台的功能。

細節

參量

`[in] aLogLevel`	日誌級別。
`[in] aLogRegion`	日誌區域。
`[in] aLogLine`	指向日誌行字符串的指針。

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`上下文傳遞給處理程序。

otCliUartInit

void otCliUartInit(
  otInstance *aInstance
)

初始化CLI UART模塊。

細節

參量

[in] aInstance

OpenThread實例結構。