Giao diện dòng lệnh

Mô-đun này bao gồm các hàm kiểm soát quá trình thực thi ngăn xếp Thread.

Tóm tắt

Typedef
otCliOutputCallback)(void *aContext, const char *aFormat, va_list aArguments) typedef
int(*
Con trỏ được gọi để thông báo đầu ra của Bảng điều khiển.

Hàm
otCliAppendResult(otError aError)
void
Ghi mã lỗi vào bảng điều khiển CLI.
otCliInit(otInstance *aInstance, otCliOutputCallback aCallback, void *aContext)
void
Khởi động mô-đun CLI.
otCliInputLine(char *aBuf)
void
Được gọi để cung cấp dữ liệu trong dòng đầu vào của bảng điều khiển.
otCliOutputBytes(const uint8_t *aBytes, uint8_t aLength)
void
Ghi một số byte vào bảng điều khiển CLI dưới dạng một chuỗi hex.
otCliOutputFormat(const char *aFmt, ...)
void
Ghi chuỗi đã định dạng vào bảng điều khiển CLI.
otCliPlatLogv(otLogLevel aLogLevel, otLogRegion aLogRegion, const char *aFormat, va_list aArgs)
void
Lệnh gọi lại để ghi Nhật ký OpenThread vào bảng điều khiển CLI.
otCliSetUserCommands(const otCliCommand *aUserCommands, uint8_t aLength, void *aContext)
Đặt bảng lệnh cho người dùng.
otCliVendorSetUserCommands(void)
void
Lệnh gọi lại để cho phép thêm các lệnh dành riêng cho nhà cung cấp vào bảng lệnh của người dùng.

Typedef

Hàm otCliOutputCallback

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

Con trỏ được gọi để thông báo đầu ra của Bảng điều khiển.

Thông tin chi tiết
Thông số
[out] aContext
Con trỏ ngữ cảnh người dùng.
[in] aFormat
Chuỗi định dạng.
[in] aArguments
Đối số chuỗi định dạng.
Trả về
Số byte được lệnh gọi lại viết.

Hàm

kết quả otCliAppendResult

void otCliAppendResult(
  otError aError
)

Ghi mã lỗi vào bảng điều khiển CLI.

Nếu aError là OT_ERROR_PENDING thì sẽ không có kết quả nào.

Thông tin chi tiết
Thông số
[in] aError
Giá trị mã lỗi.

otCliInit

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

Khởi động mô-đun CLI.

Thông tin chi tiết
Thông số
[in] aInstance
Cấu trúc của phiên bản OpenThread.
[in] aCallback
Phương thức gọi lại được gọi để xử lý đầu ra CLI.
[in] aContext
Con trỏ ngữ cảnh người dùng.

otCliInputLine

void otCliInputLine(
  char *aBuf
)

Được gọi để cung cấp dữ liệu trong dòng đầu vào của bảng điều khiển.

Thông tin chi tiết
Thông số
[in] aBuf
Con trỏ trỏ tới một chuỗi có giá trị null.

Byte đầu ra otCli

void otCliOutputBytes(
  const uint8_t *aBytes,
  uint8_t aLength
)

Ghi một số byte vào bảng điều khiển CLI dưới dạng một chuỗi hex.

Thông tin chi tiết
Thông số
[in] aBytes
Con trỏ tới dữ liệu cần in.
[in] aLength
aBytes.

Định dạng tệp đầu ra

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

Ghi chuỗi đã định dạng vào bảng điều khiển CLI.

Thông tin chi tiết
Thông số
[in] aFmt
Con trỏ tới chuỗi định dạng.
[in] ...
Danh sách các đối số phù hợp.

otCliPlatLogv

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

Lệnh gọi lại để ghi Nhật ký OpenThread vào bảng điều khiển CLI.

Thông tin chi tiết
Thông số
[in] aLogLevel
Cấp độ nhật ký.
[in] aLogRegion
Vùng nhật ký.
[in] aFormat
Con trỏ tới chuỗi định dạng.
[in] aArgs
va_list phù hợp với aFormat.

Lệnh otCliSetUserCommands

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

Đặt bảng lệnh cho người dùng.

Thông tin chi tiết
Thông số
[in] aUserCommands
Con trỏ tới một mảng có lệnh của người dùng.
[in] aLength
aUserCommands.
[in] aContext
Đã chuyển ngữ cảnh The cho trình xử lý.
Giá trị trả về
OT_ERROR_NONE
Đã cập nhật thành công bảng lệnh với các lệnh từ aUserCommands.
OT_ERROR_FAILED
Đã thiết lập số mục nhập lệnh tối đa.

otClivendorSetUserCommands

void otCliVendorSetUserCommands(
  void
)

Lệnh gọi lại để cho phép thêm các lệnh dành riêng cho nhà cung cấp vào bảng lệnh của người dùng.

Có khi OPENTHREAD_CONFIG_CLI_VENDOR_COMMANDS_ENABLE được bật và OPENTHREAD_CONFIG_CLI_MAX_USER_CMD_ENTRIES lớn hơn 1.

Tài nguyên

Các chủ đề Tham chiếu API OpenThread bắt nguồn từ mã nguồn, có sẵn trên GitHub. Để biết thêm thông tin hoặc đóng góp cho tài liệu của chúng tôi, hãy tham khảo phần Tài nguyên.