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

Instance

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

סיכום

מיספרים

anonymous enum{
  OT_CHANGED_IP6_ADDRESS_ADDED = 1 << 0,
  OT_CHANGED_IP6_ADDRESS_REMOVED = 1 << 1,
  OT_CHANGED_THREAD_ROLE = 1 << 2,
  OT_CHANGED_THREAD_LL_ADDR = 1 << 3,
  OT_CHANGED_THREAD_ML_ADDR = 1 << 4,
  OT_CHANGED_THREAD_RLOC_ADDED = 1 << 5,
  OT_CHANGED_THREAD_RLOC_REMOVED = 1 << 6,
  OT_CHANGED_THREAD_PARTITION_ID = 1 << 7,
  OT_CHANGED_THREAD_KEY_SEQUENCE_COUNTER = 1 << 8,
  OT_CHANGED_THREAD_NETDATA = 1 << 9,
  OT_CHANGED_THREAD_CHILD_ADDED = 1 << 10,
  OT_CHANGED_THREAD_CHILD_REMOVED = 1 << 11,
  OT_CHANGED_IP6_MULTICAST_SUBSCRIBED = 1 << 12,
  OT_CHANGED_IP6_MULTICAST_UNSUBSCRIBED = 1 << 13,
  OT_CHANGED_THREAD_CHANNEL = 1 << 14,
  OT_CHANGED_THREAD_PANID = 1 << 15,
  OT_CHANGED_THREAD_NETWORK_NAME = 1 << 16,
  OT_CHANGED_THREAD_EXT_PANID = 1 << 17,
  OT_CHANGED_NETWORK_KEY = 1 << 18,
  OT_CHANGED_PSKC = 1 << 19,
  OT_CHANGED_SECURITY_POLICY = 1 << 20,
  OT_CHANGED_CHANNEL_MANAGER_NEW_CHANNEL = 1 << 21,
  OT_CHANGED_SUPPORTED_CHANNEL_MASK = 1 << 22,
  OT_CHANGED_COMMISSIONER_STATE = 1 << 23,
  OT_CHANGED_THREAD_NETIF_STATE = 1 << 24,
  OT_CHANGED_THREAD_BACKBONE_ROUTER_STATE = 1 << 25,
  OT_CHANGED_THREAD_BACKBONE_ROUTER_LOCAL = 1 << 26,
  OT_CHANGED_JOINER_STATE = 1 << 27,
  OT_CHANGED_ACTIVE_DATASET = 1 << 28,
  OT_CHANGED_PENDING_DATASET = 1 << 29,
  OT_CHANGED_NAT64_TRANSLATOR_STATE = 1 << 30
}
טיפוסים בני מנייה (enum)
ספירה זו מגדירה סימונים שמועברים כחלק מ-otStateChangedCallback.

סוגי Offdef

