Cuttlefish: การควบคุมสภาพแวดล้อม

หน้านี้อธิบายวิธีควบคุมสภาพแวดล้อมในอุปกรณ์ Cuttlefish โดยใช้ REST API หรืออินเทอร์เฟซบรรทัดคำสั่ง เช่น คุณสามารถแก้ไขสัญญาณ Wi-Fi หรืออัปเดตตำแหน่ง GPS ของอุปกรณ์ Cuttlefish ได้

บริการ

คำสั่ง cvd env ให้บริการต่อไปนี้สำหรับการควบคุมสภาพแวดล้อม Cuttlefish

ควบคุมสภาพแวดล้อมโดยใช้ REST 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 ต่อไปนี้พร้อมรหัสอุปกรณ์ ชื่อบริการ และชื่อเมธอด

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

ดูข้อมูลโดยละเอียดเกี่ยวกับประเภทคำขอและการตอบกลับ

หากต้องการดูข้อมูลโดยละเอียดเกี่ยวกับประเภทข้อความคำขอหรือการตอบกลับ ให้ส่งคำขอ GET ไปยัง URL ต่อไปนี้พร้อมรหัสอุปกรณ์ ชื่อบริการ และประเภทข้อความคำขอหรือการตอบกลับ ซึ่งจะพิมพ์ชื่อและประเภทของแต่ละช่องในข้อความ จากนั้นคุณสามารถใช้ข้อมูลนี้เพื่อเขียนข้อความโปรโตคอลที่จัดรูปแบบ JSON สำหรับส่งคำขอ RPC

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

ส่งคำขอ RPC เพื่อทำการเปลี่ยนแปลงสภาพแวดล้อม

หากต้องการส่งคำขอ RPC เพื่อเรียกเมธอดของบริการด้วยโปรโตคอลที่จัดรูปแบบ JSON ให้ส่งคำขอ POST ไปยัง URL ต่อไปนี้พร้อมรหัสอุปกรณ์ ชื่อบริการ และชื่อเมธอด โดยต้องรวมโปรโตคอลที่จัดรูปแบบ JSON ไว้ในเนื้อหา

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

ตัวอย่างกรณีการใช้งาน

ต่อไปนี้เป็นตัวอย่างกรณีการใช้งาน REST API สำหรับการแก้ไขความแรงของสัญญาณ 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}
   

   นี่คือตัวอย่างการตอบกลับ

   {}
   

ควบคุมสภาพแวดล้อมโดยใช้บรรทัดคำสั่ง

ส่วนนี้อธิบายคำสั่งย่อยที่พร้อมใช้งานสำหรับคำสั่ง cvd env CLI โปรดดูรายละเอียดเพิ่มเติมโดยพิมพ์ข้อความช่วยเหลือโดยใช้ cvd help env

แสดงรายการบริการหรือเมธอดที่มี

หากต้องการดูรายการบริการทั้งหมด ให้ใช้ cvd env ls โดยไม่มีอาร์กิวเมนต์

cvd env ls

หากต้องการดูรายการเมธอดทั้งหมดสำหรับบริการ ให้ใส่ชื่อบริการเป็นอาร์กิวเมนต์

cvd env ls SERVICE_NAME

หากต้องการดูข้อมูลโดยละเอียด เช่น ประเภทข้อความคำขอหรือการตอบกลับของเมธอด ให้ใส่ชื่อบริการและชื่อเมธอด

cvd env ls SERVICE_NAME METHOD_NAME

ดูข้อมูลโดยละเอียดเกี่ยวกับประเภทคำขอและการตอบกลับ

หากต้องการดูข้อมูลโดยละเอียดเกี่ยวกับประเภทข้อความคำขอหรือการตอบกลับ ให้ใช้คำสั่ง cvd env type คำสั่งนี้จะพิมพ์ชื่อและประเภทของแต่ละช่องในข้อความ จากนั้นคุณสามารถใช้ข้อมูลนี้เพื่อเขียนข้อความโปรโตคอลที่จัดรูปแบบ JSON สำหรับส่งคำขอ RPC

cvd env type SERVICE_NAME REQUEST_OR_RESPONSE_TYPE_NAME

ส่งคำขอ RPC เพื่อทำการเปลี่ยนแปลงสภาพแวดล้อม

หากต้องการส่งคำขอ RPC เพื่อเรียกเมธอดของบริการด้วยโปรโตคอลที่จัดรูปแบบ 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. กำหนดชื่อบริการ ชื่อเมธอด และชื่อประเภทข้อความคำขอสำหรับการแก้ไขความแรงของสัญญาณ 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
   {}