דף זה תורגם על ידי Cloud Translation API.

ממשק שורת הפקודה (CLI)

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

סיכום

סוג שגיאות
`otCliOutputCallback)(void aContext, const char aFormat, va_list aArguments)`	typedef `int(*` המצביע נקרא כדי לקבל הודעה לגבי הפלט של Console.

פונקציות
`otCliAppendResult(otError aError)`	`void` כותבים קוד שגיאה במסוף CLI.
`otCliInit(otInstance aInstance, otCliOutputCallback aCallback, void aContext)`	`void` מפעילים את המודול של ה-CLI.
`otCliInputLine(char *aBuf)`	`void` נשלחת אל פיד בשורת קלט של מסוף.
`otCliOutputBytes(const uint8_t *aBytes, uint8_t aLength)`	`void` כותבים מספר בייטים במסוף CLI כמחרוזת הקסדצימלית.
`otCliOutputFormat(const char *aFmt, ...)`	`void` כותבים את המחרוזת בפורמט המתאים במסוף CLI.
`otCliPlatLogv(otLogLevel aLogLevel, otLogRegion aLogRegion, const char *aFormat, va_list aArgs)`	`void` קריאה חוזרת לכתיבת יומן OpenThread במסוף ה-CLI.
`otCliSetUserCommands(const otCliCommand aUserCommands, uint8_t aLength, void aContext)`	`otError` הגדרת טבלת פקודות של משתמשים.
`otCliVendorSetUserCommands(void)`	`void` התקשרות חזרה כדי לאפשר הוספת פקודות ספציפיות לספק לטבלת פקודות המשתמש.

סוג שגיאות

otCliפלטהתקשרות חזרה

int(* otCliOutputCallback)(void *aContext, const char *aFormat, va_list aArguments)

המצביע נקרא כדי לקבל הודעה לגבי הפלט של Console.

פרטים

פרמטרים

`[out] aContext`	מצביע הקשר של משתמש.
`[in] aFormat`	מחרוזת הפורמט.
`[in] aArguments`	הארגומנטים של מחרוזת הפורמט.

החזרות

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

פונקציות

otCliAppendResult

void otCliAppendResult(
  otError aError
)

כותבים קוד שגיאה במסוף CLI.

אם הערך של aError הוא OT_ERROR_PENDING לא יישלח פלט.

פרטים

פרמטרים

[in] aError

ערך קוד שגיאה.

otCliInit

void otCliInit(
  otInstance *aInstance,
  otCliOutputCallback aCallback,
  void *aContext
)

מפעילים את המודול של ה-CLI.

פרטים

פרמטרים

`[in] aInstance`	מבנה המכונות של OpenThread.
`[in] aCallback`	שיטת קריאה חוזרת (callback) שנקראת לעיבוד פלט CLI.
`[in] aContext`	מצביע הקשר של משתמש.

otCliInputLine

void otCliInputLine(
  char *aBuf
)

נשלחת אל פיד בשורת קלט של מסוף.

פרטים

פרמטרים

[in] aBuf

מצביע על מחרוזת עם ערך null.

otCliפלטBytes

void otCliOutputBytes(
  const uint8_t *aBytes,
  uint8_t aLength
)

כותבים מספר בייטים במסוף CLI כמחרוזת הקסדצימלית.

פרטים

פרמטרים

`[in] aBytes`	מצביע לנתונים שיש להדפיס.
`[in] aLength`	האורך: `aBytes`.

otCliפלטפורמט

void otCliOutputFormat(
  const char *aFmt,
  ...
)

כותבים את המחרוזת בפורמט המתאים במסוף CLI.

פרטים

פרמטרים

`[in] aFmt`	מצביעים על מחרוזת הפורמט.
`[in] ...`	רשימת ארגומנטים תואמים.

otCliPlatLogv

void otCliPlatLogv(
  otLogLevel aLogLevel,
  otLogRegion aLogRegion,
  const char *aFormat,
  va_list aArgs
)

קריאה חוזרת לכתיבת יומן OpenThread במסוף ה-CLI.

פרטים

פרמטרים

`[in] aLogLevel`	רמת היומן.
`[in] aLogRegion`	אזור היומן.
`[in] aFormat`	מצביעים על מחרוזת הפורמט.
`[in] aArgs`	va_list תואם ל-aformat.

OTCliSetUserCommands

otError otCliSetUserCommands(
  const otCliCommand *aUserCommands,
  uint8_t aLength,
  void *aContext
)

הגדרת טבלת פקודות של משתמשים.

פרטים

פרמטרים

`[in] aUserCommands`	מצביע למערך עם פקודות משתמש.
`[in] aLength`	האורך: `aUserCommands`.
`[in] aContext`	הקשר `The` הועבר ל-handler.

ערכי החזרה

`OT_ERROR_NONE`	טבלת הפקודות עודכנה בהצלחה עם פקודות מ-`aUserCommands`.
`OT_ERROR_FAILED`	כבר הגדרת את מספר הרשומות המקסימלי לפקודה.

otCliהספקSetUserCommands

void otCliVendorSetUserCommands(
  void
)

התקשרות חזרה כדי לאפשר הוספת פקודות ספציפיות לספק לטבלת פקודות המשתמש.

זמין כש-OPENTHREAD_CONFIG_CLI_VENDOR_COMMANDS_ENABLE מופעל ו-OPENTHREAD_CONFIG_CLI_MAX_USER_CMD_ENTRIES גדול מ-1.

משאבים

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