נתב/מנהיג

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

סיכום

ספירות
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 כדי לציין שינויים בטבלת השכנים.
otPowerSupply{
  OT_POWER_SUPPLY_BATTERY = 0,
  OT_POWER_SUPPLY_EXTERNAL = 1,
  OT_POWER_SUPPLY_EXTERNAL_STABLE = 2,
  OT_POWER_SUPPLY_EXTERNAL_UNSTABLE = 3
} 		טיפוסים בני מנייה (enum)
מייצג את מאפיין אספקת החשמל במכשיר.

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

פונקציות
otThreadBecomeLeader(otInstance *aInstance)
תוכלו להפוך למנהיגים ולהתחיל מחיצה חדשה.
otThreadBecomeRouter(otInstance *aInstance)
כדאי לנסות להפוך לנתב.
otThreadGetAdvertisementTrickleIntervalMax(otInstance *aInstance)
uint32_t
הפונקציה מקבלת את הערך הנוכחי של מרווח הזמן המקסימלי שבו נעשה שימוש בטיימר לטפטוף הפרסומת.
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 הבאה (באמצעות איטרטור) לילד נתון.
otThreadGetChildRouterLinks(otInstance *aInstance)
uint8_t
צריך לקבל את הפרמטר MLE_CHILD_ROUTER_LINKS שמשמש בתפקיד REED.
otThreadGetContextIdReuseDelay(otInstance *aInstance)
uint32_t
מקבלים את הפרמטר CONTEXT_ID_REUSE_Shift שבו נעשה שימוש בתפקיד 'מוביל'.
otThreadGetDeviceProperties(otInstance *aInstance)
מאתרים את מאפייני המכשיר הנוכחיים.
otThreadGetJoinerUdpPort(otInstance *aInstance)
uint16_t
מקבל את יציאת ה-UDP למחבר.
otThreadGetLocalLeaderWeight(otInstance *aInstance)
uint8_t
קבלת משקל מוביל ה-Thread בזמן מילוי תפקיד המוביל.
otThreadGetMaxAllowedChildren(otInstance *aInstance)
uint16_t
הפונקציה מקבלת את מספר הילדים המקסימלי המותר כרגע.
otThreadGetMaxChildIpAddresses(otInstance *aInstance)
uint8_t
הפונקציה מקבלת את המספר המקסימלי של כתובות IP שכל צאצא של MTD יכול לרשום במכשיר הזה כהורה.
otThreadGetMaxRouterId(otInstance *aInstance)
uint8_t
הפונקציה מחזירה את מזהה הנתב המקסימלי המותר.
otThreadGetNetworkIdTimeout(otInstance *aInstance)
uint8_t
כדי לקבל את הפרמטר NETWORK_ID_TIMEOUT.
otThreadGetNextCacheEntry(otInstance *aInstance, otCacheEntryInfo *aEntryInfo, otCacheEntryIterator *aIterator)
מקבלת את הערך הבא של מטמון EID (באמצעות איטרטור).
otThreadGetNextHopAndPathCost(otInstance *aInstance, uint16_t aDestRloc16, uint16_t *aNextHopRloc16, uint8_t *aPathCost)
void
הפונקציה מקבלת את העלות של הצעד הבא ועלות הנתיב לקראת יעד נתון ב-RLOC16.
otThreadGetParentPriority(otInstance *aInstance)
int8_t
מקבלים את עדיפות ההורה שהוקצתה.
otThreadGetPreferredLeaderPartitionId(otInstance *aInstance)
uint32_t
מקבלים את מזהה המחיצה המועדף של ה-Thread Leader, שבו משתמשים בתפקיד הראשי.
otThreadGetPskc(otInstance *aInstance, otPskc *aPskc)
void
קבלת PSKc ל-Thread.
otThreadGetPskcRef(otInstance *aInstance)
קבלת הפניות מרכזיות ל-Thread PSKc.
otThreadGetRouterDowngradeThreshold(otInstance *aInstance)
uint8_t
מקבלים את הפרמטר ROUTER_DOWNGRADE_{/5} המשמש בתפקיד הנתב.
otThreadGetRouterIdRange(otInstance *aInstance, uint8_t *aMinRouterId, uint8_t *aMaxRouterId)
void
הפונקציה מקבלת את הטווח של מזהי הנתבים שמותר להקצות לצמתים בתוך רשת ה-thread.
otThreadGetRouterIdSequence(otInstance *aInstance)
uint8_t
קבלת הרצף הנוכחי של מזהי הנתב.
otThreadGetRouterInfo(otInstance *aInstance, uint16_t aRouterId, otRouterInfo *aRouterInfo)
הפונקציה שומרת את פרטי האבחון של נתב פרוטוקול Thread נתון.
otThreadGetRouterSelectionJitter(otInstance *aInstance)
uint8_t
מקבלים את הפרמטר ROUTER_SELECTION_JITTER שבו נעשה שימוש בתפקיד REED/Router.
otThreadGetRouterUpgradeThreshold(otInstance *aInstance)
uint8_t
צריך לקבל את הפרמטר ROUTER_UPGRADE_ מומלץ המשמש בתפקיד REED.
otThreadIsRouterEligible(otInstance *aInstance)
bool
האפשרות מציינת אם המכשיר מתאים לנתב או לא.
otThreadIsRouterIdAllocated(otInstance *aInstance, uint8_t aRouterId)
bool
מציין אם מזהה נתב מוקצה כרגע או לא.
otThreadRegisterNeighborTableCallback(otInstance *aInstance, otNeighborTableCallback aCallback)
void
רושמת פונקציית קריאה חוזרת בטבלת שכנה.
otThreadReleaseRouterId(otInstance *aInstance, uint8_t aRouterId)
שחרור של מזהה נתב שהוקצה על ידי המכשיר בתפקיד מוביל.
otThreadSetCcmEnabled(otInstance *aInstance, bool aEnabled)
void
המדיניות הזו קובעת אם המכשיר הוזמן באמצעות CCM.
otThreadSetChildRouterLinks(otInstance *aInstance, uint8_t aChildRouterLinks)
הגדרה של הפרמטר MLE_CHILD_ROUTER_LINKS שמשמש בתפקיד REED.
otThreadSetContextIdReuseDelay(otInstance *aInstance, uint32_t aDelay)
void
מגדירים את הפרמטר CONTEXT_ID_REUSE_MENT שבו נעשה שימוש בתפקיד 'מוביל'.
otThreadSetDeviceProperties(otInstance *aInstance, const otDeviceProperties *aDeviceProperties)
void
הגדרה של מאפייני המכשיר שישמשו לקביעת משקל המנהיג.
otThreadSetJoinerUdpPort(otInstance *aInstance, uint16_t aJoinerUdpPort)
מגדיר את יציאת ה-UDP של המחבר.
otThreadSetLocalLeaderWeight(otInstance *aInstance, uint8_t aWeight)
void
הגדרת המשקל של מוביל ה-Thread בזמן מילוי תפקיד המוביל.
otThreadSetMaxAllowedChildren(otInstance *aInstance, uint16_t aMaxChildren)
הגדרה של מספר הילדים המקסימלי שמותר להוסיף כרגע.
otThreadSetMaxChildIpAddresses(otInstance *aInstance, uint8_t aMaxIpAddresses)
קובעת או משחזרת את המספר המקסימלי של כתובות IP שכל צאצא של MTD יכול לרשום במכשיר הזה כהורה.
otThreadSetNetworkIdTimeout(otInstance *aInstance, uint8_t aTimeout)
void
מגדירים את הפרמטר NETWORK_ID_TIMEOUT.
otThreadSetParentPriority(otInstance *aInstance, int8_t aParentPriority)
מגדירים את עדיפות ההורה.
otThreadSetPreferredLeaderPartitionId(otInstance *aInstance, uint32_t aPartitionId)
void
צריך להגדיר את מזהה המחיצה המועדף של ה-Thread Leader, שבו ייעשה שימוש בתפקיד הראשי.
otThreadSetPreferredRouterId(otInstance *aInstance, uint8_t aRouterId)
מגדירים את מזהה הנתב המועדף.
otThreadSetPskc(otInstance *aInstance, const otPskc *aPskc)
הגדרת ה-Thread PSKc.
otThreadSetPskcRef(otInstance *aInstance, otPskcRef aKeyRef)
מגדירים את ה-Key Reference ל-PSKc של ה-Thread.
otThreadSetRouterDowngradeThreshold(otInstance *aInstance, uint8_t aThreshold)
void
מגדירים את הפרמטר ROUTER_DOWNGRADE_MINUTES שמשמש לתפקיד 'מוביל'.
otThreadSetRouterEligible(otInstance *aInstance, bool aEligible)
ההגדרה קובעת אם המכשיר מתאים לנתב או לא.
otThreadSetRouterIdRange(otInstance *aInstance, uint8_t aMinRouterId, uint8_t aMaxRouterId)
מגדירה את הטווח של מזהי הנתבים שמותר להקצות לצמתים בתוך רשת ה-thread.
otThreadSetRouterSelectionJitter(otInstance *aInstance, uint8_t aRouterJitter)
void
הגדרת הפרמטר ROUTER_SELECTION_JITTER שבו נעשה שימוש בתפקיד REED/Router.
otThreadSetRouterUpgradeThreshold(otInstance *aInstance, uint8_t aThreshold)
void
מגדירים את הפרמטר ROUTER_UPGRADE_ מומלץ לתפקיד 'מוביל'.
otThreadSetSteeringData(otInstance *aInstance, const otExtAddress *aExtAddress)
void
הגדרת נתוני היגוי מחוץ למסגרת.
otThreadSetThreadVersionCheckEnabled(otInstance *aInstance, bool aEnabled)
void
המדיניות הזו קובעת אם סף גרסת ה-TLV לניתוב (שדה VR) מופעל.

