Interface de linha de comando

Este módulo inclui funções que controlam a execução da pilha Thread.

Resumo

Typedefs

otCliOutputCallback)(void *aContext, const char *aFormat, va_list aArguments) typedef
int(*
Ponteiro é chamado para notificar sobre a saída do Console.

Funções

otCliAppendResult(otError aError)
void
Escreva o código de erro no console da CLI.
otCliInit(otInstance *aInstance, otCliOutputCallback aCallback, void *aContext)
void
Inicialize o módulo da CLI.
otCliInputLine(char *aBuf)
void
É chamado para alimentar uma linha de entrada do console.
otCliOutputBytes(const uint8_t *aBytes, uint8_t aLength)
void
Grave alguns bytes no console da CLI como uma string hexadecimal.
otCliOutputFormat(const char *aFmt, ...)
void
Gravar uma string formatada no console da CLI.
otCliPlatLogv(otLogLevel aLogLevel, otLogRegion aLogRegion, const char *aFormat, va_list aArgs)
void
Callback para gravar o registro do OpenThread no console da CLI.
otCliSetUserCommands(const otCliCommand *aUserCommands, uint8_t aLength, void *aContext)
Defina uma tabela de comandos do usuário.
otCliVendorSetUserCommands(void)
void
Callback para permitir que comandos específicos do fornecedor sejam adicionados à tabela de comandos do usuário.

Typedefs

OtCliOutputCallback

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

Ponteiro é chamado para notificar sobre a saída do Console.

Detalhes
Parâmetros
[out] aContext
Um ponteiro de contexto do usuário.
[in] aFormat
A string de formato.
[in] aArguments
Os argumentos de string de formato.
Retorna
Número de bytes gravados pelo callback.

Funções

OcCliAppendResult

void otCliAppendResult(
  otError aError
)

Escreva o código de erro no console da CLI.

Se aError for OT_ERROR_PENDING, nada será gerado.

Detalhes
Parâmetros
[in] aError
Valor do código de erro.

OCLINI

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

Inicialize o módulo da CLI.

Detalhes
Parâmetros
[in] aInstance
A estrutura da instância do OpenThread.
[in] aCallback
Um método de retorno de chamada chamado para processar a saída da CLI.
[in] aContext
Um ponteiro de contexto do usuário.

linha de entrada de otCli

void otCliInputLine(
  char *aBuf
)

É chamado para alimentar uma linha de entrada do console.

Detalhes
Parâmetros
[in] aBuf
Um ponteiro para uma string com terminação nula.

OtCliOutputBytes

void otCliOutputBytes(
  const uint8_t *aBytes,
  uint8_t aLength
)

Grave alguns bytes no console da CLI como uma string hexadecimal.

Detalhes
Parâmetros
[in] aBytes
Um ponteiro para dados que precisam ser impressos.
[in] aLength
Comprimento: aBytes.

Formato de saída otCli

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

Gravar uma string formatada no console da CLI.

Detalhes
Parâmetros
[in] aFmt
Um ponteiro para a string de formato.
[in] ...
Uma lista correspondente de argumentos.

OtCliPlatLogv

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

Callback para gravar o registro do OpenThread no console da CLI.

Detalhes
Parâmetros
[in] aLogLevel
O nível de registro.
[in] aLogRegion
A região do registro.
[in] aFormat
Um ponteiro para a string de formato.
[in] aArgs
va_list correspondente a aFormat.

OCCSetUserCommands

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

Defina uma tabela de comandos do usuário.

Detalhes
Parâmetros
[in] aUserCommands
Um ponteiro para uma matriz com comandos do usuário.
[in] aLength
Comprimento: aUserCommands.
[in] aContext
O contexto The foi transmitido para o gerenciador.
Valores de retorno
OT_ERROR_NONE
A tabela de comandos com comandos de aUserCommands foi atualizada.
OT_ERROR_FAILED
O número máximo de entradas de comando já foi definido.

OtCliVendorSetUserCommands

void otCliVendorSetUserCommands(
  void
)

Callback para permitir que comandos específicos do fornecedor sejam adicionados à tabela de comandos do usuário.

Disponível quando OPENTHREAD_CONFIG_CLI_VENDOR_COMMANDS_ENABLE está ativado e OPENTHREAD_CONFIG_CLI_MAX_USER_CMD_ENTRIES é maior que 1.

Recursos

Os tópicos de referência da API OpenThread são originados do código-fonte, disponível no GitHub. Para mais informações ou para contribuir com nossa documentação, consulte Recursos.