Schemat Trait SmartControl NetworkControl

action.devices.traits.NetworkControl – ta cecha należy do urządzeń, które obsługują raportowanie danych sieciowych i wykonywanie operacji związanych z siecią.

ATTRIBUTES urządzenia

W ramach operacji SYNC urządzenia z tą cechą mogą zgłaszać wymienione poniżej atrybuty. Więcej informacji o obsłudze intencji SYNC znajdziesz w sekcji Realizacja intencji.

Atrybuty Typ Opis
supportsEnablingGuestNetwork Wartość logiczna

(Domyślnie: false)

Ustaw wartość „true”, jeśli można włączyć sieć dla gości.
supportsDisablingGuestNetwork Wartość logiczna

(Domyślnie: false)

Ustaw wartość „true”, jeśli sieć gościnna może zostać wyłączona.
supportsGettingGuestNetworkPassword Wartość logiczna

(Domyślnie: false)

Ustaw wartość „true”, jeśli hasło sieci dla gości można uzyskać za pomocą polecenia GetGuestNetworkPassword.
networkProfiles Tablica

Wskazuje obsługiwane nazwy profili sieciowych.
[item, ...] String

Nazwa profilu sieciowego reprezentującego grupę powiązanych urządzeń.
supportsEnablingNetworkProfile Wartość logiczna

(Domyślnie: "false")

Ustaw wartość „true”, jeśli można włączyć profile sieci.
supportsDisablingNetworkProfile Wartość logiczna

(Domyślnie: "false")

Ustaw wartość „true”, jeśli profile sieciowe mogą być wyłączone.
supportsNetworkDownloadSpeedTest Wartość logiczna

(Domyślnie: false)

Ustaw wartość „true”, jeśli można uruchomić test szybkości pobierania.
supportsNetworkUploadSpeedTest Wartość logiczna

(Domyślnie: false)

Ustaw wartość „true”, jeśli można uruchomić test szybkości przesyłania.

Przykłady

Urządzenie sieciowe, które obsługuje sieć gościa, profile i test szybkości.

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

Urządzenie STATES

W ramach operacji QUERY encje z tą cechą mogą zgłaszać wymienione poniżej stany. Więcej informacji o obsłudze intencji QUERY znajdziesz w sekcji Realizacja intencji.

Stany Typ Opis
networkEnabled Wartość logiczna

Określa, czy sieć główna jest włączona.
networkSettings Obiekt

Zawiera identyfikator SSID głównej sieci.
ssid String

Wymagane.

Identyfikator SSID sieci
guestNetworkEnabled Wartość logiczna

Określa, czy sieć dla gości jest włączona.
guestNetworkSettings Obiekt

Zawiera identyfikator SSID sieci dla gości.
ssid String

Wymagane.

Identyfikator SSID sieci
numConnectedDevices Liczba całkowita

Liczba urządzeń połączonych z siecią.
networkUsageMB Number

Wykorzystanie sieci w MB (megabajtach). Wykorzystanie sieci mieści się w bieżącym okresie rozliczeniowym, co może być przydatne do monitorowania limitu wykorzystania sieci w tym okresie.
networkUsageLimitMB Number

Limit użycia sieci w MB (megabajtach). Limit użycia sieci mieści się w bieżącym okresie rozliczeniowym.
networkUsageUnlimited Wartość logiczna

Użycie sieci jest nieograniczone. Jeśli zasada ma wartość Prawda, stan NetworkUsageLimitMB jest ignorowany.
lastNetworkDownloadSpeedTest Obiekt

Zawiera wyniki ostatniego testu szybkości pobierania sieci.
downloadSpeedMbps Number

Szybkość pobierania w Mb/s (megabitach na sekundę) podczas ostatniego testu szybkości sieci.
unixTimestampSec Liczba całkowita

Sygnatura czasowa Unix (liczba sekund od czasu uniksowego) czasu przeprowadzenia ostatniego testu szybkości pobierania w sieci.
status String

