ממשק שורת הפקודה

מודול זה כולל פונקציות ששולטות בהפעלה של מחסנית ה-thread.

סיכום

סוג מגן

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

פונקציות

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)
void
הגדרת טבלה של פקודת משתמש.

סוג מגן

otCliOutputCallback

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

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

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

פונקציות

otCliAppendתוצאה

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.

otCliOutputBytes

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 תואם פורמט A.

otCliSetUserCommands

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

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

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

מקורות מידע

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