קומישינר

המודול הזה כולל פונקציות של התפקיד Thread Commissioner.

סיכום

ספירות
otCommissionerJoinerEvent טיפוסים בני מנייה (enum)
מגדיר אירוע הצטרפות אצל הנציב.
otCommissionerState{
  OT_COMMISSIONER_STATE_DISABLED = 0,
  OT_COMMISSIONER_STATE_PETITION = 1,
  OT_COMMISSIONER_STATE_ACTIVE = 2
} 		טיפוסים בני מנייה (enum)
מגדיר את מדינת הנציב.
otJoinerInfoType{
  OT_JOINER_INFO_TYPE_ANY = 0,
  OT_JOINER_INFO_TYPE_EUI64 = 1,
  OT_JOINER_INFO_TYPE_DISCERNER = 2
} 		טיפוסים בני מנייה (enum)
הגדרת סוג פרטי המחבר.

ערכי דף
otCommissionerEnergyReportCallback)(uint32_t aChannelMask, const uint8_t *aEnergyList, uint8_t aEnergyListLength, void *aContext) typedef
void(*
מתבצעת הקראה של המצביע כאשר הנציב מקבל דוח צריכת אנרגיה.
otCommissionerJoinerCallback)(otCommissionerJoinerEvent aEvent, const otJoinerInfo *aJoinerInfo, const otExtAddress *aJoinerId, void *aContext) typedef
void(*
המצביע מופעל בכל פעם שמצב המחבר משתנה.
otCommissionerJoinerEvent typedef
מגדיר אירוע הצטרפות אצל הנציב.
otCommissionerPanIdConflictCallback)(uint16_t aPanId, uint32_t aChannelMask, void *aContext) typedef
void(*
מתבצעת הפעלה של המצביע כאשר הנציב מקבל הודעה על התנגשות בין מזהה PAN (מספר חשבון קבוע).
otCommissionerState typedef
מגדיר את מדינת הנציב.
otCommissionerStateCallback)(otCommissionerState aState, void *aContext) typedef
void(*
המערכת מפעילה את המצביע בכל פעם שמצב הנציבות משתנה.
otCommissioningDataset typedef
מייצג מערך נתונים שנקרא 'הזמנה'.
otJoinerInfo typedef
struct otJoinerInfo
מייצג פרטי מחבר.
otJoinerInfoType typedef
הגדרת סוג פרטי המחבר.
otJoinerPskd typedef
struct otJoinerPskd
מייצג PSKd של מצטרף.
otSteeringData typedef
מייצג את נתוני ההיגוי.

פונקציות
otCommissionerAddJoiner(otInstance *aInstance, const otExtAddress *aEui64, const char *aPskd, uint32_t aTimeout)
הוספת רשומת איחוד.
otCommissionerAddJoinerWithDiscerner(otInstance *aInstance, const otJoinerDiscerner *aDiscerner, const char *aPskd, uint32_t aTimeout)
מוסיף כניסת מתאם עם ערך נתון של דיסקרנר.
otCommissionerAnnounceBegin(otInstance *aInstance, uint32_t aChannelMask, uint8_t aCount, uint16_t aPeriod, const otIp6Address *aAddress)
נשלחת הודעת 'התחלת הכרזה'.
otCommissionerEnergyScan(otInstance *aInstance, uint32_t aChannelMask, uint8_t aCount, uint16_t aPeriod, uint16_t aScanDuration, const otIp6Address *aAddress, otCommissionerEnergyReportCallback aCallback, void *aContext)
תישלח הודעה לגבי שאילתה של סריקת אנרגיה.
otCommissionerGetId(otInstance *aInstance)
const char *
מחזירה את מזהה הנציב.
otCommissionerGetNextJoinerInfo(otInstance *aInstance, uint16_t *aIterator, otJoinerInfo *aJoiner)
קבלת פרטים על המחברים בעמדת ה-Aiterator.
otCommissionerGetProvisioningUrl(otInstance *aInstance)
const char *
הפונקציה מקבלת את כתובת ה-URL להקצאת משתמשים.
otCommissionerGetSessionId(otInstance *aInstance)
uint16_t
מחזירה את מזהה הסשן של הנציב.
otCommissionerGetState(otInstance *aInstance)
מחזירה את מצב הנציב.
otCommissionerPanIdQuery(otInstance *aInstance, uint16_t aPanId, uint32_t aChannelMask, const otIp6Address *aAddress, otCommissionerPanIdConflictCallback aCallback, void *aContext)
תישלח הודעה לגבי שאילתת מספר החשבון הקבוע (PAN).
otCommissionerRemoveJoiner(otInstance *aInstance, const otExtAddress *aEui64)
הסרה של רשומה מסוג 'מנהל'.
otCommissionerRemoveJoinerWithDiscerner(otInstance *aInstance, const otJoinerDiscerner *aDiscerner)
הסרה של רשומה מסוג 'מנהל'.
otCommissionerSendMgmtGet(otInstance *aInstance, const uint8_t *aTlvs, uint8_t aLength)
שליחת הקוד MGMT_COMMISSIONER_GET.
otCommissionerSendMgmtSet(otInstance *aInstance, const otCommissioningDataset *aDataset, const uint8_t *aTlvs, uint8_t aLength)
נשלחת MGMT_COMMISSIONER_SET.
otCommissionerSetId(otInstance *aInstance, const char *aId)
מגדיר את מזהה הנציב.
otCommissionerSetProvisioningUrl(otInstance *aInstance, const char *aProvisioningUrl)
מגדיר את כתובת ה-URL להקצאה.
otCommissionerStart(otInstance *aInstance, otCommissionerStateCallback aStateCallback, otCommissionerJoinerCallback aJoinerCallback, void *aCallbackContext)
הפעלת התפקיד Thread Commissioner.
otCommissionerStop(otInstance *aInstance)
ההגדרה משביתה את התפקיד Thread Commissioner.

מבנים
otCommissioningDataset

מייצג מערך נתונים שנקרא 'הזמנה'.

otJoinerInfo

מייצג פרטי מחבר.

otJoinerPskd

מייצג PSKd של מצטרף.

otSteeringData

מייצג את נתוני ההיגוי.

ספירות

otCommissionerJoinerEvent

 otCommissionerJoinerEvent

מגדיר אירוע הצטרפות אצל הנציב.

otCommissionerState

 otCommissionerState

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

תכונות
OT_COMMISSIONER_STATE_ACTIVE

תפקיד הנציב פעיל.

OT_COMMISSIONER_STATE_DISABLED

תפקיד הנציב מושבת.

OT_COMMISSIONER_STATE_PETITION

הבקשה הנוכחית היא להפוך לנציבה.

otJoinerInfoType

 otJoinerInfoType

הגדרת סוג פרטי המחבר.

תכונות
OT_JOINER_INFO_TYPE_ANY

מקבלים כל מחבר (לא צוין EUI64 או Discerner).

OT_JOINER_INFO_TYPE_DISCERNER

צוין דיסקרנר מחובר (mSharedId.mDiscerner ב-otJoinerInfo).

OT_JOINER_INFO_TYPE_EUI64

צוין האיחוד האירופי EUI-64 (mSharedId.mEui64 ב-otJoinerInfo).

ערכי דף

otCommissionerEnergyReportCallback

void(* otCommissionerEnergyReportCallback)(uint32_t aChannelMask, const uint8_t *aEnergyList, uint8_t aEnergyListLength, void *aContext)

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

פרטים
פרמטרים
[in] aChannelMask
ערך מסכת הערוץ.
[in] aEnergyList
הצבעה לרשימה של מדידת האנרגיה.
[in] aEnergyListLength
מספר הרשומות בaEnergyListLength.
[in] aContext
הפניה להקשר ספציפי לאפליקציה.

otCommissionerJoinerCallback

void(* otCommissionerJoinerCallback)(otCommissionerJoinerEvent aEvent, const otJoinerInfo *aJoinerInfo, const otExtAddress *aJoinerId, void *aContext)

המצביע מופעל בכל פעם שמצב המחבר משתנה.

פרטים
פרמטרים
[in] aEvent
סוג האירוע 'הצטרפות'.
[in] aJoinerInfo
מצביעים עם פרטי השולח.
[in] aJoinerId
המצביע על מזהה המחבר (אם הוא לא ידוע, הערך יהיה NULL).
[in] aContext
הפניה להקשר ספציפי לאפליקציה.

otCommissionerJoinerEvent

enum otCommissionerJoinerEvent otCommissionerJoinerEvent

מגדיר אירוע הצטרפות אצל הנציב.

otCommissionerPanIdConflictCallback

void(* otCommissionerPanIdConflictCallback)(uint16_t aPanId, uint32_t aChannelMask, void *aContext)

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

פרטים
פרמטרים
[in] aPanId
ערך המזהה של מספר החשבון הקבוע (PAN).
[in] aChannelMask
ערך מסכת הערוץ.
[in] aContext
הפניה להקשר ספציפי לאפליקציה.

otCommissionerState

enum otCommissionerState otCommissionerState

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

otCommissionerStateCallback

void(* otCommissionerStateCallback)(otCommissionerState aState, void *aContext)

המערכת מפעילה את המצביע בכל פעם שמצב הנציבות משתנה.

פרטים
פרמטרים
[in] aState
מדינת הנציב.
[in] aContext
הפניה להקשר ספציפי לאפליקציה.

otCommissioningDataset

struct otCommissioningDataset otCommissioningDataset

מייצג מערך נתונים שנקרא 'הזמנה'.

otJoinerInfo

struct otJoinerInfo otJoinerInfo

מייצג פרטי מחבר.

otJoinerInfoType

enum otJoinerInfoType otJoinerInfoType

הגדרת סוג פרטי המחבר.

otJoinerPskd

struct otJoinerPskd otJoinerPskd

מייצג PSKd של מצטרף.

otSteeringData

struct otSteeringData otSteeringData

מייצג את נתוני ההיגוי.

פונקציות

otCommissionerAddJoiner

otError otCommissionerAddJoiner(
  otInstance *aInstance,
  const otExtAddress *aEui64,
  const char *aPskd,
  uint32_t aTimeout
)

הוספת רשומת איחוד.

פרטים
פרמטרים
[in] aInstance
מצביע למופע של OpenThread.
[in] aEui64
מצביע ל-IEEE EUI-64 או NULL של המחבר.
[in] aPskd
מצביע אל ה-PSKd.
[in] aTimeout
פרק זמן שאחריו המשתמש מוסר באופן אוטומטי. כלומר, בשניות.
ערכים מוחזרים
OT_ERROR_NONE
המשתמש צורף בהצלחה.
OT_ERROR_NO_BUFS
אין מאגרי אחסון זמינים להוספת ה-Connecter.
OT_ERROR_INVALID_ARGS
הערך aEui64 או aPskd לא תקין.
OT_ERROR_INVALID_STATE
הנציב/ה לא פעיל/ה.

otCommissionerAddJoinerWithDiscerner

otError otCommissionerAddJoinerWithDiscerner(
  otInstance *aInstance,
  const otJoinerDiscerner *aDiscerner,
  const char *aPskd,
  uint32_t aTimeout
)

מוסיף כניסת מתאם עם ערך נתון של דיסקרנר.

פרטים
פרמטרים
[in] aInstance
מצביע למופע של OpenThread.
[in] aDiscerner
מצביע אל ה-Connecter Discerner.
[in] aPskd
מצביע אל ה-PSKd.
[in] aTimeout
פרק זמן שאחריו המשתמש מוסר באופן אוטומטי. כלומר, בשניות.
ערכים מוחזרים
OT_ERROR_NONE
המשתמש צורף בהצלחה.
OT_ERROR_NO_BUFS
אין מאגרי אחסון זמינים להוספת ה-Connecter.
OT_ERROR_INVALID_ARGS
הערך aDiscerner או aPskd לא תקין.
OT_ERROR_INVALID_STATE
הנציב/ה לא פעיל/ה.

otCommissionerAnnounceBegin

otError otCommissionerAnnounceBegin(
  otInstance *aInstance,
  uint32_t aChannelMask,
  uint8_t aCount,
  uint16_t aPeriod,
  const otIp6Address *aAddress
)

נשלחת הודעת 'התחלת הכרזה'.

פרטים
פרמטרים
[in] aInstance
מצביע למופע של OpenThread.
[in] aChannelMask
ערך מסכת הערוץ.
[in] aCount
מספר הודעות ההודעות בכל ערוץ.
[in] aPeriod
הזמן בין שתי שידורים רצופים של MLE Release (באלפיות שנייה).
[in] aAddress
מצביע ליעד IPv6.
ערכים מוחזרים
OT_ERROR_NONE
התווספה בהצלחה להודעה 'התחלת הכרזה' על המשחק.
OT_ERROR_NO_BUFS
אין מספיק מאגרים כדי ליצור הודעת 'התחלת הכרזה'.
OT_ERROR_INVALID_STATE
הנציב/ה לא פעיל/ה.

otCommissionerEnergyScan

otError otCommissionerEnergyScan(
  otInstance *aInstance,
  uint32_t aChannelMask,
  uint8_t aCount,
  uint16_t aPeriod,
  uint16_t aScanDuration,
  const otIp6Address *aAddress,
  otCommissionerEnergyReportCallback aCallback,
  void *aContext
)

תישלח הודעה לגבי שאילתה של סריקת אנרגיה.

פרטים
פרמטרים
[in] aInstance
מצביע למופע של OpenThread.
[in] aChannelMask
ערך מסכת הערוץ.
[in] aCount
מספר מדידות האנרגיה בכל ערוץ.
[in] aPeriod
הזמן בין מדידות אנרגיה (אלפיות שנייה).
[in] aScanDuration
משך הסריקה של כל מדידת אנרגיה (אלפיות שנייה).
[in] aAddress
מצביע ליעד IPv6.
[in] aCallback
מצביעה לפונקציה שקוראת לקבל הודעה על דוח צריכת חשמל.
[in] aContext
הפניה להקשר ספציפי לאפליקציה.
ערכים מוחזרים
OT_ERROR_NONE
ההודעה על השאילתה של סריקת האנרגיה תוכנס בהצלחה לתור.
OT_ERROR_NO_BUFS
אין מספיק מאגרי אחסון נתונים כדי ליצור הודעה על שאילתה של סריקת אנרגיה.
OT_ERROR_INVALID_STATE
הנציב/ה לא פעיל/ה.

otCommissionerGetId

const char * otCommissionerGetId(
  otInstance *aInstance
)

מחזירה את מזהה הנציב.

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

otCommissionerGetNextJoinerInfo

otError otCommissionerGetNextJoinerInfo(
  otInstance *aInstance,
  uint16_t *aIterator,
  otJoinerInfo *aJoiner
)

קבלת פרטים על המחברים בעמדת ה-Aiterator.

פרטים
פרמטרים
[in] aInstance
מצביע למופע.
[in,out] aIterator
מצביע על ההקשר של איטרטור פרטי הצירוף.
[out] aJoiner
הפניה לפרטי השולח.
ערכים מוחזרים
OT_ERROR_NONE
פרטי ההצטרפות התקבלו.
OT_ERROR_NOT_FOUND
המשתמש הבא לא נמצא.

otCommissionerGetProvisioningUrl

const char * otCommissionerGetProvisioningUrl(
  otInstance *aInstance
)

הפונקציה מקבלת את כתובת ה-URL להקצאת משתמשים.

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

otCommissionerGetSessionId

uint16_t otCommissionerGetSessionId(
  otInstance *aInstance
)

מחזירה את מזהה הסשן של הנציב.

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

otCommissionerGetState

otCommissionerState otCommissionerGetState(
  otInstance *aInstance
)

מחזירה את מצב הנציב.

פרטים
פרמטרים
[in] aInstance
מצביע למופע של OpenThread.
ערכים מוחזרים
OT_COMMISSIONER_STATE_DISABLED
הנציב מושבת.
OT_COMMISSIONER_STATE_PETITION
הפיכת הנציבים.
OT_COMMISSIONER_STATE_ACTIVE
העמלה הופעלה.

otCommissionerPanIdQuery

otError otCommissionerPanIdQuery(
  otInstance *aInstance,
  uint16_t aPanId,
  uint32_t aChannelMask,
  const otIp6Address *aAddress,
  otCommissionerPanIdConflictCallback aCallback,
  void *aContext
)

תישלח הודעה לגבי שאילתת מספר החשבון הקבוע (PAN).

פרטים
פרמטרים
[in] aInstance
מצביע למופע של OpenThread.
[in] aPanId
מזהה ה-PAN שיש לשלוח אליו שאילתה.
[in] aChannelMask
ערך מסכת הערוץ.
[in] aAddress
מצביע ליעד IPv6.
[in] aCallback
הפניה לפונקציה שנקראה לקבלת הודעה על התנגשות בין מזהה PAN (מספר חשבון קבוע).
[in] aContext
הפניה להקשר ספציפי לאפליקציה.
ערכים מוחזרים
OT_ERROR_NONE
ההודעה על שאילתת מזהה של מספר חשבון קבוע נוספה בהצלחה לתור.
OT_ERROR_NO_BUFS
אין מספיק חוצצים כדי ליצור הודעה לגבי שאילתת מזהה של PAN (מספר חשבון קבוע).
OT_ERROR_INVALID_STATE
הנציב/ה לא פעיל/ה.

otCommissionerRemoveJoiner

otError otCommissionerRemoveJoiner(
  otInstance *aInstance,
  const otExtAddress *aEui64
)

הסרה של רשומה מסוג 'מנהל'.

פרטים
פרמטרים
[in] aInstance
מצביע למופע של OpenThread.
[in] aEui64
מצביע ל-IEEE EUI-64 או NULL של המחבר.
ערכים מוחזרים
OT_ERROR_NONE
המחבר הוסר בהצלחה.
OT_ERROR_NOT_FOUND
המחבר שצוין על ידי aEui64 לא נמצא.
OT_ERROR_INVALID_ARGS
aEui64 אינו חוקי.
OT_ERROR_INVALID_STATE
הנציב/ה לא פעיל/ה.

otCommissionerRemoveJoinerWithDiscerner

otError otCommissionerRemoveJoinerWithDiscerner(
  otInstance *aInstance,
  const otJoinerDiscerner *aDiscerner
)

הסרה של רשומה מסוג 'מנהל'.

פרטים
פרמטרים
[in] aInstance
מצביע למופע של OpenThread.
[in] aDiscerner
מצביע אל ה-Connecter Discerner.
ערכים מוחזרים
OT_ERROR_NONE
המחבר הוסר בהצלחה.
OT_ERROR_NOT_FOUND
המחבר שצוין על ידי aEui64 לא נמצא.
OT_ERROR_INVALID_ARGS
aDiscerner אינו חוקי.
OT_ERROR_INVALID_STATE
הנציב/ה לא פעיל/ה.

otCommissionerSendMgmtGet

otError otCommissionerSendMgmtGet(
  otInstance *aInstance,
  const uint8_t *aTlvs,
  uint8_t aLength
)

שליחת הקוד MGMT_COMMISSIONER_GET.

פרטים
פרמטרים
[in] aInstance
מצביע למופע של OpenThread.
[in] aTlvs
מצביע ל-TLV.
[in] aLength
האורך של TLV.
ערכים מוחזרים
OT_ERROR_NONE
שלחת בהצלחה את הפקודה של מערך הנתונים meshcop.
OT_ERROR_NO_BUFS
אין מספיק מקום אחסון זמני לשליחה.
OT_ERROR_INVALID_STATE
הנציב/ה לא פעיל/ה.

otCommissionerSendMgmtSet

otError otCommissionerSendMgmtSet(
  otInstance *aInstance,
  const otCommissioningDataset *aDataset,
  const uint8_t *aTlvs,
  uint8_t aLength
)

נשלחת MGMT_COMMISSIONER_SET.

פרטים
פרמטרים
[in] aInstance
מצביע למופע של OpenThread.
[in] aDataset
קישור להזמנת מערך נתונים.
[in] aTlvs
מצביע ל-TLV.
[in] aLength
האורך של TLV.
ערכים מוחזרים
OT_ERROR_NONE
שלחת בהצלחה את הפקודה של מערך הנתונים meshcop.
OT_ERROR_NO_BUFS
אין מספיק מקום אחסון זמני לשליחה.
OT_ERROR_INVALID_STATE
הנציב/ה לא פעיל/ה.

otCommissionerSetId

otError otCommissionerSetId(
  otInstance *aInstance,
  const char *aId
)

מגדיר את מזהה הנציב.

פרטים
פרמטרים
[in] aInstance
מצביע למופע של OpenThread.
[in] aId
מצביע למערך תווים של מחרוזת. חייב להיות null.
ערכים מוחזרים
OT_ERROR_NONE
מזהה הנציב הוגדר בהצלחה.
OT_ERROR_INVALID_ARGS
השם הפרטי ארוך מדי.
OT_ERROR_INVALID_STATE
הנציב פעיל ולא ניתן לשנות את המזהה שלו.

otCommissionerSetProvisioningUrl

otError otCommissionerSetProvisioningUrl(
  otInstance *aInstance,
  const char *aProvisioningUrl
)

מגדיר את כתובת ה-URL להקצאה.

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

otCommissionerStart

otError otCommissionerStart(
  otInstance *aInstance,
  otCommissionerStateCallback aStateCallback,
  otCommissionerJoinerCallback aJoinerCallback,
  void *aCallbackContext
)

הפעלת התפקיד Thread Commissioner.

פרטים
פרמטרים
[in] aInstance
מצביע למופע של OpenThread.
[in] aStateCallback
מצביע אל פונקציה שמופעלת כשמצב הנציב משתנה.
[in] aJoinerCallback
מתרחש מצביע אל פונקציה שנקראת עם אירוע איחוד.
[in] aCallbackContext
הפניה להקשר ספציפי לאפליקציה.
ערכים מוחזרים
OT_ERROR_NONE
שירות הנציבות התחיל בהצלחה.
OT_ERROR_ALREADY
הנציב כבר התחיל.
OT_ERROR_INVALID_STATE
המכשיר לא מחובר כרגע לרשת.

otCommissionerStop

otError otCommissionerStop(
  otInstance *aInstance
)

ההגדרה משביתה את התפקיד Thread Commissioner.

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

פקודות מאקרו

OT_COMMISSIONING_PASSPHRASE_MAX_SIZE

 OT_COMMISSIONING_PASSPHRASE_MAX_SIZE 255

הגודל המקסימלי של ביטוי הסיסמה לעמלה.

OT_COMMISSIONING_PASSPHRASE_MIN_SIZE

 OT_COMMISSIONING_PASSPHRASE_MIN_SIZE 6

הגודל המינימלי של ביטוי הסיסמה לעמלה.

OT_JOINER_MAX_PSKD_LENGTH

 OT_JOINER_MAX_PSKD_LENGTH 32

אורך המחרוזת המקסימלי של PSKd משותף (לא כולל null char).

OT_PROVISIONING_URL_MAX_SIZE

 OT_PROVISIONING_URL_MAX_SIZE 64

גודל מקסימלי (מספר תווים) במחרוזת של כתובת URL להקצאת הרשאות (לא כולל תו ריק).

OT_STEERING_DATA_MAX_LENGTH

 OT_STEERING_DATA_MAX_LENGTH 16

האורך המקסימלי של נתוני כוונון (בייטים)

מקורות מידע

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