Interfaz de línea de comandos

Este módulo incluye funciones que controlan la ejecución de la pila de Thread.

Resumen

Typedefs
otCliOutputCallback)(void *aContext, const char *aFormat, va_list aArguments)	typedef int(* Se llama al puntero para notificar un resultado de Console.

Funciones
otCliAppendResult(otError aError)	void Escribe el código de error en la consola de la CLI.
otCliInit(otInstance *aInstance, otCliOutputCallback aCallback, void *aContext)	void Inicializa el módulo de la CLI.
otCliInputLine(char *aBuf)	void Se llama para alimentar una línea de entrada de la consola.
otCliOutputBytes(const uint8_t *aBytes, uint8_t aLength)	void Escriba una cantidad de bytes en la consola de la CLI como una string hexadecimal.
otCliOutputFormat(const char *aFmt, ...)	void Escribe una string con formato en la consola de la CLI.
otCliPlatLogv(otLogLevel aLogLevel, otLogRegion aLogRegion, const char *aFormat, va_list aArgs)	void Es la devolución de llamada para escribir el registro de OpenThread en la consola de la CLI.
otCliSetUserCommands(const otCliCommand *aUserCommands, uint8_t aLength, void *aContext)	otError Establezca una tabla de comandos de usuario.
otCliVendorSetUserCommands(void)	void Es la devolución de llamada para permitir que se agreguen comandos específicos del proveedor a la tabla de comandos del usuario.

Typedefs

otCliOutputCallback

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

Se llama al puntero para notificar un resultado de Console.

Detalles
Parámetros	[out] aContext Un puntero de contexto del usuario. [in] aFormat La string de formato. [in] aArguments Los argumentos de la string de formato.
Qué muestra	Cantidad de bytes escritos por la devolución de llamada.

Funciones

otCliAdjuntarResult

void otCliAppendResult(
  otError aError
)

Escribe el código de error en la consola de la CLI.

Si el aError es OT_ERROR_PENDING, no se mostrará nada.

Detalles
Parámetros	[in] aError Valor del código de error.

oliCliInit

void otCliInit(
  otInstance *aInstance,
  otCliOutputCallback aCallback,
  void *aContext
)

Inicializa el módulo de la CLI.

Detalles
Parámetros	[in] aInstance Estructura de la instancia de OpenThread. [in] aCallback Un método de devolución de llamada llamado para procesar el resultado de la CLI. [in] aContext Un puntero de contexto del usuario.

Línea de entrada olítica

void otCliInputLine(
  char *aBuf
)

Se llama para alimentar una línea de entrada de la consola.

Detalles
Parámetros	[in] aBuf Un puntero para una string terminada en null.

otCliOutputBytes

void otCliOutputBytes(
  const uint8_t *aBytes,
  uint8_t aLength
)

Escriba una cantidad de bytes en la consola de la CLI como una string hexadecimal.

Detalles
Parámetros	[in] aBytes Un puntero para los datos que se deben imprimir. [in] aLength Longitud de aBytes.

formato de salida de destino

void otCliOutputFormat(
  const char *aFmt,
  ...
)

Escribe una string con formato en la consola de la CLI.

Detalles
Parámetros	[in] aFmt Un puntero para la string de formato. [in] ... Una lista de argumentos coincidente

otCliPlatLogv

void otCliPlatLogv(
  otLogLevel aLogLevel,
  otLogRegion aLogRegion,
  const char *aFormat,
  va_list aArgs
)

Es la devolución de llamada para escribir el registro de OpenThread en la consola de la CLI.

Detalles
Parámetros	[in] aLogLevel El nivel de registro. [in] aLogRegion La región de registro. [in] aFormat Un puntero para la string de formato. [in] aArgs Va_list coincide con aFormat.

otCliSetUserCommands

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

Establezca una tabla de comandos de usuario.

Detalles
Parámetros	[in] aUserCommands Un puntero para un array con comandos de usuario. [in] aLength Longitud de aUserCommands. [in] aContext Se pasó el contexto The al controlador.
Valores que se muestran	OT_ERROR_NONE Se actualizó correctamente la tabla de comandos con los comandos de aUserCommands. OT_ERROR_FAILED Ya se estableció la cantidad máxima de entradas de comandos.

otCliVendorSetUserCommands

void otCliVendorSetUserCommands(
  void
)

Es la devolución de llamada para permitir que se agreguen comandos específicos del proveedor a la tabla de comandos del usuario.

Disponible cuando se habilita OPENTHREAD_CONFIG_CLI_VENDOR_COMMANDS_ENABLE y OPENTHREAD_CONFIG_CLI_MAX_USER_CMD_ENTRIES es mayor que 1.

Recursos

Los temas de referencia de la API de OpenThread se originan a partir del código fuente, disponible en GitHub. Para obtener más información o colaborar con nuestra documentación, consulta la sección Recursos.