דף זה תורגם על ידי Cloud Translation API.

כללי

המודול הזה כולל פונקציות לכל התפקידים ב-Thread.

סיכום

בעל האתר של נתוני הרשת מספק מנגנונים להגבלת מספר הרשומות הדומות של 'שירות' ו/או 'קידומת (בקידומת' או 'נתיב חיצוני') בנתוני הרשת של Thread על ידי מעקב אחר נתוני הרשת וניהול אם או מתי להוסיף או להסיר רשומות.

כדי להשתמש בכל הפונקציות במודול הזה צריך להפעיל את OPENTHREAD_CONFIG_NETDATA_PUBLISHER_ENABLE.

הערה: לפונקציות במודול הזה נדרשות OPENTHREAD_FTD=1 או OPENTHREAD_MTD=1.

ספירות
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`.

ערכי דף
`otBorderRouterConfig`	typedef `struct otBorderRouterConfig` מייצג תצורה של נתב גבול.
`otDetachGracefullyCallback)(void *aContext)`	typedef `void(*` הקריאה החוזרת (callback) מודיעה לאפליקציה שתהליך הניתוק הסתיים.
`otExternalRouteConfig`	typedef `struct otExternalRouteConfig` מייצג תצורת מסלול חיצוני.
`otIpCounters`	typedef `struct otIpCounters` מייצג את המונים ברמת ה-IP.
`otLeaderData`	typedef `struct otLeaderData` מייצג את נתוני ה-Thread Leader.
`otLinkModeConfig`	typedef `struct otLinkModeConfig` מייצג הגדרה של מצב קישור MLE.
`otLowpanContextInfo`	typedef `struct otLowpanContextInfo` מייצג מידע של מזהה הקשר 6LoWPAN שמשויך לקידומת בנתוני רשת.
`otMleCounters`	typedef `struct otMleCounters` מייצג את מוני Thread MLE.
`otNeighborInfoIterator`	typedef `int16_t` משמש לאיטרציה דרך טבלה סמוכה.
`otNetDataDnsSrpServicePublisherCallback)(otNetDataPublisherEvent aEvent, void *aContext)`	typedef `void(*` סוג המצביע מגדיר את הקריאה החוזרת (callback) שתשמש לקבלת התראה כשמתבצעת הוספה של רשומת DNS/SRP לנתוני רשת של פרוטוקול Thread או הסרה שלהם.
`otNetDataPrefixPublisherCallback)(otNetDataPublisherEvent aEvent, const otIp6Prefix aPrefix, void aContext)`	typedef `void(*` סוג המצביע מגדיר את הקריאה החוזרת (callback) שתשמש לקבלת התראה כשנוספת קידומת (ברשת או בנתיב חיצוני) לנתוני הרשת של Thread או כשמסירים אותם.
`otNetDataPublisherEvent`	typedef `enum otNetDataPublisherEvent` מייצג את האירועים שדווחו מההתקשרות חזרה של בעל התוכן הדיגיטלי.
`otNetworkDataIterator`	typedef `uint32_t` משמש לאיטרציה באמצעות מידע על נתוני רשת.
`otNetworkDiagChildEntry`	typedef `struct otNetworkDiagChildEntry` מייצג רשומת צאצא של אבחון רשת.
`otNetworkDiagConnectivity`	typedef `struct otNetworkDiagConnectivity` מייצג ערך של קישוריות אבחון רשת.
`otNetworkDiagIterator`	typedef `uint16_t` משמש לאיטרציה דרך TLV של אבחון הרשת.
`otNetworkDiagMacCounters`	typedef `struct otNetworkDiagMacCounters` מייצג ערך של מוני אבחון רשת.
`otNetworkDiagMleCounters`	typedef `struct otNetworkDiagMleCounters` מייצג ערך של מוני MLE לניתוחי רשת.
`otNetworkDiagRoute`	typedef `struct otNetworkDiagRoute` מייצג ערך TLV של נתיב ניתוח הרשת.
`otNetworkDiagRouteData`	typedef `struct otNetworkDiagRouteData` מייצג נתונים של נתיב אבחון רשת.
`otNetworkDiagTlv`	typedef `struct otNetworkDiagTlv` מייצג TLV לאבחון רשת.
`otReceiveDiagnosticGetCallback)(otError aError, otMessage aMessage, const otMessageInfo aMessageInfo, void *aContext)`	typedef `void(*` מתבצעת הפעלה של המצביע כאשר מתקבלת תגובה מסוג 'קבלת אבחון רשת'.
`otRoutePreference`	typedef `enum otRoutePreference` מגדיר ערכים חוקיים עבור `mPreference` ב-`otExternalRouteConfig` וב-`otBorderRouterConfig`.
`otServerConfig`	typedef `struct otServerConfig` מייצג תצורת שרת.
`otServiceConfig`	typedef `struct otServiceConfig` מייצג הגדרת שירות.
`otThreadAnycastLocatorCallback)(void aContext, otError aError, const otIp6Address aMeshLocalAddress, uint16_t aRloc16)`	typedef `void(*` סוג המצביע מגדיר את הקריאה החוזרת (callback) כדי להודיע על התוצאה של בקשת `otThreadLocateAnycastDestination()`.
`otThreadDiscoveryRequestCallback)(const otThreadDiscoveryRequestInfo aInfo, void aContext)`	typedef `void(*` המצביע מופעל בכל פעם שמתקבלת הודעה של בקשת Discovery של MLE.
`otThreadDiscoveryRequestInfo`	typedef `struct otThreadDiscoveryRequestInfo` מייצג את הנתונים של בקשת גילוי שרשור.
`otThreadParentResponseCallback)(otThreadParentResponseInfo aInfo, void aContext)`	typedef `void(*` מתבצעת הפעלה של המצביע בכל פעם שמתקבלת הודעה של 'תגובת הורה ב-MLE'.
`otThreadParentResponseInfo`	typedef `struct otThreadParentResponseInfo` מייצג את נתוני התגובה להורים ב-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)`	`otError` יש לספק עותק מלא או יציב של נתוני Thread Network של המחיצה.
`otNetDataGetCommissioningDataset(otInstance aInstance, otCommissioningDataset aDataset)`	`void` הפונקציה מקבלת את מערך הנתונים של העמלה מנתוני הרשת של המחיצה.
`otNetDataGetLength(otInstance *aInstance)`	`uint8_t` קבלת האורך הנוכחי (מספר הבייטים) של נתוני רשת Thread של המחיצה.
`otNetDataGetMaxLength(otInstance *aInstance)`	`uint8_t` משך הזמן המקסימלי שנצפה של נתוני Thread Network מאז אתחול סטאק ה-OT או מאז הקריאה האחרונה ל-`otNetDataResetMaxLength()`.
`otNetDataGetNextLowpanContextInfo(otInstance aInstance, otNetworkDataIterator aIterator, otLowpanContextInfo *aContextInfo)`	`otError` קבלת הפרטים הבאים של מזהה הקשר 6LoWPAN בנתוני הרשת של המחיצה.
`otNetDataGetNextOnMeshPrefix(otInstance aInstance, otNetworkDataIterator aIterator, otBorderRouterConfig *aConfig)`	`otError` קבלת קידומת On Mesh הבאה בנתוני הרשת של המחיצה.
`otNetDataGetNextRoute(otInstance aInstance, otNetworkDataIterator aIterator, otExternalRouteConfig *aConfig)`	`otError` קבלת הנתיב החיצוני הבא בנתוני הרשת של המחיצה.
`otNetDataGetNextService(otInstance aInstance, otNetworkDataIterator aIterator, otServiceConfig *aConfig)`	`otError` קבלת השירות הבא בנתוני הרשת של המחיצה.
`otNetDataGetStableVersion(otInstance *aInstance)`	`uint8_t` להורדת גרסת הנתונים היציבה של הרשת
`otNetDataGetVersion(otInstance *aInstance)`	`uint8_t` מורידים את הגרסה של נתוני הרשת.
`otNetDataIsDnsSrpServiceAdded(otInstance *aInstance)`	`bool` בעמודה הזו מציינים אם הערך של 'שירות DNS/SRP' נוסף לנתוני הרשת של פרוטוקול Thread.
`otNetDataIsPrefixAdded(otInstance aInstance, const otIp6Prefix aPrefix)`	`bool` מציין אם רשומת קידומת שפורסמה (ב-mesh או נתיב חיצוני) נוספה כרגע לנתוני הרשת של Thread.
`otNetDataPublishDnsSrpServiceAnycast(otInstance *aInstance, uint8_t aSequenceNUmber)`	`void` נשלחת בקשה לפרסום של 'כתובת מסוג Anycast של שירות DNS/SRP' בנתונים של Thread Network.
`otNetDataPublishDnsSrpServiceUnicast(otInstance aInstance, const otIp6Address aAddress, uint16_t aPort)`	`void` נשלחת בקשה לפרסום של 'כתובת Unicast של שירות DNS/SRP' בנתוני הרשת של פרוטוקול Thread.
`otNetDataPublishDnsSrpServiceUnicastMeshLocalEid(otInstance *aInstance, uint16_t aPort)`	`void` נשלחת בקשה לפרסום של 'כתובת Unicast של שירות DNS/SRP' בנתוני הרשת של פרוטוקול Thread.
`otNetDataPublishExternalRoute(otInstance aInstance, const otExternalRouteConfig aConfig)`	`otError` נשלחת בקשה לפרסום קידומת של נתיב חיצוני בנתוני Thread Network.
`otNetDataPublishOnMeshPrefix(otInstance aInstance, const otBorderRouterConfig aConfig)`	`otError` נשלחת בקשה להצגת קידומת מסוג on-mesh בנתוני הרשת של Thread.
`otNetDataReplacePublishedExternalRoute(otInstance aInstance, const otIp6Prefix aPrefix, const otExternalRouteConfig *aConfig)`	`otError` מחליפה נתיב חיצוני שכבר פורסם בנתוני Thread Network.
`otNetDataResetMaxLength(otInstance *aInstance)`	`void` איפוס האורך המקסימלי של המעקב אחר נתוני Thread Network.
`otNetDataSetDnsSrpServicePublisherCallback(otInstance aInstance, otNetDataDnsSrpServicePublisherCallback aCallback, void aContext)`	`void` מגדירה קריאה חוזרת (callback) לקבלת התראה כששירות DNS/SRP שפורסם בפועל נוסף לנתוני רשת Thread או הוסר מהם.
`otNetDataSetPrefixPublisherCallback(otInstance aInstance, otNetDataPrefixPublisherCallback aCallback, void aContext)`	`void` הגדרת קריאה חוזרת (callback) לקבלת התראה כשרשומת קידומת שפורסמה מתווספת בפועל לנתוני רשת Thread או מסירה מהם.
`otNetDataSteeringDataCheckJoiner(otInstance aInstance, const otExtAddress aEui64)`	`otError` בודקים אם נתוני ההיגוי כוללים איחוד (joiner).
`otNetDataSteeringDataCheckJoinerWithDiscerner(otInstance aInstance, const struct otJoinerDiscerner aDiscerner)`	`otError` בודקים אם נתוני ההיגוי כוללים איחוד (join) עם ערך נתון של אובייקט.
`otNetDataUnpublishDnsSrpService(otInstance *aInstance)`	`void` מבטל את הפרסום של כל ערך של שירות DNS/SRP (Anycast או Unicast) שנוסף בעבר מנתוני Thread Network.
`otNetDataUnpublishPrefix(otInstance aInstance, const otIp6Prefix aPrefix)`	`otError` ביטול הפרסום של קידומת On-Mesh או קידומת נתיב חיצונית שפורסמה בעבר.
`otThreadBecomeChild(otInstance *aInstance)`	`otError` מנסים לצרף את העסק מחדש כילד או ילדה.
`otThreadBecomeDetached(otInstance *aInstance)`	`otError` ניתוק מהרשת של פרוטוקול Thread.
`otThreadDetachGracefully(otInstance aInstance, otDetachGracefullyCallback aCallback, void aContext)`	`otError` מודיעה על צמתים אחרים ברשת (אם יש כאלה) ואז מפסיקה את הפעולה של פרוטוקול Thread.
`otThreadDeviceRoleToString(otDeviceRole aRole)`	`const char *` ממירים את תפקיד המכשיר למחרוזת שאנשים יכולים לקרוא.
`otThreadDiscover(otInstance aInstance, uint32_t aScanChannels, uint16_t aPanId, bool aJoiner, bool aEnableEui64Filtering, otHandleActiveScanResult aCallback, void aCallbackContext)`	`otError` התחלת סריקה של Thread Discovery.
`otThreadGetChildTimeout(otInstance *aInstance)`	`uint32_t` מקבלת את הזמן הקצוב לתפוגה של צאצאים ב-Thread (בשניות) בשימוש בתפקיד 'צאצא'.
`otThreadGetDeviceRole(otInstance *aInstance)`	`otDeviceRole` מקבלים את התפקיד של המכשיר.
`otThreadGetDomainName(otInstance *aInstance)`	`const char *` מקבל את שם הדומיין של ה-thread.
`otThreadGetExtendedPanId(otInstance *aInstance)`	`const otExtendedPanId *` מקבל את מזהה ה-PAN המורחב 802.15.4 PAN.
`otThreadGetFixedDuaInterfaceIdentifier(otInstance *aInstance)`	`const otIp6InterfaceIdentifier *` הפונקציה מקבלת את מזהה הממשק שצוין באופן ידני עבור כתובת Unicast של דומיין Thread.
`otThreadGetIp6Counters(otInstance *aInstance)`	`const otIpCounters *` הפונקציה מקבלת את מוני IPv6.
`otThreadGetKeySequenceCounter(otInstance *aInstance)`	`uint32_t` מקבל את thrKeySequenceCounter.
`otThreadGetKeySwitchGuardTime(otInstance *aInstance)`	`uint32_t` מקבל את thrKeySwitchGuardTime (בשעות).
`otThreadGetLeaderData(otInstance aInstance, otLeaderData aLeaderData)`	`otError` מקבלים את הנתונים של מובילי השרשורים.
`otThreadGetLeaderRloc(otInstance aInstance, otIp6Address aLeaderRloc)`	`otError` מחזירה את הסמן ל-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 *` הפונקציה מקבלת את כתובת ה-IPv6 המקומית של הקישור לשרשור.
`otThreadGetLinkMode(otInstance *aInstance)`	`otLinkModeConfig` הגדרה של מצב קישור MLE.
`otThreadGetMaxTimeInQueue(otInstance *aInstance)`	`uint32_t` הפונקציה מקבלת את הזמן המקסימלי לתור להודעות בתור הודעות ב-TX.
`otThreadGetMeshLocalEid(otInstance *aInstance)`	`const otIp6Address *` הפונקציה מקבלת את כתובת ה-EID המקומית מסוג Mesh.
`otThreadGetMeshLocalPrefix(otInstance *aInstance)`	`const otMeshLocalPrefix *` מחזירה מצביע לקידומת מקומית ברשת.
`otThreadGetMleCounters(otInstance *aInstance)`	`const otMleCounters *` קבלת מוני MLE של Thread.
`otThreadGetNetworkKey(otInstance aInstance, otNetworkKey aNetworkKey)`	`void` מקבלים את מפתח Thread Network.
`otThreadGetNetworkKeyRef(otInstance *aInstance)`	`otNetworkKeyRef` מקבלים את `otNetworkKeyRef` עבור מפתח Thread Network.
`otThreadGetNetworkName(otInstance *aInstance)`	`const char *` מקבלים את השם של פרוטוקול Thread Network.
`otThreadGetNextDiagnosticTlv(const otMessage aMessage, otNetworkDiagIterator aIterator, otNetworkDiagTlv *aNetworkDiagTlv)`	`otError` מקבל את ה-TLV הבא של אבחון הרשת בהודעה.
`otThreadGetNextNeighborInfo(otInstance aInstance, otNeighborInfoIterator aIterator, otNeighborInfo *aInfo)`	`otError` הפונקציה מקבלת את המידע על השכן הבא.
`otThreadGetParentAverageRssi(otInstance aInstance, int8_t aParentRssi)`	`otError` הפונקציה מאחזרת את ה-RSSI הממוצע של ההורה של ה-thread.
`otThreadGetParentInfo(otInstance aInstance, otRouterInfo aParentInfo)`	`otError` הפונקציה מאחזרת את פרטי האבחון של נתב Thread כהורה.
`otThreadGetParentLastRssi(otInstance aInstance, int8_t aLastRssi)`	`otError` הפונקציה מאחזרת את ה-RSSI של החבילה האחרונה מההורה של ה-thread.
`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)`	`otError` אחזור ה-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 מתבצעת כעת.
`otThreadIsDiscoverInProgress(otInstance *aInstance)`	`bool` המדיניות קובעת אם מתבצע כרגע תהליך גילוי של שרשור MLE.
`otThreadIsSingleton(otInstance *aInstance)`	`bool` מציין אם צומת הוא הנתב היחיד ברשת.
`otThreadLocateAnycastDestination(otInstance aInstance, const otIp6Address aAnycastAddress, otThreadAnycastLocatorCallback aCallback, void *aContext)`	`otError` מבקש לאתר את היעד הקרוב ביותר של כתובת anycast נתונה.
`otThreadRegisterParentResponseCallback(otInstance aInstance, otThreadParentResponseCallback aCallback, void aContext)`	`void` רישום קריאה חוזרת (callback) לקבלת נתוני תגובת הורה ב-MLE.
`otThreadResetIp6Counters(otInstance *aInstance)`	`void` איפוס מוני IPv6.
`otThreadResetMleCounters(otInstance *aInstance)`	`void` איפוס מוני ה-MLE של Thread.
`otThreadResetTimeInQueueStat(otInstance *aInstance)`	`void` איפוס הנתונים הסטטיסטיים של תור ה-TX.
`otThreadSearchForBetterParent(otInstance *aInstance)`	`otError` הפעלת התהליך שבו הילד או הילדה מחפשים הורה טוב יותר, בלי קשר להורה הנוכחי.
`otThreadSendAddressNotification(otInstance aInstance, otIp6Address aDestination, otIp6Address aTarget, otIp6InterfaceIdentifier aMlIid)`	`void` שולח הודעה מסוג 'התראה יזומה על כתובת' ((IMAGE_NTF.ntf).
`otThreadSendDiagnosticGet(otInstance aInstance, const otIp6Address aDestination, const uint8_t aTlvTypes[], uint8_t aCount, otReceiveDiagnosticGetCallback aCallback, void *aCallbackContext)`	`otError` שליחת בקשה לקבלת אבחון רשת.
`otThreadSendDiagnosticReset(otInstance aInstance, const otIp6Address aDestination, const uint8_t aTlvTypes[], uint8_t aCount)`	`otError` שולחים בקשה לאיפוס של אבחון הרשת.
`otThreadSendProactiveBackboneNotification(otInstance aInstance, otIp6Address aTarget, otIp6InterfaceIdentifier *aMlIid, uint32_t aTimeSinceLastTransaction)`	`otError` שולח הודעה יזומה של Backbone Notification (PRO_BB.ntf) בקישור Backbone.
`otThreadSetChildTimeout(otInstance *aInstance, uint32_t aTimeout)`	`void` מגדירה את הזמן הקצוב לתפוגה של צאצאים ב-Thread (בשניות) לשימוש בתפקיד 'צאצא'.
`otThreadSetDiscoveryRequestCallback(otInstance aInstance, otThreadDiscoveryRequestCallback aCallback, void aContext)`	`void` הגדרת קריאה חוזרת (callback) לקבלת נתוני בקשה מסוג MLE Discovery.
`otThreadSetDomainName(otInstance aInstance, const char aDomainName)`	`otError` מגדיר את שם הדומיין לשרשורים.
`otThreadSetEnabled(otInstance *aInstance, bool aEnabled)`	`otError` התחלת הפעולה של פרוטוקול השרשור.
`otThreadSetExtendedPanId(otInstance aInstance, const otExtendedPanId aExtendedPanId)`	`otError` מגדיר את IEEE 802.15.4 Extended PAN ID.
`otThreadSetFixedDuaInterfaceIdentifier(otInstance aInstance, const otIp6InterfaceIdentifier aIid)`	`otError` מגדירה או מנקה את מזהה הממשק שצוין באופן ידני עבור כתובת Unicast של הדומיין לשרשורים.
`otThreadSetJoinerAdvertisement(otInstance aInstance, uint32_t aOui, const uint8_t aAdvData, uint8_t aAdvDataLength)`	`otError` מגדיר את הפרסומת של מחבר ה-Thread בזמן גילוי רשת Thread.
`otThreadSetKeySequenceCounter(otInstance *aInstance, uint32_t aKeySequenceCounter)`	`void` מגדיר את thrKeySequenceCounter.
`otThreadSetKeySwitchGuardTime(otInstance *aInstance, uint32_t aKeySwitchGuardTime)`	`void` מגדיר את thrKeySwitchGuardTime (בשעות).
`otThreadSetLinkMode(otInstance *aInstance, otLinkModeConfig aConfig)`	`otError` הגדרת ההגדרה של מצב קישור MLE.
`otThreadSetMeshLocalPrefix(otInstance aInstance, const otMeshLocalPrefix aMeshLocalPrefix)`	`otError` מגדיר את הקידומת המקומית ברשת.
`otThreadSetNetworkKey(otInstance aInstance, const otNetworkKey aKey)`	`otError` מגדירים את Thread Network Key.
`otThreadSetNetworkKeyRef(otInstance *aInstance, otNetworkKeyRef aKeyRef)`	`otError` מגדירים את Thread Network Key כ-`otNetworkKeyRef`.
`otThreadSetNetworkName(otInstance aInstance, const char aNetworkName)`	`otError` הגדרת השם של פרוטוקול Thread Network.
`otThreadSetVendorModel(otInstance aInstance, const char aVendorModel)`	`otError` מגדירים את מחרוזת המודל של הספק.
`otThreadSetVendorName(otInstance aInstance, const char aVendorName)`	`otError` מגדירים את המחרוזת של שם הספק.
`otThreadSetVendorSwVersion(otInstance aInstance, const char aVendorSwVersion)`	`otError` מגדירים את מחרוזת גרסת התוכנה של הספק.

מבנים
otBorderRouterConfig	מייצג תצורה של נתב גבול.
otExternalRouteConfig	מייצג תצורת מסלול חיצוני.
otIpCounters	מייצג את המונים ברמת ה-IP.
otLeaderData	מייצג את נתוני ה-Thread Leader.
otLinkModeConfig	מייצג הגדרה של מצב קישור MLE.
otLowpanContextInfo	מייצג מידע של מזהה הקשר 6LoWPAN שמשויך לקידומת בנתוני רשת.
otMleCounters	מייצג את מוני Thread MLE.
otNeighborInfo	מכיל את פרטי האבחון של צומת Thread סמוך.
otNetworkDiagChildEntry	מייצג רשומת צאצא של אבחון רשת.
otNetworkDiagConnectivity	מייצג ערך של קישוריות אבחון רשת.
otNetworkDiagMacCounters	מייצג ערך של מוני אבחון רשת.
otNetworkDiagMleCounters	מייצג ערך של מוני MLE לניתוחי רשת.
otNetworkDiagRoute	מייצג ערך TLV של נתיב ניתוח הרשת.
otNetworkDiagRouteData	מייצג נתונים של נתיב אבחון רשת.
otNetworkDiagTlv	מייצג TLV לאבחון רשת.
otRouterInfo	מכילה פרטי אבחון של נתב פרוטוקול Thread.
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`	TLV של רשימת כתובות IPv6 של צאצא.
`OT_NETWORK_DIAGNOSTIC_TLV_CHILD_TABLE`	TLV – שולחן לילדים.
`OT_NETWORK_DIAGNOSTIC_TLV_CONNECTIVITY`	TLV של קישוריות.
`OT_NETWORK_DIAGNOSTIC_TLV_EXT_ADDRESS`	כתובת מורחבת של MAC, TLV.
`OT_NETWORK_DIAGNOSTIC_TLV_IP6_ADDR_LIST`	TLV של רשימת כתובות IPv6.
`OT_NETWORK_DIAGNOSTIC_TLV_LEADER_DATA`	Leader Data TLV.
`OT_NETWORK_DIAGNOSTIC_TLV_MAC_COUNTERS`	מוני MAC TLV.
`OT_NETWORK_DIAGNOSTIC_TLV_MAX_CHILD_TIMEOUT`	זמן קצוב לתפוגה של ילדים מקסימליים (TLV).
`OT_NETWORK_DIAGNOSTIC_TLV_MLE_COUNTERS`	MLE Counters 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`	כביש 64 TLV.
`OT_NETWORK_DIAGNOSTIC_TLV_ROUTER_NEIGHBOR`	Router Neighbor TLV.
`OT_NETWORK_DIAGNOSTIC_TLV_SHORT_ADDRESS`	כתובת16 TLV.
`OT_NETWORK_DIAGNOSTIC_TLV_SUPPLY_VOLTAGE`	אספקת מתח TLV.
`OT_NETWORK_DIAGNOSTIC_TLV_THREAD_STACK_VERSION`	גרסת ThLV של Thread Stack.
`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`	גרסה TLV של הספק.
`OT_NETWORK_DIAGNOSTIC_TLV_VERSION`	גרסת TLV.

otDeviceRole

 otDeviceRole

מייצג תפקיד של מכשיר Thread.

תכונות
`OT_DEVICE_ROLE_CHILD`	התפקיד צאצא של Thread.
`OT_DEVICE_ROLE_DETACHED`	לא משתתף כרגע ברשת/מחיצה של פרוטוקול Thread.
`OT_DEVICE_ROLE_DISABLED`	מקבץ השרשורים מושבת.
`OT_DEVICE_ROLE_LEADER`	התפקיד 'ראש השרשור'.
`OT_DEVICE_ROLE_ROUTER`	התפקיד של נתב Thread

otNetDataPublisherEvent

 otNetDataPublisherEvent

מייצג את האירועים שדווחו מההתקשרות חזרה של בעל התוכן הדיגיטלי.

תכונות
`OT_NETDATA_PUBLISHER_EVENT_ENTRY_ADDED`	הרשומה שפורסמה נוספה לנתוני Thread Network.
`OT_NETDATA_PUBLISHER_EVENT_ENTRY_REMOVED`	הרשומה שפורסמה תוסר מנתוני Thread Network.

otRoutePreference

 otRoutePreference

מגדיר ערכים חוקיים עבור mPreference ב-otExternalRouteConfig וב-otBorderRouterConfig.

תכונות
`OT_ROUTE_PREFERENCE_HIGH`	העדפת מסלול גבוהה.
`OT_ROUTE_PREFERENCE_LOW`	העדפת מסלול נמוכה.
`OT_ROUTE_PREFERENCE_MED`	העדפת מסלול בינונית.

ערכי דף

otBorderRouterConfig

struct otBorderRouterConfig otBorderRouterConfig

מייצג תצורה של נתב גבול.

otDetachGracefullyCallback

void(* otDetachGracefullyCallback)(void *aContext)

הקריאה החוזרת (callback) מודיעה לאפליקציה שתהליך הניתוק הסתיים.

פרטים

פרמטרים

[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 שמשויך לקידומת בנתוני רשת.

otMleCounters

struct otMleCounters otMleCounters

מייצג את מוני Thread MLE.

otNeighborInfoIterator

int16_t otNeighborInfoIterator

משמש לאיטרציה דרך טבלה סמוכה.

otNetDataDnsSrpServicePublisherCallback

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

סוג המצביע מגדיר את הקריאה החוזרת (callback) שתשמש לקבלת התראה כשמתבצעת הוספה של רשומת DNS/SRP לנתוני רשת של פרוטוקול Thread או הסרה שלהם.

בעת ההסרה, הקריאה החוזרת מופעלת ללא תלות בהסרת הרשומה על ידי Publisher (למשל, כאשר קיימות כבר יותר מדי רשומות דומות בנתוני הרשת) או באמצעות קריאה מפורשת לבטל את פרסום הרשומה (כלומר, קריאה ל-otNetDataUnpublishDnsSrpService()).

פרטים

פרמטרים

`[in] aEvent`	מציין את האירוע (האם הערך נוסף או הוסר).
`[in] aContext`	הפניה להקשר ספציפי לאפליקציה.

otNetDataPrefixPublisherCallback

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

סוג המצביע מגדיר את הקריאה החוזרת (callback) שתשמש לקבלת התראה כשנוספת קידומת (ברשת או בנתיב חיצוני) לנתוני הרשת של Thread או כשמסירים אותם.

בעת ההסרה, הקריאה החוזרת מופעלת ללא תלות בהסרת הרשומה על ידי 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

משמש לאיטרציה דרך TLV של אבחון הרשת.

otNetworkDiagMacCounters

struct otNetworkDiagMacCounters otNetworkDiagMacCounters

מייצג ערך של מוני אבחון רשת.

הגדרות של שדות חברים מפורטות ב-RFC 2863.

otNetworkDiagMleCounters

struct otNetworkDiagMleCounters otNetworkDiagMleCounters

מייצג ערך של מוני MLE לניתוחי רשת.

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`	הפניה למאגר ההודעות שמכיל את המטען הייעודי (payload) של אבחון הרשת שהתקבל. האפשרות זמינה רק כשהערך בשדה `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)

סוג המצביע מגדיר את הקריאה החוזרת (callback) כדי להודיע על התוצאה של בקשת otThreadLocateAnycastDestination().

פרטים

פרמטרים

`[in] aContext`	הפניה להקשר שרירותי (שנקבע כשמתבצע רישום של הקריאה החוזרת).
`[in] aError`	השגיאה במהלך הטיפול בבקשה. OT_ERROR_NONE מצביע על הצלחה. OT_ERROR_FUNCTION_OFFSET מציין שלא ניתן למצוא יעד. 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)

המצביע מופעל בכל פעם שמתקבלת הודעה של בקשת Discovery של MLE.

פרטים

פרמטרים

`[in] aInfo`	מעבר עם הסמן לנתוני הפרטים של בקשת הגילוי.
`[in] aContext`	הפניה להקשר ספציפי לאפליקציה של הקריאה החוזרת (callback).

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`	הפניה למערך תווים כדי ליצור את המחרוזת כפלט.
`[in] aSize`	הגודל של `aBuffer` (בבייטים). מומלץ להשתמש ב-`OT_DURATION_STRING_SIZE`.

