Notice: We're retiring Works with Nest. See the home page for more information.
Google cam kết thúc đẩy công bằng chủng tộc cho Cộng đồng người da đen. Xem cách thực hiện.
Trang này được dịch bởi Cloud Translation API.
Switch to English

API cấu trúc

Người dùng có thể thêm tối đa ba cấu trúc , với nhiều thiết bị trên mỗi cấu trúc.

Tất cả các giá trị dưới đây được tìm thấy dưới mỗi structures/ structure_id trong tài liệu JSON.

cấu trúc_id

Số ID của cấu trúc. Khi bạn thực hiện cuộc gọi đến vị trí dữ liệu này, bạn có thể truy cập các giá trị dữ liệu trong cấu trúc này.

Chi tiết
https://developer-api.nest.com/structures/ structure_id /structure_id
Trả về string
Ví dụ: "VqFabWH21nw ..."
Truy cập chỉ đọc
Có sẵn trong Bộ điều chỉnh nhiệt đọc / v1-v6
Điều chỉnh nhiệt đọc / ghi / v1-v6
Khói + CO đọc / v1-v5
Đọc đi / v1-v2
Đọc / ghi / v1-v2
Viết ETA / v1-v2
Mã bưu chính đọc / v2
Máy ảnh đọc / v1-v3
Máy ảnh đọc + hình ảnh / v1-v4
Máy ảnh đọc / ghi / v1-v3
Máy ảnh đọc / ghi + hình ảnh / v1-v4
Năng lượng đọc / v2

máy điều nhiệt

Danh sách các bộ điều nhiệt trong cấu trúc, theo định danh thiết bị duy nhất. Đây là một mảng các đối tượng JSON bao gồm tất cả các bộ điều nhiệt trong cấu trúc.

Chi tiết
https://developer-api.nest.com/structures/ structure_id /thermostats
Trả về array
Ví dụ: [ "peyiJNo0IldT2YlIVtYaGQ",... ]
Truy cập chỉ đọc
Có sẵn trong Bộ điều chỉnh nhiệt đọc / v1-v6
Điều chỉnh nhiệt đọc / ghi / v1-v6
Khói + CO đọc / v1-v5
Đọc đi / v1-v2
Đọc / ghi / v1-v2
Viết ETA / v1-v2
Máy ảnh đọc / v2-v3
Máy ảnh đọc + hình ảnh / v2-v4
Camera đọc / ghi / v2-v3
Máy ảnh đọc / ghi + hình ảnh / v2-v4

khói_co_alarms

Danh sách các báo động khói + CO trong cấu trúc, theo định danh thiết bị duy nhất. Đây là một mảng các đối tượng JSON bao gồm tất cả các báo động khói + CO trong cấu trúc.

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
Có sẵn trong Bộ điều chỉnh nhiệt đọc / v1-v6
Điều chỉnh nhiệt đọc / ghi / v1-v6
Khói + CO đọc / v1-v5
Đọc đi / v1-v2
Đọc / ghi / v1-v2
Viết ETA / v1-v2
Máy ảnh đọc / v2-v3
Máy ảnh đọc + hình ảnh / v2-v4
Camera đọc / ghi / v2-v3
Máy ảnh đọc / ghi + hình ảnh / v2-v4

máy ảnh

Danh sách các camera trong cấu trúc, theo định danh thiết bị duy nhất. Đâ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.

Chi tiết
https://developer-api.nest.com/structures/ structure_id /cameras
Trả về array
Ví dụ: [ "awJo6rH...",... ]
Truy cập chỉ đọc
Có sẵn trong Bộ điều chỉnh nhiệt đọc / v4-v6
Bộ điều nhiệt đọc / ghi / v4-v6
Khói + CO đọc / v4-v5
Đọc đi / v2
Đọc / ghi / v2
Viết ETA / v2
Máy ảnh đọc / v1-v3
Máy ảnh đọc + hình ảnh / v1-v4
Máy ảnh đọc / ghi / v1-v3
Máy ảnh đọc / ghi + hình ảnh / v1-v4

