Esquema de atributos de NetworkControl de la casa inteligente

action.devices.traits.NetworkControl: Esta característica pertenece a los dispositivos que admiten informes de datos de red y la realización de operaciones específicas de red.

ATRIBUTOS del dispositivo

Los dispositivos con esta característica pueden informar los siguientes atributos como parte de la operación SYNC. Para obtener más información sobre cómo controlar intents SYNC, consulta Cómo entregar intents.

Atributos Tipo Descripción
supportsEnablingGuestNetwork Booleano

(Predeterminado: false)

Establece este valor en verdadero si se puede habilitar la red para invitados.
supportsDisablingGuestNetwork Booleano

(Predeterminado: false)

Establece como verdadero si se puede inhabilitar la red para invitados.
supportsGettingGuestNetworkPassword Booleano

(Predeterminado: false)

Establece este valor como verdadero si la contraseña de la red para invitados se puede obtener mediante el comando GetGuestNetworkPassword.
networkProfiles Matriz

Indica los nombres de los perfiles de red admitidos.
[item, ...] String

Es el nombre de un perfil de red que representa un grupo de dispositivos relacionados.
supportsEnablingNetworkProfile Booleano

(Predeterminado: "false")

Se establece como verdadero si se pueden habilitar los perfiles de red.
supportsDisablingNetworkProfile Booleano

(Predeterminado: "false")

Se establece como verdadero si se pueden inhabilitar los perfiles de red.
supportsNetworkDownloadSpeedTest Booleano

(Predeterminado: false)

Establece este valor como verdadero si se puede ejecutar una prueba de velocidad de descarga.
supportsNetworkUploadSpeedTest Booleano

(Predeterminado: false)

Establece este valor en verdadero si se puede ejecutar una prueba de velocidad de carga.

Ejemplos

Dispositivo de red que admita la red para invitados, los perfiles y la prueba de velocidad.

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

ESTADOS DEL DISPOSITIVO

Las entidades con este atributo pueden informar los siguientes estados como parte de la operación QUERY. Para obtener más información sobre cómo controlar intents QUERY, consulta Cómo entregar intents.

Estados Tipo Descripción
networkEnabled Booleano

Indica si la red principal está habilitada.
networkSettings Objeto

Contiene el SSID de la red principal.
ssid String

Obligatorio.

SSID de la red
guestNetworkEnabled Booleano

Si la red para invitados está habilitada.
guestNetworkSettings Objeto

Contiene el SSID de la red para invitados.
ssid String

Obligatorio.

SSID de la red
numConnectedDevices Número entero

Es la cantidad de dispositivos conectados a la red.
networkUsageMB Número

El uso de red en MB (megabytes). El uso de la red se encuentra dentro del período de facturación actual, lo que puede ser útil para supervisar en relación con un límite de uso de la red del período de facturación.
networkUsageLimitMB Número

Es el límite de uso de la red en MB (megabytes). El límite de uso de red se encuentra dentro del período de facturación actual.
networkUsageUnlimited Booleano

Indica si el uso de red es ilimitado. Se ignorará el estado del dispositivo networkUsageLimitMB si se establece como verdadero.
lastNetworkDownloadSpeedTest Objeto

Contiene los resultados de la prueba de velocidad de descarga de red más reciente.
downloadSpeedMbps Número

Es la velocidad de descarga en Mbps (megabits por segundo) de la última prueba de velocidad de la red.
unixTimestampSec Número entero

Es la marca de tiempo de Unix (cantidad de segundos desde la época Unix) de la última vez que se ejecutó la prueba de velocidad de descarga de la red.
status String

Indica si la última prueba de velocidad de descarga de la red se realizó correctamente o no.

Valores admitidos:

SUCCESS
FAILURE
lastNetworkUploadSpeedTest Objeto

Contiene los resultados de la prueba de velocidad de carga de red más reciente.
uploadSpeedMbps Número

Es la velocidad de carga en Mbps (megabits por segundo) de la última prueba de velocidad de la red.
unixTimestampSec Número entero

Es la marca de tiempo de Unix (cantidad de segundos desde la época Unix) de la última vez que se ejecutó la prueba de velocidad de carga de red.
status String

Indica si la última prueba de velocidad de carga de la red se realizó correctamente o no.

Valores admitidos:

SUCCESS
FAILURE
networkSpeedTestInProgress Booleano

(Predeterminado: false)

Indica si se está ejecutando una prueba de velocidad.
networkProfilesState Objeto

Estado de los perfiles de red. Este objeto de nivel superior debe contener pares clave-valor en los que la clave sea el nombre de uno de los perfiles de red que se enumeran en el atributo networkProfiles y el valor sea el estado correspondiente de ese perfil.
<string> Objeto

Es un objeto que almacena el estado de un perfil de red individual. El valor de la clave debe ser el nombre de uno de los perfiles de red en el atributo networkProfiles.
enabled Booleano

Es el estado habilitado o inhabilitado actual del perfil de red.

Ejemplos

Dispositivo con una red activa.

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

Dispositivo con una red activa y resultados de la prueba de velocidad

