Estructura

Las estructuras de nidos representan estructuras físicas en el mundo real. Por lo general, la casa de un usuario, sirven como un punto de organización para los dispositivos y almacenarán datos que se aplican a toda la casa.

La API de Nest proporciona acceso a los siguientes datos a nivel de estructura, según el nivel de permisos concedidos:

Nombre de estructura y dispositivo "donde nombre" (ubicación en la casa)
La lista de dispositivos en el hogar.
Estado del evento energético ( hora punta de energía )
Estado ausente
ETA del usuario
Estado de seguridad
codigo postal

Algunas características de nivel de estructura se tratan en guías API independientes y más detalladas:

Ausente y ETA : estado Ausente, ETA del usuario
Energía : estado del evento de energía
Seguridad: seguridad y disuasión

Permisos de estructura

Para acceder a ...	Seleccione...
La mayoría de los valores de datos en el objeto de `structures`	Permisos de visitante , ETA , energía o código postal
El valor de los datos de `name` en el objeto de `structures`	Estructura de permiso de lectura / escritura

Vea cómo funcionan los permisos en la Referencia de API interactiva .

Identificadores de estructura

Nombre

El nombre de la estructura por defecto es "Inicio" pero puede ser cualquier cadena que elija el usuario. Cuando elige el permiso de lectura / escritura de estructura , puede cambiar el name la estructura.

Donde

wheres es un conjunto de objetos en una estructura, que contiene identificadores where_id ( where_id y name ). Utilice wheres para crear nombres personalizados donde, o acceda a nombres estándar.

El acceso al objeto wheres requiere permisos de cámara , alarma de humo + CO o termostato .

`where_id`

Un identificador único generado por Nest que representa el name
where_id es de solo lectura y se crea automáticamente en la llamada para crear un name where personalizado

`name`

El nombre para mostrar del dispositivo; puede ser cualquier nombre de habitación de una lista que proporcionamos o un nombre personalizado
Para crear un name personalizado, realice una llamada POST para escribir un nuevo name personalizado; el where_id se devuelve en la llamada
Consideraciones
- name no se puede editar ni eliminar después de su creación
- name debe ser único dentro de la estructura
- Si un dispositivo está emparejado con una estructura, se puede acceder al name personalizado asociado con el dispositivo desde la ruta /structures/
- Para mover un dispositivo con un name personalizado donde a una estructura diferente, desempareje el dispositivo y luego vuelva a emparejar el dispositivo con el nombre deseado

Obtén más información sobre los nombres de termostatos Nest ,Nest Protects y Nest Cams .

Otros metadatos

Todos los valores de datos son de solo lectura, a menos que se especifique lo contrario.

Valor de los datos	Descripción
`structure_id`	Una cadena que representa de forma única esta estructura. Cada desarrollador verá un ID diferente para la misma estructura, pero varios productos del mismo desarrollador verán el mismo ID
`country_code`	Un código de país ISO 3166-1 alpha-2 que se asigna a la ubicación registrada de la estructura.
`postal_code`	Código postal o postal, según el país
`time_zone`	Una cadena de zona horaria de IANA que se asigna a la zona horaria de la estructura

Características de la estructura

Estados de alarma de humo y CO

Cuando elige el permiso de lectura Smoke + CO , puede acceder a smoke_alarm_state y co_alarm_state en el objeto de structures . Estos mismos valores de datos también están disponibles en el objeto de dispositivo ( devices/smoke_co_alarms ).

Consulte la guía de alarmas de humo + CO para obtener más información sobre estos estados.

Restricciones relacionadas con la estructura

Muchos valores de datos trabajan juntos para determinar cómo se comportan los dispositivos en una estructura.

Cuando un estado de estructura away está configurado como away la palabra "ECO" se muestra en el termostato Nest, en el idioma preferido del usuario.
Cuando un estado de estructura away se establece en away , puede:
- establecer fan_timer_active
- cambiar target_temperature_f o target_temperature_c
Cuando un estado de estructura away se establece en home , puede:
- hacer una llamada ETA (establecer identificación de viaje y ventana de llegada)
Cuando el apagado de emergencia está activo, no puede configurar fan_timer_active
Cuando la calefacción de emergencia está activado, no se puede puede establecer la estructura a away

Varias estructuras

Es posible que un usuario tenga más de una estructura adjunta a su cuenta de Nest, por lo que su producto debe ofrecer un medio para que el usuario elija entre las estructuras disponibles (un selector de estructuras).

Por ejemplo, al configurar ETA, es importante que el usuario pueda elegir una estructura para el destino ETA. De manera similar, un usuario podría tener dos detectores de humo en la "sala de estar" de dos casas diferentes. Si necesita hacer una correlación de estructura con su propio concepto de vivienda, le recomendamos que lo haga durante el proceso de autorización.

Aprenda cómo los usuarios administran dispositivos en múltiples estructuras .

Máximos de dispositivo

Hay límites en la cantidad de dispositivos que admite Nest en una estructura.

Tipo de dispositivo	Max por estructura
Termostato Nest	20
Cámaras Nest	10
Nest Protect	18

Error de mensajes

Para obtener información sobre qué significan los errores de llamada a la API y cómo manejarlos, consulte Mensajes de error .