Estructura

Las estructuras de Nest representan estructuras físicas en el mundo real. Por lo general, es la casa de un usuario y sirve como punto de partida para los dispositivos. Además, almacenará datos que se aplican a toda la casa.

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

• Nombre de la estructura y nombre del dispositivo (ubicación del hogar)
• La lista de dispositivos de la casa
• Estado del evento de energía (hora pico de energía)
• Estado Ausente
• Llegada del usuario
• Estado de seguridad
• Código postal

Algunas funciones a nivel de estructura se abordan en guías de API independientes y más detalladas:

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

Permisos de estructura

Para acceder a...	Selecciona…
La mayoría de los valores de datos del objeto structures	Permisos Ausente, ETA, Energía o Código postal
El valor de datos name en el objeto structures	Permiso de estructura y lectura de estructura

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

Identificadores de la estructura

Nombre

El nombre predeterminado de la estructura es "Home", pero puede ser cualquier string que elija el usuario. Cuando eliges el permiso Estructura de lectura y escritura, puedes cambiar la estructura name.

Dónde

wheres es un objeto configurado en una estructura que contiene los identificadores (where_id y name). Usa wheres para crear nombres personalizados de nombres o acceder a esos nombres estándar.

Para acceder al objeto wheres, se requieren los permisos Cámara, Alarma de humo + CO o Termostato.

where_id

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

name

• El nombre visible del dispositivo; puede ser cualquier nombre de habitación de una lista que proporcionamos, o bien un nombre personalizado
• A fin de crear un elemento personalizado en el que name, realiza una llamada POST para escribir una nueva, personalizada en la que name; el where_id se muestra en la llamada.
• Consideraciones
  • No se puede editar ni borrar name
  • name debe ser único dentro de la estructura.
  • Si un dispositivo está vinculado a una estructura, es personalizado en el que se puede acceder a name asociado con el dispositivo desde la ruta de acceso /structures/.
  • Para mover un dispositivo con un elemento personalizado donde name a una estructura diferente, desvincula el dispositivo y vuelve a vincularlo con el nombre deseado.

Obtén más información sobre los nombres de los termostatos Nest, los Nest Protect y las 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	Es una string 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 alfa-2 que se asigna a la ubicación registrada de la estructura
postal_code	Código postal, según el país
time_zone	Una string de zona horaria de IANA que se asigna a la zona horaria de la estructura

Características de estructura

Estados de las alarmas de humo y monóxido de carbono

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

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

Restricciones relacionadas con la estructura

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

• Cuando el estado away de la estructura se establece en away, se muestra la palabra "ECO" en el Nest Thermostat, en el idioma preferido del usuario.
• Cuando un estado away de estructura se establece en away, puedes hacer lo siguiente:
  • Configurar fan_timer_active
  • cambiar target_temperature_f o target_temperature_c
• Cuando un estado away de estructura se establece en home, puedes hacer lo siguiente:
  • hacer una llamada de ETA (establecer ID de viaje y período de llegada)
• Cuando el Corte de emergencia está activo, no puedes configurar fan_timer_active.
• Cuando la función Calefactor de emergencia está habilitada, no puedes establecer la estructura en away

Varias estructuras

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

Por ejemplo, al configurar la hora de llegada, es importante que el usuario pueda elegir una estructura para el destino de hora de llegada. De manera similar, un usuario puede tener dos detectores de humo en la sala de estar de dos casas diferentes. Si necesitas hacer una correlación de estructuras con tu propio concepto de casa, te recomendamos que lo hagas durante el proceso de autorización.

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

Máximas de dispositivos

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

Tipo de dispositivo	Máx. por estructura
Nest Thermostat	20
Cámaras Nest	10
Nest Protect	18

Mensajes de error

Para obtener información sobre el significado de los errores de llamada a la API y cómo manejarlos, consulta Mensajes de error.