عمومی

این ماژول شامل توابعی برای همه نقش های Thread است.

خلاصه

ناشر داده‌های شبکه مکانیسم‌هایی را برای محدود کردن تعداد ورودی‌های مشابه سرویس و/یا پیشوند (پیشوند روی مش یا مسیر خارجی) در داده‌های شبکه موضوعی با نظارت بر داده‌های شبکه و مدیریت زمان افزودن یا حذف ورودی‌ها فراهم می‌کند.

همه توابع در این ماژول نیاز به فعال کردن OPENTHREAD_CONFIG_NETDATA_PUBLISHER_ENABLE دارند.

شمارش ها

anonymous enum {
OT_NETWORK_DIAGNOSTIC_TLV_EXT_ADDRESS = 0,
OT_NETWORK_DIAGNOSTIC_TLV_SHORT_ADDRESS = 1,
OT_NETWORK_DIAGNOSTIC_TLV_MODE = 2,
OT_NETWORK_DIAGNOSTIC_TLV_TIMEOUT = 3,
OT_NETWORK_DIAGNOSTIC_TLV_CONNECTIVITY = 4,
OT_NETWORK_DIAGNOSTIC_TLV_ROUTE = 5,
OT_NETWORK_DIAGNOSTIC_TLV_LEADER_DATA = 6,
OT_NETWORK_DIAGNOSTIC_TLV_NETWORK_DATA = 7,
OT_NETWORK_DIAGNOSTIC_TLV_IP6_ADDR_LIST = 8,
OT_NETWORK_DIAGNOSTIC_TLV_MAC_COUNTERS = 9,
OT_NETWORK_DIAGNOSTIC_TLV_BATTERY_LEVEL = 14,
OT_NETWORK_DIAGNOSTIC_TLV_SUPPLY_VOLTAGE = 15,
OT_NETWORK_DIAGNOSTIC_TLV_CHILD_TABLE = 16,
OT_NETWORK_DIAGNOSTIC_TLV_CHANNEL_PAGES = 17,
OT_NETWORK_DIAGNOSTIC_TLV_TYPE_LIST = 18,
OT_NETWORK_DIAGNOSTIC_TLV_MAX_CHILD_TIMEOUT = 19,
OT_NETWORK_DIAGNOSTIC_TLV_VERSION = 24,
OT_NETWORK_DIAGNOSTIC_TLV_VENDOR_NAME = 25,
OT_NETWORK_DIAGNOSTIC_TLV_VENDOR_MODEL = 26,
OT_NETWORK_DIAGNOSTIC_TLV_VENDOR_SW_VERSION = 27,
OT_NETWORK_DIAGNOSTIC_TLV_THREAD_STACK_VERSION = 28,
OT_NETWORK_DIAGNOSTIC_TLV_CHILD = 29,
OT_NETWORK_DIAGNOSTIC_TLV_CHILD_IP6_ADDR_LIST = 30,
OT_NETWORK_DIAGNOSTIC_TLV_ROUTER_NEIGHBOR = 31,
OT_NETWORK_DIAGNOSTIC_TLV_ANSWER = 32,
OT_NETWORK_DIAGNOSTIC_TLV_QUERY_ID = 33,
OT_NETWORK_DIAGNOSTIC_TLV_MLE_COUNTERS = 34
}
enum
otDeviceRole {
OT_DEVICE_ROLE_DISABLED = 0,
OT_DEVICE_ROLE_DETACHED = 1,
OT_DEVICE_ROLE_CHILD = 2,
OT_DEVICE_ROLE_ROUTER = 3,
OT_DEVICE_ROLE_LEADER = 4
}
enum
نقش دستگاه Thread را نشان می دهد.
otNetDataPublisherEvent {
OT_NETDATA_PUBLISHER_EVENT_ENTRY_ADDED = 0,
OT_NETDATA_PUBLISHER_EVENT_ENTRY_REMOVED = 1
}
enum
رویدادهای گزارش شده از تماس های ناشر را نشان می دهد.
otRoutePreference {
OT_ROUTE_PREFERENCE_LOW = -1,
OT_ROUTE_PREFERENCE_MED = 0,
OT_ROUTE_PREFERENCE_HIGH = 1
}
enum
مقادیر معتبری را برای mPreference در otExternalRouteConfig و otBorderRouterConfig تعریف می کند.

Typedefs

