نجّار

تتضمّن هذه الوحدة وظائف دور "سلسلة المحادثات المرتبطة".

الملخّص

التعدادات
otJoinerState تعداد
تحدّد هذه القائمة العدد حالة ضمّ المشتركين.

مواقد الخط
otJoinerCallback)(otError aError, void *aContext) مَعلمة typetype
void(*
يُطلق على مؤشر الدالة هذا إشعار باكتمال عملية انضمام.
otJoinerDiscerner مَعلمة typetype
تمثّل هذه البنية مشتركًا مشتركًا.
otJoinerState مَعلمة typetype
تحدّد هذه القائمة العدد حالة ضمّ المشتركين.

الدوال
otJoinerGetDiscerner(otInstance *aInstance)
تحصل هذه الدالة على Joiner Discerner.
otJoinerGetId(otInstance *aInstance)
const otExtAddress *
تحصل هذه الدالة على معرّف المشارك.
otJoinerGetState(otInstance *aInstance)
تعرض هذه الدالة حالة الانضمام.
otJoinerSetDiscerner(otInstance *aInstance, otJoinerDiscerner *aDiscerner)
تعمل هذه الدالة على ضبط تطبيق Joiner Discerner.
otJoinerStart(otInstance *aInstance, const char *aPskd, const char *aProvisioningUrl, const char *aVendorName, const char *aVendorModel, const char *aVendorSwVersion, const char *aVendorData, otJoinerCallback aCallback, void *aContext)
تتيح هذه الدالة تفعيل دور "سلسلة المحادثات".
otJoinerStateToString(otJoinerState aState)
const char *
تحوِّل هذه الدالة قيمة تعداد نمط ضمّ معيّنة إلى سلسلة يمكن للمستخدمين قراءتها.
otJoinerStop(otInstance *aInstance)
void
توقِف هذه الدالة دور "سلسلة المحادثات".

التشريعات
otJoinerDiscerner

تمثّل هذه البنية مشتركًا مشتركًا.

التعدادات

otJoinerState

 otJoinerState

تحدّد هذه القائمة العدد حالة ضمّ المشتركين.

مواقد الخط

otJoinerCallback

void(* otJoinerCallback)(otError aError, void *aContext)

يُطلق على مؤشر الدالة هذا إشعار باكتمال عملية انضمام.

التفاصيل
المعلَمات
[in] aError
OT_ERROR_NONE إذا تمت عملية الانضمام بنجاح. OT_ERROR_security في حالة فشل عملية الانضمام بسبب بيانات اعتماد الأمان. OT_ERROR_NOT_FOUND إذا لم يتم اكتشاف شبكة قابلة للانضمام. OT_ERROR_RESPONSE_TIMEOUT إذا انتهت مهلة الاستجابة.
[in] aContext
مؤشر للسياق الخاص بالتطبيق.

otJoinerDiscerner

struct otJoinerDiscerner otJoinerDiscerner

تمثّل هذه البنية مشتركًا مشتركًا.

otJoinerState

enum otJoinerState otJoinerState

تحدّد هذه القائمة العدد حالة ضمّ المشتركين.

الدوال

otJoinerGetDiscerner

const otJoinerDiscerner * otJoinerGetDiscerner(
  otInstance *aInstance
)

تحصل هذه الدالة على Joiner Discerner.

التفاصيل
المعلَمات
[in] aInstance
مؤشر إلى مثيل OpenThread.
طلبات الإرجاع
مؤشر إلى Joiner Discerner أو False إذا لم يتم ضبط أي نوع.

otJoinerGetId

const otExtAddress * otJoinerGetId(
  otInstance *aInstance
)

تحصل هذه الدالة على معرّف المشارك.

إذا لم يتم ضبط Joiner Discerner، يكون رقم تعريف المشارك هو أول 64 بت من نتيجة احتساب SHA-256 على الإعدادات الأصلية التي تم تخصيصها حسب الإعدادات الأصلية في IEEE-64. بخلاف ذلك، يتم حساب رقم تعريف المشارك من قيمة تطبيق Disnerner.

ويُستخدَم رقم تعريف المشارك أيضًا على أنه "العنوان IEEE 802.15.4 الموسَّع" للجهاز أثناء عملية العمولة.

التفاصيل
المعلَمات
[in] aInstance
مؤشر إلى مثيل OpenThread.
طلبات الإرجاع
مؤشر إلى معرّف المشارك

otJoinerGetState

otJoinerState otJoinerGetState(
  otInstance *aInstance
)

تعرض هذه الدالة حالة الانضمام.

التفاصيل
المعلَمات
[in] aInstance
مؤشر إلى مثيل OpenThread.
قيم الإرجاع
OT_JOINER_STATE_IDLE
OT_JOINER_STATE_DISCOVER
OT_JOINER_STATE_CONNECT
OT_JOINER_STATE_CONNECTED
OT_JOINER_STATE_ENTRUST
OT_JOINER_STATE_JOINED

otJoinerSetDiscerner

otError otJoinerSetDiscerner(
  otInstance *aInstance,
  otJoinerDiscerner *aDiscerner
)

تعمل هذه الدالة على ضبط تطبيق Joiner Discerner.

يُستخدَم رابط الانضمام لحساب معرّف المشارك أثناء عملية التكليف/الانضمام.

تلقائيًا (عندما لا يتم توفير خاتم فروق أو ضبطه على القيمة "خالٍ")، يتم اشتقاق رقم تعريف المشارك على أنه أول 64 بت من نتيجة احتساب SHA-256 على المصنع IEEE EU-64 الذي تم ضبطه على الإعدادات الأصلية. لاحظ أن هذا هو السلوك الرئيسي المتوقع في مواصفات سلسلة المحادثات.

التفاصيل
المعلَمات
[in] aInstance
مؤشر إلى مثيل OpenThread.
[in] aDiscerner
مؤشر لمنضدة الانضمام. في حال محو "خالٍ" لأي وحدة تحكُّم عن بُعد تم إعدادها سابقًا.
قيم الإرجاع
OT_ERROR_NONE
تم تعديل تطبيق Joiner Discerner بنجاح.
OT_ERROR_INVALID_ARGS
aDiscerner غير صالح (الطول المحدد ليس ضمن النطاق الصالح).
OT_ERROR_INVALID_STATE
هناك عملية انضمام مستمرة، لذلك لا يمكن تغيير Joiner Discerner.

otJoinerStart

otError otJoinerStart(
  otInstance *aInstance,
  const char *aPskd,
  const char *aProvisioningUrl,
  const char *aVendorName,
  const char *aVendorModel,
  const char *aVendorSwVersion,
  const char *aVendorData,
  otJoinerCallback aCallback,
  void *aContext
)

تتيح هذه الدالة تفعيل دور "سلسلة المحادثات".

التفاصيل
المعلَمات
[in] aInstance
مؤشر إلى مثيل OpenThread.
[in] aPskd
مؤشر إلى PSKd.
[in] aProvisioningUrl
مؤشر إلى عنوان URL لإدارة الحسابات (قد يكون فارغًا).
[in] aVendorName
مؤشر إلى اسم المورّد (قد يكون فارغًا).
[in] aVendorModel
مؤشر لنموذج المورِّد (قد يكون فارغًا).
[in] aVendorSwVersion
مؤشر إلى إصدار المورِّد (SW) (قد يكون فارغًا).
[in] aVendorData
مؤشر لبيانات المورّد (قد يكون فارغًا).
[in] aCallback
مؤشر إلى دالة يتم استدعاءها عند اكتمال عملية الربط.
[in] aContext
مؤشر للسياق الخاص بالتطبيق.
قيم الإرجاع
OT_ERROR_NONE
تم بدء دور المشارك بنجاح.
OT_ERROR_BUSY
لا تزال المحاولة السابقة جارية.
OT_ERROR_INVALID_ARGS
aPskd أو aProvisioningUrl غير صالح.
OT_ERROR_INVALID_STATE
لا يتم تفعيل حزمة IPv6 أو يتم تفعيل حزمة سلاسل المحادثات بالكامل.

otJoinerStateToString

const char * otJoinerStateToString(
  otJoinerState aState
)

تحوِّل هذه الدالة قيمة تعداد نمط ضمّ معيّنة إلى سلسلة يمكن للمستخدمين قراءتها.

التفاصيل
المعلَمات
[in] aState
حالة الانتساب
طلبات الإرجاع
تمثّل هذه الخاصية سلسلة نصية مقروءة يسهل على aState قراءتها.

otJoinerStop

void otJoinerStop(
  otInstance *aInstance
)

توقِف هذه الدالة دور "سلسلة المحادثات".

التفاصيل
المعلَمات
[in] aInstance
مؤشر إلى مثيل OpenThread.

وحدات ماكرو

OT_JoinER_MAX_DISCERNER_LENGTH

 OT_JOINER_MAX_DISCERNER_LENGTH 64

الحد الأقصى لطول جهاز الانضمام عبر وحدات البت.

المراجع

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