otNetDataContainsOmrPrefix

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

בודקים אם קידומת נתונה יכולה לשמש כקידומת OMR חוקית, וגם נתוני הרשת של המנהיג מכילים את הקידומת הזו.

הערה: ה-API הזה זמין רק כשמשתמשים ב-OPENTHREAD_CONFIG_BORDER_ROUTING_ENABLE.

פרטים

פרמטרים

`[in] aInstance`	מצביע למופע של OpenThread.
`[in] aPrefix`	מצביע לקידומת IPv6.

החזרות

אם aPrefix היא קידומת OMR חוקית, ונתוני הרשת של המוביל מכילים את קידומת OMR aPrefix.

otNetDataGet

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

יש לספק עותק מלא או יציב של נתוני Thread Network של המחיצה.

פרטים

פרמטרים

`[in] aInstance`	מצביע למופע של OpenThread.
`[in] aStable`	TRUE כשמעתיקים את הגרסה היציבה, FALSE כשמעתיקים את הגרסה המלאה.
`[out] aData`	מצביעים על מאגר הנתונים הזמני.
`[in,out] aDataLength`	בעת הכניסה, גודל מאגר הנתונים שאליו מפנה `aData`. ביציאה, מספר הבייטים שהועתקו.

ערכים מוחזרים

