A API Nest funciona com todos os modelos de alarmes de fumaça e monóxido de carbono Nest ProtectTM.
Os usuários podem adicionar vários Nest Protects ao grupo devices/smoke_co_alarms
, até
o máximo por
estrutura.
Ao fazer uma chamada para esse local de dados, você pode acessar os dados do Nest Protect
(valores de dados dos dispositivos na estrutura).
Todos os valores abaixo são encontrados em cada
devices/smoke_co_alarms/device_id
no documento JSON.
ID do dispositivo
Identificador exclusivo do Nest Protect.
Detalhes | |
---|---|
https://developer-api.nest.com/devices/smoke_co_alarms/device_id/device_id |
|
Retorna | string Exemplo: "RTMTKxsQTCxzVcsySOHPxKoF4OyCifrs" |
Acesso | somente leitura |
Disponível em | Leitura de Smoke+CO / v1-v5 |
localidade
Especifica a preferência de idioma e região (ou país).
Detalhes | |
---|---|
https://developer-api.nest.com/devices/smoke_co_alarms/device_id/locale |
|
Retorna | string Exemplos: "en-GB", "en-US", "es-US", "fr-CA", "fr-CA", "nl-NL" |
Acesso | somente leitura |
Disponível em | Leitura de Smoke+CO / v1-v5 |
versão do software
Versão do software.
Detalhes | |
---|---|
https://developer-api.nest.com/devices/smoke_co_alarms/device_id/software_version |
|
Retorna | string Exemplo: "1.0.1" |
Acesso | somente leitura |
Disponível em | Leitura de Smoke+CO / v1-v5 |
ID da estrutura
Identificador exclusivo da estrutura.
Detalhes | |
---|---|
https://developer-api.nest.com/devices/smoke_co_alarms/device_id/structure_id |
|
Retorna | string Exemplo: "VqFabWH21nw..." |
Acesso | somente leitura |
Disponível em | Leitura de Smoke+CO / v1-v5 |
nome
Nome de exibição do dispositivo. Pode ser qualquer nome de ambiente de uma lista fornecida ou um nome personalizado.
Detalhes | |
---|---|
https://developer-api.nest.com/devices/smoke_co_alarms/device_id/name |
|
Retorna | string Exemplo: "Hallway" |
Acesso | somente leitura |
Disponível em | Leitura de Smoke+CO / v1-v5 |
nome_longo
Nome de exibição longo do dispositivo. Inclui um personalizado (rótulo), criado pelo usuário
ou pelo wheres
.
Detalhes | |
---|---|
https://developer-api.nest.com/devices/smoke_co_alarms/device_id/name_long |
|
Retorna | string Exemplo: "Hallway Protect (em andares)" |
Acesso | somente leitura |
Disponível em | Leitura de Smoke+CO / v1-v5 |
last_connection
Carimbo de data/hora da última interação com o serviço Nest no formato ISO 8601.
Detalhes | |
---|---|
https://developer-api.nest.com/devices/smoke_co_alarms/device_id/last_connection |
|
Retorna | string Exemplo: "2016-12-31T23:59:59.000Z" |
Acesso | somente leitura |
Disponível em | Leitura de Smoke+CO / v1-v5 |
on-line
Status da conexão do dispositivo com o serviço Nest.
Detalhes | |
---|---|
https://developer-api.nest.com/devices/smoke_co_alarms/device_id/is_online |
|
Retorna | boolean Valores: verdadeiro, falso |
Acesso | somente leitura |
Disponível em | Leitura de Smoke+CO / v1-v5 |
integridade_da_bateria
Vida útil/bateria da bateria; estimativa do nível restante de energia da bateria.
Detalhes | |
---|---|
https://developer-api.nest.com/devices/smoke_co_alarms/device_id/battery_health |
|
Retorna | string enum Valores: "ok", "replace" |
Acesso | somente leitura |
Disponível em | Leitura de Smoke+CO / v1-v5 |
co_alarme_estado
Status do alarme de monóxido de carbono (CO).
Detalhes | |
---|---|
https://developer-api.nest.com/devices/smoke_co_alarms/device_id/co_alarm_state |
|
Retorna | string enum Valores: "ok", "warning", "emergência" |
Acesso | somente leitura |
Disponível em | Leitura de Smoke+CO / v1-v5 |
fumaça_alarme_estado
Status do alarme do detector de fumaça
Detalhes | |
---|---|
https://developer-api.nest.com/devices/smoke_co_alarms/device_id/smoke_alarm_state |
|
Retorna | string enum Valores: "ok", "warning", "emergência" |
Acesso | somente leitura |
Disponível em | Leitura de Smoke+CO / v1-v5 |
is_manual_test_active
Estado do teste manual do alarme de fumaça e monóxido de carbono.
Detalhes | |
---|---|
https://developer-api.nest.com/devices/smoke_co_alarms/device_id/is_manual_test_active |
|
Retorna | boolean Valores: verdadeiro, falso |
Acesso | somente leitura |
Disponível em | Leitura de Smoke+CO / v2-v5 |
último_teste_manual_
Carimbo de data/hora do último teste de alarme manual de fumaça e monóxido de carbono, no formato ISO 8601.
Detalhes | |
---|---|
https://developer-api.nest.com/devices/smoke_co_alarms/device_id/last_manual_test_time |
|
Retorna | string Exemplo: "2016-12-31T23:59:59.000Z" |
Acesso | somente leitura |
Disponível em | Leitura de Smoke+CO / v2-v5 |
estado_da_ui_cor
Indica o status do dispositivo pela cor na IU do app Nest. É uma condição agregada para estados de bateria + fumaça + CO e reflete os indicadores de cor reais exibidos no app Nest.
Para ver mais informações sobre os indicadores de cor, consulte Luzes do Nest Protect e Nível da bateria do Nest Protect.
Detalhes | |
---|---|
https://developer-api.nest.com/devices/smoke_co_alarms/device_id/ui_color_state |
|
Retorna | string enum Valores: "gray", "green", "yellow", "red" |
Acesso | somente leitura |
Disponível em | Leitura de Smoke+CO / v1-v5 |
ID do local
Um identificador exclusivo gerado pelo Nest que representa
name
, o nome de exibição do dispositivo.
Saiba mais sobre os nomes dos Nest Thermostats, Nest Protects e Nest Cams.
Detalhes | |
---|---|
https://developer-api.nest.com/devices/smoke_co_alarms/device_id/where_id |
|
Retorna | string Exemplo: "d6reb_OZTM..." |
Acesso | somente leitura |
Disponível em | Leitura de Smoke+CO / v3-v5 |
Nome_do_onde
O nome de exibição do dispositivo. Associados ao Nest Protect
where_id
. Pode ser qualquer nome de sala de uma lista que fornecemos ou um nome personalizado. Saiba mais sobre os nomes dos Nest Thermostats, Nest Protects e Nest Cams.
Detalhes | |
---|---|
https://developer-api.nest.com/devices/smoke_co_alarms/device_id/where_name |
|
Retorna | string Exemplo: "Hallway" |
Acesso | somente leitura |
Disponível em | Leitura de fumaça/monóxido de carbono/v5 |