Interfaccia a riga di comando

Questo modulo include funzioni che controllano l'esecuzione dello stack Thread.

Riepilogo

Definizione di tipo

otCliOutputCallback)(void *aContext, const char *aFormat, va_list aArguments) typedef
int(*
Il puntatore viene chiamato per inviare notifiche sull'output della console.

Funzioni

otCliAppendResult(otError aError)
void
Scrivi il codice di errore nella console dell'interfaccia a riga di comando.
otCliInit(otInstance *aInstance, otCliOutputCallback aCallback, void *aContext)
void
Inizializzare il modulo dell'interfaccia a riga di comando.
otCliInputLine(char *aBuf)
void
Viene chiamato per inserire il feed in una riga di input della console.
otCliOutputBytes(const uint8_t *aBytes, uint8_t aLength)
void
Scrivi un numero di byte nella console dell'interfaccia a riga di comando come stringa esadecimale.
otCliOutputFormat(const char *aFmt, ...)
void
Scrivi la stringa formattata nella console dell'interfaccia a riga di comando.
otCliPlatLogv(otLogLevel aLogLevel, otLogRegion aLogRegion, const char *aFormat, va_list aArgs)
void
Callback per scrivere il log OpenThread nella console dell'interfaccia a riga di comando.
otCliSetUserCommands(const otCliCommand *aUserCommands, uint8_t aLength, void *aContext)
Imposta una tabella dei comandi utente.
otCliVendorSetUserCommands(void)
void
Callback per consentire l'aggiunta di comandi specifici del fornitore alla tabella dei comandi degli utenti.

Definizione di tipo

OtCliOutputChiamata

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

Il puntatore viene chiamato per inviare notifiche sull'output della console.

Dettagli
Parametri
[out] aContext
Un puntatore al contesto dell'utente.
[in] aFormat
La stringa di formato.
[in] aArguments
Gli argomenti della stringa di formato.
Restituisce
Numero di byte scritti dal callback.

Funzioni

Risultato otCliAppend

void otCliAppendResult(
  otError aError
)

Scrivi il codice di errore nella console dell'interfaccia a riga di comando.

Se il valore di aError è OT_ERROR_PENDING, non verrà generato nulla.

Dettagli
Parametri
[in] aError
Valore codice di errore.

CliInit

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

Inizializzare il modulo dell'interfaccia a riga di comando.

Dettagli
Parametri
[in] aInstance
Struttura dell'istanza OpenThread.
[in] aCallback
Un metodo di callback chiamato per elaborare l'output dell'interfaccia a riga di comando.
[in] aContext
Un puntatore al contesto dell'utente.

OtCliInputLine

void otCliInputLine(
  char *aBuf
)

Viene chiamato per inserire il feed in una riga di input della console.

Dettagli
Parametri
[in] aBuf
Un puntatore su una stringa con terminazione non valida.

OtCliOutputByte

void otCliOutputBytes(
  const uint8_t *aBytes,
  uint8_t aLength
)

Scrivi un numero di byte nella console dell'interfaccia a riga di comando come stringa esadecimale.

Dettagli
Parametri
[in] aBytes
Un puntatore sui dati da stampare.
[in] aLength
Lunghezza: aBytes.

Formato output otCli

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

Scrivi la stringa formattata nella console dell'interfaccia a riga di comando.

Dettagli
Parametri
[in] aFmt
Un puntatore sulla stringa di formato.
[in] ...
Un elenco di argomenti corrispondente.

Logo otCliPlatLogv

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

Callback per scrivere il log OpenThread nella console dell'interfaccia a riga di comando.

Dettagli
Parametri
[in] aLogLevel
Il livello di log.
[in] aLogRegion
La regione del log.
[in] aFormat
Un puntatore sulla stringa di formato.
[in] aArgs
va_list corrispondente a aFormat.

ComandiUtente otCliSet

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

Imposta una tabella dei comandi utente.

Dettagli
Parametri
[in] aUserCommands
Un puntatore su un array con comandi utente.
[in] aLength
Lunghezza: aUserCommands.
[in] aContext
The contesto trasmesso al gestore.
Valori restituiti
OT_ERROR_NONE
Tabella di comando aggiornata con i comandi di aUserCommands.
OT_ERROR_FAILED
È già stato impostato il numero massimo di voci di comando.

OtCliVendorSetUserCommands

void otCliVendorSetUserCommands(
  void
)

Callback per consentire l'aggiunta di comandi specifici del fornitore alla tabella dei comandi degli utenti.

Disponibile quando OPENTHREAD_CONFIG_CLI_VENDOR_COMMANDS_ENABLE è attivato e OPENTHREAD_CONFIG_CLI_MAX_USER_CMD_ENTRIES è maggiore di 1.

Risorse

Gli argomenti di riferimento per l'API OpenThread provengono dal codice sorgente, disponibile su GitHub. Per maggiori informazioni o per contribuire alla nostra documentazione, consulta Risorse.