Cámara

La Nest CamTM es un dispositivo conectado a Internet que es intuitivo y fácil de usar. Aprende de manera continua 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 en la Nest Cam, según el nivel de permisos otorgados:

• Nombre de la estructura y nombre del dispositivo (ubicación del hogar)
• Estado de la cámara o del micrófono
• Estado de la transmisión (activar o desactivar la transmisión de video por Internet)
• Nombre del dispositivo y dónde se encuentra el identificador
• Último cambio de estado en línea (último cambio en línea/sin conexión)
• Estado de la suscripción a Nest Aware (inscrito o no inscrito)
• Vínculos directos al feed de la cámara en vivo en la app de Nest (iOS y 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 movimiento o sonido
  • Hora de inicio y finalización de eventos
  • 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 zonas de actividad y, cuando se produce un evento de movimiento, los ID en los que ocurrió el movimiento (requiere Nest Aware)

Tipos de cámaras

La API de Nest admite varios tipos de cámara:

• Nest Cam Indoor: la cámara Nest original para interiores
• Nest Cam Outdoor: la cámara Nest original para exteriores
• Nest Cam IQ para interiores: cámara Nest para interiores con potencia de procesamiento adicional, que permite usar funciones sofisticadas de instantánea, bocina y reconocimiento
• Nest Cam IQ para exteriores: cámara Nest para exteriores con potencia de procesamiento adicional, que incluye funciones sofisticadas de instantánea, bocina y reconocimiento
• Nest Hello: una cámara que funciona como un 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 la parte de la cámara del dispositivo aparece en la API de Nest. La funcionalidad del timbre más allá de la cámara no está disponible en la API.

Permisos de cámara

Los siguientes niveles de permisos de acceso están disponibles para la Nest Cam:

Acceso	Permisos Lectura de cámara	Lectura y escritura de la cámara	Lectura de la cámara y imágenes	Cámara, lectura y escritura de imágenes
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 (cámara encendida/apagada) • Este cambio de estado requiere un acuerdo explícito de usuario		Sí		Sí

Para obtener más información, consulta la Descripción general de permisos.

Identificadores de la 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 del dispositivo. Entonces, 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 esté conectado a varios productos, cada desarrollador verá un ID diferente para él. 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

El nombre visible más largo de un dispositivo. En este ejemplo, name_long es (Office) (planta alta).

Explicación de los valores

where_id

• Un identificador único generado por Nest que representa name.
• where_id es de solo lectura y se crea automáticamente en la llamada para crear un espacio personalizado donde name

Obtén más información sobre los nombres de los Nest Thermostat, los Nest Protect y las Nest Cams.

where_name

Cuando eliges el permiso de lectura de la cámara, puedes acceder al dispositivo where_name desde el objeto del dispositivo (devices/cameras).

Funciones de cámara

Transmisión en vivo

Puedes usar estas URL para acceder a la página de transmisión en vivo desde la Web o en una app:

• web_url
• app_url

Cómo activar o desactivar la transmisión

Usa el campo is_streaming para encender o apagar 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 (prende o apaga la cámara).

Último evento

El objeto last_event se usa para obtener vínculos directos al último evento detectado de sonido, movimiento o persona, y acceder a los archivos de imagen o GIF relacionados.

Los casos de uso típicos para el campo last_event/has_person son activar luces o establecer la lavandería en un ciclo de silencio.

Seguridad

Con el objeto last_event y el estado away de la estructura, el valor wwn_security_state de la estructura se puede escalar de ok a deter, lo que puede activar otros dispositivos. Consulta la Guía de seguridad para descubrir 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 haya accedido a la cuenta.

• last_event/web_url
• last_event/app_url

Archivos de imagen o GIF

Para que tu producto acceda a las URL del evento más reciente, el usuario debe tener una suscripción activa a Nest Aware y debes seleccionar uno de los permisos de Cámara + imágenes.

• last_event/image_url
• last_event/animated_image_url

Cuando realices una llamada a image_url o animated_image_url, obtendrás una URL en este 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 on demand

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 transmitiendo contenido activamente.

La calidad de la instantánea de la API es solo de 1080p si:

• ver activamente la transmisión de la cámara en la aplicación (web_url)
• viendo activamente la transmisión pública (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 1080p a partir de la cual recuperar una instantánea en esa resolución y generar una imagen de menor calidad. Además, un ancho de banda de red local bajo puede hacer 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 cámaras Nest.

Límites de frecuencia de las instantáneas

Cuando realizas una llamada para obtener la snapshot_url, aplicamos estos límites de frecuencia:

• 2 minutos 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 se trate de una Nest Cam IQ), y debes seleccionar uno de los permisos de Cámara y más para tu cliente.

Cuando hay un evento de movimiento, puedes leer los ID de la zona de actividad en que se produjo el movimiento.

• activity_zones: Lista de todos los nombres de zonas, incluidos los nombres definidos por el usuario y los generados automáticamente
  • Respuesta de ejemplo: "activity_zones": [ {"name": "Porch", "id": 244083}, {"name": "Walkway", "id": 237084} ... ]
  • En este ejemplo, el usuario cambió la zona predeterminada 1 a la entrada y la zona 2 a la pasarela.
• 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" ]

URL para compartir pública

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, muestra true si la transmisión de video por Internet es pública, false si es privado
• public_share_url: URL de la transmisión pública compartida

Vínculos externos de iOS

Si compilas una app para iOS 8 o una versión posterior, deberás agregar vínculos externos cuando uses la API de Cámara.

Parámetros

Nombre	Tipo	Obligatorio	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í	• Nombre de tu app • Se muestra en el banner de devolución • Se puede localizar
BACKLINK_PATH	string	sí	• Ruta de acceso a la app • Más información sobre los vínculos externos

Realizar la llamada

Cuando compiles un flujo en el que tu usuario vea una transmisión de video en vivo o un evento, incluye la ruta de acceso externo:

1. Recibe la app_url de la API de Nest. Debería ser similar a lo siguiente: "nestmobile://cameras/CjZHZ….7IYIm?auth=c.QbpCljxi5...Ny4gh&"
2. Agrega tus parámetros a app_url en 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 información sobre el significado de los errores de llamada a la API y cómo manejarlos, consulta Mensajes de error.