Notice: We're retiring Works with Nest. See the home page for more information.
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