API โครงสร้าง

ผู้ใช้สามารถเพิ่มโครงสร้างได้สูงสุด 3 รายการ โดยมีอุปกรณ์หลายเครื่องต่อโครงสร้าง 1 รายการ

ค่าด้านล่างทั้งหมดจะอยู่ใน structures/structure_id แต่ละรายการในเอกสาร JSON

รหัส_โครงสร้าง

หมายเลขรหัสของโครงสร้าง เมื่อเรียกใช้ตําแหน่งของข้อมูลนี้ คุณจะเข้าถึงค่าข้อมูลในโครงสร้างนี้ได้

รายละเอียด
https://developer-api.nest.com/structures/structure_id/structure_id
การคืนสินค้าstring
ตัวอย่าง: "VqFabWH21nw..."
สิทธิ์ในการเข้าถึงอ่านอย่างเดียว
พร้อมให้บริการในThermostat อ่าน / v1-v6
Therestat read/write / v1-v6
Smoke+CO read / v1-v5
Away read / v1-v2
Away read/write / v1-v2
ETA write / v1-v2
Post code Read / v1
Camera read / Camera / v1-v1 + read vvvv vเชิญผู้อื่น / อ่านริมหาด
vv

ตัวควบคุมอุณหภูมิ

รายการตัวควบคุมอุณหภูมิในโครงสร้างตามตัวระบุอุปกรณ์ที่ไม่ซ้ํากัน อาร์เรย์นี้เป็นอาร์เรย์ของออบเจ็กต์ JSON ที่รวมตัวควบคุมอุณหภูมิทั้งหมดในโครงสร้าง

รายละเอียด
https://developer-api.nest.com/structures/structure_id/thermostats
การคืนสินค้าarray
ตัวอย่าง: [ "peyiJNo0IldT2YlIVtYaGQ",... ]
สิทธิ์ในการเข้าถึงอ่านอย่างเดียว
พร้อมให้บริการในตัวควบคุมอุณหภูมิอ่าน / v1-v6
Therestat read/write / v1-v6
Smoke+CO read / v1-v5
Away read / v1-v2
Away read/write / v1-v2
Camera read v images / v2 / Camera vv write / Camera vvwrite / Camera vv / Camera vv / Camera v3

เครื่องสูบบุหรี่ไฟฟ้า

รายการสัญญาณเตือนควันและคาร์บอนมอนอกไซด์ในโครงสร้างตามตัวระบุอุปกรณ์ที่ไม่ซ้ํากัน อาร์เรย์ของออบเจ็กต์ JSON ที่มีสัญญาณเตือนควันและคาร์บอนมอนอกไซด์ทั้งหมดอยู่ในโครงสร้าง

รายละเอียด
https://developer-api.nest.com/structures/structure_id/smoke_co_alarms
การคืนสินค้าarray
ตัวอย่าง: [ "RTMTKxsQTCxzVcsySOHPxKoF4OyCifrs",... ]
สิทธิ์ในการเข้าถึงอ่านอย่างเดียว
พร้อมให้บริการในตัวควบคุมอุณหภูมิอ่าน / v1-v6
Therestat read/write / v1-v6
Smoke+CO read / v1-v5
Away read / v1-v2
Away read/write / v1-v2
Camera read v images / v2 / Camera vv write / Camera vvwrite / Camera vv / Camera vv / Camera v3

กล้อง

รายการกล้องในโครงสร้างตามตัวระบุอุปกรณ์ที่ไม่ซ้ํากัน นี่คืออาร์เรย์ของออบเจ็กต์ JSON ที่มีกล้องทั้งหมดในโครงสร้าง

รายละเอียด
https://developer-api.nest.com/structures/structure_id/cameras
การคืนสินค้าarray
ตัวอย่าง: [ "awJo6rH...",... ]
สิทธิ์ในการเข้าถึงอ่านอย่างเดียว
พร้อมให้บริการในThermostat อ่าน / v4-v6
Therestat read/write / v4-v6
Smoke+CO read / v4-v5
Away read / v2
Away read/write / v2
ETA write / v2
Camera Read vv-v3
Camera read/write / images / v1-v4
Camera read/write + images / v1-v4
Camera read/write + images / v1-v4
Camera Read/write + images / v1-v4
+

อยู่ห่าง

ระบุสถานะการเข้าใช้ของโครงสร้าง

โครงสร้างมี 2 สถานะที่เกี่ยวข้องกับการแสดงข้อมูล ได้แก่ home หรือ away หากไม่มีการเคลื่อนไหวในบ้าน โครงสร้างจะเปลี่ยนจาก home เป็น away

รายละเอียด
https://developer-api.nest.com/structures/structure_id/away
การคืนสินค้าstring
ค่า: "home", "away"
สิทธิ์ในการเข้าถึงอ่าน/เขียน
พร้อมให้บริการในอ่าน:
ตัวควบคุมอุณหภูมิ/อ่าน / v1-v6
ตัวควบคุมอุณหภูมิอ่าน/เขียน / v1-v6
Smoke+CO Read / v1-v5
Away Read / v1-v2
Away Read/write / v1-v2
ETA write / v1-v2 / v1-v2 / v1-v2 / v1-v2 / v1

