API de termostato

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 Nest Thermostats ao grupo de devices/thermostats , 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).

Todos os valores abaixo são encontrados 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	Leitura do termostato / 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	Leitura do termostato / 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	Leitura do termostato / 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	Leitura do termostato / 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	Leitura do termostato / v1-v6 Leitura / gravação do termostato / v1-v6

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/thermostats/ device_id /name_long
Devoluções	string Exemplo: "Termostato de corredor (andar de cima)"
Acesso	somente leitura
Disponível em	Leitura do termostato / v1-v6 Leitura / gravação do termostato / v1-v6

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/thermostats/ device_id /last_connection
Devoluções	string Exemplo: "2016-12-31T23: 59: 59.000Z"
Acesso	somente leitura
Disponível em	Leitura do termostato / 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	Leitura do termostato / 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	Leitura do termostato / 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	Leitura do termostato / 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 é 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	Leitura do termostato / 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	Leitura do termostato / v1-v6 Leitura / gravação do termostato / v1-v6

fan_timer_active

Indica se o temporizador do ventilador está ativado; usado com fan_timer_duration para ligar o ventilador por uma duração predefinida (especificada pelo usuário).

Consulte Controle avançado do ventilador para obter mais informações sobre como os clientes definem 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	Leitura do termostato / v1-v6 Leitura / gravação do termostato / v1-v6

fan_timer_timeout

Timestamp mostrando quando o temporizador do ventilador atinge 0 (tempo de parada), no formato ISO 8601 .

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	Leitura do termostato / 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	Leitura do termostato / 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	Ler: Leitura do termostato / 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
Alcance	50-90
Acesso	ler escrever
Disponível em	Leitura do termostato / 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
Alcance	9-32
Acesso	ler escrever
Disponível em	Leitura do termostato / v1-v6 Leitura / gravação do termostato / v1-v6

target_temperature_high_f

Temperatura máxima desejada, exibida em graus Fahrenheit (1 ° F). Usado quando hvac_mode = heat-cool (modo Heat • Cool).

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	Leitura do termostato / 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). Usado quando hvac_mode = heat-cool (modo Heat • Cool).

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	Leitura do termostato / v1-v6 Leitura / gravação do termostato / v1-v6

target_temperature_low_f

Temperatura mínima desejada, exibida em graus Fahrenheit (1 ° F). Usado quando hvac_mode = heat-cool (modo Heat • Cool).

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	Leitura do termostato / 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). Usado quando hvac_mode = heat-cool (modo Heat • Cool).

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	Leitura do termostato / v1-v6 Leitura / gravação do termostato / v1-v6

eco_temperature_high_f

Temperatura máxima de eco, exibida em graus Fahrenheit (1 ° F). 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	Leitura do termostato / 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	Leitura do termostato / v1-v6 Leitura / gravação do termostato / v1-v6

away_temperature_low_f (ANTIGO)

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	Leitura do termostato / 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	Leitura do termostato / v1-v6 Leitura / gravação do termostato / v1-v6

hvac_mode

Indica os 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 estiver bloqueado
• target_temperature_f e target_temperature_c não podem ser alterados se hvac_mode = off ou eco

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	Leitura do termostato / 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	Leitura do termostato / 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	Leitura do termostato / 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
Alcance	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 HVAC não está aquecendo ou resfriando ativamente. 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	Leitura do termostato / v3-v6 Leitura / gravação do termostato / v3-v6

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/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á trancado

Status de bloqueio do termostato. Quando verdadeiro, o recurso Bloqueio do termostato é habilitado e restringe a faixa de temperatura a estes valores mínimo / máximo: 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

Temperatura mínima de bloqueio do termostato , exibida em graus Fahrenheit (1 ° F) inteiros. 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

Temperatura máxima de bloqueio do termostato , exibida em graus Fahrenheit (1 ° F) inteiros. 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

Temperatura mínima de bloqueio do termostato , exibida em meio grau 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

Temperatura máxima de bloqueio do termostato , exibida em meio grau 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

Etiqueta personalizada do termostato. 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	Ler: 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 , a tecnologia Sunblock é ativada e o termostato se ajusta automaticamente à luz solar direta, lendo e definindo a temperatura correta.

Para obter 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 sob luz solar direta.

Para obter 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 ao termostato 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/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.

A configuração fan_timer_active liga o ventilador. O valor fan_timer_timeout indica o registro de data e hora quando fan_timer_duration é definido para terminar.

Para saber como os clientes definem o cronômetro do ventilador, consulte Duração do cronômetro .

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	Ler: 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.

Consulte Tempo para temperatura para obter 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 tiver informações suficientes para fazer uma estimativa razoável do tempo para atingir a temperatura desejada, esse valor mudará de training para ready .

Consulte Tempo para temperatura para obter 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 o hvac_mode selecionado por hvac_mode . Usado ao alternar de hvac_mode = eco em um dispositivo com firmware desatualizado.

Para saber mais sobre como alternar entre os modos Eco e 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