کاربران می توانند یک اضافه حداکثر سه ساختار با دستگاه های متعدد در هر ساختار،.
همه کمتر از مقادیر در زیر هر یافت structures/ structure_id در سند JSON.
structure_id
شماره شناسه سازه هنگامی که با این مکان داده تماس می گیرید، می توانید به مقادیر داده در این ساختار دسترسی داشته باشید.
| جزئیات | |
|---|---|
https://developer-api.nest.com/structures/ structure_id /structure_id | |
| برمی گرداند | stringمثال: "VqFabWH21nw..." |
| دسترسی داشته باشید | فقط خواندنی |
| قابل دسترسی در | خواندن ترموستات / v1-v6 خواندن/نوشتن ترموستات / v1-v6 Smoke+CO read / v1-v5 Away read / v1-v2 دور خواندن/نوشتن / v1-v2 نوشتن ETA / v1-v2 کد پستی خوانده شده / v2 دوربین خواندن / v1-v3 دوربین خواندن + تصاویر / v1-v4 خواندن/نوشتن دوربین / v1-v3 خواندن/نوشتن دوربین + تصاویر / v1-v4 انرژی خواندن / v2 |
ترموستات ها
فهرست ترموستات ها در سازه، بر اساس شناسه دستگاه منحصر به فرد. این آرایه ای از اشیاء JSON است که تمام ترموستات های ساختار را شامل می شود.
| جزئیات | |
|---|---|
https://developer-api.nest.com/structures/ structure_id /thermostats | |
| برمی گرداند | arrayبه عنوان مثال: [ "peyiJNo0IldT2YlIVtYaGQ",... ] |
| دسترسی داشته باشید | فقط خواندنی |
| قابل دسترسی در | خواندن ترموستات / v1-v6 خواندن/نوشتن ترموستات / v1-v6 Smoke+CO read / v1-v5 Away read / v1-v2 دور خواندن/نوشتن / v1-v2 نوشتن ETA / v1-v2 دوربین خواندن / v2-v3 دوربین خواندن + تصاویر / v2-v4 خواندن/نوشتن دوربین / v2-v3 خواندن/نوشتن دوربین + تصاویر / v2-v4 |
دود_هم_آلارم
فهرست هشدارهای دود + CO در سازه، بر اساس شناسه دستگاه منحصر به فرد. این آرایه ای از اشیاء JSON است که شامل همه آلارم های دود + CO در ساختار است.
| جزئیات | |
|---|---|
https://developer-api.nest.com/structures/ structure_id /smoke_co_alarms | |
| برمی گرداند | arrayبه عنوان مثال: [ "RTMTKxsQTCxzVcsySOHPxKoF4OyCifrs",... ] |
| دسترسی داشته باشید | فقط خواندنی |
| قابل دسترسی در | خواندن ترموستات / v1-v6 خواندن/نوشتن ترموستات / v1-v6 Smoke+CO read / v1-v5 Away read / v1-v2 دور خواندن/نوشتن / v1-v2 نوشتن ETA / v1-v2 دوربین خواندن / v2-v3 دوربین خواندن + تصاویر / v2-v4 خواندن/نوشتن دوربین / v2-v3 خواندن/نوشتن دوربین + تصاویر / v2-v4 |
دوربین ها
لیست دوربین های موجود در ساختار، بر اساس شناسه دستگاه منحصر به فرد. این آرایه ای از اشیاء JSON است که تمام دوربین های موجود در ساختار را شامل می شود.
| جزئیات | |
|---|---|
https://developer-api.nest.com/structures/ structure_id /cameras | |
| برمی گرداند | arrayبه عنوان مثال: [ "awJo6rH...",... ] |
| دسترسی داشته باشید | فقط خواندنی |
| قابل دسترسی در | خواندن ترموستات / v4-v6 خواندن/نوشتن ترموستات / v4-v6 Smoke+CO read / v4-v5 Away read / v2 دور خواندن/نوشتن / نسخه 2 نوشتن ETA / v2 دوربین خواندن / v1-v3 دوربین خواندن + تصاویر / v1-v4 خواندن/نوشتن دوربین / v1-v3 خواندن/نوشتن دوربین + تصاویر / v1-v4 |
دور
وضعیت اشغال سازه را نشان می دهد.
سازه وجود دو دولت مربوط به حضور: home و یا away . وقتی که هیچ حرکتی است که در خانه احساس، ساختار از تغییر خواهد کرد home را به away .
| جزئیات | |
|---|---|
https://developer-api.nest.com/structures/ structure_id /away | |
| برمی گرداند | stringارزش ها: "خانه"، "دور" |
| دسترسی داشته باشید | خواندن/نوشتن |
| قابل دسترسی در | خواندن: خواندن ترموستات / v1-v6 خواندن/نوشتن ترموستات / v1-v6 Smoke+CO read / v1-v5 Away read / v1-v2 دور خواندن/نوشتن / v1-v2 نوشتن ETA / v1-v2 نوشتن: دور خواندن/نوشتن / v1-v2 |
نام
نام نمایشی تعریف شده توسط کاربر برای ساختار.
| جزئیات | |
|---|---|
https://developer-api.nest.com/structures/ structure_id /name | |
| برمی گرداند | stringمثال: "خانه من"، "خانه ساحلی"، "خانه کوهستانی" |
| دسترسی داشته باشید | خواندن/نوشتن |
| قابل دسترسی در | خواندن: خواندن ترموستات / v1-v6 خواندن/نوشتن ترموستات / v1-v6 Smoke+CO read / v1-v5 Away read / v1-v2 دور خواندن/نوشتن / v1-v2 نوشتن ETA / v1-v2 کد پستی خوانده شده / v2 دوربین خواندن / v1-v3 دوربین خواندن + تصاویر / v1-v4 خواندن/نوشتن دوربین / v1-v3 خواندن/نوشتن دوربین + تصاویر / v1-v4 انرژی خواندن / v2 ساختار خواندن/نوشتن / v1 نوشتن: ساختار خواندن/نوشتن / v1 |
کد کشور
کد کشور، در ISO 3166 آلفا 2 فرمت.
| جزئیات | |
|---|---|
https://developer-api.nest.com/structures/ structure_id /country_code | |
| برمی گرداند | stringمثال‌ها: "US"، "CA"، "UK" |
| دسترسی داشته باشید | فقط خواندنی |
| قابل دسترسی در | خواندن ترموستات / v1-v6 خواندن/نوشتن ترموستات / v1-v6 Smoke+CO read / v1-v5 Away read / v1-v2 دور خواندن/نوشتن / v1-v2 نوشتن ETA / v1-v2 |
کد پستی
کد پستی یا پستی بسته به کشور.
| جزئیات | |
|---|---|
https://developer-api.nest.com/structures/ structure_id /postal_code | |
| برمی گرداند | stringمثال‌ها: "94304"، "94304-1027"، "EC1A 1BB" |
| دسترسی داشته باشید | فقط خواندنی |
| قابل دسترسی در | کد پستی خوانده شده / v1-v2 |
اوج_دوره_شروع_زمان
زمان شروع ساعت شلوغی انرژی رویداد، در 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" |
| دسترسی داشته باشید | فقط خواندنی |
| قابل دسترسی در | خواندن ترموستات / v1-v6 خواندن/نوشتن ترموستات / v1-v6 Smoke+CO read / v1-v5 Away read / v1-v2 دور خواندن/نوشتن / نسخه 2 نوشتن ETA / v1-v2 |
eta
ETA (زمان تخمینی رسیدن) یک شی است که می تواند بر روی یک ساختار تنظیم شود. از آن برای اطلاع دادن به Nest استفاده می شود که انتظار می رود کاربر در یک زمان خاص به خانه بازگردد. برای اطلاعات در مورد چگونگی ساخت یک تماس ETA، نگاه کنید به دور راهنمای .
| جزئیات | |||||||
|---|---|---|---|---|---|---|---|
https://developer-api.nest.com/structures/ structure_id /eta | |||||||
| برمی گرداند | objectمثال: "myTripID1024"، "2014-10-31T22:42:00.000Z"، "2016-12-31T23:59:59.000Z" | ||||||
| مولفه های |
| ||||||
| دسترسی داشته باشید | فقط نوشتن | ||||||
| قابل دسترسی در | نوشتن ETA / v1-v2 | ||||||
eta_begin
زمان انتشار اولین زمان انتظار از رسیدن در ISO 8601 فرمت. برای راه اندازی اقدامات یا رویدادها استفاده می شود.
| جزئیات | |
|---|---|
https://developer-api.nest.com/structures/ structure_id /eta_begin | |
| برمی گرداند | stringمثال: "2016-12-31T23:59:59.000Z" |
| دسترسی داشته باشید | فقط خواندنی |
| قابل دسترسی در | خواندن ETA / v1 |
rhr_ ثبت نام
ساعت شلوغی پاداش وضعیت ثبت نام.
| جزئیات | |
|---|---|
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 ، را ببینید ساختار راهنمای .
اطلاعات بیشتر در مورد که در آن نام برای دما آشیانه ، آشیانه محافظت و آشیانه کم .
| جزئیات | |
|---|---|
https://developer-api.nest.com/structures/ structure_id /wheres | |
| برمی گرداند | object |
| دسترسی داشته باشید | فقط خواندنی |
| قابل دسترسی در | خواندن: خواندن ترموستات / v3-v6 خواندن/نوشتن ترموستات / نسخه 3-v6 Smoke+CO read / v3-v5 دوربین خواندن / v1-v3 دوربین خواندن + تصاویر / v1-v4 خواندن/نوشتن دوربین / v1-v3 خواندن/نوشتن دوربین + تصاویر / v1-v4 |
Where_id
منحصر به فرد، شناسه آشیانه تولید شده است که نشان دهنده name .
where_id به طور خودکار ایجاد شده و در طول تماس بازگشت به ایجاد name .
| جزئیات | |
|---|---|
https://developer-api.nest.com/structures/ structure_id /wheres/ where_id /where_id | |
| برمی گرداند | stringمثال: "Fqp6wJI..." |
| دسترسی داشته باشید | فقط خواندنی |
| قابل دسترسی در | خواندن: خواندن ترموستات / v3-v6 خواندن/نوشتن ترموستات / نسخه 3-v6 Smoke+CO read / v3-v5 دوربین خواندن / v1-v3 دوربین خواندن + تصاویر / v1-v4 خواندن/نوشتن دوربین / v1-v3 خواندن/نوشتن دوربین + تصاویر / v1-v4 |
نام
نام نمایشی دستگاه
| جزئیات | |
|---|---|
https://developer-api.nest.com/structures/ structure_id /wheres/ where_id /name | |
| برمی گرداند | stringمثال: "اتاق خواب" |
| دسترسی داشته باشید | خواندن/نوشتن |
| قابل دسترسی در | خواندن: خواندن ترموستات / v3-v6 خواندن/نوشتن ترموستات / نسخه 3-v6 Smoke+CO read / v3-v5 دوربین خواندن / v1-v3 دوربین خواندن + تصاویر / v1-v4 خواندن/نوشتن دوربین / v1-v3 خواندن/نوشتن دوربین + تصاویر / v1-v4 |
co_alarm_state
وضعیت آلارم CO
| جزئیات | |
|---|---|
https://developer-api.nest.com/structures/ structure_id /co_alarm_state | |
| برمی گرداند | string enumمقادیر: "ok"، "هشدار"، "اورژانس" |
| دسترسی داشته باشید | فقط خواندنی |
| قابل دسترسی در | Smoke+CO read / v5 |
دود_آلارم_حالت
وضعیت هشدار دود
| جزئیات | |
|---|---|
https://developer-api.nest.com/structures/ structure_id /smoke_alarm_state | |
| برمی گرداند | string enumمقادیر: "ok"، "هشدار"، "اورژانس" |
| دسترسی داشته باشید | فقط خواندنی |
| قابل دسترسی در | Smoke+CO read / v5 |