المفوّض
تتضمّن هذه الوحدة وظائف تتعلق بدور "مفوَّض سلاسل المحادثات".
ملخّص
عمليات التعداد |
|
---|---|
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
يمثّل رابط PSKd. |
otSteeringData
|
typedefstruct otSteeringData
يُمثِّل بيانات التوجيه. |
الدوال |
|
---|---|
otCommissionerAddJoiner(otInstance *aInstance, const otExtAddress *aEui64, const char *aPskd, uint32_t aTimeout)
|
إضافة إدخال Join.
|
otCommissionerAddJoinerWithDiscerner(otInstance *aInstance, const otJoinerDiscerner *aDiscerner, const char *aPskd, uint32_t aTimeout)
|
لإضافة إدخال Joiner بقيمة محدّدة لـ Joiner Discerner.
|
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)
|
الحصول على معلومات حول النضم في وظيفة aIterator.
|
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)
|
لإزالة إدخال Join.
|
otCommissionerRemoveJoinerWithDiscerner(otInstance *aInstance, const otJoinerDiscerner *aDiscerner)
|
لإزالة إدخال Join.
|
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 |
يمثّل رابط PSKd. |
otSteeringData |
يُمثِّل بيانات التوجيه. |
عمليات التعداد
otCommissionerJoinerEvent
otCommissionerJoinerEvent
يحدِّد حدث الانضمام في المفوَّض.
otCommissionerState
otCommissionerState
يحدّد "الولاية المفوّضة".
أماكن إقامة | |
---|---|
OT_COMMISSIONER_STATE_ACTIVE
|
دور المفوَّض نشط |
OT_COMMISSIONER_STATE_DISABLED
|
تم إيقاف دور المفوّض. |
OT_COMMISSIONER_STATE_PETITION
|
عريضة حاليًا لتصبح مفوَّضًا |
otJoinerInfoType
otJoinerInfoType
تحدِّد هذه السمة نوع معلومات أداة الضم.
أماكن إقامة | |
---|---|
OT_JOINER_INFO_TYPE_ANY
|
يتم قبول أي رابط (لا يتم تحديد EUI64 أو Discerner). |
OT_JOINER_INFO_TYPE_DISCERNER
|
تم تحديد أداة تمييز الرابط ( |
OT_JOINER_INFO_TYPE_EUI64
|
تم تحديد دالة الانضمام EUI-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)
يتم استدعاء المؤشر كلما تغيرت حالة الضم.
التفاصيل | |||||||||
---|---|---|---|---|---|---|---|---|---|
المَعلمات |
|
otCommissionerJoinerEvent
enum otCommissionerJoinerEvent otCommissionerJoinerEvent
يحدِّد حدث الانضمام في المفوَّض.
otCommissionerPanIdConflictCallback
void(* otCommissionerPanIdConflictCallback)(uint16_t aPanId, uint32_t aChannelMask, void *aContext)
يتم استدعاء المؤشر عندما يتلقّى المفوَّض رسالة تعارض رقم PAN.
التفاصيل | |||||||
---|---|---|---|---|---|---|---|
المَعلمات |
|
otCommissionerStateCallback
void(* otCommissionerStateCallback)(otCommissionerState aState, void *aContext)
يتم استدعاء المؤشر كلما تغيّرت حالة المفوَّض.
التفاصيل | |||||
---|---|---|---|---|---|
المَعلمات |
|
otCommissioningDataset
struct otCommissioningDataset otCommissioningDataset
يمثل مجموعة بيانات مفوَّضة.
الدوال
otCommissionerAddJoiner
otError otCommissionerAddJoiner( otInstance *aInstance, const otExtAddress *aEui64, const char *aPskd, uint32_t aTimeout )
إضافة إدخال Join.
التفاصيل | |||||||||
---|---|---|---|---|---|---|---|---|---|
المَعلمات |
|
||||||||
قيم الإرجاع |
|
otCommissionerAddJoinerWithDiscerner
otError otCommissionerAddJoinerWithDiscerner( otInstance *aInstance, const otJoinerDiscerner *aDiscerner, const char *aPskd, uint32_t aTimeout )
لإضافة إدخال Joiner بقيمة محدّدة لـ Joiner Discerner.
التفاصيل | |||||||||
---|---|---|---|---|---|---|---|---|---|
المَعلمات |
|
||||||||
قيم الإرجاع |
|
otCommissionerAnnounceBegin
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 )
الحصول على معلومات حول النضم في وظيفة aIterator.
التفاصيل | |||||||
---|---|---|---|---|---|---|---|
المَعلمات |
|
||||||
قيم الإرجاع |
|
otCommissionerGetProvisioningUrl
const char * otCommissionerGetProvisioningUrl( otInstance *aInstance )
الحصول على عنوان URL لإدارة الحسابات.
التفاصيل | |||
---|---|---|---|
المَعلمات |
|
||
المرتجعات |
يشير إلى سلسلة عنوان URL.
|
otCommissionerGetSessionId
uint16_t otCommissionerGetSessionId( otInstance *aInstance )
تعرض معرّف جلسة المفوَّض.
التفاصيل | |||
---|---|---|---|
المَعلمات |
|
||
المرتجعات |
رقم تعريف جلسة المفوّض الحالية
|
otCommissionerGetState
otCommissionerState otCommissionerGetState( otInstance *aInstance )
تعرض ولاية المفوَّض.
التفاصيل | |||||||
---|---|---|---|---|---|---|---|
المَعلمات |
|
||||||
قيم الإرجاع |
|
otCommissionerPanIdQuery
otError otCommissionerPanIdQuery( otInstance *aInstance, uint16_t aPanId, uint32_t aChannelMask, const otIp6Address *aAddress, otCommissionerPanIdConflictCallback aCallback, void *aContext )
يتم إرسال رسالة طلب بحث عن رقم PAN.
التفاصيل | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
المَعلمات |
|
||||||||||||
قيم الإرجاع |
|
otCommissionerRemoveJoiner
otError otCommissionerRemoveJoiner( otInstance *aInstance, const otExtAddress *aEui64 )
لإزالة إدخال Join.
التفاصيل | |||||||||
---|---|---|---|---|---|---|---|---|---|
المَعلمات |
|
||||||||
قيم الإرجاع |
|
otCommissionerRemoveJoinerWithDiscerner
otError otCommissionerRemoveJoinerWithDiscerner( otInstance *aInstance, const otJoinerDiscerner *aDiscerner )
لإزالة إدخال Join.
التفاصيل | |||||||||
---|---|---|---|---|---|---|---|---|---|
المَعلمات |
|
||||||||
قيم الإرجاع |
|
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 )
لضبط رقم تعريف المفوّض.
التفاصيل | |||||||
---|---|---|---|---|---|---|---|
المَعلمات |
|
||||||
قيم الإرجاع |
|
otCommissionerSetProvisioningUrl
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
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
الحد الأقصى لطول السلسلة لـ Joiner PSKd (لا يتضمن حرفًا فارغًا).
OT_PROVISIONING_URL_MAX_SIZE
OT_PROVISIONING_URL_MAX_SIZE 64
الحد الأقصى للحجم (عدد الأحرف) في سلسلة عنوان URL لإدارة الحسابات (باستثناء الأحرف الفارغة).
OT_STEERING_DATA_MAX_LENGTH
OT_STEERING_DATA_MAX_LENGTH 16
الحدّ الأقصى لطول بيانات التوجيه (بالبايت)
المراجِع
تنشأ المواضيع المرجعية لواجهة برمجة تطبيقات OpenThread من رمز المصدر المتاح على GitHub. للحصول على مزيد من المعلومات أو للمساهمة في مستنداتنا، يمكنك الاطّلاع على المراجع.