`OT_ERROR_NONE`	נתוני הרשת של Thread הועתקו אל `aData` ועדכון `aDataLength`.
`OT_ERROR_NO_BUFS`	אין מספיק מקום ב-`aData` כדי להעתיק באופן מלא את נתוני Thread Network.

otNetDataGetCommissioningDataset

void otNetDataGetCommissioningDataset(
  otInstance *aInstance,
  otCommissioningDataset *aDataset
)

הפונקציה מקבלת את מערך הנתונים של העמלה מנתוני הרשת של המחיצה.

פרטים

פרמטרים

`[in] aInstance`	מצביע למופע של OpenThread.
`[out] aDataset`	מצביע ל-`otCommissioningDataset` שצריך לאכלס.

otNetDataGetLength

uint8_t otNetDataGetLength(
  otInstance *aInstance
)

קבלת האורך הנוכחי (מספר הבייטים) של נתוני רשת Thread של המחיצה.

פרטים

פרמטרים

[in] aInstance

מצביע למופע של OpenThread.

החזרות

האורך של נתוני הרשת.

otNetDataGetMaxLength

uint8_t otNetDataGetMaxLength(
  otInstance *aInstance
)

משך הזמן המקסימלי שנצפה של נתוני Thread Network מאז אתחול סטאק ה-OT או מאז הקריאה האחרונה ל-otNetDataResetMaxLength().

