מערך נתונים תפעולי

כולל פונקציות ל-API של מערך הנתונים התפעולי.

סיכום

בגרסאות build של FTD בלבד, Dataset Updater כולל פונקציות לניהול עדכונים של מערכי נתונים.

עבור גרסאות build של FTD ו-MTD, ה-API של מערך הנתונים התפעולי כולל פונקציות לניהול מערכי נתונים פעילים ובהמתנה ושל מערכי נתונים מסוג TLV של מערכי נתונים.

ספירות
otMeshcopTlvType{
  OT_MESHCOP_TLV_CHANNEL = 0,
  OT_MESHCOP_TLV_PANID = 1,
  OT_MESHCOP_TLV_EXTPANID = 2,
  OT_MESHCOP_TLV_NETWORKNAME = 3,
  OT_MESHCOP_TLV_PSKC = 4,
  OT_MESHCOP_TLV_NETWORKKEY = 5,
  OT_MESHCOP_TLV_NETWORK_KEY_SEQUENCE = 6,
  OT_MESHCOP_TLV_MESHLOCALPREFIX = 7,
  OT_MESHCOP_TLV_STEERING_DATA = 8,
  OT_MESHCOP_TLV_BORDER_AGENT_RLOC = 9,
  OT_MESHCOP_TLV_COMMISSIONER_ID = 10,
  OT_MESHCOP_TLV_COMM_SESSION_ID = 11,
  OT_MESHCOP_TLV_SECURITYPOLICY = 12,
  OT_MESHCOP_TLV_GET = 13,
  OT_MESHCOP_TLV_ACTIVETIMESTAMP = 14,
  OT_MESHCOP_TLV_COMMISSIONER_UDP_PORT = 15,
  OT_MESHCOP_TLV_STATE = 16,
  OT_MESHCOP_TLV_JOINER_DTLS = 17,
  OT_MESHCOP_TLV_JOINER_UDP_PORT = 18,
  OT_MESHCOP_TLV_JOINER_IID = 19,
  OT_MESHCOP_TLV_JOINER_RLOC = 20,
  OT_MESHCOP_TLV_JOINER_ROUTER_KEK = 21,
  OT_MESHCOP_TLV_PROVISIONING_URL = 32,
  OT_MESHCOP_TLV_VENDOR_NAME_TLV = 33,
  OT_MESHCOP_TLV_VENDOR_MODEL_TLV = 34,
  OT_MESHCOP_TLV_VENDOR_SW_VERSION_TLV = 35,
  OT_MESHCOP_TLV_VENDOR_DATA_TLV = 36,
  OT_MESHCOP_TLV_VENDOR_STACK_VERSION_TLV = 37,
  OT_MESHCOP_TLV_UDP_ENCAPSULATION_TLV = 48,
  OT_MESHCOP_TLV_IPV6_ADDRESS_TLV = 49,
  OT_MESHCOP_TLV_PENDINGTIMESTAMP = 51,
  OT_MESHCOP_TLV_DELAYTIMER = 52,
  OT_MESHCOP_TLV_CHANNELMASK = 53,
  OT_MESHCOP_TLV_COUNT = 54,
  OT_MESHCOP_TLV_PERIOD = 55,
  OT_MESHCOP_TLV_SCAN_DURATION = 56,
  OT_MESHCOP_TLV_ENERGY_LIST = 57,
  OT_MESHCOP_TLV_DISCOVERYREQUEST = 128,
  OT_MESHCOP_TLV_DISCOVERYRESPONSE = 129,
  OT_MESHCOP_TLV_JOINERADVERTISEMENT = 241
} 		טיפוסים בני מנייה (enum)
מייצג סוגי TLV של meshcop.