otChangedFlags typedef
uint32_t
הסוג הזה מייצג שדה ביט שמייצג מצב/תצורה ספציפיים שהשתנו.
otInstance typedef
struct otInstance
המבנה הזה מייצג את מבנה המכונות של OpenThread.
otStateChangedCallback)(otChangedFlags aFlags, void *aContext) typedef
void(*
המצביע של הפונקציה הזו נקרא כדי להודיע על שינויים מסוימים בהגדרות או במצב בתוך OpenThread.

פונקציות

otGetRadioVersionString(otInstance *aInstance)
const char *
הפונקציה הזו מקבלת את המחרוזת של גרסת הרדיו של OpenThread.
otGetVersionString(void)
const char *
הפונקציה הזו מקבלת את המחרוזת של גרסת OpenThread.
otInstanceErasePersistentInfo(otInstance *aInstance)
הפונקציה מוחקת את כל המידע התמידי (הגדרות הרשת) של OpenThread ששמור בזיכרון שאינו תנודתי.
otInstanceFactoryReset(otInstance *aInstance)
void
מחיקת כל ההגדרות ששמורות בזיכרון ללא תנודתיות ולאחר מכן מתבצעת איפוס לפלטפורמה.
otInstanceFinalize(otInstance *aInstance)
void
הפונקציה הזו משביתה את ספריית OpenThread.
otInstanceGetUptime(otInstance *aInstance)
uint64_t
הפונקציה הזו מחזירה את זמן הפעולה הנוכחי של המכונה (באלפיות השנייה).
otInstanceGetUptimeAsString(otInstance *aInstance, char *aBuffer, uint16_t aSize)
void
הפונקציה הזו מחזירה את זמן הפעולה התקינה של המופע הנוכחי כמחרוזת שניתנת לקריאה על ידי בני אדם.
otInstanceInit(void *aInstanceBuffer, size_t *aInstanceBufferSize)
הפונקציה הזו מאתחלת את הספרייה של OpenThread.
otInstanceInitSingle(void)
הפונקציה הזו מאתחלת את המופע הסטטי היחיד של ספריית OpenThread.
otInstanceIsInitialized(otInstance *aInstance)
bool
הפונקציה הזו מציינת אם המכונה חוקית/אותחלה.
otInstanceReset(otInstance *aInstance)
void
שיטה זו מפעילה איפוס לפלטפורמה.
otInstanceResetRadioStack(otInstance *aInstance)
void
השיטה הזו מאפסת את המצבים הפנימיים של מחסנית הרדיו OpenThread.
otRemoveStateChangeCallback(otInstance *aInstance, otStateChangedCallback aCallback, void *aContext)
void
הפונקציה הזו מסירה קריאה חוזרת (callback) כדי לציין מתי תצורה או מצב מסוימים משתנים בתוך OpenThread.
otSetStateChangedCallback(otInstance *aInstance, otStateChangedCallback aCallback, void *aContext)
הפונקציה הזו מתעדת קריאה חוזרת (callback) כדי לציין מתי תצורה או מצב מסוימים משתנים ב-OpenThread.

מיספרים

טיפוס אנונימי

 anonymous enum

ספירה זו מגדירה סימונים שמועברים כחלק מ-otStateChangedCallback.

נכסים
OT_CHANGED_ACTIVE_DATASET

מערך הנתונים התפעולי הפעיל השתנה.

OT_CHANGED_CHANNEL_MANAGER_NEW_CHANNEL

ערוץ השרשור החדש שבהמתנה לערוץ השתנה.

OT_CHANGED_COMMISSIONER_STATE

מצב הנציב השתנה.

OT_CHANGED_IP6_ADDRESS_ADDED

כתובת IPv6 נוספה.

OT_CHANGED_IP6_ADDRESS_REMOVED

כתובת IPv6 הוסרה.

OT_CHANGED_IP6_MULTICAST_SUBSCRIBED

נרשמת לכתובת IPv6 עם מספר שידורים.

OT_CHANGED_IP6_MULTICAST_UNSUBSCRIBED

ביטלו את הרישום.

OT_CHANGED_JOINER_STATE

מצב ההצטרפות השתנה.

OT_CHANGED_NAT64_TRANSLATOR_STATE

המצב של מתרגם NAT64 השתנה.

OT_CHANGED_NETWORK_KEY

מפתח הרשת השתנה.

OT_CHANGED_PENDING_DATASET

מערך הנתונים התפעולי בהמתנה השתנה.

OT_CHANGED_PSKC

PSKc השתנה.

OT_CHANGED_SECURITY_POLICY

מדיניות האבטחה השתנתה.

OT_CHANGED_SUPPORTED_CHANNEL_MASK

המסכה הנתמכת של הערוץ השתנתה.

OT_CHANGED_THREAD_BACKBONE_ROUTER_LOCAL

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

OT_CHANGED_THREAD_BACKBONE_ROUTER_STATE

מצב נתב הרקע השתנה.

OT_CHANGED_THREAD_CHANNEL

ערוץ הרשת של השרשורים השתנה.

OT_CHANGED_THREAD_CHILD_ADDED

הילד או הילדה נוספו.

OT_CHANGED_THREAD_CHILD_REMOVED

הילד או הילדה הוסרו.

OT_CHANGED_THREAD_EXT_PANID

מזהה PAN מורחב של רשת שרשור השתנה.

OT_CHANGED_THREAD_KEY_SEQUENCE_COUNTER

הרצף של מפתחות השרשור השתנה.

OT_CHANGED_THREAD_LL_ADDR

הכתובת המקומית של הקישור השתנתה.

OT_CHANGED_THREAD_ML_ADDR

כתובת הרשת המקומית השתנתה.

OT_CHANGED_THREAD_NETDATA

נתוני רשת השרשורים השתנו.

OT_CHANGED_THREAD_NETIF_STATE

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

OT_CHANGED_THREAD_NETWORK_NAME

השם של רשת השרשורים השתנה.

OT_CHANGED_THREAD_PANID

מזהה ה-PAN של רשת השרשורים השתנה.

OT_CHANGED_THREAD_PARTITION_ID

מזהה החלוקה השתנה.

OT_CHANGED_THREAD_RLOC_ADDED

RLOC נוסף.

OT_CHANGED_THREAD_RLOC_REMOVED

RLOC הוסר.

OT_CHANGED_THREAD_ROLE

התפקיד (מושבת, מנותק, צאצא, נתב, מנהל) השתנה.

סוגי Offdef

otChangedFlags

uint32_t otChangedFlags

הסוג הזה מייצג שדה ביט שמייצג מצב/תצורה ספציפיים שהשתנו.

לעיון בהגדרות של OT_CHANGED_*.

OTInstance

struct otInstance otInstance

המבנה הזה מייצג את מבנה המכונות של OpenThread.

otStateChangedCallback

void(* otStateChangedCallback)(otChangedFlags aFlags, void *aContext)

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

פרטים
פרמטרים
[in] aFlags
שדה ביט שמציין מצב ספציפי שהשתנה. לעיון בהגדרות של OT_CHANGED_*.
[in] aContext
הצבעה להקשר ספציפי ליישום.

פונקציות

OTGetRadioVersionString

const char * otGetRadioVersionString(
  otInstance *aInstance
)

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

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

OTGetStringString

const char * otGetVersionString(
  void
)

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

פרטים
החזרות
מצביע לגרסה של OpenThread.

OTInstanceDeletePersistentInfo

otError otInstanceErasePersistentInfo(
  otInstance *aInstance
)

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

המחיקה תתבצע רק אם המכשיר נמצא במצב/בתפקיד disabled.

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

OTInstanceInstanceReset

void otInstanceFactoryReset(
  otInstance *aInstance
)

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

פרטים
פרמטרים
[in] aInstance
מצביע למופע של OpenThread.

OTInstanceFinalize

void otInstanceFinalize(
  otInstance *aInstance
)

הפונקציה הזו משביתה את ספריית OpenThread.

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

פרטים
פרמטרים
[in] aInstance
מצביע למופע של OpenThread.

otInstanceGetUptime

uint64_t otInstanceGetUptime(
  otInstance *aInstance
)

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

כדי להפעיל את הפונקציה הזו צריך להפעיל את OPENTHREAD_CONFIG_UPTIME_ENABLE.

זמן הפעולה התקינה ניתן כמספר האלפיות השנייה מאז שאתחול ה-OpenThread הופעל.

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

OTInstanceGetUptimeAsString

void otInstanceGetUptimeAsString(
  otInstance *aInstance,
  char *aBuffer,
  uint16_t aSize
)

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

כדי להפעיל את הפונקציה הזו צריך להפעיל את OPENTHREAD_CONFIG_UPTIME_ENABLE.

המחרוזת היא בפורמט "::." לציון שעות, דקות, שניות ואלפיות השנייה (אם זמן הפעולה התקינה קצר יותר מיום אחד) או "

ד.::." (אם הוא נמשך יותר מיום אחד).

אם המחרוזת שמתקבלת לא תתאים ב-aBuffer (ב-aSize התווים שלה), המחרוזת תיחתך, אבל המחרוזת שתתקבל תהיה תמיד null.

פרטים
פרמטרים
[in] aInstance
מצביע למופע של OpenThread.
[out] aBuffer
מצביע למערך תווים כדי להפיק את המחרוזת.
[in] aSize
הגודל של aBuffer (בבייטים). מומלץ להשתמש במינוי OT_UPTIME_STRING_SIZE.

OTInstanceInit

otInstance * otInstanceInit(
  void *aInstanceBuffer,
  size_t *aInstanceBufferSize
)

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

הפונקציה הזו מאתחלת את OpenThread ומכין אותה לקריאות הבאות של OpenThread API. יש לקרוא לפונקציה הזו לפני כל קריאה אחרת ל-OpenThread.

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

פרטים
פרמטרים
[in] aInstanceBuffer
המאגר עבור OpenThread לשימוש להקצאת מבנה ה-otInstance.
[in,out] aInstanceBufferSize
גודל הקלט של AInstanceBuffer. בפלט, אם אין מספיק מקום ל-otInstance, מספר הבייטים שדרוש ל-otInstance.
החזרות
מצביע למכונה החדשה של OpenThread.
למידע נוסף:
otInstanceFinalize

OTInstanceInitSingle

otInstance * otInstanceInitSingle(
  void
)

הפונקציה הזו מאתחלת את המופע הסטטי היחיד של ספריית OpenThread.

הפונקציה הזו מאתחלת את OpenThread ומכין אותה לקריאות הבאות של OpenThread API. יש לקרוא לפונקציה הזו לפני כל קריאה אחרת ל-OpenThread.

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

פרטים
החזרות
מצביע למופע יחיד של OpenThread.

OTInstanceIsinitialized

bool otInstanceIsInitialized(
  otInstance *aInstance
)

הפונקציה הזו מציינת אם המכונה חוקית/אותחלה.

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

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

OTInstanceReset

void otInstanceReset(
  otInstance *aInstance
)

שיטה זו מפעילה איפוס לפלטפורמה.

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

פרטים
פרמטרים
[in] aInstance
מצביע למופע של OpenThread.

OTInstanceResetRadioStack

void otInstanceResetRadioStack(
  otInstance *aInstance
)

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

התקשרות חזרה ותצורות נשמרות.

ה-API הזה זמין רק בגרסאות build (OPENTHREAD_RADIO = 1).

פרטים
פרמטרים
[in] aInstance
מצביע למופע של OpenThread.

otRemoveStateChangeCallback

void otRemoveStateChangeCallback(
  otInstance *aInstance,
  otStateChangedCallback aCallback,
  void *aContext
)

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

פרטים
פרמטרים
[in] aInstance
מצביע למופע של OpenThread.
[in] aCallback
הצבעה על פונקציה שנקראת עם שינויים מסוימים בהגדרות או במצב.
[in] aContext
הצבעה להקשר ספציפי ליישום.

otSetStateChangedCallback

otError otSetStateChangedCallback(
  otInstance *aInstance,
  otStateChangedCallback aCallback,
  void *aContext
)

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

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

פקודות מאקרו

הארכה TIME_STRING_SIZE

 OT_UPTIME_STRING_SIZE 24

הגודל המומלץ לייצוג מחרוזת של זמן פעולה תקינה.

משאבים

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