Użytkownicy mogą dodać maksymalnie trzy struktury , z wieloma urządzeniami na strukturę.
Wszystkie poniższe wartości znajdują się pod każdą structures/ structure_id identyfikatorem structures/ structure_id w dokumencie JSON.
identyfikator struktury
Numer identyfikacyjny konstrukcji. W przypadku wywołania tej lokalizacji danych można uzyskać dostęp do wartości danych w tej strukturze.
| Detale | |
|---|---|
https://developer-api.nest.com/structures/ structure_id /structure_id | |
| Zwroty | string Przykład: „VqFabWH21nw ...” |
| Dostęp | tylko czytać |
| Dostępne w | Odczyt termostatu / v1-v6 Termostat odczyt / zapis / v1-v6 Dym + odczyt CO / v1-v5 Away read / v1-v2 Odczyt / zapis z dala / v1-v2 ETA write / v1-v2 Odczyt kodu pocztowego / v2 Odczyt z aparatu / v1-v3 Odczyt aparatu + obrazy / v1-v4 Aparat do odczytu / zapisu / v1-v3 Kamera do odczytu / zapisu + obrazy / v1-v4 Odczyt energii / v2 |
termostaty
Lista termostatów w konstrukcji, według unikalnego identyfikatora urządzenia. To jest tablica obiektów JSON, która zawiera wszystkie termostaty w strukturze.
| Detale | |
|---|---|
https://developer-api.nest.com/structures/ structure_id /thermostats | |
| Zwroty | array Przykład: [ "peyiJNo0IldT2YlIVtYaGQ",... ] |
| Dostęp | tylko czytać |
| Dostępne w | Odczyt termostatu / v1-v6 Termostat odczyt / zapis / v1-v6 Dym + odczyt CO / v1-v5 Away read / v1-v2 Odczyt / zapis z dala / v1-v2 ETA write / v1-v2 Odczyt z aparatu / v2-v3 Odczyt aparatu + obrazy / v2-v4 Aparat do odczytu / zapisu / v2-v3 Kamera do odczytu / zapisu + obrazy / v2-v4 |
smoke_co_alarms
Lista alarmów dymu i CO w konstrukcji, według unikalnego identyfikatora urządzenia. Jest to tablica obiektów JSON, która obejmuje wszystkie alarmy dymu i CO w strukturze.
| Detale | |
|---|---|
https://developer-api.nest.com/structures/ structure_id /smoke_co_alarms | |
| Zwroty | array Przykład: [ "RTMTKxsQTCxzVcsySOHPxKoF4OyCifrs",... ] |
| Dostęp | tylko czytać |
| Dostępne w | Odczyt termostatu / v1-v6 Termostat odczyt / zapis / v1-v6 Dym + odczyt CO / v1-v5 Away read / v1-v2 Odczyt / zapis z dala / v1-v2 ETA write / v1-v2 Odczyt z aparatu / v2-v3 Odczyt aparatu + obrazy / v2-v4 Aparat do odczytu / zapisu / v2-v3 Kamera do odczytu / zapisu + obrazy / v2-v4 |
kamery
Lista kamer w strukturze według unikalnego identyfikatora urządzenia. To jest tablica obiektów JSON, która obejmuje wszystkie kamery w strukturze.
| Detale | |
|---|---|
https://developer-api.nest.com/structures/ structure_id /cameras | |
| Zwroty | array Przykład: [ "awJo6rH...",... ] |
| Dostęp | tylko czytać |
| Dostępne w | Odczyt termostatu / v4-v6 Termostat odczyt / zapis / v4-v6 Odczyt dymu + CO / v4-v5 Away read / v2 Odczyt / zapis / v2 ETA write / v2 Odczyt z aparatu / v1-v3 Odczyt aparatu + obrazy / v1-v4 Aparat do odczytu / zapisu / v1-v3 Kamera do odczytu / zapisu + obrazy / v1-v4 |
z dala
Wskazuje stan zajętości konstrukcji.
Struktury mają dwa stany związane z obecnością: home lub away . Gdy w domu nie zostanie wykryty żaden ruch, struktura zmieni się z home na away .
| Detale | |
|---|---|
https://developer-api.nest.com/structures/ structure_id /away | |
| Zwroty | string Wartości: „home”, „away” |
| Dostęp | czytać / pisać |
| Dostępne w | Czytać: Odczyt termostatu / v1-v6 Termostat odczyt / zapis / v1-v6 Dym + odczyt CO / v1-v5 Away read / v1-v2 Odczyt / zapis z dala / v1-v2 ETA write / v1-v2 Pisać: Odczyt / zapis z dala / v1-v2 |
imię
Zdefiniowana przez użytkownika nazwa wyświetlana konstrukcji.
| Detale | |
|---|---|
https://developer-api.nest.com/structures/ structure_id /name | |
| Zwroty | string Przykłady: „Mój dom”, „Dom na plaży”, „Dom w górach” |
| Dostęp | czytać / pisać |
| Dostępne w | Czytać: Odczyt termostatu / v1-v6 Termostat odczyt / zapis / v1-v6 Dym + odczyt CO / v1-v5 Away read / v1-v2 Odczyt / zapis z dala / v1-v2 ETA write / v1-v2 Odczyt kodu pocztowego / v2 Odczyt z aparatu / v1-v3 Odczyt aparatu + obrazy / v1-v4 Aparat do odczytu / zapisu / v1-v3 Kamera do odczytu / zapisu + obrazy / v1-v4 Odczyt energii / v2 Struktura do odczytu / zapisu / v1 Pisać: Struktura do odczytu / zapisu / v1 |
kod pocztowy
Kod kraju w formacie ISO 3166 alpha-2 .
| Detale | |
|---|---|
https://developer-api.nest.com/structures/ structure_id /country_code | |
| Zwroty | string Przykłady: „US”, „CA”, „UK” |
| Dostęp | tylko czytać |
| Dostępne w | Odczyt termostatu / v1-v6 Termostat odczyt / zapis / v1-v6 Dym + odczyt CO / v1-v5 Away read / v1-v2 Odczyt / zapis z dala / v1-v2 ETA write / v1-v2 |
kod pocztowy
Kod pocztowy lub pocztowy, w zależności od kraju.
| Detale | |
|---|---|
https://developer-api.nest.com/structures/ structure_id /postal_code | |
| Zwroty | string Przykłady: „94304”, „94304-1027”, „EC1A 1BB” |
| Dostęp | tylko czytać |
| Dostępne w | Odczyt kodu pocztowego / v1-v2 |
peak_period_start_time
Godzina rozpoczęcia zdarzenia godziny szczytu energii , w formacie ISO 8601 .
| Detale | |
|---|---|
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 czytać |
| Dostępne w | Odczyt termostatu / v1-v6 Termostat odczyt / zapis / v1-v6 Odczyt energii / v1-v2 |
peak_period_end_time
Godzina zakończenia zdarzenia związanego z godziną szczytu energii , w formacie ISO 8601 .
| Detale | |
|---|---|
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 czytać |
| Dostępne w | Odczyt termostatu / v1-v6 Termostat odczyt / zapis / v1-v6 Odczyt energii / v1-v2 |
strefa czasowa
Strefa czasowa w strukturze, w formacie strefy czasowej IANA .
| Detale | |
|---|---|
https://developer-api.nest.com/structures/ structure_id /time_zone | |
| Zwroty | string Przykład: „Ameryka / Los_Angeles” |
| Dostęp | tylko czytać |
| Dostępne w | Odczyt termostatu / v1-v6 Termostat odczyt / zapis / v1-v6 Dym + odczyt CO / v1-v5 Away read / v1-v2 Odczyt / zapis / v2 ETA write / v1-v2 |
eta
ETA (szacowany czas przybycia) to obiekt, który można ustawić na konstrukcji. Służy do powiadomienia Nest, że użytkownik ma wrócić do domu o określonej godzinie. Aby uzyskać informacje o tym, jak wykonać połączenie ETA, zobacz Przewodnik po nieobecności .
| Detale | |||||||
|---|---|---|---|---|---|---|---|
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 | ETA write / v1-v2 | ||||||
eta_begin
Znacznik czasu najwcześniejszego przewidywanego czasu przybycia w formacie ISO 8601 . Służy do wyzwalania działań lub zdarzeń.
| Detale | |
|---|---|
https://developer-api.nest.com/structures/ structure_id /eta_begin | |
| Zwroty | string Przykład: „2016-12-31T23: 59: 59.000Z” |
| Dostęp | tylko czytać |
| Dostępne w | ETA odczyt / v1 |
rhr_enrollment
Status rejestracji w programie nagród w godzinach szczytu .
| Detale | |
|---|---|
https://developer-api.nest.com/structures/ structure_id /rhr_enrollment | |
| Zwroty | boolean Wartości: prawda, fałsz |
| Dostęp | tylko czytać |
| Dostępne w | Odczyt energii / v1-v2 |
wwn_security_state
Stan bezpieczeństwa struktury.
| Detale | |
|---|---|
https://developer-api.nest.com/structures/ structure_id /wwn_security_state | |
| Rodzaj | string enum Wartości: „ok”, „odstraszanie” |
| Dostęp | tylko czytać |
| Dostępne w | Odczyt stanu bezpieczeństwa / v1 |
gdzie
Obiekt zawierający identyfikatory gdzie ( where_id i name ) dla urządzeń w strukturze. name to wyświetlana nazwa urządzenia. Może to być dowolna nazwa pokoju z dostarczonej przez nas listy lub nazwa niestandardowa.
Aby uzyskać więcej informacji na temat wheres , zobacz Przewodnik po strukturze .
Dowiedz się więcej o nazwach termostatów Nest, zabezpieczeń Nest i kamer Nest .
| Detale | |
|---|---|
https://developer-api.nest.com/structures/ structure_id /wheres | |
| Zwroty | object |
| Dostęp | tylko czytać |
| Dostępne w | Czytać: Odczyt termostatu / v3-v6 Termostat odczyt / zapis / v3-v6 Odczyt dymu + CO / v3-v5 Odczyt z aparatu / v1-v3 Odczyt aparatu + obrazy / v1-v4 Aparat do odczytu / zapisu / v1-v3 Kamera do odczytu / zapisu + obrazy / v1-v4 |
gdzie_id
Unikalny, wygenerowany przez Nest identyfikator, który reprezentuje name .
where_id jest tworzone automatycznie i zwracane podczas wywołania w celu utworzenia name .
| Detale | |
|---|---|
https://developer-api.nest.com/structures/ structure_id /wheres/ where_id /where_id | |
| Zwroty | string Przykład: „Fqp6wJI ...” |
| Dostęp | tylko czytać |
| Dostępne w | Czytać: Odczyt termostatu / v3-v6 Termostat odczyt / zapis / v3-v6 Odczyt dymu + CO / v3-v5 Odczyt z aparatu / v1-v3 Odczyt aparatu + obrazy / v1-v4 Aparat do odczytu / zapisu / v1-v3 Kamera do odczytu / zapisu + obrazy / v1-v4 |
imię
Wyświetlana nazwa urządzenia.
| Detale | |
|---|---|
https://developer-api.nest.com/structures/ structure_id /wheres/ where_id /name | |
| Zwroty | string Przykład: „Sypialnia” |
| Dostęp | czytać / pisać |
| Dostępne w | Czytać: Odczyt termostatu / v3-v6 Termostat odczyt / zapis / v3-v6 Odczyt dymu + CO / v3-v5 Odczyt z aparatu / v1-v3 Odczyt aparatu + obrazy / v1-v4 Aparat do odczytu / zapisu / v1-v3 Kamera do odczytu / zapisu + obrazy / v1-v4 |
co_alarm_state
Stan alarmu CO.
| Detale | |
|---|---|
https://developer-api.nest.com/structures/ structure_id /co_alarm_state | |
| Zwroty | string enum Wartości: „ok”, „warning”, „Emergency” |
| Dostęp | tylko czytać |
| Dostępne w | Odczyt dymu + CO / v5 |
smoke_alarm_state
Stan alarmu dymu.
| Detale | |
|---|---|
https://developer-api.nest.com/structures/ structure_id /smoke_alarm_state | |
| Zwroty | string enum Wartości: „ok”, „warning”, „Emergency” |
| Dostęp | tylko czytać |
| Dostępne w | Odczyt dymu + CO / v5 |