Befehlszeile

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

Zusammenfassung

Typdefekt

otCliOutputCallback)(void *aContext, const char *aFormat, va_list aArguments) typedef
int(*
Dieser Funktionszeiger wird aufgerufen, um über die Konsolenausgabe zu informieren.

Funktionen

otCliAppendResult(otError aError)
void
Schreiben Sie Fehlercode in die Befehlszeilenkonsole.
otCliInit(otInstance *aInstance, otCliOutputCallback aCallback, void *aContext)
void
Initialisieren Sie das Befehlszeilenmodul.
otCliInputLine(char *aBuf)
void
Diese Methode wird als Feed in einer Konsolen-Eingabezeile aufgerufen.
otCliOutputBytes(const uint8_t *aBytes, uint8_t aLength)
void
Schreiben Sie eine Anzahl von Byte als Hexadezimalstring in die Befehlszeilenkonsole.
otCliOutputFormat(const char *aFmt, ...)
void
Formatierten String in die Befehlszeilenkonsole schreiben
otCliPlatLogv(otLogLevel aLogLevel, otLogRegion aLogRegion, const char *aFormat, va_list aArgs)
void
Callback, um das OpenThread-Log in die Befehlszeilenkonsole zu schreiben
otCliSetUserCommands(const otCliCommand *aUserCommands, uint8_t aLength, void *aContext)
void
Legen Sie eine Nutzerbefehlstabelle fest.

Typdefekt

otCliOutputCallback

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

Dieser Funktionszeiger wird aufgerufen, um über die Konsolenausgabe zu informieren.

Details
Parameter
[out] aContext
Ein Nutzerkontext-Zeiger.
[in] aFormat
Der Formatstring.
[in] aArguments
Die Formatstringargumente.
Rückgabe
Anzahl der vom Callback geschriebenen Byte.

Funktionen

otCliAppendResult

void otCliAppendResult(
  otError aError
)

Schreiben Sie Fehlercode in die Befehlszeilenkonsole.

Wenn aError auf OT_ERROR_PENDING gesetzt ist, wird nichts ausgegeben.

Details
Parameter
[in] aError
Fehlercodewert.

otCliInit

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

Initialisieren Sie das Befehlszeilenmodul.

Details
Parameter
[in] aInstance
Die OpenThread-Instanzstruktur.
[in] aCallback
Eine Callback-Methode, die zur Verarbeitung der Befehlszeilenausgabe aufgerufen wird.
[in] aContext
Ein Nutzerkontext-Zeiger.

otCliInputLine

void otCliInputLine(
  char *aBuf
)

Diese Methode wird als Feed in einer Konsolen-Eingabezeile aufgerufen.

Details
Parameter
[in] aBuf
Ein Zeiger auf einen String mit Null-Beendigung.

otCliOutputBytes

void otCliOutputBytes(
  const uint8_t *aBytes,
  uint8_t aLength
)

Schreiben Sie eine Anzahl von Byte als Hexadezimalstring in die Befehlszeilenkonsole.

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

otCliOutputFormat

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

Formatierten String in die Befehlszeilenkonsole schreiben

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

otCliPlatLogv

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

Callback, um das OpenThread-Log in die Befehlszeilenkonsole zu schreiben

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

otCliSetUserCommands

void 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.

Ressourcen

Die OpenThread API-Referenzthemen stammen aus dem Quellcode, der auf GitHub verfügbar ist. Weitere Informationen und einen Beitrag zu unserer Dokumentation finden Sie unter Ressourcen.