פרטים

פרמטרים

[in] aInstance

מצביע למופע של OpenThread.

החזרות

האורך המקסימלי של נתוני הרשת (סימן מים גבוה עבור אורך נתוני הרשת).

otNetDataGetNextLowpanContextInfo

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

קבלת הפרטים הבאים של מזהה הקשר 6LoWPAN בנתוני הרשת של המחיצה.

פרטים

פרמטרים

`[in] aInstance`	מצביע למופע של OpenThread.
`[in,out] aIterator`	מצביע על איטרטור נתוני הרשת. כדי לקבל את הרשומה הראשונה של השירות, צריך להגדיר אותה כ-OT_NETWORK_DATA_ITERATOR_INIT.
`[out] aContextInfo`	מצביע למקום שבו ימוקם המידע של מזהה ההקשר 6LoWPAN שאוחזר.

ערכים מוחזרים

`OT_ERROR_NONE`	נמצא בהצלחה מזהה הקשר 6LoWPAN הבא.
`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`	מצביע למקום שבו ימוקם המידע על קידומת ברשת.

ערכים מוחזרים

`OT_ERROR_NONE`	זוהתה בהצלחה הקידומת הבאה ב-On Mesh.
`OT_ERROR_NOT_FOUND`	לא קיימת קידומת On Mesh נוספת בנתונים של Thread Network.

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`	לא קיימת רשומה נוספת של נתיב חיצוני בנתונים של Thread Network.

otNetDataGetNextService

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

קבלת השירות הבא בנתוני הרשת של המחיצה.

פרטים

פרמטרים

`[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
)

להורדת גרסת הנתונים היציבה של הרשת

פרטים

פרמטרים

[in] aInstance

מצביע למופע של OpenThread.

החזרות

גרסה של נתוני הרשת היציבה.

otNetDataGetVersion

uint8_t otNetDataGetVersion(
  otInstance *aInstance
)

מורידים את הגרסה של נתוני הרשת.

פרטים

פרמטרים

[in] aInstance

מצביע למופע של OpenThread.

החזרות

הגרסה של נתוני הרשת.

otNetDataIsDnsSrpServiceAdded

bool otNetDataIsDnsSrpServiceAdded(
  otInstance *aInstance
)

בעמודה הזו מציינים אם הערך של 'שירות DNS/SRP' נוסף לנתוני הרשת של פרוטוקול Thread.

לשם כך נדרשת הפעלה של התכונה OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE.

פרטים

פרמטרים

[in] aInstance

מצביע למופע של OpenThread.

ערכים מוחזרים

`TRUE`	הערך של שירות DNS/SRP שפורסם נוסף לנתוני הרשת של פרוטוקול Thread.
`FALSE`	הרשומה לא נוספה לנתוני Thread Network או שאין רשומה שאפשר לפרסם.

otNetDataIsPrefixAdded

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

מציין אם רשומת קידומת שפורסמה (ב-mesh או נתיב חיצוני) נוספה כרגע לנתוני הרשת של Thread.

לשם כך נדרשת הפעלה של התכונה OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE.

פרטים

פרמטרים

`[in] aInstance`	מצביע למופע של OpenThread.
`[in] aPrefix`	מצביע לקידומת (לא יכול להיות NULL).

ערכים מוחזרים

`TRUE`	רשומת הקידומת שפורסמה מתווספת לנתוני הרשת של Thread.
`FALSE`	הרשומה לא נוספה לנתוני Thread Network או שאין רשומה שאפשר לפרסם.

otNetDataPublishDnsSrpServiceAnycast

void otNetDataPublishDnsSrpServiceAnycast(
  otInstance *aInstance,
  uint8_t aSequenceNUmber
)

נשלחת בקשה לפרסום של 'כתובת מסוג Anycast של שירות DNS/SRP' בנתונים של Thread Network.

לשם כך נדרשת הפעלה של התכונה OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE.

קריאה לפונקציה זו תסיר ותחליף כל רשומת "DNS/SRP" קודמת שפורסמה (מקריאה קודמת לכל אחת מפונקציות otNetDataPublishDnsSrpService{Type}()).

פרטים

פרמטרים

`[in] aInstance`	מצביע למופע של OpenThread.
`[in] aSequenceNUmber`	מספר הרצף של שירות DNS/SRP Anycast.

otNetDataPublishDnsSrpServiceUnicast

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

נשלחת בקשה לפרסום של 'כתובת Unicast של שירות DNS/SRP' בנתוני הרשת של פרוטוקול Thread.

לשם כך נדרשת הפעלה של התכונה OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE.

מפרסם את 'כתובת Unicast של שירות DNS/SRP' על ידי הכללת הכתובת ופרטי היציאה בנתוני ה-TLV של השירות.

פרטים

פרמטרים

`[in] aInstance`	מצביע למופע של OpenThread.
`[in] aAddress`	כתובת שרת ה-DNS/SRP לפרסום (חייבת להיות NULL).
`[in] aPort`	מספר היציאה של שרת ה-SRP לפרסום.

otNetDataPublishDnsSrpServiceUnicastMeshLocalEid

void otNetDataPublishDnsSrpServiceUnicastMeshLocalEid(
  otInstance *aInstance,
  uint16_t aPort
)

נשלחת בקשה לפרסום של 'כתובת Unicast של שירות DNS/SRP' בנתוני הרשת של פרוטוקול Thread.

לשם כך נדרשת הפעלה של התכונה OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE.

בניגוד ל-otNetDataPublishDnsSrpServiceUnicast(), שדורש את הכתובת שפורסמה וכולל את המידע בנתוני ה-TLV של השירות, הפונקציה הזו משתמשת ב-EID המקומי ברשת של המכשיר וכוללת את המידע מנתוני ה-TLV של השרת.

פרטים

פרמטרים

`[in] aInstance`	מצביע למופע של OpenThread.
`[in] aPort`	מספר היציאה של שרת ה-SRP לפרסום.

otNetDataPublishExternalRoute

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

נשלחת בקשה לפרסום קידומת של נתיב חיצוני בנתוני Thread Network.

לשם כך נדרשת הפעלה של התכונה OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE.

ניתן לפרסם רק ערכים יציבות (כלומרהערך aConfig.mStable חייב להיות TRUE).

קריאה נוספת לשיטה הזו תחליף בקשה קודמת לאותה קידומת. באופן ספציפי, אם הקריאה החדשה משנה רק את הדגלים (למשל רמת העדפה) והקידומת כבר נוספה בנתוני הרשת, השינוי לסימונים ישתקף מיד בנתוני הרשת. כך ניתן להבטיח שערכים קיימים בנתוני הרשת לא יוסרו באופן פתאומי. שים לב ששינוי ברמת ההעדפה עשוי לגרום בשלב מאוחר יותר להסרת הרשומה מנתוני הרשת, לאחר שנקבע כי יש צמתים אחרים שמפרסמים את אותה קידומת עם העדפה זהה או גבוהה יותר.

