Google致力於提高黑人社區的種族平等。 怎麼看。
本頁面由 Cloud Translation API 翻譯而成。
Switch to English

恆溫器API

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

用戶可以將多個Nest Thermostats添加到devices/thermostats組, 每個結構最多可以添加一個。呼叫此數據位置時,可以訪問Nest Thermostat數據(結構中設備的數據值)。

以下所有值均位於JSON文檔中的每個devices/thermostats/ device_id

設備編號

巢式恆溫器唯一標識符。

細節
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

structure_id

結構唯一標識符。

細節
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

last_connection

上一次成功與Nest服務互動的時間戳記,格式為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
值:true,false
訪問 只讀
可用於 溫控器讀取/ v1-v6
溫控器讀/寫/ v1-v6

can_cool

系統冷卻能力(具有交流電)。

細節
https://developer-api.nest.com/devices/thermostats/ device_id /can_cool
退貨 boolean
值:true,false
訪問 只讀
可用於 溫控器讀取/ v1-v6
溫控器讀/寫/ v1-v6

can_heat

系統散熱能力。

細節
https://developer-api.nest.com/devices/thermostats/ device_id /can_heat
退貨 boolean
值:true,false
訪問 只讀
可用於 溫控器讀取/ v1-v6
溫控器讀/寫/ v1-v6

is_using_emergency_heat

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

緊急加熱打開時:

  • 用戶可以在設備上調節目標溫度,但是在關閉緊急加熱之前不能更改模式
  • 仍然可以通過API更改hvac_mode

請參閱什麼是緊急熱源?有關Nest Nest恆溫器如何支持應急加熱的更多信息。

細節
https://developer-api.nest.com/devices/thermostats/ device_id /is_using_emergency_heat
退貨 boolean
值:true,false
訪問 只讀
可用於 溫控器讀取/ v1-v6
溫控器讀/寫/ v1-v6

has_fan

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

細節
https://developer-api.nest.com/devices/thermostats/ device_id /has_fan
退貨 boolean
值:true,false
訪問 只讀
可用於 溫控器讀取/ v1-v6
溫控器讀/寫/ v1-v6

fan_timer_active

指示風扇定時器是否已啟用;與fan_timer_duration一起使用可在(用戶指定的)預設持續時間內打開風扇。

有關客戶如何設置風扇持續時間的更多信息,請參閱高級風扇控制

細節
https://developer-api.nest.com/devices/thermostats/ device_id /fan_timer_active
退貨 boolean
值:true,false
訪問 讀/寫
可用於 溫控器讀取/ v1-v6
溫控器讀/寫/ v1-v6

fan_timer_timeout

ISO 8601格式顯示風扇計時器何時達到0(停止時間)的時間戳。

細節
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
值:true,false
訪問 只讀
可用於 溫控器讀取/ 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

target_temperature_f

所需的溫度,以華氏度(1°F)為單位。在hvac_mode = heatcool

細節
https://developer-api.nest.com/devices/thermostats/ device_id /target_temperature_f
退貨 number
示例:72
範圍 50-90
訪問 讀/寫
可用於 溫控器讀取/ v1-v6
溫控器讀/寫/ v1-v6

target_temperature_c

所需溫度,以半攝氏度(0.5°C)為單位。當hvac_mode = heatcool

細節
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_mode

指示HVAC系統的加熱/冷卻模式,例如具有加熱和冷卻能力的系統的“加熱•冷卻”或“節能”的節能模式。

細節
https://developer-api.nest.com/devices/thermostats/ device_id /hvac_mode
退貨 string enum
值:“熱”,“涼”,“熱涼”,“節能”,“關閉”
訪問 讀/寫
可用於 溫控器讀取/ v1-v6
溫控器讀/寫/ v1-v6

環境溫度

在設備上測得的溫度,以華氏度(1°F)為單位。

細節
https://developer-api.nest.com/devices/thermostats/ device_id /ambient_temperature_f
退貨 number
示例:72
訪問 只讀
可用於 溫控器讀取/ v1-v6
溫控器讀/寫/ v1-v6

環境溫度

在設備上測得的溫度,以半攝氏度(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

唯一的,由Nest生成的標識符,代表name ,即設備的顯示名稱。

詳細了解Nest ThermostatsNest ProtectsNest Cams的名稱

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

鎖住了

溫控器鎖定狀態。設置為true時,將啟用恆溫器鎖定功能,並將溫度範圍限制為以下最小/最大值: locked_temp_min_flocked_temp_max_flocked_temp_min_clocked_temp_max_c

細節
https://developer-api.nest.com/devices/thermostats/ device_id /is_locked
退貨 boolean
值:true,false
訪問 只讀
可用於 恆溫器讀取/ v5-v6
溫控器讀/寫/ v5-v6

Locked_temp_min_f

最低恆溫器鎖定溫度,以華氏(1°F)整度顯示。在is_lockedtrue

細節
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_lockedtrue

細節
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°C)顯示。在is_lockedtrue

細節
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°C)顯示。在is_lockedtrue

細節
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

sunshine_correction_enabled

Sunblock啟用狀態。與sunlight_correction_active 。設置為true ,將啟用Sunblock技術,並且恆溫器會自動進行調整以直射陽光,並讀取並設置正確的溫度。

有關更多信息,請參見什麼是Sunblock?

細節
https://developer-api.nest.com/devices/thermostats/ device_id /sunlight_correction_enabled
退貨 boolean
值:true,false
訪問 只讀
可用於 溫控器讀取/ v6
溫控器讀/寫/ v6

sunshine_correction_active

防曬霜活動狀態。與sunlight_correction_enabled 。如果為true ,則表示恆溫器位於陽光直射的地方。

有關更多信息,請參見什麼是Sunblock?

細節
https://developer-api.nest.com/devices/thermostats/ device_id /sunlight_correction_active
退貨 boolean
值:true,false
訪問 只讀
可用於 溫控器讀取/ v6
溫控器讀/寫/ v6

where_name

設備的顯示名稱。與恆溫器where_id 。可以是我們提供的列表中的任何房間名稱,也可以是自定義名稱。詳細了解Nest ThermostatsNest ProtectsNest Cams的名稱

細節
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

time_to_target

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

有關更多信息,請參見溫度時間

細節
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