Người dùng có thể thêm tối đa 3 cấu trúc, với nhiều thiết bị trên mỗi cấu trúc.
Bạn có thể tìm thấy tất cả các giá trị bên dưới dưới mỗi
structures/structure_id
trong tài liệu JSON.
có_cấu_ trúc
Số ID của cấu trúc. Khi thực hiện lệnh gọi đến vị trí dữ liệu này, bạn có thể truy cập vào các giá trị dữ liệu trong cấu trúc này.
Thông tin chi tiết | |
---|---|
https://developer-api.nest.com/structures/structure_id/structure_id |
|
Trả về | string Ví dụ: "VqFabWH21nw..." |
Truy cập | chỉ có thể đọc |
Đã có tại | Bộ đọc máy điều nhiệt / v1-v6 Máy đọc nhiệt/ghi / v1-v6 Smoke+CO đọc / v1-v5 Away đọc / v1-v2 Mã bưu chính đọc / v2 Máy ảnh đọc / v1-v3 Máy ảnh đọc v/hình ảnh 4 |
máy điều nhiệt
Danh sách các máy điều nhiệt trong cấu trúc, theo mã nhận dạng duy nhất của thiết bị. Đây là một mảng các đối tượng JSON bao gồm tất cả các máy điều nhiệt trong cấu trúc.
Thông tin chi tiết | |
---|---|
https://developer-api.nest.com/structures/structure_id/thermostats |
|
Trả về | array Ví dụ: [ "peyiJNo0IldT2YlIVtYaGQ",... ] |
Truy cập | chỉ có thể đọc |
Đã có tại | Máy đọc nhiệt / v1-v6 Máy đọc nhiệt/ghi / v1-v6 Smoke+CO đọc / v1-v5 Away đọc / v1-v2 Máy đọc / v2-v3 Máy ảnh đọc + hình ảnh/v2-v4 Máy ảnh/v4 |
chuông báo khói_co_sách
Danh sách chuông báo khói+CO trong cấu trúc, theo mã nhận dạng duy nhất của thiết bị. Đây là một mảng các đối tượng JSON bao gồm tất cả các chuông báo khói+CO trong cấu trúc.
Thông tin chi tiết | |
---|---|
https://developer-api.nest.com/structures/structure_id/smoke_co_alarms |
|
Trả về | array Ví dụ: [ "RTMTKxsQTCxzVcsySOHPxKoF4OyCifrs",... ] |
Truy cập | chỉ có thể đọc |
Đã có tại | Máy đọc nhiệt / v1-v6 Máy đọc nhiệt/ghi / v1-v6 Smoke+CO đọc / v1-v5 Away đọc / v1-v2 Máy đọc / v2-v3 Máy ảnh đọc + hình ảnh/v2-v4 Máy ảnh/v4 |
máy ảnh
Danh sách camera có cấu trúc, theo mã nhận dạng duy nhất của thiết bị. Đây là một mảng các đối tượng JSON bao gồm tất cả các camera trong cấu trúc.
Thông tin chi tiết | |
---|---|
https://developer-api.nest.com/structures/structure_id/cameras |
|
Trả về | array Ví dụ: [ "awJo6rH...",... ] |
Truy cập | chỉ có thể đọc |
Đã có tại | Máy điều nhiệt đọc / v4-v6 Máy điều nhiệt đọc/ghi / v4-v6 Smoke + máy đọc CO / v4-v5 Ảnh đọc / v2 Sử dụng máy ảnh + đọc ảnh / v1-v4 Máy ảnh đọc/ghi / v1-v |
cách
Cho biết trạng thái lưu trú của cấu trúc.
Cấu trúc có hai trạng thái liên quan đến sự hiện diện: home
hoặc away
. Khi không thể quan sát thấy chuyển động
trong nhà, cấu trúc sẽ thay đổi từ home
thành away
.
Thông tin chi tiết | |
---|---|
https://developer-api.nest.com/structures/structure_id/away |
|
Trả về | string Giá trị: "home", "away" |
Truy cập | đọc/ghi |
Đã có tại | Đọc: Đọc nhiệt / v1-v6 Đọc nhiệt/ghi/v1-v6 Smoke+CO đọc / v1-v5 Away đọc / v1-v2 Away Read/write / v1-v2 ETA record / v1-v2 |
tên
Tên hiển thị của cấu trúc do người dùng xác định.
Thông tin chi tiết | |
---|---|
https://developer-api.nest.com/structures/structure_id/name |
|
Trả về | string Ví dụ: "My Home", "Beach House", "Mountain House" |
Truy cập | đọc/ghi |
Đã có tại | <br><br> |
country_code [mã_quốc_gia]
Mã quốc gia, ở định dạng ISO 3166 alpha-2.
Thông tin chi tiết | |
---|---|
https://developer-api.nest.com/structures/structure_id/country_code |
|
Trả về | string Ví dụ: "US"; "CA"; "Vương quốc Anh" |
Truy cập | chỉ có thể đọc |
Đã có tại | Máy điều nhiệt đọc / v1-v6 Đọc nhiệt/ghi / v1-v6 Smoke+CO đọc / v1-v5 Away đọc / v1-v2 Away đọc/ghi / v1-v2 ETA record / v1-v2 |
mã_bưu_chính
Mã bưu chính hoặc mã bưu chính, tùy thuộc vào quốc gia.
Thông tin chi tiết | |
---|---|
https://developer-api.nest.com/structures/structure_id/postal_code |
|
Trả về | string Ví dụ: "94304", "94304-1027", "EC1A 1BB" |
Truy cập | chỉ có thể đọc |
Đã có tại | Đọc mã bưu chính / v1-v2 |
đỉnh_thời_gian_bắt_đầu_tối_đa
Thời gian bắt đầu của sự kiện giờ cao điểm ở định dạng ISO 8601.
Thông tin chi tiết | |
---|---|
https://developer-api.nest.com/structures/structure_id/peak_period_start_time |
|
Trả về | string Ví dụ: "2016-12-31T23:59:59.000Z" |
Truy cập | chỉ có thể đọc |
Đã có tại | Bộ đọc máy điều nhiệt / v1-v6 Máy đọc nhiệt/ghi nhiệt / v1-v6 Đọc năng lượng / v1-v2 |
đỉnh_thời_gian_kết_thúc_cuối_giờ
Thời gian kết thúc của sự kiện giờ cao điểm, ở định dạng ISO 8601.
Thông tin chi tiết | |
---|---|
https://developer-api.nest.com/structures/structure_id/peak_period_end_time |
|
Trả về | string Ví dụ: "2016-12-31T23:59:59.000Z" |
Truy cập | chỉ có thể đọc |
Đã có tại | Bộ đọc máy điều nhiệt / v1-v6 Máy đọc nhiệt/ghi nhiệt / v1-v6 Đọc năng lượng / v1-v2 |
múi giờ
Múi giờ ở cấu trúc, ở định dạng Múi giờ IANA.
Thông tin chi tiết | |
---|---|
https://developer-api.nest.com/structures/structure_id/time_zone |
|
Trả về | string Ví dụ: "America/Los_Angeles" |
Truy cập | chỉ có thể đọc |
Đã có tại | Bộ đọc máy điều nhiệt / v1-v6 Máy đọc nhiệt/ghi / v1-v6 Smoke+CO đọc / v1-v5 Away đọc / v1-v2 Away đọc/ghi / v2 ETA record / v1-v2 |
eta
ETA (thời gian đến dự kiến) là một đối tượng có thể được đặt trên một cấu trúc. Thông tin này được dùng để cho Nest biết rằng người dùng dự kiến sẽ quay về nhà vào một thời điểm cụ thể. Để biết thông tin về cách gọi điện đến ETA, hãy xem Hướng dẫn vắng mặt.
Thông tin chi tiết | |||||||
---|---|---|---|---|---|---|---|
https://developer-api.nest.com/structures/structure_id/eta |
|||||||
Trả về | object Ví dụ: "myTripID1024", "2014-10-31T22:42:00.000Z", "2016-12-31T23:59:59.000Z" |
||||||
Thông số |
|
||||||
Truy cập | chỉ có thể ghi | ||||||
Đã có tại | Ghi ETA / v1-v2 |
bắt đầu
Dấu thời gian về thời gian đến dự kiến sớm nhất ở định dạng ISO 8601. Dùng để kích hoạt hành động hoặc sự kiện.
Thông tin chi tiết | |
---|---|
https://developer-api.nest.com/structures/structure_id/eta_begin |
|
Trả về | string Ví dụ: "2016-12-31T23:59:59.000Z" |
Truy cập | chỉ có thể đọc |
Đã có tại | Đọc ETA / v1 |
đăng ký tham gia rhr
Trạng thái đăng ký Phần thưởng giờ cao điểm.
Thông tin chi tiết | |
---|---|
https://developer-api.nest.com/structures/structure_id/rhr_enrollment |
|
Trả về | boolean Giá trị: true, false |
Truy cập | chỉ có thể đọc |
Đã có tại | Đọc năng lượng / v1-v2 |
j__security_state
Cấu trúc trạng thái bảo mật.
Thông tin chi tiết | |
---|---|
https://developer-api.nest.com/structures/structure_id/wwn_security_state |
|
Loại | string enum Giá trị: "ok", "deter" |
Truy cập | chỉ có thể đọc |
Đã có tại | Trạng thái bảo mật đã đọc / phiên bản 1 |
trong đó
Đối tượng chứa giá trị nhận dạng (where_id
và name
) cho các thiết bị trong cấu trúc. name
là tên hiển thị của thiết bị. Đó có thể là tên bất kỳ
phòng từ danh sách mà chúng tôi cung cấp hoặc tên tùy chỉnh.
Để biết thêm thông tin về wheres
, hãy xem Hướng dẫn về cấu trúc.
Tìm hiểu thêm về tên của Nest Thermostat, Nest Protects và Nest Cams.
Thông tin chi tiết | |
---|---|
https://developer-api.nest.com/structures/structure_id/wheres |
|
Trả về | object |
Truy cập | chỉ có thể đọc |
Đã có tại | Đọc: Đọc nhiệt / v3-v6 Đọc nhiệt/ghi/v3-v6 Smoke + CO đọc / v3-v5 Máy ảnh đọc / v1-v3 Máy ảnh đọc + hình ảnh / v1-v4 Máy ảnh đọc/ghi/v1-v3 + 4 |
trong_đây
Giá trị nhận dạng duy nhất do Nest tạo ra, đại diện cho name
.
where_id
sẽ được tạo và trả về tự động trong cuộc gọi để tạo
name
.
Thông tin chi tiết | |
---|---|
https://developer-api.nest.com/structures/structure_id/wheres/where_id/where_id |
|
Trả về | string Ví dụ: "Fqp6wJI..." |
Truy cập | chỉ có thể đọc |
Đã có tại | Đọc: Máy đọc nhiệt/đọc/v3 |
tên
Tên hiển thị của thiết bị.
Thông tin chi tiết | |
---|---|
https://developer-api.nest.com/structures/structure_id/wheres/where_id/name |
|
Trả về | string Ví dụ: "Bedroom" |
Truy cập | đọc/ghi |
Đã có tại | Đọc: Đọc nhiệt / v3-v6 Đọc nhiệt/ghi/v3-v6 Smoke + CO đọc / v3-v5 Máy ảnh đọc / v1-v3 Máy ảnh đọc + hình ảnh / v1-v4 Máy ảnh đọc/ghi/v1-v3 |
co_alarm_state
Trạng thái chuông báo khí CO.
Thông tin chi tiết | |
---|---|
https://developer-api.nest.com/structures/structure_id/co_alarm_state |
|
Trả về | string enum Giá trị: "ok", "warning", "emergency" |
Truy cập | chỉ có thể đọc |
Đã có tại | Hút khói + CO / v5 |
khói_alarm_state
Trạng thái chuông báo khói.
Thông tin chi tiết | |
---|---|
https://developer-api.nest.com/structures/structure_id/smoke_alarm_state |
|
Trả về | string enum Giá trị: "ok", "warning", "emergency" |
Truy cập | chỉ có thể đọc |
Đã có tại | Hút khói + CO / v5 |