ערכי דף
otChannelMask typedef
uint32_t
מייצג את מסכת הערוץ.
otDatasetMgmtSetCallback)(otError aResult, void *aContext) typedef
void(*
המצביע מופעל כשמתקבלת תגובה לבקשת MGMT_SET או כשתם הזמן הקצוב לתפוגה.
otDatasetUpdaterCallback)(otError aError, void *aContext) typedef
void(*
המצביע הזה של פונקציית קריאה חוזרת מופעל בסיום בקשה לעדכון של מערך נתונים, ומדווח על סטטוס הצלחה או כשל של הבקשה לעדכון מערך נתונים.
otExtendedPanId typedef
מייצג מזהה של מספר חשבון קבוע (PAN) מורחב.
otMeshLocalPrefix typedef
מייצג קידומת מקומית ברשת.
otMeshcopTlvType typedef
מייצג סוגי TLV של meshcop.
otNetworkKey typedef
struct otNetworkKey
מייצג מפתח של Thread Network.
otNetworkKeyRef typedef
סוג נתונים זה מייצג את KeyRef ל-NetworkKey.
otNetworkName typedef
struct otNetworkName
מייצג שם של רשת.
otOperationalDataset typedef
מייצג מערך נתונים תפעולי פעיל או בהמתנה.
otOperationalDatasetComponents typedef
מייצג נוכחות של רכיבים שונים במערך נתונים תפעולי או בהמתנה.
otOperationalDatasetTlvs typedef
מייצג מערך נתונים תפעולי פעיל או בהמתנה.
otPskc typedef
struct otPskc
מייצג PSKc.
otPskcRef typedef
סוג הנתונים הזה מייצג את KeyRef ל-PSKc.
otSecurityPolicy typedef
לייצג את מדיניות האבטחה.
otTimestamp typedef
struct otTimestamp
מייצג רכיב חותמת זמן של Thread Dataset.

משתנים
OT_TOOL_PACKED_END

פונקציות
otDatasetConvertToTlvs(const otOperationalDataset *aDataset, otOperationalDatasetTlvs *aDatasetTlvs)
ממירה מערך נתונים תפעולי נתון ל-otOperationalDatasetTlvs.
otDatasetCreateNewNetwork(otInstance *aInstance, otOperationalDataset *aDataset)
עבור FTD בלבד, יוצר מערך נתונים תפעולי חדש לשימוש במהלך היצירה של רשת חדשה.
otDatasetGeneratePskc(const char *aPassPhrase, const otNetworkName *aNetworkName, const otExtendedPanId *aExtPanId, otPskc *aPskc)
יוצר PSKc מתוך ביטוי סיסמה, שם רשת ומזהה PAN מורחב.
otDatasetGetActive(otInstance *aInstance, otOperationalDataset *aDataset)
מקבל את מערך הנתונים התפעולי הפעיל.
otDatasetGetActiveTlvs(otInstance *aInstance, otOperationalDatasetTlvs *aDataset)
מקבל את מערך הנתונים התפעולי הפעיל.
otDatasetGetDelayTimerMinimal(otInstance *aInstance)
uint32_t
עבור FTD בלבד, מקבל טיימר השהיה מינימלי.
otDatasetGetPending(otInstance *aInstance, otOperationalDataset *aDataset)
הפונקציה מקבלת את מערך הנתונים התפעולי בהמתנה.
otDatasetGetPendingTlvs(otInstance *aInstance, otOperationalDatasetTlvs *aDataset)
הפונקציה מקבלת את מערך הנתונים התפעולי בהמתנה.
otDatasetIsCommissioned(otInstance *aInstance)
bool
הערך מציין אם קיימת רשת חוקית במערך הנתונים הפעיל של נתונים.
otDatasetParseTlvs(const otOperationalDatasetTlvs *aDatasetTlvs, otOperationalDataset *aDataset)
הפונקציה מנתחת מערך נתונים תפעולי מ-otOperationalDatasetTlvs נתון.
otDatasetSendMgmtActiveGet(otInstance *aInstance, const otOperationalDatasetComponents *aDatasetComponents, const uint8_t *aTlvTypes, uint8_t aLength, const otIp6Address *aAddress)
נשלחת MGMT_ACTIVE_GET.
otDatasetSendMgmtActiveSet(otInstance *aInstance, const otOperationalDataset *aDataset, const uint8_t *aTlvs, uint8_t aLength, otDatasetMgmtSetCallback aCallback, void *aContext)
שולחת MGMT_ACTIVE_SET.
otDatasetSendMgmtPendingGet(otInstance *aInstance, const otOperationalDatasetComponents *aDatasetComponents, const uint8_t *aTlvTypes, uint8_t aLength, const otIp6Address *aAddress)
שליחת MGMT_PENDING_GET.
otDatasetSendMgmtPendingSet(otInstance *aInstance, const otOperationalDataset *aDataset, const uint8_t *aTlvs, uint8_t aLength, otDatasetMgmtSetCallback aCallback, void *aContext)
שולח MGMT_PENDING_SET.
otDatasetSetActive(otInstance *aInstance, const otOperationalDataset *aDataset)
מגדיר את מערך הנתונים הפעיל של נתונים.
otDatasetSetActiveTlvs(otInstance *aInstance, const otOperationalDatasetTlvs *aDataset)
מגדיר את מערך הנתונים הפעיל של נתונים.
otDatasetSetDelayTimerMinimal(otInstance *aInstance, uint32_t aDelayTimerMinimal)
עבור FTD בלבד, מגדיר טיימר השהיה מינימלי.
otDatasetSetPending(otInstance *aInstance, const otOperationalDataset *aDataset)
מגדיר את מערך הנתונים בהמתנה לתפעול.
otDatasetSetPendingTlvs(otInstance *aInstance, const otOperationalDatasetTlvs *aDataset)
מגדיר את מערך הנתונים בהמתנה לתפעול.
otDatasetUpdateTlvs(const otOperationalDataset *aDataset, otOperationalDatasetTlvs *aDatasetTlvs)
מעדכן מערך נתונים תפעולי נתון.
otDatasetUpdaterCancelUpdate(otInstance *aInstance)
void
ביטול של בקשה פעילה לעדכון מערך נתונים תפעולי (אם יש כזו).
otDatasetUpdaterIsUpdateOngoing(otInstance *aInstance)
bool
שדה זה מציין אם יש בקשה פעילה לעדכון מערך הנתונים של פעולות.
otDatasetUpdaterRequestUpdate(otInstance *aInstance, const otOperationalDataset *aDataset, otDatasetUpdaterCallback aCallback, void *aContext)
נשלחת בקשה לעדכון מערך הנתונים התפעולי.
otNetworkNameFromString(otNetworkName *aNetworkName, const char *aNameString)
מגדירה מופע של otNetworkName ממחרוזת C נתונה שמסתיימת ב-null.

מבנים
otExtendedPanId

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

otNetworkKey

מייצג מפתח של Thread Network.

otNetworkName

מייצג שם של רשת.

otOperationalDataset

מייצג מערך נתונים תפעולי פעיל או בהמתנה.

otOperationalDatasetComponents

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

otOperationalDatasetTlvs

מייצג מערך נתונים תפעולי פעיל או בהמתנה.

otPskc

מייצג את PSKc.

otSecurityPolicy

לייצג את מדיניות האבטחה.

otTimestamp

מייצג רכיב חותמת זמן של Thread Dataset.

ספירות

otMeshcopTlvType

 otMeshcopTlvType

מייצג סוגי TLV של meshcop.

תכונות
OT_MESHCOP_TLV_ACTIVETIMESTAMP

חותמת זמן פעילה של meshcop TLV

OT_MESHCOP_TLV_BORDER_AGENT_RLOC

meshcop Border Agent Locator TLV

OT_MESHCOP_TLV_CHANNEL

ערוץ Meshcop TLV

OT_MESHCOP_TLV_CHANNELMASK

מסכת ערוצים של Meshop TLV

OT_MESHCOP_TLV_COMMISSIONER_ID

מספר עמלה של meshcop TLV

OT_MESHCOP_TLV_COMMISSIONER_UDP_PORT

meshcop Commissioner UDP יציאה TLV

OT_MESHCOP_TLV_COMM_SESSION_ID

מזהה מפגש נציבות ב-Meshcop TLV

OT_MESHCOP_TLV_COUNT

ספירת TLV ב-Meshcop

OT_MESHCOP_TLV_DELAYTIMER

טיימר השהיה של meshcop TLV

OT_MESHCOP_TLV_DISCOVERYREQUEST

TLV של בקשת Discovery ב-Meshcop

OT_MESHCOP_TLV_DISCOVERYRESPONSE

meshcop Discovery Response TLV

OT_MESHCOP_TLV_ENERGY_LIST

רשימת אנרגיה של meshcop TLV

OT_MESHCOP_TLV_EXTPANID

Meshcop Extended Pan ID TLV

OT_MESHCOP_TLV_GET

meshcop קבלת TLV

OT_MESHCOP_TLV_IPV6_ADDRESS_TLV

meshcop כתובת IPv6 TLV

OT_MESHCOP_TLV_JOINERADVERTISEMENT

פרסומת למצטרפים ב-Meshcop TLV

OT_MESHCOP_TLV_JOINER_DTLS

TLV של meshcop Shareder DTLS Encapsulation

OT_MESHCOP_TLV_JOINER_IID

meshcop Shareder IID TLV

OT_MESHCOP_TLV_JOINER_RLOC

מס'ופ רוטר Locator TLV

OT_MESHCOP_TLV_JOINER_ROUTER_KEK

נתב"ר KEK TLV

OT_MESHCOP_TLV_JOINER_UDP_PORT

meshcop joiner UDP Port TLV

OT_MESHCOP_TLV_MESHLOCALPREFIX

meshcop Mesh קידומת מקומית TLV

OT_MESHCOP_TLV_NETWORKKEY

Mehcop Network Key TLV

OT_MESHCOP_TLV_NETWORKNAME

שם הרשת ב-meshcop TLV

OT_MESHCOP_TLV_NETWORK_KEY_SEQUENCE

TLV של רצף מפתחות רשת

OT_MESHCOP_TLV_PANID

meshcop Pan Id TLV

OT_MESHCOP_TLV_PENDINGTIMESTAMP

Mehcop חותמת זמן בהמתנה TLV

OT_MESHCOP_TLV_PERIOD

מונה תקופתי TLV

OT_MESHCOP_TLV_PROVISIONING_URL

TLV של כתובת URL להקצאת meshcop

OT_MESHCOP_TLV_PSKC

Meshop PSKc TLV

OT_MESHCOP_TLV_SCAN_DURATION

משך הסריקה של meshcop, TLV

OT_MESHCOP_TLV_SECURITYPOLICY

TLV של מדיניות האבטחה של meshcop

OT_MESHCOP_TLV_STATE

TLV ב-Meshcop State

OT_MESHCOP_TLV_STEERING_DATA

meshcop היגוי נתונים TLV

OT_MESHCOP_TLV_UDP_ENCAPSULATION_TLV

TLV של אנקפסולציה UDP

OT_MESHCOP_TLV_VENDOR_DATA_TLV

TLV של נתוני ספק ב-Meshcop

OT_MESHCOP_TLV_VENDOR_MODEL_TLV

דגם ספק meshcop TLV

OT_MESHCOP_TLV_VENDOR_NAME_TLV

שם הספק TLV ב-Meshcop

OT_MESHCOP_TLV_VENDOR_STACK_VERSION_TLV

גרסת Stack – TLV של ספק

OT_MESHCOP_TLV_VENDOR_SW_VERSION_TLV

ספק meshcop SW גרסה TLV

ערכי דף

otChannelMask

uint32_t otChannelMask

מייצג את מסכת הערוץ.

otDatasetMgmtSetCallback

void(* otDatasetMgmtSetCallback)(otError aResult, void *aContext)

המצביע מופעל כשמתקבלת תגובה לבקשת MGMT_SET או כשתם הזמן הקצוב לתפוגה.

פרטים
פרמטרים
[in] aResult
תוצאה של הפעולה.
[in] aContext
הפניה להקשר ספציפי לאפליקציה.
ערכים מוחזרים
OT_ERROR_NONE
הבקשה אושרה על ידי המנהיג.
OT_ERROR_REJECTED
הבקשה נדחתה על ידי המנהיג.
OT_ERROR_PARSE
אירעה שגיאה במהלך ניתוח התגובה.
OT_ERROR_ABORT
הבקשה אופסה על ידי עמית.
OT_ERROR_RESPONSE_TIMEOUT
לא התקבלה תגובה או אישור במהלך תקופת הזמן הקצוב לתפוגה.

otDatasetUpdaterCallback

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

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

זמין כאשר OPENTHREAD_CONFIG_DATASET_UPDATER_ENABLE מופעל.

פרטים
פרמטרים
[in] aError
סטטוס השגיאה. OT_ERROR_NONE מציין שהעדכון של מערך הנתונים בוצע בהצלחה. OT_ERROR_INVALID_STATE מציין כשל בשל מצב לא חוקי (MLE מושבת). OT_ERROR_ALREADY מציין כשל בשל מכשיר אחר ברשת שמבקש עדכון מתנגש של מערך נתונים.
[in] aContext
הפניה להקשר שרירותי (נשלח על ידי המשתמש/ת ב-otDatasetUpdaterRequestUpdate()).

otExtendedPanId

struct otExtendedPanId otExtendedPanId

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

otMeshLocalPrefix

otIp6NetworkPrefix otMeshLocalPrefix

מייצג קידומת מקומית ברשת.

otMeshcopTlvType

enum otMeshcopTlvType otMeshcopTlvType

מייצג סוגי TLV של meshcop.

otNetworkKey

struct otNetworkKey otNetworkKey

מייצג מפתח של Thread Network.

otNetworkKeyRef

otCryptoKeyRef otNetworkKeyRef

סוג נתונים זה מייצג את KeyRef ל-NetworkKey.

הפניה למפתח

otNetworkName

struct otNetworkName otNetworkName

מייצג שם של רשת.

הערך otNetworkName הוא מחרוזת C שמסתיימת ב-null (כלומר, מערך התווים m8 חייב להסתיים בתו null \0).

otOperationalDataset

struct otOperationalDataset otOperationalDataset

מייצג מערך נתונים תפעולי פעיל או בהמתנה.

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

otOperationalDatasetComponents

struct otOperationalDatasetComponents otOperationalDatasetComponents

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

otOperationalDatasetTlvs

struct otOperationalDatasetTlvs otOperationalDatasetTlvs

מייצג מערך נתונים תפעולי פעיל או בהמתנה.

מערך הנתונים התפעולי מקודד בשיטת TLV כפי שצוין ב-Thread.

otPskc

struct otPskc otPskc

מייצג PSKc.

otPskcRef

otCryptoKeyRef otPskcRef

סוג הנתונים הזה מייצג את KeyRef ל-PSKc.

הפניה למפתח

otSecurityPolicy

struct otSecurityPolicy otSecurityPolicy

לייצג את מדיניות האבטחה.

otTimestamp

struct otTimestamp otTimestamp

מייצג רכיב חותמת זמן של Thread Dataset.

משתנים

OT_TOOL_PACKED_END

OT_TOOL_PACKED_BEGIN struct otNetworkKey OT_TOOL_PACKED_END

פונקציות

otDatasetConvertToTlvs

otError otDatasetConvertToTlvs(
  const otOperationalDataset *aDataset,
  otOperationalDatasetTlvs *aDatasetTlvs
)

ממירה מערך נתונים תפעולי נתון ל-otOperationalDatasetTlvs.

פרטים
פרמטרים
[in] aDataset
מערך נתונים תפעולי שיש להמיר ל-TLV.
[out] aDatasetTlvs
הפניה למערכי נתונים מסוג TLV כדי להחזיר את התוצאה.
ערכים מוחזרים
OT_ERROR_NONE
aDataset הומרו בהצלחה ו-aDatasetTlvs עודכן.
OT_ERROR_INVALID_ARGS
aDataset לא חוקית. היא לא מכילה חותמות זמן פעילות או בהמתנה.

otDatasetCreateNewNetwork

otError otDatasetCreateNewNetwork(
  otInstance *aInstance,
  otOperationalDataset *aDataset
)

עבור FTD בלבד, יוצר מערך נתונים תפעולי חדש לשימוש במהלך היצירה של רשת חדשה.

פרטים
פרמטרים
[in] aInstance
מצביע למופע של OpenThread.
[out] aDataset
מערך הנתונים התפעולי.
ערכים מוחזרים
OT_ERROR_NONE
יצרת בהצלחה מערך נתונים תפעולי חדש.
OT_ERROR_FAILED
יצירת ערכים אקראיים לפרמטרים חדשים נכשלה.

otDatasetGeneratePskc

otError otDatasetGeneratePskc(
  const char *aPassPhrase,
  const otNetworkName *aNetworkName,
  const otExtendedPanId *aExtPanId,
  otPskc *aPskc
)

יוצר PSKc מתוך ביטוי סיסמה, שם רשת ומזהה PAN מורחב.

PSKc משמש לקביעת ישיבת הנציב.

פרטים
פרמטרים
[in] aPassPhrase
ביטוי הסיסמה לפתיחה.
[in] aNetworkName
שם הרשת לחישוב PSKc.
[in] aExtPanId
מזהה ה-PAN המורחב עבור חישוב PSKc.
[out] aPskc
מצביע למשתנה שיפיק פלט של ה-PSKc שנוצר.
ערכים מוחזרים
OT_ERROR_NONE
יצירת PSKc בהצלחה.
OT_ERROR_INVALID_ARGS
אם ארגומנט כלשהו מהקלט אינו חוקי.

otDatasetGetActive

otError otDatasetGetActive(
  otInstance *aInstance,
  otOperationalDataset *aDataset
)

מקבל את מערך הנתונים התפעולי הפעיל.

פרטים
פרמטרים
[in] aInstance
מצביע למופע של OpenThread.
[out] aDataset
מצביע למקום שבו ימוקם מערך הנתונים הפעיל של נתונים.
ערכים מוחזרים
OT_ERROR_NONE
מערך הנתונים הפעיל של הנתונים אוחזר בהצלחה.
OT_ERROR_NOT_FOUND
אין ערך מתאים במאגר ההגדרות.

otDatasetGetActiveTlvs

otError otDatasetGetActiveTlvs(
  otInstance *aInstance,
  otOperationalDatasetTlvs *aDataset
)

מקבל את מערך הנתונים התפעולי הפעיל.

פרטים
פרמטרים
[in] aInstance
מצביע למופע של OpenThread.
[out] aDataset
מצביע למקום שבו ימוקם מערך הנתונים הפעיל של נתונים.
ערכים מוחזרים
OT_ERROR_NONE
מערך הנתונים הפעיל של הנתונים אוחזר בהצלחה.
OT_ERROR_NOT_FOUND
אין ערך מתאים במאגר ההגדרות.

otDatasetGetDelayTimerMinimal

uint32_t otDatasetGetDelayTimerMinimal(
  otInstance *aInstance
)

עבור FTD בלבד, מקבל טיימר השהיה מינימלי.

פרטים
פרמטרים
[in] aInstance
מצביע למופע של OpenThread.
ערכים מוחזרים
the
ערך של טיימר השהיה מינימלי (באלפיות השנייה).

otDatasetGetPending

otError otDatasetGetPending(
  otInstance *aInstance,
  otOperationalDataset *aDataset
)

הפונקציה מקבלת את מערך הנתונים התפעולי בהמתנה.

פרטים
פרמטרים
[in] aInstance
מצביע למופע של OpenThread.
[out] aDataset
מצביע למקום שבו ימוקם מערך הנתונים התפעוליים הממתינים.
ערכים מוחזרים
OT_ERROR_NONE
מערך הנתונים התפעולי בהמתנה אוחזר בהצלחה.
OT_ERROR_NOT_FOUND
אין ערך מתאים במאגר ההגדרות.

otDatasetGetPendingTlvs

otError otDatasetGetPendingTlvs(
  otInstance *aInstance,
  otOperationalDatasetTlvs *aDataset
)

הפונקציה מקבלת את מערך הנתונים התפעולי בהמתנה.

פרטים
פרמטרים
[in] aInstance
מצביע למופע של OpenThread.
[out] aDataset
מצביע למקום שבו ימוקם מערך הנתונים התפעוליים הממתינים.
ערכים מוחזרים
OT_ERROR_NONE
מערך הנתונים התפעולי בהמתנה אוחזר בהצלחה.
OT_ERROR_NOT_FOUND
אין ערך מתאים במאגר ההגדרות.

otDatasetIsCommissioned

bool otDatasetIsCommissioned(
  otInstance *aInstance
)

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

פרטים
פרמטרים
[in] aInstance
מצביע למופע של OpenThread.
החזרות
TRUE אם קיימת רשת חוקית במערך הנתונים הפעיל של נתונים, FALSE אם לא.

otDatasetParseTlvs

otError otDatasetParseTlvs(
  const otOperationalDatasetTlvs *aDatasetTlvs,
  otOperationalDataset *aDataset
)

הפונקציה מנתחת מערך נתונים תפעולי מ-otOperationalDatasetTlvs נתון.

פרטים
פרמטרים
[in] aDatasetTlvs
הפניה למערך נתונים מסוג TLV.
[out] aDataset
מצביע למקום שבו ימוקם מערך הנתונים.
ערכים מוחזרים
OT_ERROR_NONE
ההגדרה של aDataset בוצעה בהצלחה ב-aDatasetTlvs.
OT_ERROR_INVALID_ARGS
aDatasetTlvs אינו חוקי.

otDatasetSendMgmtActiveGet

otError otDatasetSendMgmtActiveGet(
  otInstance *aInstance,
  const otOperationalDatasetComponents *aDatasetComponents,
  const uint8_t *aTlvTypes,
  uint8_t aLength,
  const otIp6Address *aAddress
)

נשלחת MGMT_ACTIVE_GET.

פרטים
פרמטרים
[in] aInstance
מצביע למופע של OpenThread.
[in] aDatasetComponents
הפניה למבנה של רכיבי מערך נתונים שמציין אילו רכיבים לבקש.
[in] aTlvTypes
הפניה למערך שמכיל סוגי TLV גולמיים נוספים שיש לבקש.
[in] aLength
האורך של aTlvTypes.
[in] aAddress
אזכור ליעד IPv6, אם הוא NULL, ישתמש ב-Leader ALOC כברירת מחדל.
ערכים מוחזרים
OT_ERROR_NONE
שלחת בהצלחה את הפקודה של מערך הנתונים meshcop.
OT_ERROR_NO_BUFS
אין מספיק מקום אחסון זמני לשליחה.

otDatasetSendMgmtActiveSet

otError otDatasetSendMgmtActiveSet(
  otInstance *aInstance,
  const otOperationalDataset *aDataset,
  const uint8_t *aTlvs,
  uint8_t aLength,
  otDatasetMgmtSetCallback aCallback,
  void *aContext
)

שולחת MGMT_ACTIVE_SET.

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

otDatasetSendMgmtPendingGet

otError otDatasetSendMgmtPendingGet(
  otInstance *aInstance,
  const otOperationalDatasetComponents *aDatasetComponents,
  const uint8_t *aTlvTypes,
  uint8_t aLength,
  const otIp6Address *aAddress
)

שליחת MGMT_PENDING_GET.

פרטים
פרמטרים
[in] aInstance
מצביע למופע של OpenThread.
[in] aDatasetComponents
הפניה למבנה של רכיבי מערך נתונים שמציין אילו רכיבים לבקש.
[in] aTlvTypes
הפניה למערך שמכיל סוגי TLV גולמיים נוספים שיש לבקש.
[in] aLength
האורך של aTlvTypes.
[in] aAddress
אזכור ליעד IPv6, אם הוא NULL, ישתמש ב-Leader ALOC כברירת מחדל.
ערכים מוחזרים
OT_ERROR_NONE
שלחת בהצלחה את הפקודה של מערך הנתונים meshcop.
OT_ERROR_NO_BUFS
אין מספיק מקום אחסון זמני לשליחה.

otDatasetSendMgmtPendingSet

otError otDatasetSendMgmtPendingSet(
  otInstance *aInstance,
  const otOperationalDataset *aDataset,
  const uint8_t *aTlvs,
  uint8_t aLength,
  otDatasetMgmtSetCallback aCallback,
  void *aContext
)

שולח MGMT_PENDING_SET.

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

otDatasetSetActive

otError otDatasetSetActive(
  otInstance *aInstance,
  const otOperationalDataset *aDataset
)

מגדיר את מערך הנתונים הפעיל של נתונים.

אם מערך הנתונים לא כולל חותמת זמן פעילה, מערך הנתונים שלם רק באופן חלקי.

אם הפעלת פרוטוקול Thread מופעלת במכשיר שיש בו מערך נתונים פעיל חלקית, המכשיר ינסה להתחבר לרשת Thread קיימת באמצעות המידע הקיים במערך הנתונים. רק מפתח Thread Network נדרש כדי לחבר לרשת.

אם הערוץ לא נכלל במערך הנתונים, המכשיר ישלח הודעות MLE הכרזה בערוצים שונים כדי למצוא שכנים בערוצים אחרים.

אם המכשיר מתחבר בהצלחה לרשת Thread, המכשיר יאחזר את מערך הנתונים הפעיל המלא מהורה שלו. חשוב לזכור שמכשיר שתומך בנתב לא יעבור לתפקידים 'נתב' או 'מוביל' עד שיהיו בו מערך נתונים פעיל מלא.

פרטים
פרמטרים
[in] aInstance
מצביע למופע של OpenThread.
[in] aDataset
הפניה למערך הנתונים התפעולי הפעיל.
ערכים מוחזרים
OT_ERROR_NONE
מערך הנתונים הפעיל של הנתונים הוגדר בהצלחה.
OT_ERROR_NO_BUFS
אין מספיק מקום במאגר הנתונים הזמני כדי להגדיר את מערך הנתונים הפעיל של נתונים.
OT_ERROR_NOT_IMPLEMENTED
הפלטפורמה לא מטמיעה פונקציונליות של הגדרות.

otDatasetSetActiveTlvs

otError otDatasetSetActiveTlvs(
  otInstance *aInstance,
  const otOperationalDatasetTlvs *aDataset
)

מגדיר את מערך הנתונים הפעיל של נתונים.

אם מערך הנתונים לא כולל חותמת זמן פעילה, מערך הנתונים שלם רק באופן חלקי.

אם הפעלת פרוטוקול Thread מופעלת במכשיר שיש בו מערך נתונים פעיל חלקית, המכשיר ינסה להתחבר לרשת Thread קיימת באמצעות המידע הקיים במערך הנתונים. רק מפתח Thread Network נדרש כדי לחבר לרשת.

אם הערוץ לא נכלל במערך הנתונים, המכשיר ישלח הודעות MLE הכרזה בערוצים שונים כדי למצוא שכנים בערוצים אחרים.

אם המכשיר מתחבר בהצלחה לרשת Thread, המכשיר יאחזר את מערך הנתונים הפעיל המלא מהורה שלו. חשוב לזכור שמכשיר שתומך בנתב לא יעבור לתפקידים 'נתב' או 'מוביל' עד שיהיו בו מערך נתונים פעיל מלא.

פרטים
פרמטרים
[in] aInstance
מצביע למופע של OpenThread.
[in] aDataset
הפניה למערך הנתונים התפעולי הפעיל.
ערכים מוחזרים
OT_ERROR_NONE
מערך הנתונים הפעיל של הנתונים הוגדר בהצלחה.
OT_ERROR_NO_BUFS
אין מספיק מקום במאגר הנתונים הזמני כדי להגדיר את מערך הנתונים הפעיל של נתונים.
OT_ERROR_NOT_IMPLEMENTED
הפלטפורמה לא מטמיעה פונקציונליות של הגדרות.

otDatasetSetDelayTimerMinimal

otError otDatasetSetDelayTimerMinimal(
  otInstance *aInstance,
  uint32_t aDelayTimerMinimal
)

עבור FTD בלבד, מגדיר טיימר השהיה מינימלי.

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

otDatasetSetPending

otError otDatasetSetPending(
  otInstance *aInstance,
  const otOperationalDataset *aDataset
)

מגדיר את מערך הנתונים בהמתנה לתפעול.

פרטים
פרמטרים
[in] aInstance
מצביע למופע של OpenThread.
[in] aDataset
הפניה למערך הנתונים התפעולי בהמתנה.
ערכים מוחזרים
OT_ERROR_NONE
מערך הנתונים 'בהמתנה לתפעול' הוגדר בהצלחה.
OT_ERROR_NO_BUFS
אין מספיק מקום במאגר נתונים זמני כדי להגדיר את מערך הנתונים התפעולי בהמתנה.
OT_ERROR_NOT_IMPLEMENTED
הפלטפורמה לא מטמיעה פונקציונליות של הגדרות.

otDatasetSetPendingTlvs

otError otDatasetSetPendingTlvs(
  otInstance *aInstance,
  const otOperationalDatasetTlvs *aDataset
)

מגדיר את מערך הנתונים בהמתנה לתפעול.

פרטים
פרמטרים
[in] aInstance
מצביע למופע של OpenThread.
[in] aDataset
הפניה למערך הנתונים התפעולי בהמתנה.
ערכים מוחזרים
OT_ERROR_NONE
מערך הנתונים 'בהמתנה לתפעול' הוגדר בהצלחה.
OT_ERROR_NO_BUFS
אין מספיק מקום במאגר נתונים זמני כדי להגדיר את מערך הנתונים התפעולי בהמתנה.
OT_ERROR_NOT_IMPLEMENTED
הפלטפורמה לא מטמיעה פונקציונליות של הגדרות.

otDatasetUpdateTlvs

otError otDatasetUpdateTlvs(
  const otOperationalDataset *aDataset,
  otOperationalDatasetTlvs *aDatasetTlvs
)

מעדכן מערך נתונים תפעולי נתון.

aDataset מכיל את השדות לעדכון ואת הערך החדש שלהם.

פרטים
פרמטרים
[in] aDataset
מציינת את קבוצת הסוגים והערכים לעדכון.
[in,out] aDatasetTlvs
מצביע על כך שה-TLV של מערכי הנתונים צריך לעדכן.
ערכים מוחזרים
OT_ERROR_NONE
aDatasetTlvs עודכן בהצלחה.
OT_ERROR_INVALID_ARGS
aDataset מכיל ערכים לא חוקיים.
OT_ERROR_NO_BUFS
אין מספיק מקום אחסון פנוי ב-aDatasetTlvs כדי להחיל את העדכון.

otDatasetUpdaterCancelUpdate

void otDatasetUpdaterCancelUpdate(
  otInstance *aInstance
)

ביטול של בקשה פעילה לעדכון מערך נתונים תפעולי (אם יש כזו).

זמין כאשר OPENTHREAD_CONFIG_DATASET_UPDATER_ENABLE מופעל.

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

otDatasetUpdaterIsUpdateOngoing

bool otDatasetUpdaterIsUpdateOngoing(
  otInstance *aInstance
)

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

זמין כאשר OPENTHREAD_CONFIG_DATASET_UPDATER_ENABLE מופעל.

פרטים
פרמטרים
[in] aInstance
מצביע למופע של OpenThread.
ערכים מוחזרים
TRUE
יש עדכון מתמשך.
FALSE
אין עדכון מתמשך.

otDatasetUpdaterRequestUpdate

otError otDatasetUpdaterRequestUpdate(
  otInstance *aInstance,
  const otOperationalDataset *aDataset,
  otDatasetUpdaterCallback aCallback,
  void *aContext
)

נשלחת בקשה לעדכון מערך הנתונים התפעולי.

זמין כאשר OPENTHREAD_CONFIG_DATASET_UPDATER_ENABLE מופעל.

השדה aDataset צריך להכיל את השדות שיש לעדכן ואת הערך החדש שלהם. היא לא יכולה להכיל שדות של חותמת זמן פעילה או בהמתנה. השדה 'השהיה' הוא אופציונלי, אם לא צוין ערך ברירת מחדל (1,000 אלפיות שנייה).

פרטים
פרמטרים
[in] aInstance
מצביע למופע של OpenThread.
[in] aDataset
מצביע על כך למערך הנתונים שמכיל את השדות לשינוי.
[in] aCallback
קריאה חוזרת (callback) שמציינת מתי הסתיימה הבקשה לעדכון מערך הנתונים.
[in] aContext
הקשר שרירותי שהועבר לקריאה חוזרת (callback).
ערכים מוחזרים
OT_ERROR_NONE
עדכון מערך הנתונים התחיל בהצלחה (aCallback יופעל בסיום).
OT_ERROR_INVALID_STATE
המכשיר מושבת (MLE מושבת).
OT_ERROR_INVALID_ARGS
aDataset לא חוקי (מכיל חותמת זמן פעילה או בהמתנה).
OT_ERROR_BUSY
לא ניתן להתחיל את העדכון. העדכון הקודם מתבצע.
OT_ERROR_NO_BUFS
לא ניתן להקצות מאגר נתונים זמני לשמירת מערך הנתונים.

otNetworkNameFromString

otError otNetworkNameFromString(
  otNetworkName *aNetworkName,
  const char *aNameString
)

מגדירה מופע של otNetworkName ממחרוזת C נתונה שמסתיימת ב-null.

הערך של aNameString חייב להיות בקידוד UTF-8 והאורך של שם הרשת לא יכול להיות ארוך מ-OT_NETWORK_NAME_MAX_SIZE.

פרטים
פרמטרים
[out] aNetworkName
מצביע אל otNetworkName כדי להגדיר.
[in] aNameString
מחרוזת שם C.
ערכים מוחזרים
OT_ERROR_NONE
ההגדרה של aNetworkName בוצעה בהצלחה ב-aNameString.
OT_ERROR_INVALID_ARGS
aNameStrng אינו חוקי (ארוך מדי או שאינו מותאם לקידוד UTF-8).

פקודות מאקרו

OT_CHANNEL_10_MASK

 OT_CHANNEL_10_MASK (1 << 10)

ערוץ 10.

OT_CHANNEL_11_MASK

 OT_CHANNEL_11_MASK (1 << 11)

ערוץ 11.

OT_CHANNEL_12_MASK

 OT_CHANNEL_12_MASK (1 << 12)

ערוץ 12.

OT_CHANNEL_13_MASK

 OT_CHANNEL_13_MASK (1 << 13)

ערוץ 13.

OT_CHANNEL_14_MASK

 OT_CHANNEL_14_MASK (1 << 14)

ערוץ 14.

OT_CHANNEL_15_MASK

 OT_CHANNEL_15_MASK (1 << 15)

ערוץ 15.

OT_CHANNEL_16_MASK

 OT_CHANNEL_16_MASK (1 << 16)

ערוץ 16.

OT_CHANNEL_17_MASK

 OT_CHANNEL_17_MASK (1 << 17)

ערוץ 17.

OT_CHANNEL_18_MASK

 OT_CHANNEL_18_MASK (1 << 18)

ערוץ 18.

OT_CHANNEL_19_MASK

 OT_CHANNEL_19_MASK (1 << 19)

ערוץ 19.

OT_CHANNEL_1_MASK

 OT_CHANNEL_1_MASK (1 << 1)

ערוץ 1.

OT_CHANNEL_20_MASK

 OT_CHANNEL_20_MASK (1 << 20)

ערוץ 20.

OT_CHANNEL_21_MASK

 OT_CHANNEL_21_MASK (1 << 21)

ערוץ 21.

OT_CHANNEL_22_MASK

 OT_CHANNEL_22_MASK (1 << 22)

ערוץ 22.

OT_CHANNEL_23_MASK

 OT_CHANNEL_23_MASK (1 << 23)

ערוץ 23.

OT_CHANNEL_24_MASK

 OT_CHANNEL_24_MASK (1 << 24)

ערוץ 24.

OT_CHANNEL_25_MASK

 OT_CHANNEL_25_MASK (1 << 25)

ערוץ 25.

OT_CHANNEL_26_MASK

 OT_CHANNEL_26_MASK (1 << 26)

ערוץ 26.

OT_CHANNEL_2_MASK

 OT_CHANNEL_2_MASK (1 << 2)

ערוץ 2.

OT_CHANNEL_3_MASK

 OT_CHANNEL_3_MASK (1 << 3)

ערוץ 3.

OT_CHANNEL_4_MASK

 OT_CHANNEL_4_MASK (1 << 4)

ערוץ 4.

OT_CHANNEL_5_MASK

 OT_CHANNEL_5_MASK (1 << 5)

ערוץ 5.

OT_CHANNEL_6_MASK

 OT_CHANNEL_6_MASK (1 << 6)

ערוץ 6.

OT_CHANNEL_7_MASK

 OT_CHANNEL_7_MASK (1 << 7)

ערוץ 7.

OT_CHANNEL_8_MASK

 OT_CHANNEL_8_MASK (1 << 8)

ערוץ 8.

OT_CHANNEL_9_MASK

 OT_CHANNEL_9_MASK (1 << 9)

ערוץ 9.

OT_EXT_PAN_ID_SIZE

 OT_EXT_PAN_ID_SIZE 8

גודל המזהה של מספר ה-PAN של שרשור (בבייטים)

OT_MESH_LOCAL_PREFIX_SIZE

 OT_MESH_LOCAL_PREFIX_SIZE OT_IP6_PREFIX_SIZE

גודל הקידומת המקומית ברשת (בייטים)

OT_NETWORK_KEY_SIZE

 OT_NETWORK_KEY_SIZE 16

גודל מפתח הרשת של Thread (בייטים)

OT_NETWORK_NAME_MAX_SIZE

 OT_NETWORK_NAME_MAX_SIZE 16

הגודל המקסימלי של השדה Thread Network Name (בבייטים)

OT_OPERATIONAL_DATASET_MAX_LENGTH

 OT_OPERATIONAL_DATASET_MAX_LENGTH 254

האורך המקסימלי של מערך הנתונים התפעולי בבייטים.

OT_PSKC_MAX_SIZE

 OT_PSKC_MAX_SIZE 16

הגודל המקסימלי של ה-PSKc (בייטים)

מקורות מידע

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