Smart-Home-Lufterfrischer-Leitfaden

action.devices.types.AIRFRESHENER – Lufterfrischer können aktiviert und deaktiviert werden. Möglicherweise können Sie verschiedene Modi anpassen.

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

Gerätefunktionen

In der zugehörigen Dokumentation zur Eigenschaft finden Sie Implementierungsdetails wie Attribute und Status, die Ihr Dienst unterstützen sollte, und zum Erstellen von EXECUTE- und QUERY-Antworten.

Erforderliche Eigenschaften

Diese Eigenschaften und Befehle sind erforderlich, falls sie auf Ihr Gerät zutreffen. Wenn Ihr Gerät diese Eigenschaften nicht unterstützt, geben Sie den Fehlercode functionNotSupported in einer QUERY- oder EXECUTE-Antwort ein. Weitere Informationen finden Sie unter Fehler und Ausnahmen.

Diese Eigenschaften werden empfohlen, sofern sie für Ihr Gerät relevant sind. Sie können jedoch alle verfügbaren Merkmale beliebig kombinieren, um Ihre bestehenden Produktfunktionen bestmöglich anzupassen.

Qualitätsanforderungen

  • Latenz: muss kleiner oder gleich 1.000 ms sein.
  • Zuverlässigkeit:muss größer oder gleich 97% sein

Beispielgerät: Einfacher Lufterfrischer

Dieser Abschnitt enthält Beispiel-Nutzlasten, die auf einem gemeinsamen Gerätetyp und den oben genannten Merkmalen eine gemeinsame „Lufterfrischer“ darstellen. Wenn du bei der Implementierung Eigenschaften 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.AIRFRESHENER",
        "traits": [
          "action.devices.traits.OnOff",
          "action.devices.traits.Toggles"
        ],
        "name": {
          "name": "Simple air freshener"
        },
        "willReportState": true,
        "attributes": {
          "availableToggles": [
            {
              "name": "intermittent_key",
              "name_values": [
                {
                  "name_synonym": [
                    "Intermittent Spray"
                  ],
                  "lang": "en"
                },
                {
                  "name_synonym": [
                    "Intermittierender Spray"
                  ],
                  "lang": "de"
                }
              ]
            }
          ]
        },
        "deviceInfo": {
          "manufacturer": "smart-home-inc",
          "model": "hs1234",
          "hwVersion": "3.2",
          "swVersion": "11.4"
        }
      }
    ]
  }
}

Beispiel für eine QUERY-Antwort

Anfrage
{
  "requestId": "6894439706274654514",
  "inputs": [
    {
      "intent": "action.devices.QUERY",
      "payload": {
        "devices": [
          {
            "id": "123"
          }
        ]
      }
    }
  ]
}
Antwort
{
  "requestId": "6894439706274654514",
  "payload": {
    "devices": {
      "123": {
        "status": "SUCCESS",
        "online": true,
        "on": true,
        "currentToggleSettings": {
          "intermittent_key": true
        }
      }
    }
  }
}

Beispiele für EXECUTE-Befehle

An

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

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

Ein-/Aus-Schaltflächen

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

Anfrage
{
  "requestId": "6894439706274654518",
  "inputs": [
    {
      "intent": "action.devices.EXECUTE",
      "payload": {
        "commands": [
          {
            "devices": [
              {
                "id": "123"
              }
            ],
            "execution": [
              {
                "command": "action.devices.commands.SetToggles",
                "params": {
                  "updateToggleSettings": {
                    "intermittent_key": false
                  }
                }
              }
            ]
          }
        ]
      }
    }
  ]
}
Antwort
{
  "requestId": "6894439706274654518",
  "payload": {
    "commands": [
      {
        "ids": [
          "123"
        ],
        "status": "SUCCESS",
        "states": {
          "online": true,
          "currentToggleSettings": {
            "intermittent_key": false
          }
        }
      }
    ]
  }
}

Gerät ERRORS

Hier finden Sie die vollständige Liste der Fehler und Ausnahmen.