API Struktur

Pengguna dapat menambahkan maksimum tiga struktur, dengan beberapa perangkat per struktur.

Semua nilai di bawah ini ditemukan dalam setiap structures/structure_id di dokumen JSON.

id_struktur

Nomor ID struktur. Saat melakukan panggilan ke lokasi data ini, Anda dapat mengakses nilai data di struktur ini.

Detail
https://developer-api.nest.com/structures/structure_id/structure_id
Menampilkanstring
Contoh: "VqFabWH21nw..."
Akseshanya baca
Tersedia diTermostat membaca / v1-v6
Termostat membaca/menulis / v1-v6
Asap membaca CO / v1-v5
Pergi membaca / v1-v2
Pergi membaca/menulis / v1-v2
Kamera membaca / v1-v2
Kode pos membaca / v2 Kamera membaca / v1-v2
Kode baca/kamera / v1-v2
Baca kamera / v4-v2
Baca kamera / v1
Baca

termostat

Daftar termostat di struktur, berdasarkan ID perangkat unik. Ini adalah array objek JSON yang mencakup semua termostat dalam struktur.

Detail
https://developer-api.nest.com/structures/structure_id/thermostats
Menampilkanarray
Contoh: [ "peyiJNo0IldT2YlIVtYaGQ",... ]
Akseshanya baca
Tersedia diTermostat membaca / v1-v6
Termostat membaca/menulis / v1-v6
Asap membaca CO / v1-v5
Pergi membaca / v1-v2
Pergi membaca/menulis / v1-v2
Kamera membaca + gambar / v1-v2
Menulis kamera / v2-v3
Membaca kamera/gambar /gambar /gambar /gambar / v2-v3
Kamera baca/gambar /gambar /gambar / v2-v3
Kamera /v sebelah/gambar/gambar

alarm_asap_asap

Daftar alarm asap+CO dalam struktur, menurut pengenal perangkat unik. Ini adalah array objek JSON yang menyertakan semua alarm asap+CO dalam struktur.

Detail
https://developer-api.nest.com/structures/structure_id/smoke_co_alarms
Menampilkanarray
Contoh: [ "RTMTKxsQTCxzVcsySOHPxKoF4OyCifrs",... ]
Akseshanya baca
Tersedia diTermostat membaca / v1-v6
Termostat membaca/menulis / v1-v6
Asap membaca CO / v1-v5
Pergi membaca / v1-v2
Pergi membaca/menulis / v1-v2
Kamera membaca + gambar / v1-v2
Menulis kamera / v2-v3
Membaca kamera/gambar /gambar /gambar /gambar / v2-v3
Kamera baca/gambar /gambar /gambar / v2-v3
Kamera /v sebelah/gambar/gambar

kamera

Daftar kamera dalam struktur, menurut ID perangkat unik. Ini adalah array objek JSON yang mencakup semua kamera dalam struktur.

Detail
https://developer-api.nest.com/structures/structure_id/cameras
Menampilkanarray
Contoh: [ "awJo6rH...",... ]
Akseshanya baca
Tersedia diTermostat membaca / v4-v6
Termostat membaca/menulis / v4-v6
Mengasap+CO membaca / v4-v5
Menjauh membaca / v2
Tidak membaca/menulis / v2
ETA menulis / v2-v4/Kamera membaca / v1-v3
Kamera dibaca + gambar / v1-v4/v1/v4/penulisan kamera

jauhnya

Menunjukkan status hunian struktur.

Struktur memiliki dua status yang terkait dengan kehadiran: home atau away. Jika tidak ada gerakan yang dirasakan di rumah, struktur akan berubah dari home ke away.

Detail
https://developer-api.nest.com/structures/structure_id/away
Menampilkanstring
Nilai: "rumah", "tidak jalan"
Aksesbaca/tulis
Tersedia diBacaan:
Thermostat read / v1-v6
Thermostat read/write / v1-v6
Smoke+CO read / v1-v5
Away baca / v1-v2
Away baca/tulis / v1-v2
Penulisan /A v1-v2:v1:v1
/

nama

Nama tampilan struktur yang ditentukan pengguna.

Detail
https://developer-api.nest.com/structures/structure_id/name
Menampilkanstring
Contoh: "Rumah Saya", "Pantai Pantai", "Rumah Gunung"
Aksesbaca/tulis
Tersedia di.

country_code [kode_negara]

Kode negara, dalam format ISO 3166 alpha-2.

Detail
https://developer-api.nest.com/structures/structure_id/country_code
Menampilkanstring
Contoh: "AS", "CA", "Inggris"
Akseshanya baca
Tersedia diTermostat membaca / v1-v6
Termostat membaca/menulis / v1-v6
Mengasap+CO membaca / v1-v5
Tidak membaca / v1-v2
Tidak membaca/menulis / v1-v2
ETA menulis / v1-v2

kode_pos

Kode pos, tergantung negara.

Detail
https://developer-api.nest.com/structures/structure_id/postal_code
Menampilkanstring
Contoh: "94304", "94304-1027", "EC1A 1BB"
Akseshanya baca
Tersedia diPembacaan kode pos / v1-v2

puncak_periode_mulai_waktu

Waktu mulai peristiwa sibuk energi, dalam format ISO 8601.

Detail
https://developer-api.nest.com/structures/structure_id/peak_period_start_time
Menampilkanstring
Contoh: "2016-12-31T23:59:59.000Z"
Akseshanya baca
Tersedia diTermostat membaca / v1-v6
Termostat membaca/menulis / v1-v6
Membaca / energi v1-v2