name

ชื่อที่แสดงของโครงสร้างที่ผู้ใช้กําหนด

รายละเอียด
https://developer-api.nest.com/structures/structure_id/name
การคืนสินค้าstring
ตัวอย่าง: "My Home", "Beach House", "Mountain House"
สิทธิ์ในการเข้าถึงอ่าน/เขียน
พร้อมให้บริการในอ่าน:
Therestat read / v1-v6
Ther Mostat read/write / v1-v6
Smoke+CO read / v1-v5
Away read / v1-v2
Away read/v / read v / read v /ส่วนหนึ่ง / อ่าน / v1 / อ่าน / อ่าน v

รหัสประเทศ [country_code]

รหัสประเทศในรูปแบบ ISO 3166 alpha-2

รายละเอียด
https://developer-api.nest.com/structures/structure_id/country_code
การคืนสินค้าstring
ตัวอย่าง: "US", "CA", "UK"
สิทธิ์ในการเข้าถึงอ่านอย่างเดียว
พร้อมให้บริการในThermostat อ่าน / v1-v6
Therestat read/write / v1-v6
Smoke+CO read / v1-v5
Away read / v1-v2
Away read/write / v1-v2
ETA write / v1-v2

รหัสไปรษณีย์

รหัสไปรษณีย์ ทั้งนี้ขึ้นอยู่กับแต่ละประเทศ

รายละเอียด
https://developer-api.nest.com/structures/structure_id/postal_code
การคืนสินค้าstring
ตัวอย่าง: "94304", "94304-1027", "EC1A 1BB"
สิทธิ์ในการเข้าถึงอ่านอย่างเดียว
พร้อมให้บริการในการอ่านรหัสไปรษณีย์ / v1-v2

เวลาเริ่มต้นสูงสุด

เวลาเริ่มต้นของเหตุการณ์ energy Rush Hour ในรูปแบบ ISO 8601

รายละเอียด
https://developer-api.nest.com/structures/structure_id/peak_period_start_time
การคืนสินค้าstring
ตัวอย่าง: "2016-12-31T23:59:59.000Z"
สิทธิ์ในการเข้าถึงอ่านอย่างเดียว
พร้อมให้บริการในการอ่านตัวควบคุมอุณหภูมิ / v1-v6
ตัวควบคุมอุณหภูมิให้อ่าน/เขียน / v1-v6
อ่านพลังงาน / v1-v2

เวลาสิ้นสุดช่วงเวลาสูงสุด

เวลาสิ้นสุดของเหตุการณ์ชั่วโมงเร่งพลัง ในรูปแบบ ISO 8601

รายละเอียด
https://developer-api.nest.com/structures/structure_id/peak_period_end_time
การคืนสินค้าstring
ตัวอย่าง: "2016-12-31T23:59:59.000Z"
สิทธิ์ในการเข้าถึงอ่านอย่างเดียว
พร้อมให้บริการในการอ่านตัวควบคุมอุณหภูมิ / v1-v6
ตัวควบคุมอุณหภูมิให้อ่าน/เขียน / v1-v6
อ่านพลังงาน / v1-v2

เขตเวลา

เขตเวลาในโครงสร้างในรูปแบบเขตเวลา IANA

รายละเอียด
https://developer-api.nest.com/structures/structure_id/time_zone
การคืนสินค้าstring
ตัวอย่าง: "America/Los_Angeles"
สิทธิ์ในการเข้าถึงอ่านอย่างเดียว
พร้อมให้บริการในThermostat อ่าน / v1-v6
Therestat read/write / v1-v6
Smoke+CO read / v1-v5
Away read / v1-v2
Away read/write / v2
ETA write / v1-v2

ETA

ETA (เวลาถึงโดยประมาณ) คือออบเจ็กต์ที่ตั้งค่าในโครงสร้างได้ ใช้เพื่อบอกให้ Nest ทราบว่าผู้ใช้จะต้องกลับบ้านในเวลาหนึ่งๆ สําหรับข้อมูลเกี่ยวกับการโทรเวลาถึงโดยประมาณ โปรดดูคู่มือไม่อยู่บ้าน

รายละเอียด
https://developer-api.nest.com/structures/structure_id/eta
การคืนสินค้าobject
ตัวอย่าง: "myTripID1024", "2014-10-31T22:42:00.000Z", "2016-12-31T23:59:59.000Z"
พารามิเตอร์
trip_idสตริงที่ผู้ใช้ระบุสําหรับการเดินทาง
estimated_arrival_window_begin การประทับเวลาในรูปแบบ ISO 8601
ต้องมากกว่า NOW
estimated_arrival_window_endการประทับเวลาในรูปแบบ ISO 8601
ต้องมากกว่า estimated_arrival_window_begin
สิทธิ์ในการเข้าถึงเขียนเท่านั้น
พร้อมให้บริการในเวลาถึงโดยประมาณ / v1-v2

