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

تشمل هذه الوحدة وظائف "أداة تحديث مجموعة البيانات".

الملخّص

الوظائف المتوفرة في هذه الوحدة متاحة عند تفعيل ميزة "أداة تحديث مجموعة البيانات" (أي تم ضبط OPENTHREAD_CONFIG_DATASET_UPDATER_ENABLE على 1). علاوة على ذلك، لا تتوفّر هذه الميزة إلا على إصدار FTD.

التعدادات

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 لأنواع meshcop.

مواقد الخط

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

المتغيرات

OT_TOOL_PACKED_END

الدوال

otDatasetCreateNewNetwork(otInstance *aInstance, otOperationalDataset *aDataset)
تعمل هذه الطريقة على إنشاء مجموعة بيانات تشغيلية جديدة لاستخدامها عند إنشاء شبكة جديدة.
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
احصل على الحد الأدنى من مهلة التأخير.
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)
يمكنك ضبط موقّت صغير.
otDatasetSetPending(otInstance *aInstance, const otOperationalDataset *aDataset)
تحدد هذه الدالة مجموعة البيانات التشغيلية في انتظار المراجعة.
otDatasetSetPendingTlvs(otInstance *aInstance, const otOperationalDatasetTlvs *aDataset)
تحدد هذه الدالة مجموعة البيانات التشغيلية في انتظار المراجعة.
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 فارغة ومنتهية فارغة.

التشريعات

otExpandPanId

تمثّل هذه البنية رقم تعريف رقم PAN موسّع.

otNetworkKey

وتمثّل هذه البنية مفتاح شبكة سلاسل محادثات.

otNetworkName

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

otOperationalDataset

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

otOperationalDatasetComponents

تمثل هذه البنية وجود مكونات مختلفة في مجموعة البيانات التشغيلية النشطة أو المعلقة.

otOperationalDatasetTlvs

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

otPskc

تمثل هذه البنية PSKc.

otSecurityPolicy

تمثّل هذه البنية سياسة الأمان.

التعدادات

otMeshcopTlvType

 otMeshcopTlvType

تمثّل هذه القائمة العددية TLV لأنواع meshcop.

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

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

OT_MESHCOP_TLV_BORDER_AGENT_RLOC

وكلاء دعم meshcop Border Agent Lotor TLV

OT_MESHCOP_TLV_CHANNEL

TCLV قناة meshcop

OT_MESHCOP_TLV_CHANNELMASK

تعاون تعاون مع مدير قناة meshcop قناع TLV

OT_MESHCOP_TLV_COMMISSIONER_ID

رقم تعريف مفوضية meshcop TLV

OT_MESHCOP_TLV_COMMISSIONER_UDP_PORT

mshcop مفوَّض UDP TLV

OT_MESHCOP_TLV_COMM_SESSION_ID

معرّف جلسة مفوض المفوّض

OT_MESHCOP_TLV_COUNT

عدد THCV لـ meshcop

OT_MESHCOP_TLV_DELAYTIMER

مؤقت الشحن مؤقتًا TCLV

OT_MESHCOP_TLV_DISCOVERYREQUEST

طلب TLV لـ meshcop Discovery

OT_MESHCOP_TLV_DISCOVERYRESPONSE

ملف THCV لاستجابة Discovery meshcop

OT_MESHCOP_TLV_ENERGY_LIST

قائمة TLV لقائمة الطاقة meshcop

OT_MESHCOP_TLV_EXTPANID

معرّف النقرة الموسّعة Mehcop TLV

OT_MESHCOP_TLV_GET

Mehcop الحصول على TLV

OT_MESHCOP_TLV_IPV6_ADDRESS_TLV

عنوان THCV لـ meshcop IPv6

OT_MESHCOP_TLV_JOINERADVERTISEMENT

إعلان meshcop Joiner Advertising TLV

OT_MESHCOP_TLV_JOINER_DTLS

meshcop Joiner DTLS Encapsult TLV

OT_MESHCOP_TLV_JOINER_IID

meshcop Joiner IID TLV

OT_MESHCOP_TLV_JOINER_RLOC

توجيه جهاز meshcop Connector

OT_MESHCOP_TLV_JOINER_ROUTER_KEK

جهاز توجيه meshcop KEK TLV

OT_MESHCOP_TLV_JOINER_UDP_PORT

meshcop Joiner UDP منفذ TLV

OT_MESHCOP_TLV_MESHLOCALPREFIX

Mesop شبكية بادئة محلية

OT_MESHCOP_TLV_NETWORKKEY

{/1}

OT_MESHCOP_TLV_NETWORKNAME

اسم مشغّل شبكة الجوّال meshcop TLV

OT_MESHCOP_TLV_NETWORK_KEY_SEQUENCE

{/1}

OT_MESHCOP_TLV_PANID

رقم تعريف TMCV لـ meshcop

OT_MESHCOP_TLV_PENDINGTIMESTAMP

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

OT_MESHCOP_TLV_PERIOD

TLMV فترة زمنية

OT_MESHCOP_TLV_PROVISIONING_URL

عنوان URL الخاص بتزويد إدارة الحسابات في mshcop

OT_MESHCOP_TLV_PSKC

meshcop PSKc TLV

OT_MESHCOP_TLV_SCAN_DURATION

LMShcop Scan Duration TLV

