Google is committed to advancing racial equity for Black communities. See how.

Состав

Структуры

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

Гнездо API , обеспечивает доступ к следующим данным Структуры уровня, в зависимости от уровня разрешений , предоставленный:

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

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

Разрешения на структуру

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

Посмотрите , как права работать в интерактивном API Reference .

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

Имя

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

Где

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

Доступ к wheres объекту требует камер , дым + CO сигнализации или Термостат разрешения.

where_id

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

name

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

Подробнее об именах для 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 чтение , вы можете получить доступ к smoke_alarm_state и co_alarm_state в structures объекта. Эти же значения данных также доступны в устройстве объекта ( devices/smoke_co_alarms ).

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

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

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

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

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

Средство выбора структуры

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

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

Максимальные параметры устройства

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

Тип устройства Макс на структуру
Термостат Nest 20
Гнездо Камеры 10
Nest Protect 18

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

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