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

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

ملخّص

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

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

التعدادات
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
رقم تعريف رقم PAN الموسَّع
otMeshLocalPrefix typedef
يمثل بادئة محلية لشبكة متشابكة.
otMeshcopTlvType typedef
يمثّل أنواع TLV.
otNetworkKey typedef
struct otNetworkKey
يمثل مفتاح شبكة Thread.
otNetworkKeyRef typedef
يمثل نوع البيانات هذا Keyref إلى NetworkKey.
otNetworkName typedef
struct otNetworkName
يمثّل اسم شبكة.
otOperationalDataset typedef
تمثل مجموعة بيانات تشغيلية نشطة أو معلّقة.
otOperationalDatasetComponents typedef
تمثّل وجود مكوّنات مختلفة في مجموعة بيانات تشغيلية أو نشطة في انتظار المراجعة.
otOperationalDatasetTlvs typedef
تمثل مجموعة بيانات تشغيلية نشطة أو معلّقة.
otPskc typedef
struct otPskc
يمثل PSKc.
otPskcRef typedef
يمثل نوع البيانات هذا Keyref إلى PSKc.
otSecurityPolicy typedef
تمثيل سياسة الأمان
otTimestamp typedef
struct otTimestamp
يمثل مكوّن الطابع الزمني لمجموعة بيانات سلسلة المحادثات.

المتغيّرات
OT_TOOL_PACKED_END

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

هياكل
otExtendedPanId

رقم تعريف رقم PAN الموسَّع

otNetworkKey

يمثل مفتاح شبكة Thread.

otNetworkName

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

otOperaativeDataset

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

otOperaativeDatasetComponents

تمثّل وجود مكوّنات مختلفة في مجموعة بيانات تشغيلية أو نشطة في انتظار المراجعة.

otOperaativeDatasetTlvs

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

otPskc

يمثل PSKc.

otSecurityPolicy

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

otTimestamp

يمثل مكوّن الطابع الزمني لمجموعة بيانات سلسلة المحادثات.

التعدادات

otMeshcopTlvType

 otMeshcopTlvType

يمثّل أنواع TLV.

أماكن إقامة
OT_MESHCOP_TLV_ACTIVETIMESTAMP

mshcop Active الطابع الزمني TLV

OT_MESHCOP_TLV_BORDER_AGENT_RLOC

mshcop Border Agent Locator TLV

OT_MESHCOP_TLV_CHANNEL

قناة mshcop Channel TLV

OT_MESHCOP_TLV_CHANNELMASK

قناع قناة TLV

OT_MESHCOP_TLV_COMMISSIONER_ID

رقم تعريف ThcVer الخاص بالمفوضية

OT_MESHCOP_TLV_COMMISSIONER_UDP_PORT

mshcop Commissioner UDP Port TLV

OT_MESHCOP_TLV_COMM_SESSION_ID

معرّف جلسة ThcV لمفوضية ميسhcop

OT_MESHCOP_TLV_COUNT

عدد مرات المشاهدة TLV

OT_MESHCOP_TLV_DELAYTIMER

mshcop تأجيل الموقّت TLV

OT_MESHCOP_TLV_DISCOVERYREQUEST

طلب TLV بشأن استكشاف المحتوى

OT_MESHCOP_TLV_DISCOVERYRESPONSE

ردّ TLV على mshcop Discovery

OT_MESHCOP_TLV_ENERGY_LIST

قائمة خدمات الطاقة في mshcop TLV

OT_MESHCOP_TLV_EXTPANID

mshcop Extended Pan ID ID TLV

OT_MESHCOP_TLV_GET

mshcop الحصول على TLV

OT_MESHCOP_TLV_IPV6_ADDRESS_TLV

عنوان mshcop IPv6 TLV

OT_MESHCOP_TLV_JOINERADVERTISEMENT

إعلان الانضمام إلى وسائل النقل

OT_MESHCOP_TLV_JOINER_DTLS

ميسhcop وصلة DTLS Encapsulation TLV

OT_MESHCOP_TLV_JOINER_IID

ميسhcopلِي معرّف TLV

OT_MESHCOP_TLV_JOINER_RLOC

mshcop تضخّم جهاز التوجيه لجهاز تحديد المواقع TLV

OT_MESHCOP_TLV_JOINER_ROUTER_KEK

انتقِل إلى جهاز توجيه الجهاز KEK TLV

OT_MESHCOP_TLV_JOINER_UDP_PORT

ميسhcop وصلة UDP TLV

OT_MESHCOP_TLV_MESHLOCALPREFIX

mshcop Mesh البادئة المحلية TLV

OT_MESHCOP_TLV_NETWORKKEY

Mehcop Network Key TLV

OT_MESHCOP_TLV_NETWORKNAME

mshcop Network Name TLV

OT_MESHCOP_TLV_NETWORK_KEY_SEQUENCE

تسلسل علامات مفتاح الشبكة ThcV

OT_MESHCOP_TLV_PANID

رقم تعريف TTV في ميسhcop Pan

OT_MESHCOP_TLV_PENDINGTIMESTAMP

mshcop في انتظار الطابع الزمني TLV

OT_MESHCOP_TLV_PERIOD

مسار TLV

OT_MESHCOP_TLV_PROVISIONING_URL

ThV.توفير عنوان URL لإدارة الحسابات

OT_MESHCOP_TLV_PSKC

mshcop PSKc TLV

OT_MESHCOP_TLV_SCAN_DURATION

مدة البحث عن TlsV

OT_MESHCOP_TLV_SECURITYPOLICY

