Befehlszeile

Dieses Modul enthält Funktionen, die die Ausführung des Thread-Stacks steuern.

Zusammenfassung

Typdef1
otCliOutputCallback)(void *aContext, const char *aFormat, va_list aArguments) Typdef
int(*
Der Zeiger wird aufgerufen, um über die Konsolenausgabe zu benachrichtigen.

Functions
otCliAppendResult(otError aError)
void
Schreiben Sie den Fehlercode in die CLI-Konsole.
otCliInit(otInstance *aInstance, otCliOutputCallback aCallback, void *aContext)
void
Initialisieren Sie das CLI-Modul.
otCliInputLine(char *aBuf)
void
Wird aufgerufen, um den Feed in eine Eingabezeile der Konsole einzufügen.
otCliOutputBytes(const uint8_t *aBytes, uint8_t aLength)
void
Schreiben Sie eine Reihe von Byte als Hexadezimalstring in die CLI-Konsole.
otCliOutputFormat(const char *aFmt, ...)
void
Schreiben Sie einen formatierten String in die Befehlszeile.
otCliPlatLogv(otLogLevel aLogLevel, otLogRegion aLogRegion, const char *aFormat, va_list aArgs)
void
Callback zum Schreiben des OpenThread-Logs in die Befehlszeile.
otCliSetUserCommands(const otCliCommand *aUserCommands, uint8_t aLength, void *aContext)
Legen Sie eine Nutzerbefehlstabelle fest.
otCliVendorSetUserCommands(void)
void
Callback, um das Hinzufügen von anbieterspezifischen Befehlen zur Nutzerbefehlstabelle zu ermöglichen.

Typdef1

otCliAusgabeCallback

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

Der Zeiger wird aufgerufen, um über die Konsolenausgabe zu benachrichtigen.

Details
Parameter
[out] aContext
Ein Mauszeiger für den Nutzerkontext.
[in] aFormat
Der Formatstring.
[in] aArguments
Die Argumente des Formatstrings.
Rückgabe
Anzahl der vom Callback geschriebenen Byte.

Functions

OTCliAnhängen

void otCliAppendResult(
  otError aError
)

Schreiben Sie den Fehlercode in die CLI-Konsole.

Wenn aError den Wert OT_ERROR_PENDING hat, wird nichts ausgegeben.

Details
Parameter
[in] aError
Fehlercodewert.

OTCliInit

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

Initialisieren Sie das CLI-Modul.

Details
Parameter
[in] aInstance
Die Struktur der OpenThread-Instanz.
[in] aCallback
Eine Callback-Methode, die zum Verarbeiten der Befehlszeile aufgerufen wird.
[in] aContext
Ein Mauszeiger für den Nutzerkontext.

Nicht festgelegt

void otCliInputLine(
  char *aBuf
)

Wird aufgerufen, um den Feed in eine Eingabezeile der Konsole einzufügen.

Details
Parameter
[in] aBuf
Ein Zeiger auf einen String mit Nullabschluss.

OTCliAusgabeBytes

void otCliOutputBytes(
  const uint8_t *aBytes,
  uint8_t aLength
)

Schreiben Sie eine Reihe von Byte als Hexadezimalstring in die CLI-Konsole.

Details
Parameter
[in] aBytes
Ein Hinweis auf Daten, die ausgegeben werden sollen.
[in] aLength
Länge: aBytes

Format

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

Schreiben Sie einen formatierten String in die Befehlszeile.

Details
Parameter
[in] aFmt
Ein Zeiger auf den Formatstring.
[in] ...
Eine übereinstimmende Liste von Argumenten.

Logo: otCliPlatLogv

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

Callback zum Schreiben des OpenThread-Logs in die Befehlszeile.

Details
Parameter
[in] aLogLevel
Die Logebene.
[in] aLogRegion
Die Logregion.
[in] aFormat
Ein Zeiger auf den Formatstring.
[in] aArgs
va_list entspricht aFormat.

OTCliSetUserCommands

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

Legen Sie eine Nutzerbefehlstabelle fest.

Details
Parameter
[in] aUserCommands
Ein Zeiger auf ein Array mit Nutzerbefehlen.
[in] aLength
Länge: aUserCommands
[in] aContext
An den Handler übergebener The-Kontext.
Rückgabewerte
OT_ERROR_NONE
Befehlstabelle mit Befehlen von aUserCommands wurde aktualisiert.
OT_ERROR_FAILED
Es wurde bereits die maximale Anzahl von Befehlseinträgen festgelegt.

OTCliVendorSetUserCommands

void otCliVendorSetUserCommands(
  void
)

Callback, um das Hinzufügen von anbieterspezifischen Befehlen zur Nutzerbefehlstabelle zu ermöglichen.

Verfügbar, wenn OPENTHREAD_CONFIG_CLI_VENDOR_COMMANDS_ENABLE aktiviert und OPENTHREAD_CONFIG_CLI_MAX_USER_CMD_ENTRIES größer als 1 ist.

Ressourcen

Die Themen der OpenThread API-Referenz stammen aus dem Quellcode, der auf GitHub verfügbar ist. Weitere Informationen oder als Ergänzung zu unserer Dokumentation finden Sie unter Ressourcen.