מבנים
otCacheEntryInfo

מייצג ערך של מטמון EID.

otCacheEntryIterator

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

otChildInfo

מכיל פרטי אבחון של Thread צאצא.

otDeviceProperties

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

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

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

otPowerSupply

 otPowerSupply

מייצג את מאפיין אספקת החשמל במכשיר.

משמש כמאפיין ב-otDeviceProperties לחישוב המשקל המוביל.

תכונות
OT_POWER_SUPPLY_BATTERY

מופעל על ידי סוללה.

OT_POWER_SUPPLY_EXTERNAL

מופעל באופן חיצוני (מופעל על ידי חיבור ראשי).

OT_POWER_SUPPLY_EXTERNAL_STABLE

הספק חיצוני יציב עם גיבוי סוללה או UPS.

OT_POWER_SUPPLY_EXTERNAL_UNSTABLE

חשמל חיצוני שעלול להיות לא יציב (למשל, נורה שמופעלת באמצעות מתג).

ערכי דף

otCacheEntryInfo

struct otCacheEntryInfo otCacheEntryInfo

מייצג ערך של מטמון EID.

otCacheEntryIterator

struct otCacheEntryIterator otCacheEntryIterator

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

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

otCacheEntryState

enum otCacheEntryState otCacheEntryState

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

