Guía del timbre para casa inteligente

action.devices.types.DOORBELL: Los timbres pueden avisar a las personas que hay alguien en la puerta. Este dispositivo puede enviar notificaciones y transmitir video si tiene la función correspondiente.

Este tipo indica que el dispositivo obtiene el ícono del timbre y algunas funciones sinónimos y alias.

Funciones del dispositivo

Consulta la documentación de la característica correspondiente para detalles de implementación, como los atributos y los estados que tu servicio debe admitir, y cómo compilar respuestas EXECUTE y QUERY.

Se recomiendan estas características, si corresponde a tu dispositivo. Sin embargo, puedes mezclar y combinar todas las características disponibles para que se adapten mejor a tu la funcionalidad del producto.

Requisitos de calidad

  • Latencia: Debe ser menor o igual que 2,000 ms.
  • Confiabilidad: Debe ser mayor o igual que 97%.

Ejemplo de dispositivo: timbre simple

Esta sección contiene cargas útiles de intents de ejemplo que representan un "timbre" común según el tipo de dispositivo y las características antes mencionadas. Si agregas o quitas características en tu implementación, modificar tus respuestas en consecuencia para reflejar esos cambios.

Ejemplo de respuesta de SYNC

Solicitar
{
  "requestId": "6894439706274654512",
  "inputs": [
    {
      "intent": "action.devices.SYNC"
    }
  ]
}
.
.
Respuesta
{
  "requestId": "6894439706274654512",
  "payload": {
    "agentUserId": "user123",
    "devices": [
      {
        "id": "123",
        "type": "action.devices.types.DOORBELL",
        "traits": [
          "action.devices.traits.CameraStream",
          "action.devices.traits.ObjectDetection"
        ],
        "name": {
          "name": "Simple doorbell"
        },
        "willReportState": true,
        "notificationSupportedByAgent": true,
        "attributes": {
          "cameraStreamSupportedProtocols": [
            "hls"
          ],
          "cameraStreamNeedAuthToken": true
        },
        "deviceInfo": {
          "manufacturer": "smart-home-inc",
          "model": "hs1234",
          "hwVersion": "3.2",
          "swVersion": "11.4"
        }
      }
    ]
  }
}

Ejemplo de respuesta de QUERY

Solicitar
{
  "requestId": "6894439706274654514",
  "inputs": [
    {
      "intent": "action.devices.QUERY",
      "payload": {
        "devices": [
          {
            "id": "123"
          }
        ]
      }
    }
  ]
}
.
.
Respuesta
{
  "requestId": "6894439706274654514",
  "payload": {
    "devices": {
      "123": {
        "status": "SUCCESS",
        "online": true
      }
    }
  }
}

Ejemplos de comandos EXECUTE

GetCameraStream

Para obtener detalles adicionales sobre los parámetros del comando, consulta la action.devices.traits.CameraStream referencia.

Solicitar
{
  "requestId": "6894439706274654516",
  "inputs": [
    {
      "intent": "action.devices.EXECUTE",
      "payload": {
        "commands": [
          {
            "devices": [
              {
                "id": "123"
              }
            ],
            "execution": [
              {
                "command": "action.devices.commands.GetCameraStream",
                "params": {
                  "StreamToChromecast": true,
                  "SupportedStreamProtocols": [
                    "hls"
                  ]
                }
              }
            ]
          }
        ]
      }
    }
  ]
}
.
.
Respuesta
{
  "requestId": "6894439706274654516",
  "payload": {
    "commands": [
      {
        "ids": [
          "123"
        ],
        "status": "SUCCESS",
        "states": {
          "online": true,
          "cameraStreamAccessUrl": "https://example.com/stream.mp4",
          "cameraStreamProtocol": "hls"
        }
      }
    ]
  }
}

Ejemplo de informe de NOTIFICACIONES

ObjectDetection

Para obtener más detalles sobre las propiedades de las notificaciones, consulta la action.devices.traits.ObjectDetection referencia.

Solicitar
{
  "requestId": "6894439706274654518",
  "payload": {
    "devices": {
      "notifications": {
        "123": {
          "ObjectDetection": {
            "objects": {
              "named": [
                "Alice"
              ]
            },
            "priority": 0,
            "detectionTimestamp": 946684800000
          }
        }
      }
    }
  }
}
.
.
Respuesta
{
  "requestId": "6894439706274654518"
}

ERRORES DE DISPOSITIVO

Consulta la lista completa de errores y excepciones.