ממשק שורת הפקודה (CLI)
המודול הזה כולל פונקציות השולטות בהפעלה של סטאק השרשורים.
סיכום
סוג שגיאות |
|
---|---|
otCliOutputCallback)(void *aContext, const char *aFormat, va_list aArguments)
|
typedefint(*
המצביע נקרא כדי לקבל הודעה לגבי הפלט של 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)
|
הגדרת טבלת פקודות של משתמשים.
|
otCliVendorSetUserCommands(void)
|
void
התקשרות חזרה כדי לאפשר הוספת פקודות ספציפיות לספק לטבלת פקודות המשתמש.
|
סוג שגיאות
otCliפלטהתקשרות חזרה
int(* otCliOutputCallback)(void *aContext, const char *aFormat, va_list aArguments)
המצביע נקרא כדי לקבל הודעה לגבי הפלט של Console.
פרטים | |||||||
---|---|---|---|---|---|---|---|
פרמטרים |
|
||||||
החזרות |
מספר הבייטים שנכתבו על ידי הקריאה החוזרת (callback).
|
פונקציות
otCliAppendResult
void otCliAppendResult( otError aError )
כותבים קוד שגיאה במסוף CLI.
אם הערך של aError
הוא OT_ERROR_PENDING
לא יישלח פלט.
פרטים | |||
---|---|---|---|
פרמטרים |
|
otCliInit
void otCliInit( otInstance *aInstance, otCliOutputCallback aCallback, void *aContext )
מפעילים את המודול של ה-CLI.
פרטים | |||||||
---|---|---|---|---|---|---|---|
פרמטרים |
|
otCliInputLine
void otCliInputLine( char *aBuf )
נשלחת אל פיד בשורת קלט של מסוף.
פרטים | |||
---|---|---|---|
פרמטרים |
|
otCliפלטBytes
void otCliOutputBytes( const uint8_t *aBytes, uint8_t aLength )
כותבים מספר בייטים במסוף CLI כמחרוזת הקסדצימלית.
פרטים | |||||
---|---|---|---|---|---|
פרמטרים |
|
otCliפלטפורמט
void otCliOutputFormat( const char *aFmt, ... )
כותבים את המחרוזת בפורמט המתאים במסוף CLI.
פרטים | |||||
---|---|---|---|---|---|
פרמטרים |
|
otCliPlatLogv
void otCliPlatLogv( otLogLevel aLogLevel, otLogRegion aLogRegion, const char *aFormat, va_list aArgs )
קריאה חוזרת לכתיבת יומן OpenThread במסוף ה-CLI.
פרטים | |||||||||
---|---|---|---|---|---|---|---|---|---|
פרמטרים |
|
OTCliSetUserCommands
otError otCliSetUserCommands( const otCliCommand *aUserCommands, uint8_t aLength, void *aContext )
הגדרת טבלת פקודות של משתמשים.
פרטים | |||||||
---|---|---|---|---|---|---|---|
פרמטרים |
|
||||||
ערכי החזרה |
|
otCliהספקSetUserCommands
void otCliVendorSetUserCommands( void )
התקשרות חזרה כדי לאפשר הוספת פקודות ספציפיות לספק לטבלת פקודות המשתמש.
זמין כש-OPENTHREAD_CONFIG_CLI_VENDOR_COMMANDS_ENABLE
מופעל ו-OPENTHREAD_CONFIG_CLI_MAX_USER_CMD_ENTRIES
גדול מ-1.
משאבים
הנושאים של קובצי העזר של OpenThread API מגיעים מקוד המקור, והם זמינים ב-GitHub. למידע נוסף או כדי לתרום למסמכי התיעוד שלנו, יש לעיין בקטע משאבים.