otChildIp6AddressIterator

uint16_t otChildIp6AddressIterator

משמש לאחזור דרך כתובות IPv6 של רשומת Thread צאצא.

otDeviceProperties

struct otDeviceProperties otDeviceProperties

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

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

mIsUnstable מציין את היציבות התפעולית של המכשיר ונקבע באמצעות מנגנון ספציפי של ספק. הוא יכול לכלול את המקרים הבאים:

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

otNeighborTableCallback

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

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

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

פונקציות

otThreadBecomeLeader

otError otThreadBecomeLeader(
  otInstance *aInstance
)

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

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

otThreadBecomeRouter

otError otThreadBecomeRouter(
  otInstance *aInstance
)

כדאי לנסות להפוך לנתב.

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

otThreadGetAdvertisementTrickleIntervalMax

uint32_t otThreadGetAdvertisementTrickleIntervalMax(
  otInstance *aInstance
)

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

ל-API הזה נדרש שימוש ב-OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE והוא מיועד לבדיקה בלבד.

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

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 מחוץ לטווח (גבוה מהערך המקסימלי לטבלה).
כדאי לעיין גם:
otGetMaxAllowedChildren

otThreadGetChildNextIp6Address

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 

uint8_t otThreadGetChildRouterLinks(
  otInstance *aInstance
)

