مفوض
تتضمن هذه الوحدة وظائف لدور مفوض الموضوع.
ملخص
التعداد | |
---|---|
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) | تضيف هذه الوظيفة إدخال نجار. |
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) | ترسل هذه الوظيفة رسالة استعلام مسح الطاقة. |
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) | تقوم هذه الوظيفة بإزالة إدخال النجار. |
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. |
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
otJoinerInfoType
otJoinerInfoType
يعرّف هذا التعداد نوع معلومات الانضمام.
الخصائص | |
---|---|
OT_JOINER_INFO_TYPE_ANY | اقبل أي مُجند (لم يتم تحديد EUI64 أو Discerner). |
OT_JOINER_INFO_TYPE_DISCERNER | تم تحديد أداة تمييز النجار ( |
OT_JOINER_INFO_TYPE_EUI64 | تم تحديد النجار EUI-64 ( |
النوع
otCommissionerEnergyR Report رد الاتصال
void(* otCommissionerEnergyReportCallback)(uint32_t aChannelMask, const uint8_t *aEnergyList, uint8_t aEnergyListLength, void *aContext)
يتم استدعاء مؤشر الوظيفة هذا عندما يتلقى المفوض تقريرًا عن الطاقة.
تفاصيل | |||||||||
---|---|---|---|---|---|---|---|---|---|
المعلمات |
|
otCommissionerJoiner رد الاتصال
void(* otCommissionerJoinerCallback)(otCommissionerJoinerEvent aEvent, const otJoinerInfo *aJoinerInfo, const otExtAddress *aJoinerId, void *aContext)
يتم استدعاء مؤشر الوظيفة هذا كلما تغيرت حالة الواصل.
تفاصيل | |||||||||
---|---|---|---|---|---|---|---|---|---|
المعلمات |
|
otCommissionerJoinerEvent
enum otCommissionerJoinerEvent otCommissionerJoinerEvent
يعرّف هذا التعداد حدث النجار على المفوض.
otCommissionerPanIdConflict رد الاتصال
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 )
تضيف هذه الوظيفة إدخال نجار.
تفاصيل | |||||||||
---|---|---|---|---|---|---|---|---|---|
المعلمات |
| ||||||||
إرجاع القيم |
|
otCommissionerAddJoinerWithDiscerner
otError otCommissionerAddJoinerWithDiscerner( otInstance *aInstance, const otJoinerDiscerner *aDiscerner, const char *aPskd, uint32_t aTimeout )
تضيف هذه الوظيفة إدخال Joiner مع قيمة Joiner Discerner المحددة.
تفاصيل | |||||||||
---|---|---|---|---|---|---|---|---|---|
المعلمات |
| ||||||||
إرجاع القيم |
|
otCommissionerAnnounce البدء
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 )
ترسل هذه الوظيفة رسالة استعلام مسح الطاقة.
تفاصيل | |||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
المعلمات |
| ||||||||||||||||
إرجاع القيم |
|
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 )
تقوم هذه الوظيفة بإزالة إدخال النجار.
تفاصيل | |||||||||
---|---|---|---|---|---|---|---|---|---|
المعلمات |
| ||||||||
إرجاع القيم |
|
otCommissionerRemoveJoinerWithDiscerner
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.
تفاصيل | |||||||||
---|---|---|---|---|---|---|---|---|---|
المعلمات |
| ||||||||
إرجاع القيم |
|
otCommissionerSetProvisioningUrl
otError otCommissionerSetProvisioningUrl( otInstance *aInstance, const char *aProvisioningUrl )
تعمل هذه الوظيفة على تعيين عنوان URL الخاص بالتوفير.
تفاصيل | |||||
---|---|---|---|---|---|
المعلمات |
| ||||
إرجاع القيم |
|
otCommissioner ابدأ
otError otCommissionerStart( otInstance *aInstance, otCommissionerStateCallback aStateCallback, otCommissionerJoinerCallback aJoinerCallback, void *aCallbackContext )
هذه الوظيفة تمكن دور مفوض الموضوع.
تفاصيل | |||||||||
---|---|---|---|---|---|---|---|---|---|
المعلمات |
| ||||||||
إرجاع القيم |
|
otCommissioner توقف
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
الحد الأقصى لطول سلسلة PSKd (لا يتضمن حرفًا فارغًا).
OT_PROVISIONING_URL_MAX_SIZE
OT_PROVISIONING_URL_MAX_SIZE 64
الحد الأقصى للحجم (عدد الأحرف) في سلسلة عنوان URL التزويد (باستثناء الأحرف الفارغة).
OT_STEERING_DATA_MAX_LENGTH
OT_STEERING_DATA_MAX_LENGTH 16
أقصى طول لبيانات التوجيه (بايت)