Smart-Home-Lüfter-Leitfaden

action.devices.types.FAN – Lüfter können in der Regel ein- und ausgeschaltet werden und haben Einstellungen für die Geschwindigkeit. Einige Lüfter haben möglicherweise auch zusätzliche unterstützte Modi, z. B. die Lüfterrichtung/Ausrichtung. Beispielsweise kann eine Wandeinheit Einstellungen haben, um anzupassen, ob sie sich aufbläst.

Dieser Typ zeigt an, dass das Gerät das Lüftersymbol 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.

Qualitätsanforderungen

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

Beispielgerät: Einfacher Lüfter

Dieser Abschnitt enthält Beispiel-Nutzlasten, die auf einem gemeinsamen Gerätetyp und den oben genannten Merkmalen eine gemeinsame „Fan“ 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.FAN",
        "traits": [
          "action.devices.traits.FanSpeed",
          "action.devices.traits.OnOff"
        ],
        "name": {
          "name": "Simple fan"
        },
        "willReportState": true,
        "attributes": {
          "availableFanSpeeds": {
            "speeds": [
              {
                "speed_name": "low_key",
                "speed_values": [
                  {
                    "speed_synonym": [
                      "Low",
                      "Slow"
                    ],
                    "lang": "en"
                  },
                  {
                    "speed_synonym": [
                      "Niedrig",
                      "Schleppend"
                    ],
                    "lang": "de"
                  }
                ]
              },
              {
                "speed_name": "high_key",
                "speed_values": [
                  {
                    "speed_synonym": [
                      "High"
                    ],
                    "lang": "en"
                  },
                  {
                    "speed_synonym": [
                      "Hoch"
                    ],
                    "lang": "de"
                  }
                ]
              }
            ],
            "ordered": true
          },
          "reversible": true
        },
        "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,
        "currentFanSpeedSetting": "low_key"
      }
    }
  }
}

Beispiele für EXECUTE-Befehle

SetFanSpeed

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

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

An

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

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

Gerät ERRORS

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