פרטים

פרמטרים

`[in] aInstance`	מצביע למופע של OpenThread.
`[in] aConfig`	הגדרת הנתיב החיצוני לפרסום (אסור שהיא לא תהיה NULL).

ערכים מוחזרים

`OT_ERROR_NONE`	המסלול החיצוני פורסם בהצלחה.
`OT_ERROR_INVALID_ARGS`	הערך `aConfig` אינו חוקי (תחילית שגויה, שילובי סימונים לא חוקיים או לא יציב).
`OT_ERROR_NO_BUFS`	לא ניתן להקצות רשומה לבקשה החדשה. בעל האפליקציה תומך במספר מוגבל של רשומות (שמשותפות בין קידומת ב-mesh לנתיב חיצוני) שנקבעות על ידי ההגדרה `OPENTHREAD_CONFIG_NETDATA_PUBLISHER_MAX_PREFIX_ENTRIES`.

otNetDataPublishOnMeshPrefix

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

נשלחת בקשה להצגת קידומת מסוג on-mesh בנתוני הרשת של Thread.

לשם כך נדרשת הפעלה של התכונה OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE.

ניתן לפרסם רק ערכים יציבות (כלומרהערך aConfig.mStable חייב להיות TRUE).

קריאה נוספת לשיטה הזו תחליף בקשה קודמת לאותה תחילית. באופן ספציפי, אם הקריאה החדשה משנה רק את הדגלים (למשל רמת העדפה) והקידומת כבר נוספה בנתוני הרשת, השינוי לסימונים ישתקף מיד בנתוני הרשת. כך ניתן להבטיח שערכים קיימים בנתוני הרשת לא יוסרו באופן פתאומי. שים לב ששינוי ברמת ההעדפה עשוי לגרום בשלב מאוחר יותר להסרת הרשומה מנתוני הרשת, לאחר שנקבע כי יש צמתים אחרים שמפרסמים את אותה קידומת עם העדפה זהה או גבוהה יותר.

פרטים

פרמטרים

`[in] aInstance`	מצביע למופע של OpenThread.
`[in] aConfig`	הגדרת הקידומת on-mesh שיש לפרסם (חייבת להיות NULL).

ערכים מוחזרים

`OT_ERROR_NONE`	הקידומת on-mesh פורסמה.
`OT_ERROR_INVALID_ARGS`	הערך `aConfig` אינו חוקי (תחילית שגויה, שילובי סימונים לא חוקיים או לא יציב).
`OT_ERROR_NO_BUFS`	לא ניתן להקצות רשומה לבקשה החדשה. בעל האפליקציה תומך במספר מוגבל של רשומות (שמשותפות בין קידומת ב-mesh לנתיב חיצוני) שנקבעות על ידי ההגדרה `OPENTHREAD_CONFIG_NETDATA_PUBLISHER_MAX_PREFIX_ENTRIES`.

otNetDataReplacePublishedExternalRoute

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

מחליפה נתיב חיצוני שכבר פורסם בנתוני Thread Network.

לשם כך נדרשת הפעלה של התכונה OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE.

אם לא פורסם בעבר נתיב חיצוני שתואם ל-aPrefix, הפונקציה הזו תפעל באופן דומה ל-otNetDataPublishExternalRoute(). כלומר, היא תתחיל את תהליך הפרסום של aConfig כנתיב חיצוני בנתוני רשת Thread.

אם קיימת רשומה של נתיב שפורסמה בעבר שתואמת ל-aPrefix, היא תוחלף בקידומת החדשה מ-aConfig.

אם ה-aPrefix כבר נוסף לנתוני הרשת, השינוי לקידומת החדשה ב-aConfig בא לידי ביטוי באופן מיידי בנתוני הרשת. כך ניתן להבטיח שערכי הנתיב בנתוני הרשת לא יוסרו בפתאומיות והמעבר מקידומת לקידומת החדשה יהיה חלק.
אם ה-aPrefix הישן שפורסם לא נוסף לנתוני הרשת, הוא יוחלף בקידומת החדשה aConfig, אבל הוא לא יתווסף באופן מיידי. במקום זאת, האפליקציה תתחיל בתהליך הפרסום שלה בנתוני הרשת (מעקב אחר נתוני הרשת כדי לקבוע מתי/אם להוסיף את הקידומת, בהתאם למספר הקידומות הדומות שקיימות בנתוני הרשת).

פרטים

פרמטרים

`[in] aInstance`	מצביע למופע של OpenThread.
`[in] aPrefix`	קידומת הנתיב החיצוני שפורסם בעבר.
`[in] aConfig`	הגדרת הנתיב החיצוני לפרסום.

ערכים מוחזרים

`OT_ERROR_NONE`	המסלול החיצוני פורסם בהצלחה.
`OT_ERROR_INVALID_ARGS`	הערך `aConfig` אינו חוקי (תחילית שגויה, שילובי סימונים לא חוקיים או לא יציב).
`OT_ERROR_NO_BUFS`	לא ניתן להקצות רשומה לבקשה החדשה. בעל האפליקציה תומך במספר מוגבל של רשומות (שמשותפות בין קידומת ב-mesh לנתיב חיצוני) שנקבעות על ידי ההגדרה `OPENTHREAD_CONFIG_NETDATA_PUBLISHER_MAX_PREFIX_ENTRIES`.

otNetDataResetMaxLength

void otNetDataResetMaxLength(
  otInstance *aInstance
)

איפוס האורך המקסימלי של המעקב אחר נתוני Thread Network.

פרטים

פרמטרים

[in] aInstance

מצביע למופע של OpenThread.

ראו גם:
otNetDataGetMaxLength

otNetDataSetDnsSrpServicePublisherCallback

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

מגדירה קריאה חוזרת (callback) לקבלת התראה כששירות DNS/SRP שפורסם בפועל נוסף לנתוני רשת Thread או הוסר מהם.

קריאה נוספת לפונקציה הזו מחליפה כל פונקציית קריאה חוזרת שהוגדרה קודם לכן.

לשם כך נדרשת הפעלה של התכונה OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE.

פרטים

פרמטרים

`[in] aInstance`	מצביע למופע של OpenThread.
`[in] aCallback`	המצביע של פונקציית הקריאה החוזרת (callback יכול להיות NULL אם לא צריך).
`[in] aContext`	הפניה להקשר ספציפי לאפליקציה (משמשת להפעלה של `aCallback`).

otNetDataSetPrefixPublisherCallback

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

הגדרת קריאה חוזרת (callback) לקבלת התראה כשרשומת קידומת שפורסמה מתווספת בפועל לנתוני רשת Thread או מסירה מהם.

קריאה נוספת לפונקציה הזו מחליפה כל פונקציית קריאה חוזרת שהוגדרה קודם לכן.

לשם כך נדרשת הפעלה של התכונה OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE.

פרטים

פרמטרים

`[in] aInstance`	מצביע למופע של OpenThread.
`[in] aCallback`	המצביע של פונקציית הקריאה החוזרת (callback יכול להיות NULL אם לא צריך).
`[in] aContext`	הפניה להקשר ספציפי לאפליקציה (משמשת להפעלה של `aCallback`).

otNetDataSteeringDataCheckJoiner

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

בודקים אם נתוני ההיגוי כוללים איחוד (joiner).

פרטים

פרמטרים

`[in] aInstance`	מצביע למופע של OpenThread.
`[in] aEui64`	מצביע ל-IEEE EUI-64 של האיחוד.

ערכים מוחזרים

`OT_ERROR_NONE`	`aEui64` נכלל בנתוני ההיגוי.
`OT_ERROR_INVALID_STATE`	אין נתוני כוונון.
`OT_ERROR_NOT_FOUND`	`aEui64` לא נכלל בנתוני ההיגוי.

otNetDataSteeringDataCheckJoinerWithDiscerner

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

בודקים אם נתוני ההיגוי כוללים איחוד (join) עם ערך נתון של אובייקט.

פרטים

פרמטרים

`[in] aInstance`	מצביע למופע של OpenThread.
`[in] aDiscerner`	מצביע אל ה-Connecter Discerner.

ערכים מוחזרים

`OT_ERROR_NONE`	`aDiscerner` נכלל בנתוני ההיגוי.
`OT_ERROR_INVALID_STATE`	אין נתוני כוונון.
`OT_ERROR_NOT_FOUND`	`aDiscerner` לא נכלל בנתוני ההיגוי.

otNetDataUnpublishDnsSrpService

void otNetDataUnpublishDnsSrpService(
  otInstance *aInstance
)

מבטל את הפרסום של כל ערך של שירות DNS/SRP (Anycast או Unicast) שנוסף בעבר מנתוני Thread Network.

חובה להפעיל את OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE.

פרטים

פרמטרים

[in] aInstance

מצביע למופע של OpenThread.

otNetDataUnpublishPrefix

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

ביטול הפרסום של קידומת On-Mesh או קידומת נתיב חיצונית שפורסמה בעבר.

חובה להפעיל את 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.

אם מדובר בנתב, או אם מדובר בנתב, הזמן הקצוב לתפוגה מוגדר ל-0 בתור צאצא.

פרטים

פרמטרים

`[in] aInstance`	מצביע למופע של OpenThread.
`[in] aCallback`	מצביע על פונקציה שנקראת בסיום הניתוק.
`[in] aContext`	הפניה להקשר ספציפי לאפליקציה של הקריאה החוזרת (callback).

ערכים מוחזרים

