דיונון: בקרת סביבה

קל לארגן דפים בעזרת אוספים אפשר לשמור ולסווג תוכן על סמך ההעדפות שלך.

הדף הזה מתאר כיצד לשלוט בסביבה במכשיר דיונון באמצעות API ל-REST או ממשק שורת הפקודה (CLI). לדוגמה, אפשר לשנות את אותות ה-Wi-Fi או לעדכן את מיקום ה-GPS של מכשיר Cuttlefish.

שירותים

הפקודה cvd env מספקת את השירותים הבאים לצורך בקרה על סביבת Cuttlefish:

שליטה בסביבה באמצעות API ל-REST

בקטע הזה מוסבר איך לשלוט בסביבה באמצעות אריזת API דרך נקודת הקצה של השירות <https://localhost:1443>.

הצגת רשימה של השירותים או השיטות הזמינות

כדי לקבל רשימה של כל השירותים, שולחים בקשת GET לכתובת ה-URL הבאה עם מזהה מכשיר.

https://localhost:1443/devices/DEVICE_ID/services

כדי לקבל רשימה של כל השיטות בשירות מסוים, צריך לשלוח בקשת GET אל את כתובת ה-URL הבאה עם מזהה המכשיר ושם השירות.

https://localhost:1443/devices/DEVICE_ID/services/SERVICE_NAME

כדי לקבל מידע מפורט על שיטה מסוימת, כמו הבקשה או התשובה סוגי ההודעות, צריך לשלוח בקשת GET לכתובת ה-URL הבאה עם מזהה מכשיר שם השירות ושם ה-method.

https://localhost:1443/devices/DEVICE_ID/services/SERVICE_NAME/METHOD_NAME

מידע מפורט על סוגי הבקשות והתשובות

כדי לקבל מידע מפורט על סוג של בקשה או הודעה בתגובה, שולחים בקשה מסוג GET לכתובת ה-URL הבאה עם מזהה מכשיר, שם שירות וסוג הבקשה או ההודעה בתגובה. הפקודה הזו מדפיסה את כל השמות והסוגים של כל שדה בהודעה. לאחר מכן תוכלו להשתמש במידע הזה כדי לכתוב הודעת proto בפורמט JSON לשליחת בקשת RPC.

https://localhost:1443/devices/DEVICE_ID/services/SERVICE_NAME/REQUEST_OR_RESPONSE_TYPE_NAME/type

שליחה של בקשת RPC לביצוע שינויים בסביבה

כדי לשלוח בקשת RPC לקריאה לשיטה של שירות עם Proto בפורמט JSON, צריך לשלוח בקשת POST לכתובת ה-URL הבאה עם מזהה מכשיר ושירות ואת שם ה-method. ה-Proto בפורמט JSON חייב להיות כלול גוף ההודעה.

https://localhost:1443/devices/DEVICE_ID/services/SERVICE_NAME/METHOD_NAME

תרחיש לדוגמה

בדוגמה הבאה מוצג תרחיש לדוגמה לשימוש ב-API ל-REST כדי לשנות את עוצמת האות של ה-Wi-Fi באמצעות קריאה ל-SetTxpower.

1. קובעים את שם השירות, שם השיטה ושם סוג הודעת הבקשה לשינוי עוצמת האות של ה-Wi-Fi.

   1. כדי לקבל רשימה של כל השירותים הזמינים, שולחים בקשה מסוג GET לכתובת ה-URL הבאה.

      https://localhost:1443/devices/cvd-1/services
      

      זו תשובה לדוגמה.

      {"services":["OpenwrtControlService","EchoService","GnssGrpcProxy","WmediumdService"]}
      

   2. כדי לקבל רשימה של שיטות ל-WmediumdService, שולחים בקשת GET לכתובת ה-URL הבאה.

      https://localhost:1443/devices/cvd-1/services/WmediumdService
      

      זו תשובה לדוגמה.

      {"methods":["ListStations","LoadConfig","ReloadConfig","SetCivicloc","SetLci","SetPosition","SetSnr","SetTxpower","StartPcap","StopPcap"]}
      

   3. לקבל מידע על סוגי הודעות הבקשה והתשובות של השיטה SetTxpower על ידי שליחת בקשת GET לכתובת ה-URL הבאה.

      https://localhost:1443/devices/cvd-1/services/WmediumdService/SetTxpower
      

      זוהי דוגמה לתגובה.

      {"request_type_name":"wmediumdserver.SetTxpowerRequest","response_type_name":"google.protobuf.Empty"}
      

