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

Struktur

Strukturen

Neststrukturen repräsentieren physikalische Strukturen in der realen Welt. In der Regel das Zuhause eines Benutzers, dienen sie als Organisationspunkt für Geräte und speichern Daten, die für das gesamte Zuhause gelten.

Das Nest API bietet Zugriff auf die folgenden Aufbau-Level - Daten, abhängig von der Höhe der Berechtigungen erteilt:

  • Strukturname und Gerät "wo name" (Ort in der Wohnung)
  • Die Liste der Geräte im Haus
  • Energieereignisstatus ( Energie rush hour )
  • Auswärtsstatus
  • ETA des Benutzers
  • Sicherheitsstatus
  • Postleitzahl oder Postleitzahl

Einige Funktionen auf Strukturebene werden in separaten, detaillierteren API-Anleitungen behandelt:

Berechtigungen strukturieren

Für den Zugang zu... Wählen...
Die meisten Datenwerte in den structures Objekt Weg , ETA , Energie oder Postleitzahl Berechtigungen
Der name Datenwert in den structures Objekt Struktur Lese- / Schreibberechtigung

Sehen Sie, wie Berechtigungen in der Arbeit interaktive API - Referenz .

Strukturkennzeichen

Name

Der Name der Struktur lautet standardmäßig "Home", kann jedoch eine beliebige Zeichenfolge sein, die der Benutzer wählt. Wenn Sie wählen Struktur Lese- / Schreibberechtigung, können Sie die Struktur ändern name .

Wo ist

wheres ist ein Objektsatz auf einer Struktur, enthält , wobei Kennungen ( where_id und name ). Verwenden wheres benutzerdefinierten wo Namen zu erhalten , oder den Zugang Standard , in dem Namen.

Der Zugriff auf das wheres Objekt erfordert Kamera , Rauch + CO Alarm oder Thermostat - Berechtigungen.

where_id

  • Ein einzigartiger, Nest-generierten Identifikator, der darstellt , name
  • where_id ist schreibgeschützt und wird automatisch in dem Aufruf erstellt , um eine benutzerdefinierte zu erstellen , in dem name

name

  • Der Anzeigename des Geräts; kann ein beliebiger Raumname aus einer von uns bereitgestellten Liste oder ein benutzerdefinierter Name sein
  • Um eine benutzerdefinierte zu erstellen , in dem name , ein POST Anruf eine neue, kundenspezifische , wo zu schreiben name ; die where_id wird in dem Aufruf zurückgegeben
  • Überlegungen
    • name kann nach der Erstellung nicht bearbeitet oder gelöscht werden
    • name muss innerhalb der Struktur eindeutig sein
    • Wenn ein Gerät mit einer Struktur gekoppelt ist, die benutzerdefinierte wo name mit dem Gerät zugeordnet ist, von der zugänglich ist /structures/ Weg
    • Um ein Gerät mit einem benutzerdefinierten zu bewegen , wo name in eine anderen Struktur, unpair das Gerät, und dann erneut paaren , die Vorrichtung mit dem gewünschten Namen

Weitere Informationen über Namen für Nest Thermostate , Nest schützt und Nest Cams .

Andere Metadaten

Alle Datenwerte sind schreibgeschützt, sofern nicht anders angegeben.

Datenwert Beschreibung
structure_id Eine Zeichenfolge, die diese Struktur eindeutig darstellt. Jeder Entwickler sieht eine andere ID für dieselbe Struktur, aber mehrere Produkte desselben Entwicklers sehen dieselbe ID
country_code Ein ISO 3166-1 Alpha-2-Ländercode, der dem registrierten Standort der Struktur zugeordnet ist
postal_code Postleitzahl oder Postleitzahl, je nach Land
time_zone Ein IANA Zeitzone Zeichenfolge, die die Struktur der Zeitzone abbildet

Strukturmerkmale

Rauch- und CO-Alarmzustände

Wenn Sie wählen Smoke + CO Leseberechtigung , können Sie Zugriff auf smoke_alarm_state und co_alarm_state in den structures Objekt. Diese gleichen Datenwerte sind auch in dem Geräteobjekt ( devices/smoke_co_alarms ).

Siehe den Rauch + CO - Alarm Führung für weitere Informationen zu diesen Staaten.

Viele Datenwerte wirken zusammen, um zu bestimmen, wie sich Geräte in einer Struktur verhalten.

  • Wenn eine Struktur away Zustand gesetzt ist away das Wort „ECO“ auf dem Nest angezeigt Thermostat, in der bevorzugten Sprache des Benutzers
  • Wenn eine Struktur away Zustand gesetzt ist away , können Sie:
    • Set fan_timer_active
    • Änderung target_temperature_f oder target_temperature_c
  • Wenn eine Struktur away Zustand gesetzt zu home , können Sie:
    • einen ETA-Anruf tätigen (Reise-ID und Ankunftsfenster einstellen)
  • Wenn Notabschaltung aktiv ist, können Sie nicht gesetzt fan_timer_active
  • Wenn Not - away Wärme aktiviert ist, können Sie nicht Struktur setzen away

Mehrere Strukturen

Es ist möglich, dass ein Nutzer mehr als eine Struktur mit seinem Nest-Konto verknüpft hat. Daher sollte Ihr Produkt dem Nutzer die Möglichkeit bieten, aus den verfügbaren Strukturen auszuwählen (eine Strukturauswahl).

Strukturauswahl

Beim Festlegen der ETA ist es beispielsweise wichtig, dass der Benutzer eine Struktur für das ETA-Ziel auswählen kann. Auf ähnliche Weise könnte ein Benutzer zwei Rauchmelder im "Wohnzimmer" von zwei verschiedenen Häusern haben. Wenn Sie eine Strukturkorrelation mit Ihrem eigenen Wohnkonzept durchführen müssen, empfehlen wir Ihnen, dies während des Genehmigungsprozesses zu tun.

Erfahren Sie, wie Benutzer verwalten Geräte in mehreren Strukturen .

Gerätemaximum

Die Anzahl der Geräte, die Nest in einer Struktur unterstützt, ist begrenzt.

Gerätetyp Max pro Struktur
Nest-Thermostat 20
Nest-Kameras 10
Nest Protect 18

Fehlermeldungen

Für Informationen darüber , was API - Aufruf Fehler bedeuten und wie sie zu behandeln, siehe Fehlermeldungen .