Guida al passaggio alla smart home

action.devices.types.SWITCH - Switch, un dispositivo di base nella smart home, può essere acceso e spento.

Questo tipo indica che sul dispositivo viene mostrata l'icona di Switch e alcuni sinonimi e alias correlati.

Funzionalità del dispositivo

Fai riferimento alla documentazione relativa ai tratti corrispondenti per i dettagli sull'implementazione, ad esempio gli attributi e gli stati che il tuo servizio dovrebbe supportare, e come creare risposte EXECUTE e QUERY.

Trait obbligatori

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

Queste caratteristiche sono consigliate, se applicabili al tuo dispositivo. Tuttavia, puoi combinare e abbinare tutti i tratti disponibili per abbinare al meglio le funzionalità del prodotto esistente.

Requisiti di qualità

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

Esempio di dispositivo: passaggio semplice

Questa sezione contiene payload di intent di esempio che rappresentano uno "Switch" comune in base al tipo di dispositivo e ai trait indicati sopra. Se aggiungi o rimuovi trait nell'implementazione, modifica le risposte di conseguenza per riflettere queste 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.SWITCH",
        "traits": [
          "action.devices.traits.OnOff"
        ],
        "name": {
          "name": "Simple switch"
        },
        "willReportState": 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
      }
    }
  }
}

Comandi EXECUTE di esempio

OnOff

Per ulteriori dettagli sui parametri di comando, consulta la documentazione di riferimento su action.devices.traits.OnOff.

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

ERRORI del dispositivo

Consulta l'elenco completo di errori ed eccezioni.