Alarme de fumaça + monóxido de carbono

O Nest Protect foi projetado para detectar fumaça e monóxido de carbono (CO) em um ambiente residencial, com vários sensores para ajudar a entender o que está acontecendo na casa.

A API Nest fornece acesso aos seguintes dados do Nest Protect:

• Status do alarme de fumaça ou monóxido de carbono (CO)
• Estado de integridade da bateria
• Último status de teste manual e carimbo de data/hora
• Status on-line e informações da última conexão
• Nome da estrutura e do dispositivo "onde nome" (local na casa)

Permissões do Smoke+CO

Para ter acesso de leitura a todos os valores de dados da API Smoke+CO, selecione a permissão Leitura do Smoke+CO para o cliente.

Não há permissões de gravação disponíveis para a API de alarme Smoke+CO.

Identificadores de fumaça/monóxido de carbono

Dispositivo

Os dispositivos Nest são listados por tipo como uma matriz de IDs, que pode ser usada para identificar exclusivamente um dispositivo pelo caminho dele. 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... usando a API.

Quando um dispositivo está conectado a vários produtos, cada desenvolvedor vê um ID diferente para ele. Em um dispositivo que tenha instalado vários produtos do mesmo desenvolvedor, o desenvolvedor verá o mesmo ID.

Nome

Dois atributos de nome são fornecidos. O atributo name mais curto é exibido em rótulos da interface do usuário, enquanto name_long é usado em textos de formato longo.

name

Neste exemplo, name é "Nest Protect".

name_long

Neste exemplo, name_long é "Nestment Nest Protect".

Onde

where_id

• Um identificador exclusivo gerado pelo Nest que representa name.
• where_id é somente leitura e é criado automaticamente na chamada para criar um personalizado em que name.

Saiba mais sobre os nomes de Nest Thermostats, Nest Protects e Nest Cams.

where_name

Ao escolher a permissão de leitura do Smoke+CO, você pode acessar o dispositivo where_name usando o objeto de 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 dos dados	Descrição
locale	O código de idioma e país atribuído a este dispositivo
software_version	Uma string que representa o firmware atualmente instalado no dispositivo.
structure_id	Uma string que representa exclusivamente esta estrutura; é a estrutura com que o dispositivo está pareado
last_connection	O carimbo de data/hora da última conexão bem-sucedida com o serviço do Nest
is_online	Status on-line. Isso é determinado pelo Nest usando o tempo last_connection e uma janela de reconexão específica.

Recursos de fumaça e monóxido de carbono

Integridade da bateria

Use o campo battery_health para ver o estado de integridade da bateria.

Valor	Descrição
ok	Nível da bateria correto
replace	Nível de bateria baixo. Deve ser substituído

Alarme de monóxido de carbono

Use o campo co_alarm_state para ver o estado do alarme de CO.

Valor	Descrição
ok	Operação normal
warning	Detecção de níveis altos de CO
emergency	O nível de CO é muito alto, o usuário precisa sair da casa

Detector de fumaça

Use o campo smoke_alarm_state para ver o estado do alarme de fumaça.

Valor	Descrição
ok	Operação normal
warning	Detecção de níveis altos de fumaça
emergency	Os níveis de fumaça são muito altos, o usuário precisa sair da casa

Teste manual

Use esses campos para verificar se um teste manual de fumaça ou CO está ativo no momento e na última vez que um teste bem-sucedido foi concluído.

• is_manual_test_active: retorna true se uma fumaça ou teste estiver ativo.
• last_manual_test_time

Estado de cor da IU

Para facilitar a criação de uma IU 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 app Nest.

Mensagens de erro

Para mais informações sobre o que significam erros de chamada de API e como lidar com eles, consulte Mensagens de erro.