Notice: We're retiring Works with Nest. See the home page for more information.
En Google, luchamos por la equidad racial de la comunidad negra. Más información
Se usó la API de Cloud Translation para traducir esta página.
Switch to English

API de alarma de humo + CO

La API de Nest funciona con todos los modelos de alarmas de humo + monóxido de carbono Nest Protect ™.

Los usuarios pueden agregar varios Nest Protects al grupo devices/smoke_co_alarms , hasta el máximo por estructura . Cuando realiza una llamada a esta ubicación de datos, puede acceder a los datos de Nest Protect (valores de datos para dispositivos en la estructura).

Todos los valores siguientes se encuentran en cada devices/smoke_co_alarms/ device_id en el documento JSON.

Identificación del dispositivo

Identificador único de Nest Protect.

Detalles
https://developer-api.nest.com/devices/smoke_co_alarms/ device_id /device_id
Devoluciones string
Ejemplo: "RTMTKxsQTCxzVcsySOHPxKoF4OyCifrs"
Acceso solo lectura
Disponible en Lectura de humo + CO / v1-v5

lugar

Especifica la preferencia de idioma y región (o país).

Detalles
https://developer-api.nest.com/devices/smoke_co_alarms/ device_id /locale
Devoluciones string
Ejemplos: "en-GB", "en-US", "es-US", "fr-CA", "fr-CA", "nl-NL"
Acceso solo lectura
Disponible en Lectura de humo + CO / v1-v5

Versión del software

Versión del software.

Detalles
https://developer-api.nest.com/devices/smoke_co_alarms/ device_id /software_version
Devoluciones string
Ejemplo: "1.0.1"
Acceso solo lectura
Disponible en Lectura de humo + CO / v1-v5

structure_id

Identificador único de estructura.

Detalles
https://developer-api.nest.com/devices/smoke_co_alarms/ device_id /structure_id
Devoluciones string
Ejemplo: "VqFabWH21nw ..."
Acceso solo lectura
Disponible en Lectura de humo + CO / v1-v5

nombre

Nombre para mostrar del dispositivo; puede ser cualquier nombre de habitación de una lista que proporcionamos o un nombre personalizado.

Detalles
https://developer-api.nest.com/devices/smoke_co_alarms/ device_id /name
Devoluciones string
Ejemplo: "Pasillo"
Acceso solo lectura
Disponible en Lectura de humo + CO / v1-v5

name_long

Nombre de visualización largo del dispositivo. Incluye una (etiqueta) personalizada, creada por el usuario o a través de wheres .

Detalles
https://developer-api.nest.com/devices/smoke_co_alarms/ device_id /name_long
Devoluciones string
Ejemplo: "Hallway Protect (arriba)"
Acceso solo lectura
Disponible en Lectura de humo + CO / v1-v5

last_connection

Marca de tiempo de la última interacción exitosa con el servicio Nest, en formato ISO 8601 .

Detalles
https://developer-api.nest.com/devices/smoke_co_alarms/ device_id /last_connection
Devoluciones string
Ejemplo: "2016-12-31T23: 59: 59.000Z"
Acceso solo lectura
Disponible en Lectura de humo + CO / v1-v5

está en linea

Estado de conexión del dispositivo con el servicio Nest.

Detalles
https://developer-api.nest.com/devices/smoke_co_alarms/ device_id /is_online
Devoluciones boolean
Valores: verdadero, falso
Acceso solo lectura
Disponible en Lectura de humo + CO / v1-v5

battery_health

Vida / salud de la batería; estimación del nivel de carga restante de la batería.

Detalles
https://developer-api.nest.com/devices/smoke_co_alarms/ device_id /battery_health
Devoluciones string enum
Valores: "ok", "reemplazar"
Acceso solo lectura
Disponible en Lectura de humo + CO / v1-v5

co_alarm_state

Estado de alarma de monóxido de carbono (CO).

Detalles
https://developer-api.nest.com/devices/smoke_co_alarms/ device_id /co_alarm_state
Devoluciones string enum
Valores: "ok", "advertencia", "emergencia"
Acceso solo lectura
Disponible en Lectura de humo + CO / v1-v5

Smoke_alarm_state

Estado de la alarma de humo.

Detalles
https://developer-api.nest.com/devices/smoke_co_alarms/ device_id /smoke_alarm_state
Devoluciones string enum
Valores: "ok", "advertencia", "emergencia"
Acceso solo lectura
Disponible en Lectura de humo + CO / v1-v5

is_manual_test_active

Estado de la prueba manual de alarma de humo y CO.

Detalles
https://developer-api.nest.com/devices/smoke_co_alarms/ device_id /is_manual_test_active
Devoluciones boolean
Valores: verdadero, falso
Acceso solo lectura
Disponible en Lectura de humo + CO / v2-v5

last_manual_test_time

Marca de tiempo de la última prueba manual exitosa de alarma de humo y CO, en formato ISO 8601 .

Detalles
https://developer-api.nest.com/devices/smoke_co_alarms/ device_id /last_manual_test_time
Devoluciones string
Ejemplo: "2016-12-31T23: 59: 59.000Z"
Acceso solo lectura
Disponible en Lectura de humo + CO / v2-v5

ui_color_state

Indica el estado del dispositivo por color en la interfaz de usuario de la aplicación Nest. Es una condición agregada para los estados de batería + humo + CO, y refleja los indicadores de color reales que se muestran en la aplicación Nest.

Para obtener más información sobre los indicadores de color, consulte Luces de Nest Protect y nivel de batería de Nest Protect .

Detalles
https://developer-api.nest.com/devices/smoke_co_alarms/ device_id /ui_color_state
Devoluciones string enum
Valores: "gris", "verde", "amarillo", "rojo"
Acceso solo lectura
Disponible en Lectura de humo + CO / v1-v5

where_id

Un identificador único generado por Nest que representa el name , el nombre para mostrar del dispositivo.

Obtén más información sobre los nombres de los termostatosNest ,Nest Protects y Nest Cams .

Detalles
https://developer-api.nest.com/devices/smoke_co_alarms/ device_id /where_id
Devoluciones string
Ejemplo: "d6reb_OZTM ..."
Acceso solo lectura
Disponible en Lectura de humo + CO / v3-v5

where_name

El nombre para mostrar del dispositivo. Asociado con Nest Protect where_id . Puede ser cualquier nombre de habitación de una lista que proporcionamos o un nombre personalizado. Obtén más información sobre los nombres de los termostatosNest ,Nest Protects y Nest Cams .

Detalles
https://developer-api.nest.com/devices/smoke_co_alarms/ device_id /where_name
Devoluciones string
Ejemplo: "Pasillo"
Acceso solo lectura
Disponible en Lectura de humo + CO / v5