otBorderRouterConfig typedef
نمایانگر پیکربندی Border Router است.
otDetachGracefullyCallback )(void *aContext) typedef
void(*
این فراخوانی به برنامه اطلاع می دهد که فرآیند جداسازی به پایان رسیده است.
otExternalRouteConfig typedef
یک پیکربندی مسیر خارجی را نشان می دهد.
otIpCounters typedef
struct otIpCounters
شمارنده های سطح IP را نشان می دهد.
otLeaderData typedef
struct otLeaderData
نشان دهنده داده های Thread Leader است.
otLinkModeConfig typedef
یک پیکربندی حالت پیوند MLE را نشان می دهد.
otLowpanContextInfo typedef
اطلاعات 6LoWPAN Context ID مرتبط با یک پیشوند در Network Data را نشان می دهد.
otMleCounters typedef
نشان دهنده شمارنده های Thread MLE است.
otNeighborInfoIterator typedef
int16_t
برای تکرار از طریق جدول همسایه استفاده می شود.
otNetDataDnsSrpServicePublisherCallback )(otNetDataPublisherEvent aEvent, void *aContext) typedef
void(*
نوع اشاره گر، پاسخ تماس مورد استفاده برای اطلاع از اضافه شدن یا حذف ورودی «سرویس DNS/SRP» به داده شبکه موضوعی را مشخص می کند.
otNetDataPrefixPublisherCallback )(otNetDataPublisherEvent aEvent, const otIp6Prefix *aPrefix, void *aContext) typedef
void(*
نوع اشاره گر، پاسخ تماس مورد استفاده برای اطلاع از اضافه شدن یا حذف یک پیشوند (روی مش یا مسیر خارجی) به داده شبکه موضوعی را مشخص می کند.
otNetDataPublisherEvent typedef
رویدادهای گزارش شده از تماس های ناشر را نشان می دهد.
otNetworkDataIterator typedef
uint32_t
برای تکرار از طریق اطلاعات شبکه داده استفاده می شود.
otNetworkDiagChildEntry typedef
یک ورودی جدول کودک تشخیصی شبکه را نشان می دهد.
otNetworkDiagConnectivity typedef
یک مقدار اتصال تشخیصی شبکه را نشان می دهد.
otNetworkDiagIterator typedef
uint16_t
برای تکرار از طریق Network Diagnostic TLV استفاده می شود.
otNetworkDiagMacCounters typedef
یک مقدار شمارنده مک عیب یابی شبکه را نشان می دهد.
otNetworkDiagMleCounters typedef
یک مقدار شمارنده MLE Diagnostics شبکه را نشان می دهد.
otNetworkDiagRoute typedef
یک مقدار TLV مسیر تشخیصی شبکه را نشان می دهد.
otNetworkDiagRouteData typedef
یک داده مسیر تشخیصی شبکه را نشان می دهد.
otNetworkDiagTlv typedef
یک TLV تشخیصی شبکه را نشان می دهد.
otReceiveDiagnosticGetCallback )(otError aError, otMessage *aMessage, const otMessageInfo *aMessageInfo, void *aContext) typedef
void(*
هنگامی که پاسخ دریافت تشخیصی شبکه دریافت می شود، اشاره گر فراخوانی می شود.
otRoutePreference typedef
مقادیر معتبری را برای mPreference در otExternalRouteConfig و otBorderRouterConfig تعریف می کند.
otServerConfig typedef
یک پیکربندی سرور را نشان می دهد.
otServiceConfig typedef
یک پیکربندی سرویس را نشان می دهد.
otThreadAnycastLocatorCallback )(void *aContext, otError aError, const otIp6Address *aMeshLocalAddress, uint16_t aRloc16) typedef
void(*
نوع اشاره گر، بازخوانی را برای اطلاع از نتیجه درخواست otThreadLocateAnycastDestination() تعریف می کند.
otThreadDiscoveryRequestCallback )(const otThreadDiscoveryRequestInfo *aInfo, void *aContext) typedef
void(*
هر بار که یک پیام درخواست کشف MLE دریافت می شود، اشاره گر فراخوانی می شود.
otThreadDiscoveryRequestInfo typedef
نشان دهنده داده های درخواست کشف موضوع است.
otThreadParentResponseCallback )(otThreadParentResponseInfo *aInfo, void *aContext) typedef
void(*
هر بار که یک پیام پاسخ والدین MLE دریافت می شود، اشاره گر فراخوانی می شود.
otThreadParentResponseInfo typedef
نشان دهنده داده های پاسخ والدین MLE است.

کارکرد

otConvertDurationInSecondsToString (uint32_t aDuration, char *aBuffer, uint16_t aSize)
void
مدت زمان uint32_t (در ثانیه) را به یک رشته قابل خواندن توسط انسان تبدیل می کند.
otNetDataContainsOmrPrefix ( otInstance *aInstance, const otIp6Prefix *aPrefix)
bool
بررسی کنید که آیا یک پیشوند داده شده می تواند به عنوان یک پیشوند معتبر OMR عمل کند و همچنین داده های شبکه رهبر حاوی این پیشوند است.
otNetDataGet ( otInstance *aInstance, bool aStable, uint8_t *aData, uint8_t *aDataLength)
یک کپی کامل یا پایدار از داده شبکه موضوعی پارتیشن ارائه دهید.
otNetDataGetCommissioningDataset ( otInstance *aInstance, otCommissioningDataset *aDataset)
void
مجموعه داده راه اندازی را از داده های شبکه پارتیشن دریافت می کند.
otNetDataGetLength ( otInstance *aInstance)
uint8_t
طول فعلی (تعداد بایت) داده شبکه موضوعی پارتیشن را دریافت کنید.
otNetDataGetMaxLength ( otInstance *aInstance)
uint8_t
حداکثر طول مشاهده‌شده داده‌های شبکه Thread را از زمان اولیه‌سازی پشته OT یا از آخرین تماس با otNetDataResetMaxLength() دریافت کنید.
otNetDataGetNextLowpanContextInfo ( otInstance *aInstance, otNetworkDataIterator *aIterator, otLowpanContextInfo *aContextInfo)
اطلاعات 6LoWPAN Context ID بعدی را در داده های شبکه پارتیشن دریافت کنید.
otNetDataGetNextOnMeshPrefix ( otInstance *aInstance, otNetworkDataIterator *aIterator, otBorderRouterConfig *aConfig)
پیشوند On Mesh بعدی را در داده های شبکه پارتیشن دریافت کنید.
otNetDataGetNextRoute ( otInstance *aInstance, otNetworkDataIterator *aIterator, otExternalRouteConfig *aConfig)
مسیر خارجی بعدی را در داده های شبکه پارتیشن دریافت کنید.
otNetDataGetNextService ( otInstance *aInstance, otNetworkDataIterator *aIterator, otServiceConfig *aConfig)
سرویس بعدی را در Network Data پارتیشن دریافت کنید.
otNetDataGetStableVersion ( otInstance *aInstance)
uint8_t
نسخه Stable Network Data را دریافت کنید.
otNetDataGetVersion ( otInstance *aInstance)
uint8_t
نسخه Network Data را دریافت کنید.
otNetDataIsDnsSrpServiceAdded ( otInstance *aInstance)
bool
نشان می دهد که آیا در حال حاضر ورودی "DNS/SRP Service" به داده های شبکه Thread اضافه شده است یا خیر.
otNetDataIsPrefixAdded ( otInstance *aInstance, const otIp6Prefix *aPrefix)
bool
نشان می دهد که آیا در حال حاضر یک ورودی پیشوند منتشر شده (روی مش یا مسیر خارجی) به داده شبکه موضوع اضافه شده است یا خیر.
otNetDataPublishDnsSrpServiceAnycast ( otInstance *aInstance, uint8_t aSequenceNUmber)
void
درخواست "DNS/SRP Service Anycast Address" برای انتشار در Thread Network Data.
otNetDataPublishDnsSrpServiceUnicast ( otInstance *aInstance, const otIp6Address *aAddress, uint16_t aPort)
void
درخواست "DNS/SRP Service Unicast Address" برای انتشار در Thread Network Data.
otNetDataPublishDnsSrpServiceUnicastMeshLocalEid ( otInstance *aInstance, uint16_t aPort)
void
درخواست "DNS/SRP Service Unicast Address" برای انتشار در Thread Network Data.
otNetDataPublishExternalRoute ( otInstance *aInstance, const otExternalRouteConfig *aConfig)
درخواست یک پیشوند مسیر خارجی برای انتشار در Thread Network Data می کند.
otNetDataPublishOnMeshPrefix ( otInstance *aInstance, const otBorderRouterConfig *aConfig)
درخواست یک پیشوند روی مش را برای انتشار در Thread Network Data می کند.
otNetDataReplacePublishedExternalRoute ( otInstance *aInstance, const otIp6Prefix *aPrefix, const otExternalRouteConfig *aConfig)
جایگزین مسیر خارجی منتشر شده قبلی در Thread Network Data می شود.
otNetDataResetMaxLength ( otInstance *aInstance)
void
حداکثر طول ردیابی شده داده شبکه رشته را بازنشانی کنید.
otNetDataSetDnsSrpServicePublisherCallback ( otInstance *aInstance, otNetDataDnsSrpServicePublisherCallback aCallback, void *aContext)
void
زمانی که یک «سرویس DNS/SRP» منتشر شده واقعاً به داده شبکه Thread اضافه یا از آن حذف می‌شود، یک تماس برگشتی تنظیم می‌کند.
otNetDataSetPrefixPublisherCallback ( otInstance *aInstance, otNetDataPrefixPublisherCallback aCallback, void *aContext)
void
یک تماس برگشتی برای اطلاع از زمانی که یک ورودی پیشوند منتشر شده واقعاً به داده شبکه موضوع اضافه یا از آن حذف می شود، تنظیم می کند.
otNetDataSteeringDataCheckJoiner ( otInstance *aInstance, const otExtAddress *aEui64)
بررسی کنید که آیا اطلاعات فرمان شامل Joiner است یا خیر.
otNetDataSteeringDataCheckJoinerWithDiscerner ( otInstance *aInstance, const struct otJoinerDiscerner *aDiscerner)
بررسی کنید که آیا داده‌های فرمان شامل یک Joiner با مقدار تشخیص داده شده است یا خیر.
otNetDataUnpublishDnsSrpService ( otInstance *aInstance)
void
هر ورودی سرویس DNS/SRP (Anycast یا Unicast) که قبلاً اضافه شده است را از داده شبکه Thread لغو انتشار می کند.
otNetDataUnpublishPrefix ( otInstance *aInstance, const otIp6Prefix *aPrefix)
پیشوند On-Mesh یا External Route منتشر شده قبلی را لغو انتشار می کند.
otThreadBecomeChild ( otInstance *aInstance)
در کودکی سعی کنید دوباره وصل شوید.
otThreadBecomeDetached ( otInstance *aInstance)
از شبکه Thread جدا شوید.
otThreadDetachGracefully ( otInstance *aInstance, otDetachGracefullyCallback aCallback, void *aContext)
به سایر گره های شبکه (در صورت وجود) اطلاع می دهد و سپس عملیات پروتکل Thread را متوقف می کند.
otThreadDeviceRoleToString ( otDeviceRole aRole)
const char *
نقش دستگاه را به رشته قابل خواندن توسط انسان تبدیل کنید.
otThreadDiscover ( otInstance *aInstance, uint32_t aScanChannels, uint16_t aPanId, bool aJoiner, bool aEnableEui64Filtering, otHandleActiveScanResult aCallback, void *aCallbackContext)
یک اسکن Thread Discovery را شروع می کند.
otThreadGetChildTimeout ( otInstance *aInstance)
uint32_t
زمان استفاده از Thread Child Timeout (در چند ثانیه) را هنگام اجرای نقش Child دریافت می کند.
otThreadGetDeviceRole ( otInstance *aInstance)
نقش دستگاه را دریافت کنید.
otThreadGetDomainName ( otInstance *aInstance)
const char *
نام دامنه Thread را دریافت می کند.
otThreadGetExtendedPanId ( otInstance *aInstance)
شناسه PAN توسعه یافته IEEE 802.15.4 را دریافت می کند.
otThreadGetFixedDuaInterfaceIdentifier ( otInstance *aInstance)
شناسه رابط را که به صورت دستی برای آدرس Unicast دامنه موضوع مشخص شده است دریافت می کند.
otThreadGetIp6Counters ( otInstance *aInstance)
const otIpCounters *
شمارنده های IPv6 را دریافت می کند.
otThreadGetKeySequenceCounter ( otInstance *aInstance)
uint32_t
thrKeySequenceCounter را دریافت می کند.
otThreadGetKeySwitchGuardTime ( otInstance *aInstance)
uint32_t
thrKeySwitchGuardTime (به ساعت) را دریافت می کند.
otThreadGetLeaderData ( otInstance *aInstance, otLeaderData *aLeaderData)
داده های Thread Leader را دریافت کنید.
otThreadGetLeaderRloc ( otInstance *aInstance, otIp6Address *aLeaderRloc)
یک اشاره گر را به RLOC رهبر برمی گرداند.
otThreadGetLeaderRouterId ( otInstance *aInstance)
uint8_t
شناسه روتر رهبر را دریافت کنید.
otThreadGetLeaderWeight ( otInstance *aInstance)
uint8_t
وزن رهبر را بدست آورید.
otThreadGetLinkLocalAllThreadNodesMulticastAddress ( otInstance *aInstance)
const otIp6Address *
آدرس چندپخشی Thread Link-Local All Thread Nodes را دریافت می کند.
otThreadGetLinkLocalIp6Address ( otInstance *aInstance)
const otIp6Address *
پیوند Thread-local IPv6 آدرس را دریافت می کند.
otThreadGetLinkMode ( otInstance *aInstance)
پیکربندی MLE Link Mode را دریافت کنید.
otThreadGetMaxTimeInQueue ( otInstance *aInstance)
uint32_t
حداکثر زمان در صف را برای پیام ها در صف TX دریافت می کند.
otThreadGetMeshLocalEid ( otInstance *aInstance)
const otIp6Address *
آدرس EID محلی Mesh را دریافت می کند.
otThreadGetMeshLocalPrefix ( otInstance *aInstance)
یک اشاره گر را به پیشوند محلی Mesh برمی گرداند.
otThreadGetMleCounters ( otInstance *aInstance)
const otMleCounters *
شمارنده های Thread MLE را دریافت می کند.
otThreadGetNetworkKey ( otInstance *aInstance, otNetworkKey *aNetworkKey)
void
کلید شبکه Thread را دریافت کنید.
otThreadGetNetworkKeyRef ( otInstance *aInstance)
کلید otNetworkKeyRef برای Thread Network را دریافت کنید.
otThreadGetNetworkName ( otInstance *aInstance)
const char *
نام شبکه Thread را دریافت کنید.
otThreadGetNextDiagnosticTlv (const otMessage *aMessage, otNetworkDiagIterator *aIterator, otNetworkDiagTlv *aNetworkDiagTlv)
شبکه بعدی TLV تشخیصی را در پیام دریافت می کند.
otThreadGetNextNeighborInfo ( otInstance *aInstance, otNeighborInfoIterator *aIterator, otNeighborInfo *aInfo)
اطلاعات همسایه بعدی را دریافت می کند.
otThreadGetParentAverageRssi ( otInstance *aInstance, int8_t *aParentRssi)
تابع میانگین RSSI را برای Thread Parent بازیابی می کند.
otThreadGetParentInfo ( otInstance *aInstance, otRouterInfo *aParentInfo)
این تابع اطلاعات تشخیصی یک روتر Thread را به عنوان والد بازیابی می کند.
otThreadGetParentLastRssi ( otInstance *aInstance, int8_t *aLastRssi)
تابع RSSI آخرین بسته را از Thread Parent بازیابی می کند.
otThreadGetPartitionId ( otInstance *aInstance)
uint32_t
شناسه پارتیشن را دریافت کنید.
otThreadGetRealmLocalAllThreadNodesMulticastAddress ( otInstance *aInstance)
const otIp6Address *
آدرس چندپخشی Thread Realm-Local All Thread Nodes را دریافت می کند.
otThreadGetRloc ( otInstance *aInstance)
const otIp6Address *
آدرس Thread Routing Locator (RLOC) را دریافت می کند.
otThreadGetRloc16 ( otInstance *aInstance)
uint16_t
RLOC16 را دریافت کنید.
otThreadGetServiceAloc ( otInstance *aInstance, uint8_t aServiceId, otIp6Address *aServiceAloc)
سرویس ALOC را برای شناسه سرویس داده شده بازیابی می کند.
otThreadGetTimeInQueueHistogram ( otInstance *aInstance, uint16_t *aNumBins, uint32_t *aBinInterval)
const uint32_t *
هیستوگرام زمان در صف را برای پیام های موجود در صف TX دریافت می کند.
otThreadGetVendorModel ( otInstance *aInstance)
const char *
رشته مدل فروشنده را دریافت کنید.
otThreadGetVendorName ( otInstance *aInstance)
const char *
رشته نام فروشنده را دریافت کنید.
otThreadGetVendorSwVersion ( otInstance *aInstance)
const char *
رشته نسخه فروشنده sw را دریافت کنید.
otThreadGetVersion (void)
uint16_t
نسخه پروتکل Thread را دریافت می کند.
otThreadIsAnycastLocateInProgress ( otInstance *aInstance)
bool
نشان می دهد که آیا درخواست anycast locate در حال حاضر در حال انجام است یا خیر.
otThreadIsDiscoverInProgress ( otInstance *aInstance)
bool
تعیین می کند که آیا کشف موضوع MLE در حال حاضر در حال انجام است یا خیر.
otThreadIsSingleton ( otInstance *aInstance)
bool
نشان می دهد که آیا یک گره تنها روتر در شبکه است یا خیر.
otThreadLocateAnycastDestination ( otInstance *aInstance, const otIp6Address *aAnycastAddress, otThreadAnycastLocatorCallback aCallback, void *aContext)
نزدیکترین مقصد یک آدرس anycast داده شده را درخواست می کند.
otThreadRegisterParentResponseCallback ( otInstance *aInstance, otThreadParentResponseCallback aCallback, void *aContext)
void
برای دریافت داده های MLE Parent Response یک تماس برگشتی ثبت می کند.
otThreadResetIp6Counters ( otInstance *aInstance)
void
شمارنده های IPv6 را بازنشانی می کند.
otThreadResetMleCounters ( otInstance *aInstance)
void
شمارنده های Thread MLE را بازنشانی می کند.
otThreadResetTimeInQueueStat ( otInstance *aInstance)
void
آمار زمان در صف صف TX را بازنشانی می کند.
otThreadSearchForBetterParent ( otInstance *aInstance)
روندی را آغاز می کند تا کودک در حالی که به والدین فعلی خود وابسته است، به دنبال والد بهتری بگردد.
otThreadSendAddressNotification ( otInstance *aInstance, otIp6Address *aDestination, otIp6Address *aTarget, otIp6InterfaceIdentifier *aMlIid)
void
یک پیام اعلان آدرس فعال (ADDR_NTF.ntf) ارسال می کند.
otThreadSendDiagnosticGet ( otInstance *aInstance, const otIp6Address *aDestination, const uint8_t aTlvTypes[], uint8_t aCount, otReceiveDiagnosticGetCallback aCallback, void *aCallbackContext)
درخواست دریافت تشخیصی شبکه را ارسال کنید.
otThreadSendDiagnosticReset ( otInstance *aInstance, const otIp6Address *aDestination, const uint8_t aTlvTypes[], uint8_t aCount)
یک درخواست بازنشانی تشخیصی شبکه ارسال کنید.
otThreadSendProactiveBackboneNotification ( otInstance *aInstance, otIp6Address *aTarget, otIp6InterfaceIdentifier *aMlIid, uint32_t aTimeSinceLastTransaction)
یک پیام Backbone Proactive Notification (PRO_BB.ntf) در پیوند Backbone ارسال می کند.
otThreadSetChildTimeout ( otInstance *aInstance, uint32_t aTimeout)
void
زمان استفاده از Thread Child Timeout (بر حسب ثانیه) را هنگام اجرای نقش Child تنظیم می کند.
otThreadSetDiscoveryRequestCallback ( otInstance *aInstance, otThreadDiscoveryRequestCallback aCallback, void *aContext)
void
برای دریافت داده‌های درخواست کشف MLE، یک تماس برگشتی تنظیم می‌کند.
otThreadSetDomainName ( otInstance *aInstance, const char *aDomainName)
نام دامنه Thread را تنظیم می کند.
otThreadSetEnabled ( otInstance *aInstance, bool aEnabled)
عملیات پروتکل Thread را شروع می کند.
otThreadSetExtendedPanId ( otInstance *aInstance, const otExtendedPanId *aExtendedPanId)
IEEE 802.15.4 Extended PAN ID را تنظیم می کند.
otThreadSetFixedDuaInterfaceIdentifier ( otInstance *aInstance, const otIp6InterfaceIdentifier *aIid)
شناسه رابط را که به صورت دستی برای آدرس Unicast دامنه رشته تعیین شده است تنظیم یا پاک می کند.
otThreadSetJoinerAdvertisement ( otInstance *aInstance, uint32_t aOui, const uint8_t *aAdvData, uint8_t aAdvDataLength)
وقتی شبکه Thread را کشف می کنید، Thread Joiner Advertisement را تنظیم می کند.
otThreadSetKeySequenceCounter ( otInstance *aInstance, uint32_t aKeySequenceCounter)
void
thrKeySequenceCounter را تنظیم می کند.
otThreadSetKeySwitchGuardTime ( otInstance *aInstance, uint32_t aKeySwitchGuardTime)
void
thrKeySwitchGuardTime (به ساعت) را تنظیم می کند.
otThreadSetLinkMode ( otInstance *aInstance, otLinkModeConfig aConfig)
تنظیمات MLE Link Mode را تنظیم کنید.
otThreadSetMeshLocalPrefix ( otInstance *aInstance, const otMeshLocalPrefix *aMeshLocalPrefix)
پیشوند محلی Mesh را تنظیم می کند.
otThreadSetNetworkKey ( otInstance *aInstance, const otNetworkKey *aKey)
کلید شبکه Thread را تنظیم کنید.
otThreadSetNetworkKeyRef ( otInstance *aInstance, otNetworkKeyRef aKeyRef)
کلید شبکه Thread را به عنوان یک otNetworkKeyRef تنظیم کنید.
otThreadSetNetworkName ( otInstance *aInstance, const char *aNetworkName)
نام شبکه Thread را تنظیم کنید.
otThreadSetVendorModel ( otInstance *aInstance, const char *aVendorModel)
رشته مدل فروشنده را تنظیم کنید.
otThreadSetVendorName ( otInstance *aInstance, const char *aVendorName)
رشته نام فروشنده را تنظیم کنید.
otThreadSetVendorSwVersion ( otInstance *aInstance, const char *aVendorSwVersion)
رشته نسخه نرم افزار فروشنده را تنظیم کنید.

سازه ها

otBorderRouterConfig

نمایانگر پیکربندی Border Router است.

otExternalRouteConfig

یک پیکربندی مسیر خارجی را نشان می دهد.

otIpCounters

شمارنده های سطح IP را نشان می دهد.

otLeaderData

نشان دهنده داده های Thread Leader است.

otLinkModeConfig

یک پیکربندی حالت پیوند MLE را نشان می دهد.

otLowpanContextInfo

اطلاعات 6LoWPAN Context ID مرتبط با یک پیشوند در Network Data را نشان می دهد.

otMleCounters

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

otNeighborInfo

اطلاعات تشخیصی را برای گره Thread همسایه نگه می دارد.

otNetworkDiagChildEntry

یک ورودی جدول کودک تشخیصی شبکه را نشان می دهد.

otNetworkDiagConnectivity

یک مقدار اتصال تشخیصی شبکه را نشان می دهد.

otNetworkDiagMacCounters

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

otNetworkDiagMleCounters

یک مقدار شمارنده MLE Diagnostics شبکه را نشان می دهد.

otNetworkDiagRoute

یک مقدار TLV مسیر تشخیصی شبکه را نشان می دهد.

otNetworkDiagRouteData

یک داده مسیر تشخیصی شبکه را نشان می دهد.

otNetworkDiagTlv

یک TLV تشخیصی شبکه را نشان می دهد.

otRouterInfo

اطلاعات عیب یابی را برای Thread Router نگه می دارد.

otServerConfig

یک پیکربندی سرور را نشان می دهد.

otServiceConfig

یک پیکربندی سرویس را نشان می دهد.

otThreadDiscoveryRequestInfo

نشان دهنده داده های درخواست کشف موضوع است.

otThreadParentResponseInfo

نشان دهنده داده های پاسخ والدین MLE است.

شمارش ها

شماره ناشناس

 anonymous enum
خواص
OT_NETWORK_DIAGNOSTIC_TLV_ANSWER

TLV را پاسخ دهید.

OT_NETWORK_DIAGNOSTIC_TLV_BATTERY_LEVEL

سطح باتری TLV.

OT_NETWORK_DIAGNOSTIC_TLV_CHANNEL_PAGES

صفحات کانال TLV.

OT_NETWORK_DIAGNOSTIC_TLV_CHILD

TLV کودک.

OT_NETWORK_DIAGNOSTIC_TLV_CHILD_IP6_ADDR_LIST

لیست آدرس IPv6 کودک TLV.

OT_NETWORK_DIAGNOSTIC_TLV_CHILD_TABLE

میز کودک TLV.

OT_NETWORK_DIAGNOSTIC_TLV_CONNECTIVITY

قابلیت اتصال TLV.

OT_NETWORK_DIAGNOSTIC_TLV_EXT_ADDRESS

MAC Extended Address TLV.

OT_NETWORK_DIAGNOSTIC_TLV_IP6_ADDR_LIST

لیست آدرس IPv6 TLV.

OT_NETWORK_DIAGNOSTIC_TLV_LEADER_DATA

لیدر داده TLV.

OT_NETWORK_DIAGNOSTIC_TLV_MAC_COUNTERS

شمارنده MAC TLV.

OT_NETWORK_DIAGNOSTIC_TLV_MAX_CHILD_TIMEOUT

Max Child Timeout TLV.

OT_NETWORK_DIAGNOSTIC_TLV_MLE_COUNTERS

شمارنده MLE TLV.

OT_NETWORK_DIAGNOSTIC_TLV_MODE

حالت TLV.

OT_NETWORK_DIAGNOSTIC_TLV_NETWORK_DATA

داده های شبکه TLV.

OT_NETWORK_DIAGNOSTIC_TLV_QUERY_ID

شناسه پرس و جو TLV.

OT_NETWORK_DIAGNOSTIC_TLV_ROUTE

Route64 TLV.

OT_NETWORK_DIAGNOSTIC_TLV_ROUTER_NEIGHBOR

روتر Neighbor TLV.

OT_NETWORK_DIAGNOSTIC_TLV_SHORT_ADDRESS

آدرس 16 TLV.

OT_NETWORK_DIAGNOSTIC_TLV_SUPPLY_VOLTAGE

ولتاژ تغذیه TLV.

OT_NETWORK_DIAGNOSTIC_TLV_THREAD_STACK_VERSION

Thread Stack نسخه TLV.

OT_NETWORK_DIAGNOSTIC_TLV_TIMEOUT

مهلت زمانی TLV (حداکثر دوره زمانی نظرسنجی برای SED)

OT_NETWORK_DIAGNOSTIC_TLV_TYPE_LIST

لیست TLV را تایپ کنید.

OT_NETWORK_DIAGNOSTIC_TLV_VENDOR_MODEL

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

OT_NETWORK_DIAGNOSTIC_TLV_VENDOR_NAME

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

OT_NETWORK_DIAGNOSTIC_TLV_VENDOR_SW_VERSION

فروشنده نسخه SW TLV.

OT_NETWORK_DIAGNOSTIC_TLV_VERSION

نسخه TLV.

otDeviceRole

 otDeviceRole

نقش دستگاه Thread را نشان می دهد.

خواص
OT_DEVICE_ROLE_CHILD

نقش Thread Child.

OT_DEVICE_ROLE_DETACHED

در حال حاضر در شبکه/پارتیشن Thread شرکت نمی کنم.

OT_DEVICE_ROLE_DISABLED

پشته Thread غیرفعال است.

OT_DEVICE_ROLE_LEADER

نقش رهبر موضوع.

OT_DEVICE_ROLE_ROUTER

نقش Thread Router.

otNetDataPublisherEvent

 otNetDataPublisherEvent

رویدادهای گزارش شده از تماس های ناشر را نشان می دهد.

خواص
OT_NETDATA_PUBLISHER_EVENT_ENTRY_ADDED

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

OT_NETDATA_PUBLISHER_EVENT_ENTRY_REMOVED

ورودی منتشر شده از Thread Network Data حذف می شود.

otRoutePreference

 otRoutePreference

مقادیر معتبری را برای mPreference در otExternalRouteConfig و otBorderRouterConfig تعریف می کند.

خواص
OT_ROUTE_PREFERENCE_HIGH

ترجیح مسیر بالا

OT_ROUTE_PREFERENCE_LOW

ترجیح مسیر کم

OT_ROUTE_PREFERENCE_MED

ترجیح مسیر متوسط

Typedefs

otBorderRouterConfig

struct otBorderRouterConfig otBorderRouterConfig

نمایانگر پیکربندی Border Router است.

otDetachGracefullyCallback

void(* otDetachGracefullyCallback)(void *aContext)

این فراخوانی به برنامه اطلاع می دهد که فرآیند جداسازی به پایان رسیده است.

جزئیات
مولفه های
[in] aContext
اشاره‌ای به زمینه خاص برنامه.

otExternalRouteConfig

struct otExternalRouteConfig otExternalRouteConfig

یک پیکربندی مسیر خارجی را نشان می دهد.

otIpCounters

struct otIpCounters otIpCounters

شمارنده های سطح IP را نشان می دهد.

otLeaderData

struct otLeaderData otLeaderData

نشان دهنده داده های Thread Leader است.

otLinkModeConfig

struct otLinkModeConfig otLinkModeConfig

یک پیکربندی حالت پیوند MLE را نشان می دهد.

otLowpanContextInfo

struct otLowpanContextInfo otLowpanContextInfo

اطلاعات 6LoWPAN Context ID مرتبط با یک پیشوند در Network Data را نشان می دهد.

otMleCounters

struct otMleCounters otMleCounters

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

otNeighborInfoIterator

int16_t otNeighborInfoIterator

برای تکرار از طریق جدول همسایه استفاده می شود.

otNetDataDnsSrpServicePublisherCallback

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

نوع اشاره گر، پاسخ تماس مورد استفاده برای اطلاع از اضافه شدن یا حذف ورودی «سرویس DNS/SRP» به داده شبکه موضوعی را مشخص می کند.

در هنگام حذف، فراخوانی مجدد مستقل از اینکه ورودی توسط Publisher حذف شود (مثلاً زمانی که ورودی های مشابه در داده های شبکه وجود دارد) یا از طریق یک فراخوان صریح برای لغو انتشار ورودی (یعنی تماس با otNetDataUnpublishDnsSrpService() فراخوانی می شود. ).

جزئیات
مولفه های
[in] aEvent
رویداد را نشان می دهد (اعم از اینکه ورودی اضافه شده یا حذف شده است).
[in] aContext
اشاره‌ای به زمینه خاص برنامه.

otNetDataPrefixPublisherCallback

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

نوع اشاره گر، پاسخ تماس مورد استفاده برای اطلاع از اضافه شدن یا حذف یک پیشوند (روی مش یا مسیر خارجی) به داده شبکه موضوعی را مشخص می کند.

در هنگام حذف، تماس برگشتی مستقل از این که آیا ورودی توسط Publisher حذف شود (مثلاً زمانی که تعداد زیادی ورودی مشابه در داده های شبکه وجود دارد) یا از طریق یک فراخوان صریح برای لغو انتشار ورودی، فراخوانی می شود.

جزئیات
مولفه های
[in] aEvent
رویداد را نشان می دهد (اعم از اینکه ورودی اضافه شده یا حذف شده است).
[in] aPrefix
اشاره گر به ورودی پیشوند.
[in] aContext
اشاره‌ای به زمینه خاص برنامه.

otNetDataPublisherEvent

enum otNetDataPublisherEvent otNetDataPublisherEvent

رویدادهای گزارش شده از تماس های ناشر را نشان می دهد.

otNetworkDataIterator

uint32_t otNetworkDataIterator

برای تکرار از طریق اطلاعات شبکه داده استفاده می شود.

otNetworkDiagChildEntry

struct otNetworkDiagChildEntry otNetworkDiagChildEntry

یک ورودی جدول کودک تشخیصی شبکه را نشان می دهد.

otNetworkDiagConnectivity

struct otNetworkDiagConnectivity otNetworkDiagConnectivity

یک مقدار اتصال تشخیصی شبکه را نشان می دهد.

otNetworkDiagIterator

uint16_t otNetworkDiagIterator

برای تکرار از طریق Network Diagnostic TLV استفاده می شود.

otNetworkDiagMacCounters

struct otNetworkDiagMacCounters otNetworkDiagMacCounters

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

برای تعاریف فیلدهای عضو به RFC 2863 مراجعه کنید.

otNetworkDiagMleCounters

struct otNetworkDiagMleCounters otNetworkDiagMleCounters

یک مقدار شمارنده MLE Diagnostics شبکه را نشان می دهد.

otNetworkDiagRoute

struct otNetworkDiagRoute otNetworkDiagRoute

یک مقدار TLV مسیر تشخیصی شبکه را نشان می دهد.

otNetworkDiagRouteData

struct otNetworkDiagRouteData otNetworkDiagRouteData

یک داده مسیر تشخیصی شبکه را نشان می دهد.

otNetworkDiagTlv

struct otNetworkDiagTlv otNetworkDiagTlv

یک TLV تشخیصی شبکه را نشان می دهد.

otReceiveDiagnosticGetCallback

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

هنگامی که پاسخ دریافت تشخیصی شبکه دریافت می شود، اشاره گر فراخوانی می شود.

جزئیات
مولفه های
[in] aError
خطای زمانی که نتوانست پاسخ را دریافت کند.
[in] aMessage
اشاره گر به بافر پیام حاوی بار پاسخ دریافتی تشخیصی شبکه. فقط زمانی در دسترس است که aError OT_ERROR_NONE باشد.
[in] aMessageInfo
اشاره گر به اطلاعات پیام برای aMessage . فقط زمانی در دسترس است که aError OT_ERROR_NONE باشد.
[in] aContext
اشاره‌ای به زمینه خاص برنامه.

otRoutePreference

enum otRoutePreference otRoutePreference

مقادیر معتبری را برای mPreference در otExternalRouteConfig و otBorderRouterConfig تعریف می کند.

otServerConfig

struct otServerConfig otServerConfig

یک پیکربندی سرور را نشان می دهد.

otServiceConfig

struct otServiceConfig otServiceConfig

یک پیکربندی سرویس را نشان می دهد.

otThreadAnycastLocatorCallback

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

نوع اشاره گر، بازخوانی را برای اطلاع از نتیجه درخواست otThreadLocateAnycastDestination() تعریف می کند.

جزئیات
مولفه های
[in] aContext
اشاره گر به یک زمینه دلخواه (ارائه شده در هنگام ثبت تماس برگشتی).
[in] aError
خطا هنگام رسیدگی به درخواست OT_ERROR_NONE نشان دهنده موفقیت است. OT_ERROR_RESPONSE_TIMEOUT نشان می‌دهد مقصدی پیدا نشد. OT_ERROR_ABORT نشان می‌دهد که درخواست لغو شده است.
[in] aMeshLocalAddress
یک اشاره‌گر به EID محلی مش نزدیک‌ترین مقصد آدرس anycast زمانی که aError OT_ERROR_NONE است، در غیر این صورت NULL.
[in] aRloc16
RLOC16 مقصد در صورت یافتن، در غیر این صورت RLOC16 نامعتبر است (0xfffe).

otThreadDiscoveryRequestCallback

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

هر بار که یک پیام درخواست کشف MLE دریافت می شود، اشاره گر فراخوانی می شود.

جزئیات
مولفه های
[in] aInfo
اشاره‌ای به داده‌های اطلاعات درخواست کشف.
[in] aContext
اشاره گر به زمینه خاص برنامه کاربردی.

otThreadDiscoveryRequestInfo

struct otThreadDiscoveryRequestInfo otThreadDiscoveryRequestInfo

نشان دهنده داده های درخواست کشف موضوع است.

otThreadParentResponseCallback

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

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

این در otThreadRegisterParentResponseCallback() استفاده می شود.

جزئیات
مولفه های
[in] aInfo
اشاره گر به مکانی در پشته که داده های آمار را در خود نگه می دارد.
[in] aContext
یک اشاره گر به زمینه خاص کلاینت برگشتی.

otThreadParentResponseInfo

struct otThreadParentResponseInfo otThreadParentResponseInfo

نشان دهنده داده های پاسخ والدین MLE است.

کارکرد

otConvertDurationInSecondsToString

void otConvertDurationInSecondsToString(
  uint32_t aDuration,
  char *aBuffer,
  uint16_t aSize
)

مدت زمان uint32_t (در ثانیه) را به یک رشته قابل خواندن توسط انسان تبدیل می کند.

برای فعال کردن OPENTHREAD_CONFIG_UPTIME_ENABLE نیاز دارد.

رشته از قالب پیروی می کند " : : "برای ساعت ها، دقیقه ها، ثانیه ها (اگر مدت زمان کوتاه تر از یک روز باشد) یا"

د : : (اگر بیشتر از یک روز باشد).

اگر رشته به دست آمده در aBuffer (در کاراکترهای aSize آن) قرار نگیرد، رشته کوتاه می‌شود اما رشته خروجی همیشه تهی است.

برای استفاده با mAge یا mConnectionTime در ساختارهای otNeighborInfo یا otChildInfo در نظر گرفته شده است.

جزئیات
مولفه های
[in] aDuration
فاصله زمانی بر حسب ثانیه
[out] aBuffer
یک اشاره گر به یک آرایه char برای خروجی رشته.
[in] aSize
اندازه aBuffer (بر حسب بایت). برای استفاده از OT_DURATION_STRING_SIZE توصیه می شود.

otNetDataContainsOmrPrefix

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

بررسی کنید که آیا یک پیشوند داده شده می تواند به عنوان یک پیشوند معتبر OMR عمل کند و همچنین داده های شبکه رهبر حاوی این پیشوند است.

جزئیات
مولفه های
[in] aInstance
اشاره گر به یک نمونه OpenThread.
[in] aPrefix
اشاره گر به پیشوند IPv6.
برمی گرداند
آیا aPrefix یک پیشوند معتبر OMR است و داده های شبکه رهبر حاوی پیشوند OMR aPrefix است.

otNetDataGet

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

یک کپی کامل یا پایدار از داده شبکه موضوعی پارتیشن ارائه دهید.

جزئیات
مولفه های
[in] aInstance
اشاره گر به یک نمونه OpenThread.
[in] aStable
درست هنگام کپی کردن نسخه پایدار، نادرست هنگام کپی کردن نسخه کامل.
[out] aData
اشاره گر به بافر داده
[in,out] aDataLength
هنگام ورود، اندازه بافر داده توسط aData نشان داده می شود. در هنگام خروج، تعداد بایت های کپی شده.
ارزش های بازگشتی
OT_ERROR_NONE
داده های شبکه موضوعی با موفقیت در aData کپی شد و aDataLength به روز شد.
OT_ERROR_NO_BUFS
فضای کافی در aData برای کپی کامل داده های شبکه Thread وجود ندارد.

otNetDataGetCommissioningDataset

void otNetDataGetCommissioningDataset(
  otInstance *aInstance,
  otCommissioningDataset *aDataset
)

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

جزئیات
مولفه های
[in] aInstance
اشاره گر به نمونه OpenThread.
[out] aDataset
یک اشاره گر به otCommissioningDataset برای پر کردن.

otNetDataGetLength

uint8_t otNetDataGetLength(
  otInstance *aInstance
)

طول فعلی (تعداد بایت) داده شبکه موضوعی پارتیشن را دریافت کنید.

جزئیات
مولفه های
[in] aInstance
اشاره گر به یک نمونه OpenThread.
برمی گرداند
طول داده های شبکه

otNetDataGetMaxLength

uint8_t otNetDataGetMaxLength(
  otInstance *aInstance
)

حداکثر طول مشاهده‌شده داده‌های شبکه Thread را از زمان اولیه‌سازی پشته OT یا از آخرین تماس با otNetDataResetMaxLength() دریافت کنید.

جزئیات
مولفه های
[in] aInstance
اشاره گر به یک نمونه OpenThread.
برمی گرداند
حداکثر طول داده شبکه (نشان آب بالا برای طول داده شبکه).

otNetDataGetNextLowpanContextInfo

otError otNetDataGetNextLowpanContextInfo(
  otInstance *aInstance,
  otNetworkDataIterator *aIterator,
  otLowpanContextInfo *aContextInfo
)

اطلاعات 6LoWPAN Context ID بعدی را در داده های شبکه پارتیشن دریافت کنید.

جزئیات
مولفه های
[in] aInstance
اشاره گر به یک نمونه OpenThread.
[in,out] aIterator
اشاره گر به تکرار کننده داده های شبکه. برای دریافت اولین ورودی سرویس باید روی OT_NETWORK_DATA_ITERATOR_INIT تنظیم شود.
[out] aContextInfo
یک اشاره گر به جایی که اطلاعات 6LoWPAN Context ID بازیابی شده قرار می گیرد.
ارزش های بازگشتی
OT_ERROR_NONE
اطلاعات 6LoWPAN Context ID بعدی با موفقیت یافت شد.
OT_ERROR_NOT_FOUND
هیچ اطلاعات زمینه 6LoWPAN بعدی در داده های شبکه پارتیشن وجود ندارد.

otNetDataGetNextOnMeshPrefix

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

پیشوند On Mesh بعدی را در داده های شبکه پارتیشن دریافت کنید.

جزئیات
مولفه های
[in] aInstance
اشاره گر به یک نمونه OpenThread.
[in,out] aIterator
اشاره گر به زمینه شبکه داده تکرار کننده. برای دریافت اولین ورودی مش، باید روی OT_NETWORK_DATA_ITERATOR_INIT تنظیم شود.
[out] aConfig
یک اشاره گر به جایی که اطلاعات On Mesh Prefix قرار خواهد گرفت.
ارزش های بازگشتی
OT_ERROR_NONE
پیشوند On Mesh بعدی با موفقیت پیدا شد.
OT_ERROR_NOT_FOUND
هیچ پیشوند بعدی On Mesh در داده شبکه موضوعی وجود ندارد.

otNetDataGetNextRoute

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

مسیر خارجی بعدی را در داده های شبکه پارتیشن دریافت کنید.

جزئیات
مولفه های
[in] aInstance
اشاره گر به یک نمونه OpenThread.
[in,out] aIterator
اشاره گر به زمینه شبکه داده تکرار کننده. برای دریافت اولین ورودی مسیر خارجی باید روی OT_NETWORK_DATA_ITERATOR_INIT تنظیم شود.
[out] aConfig
اشاره گر به جایی که اطلاعات مسیر خارجی قرار می گیرد.
ارزش های بازگشتی
OT_ERROR_NONE
مسیر خارجی بعدی با موفقیت پیدا شد.
OT_ERROR_NOT_FOUND
هیچ ورودی مسیر خارجی بعدی در داده شبکه موضوعی وجود ندارد.

otNetDataGetNextService

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

سرویس بعدی را در Network Data پارتیشن دریافت کنید.

جزئیات
مولفه های
[in] aInstance
اشاره گر به یک نمونه OpenThread.
[in,out] aIterator
اشاره گر به زمینه شبکه داده تکرار کننده. برای دریافت اولین ورودی سرویس باید روی OT_NETWORK_DATA_ITERATOR_INIT تنظیم شود.
[out] aConfig
یک اشاره گر به جایی که اطلاعات سرویس قرار می گیرد.
ارزش های بازگشتی
OT_ERROR_NONE
سرویس بعدی با موفقیت پیدا شد.
OT_ERROR_NOT_FOUND
هیچ سرویس بعدی در داده های شبکه پارتیشن وجود ندارد.

otNetDataGetStableVersion

uint8_t otNetDataGetStableVersion(
  otInstance *aInstance
)

نسخه Stable Network Data را دریافت کنید.

جزئیات
مولفه های
[in] aInstance
اشاره گر به یک نمونه OpenThread.
برمی گرداند
نسخه داده های شبکه پایدار

otNetDataGetVersion

uint8_t otNetDataGetVersion(
  otInstance *aInstance
)

نسخه Network Data را دریافت کنید.

جزئیات
مولفه های
[in] aInstance
اشاره گر به یک نمونه OpenThread.
برمی گرداند
نسخه داده شبکه

otNetDataIsDnsSrpServiceAdded

bool otNetDataIsDnsSrpServiceAdded(
  otInstance *aInstance
)

نشان می دهد که آیا در حال حاضر ورودی "DNS/SRP Service" به داده های شبکه Thread اضافه شده است یا خیر.

برای فعال کردن ویژگی OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE نیاز است.

جزئیات
مولفه های
[in] aInstance
اشاره گر به یک نمونه OpenThread.
ارزش های بازگشتی
TRUE
ورودی سرویس DNS/SRP منتشر شده به Thread Network Data اضافه می شود.
FALSE
ورودی به Thread Network Data اضافه نشده است یا ورودی برای انتشار وجود ندارد.

otNetDataIsPrefixAdded

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

نشان می دهد که آیا در حال حاضر یک ورودی پیشوند منتشر شده (روی مش یا مسیر خارجی) به داده شبکه موضوع اضافه شده است یا خیر.

برای فعال کردن ویژگی OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE نیاز است.

جزئیات
مولفه های
[in] aInstance
اشاره گر به یک نمونه OpenThread.
[in] aPrefix
اشاره گر به پیشوند (نباید NULL باشد).
ارزش های بازگشتی
TRUE
ورودی پیشوند منتشر شده به Thread Network Data اضافه می شود.
FALSE
ورودی به Thread Network Data اضافه نشده است یا ورودی برای انتشار وجود ندارد.

otNetDataPublishDnsSrpServiceAnycast

void otNetDataPublishDnsSrpServiceAnycast(
  otInstance *aInstance,
  uint8_t aSequenceNUmber
)

درخواست "DNS/SRP Service Anycast Address" برای انتشار در Thread Network Data.

برای فعال کردن ویژگی OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE نیاز است.

فراخوانی به این تابع، هر ورودی قبلی «سرویس DNS/SRP» را که منتشر شده بود حذف و جایگزین می‌کند (از تماس قبلی با هر یک از توابع otNetDataPublishDnsSrpService{Type}() ).

جزئیات
مولفه های
[in] aInstance
اشاره گر به یک نمونه OpenThread.
[in] aSequenceNUmber
شماره توالی سرویس Anycast DNS/SRP.

otNetDataPublishDnsSrpServiceUnicast

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

درخواست "DNS/SRP Service Unicast Address" برای انتشار در Thread Network Data.

برای فعال کردن ویژگی OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE نیاز است.

فراخوانی به این تابع، هر ورودی قبلی «سرویس DNS/SRP» را که منتشر شده بود حذف و جایگزین می‌کند (از تماس قبلی با هر یک از توابع otNetDataPublishDnsSrpService{Type}() ).

با قرار دادن آدرس و اطلاعات پورت در داده‌های سرویس TLV، «آدرس Unicast سرویس DNS/SRP» را منتشر می‌کند.

جزئیات
مولفه های
[in] aInstance
اشاره گر به یک نمونه OpenThread.
[in] aAddress
آدرس سرور DNS/SRP برای انتشار (نباید NULL باشد).
[in] aPort
شماره پورت سرور SRP برای انتشار.

otNetDataPublishDnsSrpServiceUnicastMeshLocalEid

void otNetDataPublishDnsSrpServiceUnicastMeshLocalEid(
  otInstance *aInstance,
  uint16_t aPort
)

درخواست "DNS/SRP Service Unicast Address" برای انتشار در Thread Network Data.

برای فعال کردن ویژگی OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE نیاز است.

فراخوانی به این تابع، هر ورودی قبلی «سرویس DNS/SRP» را که منتشر شده بود حذف و جایگزین می‌کند (از تماس قبلی با هر یک از توابع otNetDataPublishDnsSrpService{Type}() ).

برخلاف otNetDataPublishDnsSrpServiceUnicast() که نیاز به ارائه آدرس منتشر شده دارد و اطلاعات موجود در داده های سرویس TLV را شامل می شود، این تابع از شبکه EID محلی دستگاه استفاده می کند و اطلاعات موجود در داده های TLV سرور را شامل می شود.

جزئیات
مولفه های
[in] aInstance
اشاره گر به یک نمونه OpenThread.
[in] aPort
شماره پورت سرور SRP برای انتشار.

otNetDataPublishExternalRoute

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

درخواست یک پیشوند مسیر خارجی برای انتشار در Thread Network Data می کند.

برای فعال کردن ویژگی OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE نیاز است.

فقط ورودی های پایدار می توانند منتشر شوند (یعنی aConfig.mStable باید درست باشد).

فراخوانی بعدی به این روش جایگزین درخواست قبلی برای همان پیشوند خواهد شد. به ویژه، اگر فراخوانی جدید فقط پرچم ها را تغییر دهد (مثلاً سطح ترجیحی) و پیشوند قبلاً در داده های شبکه اضافه شده باشد، تغییر به پرچم ها بلافاصله در داده های شبکه منعکس می شود. این تضمین می کند که ورودی های موجود در داده های شبکه به طور ناگهانی حذف نمی شوند. توجه داشته باشید که تغییر در سطح اولویت می‌تواند بعداً باعث حذف ورودی از داده‌های شبکه پس از تعیین وجود گره‌های دیگری شود که همان پیشوند را با اولویت یکسان یا بالاتر منتشر می‌کنند.

جزئیات
مولفه های
[in] aInstance
اشاره گر به یک نمونه OpenThread.
[in] aConfig
پیکربندی مسیر خارجی برای انتشار (نباید NULL باشد).
ارزش های بازگشتی
OT_ERROR_NONE
مسیر خارجی با موفقیت منتشر شد.
OT_ERROR_INVALID_ARGS
aConfig معتبر نیست (پیشوند بد، ترکیب پرچم نامعتبر، یا پایدار نبودن).
OT_ERROR_NO_BUFS
نمی توان یک ورودی برای درخواست جدید اختصاص داد. ناشر از تعداد محدودی ورودی (مشترک بین پیشوند روی مش و مسیر خارجی) پشتیبانی می کند که توسط پیکربندی OPENTHREAD_CONFIG_NETDATA_PUBLISHER_MAX_PREFIX_ENTRIES تعیین شده است.

otNetDataPublishOnMeshPrefix

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

درخواست یک پیشوند روی مش را برای انتشار در Thread Network Data می کند.

برای فعال کردن ویژگی OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE نیاز است.

فقط ورودی های پایدار می توانند منتشر شوند (یعنی aConfig.mStable باید درست باشد).

فراخوانی بعدی به این روش جایگزین درخواست قبلی برای همان پیشوند خواهد شد. به ویژه، اگر فراخوانی جدید فقط پرچم ها را تغییر دهد (مثلاً سطح ترجیحی) و پیشوند قبلاً در داده های شبکه اضافه شده باشد، تغییر به پرچم ها بلافاصله در داده های شبکه منعکس می شود. این تضمین می کند که ورودی های موجود در داده های شبکه به طور ناگهانی حذف نمی شوند. توجه داشته باشید که تغییر در سطح اولویت می‌تواند بعداً باعث حذف ورودی از داده‌های شبکه پس از تعیین وجود گره‌های دیگری شود که همان پیشوند را با اولویت یکسان یا بالاتر منتشر می‌کنند.

جزئیات
مولفه های
[in] aInstance
اشاره گر به یک نمونه OpenThread.
[in] aConfig
پیکربندی پیشوند روی مش برای انتشار (نباید NULL باشد).
ارزش های بازگشتی
OT_ERROR_NONE
پیشوند روی مش با موفقیت منتشر شد.
OT_ERROR_INVALID_ARGS
aConfig معتبر نیست (پیشوند بد، ترکیب پرچم نامعتبر، یا پایدار نبودن).
OT_ERROR_NO_BUFS
نمی توان یک ورودی برای درخواست جدید اختصاص داد. ناشر از تعداد محدودی ورودی (مشترک بین پیشوند روی مش و مسیر خارجی) پشتیبانی می کند که توسط پیکربندی OPENTHREAD_CONFIG_NETDATA_PUBLISHER_MAX_PREFIX_ENTRIES تعیین شده است.

otNetDataReplacePublishedExternalRoute

otError otNetDataReplacePublishedExternalRoute(
  otInstance *aInstance,
  const otIp6Prefix *aPrefix,
  const otExternalRouteConfig *aConfig
)

جایگزین مسیر خارجی منتشر شده قبلی در Thread Network Data می شود.

برای فعال کردن ویژگی OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE نیاز است.

اگر قبلاً هیچ مسیر خارجی منطبق با aPrefix وجود نداشته باشد، این تابع مانند otNetDataPublishExternalRoute() عمل می کند، به عنوان مثال، فرآیند انتشار aConfig را به عنوان یک مسیر خارجی در داده شبکه Thread آغاز می کند.

اگر ورودی مسیری که قبلاً منتشر شده باشد مطابق با aPrefix باشد، با پیشوند جدید aConfig جایگزین خواهد شد.

  • اگر aPrefix قبلاً در Network Data اضافه شده باشد، تغییر به پیشوند جدید در aConfig بلافاصله در Network Data منعکس می شود. این تضمین می کند که ورودی های مسیر در داده های شبکه به طور ناگهانی حذف نمی شوند و انتقال از aPrefix به پیشوند جدید هموار است.
  • اگر aPrefix منتشر شده قدیمی به داده های شبکه اضافه نشده باشد، با پیشوند aConfig جدید جایگزین می شود اما بلافاصله اضافه نمی شود. در عوض، فرآیند انتشار آن را در داده‌های شبکه (نظارت بر داده‌های شبکه برای تعیین زمان/آیا اضافه کردن پیشوند، بسته به تعداد پیشوندهای مشابه موجود در داده‌های شبکه) آغاز می‌کند.

جزئیات
مولفه های
[in] aInstance
اشاره گر به یک نمونه OpenThread.
[in] aPrefix
پیشوند مسیر خارجی منتشر شده قبلی برای جایگزینی.
[in] aConfig
پیکربندی مسیر خارجی برای انتشار.
ارزش های بازگشتی
OT_ERROR_NONE
مسیر خارجی با موفقیت منتشر شد.
OT_ERROR_INVALID_ARGS
aConfig معتبر نیست (پیشوند بد، ترکیب پرچم نامعتبر، یا پایدار نبودن).
OT_ERROR_NO_BUFS
نمی توان یک ورودی برای درخواست جدید اختصاص داد. ناشر از تعداد محدودی ورودی (مشترک بین پیشوند روی مش و مسیر خارجی) پشتیبانی می کند که توسط پیکربندی OPENTHREAD_CONFIG_NETDATA_PUBLISHER_MAX_PREFIX_ENTRIES تعیین شده است.

otNetDataResetMaxLength

void otNetDataResetMaxLength(
  otInstance *aInstance
)

حداکثر طول ردیابی شده داده شبکه رشته را بازنشانی کنید.

جزئیات
مولفه های
[in] aInstance
اشاره گر به یک نمونه OpenThread.
همچنین ببینید:
otNetDataGetMaxLength

otNetDataSetDnsSrpServicePublisherCallback

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

زمانی که یک «سرویس DNS/SRP» منتشر شده واقعاً به داده شبکه Thread اضافه یا از آن حذف می‌شود، یک تماس برگشتی تنظیم می‌کند.

فراخوانی بعدی به این تابع جایگزین هر تابع تماس قبلی تنظیم شده می شود.

برای فعال کردن ویژگی OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE نیاز است.

جزئیات
مولفه های
[in] aInstance
اشاره گر به یک نمونه OpenThread.
[in] aCallback
نشانگر تابع پاسخ به تماس (در صورت عدم نیاز می تواند NULL باشد).
[in] aContext
یک اشاره گر به زمینه خاص برنامه (در هنگام فراخوانی aCallback استفاده می شود).

otNetDataSetPrefixPublisherCallback

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

یک تماس برگشتی برای اطلاع از زمانی که یک ورودی پیشوند منتشر شده واقعاً به داده شبکه موضوع اضافه یا از آن حذف می شود، تنظیم می کند.

فراخوانی بعدی به این تابع جایگزین هر تابع تماس قبلی تنظیم شده می شود.

برای فعال کردن ویژگی OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE نیاز است.

جزئیات
مولفه های
[in] aInstance
اشاره گر به یک نمونه OpenThread.
[in] aCallback
نشانگر تابع پاسخ به تماس (در صورت عدم نیاز می تواند NULL باشد).
[in] aContext
یک اشاره گر به زمینه خاص برنامه (در هنگام فراخوانی aCallback استفاده می شود).

otNetDataSteeringDataCheckJoiner

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

بررسی کنید که آیا اطلاعات فرمان شامل Joiner است یا خیر.

جزئیات
مولفه های
[in] aInstance
اشاره گر به یک نمونه OpenThread.
[in] aEui64
اشاره گر به IEEE EUI-64 Joiner's.
ارزش های بازگشتی
OT_ERROR_NONE
aEui64 در داده های فرمان گنجانده شده است.
OT_ERROR_INVALID_STATE
هیچ داده فرمان وجود ندارد.
OT_ERROR_NOT_FOUND
aEui64 در اطلاعات فرمان گنجانده نشده است.

otNetDataSteeringDataCheckJoinerWithDiscerner

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

بررسی کنید که آیا داده‌های فرمان شامل یک Joiner با مقدار تشخیص داده شده است یا خیر.

جزئیات
مولفه های
[in] aInstance
اشاره گر به یک نمونه OpenThread.
[in] aDiscerner
اشاره گر به Joiner Discerner.
ارزش های بازگشتی
OT_ERROR_NONE
aDiscerner در داده های فرمان گنجانده شده است.
OT_ERROR_INVALID_STATE
هیچ داده فرمان وجود ندارد.
OT_ERROR_NOT_FOUND
aDiscerner در اطلاعات فرمان گنجانده نشده است.

otNetDataUnpublishDnsSrpService

void otNetDataUnpublishDnsSrpService(
  otInstance *aInstance
)

هر ورودی سرویس DNS/SRP (Anycast یا Unicast) که قبلاً اضافه شده است را از داده شبکه Thread لغو انتشار می کند.

OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE باید فعال باشد.

جزئیات
مولفه های
[in] aInstance
اشاره گر به یک نمونه OpenThread.

otNetDataUnpublishPrefix

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

پیشوند On-Mesh یا External Route منتشر شده قبلی را لغو انتشار می کند.

OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE باید فعال باشد.

جزئیات
مولفه های
[in] aInstance
اشاره گر به یک نمونه OpenThread.
[in] aPrefix
پیشوند لغو انتشار (نباید NULL باشد).
ارزش های بازگشتی
OT_ERROR_NONE
پیشوند با موفقیت لغو شد.
OT_ERROR_NOT_FOUND
پیشوند در لیست منتشر شده یافت نشد.

otThreadBecomeChild

otError otThreadBecomeChild(
  otInstance *aInstance
)

در کودکی سعی کنید دوباره وصل شوید.

جزئیات
مولفه های
[in] aInstance
اشاره گر به یک نمونه OpenThread.
ارزش های بازگشتی
OT_ERROR_NONE
تلاش برای بچه شدن را با موفقیت شروع کنید.
OT_ERROR_INVALID_STATE
تاپیک غیرفعال است

otThreadBecomeDetached

otError otThreadBecomeDetached(
  otInstance *aInstance
)

از شبکه Thread جدا شوید.

جزئیات
مولفه های
[in] aInstance
اشاره گر به یک نمونه OpenThread.
ارزش های بازگشتی
OT_ERROR_NONE
با موفقیت از شبکه Thread جدا شد.
OT_ERROR_INVALID_STATE
تاپیک غیرفعال است

otThreadDetachGracefully

otError otThreadDetachGracefully(
  otInstance *aInstance,
  otDetachGracefullyCallback aCallback,
  void *aContext
)

به سایر گره های شبکه (در صورت وجود) اطلاع می دهد و سپس عملیات پروتکل Thread را متوقف می کند.

اگر یک روتر باشد، یک Address Release می فرستد، یا اگر یک فرزند باشد، تایم اوت فرزند خود را روی 0 تنظیم می کند.

جزئیات
مولفه های
[in] aInstance
اشاره گر به یک نمونه OpenThread.
[in] aCallback
اشاره گر به تابعی که پس از اتمام جداسازی فراخوانی می شود.
[in] aContext
اشاره گر به زمینه خاص برنامه کاربردی.
ارزش های بازگشتی
OT_ERROR_NONE
با موفقیت شروع به جدا شدن کرد.
OT_ERROR_BUSY
جداسازی از قبل در حال انجام است.

otThreadDeviceRoleToString

const char * otThreadDeviceRoleToString(
  otDeviceRole aRole
)

نقش دستگاه را به رشته قابل خواندن توسط انسان تبدیل کنید.

جزئیات
مولفه های
[in] aRole
نقش دستگاه برای تبدیل.
برمی گرداند
رشته ای که aRole را نشان می دهد.

otThreadDiscover

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

یک اسکن Thread Discovery را شروع می کند.

جزئیات
مولفه های
[in] aInstance
اشاره گر به یک نمونه OpenThread.
[in] aScanChannels
یک بیت برداری که نشان می دهد کدام کانال ها را اسکن کنید (به عنوان مثال OT_CHANNEL_11_MASK).
[in] aPanId
فیلتر PAN ID (برای غیرفعال کردن فیلتر روی Broadcast PAN تنظیم کنید).
[in] aJoiner
ارزش پرچم وصال در درخواست کشف TLV.
[in] aEnableEui64Filtering
برای فیلتر کردن پاسخ‌ها در EUI-64 درست است، در غیر این صورت نادرست است.
[in] aCallback
اشاره گر به تابعی که با دریافت پاسخ یا اسکن MLE Discovery فراخوانی می شود، تکمیل می شود.
[in] aCallbackContext
اشاره‌ای به زمینه خاص برنامه.
ارزش های بازگشتی
OT_ERROR_NONE
یک اسکن کشف موضوع با موفقیت شروع شد.
OT_ERROR_INVALID_STATE
رابط IPv6 فعال نیست (netif بالا نیست).
OT_ERROR_NO_BUFS
پیام برای درخواست کشف تخصیص داده نشد.
OT_ERROR_BUSY
اسکن کشف موضوع در حال حاضر در حال انجام است.

otThreadGetChildTimeout

uint32_t otThreadGetChildTimeout(
  otInstance *aInstance
)

زمان استفاده از Thread Child Timeout (در چند ثانیه) را هنگام اجرای نقش Child دریافت می کند.

جزئیات
مولفه های
[in] aInstance
اشاره گر به یک نمونه OpenThread.
برمی گرداند
مقدار Thread Child Timeout در ثانیه.
همچنین ببینید:
otThreadSetChildTimeout

otThreadGetDeviceRole

otDeviceRole otThreadGetDeviceRole(
  otInstance *aInstance
)

نقش دستگاه را دریافت کنید.

جزئیات
مولفه های
[in] aInstance
اشاره گر به یک نمونه OpenThread.
ارزش های بازگشتی
OT_DEVICE_ROLE_DISABLED
پشته Thread غیرفعال است.
OT_DEVICE_ROLE_DETACHED
دستگاه در حال حاضر در شبکه/پارتیشن Thread شرکت نمی کند.
OT_DEVICE_ROLE_CHILD
دستگاه در حال حاضر به عنوان Thread Child کار می کند.
OT_DEVICE_ROLE_ROUTER
دستگاه در حال حاضر به عنوان Thread Router کار می کند.
OT_DEVICE_ROLE_LEADER
دستگاه در حال حاضر به عنوان Thread Leader کار می کند.

otThreadGetDomainName

const char * otThreadGetDomainName(
  otInstance *aInstance
)

نام دامنه Thread را دریافت می کند.

جزئیات
مولفه های
[in] aInstance
اشاره گر به یک نمونه OpenThread.
برمی گرداند
اشاره گر به Thread Domain Name.
همچنین ببینید:
otThreadSetDomainName

otThreadGetExtendedPanId

const otExtendedPanId * otThreadGetExtendedPanId(
  otInstance *aInstance
)

شناسه PAN توسعه یافته IEEE 802.15.4 را دریافت می کند.

جزئیات
مولفه های
[in] aInstance
اشاره گر به یک نمونه OpenThread.
برمی گرداند
اشاره گر به شناسه PAN توسعه یافته IEEE 802.15.4.
همچنین ببینید:
otThreadSetExtendedPanId

otThreadGetFixedDuaInterfaceIdentifier

const otIp6InterfaceIdentifier * otThreadGetFixedDuaInterfaceIdentifier(
  otInstance *aInstance
)

شناسه رابط را که به صورت دستی برای آدرس Unicast دامنه موضوع مشخص شده است دریافت می کند.

زمانی در دسترس است که OPENTHREAD_CONFIG_DUA_ENABLE فعال باشد.

جزئیات
مولفه های
[in] aInstance
اشاره گر به یک نمونه OpenThread.
برمی گرداند
یک اشاره گر به شناسه رابط که به صورت دستی تنظیم شده است، یا NULL اگر هیچ یک تنظیم نشده باشد.
همچنین ببینید:
otThreadSetFixedDuaInterfaceIdentifier

otThreadGetIp6Counters

const otIpCounters * otThreadGetIp6Counters(
  otInstance *aInstance
)

شمارنده های IPv6 را دریافت می کند.

جزئیات
مولفه های
[in] aInstance
اشاره گر به یک نمونه OpenThread.
برمی گرداند
یک اشاره گر به پیشخوان های IPv6.

OtThreadgetKeyseCrecounter

uint32_t otThreadGetKeySequenceCounter(
  otInstance *aInstance
)

TherkeyeNceCecounter را دریافت می کند.

جزئیات
مولفه های
[in] aInstance
یک اشاره گر به یک نمونه Openthread.
برمی گرداند
مقدار ThrkeyceNectectounter.
همچنین ببینید:
otthreadsetkeysequectounter

otthreadgetkeyswitchguardtime

uint32_t otThreadGetKeySwitchGuardTime(
  otInstance *aInstance
)

ThrkeyswitchGuardtime (در ساعت ها) را دریافت می کند.

جزئیات
مولفه های
[in] aInstance
یک اشاره گر به یک نمونه Openthread.
برمی گرداند
مقدار ThrkeyswitchGuardtime (در ساعت).
همچنین ببینید:
otthreadsetkeyswitchguardtime

otthreadgetleaderdata

otError otThreadGetLeaderData(
  otInstance *aInstance,
  otLeaderData *aLeaderData
)

داده های رهبر موضوع را دریافت کنید.

جزئیات
مولفه های
[in] aInstance
یک اشاره گر به یک نمونه Openthread.
[out] aLeaderData
اشاره گر به جایی که داده های رهبر در آن قرار گرفته است.
ارزش های بازگشتی
OT_ERROR_NONE
با موفقیت داده های رهبر را بازیابی کرد.
OT_ERROR_DETACHED
در حال حاضر ضمیمه نشده است.

otthreadgetleaderrloc

otError otThreadGetLeaderRloc(
  otInstance *aInstance,
  otIp6Address *aLeaderRloc
)

یک اشاره گر به RLOC رهبر برمی گردد.

جزئیات
مولفه های
[in] aInstance
یک اشاره گر به یک نمونه Openthread.
[out] aLeaderRloc
یک اشاره گر برای RLOC رهبر.
ارزش های بازگشتی
OT_ERROR_NONE
RLOC رهبر با موفقیت برای aLeaderRloc نوشته شد.
OT_ERROR_INVALID_ARGS
aLeaderRloc تهی بود.
OT_ERROR_DETACHED
در حال حاضر به یک پارتیشن نخ وصل نشده است.

otthreadgetleaderrouterid

uint8_t otThreadGetLeaderRouterId(
  otInstance *aInstance
)

شناسه روتر رهبر را دریافت کنید.

جزئیات
مولفه های
[in] aInstance
یک اشاره گر به یک نمونه Openthread.
برمی گرداند
شناسه روتر رهبر.

otthreadgetleaderweight

uint8_t otThreadGetLeaderWeight(
  otInstance *aInstance
)

وزن رهبر را بدست آورید.

جزئیات
مولفه های
[in] aInstance
یک اشاره گر به یک نمونه Openthread.
برمی گرداند
وزن رهبر

otthreadgetlinklocalallyrednodesmulticastaddress

const otIp6Address * otThreadGetLinkLocalAllThreadNodesMulticastAddress(
  otInstance *aInstance
)

لینک موضوع-محلی را به آدرس multicast همه گره های نخ تبدیل می کند.

آدرس یک آدرس multicast مبتنی بر پیشوند یکپارچه پیوند-محلی است [RFC 3306] ، با:

  • flgs روی 3 تنظیم شده است (p = 1 و t = 1)
  • Scop روی 2
  • plen به 64 تنظیم شده است
  • پیشوند شبکه روی پیشوند محلی مش تنظیم شده است
  • شناسه گروه روی 1 تنظیم شده است

جزئیات
مولفه های
[in] aInstance
یک اشاره گر به یک نمونه Openthread.
برمی گرداند
یک نشانگر برای موضوع پیوند-محلی همه گره های چند رشته ای.

otthreadgetlinklocalip6address

const otIp6Address * otThreadGetLinkLocalIp6Address(
  otInstance *aInstance
)

آدرس IPv6 Link-local Link-Link را دریافت می کند.

آدرس محلی لینک موضوع با استفاده از IEEE802.15.4 آدرس گسترده به عنوان شناسه رابط مشتق شده است.

جزئیات
مولفه های
[in] aInstance
یک اشاره گر به یک نمونه Openthread.
برمی گرداند
یک نشانگر برای موضوع آدرس IPv6 لینک-محلی.

otthreadgetlinkmode

otLinkModeConfig otThreadGetLinkMode(
  otInstance *aInstance
)

پیکربندی حالت MLE Link را دریافت کنید.

جزئیات
مولفه های
[in] aInstance
یک اشاره گر به یک نمونه Openthread.
برمی گرداند
پیکربندی حالت MLE Link.
همچنین ببینید:
otthreadsetlinkmode

otthreadgetMaxtimeInqueue

uint32_t otThreadGetMaxTimeInQueue(
  otInstance *aInstance
)

حداکثر زمان در صف را برای پیام های موجود در صف TX دریافت می کند.

به OPENTHREAD_CONFIG_TX_QUEUE_STATISTICS_ENABLE نیاز دارد.

زمان در داخل فقط برای انتقال مستقیم ردیابی می شود و به عنوان مدت زمان اضافه شدن پیام به صف انتقال اندازه گیری می شود تا زمانی که برای انتقال به لایه MAC منتقل شود یا از بین برود.

آمار جمع آوری شده را می توان با فراخوانی otThreadResetTimeInQueueStat() تنظیم مجدد کرد.

جزئیات
مولفه های
[in] aInstance
یک اشاره گر به یک نمونه Openthread.
برمی گرداند
حداکثر زمان در صف در میلی ثانیه برای همه پیام های موجود در صف TX (تاکنون).

otthreadgetmeshlocaleid

const otIp6Address * otThreadGetMeshLocalEid(
  otInstance *aInstance
)

آدرس عید محلی مش را دریافت می کند.

جزئیات
مولفه های
[in] aInstance
یک اشاره گر به یک نمونه Openthread.
برمی گرداند
یک اشاره گر به آدرس عید محلی مش.

otthreadgetmeshlocalprefix

const otMeshLocalPrefix * otThreadGetMeshLocalPrefix(
  otInstance *aInstance
)

یک نشانگر را به پیشوند محلی مش باز می گرداند.

جزئیات
مولفه های
[in] aInstance
یک اشاره گر به یک نمونه Openthread.
برمی گرداند
یک اشاره گر به پیشوند محلی مش.

otthreadgetmlecounters

const otMleCounters * otThreadGetMleCounters(
  otInstance *aInstance
)

پیشخوان های نخ را می گیرد.

جزئیات
مولفه های
[in] aInstance
یک اشاره گر به یک نمونه Openthread.
برمی گرداند
یک اشاره گر به پیشخوان های موضوع.

otthreadgetnetworkKey

void otThreadGetNetworkKey(
  otInstance *aInstance,
  otNetworkKey *aNetworkKey
)

کلید شبکه نخ را دریافت کنید.

جزئیات
مولفه های
[in] aInstance
یک اشاره گر به یک نمونه Openthread.
[out] aNetworkKey
یک نشانگر به یک otNetworkKey برای بازگشت کلید شبکه Thread.
همچنین ببینید:
otthreadsetnetworkKey

otthreadgetnetworkkeyref

otNetworkKeyRef otThreadGetNetworkKeyRef(
  otInstance *aInstance
)

otNetworkKeyRef را برای کلید شبکه Thread دریافت کنید.

به ویژگی ساخت زمان OPENTHREAD_CONFIG_PLATFORM_KEY_REFERENCES_ENABLE نیاز دارد تا فعال شود.

جزئیات
مولفه های
[in] aInstance
یک اشاره گر به یک نمونه Openthread.
برمی گرداند
مرجع به کلید شبکه نخ ذخیره شده در حافظه.
همچنین ببینید:
otthreadsetnetworkkeyref

otthreadgetnetworkname

const char * otThreadGetNetworkName(
  otInstance *aInstance
)

نام شبکه نخ را دریافت کنید.

جزئیات
مولفه های
[in] aInstance
یک اشاره گر به یک نمونه Openthread.
برمی گرداند
یک اشاره گر به نام شبکه موضوع.
همچنین ببینید:
otthreadsetnetworkname

otthreadgetnextdiagnostictlv

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

TLV تشخیص شبکه بعدی را در پیام دریافت می کند.

به OPENTHREAD_CONFIG_TMF_NETDIAG_CLIENT_ENABLE نیاز دارد.

تماس بعدی به این عملکرد فقط درصورتی که مقدار بازگشت فعلی OT_ERROR_NONE باشد مجاز است.

جزئیات
مولفه های
[in] aMessage
یک اشاره گر به یک پیام.
[in,out] aIterator
یک اشاره گر به متن تکرار کننده تشخیص شبکه. برای به دست آوردن اولین TLV Diagnostic Network باید روی OT_NETWORK_DIAGNOSTIC_ITERATOR_INIT تنظیم شود.
[out] aNetworkDiagTlv
اشاره گر به جایی که اطلاعات TLV تشخیصی شبکه در آن قرار می گیرد.
ارزش های بازگشتی
OT_ERROR_NONE
با موفقیت TLV تشخیص شبکه بعدی را پیدا کرد.
OT_ERROR_NOT_FOUND
هیچ TLV تشخیصی شبکه بعدی در پیام وجود ندارد.
OT_ERROR_PARSE
تجزیه و تحلیل شبکه بعدی انجام نشد.

otthreadgetnextneghborinfo

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

اطلاعات همسایه بعدی را دریافت می کند.

از آن برای عبور از ورودی های جدول همسایه استفاده می شود.

جزئیات
مولفه های
[in] aInstance
یک اشاره گر به یک نمونه Openthread.
[in,out] aIterator
یک اشاره گر به متن Iterator. برای به دست آوردن اولین ورودی همسایه باید روی OT_NEIGHBOR_INFO_ITERATOR_INIT تنظیم شود.
[out] aInfo
یک اشاره گر به اطلاعات همسایه.
ارزش های بازگشتی
OT_ERROR_NONE
با موفقیت ورودی همسایه بعدی را در جدول پیدا کرد.
OT_ERROR_NOT_FOUND
هیچ ورودی بعدی همسایه در جدول وجود ندارد.
OT_ERROR_INVALID_ARGS
aIterator یا aInfo تهی بود.

otthreadgetparentaveragerssi

otError otThreadGetParentAverageRssi(
  otInstance *aInstance,
  int8_t *aParentRssi
)

این عملکرد متوسط ​​RSSI را برای والدین نخ بازیابی می کند.

جزئیات
مولفه های
[in] aInstance
یک اشاره گر به یک نمونه Openthread.
[out] aParentRssi
اشاره گر به جایی که باید RSSI والدین در آن قرار گیرد.

otthreadgetparentinfo

otError otThreadGetParentInfo(
  otInstance *aInstance,
  otRouterInfo *aParentInfo
)

این عملکرد اطلاعات تشخیصی را برای یک روتر موضوع به عنوان والدین بازیابی می کند.

جزئیات
مولفه های
[in] aInstance
یک اشاره گر به یک نمونه Openthread.
[out] aParentInfo
اشاره گر به جایی که اطلاعات روتر والدین در آن قرار گرفته است.

otthreadgetparentlastrssi

otError otThreadGetParentLastRssi(
  otInstance *aInstance,
  int8_t *aLastRssi
)

این عملکرد RSSI آخرین بسته را از والدین نخ بازیابی می کند.

جزئیات
مولفه های
[in] aInstance
یک اشاره گر به یک نمونه Openthread.
[out] aLastRssi
اشاره گر به جایی که آخرین RSSI باید در آن قرار گیرد.
ارزش های بازگشتی
OT_ERROR_NONE
با موفقیت داده های RSSI را بازیابی کرد.
OT_ERROR_FAILED
دریافت داده های RSSI امکان پذیر نیست.
OT_ERROR_INVALID_ARGS
aLastRssi تهی است.

otthreadgetpartitionid

uint32_t otThreadGetPartitionId(
  otInstance *aInstance
)

شناسه پارتیشن را دریافت کنید.

جزئیات
مولفه های
[in] aInstance
یک اشاره گر به یک نمونه Openthread.
برمی گرداند
شناسه پارتیشن

otthreadgetRealMlocalAllThreadNodesMulticaStaddress

const otIp6Address * otThreadGetRealmLocalAllThreadNodesMulticastAddress(
  otInstance *aInstance
)

آدرس multicast albocal the thread-local را به دست می آورد.

آدرس یک آدرس multicast مبتنی بر پیشوند یکپارچه و مبتنی بر پیشوند است [RFC 3306] ، با:

  • flgs روی 3 تنظیم شده است (p = 1 و t = 1)
  • Scop به 3
  • plen به 64 تنظیم شده است
  • پیشوند شبکه روی پیشوند محلی مش تنظیم شده است
  • شناسه گروه روی 1 تنظیم شده است

جزئیات
مولفه های
[in] aInstance
یک اشاره گر به یک نمونه Openthread.
برمی گرداند
یک اشاره گر برای نخ قلمرو-محلی همه گره های چند رشته ای.

otthreadgetrloc

const otIp6Address * otThreadGetRloc(
  otInstance *aInstance
)

آدرس یاب مسیریابی موضوع (RLOC) را دریافت می کند.

جزئیات
مولفه های
[in] aInstance
یک اشاره گر به یک نمونه Openthread.
برمی گرداند
یک اشاره گر به آدرس یاب مسیریابی Thread (RLOC).

otthreadgetrloc16

uint16_t otThreadGetRloc16(
  otInstance *aInstance
)

RLOC16 را دریافت کنید.

جزئیات
مولفه های
[in] aInstance
یک اشاره گر به یک نمونه Openthread.
برمی گرداند
RLOC16.

otthreadgetservicealoc

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

سرویس ALOC را برای شناسه خدمات داده شده بازیابی می کند.

جزئیات
مولفه های
[in] aInstance
یک اشاره گر به یک نمونه Openthread.
[in] aServiceId
شناسه سرویس برای دریافت ALOC برای.
[out] aServiceAloc
یک اشاره گر برای خروجی سرویس ALOC. نباید خالی باشد.
ارزش های بازگشتی
OT_ERROR_NONE
با موفقیت سرویس ALOC را بازیابی کرد.
OT_ERROR_DETACHED
رابط نخ در حال حاضر به یک پارتیشن نخ وصل نشده است.

otthreadgettimeinquehistograms

const uint32_t * otThreadGetTimeInQueueHistogram(
  otInstance *aInstance,
  uint16_t *aNumBins,
  uint32_t *aBinInterval
)

هیستوگرام زمان در Queue را برای پیام های موجود در صف TX دریافت می کند.

به OPENTHREAD_CONFIG_TX_QUEUE_STATISTICS_ENABLE نیاز دارد.

هیستوگرام از زمان در صفحه پیام ها در صف انتقال جمع آوری می شود. زمان در داخل فقط برای انتقال مستقیم ردیابی می شود و به عنوان مدت زمان اضافه شدن پیام به صف انتقال اندازه گیری می شود تا زمانی که برای انتقال به لایه MAC منتقل شود یا از بین برود.

هیستوگرام به عنوان مجموعه ای از مقادیر uint32_t با ورودی های aNumBins بازگردانده می شود. اولین ورودی در آرایه (در فهرست 0) تعداد پیام های دارای یک زمان در زمان کمتر از aBinInterval را نشان می دهد. ورودی دوم تعداد پیام ها با یک زمان در یک بیشتر از یا مساوی با aBinInterval ، اما کمتر از 2 * aBinInterval را نشان می دهد. و غیره. آخرین ورودی تعداد پیام های مربوط به زمان در قسمت بزرگتر از یا مساوی (aNumBins - 1) * aBinInterval را نشان می دهد.

آمار جمع آوری شده را می توان با فراخوانی otThreadResetTimeInQueueStat() تنظیم مجدد کرد. اطلاعات هیستوگرام از زمانی که نمونه Openthread آغاز شد یا از زمان آخرین بار مجموعه آمار با فراخوانی otThreadResetTimeInQueueStat() تنظیم شد ، جمع آوری می شود.

نشانگرها aNumBins و aBinInterval نباید تهی باشند.

جزئیات
مولفه های
[in] aInstance
یک اشاره گر به یک نمونه Openthread.
[out] aNumBins
نشانگر برای بازگشت تعداد سطل های موجود در هیستوگرام (طول آرایه).
[out] aBinInterval
نشانگر برای بازگشت طول بازه سطل هیستوگرام در میلی ثانیه.
برمی گرداند
یک اشاره گر به مجموعه ای از ورودی های aNumBins که اطلاعات هیستوگرام جمع آوری شده را نشان می دهد.

otthreadgetvendormodel

const char * otThreadGetVendorModel(
  otInstance *aInstance
)

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

جزئیات
مولفه های
[in] aInstance
یک اشاره گر به یک نمونه Openthread.
برمی گرداند
رشته مدل فروشنده.

otthreadgetvendorname

const char * otThreadGetVendorName(
  otInstance *aInstance
)

رشته نام فروشنده را دریافت کنید.

جزئیات
مولفه های
[in] aInstance
یک اشاره گر به یک نمونه Openthread.
برمی گرداند
رشته نام فروشنده.

otthreadgetvendorswversion

const char * otThreadGetVendorSwVersion(
  otInstance *aInstance
)

رشته نسخه SW فروشنده را دریافت کنید.

جزئیات
مولفه های
[in] aInstance
یک اشاره گر به یک نمونه Openthread.
برمی گرداند
رشته نسخه SW فروشنده.

otthreadgetversion

uint16_t otThreadGetVersion(
  void
)

نسخه پروتکل نخ را دریافت می کند.

جزئیات
برمی گرداند
نسخه پروتکل نخ.

otthreadisanycastlocateinprogress

bool otThreadIsAnycastLocateInProgress(
  otInstance *aInstance
)

نشان می دهد که آیا یک درخواست مکان یابی Anycast در حال حاضر در حال انجام است یا خیر.

فقط در صورت فعال بودن OPENTHREAD_CONFIG_TMF_ANYCAST_LOCATOR_ENABLE در دسترس است.

جزئیات
مولفه های
[in] aInstance
یک اشاره گر به یک نمونه Openthread.
برمی گرداند
درست است اگر یک درخواست مکان یابی Anycast در حال حاضر در حال انجام است ، در غیر این صورت نادرست است.

otthreadisdiscoverinprogress

bool otThreadIsDiscoverInProgress(
  otInstance *aInstance
)

تعیین می کند که آیا یک کشف موضوع MLE در حال انجام است یا خیر.

جزئیات
مولفه های
[in] aInstance
یک اشاره گر به یک نمونه Openthread.

otthreadissingleton

bool otThreadIsSingleton(
  otInstance *aInstance
)

نشان می دهد که آیا یک گره تنها روتر در شبکه است.

جزئیات
مولفه های
[in] aInstance
یک اشاره گر به یک نمونه Openthread.
ارزش های بازگشتی
TRUE
این تنها روتر در شبکه است.
FALSE
این یک کودک است یا یک روتر واحد در شبکه نیست.

otthreadlocateanycastination

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

درخواست نزدیکترین مقصد یک آدرس Anycast داده شده را در آن قرار می دهد.

فقط در صورت فعال بودن OPENTHREAD_CONFIG_TMF_ANYCAST_LOCATOR_ENABLE در دسترس است.

اگر درخواست قبلی در حال انجام باشد ، تماس بعدی به این عملکرد درخواست قبلی را لغو و جایگزین می کند.

جزئیات
مولفه های
[in] aInstance
یک اشاره گر به یک نمونه Openthread.
[in] aAnycastAddress
آدرس Anycast برای مکان یابی. نباید خالی باشد.
[in] aCallback
عملکرد پاسخ به تماس برای گزارش نتیجه.
[in] aContext
یک زمینه دلخواه که با aCallback استفاده می شود.
ارزش های بازگشتی
OT_ERROR_NONE
درخواست با موفقیت شروع شد. برای گزارش نتیجه aCallback استفاده می شود.
OT_ERROR_INVALID_ARGS
aAnycastAddress یک آدرس معتبر معتبر نیست یا aCallback تهی است.
OT_ERROR_NO_BUFS
خارج از بافر برای تهیه و ارسال پیام درخواست.

OtThreadRegisterParentResponsEcallback

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

برای دریافت داده های پاسخ والدین MLE ، یک تماس تلفنی را ثبت می کند.

به OPENTHREAD_CONFIG_MLE_PARENT_RESPONSE_CALLBACK_API_ENABLE نیاز دارد.

جزئیات
مولفه های
[in] aInstance
یک اشاره گر به یک نمونه Openthread.
[in] aCallback
یک اشاره گر به تابعی که با دریافت پیام پاسخ والدین MLE خواسته می شود.
[in] aContext
یک نشانگر برای پاسخ به متن خاص مشتری.

otthreadresetip6counters

void otThreadResetIp6Counters(
  otInstance *aInstance
)

شمارنده های IPv6 را مجدداً تنظیم می کند.

جزئیات
مولفه های
[in] aInstance
یک اشاره گر به یک نمونه Openthread.

otthreadresetmlecounters

void otThreadResetMleCounters(
  otInstance *aInstance
)

شمارنده های نخ را مجدداً تنظیم می کند.

جزئیات
مولفه های
[in] aInstance
یک اشاره گر به یک نمونه Openthread.

otthreadresettimeinqueuestat

void otThreadResetTimeInQueueStat(
  otInstance *aInstance
)

مجدداً آمار زمان صف TX را مجدداً تنظیم می کند.

به OPENTHREAD_CONFIG_TX_QUEUE_STATISTICS_ENABLE نیاز دارد.

جزئیات
مولفه های
[in] aInstance
یک اشاره گر به یک نمونه Openthread.

otthreadsearchforbetterent

otError otThreadSearchForBetterParent(
  otInstance *aInstance
)

این روند را برای کودک شروع می کند تا در حالی که به والدین فعلی خود متصل می شود ، والدین بهتری را جستجو کند.

باید هنگام اتصال دستگاه به عنوان کودک مورد استفاده قرار گیرد.

جزئیات
ارزش های بازگشتی
OT_ERROR_NONE
با موفقیت روند جستجوی والدین بهتر را آغاز کرد.
OT_ERROR_INVALID_STATE
نقش دستگاه کودک نیست.

OtThreadSendAddressNotification

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

یک پیام اعلان آدرس فعال (ADDR_NTF.NTF) ارسال می کند.

فقط در صورت فعال بودن OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE در دسترس است.

جزئیات
مولفه های
[in] aInstance
یک اشاره گر به یک نمونه Openthread.
[in] aDestination
مقصد ارسال پیام addr_ntf.ntf.
[in] aTarget
آدرس هدف پیام addr_ntf.ntf.
[in] aMlIid
ml-iid پیام addr_ntf.ntf.

otthreadsenddiagnosticget

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

درخواست دریافت شبکه تشخیصی را ارسال کنید.

به OPENTHREAD_CONFIG_TMF_NETDIAG_CLIENT_ENABLE نیاز دارد.

جزئیات
مولفه های
[in] aInstance
یک اشاره گر به یک نمونه Openthread.
[in] aDestination
یک اشاره گر به آدرس مقصد.
[in] aTlvTypes
مجموعه ای از انواع TLV تشخیصی شبکه.
[in] aCount
تعداد انواع موجود در atlvtypes.
[in] aCallback
یک اشاره گر به تابعی که هنگام دریافت پاسخ Get Diagnostic Network دریافت می شود یا NULL برای غیرفعال کردن پاسخ به تماس است.
[in] aCallbackContext
یک اشاره گر به متن خاص برنامه.
ارزش های بازگشتی
OT_ERROR_NONE
با موفقیت در صف Diag_get.req.
OT_ERROR_NO_BUFS
بافرهای پیام کافی برای ارسال Diag_get.req در دسترس است.

otthreadsenddiagnosticreset

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

درخواست تنظیم مجدد تشخیص شبکه را ارسال کنید.

به OPENTHREAD_CONFIG_TMF_NETDIAG_CLIENT_ENABLE نیاز دارد.

جزئیات
مولفه های
[in] aInstance
یک اشاره گر به یک نمونه Openthread.
[in] aDestination
یک اشاره گر به آدرس مقصد.
[in] aTlvTypes
مجموعه ای از انواع TLV تشخیصی شبکه. در حال حاضر فقط نوع 9 مجاز است.
[in] aCount
تعداد انواع در atlvtypes
ارزش های بازگشتی
OT_ERROR_NONE
با موفقیت در صف Diag_rst.ntf قرار گرفت.
OT_ERROR_NO_BUFS
بافرهای پیام کافی برای ارسال Diag_rst.ntf در دسترس است.

otthreadsendproactibactboneNotification

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

پیام اعلان ستون فقرات فعال (Pro_BB.NTF) را در لینک ستون فقرات ارسال می کند.

فقط در صورت فعال بودن OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE در دسترس است.

جزئیات
مولفه های
[in] aInstance
یک اشاره گر به یک نمونه Openthread.
[in] aTarget
آدرس هدف پیام pro_bb.ntf.
[in] aMlIid
ml-iid پیام pro_bb.ntf.
[in] aTimeSinceLastTransaction
زمان از آخرین معامله (در ثانیه).
ارزش های بازگشتی
OT_ERROR_NONE
با موفقیت pro_bb.ntf را در پیوند ستون فقرات ارسال کرد.
OT_ERROR_NO_BUFS
اگر بافرهای پیام کافی موجود نیست.

otthreadsetchildtimeout

void otThreadSetChildTimeout(
  otInstance *aInstance,
  uint32_t aTimeout
)

تنظیم زمان کودک (در ثانیه) که هنگام کار در نقش کودک استفاده می شود ، تنظیم می کند.

جزئیات
مولفه های
[in] aInstance
یک اشاره گر به یک نمونه Openthread.
[in] aTimeout
مقدار زمان در ثانیه.
همچنین ببینید:
otthreadgetchildtimeout

OtThreadSetDiscoveryRequestCallback

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

برای دریافت داده های درخواست MLE Discovery یک تماس تلفنی را تنظیم می کند.

جزئیات
مولفه های
[in] aInstance
یک اشاره گر به یک نمونه Openthread.
[in] aCallback
یک اشاره گر به عملکردی که با دریافت پیام درخواست MLE Discovery خواسته می شود.
[in] aContext
یک نشانگر به متن خاص برنامه پاسخ به تماس.

otthreadsetdomainname

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

نام دامنه موضوع را تنظیم می کند.

فقط هنگامی که پروتکل های نخ غیرفعال هستند موفق می شوند.

جزئیات
مولفه های
[in] aInstance
یک اشاره گر به یک نمونه Openthread.
[in] aDomainName
یک اشاره گر به نام دامنه موضوع.
ارزش های بازگشتی
OT_ERROR_NONE
نام دامنه موضوع را با موفقیت تنظیم کنید.
OT_ERROR_INVALID_STATE
پروتکل های موضوع فعال هستند.
همچنین ببینید:
otthreadgetdomainname

otthreadsetenabled

otError otThreadSetEnabled(
  otInstance *aInstance,
  bool aEnabled
)

عملکرد پروتکل نخ را شروع می کند.

رابط کاربری باید هنگام فراخوانی این عملکرد بالا باشد.

فراخوانی این عملکرد با aEnabled در False ، هرگونه فرآیند در حال انجام جدا شدن توسط OtThreadDetachgracely () را متوقف می کند. پاسخ به تماس آن فراخوانی خواهد شد.

جزئیات
مولفه های
[in] aInstance
یک اشاره گر به یک نمونه Openthread.
[in] aEnabled
اگر موضوع فعال باشد ، در غیر این صورت نادرست است.
ارزش های بازگشتی
OT_ERROR_NONE
عملکرد پروتکل نخ را با موفقیت آغاز کرد.
OT_ERROR_INVALID_STATE
رابط شبکه تمام نشده بود.

OtThreadSetextendedPanid

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

IEEE 802.15.4 شناسه گسترده را تنظیم می کند.

جزئیات
مولفه های
[in] aInstance
یک اشاره گر به یک نمونه Openthread.
[in] aExtendedPanId
یک اشاره گر به IEEE 802.15.4 شناسه گسترده.
ارزش های بازگشتی
OT_ERROR_NONE
شناسه تابه طولانی را با موفقیت تنظیم کنید.
OT_ERROR_INVALID_STATE
پروتکل های موضوع فعال هستند.
همچنین ببینید:
otthreadgetextendensid

OtThreadSetFixedDuainterfaceIditifix

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

شناسه رابط را به صورت دستی برای آدرس UNICAST دامنه Thread مشخص کرده یا پاک می کند.

در صورت فعال بودن OPENTHREAD_CONFIG_DUA_ENABLE در دسترس است.

جزئیات
مولفه های
[in] aInstance
یک اشاره گر به یک نمونه Openthread.
[in] aIid
یک اشاره گر به شناسه رابط برای تنظیم یا تهی برای پاک کردن.
ارزش های بازگشتی
OT_ERROR_NONE
با موفقیت شناسه رابط را تنظیم و پاک کرد.
OT_ERROR_INVALID_ARGS
شناسه رابط مشخص شده محفوظ است.
همچنین ببینید:
otthreadgetfixedDuainterfaceIditifix

otthreadsetjoineradvertisement

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

هنگام کشف شبکه نخ ، تبلیغات وصل کننده موضوع را تنظیم می کند.

Thread Goiner Advertement استفاده می شود تا به یک اتصال دهنده اجازه دهد اطلاعات خاص برنامه (مانند شناسه فروشنده ، شناسه محصول ، تبعیض آمیز و غیره) را از طریق یک تبلیغات جدید وصل کننده TLV تبلیغ کند و این اطلاعات را در دسترس کمیسر یا کمیسر قرار دهد. نامزدهای بدون تعامل انسانی.

جزئیات
مولفه های
[in] aInstance
یک اشاره گر به یک نمونه Openthread.
[in] aOui
ارزش فروشنده IEEE OUI که در تبلیغات وصل کننده گنجانده می شود. فقط از 3 بایت قابل توجه استفاده می شود و مهمترین بایت نادیده گرفته می شود.
[in] aAdvData
یک اشاره گر به AdvData که در تبلیغات وصل کننده گنجانده می شود.
[in] aAdvDataLength
طول Advdata در بایت.
ارزش های بازگشتی
OT_ERROR_NONE
تبلیغات وصل کننده را با موفقیت تنظیم کنید.
OT_ERROR_INVALID_ARGS
AdvData نامعتبر است.

otthreadsetkeysequectounter

void otThreadSetKeySequenceCounter(
  otInstance *aInstance,
  uint32_t aKeySequenceCounter
)

تنظیم ThrkeyeboneCecounter.

جزئیات
مولفه های
[in] aInstance
یک اشاره گر به یک نمونه Openthread.
[in] aKeySequenceCounter
مقدار ThrkeyceNectectounter.
همچنین ببینید:
OtThreadgetKeyseCrecounter

otthreadsetkeyswitchguardtime

void otThreadSetKeySwitchGuardTime(
  otInstance *aInstance,
  uint32_t aKeySwitchGuardTime
)

ThrkeyswitchGuardtime (در ساعت) را تنظیم می کند.

جزئیات
مولفه های
[in] aInstance
یک اشاره گر به یک نمونه Openthread.
[in] aKeySwitchGuardTime
مقدار ThrkeyswitchGuardtime (در ساعت).
همچنین ببینید:
otthreadgetkeyswitchguardtime

otthreadsetlinkmode

otError otThreadSetLinkMode(
  otInstance *aInstance,
  otLinkModeConfig aConfig
)

پیکربندی حالت MLE Link را تنظیم کنید.

جزئیات
مولفه های
[in] aInstance
یک اشاره گر به یک نمونه Openthread.
[in] aConfig
یک اشاره گر به پیکربندی حالت پیوند.
ارزش های بازگشتی
OT_ERROR_NONE
پیکربندی حالت MLE Link را با موفقیت تنظیم کنید.
همچنین ببینید:
otthreadgetlinkmode

otthreadsetMeshlocalPrefix

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

پیشوند محلی مش را تنظیم می کند.

فقط در صورت غیرفعال کردن پروتکل های نخ موفق می شود. یک تماس موفقیت آمیز به این عملکرد ، مجموعه داده های عملیاتی فعال و در انتظار را در حافظه غیر فرار باطل می کند.

جزئیات
مولفه های
[in] aInstance
یک اشاره گر به یک نمونه Openthread.
[in] aMeshLocalPrefix
یک اشاره گر به پیشوند محلی مش.
ارزش های بازگشتی
OT_ERROR_NONE
پیشوند محلی مش را با موفقیت تنظیم کنید.
OT_ERROR_INVALID_STATE
پروتکل های موضوع فعال هستند.

otthreadsetnetworkKey

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

کلید شبکه نخ را تنظیم کنید.

فقط در صورت غیرفعال کردن پروتکل های نخ موفق می شود. یک تماس موفقیت آمیز به این عملکرد ، مجموعه داده های عملیاتی فعال و در انتظار را در حافظه غیر فرار باطل می کند.

جزئیات
مولفه های
[in] aInstance
یک اشاره گر به یک نمونه Openthread.
[in] aKey
یک اشاره گر به یک بافر حاوی کلید شبکه نخ.
ارزش های بازگشتی
OT_ERROR_NONE
کلید شبکه نخ را با موفقیت تنظیم کنید.
OT_ERROR_INVALID_STATE
پروتکل های موضوع فعال هستند.
همچنین ببینید:
otthreadgetnetworkKey

otthreadsetnetworkkeyref

otError otThreadSetNetworkKeyRef(
  otInstance *aInstance,
  otNetworkKeyRef aKeyRef
)

کلید شبکه نخ را به عنوان otNetworkKeyRef تنظیم کنید.

فقط در صورت غیرفعال کردن پروتکل های نخ موفق می شود. یک تماس موفقیت آمیز به این عملکرد ، مجموعه داده های عملیاتی فعال و در انتظار را در حافظه غیر فرار باطل می کند.

به ویژگی ساخت زمان OPENTHREAD_CONFIG_PLATFORM_KEY_REFERENCES_ENABLE نیاز دارد تا فعال شود.

جزئیات
مولفه های
[in] aInstance
یک اشاره گر به یک نمونه Openthread.
[in] aKeyRef
مرجع به کلید شبکه نخ.
ارزش های بازگشتی
OT_ERROR_NONE
کلید شبکه نخ را با موفقیت تنظیم کنید.
OT_ERROR_INVALID_STATE
پروتکل های موضوع فعال هستند.
همچنین ببینید:
otthreadgetnetworkkeyref

otthreadsetnetworkname

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

نام شبکه نخ را تنظیم کنید.

فقط در صورت غیرفعال کردن پروتکل های نخ موفق می شود. یک تماس موفقیت آمیز به این عملکرد ، مجموعه داده های عملیاتی فعال و در انتظار را در حافظه غیر فرار باطل می کند.

جزئیات
مولفه های
[in] aInstance
یک اشاره گر به یک نمونه Openthread.
[in] aNetworkName
یک اشاره گر به نام شبکه موضوع.
ارزش های بازگشتی
OT_ERROR_NONE
نام شبکه نخ را با موفقیت تنظیم کنید.
OT_ERROR_INVALID_STATE
پروتکل های موضوع فعال هستند.
همچنین ببینید:
otthreadgetnetworkname

otthreadsetvendormodel

otError otThreadSetVendorModel(
  otInstance *aInstance,
  const char *aVendorModel
)

رشته مدل فروشنده را تنظیم کنید.

به OPENTHREAD_CONFIG_NET_DIAG_VENDOR_INFO_SET_API_ENABLE نیاز دارد.

aVendorModel باید UTF8 با حداکثر طول 32 کاراکتر باشد ( MAX_VENDOR_MODEL_TLV_LENGTH ). حداکثر طول شامل کاراکتر NULL \0 نیست.

جزئیات
مولفه های
[in] aInstance
یک اشاره گر به یک نمونه Openthread.
[in] aVendorModel
رشته مدل فروشنده.
ارزش های بازگشتی
OT_ERROR_NONE
با موفقیت مدل فروشنده را تنظیم کنید.
OT_ERROR_INVALID_ARGS
aVendorModel معتبر نیست (خیلی طولانی یا UTF8).

otthreadsetvendorname

otError otThreadSetVendorName(
  otInstance *aInstance,
  const char *aVendorName
)

رشته نام فروشنده را تنظیم کنید.

به OPENTHREAD_CONFIG_NET_DIAG_VENDOR_INFO_SET_API_ENABLE نیاز دارد.

aVendorName باید UTF8 با حداکثر طول 32 کاراکتر باشد ( MAX_VENDOR_NAME_TLV_LENGTH ). حداکثر طول شامل کاراکتر NULL \0 نیست.

جزئیات
مولفه های
[in] aInstance
یک اشاره گر به یک نمونه Openthread.
[in] aVendorName
رشته نام فروشنده.
ارزش های بازگشتی
OT_ERROR_NONE
نام فروشنده را با موفقیت تنظیم کنید.
OT_ERROR_INVALID_ARGS
aVendorName معتبر نیست (خیلی طولانی یا UTF8).

otthreadsetVendorsWversion

otError otThreadSetVendorSwVersion(
  otInstance *aInstance,
  const char *aVendorSwVersion
)

رشته نسخه نرم افزار فروشنده را تنظیم کنید.

به OPENTHREAD_CONFIG_NET_DIAG_VENDOR_INFO_SET_API_ENABLE نیاز دارد.

aVendorSwVersion باید UTF8 با حداکثر طول 16 کاراکتر باشد ( MAX_VENDOR_SW_VERSION_TLV_LENGTH ). حداکثر طول شامل کاراکتر NULL \0 نیست.

جزئیات
مولفه های
[in] aInstance
یک اشاره گر به یک نمونه Openthread.
[in] aVendorSwVersion
رشته نرم افزار فروشنده.
ارزش های بازگشتی
OT_ERROR_NONE
نسخه نرم افزار فروشنده را با موفقیت تنظیم کنید.
OT_ERROR_INVALID_ARGS
aVendorSwVersion معتبر نیست (خیلی طولانی یا UTF8).

ماکرو

ot_duration_string_size

 OT_DURATION_STRING_SIZE 21

اندازه توصیه شده برای بازنمایی رشته از مدت زمان uint32_t در ثانیه.

OT_JOINER_ADVDATA_MAX_LENGHT

 OT_JOINER_ADVDATA_MAX_LENGTH 64

حداکثر AdvData طول تبلیغات وصل کننده.

ot_neighbor_info_iterator_init

 OT_NEIGHBOR_INFO_ITERATOR_INIT 0

اولیه ساز برای otneighborinfoiterator.

ot_network_base_tlv_max_l طول

 OT_NETWORK_BASE_TLV_MAX_LENGTH 254

حداکثر مقدار مقدار پایه TLV.

ot_network_data_iterator_init

 OT_NETWORK_DATA_ITERATOR_INIT 0

مقدار برای اولیه سازی otNetworkDataIterator .

ot_network_diagnostic_child_table_entry_size

 OT_NETWORK_DIAGNOSTIC_CHILD_TABLE_ENTRY_SIZE 3

اندازه ورود جدول کودک تشخیصی شبکه.

ot_network_diagnostic_iterator_init

 OT_NETWORK_DIAGNOSTIC_ITERATOR_INIT 0

اولیه ساز برای otnetworkdiagiterator.

OT_NETWORK_DIAGNOSTIC_MAX_THREAD_STACK_VERSION_TLV_L طول

 OT_NETWORK_DIAGNOSTIC_MAX_THREAD_STACK_VERSION_TLV_LENGTH 64

حداکثر طول نسخه پشته نخ TLV.

OT_NETWORK_DIAGNOSTIC_MAX_VENDOR_MODEL_TLV_L طول

 OT_NETWORK_DIAGNOSTIC_MAX_VENDOR_MODEL_TLV_LENGTH 32

حداکثر طول مدل فروشنده TLV.

OT_NETWORK_DIAGNOSTIC_MAX_VENDOR_NAME_TLV_L طول

 OT_NETWORK_DIAGNOSTIC_MAX_VENDOR_NAME_TLV_LENGTH 32

حداکثر طول نام فروشنده TLV.

ot_network_diagnostic_max_vendor_sw_version_tlv_l طول

 OT_NETWORK_DIAGNOSTIC_MAX_VENDOR_SW_VERSION_TLV_LENGTH 16

حداکثر طول فروشنده SW نسخه TLV.

ot_network_diagnostic_typelist_max_entries

 OT_NETWORK_DIAGNOSTIC_TYPELIST_MAX_ENTRIES 19

حداکثر تعداد انواع TLV تشخیصی شبکه برای درخواست یا تنظیم مجدد.

ot_network_max_router_id

 OT_NETWORK_MAX_ROUTER_ID 62

حداکثر شناسه روتر.

ot_server_data_max_size

 OT_SERVER_DATA_MAX_SIZE 248

حداکثر اندازه داده های سرور در بایت. حد نظری ، تقریباً بسیار پایین تر.

ot_service_data_max_size

 OT_SERVICE_DATA_MAX_SIZE 252

حداکثر اندازه داده های خدمات در بایت.

منابع

موضوعات مرجع OpenThread API از کد منبع موجود در GitHub سرچشمه می گیرند. برای اطلاعات بیشتر، یا مشارکت در اسناد ما، به منابع مراجعه کنید.