`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' (מוגדר ל-'שידור PAN' כדי להשבית את המסנן).
`[in] aJoiner`	הערך של דגל ההצטרפות ב-TLV של בקשת הגילוי.
`[in] aEnableEui64Filtering`	צריך להזין את הערך TRUE כדי לסנן את התשובות ב-EUI-64 או ב-FALSE, אם לא.
`[in] aCallback`	הפניה לפונקציה שנקראת כאשר מתקבלת תגובת MLE Discovery או שהסריקה הסתיימה.
`[in] aCallbackContext`	הפניה להקשר ספציפי לאפליקציה.

ערכים מוחזרים

`OT_ERROR_NONE`	הסריקה לגילוי שרשורים התחילה.
`OT_ERROR_INVALID_STATE`	ממשק IPv6 אינו מופעל (netif לא פועל).
`OT_ERROR_NO_BUFS`	לא ניתן להקצות את ההודעה לבקשת הגילוי.
`OT_ERROR_BUSY`	סריקת Thread Discovery כבר מתבצעת.

otThreadGetChildTimeout

uint32_t otThreadGetChildTimeout(
  otInstance *aInstance
)

מקבלת את הזמן הקצוב לתפוגה של צאצאים ב-Thread (בשניות) בשימוש בתפקיד 'צאצא'.

פרטים

פרמטרים

[in] aInstance

מצביע למופע של OpenThread.

החזרות

ערך הזמן הקצוב לתפוגה של צאצא של שרשור, בשניות.

כדאי לעיין גם במאמרים הבאים:
otThreadSetChildTimeout

otThreadGetDeviceRole

otDeviceRole otThreadGetDeviceRole(
  otInstance *aInstance
)

מקבלים את התפקיד של המכשיר.

פרטים

פרמטרים

[in] aInstance

מצביע למופע של OpenThread.

ערכים מוחזרים

`OT_DEVICE_ROLE_DISABLED`	מקבץ השרשורים מושבת.
`OT_DEVICE_ROLE_DETACHED`	המכשיר לא משתתף כרגע ברשת/מחיצה של פרוטוקול Thread.
`OT_DEVICE_ROLE_CHILD`	המכשיר פועל כרגע כצאצא של פרוטוקול Thread.
`OT_DEVICE_ROLE_ROUTER`	המכשיר פועל כרגע כנתב פרוטוקול Thread.
`OT_DEVICE_ROLE_LEADER`	המכשיר פועל כרגע בתור מוביל שרשור.

otThreadGetDomainName

const char * otThreadGetDomainName(
  otInstance *aInstance
)

מקבל את שם הדומיין של ה-thread.

פרטים

פרמטרים

[in] aInstance

מצביע למופע של OpenThread.

החזרות

לחיצה על שם הדומיין של השרשור.

מידע נוסף מופיע גם:
otThreadSetDomainName

otThreadGetExtendedPanId

const otExtendedPanId * otThreadGetExtendedPanId(
  otInstance *aInstance
)

מקבל את מזהה ה-PAN המורחב 802.15.4 PAN.

פרטים

פרמטרים

[in] aInstance

מצביע למופע של OpenThread.

החזרות

מצביע על המזהה IEEE 802.15.4 של מספר ה-PAN המורחב.

מידע נוסף מופיע גם:
otThreadSetExtendedPanId

otThreadGetFixedDuaInterfaceIdentifier

const otIp6InterfaceIdentifier * otThreadGetFixedDuaInterfaceIdentifier(
  otInstance *aInstance
)

הפונקציה מקבלת את מזהה הממשק שצוין באופן ידני עבור כתובת Unicast של דומיין Thread.

זמין כאשר OPENTHREAD_CONFIG_DUA_ENABLE מופעל.

פרטים

פרמטרים

[in] aInstance

מצביע למופע של OpenThread.

החזרות

הפניה למזהה הממשק שהוגדר באופן ידני, או NULL אם לא הוגדר שום מזהה.

ראו גם:
otThreadSetFixedDuaInterfaceIdentifier

otThreadGetIp6Counters

const otIpCounters * otThreadGetIp6Counters(
  otInstance *aInstance
)

הפונקציה מקבלת את מוני IPv6.

פרטים

פרמטרים

[in] aInstance

מצביע למופע של OpenThread.

החזרות

מצביע למוני IPv6.

otThreadGetKeySequenceCounter

uint32_t otThreadGetKeySequenceCounter(
  otInstance *aInstance
)

מקבל את thrKeySequenceCounter.

פרטים

פרמטרים

[in] aInstance

מצביע למופע של OpenThread.

החזרות

הערך thrKeySequenceCounter.

ראו גם:
otThreadSetKeySequenceCounter

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` היה NULL.
`OT_ERROR_DETACHED`	לא מצורף כרגע למחיצת Thread.

otThreadGetLeaderRouterId

uint8_t otThreadGetLeaderRouterId(
  otInstance *aInstance
)

מוצאים את מזהה הנתב של הבכיר בארגון.

פרטים

פרמטרים

[in] aInstance

מצביע למופע של OpenThread.

החזרות

מזהה הנתב של הבכיר בארגון.

otThreadGetLeaderWeight

uint8_t otThreadGetLeaderWeight(
  otInstance *aInstance
)

קבלו את משקל המוביל.

פרטים

פרמטרים

[in] aInstance

מצביע למופע של OpenThread.

החזרות

משקל המנהיג.

otThreadGetLinkLocalAllThreadNodesMulticastAddress

const otIp6Address * otThreadGetLinkLocalAllThreadNodesMulticastAddress(
  otInstance *aInstance
)

מקבל את כתובת השידור לכולם של Thread Link-Local All Thread Nodes.

הכתובת היא כתובת מרובת-שידורים מבוססת-קישור של Unicast מקומית [RFC 3306], עם:

flgs מוגדר ל-3 (P = 1 ו-T = 1)
scop מוגדר ל-2
מוגדר ל-64
קידומת הרשת מוגדרת לקידומת מקומית של רשת
מזהה הקבוצה הוגדר ל-1

פרטים

פרמטרים

[in] aInstance

מצביע למופע של OpenThread.

החזרות

הפניה לכתובת מרובת-שידורים של שרשורים מסוג Thread Link-Local All Thread Nodes.

otThreadGetLinkLocalIp6Address

const otIp6Address * otThreadGetLinkLocalIp6Address(
  otInstance *aInstance
)

הפונקציה מקבלת את כתובת ה-IPv6 המקומית של הקישור לשרשור.

הכתובת המקומית של הקישור לשרשור נגזרת באמצעות כתובת מורחבת של IEEE802.15.4 כמזהה הממשק.

פרטים

פרמטרים

[in] aInstance

מצביע למופע של OpenThread.

החזרות

הפניה לכתובת IPv6 מקומית עם קישור לשרשור.

otThreadGetLinkMode

otLinkModeConfig otThreadGetLinkMode(
  otInstance *aInstance
)

הגדרה של מצב קישור MLE.

פרטים

פרמטרים

[in] aInstance

מצביע למופע של OpenThread.

החזרות

ההגדרה של מצב קישור MLE.

מקורות נוספים:
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
)

הפונקציה מקבלת את כתובת ה-EID המקומית מסוג Mesh.

פרטים

פרמטרים

[in] aInstance

מצביע למופע של OpenThread.

החזרות

מצביע על כתובת ה-EID המקומי של רשת ה-Mesh.

otThreadGetMeshLocalPrefix

const otMeshLocalPrefix * otThreadGetMeshLocalPrefix(
  otInstance *aInstance
)

מחזירה מצביע לקידומת מקומית ברשת.

פרטים

פרמטרים

[in] aInstance

מצביע למופע של OpenThread.

החזרות

מצביע לקידומת המקומית של רשת אריג.

otThreadGetMleCounters

const otMleCounters * otThreadGetMleCounters(
  otInstance *aInstance
)

קבלת מוני MLE של Thread.

פרטים

פרמטרים

[in] aInstance

מצביע למופע של OpenThread.

החזרות

הפניה למוני ה-Thread MLE.

otThreadGetNetworkKey

void otThreadGetNetworkKey(
  otInstance *aInstance,
  otNetworkKey *aNetworkKey
)

מקבלים את מפתח Thread Network.

פרטים

פרמטרים

`[in] aInstance`	מצביע למופע של OpenThread.
`[out] aNetworkKey`	מצביע על `otNetworkKey` כדי להחזיר את מפתח Thread Network.

ראו גם:
otThreadSetNetworkKey

otThreadGetNetworkKeyRef

otNetworkKeyRef otThreadGetNetworkKeyRef(
  otInstance *aInstance
)

מקבלים את otNetworkKeyRef עבור מפתח Thread Network.

כדי להשתמש בתכונה 'זמן build' צריך להפעיל את OPENTHREAD_CONFIG_PLATFORM_KEY_REFERENCES_ENABLE.

פרטים

פרמטרים

[in] aInstance

מצביע למופע של OpenThread.

החזרות

הפניה למפתח רשת Thread ששמור בזיכרון.

ראו גם:
otThreadSetNetworkKeyRef

otThreadGetNetworkName

const char * otThreadGetNetworkName(
  otInstance *aInstance
)

מקבלים את השם של פרוטוקול Thread Network.

פרטים

פרמטרים

[in] aInstance

מצביע למופע של OpenThread.

החזרות

מצביע ל-Thread Network Name.

ראו גם:
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 הראשון לאבחון רשת, יש להגדיר אותו כ-OT_NETWORK_DIAGNOSTIC_ITERATOR_INIT.
`[out] aNetworkDiagTlv`	מצביע למקום שבו ימוקם פרטי ה-TLV של אבחון הרשת.

ערכים מוחזרים

`OT_ERROR_NONE`	ה-TLV הבא של אבחון הרשת נמצא בהצלחה.
`OT_ERROR_NOT_FOUND`	בהודעה לא קיים TLV נוסף של אבחון רשת.
`OT_ERROR_PARSE`	ניתוח אבחון הרשת הבא נכשל.

otThreadGetNextNeighborInfo

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

הפונקציה מקבלת את המידע על השכן הבא.

הוא משמש למעבר בין הערכים של טבלת השכן.

פרטים

פרמטרים

`[in] aInstance`	מצביע למופע של OpenThread.
`[in,out] aIterator`	מצביע על ההקשר של האיטרטור. כדי לקבל את הרשומה השכנה הראשונה, יש להגדיר אותה כ-OT_NEIGHBOR_INFO_ITERATOR_INIT.
`[out] aInfo`	מצביע על הפרטים של השכן.

