Guida per i fan della smart home

action.devices.types.FAN: le ventole possono essere generalmente accese e spente e avere impostazioni sulla velocità. Alcuni ventilatori potrebbero anche avere modalità aggiuntive supportate, come la direzione/orientamento del ventilatore (ad esempio, un'unità a muro potrebbe avere impostazioni per regolare se soffia verso l'alto o verso il basso).

Questo tipo indica che il dispositivo riceve l'icona della ventola e alcuni sinonimi e alias correlati.

Funzionalità dispositivo

Fai riferimento alla documentazione delle caratteristiche corrispondente per i dettagli dell'implementazione, come attributi e stati che il servizio deve supportare e come creare risposte EXECUTE e QUERY.

Caratteristiche obbligatorie

Questi tratti e comandi sono obbligatori, se applicabili al tuo dispositivo. Se il tuo dispositivo non supporta queste caratteristiche, inserisci il codice di errore functionNotSupported in una risposta QUERY o EXECUTE. Per ulteriori informazioni, consulta Errori ed eccezioni.

Requisiti di qualità

  • Latenza: il valore deve essere inferiore o uguale a 700 ms.
  • Affidabilità: deve essere superiore o uguale al 97%.

Dispositivo di esempio: ventola semplice

Questa sezione contiene alcuni payload di esempio che rappresentano un "Fan" comune in base al tipo di dispositivo e alle caratteristiche di cui sopra. Se aggiungi o rimuovi delle caratteristiche nell'implementazione, modifica le risposte di conseguenza per riflettere tali modifiche.

Esempio di risposta SYNC

Richiedi
{
  "requestId": "6894439706274654512",
  "inputs": [
    {
      "intent": "action.devices.SYNC"
    }
  ]
}
Risposta
{
  "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"
        }
      }
    ]
  }
}

Esempio di risposta QUERY

Richiedi
{
  "requestId": "6894439706274654514",
  "inputs": [
    {
      "intent": "action.devices.QUERY",
      "payload": {
        "devices": [
          {
            "id": "123"
          }
        ]
      }
    }
  ]
}
Risposta
{
  "requestId": "6894439706274654514",
  "payload": {
    "devices": {
      "123": {
        "status": "SUCCESS",
        "online": true,
        "on": true,
        "currentFanSpeedSetting": "low_key"
      }
    }
  }
}

Comandi ESEGUI di esempio

Imposta la velocità dei fan

Per ulteriori dettagli sui parametri di comando, consulta il riferimento action.devices.traits.FanSpeed.

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

On-Off

Per ulteriori dettagli sui parametri di comando, consulta il riferimento action.devices.traits.OnOff.

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

ERRORI del dispositivo

Consulta l'elenco completo degli errori e delle eccezioni.