מתקין/ה

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

סיכום

הדמיות

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

סוג מגן

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

פונקציות

otJoinerGetDiscerner(otInstance *aInstance)
הפונקציה הזו מקבלת את ה-Meeter Discnerer.
otJoinerGetId(otInstance *aInstance)
const otExtAddress *
הפונקציה הזו מקבלת את מזהה הצירוף.
otJoinerGetState(otInstance *aInstance)
הפונקציה הזו מחזירה את 'מצב המצטרף'.
otJoinerSetDiscerner(otInstance *aInstance, otJoinerDiscerner *aDiscerner)
הפונקציה הזו מגדירה את ה-Joiner Discnerer.
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_RESPONSE_OFFSET אם פג הזמן הקצוב לתגובה.
[in] aContext
מצביע להקשר ספציפי לאפליקציה.

otjoinerDiscerner

struct otJoinerDiscerner otJoinerDiscerner

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

otJoinerState

enum otJoinerState otJoinerState

ספירה זו מגדירה את מצב הצירוף.

פונקציות

otJoinerGetDiscerner

const otJoinerDiscerner * otJoinerGetDiscerner(
  otInstance *aInstance
)

הפונקציה הזו מקבלת את ה-Meeter Discnerer.

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

otJoinerGetId

const otExtAddress * otJoinerGetId(
  otInstance *aInstance
)

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

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

מזהה ההצטרפות משמש גם בתור הכתובת המורחבת של ה-IEEE 802.15.4 במכשיר בזמן תהליך ההזמנה.

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

otJoinerGetState

otJoinerState otJoinerGetState(
  otInstance *aInstance
)

הפונקציה הזו מחזירה את 'מצב המצטרף'.

פרטים
פרמטרים
[in] aInstance
מצביע למופע OpenThread.
ערכי החזרה
OT_JOINER_STATE_IDLE
OT_JOINER_STATE_DISCOVER
OT_JOINER_STATE_CONNECT
OT_JOINER_STATE_CONNECTED
OT_JOINER_STATE_ENTRUST
OT_JOINER_STATE_JOINED

otJoinerSetDiscerner

otError otJoinerSetDiscerner(
  otInstance *aInstance,
  otJoinerDiscerner *aDiscerner
)

הפונקציה הזו מגדירה את ה-Joiner Discnerer.

ה-Joiner דיסקer משמש לחישוב מזהה המצטרף ששימש בתהליך ההזמנה/ההצטרפות.

כברירת מחדל (כשלא מוגדר דיסקר, או שהוא מוגדר כ-NULL), מזהה הצירוף נגזר מ-64 הביטים הראשונים של תוצאת מחשוב SHA-256 מ-IEEE EUI-64 שהוקצה על ידי היצרן. הערה: זוהי הפרט העיקרי שמצופה ממפרט השרשור.

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

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
מצביע לכתובת URL של ניהול תצורה (יכול להיות 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 אינה מופעלת או ערימת שרשור מופעלת באופן מלא.

otJoinerStateToString

const char * otJoinerStateToString(
  otJoinerState aState
)

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

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

otJoinerStop

void otJoinerStop(
  otInstance *aInstance
)

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

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

פקודות מאקרו

OT_JOINER_MAX_DISRANKER_LENGTH

 OT_JOINER_MAX_DISCERNER_LENGTH 64

אורך מקסימלי של דיסקנר להצטרפות.

מקורות מידע

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