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

عام

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

ملخص

يوفر ناشر بيانات الشبكة آليات للحد من عدد إدخالات الخدمة و / أو البادئة المماثلة (البادئة على الشبكة أو المسار الخارجي) في بيانات شبكة مؤشر الترابط من خلال مراقبة بيانات الشبكة وإدارة ما إذا كان يجب إضافة أو إزالة الإدخالات أم لا.

تتطلب جميع الوظائف في هذه الوحدة OPENTHREAD_CONFIG_NETDATA_PUBLISHER_ENABLE إلى تمكين.

التعداد

anonymous enum {
OT_NETWORK_DIAGNOSTIC_TLV_EXT_ADDRESS = 0,
OT_NETWORK_DIAGNOSTIC_TLV_SHORT_ADDRESS = 1,
OT_NETWORK_DIAGNOSTIC_TLV_MODE = 2,
OT_NETWORK_DIAGNOSTIC_TLV_TIMEOUT = 3,
OT_NETWORK_DIAGNOSTIC_TLV_CONNECTIVITY = 4,
OT_NETWORK_DIAGNOSTIC_TLV_ROUTE = 5,
OT_NETWORK_DIAGNOSTIC_TLV_LEADER_DATA = 6,
OT_NETWORK_DIAGNOSTIC_TLV_NETWORK_DATA = 7,
OT_NETWORK_DIAGNOSTIC_TLV_IP6_ADDR_LIST = 8,
OT_NETWORK_DIAGNOSTIC_TLV_MAC_COUNTERS = 9,
OT_NETWORK_DIAGNOSTIC_TLV_BATTERY_LEVEL = 14,
OT_NETWORK_DIAGNOSTIC_TLV_SUPPLY_VOLTAGE = 15,
OT_NETWORK_DIAGNOSTIC_TLV_CHILD_TABLE = 16,
OT_NETWORK_DIAGNOSTIC_TLV_CHANNEL_PAGES = 17,
OT_NETWORK_DIAGNOSTIC_TLV_TYPE_LIST = 18,
OT_NETWORK_DIAGNOSTIC_TLV_MAX_CHILD_TIMEOUT = 19
}
تعداد
otDeviceRole {
OT_DEVICE_ROLE_DISABLED = 0,
OT_DEVICE_ROLE_DETACHED = 1,
OT_DEVICE_ROLE_CHILD = 2,
OT_DEVICE_ROLE_ROUTER = 3,
OT_DEVICE_ROLE_LEADER = 4
}
تعداد
يمثل دور جهاز الخيط.
otNetDataPublisherEvent {
OT_NETDATA_PUBLISHER_EVENT_ENTRY_ADDED = 0,
OT_NETDATA_PUBLISHER_EVENT_ENTRY_REMOVED = 1
}
تعداد
يمثل هذا التعداد الأحداث التي تم الإبلاغ عنها من عمليات رد نداء الناشر.
otRoutePreference {
OT_ROUTE_PREFERENCE_LOW = -1,
OT_ROUTE_PREFERENCE_MED = 0,
OT_ROUTE_PREFERENCE_HIGH = 1
}
تعداد
يحدد القيم الصالحة لل mPreference في otExternalRouteConfig و otBorderRouterConfig .

النوع

