Notice: We're retiring Works with Nest. See the home page for more information.
Google is committed to advancing racial equity for Black communities. See how.
Эта страница была переведа с помощью Cloud Translation API.
Switch to English

Структура

сооружения

Гнездовые структуры представляют физические структуры в реальном мире. Как правило, дома пользователя, они служат точкой организации для устройств и будут хранить данные, которые относятся ко всему дому.

Nest API предоставляет доступ к следующим данным структурного уровня в зависимости от уровня предоставленных разрешений:

  • Структура имени и устройства «где имя» (местоположение в доме)
  • Список устройств в доме
  • Статус энергетического события ( час пик энергии )
  • В гостях
  • Пользователь ETA
  • Состояние безопасности
  • Почтовый или почтовый индекс

Некоторые функции уровня структуры описаны в отдельных, более подробных руководствах по API:

Структура разрешений

Для доступа к ... Выбрать...
Большинство значений данных в объекте structures Разрешения на выезд , ETA , энергию или почтовый индекс
name значения данных в объекте structures Структура разрешения на чтение / запись

Посмотрите, как работают разрешения в интерактивном справочнике по API .

Структурные идентификаторы

название

Имя структуры по умолчанию - «Домой», но может быть любой строкой, которую выберет пользователь. Когда вы выбираете разрешение на чтение / запись структуры , вы можете изменить name структуры.

Wheres

wheres - это объект, установленный в структуре, содержащий идентификаторы where_id ( where_id и name ). Используйте wheres для создания пользовательских, где имена, или доступ к стандартным, где имена.

Доступ к объекту wheres требует наличия wheres Камера» , « Дым + СО» или « Термостат» .

where_id

  • Уникальный сгенерированный гнездом идентификатор, представляющий name
  • where_id только для чтения и создается автоматически при вызове для создания пользовательского name где

name

  • Отображаемое имя устройства; может быть любым именем комнаты из списка, который мы предоставляем, или произвольным именем
  • Чтобы создать пользовательское name где», сделайте вызов POST, чтобы написать новое пользовательское name где»; where_id возвращается в вызове
  • Соображения
    • name не может быть отредактировано или удалено после создания
    • name должно быть уникальным в структуре
    • Если устройство сопряжено со структурой, то name связанное с устройством, доступно из /structures/ пути
    • Чтобы переместить устройство с пользовательским name в другую структуру, отсоедините устройство, а затем повторно сопоставьте устройство с нужным именем.

Узнайте больше о названиях для Nest Thermostats , Nest Protects и Nest Cams .

Другие метаданные

Все значения данных доступны только для чтения, если не указано иное.

Значение данных Описание
structure_id Строка, которая уникально представляет эту структуру. Каждый разработчик увидит разные идентификаторы для одной и той же структуры, но несколько продуктов от одного разработчика увидят один и тот же идентификатор
country_code Код страны ISO 3166-1 alpha-2, который сопоставляется с зарегистрированным местоположением сооружения
postal_code Почтовый или почтовый индекс, в зависимости от страны
time_zone Строка часового пояса IANA, которая отображается на часовой пояс структуры

Особенности структуры

Состояния тревоги дыма и CO

Когда вы выбираете разрешение чтения Smoke + CO , вы можете получить доступ к smoke_alarm_state и co_alarm_state в объекте structures . Эти же значения данных также доступны в объекте devices/smoke_co_alarms ( devices/smoke_co_alarms ).

См. Руководство по сигнализации Smoke + CO для получения дополнительной информации об этих состояниях.

Многие значения данных работают вместе, чтобы определить, как устройства ведут себя в структуре.

  • Когда структура away состояние устанавливается в away слово «ECO» отображается на гнездо термостата, в предпочтительном языке пользователя
  • Когда структура away состояние устанавливается в away , вы можете:
    • установить fan_timer_active
    • изменить target_temperature_f или target_temperature_c
  • Когда структура away состояние устанавливается в home , вы можете:
    • совершить ETA вызов (установить идентификатор поездки и окно прибытия)
  • Когда аварийное отключение активно, вы не можете установить fan_timer_active
  • Когда Аварийное отопление включено, вы не можете установить структуру away

Несколько структур

Возможно, что пользователь имеет более одной структуры, присоединенной к своей учетной записи Nest, поэтому ваш продукт должен предлагать пользователю средство выбора из доступных структур (средство выбора структуры).

Подборщик структуры

Например, при настройке ETA важно, чтобы пользователь мог выбрать структуру для пункта назначения ETA. Аналогичным образом пользователь может иметь два детектора дыма в «гостиной» двух разных домов. Если вам нужно сделать структурную корреляцию с вашей собственной концепцией дома, мы рекомендуем вам сделать это во время процесса авторизации.

Узнайте, как пользователи управляют устройствами в нескольких структурах .

Максимумы устройства

Существуют ограничения на количество устройств, поддерживаемых Nest в структуре.

Тип устройства Макс на структуру
Гнездо Термостат 20
Гнездо камеры 10
Гнездо Защитить 18

Сообщения об ошибках

Для получения информации о том, что означают ошибки вызова API и как их обрабатывать, см. Сообщения об ошибках .