Wskazuje, czy ostatni test szybkości pobierania sieci zakończył się powodzeniem lub niepowodzeniem.

Obsługiwane wartości:

SUCCESS
FAILURE
lastNetworkUploadSpeedTest Obiekt

Zawiera wyniki ostatniego testu szybkości przesyłania w sieci.
uploadSpeedMbps Number

Szybkość przesyłania w Mb/s (megabitach na sekundę) podczas ostatniego testu szybkości sieci.
unixTimestampSec Liczba całkowita

Sygnatura czasowa Unix (liczba sekund od czasu uniksowej) czasu przeprowadzenia ostatniego testu szybkości przesyłania w sieci.
status String

Wskazuje, czy ostatni test szybkości przesyłania sieci zakończył się powodzeniem czy nie.

Obsługiwane wartości:

SUCCESS
FAILURE
networkSpeedTestInProgress Wartość logiczna

(Domyślnie: false)

Czy trwa test szybkości.
networkProfilesState Obiekt

Stan profili sieciowych. Ten obiekt najwyższego poziomu powinien zawierać pary klucz-wartość, w których klucz jest nazwą jednego z profili sieciowych wymienionych w atrybucie networkProfiles, a wartością powinien być podany stan tego profilu.
<string> Obiekt

Obiekt przechowujący stan pojedynczego profilu sieciowego. Wartość klucza powinna być nazwą jednego z profili sieciowych w atrybucie networkProfiles.
enabled Wartość logiczna

Bieżący stan włączenia lub wyłączenia profilu sieci.

Przykłady

Urządzenie z aktywną siecią.

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

Urządzenie z aktywną siecią i wynik testu szybkości.

{
  "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"
  }
}

Urządzenie z aktywną siecią i test szybkości.

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

Urządzenie z wyłączonym profilem sieci „dzieci”.

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

Urządzenie CommandS

W ramach operacji EXECUTE urządzenia z tą cechą mogą reagować na podane niżej polecenia. Więcej informacji o obsłudze intencji EXECUTE znajdziesz w sekcji Realizacja intencji.

action.devices.commands.EnableDisableGuestNetwork

Włącz lub wyłącz sieć dla gości. Należy użyć dodatkowej weryfikacji użytkownika za pomocą kodu PIN. Jeśli te polecenia zostaną wyłączone na innych urządzeniach zabezpieczających, może to być zagrożenie w domu.

To polecenie wymaga tych atrybutów:
{
  "supportsEnablingGuestNetwork": true,
  "supportsDisablingGuestNetwork": true
}

Parametry

Parametry Typ Opis
enable Wartość logiczna

Wymagane.

Wartość prawda powoduje włączenie sieci dla gości, a fałsz – wyłączenie sieci dla gości.

Przykłady

Włącz sieć dla gości.

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

action.devices.commands.EnableDisableNetworkProfile

Włącz lub wyłącz profil sieciowy. Należy użyć dodatkowej weryfikacji użytkownika za pomocą kodu PIN. Jeśli te polecenia zostaną wyłączone na innych urządzeniach zabezpieczających, może to być zagrożenie w domu.

To polecenie wymaga tych atrybutów:
{
  "supportsEnablingNetworkProfile": true,
  "supportsDisablingNetworkProfile": true
}

Parametry

Parametry Typ Opis
profile String

Wymagane.

Nazwa profilu z atrybutu networkProfiles.
enable Wartość logiczna

Wymagane.

Prawda, aby włączyć profil, lub Fałsz, aby go wyłączyć.

Przykłady

Wyłącz dzieciom dostęp do internetu.

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

Podczas próby kontrolowania danego profilu sieciowego wystąpił błąd.

Obsługiwane wartości:

networkProfileNotRecognized

action.devices.commands.GetGuestNetworkPassword

Uzyskaj hasło do sieci dla gości. Należy użyć dodatkowej weryfikacji użytkownika za pomocą kodu PIN. Jeśli te polecenia zostaną wyłączone na innych urządzeniach zabezpieczających, może to być zagrożenie w domu.

