Google is committed to advancing racial equity for Black communities. See how.

مفوض

تتضمن هذه الوحدة وظائف لدور مفوض الموضوع.

ملخص

التعداد

otCommissionerJoinerEvent تعداد
يعرّف هذا التعداد حدث النجار على المفوض.
otCommissionerState {
OT_COMMISSIONER_STATE_DISABLED = 0,
OT_COMMISSIONER_STATE_PETITION = 1,
OT_COMMISSIONER_STATE_ACTIVE = 2
}		 تعداد
هذا التعداد يحدد مفوض الدولة.
otJoinerInfoType {
OT_JOINER_INFO_TYPE_ANY = 0,
OT_JOINER_INFO_TYPE_EUI64 = 1,
OT_JOINER_INFO_TYPE_DISCERNER = 2
}		 تعداد
يعرّف هذا التعداد نوع معلومات الصلة.

النوع

otCommissionerEnergyReportCallback )(uint32_t aChannelMask, const uint8_t *aEnergyList, uint8_t aEnergyListLength, void *aContext) typedef
void(*
يتم استدعاء مؤشر الوظيفة هذا عندما يتلقى المفوض تقريرًا عن الطاقة.
otCommissionerJoinerCallback )(otCommissionerJoinerEvent aEvent, const otJoinerInfo *aJoinerInfo, const otExtAddress *aJoinerId, void *aContext) typedef
void(*
يتم استدعاء مؤشر الوظيفة هذا كلما تغيرت حالة الواصل.
otCommissionerJoinerEvent typedef
يعرّف هذا التعداد حدث النجار على المفوض.
otCommissionerPanIdConflictCallback )(uint16_t aPanId, uint32_t aChannelMask, void *aContext) typedef
void(*
يتم استدعاء مؤشر الوظيفة هذا عندما يتلقى المفوض رسالة تعارض معرّف PAN.
otCommissionerState typedef
يحدد هذا التعداد مفوض الدولة.
otCommissionerStateCallback )(otCommissionerState aState, void *aContext) typedef
void(*
يتم استدعاء مؤشر الوظيفة هذا كلما تغيرت حالة المفوض.
otCommissioningDataset typedef
يمثل هذا الهيكل مجموعة بيانات التكليف.
otJoinerInfo typedef
struct otJoinerInfo
يمثل هذا الهيكل معلومات الملتحق.
otJoinerInfoType typedef
يعرّف هذا التعداد نوع معلومات الصلة.
otJoinerPskd typedef
struct otJoinerPskd
يمثل هذا الهيكل النجار PSKd.
otSteeringData typedef
يمثل هذا الهيكل بيانات التوجيه.

المهام

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

هذا التعداد يحدد مفوض الدولة.

الخصائص
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

يتم تحديد النجار Discerner ( mSharedId.mDiscerner في otJoinerInfo ).

OT_JOINER_INFO_TYPE_EUI64

يتم تحديد النجار EUI-64 ( mSharedId.mEui64 في otJoinerInfo ).

النوع

otCommissionerEnergyR Report رد الاتصال

void(* otCommissionerEnergyReportCallback)(uint32_t aChannelMask, const uint8_t *aEnergyList, uint8_t aEnergyListLength, void *aContext)

يتم استدعاء مؤشر الوظيفة هذا عندما يتلقى المفوض تقريرًا عن الطاقة.

تفاصيل
العوامل
[in] aChannelMask
قيمة قناع القناة.
[in] aEnergyList
مؤشر لقائمة قياس الطاقة.
[in] aEnergyListLength
عدد الإدخالات في aEnergyListLength .
[in] aContext
مؤشر إلى سياق خاص بالتطبيق.

otCommissionerJoiner رد الاتصال

void(* otCommissionerJoinerCallback)(otCommissionerJoinerEvent aEvent, const otJoinerInfo *aJoinerInfo, const otExtAddress *aJoinerId, void *aContext)

يتم استدعاء مؤشر الوظيفة هذا كلما تغيرت حالة الواصل.

تفاصيل
العوامل
[in] aEvent
نوع حدث النجار.
[in] aJoinerInfo
مؤشر إلى معلومات الانضمام.
[in] aJoinerId
مؤشر إلى معرّف المنضم (إذا لم يكن معروفًا ، فسيكون فارغًا).
[in] aContext
مؤشر إلى سياق خاص بالتطبيق.

otCommissionerJoinerEvent

enum otCommissionerJoinerEvent otCommissionerJoinerEvent

يعرّف هذا التعداد حدث النجار على المفوض.

otCommissionerPanIdConflict رد الاتصال

void(* otCommissionerPanIdConflictCallback)(uint16_t aPanId, uint32_t aChannelMask, void *aContext)

يتم استدعاء مؤشر الوظيفة هذا عندما يتلقى المفوض رسالة تعارض معرّف PAN.

تفاصيل
العوامل
[in] aPanId
قيمة معرف PAN.
[in] aChannelMask
قيمة قناع القناة.
[in] aContext
مؤشر إلى سياق خاص بالتطبيق.

otCommissionerState

enum otCommissionerState otCommissionerState

هذا التعداد يحدد مفوض الدولة.

otCommissionerStateCallback

void(* otCommissionerStateCallback)(otCommissionerState aState, void *aContext)

يتم استدعاء مؤشر الوظيفة هذا كلما تغيرت حالة المفوض.

تفاصيل
العوامل
[in] aChannelMask
قيمة قناع القناة.
[in] aEnergyList
مؤشر لقائمة قياس الطاقة.
[in] aEnergyListLength
عدد الإدخالات في aEnergyListLength .
[in] aContext
مؤشر إلى سياق خاص بالتطبيق.

otCommissioningDataset

struct otCommissioningDataset otCommissioningDataset

يمثل هذا الهيكل مجموعة بيانات التكليف.

otJoinerInfo

struct otJoinerInfo otJoinerInfo

يمثل هذا الهيكل معلومات الملتحق.

otJoinerInfoType

enum otJoinerInfoType otJoinerInfoType

يعرّف هذا التعداد نوع معلومات الصلة.

otJoinerPskd

struct otJoinerPskd otJoinerPskd

يمثل هذا الهيكل النجار PSKd.

otSteeringData

struct otSteeringData otSteeringData

يمثل هذا الهيكل بيانات التوجيه.

المهام

otCommissionerAddJoiner

otError otCommissionerAddJoiner(
  otInstance *aInstance,
  const otExtAddress *aEui64,
  const char *aPskd,
  uint32_t aTimeout
)

تضيف هذه الوظيفة إدخال نجار.

تفاصيل
العوامل
[in] aInstance
مؤشر إلى مثيل OpenThread.
[in] aEui64
مؤشر إلى IEEE EUI-64 الخاص بالنجار أو NULL لأي نجار.
[in] aPskd
مؤشر إلى ملف PSKd.
[in] aTimeout
الوقت الذي يتم بعده إزالة النجار تلقائيًا ، بالثواني.
إرجاع القيم
OT_ERROR_NONE
تمت إضافة النجار بنجاح.
OT_ERROR_NO_BUFS
لا تتوفر مخازن لإضافة النجار.
OT_ERROR_INVALID_ARGS
aEui64 أو aPskd غير صالح.
OT_ERROR_INVALID_STATE
المفوض غير نشط.

otCommissionerAddJoinerWithDiscerner

otError otCommissionerAddJoinerWithDiscerner(
  otInstance *aInstance,
  const otJoinerDiscerner *aDiscerner,
  const char *aPskd,
  uint32_t aTimeout
)

تضيف هذه الوظيفة إدخال Joiner مع قيمة Joiner Discerner المحددة.

تفاصيل
العوامل
[in] aInstance
مؤشر إلى مثيل OpenThread.
[in] aDiscerner
مؤشر إلى المميز المميز.
[in] aPskd
مؤشر إلى ملف PSKd.
[in] aTimeout
الوقت الذي يتم بعده إزالة النجار تلقائيًا ، بالثواني.
إرجاع القيم
OT_ERROR_NONE
تمت إضافة النجار بنجاح.
OT_ERROR_NO_BUFS
لا تتوفر مخازن لإضافة النجار.
OT_ERROR_INVALID_ARGS
aDiscerner أو aPskd غير صالح.
OT_ERROR_INVALID_STATE
المفوض غير نشط.

otCommissionerAnnounce البدء

otError otCommissionerAnnounceBegin(
  otInstance *aInstance,
  uint32_t aChannelMask,
  uint8_t aCount,
  uint16_t aPeriod,
  const otIp6Address *aAddress
)

ترسل هذه الوظيفة رسالة إعلان بدء.

تفاصيل
العوامل
[in] aInstance
مؤشر إلى مثيل OpenThread.
[in] aChannelMask
قيمة قناع القناة.
[in] aCount
عدد رسائل الإعلام لكل قناة.
[in] aPeriod
الوقت بين اثنين متتاليين MLE تعلن عن الإرسال (بالمللي ثانية).
[in] aAddress
مؤشر إلى وجهة IPv6.
إرجاع القيم
OT_ERROR_NONE
تم بنجاح إدراج رسالة "إعلان البدء" في قائمة الانتظار.
OT_ERROR_NO_BUFS
المخازن المؤقتة غير كافية لإنشاء رسالة إعلان البدء.
OT_ERROR_INVALID_STATE
المفوض غير نشط.

otCommissionerEnergyScan

otError otCommissionerEnergyScan(
  otInstance *aInstance,
  uint32_t aChannelMask,
  uint8_t aCount,
  uint16_t aPeriod,
  uint16_t aScanDuration,
  const otIp6Address *aAddress,
  otCommissionerEnergyReportCallback aCallback,
  void *aContext
)

ترسل هذه الوظيفة رسالة استعلام مسح الطاقة.

تفاصيل
العوامل
[in] aInstance
مؤشر إلى مثيل OpenThread.
[in] aChannelMask
قيمة قناع القناة.
[in] aCount
عدد قياسات الطاقة لكل قناة.
[in] aPeriod
الوقت بين قياسات الطاقة (مللي ثانية).
[in] aScanDuration
مدة المسح لكل قياس للطاقة (مللي ثانية).
[in] aAddress
مؤشر إلى وجهة IPv6.
[in] aCallback
مؤشر لوظيفة يتم استدعاؤها عند تلقي رسالة تقرير الطاقة.
[in] aContext
مؤشر إلى سياق خاص بالتطبيق.
إرجاع القيم
OT_ERROR_NONE
نجح في إدراج رسالة استعلام مسح الطاقة في قائمة الانتظار.
OT_ERROR_NO_BUFS
المخازن المؤقتة غير كافية لإنشاء رسالة استعلام مسح الطاقة.
OT_ERROR_INVALID_STATE
المفوض غير نشط.

otCommissionerGetNextJoinerInfo

otError otCommissionerGetNextJoinerInfo(
  otInstance *aInstance,
  uint16_t *aIterator,
  otJoinerInfo *aJoiner
)

هذه الطريقة تحصل على معلومات نجار في موقع aIterator.

تفاصيل
العوامل
[in] aInstance
مؤشر على سبيل المثال.
[in,out] aIterator
مؤشر إلى سياق مكرر Joiner Info.
[out] aJoiner
إشارة إلى معلومات النجار.
إرجاع القيم
OT_ERROR_NONE
نجح الحصول على معلومات النجار.
OT_ERROR_NOT_FOUND
لم يتم العثور على النجار التالي.

otCommissionerGetProvisioningUrl

const char * otCommissionerGetProvisioningUrl(
  otInstance *aInstance
)

تحصل هذه الوظيفة على عنوان URL التزويد.

تفاصيل
العوامل
[in] aInstance
مؤشر إلى مثيل OpenThread.
عائدات
مؤشر لسلسلة URL.

otCommissionerGetSessionId

uint16_t otCommissionerGetSessionId(
  otInstance *aInstance
)

تقوم هذه الوظيفة بإرجاع معرف جلسة المفوض.

تفاصيل
العوامل
[in] aInstance
مؤشر إلى مثيل OpenThread.
عائدات
معرف جلسة المفوض الحالي.

otCommissionerGetState

otCommissionerState otCommissionerGetState(
  otInstance *aInstance
)

هذه الوظيفة ترجع مفوض الدولة.

تفاصيل
العوامل
[in] aInstance
مؤشر إلى مثيل OpenThread.
إرجاع القيم
OT_COMMISSIONER_STATE_DISABLED
مفوض معاق.
OT_COMMISSIONER_STATE_PETITION
أن يصبح المفوض.
OT_COMMISSIONER_STATE_ACTIVE
تمكين المفوض.

otCommissionerPanIdQuery

otError otCommissionerPanIdQuery(
  otInstance *aInstance,
  uint16_t aPanId,
  uint32_t aChannelMask,
  const otIp6Address *aAddress,
  otCommissionerPanIdConflictCallback aCallback,
  void *aContext
)

ترسل هذه الوظيفة رسالة استعلام معرف PAN.

تفاصيل
العوامل
[in] aInstance
مؤشر إلى مثيل OpenThread.
[in] aPanId
معرف PAN للاستعلام عنه.
[in] aChannelMask
قيمة قناع القناة.
[in] aAddress
مؤشر إلى وجهة IPv6.
[in] aCallback
مؤشر لوظيفة يتم استدعاؤها عند تلقي رسالة تعارض معرّف PAN.
[in] aContext
مؤشر إلى سياق خاص بالتطبيق.
إرجاع القيم
OT_ERROR_NONE
تم بنجاح إدراج رسالة استعلام معرف PAN في قائمة الانتظار.
OT_ERROR_NO_BUFS
المخازن المؤقتة غير كافية لإنشاء رسالة استعلام معرف PAN.
OT_ERROR_INVALID_STATE
المفوض غير نشط.

otCommissionerRemoveJoiner

otError otCommissionerRemoveJoiner(
  otInstance *aInstance,
  const otExtAddress *aEui64
)

هذه الوظيفة تزيل إدخال النجار.

تفاصيل
العوامل
[in] aInstance
مؤشر إلى مثيل OpenThread.
[in] aEui64
مؤشر إلى IEEE EUI-64 الخاص بالنجار أو NULL لأي نجار.
إرجاع القيم
OT_ERROR_NONE
تمت إزالة النجار بنجاح.
OT_ERROR_NOT_FOUND
والنجار المحدد من قبل aEui64 لم يتم العثور على.
OT_ERROR_INVALID_ARGS
aEui64 غير صالح.
OT_ERROR_INVALID_STATE
المفوض غير نشط.

otCommissionerRemoveJoinerWithDiscerner

otError otCommissionerRemoveJoinerWithDiscerner(
  otInstance *aInstance,
  const otJoinerDiscerner *aDiscerner
)

هذه الوظيفة تزيل إدخال النجار.

تفاصيل
العوامل
[in] aInstance
مؤشر إلى مثيل OpenThread.
[in] aEui64
مؤشر إلى المميز المميز.
إرجاع القيم
OT_ERROR_NONE
تمت إزالة النجار بنجاح.
OT_ERROR_NOT_FOUND
والنجار المحدد من قبل aEui64 لم يتم العثور على.
OT_ERROR_INVALID_ARGS
aDiscerner غير صالح.
OT_ERROR_INVALID_STATE
المفوض غير نشط.

otCommissionerSendMgmtGet

otError otCommissionerSendMgmtGet(
  otInstance *aInstance,
  const uint8_t *aTlvs,
  uint8_t aLength
)

ترسل هذه الوظيفة MGMT_COMMISSIONER_GET.

تفاصيل
العوامل
[in] aInstance
مؤشر إلى مثيل OpenThread.
[in] aTlvs
مؤشر إلى TLVs.
[in] aLength
طول TLVs.
إرجاع القيم
OT_ERROR_NONE
أرسل الأمر meshcop dataset بنجاح.
OT_ERROR_NO_BUFS
مساحة المخزن المؤقت غير كافية للإرسال.
OT_ERROR_INVALID_STATE
المفوض غير نشط.

otCommissionerSendMgmtSet

otError otCommissionerSendMgmtSet(
  otInstance *aInstance,
  const otCommissioningDataset *aDataset,
  const uint8_t *aTlvs,
  uint8_t aLength
)

ترسل هذه الوظيفة MGMT_COMMISSIONER_SET.

تفاصيل
العوامل
[in] aInstance
مؤشر إلى مثيل OpenThread.
[in] aDataset
مؤشر لتكليف مجموعة البيانات.
[in] aTlvs
مؤشر إلى TLVs.
[in] aLength
طول TLVs.
إرجاع القيم
OT_ERROR_NONE
أرسل الأمر meshcop dataset بنجاح.
OT_ERROR_NO_BUFS
مساحة المخزن المؤقت غير كافية للإرسال.
OT_ERROR_INVALID_STATE
المفوض غير نشط.

otCommissionerSetProvisioningUrl

otError otCommissionerSetProvisioningUrl(
  otInstance *aInstance,
  const char *aProvisioningUrl
)

تعمل هذه الوظيفة على تعيين عنوان URL الخاص بالتوفير.

تفاصيل
العوامل
[in] aInstance
مؤشر إلى مثيل OpenThread.
[in] aProvisioningUrl
مؤشر إلى عنوان URL للتزويد (قد يكون فارغًا لتعيينه كسلسلة فارغة).
إرجاع القيم
OT_ERROR_NONE
تم بنجاح تعيين عنوان URL لإدارة الحسابات.
OT_ERROR_INVALID_ARGS
aProvisioningUrl غير صالح (طويل جدا).

otCommissioner ابدأ

otError otCommissionerStart(
  otInstance *aInstance,
  otCommissionerStateCallback aStateCallback,
  otCommissionerJoinerCallback aJoinerCallback,
  void *aCallbackContext
)

هذه الوظيفة تمكن دور مفوض الموضوع.

تفاصيل
العوامل
[in] aInstance
مؤشر إلى مثيل OpenThread.
[in] aStateCallback
مؤشر لوظيفة يتم استدعاؤها عند تغير حالة المفوض.
[in] aJoinerCallback
يظهر مؤشر لوظيفة يتم استدعاؤها بحدث رابط.
[in] aCallbackContext
مؤشر إلى سياق خاص بالتطبيق.
إرجاع القيم
OT_ERROR_NONE
بدأت خدمة المفوض بنجاح.
OT_ERROR_ALREADY
بدأ المفوض بالفعل.
OT_ERROR_INVALID_STATE
الجهاز غير متصل حاليًا بالشبكة.

otCommissioner توقف

otError otCommissionerStop(
  otInstance *aInstance
)

تعمل هذه الوظيفة على تعطيل دور مفوض مؤشر الترابط.

تفاصيل
العوامل
[in] aInstance
مؤشر إلى مثيل OpenThread.
إرجاع القيم
OT_ERROR_NONE
تم إيقاف خدمة المفوض بنجاح.
OT_ERROR_ALREADY
تم إيقاف المفوض بالفعل.

وحدات الماكرو

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 Joiner (لا يتضمن حرفًا فارغًا).

OT_PROVISIONING_URL_MAX_SIZE

 OT_PROVISIONING_URL_MAX_SIZE 64

الحد الأقصى للحجم (عدد الأحرف) في سلسلة عنوان URL التزويد (باستثناء الأحرف الفارغة).

OT_STEERING_DATA_MAX_LENGTH

 OT_STEERING_DATA_MAX_LENGTH 16

أقصى طول لبيانات التوجيه (بايت)