xa

Cho biết trạng thái chiếm dụng 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 có chuyển động được cảm nhận trong nhà, cấu trúc sẽ thay đổi từ home để away .

Chi tiết
https://developer-api.nest.com/structures/ structure_id /away
Trả về string
Giá trị: "nhà", "đi"
Truy cập đọc viết
Có sẵn trong Đọc:
Bộ điều chỉnh nhiệt đọc / v1-v6
Điều chỉnh nhiệt đọc / ghi / v1-v6
Khói + CO đọc / v1-v5
Đọc đi / v1-v2
Đọc / ghi / v1-v2
Viết ETA / v1-v2
Viết:
Đọc / ghi / v1-v2

Tên

Tên hiển thị do người dùng định nghĩa của cấu trúc.

Chi tiết
https://developer-api.nest.com/structures/ structure_id /name
Trả về string
Ví dụ: "Nhà của tôi", "Ngôi nhà bãi biển", "Ngôi nhà trên núi"
Truy cập đọc viết
Có sẵn trong Đọc:
Bộ điều chỉnh nhiệt đọc / v1-v6
Điều chỉnh nhiệt đọc / ghi / v1-v6
Khói + CO đọc / v1-v5
Đọc đi / v1-v2
Đọc / ghi / v1-v2
Viết ETA / v1-v2
Mã bưu chính đọc / v2
Máy ảnh đọc / v1-v3
Máy ảnh đọc + hình ảnh / v1-v4
Máy ảnh đọc / ghi / v1-v3
Máy ảnh đọc / ghi + hình ảnh / v1-v4
Năng lượng đọc / v2
Cấu trúc đọc / ghi / v1
Viết:
Cấu trúc đọc / ghi / v1

mã quốc gia

Mã quốc gia, ở định dạng ISO 3166 alpha-2 .

Chi tiết
https://developer-api.nest.com/structures/ structure_id /country_code
Trả về string
Ví dụ: "US", "CA", "UK"
Truy cập chỉ đọc
Có sẵn trong Bộ điều chỉnh nhiệt đọc / v1-v6
Điều chỉnh nhiệt đọc / ghi / v1-v6
Khói + CO đọc / v1-v5
Đọc đi / v1-v2
Đọc / ghi / v1-v2
Viết ETA / v1-v2

mã bưu điện

Mã bưu điện hoặc mã zip, tùy thuộc vào quốc gia.

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
Có sẵn trong Mã bưu chính đọc / v1-v2

đỉnh_apse_start_time

Thời gian bắt đầu của sự kiện giờ cao điểm năng lượng , ở định dạng ISO 8601 .

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
Có sẵn trong Bộ điều chỉnh nhiệt đọc / v1-v6
Điều chỉnh nhiệt đọc / ghi / v1-v6
Năng lượng đọc / v1-v2

đỉnh_apse_end_time

Thời gian kết thúc của sự kiện giờ cao điểm năng lượng , ở định dạng ISO 8601 .

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
Có sẵn trong Bộ điều chỉnh nhiệt đọc / v1-v6
Điều chỉnh nhiệt đọc / ghi / v1-v6
Năng lượng đọc / v1-v2

Múi giờ

Múi giờ ở cấu trúc, ở định dạng múi giờ IANA .

Chi tiết
https://developer-api.nest.com/structures/ structure_id /time_zone
Trả về string
Ví dụ: "America / Los_Angele"
Truy cập chỉ đọc
Có sẵn trong Bộ điều chỉnh nhiệt đọc / v1-v6
Điều chỉnh nhiệt đọc / ghi / v1-v6
Khói + CO đọc / v1-v5
Đọc đi / v1-v2
Đọc / ghi / v2
Viết ETA / v1-v2

eta

