Nest CamTM es un dispositivo conectado a Internet que es intuitivo y fácil de usar. Aprende continuamente sobre los patrones de uso en el hogar para ahorrar energía y optimizar la seguridad y la comodidad. Los usuarios pueden controlar la Nest Cam desde cualquier lugar en el que tengan acceso a una conexión a Internet.
La API de Nest proporciona acceso a los siguientes datos de la Nest Cam, según el nivel de permisos otorgados:
- Nombre de la estructura y el dispositivo "where name" (ubicación de la casa)
- Estado de conexión de la cámara o estado del micrófono
- Estado de la transmisión (activar o desactivar la transmisión de video por Internet)
- Nombre del dispositivo e identificador de ubicación
- Último cambio de estado en línea (último cambio en línea o sin conexión)
- Estado de la suscripción a Nest Aware (inscribida o no inscrita)
- Vínculos directos al feed de la cámara en vivo en la app de Nest (iOS, Android) o en la Web en home.nest.com
- Contenido relacionado con el último evento que activó una notificación, incluido lo siguiente:
- Se detectó un evento de sonido o movimiento
- Horarios de inicio y finalización del evento
- Vínculos directos a archivos de imagen y GIF
- Instantáneas de imágenes a pedido
- Estado de uso compartido y URL de uso compartido público
- Nombres de las zonas de actividad y, cuando haya un evento de movimiento, los ID en los que ocurrió el movimiento (requiere Nest Aware)
Tipos de cámara
La API de Nest admite varios tipos de cámara:
- Nest Cam Indoor: la cámara Nest para interiores original
- Nest Cam Outdoor: la cámara Nest para exteriores original
- Nest Cam IQ para interiores: cámara Nest para interiores con capacidad de procesamiento adicional, que habilita funciones sofisticadas de reconocimiento, instantánea y bocina.
- Nest Cam IQ para exteriores: cámara Nest para exteriores con potencia de procesamiento adicional, que habilita funciones sofisticadas de reconocimiento, instantáneas y altavoces
- Nest Hello: una cámara que funciona como timbre con video
Ten en cuenta que todas las cámaras Nest aparecen en la API de la misma manera. En el caso del Nest Hello, solo aparece la parte de la cámara del dispositivo en la API de Nest. La funcionalidad del timbre que se encuentra más allá de la cámara no está disponible en la API.
Permisos de cámara
Los siguientes niveles de permiso de acceso están disponibles para la Nest Cam:
Acceso |
Permisos Lectura de cámara |
Lectura/escritura de la cámara |
Lectura de la cámara + imágenes |
Imágenes/lectura y escritura de la cámara |
|---|---|---|---|---|
| Puede leer todos los valores, excepto: • activity_zones• is_public_share_enabled• public_share_url• snapshot_url • last_event/image_url • last_event/animated_image_url• last_event/activity_zone_ids |
Sí | Sí | ||
| Puede leer todos los valores | Sí | Sí | ||
Puede escribir is_streaming (con la cámara encendida o apagada) • Este cambio de estado requiere un acuerdo explícito del usuario |
Sí | Sí |
Para obtener más información, consulta la Descripción general de permisos.
Identificadores de cámara
Dispositivo
Los dispositivos Nest se enumeran por tipo como un arreglo de ID, que se puede usar para identificar de forma única un dispositivo a través de la ruta de acceso del dispositivo. Por lo tanto, un ID de cámara de "awJo6rH..." significa que puedes cargar el modelo del dispositivo de cámaras en devices/cameras/awJo6rH... a través de la API.
Cuando un dispositivo se conecta a varios productos, cada desarrollador verá un ID diferente para ese dispositivo. En el caso de un dispositivo que instaló varios productos del mismo desarrollador, este verá el mismo ID.
Nombre
El nombre predeterminado de una estructura es "Home", pero puede ser cualquier string que elija el usuario.
name
En estos ejemplos, name es "Planta baja" o "Planta baja (puerta principal)".
name_long
Es el nombre visible más largo de un dispositivo. En este ejemplo, name_long es “Office (Planta alta)”.
Ubicación
where_id
- Un identificador único generado por Nest que representa a
name where_ides de solo lectura y se crea de forma automática en la llamada para crear una instancia personalizada.name
Obtén más información sobre los nombres de los termostatos Nest, los Nest Protects y las Nest Cams.
where_name
Cuando eliges el permiso de lectura de la cámara, puedes acceder a where_name del dispositivo desde el objeto del dispositivo (devices/cameras).
Funciones de cámara
Transmisión en vivo
Usa estas URL para acceder a la página de transmisión en vivo desde la Web o en una app:
Cómo activar o desactivar la transmisión
Usa el campo is_streaming para activar o desactivar la cámara.
- Según la red doméstica del usuario y tu implementación, es posible que haya un retraso en el tiempo de respuesta.
- Debes pedirle permiso al usuario para cambiar el estado de transmisión (activar o desactivar la cámara).
Último evento
El objeto last_event se usa para obtener vínculos directos al último sonido detectado, movimiento o evento de persona y acceder a la imagen relacionada o al archivo GIF.
Los casos prácticos típicos para el campo last_event/has_person son activar las luces o establecer la lavandería en un ciclo silencioso.
Seguridad
Con el objeto last_event y el estado away de la estructura, el valor wwn_security_state de la estructura puede escalar de ok a deter, lo que puede activar otros dispositivos. Consulta la Guía de seguridad para conocer las funciones de disuasión.
Vínculos directos (URL web o de la aplicación)
Se usa para mostrar el último evento registrado y requiere que el usuario acceda a la cuenta.
Archivos de imagen o GIF
Para que tu producto acceda a las URL del último evento, el usuario debe tener una suscripción activa a Nest Aware y debes seleccionar uno de los permisos de Cámara “+ imágenes” para tu cliente.
Cuando realices una llamada a image_url o animated_image_url, obtendrás una URL en el siguiente formato:
"STRING1/device_id/STRING2?auth=camera_token"
Usa esta URL para ver una imagen o un GIF.
Ten en cuenta que los valores de STRING son solo para uso interno de Nest. No cambies los valores de STRING, ya que la llamada fallará.
Instantánea a pedido
Utilice este campo para obtener una instantánea de la transmisión de video en vivo.
snapshot_url: Muestra la URL de una imagen capturada de la transmisión de video en vivo.- Requiere que la cámara esté encendida y en transmisión activa
La calidad de la instantánea de la API es solo de 1080p con las siguientes opciones:
- ver la transmisión de la cámara de forma activa en la aplicación (
web_url) - ver la transmisión pública de forma activa (
app_url) - Te suscribiste a Nest Aware
Si no estás viendo la transmisión de forma activa o no tienes una suscripción a Nest Aware, la API no tiene una fuente de 1080 p desde la cual recuperar una instantánea con esa resolución y genera una imagen de menor calidad. Además, el ancho de banda de red local bajo puede provocar que la resolución de la instantánea de la API sea inferior a 1080 p con Nest Aware presente.
Obtén más información sobre los requisitos de ancho de banda para las cámaras Nest.
Límites de frecuencia de las instantáneas
Cuando realizas una llamada para obtener snapshot_url, se aplican los siguientes límites de frecuencia:
- 2 por minuto para las cámaras que no tienen una suscripción a Nest Aware
- 10 por minuto para las cámaras que tienen una suscripción a Nest Aware
Zonas de actividad
Para que tu producto acceda a la información de la Zona de actividad, el usuario debe tener una suscripción activa a Nest Aware (a menos que sea una Nest Cam IQ) y debes seleccionar uno de los permisos de "+ imágenes" de la cámara para tu cliente.
Cuando se produce un evento de movimiento, puedes leer los ID de las zonas de actividad en las que haya ocurrido.
activity_zones: lista de todos los nombres de zonas, incluidos los nombres definidos por el usuario y generados automáticamente- Respuesta de ejemplo:
"activity_zones": [ {"name": "Porch", "id": 244083}, {"name": "Walkway", "id": 237084} ... ] - En este ejemplo, el usuario cambió la “Zona 1” predeterminada a “Porche”, y la “Zona 2” a “Pasillo”.
- Respuesta de ejemplo:
last_event/activity_zone_ids: lista de ID de zonas que detectaron movimiento durante el último evento- Respuesta de ejemplo:
"activity_zone_ids" : [ "237084", "244083" ]
- Respuesta de ejemplo:
URL compartida públicamente
Usa estos dos campos juntos para verificar si el usuario hizo pública la transmisión de video y, de ser así, acceder a esa URL.
is_public_share_enabled: booleano, muestratruesi la transmisión de video por Internet es pública,falsesi es privadopublic_share_url: URL de la transmisión pública compartida
Vínculos externos de iOS
Si estás compilando una app para iOS 8 o versiones posteriores, deberás agregar vínculos de retroceso cuando uses la API de Camera.
Parámetros
| Nombre | Tipo | Obligatoria | Descripción |
|---|---|---|---|
CUSTOM_SCHEME |
string | sí | • Esquema de URL personalizada para tu app • Más información sobre los esquemas de URI |
APPNAME |
string | sí | • El nombre de la app. • Se muestra en el banner de devolución. • Se puede localizar. |
BACKLINK_PATH |
string | sí | • Ruta de regreso a tu app • Más información sobre los vínculos de retroceso |
Realizar la llamada
Cuando compiles un flujo en el que tu usuario vea la transmisión de video en vivo o un evento, incluye la ruta de retroceso:
- Recibe el
app_urlde la API de Nest. Debería verse algo similar a esto:"nestmobile://cameras/CjZHZ….7IYIm?auth=c.QbpCljxi5...Ny4gh&" - Agrega tus parámetros a
app_urlen este formato de string de consulta:
"nestmobile://cameras/CjZHZ….7IYIm?auth=c.QbpCljxi5...Ny4gh&appname=APPNAME&backlink=CUSTOM_SCHEME://BACKLINK_PATH"
Mensajes de error
Para obtener más información sobre qué significan los errores de llamada a la API y cómo manejarlos, consulta Mensajes de error.