מופע

מודול זה כולל פונקציות ששולטות במופע 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
}
טיפוסים בני מנייה (enum)
בספירה הזו מוגדרים סימונים שמועברים כחלק מ-otStateChangedCallback.

סוג Dedef

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)
פונקציה זו מוחקת את כל המידע התמידי (הגדרות רשת) של OpenOpen המאוחסן בזיכרון שאינו תנודתי.
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.

מספור

Enum אנונימי

 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

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

OT_CHANGED_JOINER_STATE

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

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

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

סוג Dedef

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.

otInstanceDeletePersistentInfo

otError otInstanceErasePersistentInfo(
  otInstance *aInstance
)

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

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

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

otInstanceInstanceאיפוס

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 התווים שלה), המחרוזת תיחתך, אבל המחרוזת המופלטת תמיד תיסגר בסוף.

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

otInstanceIsInitialize

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

פקודות מאקרו

OT_UPTIME_STRING_SIZE

 OT_UPTIME_STRING_SIZE 24

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

מקורות מידע

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