Интерфейс командной строки

Этот модуль включает функции, управляющие выполнением стека потоков.

Резюме

Определения типов

otCliOutputCallback )(void *aContext, const char *aFormat, va_list aArguments) определение типа
int(*
Этот указатель функции вызывается для уведомления о выводе консоли.

Функции

otCliAppendResult ( otError aError)
void
Запишите код ошибки в консоль CLI.
otCliInit ( otInstance *aInstance, otCliOutputCallback aCallback, void *aContext)
void
Инициализируйте модуль CLI.
otCliInputLine (char *aBuf)
void
Этот метод вызывается для ввода строки ввода консоли.
otCliOutputBytes (const uint8_t *aBytes, uint8_t aLength)
void
Запишите количество байтов в консоль CLI в виде шестнадцатеричной строки.
otCliOutputFormat (const char *aFmt, ...)
void
Запишите отформатированную строку в консоль CLI.
otCliPlatLogv ( otLogLevel aLogLevel, otLogRegion aLogRegion, const char *aFormat, va_list aArgs)
void
Обратный вызов для записи журнала OpenThread в консоль CLI.
otCliSetUserCommands (const otCliCommand *aUserCommands, uint8_t aLength, void *aContext)
void
Задайте таблицу пользовательских команд.

Определения типов

otCliOutputCallback

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

Этот указатель функции вызывается для уведомления о выводе консоли.

Подробности
Параметры
[out] aContext
Указатель пользовательского контекста.
[in] aFormat
Строка формата.
[in] aArguments
Аргументы строки формата.
Возвращает
Количество байтов, записанных обратным вызовом.

Функции

otCliAppendResult

void otCliAppendResult(
  otError aError
)

Запишите код ошибки в консоль CLI.

Если aError , ничего не будет OT_ERROR_PENDING .

Подробности
Параметры
[in] aError
Значение кода ошибки.

otCliInit

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

Инициализируйте модуль CLI.

Подробности
Параметры
[in] aInstance
Структура экземпляра OpenThread.
[in] aCallback
Метод обратного вызова, вызываемый для обработки выходных данных CLI.
[in] aContext
Указатель пользовательского контекста.

отклиинпутлине

void otCliInputLine(
  char *aBuf
)

Этот метод вызывается для ввода строки ввода консоли.

Подробности
Параметры
[in] aBuf
Указатель на строку с завершающим нулем.

otCliOutputBytes

void otCliOutputBytes(
  const uint8_t *aBytes,
  uint8_t aLength
)

Запишите количество байтов в консоль CLI в виде шестнадцатеричной строки.

Подробности
Параметры
[in] aBytes
Указатель на данные, которые должны быть напечатаны.
[in] aLength
длина aBytes .

otCliOutputFormat

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

Запишите отформатированную строку в консоль CLI.

Подробности
Параметры
[in] aFmt
Указатель на строку формата.
[in] ...
Соответствующий список аргументов.

отклиплатлогв

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

Обратный вызов для записи журнала OpenThread в консоль CLI.

Подробности
Параметры
[in] aLogLevel
Уровень журнала.
[in] aLogRegion
Область журнала.
[in] aFormat
Указатель на строку формата.
[in] aArgs
va_list, соответствующий aFormat.

отклисетусеркоммандс

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

Задайте таблицу пользовательских команд.

Подробности
Параметры
[in] aUserCommands
Указатель на массив с пользовательскими командами.
[in] aLength
Длина aUserCommands .
[in] aContext
The передается обработчику.

Ресурсы

Разделы справочника по API OpenThread взяты из исходного кода, доступного на GitHub . Чтобы получить дополнительную информацию или внести свой вклад в нашу документацию, обратитесь к разделу Ресурсы .