恆溫器API

Nest API 適用於所有 Nest Learning Thermostat™ 型號，但在歐盟帶有 Heat Link 的 Thermostat E 除外。

用戶可以添加多個巢恆溫器到devices/thermostats組，直至每結構最大。當您調用此數據位置時，您可以訪問 Nest Thermostat 數據（結構中設備的數據值）。

下面所有的值被每個下找到devices/thermostats/ device_id的JSON文檔英寸

設備編號

Nest Thermostat 唯一標識符。

細節
https://developer-api.nest.com/devices/thermostats/ device_id /device_id
退貨	string 示例：“peyiJNo0IldT2YlIVtYaGQ”
使用權	只讀
可在	恆溫讀取/v1-v6 恆溫器讀/寫/v1-v6

語言環境

指定語言和地區（或國家）首選項。

細節
https://developer-api.nest.com/devices/thermostats/ device_id /locale
退貨	string 示例：“en-GB”、“en-US”、“es-US”、“fr-CA”、“fr-CA”、“nl-NL”
使用權	只讀
可在	恆溫讀取/v1-v6 恆溫器讀/寫 / v1-v6

軟件版本

軟件版本。

細節
https://developer-api.nest.com/devices/thermostats/ device_id /software_version
退貨	string 示例：“4.0”
使用權	只讀
可在	恆溫讀取/v1-v6 恆溫器讀/寫 / v1-v6

結構標識

結構唯一標識符。

細節
https://developer-api.nest.com/devices/thermostats/ device_id /structure_id
退貨	string 示例：“VqFabWH21nw...”
使用權	只讀
可在	恆溫讀取/v1-v6 恆溫器讀/寫 / v1-v6

名稱

設備的顯示名稱。可以是我們提供的列表中的任何房間名稱，也可以是自定義名稱。

細節
https://developer-api.nest.com/devices/thermostats/ device_id /name
退貨	string 示例：“走廊”
使用權	只讀
可在	恆溫讀取/v1-v6 恆溫器讀/寫 / v1-v6

name_long

設備的長顯示名稱。包括，或者通過自定義（標記），由用戶創建的wheres 。

細節
https://developer-api.nest.com/devices/thermostats/ device_id /name_long
退貨	string 示例：“走廊恆溫器（樓上）”
使用權	只讀
可在	恆溫讀取/v1-v6 恆溫器讀/寫 / v1-v6

最後一個連接

與鳥巢服務的一次成功互動，在時間戳ISO 8601的格式。

細節
https://developer-api.nest.com/devices/thermostats/ device_id /last_connection
退貨	string 示例：“2016-12-31T23:59:59.000Z”
使用權	只讀
可在	恆溫讀取/v1-v6 恆溫器讀/寫 / v1-v6

在線

設備與 Nest 服務的連接狀態。

細節
https://developer-api.nest.com/devices/thermostats/ device_id /is_online
退貨	boolean 值：真、假
使用權	只讀
可在	恆溫讀取/v1-v6 恆溫器讀/寫 / v1-v6

can_cool

系統冷卻能力（有交流電）。

細節
https://developer-api.nest.com/devices/thermostats/ device_id /can_cool
退貨	boolean 值：真、假
使用權	只讀
可在	恆溫讀取/v1-v6 恆溫器讀/寫 / v1-v6

can_heat

系統加熱能力。

細節
https://developer-api.nest.com/devices/thermostats/ device_id /can_heat
退貨	boolean 值：真、假
使用權	只讀
可在	恆溫讀取/v1-v6 恆溫器讀/寫 / v1-v6

is_using_emergency_heat

帶有用於冷卻的熱泵的系統中的緊急熱狀態。

當緊急加熱開啟時：

• 用戶可以在設備上調整目標溫度，但在緊急加熱關閉之前無法更改模式
• 該hvac_mode仍然可以通過API來改變

