این صفحه به‌وسیله ‏Cloud Translation API‏ ترجمه شده است.

رابط خط فرمان

این ماژول شامل توابعی است که اجرای پشته Thread را کنترل می کند.

خلاصه

Typedefs
`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` بازگشت به تماس برای اجازه دادن به دستورات خاص فروشنده به جدول فرمان کاربر اضافه شود.

Typedefs

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`	یک نشانگر زمینه کاربر.

otCliInputLine

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] ...`	فهرست منطبق از آرگومان ها.

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 مطابق با فرمت.

otCliSetUserCommands

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 سرچشمه می گیرند. برای اطلاعات بیشتر، یا مشارکت در اسناد ما، به منابع مراجعه کنید.