مجموعه داده عملیاتی

شامل توابع برای API مجموعه داده عملیاتی است.

خلاصه

فقط برای ساخت‌های FTD، Dataset Updater شامل توابعی برای مدیریت به‌روزرسانی‌های مجموعه است.

برای ساخت‌های FTD و MTD، API مجموعه داده عملیاتی شامل توابعی برای مدیریت مجموعه داده‌های فعال و معلق و مجموعه داده‌های 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
}
enum
نشان دهنده انواع meshcop TLV است.

Typedefs

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
نشان دهنده انواع meshcop TLV است.
otNetworkKey typedef
struct otNetworkKey
یک کلید شبکه موضوعی را نشان می دهد.
otNetworkKeyRef typedef
این نوع داده KeyRef به NetworkKey را نشان می دهد.
otNetworkName typedef
یک نام شبکه را نشان می دهد.
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

یک کلید شبکه موضوعی را نشان می دهد.

otNetworkName

یک نام شبکه را نشان می دهد.

otOperationalDataset

یک مجموعه داده عملیاتی فعال یا معلق را نشان می دهد.

otOperationalDataset Components

نشان دهنده حضور اجزای مختلف در مجموعه داده عملیاتی فعال یا معلق است.

otOperationalDatasetTlvs

یک مجموعه داده عملیاتی فعال یا معلق را نشان می دهد.

otPskc

نشان دهنده PSKc است.

otSecurityPolicy

سیاست امنیتی را نشان دهید.

otTimestamp

یک مؤلفه مهر زمانی مجموعه داده رشته را نشان می دهد.

شمارش ها

otMeshcopTlvType

 otMeshcopTlvType

نشان دهنده انواع meshcop TLV است.

خواص
OT_MESHCOP_TLV_ACTIVETIMESTAMP

meshcop Active Timestamp TLV

OT_MESHCOP_TLV_BORDER_AGENT_RLOC

meshcop Border Agent Locator TLV

OT_MESHCOP_TLV_CHANNEL

کانال meshcop TLV

OT_MESHCOP_TLV_CHANNELMASK

ماسک کانال meshcop TLV

OT_MESHCOP_TLV_COMMISSIONER_ID

meshcop کمیسر ID TLV

OT_MESHCOP_TLV_COMMISSIONER_UDP_PORT

meshcop کمیسیونر UDP بندر TLV

OT_MESHCOP_TLV_COMM_SESSION_ID

meshcop کمیسیونر جلسه ID TLV

OT_MESHCOP_TLV_COUNT

meshcop Count TLV

OT_MESHCOP_TLV_DELAYTIMER

تایمر تاخیری meshcop TLV

OT_MESHCOP_TLV_DISCOVERYREQUEST

درخواست کشف meshcop TLV

OT_MESHCOP_TLV_DISCOVERYRESPONSE

meshcop Discovery Response TLV

OT_MESHCOP_TLV_ENERGY_LIST

فهرست انرژی meshcop TLV

OT_MESHCOP_TLV_EXTPANID

meshcop Extended Pan ID TLV

OT_MESHCOP_TLV_GET

meshcop دریافت TLV

OT_MESHCOP_TLV_IPV6_ADDRESS_TLV

آدرس IPv6 meshcop TLV

OT_MESHCOP_TLV_JOINERADVERTISEMENT

meshcop Joiner Advertisement TLV

OT_MESHCOP_TLV_JOINER_DTLS

Meshcop Joiner DTLS Encapsulation TLV

OT_MESHCOP_TLV_JOINER_IID

meshcop Joiner ID TLV

OT_MESHCOP_TLV_JOINER_RLOC

یاب مسیریاب Joiner Meshcop TLV

OT_MESHCOP_TLV_JOINER_ROUTER_KEK

روتر وصال meshcop KEK TLV

OT_MESHCOP_TLV_JOINER_UDP_PORT

Meshcop Joiner UDP Port TLV

OT_MESHCOP_TLV_MESHLOCALPREFIX

meshcop Mesh Local Prefix 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

مهر زمانی معلق TLV

OT_MESHCOP_TLV_PERIOD

دوره مشکوپ TLV

OT_MESHCOP_TLV_PROVISIONING_URL

meshcop ارائه URL TLV

OT_MESHCOP_TLV_PSKC

مش کوپ PSKc TLV

OT_MESHCOP_TLV_SCAN_DURATION

مدت زمان اسکن meshcop TLV

OT_MESHCOP_TLV_SECURITYPOLICY

سیاست امنیتی meshcop TLV

OT_MESHCOP_TLV_STATE

meshcop State TLV

OT_MESHCOP_TLV_STEERING_DATA

داده های فرمان مشکوپ TLV

OT_MESHCOP_TLV_UDP_ENCAPSULATION_TLV

مش کوپ UDP کپسوله TLV

OT_MESHCOP_TLV_VENDOR_DATA_TLV

اطلاعات فروشنده meshcop TLV

OT_MESHCOP_TLV_VENDOR_MODEL_TLV