צריך לקבל את הפרמטר MLE_CHILD_ROUTER_LINKS שמשמש בתפקיד REED.

הפרמטר הזה מציין את המספר המקסימלי של נתבים קרובים שהמכשיר (כ-FED) ינסה ליצור אליהם קישור.

פרטים
פרמטרים
[in] aInstance
מצביע למופע של OpenThread.
החזרות
הערך MLE_CHILD_ROUTER_LINKS.
כדאי לעיין גם במאמרים הבאים:
otThreadSetChildRouterLinks

otThreadGetContextIdReuseDelay

uint32_t otThreadGetContextIdReuseDelay(
  otInstance *aInstance
)

מקבלים את הפרמטר CONTEXT_ID_REUSE_Shift שבו נעשה שימוש בתפקיד 'מוביל'.

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

otThreadGetDeviceProperties

const otDeviceProperties * otThreadGetDeviceProperties(
  otInstance *aInstance
)

מאתרים את מאפייני המכשיר הנוכחיים.

נדרש OPENTHREAD_CONFIG_MLE_DEVICE_PROPERTY_LEADER_WEIGHT_ENABLE.

פרטים
החזרות
מאפייני המכשיר: otDeviceProperties.

otThreadGetJoinerUdpPort

uint16_t otThreadGetJoinerUdpPort(
  otInstance *aInstance
)

מקבל את יציאת ה-UDP למחבר.

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

otThreadGetLocalLeaderWeight

uint8_t otThreadGetLocalLeaderWeight(
  otInstance *aInstance
)

קבלת משקל מוביל ה-Thread בזמן מילוי תפקיד המוביל.

פרטים
פרמטרים
[in] aInstance
מצביע למופע של OpenThread.
החזרות
ערך המשקל של מוביל ה-thread.
ראו גם:
otThreadSetLeader weight
otThreadSetDeviceProperties

otThreadGetMaxAllowedChildren

uint16_t otThreadGetMaxAllowedChildren(
  otInstance *aInstance
)

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

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

otThreadGetMaxChildIpAddresses

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_TIMEOUT.

פרטים
פרמטרים
[in] aInstance
מצביע למופע של OpenThread.
החזרות
הערך NETWORK_ID_TIMEOUT.
כדאי לעיין גם בנתונים:
otThreadSetNetworkIdTimeout

otThreadGetNextCacheEntry

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

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

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

otThreadGetNextHopAndPathCost

void otThreadGetNextHopAndPathCost(
  otInstance *aInstance,
  uint16_t aDestRloc16,
  uint16_t *aNextHopRloc16,
  uint8_t *aPathCost
)

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

אפשר להשתמש בפונקציה הזו כאשר הערך של aNextHopRloc16 או של aPathCost הוא NULL, כדי לציין שהמתקשר לא רוצה לקבל את הערך.

פרטים
פרמטרים
[in] aInstance
מצביע למופע של OpenThread.
[in] aDestRloc16
ה-RLOC16 של היעד.
[out] aNextHopRloc16
מצביע להחזרת RLOC16 של הצעד הבא, 0xfffe אם אין צעד הבא.
[out] aPathCost
סמן להחזרת עלות הנתיב עד ליעד.

