
Nest Protect está diseñado para detectar humo y monóxido de carbono (CO) en un entorno residencial, con varios sensores para ayudarlo a comprender lo que sucede en el hogar.
La API de Nest proporciona acceso a los siguientes datos en Nest Protect:
- Estado de alarma de humo o monóxido de carbono (CO)
- Estado de salud de la batería
- Último estado de prueba manual y marca de tiempo
- Estado en línea y última información de conexión
- Nombre de estructura y dispositivo "donde nombre" (ubicación en la casa)
Permisos de humo + CO
Para acceso de lectura a todos los valores de datos de la API de alarma de humo + CO, seleccione el permiso de lectura de humo + CO para su cliente.
No hay permisos de escritura disponibles para la API de alarma de humo + CO.
Identificadores de humo + CO
Dispositivo
Los dispositivos Nest se enumeran por tipo como una serie de ID, que se pueden utilizar para identificar de forma única un dispositivo a través de la ruta del dispositivo. Entonces, un ID de alarma de humo + co de "RTMTKxs..."
significa que puede cargar el modelo de dispositivo de alarma de humo + co en devices/smoke_co_alarms/RTMTKxs...
través de la API.
Cuando un dispositivo está conectado a varios productos, cada desarrollador verá un ID diferente para ese dispositivo. Para un dispositivo que ha instalado varios productos del mismo desarrollador, el desarrollador verá el mismo ID.
Nombre
Se proporcionan dos atributos de nombre. El atributo de name
más corto se muestra en las etiquetas de la interfaz de usuario, mientras que name_long
se usa en el texto de formato largo.
name
En este ejemplo, el name
es "Nest Protect".

name_long
En este ejemplo, name_long
es "Basement Nest Protect".

Dónde
where_id
- Un identificador único generado por Nest que representa el
name
-
where_id
es de solo lectura y se crea automáticamente en la llamada para crear unname
where personalizado
Obtén más información sobre los nombres de los termostatosNest ,Nest Protects y Nest Cams .
where_name
Cuando elige el permiso de lectura de Smoke + CO , puede 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 | Una cadena que representa el firmware actualmente instalado en el dispositivo. |
structure_id | Una cadena que representa de forma única esta estructura; esta es la estructura con la que está emparejado el dispositivo |
last_connection | La marca de tiempo de la última conexión exitosa al servicio Nest |
is_online | Estado en línea. Esto lo determina Nest utilizando el tiempo de last_connection y una ventana de reconexión esperada que es específica del dispositivo. |
Funciones de humo + CO
Salud de la batería
Utilice el campo battery_health
para ver el estado de la batería.
Valor | Descripción |
---|---|
ok | Nivel de batería correcto |
replace | Nivel de batería bajo, debe reemplazarse |
Alarma de CO
Utilice el campo co_alarm_state
para ver el estado de la alarma de CO.
Valor | Descripción |
---|---|
ok | Operación normal |
warning | Detección de niveles crecientes de CO |
emergency | Niveles de CO demasiado altos, el usuario debe salir de la casa |
Alarma de humo
Utilice el campo smoke_alarm_state
para ver el estado de la alarma de humo.
Valor | Descripción |
---|---|
ok | Operación normal |
warning | Detección de niveles crecientes de humo |
emergency | Niveles de humo demasiado altos, el usuario debe salir de la casa. |
Prueba manual
Utilice estos campos para verificar si una prueba manual de humo o CO está actualmente activa y la última vez que se realizó una prueba de humo o CO con éxito.
-
is_manual_test_active
devuelvetrue
si hay un humo o una prueba activa -
last_manual_test_time
Estado de color de la interfaz de usuario
Para facilitar el diseño de una interfaz de usuario coherente entre productos, hemos proporcionado el campo ui_color_state
, que proporciona una indicación de alto nivel del estado general de Nest Protect. Se deriva de is_online
, battery_health
, co_alarm_state
y smoke_alarm_state
, lo que proporciona una condición agregada que refleja los indicadores de color reales que se muestran en la aplicación Nest .
Error de mensajes
Para obtener información sobre qué significan los errores de llamada a la API y cómo manejarlos, consulte Mensajes de error .