تمت ترجمة هذه الصفحة بواسطة 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` رد الاتصال للسماح بإضافة أوامر خاصة بالمورّد إلى جدول أوامر المستخدم.

أنواع المحددات

OotCCallCallback

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

يتم استدعاء المؤشر لإبلاغه بمخرجات وحدة التحكّم.

التفاصيل

المَعلمات

`[out] aContext`	مؤشر سياق المستخدم
`[in] aFormat`	سلسلة التنسيق.
`[in] aArguments`	وسيطات سلسلة التنسيق.

المرتجعات

عدد وحدات البايت التي كتبتها معاودة الاتصال.

الدوال

otCli ستظهر نتيجة

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

مؤشر لسلسلة تم إنهاؤها فارغة.

otCliByBytes

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.

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`	سبق وتم ضبط الحد الأقصى لعدد إدخالات الأوامر.

otCliresellerSetUserCommands

void otCliVendorSetUserCommands(
  void
)

رد الاتصال للسماح بإضافة أوامر خاصة بالمورّد إلى جدول أوامر المستخدم.

تتوفّر هذه السياسة عند تفعيل OPENTHREAD_CONFIG_CLI_VENDOR_COMMANDS_ENABLE وكانت قيمة OPENTHREAD_CONFIG_CLI_MAX_USER_CMD_ENTRIES أكبر من 1.

الموارد

تبدأ مواضيع مراجع واجهة برمجة تطبيقات OpenThread من رمز المصدر، وهو متاح على GitHub. للحصول على مزيد من المعلومات أو للمساهمة في المستندات، يمكنك الاطّلاع على المراجع.