ערכים מוחזרים

`OT_ERROR_NONE`	זוהתה בהצלחה הרשומה השכנה הבאה בטבלה.
`OT_ERROR_NOT_FOUND`	לא קיימת רשומת סמוך נוסף בטבלה.
`OT_ERROR_INVALID_ARGS`	הערך של `aIterator` או של `aInfo` היה NULL.

otThreadGetParentAverageRssi

otError otThreadGetParentAverageRssi(
  otInstance *aInstance,
  int8_t *aParentRssi
)

הפונקציה מאחזרת את ה-RSSI הממוצע של ההורה של ה-thread.

פרטים

פרמטרים

`[in] aInstance`	מצביע למופע של OpenThread.
`[out] aParentRssi`	מצביע למקום שבו יש למקם את ה-RSSI הראשי.

otThreadGetParentInfo

otError otThreadGetParentInfo(
  otInstance *aInstance,
  otRouterInfo *aParentInfo
)

הפונקציה מאחזרת את פרטי האבחון של נתב Thread כהורה.

פרטים

פרמטרים

`[in] aInstance`	מצביע למופע של OpenThread.
`[out] aParentInfo`	מצביע למקום שבו ממוקם המידע של הנתב הראשי.

otThreadGetParentLastRssi

otError otThreadGetParentLastRssi(
  otInstance *aInstance,
  int8_t *aLastRssi
)

הפונקציה מאחזרת את ה-RSSI של החבילה האחרונה מההורה של ה-thread.

פרטים

פרמטרים

`[in] aInstance`	מצביע למופע של OpenThread.
`[out] aLastRssi`	מצביע למקום שבו יש להוסיף את ה-RSSI האחרון.

ערכים מוחזרים

`OT_ERROR_NONE`	נתוני ה-RSSI אוחזרו בהצלחה.
`OT_ERROR_FAILED`	לא ניתן לקבל נתוני RSSI.
`OT_ERROR_INVALID_ARGS`	הערך של `aLastRssi` הוא NULL.

otThreadGetPartitionId

uint32_t otThreadGetPartitionId(
  otInstance *aInstance
)

מוצאים את מזהה המחיצה.

פרטים

פרמטרים

[in] aInstance

מצביע למופע של OpenThread.

החזרות

מזהה המחיצה

otThreadGetRealmLocalAllThreadNodesMulticastAddress

const otIp6Address * otThreadGetRealmLocalAllThreadNodesMulticastAddress(
  otInstance *aInstance
)

מקבל את כתובת השידור לכולם של Thread Realm-Local All Thread Nodes.

הכתובת היא כתובת מקומית של Multicast המבוססת על קידומת Unicast [RFC 3306], עם:

flgs מוגדר ל-3 (P = 1 ו-T = 1)
scop מוגדר ל-3
מוגדר ל-64
קידומת הרשת מוגדרת לקידומת מקומית של רשת
מזהה הקבוצה הוגדר ל-1

פרטים

פרמטרים

[in] aInstance

מצביע למופע של OpenThread.

החזרות

הפניה לכתובת מרובת שידורים של Thread Realm-Local All Thread Nodes.

otThreadGetRloc

const otIp6Address * otThreadGetRloc(
  otInstance *aInstance
)

קבלת הכתובת של Thread Routing Locator (RLOC).

פרטים

פרמטרים

[in] aInstance

מצביע למופע של OpenThread.

החזרות

הפניה לכתובת של מאתר ניתוב השרשורים (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 לשירות. הערך לא חייב להיות NULL.

ערכים מוחזרים

`OT_ERROR_NONE`	אוחזר ה-ALOC של השירות בהצלחה.
`OT_ERROR_DETACHED`	הממשק של ה-Thread לא מצורף כרגע למחיצת Thread.

otThreadGetTimeInQueueHistogram

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

הפונקציה מקבלת את ההיסטוגרמה של הכניסה לתור עבור הודעות בתור ב-TX.

נדרש OPENTHREAD_CONFIG_TX_QUEUE_STATISTICS_ENABLE.

נאספת ההיסטוגרמה של תור ההודעות בתור השידור. משך הזמן בתור לשידור ישיר בלבד נמדד כמשך הזמן מהמועד שבו ההודעה מתווספת לתור השידור ועד שהיא מועברת לשכבת MAC בשידור או מוסרת.

ההיסטוגרמה מוחזרת כמערך של ערכי uint32_t עם רשומות aNumBins. הערך הראשון במערך (באינדקס 0) מייצג את מספר ההודעות שהזמן שלהן לתור נמוך מ-aBinInterval. הרשומה השנייה מייצגת את מספר ההודעות שזמן הצפייה שלהן בתור גדול מ-aBinInterval או שווה לו, אבל קטן מ-2 * aBinInterval. וכן הלאה. הערך האחרון מייצג את מספר ההודעות שהזמן שלהן בתור גדול מ-(aNumBins - 1) * aBinInterval או שווה לו.

ניתן לאפס את הנתונים הסטטיסטיים שנאספו על ידי קריאה ל-otThreadResetTimeInQueueStat(). פרטי ההיסטוגרמה נאספים מאז שמופע OpenThread אותחל, או מאז הפעם האחרונה שאיסוף הנתונים הסטטיסטיים אופס על ידי קריאה ל-otThreadResetTimeInQueueStat().

הערכים של המצביעים aNumBins ו-aBinInterval לא יכולים להיות NULL.

פרטים

פרמטרים

`[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
)

קבלת הגרסה של פרוטוקול ה-Thread.

פרטים
החזרות	את הגרסה של פרוטוקול ה-Thread.

otThreadIsAnycastLocateInProgress

bool otThreadIsAnycastLocateInProgress(
  otInstance *aInstance
)

מציין אם בקשת איתור מסוג anycast מתבצעת כעת.

זמין רק כאשר OPENTHREAD_CONFIG_TMF_ANYCAST_LOCATOR_ENABLE מופעל.

פרטים

פרמטרים

[in] aInstance

מצביע למופע של OpenThread.

החזרות

TRUE אם בקשת איתור מסוג Anycast מתבצעת כעת, FALSE אם לא.

otThreadIsDiscoverInProgress

bool otThreadIsDiscoverInProgress(
  otInstance *aInstance
)

המדיניות קובעת אם מתבצע כרגע תהליך גילוי של שרשור MLE.

פרטים

פרמטרים

[in] aInstance

מצביע למופע של OpenThread.

otThreadIsSingleton

bool otThreadIsSingleton(
  otInstance *aInstance
)

מציין אם צומת הוא הנתב היחיד ברשת.

פרטים

פרמטרים

[in] aInstance

מצביע למופע של OpenThread.

ערכים מוחזרים

`TRUE`	זהו הנתב היחיד ברשת.
`FALSE`	מדובר במכשיר צאצא או שאינו נתב יחיד ברשת.

otThreadLocateAnycastDestination

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

מבקש לאתר את היעד הקרוב ביותר של כתובת anycast נתונה.

זמין רק כאשר OPENTHREAD_CONFIG_TMF_ANYCAST_LOCATOR_ENABLE מופעל.

אם יש בקשה קיימת שכבר מתבצעת, קריאה נוספת לפונקציה הזו תבטל ותחליף את הבקשה הקודמת.

פרטים

פרמטרים

`[in] aInstance`	מצביע למופע של OpenThread.
`[in] aAnycastAddress`	כתובת ה-Anycast שיש לאתר. הערך לא חייב להיות NULL.
`[in] aCallback`	פונקציית הקריאה החוזרת כדי לדווח על התוצאה.
`[in] aContext`	הקשר שרירותי שנעשה בו שימוש עם `aCallback`.

ערכים מוחזרים

`OT_ERROR_NONE`	הבקשה התחילה בהצלחה. המערכת תפעיל את `aCallback` כדי לדווח על התוצאה.
`OT_ERROR_INVALID_ARGS`	הערך `aAnycastAddress` אינו כתובת anycast חוקית או הערך `aCallback` הוא NULL.
`OT_ERROR_NO_BUFS`	אין מאגר נתונים זמני להכנה ושליחה של הודעת הבקשה.

otThreadRegisterParentResponseCallback

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

רישום קריאה חוזרת (callback) לקבלת נתוני תגובת הורה ב-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
)

איפוס מוני ה-MLE של Thread.

פרטים

פרמטרים

[in] aInstance

מצביע למופע של OpenThread.

otThreadResetTimeInQueueStat

void otThreadResetTimeInQueueStat(
  otInstance *aInstance
)

איפוס הנתונים הסטטיסטיים של תור ה-TX.

נדרש OPENTHREAD_CONFIG_TX_QUEUE_STATISTICS_ENABLE.

פרטים

פרמטרים

[in] aInstance

מצביע למופע של OpenThread.

otThreadSearchForBetterParent

otError otThreadSearchForBetterParent(
  otInstance *aInstance
)

הפעלת התהליך שבו הילד או הילדה מחפשים הורה טוב יותר, בלי קשר להורה הנוכחי.

חובה להשתמש במכשיר כשהוא מחובר לילדים.

פרטים

ערכים מוחזרים

`OT_ERROR_NONE`	התחלת תהליך החיפוש של הורה מתאים יותר.
`OT_ERROR_INVALID_STATE`	תפקיד המכשיר אינו ילד.

otThreadSendAddressNotification

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

שולח הודעה מסוג 'התראה יזומה על כתובת' ((IMAGE_NTF.ntf).

זמין רק כאשר OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE מופעל.

פרטים

פרמטרים

`[in] aInstance`	מצביע למופע של OpenThread.
`[in] aDestination`	היעד לשליחת ההודעה IMAGE_NTF.ntf.
`[in] aTarget`	כתובת היעד של ההודעה זאת_NTF.ntf.
`[in] aMlIid`	ה-ML-IID של ההודעה זאת_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`	הפניה לפונקציה מופעלת כאשר מתקבלת התגובה 'קבלת ניתוח רשת', או 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.

otThreadSendProactiveBackboneNotification

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

שולח הודעה יזומה של Backbone Notification (PRO_BB.ntf) בקישור Backbone.

זמין רק כאשר 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
)

