Notice: We're retiring Works with Nest. See the home page for more information.
Google 致力于为黑人社区推动种族平等。查看具体举措
此页面由 Cloud Translation API 翻译。
Switch to English

结构体

结构体

巢状结构代表现实世界中的物理结构。通常是用户的家,它们充当设备的组织点,并将存储适用于整个家的数据。

Nest API提供对以下结构级数据的访问,具体取决于所授予的权限级别:

  • 结构名称和设备“位置名称”(家庭中的位置)
  • 家庭设备列表
  • 能源事件状态( 能源高峰时间
  • 离开状态
  • 用户预计到达时间
  • 安全状态
  • 邮递区号

单独的,更详细的API指南涵盖了一些结构级功能:

结构权限

访问... 选择...
structures对象中的大多数数据值 离开ETA能源邮政编码权限
structures对象中的name数据值 结构读/写权限

请参阅《 交互式API参考》中的权限工作原理。

结构标识符

名称

结构的名称默认为“ Home”,但可以是用户选择的任何字符串。选择结构读/写权限时,可以更改结构name

哪里

wheres是在结构上设置的对象,其中包含where标识符( where_idname )。使用wheres创建自定义的where名称,或访问标准的where名称。

要访问wheres对象,需要具有CameraSmoke + CO AlarmThermostat权限。

where_id

  • 由Nest生成的唯一标识符,代表name
  • where_id是只读的,并且会在调用中自动创建以创建自定义where name

name

  • 设备的显示名称;可以是我们提供的列表中的任何房间名称,也可以是自定义名称
  • 要创建一个自定义的where name ,请进行POST调用以编写一个新的自定义的where namewhere_id中返回where_id
  • 注意事项
    • 创建后无法编辑或删除name
    • name在结构中必须唯一
    • 如果设备与结构配对,则可以从/structures/路径访问与设备关联的name的自定义位置
    • 要将具有自定义name的设备移动到其他结构,请取消配对该设备,然后将其与所需名称重新配对

详细了解Nest ThermostatsNest ProtectsNest Cams的名称

其他元数据

除非另有说明,否则所有数据值都是只读的。

资料值描述
structure_id 唯一表示此结构的字符串。每个开发人员对于同一结构将看到不同的ID,但是同一开发人员的多个产品将看到相同的ID
country_code 映射到结构的注册位置的ISO 3166-1 alpha-2国家/地区代码
postal_code 邮递区号,取决于国家
time_zone 映射到结构时区的IANA时区字符串

结构特点

烟雾和一氧化碳报警状态

当选择Smoke + CO读取权限时 ,可以在structures对象中访问smoke_alarm_stateco_alarm_state 。这些相同的数据值在设备对象( devices/smoke_co_alarms )中也可用。

有关这些状态的更多信息,请参见Smoke + CO警报指南

许多数据值一起确定设备在结构中的行为。

  • 当结构away状态设置为away时,Nest Thermostat上会以用户首选的语言显示“ ECO”一词
  • 将结构away状态设置为away ,您可以:
    • 设置fan_timer_active
    • 更改target_temperature_ftarget_temperature_c
  • 当结构away状态设置为home ,您可以:
    • 拨打ETA电话(设置行程ID和到达窗口)
  • 紧急关闭处于活动状态时,无法设置fan_timer_active
  • 启用紧急加热后 ,您将无法将结构设置为away

多种结构

用户的Nest帐户可能附加了多个结构,因此您的产品应为用户提供一种从可用结构中进行选择的方法(结构选择器)。

结构选择器

例如,设置ETA时,用户能够为ETA目的地选择结构很重要。以类似的方式,用户可以在两个不同房屋的“客厅”中具有两个烟雾探测器。如果您需要使用自己的房屋概念进行结构关联,建议您在授权过程中进行。

了解用户如何以多种结构管理设备

设备最大值

一个结构中Nest支持的设备数量是有限的。

设备类型每个结构最大
巢式恒温器 20
巢式相机 10
巢穴保护 18

错误讯息

有关什么是API调用错误的含义以及如何处理错误的信息 ,请参见错误消息