مجموعة البيانات التشغيلية

تتضمن وظائف لواجهة برمجة التطبيقات لمجموعة البيانات التشغيلية.

ملخّص

بالنسبة إلى إصدارات FTD فقط، يشتمل "أداة تحديث مجموعة البيانات" على وظائف لإدارة تعديلات مجموعات البيانات.

بالنسبة إلى إصدارات FTD وMTD، تتضمّن واجهة برمجة التطبيقات لمجموعة البيانات التشغيلية دوال لإدارة مجموعات البيانات النشطة والمعلّقة وTLV لمجموعات البيانات.

عمليات التعداد

otMeshcopTlvType{   OT_MESHCOP_TLV_CHANNEL = 0,   OT_MESHCOP_TLV_PANID = 1,   OT_MESHCOP_TLV_EXTPANID = 2,   OT_MESHCOP_TLV_NETWORKNAME = 3,   OT_MESHCOP_TLV_PSKC = 4,   OT_MESHCOP_TLV_NETWORKKEY = 5,   OT_MESHCOP_TLV_NETWORK_KEY_SEQUENCE = 6,   OT_MESHCOP_TLV_MESHLOCALPREFIX = 7,   OT_MESHCOP_TLV_STEERING_DATA = 8,   OT_MESHCOP_TLV_BORDER_AGENT_RLOC = 9,   OT_MESHCOP_TLV_COMMISSIONER_ID = 10,   OT_MESHCOP_TLV_COMM_SESSION_ID = 11,   OT_MESHCOP_TLV_SECURITYPOLICY = 12,   OT_MESHCOP_TLV_GET = 13,   OT_MESHCOP_TLV_ACTIVETIMESTAMP = 14,   OT_MESHCOP_TLV_COMMISSIONER_UDP_PORT = 15,   OT_MESHCOP_TLV_STATE = 16,   OT_MESHCOP_TLV_JOINER_DTLS = 17,   OT_MESHCOP_TLV_JOINER_UDP_PORT = 18,   OT_MESHCOP_TLV_JOINER_IID = 19,   OT_MESHCOP_TLV_JOINER_RLOC = 20,   OT_MESHCOP_TLV_JOINER_ROUTER_KEK = 21,   OT_MESHCOP_TLV_PROVISIONING_URL = 32,   OT_MESHCOP_TLV_VENDOR_NAME_TLV = 33,   OT_MESHCOP_TLV_VENDOR_MODEL_TLV = 34,   OT_MESHCOP_TLV_VENDOR_SW_VERSION_TLV = 35,   OT_MESHCOP_TLV_VENDOR_DATA_TLV = 36,   OT_MESHCOP_TLV_VENDOR_STACK_VERSION_TLV = 37,   OT_MESHCOP_TLV_UDP_ENCAPSULATION_TLV = 48,   OT_MESHCOP_TLV_IPV6_ADDRESS_TLV = 49,   OT_MESHCOP_TLV_PENDINGTIMESTAMP = 51,   OT_MESHCOP_TLV_DELAYTIMER = 52,   OT_MESHCOP_TLV_CHANNELMASK = 53,   OT_MESHCOP_TLV_COUNT = 54,   OT_MESHCOP_TLV_PERIOD = 55,   OT_MESHCOP_TLV_SCAN_DURATION = 56,   OT_MESHCOP_TLV_ENERGY_LIST = 57,   OT_MESHCOP_TLV_DISCOVERYREQUEST = 128,   OT_MESHCOP_TLV_DISCOVERYRESPONSE = 129,   OT_MESHCOP_TLV_JOINERADVERTISEMENT = 241 }

تعداد يُمثِّل هذا النوع من أنواع الطبقات المتعددة الوسائط (TLV).