{
  "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 red activa y una prueba de velocidad en curso.

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

Dispositivo con el networkProfile "kids" inhabilitado.

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

COMANDOS del dispositivo

Los dispositivos con esta característica pueden responder a los siguientes comandos como parte de la operación EXECUTE. Para obtener más información sobre cómo controlar intents EXECUTE, consulta Cómo entregar intents.

action.devices.commands.EnableDisableGuestNetwork

Habilita o inhabilita la red para invitados. Se debe usar la verificación secundaria del usuario con PIN. Se puede considerar que la seguridad de la casa de un usuario se ve afectada si se inhabilitan otros dispositivos de seguridad a través de estos comandos.

Este comando requiere los siguientes atributos: 
{
  "supportsEnablingGuestNetwork": true,
  "supportsDisablingGuestNetwork": true
}

Parámetros

Parámetros Tipo Descripción
enable Booleano

Obligatorio.

Es verdadero para habilitar la red para invitados y falso para inhabilitarla.

Ejemplos

Activa la red para invitados.

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

action.devices.commands.EnableDisableNetworkProfile

Habilita o inhabilita un perfil de red. Se debe usar la verificación secundaria del usuario con PIN. Se puede considerar que la seguridad de la casa de un usuario se ve afectada si se inhabilitan otros dispositivos de seguridad a través de estos comandos.

Este comando requiere los siguientes atributos: 
{
  "supportsEnablingNetworkProfile": true,
  "supportsDisablingNetworkProfile": true
}

Parámetros

Parámetros Tipo Descripción
profile String

Obligatorio.

Es el nombre del perfil del atributo networkProfiles.
enable Booleano

Obligatorio.

Es verdadero para habilitar el perfil y falso para inhabilitarlo.

Ejemplos

Desactiva Internet para los niños.

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

Se produjo un error cuando se intentaba controlar el perfil de red determinado.

Valores admitidos:

networkProfileNotRecognized

action.devices.commands.GetGuestNetworkPassword

Obtén la contraseña de la red para invitados. Se debe usar la verificación secundaria del usuario con PIN. Se puede considerar que la seguridad de la casa de un usuario se ve afectada si se inhabilitan otros dispositivos de seguridad a través de estos comandos.

Este comando requiere los siguientes atributos: 
{
  "supportsGettingGuestNetworkPassword": true
}

Parámetros

Parámetros Tipo Descripción

Sin propiedades

Ejemplos

Muéstrame la contraseña de Wi-Fi para invitados.

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

Resultados

Resultados Tipo Descripción
guestNetworkPassword String

Obligatorio.

La contraseña de la red para invitados

Ejemplos

Muéstrame la contraseña de Wi-Fi para invitados.

{
  "guestNetworkPassword": "123456"
}

action.devices.commands.TestNetworkSpeed

Prueba la velocidad de carga y descarga de la red.

Este comando requiere los siguientes atributos: 
{
  "supportsNetworkDownloadSpeedTest": true,
  "supportsNetworkUploadSpeedTest": true
}

Parámetros

Parámetros Tipo Descripción
testDownloadSpeed Booleano

Obligatorio.

Indica si se debe probar la velocidad de descarga.
testUploadSpeed Booleano

Obligatorio.

Indica si se debe probar la velocidad de carga.
followUpToken String

Obligatorio.

Es el token que proporciona Google para la respuesta de seguimiento.

Ejemplos

¿Cuál es la velocidad de Wi-Fi?

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

Se produjo un error cuando se intentaba solicitar una prueba de velocidad.

Valores admitidos:

networkSpeedTestInProgress

Respuestas de seguimiento

Los dispositivos con esta característica pueden mostrar la siguiente carga útil de respuesta de seguimiento como parte de la operación EXECUTE. Para obtener más información sobre cómo implementar respuestas de seguimiento, consulta Notificaciones para Acciones de casa inteligente.

La carga útil contiene una de las siguientes opciones:

Éxito: networkDownloadSpeedMbps

Campos Tipo Descripción
followUpToken String

Obligatorio.

Es el token proporcionado en la solicitud EXECUTE original.
status String

Obligatorio.

Es el resultado de la solicitud.

Valores admitidos:

SUCCESS
networkDownloadSpeedMbps Número

Obligatorio.

Es la velocidad de descarga de la red medida en megabits por segundo.

Se completó correctamente: networkUploadSpeedMbps

Campos Tipo Descripción
followUpToken String

Obligatorio.

Es el token proporcionado en la solicitud EXECUTE original.
status String

Obligatorio.

Es el resultado de la solicitud.

Valores admitidos:

SUCCESS
networkUploadSpeedMbps Número

Obligatorio.

Es la velocidad de carga de la red medida en megabits por segundo.

Éxito: networkDownloadSpeedMbps y networkUploadSpeedMbps

Campos Tipo Descripción
followUpToken String

Obligatorio.

Es el token proporcionado en la solicitud EXECUTE original.
status String

Obligatorio.

Es el resultado de la solicitud.

Valores admitidos:

SUCCESS
networkDownloadSpeedMbps Número

Obligatorio.

Es la velocidad de descarga de la red medida en megabits por segundo.
networkUploadSpeedMbps Número

Obligatorio.

Es la velocidad de carga de la red medida en megabits por segundo.

Error

Campos Tipo Descripción
followUpToken String

Obligatorio.

Es el token proporcionado en la solicitud EXECUTE original.
status String

Obligatorio.

Es el resultado de la solicitud.

Valores admitidos:

FAILURE
errorCode String

Obligatorio.

El valor puede ser cualquier código de error para este atributo, por ejemplo, transientError.

Ejemplos

¿Cuál es la velocidad de Wi-Fi? (respuesta de seguimiento)

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

¿Cuál es la velocidad de Wi-Fi? (respuesta de seguimiento con error)

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

ERRORES del dispositivo

Consulta la lista completa de errores y excepciones.

Se produjo un error cuando se intentaba controlar el perfil de red determinado.

Valores admitidos:

networkProfileNotRecognized

Se produjo un error cuando se intentaba solicitar una prueba de velocidad.

Valores admitidos:

networkSpeedTestInProgress