見什麼急熱？了解有關 Nest Thermostat 如何支持緊急供暖的更多信息。

細節
https://developer-api.nest.com/devices/thermostats/ device_id /is_using_emergency_heat
退貨	boolean 值：真、假
使用權	只讀
可在	恆溫讀取/v1-v6 恆溫器讀/寫 / v1-v6

has_fan

系統能夠獨立於加熱或冷卻控制風扇。

細節
https://developer-api.nest.com/devices/thermostats/ device_id /has_fan
退貨	boolean 值：真、假
使用權	只讀
可在	恆溫讀取/v1-v6 恆溫器讀/寫 / v1-v6

fan_timer_active

指示風扇定時器是否已啟用；與用於fan_timer_duration接通風扇為（用戶指定的）預先設定的時間。

見先進的風機控制的客戶如何設置風扇時間的詳細信息。

細節
https://developer-api.nest.com/devices/thermostats/ device_id /fan_timer_active
退貨	boolean 值：真、假
使用權	讀/寫
可在	恆溫讀取/v1-v6 恆溫器讀/寫/v1-v6

fan_timer_timeout

時間戳示出當風扇定時器達到0（停止時間），在ISO 8601格式。

細節
https://developer-api.nest.com/devices/thermostats/ device_id /fan_timer_timeout
退貨	string 示例：“2016-12-31T23:59:59.000Z”
使用權	只讀
可在	恆溫讀取/v1-v6 恆溫器讀/寫 / v1-v6

has_leaf

當恆溫器設置為節能溫度時顯示。

細節
https://developer-api.nest.com/devices/thermostats/ device_id /has_leaf
退貨	boolean 值：真、假
使用權	只讀
可在	恆溫讀取/v1-v6 恆溫器讀/寫/v1-v6

溫度標度

華氏或攝氏；配合溫度顯示使用。

細節
https://developer-api.nest.com/devices/thermostats/ device_id /temperature_scale
退貨	string enum 值：“F”、“C”
使用權	讀/寫
可在	讀： 恆溫讀取/v1-v6 恆溫器讀/寫 / v1-v6 寫： 恆溫器讀/寫 / v5-v6

目標溫度_f

所需溫度，全華氏度 (1°F)。使用時hvac_mode = heat或cool 。

細節
https://developer-api.nest.com/devices/thermostats/ device_id /target_temperature_f
退貨	number 示例：72
範圍	50-90
使用權	讀/寫
可在	恆溫讀取/v1-v6 恆溫器讀/寫 / v1-v6

目標溫度_c

所需溫度，以半攝氏度 (0.5°C) 為單位。使用時hvac_mode = heat或cool 。

細節
https://developer-api.nest.com/devices/thermostats/ device_id /target_temperature_c
退貨	number 示例：21.5
範圍	9-32
使用權	讀/寫
可在	恆溫讀取/v1-v6 恆溫器讀/寫 / v1-v6

target_temperature_high_f

最高目標溫度，以整華氏度 (1°F) 顯示。使用時hvac_mode = heat-cool （熱•冷色模式）。

細節
https://developer-api.nest.com/devices/thermostats/ device_id /target_temperature_high_f
退貨	number 示例：80
使用權	讀/寫
可在	恆溫讀取/v1-v6 恆溫器讀/寫 / v1-v6

target_temperature_high_c

最高目標溫度，以半攝氏度 (0.5°C) 顯示。使用時hvac_mode = heat-cool （熱•冷色模式）。

細節
https://developer-api.nest.com/devices/thermostats/ device_id /target_temperature_high_c
退貨	number 示例：24.5
使用權	讀/寫
可在	恆溫讀取/v1-v6 恆溫器讀/寫/v1-v6

target_temperature_low_f

最低目標溫度，以整個華氏度 (1°F) 顯示。使用時hvac_mode = heat-cool （熱•冷色模式）。

