Nest Protect está diseñado para detectar humo y monóxido de carbono (CO) en un entorno residencial, con varios sensores que ayudan a comprender qué sucede en la casa.
La API de Nest proporciona acceso a los siguientes datos en el Nest Protect:
- Estado de la alarma de humo o monóxido de carbono (CO)
- Estado de la batería
- Última marca de tiempo y estado de la prueba manual
- Información de estado de la conexión y última conexión
- Nombre de la estructura y nombre del dispositivo (ubicación del hogar)
Permisos de humo + CO
Para obtener acceso de lectura a todos los valores de datos de la API de alarma de humo + CO, selecciona el permiso Lectura de humo + CO para tu cliente.
No hay permisos de escritura disponibles para la API de alarma de humo + monóxido de carbono.
Identificadores de humo y monóxido de carbono
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. Por lo tanto, un ID de alarma de humo + co de "RTMTKxs..." significa que puedes cargar el modelo del dispositivo de alarma de humo + co en devices/smoke_co_alarms/RTMTKxs... a través de la API.
Cuando un dispositivo esté conectado a varios productos, cada desarrollador verá un ID diferente del mismo. 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 texto largo.
name
En este ejemplo, name es (Nest Protect).
name_long
En este ejemplo, name_long es un Nest Protect en el sótano.
Explicación de los valores
where_id
- Un identificador único generado por Nest que representa
name. where_ides de solo lectura y se crea automáticamente en la llamada para crear un espacio personalizado dondename
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 humo + 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 código de idioma y país asignado a este dispositivo |
software_version
|
String que representa el firmware instalado actualmente en el dispositivo |
structure_id
|
Una string que representa de forma única esta estructura, que es la que está vinculada al dispositivo. |
last_connection
|
La marca de tiempo de la última conexión exitosa al servicio de Nest |
is_online
|
Estado de conexión. Esto lo determina Nest usando la hora last_connection y una ventana de reconexión esperada que es específica del dispositivo. |
Funciones de humo y monóxido de carbono
Estado de la batería
Usa el campo battery_health para consultar el estado de la batería.
| Valor | Descripción |
|---|---|
ok |
Nivel de batería aceptable |
replace |
El nivel de batería está 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 altos de CO |
emergency |
Los niveles de monóxido de carbono 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 aumento de niveles de humo |
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 CO está activa y la última vez que se realizó una prueba de humo o CO correcta.
is_manual_test_active: muestratruesi una prueba de humo o prueba está activalast_manual_test_time
Estado del 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 general del estado general del Nest Protect. Derivado de is_online, battery_health, co_alarm_state y smoke_alarm_state, que 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 información sobre el significado de los errores de llamada a la API y cómo manejarlos, consulta Mensajes de error.