Cuttlefish: controllo dell'ambiente

Questa pagina descrive come controllare l'ambiente in un dispositivo Cuttlefish utilizzando l'API REST o l'interfaccia a riga di comando. Ad esempio, puoi modificare il segnale Wi-Fi o aggiornare la posizione GPS del dispositivo Cuttlefish.

Servizi

Il comando cvd env fornisce i seguenti servizi per il controllo dell'ambiente Cuttlefish:

Servizi Descrizione
GnssGrpcProxy Controlla il GNSS per la funzionalità di geolocalizzazione di Cuttlefish.
OpenwrtControlService Controlla Openwrt, un fornitore di AP Wi-Fi virtualizzati per la funzionalità Wi-Fi di Cuttlefish.
WmediumdService Controlla Wmediumd, un simulatore di mezzo wireless per la funzionalità Wi-Fi di Cuttlefish.
CasimirControlService Controlla Casimir, un simulatore per dispositivi NFC esterni.

Controllare l'ambiente utilizzando l'API REST

Questa sezione descrive come controllare l'ambiente utilizzando l'API Rest tramite l'endpoint di servizio <https://localhost:1443>.

Elenca i servizi o i metodi disponibili

Per ottenere un elenco di tutti i servizi, invia una richiesta GET al seguente URL con un ID dispositivo.

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

Per ottenere un elenco di tutti i metodi per un servizio, invia una richiesta GET al seguente URL con un ID dispositivo e il nome del servizio.

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

Per ottenere informazioni dettagliate su un metodo, ad esempio i tipi di messaggi di richiesta o risposta, invia una richiesta GET al seguente URL con un ID dispositivo, un nome servizio e il nome del metodo.

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

Ottieni informazioni dettagliate sui tipi di richiesta e risposta

Per ottenere informazioni dettagliate su un tipo di messaggio di richiesta o risposta, invia una richiesta GET al seguente URL con un ID dispositivo, un nome del servizio e il tipo di messaggio di richiesta o risposta. Vengono stampati tutti i nomi e i tipi di ciascun campo nel messaggio. Puoi quindi utilizzare queste informazioni per scrivere un messaggio proto in formato JSON per l'invio di una richiesta RPC.

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

Invia una richiesta RPC per apportare modifiche all'ambiente

Per inviare una richiesta RPC per chiamare un metodo di un servizio con un proto in formato JSON, invia una richiesta POST al seguente URL con un ID dispositivo, un nome di servizio e il nome del metodo. Il proto in formato JSON deve essere incluso nel corpo.

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

Esempio di caso d'uso

Di seguito è riportato un esempio di caso d'uso dell'API REST per la modifica dell'intensità del segnale Wi-Fi chiamando SetTxpower.

  1. Determina il nome del servizio, il nome del metodo e il nome del tipo di messaggio di richiesta per modificare l'intensità del segnale Wi-Fi.

    1. Per ottenere un elenco di tutti i servizi disponibili, invia una richiesta GET al seguente URL.

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

      Questo è un esempio di risposta.

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

    2. Per ottenere un elenco di metodi per WmediumdService, invia una richiesta GET al seguente URL.

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

      Questo è un esempio di risposta.

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

    3. Per informazioni sui tipi di messaggi di richiesta e risposta per il metodo SetTxpower, invia una richiesta GET al seguente URL.

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

      Questo è un esempio di risposta.

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

  2. Per informazioni dettagliate sul tipo di messaggio di richiesta wmediumdserver.SetTxpowerRequest, invia una richiesta GET al seguente URL.

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

    Questo è un esempio di risposta.

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

  3. Invia una richiesta RPC al servizio WmediumdService per modificare l'intensità del segnale Wi-Fi al livello desiderato inviando una richiesta POST a questo URL con il seguente corpo della richiesta.

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

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

    Questo è un esempio di risposta.

    {}

Controllare l'ambiente utilizzando la riga di comando

Questa sezione descrive i sottocomandi disponibili per il comando cvd env della riga di comando. Per ulteriori dettagli, stampa il messaggio di aiuto utilizzando cvd help env.

Elenca i servizi o i metodi disponibili

Per ottenere un elenco di tutti i servizi, utilizza cvd env ls senza argomenti.

cvd env ls

Per ottenere un elenco di tutti i metodi di un servizio, includi il nome del servizio come argomento.

cvd env ls SERVICE_NAME

Per ottenere informazioni dettagliate, ad esempio i tipi di messaggi di richiesta o risposta di un metodo, includi il nome del servizio e il nome del metodo.

cvd env ls SERVICE_NAME METHOD_NAME

Ottieni informazioni dettagliate sui tipi di richiesta e risposta

Per ottenere informazioni dettagliate su un tipo di messaggio di richiesta o risposta, utilizza il comando cvd env type. Questo comando stampa tutti i nomi e i tipi di ciascun campo nel messaggio. Puoi quindi utilizzare queste informazioni per scrivere un messaggio proto in formato JSON per l'invio di una richiesta RPC.

cvd env type SERVICE_NAME REQUEST_OR_RESPONSE_TYPE_NAME

Invia una richiesta RPC per apportare modifiche all'ambiente

Per inviare una richiesta RPC per chiamare un metodo di un servizio con un proto in formato JSON, utilizza il comando cvd enc call. Quando la richiesta RPC termina, l'interfaccia stampa il messaggio Rpc succeeded with OK status e, se disponibile, un messaggio di risposta che include i valori.

cvd env call SERVICE_NAME METHOD_NAME JSON_FORMATTED_PROTO

Esempio di caso d'uso

Di seguito è riportato un esempio di caso d'uso del comando cvd env CLI per la modifica dell'intensità del segnale Wi-Fi chiamando SetTxpower.

  1. Determina il nome del servizio, il nome del metodo e il nome del tipo di messaggio di richiesta per modificare l'intensità del segnale Wi-Fi.

    Visualizza un elenco di tutti i servizi disponibili.

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

    Visualizza un elenco di metodi per WmediumdService.

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

    Visualizza informazioni sui tipi di messaggi di richiesta e risposta per il metodoSetTxpower.

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

  2. Visualizza informazioni dettagliate per il tipo di messaggio di richiesta wmediumdserver.SetTxpowerRequest.

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

  3. Invia una richiesta RPC al servizio WmediumdService per modificare l'intensità del segnale Wi-Fi al livello desiderato.

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