細節
https://developer-api.nest.com/devices/thermostats/ device_id /target_temperature_low_f
退貨	number 示例：65
使用權	讀/寫
可在	恆溫讀取/v1-v6 恆溫器讀/寫 / v1-v6

target_temperature_low_c

最低目標溫度，以半攝氏度 (0.5°C) 顯示。使用時hvac_mode = heat-cool （熱•冷色模式）。

細節
https://developer-api.nest.com/devices/thermostats/ device_id /target_temperature_low_c
退貨	number 示例：19.5
使用權	讀/寫
可在	恆溫讀取/v1-v6 恆溫器讀/寫/v1-v6

eco_temperature_high_f

最高環保溫度，以整個華氏度 (1°F) 顯示。使用時hvac_mode = eco 。

細節
https://developer-api.nest.com/devices/thermostats/ device_id /eco_temperature_high_f
退貨	number 示例：80
使用權	只讀
可在	溫控器讀取/v6 恆溫器讀/寫/v6

eco_temperature_high_c

最高環保溫度，以半攝氏度 (0.5°C) 顯示。使用時hvac_mode = eco 。

細節
https://developer-api.nest.com/devices/thermostats/ device_id /eco_temperature_high_c
退貨	number 示例：24.5
使用權	只讀
可在	溫控器讀取/v6 恆溫器讀/寫/v6

eco_temperature_low_f

最低生態溫度，以整個華氏度 (1°F) 顯示。使用時hvac_mode = eco 。

細節
https://developer-api.nest.com/devices/thermostats/ device_id /eco_temperature_low_f
退貨	number 示例：65
使用權	只讀
可在	溫控器讀取/v6 恆溫器讀/寫/v6

eco_temperature_low_c

最低環保溫度，以半攝氏度 (0.5°C) 顯示。使用時hvac_mode = eco 。

細節
https://developer-api.nest.com/devices/thermostats/ device_id /eco_temperature_low_c
退貨	number 示例：19.5
使用權	只讀
可在	溫控器讀取/v6 恆溫器讀/寫/v6

away_temperature_high_f（已棄用）

最大客場溫度，以整個華氏度 (1°F) 顯示。

細節
https://developer-api.nest.com/devices/thermostats/ device_id /away_temperature_high_f
退貨	number 示例：80
使用權	只讀
可在	恆溫讀取/v1-v6 恆溫器讀/寫 / v1-v6

away_temperature_high_c（已棄用）

最大客場溫度，以半攝氏度 (0.5°C) 顯示。

細節
https://developer-api.nest.com/devices/thermostats/ device_id /away_temperature_high_c
退貨	number 示例：24.5
使用權	只讀
可在	恆溫讀取/v1-v6 恆溫器讀/寫 / v1-v6

away_temperature_low_f（已棄用）

最低客場溫度，以整個華氏度 (1°F) 顯示。

細節
https://developer-api.nest.com/devices/thermostats/ device_id /away_temperature_low_f
退貨	number 示例：65
使用權	只讀
可在	恆溫讀取/v1-v6 恆溫器讀/寫 / v1-v6

away_temperature_low_c（已棄用）

最低客場溫度，以半攝氏度 (0.5°C) 顯示。

細節
https://developer-api.nest.com/devices/thermostats/ device_id /away_temperature_low_c
退貨	number 示例：19.5
使用權	只讀
可在	恆溫讀取/v1-v6 恆溫器讀/寫 / v1-v6

暖通空調模式

指示 HVAC 系統加熱/冷卻模式，例如 Heat•Cool 用於具有加熱和冷卻能力的系統，或 Eco 溫度用於節能。

• hvac_mode如果溫控器可以改變鎖定
• target_temperature_f和target_temperature_c如果不能改變hvac_mode = off或eco

細節
https://developer-api.nest.com/devices/thermostats/ device_id /hvac_mode
退貨	string enum 值：“熱”、“冷”、“熱-冷”、“生態”、“關閉”
使用權	讀/寫
可在	恆溫讀取/v1-v6 恆溫器讀/寫 / v1-v6

