Schemat cech Smart Home 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ą.

Urządzenia – ATTRIBUTES

Urządzenia z tą cechą mogą zgłaszać te problemy jako część operacji SYNC. Aby się uczyć więcej informacji o obsłudze intencji SYNC znajdziesz tutaj 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ć dla gości można wyłączyć.

supportsGettingGuestNetworkPassword Wartość logiczna

(Domyślnie: false)

Ustaw wartość „true”, jeśli hasło do 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 profile sieciowe można włączyć.

supportsDisablingNetworkProfile Wartość logiczna

(Domyślnie: "false")

Ustaw wartość „true”, jeśli profile sieciowe można wyłączyć.

supportsNetworkDownloadSpeedTest Wartość logiczna

(Domyślnie: false)

Jeśli można uruchomić test szybkości pobierania, ustaw wartość „true” (prawda).

supportsNetworkUploadSpeedTest Wartość logiczna

(Domyślnie: false)

Jeśli można uruchomić test szybkości przesyłania, ustaw wartość „true” (prawda).

Przykłady

Urządzenie sieciowe obsługujące sieć dla gości, profile i test szybkości.

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

Urządzenie STATES

Jednostki o tej cechie mogą zgłaszać: stanów w ramach operacji QUERY. Aby się uczyć więcej informacji o obsłudze intencji QUERY znajdziesz tutaj 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 (megabajty). Wykorzystanie sieci mieści się w bieżącym okresie rozliczeniowym, co może być przydatne podczas monitorowania limitu wykorzystania sieci w tym okresie.

networkUsageLimitMB Number

Limit wykorzystania sieci w MB (megabajty). Limit wykorzystania sieci mieści się w bieżącym okresie rozliczeniowym.

networkUsageUnlimited Wartość logiczna

Określa, czy użycie sieci jest nieograniczone. Jeśli zasada ma wartość Prawda, stan urządzenia networkUsageLimitMB jest ignorowany.

lastNetworkDownloadSpeedTest Obiekt.

Zawiera wyniki ostatniego testu szybkości pobierania w sieci.

downloadSpeedMbps Number

Szybkość pobierania w Mb/s (megabitach na sekundę) ostatniego testu szybkości sieci.

unixTimestampSec Liczba całkowita

Sygnatura czasowa uniksowa (liczba sekund od początku epoki uniksowej), w której przeprowadzono ostatni test szybkości pobierania w sieci.

status String

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

Obsługiwane wartości:

SUCCESS
FAILURE
lastNetworkUploadSpeedTest Obiekt.

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

uploadSpeedMbps Number

Szybkość wysyłania w Mb/s (megabitach na sekundę) z ostatniego testu szybkości sieci.

unixTimestampSec Liczba całkowita

Sygnatura czasowa uniksowa (liczba sekund od początku epoki uniksowej), w której przeprowadzono ostatni test szybkości przesyłania w sieci.

status String

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

Obsługiwane wartości:

SUCCESS
FAILURE
networkSpeedTestInProgress Wartość logiczna

(Domyślnie: false)

Wskazuje, 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ć odpowiedni stan tego profilu.

<string> Obiekt.

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

enabled Wartość logiczna

Bieżący stan włączenia/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 wynikami 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 testem 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 oznaczeniem „dzieci” Wyłączono networkProfile.

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

Polecenia na urządzeniu

Urządzenia z tą cechą mogą reagować na: w ramach operacji EXECUTE. Aby się uczyć więcej informacji o obsłudze intencji EXECUTE znajdziesz tutaj 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. Bezpieczeństwo domu użytkownika może zostać uznane, jeśli inne urządzenia zabezpieczające zostaną wyłączone za pomocą tych poleceń.

To polecenie wymaga następujących atrybutów:
{
  "supportsEnablingGuestNetwork": true,
  "supportsDisablingGuestNetwork": true
}

Parametry

Parametry Typ Opis
enable Wartość logiczna

Wymagane.

Prawda, aby włączyć sieć dla gości, false, by wyłączyć sieć dla gości.

