Esquema de traço do NetworkControl de casa inteligente

action.devices.traits.NetworkControl: essa característica pertence a dispositivos que oferecem suporte para informar dados de rede e realizar operações específicas da rede.

ATRIBUTOS do dispositivo

Dispositivos com essa característica podem informar os seguintes atributos como parte da operação SYNC. Para saber mais sobre o gerenciamento de intents SYNC, consulte fulfillment de intents.

Atributos Tipo Descrição
supportsEnablingGuestNetwork Booleano

Padrão: false.

Defina como "true" se a rede para visitantes puder ser ativada.
supportsDisablingGuestNetwork Booleano

Padrão: false.

Defina como "true" se a rede para visitantes puder ser desativada.
supportsGettingGuestNetworkPassword Booleano

Padrão: false.

Defina como "true" se a senha da rede para visitantes puder ser recebida pelo comando GetGuestNetworkPassword.
networkProfiles Array

Indica os nomes dos perfis de rede compatíveis.
[item, ...] String

Nome de um perfil de rede que representa um grupo de dispositivos relacionados.
supportsEnablingNetworkProfile Booleano

Padrão: "false".

Definido como verdadeiro se for possível ativar os perfis de rede.
supportsDisablingNetworkProfile Booleano

Padrão: "false".

Definido como verdadeiro se os perfis de rede puderem ser desativados.
supportsNetworkDownloadSpeedTest Booleano

Padrão: false.

Defina como "true" se for possível executar um teste de velocidade de download.
supportsNetworkUploadSpeedTest Booleano

Padrão: false.

Defina como verdadeiro se for possível realizar um teste de velocidade de upload.

Exemplos

Dispositivo de rede compatível com redes, perfis e testes de velocidade para visitantes.

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

STATES do dispositivo

Entidades com essa característica podem informar os seguintes estados como parte da operação QUERY. Para saber mais sobre o gerenciamento de intents QUERY, consulte fulfillment de intents.

Estados Tipo Descrição
networkEnabled Booleano

Indica se a rede principal está ativada.
networkSettings Object

Contém o SSID da rede principal.
ssid String

Obrigatório.

SSID (Identificador do conjunto de serviços) da rede.
guestNetworkEnabled Booleano

Indica se a rede para visitantes está ativada.
guestNetworkSettings Object

Contém o SSID (Identificador do conjunto de serviços) da rede para visitantes.
ssid String

Obrigatório.

SSID (Identificador do conjunto de serviços) da rede.
numConnectedDevices Número inteiro

O número de dispositivos conectados à rede.
networkUsageMB Número

O uso da rede em MB (megabytes). O uso da rede está dentro do período de faturamento atual, o que pode ser útil para monitorar o limite de uso da rede no período de faturamento.
networkUsageLimitMB Número

O limite de uso da rede em MB (megabytes). O limite de uso da rede está dentro do período de faturamento atual.
networkUsageUnlimited Booleano

Indica se o uso da rede é ilimitado. O estado do dispositivo networkUsageLimitMB será ignorado se for definido como verdadeiro.
lastNetworkDownloadSpeedTest Object

Contém os resultados do teste de velocidade de download da rede mais recente.
downloadSpeedMbps Número

Velocidade de download em Mbps (megabits por segundo) do último teste de velocidade da rede.
unixTimestampSec Número inteiro

É o carimbo de data/hora Unix (número de segundos desde a era Unix) de quando o último teste de velocidade de download da rede foi executado.
status String

Indica se o último teste de velocidade de download da rede foi concluído ou falhou.

Os valores suportados são:

SUCCESS
FAILURE
lastNetworkUploadSpeedTest Object

Contém os resultados do teste de velocidade de upload mais recente da rede.
uploadSpeedMbps Número

A velocidade de upload em Mbps (megabits por segundo) do último teste de velocidade da rede.
unixTimestampSec Número inteiro

É o carimbo de data/hora Unix (número de segundos desde a era Unix) de quando o último teste de velocidade de upload da rede foi executado.
status String

Indica se o último teste de velocidade de upload da rede foi concluído ou falhou.

Os valores suportados são:

SUCCESS
FAILURE
networkSpeedTestInProgress Booleano

Padrão: false.

Se um teste de velocidade está em andamento.
networkProfilesState Object

Estado dos perfis de rede. Esse objeto de nível superior precisa conter pares de chave-valor, em que a chave é o nome de um dos perfis de rede listados no atributo networkProfiles, e o valor precisa ser o estado correspondente desse perfil.
<string> Object

Um objeto que armazena o estado de um perfil de rede individual. O valor da chave deve ser o nome de um dos perfis de rede no atributo networkProfiles.
enabled Booleano

O estado atual ativado/desativado do perfil de rede.

Exemplos

Dispositivo com uma rede ativa.

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

Dispositivo com uma rede ativa e resultados de teste de velocidade.