環境溫度_f

在設備上測量的溫度，單位為華氏度 (1°F)。

細節
https://developer-api.nest.com/devices/thermostats/ device_id /ambient_temperature_f
退貨	number 示例：72
使用權	只讀
可在	恆溫讀取/v1-v6 恆溫器讀/寫 / v1-v6

環境溫度_c

在設備上測量的溫度，單位為半攝氏度 (0.5°C)。

細節
https://developer-api.nest.com/devices/thermostats/ device_id /ambient_temperature_c
退貨	number 示例：21.5
使用權	只讀
可在	恆溫讀取/v1-v6 恆溫器讀/寫 / v1-v6

濕度

濕度，以百分比 (%) 格式，在設備上測量，四捨五入到最接近的 5%。

細節
https://developer-api.nest.com/devices/thermostats/ device_id /humidity
退貨	number 示例：35
範圍	0-100
使用權	只讀
可在	恆溫讀取 / v2-v6 恆溫器讀/寫 / v2-v6

hvac_state

指示 HVAC 系統是主動加熱、冷卻還是關閉。使用此值指示 HVAC 活動狀態。

時off ，HVAC系統沒有被主動地加熱或冷卻。 hvac_state是獨立風扇運轉的。

細節
https://developer-api.nest.com/devices/thermostats/ device_id /hvac_state
退貨	string enum 值：“加熱”、“冷卻”、“關閉”
使用權	只讀
可在	恆溫讀取 / v3-v6 恆溫器讀/寫 / v3-v6

where_id

一個唯一的，巢生成的標識符，它表示name ，設備的顯示名稱。

了解更多關於哪裡的名字 鳥巢恆溫器，巢保護和巢凸輪。

細節
https://developer-api.nest.com/devices/thermostats/ device_id /where_id
退貨	string 示例：“d6reb_OZTM...”
使用權	只讀
可在	恆溫讀取 / v4-v6 恆溫器讀/寫 / v4-v6

被鎖住了

恆溫器鎖定狀態。為真時，該恆溫器鎖定功能被啟用，並且限制的溫度範圍內對這些最小/最大值： locked_temp_min_f ， locked_temp_max_f ， locked_temp_min_c ，和locked_temp_max_c 。

細節
https://developer-api.nest.com/devices/thermostats/ device_id /is_locked
退貨	boolean 值：真、假
使用權	只讀
可在	恆溫讀取 / v5-v6 恆溫器讀/寫 / v5-v6

locked_temp_min_f

最小恆溫鎖溫度，在整個華氏度（1°F）顯示。當使用is_locked是true 。

細節
https://developer-api.nest.com/devices/thermostats/ device_id /locked_temp_min_f
退貨	string 示例：65
使用權	只讀
可在	恆溫讀取 / v5-v6 恆溫器讀/寫 / v5-v6

locked_temp_max_f

最大恆溫鎖溫度，在整個華氏度（1°F）顯示。當使用is_locked是true 。

細節
https://developer-api.nest.com/devices/thermostats/ device_id /locked_temp_max_f
退貨	string 示例：80
使用權	只讀
可在	恆溫讀取 / v5-v6 恆溫器讀/寫 / v5-v6

locked_temp_min_c

最小恆溫鎖溫度，顯示在半度顯示攝氏度（0.5℃）。當使用is_locked是true 。

細節
https://developer-api.nest.com/devices/thermostats/ device_id /locked_temp_min_c
退貨	string 示例：19.5
使用權	只讀
可在	恆溫讀取 / v5-v6 恆溫器讀/寫 / v5-v6

locked_temp_max_c

最大恆溫鎖溫度，顯示在半度顯示攝氏度（0.5℃）。當使用is_locked是true 。

