A API Nest funciona com todos os modelos Nest Learning ThermostatTM, exceto o Thermostat E com Heat Link na UE.
Os usuários podem adicionar vários termostatos Nest ao grupo devices/thermostats
, até
o máximo por
estrutura.
Ao fazer uma chamada para esse local de dados, você poderá acessar os dados do Nest Thermostat
(valores de dados dos dispositivos na estrutura).
Todos os valores abaixo estão em cada
devices/thermostats/device_id
no documento JSON.
ID do dispositivo
Identificador exclusivo do Nest Thermostat.
Detalhes | |
---|---|
https://developer-api.nest.com/devices/thermostats/device_id/device_id |
|
Retorna | string Exemplo: "peyiJNo0IldT2YlIVtYaGQ" |
Acesso | somente leitura |
Disponível em | Termostato / leitura v1-v6 Termostato para leitura/gravação / v1-v6 |
localidade
Especifica o idioma e a região (ou país) de preferência.
Detalhes | |
---|---|
https://developer-api.nest.com/devices/thermostats/device_id/locale |
|
Retorna | string Exemplos: "en-GB", "en-US", "es-US", "fr-CA", "fr-CA", "nl-NL" |
Acesso | somente leitura |
Disponível em | Termostato / leitura v1-v6 Termostato para leitura/gravação / v1-v6 |
Versão do software
Versão do software.
Detalhes | |
---|---|
https://developer-api.nest.com/devices/thermostats/device_id/software_version |
|
Retorna | string Exemplo: "4.0" |
Acesso | somente leitura |
Disponível em | Termostato / leitura v1-v6 Termostato para leitura/gravação / v1-v6 |
ID da estrutura
Identificador exclusivo da estrutura.
Detalhes | |
---|---|
https://developer-api.nest.com/devices/thermostats/device_id/structure_id |
|
Retorna | string Exemplo: "VqFabWH21nw..." |
Acesso | somente leitura |
Disponível em | Termostato / leitura v1-v6 Termostato para leitura/gravação / v1-v6 |
nome
Nome de exibição do dispositivo. Pode ser qualquer nome de ambiente de uma lista fornecida ou um nome personalizado.
Detalhes | |
---|---|
https://developer-api.nest.com/devices/thermostats/device_id/name |
|
Retorna | string Exemplo: "Hallway" |
Acesso | somente leitura |
Disponível em | Termostato / leitura v1-v6 Termostato para leitura/gravação / v1-v6 |
nome_longo
Nome de exibição longo do dispositivo. Inclui um rótulo personalizado, criado pelo usuário
ou pelo wheres
.
Detalhes | |
---|---|
https://developer-api.nest.com/devices/thermostats/device_id/name_long |
|
Retorna | string Exemplo: "Termostato de inverno (no andar de cima)" |
Acesso | somente leitura |
Disponível em | Termostato / leitura v1-v6 Termostato para leitura/gravação / v1-v6 |
Última conexão
Carimbo de data/hora da última interação com o serviço Nest no formato ISO 8601.
Detalhes | |
---|---|
https://developer-api.nest.com/devices/thermostats/device_id/last_connection |
|
Retorna | string Exemplo: "2016-12-31T23:59:59.000Z" |
Acesso | somente leitura |
Disponível em | Termostato / leitura v1-v6 Termostato para leitura/gravação / v1-v6 |
está on-line
Status da conexão do dispositivo com o serviço Nest.
Detalhes | |
---|---|
https://developer-api.nest.com/devices/thermostats/device_id/is_online |
|
Retorna | boolean Valores: verdadeiro, falso |
Acesso | somente leitura |
Disponível em | Termostato / leitura v1-v6 Termostato para leitura/gravação / v1-v6 |
can_cool
Capacidade do sistema de resfriamento (com ar-condicionado).
Detalhes | |
---|---|
https://developer-api.nest.com/devices/thermostats/device_id/can_cool |
|
Retorna | boolean Valores: verdadeiro, falso |
Acesso | somente leitura |
Disponível em | Termostato / leitura v1-v6 Termostato para leitura/gravação / v1-v6 |
can_heat
Capacidade do sistema de aquecimento.
Detalhes | |
---|---|
https://developer-api.nest.com/devices/thermostats/device_id/can_heat |
|
Retorna | boolean Valores: verdadeiro, falso |
Acesso | somente leitura |
Disponível em | Termostato / leitura v1-v6 Termostato para leitura/gravação / v1-v6 |
is_using_emergency_heat
Status do aquecimento de emergência em sistemas com bombas de calor para resfriamento.
Quando o aquecimento de emergência está ativado:
- O usuário pode ajustar a temperatura desejada no dispositivo, mas não pode mudar o modo até que o aquecimento de emergência seja desativado.
- O
hvac_mode
ainda pode ser alterado pela API
Consulte O que é o aquecimento de emergência? para mais informações sobre como o Nest Thermostat é compatível com o aquecimento de emergência.
Detalhes | |
---|---|
https://developer-api.nest.com/devices/thermostats/device_id/is_using_emergency_heat |
|
Retorna | boolean Valores: verdadeiro, falso |
Acesso | somente leitura |
Disponível em | Termostato / leitura v1-v6 Termostato para leitura/gravação / v1-v6 |
tem_fã
Capacidade do sistema de controlar o ventilador independentemente do aquecimento ou do resfriamento.
Detalhes | |
---|---|
https://developer-api.nest.com/devices/thermostats/device_id/has_fan |
|
Retorna | boolean Valores: verdadeiro, falso |
Acesso | somente leitura |
Disponível em | Termostato / leitura v1-v6 Termostato para leitura/gravação / v1-v6 |
tempo_de_vento_ativo
Indica se o timer do ventilador está engajado. Usado com
fan_timer_duration
para ativar o ventilador por uma duração predefinida (especificada pelo usuário).
Consulte Controle de fãs avançado para mais informações sobre como os clientes definem a duração dos fãs.
Detalhes | |
---|---|
https://developer-api.nest.com/devices/thermostats/device_id/fan_timer_active |
|
Retorna | boolean Valores: verdadeiro, falso |
Acesso | leitura/gravação |
Disponível em | Termostato / leitura v1-v6 Termostato para leitura/gravação / v1-v6 |
tempo limite dos fãs
Carimbo de data/hora que mostra quando o timer do ventilador atinge 0 (hora de parada), no formato ISO 8601.
Detalhes | |
---|---|
https://developer-api.nest.com/devices/thermostats/device_id/fan_timer_timeout |
|
Retorna | string Exemplo: "2016-12-31T23:59:59.000Z" |
Acesso | somente leitura |
Disponível em | Termostato / leitura v1-v6 Termostato para leitura/gravação / v1-v6 |
has_leaf
Exibido quando o termostato está definido para uma temperatura que economiza energia.
Detalhes | |
---|---|
https://developer-api.nest.com/devices/thermostats/device_id/has_leaf |
|
Retorna | boolean Valores: verdadeiro, falso |
Acesso | somente leitura |
Disponível em | Termostato / leitura v1-v6 Termostato para leitura/gravação / v1-v6 |
escala_de_temperatura
Fahrenheit ou Celsius, usado com o modo de exibição de temperatura.
Detalhes | |
---|---|
https://developer-api.nest.com/devices/thermostats/device_id/temperature_scale |
|
Retorna | string enum Valores: "F", "C" |
Acesso | leitura/gravação |
Disponível em | Leitura: Termostato leitura / v1-v6 Termostato leitura/gravação / v1-v6 Gravação: Termostato/gravação / v5-v6 |
target_temperature_f
Temperatura desejada, em graus Celsius (1°F) completos. Usado quando
hvac_mode
= heat
ou cool
.
Detalhes | |
---|---|
https://developer-api.nest.com/devices/thermostats/device_id/target_temperature_f |
|
Retorna | number Exemplo: 72 |
Intervalo | 50-90 |
Acesso | leitura/gravação |
Disponível em | Termostato / leitura v1-v6 Termostato para leitura/gravação / v1-v6 |
target_temperature_c
Temperatura desejada, em 0,5 °C. Usado quando
hvac_mode
= heat
ou cool
.
Detalhes | |
---|---|
https://developer-api.nest.com/devices/thermostats/device_id/target_temperature_c |
|
Retorna | number Exemplo: 21,5 |
Intervalo | 9-32 |
Acesso | leitura/gravação |
Disponível em | Termostato / leitura v1-v6 Termostato para leitura/gravação / v1-v6 |
target_temperature_high_f
Temperatura-alvo máxima, exibida em graus Celsius Fahrenheit.
Usado quando hvac_mode
= heat-cool
( modo quente • modo frio).
Detalhes | |
---|---|
https://developer-api.nest.com/devices/thermostats/device_id/target_temperature_high_f |
|
Retorna | number Exemplo: 80 |
Acesso | leitura/gravação |
Disponível em | Termostato / leitura v1-v6 Termostato para leitura/gravação / v1-v6 |
target_temperature_high_c
Temperatura-alvo máxima, exibida em meio grau Celsius (0,5 °C). Usado
quando hvac_mode
= heat-cool
(modo de aquecimento • resfriamento).
Detalhes | |
---|---|
https://developer-api.nest.com/devices/thermostats/device_id/target_temperature_high_c |
|
Retorna | number Exemplo: 24,5 |
Acesso | leitura/gravação |
Disponível em | Termostato / leitura v1-v6 Termostato para leitura/gravação / v1-v6 |
target_temperature_low_f
Temperatura-alvo mínima, exibida em graus Celsius Fahrenheit (1°F).
Usado quando hvac_mode
= heat-cool
( modo quente • modo frio).
Detalhes | |
---|---|
https://developer-api.nest.com/devices/thermostats/device_id/target_temperature_low_f |
|
Retorna | number Exemplo: 65 |
Acesso | leitura/gravação |
Disponível em | Termostato / leitura v1-v6 Termostato para leitura/gravação / v1-v6 |
target_temperature_low_c
Temperatura-alvo mínima, exibida em 0,5 °C. Usado
quando hvac_mode
= heat-cool
(modo de aquecimento • resfriamento).
Detalhes | |
---|---|
https://developer-api.nest.com/devices/thermostats/device_id/target_temperature_low_c |
|
Retorna | number Exemplo: 19.5 |
Acesso | leitura/gravação |
Disponível em | Termostato / leitura v1-v6 Termostato para leitura/gravação / v1-v6 |
eco_temperature_high_f
Temperatura econômica máxima, exibida em graus Celsius Fahrenheit. Usado
quando hvac_mode
= eco
.
Detalhes | |
---|---|
https://developer-api.nest.com/devices/thermostats/device_id/eco_temperature_high_f |
|
Retorna | number Exemplo: 80 |
Acesso | somente leitura |
Disponível em | Termostato para leitura / v6 Termostato para leitura/gravação / v6 |
eco_temperature_high_c
Temperatura econômica 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 |
|
Retorna | number Exemplo: 24,5 |
Acesso | somente leitura |
Disponível em | Termostato para leitura / v6 Termostato para leitura/gravação / v6 |
ecotemperatura_baixa
Temperatura econômica mínima, mostrada em graus Celsius Fahrenheit (1°F). Usado
quando hvac_mode
= eco
.
Detalhes | |
---|---|
https://developer-api.nest.com/devices/thermostats/device_id/eco_temperature_low_f |
|
Retorna | number Exemplo: 65 |
Acesso | somente leitura |
Disponível em | Termostato para leitura / v6 Termostato para leitura/gravação / v6 |
eco_temperature_low_c
Temperatura econômica mínima, exibida em 0,5 °C. Usado
quando hvac_mode
= eco
.
Detalhes | |
---|---|
https://developer-api.nest.com/devices/thermostats/device_id/eco_temperature_low_c |
|
Retorna | number Exemplo: 19.5 |
Acesso | somente leitura |
Disponível em | Termostato para leitura / v6 Termostato para leitura/gravação / v6 |
enviar_temperature_high_f (OBSOLETO)
Temperatura máxima máxima exibida em graus Fahrenheit Fahrenheit (1°F).
Detalhes | |
---|---|
https://developer-api.nest.com/devices/thermostats/device_id/away_temperature_high_f |
|
Retorna | number Exemplo: 80 |
Acesso | somente leitura |
Disponível em | Termostato / leitura v1-v6 Termostato para leitura/gravação / v1-v6 |
ausente_temperature_high_c (OBSOLETO)
Temperatura máxima ausente, exibida em meio grau Celsius (0,5 °C).
Detalhes | |
---|---|
https://developer-api.nest.com/devices/thermostats/device_id/away_temperature_high_c |
|
Retorna | number Exemplo: 24,5 |
Acesso | somente leitura |
Disponível em | Termostato / leitura v1-v6 Termostato para leitura/gravação / v1-v6 |
ausente_temperature_low_f (OBSOLETO)
Temperatura mínima mínima, mostrada em graus Celsius Fahrenheit (1°F).
Detalhes | |
---|---|
https://developer-api.nest.com/devices/thermostats/device_id/away_temperature_low_f |
|
Retorna | number Exemplo: 65 |
Acesso | somente leitura |
Disponível em | Termostato / leitura v1-v6 Termostato para leitura/gravação / v1-v6 |
ausente_temperature_low_c (OBSOLETO)
Temperatura mínima mínima, exibida em 0,5 °C.
Detalhes | |
---|---|
https://developer-api.nest.com/devices/thermostats/device_id/away_temperature_low_c |
|
Retorna | number Exemplo: 19.5 |
Acesso | somente leitura |
Disponível em | Termostato / leitura v1-v6 Termostato para leitura/gravação / v1-v6 |
modo HVAC (Aquecimento, ventilação e ar-condicionado)
Indica os modos de aquecimento/refrigeração do sistema HVAC (aquecimento, ventilação e ar-condicionado), como aquecer/resfriar para sistemas com capacidade de aquecimento e resfriamento, ou temperaturas econômicas para economia de energia.
- O
hvac_mode
poderá ser alterado se o termostato for bloqueado target_temperature_f
etarget_temperature_c
não vão poder ser alterados sehvac_mode
=off
oueco
.
Detalhes | |
---|---|
https://developer-api.nest.com/devices/thermostats/device_id/hvac_mode |
|
Retorna | string enum Valores: "heat", "cool", "heat-cool", "eco", "off" |
Acesso | leitura/gravação |
Disponível em | Termostato / leitura v1-v6 Termostato para leitura/gravação / v1-v6 |
ambiente_temperatura_f
Temperatura, medida no dispositivo, em graus Celsius (1°F).
Detalhes | |
---|---|
https://developer-api.nest.com/devices/thermostats/device_id/ambient_temperature_f |
|
Retorna | number Exemplo: 72 |
Acesso | somente leitura |
Disponível em | Termostato / leitura v1-v6 Termostato para leitura/gravação / v1-v6 |
ambiente_temperatura_c
Temperatura, medida no dispositivo, em 0,5 °C.
Detalhes | |
---|---|
https://developer-api.nest.com/devices/thermostats/device_id/ambient_temperature_c |
|
Retorna | number Exemplo: 21,5 |
Acesso | somente leitura |
Disponível em | Termostato / leitura v1-v6 Termostato para leitura/gravação / v1-v6 |
umidade
Umidade, no formato de porcentagem (%), medida no dispositivo, arredondada para o valor de 5% mais próximo.
Detalhes | |
---|---|
https://developer-api.nest.com/devices/thermostats/device_id/humidity |
|
Retorna | number Exemplo: 35 |
Intervalo | 0 a 100 |
Acesso | somente leitura |
Disponível em | Termostato / leitura v2-v6 Termostato para leitura/gravação / v2-v6 |
estado hvac
Indica se o sistema HVAC (Aquecimento, ventilação e ar-condicionado) está ativamente aquecendo, resfriando ou desligado. Use esse valor para indicar o estado da atividade HVAC (aquecimento, ventilação e ar-condicionado).
Quando off
, o sistema HVAC (Aquecimento, ventilação e ar-condicionado) não está aquecendo ou refrigerando ativamente. hvac_state
é
independente da operação de ventilador.
Detalhes | |
---|---|
https://developer-api.nest.com/devices/thermostats/device_id/hvac_state |
|
Retorna | string enum Valores: "aquecimento", "refrigeração", "desativado" |
Acesso | somente leitura |
Disponível em | Termostato / leitura v3-v6 Termostato para leitura/gravação / v3-v6 |
ID do local
Um identificador exclusivo gerado pelo Nest que representa
name
, o nome de exibição do dispositivo.
Saiba mais sobre os nomes de Nest Thermostats, Nest Protects e Nest Cams.
Detalhes | |
---|---|
https://developer-api.nest.com/devices/thermostats/device_id/where_id |
|
Retorna | string Exemplo: "d6reb_OZTM..." |
Acesso | somente leitura |
Disponível em | Termostato / leitura v4-v6 Termostato para leitura/gravação / v4-v6 |
está bloqueado
Status do bloqueio do termostato. Quando verdadeiro, o recurso Bloqueio
de termostato
está ativado e restringe a faixa de temperatura para estes valores mínimos/máximos:
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 |
|
Retorna | boolean Valores: verdadeiro, falso |
Acesso | somente leitura |
Disponível em | Termostato / leitura v5-v6 Termostato para leitura/gravação / v5-v6 |
lock_temp_min_f
Temperatura mínima de termostato
de travamento, exibida em graus Fahrenheit Fahrenheit (1°F). Usado quando
is_locked
é true
.
Detalhes | |
---|---|
https://developer-api.nest.com/devices/thermostats/device_id/locked_temp_min_f |
|
Retorna | string Exemplo: 65 |
Acesso | somente leitura |
Disponível em | Termostato / leitura v5-v6 Termostato para leitura/gravação / v5-v6 |
bloqueio_temp_max_f
Temperatura máxima de Fechadura
térmica, exibida em graus Celsius. Usado quando
is_locked
é true
.
Detalhes | |
---|---|
https://developer-api.nest.com/devices/thermostats/device_id/locked_temp_max_f |
|
Retorna | string Exemplo: 80 |
Acesso | somente leitura |
Disponível em | Termostato / leitura v5-v6 Termostato para leitura/gravação / v5-v6 |
lock_temp_min_c
Temperatura mínima de Termostato
Bloqueio,
exibida em 0,5 °C. Usado
quando is_locked
é true
.
Detalhes | |
---|---|
https://developer-api.nest.com/devices/thermostats/device_id/locked_temp_min_c |
|
Retorna | string Exemplo: 19.5 |
Acesso | somente leitura |
Disponível em | Termostato / leitura v5-v6 Termostato para leitura/gravação / v5-v6 |
bloqueio_temp_max_c
Temperatura máxima de termostato
fechada,
exibida em 0,5 °C. Usado
quando is_locked
é true
.
Detalhes | |
---|---|
https://developer-api.nest.com/devices/thermostats/device_id/locked_temp_max_c |
|
Retorna | string Exemplo: 24,5 |
Acesso | somente leitura |
Disponível em | Termostato / leitura v5-v6 Termostato para leitura/gravação / v5-v6 |
Identificador
Rótulo personalizado do termostato. Aparece entre parênteses, após o nome "where".
Detalhes | |
---|---|
https://developer-api.nest.com/devices/thermostats/device_id/label |
|
Retorna | string Exemplos: "Andar de cima", "Sala de hóspedes", "Sala de jogos" |
Acesso | leitura/gravação |
Disponível em | Leitura: Termostato leitura / v6 Termostato/leitura / v6 Gravação: Termostato/leitura / v5-v6 |
sunlight_correction_enabled
Filtro solar ativado. Usado com
sunlight_correction_active
.
Quando true
, a tecnologia de Filtro solar é ativada e o termostato se ajusta
automaticamente à luz solar direta, lendo e definindo a temperatura correta.
Para mais informações, consulte O que é o Filtro solar?
Detalhes | |
---|---|
https://developer-api.nest.com/devices/thermostats/device_id/sunlight_correction_enabled |
|
Retorna | boolean Valores: verdadeiro, falso |
Acesso | somente leitura |
Disponível em | Termostato para leitura / v6 Termostato para leitura/gravação / v6 |
luz_solar_ativa_ativa
Filtro solar ativado. Usado com
sunlight_correction_enabled
.
Quando true
, indica que o termostato está localizado sob luz solar direta.
Para mais informações, consulte O que é o Filtro solar?
Detalhes | |
---|---|
https://developer-api.nest.com/devices/thermostats/device_id/sunlight_correction_active |
|
Retorna | boolean Valores: verdadeiro, falso |
Acesso | somente leitura |
Disponível em | Termostato para leitura / v6 Termostato para leitura/gravação / v6 |
Nome do local
Nome de exibição do dispositivo. Associado ao termostato
where_id
. Pode ser qualquer nome de ambiente a partir de uma lista
que fornecemos ou um nome personalizado. Saiba mais sobre os nomes de Nest Thermostats, Nest Protects e Nest Cams.
Detalhes | |
---|---|
https://developer-api.nest.com/devices/thermostats/device_id/where_name |
|
Retorna | string Exemplo: "Hallway" |
Acesso | somente leitura |
Disponível em | Termostato para leitura / v6 Termostato para leitura/gravação / v6 |
tempo_de_vencimento
Especifica o tempo (em minutos) em que a ventilação está definida para execução.
A configuração fan_timer_active
ativa
o ventilador. O valor fan_timer_timeout
indica o carimbo de data/hora quando fan_timer_duration
está definido como
final.
Para saber como os clientes definem o timer do ventilador, consulte Duração do timer.
Detalhes | |
---|---|
https://developer-api.nest.com/devices/thermostats/device_id/fan_timer_duration |
|
Retorna | int Valores: 15, 30, 45, 60, 120, 240, 480, 720 |
Acesso | leitura/gravação |
Disponível em | Leitura: Termostato leitura / v6 Termostato/leitura / v6 Gravação: Termostato/leitura / v6 |
tempo até a segmentação
É o tempo, em minutos, necessário para que a estrutura alcance a temperatura desejada.
Consulte Tempo até a temperatura para mais informações.
Detalhes | |
---|---|
https://developer-api.nest.com/devices/thermostats/device_id/time_to_target |
|
Retorna | string enum Valores: "~0", "<5", "~15", "~90", "120" |
Acesso | somente leitura |
Disponível em | Termostato para leitura / v6 Termostato para leitura/gravação / v6 |
tempo_de_destino_treinamento
No modo de treinamento, o Nest Thermostat aprende sobre o sistema HVAC e descobre quanto tempo leva para alcançar a temperatura desejada. Quando o
Termostato tiver informações suficientes para fazer uma estimativa razoável do tempo para
alcançar a temperatura desejada, esse valor vai mudar de training
para ready
.
Consulte Tempo até a temperatura para mais informações.
Detalhes | |
---|---|
https://developer-api.nest.com/devices/thermostats/device_id/time_to_target_training |
|
Retorna | string enum Valores: "training", "ready" |
Acesso | somente leitura |
Disponível em | Termostato para leitura / v6 Termostato para leitura/gravação / v6 |
modo_hvac anterior
Mostra o último hvac_mode
selecionado. 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 econômicos, consulte o Guia de Termostatos.
Detalhes | |
---|---|
https://developer-api.nest.com/devices/thermostats/device_id/previous_hvac_mode |
|
Retorna | string Valores: "heat", "cool", "heat-cool", "off", em branco (sem valor) |
Acesso | somente leitura |
Disponível em | Termostato para leitura / v6 Termostato para leitura/gravação / v6 |