2. קבלת מידע מפורט על הבקשה של wmediumdserver.SetTxpowerRequest סוג ההודעה על ידי שליחת בקשת GET לכתובת ה-URL הבאה.

   https://localhost:1443/devices/cvd-1/services/WmediumdService/wmediumdserver.SetTxpowerRequest/type
   

   זוהי דוגמה לתגובה.

   message SetTxpowerRequest {
     string mac_address = 1;
     int32 tx_power = 2;
   }
   

3. יש לשלוח בקשת RPC לשירות WmediumdService כדי לשנות את ה-Wi-Fi את עוצמת האות לרמה הרצויה על ידי שליחת בקשת POST לכתובת ה-URL הזו עם גוף הבקשה הבא.

   https://localhost:1443/devices/cvd-1/services/WmediumdService/SetTxpower
   

   {"mac_address":"42:00:00:00:00:00", "tx_power":1}
   

   זוהי דוגמה לתגובה.

   {}
   

שליטה בסביבה באמצעות שורת הפקודה

בקטע הזה מתוארות פקודות המשנה הזמינות לפקודת ה-CLI cvd env. לקבלת פרטים נוספים, אפשר להדפיס את הודעת העזרה באמצעות cvd help env.

פירוט השירותים או השיטות הזמינים

כדי לקבל רשימה של כל השירותים, צריך להשתמש ב-cvd env ls ללא ארגומנטים.

cvd env ls

כדי לקבל רשימה של כל השיטות בשירות, צריך לכלול את שם כארגומנט.

cvd env ls SERVICE_NAME

כדי לקבל מידע מפורט, כמו הסוגים של הודעת הבקשה או התשובה של , צריך לכלול את שם השירות ואת שם ה-method.

cvd env ls SERVICE_NAME METHOD_NAME

מידע מפורט על סוגי הבקשות והתשובות

כדי לקבל מידע מפורט על סוג של בקשה או הודעה בתגובה, משתמשים בפקודה cvd env type. הפקודה הזו מדפיסה את כל השמות והסוגים של כל שדה בהודעה. לאחר מכן תוכלו להשתמש במידע הזה כדי לכתוב הודעת proto בפורמט JSON לשליחת בקשת RPC.

cvd env type SERVICE_NAME REQUEST_OR_RESPONSE_TYPE_NAME

שליחה של בקשת RPC לביצוע שינויים בסביבה

כדי לשלוח בקשת RPC לקריאה ל-method של שירות עם proto בפורמט JSON, משתמשים בפקודה cvd enc call. כשבקשת ה-RPC מסתיימת, הממשק מדפיס את ההודעה Rpc succeeded with OK status, ואם יש תשובה, גם אותה, כולל ערכים.

cvd env call SERVICE_NAME METHOD_NAME JSON_FORMATTED_PROTO

תרחיש לדוגמה

הדוגמה הבאה היא תרחיש לדוגמה של הפקודה cvd env ב-CLI לשינוי ערך. לעוצמת אות ה-Wi-Fi באמצעות קריאה ל-SetTxpower.

1. קובעים את שם השירות, שם ה-method וסוג הודעת הבקשה שם לשינוי עוצמת אות ה-Wi-Fi.

   לקבל רשימה של כל השירותים הזמינים.

   cvd env ls
   (Omitted)
   {
     "services" :
     [
       "OpenwrtControlService",
       "EchoService",
       "GnssGrpcProxy",
       "WmediumdService"
     ]
   }

   הצגת רשימה של שיטות ל-WmediumdService.

   cvd env ls WmediumdService
   (Omitted)
   {
     "methods" :
     [
       "ListStations",
       "LoadConfig",
       "ReloadConfig",
       "SetCivicloc",
       "SetLci",
       "SetPosition",
       "SetSnr",
       "SetTxpower",
       "StartPcap",
       "StopPcap"
     ]
   }

   מידע על סוגי ההודעות של הבקשה והתגובה של השיטה SetTxpower.

   cvd env ls WmediumdService SetTxpower
   (Omitted)
   {
     "request_type" : "wmediumdserver.SetTxpowerRequest",
     "response_type" : "google.protobuf.Empty"
   }

2. קבלת מידע מפורט על הבקשה של wmediumdserver.SetTxpowerRequest סוג ההודעה.

   cvd env type WmediumdService wmediumdserver.SetTxpowerRequest
   (Omitted)
   message SetTxpowerRequest {
     string mac_address = 1;
     int32 tx_power = 2;
   }

3. יש לשלוח בקשת RPC לשירות WmediumdService כדי לשנות את ה-Wi-Fi עוצמת האות עד לרמה הרצויה.

   cvd env call WmediumdService SetTxpower "{mac_address:'42:00:00:00:00:00', tx_power:1}"
   (Omitted)
   Rpc succeeded with OK status
   {}