A API Nest funciona com todos os modelos Nest Learning Thermostat ™, exceto para o Thermostat E com Heat Link na UE.
Os usuários podem adicionar vários termostatos ninho para o devices/thermostats
grupo, até o máximo por estrutura . Ao fazer uma chamada para esse local de dados, você pode acessar os dados do Nest Thermostat (valores de dados para dispositivos na estrutura).
Toda a valores abaixo são encontradas em cada devices/thermostats/ device_id
no documento JSON.
Identificador do dispositivo
Identificador exclusivo do Nest Thermostat.
Detalhes | |
---|---|
https://developer-api.nest.com/devices/thermostats/ device_id /device_id | |
Devoluções | string Exemplo: "peyiJNo0IldT2YlIVtYaGQ" |
Acesso | somente leitura |
Disponível em | Termostato lido / v1-v6 Leitura / gravação do termostato / v1-v6 |
localidade
Especifica a preferência de idioma e região (ou país).
Detalhes | |
---|---|
https://developer-api.nest.com/devices/thermostats/ 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 | Termostato lido / v1-v6 Leitura / gravação do termostato / v1-v6 |
versão do software
Versão do software.
Detalhes | |
---|---|
https://developer-api.nest.com/devices/thermostats/ device_id /software_version | |
Devoluções | string Exemplo: "4.0" |
Acesso | somente leitura |
Disponível em | Termostato lido / v1-v6 Leitura / gravação do termostato / v1-v6 |
structure_id
Identificador exclusivo da estrutura.
Detalhes | |
---|---|
https://developer-api.nest.com/devices/thermostats/ device_id /structure_id | |
Devoluções | string Exemplo: "VqFabWH21nw ..." |
Acesso | somente leitura |
Disponível em | Termostato lido / v1-v6 Leitura / gravação do termostato / v1-v6 |
nome
Nome de exibição do dispositivo. Pode ser qualquer nome de sala de uma lista que fornecemos ou um nome personalizado.
Detalhes | |
---|---|
https://developer-api.nest.com/devices/thermostats/ device_id /name | |
Devoluções | string Exemplo: "Corredor" |
Acesso | somente leitura |
Disponível em | Termostato lido / v1-v6 Leitura / gravação do termostato / v1-v6 |
name_long
Nome de exibição longo do dispositivo. Inclui um personalizado (etiqueta), criado pelo usuário, ou através wheres
.
Detalhes | |
---|---|
https://developer-api.nest.com/devices/thermostats/ device_id /name_long | |
Devoluções | string Exemplo: "Termostato de corredor (andar de cima)" |
Acesso | somente leitura |
Disponível em | Termostato lido / v1-v6 Leitura / gravação do termostato / v1-v6 |
last_connection
Timestamp da última interação bem-sucedida com o serviço Nest, na ISO 8601 formato.
Detalhes | |
---|---|
https://developer-api.nest.com/devices/thermostats/ device_id /last_connection | |
Devoluções | string Exemplo: "2016-12-31T23: 59: 59.000Z" |
Acesso | somente leitura |
Disponível em | Termostato lido / v1-v6 Leitura / gravação do termostato / v1-v6 |
está online
Status de conexão do dispositivo com o serviço Nest.
Detalhes | |
---|---|
https://developer-api.nest.com/devices/thermostats/ device_id /is_online | |
Devoluções | boolean Valores: verdadeiro, falso |
Acesso | somente leitura |
Disponível em | Termostato lido / v1-v6 Leitura / gravação do termostato / v1-v6 |
can_cool
Capacidade do sistema para resfriar (tem CA).
Detalhes | |
---|---|
https://developer-api.nest.com/devices/thermostats/ device_id /can_cool | |
Devoluções | boolean Valores: verdadeiro, falso |
Acesso | somente leitura |
Disponível em | Termostato lido / v1-v6 Leitura / gravação do termostato / v1-v6 |
can_heat
Capacidade do sistema para aquecer.
Detalhes | |
---|---|
https://developer-api.nest.com/devices/thermostats/ device_id /can_heat | |
Devoluções | boolean Valores: verdadeiro, falso |
Acesso | somente leitura |
Disponível em | Termostato lido / v1-v6 Leitura / gravação do termostato / v1-v6 |
is_using_emergency_heat
Status de aquecimento de emergência em sistemas com bombas de calor para resfriamento.
Quando o aquecimento de emergência está ligado:
- O usuário pode ajustar a temperatura alvo no dispositivo, mas não pode alterar o modo até que o aquecimento de emergência seja desligado
- O
hvac_mode
ainda pode ser alterado por meio da API
Veja O que há de calor de emergência? para mais informações sobre como o Nest Thermostat oferece suporte para aquecimento de emergência.
Detalhes | |
---|---|
https://developer-api.nest.com/devices/thermostats/ device_id /is_using_emergency_heat | |
Devoluções | boolean Valores: verdadeiro, falso |
Acesso | somente leitura |
Disponível em | Termostato lido / v1-v6 Leitura / gravação do termostato / v1-v6 |
has_fan
Capacidade do sistema de controlar o ventilador independentemente do aquecimento ou resfriamento.
Detalhes | |
---|---|
https://developer-api.nest.com/devices/thermostats/ device_id /has_fan | |
Devoluções | boolean Valores: verdadeiro, falso |
Acesso | somente leitura |
Disponível em | Termostato lido / v1-v6 Leitura / gravação do termostato / v1-v6 |
fan_timer_active
Indica se o temporizador do ventilador está acionado; utilizado com fan_timer_duration
para ligar o ventilador para uma duração predefinida (definido pelo utilizador).
Veja Controle Fan avançada para mais informações sobre como os clientes definir a duração do ventilador.
Detalhes | |
---|---|
https://developer-api.nest.com/devices/thermostats/ device_id /fan_timer_active | |
Devoluções | boolean Valores: verdadeiro, falso |
Acesso | ler escrever |
Disponível em | Termostato lido / v1-v6 Leitura / gravação do termostato / v1-v6 |
fan_timer_timeout
Timestamp mostrando quando o temporizador do ventilador atinge 0 (tempo de paragem), em ISO 8601 formato.
Detalhes | |
---|---|
https://developer-api.nest.com/devices/thermostats/ device_id /fan_timer_timeout | |
Devoluções | string Exemplo: "2016-12-31T23: 59: 59.000Z" |
Acesso | somente leitura |
Disponível em | Termostato lido / v1-v6 Leitura / gravação do termostato / v1-v6 |
has_leaf
Exibido quando o termostato está definido para uma temperatura de economia de energia.
Detalhes | |
---|---|
https://developer-api.nest.com/devices/thermostats/ device_id /has_leaf | |
Devoluções | boolean Valores: verdadeiro, falso |
Acesso | somente leitura |
Disponível em | Termostato lido / v1-v6 Leitura / gravação do termostato / v1-v6 |
temperatura_escala
Fahrenheit ou Celsius; usado com display de temperatura.
Detalhes | |
---|---|
https://developer-api.nest.com/devices/thermostats/ device_id /temperature_scale | |
Devoluções | string enum Valores: "F", "C" |
Acesso | ler escrever |
Disponível em | Leitura: Termostato lido / v1-v6 Leitura / gravação do termostato / v1-v6 Escrever: Leitura / gravação do termostato / v5-v6 |
target_temperature_f
Temperatura desejada, em graus Fahrenheit (1 ° F) completos. Usado quando hvac_mode
= heat
ou cool
.
Detalhes | |
---|---|
https://developer-api.nest.com/devices/thermostats/ device_id /target_temperature_f | |
Devoluções | number Exemplo: 72 |
Faixa | 50-90 |
Acesso | ler escrever |
Disponível em | Termostato lido / v1-v6 Leitura / gravação do termostato / v1-v6 |
target_temperature_c
Temperatura desejada, em meio grau Celsius (0,5 ° C). Usado quando hvac_mode
= heat
ou cool
.
Detalhes | |
---|---|
https://developer-api.nest.com/devices/thermostats/ device_id /target_temperature_c | |
Devoluções | number Exemplo: 21,5 |
Faixa | 9-32 |
Acesso | ler escrever |
Disponível em | Termostato lido / v1-v6 Leitura / gravação do termostato / v1-v6 |
target_temperature_high_f
Temperatura máxima desejada, exibida em graus Fahrenheit (1 ° F). Quando usado hvac_mode
= heat-cool
(modo Frio Calor •).
Detalhes | |
---|---|
https://developer-api.nest.com/devices/thermostats/ device_id /target_temperature_high_f | |
Devoluções | number Exemplo: 80 |
Acesso | ler escrever |
Disponível em | Termostato lido / v1-v6 Leitura / gravação do termostato / v1-v6 |
target_temperature_high_c
Temperatura máxima desejada, exibida em meio grau Celsius (0,5 ° C). Quando usado hvac_mode
= heat-cool
(modo Frio Calor •).
Detalhes | |
---|---|
https://developer-api.nest.com/devices/thermostats/ device_id /target_temperature_high_c | |
Devoluções | number Exemplo: 24,5 |
Acesso | ler escrever |
Disponível em | Termostato lido / v1-v6 Leitura / gravação do termostato / v1-v6 |
target_temperature_low_f
Temperatura mínima desejada, exibida em graus Fahrenheit (1 ° F). Quando usado hvac_mode
= heat-cool
(modo Frio Calor •).
Detalhes | |
---|---|
https://developer-api.nest.com/devices/thermostats/ device_id /target_temperature_low_f | |
Devoluções | number Exemplo: 65 |
Acesso | ler escrever |
Disponível em | Termostato lido / v1-v6 Leitura / gravação do termostato / v1-v6 |
target_temperature_low_c
Temperatura mínima desejada, exibida em meio grau Celsius (0,5 ° C). Quando usado hvac_mode
= heat-cool
(modo Frio Calor •).
Detalhes | |
---|---|
https://developer-api.nest.com/devices/thermostats/ device_id /target_temperature_low_c | |
Devoluções | number Exemplo: 19,5 |
Acesso | ler escrever |
Disponível em | Termostato lido / v1-v6 Leitura / gravação do termostato / v1-v6 |
eco_temperature_high_f
Temperatura máxima de eco, exibida em graus Fahrenheit (1 ° F) inteiros. Usado quando hvac_mode
= eco
.
Detalhes | |
---|---|
https://developer-api.nest.com/devices/thermostats/ device_id /eco_temperature_high_f | |
Devoluções | number Exemplo: 80 |
Acesso | somente leitura |
Disponível em | Termostato lido / v6 Leitura / gravação do termostato / v6 |
eco_temperature_high_c
Eco Temperatura máxima, exibida em meio grau Celsius (0,5 ° C). Usado quando hvac_mode
= eco
.
Detalhes | |
---|---|
https://developer-api.nest.com/devices/thermostats/ device_id /eco_temperature_high_c | |
Devoluções | number Exemplo: 24,5 |
Acesso | somente leitura |
Disponível em | Termostato lido / v6 Leitura / gravação do termostato / v6 |
eco_temperature_low_f
Eco Temperatura Mínima, exibida em graus Fahrenheit (1 ° F) inteiros. Usado quando hvac_mode
= eco
.
Detalhes | |
---|---|
https://developer-api.nest.com/devices/thermostats/ device_id /eco_temperature_low_f | |
Devoluções | number Exemplo: 65 |
Acesso | somente leitura |
Disponível em | Termostato lido / v6 Leitura / gravação do termostato / v6 |
eco_temperature_low_c
Eco Temperatura Mínima, exibida em meio grau Celsius (0,5 ° C). Usado quando hvac_mode
= eco
.
Detalhes | |
---|---|
https://developer-api.nest.com/devices/thermostats/ device_id /eco_temperature_low_c | |
Devoluções | number Exemplo: 19,5 |
Acesso | somente leitura |
Disponível em | Termostato lido / v6 Leitura / gravação do termostato / v6 |
away_temperature_high_f (REMOVIDO)
Temperatura máxima de distância, exibida em graus Fahrenheit (1 ° F).
Detalhes | |
---|---|
https://developer-api.nest.com/devices/thermostats/ device_id /away_temperature_high_f | |
Devoluções | number Exemplo: 80 |
Acesso | somente leitura |
Disponível em | Termostato lido / v1-v6 Leitura / gravação do termostato / v1-v6 |
away_temperature_high_c (REMOVIDO)
Temperatura máxima de distância, exibida em meio grau Celsius (0,5 ° C).
Detalhes | |
---|---|
https://developer-api.nest.com/devices/thermostats/ device_id /away_temperature_high_c | |
Devoluções | number Exemplo: 24,5 |
Acesso | somente leitura |
Disponível em | Termostato lido / v1-v6 Leitura / gravação do termostato / v1-v6 |
away_temperature_low_f (REMOVIDO)
Temperatura mínima de distância, exibida em graus Fahrenheit (1 ° F).
Detalhes | |
---|---|
https://developer-api.nest.com/devices/thermostats/ device_id /away_temperature_low_f | |
Devoluções | number Exemplo: 65 |
Acesso | somente leitura |
Disponível em | Termostato lido / v1-v6 Leitura / gravação do termostato / v1-v6 |
away_temperature_low_c (REMOVIDO)
Temperatura mínima de distância, exibida em meio grau Celsius (0,5 ° C).
Detalhes | |
---|---|
https://developer-api.nest.com/devices/thermostats/ device_id /away_temperature_low_c | |
Devoluções | number Exemplo: 19,5 |
Acesso | somente leitura |
Disponível em | Termostato lido / v1-v6 Leitura / gravação do termostato / v1-v6 |
hvac_mode
Indica modos de aquecimento / resfriamento do sistema HVAC, como Calor • Resfriamento para sistemas com capacidade de aquecimento e resfriamento ou Eco temperaturas para economia de energia.
-
hvac_mode
pode ser alterado se o termostato está bloqueado -
target_temperature_f
etarget_temperature_c
não pode ser alterada sehvac_mode
=off
oueco
Detalhes | |
---|---|
https://developer-api.nest.com/devices/thermostats/ device_id /hvac_mode | |
Devoluções | string enum Valores: "heat", "cool", "heat-cool", "eco", "off" |
Acesso | ler escrever |
Disponível em | Termostato lido / v1-v6 Leitura / gravação do termostato / v1-v6 |
ambient_temperature_f
Temperatura, medida no dispositivo, em graus Fahrenheit (1 ° F) inteiros.
Detalhes | |
---|---|
https://developer-api.nest.com/devices/thermostats/ device_id /ambient_temperature_f | |
Devoluções | number Exemplo: 72 |
Acesso | somente leitura |
Disponível em | Termostato lido / v1-v6 Leitura / gravação do termostato / v1-v6 |
ambient_temperature_c
Temperatura, medida no aparelho, em meio grau Celsius (0,5 ° C).
Detalhes | |
---|---|
https://developer-api.nest.com/devices/thermostats/ device_id /ambient_temperature_c | |
Devoluções | number Exemplo: 21,5 |
Acesso | somente leitura |
Disponível em | Termostato lido / v1-v6 Leitura / gravação do termostato / v1-v6 |
umidade
Umidade, em formato de porcentagem (%), medida no dispositivo, arredondada para os 5% mais próximos.
Detalhes | |
---|---|
https://developer-api.nest.com/devices/thermostats/ device_id /humidity | |
Devoluções | number Exemplo: 35 |
Faixa | 0-100 |
Acesso | somente leitura |
Disponível em | Termostato lido / v2-v6 Leitura / gravação do termostato / v2-v6 |
hvac_state
Indica se o sistema HVAC está ativamente aquecendo, resfriando ou está desligado. Use este valor para indicar o estado de atividade HVAC.
Quando off
, o sistema de climatização não é o aquecimento ou arrefecimento de forma activa. hvac_state
é independente da operação do ventilador.
Detalhes | |
---|---|
https://developer-api.nest.com/devices/thermostats/ device_id /hvac_state | |
Devoluções | string enum Valores: "aquecimento", "resfriamento", "desligado" |
Acesso | somente leitura |
Disponível em | Termostato lido / v3-v6 Leitura / gravação do termostato / v3-v6 |
where_id
Um identificador único, gerou-Nest que representa name
, o nome do dispositivo de exibição.
Saiba mais sobre onde nomes para termostatos Ninho , Ninho Protege e ninho de webcams .
Detalhes | |
---|---|
https://developer-api.nest.com/devices/thermostats/ device_id /where_id | |
Devoluções | string Exemplo: "d6reb_OZTM ..." |
Acesso | somente leitura |
Disponível em | Termostato lido / v4-v6 Leitura / gravação do termostato / v4-v6 |
está bloqueado
Status de bloqueio do termostato. Quando verdadeiro, o termostato de bloqueio função é activada, e restringe a gama de temperaturas para estes valores min / max: locked_temp_min_f
, locked_temp_max_f
, locked_temp_min_c
, e locked_temp_max_c
.
Detalhes | |
---|---|
https://developer-api.nest.com/devices/thermostats/ device_id /is_locked | |
Devoluções | boolean Valores: verdadeiro, falso |
Acesso | somente leitura |
Disponível em | Termostato lido / v5-v6 Leitura / gravação do termostato / v5-v6 |
lock_temp_min_f
Mínimo Termostato de bloqueio temperatura, indicada em graus Fahrenheit inteiras (1 ° F). Usado quando is_locked
é true
.
Detalhes | |
---|---|
https://developer-api.nest.com/devices/thermostats/ device_id /locked_temp_min_f | |
Devoluções | string Exemplo: 65 |
Acesso | somente leitura |
Disponível em | Termostato lido / v5-v6 Leitura / gravação do termostato / v5-v6 |
lock_temp_max_f
Máxima Termostato de bloqueio temperatura, indicada em graus Fahrenheit inteiras (1 ° F). Usado quando is_locked
é true
.
Detalhes | |
---|---|
https://developer-api.nest.com/devices/thermostats/ device_id /locked_temp_max_f | |
Devoluções | string Exemplo: 80 |
Acesso | somente leitura |
Disponível em | Termostato lido / v5-v6 Leitura / gravação do termostato / v5-v6 |
lock_temp_min_c
Mínimo Termostato de bloqueio temperatura, apresentado em exibido na metade graus Celsius (0,5 ° C). Usado quando is_locked
é true
.
Detalhes | |
---|---|
https://developer-api.nest.com/devices/thermostats/ device_id /locked_temp_min_c | |
Devoluções | string Exemplo: 19,5 |
Acesso | somente leitura |
Disponível em | Termostato lido / v5-v6 Leitura / gravação do termostato / v5-v6 |
lock_temp_max_c
Máxima Termostato de bloqueio temperatura, apresentado em exibido na metade graus Celsius (0,5 ° C). Usado quando is_locked
é true
.
Detalhes | |
---|---|
https://developer-api.nest.com/devices/thermostats/ device_id /locked_temp_max_c | |
Devoluções | string Exemplo: 24,5 |
Acesso | somente leitura |
Disponível em | Termostato lido / v5-v6 Leitura / gravação do termostato / v5-v6 |
rótulo
Termostato etiqueta personalizada . Aparece entre parênteses, após o nome where.
Detalhes | |
---|---|
https://developer-api.nest.com/devices/thermostats/ device_id /label | |
Devoluções | string Exemplos: "Upstairs", "Guest room", "Playroom" |
Acesso | ler escrever |
Disponível em | Leitura: Termostato lido / v6 Leitura / gravação do termostato / v6 Escrever: Leitura / gravação do termostato / v5-v6 |
sunshine_correction_enabled
Status de protetor solar ativado. Usado com sunlight_correction_active
. Quando true
, tecnologia Protetor solar é habilitado, e o termostato é automaticamente ajustando a luz solar directa, leitura e definir a temperatura correta.
Para mais informações, consulte O que é protetor solar?
Detalhes | |
---|---|
https://developer-api.nest.com/devices/thermostats/ device_id /sunlight_correction_enabled | |
Devoluções | boolean Valores: verdadeiro, falso |
Acesso | somente leitura |
Disponível em | Termostato lido / v6 Leitura / gravação do termostato / v6 |
sunshine_correction_active
Status ativo do protetor solar. Usado com sunlight_correction_enabled
. Quando true
, indica que o termostato está localizado na luz solar direta.
Para mais informações, consulte O que é protetor solar?
Detalhes | |
---|---|
https://developer-api.nest.com/devices/thermostats/ device_id /sunlight_correction_active | |
Devoluções | boolean Valores: verdadeiro, falso |
Acesso | somente leitura |
Disponível em | Termostato lido / v6 Leitura / gravação do termostato / v6 |
where_name
O nome de exibição do dispositivo. Associado com o termostato where_id
. Pode ser qualquer nome de sala de uma lista que fornecemos ou um nome personalizado. Saiba mais sobre onde nomes para termostatos Ninho , Ninho Protege e ninho de webcams .
Detalhes | |
---|---|
https://developer-api.nest.com/devices/thermostats/ device_id /where_name | |
Devoluções | string Exemplo: "Corredor" |
Acesso | somente leitura |
Disponível em | Termostato lido / v6 Leitura / gravação do termostato / v6 |
fan_timer_duration
Especifica por quanto tempo (em minutos) o ventilador está configurado para funcionar.
O fan_timer_active
definição liga o ventilador. O fan_timer_timeout
valor indica a hora quando fan_timer_duration
é definido como fim.
Para saber como os clientes definir o temporizador do ventilador, consulte Temporizador Duração .
Detalhes | |
---|---|
https://developer-api.nest.com/devices/thermostats/ device_id /fan_timer_duration | |
Devoluções | int Valores: 15, 30, 45, 60, 120, 240, 480, 720 |
Acesso | ler escrever |
Disponível em | Leitura: Termostato lido / v6 Leitura / gravação do termostato / v6 Escrever: Leitura / gravação do termostato / v6 |
time_to_target
O tempo, em minutos, que levará para a estrutura atingir a temperatura desejada.
Veja Time-to-Temperatura para mais informações.
Detalhes | |
---|---|
https://developer-api.nest.com/devices/thermostats/ device_id /time_to_target | |
Devoluções | string enum Valores: "~ 0", "<5", "~ 15", "~ 90", "120" |
Acesso | somente leitura |
Disponível em | Termostato lido / v6 Leitura / gravação do termostato / v6 |
time_to_target_training
No modo de treinamento, o Nest Thermostat aprende sobre o sistema HVAC e descobre quanto tempo leva para atingir a temperatura desejada. Quando o termostato tem informações suficientes para fazer uma estimativa razoável do tempo para atingir a temperatura alvo, este valor irá mudar de training
para ready
.
Veja Time-to-Temperatura para mais informações.
Detalhes | |
---|---|
https://developer-api.nest.com/devices/thermostats/ device_id /time_to_target_training | |
Devoluções | string enum Valores: "treinamento", "pronto" |
Acesso | somente leitura |
Disponível em | Termostato lido / v6 Leitura / gravação do termostato / v6 |
anterior_hvac_mode
Exibe a última selecionada hvac_mode
. Usado quando se muda de hvac_mode
= eco
em um dispositivo com firmware desatualizado.
Para saber mais sobre a mudança betwen Eco e modos não-Eco, consulte o Guia do termostato .
Detalhes | |
---|---|
https://developer-api.nest.com/devices/thermostats/ device_id /previous_hvac_mode | |
Devoluções | string Valores: "heat", "cool", "heat-cool", "off", em branco (sem valor) |
Acesso | somente leitura |
Disponível em | Termostato lido / v6 Leitura / gravação do termostato / v6 |