命令行界面

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

总结

类型定义符
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)
设置用户命令表。
otCliVendorSetUserCommands(void)
void
允许向供应商命令表中添加供应商专用命令的回调。

类型定义符

otCliOutputCallback

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

系统会调用指针来通知有关控制台输出的信息。

详情
参数
[out] aContext
用户上下文指针。
[in] aFormat
格式字符串。
[in] aArguments
格式字符串参数。
返回
回调写入的字节数。

函数

otCli 附录结果

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
用户上下文指针。

OTC 输入行

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
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 上获取。 如需了解详情或为我们的文档贡献内容，请参阅资源。