Google 致力于为黑人社区推动种族平等。查看具体举措

结构

结构

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

巢API提供访问以下结构级数据,依赖于权限授予的水平:

  • 结构名称和设备“where name”(在家中的位置)
  • 家里的设备清单
  • 能源事件状态(能源高峰时段
  • 离开状态
  • 用户预计到达时间
  • 安全状态
  • 邮政编码

一些结构级功能在单独的、更详细的 API 指南中介绍:

结构权限

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

见权限中是如何工作的互动API参考

结构标识符

名称

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

哪里

wheres是在结构上的对象组,其中含有标识符( where_idname )。使用wheres创建自定义,这里的名字,或准入标准,这里的名字。

访问wheres对象需要相机烟雾和一氧化碳警报器,或恒温器的权限。

where_id

  • 代表一个唯一的,巢生成的标识符name
  • where_id是只读的,并在通话中自动创建创建自定义的地方name

name

  • 设备的显示名称;可以是我们提供的列表中的任何房间名称,也可以是自定义名称
  • 要创建一个自定义的地方name ,做一个POST调用写一个新的,定制的,其中name ;该where_id在调用返回
  • 注意事项
    • name不能被编辑或创建后删除
    • name必须是结构中是唯一的
    • 如果设备配对的结构,其中,所述自定义name与所述设备相关联的是从可访问/structures/路径
    • 要移动设备与自定义,其中name为不同的结构,取消配对的设备,然后重新配对的设备与期望的名称

了解更多关于名称 鸟巢恒温器巢保护巢凸轮

其他元数据

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

数据值描述
structure_id唯一表示此结构的字符串。每个开发者会看到相同结构的不同 ID,但同一开发者的多个产品会看到相同的 ID
country_code映射到结构注册位置的 ISO 3166-1 alpha-2 国家/地区代码
postal_code邮政编码或邮政编码,取决于国家/地区
time_zone一个IANA时区映射到结构的时区字符串

结构特点

烟雾和一氧化碳警报状态

当您选择了烟雾和一氧化碳读取权限,您可以访问smoke_alarm_stateco_alarm_statestructures对象。这些相同的数据值,可以在所述设备的对象(可用devices/smoke_co_alarms )。

看到烟雾+ CO警报器导向关于这些状态的更多信息。

许多数据值共同确定设备在结构中的行为方式。

  • 当一个结构away状态被设置为away显示在巢恒温单词“ECO”,在用户的偏好语言
  • 当结构away状态设置为away ,您可以:
    • fan_timer_active
    • 变化target_temperature_ftarget_temperature_c
  • 当结构away状态设置为home ,您可以:
    • 拨打 ETA 电话(设置行程 ID 和到达窗口)
  • 紧急切断处于活动状态,你不能设置fan_timer_active
  • 急热启动,你不能可以设置结构, away

多重结构

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

结构选择器

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

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

设备最大值

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

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

错误信息

对于哪些API调用错误的含义及如何处理这些信息,请参阅错误信息