Użytkownicy mogą dodawać maksymalnie 3 struktury z wieloma urządzeniami na każdą strukturę.
Wszystkie poniższe wartości znajdują się poniżej każdego ciągu structures/structure_id
w dokumencie JSON.
struktura_id
Numer identyfikacyjny budynku. Gdy wywołujesz tę lokalizację danych, masz dostęp do wartości danych w tej strukturze.
Szczegóły | |
---|---|
https://developer-api.nest.com/structures/structure_id/structure_id |
|
Zwroty | string Przykład: "VqFabWH21nw..." |
Dostęp | tylko do odczytu |
Dostępne w | Odczyt termostatu / v1-v6 Odczyt termostatu/odczyt / v1-v6 Odczyt dymu i dwutlenku węgla / v1-v5 Odczyt w trybie / 1 |
termostatu
Lista termostatów w strukturze, według unikalnych identyfikatorów urządzeń. Jest to zestaw obiektów JSON zawierający wszystkie termostaty w strukturze.
Szczegóły | |
---|---|
https://developer-api.nest.com/structures/structure_id/thermostats |
|
Zwroty | array Przykład: [ "peyiJNo0IldT2YlIVtYaGQ",... ] |
Dostęp | tylko do odczytu |
Dostępne w | Odczyt termostatu / v1-v6 Odczyt/zapis termostatu / v1-v6 Odczyt dymu i tlenku węgla / v1-v5 Czytanie na zewnątrz / v1-v2 Zapisywanie/odczyt / 1 |
dymki_co_z
Lista alarmów z czujnikiem dymu i tlenku węgla w strukturze, według unikalnych identyfikatorów urządzeń. Jest to tablica obiektów JSON obejmująca wszystkie alarmy z czujnika dymu i tlenku węgla w strukturze.
Szczegóły | |
---|---|
https://developer-api.nest.com/structures/structure_id/smoke_co_alarms |
|
Zwroty | array Przykład: [ "RTMTKxsQTCxzVcsySOHPxKoF4OyCifrs",... ] |
Dostęp | tylko do odczytu |
Dostępne w | Odczyt termostatu / v1-v6 Odczyt/zapis termostatu / v1-v6 Odczyt dymu i tlenku węgla / v1-v5 Czytanie na zewnątrz / v1-v2 Zapisywanie/odczyt / 1 |
kamery
Lista kamer w strukturze według unikalnych identyfikatorów urządzeń. Jest to tablica obiektów JSON obejmująca wszystkie kamery w strukturze.
Szczegóły | |
---|---|
https://developer-api.nest.com/structures/structure_id/cameras |
|
Zwroty | array Przykład: [ "awJo6rH...",... ] |
Dostęp | tylko do odczytu |
Dostępne w | Odczyt termostatu / v4-v6 Odczyt termostatu z odczytu/zapisu / v4-v6 Odczyt dymu i CO2 / v4-v5 Odczyt w trybie / v2 Away odczyt/zapis / v2 zapis ETA / v2 odczyt z aparatu / v1-v3 odczyt z aparatu + zdjęcia / v1-v4 odczyt z aparatu |
daleko stąd
Określa poziom obłożenia budynku.
Budynki mają 2 stany związane z obecnością: home
lub away
. Jeśli w domu nie wykryto ruchu, struktura zmieni się z home
na away
.
Szczegóły | |
---|---|
https://developer-api.nest.com/structures/structure_id/away |
|
Zwroty | string Wartości: "dom", "w domu" |
Dostęp | odczyt/zapis |
Dostępne w | Odczyt: odczyt termostatu / v1-v6 odczyt termostatu / zapis w wersji v1-v6 dym + odczyt CO / v1-v5 odczyt w trybie Poza domem / v1-v2 Zapisywanie z odczytu/zapisu / v1-v2 zapis / v2 v1-v2 v1 v1-v2 . |
name
Zdefiniowana przez użytkownika nazwa struktury.
Szczegóły | |
---|---|
https://developer-api.nest.com/structures/structure_id/name |
|
Zwroty | string Przykłady: "Mój dom", "Dom plażowy", "Dom górski" |
Dostęp | odczyt/zapis |
Dostępne w | Odczyt: odczyty z termostatu / v1-v6 Odczyt/odczyt z termostatu / v1-v6 Obrót odczyt / zapis / v1-v2 odczyt / v / v v v v v m v v v v v v v v v v nav v v V V V V - V / V - v v v m v v v v v v v v - v v m v v v v v V v v v v v V v v v v V v v v v V v v v v V v v v v V v v v v V v v v v v v v v v v v V v v v v V V v v |
country_code
Kod kraju w formacie ISO 3166 alfa-2.
Szczegóły | |
---|---|
https://developer-api.nest.com/structures/structure_id/country_code |
|
Zwroty | string Przykłady: "USA" "CA", "Wielka Brytania |
Dostęp | tylko do odczytu |
Dostępne w | Odczyt danych z termostatu / v1-v6 Odczyt termostatu z zapisem / v1-v6 Odczyt dymu i dwutlenku węgla / v1-v5 Czytanie na zewnątrz / v1-v2 Nie odczyt/zapis / v1-v2 Zapis ET / v1-v2 |
kod pocztowy
Kod pocztowy, w zależności od kraju.
Szczegóły | |
---|---|
https://developer-api.nest.com/structures/structure_id/postal_code |
|
Zwroty | string Przykłady: "94304", "94304-1027", "EC1A 1BB" |
Dostęp | tylko do odczytu |
Dostępne w | Odczyt kodu pocztowego / wersja 1-2 |
szczyt_okres_początkowy_czas
Godzina rozpoczęcia zdarzenia energy hour hour, w formacie ISO 8601.
Szczegóły | |
---|---|
https://developer-api.nest.com/structures/structure_id/peak_period_start_time |
|
Zwroty | string Przykład: "2016-12-31T23:59:59.000Z" |
Dostęp | tylko do odczytu |
Dostępne w | Odczyt termostatu / v1-v6 Odczyt/zapis termostatu / v1-v6 Odczyt energii / v1-v2 |
szczyt_okres_końcowy
Godzina zakończenia godziny szczytu energetycznego w formacie ISO 8601.
Szczegóły | |
---|---|
https://developer-api.nest.com/structures/structure_id/peak_period_end_time |
|
Zwroty | string Przykład: "2016-12-31T23:59:59.000Z" |
Dostęp | tylko do odczytu |
Dostępne w | Odczyt termostatu / v1-v6 Odczyt/zapis termostatu / v1-v6 Odczyt energii / v1-v2 |
strefa czasowa
Strefa czasowa w formacie strukturalnym IANA.
Szczegóły | |
---|---|
https://developer-api.nest.com/structures/structure_id/time_zone |
|
Zwroty | string Przykład: "Ameryka Północna i Południowa" |
Dostęp | tylko do odczytu |
Dostępne w | Odczyt termostatu / v1-v6 Odczyt/zapis Thermostat / v1-v6 Odczyt dymu + tlenku / v1-v5 Nie odczyt/ v1-v2 Nie odczyt/zapis / v2 Zapis ET / v1-v2 |
eta
Szacowany czas dotarcia to obiekt, który można ustawić na konstrukcji. Służy do informowania Nest, że użytkownik powinien wrócić do domu o określonej godzinie. Informacje o tym, jak zadzwonić, znajdziesz w przewodniku Poza domem.
Szczegóły | |||||||
---|---|---|---|---|---|---|---|
https://developer-api.nest.com/structures/structure_id/eta |
|||||||
Zwroty | object Przykład: "myTripID1024", "2014-10-31T22:42:00.000Z", "2016-12-31T23:59:59.000Z" |
||||||
Parametry |
|
||||||
Dostęp | tylko do zapisu | ||||||
Dostępne w | szacowany czas dotarcia / wersja 1-2 |
eta_begin
Sygnatura czasowa przybycia oczekiwanego terminu w formacie ISO 8601. Służy do wywoływania działań lub zdarzeń.
Szczegóły | |
---|---|
https://developer-api.nest.com/structures/structure_id/eta_begin |
|
Zwroty | string Przykład: "2016-12-31T23:59:59.000Z" |
Dostęp | tylko do odczytu |
Dostępne w | Czas odczytu / wersja 1 |
rejestracja_rhr
stan rejestracji Rush Hour Rewards,
Szczegóły | |
---|---|
https://developer-api.nest.com/structures/structure_id/rhr_enrollment |
|
Zwroty | boolean Wartości: true, false |
Dostęp | tylko do odczytu |
Dostępne w | Energia odczytu / v1-v2 |
cw_security_state
Stan zabezpieczeń struktury.
Szczegóły | |
---|---|
https://developer-api.nest.com/structures/structure_id/wwn_security_state |
|
Typ | string enum Wartości: "ok", "krót" |
Dostęp | tylko do odczytu |
Dostępne w | Stan zabezpieczeń odczyt / wersja 1 |
gdzie
Obiekt zawierający identyfikatory urządzeń (where_id
i name
) w strukturze urządzeń. name
to wyświetlana nazwa urządzenia. Może to być dowolna nazwa pomieszczenia z podanej przez nas listy lub nazwa niestandardowa.
Więcej informacji o wheres
znajdziesz w Przewodniku po strukturze.
Dowiedz się więcej o nazwach termostatów Nest, zabezpieczeń Nest i kamer Nest Cam.
Szczegóły | |
---|---|
https://developer-api.nest.com/structures/structure_id/wheres |
|
Zwroty | object |
Dostęp | tylko do odczytu |
Dostępne w | Odczyt: odczyt/termostat / v3-v6 odczyt termostatu / zapis w wersji v3-v6 dym + odczyt CO / v3-v5 odczyt z aparatu / v1-v3 odczyt z kamery + obrazy / v1-v4 odczyty z aparatu / v1/v4 v1-v4. |
gdzie_identyfikator
Unikalny identyfikator wygenerowany przez Nest, który reprezentuje name
.
where_id
jest tworzony i zwracany podczas wywołania, by utworzyć name
.
Szczegóły | |
---|---|
https://developer-api.nest.com/structures/structure_id/wheres/where_id/where_id |
|
Zwroty | string Przykład: "Fqp6wJI..." |
Dostęp | tylko do odczytu |
Dostępne w | Odczyt: Odczyt termostatu / v3-v6 Odczyt/termostat / v3-v6 Odczyt dymu + / v3-v5 Odczyt z aparatu / v1-v3 Odczyt aparatu + zdjęcia / v1-v4 Odczyt/zapis aparatu / v1-v3 Odczyt/zapis danych z kamery + 4 / v1 |
name
Wyświetlana nazwa urządzenia.
Szczegóły | |
---|---|
https://developer-api.nest.com/structures/structure_id/wheres/where_id/name |
|
Zwroty | string Przykład: "Sypialnia" |
Dostęp | read/write |
Dostępne w | Odczyt: odczyt termostatu / v3-v6 odczyt/termostat / v3-v6 dym + odczyt CO / v3-v5 odczyt z aparatu / v1-v3 odczyt z aparatu + obrazy / v1-v4 odczyty z aparatu / v1/v4 v1/v4 . |
stan_alarmu
Stan alarmu tlenku węgla.
Szczegóły | |
---|---|
https://developer-api.nest.com/structures/structure_id/co_alarm_state |
|
Zwroty | string enum Wartości: "ok", "ostrzeżenie", "przypadki" |
Dostęp | tylko do odczytu |
Dostępne w | Odczyt dymu i tlenku węgla / wersja 5 |
stan_czujnika_dymu
Stan alarmu z czujnika dymu.
Szczegóły | |
---|---|
https://developer-api.nest.com/structures/structure_id/smoke_alarm_state |
|
Zwroty | string enum Wartości: "ok", "ostrzeżenie", "przypadki" |
Dostęp | tylko do odczytu |
Dostępne w | Odczyt dymu i tlenku węgla / wersja 5 |