Przykłady

Włącz sieć dla gości.

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

action.devices.commands.EnableDisableNetworkProfile

Włączanie i wyłączanie profilu sieciowego. Należy użyć dodatkowej weryfikacji użytkownika za pomocą kodu PIN. Bezpieczeństwo domu użytkownika może zostać uznane, jeśli inne urządzenia zabezpieczające zostaną wyłączone za pomocą tych poleceń.

To polecenie wymaga następujących atrybutów:
{
  "supportsEnablingNetworkProfile": true,
  "supportsDisablingNetworkProfile": true
}

Parametry

Parametry Typ Opis
profile String

Wymagane.

Nazwa profilu z atrybutu networkProfiles.

enable Wartość logiczna

Wymagane.

Wartość Prawda, aby włączyć profil, false, żeby go wyłączyć.

Przykłady

Wyłączyć internet dla dzieci.

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

Podczas próby sterowania danym profilem sieci 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. Bezpieczeństwo domu użytkownika może zostać uznane, jeśli inne urządzenia zabezpieczające zostaną wyłączone za pomocą tych poleceń.

To polecenie wymaga następujących atrybutów:
{
  "supportsGettingGuestNetworkPassword": true
}

Parametry

Parametry Typ Opis

Brak właściwości

Przykłady

Pokaż moje 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ż moje 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 następujących atrybutów:
{
  "supportsNetworkDownloadSpeedTest": true,
  "supportsNetworkUploadSpeedTest": true
}

Parametry

Parametry Typ Opis
testDownloadSpeed Wartość logiczna

Wymagane.

Wskazuje, czy należy przetestować szybkość pobierania.

testUploadSpeed Wartość logiczna

Wymagane.

Wskazuje, czy należy przetestować szybkość przesyłania.

followUpToken String

Wymagane.

Token dostarczony przez Google na potrzeby dalszych odpowiedzi.

Przykłady

Jaka jest prędkość 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

Urządzenia z tą cechą mogą zwracać te wartości: ładunku kolejnej odpowiedzi w ramach operacji EXECUTE. Aby się uczyć więcej o wdrażaniu kolejnych odpowiedzi, zobacz Powiadomienia dotyczące działań inteligentnego domu.

Ładunek zawiera jeden z następujących elementów:

Udało się: networkDownloadSzybkośćMb/s

Pola Typ Opis
followUpToken String

Wymagane.

Token podany w pierwotnym żądaniu EXECUTE.

status String

Wymagane.

Rezultat żądania.

Obsługiwane wartości:

SUCCESS
networkDownloadSpeedMbps Number

Wymagane.

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

Udało się: networkUploadSzybkość Mb/s

Pola Typ Opis
followUpToken String

Wymagane.

Token podany w pierwotnym żądaniu EXECUTE.

status String

Wymagane.

Rezultat żądania.

Obsługiwane wartości:

SUCCESS
networkUploadSpeedMbps Number

Wymagane.

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

Sukcesy: networkDownloadSzybkośćMb/s i networkUploadSzybkośćMb/s

Pola Typ Opis
followUpToken String

Wymagane.

Token podany w pierwotnym żądaniu EXECUTE.

status String

Wymagane.

Rezultat żądania.

Obsługiwane wartości:

SUCCESS
networkDownloadSpeedMbps Number

Wymagane.

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

networkUploadSpeedMbps Number

Wymagane.

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

Niepowodzenie

Pola Typ Opis
followUpToken String

Wymagane.

Token podany w pierwotnym żądaniu EXECUTE.

status String

Wymagane.

Rezultat żądania.

Obsługiwane wartości:

FAILURE
errorCode String

Wymagane.

Wartością może być dowolny kod błędu tej cechy, na przykład transientError.

Przykłady

Jaka jest prędkość Wi-Fi? (dodatkowa odpowiedź)

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

Jaka jest prędkość Wi-Fi? (kontynuacja odpowiedzi z 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 sterowania danym profilem sieci 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