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

Struktura

Struktury

Struktury gniazdowe reprezentują struktury fizyczne w świecie rzeczywistym. Zazwyczaj w domu użytkownika służą one jako punkt organizacyjny dla urządzeń i przechowują dane dotyczące całego domu.

Nest API umożliwia dostęp do następujących danych struktura szczebla, zależnych od poziomu uprawnień udzielonych:

  • Nazwa struktury i nazwa urządzenia „gdzie” (lokalizacja w domu)
  • Lista urządzeń w domu
  • Status zdarzenia energii ( energia Rush Hour )
  • Stan na wyjeździe
  • ETA użytkownika
  • Stan bezpieczeństwa
  • Kod pocztowy lub pocztowy

Niektóre funkcje na poziomie struktury są opisane w osobnych, bardziej szczegółowych przewodnikach po interfejsach API:

Uprawnienia do struktury

Aby uzyskać dostęp do... Wybierz...
Większość wartości danych w structures obiektu Odległość , ETA , energetyczne , lub kod pocztowy uprawnienia
name wartość danych w structures obiektu Struktura odczytu / zapisu pozwolenie

Zobacz, jak działają uprawnienia w interaktywnej API Reference .

Identyfikatory struktury

Nazwa

Domyślna nazwa struktury to „Home”, ale może to być dowolny ciąg znaków wybrany przez użytkownika. Po wybraniu opcji Struktura odczytu / zapisu pozwolenie, można zmienić strukturę name .

Gdzie

wheres to zbiór obiektów na strukturę zawierającą gdzie identyfikatory ( where_id i name ). Zastosowanie wheres tworzyć niestandardowe gdzie nazwy lub standardowy dostęp gdzie nazwy.

Dostęp do wheres obiektu wymaga aparatu , dym + CO Alarm lub Termostat uprawnienia.

where_id

  • Wyjątkowy, Gniazdo wygenerowany identyfikator, który reprezentuje name
  • where_id , jest tylko do odczytu i jest tworzony automatycznie w zaproszeniu do tworzenia niestandardowych ustawień, gdzie name

name

  • Wyświetlana nazwa urządzenia; może to być dowolna nazwa pokoju z podanej przez nas listy lub nazwa niestandardowa
  • Aby utworzyć niestandardowy gdzie name , nawiązać połączenie POST napisać nowy zwyczaj, gdzie name ; where_id jest zwracana w wezwaniu
  • Rozważania
    • name nie może być edytowane lub usuwane po utworzeniu
    • name musi być unikatowa w obrębie struktury
    • Jeśli urządzenie jest połączone z konstrukcją, zwyczaj, gdzie name związana z urządzeniem dostępnym z /structures/ ścieżki
    • Aby przejść do urządzenia z niestandardowym gdzie name do innej struktury, rozłączyć urządzenia, a następnie ponownie powiązać je z danej nazwy

Więcej informacji na temat nazw Termostaty Nest ,Gniazdo Chroni i Nest kamery internetowe .

Inne metadane

Wszystkie wartości danych są tylko do odczytu, chyba że określono inaczej.

Wartość danych Opis
structure_id Ciąg, który jednoznacznie reprezentuje tę strukturę. Każdy programista zobaczy inny identyfikator dla tej samej struktury, ale wiele produktów tego samego programisty zobaczy ten sam identyfikator
country_code Kod kraju ISO 3166-1 alfa-2, który mapuje do zarejestrowanej lokalizacji konstrukcji location
postal_code Kod pocztowy lub pocztowy, w zależności od kraju
time_zone IANA strefa czasowa ciąg, który mapuje do strefy czasowej konstrukcji w

Cechy struktury

Stany alarmowe dotyczące dymu i tlenku węgla

Gdy wybierzesz Smoke + CO uprawnienia do odczytu , można uzyskać dostęp smoke_alarm_state i co_alarm_state w structures obiektu. Te same wartości dostępnych danych w obiekcie (urządzenia są również devices/smoke_co_alarms ).

Zobacz Smoke + przewodnika alarmu CO uzyskać więcej informacji na temat tych stanów.

Wiele wartości danych współpracuje ze sobą, aby określić, jak urządzenia zachowują się w strukturze.

  • Gdy struktura away stan jest ustawiony away słowo „ECO” jest wyświetlany na gniazdo termostatu, w preferowanym języku użytkownika
  • Gdy struktura away stan jest ustawiony away , można:
    • zestaw fan_timer_active
    • Zmiana target_temperature_f lub target_temperature_c
  • Gdy struktura away stan jest ustawiony do home , możesz:
    • zadzwoń ETA (ustaw identyfikator podróży i okno przyjazdu)
  • Podczas awaryjnego odcinający jest aktywny, nie można ustawić fan_timer_active
  • Podczas awaryjnego ciepła jest włączona, nie można można ustawić strukturę away

Wiele struktur

Możliwe, że użytkownik ma więcej niż jedną strukturę dołączoną do swojego konta Nest, więc Twój produkt powinien oferować użytkownikowi możliwość wyboru spośród dostępnych struktur (selektor struktur).

Selektor struktury

Na przykład podczas ustawiania ETA ważne jest, aby użytkownik mógł wybrać strukturę dla miejsca docelowego ETA. W podobny sposób użytkownik może mieć dwie czujki dymu w „salonie” dwóch różnych domów. Jeśli potrzebujesz dokonać korelacji struktury z własną koncepcją domu, zalecamy to zrobić podczas procesu autoryzacji.

Dowiedz się, jak użytkownicy zarządzania urządzeniami w wielu konstrukcjach .

Maksymalne wartości urządzenia

Liczba urządzeń obsługiwanych przez Nest w strukturze jest ograniczona.

Rodzaj urządzenia Maks. na strukturę
Gniazdo termostatu 20
Kamery gniazdowe 10
Ochrona gniazda 18

Komunikaty o błędach

Aby uzyskać informacje o tym, co znaczy błędy wywołania API i jak sobie z nimi radzić, patrz Komunikaty o błędach .