Instance

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

סיכום

סוג שגיאות
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)
מחיקת כל הנתונים הקבועים של OpenThreads (הגדרות הרשת) ששמורים בזיכרון לא תנודתי.
otInstanceFactoryReset(otInstance *aInstance)
void
מחיקת כל ההגדרות המאוחסנות בזיכרון לא תנודתי ואז מפעילה איפוס של הפלטפורמה.
otInstanceFinalize(otInstance *aInstance)
void
המדיניות משביתה את ספריית OpenThread.
otInstanceGetId(otInstance *aInstance)
uint32_t
קבלת מזהה המכונה.
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
ניתוק קריאה חוזרת כדי לציין כאשר תצורה או מצב מסוימים משתנים ב-OpenThread.
otSetStateChangedCallback(otInstance *aInstance, otStateChangedCallback aCallback, void *aContext)
רושם שיחה חוזרת כדי לציין מתי תצורה או מצב מסוימים משתנים ב-OpenThread.

סוג שגיאות

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.

מחרוזת otGetVersion

const char * otGetVersionString(
  void
)

מתקבל המחרוזת של גרסת OpenThread.

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

otInstanceDeletePersistentInfo

otError otInstanceErasePersistentInfo(
  otInstance *aInstance
)

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

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

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

otInstanceFactoryReset

void otInstanceFactoryReset(
  otInstance *aInstance
)

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

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

otInstanceFinalize

void otInstanceFinalize(
  otInstance *aInstance
)

המדיניות משביתה את ספריית OpenThread.

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

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

מזהה OTInstanceGetId

uint32_t otInstanceGetId(
  otInstance *aInstance
)

קבלת מזהה המכונה.

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

פרטים
החזרות
מזהה המכונה.

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 הזה זמין רק בערוצי רדיו (OPENTHREAD_RADIO = 1).

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

otRemoveStateChangeCallback

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

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

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

otSetStateChangedCallback

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

רושם שיחה חוזרת כדי לציין מתי תצורה או מצב מסוימים משתנים ב-OpenThread.

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

פקודות מאקרו

OT_CHANGE_ACTIVE_DATASET

 OT_CHANGED_ACTIVE_DATASET (1U << 28)

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

OT_CHANGE_CHANNEL_MANAGER_NEW_CHANNEL

 OT_CHANGED_CHANNEL_MANAGER_NEW_CHANNEL (1U << 21)

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

הארכה_שינוי_COMMISSIONER_STATE

 OT_CHANGED_COMMISSIONER_STATE (1U << 23)

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

OT_CHANGE_IP6_ADDRESS_ADDED

 OT_CHANGED_IP6_ADDRESS_ADDED (1U << 0)

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

OT_CHANGE_IP6_ADDRESS_REMOVED

 OT_CHANGED_IP6_ADDRESS_REMOVED (1U << 1)

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

הארכה_שינוי_IP6_MULTICAST_SUBSCRIBED

 OT_CHANGED_IP6_MULTICAST_SUBSCRIBED (1U << 12)

נרשמת לכתובת IPv6 עם מולטיקאסט.

הארכה_שינוי_IP6_MULTICAST_SUBSCRIBED

 OT_CHANGED_IP6_MULTICAST_UNSUBSCRIBED (1U << 13)

בוטלה ההרשמה לכתובת מולטיקאסט של IPv6.

OT_CHANGE_JOINER_STATE

 OT_CHANGED_JOINER_STATE (1U << 27)

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

OT_CHANGE_NAT64_TRANSLATOR_STATE

 OT_CHANGED_NAT64_TRANSLATOR_STATE (1U << 30)

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

OT_CHANGE_NETWORK_KEY

 OT_CHANGED_NETWORK_KEY (1U << 18)

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

 OT_CHANGED_PARENT_LINK_QUALITY (1U << 31)

איכות הקישור להורים שונתה.

OT_CHANGE_PENDING_DATASET

 OT_CHANGED_PENDING_DATASET (1U << 29)

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

OT_CHANGE_PSKC

 OT_CHANGED_PSKC (1U << 19)

PSKc השתנה.

OT_CHANGE_Security_POLICY

 OT_CHANGED_SECURITY_POLICY (1U << 20)

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

OT_CHANGE_SUPPORTED_CHANNEL_MASK

 OT_CHANGED_SUPPORTED_CHANNEL_MASK (1U << 22)

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

OT_CHANGE_THREAD_BACKBONE_ROUTER_LOCAL

 OT_CHANGED_THREAD_BACKBONE_ROUTER_LOCAL (1U << 26)

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

OT_CHANGE_THREAD_BACKBONE_ROUTER_STATE

 OT_CHANGED_THREAD_BACKBONE_ROUTER_STATE (1U << 25)

מצב נתב השדרה השתנה.

OT_CHANGE_THREAD_CHANNEL

 OT_CHANGED_THREAD_CHANNEL (1U << 14)

ערוץ הרשת של ה-thread השתנה.

OT_CHANGE_THREAD_CHILD_ADDED

 OT_CHANGED_THREAD_CHILD_ADDED (1U << 10)

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

OT_CHANGE_THREAD_CHILD_REMOVED

 OT_CHANGED_THREAD_CHILD_REMOVED (1U << 11)

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

OT_CHANGE_THREAD_EXT_PANID

 OT_CHANGED_THREAD_EXT_PANID (1U << 17)

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

OT_CHANGE_THREAD_KEY_SEQUENCE_COUNTER

 OT_CHANGED_THREAD_KEY_SEQUENCE_COUNTER (1U << 8)

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

הארכה

 OT_CHANGED_THREAD_LL_ADDR (1U << 3)

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

OT_CHANGE_THREAD_ML_nowrap

 OT_CHANGED_THREAD_ML_ADDR (1U << 4)

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

OT_changed_THREAD_NETDATA

 OT_CHANGED_THREAD_NETDATA (1U << 9)

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

OT_CHANGE_THREAD_NETIF_STATE

 OT_CHANGED_THREAD_NETIF_STATE (1U << 24)

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

OT_CHANGE_THREAD_NETWORK_NAME

 OT_CHANGED_THREAD_NETWORK_NAME (1U << 16)

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

OT_CHANGE_THREAD_PANID

 OT_CHANGED_THREAD_PANID (1U << 15)

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

OT_CHANGE_THREAD_PARTITION_ID

 OT_CHANGED_THREAD_PARTITION_ID (1U << 7)

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

OT_CHANGE_THREAD_RLOC_ADDED

 OT_CHANGED_THREAD_RLOC_ADDED (1U << 5)

RLOC נוסף.

OT_CHANGE_THREAD_RLOC_REMOVED

 OT_CHANGED_THREAD_RLOC_REMOVED (1U << 6)

RLOC הוסר.

OT_CHANGE_THREAD_ROLE

 OT_CHANGED_THREAD_ROLE (1U << 2)

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

OT_UPTIME_STRING_SIZE

 OT_UPTIME_STRING_SIZE 24

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

משאבים

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