細節
https://developer-api.nest.com/devices/thermostats/ device_id /locked_temp_max_c
退貨	string 示例：24.5
使用權	只讀
可在	恆溫讀取 / v5-v6 恆溫器讀/寫 / v5-v6

標籤

溫控器自定義標籤。出現在括號中，在 where 名稱之後。

細節
https://developer-api.nest.com/devices/thermostats/ device_id /label
退貨	string 示例：“樓上”、“客房”、“遊戲室”
使用權	讀/寫
可在	讀： 溫控器讀取/v6 恆溫器讀/寫/v6 寫： 恆溫器讀/寫 / v5-v6

sun_correction_enabled

防曬霜啟用狀態。使用sunlight_correction_active 。當true ，防曬技術被啟用，且恆溫自動調節陽光直射，閱讀和設置正確的溫度。

欲了解更多信息，請參閱什麼是防曬？

細節
https://developer-api.nest.com/devices/thermostats/ device_id /sunlight_correction_enabled
退貨	boolean 值：真、假
使用權	只讀
可在	溫控器讀取/v6 恆溫器讀/寫/v6

sun_correction_active

防曬霜有效狀態。使用sunlight_correction_enabled 。當true ，表明該溫控器位於陽光直射。

欲了解更多信息，請參閱什麼是防曬？

細節
https://developer-api.nest.com/devices/thermostats/ device_id /sunlight_correction_active
退貨	boolean 值：真、假
使用權	只讀
可在	溫控器讀取/v6 恆溫器讀/寫/v6

where_name

設備的顯示名稱。有關與恆溫where_id 。可以是我們提供的列表中的任何房間名稱，也可以是自定義名稱。了解更多關於哪裡的名字 鳥巢恆溫器，巢保護和巢凸輪。

細節
https://developer-api.nest.com/devices/thermostats/ device_id /where_name
退貨	string 示例：“走廊”
使用權	只讀
可在	溫控器讀取/v6 恆溫器讀/寫/v6

fan_timer_duration

指定風扇設置運行的時間長度（以分鐘為單位）。

該fan_timer_active設置打開風扇。所述fan_timer_timeout值表明時間戳fan_timer_duration被設置為結束。

要了解客戶如何設置風扇計時器，看計時器時間。

細節
https://developer-api.nest.com/devices/thermostats/ device_id /fan_timer_duration
退貨	int 值：15、30、45、60、120、240、480、720
使用權	讀/寫
可在	讀： 溫控器讀取/v6 恆溫器讀/寫/v6 寫： 恆溫器讀/寫/v6

時間到目標

結構達到目標溫度所需的時間（以分鐘為單位）。

見時間-溫度以獲取更多信息。

細節
https://developer-api.nest.com/devices/thermostats/ device_id /time_to_target
退貨	string enum 值：“~0”、“<5”、“~15”、“~90”、“120”
使用權	只讀
可在	溫控器讀取/v6 恆溫器讀/寫/v6

time_to_target_training

在訓練模式下，Nest Thermostat 會了解 HVAC 系統並發現達到目標溫度所需的時間。當溫控器有足夠的信息，以使達到目標溫度的時間，合理估算，這個值將改變從training到ready 。

見時間-溫度以獲取更多信息。

細節
https://developer-api.nest.com/devices/thermostats/ device_id /time_to_target_training
退貨	string enum 值：“訓練”、“準備”
使用權	只讀
可在	溫控器讀取/v6 恆溫器讀/寫/v6

previous_hvac_mode

顯示最後一次選擇的hvac_mode 。從切換時使用hvac_mode = eco與過時的固件的設備上。

要了解更多關於愨生態和非生態模式之間切換，請參閱溫控器指南。

細節
https://developer-api.nest.com/devices/thermostats/ device_id /previous_hvac_mode
退貨	string 值：“heat”、“cool”、“heat-cool”、“off”、空白（無值）
使用權	只讀
可在	溫控器讀取/v6 恆溫器讀/寫/v6