Willkommen beim Google Home Developer Center, der neuen Anlaufstelle für Smart-Home-Aktionen. Hinweis:Sie erstellen weiterhin Aktionen in der Actions Console.
Mit Sammlungen den Überblick behalten Sie können Inhalte basierend auf Ihren Einstellungen speichern und kategorisieren.

Schema der Smart-Home-Netzwerksteuerung

action.devices.traits.NetworkControl – Diese Eigenschaft gehört zu Geräten, die das Melden von Netzwerkdaten und das Ausführen netzwerkspezifischer Vorgänge unterstützen.

Gerät ATTRIBUTE

Geräte mit diesem Attribut können im Rahmen des Vorgangs SYNC die folgenden Attribute melden. Weitere Informationen zum Umgang mit SYNC-Intents finden Sie unter Intent-Auftragsausführung.

Attribute Typ Beschreibung
supportsEnablingGuestNetwork Boolesch

(Standard: false)

Wird auf „true“ gesetzt, wenn das Gastnetzwerk aktiviert werden kann.

supportsDisablingGuestNetwork Boolesch

(Standard: false)

Wird auf „true“ gesetzt, wenn das Gastnetzwerk deaktiviert werden kann.

supportsGettingGuestNetworkPassword Boolesch

(Standard: false)

Wird auf „true“ gesetzt, wenn das Passwort des Gastnetzwerks über den Befehl GetGuestNetworkPassword abgerufen werden kann.

networkProfiles Array

Gibt die unterstützten Netzwerkprofilnamen an.

[item, ...] String

Name eines Netzwerkprofils, das eine Gruppe zusammengehöriger Geräte darstellt.

supportsEnablingNetworkProfile Boolesch

(Standard: "false")

Wird auf „true“ gesetzt, wenn Netzwerkprofile aktiviert werden können.

supportsDisablingNetworkProfile Boolesch

(Standard: "false")

Wird auf „true“ gesetzt, wenn Netzwerkprofile deaktiviert werden können.

supportsNetworkDownloadSpeedTest Boolesch

(Standard: false)

Wird auf „true“ gesetzt, wenn ein Test der Downloadgeschwindigkeit ausgeführt werden kann.

supportsNetworkUploadSpeedTest Boolesch

(Standard: false)

Wird auf „true“ gesetzt, wenn ein Uploadgeschwindigkeitstest ausgeführt werden kann.

Beispiele

Netzwerkgerät, das Gastnetzwerke, -profile und Geschwindigkeitstests unterstützt.

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

Gerät STATES

Geräte mit diesem Attribut können im Rahmen des Vorgangs QUERY die folgenden Zustände melden. Weitere Informationen zum Umgang mit QUERY-Intents finden Sie unter Intent-Auftragsausführung.

Bundesstaaten Typ Beschreibung
networkEnabled Boolesch

Gibt an, ob das Hauptnetzwerk aktiviert ist.

networkSettings Objekt

Enthält die SSID des Hauptnetzwerks.

ssid String

Erforderlich.

Netzwerk-SSID.

guestNetworkEnabled Boolesch

Gibt an, ob das Gastnetzwerk aktiviert ist.

guestNetworkSettings Objekt

Enthält die SSID des Gastnetzwerks.

ssid String

Erforderlich.

Netzwerk-SSID.

numConnectedDevices Ganzzahl

Die Anzahl der Geräte, die mit dem Netzwerk verbunden sind.

networkUsageMB Number

Die Netzwerknutzung in MB (Megabyte). Die Netzwerknutzung liegt innerhalb des aktuellen Abrechnungszeitraums. Dies kann nützlich sein, um die Netzwerknutzungsdauer für einen Abrechnungszeitraum im Blick zu behalten.

networkUsageLimitMB Number

Das Netzwerknutzungslimit in MB (Megabyte). Das Limit der Netzwerknutzung liegt innerhalb des aktuellen Abrechnungszeitraums.

networkUsageUnlimited Boolesch

Gibt an, ob die Netzwerknutzung unbegrenzt ist. Der Gerätestatus „networkUsageLimitMB“ wird ignoriert, wenn dies auf „true“ gesetzt ist.

lastNetworkDownloadSpeedTest Objekt

Enthält die Ergebnisse des letzten Tests zur Netzwerkdownloadgeschwindigkeit.

downloadSpeedMbps Number

Die Downloadgeschwindigkeit in Mbit/s (Megabit pro Sekunde) des letzten Tests der Netzwerkgeschwindigkeit.

unixTimestampSec Ganzzahl

Der Unix-Zeitstempel (Anzahl der Sekunden seit der Unix-Epoche), zu dem der Test der Netzwerkgeschwindigkeit zum letzten Mal ausgeführt wurde.

