
O Nest Protect foi projetado para detectar fumaça e monóxido de carbono (CO) em um ambiente residencial, com vários sensores para ajudá-lo a entender o que está acontecendo em casa.
A API Nest fornece acesso aos seguintes dados no Nest Protect:
- Status de alarme de fumaça ou monóxido de carbono (CO)
- Estado de saúde da bateria
- Último status de teste manual e carimbo de data / hora
- Status online e última informação de conexão
- Nome da estrutura e dispositivo "onde nome" (localização na casa)
Permissões de fumaça + CO
Para acesso de leitura a todos os valores de dados da API de alarme Smoke + CO, selecione a permissão de leitura Smoke + CO para o seu cliente.
Não há permissões de gravação disponíveis para a API de alarme Smoke + CO.
Identificadores de fumaça + CO
Dispositivo
Os dispositivos Nest são listados por tipo como uma série de IDs, que podem ser usados para identificar exclusivamente um dispositivo por meio do caminho do dispositivo. Portanto, um ID de alarme de fumaça + co de "RTMTKxs..."
significa que você pode carregar o modelo de dispositivo de alarme de fumaça + co em devices/smoke_co_alarms/RTMTKxs...
via API.
Quando um dispositivo é conectado a vários produtos, cada desenvolvedor verá um ID diferente para aquele dispositivo. Para um dispositivo que instalou vários produtos do mesmo desenvolvedor, o desenvolvedor verá o mesmo ID.
Nome
Dois atributos de nome são fornecidos. O atributo de name
mais curto é exibido nos rótulos da interface do usuário, enquanto name_long
é usado em texto de formato longo.
name
Neste exemplo, o name
é "Nest Protect".

name_long
Neste exemplo, name_long
é "Basement Nest Protect".

Onde
where_id
- Um identificador exclusivo gerado pelo Nest que representa o
name
-
where_id
é somente leitura e é criado automaticamente na chamada para criar umname
where personalizado
Saiba mais sobre os nomes dos termostatosNest ,Nest Protects e Nest Cams .
where_name
Ao escolher a permissão de leitura Smoke + CO , você pode acessar o dispositivo where_name
partir do objeto dispositivo ( devices/smoke_co_alarms
).
Outros metadados
Todos os valores de dados são somente leitura, a menos que seja especificado de outra forma.
Valor de Dados | Descrição |
---|---|
locale | O idioma e o código do país atribuídos a este dispositivo |
software_version | Uma string que representa o firmware atualmente instalado no dispositivo |
structure_id | Uma string que representa exclusivamente esta estrutura; esta é a estrutura com a qual o dispositivo está emparelhado |
last_connection | O carimbo de data / hora da última conexão bem-sucedida com o serviço Nest |
is_online | Status online. Isso é determinado pelo Nest usando o tempo de last_connection e uma janela de reconexão esperada que é específica do dispositivo. |
Recursos do Smoke + CO
Saúde da bateria
Use o campo battery_health
para visualizar o estado de integridade da bateria.
Valor | Descrição |
---|---|
ok | Nível de bateria ok |
replace | Nível de bateria baixo, deve ser substituído |
Alarme CO
Use o campo co_alarm_state
para visualizar o estado do alarme CO.
Valor | Descrição |
---|---|
ok | Operação normal |
warning | Detecção de níveis crescentes de CO |
emergency | Níveis de CO muito altos, o usuário deve sair de casa |
Alarme de fumo
Use o campo smoke_alarm_state
para visualizar o estado do alarme de fumaça.
Valor | Descrição |
---|---|
ok | Operação normal |
warning | Detecção de níveis crescentes de fumaça |
emergency | Níveis de fumaça muito altos, o usuário deve sair de casa |
Teste manual
Use esses campos para verificar se um teste manual de fumaça ou CO está ativo no momento e a última vez que um teste de fumaça ou CO foi realizado com sucesso.
-
is_manual_test_active
true
se uma fumaça ou teste estiver ativo -
last_manual_test_time
Estado da cor da IU
Para facilitar o projeto de uma interface de usuário coerente entre produtos, fornecemos o campo ui_color_state
, que fornece uma indicação de alto nível do estado geral do Nest Protect. É derivado de is_online
, battery_health
, co_alarm_state
e smoke_alarm_state
, fornecendo uma condição agregada que reflete os indicadores de cor reais exibidos no aplicativo Nest .
Mensagens de erro
Para obter informações sobre o que significam os erros de chamada de API e como lidar com eles, consulte Mensagens de erro .