Google 致力于为黑人社区推动种族平等。查看具体行动

命令行界面

此模块包含控制线程堆栈执行的函数。

摘要

类型定义符

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
可调用此方法,在控制台输入行中提供 Feed。
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
格式字符串参数。
返回值
由回调写入的字节数。

函数

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
)

可调用此方法,在控制台输入行中提供 Feed。

详情
参数
[in] aBuf
指向以 null 结尾的字符串的指针。

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
与 aFormat 匹配的 va_list。

otCliSetUserCommands

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

设置用户命令表。

详情
参数
[in] aUserCommands
指向具有用户命令的数组的指针。
[in] aLength
aUserCommands 长度。
[in] aContext
传递给处理程序的 The 上下文。

资源

OpenThread API 参考主题源自源代码,可在 GitHub 上找到。 如需了解详情或为我们的文档做贡献,请参阅资源