To polecenie wymaga tych atrybutów:
{
  "supportsGettingGuestNetworkPassword": true
}

Parametry

Parametry Typ Opis

Brak właściwości

Przykłady

Pokaż hasło do Wi-Fi dla gości.

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

Wyniki

Wyniki Typ Opis
guestNetworkPassword String

Wymagane.

Hasło do sieci dla gości.

Przykłady

Pokaż hasło do Wi-Fi dla gości.

{
  "guestNetworkPassword": "123456"
}

action.devices.commands.TestNetworkSpeed

Sprawdź szybkość pobierania i przesyłania w sieci.

To polecenie wymaga tych atrybutów:
{
  "supportsNetworkDownloadSpeedTest": true,
  "supportsNetworkUploadSpeedTest": true
}

Parametry

Parametry Typ Opis
testDownloadSpeed Wartość logiczna

Wymagane.

Wskazuje, czy szybkość pobierania powinna zostać przetestowana.
testUploadSpeed Wartość logiczna

Wymagane.

Wskazuje, czy szybkość przesyłania powinna zostać przetestowana.
followUpToken String

Wymagane.

Token udostępniony przez Google dla odpowiedzi uzupełniającej.

Przykłady

Jaka jest szybkość Wi-Fi?

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

Podczas próby wysłania prośby o test szybkości wystąpił błąd.

Obsługiwane wartości:

networkSpeedTestInProgress

Dalsze odpowiedzi

W ramach operacji EXECUTE urządzenia z tą cechą mogą zwrócić poniższy ładunek odpowiedzi. Więcej informacji o wdrażaniu dalszych odpowiedzi znajdziesz w artykule Powiadomienia dotyczące inteligentnych działań w domu.

Ładunek zawiera jedną z tych wartości:

Udało się: networkDownloadSpeed Mb

Pola Typ Opis
followUpToken String

Wymagane.

Token podany w pierwotnym żądaniu EXECUTE.
status String

Wymagane.

Wynik żądania.

Obsługiwane wartości:

SUCCESS
networkDownloadSpeedMbps Number

Wymagane.

Szybkość pobierania w sieci mierzona w megabitach na sekundę.

Udało się: NetworkUploadSpeed Mb/s

Pola Typ Opis
followUpToken String

Wymagane.

Token podany w pierwotnym żądaniu EXECUTE.
status String

Wymagane.

Wynik żądania.

Obsługiwane wartości:

SUCCESS
networkUploadSpeedMbps Number

Wymagane.

Szybkość przesyłania sieci mierzona w megabitach na sekundę.

Gotowe: networkDownloadSpeed Mb/s i networkUploadSpeed Mb/s

Pola Typ Opis
followUpToken String

Wymagane.

Token podany w pierwotnym żądaniu EXECUTE.
status String

Wymagane.

Wynik żądania.

Obsługiwane wartości:

SUCCESS
networkDownloadSpeedMbps Number

Wymagane.

Szybkość pobierania w sieci mierzona w megabitach na sekundę.
networkUploadSpeedMbps Number

Wymagane.

Szybkość przesyłania sieci mierzona w megabitach na sekundę.

Niepowodzenie

Pola Typ Opis
followUpToken String

Wymagane.

Token podany w pierwotnym żądaniu EXECUTE.
status String

Wymagane.

Wynik żądania.

Obsługiwane wartości:

FAILURE
errorCode String

Wymagane.

Wartością może być kod błędu dla tej cechy, np. transientError.

Przykłady

Jaka jest szybkość Wi-Fi? (Odpowiedź uzupełniająca)

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

Jaka jest szybkość Wi-Fi? (dalsza odpowiedź zakończy się niepowodzeniem)

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

Urządzenie ERRORS

Zobacz pełną listę błędów i wyjątków.

Podczas próby kontrolowania danego profilu sieciowego wystąpił błąd.

Obsługiwane wartości:

networkProfileNotRecognized

Podczas próby wysłania prośby o test szybkości wystąpił błąd.

Obsługiwane wartości:

networkSpeedTestInProgress