تحديدات النوع
otChannelMask	typedef uint32_t يمثّل قناع القناة.
otDatasetMgmtSetCallback)(otError aResult, void *aContext)	typedef void(* يتم استدعاء المؤشر عند استلام ردّ على طلب MGMT_SET أو انتهاء المهلة.
otDatasetUpdaterCallback)(otError aError, void *aContext)	typedef void(* يتم استدعاء مؤشر وظيفة معاودة الاتصال هذا عند انتهاء طلب تعديل مجموعة البيانات، أو الإبلاغ عن حالة نجاح أو إخفاق طلب تعديل مجموعة البيانات.
otExtendedPanId	typedef struct otExtendedPanId يُمثِّل رقم تعريف PAN الموسَّع.
otMeshLocalPrefix	typedef otIp6NetworkPrefix يمثّل بادئة محلية لشبكة متداخلة.
otMeshcopTlvType	typedef enum otMeshcopTlvType يُمثِّل هذا النوع من أنواع الطبقات المتعددة الوسائط (TLV).
otNetworkKey	typedef struct otNetworkKey مفتاح شبكة Thread
otNetworkKeyRef	typedef otCryptoKeyRef يمثل نوع البيانات هذا KeyRef إلى NetworkKey.
otNetworkName	typedef struct otNetworkName يُمثِّل اسم شبكة.
otOperationalDataset	typedef struct otOperationalDataset يُمثِّل مجموعة بيانات تشغيلية نشطة أو معلّقة.
otOperationalDatasetComponents	typedef struct otOperationalDatasetComponents يشير ذلك إلى وجود مكوّنات مختلفة في مجموعة البيانات التشغيلية النشطة أو المعلّقة.
otOperationalDatasetTlvs	typedef struct otOperationalDatasetTlvs يُمثِّل مجموعة بيانات تشغيلية نشطة أو معلّقة.
otPskc	typedef struct otPskc يُمثِّل PSKc.
otPskcRef	typedef otCryptoKeyRef يمثل نوع البيانات هذا KeyRef إلى PSKc.
otSecurityPolicy	typedef struct otSecurityPolicy تمثيل سياسة الأمان.
otTimestamp	typedef struct otTimestamp يمثّل هذا المكوِّن مكوِّن الطابع الزمني لمجموعة بيانات Thread.

المتغيرات
OT_TOOL_PACKED_END	OT_TOOL_PACKED_BEGIN struct otNetworkKey

الدوال
otDatasetConvertToTlvs(const otOperationalDataset *aDataset, otOperationalDatasetTlvs *aDatasetTlvs)	otError تحوِّل مجموعة بيانات تشغيلية معيّنة إلى otOperationalDatasetTlvs.
otDatasetCreateNewNetwork(otInstance *aInstance, otOperationalDataset *aDataset)	otError بالنسبة إلى FTD فقط، يتم إنشاء مجموعة بيانات تشغيلية جديدة لاستخدامها عند إنشاء شبكة جديدة.
otDatasetGeneratePskc(const char *aPassPhrase, const otNetworkName *aNetworkName, const otExtendedPanId *aExtPanId, otPskc *aPskc)	otError تنشئ PSKc من عبارة مرور معيّنة واسم شبكة ورقم تعريف PAN الموسّع.
otDatasetGetActive(otInstance *aInstance, otOperationalDataset *aDataset)	otError الحصول على مجموعة البيانات التشغيلية النشطة.
otDatasetGetActiveTlvs(otInstance *aInstance, otOperationalDatasetTlvs *aDataset)	otError الحصول على مجموعة البيانات التشغيلية النشطة.
otDatasetGetDelayTimerMinimal(otInstance *aInstance)	uint32_t بالنسبة إلى وقت التسليم المؤقت فقط، يتم ضبط موقّت التأخير الأدنى.
otDatasetGetPending(otInstance *aInstance, otOperationalDataset *aDataset)	otError الحصول على مجموعة البيانات التشغيلية المعلّقة.
otDatasetGetPendingTlvs(otInstance *aInstance, otOperationalDatasetTlvs *aDataset)	otError الحصول على مجموعة البيانات التشغيلية المعلّقة.
otDatasetIsCommissioned(otInstance *aInstance)	bool يشير إلى ما إذا كانت هناك شبكة صالحة ضمن مجموعة البيانات التشغيلية النشطة أم لا.
otDatasetParseTlvs(const otOperationalDatasetTlvs *aDatasetTlvs, otOperationalDataset *aDataset)	otError تحليل مجموعة بيانات تشغيلية من otOperationalDatasetTlvs محدَّد.
otDatasetSendMgmtActiveGet(otInstance *aInstance, const otOperationalDatasetComponents *aDatasetComponents, const uint8_t *aTlvTypes, uint8_t aLength, const otIp6Address *aAddress)	otError لإرسال MGMT_ACTIVE_GET.
otDatasetSendMgmtActiveSet(otInstance *aInstance, const otOperationalDataset *aDataset, const uint8_t *aTlvs, uint8_t aLength, otDatasetMgmtSetCallback aCallback, void *aContext)	otError إرسال MGMT_ACTIVE_SET.
otDatasetSendMgmtPendingGet(otInstance *aInstance, const otOperationalDatasetComponents *aDatasetComponents, const uint8_t *aTlvTypes, uint8_t aLength, const otIp6Address *aAddress)	otError إرسال MGMT_PENDING_GET.
otDatasetSendMgmtPendingSet(otInstance *aInstance, const otOperationalDataset *aDataset, const uint8_t *aTlvs, uint8_t aLength, otDatasetMgmtSetCallback aCallback, void *aContext)	otError يتم إرسال MGMT_PENDING_SET.
otDatasetSetActive(otInstance *aInstance, const otOperationalDataset *aDataset)	otError تحدِّد هذه السياسة مجموعة البيانات التشغيلية النشطة.
otDatasetSetActiveTlvs(otInstance *aInstance, const otOperationalDatasetTlvs *aDataset)	otError تحدِّد هذه السياسة مجموعة البيانات التشغيلية النشطة.
otDatasetSetDelayTimerMinimal(otInstance *aInstance, uint32_t aDelayTimerMinimal)	otError بالنسبة إلى وقت التسليم التلقائي فقط، يتم ضبط الحدّ الأدنى لمدة التأخير.
otDatasetSetPending(otInstance *aInstance, const otOperationalDataset *aDataset)	otError تحدِّد هذه السياسة مجموعة البيانات التشغيلية المعلّقة.
otDatasetSetPendingTlvs(otInstance *aInstance, const otOperationalDatasetTlvs *aDataset)	otError تحدِّد هذه السياسة مجموعة البيانات التشغيلية المعلّقة.
otDatasetUpdateTlvs(const otOperationalDataset *aDataset, otOperationalDatasetTlvs *aDatasetTlvs)	otError تُحدّث مجموعة بيانات تشغيلية معينة.
otDatasetUpdaterCancelUpdate(otInstance *aInstance)	void إلغاء طلب تعديل مجموعة بيانات تشغيلية مستمر (إن وُجد).
otDatasetUpdaterIsUpdateOngoing(otInstance *aInstance)	bool تشير هذه السمة إلى ما إذا كان هناك طلب حالي لتعديل مجموعة بيانات للعمليات.
otDatasetUpdaterRequestUpdate(otInstance *aInstance, const otOperationalDataset *aDataset, otDatasetUpdaterCallback aCallback, void *aContext)	otError لطلب تعديل مجموعة البيانات التشغيلية.
otNetworkNameFromString(otNetworkName *aNetworkName, const char *aNameString)	otError لضبط مثيل otNetworkName من سلسلة C محدّدة تم إنهاؤها فارغة.

الهياكل
otExtendedPanId	يُمثِّل رقم تعريف PAN الموسَّع.
otNetworkKey	مفتاح شبكة Thread
otNetworkName	يُمثِّل اسم شبكة.
otOperationalDataset	يُمثِّل مجموعة بيانات تشغيلية نشطة أو معلّقة.
otOperationalDatasetComponents	يشير ذلك إلى وجود مكوّنات مختلفة في مجموعة البيانات التشغيلية النشطة أو المعلّقة.
otOperationalDatasetTlvs	يُمثِّل مجموعة بيانات تشغيلية نشطة أو معلّقة.
otPskc	يُمثِّل PSKc.
otSecurityPolicy	تمثيل سياسة الأمان.
otTimestamp	يمثّل هذا المكوِّن مكوِّن الطابع الزمني لمجموعة بيانات Thread.

عمليات التعداد

otMeshcopTlvType

 otMeshcopTlvType

يُمثِّل هذا النوع من أنواع الطبقات المتعددة الوسائط (TLV).

أماكن إقامة
OT_MESHCOP_TLV_ACTIVETIMESTAMP	الطابع الزمني النشط لـ meshcop TLV
OT_MESHCOP_TLV_BORDER_AGENT_RLOC	محدد مواقع وكيل ميتشوب TLV
OT_MESHCOP_TLV_CHANNEL	قناة meshcop TLV
OT_MESHCOP_TLV_CHANNELMASK	meshcop Channel Mask TLV
OT_MESHCOP_TLV_COMMISSIONER_ID	رقم تعريف المفوَّض في meshcop TLV
OT_MESHCOP_TLV_COMMISSIONER_UDP_PORT	منفذ TLV لمنفذ بروتوكول UDP مع المفوَّض
OT_MESHCOP_TLV_COMM_SESSION_ID	رقم تعريف جلسة مفوَّض meshcop TLV
OT_MESHCOP_TLV_COUNT	عدد الهياكل القابلة للاستبدال (TLV)
OT_MESHCOP_TLV_DELAYTIMER	جهاز ضبط الوقت لتأخير meshcop TLV
OT_MESHCOP_TLV_DISCOVERYREQUEST	طلب استكشاف meshcop TLV
OT_MESHCOP_TLV_DISCOVERYRESPONSE	رسالة TLV للاستجابة الاستكشافية من meshcop
OT_MESHCOP_TLV_ENERGY_LIST	قائمة meshcop Energy List TLV
OT_MESHCOP_TLV_EXTPANID	رقم تعريف التحريك الموسع لـ meshcop TLV
OT_MESHCOP_TLV_GET	meshcop Get TLV
OT_MESHCOP_TLV_IPV6_ADDRESS_TLV	عنوان meshcop IPv6 TLV
OT_MESHCOP_TLV_JOINERADVERTISEMENT	إعلان وصلة meshcop TLV
OT_MESHCOP_TLV_JOINER_DTLS	TLV للتغليف DTLS لـ meshcop Joiner DTLS
OT_MESHCOP_TLV_JOINER_IID	IID TLV لـ meshcop Joiner IID
OT_MESHCOP_TLV_JOINER_RLOC	أداة تحديد موقع جهاز الربط meshcop TLV
OT_MESHCOP_TLV_JOINER_ROUTER_KEK	جهاز توجيه وصلة KEK TLV
OT_MESHCOP_TLV_JOINER_UDP_PORT	منفذ UDP من نوع meshcop Joiner TLV
OT_MESHCOP_TLV_MESHLOCALPREFIX	بادئة قناة Meshhcop Mesh المحلية للبادئة TLV
OT_MESHCOP_TLV_NETWORKKEY	مفتاح شبكة meshcop TLV
OT_MESHCOP_TLV_NETWORKNAME	اسم شبكة meshcop TLV
OT_MESHCOP_TLV_NETWORK_KEY_SEQUENCE	تسلسل مفاتيح شبكة meshcop TLV
OT_MESHCOP_TLV_PANID	معرّف meshcop Pan Id TLV
OT_MESHCOP_TLV_PENDINGTIMESTAMP	الطابع الزمني في انتظار meshcop TLV
OT_MESHCOP_TLV_PERIOD	فترة مياشكوب TLV
OT_MESHCOP_TLV_PROVISIONING_URL	عنوان URL لإدارة الحسابات من meshcop TLV
OT_MESHCOP_TLV_PSKC	ميشوب PSKc TLV
OT_MESHCOP_TLV_SCAN_DURATION	مدة البحث في meshcop TLV
OT_MESHCOP_TLV_SECURITYPOLICY	سياسة أمان meshcop TLV
OT_MESHCOP_TLV_STATE	ميشيوب ستيت TLV
OT_MESHCOP_TLV_STEERING_DATA	بيانات التوجيه للتوجيه من meshcop TLV
OT_MESHCOP_TLV_UDP_ENCAPSULATION_TLV	TLV بتغليف meshcop UDP
OT_MESHCOP_TLV_VENDOR_DATA_TLV	تقرير TLV لبيانات المورِّد
OT_MESHCOP_TLV_VENDOR_MODEL_TLV	نموذج مورد meshcop TLV
OT_MESHCOP_TLV_VENDOR_NAME_TLV	اسم مورّد meshcop TLV
OT_MESHCOP_TLV_VENDOR_STACK_VERSION_TLV	إصدار TLV لحزمة مورد meshcop
OT_MESHCOP_TLV_VENDOR_SW_VERSION_TLV	مورِّد ميسكوب جنوب غرب نسخة TLV

تحديدات النوع

otChannelMask

uint32_t otChannelMask

يمثّل قناع القناة.

otDatasetMgmtSetCallback

void(* otDatasetMgmtSetCallback)(otError aResult, void *aContext)

يتم استدعاء المؤشر عند استلام ردّ على طلب MGMT_SET أو انتهاء المهلة.

التفاصيل
المَعلمات	[in] aResult نتيجة للعملية. [in] aContext مؤشر إلى السياق الخاص بالتطبيق.
قيم الإرجاع	OT_ERROR_NONE قبل القائد الطلب. OT_ERROR_REJECTED رفض القائد الطلب. OT_ERROR_PARSE حدث خطأ أثناء تحليل الردّ. OT_ERROR_ABORT أعاد تطبيق مشابه ضبط الطلب. OT_ERROR_RESPONSE_TIMEOUT لم يتم استلام أي رد أو إقرار خلال فترة المهلة.

otDatasetUpdaterCallback

void(* otDatasetUpdaterCallback)(otError aError, void *aContext)

يتم استدعاء مؤشر وظيفة معاودة الاتصال هذا عند انتهاء طلب تعديل مجموعة البيانات، أو الإبلاغ عن حالة نجاح أو إخفاق طلب تعديل مجموعة البيانات.

تتوفّر هذه الميزة عندما تكون ميزة "OPENTHREAD_CONFIG_DATASET_UPDATER_ENABLE" مفعّلة.

التفاصيل
المَعلمات	[in] aError حالة الخطأ يشير OT_ERROR_NONE إلى نجاح تعديل مجموعة البيانات. تشير OT_ERROR_INVALID_STATE إلى حدوث إخفاق بسبب حالة غير صالحة (يتم إيقاف MLE). يشير OT_ERROR_ALREADY إلى حدوث عطل بسبب جهاز آخر داخل الشبكة يطلب تحديث مجموعة بيانات متعارض. [in] aContext تشير هذه السمة إلى السياق العشوائي (الذي يوفّره المستخدم في otDatasetUpdaterRequestUpdate()).

otExtendedPanId

struct otExtendedPanId otExtendedPanId

يُمثِّل رقم تعريف PAN الموسَّع.

otMeshLocalPrefix

otIp6NetworkPrefix otMeshLocalPrefix

يمثّل بادئة محلية لشبكة متداخلة.

otMeshcopTlvType

enum otMeshcopTlvType otMeshcopTlvType

يُمثِّل هذا النوع من أنواع الطبقات المتعددة الوسائط (TLV).

otNetworkKey

struct otNetworkKey otNetworkKey

مفتاح شبكة Thread

otNetworkKeyRef

otCryptoKeyRef otNetworkKeyRef

يمثل نوع البيانات هذا KeyRef إلى NetworkKey.

الإشارة إلى المفتاح

otNetworkName

struct otNetworkName otNetworkName

يُمثِّل اسم شبكة.

السمة otNetworkName هي سلسلة C منتهية فارغة (أي يجب أن تنتهي مصفوفة أحرف m8 بحرف \0 فارغ).

otOperationalDataset

struct otOperationalDataset otOperationalDataset

يُمثِّل مجموعة بيانات تشغيلية نشطة أو معلّقة.

المكونات في مجموعة البيانات اختيارية. تحدِّد بنية mComponents المكوّنات المتوفّرة في مجموعة البيانات.

otOperationalDatasetComponents

struct otOperationalDatasetComponents otOperationalDatasetComponents

يشير ذلك إلى وجود مكوّنات مختلفة في مجموعة البيانات التشغيلية النشطة أو المعلّقة.

otOperationalDatasetTlvs

struct otOperationalDatasetTlvs otOperationalDatasetTlvs

يُمثِّل مجموعة بيانات تشغيلية نشطة أو معلّقة.

يتم ترميز مجموعة البيانات التشغيلية TLV كما هو محدد بواسطة Thread.

otPskc

struct otPskc otPskc

يُمثِّل PSKc.

otPskcRef

otCryptoKeyRef otPskcRef

يمثل نوع البيانات هذا KeyRef إلى PSKc.

الإشارة إلى المفتاح

otSecurityPolicy

struct otSecurityPolicy otSecurityPolicy

تمثيل سياسة الأمان.

otTimestamp

struct otTimestamp otTimestamp

يمثّل هذا المكوِّن مكوِّن الطابع الزمني لمجموعة بيانات Thread.

المتغيرات

OT_TOOL_PACKED_END

OT_TOOL_PACKED_BEGIN struct otNetworkKey OT_TOOL_PACKED_END

الدوال

otDatasetConvertToTlvs

otError otDatasetConvertToTlvs(
  const otOperationalDataset *aDataset,
  otOperationalDatasetTlvs *aDatasetTlvs
)

تحوِّل مجموعة بيانات تشغيلية معيّنة إلى otOperationalDatasetTlvs.

التفاصيل
المَعلمات	[in] aDataset مجموعة بيانات تشغيلية لتحويلها إلى TLV. [out] aDatasetTlvs مؤشر لـ TLV في مجموعة البيانات لعرض النتيجة.
قيم الإرجاع	OT_ERROR_NONE تم تحويل aDataset بنجاح وتعديل aDatasetTlvs. OT_ERROR_INVALID_ARGS السمة aDataset غير صالحة أو لا تحتوي على طوابع زمنية نشطة أو في انتظار المراجعة.

otDatasetCreateNewNetwork

otError otDatasetCreateNewNetwork(
  otInstance *aInstance,
  otOperationalDataset *aDataset
)

بالنسبة إلى FTD فقط، يتم إنشاء مجموعة بيانات تشغيلية جديدة لاستخدامها عند إنشاء شبكة جديدة.

التفاصيل
المَعلمات	[in] aInstance يشير هذا المصطلح إلى مؤشر لمثيل OpenThread. [out] aDataset مجموعة البيانات التشغيلية.
قيم الإرجاع	OT_ERROR_NONE تم إنشاء مجموعة بيانات تشغيلية جديدة بنجاح. OT_ERROR_FAILED تعذّر إنشاء قيم عشوائية للمعلَمات الجديدة.

otDatasetGeneratePskc

otError otDatasetGeneratePskc(
  const char *aPassPhrase,
  const otNetworkName *aNetworkName,
  const otExtendedPanId *aExtPanId,
  otPskc *aPskc
)

تنشئ PSKc من عبارة مرور معيّنة واسم شبكة ورقم تعريف PAN الموسّع.

وتُستخدَم PSKc لإنشاء جلسة المفوَّض.

التفاصيل
المَعلمات	[in] aPassPhrase عبارة المرور التكليفية. [in] aNetworkName اسم الشبكة لحساب PSKc [in] aExtPanId رقم تعريف PAN الموسَّع لحساب PSKc. [out] aPskc مؤشر إلى متغيّر لإخراج PSKc الذي تم إنشاؤه.
قيم الإرجاع	OT_ERROR_NONE إنشاء PSKc بنجاح. OT_ERROR_INVALID_ARGS إذا كان أي من وسيطات الإدخال غير صالح.

otDatasetGetActive

otError otDatasetGetActive(
  otInstance *aInstance,
  otOperationalDataset *aDataset
)

الحصول على مجموعة البيانات التشغيلية النشطة.

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

otDatasetGetActiveTlvs

otError otDatasetGetActiveTlvs(
  otInstance *aInstance,
  otOperationalDatasetTlvs *aDataset
)

الحصول على مجموعة البيانات التشغيلية النشطة.

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

otDatasetGetDelayTimerMinimal

uint32_t otDatasetGetDelayTimerMinimal(
  otInstance *aInstance
)

بالنسبة إلى وقت التسليم المؤقت فقط، يتم ضبط موقّت التأخير الأدنى.

التفاصيل
المَعلمات	[in] aInstance يشير هذا المصطلح إلى مؤشر لمثيل OpenThread.
قيم الإرجاع	the قيمة الحد الأدنى لموقت التأخير (بالمللي ثانية).

otDatasetGetPending

otError otDatasetGetPending(
  otInstance *aInstance,
  otOperationalDataset *aDataset
)

الحصول على مجموعة البيانات التشغيلية المعلّقة.

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

otDatasetGetPendingTlvs

otError otDatasetGetPendingTlvs(
  otInstance *aInstance,
  otOperationalDatasetTlvs *aDataset
)

الحصول على مجموعة البيانات التشغيلية المعلّقة.

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

otDatasetIsCommissioned

bool otDatasetIsCommissioned(
  otInstance *aInstance
)

يشير إلى ما إذا كانت هناك شبكة صالحة ضمن مجموعة البيانات التشغيلية النشطة أم لا.

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

otDatasetParseTlvs

otError otDatasetParseTlvs(
  const otOperationalDatasetTlvs *aDatasetTlvs,
  otOperationalDataset *aDataset
)

تحليل مجموعة بيانات تشغيلية من otOperationalDatasetTlvs محدَّد.

التفاصيل
المَعلمات	[in] aDatasetTlvs مؤشر لـ TLV في مجموعة البيانات. [out] aDataset يشير ذلك المصطلح إلى المكان الذي سيتم وضع مجموعة البيانات فيه.
قيم الإرجاع	OT_ERROR_NONE تم بنجاح ضبط aDataset من aDatasetTlvs. OT_ERROR_INVALID_ARGS aDatasetTlvs غير صالح.

otDatasetSendMgmtActiveGet

otError otDatasetSendMgmtActiveGet(
  otInstance *aInstance,
  const otOperationalDatasetComponents *aDatasetComponents,
  const uint8_t *aTlvTypes,
  uint8_t aLength,
  const otIp6Address *aAddress
)

لإرسال MGMT_ACTIVE_GET.

التفاصيل
المَعلمات	[in] aInstance يشير هذا المصطلح إلى مؤشر لمثيل OpenThread. [in] aDatasetComponents يشير ذلك المصطلح إلى مؤشر يشير إلى بنية مكوّنات مجموعة البيانات التي تحدِّد المكوّنات التي يجب طلبها. [in] aTlvTypes مؤشر إلى مصفوفة تحتوي على أنواع TLV أولية إضافية مطلوب طلبها. [in] aLength طول aTlvTypes. [in] aAddress مؤشر إلى وجهة IPv6، إذا كانت فارغة، سوف يستخدم Leader ALOC كإعداد تلقائي.
قيم الإرجاع	OT_ERROR_NONE تم إرسال أمر مجموعة بيانات meshcop بنجاح. OT_ERROR_NO_BUFS مساحة التخزين المؤقت غير كافية للإرسال.

otDatasetSendMgmtActiveSet

otError otDatasetSendMgmtActiveSet(
  otInstance *aInstance,
  const otOperationalDataset *aDataset,
  const uint8_t *aTlvs,
  uint8_t aLength,
  otDatasetMgmtSetCallback aCallback,
  void *aContext
)

إرسال MGMT_ACTIVE_SET.

التفاصيل
المَعلمات	[in] aInstance يشير هذا المصطلح إلى مؤشر لمثيل OpenThread. [in] aDataset يشير ذلك المصطلح إلى مجموعة بيانات تشغيلية. [in] aTlvs مؤشر لـ TLV. [in] aLength طول TLV. [in] aCallback يشير ذلك المصطلح إلى دالة يتم استدعاؤها عند تلقّي الاستجابة أو انتهاء المهلة. [in] aContext مؤشر إلى السياق الخاص بالتطبيق لـ aCallback.
قيم الإرجاع	OT_ERROR_NONE تم إرسال أمر مجموعة بيانات meshcop بنجاح. OT_ERROR_NO_BUFS مساحة التخزين المؤقت غير كافية للإرسال. OT_ERROR_BUSY هناك طلب سابق قيد التنفيذ.

otDatasetSendMgmtPendingGet

otError otDatasetSendMgmtPendingGet(
  otInstance *aInstance,
  const otOperationalDatasetComponents *aDatasetComponents,
  const uint8_t *aTlvTypes,
  uint8_t aLength,
  const otIp6Address *aAddress
)

إرسال MGMT_PENDING_GET.

التفاصيل
المَعلمات	[in] aInstance يشير هذا المصطلح إلى مؤشر لمثيل OpenThread. [in] aDatasetComponents يشير ذلك المصطلح إلى مؤشر يشير إلى بنية مكوّنات مجموعة البيانات التي تحدِّد المكوّنات التي يجب طلبها. [in] aTlvTypes مؤشر إلى مصفوفة تحتوي على أنواع TLV أولية إضافية مطلوب طلبها. [in] aLength طول aTlvTypes. [in] aAddress مؤشر إلى وجهة IPv6، إذا كانت فارغة، سوف يستخدم Leader ALOC كإعداد تلقائي.
قيم الإرجاع	OT_ERROR_NONE تم إرسال أمر مجموعة بيانات meshcop بنجاح. OT_ERROR_NO_BUFS مساحة التخزين المؤقت غير كافية للإرسال.

otDatasetSendMgmtPendingSet

otError otDatasetSendMgmtPendingSet(
  otInstance *aInstance,
  const otOperationalDataset *aDataset,
  const uint8_t *aTlvs,
  uint8_t aLength,
  otDatasetMgmtSetCallback aCallback,
  void *aContext
)

يتم إرسال MGMT_PENDING_SET.

التفاصيل
المَعلمات	[in] aInstance يشير هذا المصطلح إلى مؤشر لمثيل OpenThread. [in] aDataset يشير ذلك المصطلح إلى مجموعة بيانات تشغيلية. [in] aTlvs مؤشر لـ TLV. [in] aLength طول TLV. [in] aCallback يشير ذلك المصطلح إلى دالة يتم استدعاؤها عند تلقّي الاستجابة أو انتهاء المهلة. [in] aContext مؤشر إلى السياق الخاص بالتطبيق لـ aCallback.
قيم الإرجاع	OT_ERROR_NONE تم إرسال أمر مجموعة بيانات meshcop بنجاح. OT_ERROR_NO_BUFS مساحة التخزين المؤقت غير كافية للإرسال. OT_ERROR_BUSY هناك طلب سابق قيد التنفيذ.

otDatasetSetActive

otError otDatasetSetActive(
  otInstance *aInstance,
  const otOperationalDataset *aDataset
)

تحدِّد هذه السياسة مجموعة البيانات التشغيلية النشطة.

إذا كانت مجموعة البيانات لا تتضمن طابعًا زمنيًا نشطًا، فإن مجموعة البيانات تكتمل جزئيًا فقط.

إذا تم تفعيل Thread على جهاز يحتوي على مجموعة بيانات نشطة كاملة جزئيًا، سيحاول الجهاز الاتصال بشبكة Thread حالية باستخدام أي معلومات حالية في مجموعة البيانات. تحتاج إلى مفتاح شبكة Thread فقط للتوصيل بالشبكة.

إذا لم يتم تضمين القناة في مجموعة البيانات، سيرسل الجهاز رسائل MLE للإعلان عن القنوات على مستوى القنوات المختلفة للعثور على القنوات المجاورة على قنوات أخرى.

إذا نجح الجهاز في التوصيل بشبكة Thread، سيسترد الجهاز مجموعة البيانات النشطة بالكامل من الشبكة الرئيسية. لاحظ أن الجهاز القابل للتوجيه لن ينتقل إلى دور "جهاز التوجيه" أو "القائد" حتى يحصل على مجموعة بيانات نشطة كاملة.

التفاصيل
المَعلمات	[in] aInstance يشير هذا المصطلح إلى مؤشر لمثيل OpenThread. [in] aDataset يشير ذلك المصطلح إلى "مجموعة البيانات التشغيلية النشطة".
قيم الإرجاع	OT_ERROR_NONE تم بنجاح إعداد مجموعة البيانات التشغيلية النشطة. OT_ERROR_NO_BUFS مساحة التخزين المؤقت غير كافية لإعداد مجموعة البيانات التشغيلية النشطة. OT_ERROR_NOT_IMPLEMENTED لا ينفّذ النظام الأساسي وظيفة الإعدادات.

otDatasetSetActiveTlvs

otError otDatasetSetActiveTlvs(
  otInstance *aInstance,
  const otOperationalDatasetTlvs *aDataset
)

تحدِّد هذه السياسة مجموعة البيانات التشغيلية النشطة.

إذا كانت مجموعة البيانات لا تتضمن طابعًا زمنيًا نشطًا، فإن مجموعة البيانات تكتمل جزئيًا فقط.

إذا تم تفعيل Thread على جهاز يحتوي على مجموعة بيانات نشطة كاملة جزئيًا، سيحاول الجهاز الاتصال بشبكة Thread حالية باستخدام أي معلومات حالية في مجموعة البيانات. تحتاج إلى مفتاح شبكة Thread فقط للتوصيل بالشبكة.

إذا لم يتم تضمين القناة في مجموعة البيانات، سيرسل الجهاز رسائل MLE للإعلان عن القنوات على مستوى القنوات المختلفة للعثور على القنوات المجاورة على قنوات أخرى.

إذا نجح الجهاز في التوصيل بشبكة Thread، سيسترد الجهاز مجموعة البيانات النشطة بالكامل من الشبكة الرئيسية. لاحظ أن الجهاز القابل للتوجيه لن ينتقل إلى دور "جهاز التوجيه" أو "القائد" حتى يحصل على مجموعة بيانات نشطة كاملة.

التفاصيل
المَعلمات	[in] aInstance يشير هذا المصطلح إلى مؤشر لمثيل OpenThread. [in] aDataset يشير ذلك المصطلح إلى "مجموعة البيانات التشغيلية النشطة".
قيم الإرجاع	OT_ERROR_NONE تم بنجاح إعداد مجموعة البيانات التشغيلية النشطة. OT_ERROR_NO_BUFS مساحة التخزين المؤقت غير كافية لإعداد مجموعة البيانات التشغيلية النشطة. OT_ERROR_NOT_IMPLEMENTED لا ينفّذ النظام الأساسي وظيفة الإعدادات.

otDatasetSetDelayTimerMinimal

otError otDatasetSetDelayTimerMinimal(
  otInstance *aInstance,
  uint32_t aDelayTimerMinimal
)

بالنسبة إلى وقت التسليم التلقائي فقط، يتم ضبط الحدّ الأدنى لمدة التأخير.

ملاحظة: إنّ واجهة برمجة التطبيقات هذه مخصّصة لأغراض الاختبار والعرض فقط. سيؤدي تغيير الإعدادات باستخدام واجهة برمجة التطبيقات هذه إلى عرض تطبيق الإنتاج غير المتوافق مع مواصفات Thread.

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

otDatasetSetPending

otError otDatasetSetPending(
  otInstance *aInstance,
  const otOperationalDataset *aDataset
)

تحدِّد هذه السياسة مجموعة البيانات التشغيلية المعلّقة.

التفاصيل
المَعلمات	[in] aInstance يشير هذا المصطلح إلى مؤشر لمثيل OpenThread. [in] aDataset يشير ذلك المصطلح إلى "مجموعة البيانات التشغيلية في انتظار المراجعة".
قيم الإرجاع	OT_ERROR_NONE تم بنجاح إعداد مجموعة البيانات التشغيلية المعلّقة. OT_ERROR_NO_BUFS مساحة مخزن مؤقت غير كافية لإعداد مجموعة بيانات تشغيلية في انتظار المراجعة. OT_ERROR_NOT_IMPLEMENTED لا ينفّذ النظام الأساسي وظيفة الإعدادات.

otDatasetSetPendingTlvs

otError otDatasetSetPendingTlvs(
  otInstance *aInstance,
  const otOperationalDatasetTlvs *aDataset
)

تحدِّد هذه السياسة مجموعة البيانات التشغيلية المعلّقة.

التفاصيل
المَعلمات	[in] aInstance يشير هذا المصطلح إلى مؤشر لمثيل OpenThread. [in] aDataset يشير ذلك المصطلح إلى "مجموعة البيانات التشغيلية في انتظار المراجعة".
قيم الإرجاع	OT_ERROR_NONE تم بنجاح إعداد مجموعة البيانات التشغيلية المعلّقة. OT_ERROR_NO_BUFS مساحة مخزن مؤقت غير كافية لإعداد مجموعة بيانات تشغيلية في انتظار المراجعة. OT_ERROR_NOT_IMPLEMENTED لا ينفّذ النظام الأساسي وظيفة الإعدادات.

otDatasetUpdateTlvs

otError otDatasetUpdateTlvs(
  const otOperationalDataset *aDataset,
  otOperationalDatasetTlvs *aDatasetTlvs
)

تُحدّث مجموعة بيانات تشغيلية معينة.

تحتوي السمة aDataset على الحقول التي سيتم تعديلها وقيمتها الجديدة.

التفاصيل
المَعلمات	[in] aDataset تُحدِّد مجموعة الأنواع والقيم المطلوب تعديلها. [in,out] aDatasetTlvs مؤشر لدالة TLV لمجموعة البيانات المطلوب تعديلها.
قيم الإرجاع	OT_ERROR_NONE تم تعديل aDatasetTlvs بنجاح. OT_ERROR_INVALID_ARGS يحتوي الحقل "aDataset" على قيم غير صالحة. OT_ERROR_NO_BUFS لا تتوفّر مساحة تخزين كافية في "aDatasetTlvs" لتطبيق التحديث.

otDatasetUpdaterCancelUpdate

void otDatasetUpdaterCancelUpdate(
  otInstance *aInstance
)

إلغاء طلب تعديل مجموعة بيانات تشغيلية مستمر (إن وُجد).

تتوفّر هذه الميزة عندما تكون ميزة "OPENTHREAD_CONFIG_DATASET_UPDATER_ENABLE" مفعّلة.

التفاصيل
المَعلمات	[in] aInstance يشير هذا المصطلح إلى مؤشر لمثيل OpenThread.

otDatasetUpdaterIsUpdateOngoing

bool otDatasetUpdaterIsUpdateOngoing(
  otInstance *aInstance
)

تشير هذه السمة إلى ما إذا كان هناك طلب حالي لتعديل مجموعة بيانات للعمليات.

تتوفّر هذه الميزة عندما تكون ميزة "OPENTHREAD_CONFIG_DATASET_UPDATER_ENABLE" مفعّلة.

التفاصيل
المَعلمات	[in] aInstance يشير هذا المصطلح إلى مؤشر لمثيل OpenThread.
قيم الإرجاع	TRUE هناك تحديث جارٍ. FALSE ما مِن تعديلات جارية.

otDatasetUpdaterRequestUpdate

otError otDatasetUpdaterRequestUpdate(
  otInstance *aInstance,
  const otOperationalDataset *aDataset,
  otDatasetUpdaterCallback aCallback,
  void *aContext
)

لطلب تعديل مجموعة البيانات التشغيلية.

تتوفّر هذه الميزة عندما تكون ميزة "OPENTHREAD_CONFIG_DATASET_UPDATER_ENABLE" مفعّلة.

يجب أن تحتوي السمة aDataset على الحقول المراد تعديلها وقيمتها الجديدة. ويجب ألا يحتوي على حقول طابع زمني نشط أو في انتظار المراجعة. حقل "التأخير" اختياري، وفي حال عدم تقديمه، سيتم استخدام قيمة تلقائية (1000 ملي ثانية).

التفاصيل
المَعلمات	[in] aInstance يشير هذا المصطلح إلى مؤشر لمثيل OpenThread. [in] aDataset مؤشر إلى مجموعة البيانات يحتوي على الحقول المطلوب تغييرها. [in] aCallback معاودة الاتصال للإشارة إلى وقت انتهاء طلب تعديل مجموعة البيانات. [in] aContext تم تمرير سياق عشوائي إلى معاودة الاتصال.
قيم الإرجاع	OT_ERROR_NONE بدأ تعديل مجموعة البيانات بنجاح (سيتم استدعاء aCallback عند الانتهاء). OT_ERROR_INVALID_STATE تم إيقاف الجهاز (تم إيقاف MLE). OT_ERROR_INVALID_ARGS aDataset غير صالح (يحتوي على طابع زمني نشط أو في انتظار المراجعة). OT_ERROR_BUSY يتعذّر بدء التحديث لأنّ عملية التحديث السابقة جارية. OT_ERROR_NO_BUFS تعذَّر تخصيص المخزن المؤقت لحفظ مجموعة البيانات.

otNetworkNameFromString

otError otNetworkNameFromString(
  otNetworkName *aNetworkName,
  const char *aNameString
)

لضبط مثيل otNetworkName من سلسلة C محدّدة تم إنهاؤها فارغة.

يجب أن يتّبع aNameString ترميز UTF-8 ويجب ألا يزيد طول اسم الشبكة عن OT_NETWORK_NAME_MAX_SIZE.

التفاصيل
المَعلمات	[out] aNetworkName مؤشر يشير إلى otNetworkName المطلوب ضبطها. [in] aNameString سلسلة للاسم C.
قيم الإرجاع	OT_ERROR_NONE تم بنجاح ضبط aNetworkName من aNameString. OT_ERROR_INVALID_ARGS aNameStrng غير صالح (طويل جدًا أو لا يتّبع ترميز UTF-8).

وحدات ماكرو

OT_CHANNEL_10_MASK

 OT_CHANNEL_10_MASK (1 << 10)

القناة 10

OT_CHANNEL_11_MASK

 OT_CHANNEL_11_MASK (1 << 11)

القناة 11.

OT_CHANNEL_12_MASK

 OT_CHANNEL_12_MASK (1 << 12)

القناة 12.

OT_CHANNEL_13_MASK

 OT_CHANNEL_13_MASK (1 << 13)

القناة 13.

OT_CHANNEL_14_MASK

 OT_CHANNEL_14_MASK (1 << 14)

القناة 14

OT_CHANNEL_15_MASK

 OT_CHANNEL_15_MASK (1 << 15)

القناة 15.

OT_CHANNEL_16_MASK

 OT_CHANNEL_16_MASK (1 << 16)

القناة 16.

OT_CHANNEL_17_MASK

 OT_CHANNEL_17_MASK (1 << 17)

القناة 17

OT_CHANNEL_18_MASK

 OT_CHANNEL_18_MASK (1 << 18)

القناة 18

OT_CHANNEL_19_MASK

 OT_CHANNEL_19_MASK (1 << 19)

القناة 19

OT_CHANNEL_1_MASK

 OT_CHANNEL_1_MASK (1 << 1)

القناة 1.

OT_CHANNEL_20_MASK

 OT_CHANNEL_20_MASK (1 << 20)

القناة 20

OT_CHANNEL_21_MASK

 OT_CHANNEL_21_MASK (1 << 21)

القناة 21

OT_CHANNEL_22_MASK

 OT_CHANNEL_22_MASK (1 << 22)

القناة 22

OT_CHANNEL_23_MASK

 OT_CHANNEL_23_MASK (1 << 23)

القناة 23

OT_CHANNEL_24_MASK

 OT_CHANNEL_24_MASK (1 << 24)

القناة 24

OT_CHANNEL_25_MASK

 OT_CHANNEL_25_MASK (1 << 25)

القناة 25

OT_CHANNEL_26_MASK

 OT_CHANNEL_26_MASK (1 << 26)

القناة 26

OT_CHANNEL_2_MASK

 OT_CHANNEL_2_MASK (1 << 2)

القناة 2

OT_CHANNEL_3_MASK

 OT_CHANNEL_3_MASK (1 << 3)

القناة 3

OT_CHANNEL_4_MASK

 OT_CHANNEL_4_MASK (1 << 4)

القناة 4.

OT_CHANNEL_5_MASK

 OT_CHANNEL_5_MASK (1 << 5)

القناة 5

OT_CHANNEL_6_MASK

 OT_CHANNEL_6_MASK (1 << 6)

القناة 6.

OT_CHANNEL_7_MASK

 OT_CHANNEL_7_MASK (1 << 7)

القناة 7.

OT_CHANNEL_8_MASK

 OT_CHANNEL_8_MASK (1 << 8)

القناة 8.

OT_CHANNEL_9_MASK

 OT_CHANNEL_9_MASK (1 << 9)

القناة 9

OT_EXT_PAN_ID_SIZE

 OT_EXT_PAN_ID_SIZE 8

حجم رقم تعريف PAN في سلسلة المحادثات (بالبايت)

OT_MESH_LOCAL_PREFIX_SIZE

 OT_MESH_LOCAL_PREFIX_SIZE OT_IP6_PREFIX_SIZE

حجم البادئة المحلية المتداخلة (بالبايت)

OT_NETWORK_KEY_SIZE

 OT_NETWORK_KEY_SIZE 16

حجم مفتاح شبكة Thread (بالبايت)

OT_NETWORK_NAME_MAX_SIZE

 OT_NETWORK_NAME_MAX_SIZE 16

الحد الأقصى لحجم حقل Thread Network Name (بالبايت)

OT_OPERATIONAL_DATASET_MAX_LENGTH

 OT_OPERATIONAL_DATASET_MAX_LENGTH 254

الحد الأقصى لطول مجموعة البيانات التشغيلية بالبايت.

OT_PSKC_MAX_SIZE

 OT_PSKC_MAX_SIZE 16

الحد الأقصى لحجم PSKc (بالبايت)

المراجِع

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