מתקין/ה

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

סיכום

ספירות
otJoinerState טיפוסים בני מנייה (enum)
מגדיר את מצב המחבר.

ערכי דף
otJoinerCallback)(otError aError, void *aContext) typedef
void(*
המצביע מופעל כדי להודיע על השלמת פעולת הצטרפות.
otJoinerDiscerner typedef
מייצג שותף דיסקר.
otJoinerState typedef
מגדיר את מצב המחבר.

פונקציות
otJoinerGetDiscerner(otInstance *aInstance)
מקבל את ה-joiner Discerner.
otJoinerGetId(otInstance *aInstance)
const otExtAddress *
הפונקציה מקבלת את מזהה המחבר.
otJoinerGetState(otInstance *aInstance)
מקבל את מצב הצירוף.
otJoinerSetDiscerner(otInstance *aInstance, otJoinerDiscerner *aDiscerner)
מגדיר את הדיסקרנר לאיחוד.
otJoinerStart(otInstance *aInstance, const char *aPskd, const char *aProvisioningUrl, const char *aVendorName, const char *aVendorModel, const char *aVendorSwVersion, const char *aVendorData, otJoinerCallback aCallback, void *aContext)
הפעלת התפקיד 'שותף שרשור'.
otJoinerStateToString(otJoinerState aState)
const char *
ממירה ערך ספירה נתון של מצב מצרף למחרוזת ניתנת לקריאה על ידי בני אדם.
otJoinerStop(otInstance *aInstance)
void
משבית את התפקיד 'מחבר שרשור'.

מבנים
otJoinerDiscerner

מייצג שותף דיסקר.

ספירות

otJoinerState

 otJoinerState

מגדיר את מצב המחבר.

ערכי דף

otJoinerCallback

void(* otJoinerCallback)(otError aError, void *aContext)

המצביע מופעל כדי להודיע על השלמת פעולת הצטרפות.

פרטים
פרמטרים
[in] aError
OT_ERROR_NONE אם תהליך ההצטרפות הצליח. OT_ERROR_Security אם תהליך ההצטרפות נכשל עקב אישורי אבטחה. OT_ERROR_NOT_FOUND אם לא נמצאה רשת שניתנת לאיחוד. OT_ERROR_SCREEN_OFFSET אם הזמן הקצוב לתגובה הסתיים.
[in] aContext
הפניה להקשר ספציפי לאפליקציה.

otJoinerDiscerner

struct otJoinerDiscerner otJoinerDiscerner

מייצג שותף דיסקר.

otJoinerState

enum otJoinerState otJoinerState

מגדיר את מצב המחבר.

פונקציות

otJoinerGetDiscerner

const otJoinerDiscerner * otJoinerGetDiscerner(
  otInstance *aInstance
)

מקבל את ה-joiner Discerner.

למידע נוסף, אפשר לעיין ב-otJoinerSetDiscerner.

פרטים
פרמטרים
[in] aInstance
מצביע למופע של OpenThread.
החזרות
אם לא הוגדר שום אזכור, מצביע העכבר ל-joiner Discerner או ל-NULL.

otJoinerGetId

const otExtAddress * otJoinerGetId(
  otInstance *aInstance
)

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

אם לא הוגדר מזהה חיבור, מזהה השילוב הוא 64 הביטים הראשונים של תוצאת חישוב SHA-256 באמצעות IEEE EUI-64 שהוקצה על ידי היצרן. אחרת, מזהה המחבר מחושב לפי הערך של Shareder Discerner.

מזהה המחבר משמש גם בתור כתובת IEEE 802.15.4 מורחבת של המכשיר בתהליך ההזמנה.

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

otJoinerGetState

otJoinerState otJoinerGetState(
  otInstance *aInstance
)

מקבל את מצב הצירוף.

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

otJoinerSetDiscerner

otError otJoinerSetDiscerner(
  otInstance *aInstance,
  otJoinerDiscerner *aDiscerner
)

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

ה-Connecter Discerner משמש לחישוב מזהה המחבר בתהליך של חיבור ה-thread. מידע נוסף זמין ב-otJoinerGetId.

פרטים
פרמטרים
[in] aInstance
מצביע למופע של OpenThread.
[in] aDiscerner
מצביע ל-joiner Discerner. אם הפונקציה NULL מסירה את כל המפריד שהוגדר קודם לכן.
ערכים מוחזרים
OT_ERROR_NONE
ה-Connecter Discerner עודכן בהצלחה.
OT_ERROR_INVALID_ARGS
הערך aDiscerner לא חוקי (האורך שצוין אינו בטווח החוקי).
OT_ERROR_INVALID_STATE
ההצטרפות מתבצעת עכשיו, ולכן לא ניתן לשנות את ה-Diserner Discerner.

otJoinerStart

otError otJoinerStart(
  otInstance *aInstance,
  const char *aPskd,
  const char *aProvisioningUrl,
  const char *aVendorName,
  const char *aVendorModel,
  const char *aVendorSwVersion,
  const char *aVendorData,
  otJoinerCallback aCallback,
  void *aContext
)

הפעלת התפקיד 'שותף שרשור'.

פרטים
פרמטרים
[in] aInstance
מצביע למופע של OpenThread.
[in] aPskd
מצביע אל ה-PSKd.
[in] aProvisioningUrl
מצביע לכתובת האתר להקצאת משתמשים (יכול להיות NULL).
[in] aVendorName
הפניה לשם הספק (יכול להיות NULL).
[in] aVendorModel
הפניה למודל הספקים (יכול להיות NULL).
[in] aVendorSwVersion
הפניה לגרסת SW של הספק (יכולה להיות NULL).
[in] aVendorData
הפניה לנתוני הספק (יכול להיות NULL).
[in] aCallback
מצביע לפונקציה מופעלת כשפעולת ההצטרפות מסתיימת.
[in] aContext
הפניה להקשר ספציפי לאפליקציה.
ערכים מוחזרים
OT_ERROR_NONE
התפקיד של הצירוף התחיל.
OT_ERROR_BUSY
הניסיון הקודם עדיין בעיצומו.
OT_ERROR_INVALID_ARGS
הערך aPskd או aProvisioningUrl לא תקין.
OT_ERROR_INVALID_STATE
מחסנית IPv6 לא מופעלת או שמחסנית Thread מופעלת במלואה.

otJoinerStateToString

const char * otJoinerStateToString(
  otJoinerState aState
)

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

פרטים
פרמטרים
[in] aState
מצב הצירוף.
החזרות
ייצוג של aState, שבודק אנושי יכול לקרוא.

otJoinerStop

void otJoinerStop(
  otInstance *aInstance
)

משבית את התפקיד 'מחבר שרשור'.

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

פקודות מאקרו

OT_JOINER_MAX_DISCERNER_LENGTH

 OT_JOINER_MAX_DISCERNER_LENGTH 64

אורך מקסימלי של Shareder Discerner, בביטים.

מקורות מידע

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