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.

Smart-Home-Staubsauger

action.devices.types.VACUUM – Staubsauger können Funktionen wie das Starten, Stoppen und Pausieren der Reinigung, Andocken, Prüfen des aktuellen Reinigungszyklus, Ermitteln des Staubsaugers oder Anpassen verschiedener Modi haben. Einige Staubsauger unterstützen die Reinigung bestimmter Bereiche im Haus.

Dieser Typ gibt an, dass das Gerät das Staubsaugersymbol und einige zugehörige Synonyme und Aliasse erhält.

Gerätefunktionen

In der entsprechenden Trat-Dokumentation finden Sie Details zur Implementierung, z. B. Attribute und Status, die Ihr Dienst unterstützen sollte, und das Erstellen von EXECUTE- und QUERY-Antworten.

Erforderliche Merkmale

Diese Eigenschaften und Befehle sind gegebenenfalls für Ihr Gerät erforderlich.

Diese Eigenschaften werden empfohlen, sofern sie auf Ihrem Gerät zutreffen. Sie können jedoch alle verfügbaren Merkmale beliebig kombinieren, um die vorhandene Produktfunktionalität bestmöglich anzupassen.

Qualitätsanforderungen

  • Latenz muss kleiner oder gleich 800 ms sein.
  • Zuverlässigkeit muss mindestens 97% betragen.

Beispielgerät: Einfacher Staubsauger

Dieser Abschnitt enthält Intent-Nutzlasten, die je nach Gerätetyp und Merkmalen oben einen gemeinsamen "Staubsauger" darstellen. Wenn du in deiner Implementierung Merkmale hinzufügst oder entfernst, ändere deine Antworten entsprechend.

SYNC-Beispielantwort

Anfrage
{
  "requestId": "6894439706274654512",
  "inputs": [
    {
      "intent": "action.devices.SYNC"
    }
  ]
}
Antwort
{
  "requestId": "6894439706274654512",
  "payload": {
    "agentUserId": "user123",
    "devices": [
      {
        "id": "123",
        "type": "action.devices.types.VACUUM",
        "traits": [
          "action.devices.traits.Dock",
          "action.devices.traits.EnergyStorage",
          "action.devices.traits.StartStop"
        ],
        "name": {
          "name": "Simple vacuum"
        },
        "willReportState": true,
        "attributes": {
          "queryOnlyEnergyStorage": true,
          "pausable": true
        },
        "deviceInfo": {
          "manufacturer": "smart-home-inc",
          "model": "hs1234",
          "hwVersion": "3.2",
          "swVersion": "11.4"
        }
      }
    ]
  }
}

QUERY-Beispielantwort

Anfrage
{
  "requestId": "6894439706274654514",
  "inputs": [
    {
      "intent": "action.devices.QUERY",
      "payload": {
        "devices": [
          {
            "id": "123"
          }
        ]
      }
    }
  ]
}
Antwort
{
  "requestId": "6894439706274654514",
  "payload": {
    "devices": {
      "123": {
        "status": "SUCCESS",
        "online": true,
        "isRunning": false,
        "isPaused": false,
        "isDocked": true,
        "descriptiveCapacityRemaining": "HIGH",
        "capacityRemaining": [
          {
            "unit": "SECONDS",
            "rawValue": 36000
          },
          {
            "unit": "PERCENTAGE",
            "rawValue": 90
          }
        ]
      }
    }
  }
}

Beispiele für EXECUTE-Befehle

Andocken

Weitere Informationen zu den Befehlsparametern finden Sie in der Referenz zu action.devices.traits.Dock.

Anfrage
{
  "requestId": "6894439706274654516",
  "inputs": [
    {
      "intent": "action.devices.EXECUTE",
      "payload": {
        "commands": [
          {
            "devices": [
              {
                "id": "123"
              }
            ],
            "execution": [
              {
                "command": "action.devices.commands.Dock"
              }
            ]
          }
        ]
      }
    }
  ]
}
Antwort
{
  "requestId": "6894439706274654516",
  "payload": {
    "commands": [
      {
        "ids": [
          "123"
        ],
        "status": "SUCCESS",
        "states": {
          "online": true,
          "isDocked": true
        }
      }
    ]
  }
}

StartStop

Weitere Informationen zu den Befehlsparametern finden Sie in der Referenz zu action.devices.traits.StartStop.

Anfrage
{
  "requestId": "6894439706274654518",
  "inputs": [
    {
      "intent": "action.devices.EXECUTE",
      "payload": {
        "commands": [
          {
            "devices": [
              {
                "id": "123"
              }
            ],
            "execution": [
              {
                "command": "action.devices.commands.StartStop",
                "params": {
                  "start": true
                }
              }
            ]
          }
        ]
      }
    }
  ]
}
Antwort
{
  "requestId": "6894439706274654518",
  "payload": {
    "commands": [
      {
        "ids": [
          "123"
        ],
        "status": "SUCCESS",
        "states": {
          "online": true,
          "isRunning": true,
          "isPaused": false
        }
      }
    ]
  }
}

Gerät ERRORS

Vollständige Liste der Fehler und Ausnahmen