puncak_periode_akhir_waktu

Waktu berakhir peristiwa waktu sibuk, dalam format ISO 8601.

Detail
https://developer-api.nest.com/structures/structure_id/peak_period_end_time
Menampilkanstring
Contoh: "2016-12-31T23:59:59.000Z"
Akseshanya baca
Tersedia diTermostat membaca / v1-v6
Termostat membaca/menulis / v1-v6
Membaca / energi v1-v2

time_zone

Zona waktu pada struktur, dalam format zona waktu IANA.

Detail
https://developer-api.nest.com/structures/structure_id/time_zone
Menampilkanstring
Contoh: "Amerika/Los_Angeles"
Akseshanya baca
Tersedia diTermostat membaca / v1-v6
Termostat membaca/menulis / v1-v6
Mengasap+CO membaca / v1-v5
Membaca / v1-v2
Tidak membaca/menulis / v2
ETA menulis / v1-v2

Eta

ETA (perkiraan waktu tiba) adalah objek yang dapat ditetapkan pada struktur. Atribut ini digunakan untuk memberi tahu Nest bahwa pengguna diperkirakan akan kembali ke rumah pada waktu tertentu. Untuk informasi tentang cara melakukan panggilan PWT, lihat Panduan Pergi.

Detail
https://developer-api.nest.com/structures/structure_id/eta
Menampilkanobject
Contoh: "myTripID1024", "2014-10-31T22:42:00.000Z", "2016-12-31T23:59:59.000Z"
Parameter
trip_idString buatan pengguna yang mengidentifikasi perjalanan
estimated_arrival_window_begin Stempel waktu dalam format ISO 8601.
Harus lebih besar dari NOW.
estimated_arrival_window_endStempel waktu dalam format ISO 8601.
Harus lebih besar dari estimated_arrival_window_begin.
Akseshanya-tulis
Tersedia diPenulisan PWT / v1-v2

eta_begin

Stempel waktu perkiraan waktu tiba paling awal dalam format ISO 8601. Digunakan untuk memicu tindakan atau peristiwa.

Detail
https://developer-api.nest.com/structures/structure_id/eta_begin
Menampilkanstring
Contoh: "2016-12-31T23:59:59.000Z"
Akseshanya baca
Tersedia diPWT dibaca / v1

rhr_enrollment

Status pendaftaran Reward Jam Sibuk.

Detail
https://developer-api.nest.com/structures/structure_id/rhr_enrollment
Menampilkanboolean
Nilai: benar, salah
Akseshanya baca
Tersedia diPembacaan energi / v1-v2

status_keamanan_ww

Status keamanan struktur.

Detail
https://developer-api.nest.com/structures/structure_id/wwn_security_state
Jenisstring enum
Nilai: "ok", "menunda"
Akseshanya baca
Tersedia diStatus keamanan baca / v1

di mana

Objek yang berisi ID (where_id dan name) untuk perangkat dalam struktur. name adalah nama tampilan perangkat. Nama ini dapat berupa nama ruang dari daftar yang kami berikan, atau nama khusus.

Untuk informasi selengkapnya tentang wheres, lihat Panduan Struktur.

Pelajari lebih lanjut nama untuk Nest Thermostat, Nest Protect, dan Nest Cam.

Detail
https://developer-api.nest.com/structures/structure_id/wheres
Menampilkanobject
Akseshanya baca
Tersedia diBacaan:
Termostat membaca/v3-v6
Termostat membaca/menulis/v3-v6
Asap+CO baca/v3-v5
Kamera baca/v1-v3
Kamera baca + gambar / v1-v4
Kamera baca/tulis/v1-v1-v3

di mana_id

ID unik yang dihasilkan Nest yang mewakili name.

where_id otomatis dibuat dan ditampilkan selama panggilan untuk membuat name.

Detail
https://developer-api.nest.com/structures/structure_id/wheres/where_id/where_id
Menampilkanstring
Contoh: "Fqp6wJI..."
Akseshanya baca
Tersedia diBaca:
Termostat membaca/v3-v6
Termostat membaca/menulis/v3-v6
Asap+CO dibaca/v3-v5
Kamera dibaca/v1-v3
Kamera baca + gambar/v1-v4
Kamera baca/tulis / v1-v3
Kamera baca/tulis + gambar / v1

nama

Nama tampilan perangkat.

Detail
https://developer-api.nest.com/structures/structure_id/wheres/where_id/name
Menampilkanstring
Contoh: "Kamar Tidur"
Aksesbaca/tulis
Tersedia diBacaan:
Termostat membaca/v3-v6
Pembacaan/penulisan termostat / v3-v6
Asap+CO dibaca / v3-v5
Pembacaan kamera / v1-v3
Pembacaan kamera + gambar / v1-v4
Pembacaan/penulisan kamera / v1-v3 gambar

status_bersama

Status alarm CO.

Detail
https://developer-api.nest.com/structures/structure_id/co_alarm_state
Menampilkanstring enum
Nilai: "ok", "peringatan", "darurat"
Akseshanya baca
Tersedia diAsap+CO baca / v5

status_asap_asap

Status alarm asap.

Detail
https://developer-api.nest.com/structures/structure_id/smoke_alarm_state
Menampilkanstring enum
Nilai: "ok", "peringatan", "darurat"
Akseshanya baca
Tersedia diAsap+CO baca / v5