Notice: We're retiring Works with Nest. See the home page for more information.
O Google tem o compromisso de promover a igualdade racial para as comunidades negras. Saiba como.
Esta página foi traduzida pela API Cloud Translation.
Switch to English

API Smoke + CO Alarm

O Nest API funciona com todos os modelos de alarme de fumaça + monóxido de carbono Nest Protect ™.

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 para dispositivos na estrutura).

Todos os valores abaixo são encontrados em cada devices/smoke_co_alarms/ device_id no documento JSON.

Identificador do dispositivo

Identificador exclusivo do Nest Protect.

Detalhes
https://developer-api.nest.com/devices/smoke_co_alarms/ device_id /device_id
Devoluções string
Exemplo: "RTMTKxsQTCxzVcsySOHPxKoF4OyCifrs"
Acesso somente leitura
Disponível em Leitura de fumaça + 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
Devoluções string
Exemplos: "en-GB", "en-US", "es-US", "fr-CA", "fr-CA", "nl-NL"
Acesso somente leitura
Disponível em Leitura de fumaça + 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
Devoluções string
Exemplo: "1.0.1"
Acesso somente leitura
Disponível em Leitura de fumaça + CO / v1-v5

structure_id

Identificador exclusivo da estrutura.

Detalhes
https://developer-api.nest.com/devices/smoke_co_alarms/ device_id /structure_id
Devoluções string
Exemplo: "VqFabWH21nw ..."
Acesso somente leitura
Disponível em Leitura de fumaça + CO / v1-v5

nome

Exibir nome do dispositivo; pode ser qualquer nome de sala de uma lista que fornecemos ou um nome personalizado.

Detalhes
https://developer-api.nest.com/devices/smoke_co_alarms/ device_id /name
Devoluções string
Exemplo: "Corredor"
Acesso somente leitura
Disponível em Leitura de fumaça + CO / v1-v5

name_long

Nome de exibição longo do dispositivo. Inclui um personalizado (rótulo), criado pelo usuário ou por meio de wheres .

Detalhes
https://developer-api.nest.com/devices/smoke_co_alarms/ device_id /name_long
Devoluções string
Exemplo: "Proteção do corredor (andar de cima)"
Acesso somente leitura
Disponível em Leitura de fumaça + CO / v1-v5

last_connection

Timestamp da última interação bem-sucedida com o serviço Nest, no formato ISO 8601 .

Detalhes
https://developer-api.nest.com/devices/smoke_co_alarms/ device_id /last_connection
Devoluções string
Exemplo: "2016-12-31T23: 59: 59.000Z"
Acesso somente leitura
Disponível em Leitura de fumaça + CO / v1-v5

está online

Status de conexão do dispositivo com o serviço Nest.

Detalhes
https://developer-api.nest.com/devices/smoke_co_alarms/ device_id /is_online
Devoluções boolean
Valores: verdadeiro, falso
Acesso somente leitura
Disponível em Leitura de fumaça + CO / v1-v5

bateria_health

Vida / saúde da bateria; estimativa do nível de energia restante da bateria.

Detalhes
https://developer-api.nest.com/devices/smoke_co_alarms/ device_id /battery_health
Devoluções string enum
Valores: "ok", "substituir"
Acesso somente leitura
Disponível em Leitura de fumaça + CO / v1-v5

co_alarm_state

Status de alarme de monóxido de carbono (CO).

Detalhes
https://developer-api.nest.com/devices/smoke_co_alarms/ device_id /co_alarm_state
Devoluções string enum
Valores: "ok", "aviso", "emergência"
Acesso somente leitura
Disponível em Leitura de fumaça + CO / v1-v5

smoke_alarm_state

Status do alarme de fumaça.

Detalhes
https://developer-api.nest.com/devices/smoke_co_alarms/ device_id /smoke_alarm_state
Devoluções string enum
Valores: "ok", "aviso", "emergência"
Acesso somente leitura
Disponível em Leitura de fumaça + CO / v1-v5

is_manual_test_active

Estado do teste manual de alarme de fumaça e CO.

Detalhes
https://developer-api.nest.com/devices/smoke_co_alarms/ device_id /is_manual_test_active
Devoluções boolean
Valores: verdadeiro, falso
Acesso somente leitura
Disponível em Leitura de fumaça + CO / v2-v5

last_manual_test_time

Registro de data e hora do último teste manual de alarme de fumaça e CO bem-sucedido, no formato ISO 8601 .

Detalhes
https://developer-api.nest.com/devices/smoke_co_alarms/ device_id /last_manual_test_time
Devoluções string
Exemplo: "2016-12-31T23: 59: 59.000Z"
Acesso somente leitura
Disponível em Leitura de fumaça + CO / v2-v5

ui_color_state

Indica o status do dispositivo por cor na IU do app Nest. É uma condição agregada para os estados bateria + fumaça + CO e reflete os indicadores de cor reais exibidos no aplicativo Nest.

Para mais informações sobre os indicadores de cores, 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
Devoluções string enum
Valores: "cinza", "verde", "amarelo", "vermelho"
Acesso somente leitura
Disponível em Leitura de fumaça + CO / v1-v5

where_id

Um identificador exclusivo gerado pelo Nest que representa o name , o nome de exibição do dispositivo.

Saiba mais sobre os nomes dos termostatosNest ,Nest Protects e Nest Cams .

Detalhes
https://developer-api.nest.com/devices/smoke_co_alarms/ device_id /where_id
Devoluções string
Exemplo: "d6reb_OZTM ..."
Acesso somente leitura
Disponível em Leitura de fumaça + CO / v3-v5

where_name

O nome de exibição do dispositivo. Associado 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 termostatosNest ,Nest Protects e Nest Cams .

Detalhes
https://developer-api.nest.com/devices/smoke_co_alarms/ device_id /where_name
Devoluções string
Exemplo: "Corredor"
Acesso somente leitura
Disponível em Leitura de fumaça + CO / v5