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

Structure

Structures

Les structures de nids représentent des structures physiques dans le monde réel. Généralement la maison d'un utilisateur, ils servent de point d'organisation pour les appareils et stockeront des données qui s'appliquent à toute la maison.

L' API Nest permet d' accéder aux données de structure au niveau suivant, en fonction du niveau des autorisations accordées:

  • Nom de la structure et appareil "où nom" (emplacement dans la maison)
  • La liste des appareils de la maison
  • État de l' événement énergie ( heure de pointe d'énergie )
  • État d'absence
  • ETA utilisateur
  • État de sécurité
  • Code postal ou zip

Certaines fonctionnalités au niveau de la structure sont couvertes dans des guides API distincts et plus détaillés :

Autorisations de structure

Pour accéder à... Sélectionner...
La plupart des valeurs de données dans les structures objet Bilan à l' extérieur , l' ETA , l' énergie , ou Code postal autorisations
Le name valeur de données dans la structures objet Structure lecture / écriture permission

Voyez comment fonctionnent les autorisations dans l' API interactive de référence .

Identifiants de structure

Nom

Le nom de la structure par défaut est "Home" mais peut être n'importe quelle chaîne choisie par l'utilisateur. Lorsque vous choisissez Structure lecture / écriture permission, vous pouvez modifier la structure name .

wheres est un ensemble d'objets sur une structure, contenant où les identificateurs ( where_id et name ). Utilisez wheres pour créer sur mesure où les noms, ou à une norme d'accès où les noms.

L' accès au wheres objet nécessite caméra , fumée + CO Alarme ou thermostat autorisations.

where_id

  • Un identificateur unique, généré Nest qui représente le name
  • where_id est en lecture seule, et est automatiquement créé dans l'appel pour créer une coutume où le name

name

  • Le nom d'affichage de l'appareil ; peut être n'importe quel nom de pièce d'une liste que nous fournissons, ou un nom personnalisé
  • Pour créer une où le name , faire un appel POST pour écrire une nouvelle mesure où le name ; le where_id est retourné dans l'appel
  • Considérations
    • le name ne peut pas être modifié ou supprimé après la création
    • le name doit être unique dans la structure
    • Si un appareil est couplé à une structure, la coutume où le name associé au dispositif est accessible à partir de la /structures/ chemin
    • Pour déplacer un appareil avec une coutume où le name d'une autre structure, Dissocier l'appareil, puis re paire l'appareil avec le nom souhaité

En savoir plus sur les noms pour Nest Thermostats ,Nest Protège et Nest en direct .

Autres métadonnées

Toutes les valeurs de données sont en lecture seule, sauf indication contraire.

Valeur des données La description
structure_id Une chaîne qui représente de manière unique cette structure. Chaque développeur verra un identifiant différent pour la même structure, mais plusieurs produits du même développeur verront le même identifiant
country_code Un code de pays ISO 3166-1 alpha-2 qui correspond à l'emplacement enregistré de la structure
postal_code Code postal ou zip, selon le pays
time_zone Une zone de temps IANA chaîne qui correspond à temps de la structure de la zone

Caractéristiques structurelles

États des alarmes de fumée et de CO

Lorsque vous choisissez la fumée + CO permission de smoke_alarm_state co_alarm_state structures lecture , vous pouvez accéder smoke_alarm_state et co_alarm_state dans les structures objet. Ces mêmes valeurs de données sont également disponibles dans l'objet de dispositif ( devices/smoke_co_alarms ).

Voir la fumée + guide d'alarme CO pour plus d' informations sur ces états.

De nombreuses valeurs de données fonctionnent ensemble pour déterminer le comportement des périphériques dans une structure.

  • Quand une structure de away l' état est mis à l' away le mot « ECO » est affiché sur le thermostat Nest, dans la langue de l'utilisateur
  • Quand une structure de away l' état est mis à l' away , vous pouvez:
    • ensemble fan_timer_active
    • changement target_temperature_f ou target_temperature_c
  • Quand une structure de away l' état est mis à la home , vous pouvez:
    • passer un appel ETA (définir l'identifiant du trajet et la fenêtre d'arrivée)
  • Lorsque d' urgence d' fan_timer_active arrêt est actif, vous ne pouvez pas définir fan_timer_active
  • Lorsque la chaleur d' away urgence est activée, vous pouvez ne pouvez pas définir la structure à l' away

Structures multiples

Il est possible qu'un utilisateur ait plusieurs structures associées à son compte Nest. Votre produit doit donc offrir à l'utilisateur un moyen de choisir parmi les structures disponibles (un sélecteur de structure).

Sélecteur de structure

Par exemple, lors de la configuration de l'ETA, il est important que l'utilisateur puisse choisir une structure pour la destination ETA. De manière similaire, un utilisateur pourrait disposer de deux détecteurs de fumée dans le "salon" de deux maisons différentes. Si vous devez faire une corrélation de structure avec votre propre concept de maison, nous vous recommandons de le faire pendant le processus d'autorisation.

Découvrez comment les utilisateurs à gérer les périphériques dans plusieurs structures .

Nombre maximal d'appareils

Le nombre d'appareils pris en charge par Nest dans une structure est limité.

Type d'appareil Max par structure
Thermostat Nest 20
Caméras Nest dix
Nest Protect 18

Messages d'erreur

Pour plus d' informations sur ce que les erreurs d'appel de l' API signifient et comment les gérer, voir les messages d'erreur .