Ti diamo il benvenuto nel Centro sviluppatori Google Home, la nuova destinazione per scoprire come sviluppare azioni per la smart home. Nota: continuerai a creare azioni nella console di Actions.

Schema del tratto di rete SmartControl

action.devices.traits.NetworkControl: questa caratteristica appartiene ai dispositivi che supportano i dati della rete di segnalazione ed eseguono operazioni specifiche per la rete.

ATTRIBUTE dispositivo

I dispositivi con questo trattino potrebbero segnalare i seguenti attributi come parte dell'operazione SYNC. Per saperne di più sulla gestione degli intent SYNC, consulta la sezione fulfillment di intent.

Attributi Tipo Descrizione
supportsEnablingGuestNetwork Booleano

(Valore predefinito: false)

Impostato su "true" se è possibile attivare la rete ospite.

supportsDisablingGuestNetwork Booleano

(Valore predefinito: false)

Impostato su "true" se la rete ospite può essere disabilitata.

supportsGettingGuestNetworkPassword Booleano

(Valore predefinito: false)

Impostato su true se la password di rete ospite si ottiene con il comando GetGuestNetworkPassword.

networkProfiles Array

Indica i nomi dei profili di rete supportati.

[item, ...] String

Nome di un profilo di rete che rappresenta un gruppo di dispositivi correlati.

supportsEnablingNetworkProfile Booleano

(Valore predefinito: "false")

Impostato su true se è possibile attivare i profili di rete.

supportsDisablingNetworkProfile Booleano

(Valore predefinito: "false")

Impostato su true se i profili di rete possono essere disattivati.

supportsNetworkDownloadSpeedTest Booleano

(Valore predefinito: false)

Impostato su "true" se è possibile eseguire un test della velocità di download.

supportsNetworkUploadSpeedTest Booleano

(Valore predefinito: false)

Impostato su "true" se è possibile eseguire un test di velocità del caricamento.

Esempi

Dispositivo di rete che supporta rete ospite, profili e test di velocità.

{
  "supportsEnablingGuestNetwork": true,
  "supportsDisablingGuestNetwork": true,
  "supportsEnablingNetworkProfile": true,
  "supportsDisablingNetworkProfile": true,
  "supportsNetworkDownloadSpeedTest": true,
  "supportsNetworkUploadSpeedTest": true,
  "supportsGettingGuestNetworkPassword": true,
  "networkProfiles": [
    "Kids"
  ]
}

STATO dispositivo

Le entità con questa caratteristica possono segnalare i seguenti stati nell'ambito dell'operazione QUERY, Per saperne di più sulla gestione degli intent QUERY, consulta la sezione fulfillment di intent.

Stati Tipo Descrizione
networkEnabled Booleano

Indica se la rete principale è abilitata.

networkSettings Oggetto

Contiene l'SSID della rete principale.

ssid String

Obbligatorio.

SSID rete.

guestNetworkEnabled Booleano

Indica se la rete ospite è abilitata.

guestNetworkSettings Oggetto

Contiene l'SSID della rete ospite.

ssid String

Obbligatorio.

SSID rete.

numConnectedDevices Intero

Il numero di dispositivi connessi alla rete.

networkUsageMB Number

L'utilizzo della rete in MB (megabyte). L'utilizzo della rete rientra nel periodo di fatturazione corrente, che può essere utile per monitorare un limite di utilizzo della rete per il periodo di fatturazione.

networkUsageLimitMB Number

Il limite di utilizzo della rete in MB (megabyte). Il limite di utilizzo della rete rientra nel periodo di fatturazione corrente.

networkUsageUnlimited Booleano

Indica se l'utilizzo della rete è illimitato. Lo stato del dispositivo networkUsageLimitMB verrà ignorato se è impostato su true.

lastNetworkDownloadSpeedTest Oggetto

Contiene i risultati del test di velocità di download della rete più recente.

downloadSpeedMbps Number

La velocità di download in Mbps (megabit al secondo) dell'ultimo test di velocità della rete.

unixTimestampSec Intero

