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.
Cette page a été traduite par l'API Cloud Translation.
Switch to English

Structure

Structures

Les structures de nid 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 stockent des données qui s'appliquent à toute la maison.

L' API Nest permet d'accéder aux données de niveau structure suivantes, en fonction du niveau d'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 énergétique ( heure de pointe de l'énergie )
  • État absent
  • 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 l'objet structures Autorisations d' absence , d' ETA , d' énergie ou de code postal
La valeur de données de name dans l'objet structures Structure des droits de lecture / écriture

Découvrez le fonctionnement des autorisations dans la référence API interactive .

Identificateurs 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 l'autorisation de lecture / écriture de la structure, vous pouvez modifier le name la structure.

wheres est un objet défini sur une structure, contenant des identificateurs where_id ( where_id et name ). Utilisez wheres pour créer des noms where personnalisés ou accédez à des noms where standard.

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

where_id

  • Un identifiant unique généré par Nest qui représente le name
  • where_id est en lecture seule et est créé automatiquement dans l'appel pour créer un name where personnalisé

name

  • Le nom d'affichage de l'appareil; peut être n'importe quel nom de salle dans une liste que nous fournissons, ou un nom personnalisé
  • Pour créer un name where personnalisé, effectuez un appel POST pour écrire un nouveau name where personnalisé; le where_id est retourné dans l'appel
  • Considérations
    • name ne peut pas être modifié ou supprimé après sa création
    • name doit être unique dans la structure
    • Si un périphérique est couplé à une structure, le name personnalisé où associé au périphérique est accessible à partir du chemin /structures/
    • Pour déplacer un appareil avec un name where personnalisé vers une structure différente, dissociez l'appareil, puis réappariez l'appareil avec le nom souhaité

En savoir plus sur les noms des thermostats Nest , des Nest Protect et des Nest Cam .

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 cette structure de manière unique. Chaque développeur verra un ID différent pour la même structure, mais plusieurs produits du même développeur verront le même ID
country_code Un code de pays ISO 3166-1 alpha-2 qui correspond à l'emplacement enregistré de la structure
postal_code Code postal ou postal, selon le pays
time_zone Une chaîne de fuseau horaire IANA qui correspond au fuseau horaire de la structure

Caractéristiques de la structure

États des alarmes de fumée et de CO

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

Consultez le guide des avertisseurs de fumée + 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.

  • Lorsqu'un état d' away structure est défini sur away le mot "ECO" s'affiche sur le thermostat Nest, dans la langue préférée de l'utilisateur
  • Lorsqu'un état d' away structure est défini sur away , vous pouvez:
    • définir fan_timer_active
    • changer target_temperature_f ou target_temperature_c
  • Lorsqu'un état d' away structure est défini sur home , vous pouvez:
    • faire un appel ETA (définir l'identifiant du trajet et la fenêtre d'arrivée)
  • Lorsque l' arrêt d'urgence 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 plus d'une structure attachée à 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 définition 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 avez besoin de 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èrent les appareils dans plusieurs structures .

Maximum 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 la signification des erreurs d'appel d'API et sur la manière de les gérer, consultez Messages d'erreur .