المفوّض
تتضمّن هذه الوحدة وظائف لدور "مفوض سلسلة المحادثات".
ملخّص
التعدادات |
|
---|---|
otCommissionerJoinerEvent
|
تعداد تحديد حدث الانضمام في المفوض. |
otCommissionerState{
|
تعداد تحدّد ولاية المفوض. |
otJoinerInfoType{
|
تعداد تحدّد هذه المعلّمة نوع معلومات المشارك. |
أنواع المحددات |
|
---|---|
otCommissionerEnergyReportCallback)(uint32_t aChannelMask, const uint8_t *aEnergyList, uint8_t aEnergyListLength, void *aContext)
|
typedefvoid(*
يتم طلب المؤشر عندما يتلقّى المفوّض تقرير الطاقة. |
otCommissionerJoinerCallback)(otCommissionerJoinerEvent aEvent, const otJoinerInfo *aJoinerInfo, const otExtAddress *aJoinerId, void *aContext)
|
typedefvoid(*
يتم استدعاء المؤشر عندما تتغير حالة الانضمام. |
otCommissionerJoinerEvent
|
typedef تحديد حدث الانضمام في المفوض. |
otCommissionerPanIdConflictCallback)(uint16_t aPanId, uint32_t aChannelMask, void *aContext)
|
typedefvoid(*
يتم استدعاء المؤشر عندما يتلقّى المفوَّض رسالة تعارض رقم تعريف رقم PAN. |
otCommissionerState
|
typedefenum otCommissionerState
تحدّد ولاية المفوض. |
otCommissionerStateCallback)(otCommissionerState aState, void *aContext)
|
typedefvoid(*
يتم استدعاء المؤشر عندما تتغير حالة المفوض. |
otCommissioningDataset
|
typedefstruct otCommissioningDataset
تمثل مجموعة بيانات مستندة إلى العمولات. |
otJoinerInfo
|
typedefstruct otJoinerInfo
يمثل معلومات المنضم. |
otJoinerInfoType
|
typedefenum otJoinerInfoType
تحدّد هذه المعلّمة نوع معلومات المشارك. |
otJoinerPskd
|
typedefstruct otJoinerPskd
يمثّل PSK. |
otSteeringData
|
typedefstruct otSteeringData
يمثّل بيانات التوجيه. |
الدوال |
|
---|---|
otCommissionerAddJoiner(otInstance *aInstance, const otExtAddress *aEui64, const char *aPskd, uint32_t aTimeout)
|
إضافة إدخال أحد الأعضاء
|
otCommissionerAddJoinerWithDiscerner(otInstance *aInstance, const otJoinerDiscerner *aDiscerner, const char *aPskd, uint32_t aTimeout)
|
إضافة إدخال يحتوي على قيمة غير مميّزة للمسجِّل
|
otCommissionerAnnounceBegin(otInstance *aInstance, uint32_t aChannelMask, uint8_t aCount, uint16_t aPeriod, const otIp6Address *aAddress)
|
يُرسِل رسالة بدء الرسالة.
|
otCommissionerEnergyScan(otInstance *aInstance, uint32_t aChannelMask, uint8_t aCount, uint16_t aPeriod, uint16_t aScanDuration, const otIp6Address *aAddress, otCommissionerEnergyReportCallback aCallback, void *aContext)
|
يُرسِل رسالة طلب البحث عن الطاقة.
|
otCommissionerGetId(otInstance *aInstance)
|
const char *
لعرض رقم تعريف المفوض.
|
otCommissionerGetNextJoinerInfo(otInstance *aInstance, uint16_t *aIterator, otJoinerInfo *aJoiner)
|
يمكنك الحصول على معلومات حول موظّف الدعم على منصة Iterator.
|
otCommissionerGetProvisioningUrl(otInstance *aInstance)
|
const char *
يحصل على عنوان URL لإدارة الحسابات.
|
otCommissionerGetSessionId(otInstance *aInstance)
|
uint16_t
يعرض رقم تعريف جلسة المفوَّض.
|
otCommissionerGetState(otInstance *aInstance)
|
تعرض ولاية المفوض.
|
otCommissionerPanIdQuery(otInstance *aInstance, uint16_t aPanId, uint32_t aChannelMask, const otIp6Address *aAddress, otCommissionerPanIdConflictCallback aCallback, void *aContext)
|
تُرسِل رسالة طلب رقم تعريف PAN.
|
otCommissionerRemoveJoiner(otInstance *aInstance, const otExtAddress *aEui64)
|
إزالة إدخال أحد الأعضاء
|
otCommissionerRemoveJoinerWithDiscerner(otInstance *aInstance, const otJoinerDiscerner *aDiscerner)
|
إزالة إدخال أحد الأعضاء
|
otCommissionerSendMgmtGet(otInstance *aInstance, const uint8_t *aTlvs, uint8_t aLength)
|
يتم إرسال MGMT_COMMISSIONER_GET.
|
otCommissionerSendMgmtSet(otInstance *aInstance, const otCommissioningDataset *aDataset, const uint8_t *aTlvs, uint8_t aLength)
|
يتم إرسال MGMT_COMMISSIONER_SET.
|
otCommissionerSetId(otInstance *aInstance, const char *aId)
|
لضبط رقم تعريف المفوض.
|
otCommissionerSetProvisioningUrl(otInstance *aInstance, const char *aProvisioningUrl)
|
لضبط عنوان URL لإدارة الحسابات.
|
otCommissionerStart(otInstance *aInstance, otCommissionerStateCallback aStateCallback, otCommissionerJoinerCallback aJoinerCallback, void *aCallbackContext)
|
تفعيل دور مفوّض سلاسل المحادثات
|
otCommissionerStop(otInstance *aInstance)
|
لإيقاف دور مفوّض سلاسل المحادثات
|
هياكل |
|
---|---|
otCommissioningDataset |
تمثل مجموعة بيانات مستندة إلى العمولات. |
otjoinerInfo |
يمثل معلومات المنضم. |
otjoinerPskd |
يمثّل PSK. |
otSteeringData |
يمثّل بيانات التوجيه. |
التعدادات
otCommissionerالانضمام إلى الحدث
otCommissionerJoinerEvent
تحديد حدث الانضمام في المفوض.
otCommissionerState
otCommissionerState
تحدّد ولاية المفوض.
أماكن إقامة | |
---|---|
OT_COMMISSIONER_STATE_ACTIVE
|
دور المفوَّض نشط. |
OT_COMMISSIONER_STATE_DISABLED
|
تم إيقاف دور المفوَّض. |
OT_COMMISSIONER_STATE_PETITION
|
يقدّم حاليًا شكوى. |
otjoinerInfoType
otJoinerInfoType
تحدّد هذه المعلّمة نوع معلومات المشارك.
أماكن إقامة | |
---|---|
OT_JOINER_INFO_TYPE_ANY
|
اقبل أي شخص ينضم (لا يتم تحديد UnI64 أو Discerner). |
OT_JOINER_INFO_TYPE_DISCERNER
|
تم تحديد المُسجِّل ( |
OT_JOINER_INFO_TYPE_EUI64
|
تم تحديد الاتحاد الأوروبي-64 (العدد |
أنواع المحددات
otCommissionerEnergyReportCallback
void(* otCommissionerEnergyReportCallback)(uint32_t aChannelMask, const uint8_t *aEnergyList, uint8_t aEnergyListLength, void *aContext)
يتم طلب المؤشر عندما يتلقّى المفوّض تقرير الطاقة.
التفاصيل | |||||||||
---|---|---|---|---|---|---|---|---|---|
المَعلمات |
|
otCommissionerjoinerCallback
void(* otCommissionerJoinerCallback)(otCommissionerJoinerEvent aEvent, const otJoinerInfo *aJoinerInfo, const otExtAddress *aJoinerId, void *aContext)
يتم استدعاء المؤشر عندما تتغير حالة الانضمام.
التفاصيل | |||||||||
---|---|---|---|---|---|---|---|---|---|
المَعلمات |
|
otCommissionerالانضمام إلى الحدث
enum otCommissionerJoinerEvent otCommissionerJoinerEvent
تحديد حدث الانضمام في المفوض.
otCommissionerPanIdCallCallback
void(* otCommissionerPanIdConflictCallback)(uint16_t aPanId, uint32_t aChannelMask, void *aContext)
يتم استدعاء المؤشر عندما يتلقّى المفوَّض رسالة تعارض رقم تعريف رقم PAN.
التفاصيل | |||||||
---|---|---|---|---|---|---|---|
المَعلمات |
|
otCommissionerStateCallback
void(* otCommissionerStateCallback)(otCommissionerState aState, void *aContext)
يتم استدعاء المؤشر عندما تتغير حالة المفوض.
التفاصيل | |||||
---|---|---|---|---|---|
المَعلمات |
|
otCommissioningDataset
struct otCommissioningDataset otCommissioningDataset
تمثل مجموعة بيانات مستندة إلى العمولات.
الدوال
otCommissionerAddAdder
otError otCommissionerAddJoiner( otInstance *aInstance, const otExtAddress *aEui64, const char *aPskd, uint32_t aTimeout )
إضافة إدخال أحد الأعضاء
التفاصيل | |||||||||
---|---|---|---|---|---|---|---|---|---|
المَعلمات |
|
||||||||
قيم الإرجاع |
|
otCommissionerAddjoinerWithDiscerner
otError otCommissionerAddJoinerWithDiscerner( otInstance *aInstance, const otJoinerDiscerner *aDiscerner, const char *aPskd, uint32_t aTimeout )
إضافة إدخال يحتوي على قيمة غير مميّزة للمسجِّل
التفاصيل | |||||||||
---|---|---|---|---|---|---|---|---|---|
المَعلمات |
|
||||||||
قيم الإرجاع |
|
otCommissionerAnnounceStart
otError otCommissionerAnnounceBegin( otInstance *aInstance, uint32_t aChannelMask, uint8_t aCount, uint16_t aPeriod, const otIp6Address *aAddress )
يُرسِل رسالة بدء الرسالة.
التفاصيل | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
المَعلمات |
|
||||||||||
قيم الإرجاع |
|
otCommissionerEnergyScan
otError otCommissionerEnergyScan( otInstance *aInstance, uint32_t aChannelMask, uint8_t aCount, uint16_t aPeriod, uint16_t aScanDuration, const otIp6Address *aAddress, otCommissionerEnergyReportCallback aCallback, void *aContext )
يُرسِل رسالة طلب البحث عن الطاقة.
التفاصيل | |||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
المَعلمات |
|
||||||||||||||||
قيم الإرجاع |
|
otCommissionerGetId
const char * otCommissionerGetId( otInstance *aInstance )
لعرض رقم تعريف المفوض.
التفاصيل | |||
---|---|---|---|
المَعلمات |
|
||
المرتجعات |
رقم تعريف المفوَّض.
|
otCommissionerGetNextjoinerInfo
otError otCommissionerGetNextJoinerInfo( otInstance *aInstance, uint16_t *aIterator, otJoinerInfo *aJoiner )
يمكنك الحصول على معلومات حول موظّف الدعم على منصة Iterator.
التفاصيل | |||||||
---|---|---|---|---|---|---|---|
المَعلمات |
|
||||||
قيم الإرجاع |
|
otCommissionerGetProviderUrl
const char * otCommissionerGetProvisioningUrl( otInstance *aInstance )
يحصل على عنوان URL لإدارة الحسابات.
التفاصيل | |||
---|---|---|---|
المَعلمات |
|
||
المرتجعات |
مؤشر لسلسلة عنوان URL.
|
otCommissionerGetSessionId
uint16_t otCommissionerGetSessionId( otInstance *aInstance )
يعرض رقم تعريف جلسة المفوَّض.
التفاصيل | |||
---|---|---|---|
المَعلمات |
|
||
المرتجعات |
رقم تعريف جلسة المفوَّض الحالية.
|
OotCommissionerGetState
otCommissionerState otCommissionerGetState( otInstance *aInstance )
تعرض ولاية المفوض.
التفاصيل | |||||||
---|---|---|---|---|---|---|---|
المَعلمات |
|
||||||
قيم الإرجاع |
|
otCommissionerPanIdQuery
otError otCommissionerPanIdQuery( otInstance *aInstance, uint16_t aPanId, uint32_t aChannelMask, const otIp6Address *aAddress, otCommissionerPanIdConflictCallback aCallback, void *aContext )
تُرسِل رسالة طلب رقم تعريف PAN.
التفاصيل | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
المَعلمات |
|
||||||||||||
قيم الإرجاع |
|
otCommissionerإزالة الانضمام
otError otCommissionerRemoveJoiner( otInstance *aInstance, const otExtAddress *aEui64 )
إزالة إدخال أحد الأعضاء
التفاصيل | |||||||||
---|---|---|---|---|---|---|---|---|---|
المَعلمات |
|
||||||||
قيم الإرجاع |
|
otCommissioner المُدرَج إزالة الانضمام مع Discerner
otError otCommissionerRemoveJoinerWithDiscerner( otInstance *aInstance, const otJoinerDiscerner *aDiscerner )
إزالة إدخال أحد الأعضاء
التفاصيل | |||||||||
---|---|---|---|---|---|---|---|---|---|
المَعلمات |
|
||||||||
قيم الإرجاع |
|
otCommissionerSendMgmtGet
otError otCommissionerSendMgmtGet( otInstance *aInstance, const uint8_t *aTlvs, uint8_t aLength )
يتم إرسال MGMT_COMMISSIONER_GET.
التفاصيل | |||||||
---|---|---|---|---|---|---|---|
المَعلمات |
|
||||||
قيم الإرجاع |
|
otCommissionerSendMgmtSet
otError otCommissionerSendMgmtSet( otInstance *aInstance, const otCommissioningDataset *aDataset, const uint8_t *aTlvs, uint8_t aLength )
يتم إرسال MGMT_COMMISSIONER_SET.
التفاصيل | |||||||||
---|---|---|---|---|---|---|---|---|---|
المَعلمات |
|
||||||||
قيم الإرجاع |
|
otCommissionerSetId
otError otCommissionerSetId( otInstance *aInstance, const char *aId )
لضبط رقم تعريف المفوض.
التفاصيل | |||||||
---|---|---|---|---|---|---|---|
المَعلمات |
|
||||||
قيم الإرجاع |
|
otCommissionerSetProviderUrl
otError otCommissionerSetProvisioningUrl( otInstance *aInstance, const char *aProvisioningUrl )
لضبط عنوان URL لإدارة الحسابات.
التفاصيل | |||||
---|---|---|---|---|---|
المَعلمات |
|
||||
قيم الإرجاع |
|
otCommissionerStart
otError otCommissionerStart( otInstance *aInstance, otCommissionerStateCallback aStateCallback, otCommissionerJoinerCallback aJoinerCallback, void *aCallbackContext )
تفعيل دور مفوّض سلاسل المحادثات
التفاصيل | |||||||||
---|---|---|---|---|---|---|---|---|---|
المَعلمات |
|
||||||||
قيم الإرجاع |
|
otCommissionerStop
otError otCommissionerStop( otInstance *aInstance )
لإيقاف دور مفوّض سلاسل المحادثات
التفاصيل | |||||
---|---|---|---|---|---|
المَعلمات |
|
||||
قيم الإرجاع |
|
وحدات ماكرو
عدد مرّات الدخول المتاحة
OT_COMMISSIONING_PASSPHRASE_MAX_SIZE 255
الحد الأقصى لحجم عبارة مرور العمولة
عدد الأيام الإضافية: OT_COMMISSIONING_PASSPHRASE_MIN_SIZE
OT_COMMISSIONING_PASSPHRASE_MIN_SIZE 6
الحد الأدنى لحجم عبارة المرور المخصّصة للاستخدام
الوقت الإضافي: OT_JOINER_MAX_PSKD_LENGTH
OT_JOINER_MAX_PSKD_LENGTH 32
الحد الأقصى لطول سلسلة PSKD المشتركة (لا يشمل حرفًا خالٍ)
OT_PROVISIONING_URL_MAX_SIZE
OT_PROVISIONING_URL_MAX_SIZE 64
الحد الأقصى للحجم (عدد الأحرف) في سلسلة عناوين URL لإدارة الحسابات (باستثناء الأحرف الخالية من الأحرف)
الوقت الإضافي_STEERING_DATA_MAX_LENGTH
OT_STEERING_DATA_MAX_LENGTH 16
الحدّ الأقصى لطول بيانات التوجيه (بالبايت)
الموارد
تبدأ مواضيع مراجع واجهة برمجة تطبيقات OpenThread من رمز المصدر، وهو متاح على GitHub. للحصول على مزيد من المعلومات أو للمساهمة في المستندات، يمكنك الاطّلاع على المراجع.