נתב/מנהיג

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

סיכום

מספור

otCacheEntryState טיפוסים בני מנייה (enum)
ספירה זו מגדירה את מצב הזנת המטמון של EID.
otNeighborTableEvent{
  OT_NEIGHBOR_TABLE_EVENT_CHILD_ADDED,
  OT_NEIGHBOR_TABLE_EVENT_CHILD_REMOVED,
  OT_NEIGHBOR_TABLE_EVENT_CHILD_MODE_CHANGED,
  OT_NEIGHBOR_TABLE_EVENT_ROUTER_ADDED,
  OT_NEIGHBOR_TABLE_EVENT_ROUTER_REMOVED
}
טיפוסים בני מנייה (enum)
ספירה זו מגדירה את הקבועים המשמשים ב-otNeighborTableCallback כדי לציין שינויים בטבלת השכנים.

סוג Dedef

otCacheEntryInfo Typedef
מבנה זה מייצג ערך של מטמון EID.
otCacheEntryIterator Typedef
סוג זה מייצג איטרטור המשמש איטרציה דרך הרשומות בטבלה של המטמון של EID.
otCacheEntryState Typedef
ספירה זו מגדירה את מצב הזנת המטמון של EID.
otChildIp6AddressIterator Typedef
uint16_t
משמש איטרציה באמצעות כתובות IPv6 של רשומת Thread לילדים.
otNeighborTableCallback)(otNeighborTableEvent aEvent, const otNeighborTableEntryInfo *aEntryInfo) Typedef
void(*
מצביע הפונקציה הזה נשלח כדי להודיע על שינוי בטבלת השכנים.

פונקציות

otThreadBecomeLeader(otInstance *aInstance)
להיות מנהיגים ולהתחיל מחיצה חדשה.
otThreadBecomeRouter(otInstance *aInstance)
מנסים להפוך לנתב.
otThreadGetChildInfoById(otInstance *aInstance, uint16_t aChildId, otChildInfo *aChildInfo)
הפונקציה שומרת פרטי אבחון עבור ילד מצורף על ידי מזהה הילד או ה-RLOC16 שלו.
otThreadGetChildInfoByIndex(otInstance *aInstance, uint16_t aChildIndex, otChildInfo *aChildInfo)
הפונקציה שומרת את פרטי האבחון של הילד או הילדה שנוספו לאינדקס של הטבלה הפנימית.
otThreadGetChildNextIp6Address(otInstance *aInstance, uint16_t aChildIndex, otChildIp6AddressIterator *aIterator, otIp6Address *aAddress)
הפונקציה הזו מקבלת את כתובת ה-IPv6 הבאה (באמצעות איטרטור) עבור ילד נתון.
otThreadGetContextIdReuseDelay(otInstance *aInstance)
uint32_t
קבלת הפרמטר context_ID_REUSE_PENDING המשמש בתפקיד המנהיג.
otThreadGetJoinerUdpPort(otInstance *aInstance)
uint16_t
מורידים את יציאת ה-UDP של ההצטרפות.
otThreadGetLocalLeaderWeight(otInstance *aInstance)
uint8_t
קבלת המשקל של ה-Lead Lead המשמש בתפקיד המנהיג.
otThreadGetMaxAllowedChildren(otInstance *aInstance)
uint16_t
להוסיף את המספר המרבי המותר של ילדים.
otThreadGetMaxChildIpAddresses(otInstance *aInstance)
uint8_t
הפונקציה מקבלת את המספר המקסימלי של כתובות IP שכל ילד MTD יכול לרשום במכשיר הזה כהורה.
otThreadGetMaxRouterId(otInstance *aInstance)
uint8_t
הפונקציה מחזירה את מזהה הנתב המקסימלי המותר.
otThreadGetNetworkIdTimeout(otInstance *aInstance)
uint8_t
קבל את הפרמטר NETWORK_ID_MINUTE המשמש בתפקיד הנתב.
otThreadGetNextCacheEntry(otInstance *aInstance, otCacheEntryInfo *aEntryInfo, otCacheEntryIterator *aIterator)
פונקציה זו מקבלת את רשומת המטמון הבאה של EID (באמצעות איטרטור).
otThreadGetParentPriority(otInstance *aInstance)
int8_t
קבלת העדיפות ההורים.
otThreadGetPreferredLeaderPartitionId(otInstance *aInstance)
uint32_t
קבלת המזהה המועדף של ה-Lead Leadpartion שבו משתמשים בתפקיד Leader.
otThreadGetPskc(otInstance *aInstance, otPskc *aPskc)
void
הורדה של ה-PSKC בשרשור.
otThreadGetPskcRef(otInstance *aInstance)
קבלת אחסון של מפתחות ב-Thread PSKc.
otThreadGetRouterDowngradeThreshold(otInstance *aInstance)
uint8_t
שימוש בפרמטר ROUTER_DOWNGRADE_THRESHOLD בתפקיד הנתב.
otThreadGetRouterIdRange(otInstance *aInstance, uint8_t *aMinRouterId, uint8_t *aMaxRouterId)
void
הפונקציה הזו מקבלת את טווח מזהי הנתבים שאפשר להקצות לצמתים ברשת השרשורים.
otThreadGetRouterIdSequence(otInstance *aInstance)
uint8_t
קבלת הרצף הנוכחי של מזהה הנתב.
otThreadGetRouterInfo(otInstance *aInstance, uint16_t aRouterId, otRouterInfo *aRouterInfo)
הפונקציה שומרת פרטי אבחון של נתב שרשור נתון.
otThreadGetRouterSelectionJitter(otInstance *aInstance)
uint8_t
קבלת הפרמטר ROUTER_selected_JITTER שבו נעשה שימוש בתפקיד REED/נתב.
otThreadGetRouterUpgradeThreshold(otInstance *aInstance)
uint8_t
קבלת הפרמטר ROUTER_UPGRADE_THRESHOLD שנעשה בו שימוש בתפקיד REED.
otThreadIsRouterEligible(otInstance *aInstance)
bool
השיטה הזו מציינת אם המכשיר כשיר לנתב.
otThreadRegisterNeighborTableCallback(otInstance *aInstance, otNeighborTableCallback aCallback)
void
פונקציה זו רושמת פונקציה של קריאה חוזרת בטבלה הקרובה.
otThreadReleaseRouterId(otInstance *aInstance, uint8_t aRouterId)
שחרור של מזהה נתב שהוקצה על ידי המכשיר לתפקיד 'מנהיג'.
otThreadSetCcmEnabled(otInstance *aInstance, bool aEnabled)
void
פונקציה זו קובעת אם המכשיר הוזמן באמצעות CCM.
otThreadSetContextIdReuseDelay(otInstance *aInstance, uint32_t aDelay)
void
הגדרה של הפרמטר text_ID_REUSE_PENDING המשמש בתפקיד המנהיג.
otThreadSetJoinerUdpPort(otInstance *aInstance, uint16_t aJoinerUdpPort)
מגדירים את יציאת ה-UDP של ההצטרפות.
otThreadSetLocalLeaderWeight(otInstance *aInstance, uint8_t aWeight)
void
מגדירים את משקל החוטים המובילים כשאתם פועלים בתפקיד מנהיג.
otThreadSetMaxAllowedChildren(otInstance *aInstance, uint16_t aMaxChildren)
מגדירים את מספר הילדים המרבי המותר כרגע.
otThreadSetMaxChildIpAddresses(otInstance *aInstance, uint8_t aMaxIpAddresses)
הפונקציה מגדירה או משחזרת את המספר המקסימלי של כתובות IP שכל צאצא של MTD יכול לרשום במכשיר הזה כהורה.
otThreadSetNetworkIdTimeout(otInstance *aInstance, uint8_t aTimeout)
void
הגדרה של הפרמטר NETWORK_ID_MINUTE המשמש בתפקיד המנהיג.
otThreadSetParentPriority(otInstance *aInstance, int8_t aParentPriority)
מגדירים את העדיפות של בקרת ההורים.
otThreadSetPreferredLeaderPartitionId(otInstance *aInstance, uint32_t aPartitionId)
void
עליך להגדיר את המזהה המועדף של ה-Lead Lead מחיצה המשמש בעת הפעלת התפקיד.
otThreadSetPreferredRouterId(otInstance *aInstance, uint8_t aRouterId)
מגדירים את מזהה הנתב המועדף.
otThreadSetPskc(otInstance *aInstance, const otPskc *aPskc)
מגדירים את השרשור של PSKc.
otThreadSetPskcRef(otInstance *aInstance, otPskcRef aKeyRef)
מגדירים את השרשור של PSKc.
otThreadSetRouterDowngradeThreshold(otInstance *aInstance, uint8_t aThreshold)
void
הגדרה של הפרמטר ROUTER_DOWNGRADE_THRESHOLD בתפקיד המנהיג.
otThreadSetRouterEligible(otInstance *aInstance, bool aEligible)
פונקציה זו קובעת אם המכשיר כשיר לנתב.
otThreadSetRouterIdRange(otInstance *aInstance, uint8_t aMinRouterId, uint8_t aMaxRouterId)
הפונקציה הזו מגדירה את הטווח של מזהי הנתבים שרוצים להקצות לצמתים ברשת השרשור.
otThreadSetRouterSelectionJitter(otInstance *aInstance, uint8_t aRouterJitter)
void
מגדירים את הפרמטר ROUTER_selected_JITTER שבו נעשה שימוש בתפקיד REED/נתב.
otThreadSetRouterUpgradeThreshold(otInstance *aInstance, uint8_t aThreshold)
void
הגדרה של הפרמטר ROUTER_UPGRADE_THRESHOLD לתפקיד 'מנהיג'.
otThreadSetSteeringData(otInstance *aInstance, const otExtAddress *aExtAddress)
void
הגדרת הגה תדר.
otThreadSetThreadVersionCheckEnabled(otInstance *aInstance, bool aEnabled)
void
פונקציה זו קובעת אם הערך מסוג 'סף תחתון' לגרסת אבטחה של ניתוב מדיניות (שדה VR) מופעל.

מבנים

otcacheEntryInfo

מבנה זה מייצג ערך של מטמון EID.

otCacheEntryIterator

סוג זה מייצג איטרטור המשמש איטרציה דרך הרשומות בטבלה של המטמון של EID.

otChildInfo

מבנה זה מכיל פרטי אבחון של ילד/ה של שרשור.

otNeighborTableEntryInfo

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

מספור

otCacheEntryState

 otCacheEntryState

ספירה זו מגדירה את מצב הזנת המטמון של EID.

otNeighborTableEvent

 otNeighborTableEvent

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

מאפיינים
OT_NEIGHBOR_TABLE_EVENT_CHILD_ADDED

מתבצעת הוספה של ילד/ה.

OT_NEIGHBOR_TABLE_EVENT_CHILD_MODE_CHANGED

מצב קיים של ילד משתנה.

OT_NEIGHBOR_TABLE_EVENT_CHILD_REMOVED

אנחנו מסירים ילדים.

OT_NEIGHBOR_TABLE_EVENT_ROUTER_ADDED

מתבצעת הוספה של נתב.

OT_NEIGHBOR_TABLE_EVENT_ROUTER_REMOVED

מתבצעת הסרה של נתב.

סוג Dedef

otCacheEntryInfo

struct otCacheEntryInfo otCacheEntryInfo

מבנה זה מייצג ערך של מטמון EID.

otCacheEntryIterator

struct otCacheEntryIterator otCacheEntryIterator

סוג זה מייצג איטרטור המשמש איטרציה דרך הרשומות בטבלה של המטמון של EID.

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

otCacheEntryState

enum otCacheEntryState otCacheEntryState

ספירה זו מגדירה את מצב הזנת המטמון של EID.

otChildIp6AddressIterator

uint16_t otChildIp6AddressIterator

משמש איטרציה באמצעות כתובות IPv6 של רשומת Thread לילדים.

otNeighborTableCallback

void(* otNeighborTableCallback)(otNeighborTableEvent aEvent, const otNeighborTableEntryInfo *aEntryInfo)

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

פרטים
פרמטרים
[in] aEvent
סימון אירוע.
[in] aEntryInfo
מצביע על פרטי הכניסה לטבלה.

פונקציות

otThreadedLeader

otError otThreadBecomeLeader(
  otInstance *aInstance
)

להיות מנהיגים ולהתחיל מחיצה חדשה.

פרטים
פרמטרים
[in] aInstance
מצביע על מופע של OpenThread.
ערכי החזרה
OT_ERROR_NONE
הפכה למנהיגה והתחילה מחיצה חדשה.
OT_ERROR_INVALID_STATE
השרשור מושבת.

להיכנס למסגרת

otError otThreadBecomeRouter(
  otInstance *aInstance
)

מנסים להפוך לנתב.

פרטים
פרמטרים
[in] aInstance
מצביע על מופע של OpenThread.
ערכי החזרה
OT_ERROR_NONE
ניסיון ההצטרפות לשרת הסתיים.
OT_ERROR_INVALID_STATE
השרשור מושבת.

OTThreadGetChildInfoById

otError otThreadGetChildInfoById(
  otInstance *aInstance,
  uint16_t aChildId,
  otChildInfo *aChildInfo
)

הפונקציה שומרת פרטי אבחון עבור ילד מצורף על ידי מזהה הילד או ה-RLOC16 שלו.

פרטים
פרמטרים
[in] aInstance
מצביע על מופע של OpenThread.
[in] aChildId
מזהה הצאצא או ה-RLOC16 של הילד או הילדה המצורפים.
[out] aChildInfo
מציין את המיקום שבו פרטי הילד ממוקמים.
ערכי החזרה
OT_ERROR_NONE
aChildInfo עודכן עם מידע על המזהה הנתון.
OT_ERROR_NOT_FOUND
אין ילד חוקי עם מזהה הצאצא הזה.
OT_ERROR_INVALID_ARGS
אם הערך של aChildInfo הוא NULL.

otThreadGetChildInfoByIndex

otError otThreadGetChildInfoByIndex(
  otInstance *aInstance,
  uint16_t aChildIndex,
  otChildInfo *aChildInfo
)

הפונקציה שומרת את פרטי האבחון של הילד או הילדה שנוספו לאינדקס של הטבלה הפנימית.

פרטים
פרמטרים
[in] aInstance
מצביע על מופע של OpenThread.
[in] aChildIndex
אינדקס הטבלה.
[out] aChildInfo
מציין את המיקום שבו פרטי הילד ממוקמים.
ערכי החזרה
OT_ERROR_NONE
aChildInfo עודכן בהצלחה עם המידע על האינדקס הנתון.
OT_ERROR_NOT_FOUND
אין צאצא חוקי באינדקס הזה.
OT_ERROR_INVALID_ARGS
הערך aChildInfo הוא NULL או aChildIndex מחוץ לטווח (גבוה מאינדקס הטבלה המקסימלי).
מידע נוסף:
otGetMaxAllowedChild

כתובת otThreadGetChildNextIp6p6

otError otThreadGetChildNextIp6Address(
  otInstance *aInstance,
  uint16_t aChildIndex,
  otChildIp6AddressIterator *aIterator,
  otIp6Address *aAddress
)

הפונקציה הזו מקבלת את כתובת ה-IPv6 הבאה (באמצעות איטרטור) עבור ילד נתון.

פרטים
פרמטרים
[in] aInstance
מצביע על מופע של OpenThread.
[in] aChildIndex
אינדקס הצאצא.
[in,out] aIterator
מצביע לאטרטור. לאחר ההצלחה, האיטרטור יתעדכן ויעדכן את הרשומה הבאה ברשימה. כדי לקבל את כתובת ה-IPv6 הראשונה, יש להגדיר את האיטרטור ל-OT_CHILD_IP6_ADDRESS_ITERATOR_INIT.
[out] aAddress
מצביע על כתובת IPv6 שבה נמצאת הכתובת הבאה של הילד או הילדה (בהצלחה).
ערכי החזרה
OT_ERROR_NONE
כתובת ה-IPv6 הבאה נמצאה בהצלחה (aAddress עודכנו).
OT_ERROR_NOT_FOUND
לילד אין רשומה נוספת של כתובת IPv6.
OT_ERROR_INVALID_ARGS
aIterator או aAddress אינם NULL, או שילד ב-aChildIndex אינו חוקי.
לעיון גם:
otThreadGetChildInfoByIndex

otThreadGetContextIdReuseDelay

uint32_t otThreadGetContextIdReuseDelay(
  otInstance *aInstance
)

קבלת הפרמטר context_ID_REUSE_PENDING המשמש בתפקיד המנהיג.

פרטים
פרמטרים
[in] aInstance
מצביע על מופע של OpenThread.
החזרות
הערך text_ID_REUSE_PENDING.
לעיון גם:
otThreadSetContextIdReuseDelay

OTThreadGetGeterUdpPort

uint16_t otThreadGetJoinerUdpPort(
  otInstance *aInstance
)

מורידים את יציאת ה-UDP של ההצטרפות.

פרטים
פרמטרים
[in] aInstance
מצביע על מופע של OpenThread.
החזרות
מספר ה-UDP של ג'ונר.
כאן אפשר גם לעיין:
otThreadSetMeeterUdpPort

OTGetGetLocalLeaderweight

uint8_t otThreadGetLocalLeaderWeight(
  otInstance *aInstance
)

קבלת המשקל של ה-Lead Lead המשמש בתפקיד המנהיג.

פרטים
פרמטרים
[in] aInstance
מצביע על מופע של OpenThread.
החזרות
ערך המשקל של השרשור המוביל.
מידע נוסף:
otThreadSetLeaderweight

otThreadGetMaxAllowedChild

uint16_t otThreadGetMaxAllowedChildren(
  otInstance *aInstance
)

להוסיף את המספר המרבי המותר של ילדים.

פרטים
פרמטרים
[in] aInstance
מצביע על מופע של OpenThread.
החזרות
מספר הילדים המרבי המותר כרגע.
עיינו גם:
otThreadSetMaxAllowedChild

כתובות OTThreadGetMaxChildIp

uint8_t otThreadGetMaxChildIpAddresses(
  otInstance *aInstance
)

הפונקציה מקבלת את המספר המקסימלי של כתובות IP שכל ילד MTD יכול לרשום במכשיר הזה כהורה.

פרטים
פרמטרים
[in] aInstance
מצביע על מופע של OpenThread.
החזרות
המספר המקסימלי של כתובות IP שכל חשבון MTD יכול לרשום במכשיר הזה כהורה.
כמו כן, מומלץ:
otThreadSetMaxChildIpAddresses

otThreadGetMaxRouterId

uint8_t otThreadGetMaxRouterId(
  otInstance *aInstance
)

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

פרטים
פרמטרים
[in] aInstance
מצביע על מופע של OpenThread.
החזרות
מזהה הנתב המקסימלי המותר.

otThreadGetNetworkIdTimeout

uint8_t otThreadGetNetworkIdTimeout(
  otInstance *aInstance
)

קבל את הפרמטר NETWORK_ID_MINUTE המשמש בתפקיד הנתב.

פרטים
פרמטרים
[in] aInstance
מצביע על מופע של OpenThread.
החזרות
הערך של NETWORK_ID_MINUTE.
כמו כן, יש לעיין ב:
otThreadSetNetworkIdTimeout

otThreadGetNextCacheEntry

otError otThreadGetNextCacheEntry(
  otInstance *aInstance,
  otCacheEntryInfo *aEntryInfo,
  otCacheEntryIterator *aIterator
)

פונקציה זו מקבלת את רשומת המטמון הבאה של EID (באמצעות איטרטור).

פרטים
פרמטרים
[in] aInstance
מצביע על מופע של OpenThread.
[out] aEntryInfo
מצביע אל המיקום שבו נמצאים פרטי רשומת המטמון של EID.
[in,out] aIterator
מצביע לאטרטור. הוא יתעדכן ויצביע על ההצעה הבאה להצלחה. כדי לקבל את הרשומה הראשונה, מאתחלים את האיטרטור על ידי איפוס כל השדות שלו (למשל memset מבנה האיטרטור האפס).
ערכי החזרה
OT_ERROR_NONE
השדה aEntryInfo הוזן בהצלחה עבור הרשומה הבאה במטמון ה-EID.
OT_ERROR_NOT_FOUND
אין רשומות נוספות בטבלת המטמון של הכתובות.

otThreadGetנושא עדיפות

int8_t otThreadGetParentPriority(
  otInstance *aInstance
)

קבלת העדיפות ההורים.

פרטים
פרמטרים
[in] aInstance
מצביע על מופע של OpenThread.
החזרות
הערך המועדף שהוקצה להורה, -2 פירושו שלא הוקצה.
כמו כן, מומלץ לעיין במאמרים הבאים:
otThreadSetParentPriority

OTThreadGetPreferredLeaderPARTitionId

uint32_t otThreadGetPreferredLeaderPartitionId(
  otInstance *aInstance
)

קבלת המזהה המועדף של ה-Lead Leadpartion שבו משתמשים בתפקיד Leader.

פרטים
פרמטרים
[in] aInstance
מצביע על מופע של OpenThread.
החזרות
ערך המזהה של מחיצת השרשורים.

otThreadGetPskc

void otThreadGetPskc(
  otInstance *aInstance,
  otPskc *aPskc
)

הורדה של ה-PSKC בשרשור.

פרטים
פרמטרים
[in] aInstance
מצביע על מופע של OpenThread.
[out] aPskc
מצביע ל-otPskc כדי להחזיר את השרשור PSKc שאוחזר.
לעיון גם:
otThreadSetPskc

otThreadGetPskcRef

otPskcRef otThreadGetPskcRef(
  otInstance *aInstance
)

קבלת אחסון של מפתחות ב-Thread PSKc.

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

פרטים
פרמטרים
[in] aInstance
מצביע על מופע של OpenThread.
החזרות
התייחסות מרכזית ל-PSKc
לעיון גם:
otThreadSetPskcRef

סף otThreadGetRouterDownDown

uint8_t otThreadGetRouterDowngradeThreshold(
  otInstance *aInstance
)

שימוש בפרמטר ROUTER_DOWNGRADE_THRESHOLD בתפקיד הנתב.

פרטים
פרמטרים
[in] aInstance
מצביע על מופע של OpenThread.
החזרות
הערך ROUTER_DOWNGRADE_THRESHOLD.
ראו גם:
otThreadSetRouterDowngradThreshold

otThreadGetRouterIdRange

void otThreadGetRouterIdRange(
  otInstance *aInstance,
  uint8_t *aMinRouterId,
  uint8_t *aMaxRouterId
)

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

פרטים
פרמטרים
[in] aInstance
מצביע על מופע של OpenThread.
[out] aMinRouterId
מזהה הנתב המינימלי.
[out] aMaxRouterId
מזהה הנתב המקסימלי.
לעיון גם:
otThreadSetRouterIdRange

otThreadGetRouterIdסדר

uint8_t otThreadGetRouterIdSequence(
  otInstance *aInstance
)

קבלת הרצף הנוכחי של מזהה הנתב.

פרטים
פרמטרים
[in] aInstance
מצביע על מופע של OpenThread.
החזרות
רצף מזהי הנתב.

otThreadGetRouterInfo

otError otThreadGetRouterInfo(
  otInstance *aInstance,
  uint16_t aRouterId,
  otRouterInfo *aRouterInfo
)

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

פרטים
פרמטרים
[in] aInstance
מצביע על מופע של OpenThread.
[in] aRouterId
מזהה הנתב או RLOC16 עבור נתב נתון.
[out] aRouterInfo
מצביע אל המיקום של פרטי הנתב.
ערכי החזרה
OT_ERROR_NONE
פרטי הנתב נשמרו עבור המזהה הנתון.
OT_ERROR_NOT_FOUND
אין כניסה לנתב עם המזהה הנתון.
OT_ERROR_INVALID_ARGS
aRouterInfo הוא NULL.

otThreadGetRouterSelectionJitter

uint8_t otThreadGetRouterSelectionJitter(
  otInstance *aInstance
)

קבלת הפרמטר ROUTER_selected_JITTER שבו נעשה שימוש בתפקיד REED/נתב.

פרטים
פרמטרים
[in] aInstance
מצביע על מופע של OpenThread.
החזרות
הערך ROUTER_SEATS_JITTER.
להצגת גם:
otThreadSetRouterSelectionJitter

סף otThreadGetRouter

uint8_t otThreadGetRouterUpgradeThreshold(
  otInstance *aInstance
)

קבלת הפרמטר ROUTER_UPGRADE_THRESHOLD שנעשה בו שימוש בתפקיד REED.

פרטים
פרמטרים
[in] aInstance
מצביע על מופע של OpenThread.
החזרות
הערך ROUTER_UPGRADE_THRESHOLD.
לעיון גם:
otThreadSetRouterשדרוגThreshold

פרוטוקול otThreadIsRouterכשיר

bool otThreadIsRouterEligible(
  otInstance *aInstance
)

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

פרטים
פרמטרים
[in] aInstance
מצביע על מופע של OpenThread.
ערכי החזרה
TRUE
אם המכשיר כשיר לנתב.
FALSE
אם המכשיר לא עומד בדרישות של הנתב.

otThreadenrollNeighborTableCallback

void otThreadRegisterNeighborTableCallback(
  otInstance *aInstance,
  otNeighborTableCallback aCallback
)

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

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

השיחות הבאות לשיטה זו יחליפו את השיחה הקודמת. חשוב לזכור שהקריאה החוזרת הזו מופעלת בזמן שטבלת השכנים/הילדים מתעדכנת ותמיד לפני otStateChangedCallback.

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

הפרמטר otThreadReleaseRouterId

otError otThreadReleaseRouterId(
  otInstance *aInstance,
  uint8_t aRouterId
)

שחרור של מזהה נתב שהוקצה על ידי המכשיר לתפקיד 'מנהיג'.

פרטים
פרמטרים
[in] aInstance
מצביע על מופע של OpenThread.
[in] aRouterId
מזהה הנתב שיש לשחרר. הטווח החוקי הוא [0, 62].
ערכי החזרה
OT_ERROR_NONE
מזהה הנתב הוסר בהצלחה.
OT_ERROR_INVALID_ARGS
aRouterId לא בטווח ([0, 62].
OT_ERROR_INVALID_STATE
המכשיר לא פועל כרגע כמוביל.
OT_ERROR_NOT_FOUND
מזהה הנתב לא מוקצה כרגע.

OTThreadSetCcmEnabled

void otThreadSetCcmEnabled(
  otInstance *aInstance,
  bool aEnabled
)

פונקציה זו קובעת אם המכשיר הוזמן באמצעות CCM.

פרטים
פרמטרים
[in] aInstance
מצביע על מופע של OpenThread.
[in] aEnabled
TRUE אם המכשיר הוזמן באמצעות CCM, אחרת FALSE.

OTThreadSetContextIdReuseDelay

void otThreadSetContextIdReuseDelay(
  otInstance *aInstance,
  uint32_t aDelay
)

הגדרה של הפרמטר text_ID_REUSE_PENDING המשמש בתפקיד המנהיג.

פרטים
פרמטרים
[in] aInstance
מצביע על מופע של OpenThread.
[in] aDelay
הערך text_ID_REUSE_PENDING.
להצגת גם:
otThreadGetContextIdReuseDelay

פרוטוקול otThreadSetUrpPort

otError otThreadSetJoinerUdpPort(
  otInstance *aInstance,
  uint16_t aJoinerUdpPort
)

מגדירים את יציאת ה-UDP של ההצטרפות.

פרטים
פרמטרים
[in] aInstance
מצביע על מופע של OpenThread.
[in] aJoinerUdpPort
מספר ה-UDP של ג'ונר.
ערכי החזרה
OT_ERROR_NONE
יציאת ההצטרפות של UDP של המשתמש הוגדרה בהצלחה.
כאן אפשר גם לעיין:
otThreadGetGeterUdpPort

משקל מכונה מקומי

void otThreadSetLocalLeaderWeight(
  otInstance *aInstance,
  uint8_t aWeight
)

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

פרטים
פרמטרים
[in] aInstance
מצביע על מופע של OpenThread.
[in] aWeight
ערך המשקל של השרשור המוביל.
כאן אפשר לראות גם:
otThreadGetLeaderweight

otThreadSetMaxAllowedChild

otError otThreadSetMaxAllowedChildren(
  otInstance *aInstance,
  uint16_t aMaxChildren
)

מגדירים את מספר הילדים המרבי המותר כרגע.

אפשר להגדיר את הפרמטר הזה רק כשהפעולה של פרוטוקול השרשור הופסקה.

פרטים
פרמטרים
[in] aInstance
מצביע על מופע של OpenThread.
[in] aMaxChildren
מספר הילדים המקסימלי המותר.
ערכי החזרה
OT_ERROR_NONE
הגדרת העלות המקסימלית לקליק בוצעה בהצלחה
OT_ERROR_INVALID_ARGS
אם aMaxChildren אינו בטווח [1, Openthread_CONFIG_MLE_MAX_CHILDREN].
OT_ERROR_INVALID_STATE
אם השרשור לא הופסק.
עיינו גם:
otThreadGetMaxAllowedChild

כתובות otThreadSetMaxChildIp

otError otThreadSetMaxChildIpAddresses(
  otInstance *aInstance,
  uint8_t aMaxIpAddresses
)

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

פרטים
פרמטרים
[in] aInstance
מצביע על מופע של OpenThread.
[in] aMaxIpAddresses
המספר המקסימלי של כתובות IP שכל חשבון MTD יכול לרשום במכשיר הזה כהורה. 0 כדי לנקות את ההגדרה ולשחזר את ברירת המחדל.
ערכי החזרה
OT_ERROR_NONE
המספר/המספר הוגדר בהצלחה.
OT_ERROR_INVALID_ARGS
אם הוא חורג מהמספר המרבי המותר.
כמו כן, מומלץ:
otThreadGetMaxChildIpAddress

otThreadSetNetworkIdTimeout

void otThreadSetNetworkIdTimeout(
  otInstance *aInstance,
  uint8_t aTimeout
)

הגדרה של הפרמטר NETWORK_ID_MINUTE המשמש בתפקיד המנהיג.

פרטים
פרמטרים
[in] aInstance
מצביע על מופע של OpenThread.
[in] aTimeout
הערך של NETWORK_ID_MINUTE.
כמו כן, יש לעיין ב:
otThreadGetNetworkIdTimeout

OTThreadSetעדיפות

otError otThreadSetParentPriority(
  otInstance *aInstance,
  int8_t aParentPriority
)

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

פרטים
פרמטרים
[in] aInstance
מצביע על מופע של OpenThread.
[in] aParentPriority
ערך העדיפות של ההורה.
ערכי החזרה
OT_ERROR_NONE
הגדרת העדיפות של ההורה הושלמה בהצלחה.
OT_ERROR_INVALID_ARGS
אם ערך העדיפות של ההורה אינו בין 0, 1-- ו-2.
כמו כן, מומלץ לעיין במאמרים הבאים:
otThreadGetParentPriority

OTThreadSetPreferredLeaderPartitionId

void otThreadSetPreferredLeaderPartitionId(
  otInstance *aInstance,
  uint32_t aPartitionId
)

עליך להגדיר את המזהה המועדף של ה-Lead Lead מחיצה המשמש בעת הפעלת התפקיד.

פרטים
פרמטרים
[in] aInstance
מצביע על מופע של OpenThread.
[in] aPartitionId
ערך המזהה של מחיצת השרשורים.

OTThreadSetPreferredRouterId

otError otThreadSetPreferredRouterId(
  otInstance *aInstance,
  uint8_t aRouterId
)

מגדירים את מזהה הנתב המועדף.

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

פרטים
פרמטרים
[in] aInstance
מצביע על מופע של OpenThread.
[in] aRouterId
מזהה הנתב המועדף.
ערכי החזרה
OT_ERROR_NONE
הגדרת הנתב המועדף בוצעה בהצלחה.
OT_ERROR_INVALID_STATE
לא ניתן היה להגדיר (התפקיד לא מנותק או מושבת)

OTThreadSetPskc

otError otThreadSetPskc(
  otInstance *aInstance,
  const otPskc *aPskc
)

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

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

פרטים
פרמטרים
[in] aInstance
מצביע על מופע של OpenThread.
[in] aPskc
מצביע לשרשור החדש של PSKc.
ערכי החזרה
OT_ERROR_NONE
הגדרת השרשור של PSKc הסתיימה.
OT_ERROR_INVALID_STATE
הפרוטוקולים לשרשורים מופעלים.
לעיון גם:
otThreadGetPskc

OTThreadSetPskcRef

otError otThreadSetPskcRef(
  otInstance *aInstance,
  otPskcRef aKeyRef
)

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

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

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

פרטים
פרמטרים
[in] aInstance
מצביע על מופע של OpenThread.
[in] aKeyRef
הפניה לשרשור החדש של PSKc.
ערכי החזרה
OT_ERROR_NONE
הגדרת השרשור של PSKc הסתיימה.
OT_ERROR_INVALID_STATE
הפרוטוקולים לשרשורים מופעלים.
לעיון גם:
otThreadGetPskcRef

סף otThreadSetRouterDownDown

void otThreadSetRouterDowngradeThreshold(
  otInstance *aInstance,
  uint8_t aThreshold
)

הגדרה של הפרמטר ROUTER_DOWNGRADE_THRESHOLD בתפקיד המנהיג.

פרטים
פרמטרים
[in] aInstance
מצביע על מופע של OpenThread.
[in] aThreshold
הערך ROUTER_DOWNGRADE_THRESHOLD.
להצגת גם:
otThreadGetRouterDowngradThreshold

otThreadSetRouterכשיר

otError otThreadSetRouterEligible(
  otInstance *aInstance,
  bool aEligible
)

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

אם aEligible מוגדר כ-False והמכשיר פועל כרגע כנתב, השיחה הזו תגרום למכשיר להתנתק ולחבר מחדש כילד.

פרטים
פרמטרים
[in] aInstance
מצביע על מופע של OpenThread.
[in] aEligible
TRUE כדי להגדיר את המכשיר כמתאים לנתב, אחרת FALSE.
ערכי החזרה
OT_ERROR_NONE
ההגדרה של הנתב שעומד בדרישות הסתיימה בהצלחה.
OT_ERROR_NOT_CAPABLE
המכשיר לא יכול להפוך לנתב.

OTThreadSetRouterIdRange

otError otThreadSetRouterIdRange(
  otInstance *aInstance,
  uint8_t aMinRouterId,
  uint8_t aMaxRouterId
)

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

פרטים
פרמטרים
[in] aInstance
מצביע על מופע של OpenThread.
[in] aMinRouterId
מזהה הנתב המינימלי.
[in] aMaxRouterId
מזהה הנתב המקסימלי.
ערכי החזרה
OT_ERROR_NONE
הטווח הוגדר בהצלחה.
OT_ERROR_INVALID_ARGS
aMinRouterId > aMaxRouterId או שהטווח אינו מכוסה על ידי [0, 62].
לעיון גם:
otThreadGetRouterIdRange

otThreadSetRouterSelectionJitter

void otThreadSetRouterSelectionJitter(
  otInstance *aInstance,
  uint8_t aRouterJitter
)

מגדירים את הפרמטר ROUTER_selected_JITTER שבו נעשה שימוש בתפקיד REED/נתב.

פרטים
פרמטרים
[in] aInstance
מצביע על מופע של OpenThread.
[in] aRouterJitter
הערך ROUTER_SEATS_JITTER.
לעיון גם:
otThreadGetRouterSelectionJitter

סף otThreadSetRouterשדרוג

void otThreadSetRouterUpgradeThreshold(
  otInstance *aInstance,
  uint8_t aThreshold
)

הגדרה של הפרמטר ROUTER_UPGRADE_THRESHOLD לתפקיד 'מנהיג'.

פרטים
פרמטרים
[in] aInstance
מצביע על מופע של OpenThread.
[in] aThreshold
הערך ROUTER_UPGRADE_THRESHOLD.
לעיון גם:
otThreadGetRouterשדרוגThreshold

otThreadSetSteeringData

void otThreadSetSteeringData(
  otInstance *aInstance,
  const otExtAddress *aExtAddress
)

הגדרת הגה תדר.

יש להגדיר את אפשרות התצורה OPENTHREAD_CONFIG_MLE_STEERING_DATA_SET_OOB_ENABLE כדי לאפשר הגדרה של הגה נתונים מחוץ לתדר.

פרטים
פרמטרים
[in] aInstance
מצביע על מופע של OpenThread.
[in] aExtAddress
הכתובת המשמשת לעדכון נתוני ההיגוי. לא מאפסים את נתוני ההיגוי (אין נתוני היגוי). כל ערכי 0xFF כדי להגדיר מסנן לנתוני היגוי/פריחה כדי לקבל/לאשר הכול. סביבת EUI64 ספציפית שמתווספת לאחר מכן למסנן הנוכחי של ההיגוי/ההיגוי.

OTthreadSetThreadVersionCheckEnabled

void otThreadSetThreadVersionCheckEnabled(
  otInstance *aInstance,
  bool aEnabled
)

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

פרטים
פרמטרים
[in] aInstance
מצביע על מופע של OpenThread.
[in] aEnabled
TRUE כדי להפעיל גרסת TLV של מדיניות אבטחה עבור ניתוב, אחרת FALSE.

פקודות מאקרו

OT_CHILD_IP6_ADDRESS_ITERATOR_INIT

 OT_CHILD_IP6_ADDRESS_ITERATOR_INIT 0

מאתחל עבור otChildIP6AddressIterator.

מקורות מידע

נושאי עזר של OpenThread API מגיעים מקוד המקור, שזמין ב-GitHub. למידע נוסף או כדי להוסיף מידע למסמכים שלנו, יש לעיין במשאבים.