Interfejs wiersza poleceń

Ten moduł zawiera funkcje sterujące wykonywaniem stosu w wątku.

Podsumowanie

Definicja typów
otCliOutputCallback)(void *aContext, const char *aFormat, va_list aArguments) definicja typu
int(*
Wskaźnik jest wywoływany w celu powiadomienia o danych wyjściowych konsoli.

Functions
otCliAppendResult(otError aError)
void
Zapisz kod błędu w konsoli interfejsu wiersza poleceń.
otCliInit(otInstance *aInstance, otCliOutputCallback aCallback, void *aContext)
void
Zainicjuj moduł wiersza poleceń.
otCliInputLine(char *aBuf)
void
Wywołano kanał w wierszu danych wejściowych w konsoli.
otCliOutputBytes(const uint8_t *aBytes, uint8_t aLength)
void
Zapisz liczbę bajtów w konsoli wiersza poleceń jako ciąg szesnastkowy.
otCliOutputFormat(const char *aFmt, ...)
void
Zapisz sformatowany ciąg znaków w konsoli interfejsu wiersza poleceń.
otCliPlatLogv(otLogLevel aLogLevel, otLogRegion aLogRegion, const char *aFormat, va_list aArgs)
void
Wywołanie zwrotne, aby zapisać dziennik OpenThread do konsoli interfejsu wiersza poleceń.
otCliSetUserCommands(const otCliCommand *aUserCommands, uint8_t aLength, void *aContext)
Ustaw tabelę poleceń użytkownika.
otCliVendorSetUserCommands(void)
void
Wywołanie zwrotne, które pozwala na dodanie do tabeli poleceń użytkownika poleceń konkretnego dostawcy.

Definicja typów

Wywołanie zwrotne otCliWyniki

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

Wskaźnik jest wywoływany w celu powiadomienia o danych wyjściowych konsoli.

Szczegóły
Parametry
[out] aContext
Wskaźnik kontekstu użytkownika.
[in] aFormat
Ciąg znaków.
[in] aArguments
Argumenty ciągu formatu.
Zwroty
Liczba bajtów zapisanych przez wywołanie zwrotne.

Functions

otCliIncludeResult,

void otCliAppendResult(
  otError aError
)

Zapisz kod błędu w konsoli interfejsu wiersza poleceń.

Jeśli aError ma wartość OT_ERROR_PENDING, dane wyjściowe nie będą zwracane.

Szczegóły
Parametry
[in] aError
Wartość kodu błędu.

OTCliInit,

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

Zainicjuj moduł wiersza poleceń.

Szczegóły
Parametry
[in] aInstance
Struktura instancji OpenThread.
[in] aCallback
Metoda wywołania zwrotnego wywoływana w celu przetworzenia danych wyjściowych interfejsu wiersza poleceń.
[in] aContext
Wskaźnik kontekstu użytkownika.

OTCliInputLine

void otCliInputLine(
  char *aBuf
)

Wywołano kanał w wierszu danych wejściowych w konsoli.

Szczegóły
Parametry
[in] aBuf
Wskaźnik do ciągu znaków o wartości null.

OTClioutputBytes,

void otCliOutputBytes(
  const uint8_t *aBytes,
  uint8_t aLength
)

Zapisz liczbę bajtów w konsoli wiersza poleceń jako ciąg szesnastkowy.

Szczegóły
Parametry
[in] aBytes
Wskaźnik określający dane, które powinny zostać wydrukowane.
[in] aLength
Długość: aBytes.

Format wyjściowy otCli

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

Zapisz sformatowany ciąg znaków w konsoli interfejsu wiersza poleceń.

Szczegóły
Parametry
[in] aFmt
Wskaźnik do ciągu formatu.
[in] ...
Pasująca lista argumentów.

otCliPlatLogv,

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

Wywołanie zwrotne, aby zapisać dziennik OpenThread do konsoli interfejsu wiersza poleceń.

Szczegóły
Parametry
[in] aLogLevel
Poziom rejestrowania.
[in] aLogRegion
Region dziennika.
[in] aFormat
Wskaźnik do ciągu formatu.
[in] aArgs
va_list pasujący do formatu.

OTCliSetUserCommands

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

Ustaw tabelę poleceń użytkownika.

Szczegóły
Parametry
[in] aUserCommands
Wskaźnik do tablicy z poleceniami użytkownika.
[in] aLength
Długość: aUserCommands.
[in] aContext
Kontekst The został przekazany do modułu obsługi.
Wartości zwracane
OT_ERROR_NONE
Tabela poleceń została zaktualizowana o polecenia z pliku aUserCommands.
OT_ERROR_FAILED
Maksymalna liczba wpisów polecenia została już ustawiona.

OTCliVendorSetUserCommands

void otCliVendorSetUserCommands(
  void
)

Wywołanie zwrotne, które pozwala na dodanie do tabeli poleceń użytkownika poleceń konkretnego dostawcy.

Ta opcja jest dostępna, gdy włączona jest zasada OPENTHREAD_CONFIG_CLI_VENDOR_COMMANDS_ENABLE, a wartość OPENTHREAD_CONFIG_CLI_MAX_USER_CMD_ENTRIES jest większa niż 1.

Zasoby

Tematy referencyjne interfejsu API OpenThread pochodzą z kodu źródłowego dostępnego w GitHub. Aby dowiedzieć się więcej lub dodać treści do naszej dokumentacji, zapoznaj się z materiałami.