otThreadGetParentPriority

int8_t otThreadGetParentPriority(
  otInstance *aInstance
)

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

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

otThreadGetPreferredLeaderPartitionId

uint32_t otThreadGetPreferredLeaderPartitionId(
  otInstance *aInstance
)

מקבלים את מזהה המחיצה המועדף של ה-Thread Leader, שבו משתמשים בתפקיד הראשי.

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

otThreadGetPskc

void otThreadGetPskc(
  otInstance *aInstance,
  otPskc *aPskc
)

קבלת PSKc ל-Thread.

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

otThreadGetPskcRef

otPskcRef otThreadGetPskcRef(
  otInstance *aInstance
)

קבלת הפניות מרכזיות ל-Thread PSKc.

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

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

otThreadGetRouterDowngradeThreshold

uint8_t otThreadGetRouterDowngradeThreshold(
  otInstance *aInstance
)

מקבלים את הפרמטר ROUTER_DOWNGRADE_{/5} המשמש בתפקיד הנתב.

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

otThreadGetRouterIdRange

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

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

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

otThreadGetRouterIdSequence

uint8_t otThreadGetRouterIdSequence(
  otInstance *aInstance
)

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

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

otThreadGetRouterInfo

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

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

פרטים
פרמטרים
[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_SELECTION_JITTER שבו נעשה שימוש בתפקיד REED/Router.

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

otThreadGetRouterUpgradeThreshold

uint8_t otThreadGetRouterUpgradeThreshold(
  otInstance *aInstance
)

צריך לקבל את הפרמטר ROUTER_UPGRADE_ מומלץ המשמש בתפקיד REED.

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

otThreadIsRouterEligible

bool otThreadIsRouterEligible(
  otInstance *aInstance
)

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

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

otThreadIsRouterIdAllocated

bool otThreadIsRouterIdAllocated(
  otInstance *aInstance,
  uint8_t aRouterId
)

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

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

otThreadRegisterNeighborTableCallback

void otThreadRegisterNeighborTableCallback(
  otInstance *aInstance,
  otNeighborTableCallback aCallback
)

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

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

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

פרטים
פרמטרים
[in] aInstance
מצביע למופע של OpenThread.
[in] aCallback
מצביע לפונקציית handler של קריאה חוזרת (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. 
otError otThreadSetChildRouterLinks(
  otInstance *aInstance,
  uint8_t aChildRouterLinks
)

הגדרה של הפרמטר MLE_CHILD_ROUTER_LINKS שמשמש בתפקיד REED.

פרטים
פרמטרים
[in] aInstance
מצביע למופע של OpenThread.
[in] aChildRouterLinks
הערך MLE_CHILD_ROUTER_LINKS.
ערכים מוחזרים
OT_ERROR_NONE
הערך הוגדר בהצלחה.
OT_ERROR_INVALID_STATE
הפרוטוקולים של השרשור מופעלים.
כדאי לעיין גם במאמרים הבאים:
otThreadGetChildRouterLinks

otThreadSetContextIdReuseDelay

void otThreadSetContextIdReuseDelay(
  otInstance *aInstance,
  uint32_t aDelay
)

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

פרטים
פרמטרים
[in] aInstance
מצביע למופע של OpenThread.
[in] aDelay
הערך CONTEXT_ID_REUSE_SERVICE.
כדאי לעיין גם בנתונים:
otThreadGetContextIdReuseDelay

otThreadSetDeviceProperties

void otThreadSetDeviceProperties(
  otInstance *aInstance,
  const otDeviceProperties *aDeviceProperties
)

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

נדרש OPENTHREAD_CONFIG_MLE_DEVICE_PROPERTY_LEADER_WEIGHT_ENABLE.

פרטים
פרמטרים
[in] aInstance
מצביע למופע של OpenThread.
[in] aDeviceProperties
מאפייני המכשיר.

otThreadSetJoinerUdpPort

otError otThreadSetJoinerUdpPort(
  otInstance *aInstance,
  uint16_t aJoinerUdpPort
)

מגדיר את יציאת ה-UDP של המחבר.

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

otThreadSetLocalLeaderWeight

void otThreadSetLocalLeaderWeight(
  otInstance *aInstance,
  uint8_t aWeight
)

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

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

פרטים
פרמטרים
[in] aInstance
מצביע למופע של OpenThread.
[in] aWeight
ערך המשקל של מוביל ה-thread.
לעיון גם:
otThreadGetLeaderWeight

otThreadSetMaxAllowedChildren

otError otThreadSetMaxAllowedChildren(
  otInstance *aInstance,
  uint16_t aMaxChildren
)

הגדרה של מספר הילדים המקסימלי שמותר להוסיף כרגע.

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

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

otThreadSetMaxChildIpAddresses

otError otThreadSetMaxChildIpAddresses(
  otInstance *aInstance,
  uint8_t aMaxIpAddresses
)

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

כדי לנקות את ההגדרה ולשחזר את ברירת המחדל, צריך לעבור את 0.

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

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

otThreadSetNetworkIdTimeout

void otThreadSetNetworkIdTimeout(
  otInstance *aInstance,
  uint8_t aTimeout
)

מגדירים את הפרמטר NETWORK_ID_TIMEOUT.

פרטים
פרמטרים
[in] aInstance
מצביע למופע של OpenThread.
[in] aTimeout
הערך NETWORK_ID_TIMEOUT.
כדאי לעיין גם בנתונים:
otThreadGetNetworkIdTimeout

otThreadSetParentPriority

otError otThreadSetParentPriority(
  otInstance *aInstance,
  int8_t aParentPriority
)

מגדירים את עדיפות ההורה.

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

otThreadSetPreferredLeaderPartitionId

void otThreadSetPreferredLeaderPartitionId(
  otInstance *aInstance,
  uint32_t aPartitionId
)

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

פרטים
פרמטרים
[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
)

הגדרת ה-Thread PSKc.

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

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

otThreadSetPskcRef

otError otThreadSetPskcRef(
  otInstance *aInstance,
  otPskcRef aKeyRef
)

מגדירים את ה-Key Reference ל-PSKc של ה-Thread.

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

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

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

otThreadSetRouterDowngradeThreshold

void otThreadSetRouterDowngradeThreshold(
  otInstance *aInstance,
  uint8_t aThreshold
)

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

פרטים
פרמטרים
[in] aInstance
מצביע למופע של OpenThread.
[in] aThreshold
הערך ROUTER_DOWNGRADE_MINUTES.
למידע נוסף:
otThreadGetRouterDowngradeThreshold

otThreadSetRouterEligible

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
)

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

פרטים
פרמטרים
[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_SELECTION_JITTER שבו נעשה שימוש בתפקיד REED/Router.

פרטים
פרמטרים
[in] aInstance
מצביע למופע של OpenThread.
[in] aRouterJitter
הערך ROUTER_SELECTION_JITTER.
למידע נוסף:
otThreadGetRouterSelectionJitter

otThreadSetRouterUpgradeThreshold

void otThreadSetRouterUpgradeThreshold(
  otInstance *aInstance,
  uint8_t aThreshold
)

מגדירים את הפרמטר ROUTER_UPGRADE_ מומלץ לתפקיד 'מוביל'.

פרטים
פרמטרים
[in] aInstance
מצביע למופע של OpenThread.
[in] aThreshold
הערך ROUTER_UPGRADE_MINUTES.
ראו גם:
otThreadGetRouterUpgradeThreshold

otThreadSetSteeringData

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

הגדרת נתוני היגוי מחוץ למסגרת.

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

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

otThreadSetThreadVersionCheckEnabled

void otThreadSetThreadVersionCheckEnabled(
  otInstance *aInstance,
  bool aEnabled
)

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