Nest Protect é 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 sobre Nest Protect:
- Fumo ou monóxido de carbono (CO) de estado de alarme
- estado de saúde da bateria
- Última status de teste manual e timestamp
- status online e informações de conexão passado
- nome estrutura e dispositivo "onde o nome" (localização na casa)
Fuma permissões + CO
Para acesso de leitura a todos os valores de dados de alarme API + CO fumo, selecione o Smoke + CO ler permissão para o seu cliente.
Não há permissões de gravação disponíveis para o Smoke + CO alarme API.
Fumaça identificadores + CO
Dispositivo
Nest dispositivos são listadas por tipo como uma matriz de identificações, que pode ser usada para identificar exclusivamente um dispositivo através do caminho do dispositivo. Então a + co ID alarme de fumo de "RTMTKxs..." significa que você pode carregar o + co modelo de dispositivo de alarme de fumaça em devices/smoke_co_alarms/RTMTKxs... por meio da API.
Quando um dispositivo é conectado a vários produtos, cada desenvolvedor verá um ID diferente para esse dispositivo. Para um dispositivo que instalou vários produtos do mesmo desenvolvedor, o desenvolvedor vai ver o mesmo ID.
Nome
Dois atributos de nome são fornecidos. Quanto mais curto name atributo é exibido em etiquetas de interface do usuário, enquanto name_long é utilizado em longo texto formulário.
name
Neste exemplo, name é "Nest Protect".
name_long
Neste exemplo, name_long é "Basement Nest Protect".
Onde
where_id
- Um identificador exclusivo, gerado-Nest que representa
name -
where_idé só de leitura, e é criado automaticamente na chamada para criar um personalizado, ondename
Saiba mais sobre onde nomes para termostatos Ninho , Ninho Protege e ninho de webcams .
where_name
Quando você escolhe o Smoke + CO permissão de leitura , você pode acessar o dispositivo where_name do objeto de dispositivo ( devices/smoke_co_alarms ).
outros metadados
Todos os valores de dados são somente leitura, salvo indicação em contrário.
| dados do Valor | Descrição |
|---|---|
locale | O código de idioma e país atribuído a esse dispositivo |
software_version | A cadeia que representa o firmware atualmente instalado no dispositivo |
structure_id | Uma cadeia que representa unicamente esta estrutura; esta é a estrutura que o dispositivo está emparelhado com |
last_connection | O timestamp da última conexão bem-sucedida ao serviço Nest |
is_online | Status online. Isto é determinado pelo ninho usando o last_connection tempo e de uma janela de religação esperado que é específico do dispositivo. |
Fumaça Características + CO
saúde da bateria
Use o battery_health campo para ver o estado de saúde da bateria.
| Valor | Descrição |
|---|---|
ok | Bateria ok nível |
replace | nível de bateria baixa, deve ser substituído |
alarme de CO
Use o co_alarm_state campo para ver o estado de alarme CO.
| Valor | Descrição |
|---|---|
ok | Operação normal |
warning | Detecção do aumento dos níveis de CO |
emergency | níveis de CO muito alto, o usuário deve sair da casa |
Alarme de fumo
Use o smoke_alarm_state campo para ver o estado de alarme de fumaça.
| Valor | Descrição |
|---|---|
ok | Operação normal |
warning | Detecção do aumento dos níveis de fumaça |
emergency | níveis de fumaça muito alta, o usuário deve sair da casa |
teste manual
Use estes campos para verificar se a fumaça manual ou teste de CO está ativa no momento, ea última vez que uma fumaça bem sucedido ou teste de CO foi realizada.
-
is_manual_test_active-retornatruese um fumo ou teste está ativo -
last_manual_test_time
Estado cor UI
Para torná-lo mais fácil de projetar uma interface entre produtos coerente, nós fornecemos o ui_color_state campo, o que dá 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 , proporcionando uma condição de agregado que reflete os indicadores de cor reais exibidos no app Nest .
Mensagens de erro
Para obter informações sobre o que os erros de chamadas API significa e como lidar com eles, ver mensagens de erro .