OT_MESHCOP_TLV_SECURITYPOLICY

TLMV لسياسة الأمان meshcop

OT_MESHCOP_TLV_STATE

TMV

OT_MESHCOP_TLV_STEERING_DATA

TLV بيانات توجيه meshcop

OT_MESHCOP_TLV_UDP_ENCAPSULATION_TLV

TLV meshcop UDP تغليف

OT_MESHCOP_TLV_VENDOR_DATA_TLV

ملف بيانات المورّدين (MChcop) لبيانات المورّدين

OT_MESHCOP_TLV_VENDOR_MODEL_TLV

نموذج TLV ل المورّدين في meshcop

OT_MESHCOP_TLV_VENDOR_NAME_TLV

اسم المورّد "Mehcop Supplier TLV"

OT_MESHCOP_TLV_VENDOR_STACK_VERSION_TLV

إصدار TLV لـ meshcop Vendor Stack

OT_MESHCOP_TLV_VENDOR_SW_VERSION_TLV

mshcop Vendor SW Version TLV

مواقد الخط

قناع otChannel

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)

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

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

otextPanId

struct otExtendedPanId otExtendedPanId

تمثّل هذه البنية رقم تعريف رقم PAN موسّع.

otMeshLocalPrefix

otIp6NetworkPrefix otMeshLocalPrefix

تمثّل هذه البنية بادئة شبكة متداخلة.

otMeshcopTlvType

enum otMeshcopTlvType otMeshcopTlvType

تمثّل هذه القائمة العددية TLV لأنواع meshcop.

مفتاح otNetwork

struct otNetworkKey otNetworkKey

وتمثّل هذه البنية مفتاح شبكة سلاسل محادثات.

otNetworkKeyRef

otCryptoKeyRef otNetworkKeyRef

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

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

otNetworkName

struct otNetworkName otNetworkName

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

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

مجموعة بيانات otOperationalData

struct otOperationalDataset otOperationalDataset

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

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

otOperationalDatasetComponents

struct otOperationalDatasetComponents otOperationalDatasetComponents

تمثل هذه البنية وجود مكونات مختلفة في مجموعة البيانات التشغيلية النشطة أو المعلقة.

otOperationalDatasetTlvs

struct otOperationalDatasetTlvs otOperationalDatasetTlvs

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

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

otPskc

struct otPskc otPskc

وتمثل هذه البنية PSKc.

otPskcRef

otCryptoKeyRef otPskcRef

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

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

otSecurityPolicy

struct otSecurityPolicy otSecurityPolicy

تمثّل هذه البنية سياسة الأمان.

المتغيرات

OT_Tool_PACKED_END

OT_TOOL_PACKED_BEGIN struct otNetworkKey OT_TOOL_PACKED_END

الدوال

otDatasetCreateNewNetwork

otError otDatasetCreateNewNetwork(
  otInstance *aInstance,
  otOperationalDataset *aDataset
)

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

التفاصيل
المعلَمات
[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
قيمة الحد الأدنى لمؤقِّت التأخير (بالمللي ثانية).

otDatasetGetفي انتظار المراجعة

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

otDatasetIsComعمولة

bool otDatasetIsCommissioned(
  otInstance *aInstance
)

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

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

otDatasetParseTlvs

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

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

التفاصيل
المعلَمات
[in] aDatasetTlvs
مؤشر إلى TVVs لمجموعة البيانات.
[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، وسيتم استخدامه كقائد 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
مؤشر إلى TLVs
[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، وسيتم استخدامه كقائد 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
مؤشر إلى TLVs
[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
)

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

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

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

وإذا لم تكن القناة مضمّنة في مجموعة البيانات، سيرسل الجهاز رسائل إعلان 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
)

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

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

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

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

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

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

otDatasetSetDelayTimerMinimal

otError otDatasetSetDelayTimerMinimal(
  otInstance *aInstance,
  uint32_t aDelayTimerMinimal
)

يمكنك ضبط موقّت صغير.

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

otDatasetSetمعلّق

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
لا تنفّذ المنصة وظيفة الإعدادات.

otDatasetUpdaterإلغاء التحديث

void otDatasetUpdaterCancelUpdate(
  otInstance *aInstance
)

وتلغي هذه الدالة طلب تحديث مجموعة البيانات التشغيلية (إن وجد).

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

otDatasetUpdaterIsUpdateContinue

bool otDatasetUpdaterIsUpdateOngoing(
  otInstance *aInstance
)

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

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

otDatasetUpdaterRequestUpdate

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

تتطلب هذه الدالة تحديثًا لمجموعة بيانات التشغيل.

يجب أن يحتوي 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_INTERVAL_SIZE

 OT_MESH_LOCAL_PREFIX_SIZE OT_IP6_PREFIX_SIZE

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

OT_NETWORK_KEY_SIZE

 OT_NETWORK_KEY_SIZE 16

حجم مفتاح شبكة سلسلة المحادثات (بايت)

OT_NETWORK_NAME_MAX_SIZE

 OT_NETWORK_NAME_MAX_SIZE 16

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

OT_TASKAL_DATASET_MAX_LENGTH

 OT_OPERATIONAL_DATASET_MAX_LENGTH 254

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

OT_PSKC_MAX_SIZE

 OT_PSKC_MAX_SIZE 16

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

المراجع

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