status String

Gibt an, ob der letzte Test der Netzwerkgeschwindigkeit beim Download erfolgreich war oder fehlgeschlagen ist.

Unterstützte Werte:

SUCCESS
FAILURE
lastNetworkUploadSpeedTest Objekt

Enthält die Ergebnisse des letzten Tests für die Netzwerkuploadgeschwindigkeit.

uploadSpeedMbps Number

Die Uploadgeschwindigkeit in Mbit/s (Megabit pro Sekunde) des letzten Netzwerkgeschwindigkeitstests.

unixTimestampSec Ganzzahl

Der Unix-Zeitstempel (Anzahl der Sekunden seit der Unix-Epoche) der Ausführungszeit des letzten Netzwerk-Uploadgeschwindigkeitstests.

status String

Gibt an, ob der letzte Test der Netzwerkuploadgeschwindigkeit erfolgreich war oder fehlgeschlagen ist.

Unterstützte Werte:

SUCCESS
FAILURE
networkSpeedTestInProgress Boolesch

(Standard: false)

Gibt an, ob gerade ein Geschwindigkeitstest ausgeführt wird.

networkProfilesState Objekt

Status für Netzwerkprofile. Dieses Objekt auf oberster Ebene sollte Schlüssel/Wert-Paare enthalten, wobei der Schlüssel der Name eines der im Attribut networkProfiles aufgeführten Netzwerkprofile ist und der Wert der entsprechende Status dieses Profils ist.

<string> Objekt

Ein Objekt, das den Status eines einzelnen Netzwerkprofils speichert. Der Wert des Schlüssels sollte der Name eines der Netzwerkprofile im Attribut networkProfiles sein.

enabled Boolesch

Der aktuelle Aktivierungs-/Deaktivierungsstatus des Netzwerkprofils.

Beispiele

Gerät mit einem aktiven Netzwerk:

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

Gerät mit aktivem Netzwerk und Ergebnissen des Geschwindigkeitstests.

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

Gerät mit einem aktiven Netzwerk und Geschwindigkeitstest läuft.

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

Gerät mit deaktiviertem networkProfile-Profil für Kinder

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

Gerätebefehle

Geräte mit diesem Attribut können im Rahmen des Vorgangs EXECUTE auf die folgenden Befehle reagieren. Weitere Informationen zum Umgang mit EXECUTE-Intents finden Sie unter Intent-Auftragsausführung.

action.devices.commands.EnableDisableGuestNetwork

Aktivieren oder deaktivieren Sie das Gastnetzwerk. Es muss eine sekundäre Nutzerbestätigung mit PIN verwendet werden. Wenn andere Sicherheitsgeräte über diese Befehle deaktiviert wurden, kann die Sicherheit eines Nutzers zu Hause beeinträchtigt werden.

Für diesen Befehl sind die folgenden Attribute erforderlich:
{
  "supportsEnablingGuestNetwork": true,
  "supportsDisablingGuestNetwork": true
}

Parameter

Parameter Typ Beschreibung
enable Boolesch

Erforderlich.

Einstellung "true", um das Gastnetzwerk zu aktivieren, und "false", um das Gastnetzwerk zu deaktivieren.

Beispiele

Aktivieren Sie das Gastnetzwerk.

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

action.devices.commands.EnableDisableNetworkProfile

Netzwerkprofil aktivieren oder deaktivieren Es muss eine sekundäre Nutzerbestätigung mit PIN verwendet werden. Wenn andere Sicherheitsgeräte über diese Befehle deaktiviert wurden, kann die Sicherheit eines Nutzers zu Hause beeinträchtigt werden.

Für diesen Befehl sind die folgenden Attribute erforderlich:
{
  "supportsEnablingNetworkProfile": true,
  "supportsDisablingNetworkProfile": true
}

Parameter

Parameter Typ Beschreibung
profile String

Erforderlich.

Der Profilname aus dem Attribut networkProfiles.

enable Boolesch

Erforderlich.

Einstellung "true", um das Profil zu aktivieren, und "false", um das Profil zu deaktivieren.

Beispiele

Schalte das Internet für Kinder aus.

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

Beim Versuch, das angegebene Netzwerkprofil zu steuern, ist ein Fehler aufgetreten.

Unterstützte Werte:

networkProfileNotRecognized

action.devices.commands.GetGuestNetworkPassword

Rufen Sie das Passwort für das Gastnetzwerk ab. Es muss eine sekundäre Nutzerbestätigung mit PIN verwendet werden. Wenn andere Sicherheitsgeräte über diese Befehle deaktiviert wurden, kann die Sicherheit eines Nutzers zu Hause beeinträchtigt werden.

