Panduan Keran Smart Home

action.devices.types.FAUCET - Keran dapat mengeluarkan cairan dalam berbagai kuantitas dan preset. Keran dapat memiliki berbagai mode dan masing-masing mode memiliki setelan terkaitnya sendiri. Perintah ini khusus untuk keran dan ditafsirkan dalam bentuk umum.

Jenis ini menunjukkan bahwa perangkat mendapatkan ikon Faucet serta beberapa sinonim dan alias yang terkait.

Kemampuan perangkat

Lihat dokumentasi karakteristik yang sesuai untuk detail penerapan, seperti atribut dan status yang harus didukung oleh layanan Anda, serta cara membuat respons EXECUTE dan QUERY.

Ciri-ciri ini direkomendasikan, jika berlaku untuk perangkat Anda. Namun, Anda bebas untuk memadupadankan semua sifat yang tersedia agar cocok dengan fungsi produk yang ada.

Persyaratan kualitas

  • Latensi: harus kurang dari atau sama dengan 800 md.
  • Keandalan: harus lebih dari atau sama dengan 97%.

Contoh perangkat: Keran sederhana

Bagian ini berisi contoh payload intent yang merepresentasikan "Faucet" umum berdasarkan jenis dan karakteristik perangkat di atas. Jika Anda menambahkan atau menghapus fitur dalam penerapan, ubah respons Anda untuk mencerminkan perubahan tersebut.

Contoh respons SYNC

Permintaan
{
  "requestId": "6894439706274654512",
  "inputs": [
    {
      "intent": "action.devices.SYNC"
    }
  ]
}
Respons
{
  "requestId": "6894439706274654512",
  "payload": {
    "agentUserId": "user123",
    "devices": [
      {
        "id": "123",
        "type": "action.devices.types.FAUCET",
        "traits": [
          "action.devices.traits.Dispense",
          "action.devices.traits.TemperatureControl",
          "action.devices.traits.OnOff"
        ],
        "name": {
          "name": "Simple faucet"
        },
        "willReportState": true,
        "attributes": {
          "supportedDispenseItems": [
            {
              "item_name": "water_key",
              "item_name_synonyms": [
                {
                  "lang": "en",
                  "synonyms": [
                    "Water"
                  ]
                },
                {
                  "lang": "es",
                  "synonyms": [
                    "Agua"
                  ]
                },
                {
                  "lang": "fr",
                  "synonyms": [
                    "Eau"
                  ]
                }
              ],
              "supported_units": [
                "TEASPOONS",
                "TABLESPOONS",
                "FLUID_OUNCES",
                "CUPS",
                "PINTS",
                "QUARTS",
                "GALLONS",
                "MILLILITERS",
                "LITERS",
                "DECILITERS"
              ],
              "default_portion": {
                "amount": 2,
                "unit": "CUPS"
              }
            }
          ],
          "supportedDispensePresets": [
            {
              "preset_name": "cat_water_bowl_key",
              "preset_name_synonyms": [
                {
                  "lang": "en",
                  "synonyms": [
                    "Cat water bowl",
                    "Cat water dish",
                    "Cat water cup"
                  ]
                },
                {
                  "lang": "es",
                  "synonyms": [
                    "Plato de agua para gato",
                    "Bebedero para gato"
                  ]
                },
                {
                  "lang": "fr",
                  "synonyms": [
                    "Bol d'eau de chat",
                    "Bac \u00e0 eau pour chat",
                    "Tasse d'eau de chat"
                  ]
                }
              ]
            }
          ],
          "temperatureRange": {
            "minThresholdCelsius": 25,
            "maxThresholdCelsius": 100
          },
          "temperatureUnitForUX": "F"
        },
        "deviceInfo": {
          "manufacturer": "smart-home-inc",
          "model": "hs1234",
          "hwVersion": "3.2",
          "swVersion": "11.4"
        }
      }
    ]
  }
}

Contoh respons QUERY

Permintaan
{
  "requestId": "6894439706274654514",
  "inputs": [
    {
      "intent": "action.devices.QUERY",
      "payload": {
        "devices": [
          {
            "id": "123"
          }
        ]
      }
    }
  ]
}
Respons
{
  "requestId": "6894439706274654514",
  "payload": {
    "devices": {
      "123": {
        "status": "SUCCESS",
        "online": true,
        "on": false,
        "temperatureSetpointCelsius": 30,
        "dispenseItems": [
          {
            "itemName": "water_key",
            "amountLastDispensed": {
              "amount": 2.5,
              "unit": "CUPS"
            },
            "isCurrentlyDispensing": false
          }
        ]
      }
    }
  }
}

Contoh perintah EXECUTE

Keluarkan

Untuk detail tambahan tentang parameter perintah, lihat referensi action.devices.traits.Dispense.

Permintaan
{
  "requestId": "6894439706274654516",
  "inputs": [
    {
      "intent": "action.devices.EXECUTE",
      "payload": {
        "commands": [
          {
            "devices": [
              {
                "id": "123"
              }
            ],
            "execution": [
              {
                "command": "action.devices.commands.Dispense",
                "params": {
                  "amount": 1,
                  "unit": "CUPS",
                  "item": "water_key"
                }
              }
            ]
          }
        ]
      }
    }
  ]
}
Respons
{
  "requestId": "6894439706274654516",
  "payload": {
    "commands": [
      {
        "ids": [
          "123"
        ],
        "status": "SUCCESS",
        "states": {
          "online": true,
          "dispenseItems": [
            {
              "itemName": "water_key",
              "amountLastDispensed": {
                "amount": 1,
                "unit": "CUPS"
              },
              "isCurrentlyDispensing": true
            }
          ]
        }
      }
    ]
  }
}

SetelSuhu

Untuk detail tambahan tentang parameter perintah, lihat referensi action.devices.traits.TemperatureControl.

Permintaan
{
  "requestId": "6894439706274654518",
  "inputs": [
    {
      "intent": "action.devices.EXECUTE",
      "payload": {
        "commands": [
          {
            "devices": [
              {
                "id": "123"
              }
            ],
            "execution": [
              {
                "command": "action.devices.commands.SetTemperature",
                "params": {
                  "temperature": 65
                }
              }
            ]
          }
        ]
      }
    }
  ]
}
Respons
{
  "requestId": "6894439706274654518",
  "payload": {
    "commands": [
      {
        "ids": [
          "123"
        ],
        "status": "SUCCESS",
        "states": {
          "online": true,
          "temperatureSetpointCelsius": 65
        }
      }
    ]
  }
}

Aktif

Untuk detail tambahan tentang parameter perintah, lihat referensi action.devices.traits.OnOff.

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

ERRORS perangkat

Lihat daftar lengkap error dan pengecualian.