OpenThread CLI APIهای پیکربندی و مدیریت را از یک رابط خط فرمان در معرض دید قرار می دهد. از OT CLI برای ایجاد یک محیط توسعه OpenThread استفاده کنید یا از آن به عنوان ابزاری با کد برنامه اضافی استفاده کنید. به عنوان مثال، اسکریپت های تست OpenThread از CLI برای اجرای موارد تست استفاده می کنند.
شروع کنید
شبیه سازی Codelab ما را با Docker تکمیل کنید و مرجع فرمان CLI را بررسی کنید.
به شبیه سازی Codelab بروید به مرجع CLI Command بروید
از OT CLI استفاده کنید
می توانید از OT CLI با روتر مرزی OpenThread (OTBR) و دستگاه های Thread استفاده کنید. دستورات CLI بسته به نوع دستگاه و پرچمهای ساخت متفاوت خواهد بود.
OTBR
برای استفاده از OT CLI با OTBR ، پیشوند زیر را قبل از هر دستور وارد کنید:
sudo ot-ctl
دستگاه های نخ
برای استفاده از دستورات CLI در دستگاه Thread، به اسناد پلتفرم، کد لبه یا راهنما مراجعه کنید. برای مثالهای زیادی، میتوانید دستورات را بدون پیشوند تایپ کنید:
state
router
Done
در اینجا چند منبع برای کمک به شما برای شروع آورده شده است:
- پلتفرم های OpenThread را مرور کنید
- نرم افزار Nordic Hardware Codelab
- Silicon Labs Hardware Codelab
- نمونه های پلتفرم در GitHub
شخصیت های خاص
کاراکتر فضای خالی ( ' '
) برای محدود کردن نام فرمان و آرگومان های مختلف، همراه با برگه ( '\t'
) و کاراکترهای خط جدید ( '\r'
, '\n'
) استفاده می شود.
برخی از آرگومان ها ممکن است شامل فضاها باشند، برای مثال نام شبکه Thread. برای ارسال آرگومان هایی که شامل فاصله هستند، از کاراکتر بک اسلش ( '\'
) برای فرار از جداکننده ها یا خود اسلش استفاده کنید:
networkname Test\ Network
Donenetworkname
Test Network Done
نگاشت آرگومان ها
OT CLI از آرگومان های از پیش تعریف شده استفاده می کند که با مقادیر پیکربندی API مطابقت دارند. این نقشهبرداریها را میتوان با دستورات CLI ارسال کرد، و همچنین ممکن است برای دستورات مختلف دادههای شبکه، به عنوان مثال netdata show، به کنسول CLI برگردند.
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 مراجعه کنید.