หน้านี้จะอธิบายวิธีควบคุมสภาพแวดล้อมในอุปกรณ์ Cuttlefish โดยใช้ REST API หรืออินเทอร์เฟซบรรทัดคำสั่ง เช่น คุณอาจแก้ไขสัญญาณ Wi-Fi หรืออัปเดตตำแหน่ง GPS ของอุปกรณ์ Cuttlefish ได้
บริการ
คำสั่ง cvd env
จะมีบริการต่อไปนี้สำหรับการควบคุมสภาพแวดล้อม Cuttlefish
บริการ | คำอธิบาย |
---|---|
GnssGrpcProxy
|
ควบคุม GNSS สำหรับฟีเจอร์ตำแหน่งทางภูมิศาสตร์ ของ Cuttlefish |
OpenwrtControlService
|
ควบคุม Openwrt ซึ่งเป็นผู้ให้บริการ Wi-Fi AP เสมือนสำหรับฟีเจอร์ Wi-Fi ของ Cuttlefish |
WmediumdService
|
ควบคุม Wmediumd ซึ่งเป็นเครื่องมือจำลองขนาดกลางแบบไร้สายสำหรับฟีเจอร์ Wi-Fi ของ Cuttlefish |
CasimirControlService
|
ควบคุม Casimir ซึ่งเป็นเครื่องจำลองสำหรับอุปกรณ์ NFC ภายนอก |
ควบคุมสภาพแวดล้อมโดยใช้ 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 ต่อไปนี้พร้อมรหัสอุปกรณ์ ชื่อบริการ และประเภทคำขอหรือข้อความตอบกลับ วิธีนี้จะพิมพ์ชื่อและประเภททั้งหมดของแต่ละช่องในข้อความ จากนั้นใช้ข้อมูลนี้เพื่อเขียนข้อความ Proto ในรูปแบบ 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
ระบุชื่อบริการ ชื่อวิธีการ และชื่อประเภทข้อความคำขอเพื่อแก้ไขความแรงของสัญญาณ Wi-Fi
ดูรายการบริการทั้งหมดที่มีโดยส่งคำขอ
GET
ไปยัง URL ต่อไปนี้https://localhost:1443/devices/cvd-1/services
นี่คือตัวอย่างการตอบกลับ
{"services":["OpenwrtControlService","EchoService","GnssGrpcProxy","WmediumdService"]}
ดูรายการเมธอดสำหรับ
WmediumdService
โดยส่งคำขอGET
ไปยัง URL ต่อไปนี้https://localhost:1443/devices/cvd-1/services/WmediumdService
นี่คือตัวอย่างคำตอบ
{"methods":["ListStations","LoadConfig","ReloadConfig","SetCivicloc","SetLci","SetPosition","SetSnr","SetTxpower","StartPcap","StopPcap"]}
ดูข้อมูลเกี่ยวกับประเภทคำขอและข้อความตอบกลับสำหรับเมธอด
SetTxpower
โดยส่งคำขอGET
ไปยัง URL ต่อไปนี้https://localhost:1443/devices/cvd-1/services/WmediumdService/SetTxpower
นี่คือตัวอย่างคำตอบ
{"request_type_name":"wmediumdserver.SetTxpowerRequest","response_type_name":"google.protobuf.Empty"}
ดูรายละเอียดสำหรับคำขอ
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; }
ส่งคำขอ 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
คำสั่งนี้จะพิมพ์ชื่อและประเภทของช่องแต่ละช่องในข้อความ จากนั้นคุณก็ใช้ข้อมูลนี้เพื่อเขียนข้อความ proto ในรูปแบบ 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
ตัวอย่างกรณีการใช้งาน
ต่อไปนี้คือตัวอย่าง Use Case ของคำสั่ง cvd env
CLI ในการแก้ไขความแรงของสัญญาณ Wi-Fi โดยการเรียกใช้ SetTxpower
กำหนดชื่อบริการ ชื่อเมธอด และชื่อประเภทข้อความคำขอสำหรับการแก้ไขความแรงของสัญญาณ 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" }
รับข้อมูลโดยละเอียดสำหรับประเภทข้อความคำขอ
wmediumdserver.SetTxpowerRequest
cvd env type WmediumdService wmediumdserver.SetTxpowerRequest (Omitted) message SetTxpowerRequest { string mac_address = 1; int32 tx_power = 2; }
ส่งคำขอ 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 {}