מגדירה את הזמן הקצוב לתפוגה של צאצאים ב-Thread (בשניות) לשימוש בתפקיד 'צאצא'.

פרטים

פרמטרים

`[in] aInstance`	מצביע למופע של OpenThread.
`[in] aTimeout`	ערך הזמן הקצוב לתפוגה בשניות.

כדאי לעיין גם במאמרים הבאים:
otThreadGetChildTimeout

otThreadSetDiscoveryRequestCallback

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

הגדרת קריאה חוזרת (callback) לקבלת נתוני בקשה מסוג MLE Discovery.

פרטים

פרמטרים

`[in] aInstance`	מצביע למופע של OpenThread.
`[in] aCallback`	הפניה לפונקציה מופעלת בזמן קבלת הודעת בקשה מסוג MLE Discovery.
`[in] aContext`	הפניה להקשר ספציפי לאפליקציה של הקריאה החוזרת (callback).

otThreadSetDomainName

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

מגדיר את שם הדומיין לשרשורים.

ההעלאה תתבצע רק כשהפרוטוקולים של השרשורים מושבתים.

פרטים

פרמטרים

`[in] aInstance`	מצביע למופע של OpenThread.
`[in] aDomainName`	לחיצה על שם הדומיין של השרשור.

ערכים מוחזרים

`OT_ERROR_NONE`	שם הדומיין של ה-thread הוגדר בהצלחה.
`OT_ERROR_INVALID_STATE`	הפרוטוקולים של השרשור מופעלים.

למידע נוסף:
otThreadGetDomainName

otThreadSetEnabled

otError otThreadSetEnabled(
  otInstance *aInstance,
  bool aEnabled
)

התחלת הפעולה של פרוטוקול השרשור.

הממשק חייב להיות פעיל בזמן הקריאה לפונקציה הזו.

קריאה לפונקציה הזו כאשר aEnabled מוגדר ל-FALSE תגרום להפסקת כל התהליכים המתמשכים של ניתוק שהופעלו על ידי otThreadDetachGracefully(). הקריאה החוזרת (callback) תבוצע.

פרטים

פרמטרים

`[in] aInstance`	מצביע למופע של OpenThread.
`[in] aEnabled`	TRUE אם פרוטוקול Thread מופעל, אחרת FALSE.

ערכים מוחזרים

`OT_ERROR_NONE`	הפעולה של פרוטוקול השרשור התחילה.
`OT_ERROR_INVALID_STATE`	ממשק הרשת לא פעל.

otThreadSetExtendedPanId

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

מגדיר את IEEE 802.15.4 Extended PAN ID.

פרטים

פרמטרים

`[in] aInstance`	מצביע למופע של OpenThread.
`[in] aExtendedPanId`	מצביע על המזהה IEEE 802.15.4 של מספר ה-PAN המורחב.

ערכים מוחזרים

`OT_ERROR_NONE`	המזהה של מספר ה-PAN המורחב הוגדר בהצלחה.
`OT_ERROR_INVALID_STATE`	הפרוטוקולים של השרשור מופעלים.

כדאי לעיין גם בנתונים:
otThreadGetExtendedPanId

otThreadSetFixedDuaInterfaceIdentifier

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

מגדירה או מנקה את מזהה הממשק שצוין באופן ידני עבור כתובת Unicast של הדומיין לשרשורים.

זמין כאשר OPENTHREAD_CONFIG_DUA_ENABLE מופעל.

פרטים

פרמטרים

`[in] aInstance`	מצביע למופע של OpenThread.
`[in] aIid`	מצביע על מזהה הממשק שצריך להגדיר, או NULL כדי למחוק.

ערכים מוחזרים

`OT_ERROR_NONE`	מזהה הממשק הוגדר/נוקה בהצלחה.
`OT_ERROR_INVALID_ARGS`	מזהה הממשק שצוין שמור.

ראו גם:
otThreadGetFixedDuaInterfaceIdentifier

otThreadSetJoinerAdvertisement

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

מגדיר את הפרסומת של מחבר ה-Thread בזמן גילוי רשת Thread.

המטרה של מודעה להצטרפות לשרשורים היא לאפשר למחבר לפרסם מידע ספציפי לאפליקציה שלו (כגון מזהה ספק, מזהה מוצר, דיסקרימינטור וכו') באמצעות TLV של פרסומת לאיחוד שרשורים, כדי שהמידע הזה יהיה זמין לנציבים או למועמדים לנציבות, ללא התערבות אנושית.

פרטים

פרמטרים

`[in] aInstance`	מצביע למופע של OpenThread.
`[in] aOui`	ערך ה-IEEE OUI של הספק שייכלל בפרסומת של המארגן. המערכת תשתמש רק בשלושת הבייטים המשמעותיים ביותר, והמערכת תתעלם מהבייטים המשמעותיים ביותר.
`[in] aAdvData`	הפניה ל-AdvData שייכלל בפרסומת של המארגן.
`[in] aAdvDataLength`	האורך של AdvData בבייטים.

ערכים מוחזרים

`OT_ERROR_NONE`	פרסומת ההצטרפות הוגדרה בהצלחה.
`OT_ERROR_INVALID_ARGS`	נתוני AdvData לא חוקיים.

otThreadSetKeySequenceCounter

void otThreadSetKeySequenceCounter(
  otInstance *aInstance,
  uint32_t aKeySequenceCounter
)

מגדיר את thrKeySequenceCounter.

פרטים

פרמטרים

`[in] aInstance`	מצביע למופע של OpenThread.
`[in] aKeySequenceCounter`	הערך thrKeySequenceCounter.

ראו גם:
otThreadGetKeySequenceCounter

otThreadSetKeySwitchGuardTime

void otThreadSetKeySwitchGuardTime(
  otInstance *aInstance,
  uint32_t aKeySwitchGuardTime
)

מגדיר את thrKeySwitchGuardTime (בשעות).

פרטים

פרמטרים

`[in] aInstance`	מצביע למופע של OpenThread.
`[in] aKeySwitchGuardTime`	ערך thrKeySwitchGuardTime (בשעות).

ראו גם:
otThreadGetKeySwitchGuardTime

otThreadSetLinkMode

otError otThreadSetLinkMode(
  otInstance *aInstance,
  otLinkModeConfig aConfig
)

הגדרת ההגדרה של מצב קישור MLE.

פרטים

פרמטרים

`[in] aInstance`	מצביע למופע של OpenThread.
`[in] aConfig`	מצביע על ההגדרה של מצב קישור.

ערכים מוחזרים

OT_ERROR_NONE

ההגדרה של מצב קישור MLE הוגדרה בהצלחה.

למידע נוסף:
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
)

מגדירים את Thread Network Key.

פרטים

פרמטרים

`[in] aInstance`	מצביע למופע של OpenThread.
`[in] aKey`	הפניה למאגר אחסון שמכיל את מפתח Thread Network.

ערכים מוחזרים

`OT_ERROR_NONE`	מפתח הרשת של Thread הוגדר בהצלחה.
`OT_ERROR_INVALID_STATE`	הפרוטוקולים של השרשור מופעלים.

כדאי לעיין גם במאמרים הבאים:
otThreadGetNetworkKey

otThreadSetNetworkKeyRef

otError otThreadSetNetworkKeyRef(
  otInstance *aInstance,
  otNetworkKeyRef aKeyRef
)

מגדירים את Thread Network Key כ-otNetworkKeyRef.

כדי להשתמש בתכונה 'זמן build' צריך להפעיל את OPENTHREAD_CONFIG_PLATFORM_KEY_REFERENCES_ENABLE.

פרטים

פרמטרים

`[in] aInstance`	מצביע למופע של OpenThread.
`[in] aKeyRef`	הפניה למפתח Thread Network.

ערכים מוחזרים

`OT_ERROR_NONE`	מפתח הרשת של Thread הוגדר בהצלחה.
`OT_ERROR_INVALID_STATE`	הפרוטוקולים של השרשור מופעלים.

כדאי לעיין גם במקורות הבאים:
otThreadGetNetworkKeyRef

otThreadSetNetworkName

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

הגדרת השם של פרוטוקול Thread Network.

פרטים

פרמטרים

`[in] aInstance`	מצביע למופע של OpenThread.
`[in] aNetworkName`	מצביע ל-Thread Network Name.

ערכים מוחזרים

`OT_ERROR_NONE`	השם של רשת Thread הוגדר בהצלחה.
`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). האורך המקסימלי לא כולל את התו \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). האורך המקסימלי לא כולל את התו \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). האורך המקסימלי לא כולל את התו \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_LENGTH

 OT_JOINER_ADVDATA_MAX_LENGTH 64

משך מקסימלי של AdvData של פרסומת מאחד השותפים.

OT_NEIGHBOR_INFO_ITERATOR_INIT

 OT_NEIGHBOR_INFO_ITERATOR_INIT 0

מאתחל עבור otNeighborInfoIterator.

OT_NETWORK_BASE_TLV_MAX_LENGTH

 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_LENGTH

 OT_NETWORK_DIAGNOSTIC_MAX_THREAD_STACK_VERSION_TLV_LENGTH 64

אורך מקסימלי של TLV לגרסת Thread Stack.

OT_NETWORK_DIAGNOSTIC_MAX_VENDOR_MODEL_TLV_LENGTH

 OT_NETWORK_DIAGNOSTIC_MAX_VENDOR_MODEL_TLV_LENGTH 32

האורך המקסימלי של דגם הספק TLV.

OT_NETWORK_DIAGNOSTIC_MAX_VENDOR_NAME_TLV_LENGTH

 OT_NETWORK_DIAGNOSTIC_MAX_VENDOR_NAME_TLV_LENGTH 32

אורך מקסימלי של שם הספק TLV.

OT_NETWORK_DIAGNOSTIC_MAX_VENDOR_SW_VERSION_TLV_LENGTH

 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. אפשר לקרוא מידע נוסף או לתרום למסמכי התיעוד שלנו בדף מקורות מידע.