Notice: We're retiring Works with Nest. See the home page for more information.
Google berkomitmen untuk mendorong terwujudnya keadilan ras bagi komunitas Kulit Hitam. Lihat caranya.
Halaman ini diterjemahkan oleh Cloud Translation API.
Switch to English

Struktur

Struktur

Struktur sarang mewakili struktur fisik di dunia nyata. Biasanya rumah pengguna, mereka berfungsi sebagai titik pengorganisasian untuk perangkat dan akan menyimpan data yang berlaku untuk seluruh rumah.

Nest API menyediakan akses ke data tingkat struktur berikut, bergantung pada tingkat izin yang diberikan:

  • Nama struktur dan perangkat "di mana nama" (lokasi di rumah)
  • Daftar perangkat di rumah
  • Status peristiwa energi ( jam energi sibuk )
  • Keadaan jauh
  • ETA pengguna
  • Negara keamanan
  • Pos atau kode pos

Beberapa fitur tingkat struktur dicakup dalam panduan API terpisah dan lebih rinci:

Izin struktur

Untuk akses ke ... Pilih...
Sebagian besar nilai data dalam objek structures Izin pergi , ETA , Energi , atau Kode pos
Nilai data name dalam objek structures Izin baca / tulis struktur

Lihat cara kerja izin dalam Referensi API interaktif .

Pengidentifikasi struktur

Nama

Nama struktur secara default adalah "Beranda" tetapi dapat berupa string apa pun yang dipilih pengguna. Saat Anda memilih izin baca / tulis Struktur , Anda dapat mengubah name struktur.

Dimana

wheres adalah objek yang ditetapkan pada struktur, yang berisi pengidentifikasi tempat ( where_id dan name ). Gunakan wheres untuk membuat kustom di mana nama, atau akses standar di mana nama.

Akses ke objek wheres memerlukan izin Kamera , Smoke + CO Alarm , atau Thermostat .

where_id

  • Pengidentifikasi unik yang dibuat oleh Nest yang mewakili name
  • where_id read-only, dan dibuat secara otomatis dalam panggilan untuk membuat custom mana name

name

  • Nama tampilan perangkat; dapat berupa nama kamar apa pun dari daftar yang kami sediakan, atau nama khusus
  • Untuk membuat custom mana name , membuat panggilan POST untuk menulis baru, kustom mana name ; where_id dikembalikan dalam panggilan
  • Pertimbangan
    • name tidak dapat diedit atau dihapus setelah pembuatan
    • name harus unik dalam struktur
    • Jika suatu perangkat dipasangkan ke suatu struktur, kebiasaan di mana name terkait dengan perangkat dapat diakses dari /structures/ jalur
    • Untuk memindahkan perangkat dengan name tempat kustom ke struktur yang berbeda, putuskan pasangan perangkat, lalu pasangkan kembali perangkat dengan nama yang diinginkan

Pelajari lebih lanjut tentang nama untuk Termostat Sarang , Perlindungan Sarang , dan Sarang Cams .

Metadata lainnya

Semua nilai data hanya baca, kecuali ditentukan lain.

Nilai Data Deskripsi
structure_id String yang secara unik mewakili struktur ini. Setiap pengembang akan melihat ID berbeda untuk struktur yang sama, tetapi beberapa produk dari pengembang yang sama akan melihat ID yang sama
country_code Kode negara ISO 3166-1 alpha-2 yang memetakan ke lokasi terdaftar struktur
postal_code Pos atau kode pos, tergantung negara
time_zone String zona waktu IANA yang memetakan ke zona waktu struktur

Fitur struktur

Status asap dan alarm CO

Ketika Anda memilih izin membaca Smoke + CO , Anda dapat mengakses smoke_alarm_state dan co_alarm_state di objek structures . Nilai data yang sama ini juga tersedia di objek perangkat ( devices/smoke_co_alarms ).

Lihat panduan alarm Smoke + CO untuk informasi lebih lanjut tentang status ini.

Banyak nilai data bekerja bersama untuk menentukan bagaimana perangkat berperilaku dalam suatu struktur.

  • Ketika status struktur away away , kata "ECO" ditampilkan pada Nest Thermostat, dalam bahasa pilihan pengguna
  • Saat status struktur away away , Anda dapat:
    • atur fan_timer_active
    • ubah target_temperature_f atau target_temperature_c
  • Ketika status away struktur diatur ke home , Anda dapat:
    • melakukan panggilan ETA (set id perjalanan dan jendela kedatangan)
  • Ketika Emergency Shutoff aktif, Anda tidak dapat mengatur fan_timer_active
  • Ketika Panas Darurat diaktifkan, Anda tidak dapat mengatur struktur untuk away

Beberapa struktur

Ada kemungkinan bahwa pengguna memiliki lebih dari satu struktur yang melekat pada Akun Nest mereka, sehingga produk Anda harus menawarkan sarana bagi pengguna untuk memilih dari struktur yang tersedia (pemilih struktur).

Pemilih struktur

Misalnya, ketika mengatur ETA, penting bagi pengguna untuk dapat memilih struktur untuk tujuan ETA. Dengan cara yang sama, pengguna dapat memiliki dua detektor asap di "ruang tamu" dari dua rumah yang berbeda. Jika Anda perlu melakukan korelasi struktur dengan konsep rumah Anda sendiri, kami sarankan Anda melakukan ini selama proses otorisasi.

Pelajari cara pengguna mengelola perangkat dalam berbagai struktur .

Maksimum perangkat

Ada batasan untuk berapa banyak perangkat yang didukung Nest dalam suatu struktur.

Tipe perangkat Max per struktur
Thermostat Sarang 20
Kamera Sarang 10
Nest Protect 18

Pesan kesalahan

Untuk informasi tentang arti kesalahan panggilan API dan cara menanganinya, lihat Pesan Kesalahan .