جهاز التوجيه/القائد

تتضمن هذه الوحدة وظائف أجهزة توجيه وقادة سلسلة المحادثات.

الملخّص

التعدادات

otCacheEntryState تعداد
تحدِّد هذه القائمة حالة إدخال ذاكرة التخزين المؤقت لرقم EID.
otNeighborTableEvent{
  OT_NEIGHBOR_TABLE_EVENT_CHILD_ADDED,
  OT_NEIGHBOR_TABLE_EVENT_CHILD_REMOVED,
  OT_NEIGHBOR_TABLE_EVENT_CHILD_MODE_CHANGED,
  OT_NEIGHBOR_TABLE_EVENT_ROUTER_ADDED,
  OT_NEIGHBOR_TABLE_EVENT_ROUTER_REMOVED
}
تعداد
يحدد هذا العدد الثوابت المستخدمة في otNeighborTableCallback للإشارة إلى التغييرات في جدول الجيران.

مواقد الخط

otCacheEntryInfo مَعلمة typetype
تمثّل هذه البنية إدخال EID Cache.
otCacheEntryIterator مَعلمة typetype
يمثل هذا النوع تكرارًا يُستخدم للإدخال من خلال إدخالات جدول ذاكرة التخزين المؤقت لـ EID.
otCacheEntryState مَعلمة typetype
تحدِّد هذه القائمة حالة إدخال ذاكرة التخزين المؤقت لرقم EID.
otChildIp6AddressIterator مَعلمة typetype
uint16_t
يُستخدَم للتكرار من خلال عناوين IPv6 لإدخال سلسلة المحادثات الفرعية.
otNeighborTableCallback)(otNeighborTableEvent aEvent, const otNeighborTableEntryInfo *aEntryInfo) مَعلمة typetype
void(*
يتم استدعاء مؤشر الدالة هذا لإبلاغه بتغيير في جدول الجيران.

الدوال

otThreadBecomeLeader(otInstance *aInstance)
كن قائدًا وابدأ قسمًا جديدًا.
otThreadBecomeRouter(otInstance *aInstance)
محاولة أن تصبح جهاز توجيه
otThreadGetChildInfoById(otInstance *aInstance, uint16_t aChildId, otChildInfo *aChildInfo)
تحتفظ الدالة بمعلومات تشخيصية لطفل مرفق من خلال رقم تعريف الطفل أو RLOC16.
otThreadGetChildInfoByIndex(otInstance *aInstance, uint16_t aChildIndex, otChildInfo *aChildInfo)
تحتفظ الدالة بالمعلومات التشخيصية لطفل فرعي مرفق من خلال فهرس الجدول الداخلي.
otThreadGetChildNextIp6Address(otInstance *aInstance, uint16_t aChildIndex, otChildIp6AddressIterator *aIterator, otIp6Address *aAddress)
تحصل هذه الدالة على عنوان IPv6 التالي (باستخدام المكرر) لمستخدم محدد.
otThreadGetContextIdReuseDelay(otInstance *aInstance)
uint32_t
احصل على معلمة Context_ID_REUSE_STATUS في دور القائد.
otThreadGetJoinerUdpPort(otInstance *aInstance)
uint16_t
احصل على منفذ UDP UDP.
otThreadGetLocalLeaderWeight(otInstance *aInstance)
uint8_t
يمكنك استخدام "قائد سلاسل المحادثات" عند العمل في دور القائد.
otThreadGetMaxAllowedChildren(otInstance *aInstance)
uint16_t
الحصول على الحد الأقصى لعدد الأطفال المسموح بهم حاليًا.
otThreadGetMaxChildIpAddresses(otInstance *aInstance)
uint8_t
تحصل هذه الدالة على الحد الأقصى لعدد عناوين IP التي قد يسجّلها كل طفل MTD في هذا الجهاز كأحد الوالدين.
otThreadGetMaxRouterId(otInstance *aInstance)
uint8_t
تعرض الدالة الحدّ الأقصى المسموح به لمعرّف التوجيه.
otThreadGetNetworkIdTimeout(otInstance *aInstance)
uint8_t
الحصول على المعلمة NETWORK_ID_TIMEOUT المستخدمة في دور جهاز التوجيه.
otThreadGetNextCacheEntry(otInstance *aInstance, otCacheEntryInfo *aEntryInfo, otCacheEntryIterator *aIterator)
تحصل هذه الدالة على إدخال ذاكرة التخزين المؤقت التالي في EID (باستخدام المكرر).
otThreadGetParentPriority(otInstance *aInstance)
int8_t
احصل على الأولوية الرئيسية التي تم تحديدها.
otThreadGetPreferredLeaderPartitionId(otInstance *aInstance)
uint32_t
استخدِم "رقم تعريف قسم قائد سلاسل المحادثات" المفضّل عند العمل في دور القائد.
otThreadGetPskc(otInstance *aInstance, otPskc *aPskc)
void
الحصول على سلسلة المحادثات PSKc
otThreadGetPskcRef(otInstance *aInstance)
الحصول على مرجع المفتاح إلى سلسلة محادثات PSKc
otThreadGetRouterDowngradeThreshold(otInstance *aInstance)
uint8_t
استخدِم المَعلمة ROUTER_DOWNGRADE_PERCENTAGE في دور جهاز التوجيه.
otThreadGetRouterIdRange(otInstance *aInstance, uint8_t *aMinRouterId, uint8_t *aMaxRouterId)
void
تحصل هذه الدالة على نطاق معرّفات جهاز التوجيه المسموح لها بتحديد عُقد ضمن شبكة سلسلة المحادثات.
otThreadGetRouterIdSequence(otInstance *aInstance)
uint8_t
احصل على تسلسل رقم تعريف جهاز التوجيه الحالي.
otThreadGetRouterInfo(otInstance *aInstance, uint16_t aRouterId, otRouterInfo *aRouterInfo)
تحتفظ الوظيفة بمعلومات التشخيص لجهاز توجيه سلسلة محادثات معيّن.
otThreadGetRouterSelectionJitter(otInstance *aInstance)
uint8_t
احصل على معلمة ROUTER_SELECTION_JITTER المستخدمة في دور REED/Router.
otThreadGetRouterUpgradeThreshold(otInstance *aInstance)
uint8_t
احصل على معلمة ROUTER_UPGRADE_INTERVAL المستخدمة في دور REED.
otThreadIsRouterEligible(otInstance *aInstance)
bool
تحدد هذه الطريقة ما إذا كان الجهاز مؤهلاً لجهاز التوجيه أو لا.
otThreadRegisterNeighborTableCallback(otInstance *aInstance, otNeighborTableCallback aCallback)
void
تسجِّل هذه الدالة دالة استدعاء جدول مجاور.
otThreadReleaseRouterId(otInstance *aInstance, uint8_t aRouterId)
إصدار رقم تعريف جهاز التوجيه الذي خصّصه الجهاز في دور القائد.
otThreadSetCcmEnabled(otInstance *aInstance, bool aEnabled)
void
تحدّد هذه الدالة ما إذا تم تفويض الجهاز باستخدام إدارة البيانات (CCM).
otThreadSetContextIdReuseDelay(otInstance *aInstance, uint32_t aDelay)
void
عيّن المعلمة Context_ID_REUSE_STATUS في دور القائد.
otThreadSetJoinerUdpPort(otInstance *aInstance, uint16_t aJoinerUdpPort)
اضبط منفذ UDP UDP.
otThreadSetLocalLeaderWeight(otInstance *aInstance, uint8_t aWeight)
void
ضبط وزن قائد سلاسل المحادثات عند العمل في دور القائد.
otThreadSetMaxAllowedChildren(otInstance *aInstance, uint16_t aMaxChildren)
ضبط الحد الأقصى لعدد الأطفال المسموح بهم حاليًا.
otThreadSetMaxChildIpAddresses(otInstance *aInstance, uint8_t aMaxIpAddresses)
تعمل هذه الدالة على إعداد/استعادة الحد الأقصى لعدد عناوين IP التي قد يسجّلها كل جهاز MTD فرعي عبر هذا الجهاز كأحد الوالدين.
otThreadSetNetworkIdTimeout(otInstance *aInstance, uint8_t aTimeout)
void
يمكنك تعيين المعلمة NETWORK_ID_TIMEOUT المستخدمة في دور القائد.
otThreadSetParentPriority(otInstance *aInstance, int8_t aParentPriority)
حدِّد الأولوية الرئيسية.
otThreadSetPreferredLeaderPartitionId(otInstance *aInstance, uint32_t aPartitionId)
void
اضبط "رقم تعريف قسم قائد سلسلة المحادثات" المُفضَّل عند تشغيله في دور القائد.
otThreadSetPreferredRouterId(otInstance *aInstance, uint8_t aRouterId)
ضبط معرّف جهاز التوجيه المفضّل
otThreadSetPskc(otInstance *aInstance, const otPskc *aPskc)
ضبط سلسلة المحادثات PSKc
otThreadSetPskcRef(otInstance *aInstance, otPskcRef aKeyRef)
ضبط سلسلة المحادثات PSKc
otThreadSetRouterDowngradeThreshold(otInstance *aInstance, uint8_t aThreshold)
void
يمكنك تعيين المعلمة ROUTER_DOWNGRADE_PERCENTAGE المستخدمة في دور القائد.
otThreadSetRouterEligible(otInstance *aInstance, bool aEligible)
تحدّد هذه الدالة ما إذا كان الجهاز مؤهلاً لجهاز التوجيه أو لا.
otThreadSetRouterIdRange(otInstance *aInstance, uint8_t aMinRouterId, uint8_t aMaxRouterId)
تحدّد هذه الدالة نطاق معرّفات جهاز التوجيه المسموح لها بتحديد عُقد ضمن شبكة سلسلة المحادثات.
otThreadSetRouterSelectionJitter(otInstance *aInstance, uint8_t aRouterJitter)
void
عيِّن معلمة ROUTER_SELECTION_JITTER المستخدمة في دور REED/Router.
otThreadSetRouterUpgradeThreshold(otInstance *aInstance, uint8_t aThreshold)
void
اضبط معلمة ROUTER_UPGRADE_INTERVAL المستخدمة في دور القائد.
otThreadSetSteeringData(otInstance *aInstance, const otExtAddress *aExtAddress)
void
ضبط بيانات التوجيه خارج النطاق.
otThreadSetThreadVersionCheckEnabled(otInstance *aInstance, bool aEnabled)
void
تحدّد هذه الدالة ما إذا كان الحدّ الأقصى لإصدار التوجيه (TLV) لسياسة الأمان مفعَّلاً (حقل VR).

التشريعات

otCacheEntryInfo

تمثّل هذه البنية إدخال EID Cache.

otCacheEntryIterator

يمثل هذا النوع تكرارًا يُستخدم للإدخال من خلال إدخالات جدول ذاكرة التخزين المؤقت لـ EID.

otChildInfo

تحتفظ هذه البنية بمعلومات تشخيصية لسلسلة محادثات فرعية.

otNeighborTableEntryInfo

يمثل هذا النوع معلومات إدخال جدول الجيران (التابعة أو جهاز التوجيه) ويستخدم كمعلمة في استدعاء جدول الجيران otNeighborTableCallback.

التعدادات

otCacheEntryState

 otCacheEntryState

تحدِّد هذه القائمة حالة إدخال ذاكرة التخزين المؤقت لرقم EID.

otNeighborTableEvent

 otNeighborTableEvent

يحدد هذا العدد الثوابت المستخدمة في otNeighborTableCallback للإشارة إلى التغييرات في جدول الجيران.

المنشآت الفندقية
OT_NEIGHBOR_TABLE_EVENT_CHILD_ADDED

تتم إضافة حساب فرعي.

OT_NEIGHBOR_TABLE_EVENT_CHILD_MODE_CHANGED

تم تغيير وضع الطفل الحالي.

OT_NEIGHBOR_TABLE_EVENT_CHILD_REMOVED

جارٍ إزالة طفل.

OT_NEIGHBOR_TABLE_EVENT_ROUTER_ADDED

تتم إضافة جهاز توجيه.

OT_NEIGHBOR_TABLE_EVENT_ROUTER_REMOVED

جارٍ إزالة جهاز توجيه.

مواقد الخط

otCacheEntryInfo

struct otCacheEntryInfo otCacheEntryInfo

تمثّل هذه البنية إدخال EID Cache.

otCacheEntryIterator

struct otCacheEntryIterator otCacheEntryIterator

يمثل هذا النوع تكرارًا يُستخدم للإدخال من خلال إدخالات جدول ذاكرة التخزين المؤقت لـ EID.

لإعداد المكرر والبدء من الإدخال الأول في جدول ذاكرة التخزين المؤقت، حدد جميع حقوله في البنية على صفر (مثل، memset المكرر إلى صفر).

otCacheEntryState

enum otCacheEntryState otCacheEntryState

تحدِّد هذه القائمة حالة إدخال ذاكرة التخزين المؤقت لرقم EID.

otChildIp6AddressITerator

uint16_t otChildIp6AddressIterator

يُستخدَم للتكرار من خلال عناوين IPv6 لإدخال سلسلة المحادثات الفرعية.

otNeighborTableCall

void(* otNeighborTableCallback)(otNeighborTableEvent aEvent, const otNeighborTableEntryInfo *aEntryInfo)

يتم استدعاء مؤشر الدالة هذا لإبلاغه بتغيير في جدول الجيران.

التفاصيل
المعلَمات
[in] aEvent
علامة حدث.
[in] aEntryInfo
مؤشر لمعلومات إدخال الجدول.

الدوال

otthreadالبدء

otError otThreadBecomeLeader(
  otInstance *aInstance
)

كن قائدًا وابدأ قسمًا جديدًا.

التفاصيل
المعلَمات
[in] aInstance
مؤشر إلى مثيل OpenThread.
قيم الإرجاع
OT_ERROR_NONE
ونجحت الشركة في قيادة قسم جديد وبدأت قسمًا جديدًا فيها.
OT_ERROR_INVALID_STATE
تم إيقاف سلسلة المحادثات.

otthreadGetRouter

otError otThreadBecomeRouter(
  otInstance *aInstance
)

محاولة أن تصبح جهاز توجيه

التفاصيل
المعلَمات
[in] aInstance
مؤشر إلى مثيل OpenThread.
قيم الإرجاع
OT_ERROR_NONE
بدء محاولة أن تصبح جهاز توجيه بنجاح.
OT_ERROR_INVALID_STATE
تم إيقاف سلسلة المحادثات.

otthreadGetChildInfoById

otError otThreadGetChildInfoById(
  otInstance *aInstance,
  uint16_t aChildId,
  otChildInfo *aChildInfo
)

تحتفظ الدالة بمعلومات تشخيصية لطفل مرفق من خلال رقم تعريف الطفل أو RLOC16.

التفاصيل
المعلَمات
[in] aInstance
مؤشر إلى مثيل OpenThread.
[in] aChildId
معرّف الطفل أو RLOC16 للمؤسسة الفرعية المرفقة.
[out] aChildInfo
مؤشر إلى المكان الذي يتم وضع المعلومات الفرعية فيه.
قيم الإرجاع
OT_ERROR_NONE
تم تعديل aChildInfo بنجاح باستخدام المعلومات المتعلقة بالمعرّف المحدّد.
OT_ERROR_NOT_FOUND
ليس هناك طفل صالح يحمل رقم تعريف الطفل هذا.
OT_ERROR_INVALID_ARGS
إذا كانت قيمة aChildInfo فارغة.

otthreadGetChildInfoByIndex

otError otThreadGetChildInfoByIndex(
  otInstance *aInstance,
  uint16_t aChildIndex,
  otChildInfo *aChildInfo
)

تحتفظ الدالة بالمعلومات التشخيصية لطفل فرعي مرفق من خلال فهرس الجدول الداخلي.

التفاصيل
المعلَمات
[in] aInstance
مؤشر إلى مثيل OpenThread.
[in] aChildIndex
فهرس الجدول.
[out] aChildInfo
مؤشر إلى المكان الذي يتم وضع المعلومات الفرعية فيه.
قيم الإرجاع
OT_ERROR_NONE
تم تعديل aChildInfo بنجاح باستخدام المعلومات الخاصة بالفهرس المحدّد.
OT_ERROR_NOT_FOUND
ليس هناك عنصر ثانوي صالح في هذا الفهرس.
OT_ERROR_INVALID_ARGS
إما aChildInfo فارغ، أو aChildIndex خارج النطاق (أعلى من فهرس الجدول الأقصى).
راجع أيضًا:
otGetMaxAllowedChilds

otthreadGetChildNextIp6Address

otError otThreadGetChildNextIp6Address(
  otInstance *aInstance,
  uint16_t aChildIndex,
  otChildIp6AddressIterator *aIterator,
  otIp6Address *aAddress
)

تحصل هذه الدالة على عنوان IPv6 التالي (باستخدام المكرر) لمستخدم محدد.

التفاصيل
المعلَمات
[in] aInstance
مؤشر إلى مثيل OpenThread.
[in] aChildIndex
الفهرس الفرعي.
[in,out] aIterator
مؤشر للتكرار. في حالة النجاح، سيتم تحديث المكرر للإشارة إلى الإدخال التالي في القائمة. للحصول على أول عنوان IPv6، يجب ضبط المكرر على OT_CHILD_IP6_ADDRESS_ITERATOR_INIT.
[out] aAddress
مؤشر إلى عنوان IPv6 حيث يتم وضع العنوان التالي لطفلك (عند النجاح).
قيم الإرجاع
OT_ERROR_NONE
تم العثور على عنوان IPv6 التالي بنجاح (تم تحديث aAddress بنجاح).
OT_ERROR_NOT_FOUND
ليس لدى الطفل إدخال عنوان لاحق في IPv6.
OT_ERROR_INVALID_ARGS
aIterator أو aAddress فارغ، أو أن الطفل في aChildIndex غير صالح.
راجع أيضًا:
otthreadGetChildInfoByIndex

otthreadGetContextIdReuseDelay

uint32_t otThreadGetContextIdReuseDelay(
  otInstance *aInstance
)

احصل على معلمة Context_ID_REUSE_STATUS في دور القائد.

التفاصيل
المعلَمات
[in] aInstance
مؤشر إلى مثيل OpenThread.
طلبات الإرجاع
قيمة Context_ID_REUSE_INTERVAL.
اطّلع أيضًا على:
otthreadSetIdIdReuseDelay

otthreadGetJoinerUdpPort

uint16_t otThreadGetJoinerUdpPort(
  otInstance *aInstance
)

احصل على منفذ UDP UDP.

التفاصيل
المعلَمات
[in] aInstance
مؤشر إلى مثيل OpenThread.
طلبات الإرجاع
رقم منفذ UDP المستخدم.
اطّلع أيضًا على:
otthreadSetJoinerUdpPort

otthreadGetLocalleaderweight

uint8_t otThreadGetLocalLeaderWeight(
  otInstance *aInstance
)

يمكنك استخدام "قائد سلاسل المحادثات" عند العمل في دور القائد.

التفاصيل
المعلَمات
[in] aInstance
مؤشر إلى مثيل OpenThread.
طلبات الإرجاع
قيمة الوزن لقائد سلسلة المحادثات.
اطّلع أيضًا على:
otthreadSetleaderweight

otthreadGetMaxAllowedChild

uint16_t otThreadGetMaxAllowedChildren(
  otInstance *aInstance
)

الحصول على الحد الأقصى لعدد الأطفال المسموح بهم حاليًا.

التفاصيل
المعلَمات
[in] aInstance
مؤشر إلى مثيل OpenThread.
طلبات الإرجاع
الحد الأقصى لعدد الأطفال المسموح بهم حاليًا.
يُرجى الاطلاع أيضًا على:
otthreadSetMaxAllowedChild

otسلاسلGetMaxIIAddresses

uint8_t otThreadGetMaxChildIpAddresses(
  otInstance *aInstance
)

تحصل هذه الدالة على الحد الأقصى لعدد عناوين IP التي قد يسجّلها كل طفل MTD في هذا الجهاز كأحد الوالدين.

التفاصيل
المعلَمات
[in] aInstance
مؤشر إلى مثيل OpenThread.
طلبات الإرجاع
الحد الأقصى لعدد عناوين IP التي قد يسجّلها كل جهاز MTD فرعي مع هذا الجهاز كأحد الوالدين.
اطّلع أيضًا على:
otthreadSetMaxIIAddressAddresses

otthreadGetMaxRouterId

uint8_t otThreadGetMaxRouterId(
  otInstance *aInstance
)

تعرض الدالة الحدّ الأقصى المسموح به لمعرّف التوجيه.

التفاصيل
المعلَمات
[in] aInstance
مؤشر إلى مثيل OpenThread.
طلبات الإرجاع
الحدّ الأقصى المسموح به لمعرّف جهاز التوجيه.

otthreadGetNetworkIdTimeout

uint8_t otThreadGetNetworkIdTimeout(
  otInstance *aInstance
)

الحصول على المعلمة NETWORK_ID_TIMEOUT المستخدمة في دور جهاز التوجيه.

التفاصيل
المعلَمات
[in] aInstance
مؤشر إلى مثيل OpenThread.
طلبات الإرجاع
قيمة NETWORK_ID_TIMEOUT.
اطّلع أيضًا على:
otthreadSetIdIdTimeout

otthreadGetNextCacheEntry

otError otThreadGetNextCacheEntry(
  otInstance *aInstance,
  otCacheEntryInfo *aEntryInfo,
  otCacheEntryIterator *aIterator
)

تحصل هذه الدالة على إدخال ذاكرة التخزين المؤقت التالي في EID (باستخدام المكرر).

التفاصيل
المعلَمات
[in] aInstance
مؤشر إلى مثيل OpenThread.
[out] aEntryInfo
مؤشر إلى المكان الذي يتم فيه وضع معلومات إدخال EID لذاكرة التخزين المؤقت.
[in,out] aIterator
مؤشر للتكرار. وسيتم تحديثه للإشارة إلى الإدخال التالي بنجاح. للحصول على الإدخال الأول، يمكنك إعداد المكرر من خلال ضبط جميع حقوله على صفر (على سبيل المثال، memset بنية المكرر على صفر).
قيم الإرجاع
OT_ERROR_NONE
تمت تعبئة aEntryInfo بنجاح لإدخال ذاكرة التخزين المؤقت التالي لـ EID.
OT_ERROR_NOT_FOUND
لن يتم عرض المزيد من الإدخالات في جدول ذاكرة التخزين المؤقت للعنوان.

otthreadGetParentPriority

int8_t otThreadGetParentPriority(
  otInstance *aInstance
)

احصل على الأولوية الرئيسية التي تم تحديدها.

التفاصيل
المعلَمات
[in] aInstance
مؤشر إلى مثيل OpenThread.
طلبات الإرجاع
قيمة الأولوية الرئيسية التي تم تعيينها، - 2 تعني أنه لم يتم تعيينها.
اطّلع أيضًا على:
otthreadSetParentPriority

otthreadGetPreferrerLeaderParttionId

uint32_t otThreadGetPreferredLeaderPartitionId(
  otInstance *aInstance
)

استخدِم "رقم تعريف قسم قائد سلاسل المحادثات" المفضّل عند العمل في دور القائد.

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

otthreadGetPskc

void otThreadGetPskc(
  otInstance *aInstance,
  otPskc *aPskc
)

الحصول على سلسلة المحادثات PSKc

التفاصيل
المعلَمات
[in] aInstance
مؤشر إلى مثيل OpenThread.
[out] aPskc
مؤشر إلى otPskc لعرض سلسلة محادثات PSKc التي تم استردادها
اطّلع أيضًا على:
otthreadSetPskc

otthreadGetPskcRef

otPskcRef otThreadGetPskcRef(
  otInstance *aInstance
)

الحصول على مرجع المفتاح إلى سلسلة محادثات PSKc

تتطلب هذه الدالة تفعيل ميزة وقت الإنشاء OPENTHREAD_CONFIG_PLATFORM_KEY_REFERENCES_ENABLE.

التفاصيل
المعلَمات
[in] aInstance
مؤشر إلى مثيل OpenThread.
طلبات الإرجاع
مرجع المفتاح إلى PSKc
اطّلع أيضًا على:
otthreadSetPskcRef

otthreadGetRouterالرجوع الحد الأدنى

uint8_t otThreadGetRouterDowngradeThreshold(
  otInstance *aInstance
)

استخدِم المَعلمة ROUTER_DOWNGRADE_PERCENTAGE في دور جهاز التوجيه.

التفاصيل
المعلَمات
[in] aInstance
مؤشر إلى مثيل OpenThread.
طلبات الإرجاع
قيمة ROUTER_DOWNGRADE_PERCENTAGE.
يُرجى الاطّلاع أيضًا على:
otthreadSetRouterDECREASEThreshold

otthreadGetRouterIdRANGE

void otThreadGetRouterIdRange(
  otInstance *aInstance,
  uint8_t *aMinRouterId,
  uint8_t *aMaxRouterId
)

تحصل هذه الدالة على نطاق معرّفات جهاز التوجيه المسموح لها بتحديد عُقد ضمن شبكة سلسلة المحادثات.

التفاصيل
المعلَمات
[in] aInstance
مؤشر إلى مثيل OpenThread.
[out] aMinRouterId
الحدّ الأدنى لرقم تعريف جهاز التوجيه
[out] aMaxRouterId
الحدّ الأقصى لعدد أرقام تعريف جهاز التوجيه
اطّلع أيضًا على:
otthreadSetRouterIdRANGE

otthreadGetRouterIdتسلسل

uint8_t otThreadGetRouterIdSequence(
  otInstance *aInstance
)

احصل على تسلسل رقم تعريف جهاز التوجيه الحالي.

التفاصيل
المعلَمات
[in] aInstance
مؤشر إلى مثيل OpenThread.
طلبات الإرجاع
تسلسل رقم تعريف جهاز التوجيه.

otthreadGetRouterInfo

otError otThreadGetRouterInfo(
  otInstance *aInstance,
  uint16_t aRouterId,
  otRouterInfo *aRouterInfo
)

تحتفظ الوظيفة بمعلومات التشخيص لجهاز توجيه سلسلة محادثات معيّن.

التفاصيل
المعلَمات
[in] aInstance
مؤشر إلى مثيل OpenThread.
[in] aRouterId
رقم تعريف جهاز التوجيه أو RLOC16 لجهاز توجيه معيّن.
[out] aRouterInfo
مؤشر إلى مكان وضع جهاز التوجيه
قيم الإرجاع
OT_ERROR_NONE
تم بنجاح استرداد معلومات جهاز التوجيه للمعرّف المحدد.
OT_ERROR_NOT_FOUND
ليس هناك إدخال لجهاز توجيه يحمل المعرّف المحدد.
OT_ERROR_INVALID_ARGS
aRouterInfo فارغ.

otthreadGetRouterSelectionJter

uint8_t otThreadGetRouterSelectionJitter(
  otInstance *aInstance
)

احصل على معلمة ROUTER_SELECTION_JITTER المستخدمة في دور REED/Router.

التفاصيل
المعلَمات
[in] aInstance
مؤشر إلى مثيل OpenThread.
طلبات الإرجاع
قيمة ROUTER_SELECTION_JITTER.
اطّلع أيضًا على:
otthreadSetRouterSelectionJTER

otthreadGetRouterترقية الحد الأدنى

uint8_t otThreadGetRouterUpgradeThreshold(
  otInstance *aInstance
)

احصل على معلمة ROUTER_UPGRADE_INTERVAL المستخدمة في دور REED.

التفاصيل
المعلَمات
[in] aInstance
مؤشر إلى مثيل OpenThread.
طلبات الإرجاع
قيمة ROUTER_UPGRADE_INTERVAL.
يُرجى الاطّلاع أيضًا على:
otthreadSetRouterupgradeThreshold

مؤهّل otthreadIsRouter

bool otThreadIsRouterEligible(
  otInstance *aInstance
)

تحدد هذه الطريقة ما إذا كان الجهاز مؤهلاً لجهاز التوجيه أو لا.

التفاصيل
المعلَمات
[in] aInstance
مؤشر إلى مثيل OpenThread.
قيم الإرجاع
TRUE
إذا كان الجهاز مؤهَّلاً لجهاز التوجيه.
FALSE
إذا لم يكن الجهاز مؤهلاً لجهاز التوجيه.

otthreadRegisterNeighborTableCallback

void otThreadRegisterNeighborTableCallback(
  otInstance *aInstance,
  otNeighborTableCallback aCallback
)

تسجِّل هذه الدالة دالة استدعاء جدول مجاور.

سيتم استدعاء معاودة الاتصال (إذا لم تكن غير فارغة) عند حدوث تغيير في جدول الجيران (على سبيل المثال، إضافة جهة مجاورة أو جهاز توجيه تتم إضافته/إزالتها أو تغيير وضع الطفل الحالي).

وسيتم استبدال المكالمات اللاحقة بهذه الطريقة باستدعاء الاتصال السابق. تجدر الإشارة إلى أنه تم استدعاء هذا الاستدعاء أثناء تحديث الجدول المجاور/الثانوي وعلى otStateChangedCallback دائمًا.

التفاصيل
المعلَمات
[in] aInstance
مؤشر إلى مثيل OpenThread.
[in] aCallback
مؤشر لوظيفة معالج معاودة الاتصال.

otthreadReleaseRouterId

otError otThreadReleaseRouterId(
  otInstance *aInstance,
  uint8_t aRouterId
)

إصدار رقم تعريف جهاز التوجيه الذي خصّصه الجهاز في دور القائد.

التفاصيل
المعلَمات
[in] aInstance
مؤشر إلى مثيل OpenThread.
[in] aRouterId
مُعَرِّفْ جِهَازِ التَّوْجِيهِ لِلْإِصْدَارْ. النطاق الصالح هو [0، 62].
قيم الإرجاع
OT_ERROR_NONE
تم إصدار معرّف جهاز التوجيه بنجاح.
OT_ERROR_INVALID_ARGS
aRouterId ليس ضمن النطاق [0، 62].
OT_ERROR_INVALID_STATE
الجهاز لا يعمل حاليًا كقائد.
OT_ERROR_NOT_FOUND
معرّف جهاز التوجيه غير مخصص حاليًا.

otthreadSetCcmEnabled

void otThreadSetCcmEnabled(
  otInstance *aInstance,
  bool aEnabled
)

تحدّد هذه الدالة ما إذا تم تفويض الجهاز باستخدام إدارة البيانات (CCM).

التفاصيل
المعلَمات
[in] aInstance
مؤشر إلى مثيل OpenThread.
[in] aEnabled
صواب إذا تم تفويض الجهاز باستخدام CCM، بخلاف ذلك، سيتم تعيينه على "خطأ".

otthreadSetContextIdReuseDelay

void otThreadSetContextIdReuseDelay(
  otInstance *aInstance,
  uint32_t aDelay
)

عيّن المعلمة Context_ID_REUSE_STATUS في دور القائد.

التفاصيل
المعلَمات
[in] aInstance
مؤشر إلى مثيل OpenThread.
[in] aDelay
قيمة Context_ID_REUSE_INTERVAL.
راجع أيضًا:
otthreadGetContextIdReuseDelay

otthreadSetJoinerUdpPort

otError otThreadSetJoinerUdpPort(
  otInstance *aInstance,
  uint16_t aJoinerUdpPort
)

اضبط منفذ UDP UDP.

التفاصيل
المعلَمات
[in] aInstance
مؤشر إلى مثيل OpenThread.
[in] aJoinerUdpPort
رقم منفذ UDP المستخدم.
قيم الإرجاع
OT_ERROR_NONE
تم ضبط منفذ UDP الموحدة بنجاح.
اطّلع أيضًا على:
otthreadGetJoinerUdpPort

otthreadSetLocalleaderweight

void otThreadSetLocalLeaderWeight(
  otInstance *aInstance,
  uint8_t aWeight
)

ضبط وزن قائد سلاسل المحادثات عند العمل في دور القائد.

التفاصيل
المعلَمات
[in] aInstance
مؤشر إلى مثيل OpenThread.
[in] aWeight
قيمة الوزن لقائد سلسلة المحادثات.
اطّلع أيضًا على:
otthreadGetLeaderweight

otthreadSetMaxAllowedChild

otError otThreadSetMaxAllowedChildren(
  otInstance *aInstance,
  uint16_t aMaxChildren
)

ضبط الحد الأقصى لعدد الأطفال المسموح بهم حاليًا.

لا يمكن ضبط هذه المعلَمة إلا عند إيقاف عملية بروتوكول سلسلة المحادثات.

التفاصيل
المعلَمات
[in] aInstance
مؤشر إلى مثيل OpenThread.
[in] aMaxChildren
الحد الأقصى المسموح به لعدد الأطفال
قيم الإرجاع
OT_ERROR_NONE
تم ضبط الحد الأقصى
OT_ERROR_INVALID_ARGS
إذا لم يكن aMaxChildren في النطاق [1،OPENHowTo_CONFIG_MLE_MAX_Child].
OT_ERROR_INVALID_STATE
إذا لم يتم إيقاف سلسلة المحادثات.
راجع أيضًا:
otthreadGetMaxAllowedChild

otthreadSetMaxIIAddresses

otError otThreadSetMaxChildIpAddresses(
  otInstance *aInstance,
  uint8_t aMaxIpAddresses
)

تعمل هذه الدالة على إعداد/استعادة الحد الأقصى لعدد عناوين IP التي قد يسجّلها كل جهاز MTD فرعي عبر هذا الجهاز كأحد الوالدين.

التفاصيل
المعلَمات
[in] aInstance
مؤشر إلى مثيل OpenThread.
[in] aMaxIpAddresses
الحد الأقصى لعدد عناوين IP التي قد يسجّلها كل جهاز MTD فرعي مع هذا الجهاز كأحد الوالدين. 0 لمحو الإعداد واستعادة الإعداد التلقائي.
قيم الإرجاع
OT_ERROR_NONE
تم ضبط/محو الرقم بنجاح.
OT_ERROR_INVALID_ARGS
إذا تجاوزت الحد الأقصى المسموح به.
راجع أيضًا:
otthreadGetMaxIIAddressAddresses

otThreadSetNetworkIdTimeout

void otThreadSetNetworkIdTimeout(
  otInstance *aInstance,
  uint8_t aTimeout
)

يمكنك تعيين المعلمة NETWORK_ID_TIMEOUT المستخدمة في دور القائد.

التفاصيل
المعلَمات
[in] aInstance
مؤشر إلى مثيل OpenThread.
[in] aTimeout
قيمة NETWORK_ID_TIMEOUT.
راجع أيضًا:
otthreadGetNetworkIdTimeout

otthreadSetParentPriority

otError otThreadSetParentPriority(
  otInstance *aInstance,
  int8_t aParentPriority
)

حدِّد الأولوية الرئيسية.

التفاصيل
المعلَمات
[in] aInstance
مؤشر إلى مثيل OpenThread.
[in] aParentPriority
قيمة الأولوية الرئيسية.
قيم الإرجاع
OT_ERROR_NONE
تم ضبط أولوية العنصر بنجاح.
OT_ERROR_INVALID_ARGS
إذا لم تكن قيمة الأولوية الرئيسية بين 1 و0 و-1 و-2.
يُرجى الاطّلاع أيضًا على:
otthreadGetParentPriority

otthreadSetPreferrerLeaderParttionId

void otThreadSetPreferredLeaderPartitionId(
  otInstance *aInstance,
  uint32_t aPartitionId
)

اضبط "رقم تعريف قسم قائد سلسلة المحادثات" المُفضَّل عند تشغيله في دور القائد.

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

otthreadSetPreferrerRouterId

otError otThreadSetPreferredRouterId(
  otInstance *aInstance,
  uint8_t aRouterId
)

ضبط معرّف جهاز التوجيه المفضّل

عندما تصبح قائدة/جهاز توجيه، تحاول العُقدة استخدام رقم تعريف جهاز التوجيه هذا. في حال عدم ضبط رقم تعريف جهاز التوجيه المفضّل أو عدم إمكانية استخدامه، يتم اختيار معرّف جهاز توجيه تم إنشاؤه عشوائيًا. لا يمكن ضبط هذه الخاصية إلا عندما يكون دور الجهاز منفصلاً أو موقوفًا.

التفاصيل
المعلَمات
[in] aInstance
مؤشر إلى مثيل OpenThread.
[in] aRouterId
المعرّف المفضّل لجهاز التوجيه
قيم الإرجاع
OT_ERROR_NONE
تم ضبط رقم تعريف جهاز التوجيه المفضل بنجاح.
OT_ERROR_INVALID_STATE
تعذّر الضبط (لم يتم فصل الدور أو إيقافه)

otthreadSetPskc

otError otThreadSetPskc(
  otInstance *aInstance,
  const otPskc *aPskc
)

ضبط سلسلة المحادثات PSKc

لن تنجح هذه الدالة إلا عند إيقاف بروتوكولات سلاسل المحادثات. وسيؤدي استدعاء ناجح لهذه الدالة إلى إبطال مجموعات البيانات التشغيلية النشطة والمُعلّقة في الذاكرة غير المتقلبة.

التفاصيل
المعلَمات
[in] aInstance
مؤشر إلى مثيل OpenThread.
[in] aPskc
مؤشر إلى سلسلة المحادثات PSKc الجديدة
قيم الإرجاع
OT_ERROR_NONE
تم ضبط سلسلة المحادثات PSKc بنجاح.
OT_ERROR_INVALID_STATE
تم تفعيل بروتوكولات سلاسل المحادثات.
اطّلع أيضًا على:
otthreadGetPskc

otthreadSetPskcRef

otError otThreadSetPskcRef(
  otInstance *aInstance,
  otPskcRef aKeyRef
)

ضبط سلسلة المحادثات PSKc

تتطلب هذه الدالة تفعيل ميزة وقت الإنشاء OPENTHREAD_CONFIG_PLATFORM_KEY_REFERENCES_ENABLE.

لن تنجح هذه الدالة إلا عند إيقاف بروتوكولات سلاسل المحادثات. وسيؤدي استدعاء ناجح لهذه الدالة إلى إبطال مجموعات البيانات التشغيلية النشطة والمُعلّقة في الذاكرة غير المتقلبة.

التفاصيل
المعلَمات
[in] aInstance
مؤشر إلى مثيل OpenThread.
[in] aKeyRef
مرجع أساسي لسلسلة المحادثات PSKc الجديدة.
قيم الإرجاع
OT_ERROR_NONE
تم ضبط سلسلة المحادثات PSKc بنجاح.
OT_ERROR_INVALID_STATE
تم تفعيل بروتوكولات سلاسل المحادثات.
اطّلع أيضًا على:
otthreadGetPskcRef

otthreadSetRouterالرجوع الحد الأدنى

void otThreadSetRouterDowngradeThreshold(
  otInstance *aInstance,
  uint8_t aThreshold
)

يمكنك تعيين المعلمة ROUTER_DOWNGRADE_PERCENTAGE المستخدمة في دور القائد.

التفاصيل
المعلَمات
[in] aInstance
مؤشر إلى مثيل OpenThread.
[in] aThreshold
قيمة ROUTER_DOWNGRADE_PERCENTAGE.
يُرجى الاطّلاع أيضًا على:
otthreadGetRouterDECREASEالترتيب

مؤهّل otthreadSetRouterمؤهَّل

otError otThreadSetRouterEligible(
  otInstance *aInstance,
  bool aEligible
)

تحدّد هذه الدالة ما إذا كان الجهاز مؤهلاً لجهاز التوجيه أو لا.

إذا كانت القيمة aEligible كاذبة وكان الجهاز يعمل حاليًا كجهاز توجيه، سيؤدي هذا الاستدعاء إلى فصل الجهاز ومحاولة إعادة ربطه كطفل.

التفاصيل
المعلَمات
[in] aInstance
مؤشر إلى مثيل OpenThread.
[in] aEligible
TRUE لضبط الجهاز على التوجيه الموجَّه أو تعيين خطأ على خطأ بخلاف ذلك.
قيم الإرجاع
OT_ERROR_NONE
تم ضبط الإعداد الموجَّه إلى جهاز التوجيه بنجاح.
OT_ERROR_NOT_CAPABLE
الجهاز غير قادر على أن يصبح جهاز توجيه.

otthreadSetRouterIdRANGE

otError otThreadSetRouterIdRange(
  otInstance *aInstance,
  uint8_t aMinRouterId,
  uint8_t aMaxRouterId
)

تحدّد هذه الدالة نطاق معرّفات جهاز التوجيه المسموح لها بتحديد عُقد ضمن شبكة سلسلة المحادثات.

التفاصيل
المعلَمات
[in] aInstance
مؤشر إلى مثيل OpenThread.
[in] aMinRouterId
الحدّ الأدنى لرقم تعريف جهاز التوجيه
[in] aMaxRouterId
الحدّ الأقصى لعدد أرقام تعريف جهاز التوجيه
قيم الإرجاع
OT_ERROR_NONE
تم ضبط النطاق بنجاح.
OT_ERROR_INVALID_ARGS
{0}MinRouterId > AMaxRouterId، أو إذا كان النطاق غير مشمول في [0, 62].
اطّلع أيضًا على:
otthreadGetRouterIdRANGE

otthreadSetRouterSelectionJter

void otThreadSetRouterSelectionJitter(
  otInstance *aInstance,
  uint8_t aRouterJitter
)

عيِّن معلمة ROUTER_SELECTION_JITTER المستخدمة في دور REED/Router.

التفاصيل
المعلَمات
[in] aInstance
مؤشر إلى مثيل OpenThread.
[in] aRouterJitter
قيمة ROUTER_SELECTION_JITTER.
اطّلع أيضًا على:
otthreadGetRouterSelectionJTER

otthreadSetRouterترقية الحد الأدنى

void otThreadSetRouterUpgradeThreshold(
  otInstance *aInstance,
  uint8_t aThreshold
)

اضبط معلمة ROUTER_UPGRADE_INTERVAL المستخدمة في دور القائد.

التفاصيل
المعلَمات
[in] aInstance
مؤشر إلى مثيل OpenThread.
[in] aThreshold
قيمة ROUTER_UPGRADE_INTERVAL.
يُرجى الاطّلاع أيضًا على:
otthreadGetRouterupgrade Max

otthreadSetSteeringData

void otThreadSetSteeringData(
  otInstance *aInstance,
  const otExtAddress *aExtAddress
)

ضبط بيانات التوجيه خارج النطاق.

يجب ضبط خيار الإعداد OPENTHREAD_CONFIG_MLE_STEERING_DATA_SET_OOB_ENABLE لتفعيل إعداد بيانات التوجيه خارج النطاق.

التفاصيل
المعلَمات
[in] aInstance
مؤشر إلى مثيل OpenThread.
[in] aExtAddress
العنوان المُستخدَم لتعديل بيانات التوجيه. كل الأصفار لمحو بيانات التوجيه (ما مِن بيانات للقيادة). كل 0xFFs لضبط بيانات التوجيه/فلتر التوهج لقبول/السماح للكل. وEUI64 معيّن تتم إضافته بعد ذلك إلى فلتر بيانات/زهر التوجيه الحالي.

otthreadSetthreadCheckCheckEnabled

void otThreadSetThreadVersionCheckEnabled(
  otInstance *aInstance,
  bool aEnabled
)

تحدّد هذه الدالة ما إذا كان الحدّ الأقصى لإصدار التوجيه (TLV) لسياسة الأمان مفعَّلاً (حقل VR).

التفاصيل
المعلَمات
[in] aInstance
مؤشر إلى مثيل OpenThread.
[in] aEnabled
صواب لتفعيل الحد الأدنى لإصدار TLV لسياسة الأمان للتوجيه، أو خطأ بخلاف ذلك.

وحدات ماكرو

OT_CHILD_IP6_ADDRESS_ITERATOR_INIT

 OT_CHILD_IP6_ADDRESS_ITERATOR_INIT 0

أداة تهيئة otChildIP6AddressIterator.

المراجع

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