سياسة أمان سياسة الخدمة TLV

OT_MESHCOP_TLV_STATE

TLV (ولاية ميستشوب)

OT_MESHCOP_TLV_STEERING_DATA

توجيه المكالمات TLV

OT_MESHCOP_TLV_UDP_ENCAPSULATION_TLV

ميسhcop UDP TLV

OT_MESHCOP_TLV_VENDOR_DATA_TLV

بيانات المورّد الجديد على mshcop

OT_MESHCOP_TLV_VENDOR_MODEL_TLV

نموذج مورد TLV في ميسhcop

OT_MESHCOP_TLV_VENDOR_NAME_TLV

المتوفّر اسم المورِّد TLV

OT_MESHCOP_TLV_VENDOR_STACK_VERSION_TLV

إصدار TLV لحزمة المورّدين (mshcop)

OT_MESHCOP_TLV_VENDOR_SW_VERSION_TLV

إصدار TLV من مورِّد mshcop للمورّد

أنواع المحددات

قناع القناة

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 الموسَّع

otMishLocalPrefix

otIp6NetworkPrefix otMeshLocalPrefix

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

otMeshcopTlvType

enum otMeshcopTlvType otMeshcopTlvType

يمثّل أنواع TLV.

مفتاح otNetwork

struct otNetworkKey otNetworkKey

يمثل مفتاح شبكة Thread.

مرجع شبكة OotNetwork

otCryptoKeyRef otNetworkKeyRef

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

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

otNetworkName

struct otNetworkName otNetworkName

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

otNetworkName عبارة عن سلسلة C فارغة عند الإنهاء (أي يجب أن ينتهي صفيف m8 حرف الأبجدية \0 فارغًا.

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

struct otOperationalDataset otOperationalDataset

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

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

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

struct otOperationalDatasetComponents otOperationalDatasetComponents

تمثّل وجود مكوّنات مختلفة في مجموعة بيانات تشغيلية أو نشطة في انتظار المراجعة.

otOperaativeDatasetTlvs

struct otOperationalDatasetTlvs otOperationalDatasetTlvs

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

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

OtPskc

struct otPskc otPskc

يمثل PSKc.

OtPskcref

otCryptoKeyRef otPskcRef

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

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

سياسة otSecurity

struct otSecurityPolicy otSecurityPolicy

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

الطابع الزمني

struct otTimestamp otTimestamp

يمثل مكوّن الطابع الزمني لمجموعة بيانات سلسلة المحادثات.

المتغيّرات

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
لا تتوفر قيمة مطابقة في متجر الإعدادات.

otDatasetGetتأخيرTimerMinimal

uint32_t otDatasetGetDelayTimerMinimal(
  otInstance *aInstance
)

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

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

otDatasetGetPending

otError otDatasetGetPending(
  otInstance *aInstance,
  otOperationalDataset *aDataset
)

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

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

otDatasetGet pendingTlvs

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.
المرتجعات
صحيح إذا كانت هناك شبكة صالحة في مجموعة البيانات التشغيلية النشطة، أو على خطأ "خطأ" بخلاف ذلك.

OotDatasetParseTlvs

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
تم إرسال أمر مجموعة بيانات mshcop بنجاح.
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
مدة الفيديوهات التلفزيونية
[in] aCallback
مؤشر إلى دالة تُسمى عند استقبال الاستجابة أو انتهاء المهلة.
[in] aContext
مؤشر إلى السياق الخاص بالتطبيق لـ aCallback.
قيم الإرجاع
OT_ERROR_NONE
تم إرسال أمر مجموعة بيانات mshcop بنجاح.
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
تم إرسال أمر مجموعة بيانات mshcop بنجاح.
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
مدة الفيديوهات التلفزيونية
[in] aCallback
مؤشر إلى دالة تُسمى عند استقبال الاستجابة أو انتهاء المهلة.
[in] aContext
مؤشر إلى السياق الخاص بالتطبيق لـ aCallback.
قيم الإرجاع
OT_ERROR_NONE
تم إرسال أمر مجموعة بيانات mshcop بنجاح.
OT_ERROR_NO_BUFS
لا تتوفّر مساحة تخزين كافية للإرسال.
OT_ERROR_BUSY
جارٍ تنفيذ طلب سابق.

otDatasetSetActive

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

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

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

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

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

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

التفاصيل
المَعلمات
[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 فقط للاتصال بإحدى الشبكات.

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

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

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

otDatasetSetتأخيرTimerMinimal

otError otDatasetSetDelayTimerMinimal(
  otInstance *aInstance,
  uint32_t aDelayTimerMinimal
)

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

التفاصيل
المَعلمات
[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.

otDatasetUpdaterIsUpdateOncontinue 

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
سلسلة الاسم (ج)
قيم الإرجاع
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_MAK

 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_MAK

 OT_CHANNEL_5_MASK (1 << 5)

القناة 5.

قناة OT_CHANNEL_6_MASK

 OT_CHANNEL_6_MASK (1 << 6)

القناة 6:

قناة OT_CHANNEL_7_MAK

 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 PAN (بالبايت)

OT_MESH_LOCAL_RDFa_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

الحد الأقصى لحجم حقل "اسم شبكة سلسلة المحادثات" (بالبايت)

الوقت الإضافي_OT_FUNCTIONIONAL_DATASET_MAX_LENGTH

 OT_OPERATIONAL_DATASET_MAX_LENGTH 254

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

OT_PSKC_MAX_SIZE

 OT_PSKC_MAX_SIZE 16

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

الموارد

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