eta_begin

การประทับเวลาแรกของเวลาที่คาดว่าจะได้รับในรูปแบบ ISO 8601 ใช้เพื่อทริกเกอร์การทํางานหรือเหตุการณ์

รายละเอียด
https://developer-api.nest.com/structures/structure_id/eta_begin
การคืนสินค้าstring
ตัวอย่าง: "2016-12-31T23:59:59.000Z"
สิทธิ์ในการเข้าถึงอ่านอย่างเดียว
พร้อมให้บริการในเวลาถึงโดยประมาณ / v1

การลงทะเบียน rhr

สถานะการลงทะเบียน Rush Hour Rewards

รายละเอียด
https://developer-api.nest.com/structures/structure_id/rhr_enrollment
การคืนสินค้าboolean
ค่า: จริง, เท็จ
สิทธิ์ในการเข้าถึงอ่านอย่างเดียว
พร้อมให้บริการในการอ่านพลังงาน / v1-v2

สถานะความปลอดภัย wwn_security_state

สถานะความปลอดภัยของโครงสร้าง

รายละเอียด
https://developer-api.nest.com/structures/structure_id/wwn_security_state
ประเภทstring enum
ค่า: "ok", "deter"
สิทธิ์ในการเข้าถึงอ่านอย่างเดียว
พร้อมให้บริการในการอ่านสถานะความปลอดภัย / v1

ที่ไหน

ออบเจ็กต์ที่มีตัวระบุ (where_id และ name) สําหรับอุปกรณ์ในโครงสร้าง name คือชื่อที่แสดงของอุปกรณ์ โดยอาจเป็นชื่อห้องใดก็ได้จากรายการที่เราแสดงไว้ หรือชื่อที่กําหนดเอง

ดูข้อมูลเพิ่มเติมเกี่ยวกับ wheres ได้ที่คู่มือโครงสร้าง

ดูข้อมูลเพิ่มเติมเกี่ยวกับชื่อของ Nest Thermostat, Nest Protect และ Nest Cam

รายละเอียด
https://developer-api.nest.com/structures/structure_id/wheres
การคืนสินค้าobject
สิทธิ์ในการเข้าถึงอ่านอย่างเดียว
พร้อมให้บริการในอ่าน:
Therestat read / v3-v6
Srokeat read/write / v3-v6
Smoke+CO read / v3-v5
Camera Read / v1-v3
อ่านบนกล้อง + รูปภาพ / v1-v4
อ่าน/เขียนกล้องถ่ายรูป / v1-v4 / v1-v4 / v1-v4 /

รหัสสถานที่

ตัวระบุที่ไม่ซ้ํากันซึ่งสร้างขึ้นโดย Nest ซึ่งแสดง name

where_id จะสร้างขึ้นและส่งคืนโดยอัตโนมัติระหว่างการโทรเพื่อสร้างname

รายละเอียด
https://developer-api.nest.com/structures/structure_id/wheres/where_id/where_id
การคืนสินค้าstring
ตัวอย่าง: "Fqp6wJI..."
สิทธิ์ในการเข้าถึงอ่านอย่างเดียว
พร้อมให้บริการในอ่าน:
Therestat read / v3-v6
Ther Mostat read/write / v3-v6
Smoke+CO read / v3-v5
Camera read / v1-v3
Camera read + images / v1-v4
Camera Read/write / v1-v3
กล้องอ่าน/เขียน + รูปภาพ -

name

ชื่อที่แสดงของอุปกรณ์

รายละเอียด
https://developer-api.nest.com/structures/structure_id/wheres/where_id/name
การคืนสินค้าstring
ตัวอย่าง: "Bedroom"
สิทธิ์ในการเข้าถึงอ่าน/เขียน
พร้อมให้บริการในอ่าน:
Therestat read / v3-v6
Srokeat read/write / v3-v6
Smoke+CO read / v3-v5
Camera Read / v1-v3
อ่านกล้อง + รูปภาพ / v1-v4
อ่าน/เขียนในกล้อง / v1-v4 / v1-v4 / v1-v4 /

รัฐ_coalarm_state

สถานะสัญญาณเตือนคาร์บอนมอนอกไซด์

รายละเอียด
https://developer-api.nest.com/structures/structure_id/co_alarm_state
การคืนสินค้าstring enum
ค่า: "ok", "warning", "เหตุฉุกเฉิน
สิทธิ์ในการเข้าถึงอ่านอย่างเดียว
พร้อมให้บริการในการอ่านควัน / คาร์บอนมอนอกไซด์ v5

สถานะควัน

สถานะสัญญาณเตือนควัน

รายละเอียด
https://developer-api.nest.com/structures/structure_id/smoke_alarm_state
การคืนสินค้าstring enum
ค่า: "ok", "warning", "เหตุฉุกเฉิน
สิทธิ์ในการเข้าถึงอ่านอย่างเดียว
พร้อมให้บริการในการอ่านควัน / คาร์บอนมอนอกไซด์ v5