Für diesen Befehl sind die folgenden Attribute erforderlich:
{
  "supportsGettingGuestNetworkPassword": true
}

Parameter

Parameter Typ Beschreibung

Keine Attribute

Beispiele

Zeig mir das Passwort für mein Gast-WLAN.

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

Ergebnisse

Ergebnisse Typ Beschreibung
guestNetworkPassword String

Erforderlich.

Das Passwort für das Gastnetzwerk.

Beispiele

Zeig mir das Passwort für mein Gast-WLAN.

{
  "guestNetworkPassword": "123456"
}

action.devices.commands.TestNetworkSpeed

Testen Sie die Download- und Uploadgeschwindigkeit des Netzwerks.

Für diesen Befehl sind die folgenden Attribute erforderlich:
{
  "supportsNetworkDownloadSpeedTest": true,
  "supportsNetworkUploadSpeedTest": true
}

Parameter

Parameter Typ Beschreibung
testDownloadSpeed Boolesch

Erforderlich.

Gibt an, ob die Downloadgeschwindigkeit getestet werden soll.

testUploadSpeed Boolesch

Erforderlich.

Gibt an, ob die Uploadgeschwindigkeit getestet werden soll.

followUpToken String

Erforderlich.

Von Google bereitgestelltes Token für die Folgeantwort.

Beispiele

Wie hoch ist die WLAN-Geschwindigkeit?

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

Beim Anfordern eines Geschwindigkeitstests ist ein Fehler aufgetreten.

Unterstützte Werte:

networkSpeedTestInProgress

Folgeantworten

Geräte mit diesem Attribut können die folgende Antwortantwortantwort als Teil des Vorgangs EXECUTE zurückgeben. Weitere Informationen zum Implementieren von Folgeantworten finden Sie unter Benachrichtigungen für Smart-Home-Aktionen.

Die Nutzlast enthält einen der folgenden Werte:

Erfolg: networkDownloadSpeed Mbit/s

Felder Typ Beschreibung
followUpToken String

Erforderlich.

Token, das in der ursprünglichen EXECUTE-Anfrage bereitgestellt wurde.

status String

Erforderlich.

Ergebnis der Anfrage.

Unterstützte Werte:

SUCCESS
networkDownloadSpeedMbps Number

Erforderlich.

Die Netzwerk-Downloadgeschwindigkeit wird in Megabit pro Sekunde gemessen.

Erfolgreich: networkUploadSpeed Mbit/s

Felder Typ Beschreibung
followUpToken String

Erforderlich.

Token, das in der ursprünglichen EXECUTE-Anfrage bereitgestellt wurde.

status String

Erforderlich.

Ergebnis der Anfrage.

Unterstützte Werte:

SUCCESS
networkUploadSpeedMbps Number

Erforderlich.

Die Uploadgeschwindigkeit des Netzwerks, gemessen in Megabit pro Sekunde.

Erfolgreich: networkDownloadSpeedMBs und networkUploadSpeedMBs

Felder Typ Beschreibung
followUpToken String

Erforderlich.

Token, das in der ursprünglichen EXECUTE-Anfrage bereitgestellt wurde.

status String

Erforderlich.

Ergebnis der Anfrage.

Unterstützte Werte:

SUCCESS
networkDownloadSpeedMbps Number

Erforderlich.

Die Netzwerk-Downloadgeschwindigkeit wird in Megabit pro Sekunde gemessen.

networkUploadSpeedMbps Number

Erforderlich.

Die Uploadgeschwindigkeit des Netzwerks, gemessen in Megabit pro Sekunde.

Fehler

Felder Typ Beschreibung
followUpToken String

Erforderlich.

Token, das in der ursprünglichen EXECUTE-Anfrage bereitgestellt wurde.

status String

Erforderlich.

Ergebnis der Anfrage.

Unterstützte Werte:

FAILURE
errorCode String

Erforderlich.

Der Wert kann ein beliebiger Fehlercode für diese Eigenschaft sein, z. B. transientError.

Beispiele

Wie hoch ist die WLAN-Geschwindigkeit? (Anschlussantwort)

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

Wie hoch ist die WLAN-Geschwindigkeit? (Folgeantwort mit Fehler)

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

Gerät ERRORS

Vollständige Liste der Fehler und Ausnahmen

Beim Versuch, das angegebene Netzwerkprofil zu steuern, ist ein Fehler aufgetreten.

Unterstützte Werte:

networkProfileNotRecognized

Beim Anfordern eines Geschwindigkeitstests ist ein Fehler aufgetreten.

Unterstützte Werte:

networkSpeedTestInProgress