סקירה כללית של OpenThread CLI

הצגת המקור ב-GitHub

ה-OpenThread CLI חושף את ממשקי ה-API להגדרה ולניהול ממשק שורת הפקודה (CLI). שימוש ב-OT CLI כדי ליצור פיתוח OpenThread או להשתמש בו ככלי עם קוד נוסף של אפליקציה. לדוגמה, ה-OpenThread סקריפטים לבדיקה משתמשים ה-CLI כדי להריץ מקרי בדיקה.

שנתחיל?

משלימים את הסימולציה של Codelab באמצעות Docker ומעיינים בהסבר על Command CLI.

כניסה ל-Simulation Codelab מעבר אל CLI Command Reference

שימוש ב-OT CLI

אפשר להשתמש ב-OT CLI עם נתב OpenThread Border (OTBR) ומכשירי Thread. CLI הפקודות ישתנו בהתאם לסוג המכשיר ול-builders.

OTBR (OTBR)

כדי להשתמש ב-OT CLI עם OTBR, צריך להזין את הפרטים הבאים תחילית לפני כל פקודה:

sudo ot-ctl

מכשירים בפרוטוקול Thread

כדי להשתמש בפקודות CLI במכשיר פרוטוקול Thread, צריך לעיין במסמכי התיעוד של הפלטפורמה. או guide. בדוגמאות רבות, תוכלו להתחיל להקליד פקודות ללא תחילית:

state
router
Done

ריכזנו כאן כמה מקורות מידע שיעזרו לכם להתחיל:

תווים מיוחדים

תו הרווח הלבן (' ') משמש להפרדה בין שם הפקודה ארגומנטים שונים, יחד עם הכרטיסייה ('\t') ותווי שורה חדשים ('\r', '\n').

חלק מהארגומנטים יכולים לכלול רווחים, למשל שם של רשת פרוטוקול Thread. שפת תרגום שליחת ארגומנטים שכוללים רווחים, יש להשתמש בתו הלוכסן ההפוך ('\') כדי תווי הפרדה בתו בריחה (escape) או הלוכסן ההפוך עצמו:

networkname Test\ Network
Done
networkname
Test Network
Done

מיפויי ארגומנטים

ב-OT CLI משתמשים בארגומנטים מוגדרים מראש שתואמים לערכי ההגדרות של API. האלה אפשר להעביר את המיפויים באמצעות פקודות CLI, ויכול להיות שהם גם יחזרו ל-CLI מסוף לפקודות שונות של נתוני רשת, netdata show.

otBorderRouterConfig

לחלק מהפקודות, למשל prefix add, נדרש otBorderRouterConfig ערכים. כדי להגדיר otBorderRouterConfig משתמשים משורת הפקודה, OT CLI מנתחת ארגומנט של אות ממופה לכל איבר. לדוגמה, הארגומנט השילוב paros מגדיר את mPreferred, mSlaac, mDefaultRoute, mOnMesh, ו-mStable חברים ברצף.

תחביר

בדוגמה הבאה, חובה לציין prefix, וגם otBorderRouterConfig הארגומנטים הם אופציונליים, ממופים בתור p, a, d, c, r, o, s, n וגם D:

prefix add prefix [padcrosnD]

שימוש

כדי להשתמש במיפויי ארגומנטים, אין להזין רווחים בין האותיות:

prefix add 2001:dead:beef:cafe::/64 paros

otRoutePreference

כדי להגדיר את otRoutePreference, להשתמש ב-high, ב-med או ב-low בפקודות OT CLI.

תחביר

prefix add prefix [padcrosnD] [high|med|low]

שימוש

זאת דוגמה לשימוש ב-otBorderRouterConfig וב-otRoutePreference ממופים :

prefix add 2001:dead:beef:cafe::/64 paros med
Done

otExternalRouteConfig

ל-otExternalRouteConfig ערכים, s ממופה לmStable ו-n ממופה לmNat64.

תחביר

publish route prefix [sn]

שימוש

route add 2001:dead:beef:cafe::/64 s
Done

ערכים מוחזרים

רוב הפקודות מחזירות את הערך המבוקש ואחריו Done:

br onlinkprefix
fd41:2650:a6f5:0::/64
Done

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