קומישינר
המודול הזה כולל פונקציות לתפקיד של שרשור השרשורים.
סיכום
מספור |
|
---|---|
otCommissionerJoinerEvent
|
טיפוסים בני מנייה (enum) ספירה זו מגדירה אירוע הצטרפות בנציב. |
otCommissionerState{
|
טיפוסים בני מנייה (enum) ספירה זו מגדירה את מצב הנציב. |
otJoinerInfoType{
|
טיפוסים בני מנייה (enum) ספירה זו מגדירה סוג של פרטי חבר. |
סוג Dedef |
|
---|---|
otCommissionerEnergyReportCallback)(uint32_t aChannelMask, const uint8_t *aEnergyList, uint8_t aEnergyListLength, void *aContext)
|
Typedefvoid(*
מצביע הפונקציה הזה נקרא כאשר הנציב מקבל דוח אנרגיה. |
otCommissionerJoinerCallback)(otCommissionerJoinerEvent aEvent, const otJoinerInfo *aJoinerInfo, const otExtAddress *aJoinerId, void *aContext)
|
Typedefvoid(*
הקריאה לפונקציה הזו נשלחת בכל פעם שמצב המצרף משתנה. |
otCommissionerJoinerEvent
|
Typedef ספירה זו מגדירה אירוע הצטרפות בנציב. |
otCommissionerPanIdConflictCallback)(uint16_t aPanId, uint32_t aChannelMask, void *aContext)
|
Typedefvoid(*
מצביע הפונקציה הזה נקרא כאשר הנציב מקבל הודעה על התנגשות בין מזהה PAN. |
otCommissionerState
|
Typedefenum otCommissionerState
ספירה זו מגדירה את מצב הנציב. |
otCommissionerStateCallback)(otCommissionerState aState, void *aContext)
|
Typedefvoid(*
הקריאה לפונקציה הזו מתבצעת בכל פעם שמצב הנציב משתנה. |
otCommissioningDataset
|
Typedefstruct otCommissioningDataset
המבנה הזה מייצג מערך נתונים של עמלות. |
otJoinerInfo
|
Typedefstruct otJoinerInfo
מבנה זה מייצג פרטי מחבר. |
otJoinerInfoType
|
Typedefenum otJoinerInfoType
ספירה זו מגדירה סוג של פרטי חבר. |
otJoinerPskd
|
Typedefstruct otJoinerPskd
המבנה הזה מייצג חיבור PSKd של מנוי. |
otSteeringData
|
Typedefstruct otSteeringData
מבנה זה מייצג את נתוני ההיגוי. |
פונקציות |
|
---|---|
otCommissionerAddJoiner(otInstance *aInstance, const otExtAddress *aEui64, const char *aPskd, uint32_t aTimeout)
|
פונקציה זו מוסיפה רשומה של מצטרף.
|
otCommissionerAddJoinerWithDiscerner(otInstance *aInstance, const otJoinerDiscerner *aDiscerner, const char *aPskd, uint32_t aTimeout)
|
פונקציה זו מוסיפה רשומה של Adder ל-Adder עם ערך נתון של Adder Discerner.
|
otCommissionerAnnounceBegin(otInstance *aInstance, uint32_t aChannelMask, uint8_t aCount, uint16_t aPeriod, const otIp6Address *aAddress)
|
פונקציה זו שולחת הודעת Announce Start.
|
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)
|
שיטה זו מקבלת את פרטי המחבר במיקום של Iterator.
|
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)
|
הפונקציה הזו מאפשרת את התפקיד 'מנהל שרשורים'.
|
otCommissionerStop(otInstance *aInstance)
|
הפונקציה הזו משביתה את התפקיד 'מפקח על השרשור'.
|
מבנים |
|
---|---|
otCommissioningDataset |
המבנה הזה מייצג מערך נתונים של עמלות. |
otjoinerInfo |
מבנה זה מייצג פרטי מחבר. |
otjoinerPskd |
המבנה הזה מייצג חיבור PSKd של מנוי. |
otSteeringData |
מבנה זה מייצג את נתוני ההיגוי. |
מספור
אירוע otCommissioner
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
|
צוין מזהה ג'נדר ( |
OT_JOINER_INFO_TYPE_EUI64
|
המחבר EUI-64 צוין ( |
סוג Dedef
otCommissionerReportCallCallback
void(* otCommissionerEnergyReportCallback)(uint32_t aChannelMask, const uint8_t *aEnergyList, uint8_t aEnergyListLength, void *aContext)
מצביע הפונקציה הזה נקרא כאשר הנציב מקבל דוח אנרגיה.
פרטים | |||||||||
---|---|---|---|---|---|---|---|---|---|
פרמטרים |
|
otCommissionerjoinerCallback
void(* otCommissionerJoinerCallback)(otCommissionerJoinerEvent aEvent, const otJoinerInfo *aJoinerInfo, const otExtAddress *aJoinerId, void *aContext)
הקריאה לפונקציה הזו נשלחת בכל פעם שמצב המצרף משתנה.
פרטים | |||||||||
---|---|---|---|---|---|---|---|---|---|
פרמטרים |
|
אירוע otCommissioner
enum otCommissionerJoinerEvent otCommissionerJoinerEvent
ספירה זו מגדירה אירוע הצטרפות בנציב.
otCommissionerPanIdהתנגשותCallback
void(* otCommissionerPanIdConflictCallback)(uint16_t aPanId, uint32_t aChannelMask, void *aContext)
מצביע הפונקציה הזה נקרא כאשר הנציב מקבל הודעה על התנגשות בין מזהה PAN.
פרטים | |||||||
---|---|---|---|---|---|---|---|
פרמטרים |
|
otCommissionerStateCallback
void(* otCommissionerStateCallback)(otCommissionerState aState, void *aContext)
הקריאה לפונקציה הזו מתבצעת בכל פעם שמצב הנציב משתנה.
פרטים | |||||
---|---|---|---|---|---|
פרמטרים |
|
otCommissioningDataset
struct otCommissioningDataset otCommissioningDataset
המבנה הזה מייצג מערך נתונים של עמלות.
פונקציות
otCommissionerAddמצטרפים
otError otCommissionerAddJoiner( otInstance *aInstance, const otExtAddress *aEui64, const char *aPskd, uint32_t aTimeout )
פונקציה זו מוסיפה רשומה של מצטרף.
פרטים | |||||||||
---|---|---|---|---|---|---|---|---|---|
פרמטרים |
|
||||||||
ערכי החזרה |
|
otCommissionerAddJOINerWithDiscerner
otError otCommissionerAddJoinerWithDiscerner( otInstance *aInstance, const otJoinerDiscerner *aDiscerner, const char *aPskd, uint32_t aTimeout )
פונקציה זו מוסיפה רשומה של Adder ל-Adder עם ערך נתון של Adder Discerner.
פרטים | |||||||||
---|---|---|---|---|---|---|---|---|---|
פרמטרים |
|
||||||||
ערכי החזרה |
|
otCommissionerAnnounceStart
otError otCommissionerAnnounceBegin( otInstance *aInstance, uint32_t aChannelMask, uint8_t aCount, uint16_t aPeriod, const otIp6Address *aAddress )
פונקציה זו שולחת הודעת Announce Start.
פרטים | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
פרמטרים |
|
||||||||||
ערכי החזרה |
|
otCommissionerEnergyScan
otError otCommissionerEnergyScan( otInstance *aInstance, uint32_t aChannelMask, uint8_t aCount, uint16_t aPeriod, uint16_t aScanDuration, const otIp6Address *aAddress, otCommissionerEnergyReportCallback aCallback, void *aContext )
פונקציה זו שולחת הודעה של שאילתת סריקת אנרגיה.
פרטים | |||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
פרמטרים |
|
||||||||||||||||
ערכי החזרה |
|
מזהה otCommissioner
const char * otCommissionerGetId( otInstance *aInstance )
פונקציה זו מחזירה את מזהה הנציב.
פרטים | |||
---|---|---|---|
פרמטרים |
|
||
החזרות |
מזהה העמלה.
|
פרטי otCommissionerGetNextמצטרפים
otError otCommissionerGetNextJoinerInfo( otInstance *aInstance, uint16_t *aIterator, otJoinerInfo *aJoiner )
שיטה זו מקבלת את פרטי המחבר במיקום של Iterator.
פרטים | |||||||
---|---|---|---|---|---|---|---|
פרמטרים |
|
||||||
ערכי החזרה |
|
otCommissionerGetConfigurationingUrl
const char * otCommissionerGetProvisioningUrl( otInstance *aInstance )
פונקציה זו מקבלת את כתובת ה-URL לניהול תצורה.
פרטים | |||
---|---|---|---|
פרמטרים |
|
||
החזרות |
מצביע על מחרוזת כתובת ה-URL.
|
otCommissionerGetSessionId
uint16_t otCommissionerGetSessionId( otInstance *aInstance )
פונקציה זו מחזירה את מזהה הסשן של הנציב.
פרטים | |||
---|---|---|---|
פרמטרים |
|
||
החזרות |
מזהה הסשן הנוכחי של העמלה.
|
otCommissionerGetState
otCommissionerState otCommissionerGetState( otInstance *aInstance )
פונקציה זו מחזירה את מצב נציב.
פרטים | |||||||
---|---|---|---|---|---|---|---|
פרמטרים |
|
||||||
ערכי החזרה |
|
otCommissionerPanIdQuery
otError otCommissionerPanIdQuery( otInstance *aInstance, uint16_t aPanId, uint32_t aChannelMask, const otIp6Address *aAddress, otCommissionerPanIdConflictCallback aCallback, void *aContext )
פונקציה זו שולחת הודעת שאילתה של מזהה (PAN).
פרטים | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
פרמטרים |
|
||||||||||||
ערכי החזרה |
|
הסרה של otCommissioner
otError otCommissionerRemoveJoiner( otInstance *aInstance, const otExtAddress *aEui64 )
פונקציה זו מסירה רשומה של מחבר.
פרטים | |||||||||
---|---|---|---|---|---|---|---|---|---|
פרמטרים |
|
||||||||
ערכי החזרה |
|
otCommissionerRemoveJOINer withDiscerner
otError otCommissionerRemoveJoinerWithDiscerner( otInstance *aInstance, const otJoinerDiscerner *aDiscerner )
פונקציה זו מסירה רשומה של מחבר.
פרטים | |||||||||
---|---|---|---|---|---|---|---|---|---|
פרמטרים |
|
||||||||
ערכי החזרה |
|
otCommissionerSendMgmtGet
otError otCommissionerSendMgmtGet( otInstance *aInstance, const uint8_t *aTlvs, uint8_t aLength )
פונקציה זו שולחת MGMT_COMMISSIONER_GET.
פרטים | |||||||
---|---|---|---|---|---|---|---|
פרמטרים |
|
||||||
ערכי החזרה |
|
otCommissionerSendMgmtSet
otError otCommissionerSendMgmtSet( otInstance *aInstance, const otCommissioningDataset *aDataset, const uint8_t *aTlvs, uint8_t aLength )
פונקציה זו שולחת את MGMT_COMMISSIONER_SET.
פרטים | |||||||||
---|---|---|---|---|---|---|---|---|---|
פרמטרים |
|
||||||||
ערכי החזרה |
|
מזהה otCommissioner
otError otCommissionerSetId( otInstance *aInstance, const char *aId )
פונקציה זו מגדירה את מזהה העמלה.
פרטים | |||||||
---|---|---|---|---|---|---|---|
פרמטרים |
|
||||||
ערכי החזרה |
|
otCommissionerSetassigningUrl
otError otCommissionerSetProvisioningUrl( otInstance *aInstance, const char *aProvisioningUrl )
פונקציה זו מגדירה את כתובת ה-URL לניהול ההקצאות.
פרטים | |||||
---|---|---|---|---|---|
פרמטרים |
|
||||
ערכי החזרה |
|
otCommissionerStart
otError otCommissionerStart( otInstance *aInstance, otCommissionerStateCallback aStateCallback, otCommissionerJoinerCallback aJoinerCallback, void *aCallbackContext )
הפונקציה הזו מאפשרת את התפקיד 'מנהל שרשורים'.
פרטים | |||||||||
---|---|---|---|---|---|---|---|---|---|
פרמטרים |
|
||||||||
ערכי החזרה |
|
otCommissionerStop
otError otCommissionerStop( otInstance *aInstance )
הפונקציה הזו משביתה את התפקיד 'מפקח על השרשור'.
פרטים | |||||
---|---|---|---|---|---|
פרמטרים |
|
||||
ערכי החזרה |
|
פקודות מאקרו
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
אורך מחרוזת מקסימלי של joinr PSKd (לא כולל null).
OT_PROVISIONING_URL_MAX_SIZE
OT_PROVISIONING_URL_MAX_SIZE 64
גודל מקסימלי (מספר תווים) במחרוזת של כתובת אתר לניהול תצורה (לא כולל תו ריק).
OT_STEERING_DATA_MAX_LENGTH
OT_STEERING_DATA_MAX_LENGTH 16
אורך מקסימלי של הגה (בייטים)
מקורות מידע
נושאי עזר של OpenThread API מגיעים מקוד המקור, שזמין ב-GitHub. למידע נוסף או כדי להוסיף מידע למסמכים שלנו, יש לעיין במשאבים.