Schema delle caratteristiche di controllo di rete per la smart home

action.devices.traits.NetworkControl. Questa trait appartiene ai dispositivi che supportano la segnalazione dei dati di rete e l'esecuzione di operazioni specifiche per la rete.

ATTRIBUTES del dispositivo

I dispositivi con questo trait potrebbero segnalare i seguenti attributi nell'ambito dell'operazione SYNC. Per scoprire di più sulla gestione degli intent SYNC, consulta fulfillment dell'intent.

Attributi Tipo Descrizione
supportsEnablingGuestNetwork Booleano

(Valore predefinito: false)

Imposta questo valore su true se è possibile attivare la rete ospite.
supportsDisablingGuestNetwork Booleano

(Valore predefinito: false)

Imposta questo valore su true se è possibile disattivare la rete ospite.
supportsGettingGuestNetworkPassword Booleano

(Valore predefinito: false)

Imposta su true se la password della rete ospite può essere ottenuta tramite il comando GetGuestNetworkPassword.
networkProfiles Matrice

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")

Imposta su true se è possibile abilitare i profili di rete.
supportsDisablingNetworkProfile Booleano

(Valore predefinito: "false")

Imposta questo valore su true se è possibile disattivare i profili di rete.
supportsNetworkDownloadSpeedTest Booleano

(Valore predefinito: false)

Impostarlo su true se è possibile eseguire un test della velocità di download.
supportsNetworkUploadSpeedTest Booleano

(Valore predefinito: false)

Imposta questo valore su true se è possibile eseguire un test della velocità di 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"
  ]
}

Dispositivo STATES

Le entità con questo trait possono segnalare i seguenti stati nell'ambito dell'operazione QUERY. Per scoprire di più sulla gestione degli intent QUERY, consulta fulfillment dell'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; è utile monitorare rispetto al limite di utilizzo della rete durante 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 questo valore è 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 della velocità di rete.
unixTimestampSec Intero

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

Indica se l'ultimo test della 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) in cui è stato eseguito l'ultimo test di velocità di caricamento della rete.
status String

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

Valori supportati:

SUCCESS
FAILURE
networkSpeedTestInProgress Booleano

(Valore predefinito: false)

Indica se è in corso un test di velocità.
networkProfilesState Oggetto

Stato per i 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 essere lo stato corrispondente del profilo.
<string> Oggetto

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 correntemente 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 una rete attiva e risultati del test di velocità.

{
  "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 "bambini" disattivato.

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

COMMANDS dispositivo

I dispositivi con questa caratteristica potrebbero rispondere ai seguenti comandi nell'ambito dell'operazione EXECUTE. Per scoprire di più sulla gestione degli intent EXECUTE, consulta fulfillment dell'intent.

action.devices.commands.EnableDisableGuestNetwork

Attiva o disattiva la rete ospite. È necessario utilizzare la verifica utente secondaria con PIN. La sicurezza in casa di un utente può essere considerata influenzata dalla disattivazione di altri dispositivi di sicurezza tramite questi comandi.

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

Parametri

Parametri Tipo Descrizione
enable Booleano

Obbligatorio.

True per attivare la rete ospite o false per disattivare la rete ospite.

Esempi

Attiva la rete ospite.

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

action.devices.commands.EnableDisableNetworkProfile

Attivazione o disattivazione di un profilo di rete. È necessario utilizzare la verifica utente secondaria con PIN. La sicurezza in casa di un utente può essere considerata influenzata dalla disattivazione di altri dispositivi di sicurezza tramite questi comandi.

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

Parametri

Parametri Tipo Descrizione
profile String

Obbligatorio.

Il nome del profilo dall'attributo networkProfiles.
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 della rete ospite. È necessario utilizzare la verifica utente secondaria con PIN. La sicurezza in casa di un utente può essere considerata influenzata dalla disattivazione di altri dispositivi di sicurezza tramite questi comandi.

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

Testa 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 è necessario verificare la velocità di download.
testUploadSpeed Booleano

Obbligatorio.

Indica se è necessario verificare la velocità di caricamento.
followUpToken String

Obbligatorio.

Token fornito da Google per la risposta di 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 trait possono restituire il seguente payload della risposta di follow-up nell'ambito dell'operazione EXECUTE. Per scoprire di più sull'implementazione delle risposte di follow-up, consulta Notifiche per le azioni per la 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à del Wi-Fi? (risposta di follow-up)

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

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

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

ERRORS dispositivo

Consulta l'elenco completo di errori ed 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