Antarmuka Command Line

Modul ini mencakup fungsi yang mengontrol eksekusi stack Thread.

Ringkasan

Typedef
otCliOutputCallback)(void *aContext, const char *aFormat, va_list aArguments) typedef
int(*
Pointer dipanggil untuk memberi tahu tentang output Console.

Fungsi
otCliAppendResult(otError aError)
void
Menulis kode error ke konsol CLI.
otCliInit(otInstance *aInstance, otCliOutputCallback aCallback, void *aContext)
void
Melakukan inisialisasi modul CLI.
otCliInputLine(char *aBuf)
void
Dipanggil untuk memasukkan feed dalam baris input konsol.
otCliOutputBytes(const uint8_t *aBytes, uint8_t aLength)
void
Tulis sejumlah byte ke konsol CLI sebagai string hex.
otCliOutputFormat(const char *aFmt, ...)
void
Tulis string berformat ke konsol CLI.
otCliPlatLogv(otLogLevel aLogLevel, otLogRegion aLogRegion, const char *aFormat, va_list aArgs)
void
Callback untuk menulis Log OpenThread ke konsol CLI.
otCliSetUserCommands(const otCliCommand *aUserCommands, uint8_t aLength, void *aContext)
Menetapkan tabel perintah pengguna.
otCliVendorSetUserCommands(void)
void
Callback untuk memungkinkan perintah khusus vendor ditambahkan ke tabel perintah pengguna.

Typedef

OTCliOutputCallback

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

Pointer dipanggil untuk memberi tahu tentang output Console.

Detail
Parameter
[out] aContext
Pointer konteks pengguna.
[in] aFormat
String format.
[in] aArguments
Argumen string format.
Pengembalian
Jumlah byte yang ditulis oleh callback.

Fungsi

OTCliAddResult

void otCliAppendResult(
  otError aError
)

Menulis kode error ke konsol CLI.

Jika aError adalah OT_ERROR_PENDING, tidak ada yang akan dihasilkan.

Detail
Parameter
[in] aError
Nilai kode error.

OTCliInit

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

Melakukan inisialisasi modul CLI.

Detail
Parameter
[in] aInstance
Struktur instance OpenThread.
[in] aCallback
Metode callback yang dipanggil untuk memproses output CLI.
[in] aContext
Pointer konteks pengguna.

OTCliInputLine

void otCliInputLine(
  char *aBuf
)

Dipanggil untuk memasukkan feed dalam baris input konsol.

Detail
Parameter
[in] aBuf
Pointer ke string yang dihentikan null.

OTCliOutputByte

void otCliOutputBytes(
  const uint8_t *aBytes,
  uint8_t aLength
)

Tulis sejumlah byte ke konsol CLI sebagai string hex.

Detail
Parameter
[in] aBytes
Pointer ke data yang harus dicetak.
[in] aLength
Panjang aBytes.

OTCliOutputFormat

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

Tulis string berformat ke konsol CLI.

Detail
Parameter
[in] aFmt
Pointer ke string format.
[in] ...
Daftar argumen yang cocok.

OTCliPlatLogv

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

Callback untuk menulis Log OpenThread ke konsol CLI.

Detail
Parameter
[in] aLogLevel
Level log.
[in] aLogRegion
Region log.
[in] aFormat
Pointer ke string format.
[in] aArgs
va_list yang cocok dengan aFormat.

OTCliSetUserCommands

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

Menetapkan tabel perintah pengguna.

Detail
Parameter
[in] aUserCommands
Pointer ke array dengan perintah pengguna.
[in] aLength
Panjang aUserCommands.
[in] aContext
Konteks The diteruskan ke pengendali.
Nilai yang Ditampilkan
OT_ERROR_NONE
Tabel perintah berhasil diperbarui dengan perintah dari aUserCommands.
OT_ERROR_FAILED
Jumlah maksimum entri perintah telah ditetapkan.

OTCliVendorSetUserCommands

void otCliVendorSetUserCommands(
  void
)

Callback untuk memungkinkan perintah khusus vendor ditambahkan ke tabel perintah pengguna.

Tersedia jika OPENTHREAD_CONFIG_CLI_VENDOR_COMMANDS_ENABLE diaktifkan dan OPENTHREAD_CONFIG_CLI_MAX_USER_CMD_ENTRIES lebih besar dari 1.

Resource

Topik Referensi OpenThread API berasal dari kode sumber, yang tersedia di GitHub. Untuk informasi selengkapnya, atau untuk berkontribusi pada dokumentasi kami, lihat Referensi.