Il timestamp Unix (numero di secondi dall'epoca Unix) del momento in cui è stato eseguito l'ultimo test della velocità di download della rete.

status String

Indica se l'ultimo test di velocità di download della rete è riuscito o meno.

Valori supportati:

SUCCESS
FAILURE
lastNetworkUploadSpeedTest Oggetto

Contiene i risultati del test di velocità di caricamento della rete più recente.

uploadSpeedMbps Number

La velocità di caricamento in Mbps (megabit al secondo) dell'ultimo test di velocità della rete.

unixTimestampSec Intero

Il timestamp Unix (numero di secondi dall'epoca Unix) del momento in cui è stato eseguito l'ultimo test di velocità del caricamento della rete.

status String

Indica se l'ultimo test di velocità di caricamento della rete è riuscito o meno.

Valori supportati:

SUCCESS
FAILURE
networkSpeedTestInProgress Booleano

(Valore predefinito: false)

Indica se è attualmente in corso un test di velocità.

networkProfilesState Oggetto

Stato dei profili di rete. Questo oggetto di primo livello deve contenere coppie chiave-valore in cui la chiave è il nome di uno dei profili di rete elencati nell'attributo networkProfiles e il valore deve corrispondere allo stato corrispondente del profilo.

<string> Oggetto

Un oggetto che memorizza lo stato di un singolo profilo di rete. Il valore della chiave deve essere il nome di uno dei profili di rete nell'attributo networkProfiles.

enabled Booleano

Lo stato attuale attivato/disattivato del profilo di rete.

Esempi

Dispositivo con una rete attiva.

{
  "networkEnabled": true,
  "networkSettings": {
    "ssid": "home-network-123"
  },
  "guestNetworkSettings": {
    "ssid": "home-network-123-guest"
  },
  "numConnectedDevices": 4,
  "networkUsageMB": 100.8
}

Dispositivo con risultati di test di velocità e di una rete attivi.

{
  "networkEnabled": true,
  "networkSettings": {
    "ssid": "home-network-123"
  },
  "guestNetworkSettings": {
    "ssid": "home-network-123-guest"
  },
  "numConnectedDevices": 4,
  "networkUsageMB": 100.8,
  "lastNetworkDownloadSpeedTest": {
    "downloadSpeedMbps": 159.8,
    "unixTimestampSec": 1563215576,
    "status": "SUCCESS"
  },
  "lastNetworkUploadSpeedTest": {
    "uploadSpeedMbps": 64.1,
    "unixTimestampSec": 1563215576,
    "status": "SUCCESS"
  }
}

Dispositivo con una rete attiva e test di velocità in corso.

{
  "networkEnabled": true,
  "networkSettings": {
    "ssid": "home-network-123"
  },
  "guestNetworkSettings": {
    "ssid": "home-network-123-guest"
  },
  "numConnectedDevices": 4,
  "networkUsageMB": 100.8,
  "networkSpeedTestInProgress": true
}

Dispositivo con il profilo di rete "kids" disattivato.

{
  "networkEnabled": true,
  "networkSettings": {
    "ssid": "home-network-123"
  },
  "networkProfilesState": {
    "parents": {
      "enabled": true
    },
    "kids": {
      "enabled": false
    }
  }
}

COMANDI dispositivo

I dispositivi con questo trattino potrebbero rispondere ai seguenti comandi nell'ambito dell'operazione EXECUTE. Per saperne di più sulla gestione degli intent EXECUTE, consulta la sezione fulfillment di intent.

action.devices.commands.EnableDisableGuestNetwork

Attiva o disattiva la rete ospite. È necessario utilizzare la verifica utente secondaria con PIN. Se questi dispositivi di sicurezza sono disattivati tramite questi comandi, la sicurezza della casa di un utente può essere considerata interessata.

Questo comando richiede i seguenti attributi:
{
  "supportsEnablingGuestNetwork": true,
  "supportsDisablingGuestNetwork": true
}

Parametri

Parametri Tipo Descrizione
enable Booleano

Obbligatorio.

Vero per attivare la rete ospite, falso per disattivarla.

Esempi

Attiva la rete ospite.

{
  "command": "action.devices.commands.EnableDisableGuestNetwork",
  "params": {
    "enable": true
  }
}

action.devices.commands.EnableDisableNetworkProfile

Attiva o disattiva un profilo di rete. È necessario utilizzare la verifica utente secondaria con PIN. Se questi dispositivi di sicurezza sono disattivati tramite questi comandi, la sicurezza della casa di un utente può essere considerata interessata.

Questo comando richiede i seguenti attributi:
{
  "supportsEnablingNetworkProfile": true,
  "supportsDisablingNetworkProfile": true
}

Parametri

Parametri Tipo Descrizione
profile String

Obbligatorio.

Il nome del profilo di networkProfiles attributo.

enable Booleano

Obbligatorio.

Vero per attivare il profilo, falso per disattivarlo.

Esempi

Disattiva Internet per i bambini.

{
  "command": "action.devices.commands.EnableDisableNetworkProfile",
  "params": {
    "profile": "Kids",
    "enable": false
  }
}

Si è verificato un errore durante il tentativo di controllare il profilo di rete specificato.

Valori supportati:

networkProfileNotRecognized

action.devices.commands.GetGuestNetworkPassword

Recupera la password di rete ospite. È necessario utilizzare la verifica utente secondaria con PIN. Se questi dispositivi di sicurezza sono disattivati tramite questi comandi, la sicurezza della casa di un utente può essere considerata interessata.

Questo comando richiede i seguenti attributi:
{
  "supportsGettingGuestNetworkPassword": true
}

Parametri

Parametri Tipo Descrizione

Nessuna proprietà

Esempi

Mostrami la password del Wi-Fi ospite.

{
  "command": "action.devices.commands.GetGuestNetworkPassword",
  "params": {}
}

Risultati

Risultati Tipo Descrizione
guestNetworkPassword String

Obbligatorio.

La password della rete ospite.

Esempi

Mostrami la password del Wi-Fi ospite.

{
  "guestNetworkPassword": "123456"
}

action.devices.commands.TestNetworkSpeed

Verifica la velocità di download e caricamento della rete.

Questo comando richiede i seguenti attributi:
{
  "supportsNetworkDownloadSpeedTest": true,
  "supportsNetworkUploadSpeedTest": true
}

Parametri

Parametri Tipo Descrizione
testDownloadSpeed Booleano

Obbligatorio.

Indica se la velocità di download deve essere testata.

testUploadSpeed Booleano

Obbligatorio.

Indica se la velocità di caricamento deve essere testata.

followUpToken String

Obbligatorio.

Token fornito da Google per il follow-up.

Esempi

Qual è la velocità della rete Wi-Fi?

{
  "command": "action.devices.commands.TestNetworkSpeed",
  "params": {
    "testDownloadSpeed": true,
    "testUploadSpeed": true,
    "followUpToken": "123"
  }
}

Si è verificato un errore durante il tentativo di richiedere un test di velocità.

Valori supportati:

networkSpeedTestInProgress

Risposte di follow-up

I dispositivi con questo tratto potrebbero restituire il seguente payload di risposta di follow-up nell'ambito dell'operazione EXECUTE. Per scoprire di più sull'implementazione delle risposte successive, consulta Notifiche per le azioni della smart home.

Il payload contiene uno dei seguenti valori:

Operazione riuscita: networkDownloadSpeedMbps

Campi Tipo Descrizione
followUpToken String

Obbligatorio.

Token fornito nella richiesta EXECUTE originale.

status String

Obbligatorio.

Risultato della richiesta.

Valori supportati:

SUCCESS
networkDownloadSpeedMbps Number

Obbligatorio.

La velocità di download della rete misurata in megabit al secondo.

Operazione riuscita: networkUploadSpeedMbps

Campi Tipo Descrizione
followUpToken String

Obbligatorio.

Token fornito nella richiesta EXECUTE originale.

status String

Obbligatorio.

Risultato della richiesta.

Valori supportati:

SUCCESS
networkUploadSpeedMbps Number

Obbligatorio.

La velocità di caricamento della rete misurata in megabit al secondo.

Operazione riuscita: networkDownloadSpeedMbps e networkUploadSpeedMbps

Campi Tipo Descrizione
followUpToken String

Obbligatorio.

Token fornito nella richiesta EXECUTE originale.

status String

Obbligatorio.

Risultato della richiesta.

Valori supportati:

SUCCESS
networkDownloadSpeedMbps Number

Obbligatorio.

La velocità di download della rete misurata in megabit al secondo.

networkUploadSpeedMbps Number

Obbligatorio.

La velocità di caricamento della rete misurata in megabit al secondo.

Non riuscita

Campi Tipo Descrizione
followUpToken String

Obbligatorio.

Token fornito nella richiesta EXECUTE originale.

status String

Obbligatorio.

Risultato della richiesta.

Valori supportati:

FAILURE
errorCode String

Obbligatorio.

Il valore può essere qualsiasi codice di errore per questa caratteristica, ad esempio transientError.

Esempi

Qual è la velocità della rete Wi-Fi? (risposta di follow-up)

{
  "NetworkControl": {
    "priority": 0,
    "followUpResponse": {
      "status": "SUCCESS",
      "networkDownloadSpeedMbps": 23.3,
      "networkUploadSpeedMbps": 10.2,
      "followUpToken": "1234"
    }
  }
}

Qual è la velocità della rete Wi-Fi? (risposta di follow up con errore)

{
  "NetworkControl": {
    "priority": 0,
    "followUpResponse": {
      "status": "FAILURE",
      "errorCode": "transientError",
      "followUpToken": "1234"
    }
  }
}

ERRORI del dispositivo

Consulta l'elenco completo degli errori e delle eccezioni.

Si è verificato un errore durante il tentativo di controllare il profilo di rete specificato.

Valori supportati:

networkProfileNotRecognized

Si è verificato un errore durante il tentativo di richiedere un test di velocità.

Valori supportati:

networkSpeedTestInProgress