Nest Protect está diseñado para detectar humo y monóxido de carbono (CO) en un entorno residencial, con múltiples sensores que ayudan a comprender lo que sucede en la casa.
La API de Nest proporciona acceso a los siguientes datos de Nest Protect:
- Estado de la alarma de humo o monóxido de carbono (CO)
- Estado de la batería
- Marca de tiempo y estado de la última prueba manual
- Información sobre el estado en línea y la última conexión
- Nombre de la estructura y el dispositivo "where name" (ubicación de la casa)
Permisos de humo y monóxido de carbono
Para el acceso de lectura a todos los valores de datos de la API de alarma de humo/monóxido de carbono, selecciona el permiso de lectura de humo/monóxido de carbono para tu cliente.
No hay permisos de escritura disponibles para la API de alarma de humo/monóxido de carbono.
Identificadores de humo y CO
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 alarma de humo + co de "RTMTKxs..." significa que puedes cargar el modelo de dispositivo de alarma de humo + co en devices/smoke_co_alarms/RTMTKxs... 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
Se proporcionaron dos atributos de nombre. El atributo name más corto se muestra en las etiquetas de la interfaz de usuario, mientras que name_long se usa en el texto largo.
name
En este ejemplo, name es "Nest Protect".
name_long
En este ejemplo, name_long es “Nest Protect del sótano”.
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 humo y CO, puedes acceder al dispositivo where_name desde el objeto del dispositivo (devices/smoke_co_alarms).
Otros metadatos
Todos los valores de datos son de solo lectura, a menos que se especifique lo contrario.
| Valor de los datos | Descripción |
|---|---|
locale |
El idioma y el código de país asignados a este dispositivo |
software_version
|
Una string que representa el firmware que está instalado en el dispositivo |
structure_id
|
Una string que representa de forma única esta estructura; es la estructura con la que se sincroniza el dispositivo. |
last_connection
|
La marca de tiempo de la última conexión exitosa con el servicio de Nest |
is_online
|
Estado en línea. Esto lo determina Nest mediante la hora last_connection y una ventana de reconexión esperada específica para el dispositivo. |
Funciones de humo y monóxido de carbono
Estado de la batería
Usa el campo battery_health para ver el estado de la batería.
| Valor | Descripción |
|---|---|
ok |
Nivel de batería aceptable |
replace |
Nivel de batería bajo; debes reemplazarlo |
alarma de monóxido de carbono
Usa el campo co_alarm_state para ver el estado de la alarma de CO.
| Valor | Descripción |
|---|---|
ok |
Funcionamiento normal |
warning |
Detección de niveles ascendentes de CO |
emergency |
Los niveles de CO son demasiado altos; el usuario debería salir de la casa |
Alarma de humo
Usa el campo smoke_alarm_state para ver el estado de la alarma de humo.
| Valor | Descripción |
|---|---|
ok |
Funcionamiento normal |
warning |
Detección de niveles de humo en aumento |
emergency |
Los niveles de humo son demasiado altos; el usuario debe salir de la casa |
Prueba manual
Usa estos campos para verificar si una prueba manual de humo o monóxido de carbono está activa y la última vez que se realizó una prueba de humo o monóxido de carbono exitosa.
is_manual_test_active: muestratruesi hay un humo o una prueba activos.last_manual_test_time
Estado de color de la IU
Para facilitar el diseño de una IU coherente entre productos, proporcionamos el campo ui_color_state, que proporciona una indicación de alto nivel sobre el estado general del Nest Protect. Deriva de is_online, battery_health, co_alarm_state y smoke_alarm_state, y proporciona una condición agregada que refleja los indicadores de color reales que se muestran en la app de Nest.
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.