meshcop فروشنده مدل TLV

OT_MESHCOP_TLV_VENDOR_NAME_TLV

meshcop نام فروشنده TLV

OT_MESHCOP_TLV_VENDOR_STACK_VERSION_TLV

meshcop Vendor Stack نسخه TLV

OT_MESHCOP_TLV_VENDOR_SW_VERSION_TLV

meshcop Vendor SW نسخه TLV

Typedefs

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

نشان دهنده انواع meshcop TLV است.

otNetworkKey

struct otNetworkKey otNetworkKey

یک کلید شبکه موضوعی را نشان می دهد.

otNetworkKeyRef

otCryptoKeyRef otNetworkKeyRef

این نوع داده KeyRef به NetworkKey را نشان می دهد.

ارجاع به کلید

otNetworkName

struct otNetworkName otNetworkName

یک نام شبکه را نشان می دهد.

otNetworkName یک رشته C خاتمه یافته تهی است (یعنی آرایه نویسه m8 باید با null char \0 ختم شود).

otOperationalDataset

struct otOperationalDataset otOperationalDataset

یک مجموعه داده عملیاتی فعال یا معلق را نشان می دهد.

اجزای موجود در Dataset اختیاری هستند. ساختار mComponents مشخص می کند که کدام مؤلفه ها در مجموعه داده وجود دارند.

otOperationalDataset Components

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

یک مؤلفه مهر زمانی مجموعه داده رشته را نشان می دهد.

متغیرها

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 ID توسعه یافته برای محاسبات 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
)

فقط برای FTD، تایمر حداقل تاخیر دریافت می کند.

جزئیات
مولفه های
[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.
برمی گرداند
اگر یک شبکه معتبر در مجموعه داده عملیاتی فعال وجود داشته باشد، درست است، در غیر این صورت نادرست است.

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
یک اشاره گر به ساختار Dataset Components که مشخص می کند کدام مؤلفه ها باید درخواست شوند.
[in] aTlvTypes
یک اشاره گر به آرایه حاوی انواع TLV خام اضافی که باید درخواست شود.
[in] aLength
طول aTlvTypes .
[in] aAddress
اشاره گر به مقصد IPv6، اگر NULL باشد، از 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
یک اشاره گر به ساختار Dataset Components که مشخص می کند کدام مؤلفه ها باید درخواست شوند.
[in] aTlvTypes
یک اشاره گر به آرایه حاوی انواع TLV خام اضافی که باید درخواست شود.
[in] aLength
طول aTlvTypes .
[in] aAddress
اشاره گر به مقصد IPv6، اگر NULL باشد، از 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 موجود متصل شود. فقط کلید شبکه موضوعی برای اتصال به شبکه مورد نیاز است.

اگر کانال در مجموعه داده گنجانده نشود، دستگاه پیام‌های MLE Announce را در کانال‌های مختلف ارسال می‌کند تا همسایگان را در کانال‌های دیگر پیدا کند.

اگر دستگاه با موفقیت به شبکه Thread متصل شود، دستگاه کل Active Dataset را از والد خود بازیابی می کند. توجه داشته باشید که یک دستگاه دارای روتر تا زمانی که مجموعه داده فعال کامل نداشته باشد، به نقش های روتر یا رهبر منتقل نمی شود.

جزئیات
مولفه های
[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 Announce را در کانال‌های مختلف ارسال می‌کند تا همسایگان را در کانال‌های دیگر پیدا کند.

اگر دستگاه با موفقیت به شبکه Thread متصل شود، دستگاه کل Active Dataset را از والد خود بازیابی می کند. توجه داشته باشید که یک دستگاه دارای روتر تا زمانی که مجموعه داده فعال کامل نداشته باشد، به نقش های روتر یا رهبر منتقل نمی شود.

جزئیات
مولفه های
[in] aInstance
اشاره گر به یک نمونه OpenThread.
[in] aDataset
اشاره گر به مجموعه داده های عملیاتی فعال.
ارزش های بازگشتی
OT_ERROR_NONE
مجموعه داده عملیاتی فعال با موفقیت تنظیم شد.
OT_ERROR_NO_BUFS
فضای بافر کافی برای تنظیم مجموعه داده عملیاتی فعال نیست.
OT_ERROR_NOT_IMPLEMENTED
پلتفرم عملکرد تنظیمات را اجرا نمی کند.

otDatasetSetDelayTimerMinimal

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.

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 باید حاوی فیلدهایی باشد که باید به روز شوند و مقدار جدید آنها. نباید حاوی فیلدهای مهر زمانی فعال یا معلق باشد. فیلد Delay اختیاری است، در صورت عدم ارائه یک مقدار پیش فرض (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

اندازه یک Thread PAN ID (بایت)

OT_MESH_LOCAL_PREFIX_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

حداکثر اندازه فیلد 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 API از کد منبع موجود در GitHub سرچشمه می گیرند. برای اطلاعات بیشتر، یا مشارکت در اسناد ما، به منابع مراجعه کنید.