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)
מוחק את כל המידע הקבוע של OpenThread (הגדרות רשת) השמור בזיכרון לא תנודתי.
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.
otInstanceInitMultiple(uint8_t aIdx)
מאתחל את המכונה OpenThread.
otInstanceInitSingle(void)
הפעלה של המופע הסטטי היחיד של ספריית OpenThread.
otInstanceIsInitialized(otInstance *aInstance)
bool
מציין אם המכונה חוקית/אותחלה.
otInstanceReset(otInstance *aInstance)
void
הפעלה של איפוס פלטפורמה.
otInstanceResetRadioStack(otInstance *aInstance)
void
איפוס המצבים הפנימיים של מקבץ הרדיו OpenThread.
otInstanceResetToBootloader(otInstance *aInstance)
מפעיל איפוס של הפלטפורמה למצב תוכנת אתחול, אם הוא נתמך.
otRemoveStateChangeCallback(otInstance *aInstance, otStateChangedCallback aCallback, void *aContext)
void
הפונקציה מסירה קריאה חוזרת (callback) כדי לציין שינויים בתצורה או במצב מסוימים ב-OpenThread.
otSetStateChangedCallback(otInstance *aInstance, otStateChangedCallback aCallback, void *aContext)
רישום של קריאה חוזרת (callback) כדי לציין שינויים בתצורה או במצב מסוימים בתוך 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.

otGetVersionString

const char * otGetVersionString(
  void
)

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

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

otInstanceErasePersistentInfo

otError otInstanceErasePersistentInfo(
  otInstance *aInstance
)

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

המחיקה מתבצעת בהצלחה רק אם המכשיר נמצא במצב/תפקיד 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 התווים שלה), המחרוזת תיחתך, אבל המחרוזת הפלט תמיד תהיה אפסית.

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

otInstanceInitMultiple

otInstance * otInstanceInitMultiple(
  uint8_t aIdx
)

מאתחל את המכונה OpenThread.

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

הפונקציה הזו זמינה ואפשר להשתמש בה רק כשמופעלת תמיכה במספר מופעים סטטיים של OpenThread (OPENTHREAD_CONFIG_MULTIPLE_STATIC_INSTANCE_ENABLE)

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

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.

otInstanceResetToBootloader

otError otInstanceResetToBootloader(
  otInstance *aInstance
)

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

נדרש OPENTHREAD_CONFIG_PLATFORM_BOOTLOADER_MODE_ENABLE.

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

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
הקריאה החוזרת כבר נרשמה.
OT_ERROR_NO_BUFS
לא ניתן להוסיף את הקריאה החוזרת (callback) בגלל מגבלות משאבים.

פקודות מאקרו

OT_CHANGED_ACTIVE_DATASET

 OT_CHANGED_ACTIVE_DATASET (1U << 28)

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

OT_CHANGED_CHANNEL_MANAGER_NEW_CHANNEL

 OT_CHANGED_CHANNEL_MANAGER_NEW_CHANNEL (1U << 21)

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

OT_CHANGED_COMMISSIONER_STATE

 OT_CHANGED_COMMISSIONER_STATE (1U << 23)

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

OT_CHANGED_IP6_ADDRESS_ADDED

 OT_CHANGED_IP6_ADDRESS_ADDED (1U << 0)

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

OT_CHANGED_IP6_ADDRESS_REMOVED

 OT_CHANGED_IP6_ADDRESS_REMOVED (1U << 1)

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

OT_CHANGED_IP6_MULTICAST_SUBSCRIBED

 OT_CHANGED_IP6_MULTICAST_SUBSCRIBED (1U << 12)

נרשמת לכתובת Multicast של IPv6.

OT_CHANGED_IP6_MULTICAST_UNSUBSCRIBED

 OT_CHANGED_IP6_MULTICAST_UNSUBSCRIBED (1U << 13)

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

OT_CHANGED_JOINER_STATE

 OT_CHANGED_JOINER_STATE (1U << 27)

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

OT_CHANGED_NAT64_TRANSLATOR_STATE

 OT_CHANGED_NAT64_TRANSLATOR_STATE (1U << 30)

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

OT_CHANGED_NETWORK_KEY

 OT_CHANGED_NETWORK_KEY (1U << 18)

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

 OT_CHANGED_PARENT_LINK_QUALITY (1U << 31)

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

OT_CHANGED_PENDING_DATASET

 OT_CHANGED_PENDING_DATASET (1U << 29)

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

OT_CHANGED_PSKC

 OT_CHANGED_PSKC (1U << 19)

PSKc השתנה.

OT_CHANGED_SECURITY_POLICY

 OT_CHANGED_SECURITY_POLICY (1U << 20)

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

OT_CHANGED_SUPPORTED_CHANNEL_MASK

 OT_CHANGED_SUPPORTED_CHANNEL_MASK (1U << 22)

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

OT_CHANGED_THREAD_BACKBONE_ROUTER_LOCAL

 OT_CHANGED_THREAD_BACKBONE_ROUTER_LOCAL (1U << 26)

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

OT_CHANGED_THREAD_BACKBONE_ROUTER_STATE

 OT_CHANGED_THREAD_BACKBONE_ROUTER_STATE (1U << 25)

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

OT_CHANGED_THREAD_CHANNEL

 OT_CHANGED_THREAD_CHANNEL (1U << 14)

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

OT_CHANGED_THREAD_CHILD_ADDED

 OT_CHANGED_THREAD_CHILD_ADDED (1U << 10)

הילד/ה נוסף/ה.

OT_CHANGED_THREAD_CHILD_REMOVED

 OT_CHANGED_THREAD_CHILD_REMOVED (1U << 11)

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

OT_CHANGED_THREAD_EXT_PANID

 OT_CHANGED_THREAD_EXT_PANID (1U << 17)

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

OT_CHANGED_THREAD_KEY_SEQUENCE_COUNTER

 OT_CHANGED_THREAD_KEY_SEQUENCE_COUNTER (1U << 8)

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

OT_CHANGED_THREAD_LL_ADDR

 OT_CHANGED_THREAD_LL_ADDR (1U << 3)

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

OT_CHANGED_THREAD_ML_ADDR

 OT_CHANGED_THREAD_ML_ADDR (1U << 4)

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

OT_CHANGED_THREAD_NETDATA

 OT_CHANGED_THREAD_NETDATA (1U << 9)

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

OT_CHANGED_THREAD_NETIF_STATE

 OT_CHANGED_THREAD_NETIF_STATE (1U << 24)

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

OT_CHANGED_THREAD_NETWORK_NAME

 OT_CHANGED_THREAD_NETWORK_NAME (1U << 16)

שם הרשת של Thread השתנה.

OT_CHANGED_THREAD_PANID

 OT_CHANGED_THREAD_PANID (1U << 15)

מזהה ה-PAN של רשת ה-thread השתנה.

OT_CHANGED_THREAD_PARTITION_ID

 OT_CHANGED_THREAD_PARTITION_ID (1U << 7)

מזהה המחיצה השתנה.

OT_CHANGED_THREAD_RLOC_ADDED

 OT_CHANGED_THREAD_RLOC_ADDED (1U << 5)

ה-RLOC נוסף.

OT_CHANGED_THREAD_RLOC_REMOVED

 OT_CHANGED_THREAD_RLOC_REMOVED (1U << 6)

ה-RLOC הוסר.

OT_CHANGED_THREAD_ROLE

 OT_CHANGED_THREAD_ROLE (1U << 2)

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

OT_UPTIME_STRING_SIZE

 OT_UPTIME_STRING_SIZE 24

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

מקורות מידע

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