หน้านี้ได้รับการแปลโดย Cloud Translation API

อินเทอร์เฟซบรรทัดคําสั่ง

โมดูลนี้ประกอบด้วยฟังก์ชันที่ควบคุมการดําเนินการของเธรด

สรุป

ประเภทคําสั่ง
`otCliOutputCallback)(void aContext, const char aFormat, va_list aArguments)`	Typedef `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)`	`otError` ตั้งค่าตารางคําสั่งของผู้ใช้
`otCliVendorSetUserCommands(void)`	`void` โค้ดกลับเพื่ออนุญาตให้เพิ่มคําสั่งที่เจาะจงผู้ให้บริการลงในตารางคําสั่งของผู้ใช้

ประเภทคําสั่ง

otCliOutputCallback

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

โดยระบบจะเรียกใช้ตัวชี้เพื่อแจ้งเกี่ยวกับเอาต์พุตคอนโซล

รายละเอียด

พารามิเตอร์

`[out] aContext`	ตัวชี้บริบทผู้ใช้
`[in] aFormat`	สตริงรูปแบบ
`[in] aArguments`	อาร์กิวเมนต์สตริงรูปแบบ

การส่งคืน

จํานวนไบต์ที่เขียนโดยการเรียกกลับ

ฟังก์ชัน

ผลของ OCC

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`

รูปแบบเอาต์พุตของ OtCli

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

เขียนสตริงที่จัดรูปแบบแล้วในคอนโซล CLI

รายละเอียด

พารามิเตอร์

`[in] aFmt`	ตัวชี้ไปยังสตริงรูปแบบ
`[in] ...`	รายการอาร์กิวเมนต์ที่ตรงกัน

OTCliPlatLogv

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.

OTCliSetUserCommand

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

ตั้งค่าตารางคําสั่งของผู้ใช้

รายละเอียด

พารามิเตอร์

`[in] aUserCommands`	ตัวชี้ไปยังอาร์เรย์ที่มีคําสั่งของผู้ใช้
`[in] aLength`	ความยาว `aUserCommands`
`[in] aContext`	ส่งต่อบริบท `The` รายการไปยังเครื่องจัดการแล้ว

แสดงผลค่า

`OT_ERROR_NONE`	อัปเดตตารางคําสั่งด้วยคําสั่งจาก `aUserCommands` เรียบร้อยแล้ว
`OT_ERROR_FAILED`	ตั้งค่ารายการคําสั่งถึงจํานวนสูงสุดแล้ว

OTCliVendorSetUserCommands

void otCliVendorSetUserCommands(
  void
)

โค้ดกลับเพื่ออนุญาตให้เพิ่มคําสั่งที่เจาะจงผู้ให้บริการลงในตารางคําสั่งของผู้ใช้

ใช้ได้เมื่อเปิดใช้ OPENTHREAD_CONFIG_CLI_VENDOR_COMMANDS_ENABLE และ OPENTHREAD_CONFIG_CLI_MAX_USER_CMD_ENTRIES มากกว่า 1

แหล่งข้อมูล

หัวข้ออ้างอิง OpenThread API มาจากซอร์สโค้ด ซึ่งพร้อมใช้งานใน GitHub ดูข้อมูลเพิ่มเติมหรือมีส่วนร่วมในเอกสารประกอบได้ที่แหล่งข้อมูล