ETA (thời gian dự kiến ​​đến) là một đối tượng có thể được đặt trên một cấu trúc. Nó được sử dụng để cho Nest biết rằng người dùng dự kiến ​​sẽ trở về nhà vào một thời điểm cụ thể. Để biết thông tin về cách thực hiện cuộc gọi ETA, hãy xem Hướng dẫn đi .

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ố
trip_id Chuỗi do người dùng xác định xác định chuyến đi
estimated_arrival_window_begin Dấu thời gian ở định dạng ISO 8601 .
Phải lớn hơn NOW .
estimated_arrival_window_end Dấu thời gian ở định dạng ISO 8601 .
Phải lớn hơn estimated_arrival_window_begin .
Truy cập chỉ viết
Có sẵn trong Viết ETA / v1-v2

eta_begin

Dấu thời gian của thời gian dự kiến ​​đến sớm nhất ở định dạng ISO 8601 . Được sử dụng để kích hoạt các hành động hoặc sự kiện.

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
Có sẵn trong Đọc ETA / v1

rhr_enrollment

Trạng thái đăng ký Phần thưởng Giờ cao điểm .

Chi tiết
https://developer-api.nest.com/structures/ structure_id /rhr_enrollment
Trả về boolean
Giá trị: đúng, sai
Truy cập chỉ đọc
Có sẵn trong Năng lượng đọc / v1-v2

wwn_security_state

Cấu trúc nhà nước bảo mật.

Chi tiết
https://developer-api.nest.com/structures/ structure_id /wwn_security_state
Kiểu string enum
Giá trị: "ok", "răn đe"
Truy cập chỉ đọc
Có sẵn trong Trạng thái bảo mật đọc / v1

nơi

Một đối tượng chứa nơi định danh ( where_idname ) cho các thiết bị trong cấu trúc. namename hiển thị của thiết bị. Nó có thể là bất kỳ tên phòng nào từ danh sách chúng tôi cung cấp hoặc tên tùy chỉnh.

Để biết thêm thông tin về wheres , xem Cấu trúc Hướng dẫn .

Tìm hiểu thêm về nơi đặt tên cho Nest Thermostats , Nest ProtectsNest Cam .

Chi tiết
https://developer-api.nest.com/structures/ structure_id /wheres
Trả về object
Truy cập chỉ đọc
Có sẵn trong Đọc:
Bộ điều chỉnh nhiệt đọc / v3-v6
Bộ điều nhiệt đọc / ghi / v3-v6
Khói + 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
Máy ảnh đọc / ghi + hình ảnh / v1-v4

trong đó

Một định danh duy nhất, do Nest tạo ra đại diện cho name .

where_id được tự động tạo và trả lại trong khi gọi để tạo name .

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
Có sẵn trong Đọc:
Bộ điều chỉnh nhiệt đọc / v3-v6
Bộ điều nhiệt đọc / ghi / v3-v6
Khói + 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
Máy ảnh đọc / ghi + hình ảnh / v1-v4

Tên

Tên hiển thị của thiết bị.

Chi tiết
https://developer-api.nest.com/structures/ structure_id /wheres/ where_id /name
Trả về string
Ví dụ: "Phòng ngủ"
Truy cập đọc viết
Có sẵn trong Đọc:
Bộ điều chỉnh nhiệt đọc / v3-v6
Bộ điều nhiệt đọc / ghi / v3-v6
Khói + 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
Máy ảnh đọc / ghi + hình ảnh / v1-v4

co_alarm_state

Tình trạng báo động CO.

Chi tiết
https://developer-api.nest.com/structures/ structure_id /co_alarm_state
Trả về string enum
Giá trị: "ok", "cảnh báo", "khẩn cấp"
Truy cập chỉ đọc
Có sẵn trong Khói + CO đọc / v5

khói_alarm_state

Tình trạng báo động khói.

Chi tiết
https://developer-api.nest.com/structures/ structure_id /smoke_alarm_state
Trả về string enum
Giá trị: "ok", "cảnh báo", "khẩn cấp"
Truy cập chỉ đọc
Có sẵn trong Khói + CO đọc / v5