otBorderRouterConfig typedef
يمثل هذا الهيكل تكوين جهاز توجيه الحدود.
otExternalRouteConfig typedef
يمثل هذا الهيكل تكوين مسار خارجي.
otIpCounters typedef
struct otIpCounters
تمثل هذه البنية عدادات مستوى IP.
otLeaderData typedef
struct otLeaderData
يمثل هذا الهيكل بيانات زعيم الخيط.
otLinkModeConfig typedef
يمثل هذا الهيكل تكوين وضع ارتباط MLE.
otMleCounters typedef
تمثل هذه البنية عدادات Thread MLE.
otNeighborInfoIterator typedef
int16_t
تستخدم للتكرار من خلال جدول الجوار.
otNetDataDnsSrpServicePublisherCallback )(otNetDataPublisherEvent aEvent, void *aContext) typedef
void(*
يحدد نوع مؤشر الوظيفة هذا رد الاتصال المستخدم للإعلام عند إضافة إدخال "خدمة DNS / SRP" إلى بيانات شبكة مؤشر الترابط أو إزالته منها.
otNetDataPrefixPublisherCallback )(otNetDataPublisherEvent aEvent, const otIp6Prefix *aPrefix, void *aContext) typedef
void(*
يحدد نوع مؤشر الوظيفة هذا رد الاتصال المستخدم في التنبيه عند إضافة بادئة (على شبكة أو مسار خارجي) إلى بيانات شبكة مؤشر الترابط أو إزالتها منها.
otNetDataPublisherEvent typedef
يمثل هذا التعداد الأحداث التي تم الإبلاغ عنها من عمليات رد نداء الناشر.
otNetworkDataIterator typedef
uint32_t
تستخدم للتكرار من خلال معلومات بيانات الشبكة.
otNetworkDiagChildEntry typedef
يمثل هذا الهيكل إدخال جدول تابع لتشخيص الشبكة.
otNetworkDiagConnectivity typedef
يمثل هذا الهيكل قيمة اتصال تشخيص الشبكة.
otNetworkDiagIterator typedef
uint16_t
تستخدم للتكرار من خلال TLV لتشخيص الشبكة.
otNetworkDiagMacCounters typedef
تمثل هذه البنية قيمة عدادات Mac لتشخيص الشبكة.
otNetworkDiagRoute typedef
تمثل هذه البنية قيمة TLV لمسار تشخيص الشبكة.
otNetworkDiagRouteData typedef
يمثل هذا الهيكل بيانات مسار تشخيص الشبكة.
otNetworkDiagTlv typedef
يمثل هذا الهيكل TLV لتشخيص الشبكة.
otReceiveDiagnosticGetCallback )(otError aError, otMessage *aMessage, const otMessageInfo *aMessageInfo, void *aContext) typedef
void(*
يتم استدعاء مؤشر الوظيفة هذا عند تلقي استجابة "الحصول على تشخيص الشبكة".
otRoutePreference typedef
يحدد القيم الصالحة لل mPreference في otExternalRouteConfig و otBorderRouterConfig .
otServerConfig typedef
يمثل هذا الهيكل تكوين الخادم.
otServiceConfig typedef
يمثل هذا الهيكل تكوين الخدمة.
otThreadAnycastLocatorCallback )(void *aContext, otError aError, const otIp6Address *aMeshLocalAddress, uint16_t aRloc16) typedef
void(*
هذا النوع ظيفة مؤشر يحدد الاستدعاء لإعلام حصيلة otThreadLocateAnycastDestination() الطلب.
otThreadDiscoveryRequestCallback )(const otThreadDiscoveryRequestInfo *aInfo, void *aContext) typedef
void(*
يتم استدعاء مؤشر الوظيفة هذا في كل مرة يتم فيها تلقي رسالة طلب اكتشاف MLE.
otThreadDiscoveryRequestInfo typedef
تمثل هذه البنية بيانات طلب اكتشاف مؤشر الترابط.
otThreadParentResponseCallback )(otThreadParentResponseInfo *aInfo, void *aContext) typedef
void(*
يتم استدعاء مؤشر الوظيفة هذا في كل مرة يتم فيها تلقي رسالة MLE Parent Response.
otThreadParentResponseInfo typedef
تمثل هذه البنية بيانات MLE Parent Response.

المهام

otNetDataGet ( otInstance *aInstance, bool aStable, uint8_t *aData, uint8_t *aDataLength)
توفر هذه الطريقة نسخة كاملة أو ثابتة من بيانات شبكة مؤشر الترابط الخاصة بالقسم.
otNetDataGetNextOnMeshPrefix ( otInstance *aInstance, otNetworkDataIterator *aIterator, otBorderRouterConfig *aConfig)
تحصل هذه الوظيفة على بادئة On Mesh التالية في بيانات شبكة القسم.
otNetDataGetNextRoute ( otInstance *aInstance, otNetworkDataIterator *aIterator, otExternalRouteConfig *aConfig)
تحصل هذه الوظيفة على المسار الخارجي التالي في بيانات شبكة القسم.
otNetDataGetNextService ( otInstance *aInstance, otNetworkDataIterator *aIterator, otServiceConfig *aConfig)
تحصل هذه الوظيفة على الخدمة التالية في بيانات شبكة القسم.
otNetDataGetStableVersion ( otInstance *aInstance)
uint8_t
احصل على نسخة بيانات الشبكة المستقرة.
otNetDataGetVersion ( otInstance *aInstance)
uint8_t
احصل على إصدار بيانات الشبكة.
otNetDataIsDnsSrpServiceAdded ( otInstance *aInstance)
bool
تشير هذه الوظيفة إلى ما إذا كان قد تمت إضافة إدخال "خدمة DNS / SRP" حاليًا إلى بيانات شبكة مؤشر الترابط أم لا.
otNetDataIsPrefixAdded ( otInstance *aInstance, const otIp6Prefix *aPrefix)
bool
تشير هذه الوظيفة إلى ما إذا كان يتم حاليًا إضافة إدخال بادئة منشورة (مسار متصل أو خارجي) إلى بيانات شبكة مؤشر الترابط أم لا.
otNetDataPublishDnsSrpServiceAnycast ( otInstance *aInstance, uint8_t aSequenceNUmber)
void
تطلب هذه الوظيفة "DNS / SRP Service Anycast Address" ليتم نشرها في بيانات شبكة مؤشر الترابط.
otNetDataPublishDnsSrpServiceUnicast ( otInstance *aInstance, const otIp6Address *aAddress, uint16_t aPort)
void
تطلب هذه الوظيفة "DNS / SRP Service Unicast Address" ليتم نشرها في بيانات شبكة مؤشر الترابط.
otNetDataPublishDnsSrpServiceUnicastMeshLocalEid ( otInstance *aInstance, uint16_t aPort)
void
تطلب هذه الوظيفة "DNS / SRP Service Unicast Address" ليتم نشرها في بيانات شبكة مؤشر الترابط.
otNetDataPublishExternalRoute ( otInstance *aInstance, const otExternalRouteConfig *aConfig)
تطلب هذه الوظيفة نشر بادئة مسار خارجية في بيانات شبكة الموضوع.
otNetDataPublishOnMeshPrefix ( otInstance *aInstance, const otBorderRouterConfig *aConfig)
تطلب هذه الوظيفة نشر بادئة على الشبكة في بيانات شبكة الموضوع.
otNetDataSetDnsSrpServicePublisherCallback ( otInstance *aInstance, otNetDataDnsSrpServicePublisherCallback aCallback, void *aContext)
void
تقوم هذه الوظيفة بتعيين رد اتصال للإعلام عند إضافة "خدمة DNS / SRP" المنشورة بالفعل إلى بيانات شبكة مؤشر الترابط أو إزالتها منها.
otNetDataSetPrefixPublisherCallback ( otInstance *aInstance, otNetDataPrefixPublisherCallback aCallback, void *aContext)
void
تقوم هذه الوظيفة بتعيين رد اتصال للإعلام عند إضافة إدخال بادئة منشورة بالفعل إلى بيانات شبكة مؤشر الترابط أو إزالتها منها.
otNetDataSteeringDataCheckJoiner ( otInstance *aInstance, const otExtAddress *aEui64)
تحقق مما إذا كانت بيانات التوجيه تتضمن رابطًا.
otNetDataSteeringDataCheckJoinerWithDiscerner ( otInstance *aInstance, const struct otJoinerDiscerner *aDiscerner)
تحقق مما إذا كانت بيانات التوجيه تتضمن رابطًا بقيمة مميزة معينة.
otNetDataUnpublishDnsSrpService ( otInstance *aInstance)
void
تقوم هذه الوظيفة بإلغاء نشر أي إدخال "خدمة DNS / SRP (Anycast أو Unicast)" مضاف مسبقًا من بيانات شبكة مؤشر الترابط.
otNetDataUnpublishPrefix ( otInstance *aInstance, const otIp6Prefix *aPrefix)
تقوم هذه الوظيفة بإلغاء نشر بادئة منشورة مسبقًا (مسار على الشبكة أو خارجي).
otThreadBecomeChild ( otInstance *aInstance)
حاول إعادة التوصيل كطفل.
otThreadBecomeDetached ( otInstance *aInstance)
فصل من شبكة الموضوع.
otThreadDeviceRoleToString ( otDeviceRole aRole)
const char *
تحويل دور الجهاز إلى سلسلة يمكن للبشر قراءتها.
otThreadDiscover ( otInstance *aInstance, uint32_t aScanChannels, uint16_t aPanId, bool aJoiner, bool aEnableEui64Filtering, otHandleActiveScanResult aCallback, void *aCallbackContext)
تبدأ هذه الوظيفة في فحص Thread Discovery.
otThreadGetChildTimeout ( otInstance *aInstance)
uint32_t
احصل على مهلة Thread Child المستخدمة عند التشغيل في دور الطفل.
otThreadGetDeviceRole ( otInstance *aInstance)
احصل على دور الجهاز.
otThreadGetDomainName ( otInstance *aInstance)
const char *
احصل على اسم مجال الموضوع.
otThreadGetExtendedPanId ( otInstance *aInstance)
احصل على IEEE 802.15.4 Extended PAN ID.
otThreadGetFixedDuaInterfaceIdentifier ( otInstance *aInstance)
احصل على معرف الواجهة المحدد يدويًا لعنوان الإرسال الأحادي لمجال الموضوع.
otThreadGetIp6Counters ( otInstance *aInstance)
const otIpCounters *
احصل على عدادات IPv6.
otThreadGetKeySequenceCounter ( otInstance *aInstance)
uint32_t
احصل على ThKeySequenceCounter.
otThreadGetKeySwitchGuardTime ( otInstance *aInstance)
uint32_t
احصل على thrKeySwitchGuardTime.
otThreadGetLeaderData ( otInstance *aInstance, otLeaderData *aLeaderData)
هذه الوظيفة تحصل على بيانات زعيم الخيط.
otThreadGetLeaderRloc ( otInstance *aInstance, otIp6Address *aLeaderRloc)
تقوم هذه الوظيفة بإرجاع مؤشر إلى قائمة RLOC الخاصة بالقائد.
otThreadGetLeaderRouterId ( otInstance *aInstance)
uint8_t
احصل على معرف جهاز التوجيه الخاص بالزعيم.
otThreadGetLeaderWeight ( otInstance *aInstance)
uint8_t
احصل على وزن القائد.
otThreadGetLinkLocalAllThreadNodesMulticastAddress ( otInstance *aInstance)
const otIp6Address *
تقوم هذه الوظيفة بإرجاع عنوان الإرسال المتعدد لـ Thread Link-Local All Thread Nodes.
otThreadGetLinkLocalIp6Address ( otInstance *aInstance)
const otIp6Address *
تقوم هذه الوظيفة بإرجاع عنوان IPv6 المحلي لرابط الموضوع.
otThreadGetLinkMode ( otInstance *aInstance)
احصل على تكوين وضع ارتباط MLE.
otThreadGetMeshLocalEid ( otInstance *aInstance)
const otIp6Address *
تقوم هذه الوظيفة بإرجاع مؤشر إلى عنوان Mesh Local EID.
otThreadGetMeshLocalPrefix ( otInstance *aInstance)
تقوم هذه الوظيفة بإرجاع مؤشر إلى بادئة الشبكة المحلية.
otThreadGetMleCounters ( otInstance *aInstance)
const otMleCounters *
احصل على عدادات الخيط MLE.
otThreadGetNetworkKey ( otInstance *aInstance, otNetworkKey *aNetworkKey)
void
احصل على مفتاح شبكة الموضوع.
otThreadGetNetworkKeyRef ( otInstance *aInstance)
الحصول على otNetworkKeyRef عن الموضوع مفتاح الشبكة.
otThreadGetNetworkName ( otInstance *aInstance)
const char *
احصل على اسم شبكة الموضوع.
otThreadGetNextDiagnosticTlv (const otMessage *aMessage, otNetworkDiagIterator *aIterator, otNetworkDiagTlv *aNetworkDiagTlv)
تحصل هذه الوظيفة على TLV التالي لتشخيص الشبكة في الرسالة.
otThreadGetNextNeighborInfo ( otInstance *aInstance, otNeighborInfoIterator *aIterator, otNeighborInfo *aInfo)
تحصل هذه الوظيفة على معلومات الجار التالية.
otThreadGetParentAverageRssi ( otInstance *aInstance, int8_t *aParentRssi)
تسترد الدالة متوسط ​​RSSI لـ Thread الأصل.
otThreadGetParentInfo ( otInstance *aInstance, otRouterInfo *aParentInfo)
تقوم الوظيفة باسترداد المعلومات التشخيصية لجهاز التوجيه الخيطي باعتباره أحد الوالدين.
otThreadGetParentLastRssi ( otInstance *aInstance, int8_t *aLastRssi)
تسترد الوظيفة RSSI للحزمة الأخيرة من Thread Parent.
otThreadGetPartitionId ( otInstance *aInstance)
uint32_t
احصل على معرف القسم.
otThreadGetRealmLocalAllThreadNodesMulticastAddress ( otInstance *aInstance)
const otIp6Address *
تقوم هذه الدالة بإرجاع عنوان الإرسال المتعدد لـ Thread Realm-Local All Thread Nodes.
otThreadGetRloc ( otInstance *aInstance)
const otIp6Address *
تقوم هذه الدالة بإرجاع مؤشر إلى عنوان "محدد موقع توجيه مؤشر الترابط" (RLOC).
otThreadGetRloc16 ( otInstance *aInstance)
uint16_t
احصل على RLOC16.
otThreadGetServiceAloc ( otInstance *aInstance, uint8_t aServiceId, otIp6Address *aServiceAloc)
تسترد هذه الوظيفة ALOC للخدمة لمعرف الخدمة المحدد.
otThreadGetVersion (void)
uint16_t
تحصل هذه الوظيفة على إصدار بروتوكول الموضوع.
otThreadIsAnycastLocateInProgress ( otInstance *aInstance)
bool
تشير هذه الوظيفة إلى ما إذا كان طلب تحديد موقع anycast قيد التقدم حاليًا.
otThreadIsDiscoverInProgress ( otInstance *aInstance)
bool
تحدد هذه الوظيفة ما إذا كان MLE Thread Discovery قيد التقدم حاليًا.
otThreadIsSingleton ( otInstance *aInstance)
bool
تشير هذه الوظيفة إلى ما إذا كانت العقدة هي جهاز التوجيه الوحيد على الشبكة.
otThreadLocateAnycastDestination ( otInstance *aInstance, const otIp6Address *aAnycastAddress, otThreadAnycastLocatorCallback aCallback, void *aContext)
تطلب هذه الوظيفة تحديد أقرب وجهة لعنوان أي بث.
otThreadRegisterParentResponseCallback ( otInstance *aInstance, otThreadParentResponseCallback aCallback, void *aContext)
void
تسجل هذه الوظيفة رد اتصال لتلقي بيانات MLE Parent Response.
otThreadResetIp6Counters ( otInstance *aInstance)
void
أعد تعيين عدادات IPv6.
otThreadResetMleCounters ( otInstance *aInstance)
void
إعادة تعيين عدادات مؤشر الترابط MLE.
otThreadSendAddressNotification ( otInstance *aInstance, otIp6Address *aDestination, otIp6Address *aTarget, otIp6InterfaceIdentifier *aMlIid)
void
ترسل هذه الوظيفة رسالة إشعار عنوان استباقي (ADDR_NTF.ntf).
otThreadSendDiagnosticGet ( otInstance *aInstance, const otIp6Address *aDestination, const uint8_t aTlvTypes[], uint8_t aCount, otReceiveDiagnosticGetCallback aCallback, void *aCallbackContext)
إرسال طلب الحصول على تشخيص الشبكة.
otThreadSendDiagnosticReset ( otInstance *aInstance, const otIp6Address *aDestination, const uint8_t aTlvTypes[], uint8_t aCount)
إرسال طلب إعادة تعيين تشخيص الشبكة.
otThreadSendProactiveBackboneNotification ( otInstance *aInstance, otIp6Address *aTarget, otIp6InterfaceIdentifier *aMlIid, uint32_t aTimeSinceLastTransaction)
ترسل هذه الوظيفة رسالة إعلام استباقي العمود الفقري (PRO_BB.ntf) على ارتباط العمود الفقري.
otThreadSetChildTimeout ( otInstance *aInstance, uint32_t aTimeout)
void
اضبط مهلة Thread Child المستخدمة عند التشغيل في دور الطفل.
otThreadSetDiscoveryRequestCallback ( otInstance *aInstance, otThreadDiscoveryRequestCallback aCallback, void *aContext)
void
تقوم هذه الوظيفة بتعيين رد اتصال لتلقي بيانات طلب اكتشاف MLE.
otThreadSetDomainName ( otInstance *aInstance, const char *aDomainName)
قم بتعيين اسم مجال مؤشر الترابط.
otThreadSetEnabled ( otInstance *aInstance, bool aEnabled)
تبدأ هذه الوظيفة عملية بروتوكول الموضوع.
otThreadSetExtendedPanId ( otInstance *aInstance, const otExtendedPanId *aExtendedPanId)
قم بتعيين IEEE 802.15.4 Extended PAN ID.
otThreadSetFixedDuaInterfaceIdentifier ( otInstance *aInstance, const otIp6InterfaceIdentifier *aIid)
قم بتعيين / مسح معرف الواجهة المحدد يدويًا لعنوان الإرسال الأحادي لمجال مؤشر الترابط.
otThreadSetJoinerAdvertisement ( otInstance *aInstance, uint32_t aOui, const uint8_t *aAdvData, uint8_t aAdvDataLength)
تقوم هذه الطريقة بتعيين إعلان رابط الموضوع عند اكتشاف شبكة سلاسل الرسائل.
otThreadSetKeySequenceCounter ( otInstance *aInstance, uint32_t aKeySequenceCounter)
void
قم بتعيين thrKeySequenceCounter.
otThreadSetKeySwitchGuardTime ( otInstance *aInstance, uint32_t aKeySwitchGuardTime)
void
قم بتعيين thrKeySwitchGuardTime.
otThreadSetLinkMode ( otInstance *aInstance, otLinkModeConfig aConfig)
قم بتعيين تكوين وضع ارتباط MLE.
otThreadSetMeshLocalPrefix ( otInstance *aInstance, const otMeshLocalPrefix *aMeshLocalPrefix)
تقوم هذه الوظيفة بتعيين بادئة الشبكة المحلية.
otThreadSetNetworkKey ( otInstance *aInstance, const otNetworkKey *aKey)
اضبط مفتاح شبكة الخيط.
otThreadSetNetworkKeyRef ( otInstance *aInstance, otNetworkKeyRef aKeyRef)
تعيين الموضوع مفتاح الشبكة بمثابة otNetworkKeyRef .
otThreadSetNetworkName ( otInstance *aInstance, const char *aNetworkName)
قم بتعيين اسم شبكة الموضوع.

الهياكل

otBorderRouterConfig

يمثل هذا الهيكل تكوين جهاز توجيه الحدود.

otExternalRouteConfig

يمثل هذا الهيكل تكوين مسار خارجي.

otIpCounters

تمثل هذه البنية عدادات مستوى IP.

otLeaderData

يمثل هذا الهيكل بيانات زعيم الخيط.

otLinkModeConfig

يمثل هذا الهيكل تكوين وضع ارتباط MLE.

otMleCounters

تمثل هذه البنية عدادات Thread MLE.

otNeighborInfo

تحتوي هذه البنية على معلومات تشخيصية لعقدة مؤشر ترابط مجاورة.

otNetworkDiagChildEntry

يمثل هذا الهيكل إدخال جدول تشخيص الشبكة التابع.

otNetworkDiagConnectivity

يمثل هذا الهيكل قيمة اتصال تشخيص الشبكة.

otNetworkDiagMacCounters

يمثل هذا الهيكل قيمة عدادات Mac لتشخيص الشبكة.

otNetworkDiagRoute

تمثل هذه البنية قيمة TLV لمسار تشخيص الشبكة.

otNetworkDiagRouteData

يمثل هذا الهيكل بيانات مسار تشخيص الشبكة.

otNetworkDiagTlv

يمثل هذا الهيكل TLV لتشخيص الشبكة.

otRouterInfo

تحتوي هذه البنية على معلومات تشخيصية لجهاز التوجيه الموضوع.

otServerConfig

يمثل هذا الهيكل تكوين الخادم.

otServiceConfig

يمثل هذا الهيكل تكوين الخدمة.

otThreadDiscoveryRequestInfo

تمثل هذه البنية بيانات طلب اكتشاف مؤشر الترابط.

otThreadParentResponseInfo

تمثل هذه البنية بيانات MLE Parent Response.

التعداد

تعداد مجهول

 anonymous enum
الخصائص
OT_NETWORK_DIAGNOSTIC_TLV_BATTERY_LEVEL

مستوى البطارية TLV.

OT_NETWORK_DIAGNOSTIC_TLV_CHANNEL_PAGES

صفحات القناة TLV.

OT_NETWORK_DIAGNOSTIC_TLV_CHILD_TABLE

جدول تابع TLV.

OT_NETWORK_DIAGNOSTIC_TLV_CONNECTIVITY

اتصال TLV.

OT_NETWORK_DIAGNOSTIC_TLV_EXT_ADDRESS

عنوان MAC الممتد TLV.

OT_NETWORK_DIAGNOSTIC_TLV_IP6_ADDR_LIST

قائمة عناوين IPv6 TLV.

OT_NETWORK_DIAGNOSTIC_TLV_LEADER_DATA

زعيم البيانات TLV.

OT_NETWORK_DIAGNOSTIC_TLV_MAC_COUNTERS

عدادات MAC TLV.

OT_NETWORK_DIAGNOSTIC_TLV_MAX_CHILD_TIMEOUT

الحد الأقصى لمهلة الطفل TLV.

OT_NETWORK_DIAGNOSTIC_TLV_MODE

الوضع TLV.

OT_NETWORK_DIAGNOSTIC_TLV_NETWORK_DATA

بيانات الشبكة TLV.

OT_NETWORK_DIAGNOSTIC_TLV_ROUTE

Route64 TLV.

OT_NETWORK_DIAGNOSTIC_TLV_SHORT_ADDRESS

العنوان 16 TLV.

OT_NETWORK_DIAGNOSTIC_TLV_SUPPLY_VOLTAGE

توريد الجهد TLV.

OT_NETWORK_DIAGNOSTIC_TLV_TIMEOUT

Timeout TLV (أقصى فترة زمنية للاقتراع لـ SEDs)

OT_NETWORK_DIAGNOSTIC_TLV_TYPE_LIST

اكتب قائمة TLV.

otDeviceRole

 otDeviceRole

يمثل دور جهاز الخيط.

الخصائص
OT_DEVICE_ROLE_CHILD

دور الطفل الخيط.

OT_DEVICE_ROLE_DETACHED

لا تشارك حاليًا في شبكة / قسم مؤشر ترابط.

OT_DEVICE_ROLE_DISABLED

تم تعطيل مكدس الخيط.

OT_DEVICE_ROLE_LEADER

دور قائد الخيط.

OT_DEVICE_ROLE_ROUTER

دور جهاز التوجيه الموضوع.

otNetDataPublisherEvent

 otNetDataPublisherEvent

يمثل هذا التعداد الأحداث التي تم الإبلاغ عنها من عمليات رد نداء الناشر.

الخصائص
OT_NETDATA_PUBLISHER_EVENT_ENTRY_ADDED

يتم إضافة الإدخال المنشور إلى بيانات شبكة الموضوع.

OT_NETDATA_PUBLISHER_EVENT_ENTRY_REMOVED

يتم إزالة الإدخال المنشور من بيانات شبكة الموضوع.

otRoutePreference

 otRoutePreference

يحدد القيم الصالحة لل mPreference في otExternalRouteConfig و otBorderRouterConfig .

الخصائص
OT_ROUTE_PREFERENCE_HIGH

الطريق المفضل المفضل.

OT_ROUTE_PREFERENCE_LOW

تفضيل منخفض للطريق.

OT_ROUTE_PREFERENCE_MED

تفضيل المسار المتوسط.

النوع

otBorderRouterConfig

struct otBorderRouterConfig otBorderRouterConfig

يمثل هذا الهيكل تكوين جهاز توجيه الحدود.

otExternalRouteConfig

struct otExternalRouteConfig otExternalRouteConfig

يمثل هذا الهيكل تكوين مسار خارجي.

otIpCounters

struct otIpCounters otIpCounters

تمثل هذه البنية عدادات مستوى IP.

otLeaderData

struct otLeaderData otLeaderData

يمثل هذا الهيكل بيانات زعيم الخيط.

otLinkModeConfig

struct otLinkModeConfig otLinkModeConfig

يمثل هذا الهيكل تكوين وضع ارتباط MLE.

otMleCounters

struct otMleCounters otMleCounters

تمثل هذه البنية عدادات Thread MLE.

otNeighborInfoIterator

int16_t otNeighborInfoIterator

تستخدم للتكرار من خلال جدول الجوار.

otNetDataDnsSrpServicePublisherCallback

void(* otNetDataDnsSrpServicePublisherCallback)(otNetDataPublisherEvent aEvent, void *aContext)

يحدد نوع مؤشر الوظيفة هذا رد الاتصال المستخدم للإعلام عند إضافة إدخال "خدمة DNS / SRP" إلى بيانات شبكة مؤشر الترابط أو إزالته منها.

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

تفاصيل
العوامل
[in] aEvent
يشير إلى الحدث (سواء تمت إضافة الإدخال أو إزالته).
[in] aContext
مؤشر إلى سياق خاص بالتطبيق.

otNetDataPrefixPublisherCallback

void(* otNetDataPrefixPublisherCallback)(otNetDataPublisherEvent aEvent, const otIp6Prefix *aPrefix, void *aContext)

يحدد نوع مؤشر الوظيفة هذا رد الاتصال المستخدم في التنبيه عند إضافة بادئة (على شبكة أو مسار خارجي) إلى بيانات شبكة مؤشر الترابط أو إزالتها منها.

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

تفاصيل
العوامل
[in] aEvent
يشير إلى الحدث (سواء تمت إضافة الإدخال أو إزالته).
[in] aPrefix
مؤشر إلى إدخال البادئة.
[in] aContext
مؤشر إلى سياق خاص بالتطبيق.

otNetDataPublisherEvent

enum otNetDataPublisherEvent otNetDataPublisherEvent

يمثل هذا التعداد الأحداث التي تم الإبلاغ عنها من عمليات رد نداء الناشر.

otNetworkDataIterator

uint32_t otNetworkDataIterator

تستخدم للتكرار من خلال معلومات بيانات الشبكة.

otNetworkDiagChildEntry

struct otNetworkDiagChildEntry otNetworkDiagChildEntry

يمثل هذا الهيكل إدخال جدول تابع لتشخيص الشبكة.

otNetworkDiagConnectivity

struct otNetworkDiagConnectivity otNetworkDiagConnectivity

يمثل هذا الهيكل قيمة اتصال تشخيص الشبكة.

otNetworkDiagIterator

uint16_t otNetworkDiagIterator

تستخدم للتكرار من خلال TLV لتشخيص الشبكة.

otNetworkDiagMacCounters

struct otNetworkDiagMacCounters otNetworkDiagMacCounters

يمثل هذا الهيكل قيمة عدادات Mac لتشخيص الشبكة.

انظر RFC 2863 للحصول على تعريفات الحقول الأعضاء.

otNetworkDiagRoute

struct otNetworkDiagRoute otNetworkDiagRoute

تمثل هذه البنية قيمة TLV لمسار تشخيص الشبكة.

otNetworkDiagRouteData

struct otNetworkDiagRouteData otNetworkDiagRouteData

يمثل هذا الهيكل بيانات مسار تشخيص الشبكة.

otNetworkDiagTlv

struct otNetworkDiagTlv otNetworkDiagTlv

يمثل هذا الهيكل TLV لتشخيص الشبكة.

otReceiveDiagnosticGetCallback

void(* otReceiveDiagnosticGetCallback)(otError aError, otMessage *aMessage, const otMessageInfo *aMessageInfo, void *aContext)

يتم استدعاء مؤشر الوظيفة هذا عند تلقي استجابة "الحصول على تشخيص الشبكة".

تفاصيل
العوامل
[in] aError
الخطأ عندما فشل في الحصول على الرد.
[in] aMessage
مؤشر إلى المخزن المؤقت للرسائل الذي يحتوي على حمولة استجابة تشخيص الشبكة المستلمة. متاح فقط عندما aError هو OT_ERROR_NONE .
[in] aMessageInfo
مؤشر إلى المعلومات رسالة ل aMessage . متاح فقط عندما aError هو OT_ERROR_NONE .
[in] aContext
مؤشر إلى سياق خاص بالتطبيق.

otRoutePreference

enum otRoutePreference otRoutePreference

يحدد القيم الصالحة لل mPreference في otExternalRouteConfig و otBorderRouterConfig .

otServerConfig

struct otServerConfig otServerConfig

يمثل هذا الهيكل تكوين الخادم.

otServiceConfig

struct otServiceConfig otServiceConfig

يمثل هذا الهيكل تكوين الخدمة.

otThreadAnycastLocator رد الاتصال

void(* otThreadAnycastLocatorCallback)(void *aContext, otError aError, const otIp6Address *aMeshLocalAddress, uint16_t aRloc16)

هذا النوع ظيفة مؤشر يحدد الاستدعاء لإعلام حصيلة otThreadLocateAnycastDestination() الطلب.

تفاصيل
العوامل
[in] aContext
مؤشر إلى سياق عشوائي (يتم توفيره عند تسجيل رد الاتصال).
[in] aError
الخطأ عند معالجة الطلب. OT_ERROR_NONE يشير إلى النجاح. يشير OT_ERROR_RESPONSE_TIMEOUT إلى تعذر العثور على الوجهة. يشير OT_ERROR_ABORT إلى أنه تم إحباط الطلب.
[in] aMeshLocalAddress
مؤشر إلى EID-شبكة محلية من أقرب جهة من عنوان مختلفة الإرسال عندما aError هو OT_ERROR_NONE، NULL خلاف ذلك.
[in] aRloc16
RLOC16 للوجهة إذا تم العثور عليها ، وإلا فهي غير صالحة RLOC16 (0xfffe).

otThreadDiscoveryRequestCallback

void(* otThreadDiscoveryRequestCallback)(const otThreadDiscoveryRequestInfo *aInfo, void *aContext)

يتم استدعاء مؤشر الوظيفة هذا في كل مرة يتم فيها تلقي رسالة طلب اكتشاف MLE.

تفاصيل
العوامل
[in] aInfo
مؤشر إلى بيانات معلومات طلب الاكتشاف.
[in] aContext
مؤشر لسياق تطبيق رد الاتصال.

otThreadDiscoveryRequestInfo

struct otThreadDiscoveryRequestInfo otThreadDiscoveryRequestInfo

تمثل هذه البنية بيانات طلب اكتشاف مؤشر الترابط.

otThreadParentResponseCallback

void(* otThreadParentResponseCallback)(otThreadParentResponseInfo *aInfo, void *aContext)

يتم استدعاء مؤشر الوظيفة هذا في كل مرة يتم فيها تلقي رسالة MLE Parent Response.

تفاصيل
العوامل
[in] aStats
مؤشر إلى موقع على المكدس يحتفظ ببيانات الإحصائيات.
[in] aContext
مؤشر لسياق رد الاتصال الخاص بالعميل.

otThreadParentResponseInfo

struct otThreadParentResponseInfo otThreadParentResponseInfo

تمثل هذه البنية بيانات MLE Parent Response.

المهام

otNetDataGet

otError otNetDataGet(
  otInstance *aInstance,
  bool aStable,
  uint8_t *aData,
  uint8_t *aDataLength
)

توفر هذه الطريقة نسخة كاملة أو ثابتة من بيانات شبكة مؤشر الترابط الخاصة بالقسم.

تفاصيل
العوامل
[in] aInstance
مؤشر إلى مثيل OpenThread.
[in] aStable
صحيح عند نسخ الإصدار الثابت ، خطأ عند نسخ النسخة الكاملة.
[out] aData
مؤشر إلى مخزن البيانات المؤقت.
[in,out] aDataLength
عند الدخول، وحجم المخزن المؤقت للبيانات المشار إليه بواسطة aData . عند الخروج ، عدد البايت المنسوخ.

otNetDataGetNextOnMeshPrefix

otError otNetDataGetNextOnMeshPrefix(
  otInstance *aInstance,
  otNetworkDataIterator *aIterator,
  otBorderRouterConfig *aConfig
)

تحصل هذه الوظيفة على بادئة On Mesh التالية في بيانات شبكة القسم.

تفاصيل
العوامل
[in] aInstance
مؤشر إلى مثيل OpenThread.
[in,out] aIterator
مؤشر إلى سياق مكرر بيانات الشبكة. للحصول على أول إدخال على الشبكة ، يجب ضبطه على OT_NETWORK_DATA_ITERATOR_INIT.
[out] aConfig
مؤشر إلى مكان وضع معلومات "البادئة على الشبكة".
إرجاع القيم
OT_ERROR_NONE
تم العثور على بادئة On Mesh التالية بنجاح.
OT_ERROR_NOT_FOUND
لا توجد بادئة On Mesh لاحقة في بيانات شبكة الموضوع.

otNetDataGetNextRoute

otError otNetDataGetNextRoute(
  otInstance *aInstance,
  otNetworkDataIterator *aIterator,
  otExternalRouteConfig *aConfig
)

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

تفاصيل
العوامل
[in] aInstance
مؤشر إلى مثيل OpenThread.
[in,out] aIterator
مؤشر إلى سياق مكرر بيانات الشبكة. للحصول على أول إدخال مسار خارجي ، يجب ضبطه على OT_NETWORK_DATA_ITERATOR_INIT.
[out] aConfig
مؤشر إلى مكان وضع معلومات المسار الخارجي.
إرجاع القيم
OT_ERROR_NONE
تم العثور بنجاح على المسار الخارجي التالي.
OT_ERROR_NOT_FOUND
لا يوجد إدخال توجيه خارجي لاحق موجود في بيانات شبكة مؤشر الترابط.

otNetDataGetNextService

otError otNetDataGetNextService(
  otInstance *aInstance,
  otNetworkDataIterator *aIterator,
  otServiceConfig *aConfig
)

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

تفاصيل
العوامل
[in] aInstance
مؤشر إلى مثيل OpenThread.
[in,out] aIterator
مؤشر إلى سياق مكرر بيانات الشبكة. للحصول على إدخال الخدمة الأول ، يجب ضبطه على OT_NETWORK_DATA_ITERATOR_INIT.
[out] aConfig
مؤشر إلى مكان وضع معلومات الخدمة.
إرجاع القيم
OT_ERROR_NONE
تم العثور على الخدمة التالية بنجاح.
OT_ERROR_NOT_FOUND
لا توجد خدمة لاحقة موجودة في بيانات شبكة القسم.

otNetDataGetStableVersion

uint8_t otNetDataGetStableVersion(
  otInstance *aInstance
)

احصل على نسخة بيانات الشبكة المستقرة.

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

otNetDataGetVersion

uint8_t otNetDataGetVersion(
  otInstance *aInstance
)

احصل على إصدار بيانات الشبكة.

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

تمت إضافة otNetDataIsDnsSrpService

bool otNetDataIsDnsSrpServiceAdded(
  otInstance *aInstance
)

تشير هذه الوظيفة إلى ما إذا كان قد تمت إضافة إدخال "خدمة DNS / SRP" حاليًا إلى بيانات شبكة مؤشر الترابط أم لا.

تتطلب هذه الوظيفة ميزة OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE إلى تمكين.

تفاصيل
العوامل
[in] aInstance
مؤشر إلى مثيل OpenThread.
إرجاع القيم
TRUE
يضاف إدخال خدمة DNS / SRP المنشور إلى بيانات شبكة مؤشر الترابط.
FALSE
لا يتم إضافة الإدخال إلى "بيانات شبكة الاتصال" أو لا يوجد إدخال للنشر.

otNetDataIsPrefix تمت الإضافة

bool otNetDataIsPrefixAdded(
  otInstance *aInstance,
  const otIp6Prefix *aPrefix
)

تشير هذه الوظيفة إلى ما إذا كان يتم حاليًا إضافة إدخال بادئة منشورة (مسار متصل أو خارجي) إلى بيانات شبكة مؤشر الترابط أم لا.

تتطلب هذه الوظيفة ميزة OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE إلى تمكين.

تفاصيل
العوامل
[in] aInstance
مؤشر إلى مثيل OpenThread.
[in] aPrefix
مؤشر إلى البادئة (يجب ألا يكون فارغًا).
إرجاع القيم
TRUE
يتم إضافة إدخال البادئة المنشورة إلى بيانات شبكة مؤشر الترابط.
FALSE
لا يتم إضافة الإدخال إلى "بيانات شبكة الاتصال" أو لا يوجد إدخال للنشر.

otNetDataPublishDnsSrpServiceAnycast

void otNetDataPublishDnsSrpServiceAnycast(
  otInstance *aInstance,
  uint8_t aSequenceNUmber
)

تطلب هذه الوظيفة "DNS / SRP Service Anycast Address" ليتم نشرها في بيانات شبكة مؤشر الترابط.

تتطلب هذه الوظيفة ميزة OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE إلى تمكين.

وهناك دعوة لهذه الوظيفة إزالة واستبدال أي السابق "/ خدمة SRP DNS" الدخول التي تم نشرها (من دعوة سابقة إلى أي من otNetDataPublishDnsSrpService{Type}() وظائف).

تفاصيل
العوامل
[in] aInstance
مؤشر إلى مثيل OpenThread.
[in] aSequenceNUmber
الرقم التسلسلي لـ DNS / SRP Anycast Service.

otNetDataPublishDnsSrpServiceUnicast

void otNetDataPublishDnsSrpServiceUnicast(
  otInstance *aInstance,
  const otIp6Address *aAddress,
  uint16_t aPort
)

تطلب هذه الوظيفة "DNS / SRP Service Unicast Address" ليتم نشرها في بيانات شبكة مؤشر الترابط.

تتطلب هذه الوظيفة ميزة OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE إلى تمكين.

وهناك دعوة لهذه الوظيفة إزالة واستبدال أي السابق "/ خدمة SRP DNS" الدخول التي تم نشرها (من دعوة سابقة إلى أي من otNetDataPublishDnsSrpService{Type}() وظائف).

تنشر هذه الوظيفة "عنوان الإرسال الموحد لخدمة DNS / SRP" من خلال تضمين العنوان ومعلومات المنفذ في بيانات TLV للخدمة.

تفاصيل
العوامل
[in] aInstance
مؤشر إلى مثيل OpenThread.
[in] aAddress
عنوان خادم DNS / SRP المراد نشره (يجب ألا يكون فارغًا).
[in] aPort
رقم منفذ خادم SRP المراد نشره.

otNetDataPublishDnsSrpServiceUnicastMeshLocalEid

void otNetDataPublishDnsSrpServiceUnicastMeshLocalEid(
  otInstance *aInstance,
  uint16_t aPort
)

تطلب هذه الوظيفة "DNS / SRP Service Unicast Address" ليتم نشرها في بيانات شبكة مؤشر الترابط.

تتطلب هذه الوظيفة ميزة OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE إلى تمكين.

وهناك دعوة لهذه الوظيفة إزالة واستبدال أي السابق "/ خدمة SRP DNS" الدخول التي تم نشرها (من دعوة سابقة إلى أي من otNetDataPublishDnsSrpService{Type}() وظائف).

على عكس otNetDataPublishDnsSrpServiceUnicast() الأمر الذي يتطلب عنوان نشرت أن تعطى ويتضمن معلومات في بيانات الخدمة TLV، تستخدم هذه الوظيفة EID-شبكة المحلية للجهاز وتشمل المعلومات في البيانات خادم TLV.

تفاصيل
العوامل
[in] aInstance
مؤشر إلى مثيل OpenThread.
[in] aPort
رقم منفذ خادم SRP المراد نشره.

otNetDataPublishExternalRoute

otError otNetDataPublishExternalRoute(
  otInstance *aInstance,
  const otExternalRouteConfig *aConfig
)

تطلب هذه الوظيفة نشر بادئة مسار خارجية في بيانات شبكة الموضوع.

تتطلب هذه الوظيفة ميزة OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE إلى تمكين.

يمكن نشر مقالات مستقرة فقط (أي aConfig.mStable يجب أن يكون صحيحا).

تفاصيل
العوامل
[in] aInstance
مؤشر إلى مثيل OpenThread.
[in] aConfig
تكوين المسار الخارجي للنشر (يجب ألا يكون فارغًا).
إرجاع القيم
OT_ERROR_NONE
تم نشر المسار الخارجي بنجاح.
OT_ERROR_INVALID_ARGS
و aConfig غير صالحة (بادئة سيئة، تركيبات العلم غير صالحة، أو غير مستقر).
OT_ERROR_ALREADY
يوجد إدخال بنفس البادئة بالفعل في القائمة المنشورة.
OT_ERROR_NO_BUFS
تعذر تخصيص إدخال للطلب الجديد. الناشر يدعم عدد محدود من إدخالات (مشتركة بين على شبكة البادئة والطريق الخارجي) التي يحددها التكوين OPENTHREAD_CONFIG_NETDATA_PUBLISHER_MAX_PREFIX_ENTRIES .

otNetDataPublishOnMeshPrefix

otError otNetDataPublishOnMeshPrefix(
  otInstance *aInstance,
  const otBorderRouterConfig *aConfig
)

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

تتطلب هذه الوظيفة ميزة OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE إلى تمكين.

يمكن نشر مقالات مستقرة فقط (أي aConfig.mStable يجب أن يكون صحيحا).

تفاصيل
العوامل
[in] aInstance
مؤشر إلى مثيل OpenThread.
[in] aConfig
تهيئة البادئة على الشبكة المراد نشرها (يجب ألا تكون فارغة).
إرجاع القيم
OT_ERROR_NONE
تم نشر البادئة على الشبكة بنجاح.
OT_ERROR_INVALID_ARGS
و aConfig غير صالحة (بادئة سيئة، تركيبات العلم غير صالحة، أو غير مستقر).
OT_ERROR_ALREADY
يوجد إدخال بنفس البادئة بالفعل في القائمة المنشورة.
OT_ERROR_NO_BUFS
تعذر تخصيص إدخال للطلب الجديد. الناشر يدعم عدد محدود من إدخالات (مشتركة بين على شبكة البادئة والطريق الخارجي) التي يحددها التكوين OPENTHREAD_CONFIG_NETDATA_PUBLISHER_MAX_PREFIX_ENTRIES .

otNetDataSetDnsSrpServicePublisherCallback

void otNetDataSetDnsSrpServicePublisherCallback(
  otInstance *aInstance,
  otNetDataDnsSrpServicePublisherCallback aCallback,
  void *aContext
)

تقوم هذه الوظيفة بتعيين رد اتصال للإعلام عند إضافة "خدمة DNS / SRP" المنشورة بالفعل إلى بيانات شبكة مؤشر الترابط أو إزالتها منها.

يحل استدعاء لاحق لهذه الوظيفة محل أي وظيفة رد تم تعيينها مسبقًا.

تتطلب هذه الوظيفة ميزة OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE إلى تمكين.

تفاصيل
العوامل
[in] aInstance
مؤشر إلى مثيل OpenThread.
[in] aCallback
مؤشر وظيفة رد الاتصال (يمكن أن يكون NULL إذا لم تكن هناك حاجة).
[in] aContext
مؤشر إلى سياق التطبيق محددة (تستخدم عند aCallback يتم استدعاء).

otNetDataSetPrefixPublisher رد الاتصال

void otNetDataSetPrefixPublisherCallback(
  otInstance *aInstance,
  otNetDataPrefixPublisherCallback aCallback,
  void *aContext
)

تقوم هذه الوظيفة بتعيين رد اتصال للإعلام عند إضافة إدخال بادئة منشورة بالفعل إلى بيانات شبكة مؤشر الترابط أو إزالتها منها.

يحل استدعاء لاحق لهذه الوظيفة محل أي وظيفة رد تم تعيينها مسبقًا.

تتطلب هذه الوظيفة ميزة OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE إلى تمكين.

تفاصيل
العوامل
[in] aInstance
مؤشر إلى مثيل OpenThread.
[in] aCallback
مؤشر وظيفة رد الاتصال (يمكن أن يكون NULL إذا لم تكن هناك حاجة).
[in] aContext
مؤشر إلى سياق التطبيق محددة (تستخدم عند aCallback يتم استدعاء).

otNetDataSteeringDataCheckJoiner

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

تحقق مما إذا كانت بيانات التوجيه تتضمن رابطًا.

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

otNetDataSteeringDataCheckJoinerWithDiscerner

otError otNetDataSteeringDataCheckJoinerWithDiscerner(
  otInstance *aInstance,
  const struct otJoinerDiscerner *aDiscerner
)

تحقق مما إذا كانت بيانات التوجيه تتضمن رابطًا بقيمة مميزة معينة.

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

otNetDataUnpublishDnsSrpService

void otNetDataUnpublishDnsSrpService(
  otInstance *aInstance
)

تقوم هذه الوظيفة بإلغاء نشر أي إدخال "خدمة DNS / SRP (Anycast أو Unicast)" مضاف مسبقًا من بيانات شبكة مؤشر الترابط.

تتطلب هذه الوظيفة ميزة OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE إلى تمكين.

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

otNetDataUnpublishPrefix

otError otNetDataUnpublishPrefix(
  otInstance *aInstance,
  const otIp6Prefix *aPrefix
)

تقوم هذه الوظيفة بإلغاء نشر بادئة منشورة مسبقًا (مسار على الشبكة أو خارجي).

تتطلب هذه الوظيفة ميزة OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE إلى تمكين.

تفاصيل
العوامل
[in] aInstance
مؤشر إلى مثيل OpenThread.
[in] aPrefix
البادئة المراد إلغاء النشر (يجب ألا تكون فارغة).
إرجاع القيم
OT_ERROR_NONE
لم يتم نشر البادئة بنجاح.
OT_ERROR_NOT_FOUND
تعذر العثور على البادئة في القائمة المنشورة.

otThreadBecomeChild

otError otThreadBecomeChild(
  otInstance *aInstance
)

حاول إعادة التوصيل كطفل.

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

otThreadBecome مفصول

otError otThreadBecomeDetached(
  otInstance *aInstance
)

فصل من شبكة الموضوع.

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

otThreadDeviceRoleToString

const char * otThreadDeviceRoleToString(
  otDeviceRole aRole
)

تحويل دور الجهاز إلى سلسلة يمكن للبشر قراءتها.

تفاصيل
العوامل
[in] aRole
دور الجهاز المراد التحويل.
عائدات
سلسلة تمثل aRole .

otThreadDiscover

otError otThreadDiscover(
  otInstance *aInstance,
  uint32_t aScanChannels,
  uint16_t aPanId,
  bool aJoiner,
  bool aEnableEui64Filtering,
  otHandleActiveScanResult aCallback,
  void *aCallbackContext
)

تبدأ هذه الوظيفة في فحص Thread Discovery.

تفاصيل
العوامل
[in] aInstance
مؤشر إلى مثيل OpenThread.
[in] aScanChannels
متجه بت يشير إلى القنوات المراد مسحها (مثل OT_CHANNEL_11_MASK).
[in] aPanId
مرشح PAN ID (تم ضبطه على Broadcast PAN لتعطيل عامل التصفية).
[in] aJoiner
قيمة علامة الانضمام في TLV لطلب الاكتشاف.
[in] aEnableEui64Filtering
TRUE لتصفية الردود على EUI-64 ، أو FALSE خلاف ذلك.
[in] aCallback
مؤشر إلى وظيفة تسمى عند تلقي استجابة اكتشاف MLE أو اكتمال المسح.
[in] aCallbackContext
مؤشر إلى سياق خاص بالتطبيق.
إرجاع القيم
OT_ERROR_NONE
بدأ بنجاح فحص اكتشاف الموضوع.
OT_ERROR_INVALID_STATE
لم يتم تمكين واجهة IPv6 (لم يتم تشغيل netif).
OT_ERROR_NO_BUFS
تعذر تخصيص الرسالة لطلب الاكتشاف.
OT_ERROR_BUSY
فحص اكتشاف الموضوع قيد التقدم بالفعل.

otThreadGetChildTimeout

uint32_t otThreadGetChildTimeout(
  otInstance *aInstance
)

احصل على مهلة Thread Child المستخدمة عند التشغيل في دور الطفل.

تفاصيل
العوامل
[in] aInstance
مؤشر إلى مثيل OpenThread.
عائدات
قيمة مهلة سلسلة الأطفال بالثواني.
أنظر أيضا:
otThreadSetChildTimeout

otThreadGetDeviceRole

otDeviceRole otThreadGetDeviceRole(
  otInstance *aInstance
)

احصل على دور الجهاز.

تفاصيل
العوامل
[in] aInstance
مؤشر إلى مثيل OpenThread.
إرجاع القيم
OT_DEVICE_ROLE_DISABLED
تم تعطيل مكدس الخيط.
OT_DEVICE_ROLE_DETACHED
الجهاز لا يشارك حاليًا في شبكة / قسم مؤشر ترابط.
OT_DEVICE_ROLE_CHILD
يعمل الجهاز حاليًا كجهاز Thread Child.
OT_DEVICE_ROLE_ROUTER
يعمل الجهاز حاليًا كجهاز توجيه خيط.
OT_DEVICE_ROLE_LEADER
يعمل الجهاز حاليًا كقائد سلسلة الرسائل.

otThreadGetDomainName

const char * otThreadGetDomainName(
  otInstance *aInstance
)

احصل على اسم مجال الموضوع.

هذه الوظيفة متاحة فقط منذ الإصدار 1.2.

تفاصيل
العوامل
[in] aInstance
مؤشر إلى مثيل OpenThread.
عائدات
مؤشر إلى اسم مجال مؤشر الترابط.
أنظر أيضا:
otThreadSetDomainName

otThreadGetExtendedPanId

const otExtendedPanId * otThreadGetExtendedPanId(
  otInstance *aInstance
)

احصل على IEEE 802.15.4 Extended PAN ID.

تفاصيل
العوامل
[in] aInstance
مؤشر إلى مثيل OpenThread.
عائدات
مؤشر إلى IEEE 802.15.4 Extended PAN ID.
أنظر أيضا:
otThreadSetExtendedPanId

otThreadGetFixedDuaInterfaceIdentifier

const otIp6InterfaceIdentifier * otThreadGetFixedDuaInterfaceIdentifier(
  otInstance *aInstance
)

احصل على معرف الواجهة المحدد يدويًا لعنوان الإرسال الأحادي لمجال الموضوع.

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

تفاصيل
العوامل
[in] aInstance
مؤشر إلى مثيل OpenThread.
عائدات
مؤشر لمعرف الواجهة الذي تم تعيينه يدويًا ، أو NULL إذا لم يتم تعيين أي شيء.
أنظر أيضا:
otThreadSetFixedDuaInterfaceIdentifier

otThreadGetIp6Counters

const otIpCounters * otThreadGetIp6Counters(
  otInstance *aInstance
)

احصل على عدادات IPv6.

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

otThreadGetKeySequenceCounter

uint32_t otThreadGetKeySequenceCounter(
  otInstance *aInstance
)

احصل على ThKeySequenceCounter.

تفاصيل
العوامل
[in] aInstance
مؤشر إلى مثيل OpenThread.
عائدات
قيمة thrKeySequenceCounter.
أنظر أيضا:
otThreadSetKeySequenceCounter

otThreadGetKeySwitchGuardTime

uint32_t otThreadGetKeySwitchGuardTime(
  otInstance *aInstance
)

احصل على thrKeySwitchGuardTime.

تفاصيل
العوامل
[in] aInstance
مؤشر إلى مثيل OpenThread.
عائدات
قيمة thrKeySwitchGuardTime (بالساعات).
أنظر أيضا:
otThreadSetKeySwitchGuardTime

otThreadGetLeaderData

otError otThreadGetLeaderData(
  otInstance *aInstance,
  otLeaderData *aLeaderData
)

هذه الوظيفة تحصل على بيانات زعيم الخيط.

تفاصيل
العوامل
[in] aInstance
مؤشر إلى مثيل OpenThread.
[out] aLeaderData
مؤشر إلى مكان وضع البيانات السابقة.
إرجاع القيم
OT_ERROR_NONE
تم استرداد بيانات القائد بنجاح.
OT_ERROR_DETACHED
غير مرفق حاليا.

otThreadGetLeaderRloc

otError otThreadGetLeaderRloc(
  otInstance *aInstance,
  otIp6Address *aLeaderRloc
)

تقوم هذه الوظيفة بإرجاع مؤشر إلى قائمة RLOC الخاصة بالقائد.

تفاصيل
العوامل
[in] aInstance
مؤشر إلى مثيل OpenThread.
[out] aLeaderRloc
مؤشر إلى RLOC القائد.
إرجاع القيم
OT_ERROR_NONE
وقد كتب RLOC الأخ القائد بنجاح aLeaderRloc .
OT_ERROR_INVALID_ARGS
aLeaderRloc كان NULL.
OT_ERROR_DETACHED
غير مرفق حاليًا بقسم الموضوع.

otThreadGetLeaderRouterId

uint8_t otThreadGetLeaderRouterId(
  otInstance *aInstance
)

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

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

otThreadGetLeader الوزن

uint8_t otThreadGetLeaderWeight(
  otInstance *aInstance
)

احصل على وزن القائد.

تفاصيل
العوامل
[in] aInstance
مؤشر إلى مثيل OpenThread.
عائدات
وزن القائد.

otThreadGetLinkLocalAllThreadNodesMulticastAddress

const otIp6Address * otThreadGetLinkLocalAllThreadNodesMulticastAddress(
  otInstance *aInstance
)

تقوم هذه الوظيفة بإرجاع عنوان الإرسال المتعدد لـ Thread Link-Local All Thread Nodes.

العنوان هو عنوان البث المتعدد المستند إلى بادئة أحادية الإرسال المحلي [RFC 3306] ، مع:

  • تم ضبط flgs على 3 (P = 1 و T = 1)
  • ضبط النطاق على 2
  • ضبط plen على 64
  • تم ضبط بادئة الشبكة على البادئة المحلية Mesh
  • تم تعيين معرف المجموعة على 1

تفاصيل
العوامل
[in] aInstance
مؤشر إلى مثيل OpenThread.
عائدات
مؤشر إلى عنوان الإرسال المتعدد لـ Thread Link-Local All Thread Nodes.

otThreadGetLinkLocalIp6Address

const otIp6Address * otThreadGetLinkLocalIp6Address(
  otInstance *aInstance
)

تقوم هذه الوظيفة بإرجاع عنوان IPv6 المحلي لربط مؤشر الترابط.

يتم اشتقاق العنوان المحلي لرابط مؤشر الترابط باستخدام IEEE802.15.4 العنوان الموسع كمعرّف واجهة.

تفاصيل
العوامل
[in] aInstance
مؤشر إلى مثيل OpenThread.
عائدات
مؤشر إلى عنوان IPv6 المحلي لرابط الموضوع.

otThreadGetLinkMode

otLinkModeConfig otThreadGetLinkMode(
  otInstance *aInstance
)

احصل على تكوين وضع ارتباط MLE.

تفاصيل
العوامل
[in] aInstance
مؤشر إلى مثيل OpenThread.
عائدات
تكوين وضع ارتباط MLE.
أنظر أيضا:
otThreadSetLinkMode

otThreadGetMeshLocalEid

const otIp6Address * otThreadGetMeshLocalEid(
  otInstance *aInstance
)

تقوم هذه الوظيفة بإرجاع مؤشر إلى عنوان Mesh Local EID.

تفاصيل
العوامل
[in] aInstance
مؤشر إلى مثيل OpenThread.
عائدات
مؤشر إلى عنوان Mesh Local EID.

otThreadGetMeshLocalPrefix

const otMeshLocalPrefix * otThreadGetMeshLocalPrefix(
  otInstance *aInstance
)

تقوم هذه الوظيفة بإرجاع مؤشر إلى بادئة الشبكة المحلية.

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

otThreadGetMleCounters

const otMleCounters * otThreadGetMleCounters(
  otInstance *aInstance
)

احصل على عدادات الخيط MLE.

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

otThreadGetNetworkKey

void otThreadGetNetworkKey(
  otInstance *aInstance,
  otNetworkKey *aNetworkKey
)

احصل على مفتاح شبكة الموضوع.

تفاصيل
العوامل
[in] aInstance
مؤشر إلى مثيل OpenThread.
[out] aNetworkKey
مؤشر إلى otNetworkkey لإعادة الموضوع الشبكة مفتاح.
أنظر أيضا:
otThreadSetNetworkKey

otThreadGetNetworkKeyRef

otNetworkKeyRef otThreadGetNetworkKeyRef(
  otInstance *aInstance
)

الحصول على otNetworkKeyRef عن الموضوع مفتاح الشبكة.

تتطلب هذه الوظيفة لمرة وبناء ميزة OPENTHREAD_CONFIG_PLATFORM_KEY_REFERENCES_ENABLE إلى تمكين.

تفاصيل
العوامل
[in] aInstance
مؤشر إلى مثيل OpenThread.
عائدات
إشارة إلى مفتاح شبكة الخيط المخزن في الذاكرة.
أنظر أيضا:
otThreadSetNetworkKeyRef

otThreadGetNetworkName

const char * otThreadGetNetworkName(
  otInstance *aInstance
)

احصل على اسم شبكة الموضوع.

تفاصيل
العوامل
[in] aInstance
مؤشر إلى مثيل OpenThread.
عائدات
مؤشر إلى اسم شبكة الخيط.
أنظر أيضا:
otThreadSetNetworkName

otThreadGetNextDiagnosticTlv

otError otThreadGetNextDiagnosticTlv(
  const otMessage *aMessage,
  otNetworkDiagIterator *aIterator,
  otNetworkDiagTlv *aNetworkDiagTlv
)

تحصل هذه الوظيفة على TLV التالي لتشخيص الشبكة في الرسالة.

يُسمح باستدعاء لاحق لهذه الوظيفة فقط عندما تكون قيمة الإرجاع الحالية هي OT_ERROR_NONE.

تفاصيل
العوامل
[in] aMessage
مؤشر لرسالة.
[in,out] aIterator
مؤشر لسياق مكرر تشخيص الشبكة. للحصول على أول TLV لتشخيص الشبكة ، يجب ضبطه على OT_NETWORK_DIAGNOSTIC_ITERATOR_INIT.
[out] aNetworkDiagTlv
مؤشر إلى مكان وضع معلومات TLV لتشخيص الشبكة.
إرجاع القيم
OT_ERROR_NONE
تم العثور بنجاح على TLV التالي لتشخيص الشبكة.
OT_ERROR_NOT_FOUND
لا توجد TLV لاحقة لتشخيص الشبكة في الرسالة.
OT_ERROR_PARSE
فشل تحليل تشخيص الشبكة التالي.

otThreadGetNextNeighborInfo

otError otThreadGetNextNeighborInfo(
  otInstance *aInstance,
  otNeighborInfoIterator *aIterator,
  otNeighborInfo *aInfo
)

تحصل هذه الوظيفة على معلومات الجار التالية.

يتم استخدامه لتصفح إدخالات جدول الجوار.

تفاصيل
العوامل
[in] aInstance
مؤشر إلى مثيل OpenThread.
[in,out] aIterator
مؤشر إلى سياق المكرر. للحصول على إدخال الجار الأول ، يجب تعيينه على OT_NEIGHBOR_INFO_ITERATOR_INIT.
[out] aInfo
مؤشر إلى معلومات الجار.
إرجاع القيم
OT_ERROR_NONE
تم العثور على إدخال الجار التالي في الجدول بنجاح.
OT_ERROR_NOT_FOUND
لا يوجد إدخال جار لاحق موجود في الجدول.
OT_ERROR_INVALID_ARGS
aIterator أو aInfo كان NULL.

otThreadGetParentAverageRssi

otError otThreadGetParentAverageRssi(
  otInstance *aInstance,
  int8_t *aParentRssi
)

تسترد الدالة متوسط ​​RSSI لـ Thread الأصل.

تفاصيل
العوامل
[in] aInstance
مؤشر إلى مثيل OpenThread.
[out] aParentRssi
مؤشر إلى المكان الذي يجب وضع RSSI الأصلي فيه.

otThreadGetParentInfo

otError otThreadGetParentInfo(
  otInstance *aInstance,
  otRouterInfo *aParentInfo
)

The function retrieves diagnostic information for a Thread Router as parent.

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.
[out] aParentInfo
A pointer to where the parent router information is placed.

otThreadGetParentLastRssi

otError otThreadGetParentLastRssi(
  otInstance *aInstance,
  int8_t *aLastRssi
)

The function retrieves the RSSI of the last packet from the Thread Parent.

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.
[out] aLastRssi
A pointer to where the last RSSI should be placed.
Return Values
OT_ERROR_NONE
Successfully retrieved the RSSI data.
OT_ERROR_FAILED
Unable to get RSSI data.
OT_ERROR_INVALID_ARGS
aLastRssi is NULL.

otThreadGetPartitionId

uint32_t otThreadGetPartitionId(
  otInstance *aInstance
)

Get the Partition ID.

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.
Returns
The Partition ID.

otThreadGetRealmLocalAllThreadNodesMulticastAddress

const otIp6Address * otThreadGetRealmLocalAllThreadNodesMulticastAddress(
  otInstance *aInstance
)

This function returns the Thread Realm-Local All Thread Nodes multicast address.

The address is a realm-local Unicast Prefix-Based Multcast Address [RFC 3306], with:

  • flgs set to 3 (P = 1 and T = 1)
  • scop set to 3
  • plen set to 64
  • network prefix set to the Mesh Local Prefix
  • group ID set to 1

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.
Returns
A pointer to Thread Realm-Local All Thread Nodes multicast address.

otThreadGetRloc

const otIp6Address * otThreadGetRloc(
  otInstance *aInstance
)

This function returns a pointer to the Thread Routing Locator (RLOC) address.

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.
Returns
A pointer to the Thread Routing Locator (RLOC) address.

otThreadGetRloc16

uint16_t otThreadGetRloc16(
  otInstance *aInstance
)

Get the RLOC16.

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.
Returns
The RLOC16.

otThreadGetServiceAloc

otError otThreadGetServiceAloc(
  otInstance *aInstance,
  uint8_t aServiceId,
  otIp6Address *aServiceAloc
)

This function retrieves the Service ALOC for given Service ID.

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.
[in] aServiceId
Service ID to get ALOC for.
[out] aServiceAloc
A pointer to output the Service ALOC. MUST NOT BE NULL.
Return Values
OT_ERROR_NONE
Successfully retrieved the Service ALOC.
OT_ERROR_DETACHED
The Thread interface is not currently attached to a Thread Partition.

otThreadGetVersion

uint16_t otThreadGetVersion(
  void
)

This function gets the Thread protocol version.

Details
Returns
the Thread protocol version.

otThreadIsAnycastLocateInProgress

bool otThreadIsAnycastLocateInProgress(
  otInstance *aInstance
)

This function indicates whether an anycast locate request is currently in progress.

This function is only available when OPENTHREAD_CONFIG_TMF_ANYCAST_LOCATOR_ENABLE is enabled.

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.
Returns
TRUE if an anycast locate request is currently in progress, FALSE otherwise.

otThreadIsDiscoverInProgress

bool otThreadIsDiscoverInProgress(
  otInstance *aInstance
)

This function determines if an MLE Thread Discovery is currently in progress.

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.

otThreadIsSingleton

bool otThreadIsSingleton(
  otInstance *aInstance
)

This function indicates whether a node is the only router on the network.

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.
Return Values
TRUE
It is the only router in the network.
FALSE
It is a child or is not a single router in the network.

otThreadLocateAnycastDestination

otError otThreadLocateAnycastDestination(
  otInstance *aInstance,
  const otIp6Address *aAnycastAddress,
  otThreadAnycastLocatorCallback aCallback,
  void *aContext
)

This function requests the closest destination of a given anycast address to be located.

This function is only available when OPENTHREAD_CONFIG_TMF_ANYCAST_LOCATOR_ENABLE is enabled.

If a previous request is ongoing, a subsequent call to this function will cancel and replace the earlier request.

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.
[in] aAnycastAddress
The anycast address to locate. MUST NOT be NULL.
[in] aCallback
The callback function to report the result.
[in] aContext
An arbitrary context used with aCallback .
Return Values
OT_ERROR_NONE
The request started successfully. aCallback will be invoked to report the result.
OT_ERROR_INVALID_ARGS
The aAnycastAddress is not a valid anycast address or aCallback is NULL.
OT_ERROR_NO_BUFS
Out of buffer to prepare and send the request message.

otThreadRegisterParentResponseCallback

void otThreadRegisterParentResponseCallback(
  otInstance *aInstance,
  otThreadParentResponseCallback aCallback,
  void *aContext
)

This function registers a callback to receive MLE Parent Response data.

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.
[in] aCallback
A pointer to a function that is called upon receiving an MLE Parent Response message.
[in] aContext
A pointer to callback client-specific context.

otThreadResetIp6Counters

void otThreadResetIp6Counters(
  otInstance *aInstance
)

Reset the IPv6 counters.

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.

otThreadResetMleCounters

void otThreadResetMleCounters(
  otInstance *aInstance
)

Reset the Thread MLE counters.

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.

otThreadSendAddressNotification

void otThreadSendAddressNotification(
  otInstance *aInstance,
  otIp6Address *aDestination,
  otIp6Address *aTarget,
  otIp6InterfaceIdentifier *aMlIid
)

This function sends a Proactive Address Notification (ADDR_NTF.ntf) message.

This function is only available when OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE is enabled.

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.
[in] aDestination
The destination to send the ADDR_NTF.ntf message.
[in] aTarget
The target address of the ADDR_NTF.ntf message.
[in] aMlIid
The ML-IID of the ADDR_NTF.ntf message.

otThreadSendDiagnosticGet

otError otThreadSendDiagnosticGet(
  otInstance *aInstance,
  const otIp6Address *aDestination,
  const uint8_t aTlvTypes[],
  uint8_t aCount,
  otReceiveDiagnosticGetCallback aCallback,
  void *aCallbackContext
)

Send a Network Diagnostic Get request.

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.
[in] aDestination
A pointer to destination address.
[in] aTlvTypes
An array of Network Diagnostic TLV types.
[in] aCount
Number of types in aTlvTypes.
[in] aCallback
A pointer to a function that is called when Network Diagnostic Get response is received or NULL to disable the callback.
[in] aCallbackContext
A pointer to application-specific context.
Return Values
OT_ERROR_NONE
Successfully queued the DIAG_GET.req.
OT_ERROR_NO_BUFS
Insufficient message buffers available to send DIAG_GET.req.

otThreadSendDiagnosticReset

otError otThreadSendDiagnosticReset(
  otInstance *aInstance,
  const otIp6Address *aDestination,
  const uint8_t aTlvTypes[],
  uint8_t aCount
)

Send a Network Diagnostic Reset request.

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.
[in] aDestination
A pointer to destination address.
[in] aTlvTypes
An array of Network Diagnostic TLV types. Currently only Type 9 is allowed.
[in] aCount
Number of types in aTlvTypes
Return Values
OT_ERROR_NONE
Successfully queued the DIAG_RST.ntf.
OT_ERROR_NO_BUFS
Insufficient message buffers available to send DIAG_RST.ntf.

otThreadSendProactiveBackboneNotification

otError otThreadSendProactiveBackboneNotification(
  otInstance *aInstance,
  otIp6Address *aTarget,
  otIp6InterfaceIdentifier *aMlIid,
  uint32_t aTimeSinceLastTransaction
)

This function sends a Proactive Backbone Notification (PRO_BB.ntf) message on the Backbone link.

This function is only available when OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE is enabled.

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.
[in] aTarget
The target address of the PRO_BB.ntf message.
[in] aMlIid
The ML-IID of the PRO_BB.ntf message.
[in] aTimeSinceLastTransaction
Time since last transaction (in seconds).
Return Values
OT_ERROR_NONE
Successfully sent PRO_BB.ntf on backbone link.
OT_ERROR_NO_BUFS
If insufficient message buffers available.

otThreadSetChildTimeout

void otThreadSetChildTimeout(
  otInstance *aInstance,
  uint32_t aTimeout
)

Set the Thread Child Timeout used when operating in the Child role.

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.
[in] aTimeout
The timeout value in seconds.
See also:
otThreadGetChildTimeout

otThreadSetDiscoveryRequestCallback

void otThreadSetDiscoveryRequestCallback(
  otInstance *aInstance,
  otThreadDiscoveryRequestCallback aCallback,
  void *aContext
)

This function sets a callback to receive MLE Discovery Request data.

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.
[in] aCallback
A pointer to a function that is called upon receiving an MLE Discovery Request message.
[in] aContext
A pointer to callback application-specific context.

otThreadSetDomainName

otError otThreadSetDomainName(
  otInstance *aInstance,
  const char *aDomainName
)

Set the Thread Domain Name.

This function is only available since Thread 1.2. This function succeeds only when Thread protocols are disabled.

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.
[in] aDomainName
A pointer to the Thread Domain Name.
Return Values
OT_ERROR_NONE
Successfully set the Thread Domain Name.
OT_ERROR_INVALID_STATE
Thread protocols are enabled.
See also:
otThreadGetDomainName

otThreadSetEnabled

otError otThreadSetEnabled(
  otInstance *aInstance,
  bool aEnabled
)

This function starts Thread protocol operation.

The interface must be up when calling this function.

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.
[in] aEnabled
TRUE if Thread is enabled, FALSE otherwise.
Return Values
OT_ERROR_NONE
Successfully started Thread protocol operation.
OT_ERROR_INVALID_STATE
The network interface was not not up.

otThreadSetExtendedPanId

otError otThreadSetExtendedPanId(
  otInstance *aInstance,
  const otExtendedPanId *aExtendedPanId
)

Set the IEEE 802.15.4 Extended PAN ID.

This function can only be called while Thread protocols are disabled. A successful call to this function invalidates the Active and Pending Operational Datasets in non-volatile memory.

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.
[in] aExtendedPanId
A pointer to the IEEE 802.15.4 Extended PAN ID.
Return Values
OT_ERROR_NONE
Successfully set the Extended PAN ID.
OT_ERROR_INVALID_STATE
Thread protocols are enabled.
See also:
otThreadGetExtendedPanId

otThreadSetFixedDuaInterfaceIdentifier

otError otThreadSetFixedDuaInterfaceIdentifier(
  otInstance *aInstance,
  const otIp6InterfaceIdentifier *aIid
)

Set/Clear the Interface Identifier manually specified for the Thread Domain Unicast Address.

This function is only available since Thread 1.2 when OPENTHREAD_CONFIG_DUA_ENABLE is enabled.

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.
[in] aIid
A pointer to the Interface Identifier to set or NULL to clear.
Return Values
OT_ERROR_NONE
Successfully set/cleared the Interface Identifier.
OT_ERROR_INVALID_ARGS
The specified Interface Identifier is reserved.
See also:
otThreadGetFixedDuaInterfaceIdentifier

otThreadSetJoinerAdvertisement

otError otThreadSetJoinerAdvertisement(
  otInstance *aInstance,
  uint32_t aOui,
  const uint8_t *aAdvData,
  uint8_t aAdvDataLength
)

This method sets the Thread Joiner Advertisement when discovering Thread network.

Thread Joiner Advertisement is used to allow a Joiner to advertise its own application-specific information (such as Vendor ID, Product ID, Discriminator, etc.) via a newly-proposed Joiner Advertisement TLV, and to make this information available to Commissioners or Commissioner Candidates without human interaction.

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.
[in] aOui
The Vendor IEEE OUI value that will be included in the Joiner Advertisement. Only the least significant 3 bytes will be used, and the most significant byte will be ignored.
[in] aAdvData
A pointer to the AdvData that will be included in the Joiner Advertisement.
[in] aAdvDataLength
The length of AdvData in bytes.
Return Values
OT_ERROR_NONE
Successfully set Joiner Advertisement.
OT_ERROR_INVALID_ARGS
Invalid AdvData.

otThreadSetKeySequenceCounter

void otThreadSetKeySequenceCounter(
  otInstance *aInstance,
  uint32_t aKeySequenceCounter
)

Set the thrKeySequenceCounter.

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.
[in] aKeySequenceCounter
The thrKeySequenceCounter value.
See also:
otThreadGetKeySequenceCounter

otThreadSetKeySwitchGuardTime

void otThreadSetKeySwitchGuardTime(
  otInstance *aInstance,
  uint32_t aKeySwitchGuardTime
)

Set the thrKeySwitchGuardTime.

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.
[in] aKeySwitchGuardTime
The thrKeySwitchGuardTime value (in hours).
See also:
otThreadGetKeySwitchGuardTime

otThreadSetLinkMode

otError otThreadSetLinkMode(
  otInstance *aInstance,
  otLinkModeConfig aConfig
)

Set the MLE Link Mode configuration.

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.
[in] aConfig
A pointer to the Link Mode configuration.
Return Values
OT_ERROR_NONE
Successfully set the MLE Link Mode configuration.
See also:
otThreadGetLinkMode

otThreadSetMeshLocalPrefix

otError otThreadSetMeshLocalPrefix(
  otInstance *aInstance,
  const otMeshLocalPrefix *aMeshLocalPrefix
)

This function sets the Mesh Local Prefix.

This function succeeds only when Thread protocols are disabled. A successful call to this function invalidates the Active and Pending Operational Datasets in non-volatile memory.

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.
[in] aMeshLocalPrefix
A pointer to the Mesh Local Prefix.
Return Values
OT_ERROR_NONE
Successfully set the Mesh Local Prefix.
OT_ERROR_INVALID_STATE
Thread protocols are enabled.

otThreadSetNetworkKey

otError otThreadSetNetworkKey(
  otInstance *aInstance,
  const otNetworkKey *aKey
)

Set the Thread Network Key.

This function succeeds only when Thread protocols are disabled. A successful call to this function invalidates the Active and Pending Operational Datasets in non-volatile memory.

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.
[in] aKey
A pointer to a buffer containing the Thread Network Key.
Return Values
OT_ERROR_NONE
Successfully set the Thread Network Key.
OT_ERROR_INVALID_STATE
Thread protocols are enabled.
See also:
otThreadGetNetworkKey

otThreadSetNetworkKeyRef

otError otThreadSetNetworkKeyRef(
  otInstance *aInstance,
  otNetworkKeyRef aKeyRef
)

Set the Thread Network Key as a otNetworkKeyRef .

This function succeeds only when Thread protocols are disabled. A successful call to this function invalidates the Active and Pending Operational Datasets in non-volatile memory.

This function requires the build-time feature OPENTHREAD_CONFIG_PLATFORM_KEY_REFERENCES_ENABLE to be enabled.

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.
[in] aKeyRef
Reference to the Thread Network Key.
Return Values
OT_ERROR_NONE
Successfully set the Thread Network Key.
OT_ERROR_INVALID_STATE
Thread protocols are enabled.
See also:
otThreadGetNetworkKeyRef

otThreadSetNetworkName

otError otThreadSetNetworkName(
  otInstance *aInstance,
  const char *aNetworkName
)

Set the Thread Network Name.

This function succeeds only when Thread protocols are disabled. A successful call to this function invalidates the Active and Pending Operational Datasets in non-volatile memory.

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.
[in] aNetworkName
A pointer to the Thread Network Name.
Return Values
OT_ERROR_NONE
Successfully set the Thread Network Name.
OT_ERROR_INVALID_STATE
Thread protocols are enabled.
See also:
otThreadGetNetworkName

Macros

OT_JOINER_ADVDATA_MAX_LENGTH

 OT_JOINER_ADVDATA_MAX_LENGTH 64

Maximum AdvData Length of Joiner Advertisement.

OT_NEIGHBOR_INFO_ITERATOR_INIT

 OT_NEIGHBOR_INFO_ITERATOR_INIT 0

Initializer for otNeighborInfoIterator.

OT_NETWORK_BASE_TLV_MAX_LENGTH

 OT_NETWORK_BASE_TLV_MAX_LENGTH 254

Maximum value length of Thread Base TLV.

OT_NETWORK_DATA_ITERATOR_INIT

 OT_NETWORK_DATA_ITERATOR_INIT 0

Value to initialize otNetworkDataIterator .

OT_NETWORK_DIAGNOSTIC_CHILD_TABLE_ENTRY_SIZE

 OT_NETWORK_DIAGNOSTIC_CHILD_TABLE_ENTRY_SIZE 3

Size of Network Diagnostic Child Table entry.

OT_NETWORK_DIAGNOSTIC_ITERATOR_INIT

 OT_NETWORK_DIAGNOSTIC_ITERATOR_INIT 0

Initializer for otNetworkDiagIterator.

OT_NETWORK_DIAGNOSTIC_TYPELIST_MAX_ENTRIES

 OT_NETWORK_DIAGNOSTIC_TYPELIST_MAX_ENTRIES 19

Maximum Number of Network Diagnostic TLV Types to Request or Reset.

OT_NETWORK_MAX_ROUTER_ID

 OT_NETWORK_MAX_ROUTER_ID 62

Maximum Router ID.

OT_SERVER_DATA_MAX_SIZE

 OT_SERVER_DATA_MAX_SIZE 248

Max size of Server Data in bytes. Theoretical limit, practically much lower.

OT_SERVICE_DATA_MAX_SIZE

 OT_SERVICE_DATA_MAX_SIZE 252

Max size of Service Data in bytes.