{
  "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 com rede ativa e teste de velocidade em andamento.

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

Dispositivo com o networkProfile "kids" desativado.

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

Comandos do dispositivo

Dispositivos com essa característica podem responder aos seguintes comandos como parte da operação EXECUTE. Para saber mais sobre o gerenciamento de intents EXECUTE, consulte fulfillment de intents.

action.devices.commands.EnableDisableGuestNetwork

Ative ou desative a rede para visitantes. É necessário usar a verificação secundária do usuário com PIN. A segurança residencial de um usuário poderá ser considerada afetada se outros dispositivos de segurança forem desativados por esses comandos.

Esse comando requer os seguintes atributos: 
{
  "supportsEnablingGuestNetwork": true,
  "supportsDisablingGuestNetwork": true
}

Parâmetros

Parâmetros Tipo Descrição
enable Booleano

Obrigatório.

Verdadeiro para ativar a rede para visitantes, falso para desativar a rede para visitantes.

Exemplos

Ative a rede para visitantes.

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

action.devices.commands.EnableDisableNetworkProfile

Ativar ou desativar um perfil de rede. É necessário usar a verificação secundária do usuário com PIN. A segurança residencial de um usuário poderá ser considerada afetada se outros dispositivos de segurança forem desativados por esses comandos.

Esse comando requer os seguintes atributos: 
{
  "supportsEnablingNetworkProfile": true,
  "supportsDisablingNetworkProfile": true
}

Parâmetros

Parâmetros Tipo Descrição
profile String

Obrigatório.

O nome do perfil do atributo networkProfiles.
enable Booleano

Obrigatório.

Verdadeiro para ativar o perfil ou falso para desativá-lo.

Exemplos

Desative a Internet para as crianças.

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

Ocorreu um erro ao tentar controlar o perfil de rede especificado.

Os valores suportados são:

networkProfileNotRecognized

action.devices.commands.GetGuestNetworkPassword

Encontre a senha da rede para visitantes. É necessário usar a verificação secundária do usuário com PIN. A segurança residencial de um usuário poderá ser considerada afetada se outros dispositivos de segurança forem desativados por esses comandos.

Esse comando requer os seguintes atributos: 
{
  "supportsGettingGuestNetworkPassword": true
}

Parâmetros

Parâmetros Tipo Descrição

Não há propriedades

Exemplos

Mostrar a senha do Wi-Fi para visitantes

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

Resultados

Resultados Tipo Descrição
guestNetworkPassword String

Obrigatório.

Senha da rede para visitantes.

Exemplos

Mostrar a senha do Wi-Fi para visitantes

{
  "guestNetworkPassword": "123456"
}

action.devices.commands.TestNetworkSpeed

Testar a velocidade de download e upload da rede.

Esse comando requer os seguintes atributos: 
{
  "supportsNetworkDownloadSpeedTest": true,
  "supportsNetworkUploadSpeedTest": true
}

Parâmetros

Parâmetros Tipo Descrição
testDownloadSpeed Booleano

Obrigatório.

Indica se a velocidade de download precisa ser testada.
testUploadSpeed Booleano

Obrigatório.

Indica se a velocidade de upload precisa ser testada.
followUpToken String

Obrigatório.

Token fornecido pelo Google para resposta de acompanhamento.

Exemplos

Qual é a velocidade do Wi-Fi?

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

Ocorreu um erro ao tentar solicitar um teste de velocidade.

Os valores suportados são:

networkSpeedTestInProgress

Respostas de acompanhamento

Dispositivos com essa característica podem retornar o payload de resposta de acompanhamento a seguir como parte da operação EXECUTE. Para saber mais sobre a implementação de respostas de acompanhamento, consulte Notificações para ações de casa inteligente.

O payload contém um dos seguintes itens:

Sucesso: networkDownloadSpeedMbps

Campos Tipo Descrição
followUpToken String

Obrigatório.

Token fornecido na solicitação EXECUTE original.
status String

Obrigatório.

Resultado da solicitação.

Os valores suportados são:

SUCCESS
networkDownloadSpeedMbps Número

Obrigatório.

A velocidade de download da rede medida em megabits por segundo.

Sucesso: networkUploadSpeedMbps

Campos Tipo Descrição
followUpToken String

Obrigatório.

Token fornecido na solicitação EXECUTE original.
status String

Obrigatório.

Resultado da solicitação.

Os valores suportados são:

SUCCESS
networkUploadSpeedMbps Número

Obrigatório.

A velocidade de upload da rede medida em megabits por segundo.

Sucesso: networkDownloadSpeedMbps e networkUploadSpeedMbps

Campos Tipo Descrição
followUpToken String

Obrigatório.

Token fornecido na solicitação EXECUTE original.
status String

Obrigatório.

Resultado da solicitação.

Os valores suportados são:

SUCCESS
networkDownloadSpeedMbps Número

Obrigatório.

A velocidade de download da rede medida em megabits por segundo.
networkUploadSpeedMbps Número

Obrigatório.

A velocidade de upload da rede medida em megabits por segundo.

Falha

Campos Tipo Descrição
followUpToken String

Obrigatório.

Token fornecido na solicitação EXECUTE original.
status String

Obrigatório.

Resultado da solicitação.

Os valores suportados são:

FAILURE
errorCode String

Obrigatório.

O valor pode ser qualquer código de erro para essa característica, por exemplo, transientError.

Exemplos

Qual é a velocidade do Wi-Fi? (resposta de acompanhamento)

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

Qual é a velocidade do Wi-Fi? (resposta de acompanhamento com falha)

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

ERROS DO Dispositivo

Veja a lista completa de erros e exceções.

Ocorreu um erro ao tentar controlar o perfil de rede especificado.

Os valores suportados são:

networkProfileNotRecognized

Ocorreu um erro ao tentar solicitar um teste de velocidade.

Os valores suportados são:

networkSpeedTestInProgress