کاربران می توانند حداکثر سه ساختار با چندین دستگاه در هر ساختار اضافه کنند.
همه کمتر از مقادیر در زیر هر یافت structures/ structure_id در سند JSON.
ساختار
شناسه سازه. وقتی با این مکان داده تماس برقرار می کنید ، می توانید به مقادیر داده موجود در این ساختار دسترسی پیدا کنید.
| جزئیات | |
|---|---|
https://developer-api.nest.com/structures/ structure_id /structure_id | |
| برمی گردد | string مثال: "VqFabWH21nw ..." |
| دسترسی | فقط خواندنی |
| قابل دسترسی در | ترموستات read / v1-v6 ترموستات خواندن / نوشتن / v1-v6 دود + CO بخوانید / v1-v5 دور خوانده شود / v1-v2 دور بخوانید / بنویسید / v1-v2 ETA write / v1-v2 کد پستی خوانده شده / v2 دوربین خوانده شده / v1-v3 خواندن دوربین + تصاویر / v1-v4 دوربین خواندن / نوشتن / v1-v3 دوربین خواندن / نوشتن + تصاویر / v1-v4 انرژی خواندن / v2 |
ترموستات
لیست ترموستات موجود در سازه ، توسط شناسه دستگاه منحصر به فرد. این مجموعه ای از اشیاء JSON است که کلیه ترموستات های موجود در سازه را شامل می شود.
| جزئیات | |
|---|---|
https://developer-api.nest.com/structures/ structure_id /thermostats | |
| برمی گردد | array مثال: [ "peyiJNo0IldT2YlIVtYaGQ",... ] |
| دسترسی | فقط خواندنی |
| قابل دسترسی در | ترموستات read / v1-v6 ترموستات خواندن / نوشتن / v1-v6 دود + CO بخوانید / v1-v5 دور خوانده شود / v1-v2 دور بخوانید / بنویسید / v1-v2 ETA write / 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",... ] |
| دسترسی | فقط خواندنی |
| قابل دسترسی در | ترموستات read / v1-v6 ترموستات خواندن / نوشتن / v1-v6 دود + CO بخوانید / v1-v5 دور خوانده شود / v1-v2 دور بخوانید / بنویسید / v1-v2 ETA write / v1-v2 دوربین خوانده شده / v2-v3 خواندن دوربین + تصاویر / v2-v4 دوربین خواندن / نوشتن / v2-v3 دوربین خواندن / نوشتن + تصاویر / v2-v4 |
دوربین
لیست دوربین های موجود در سازه ، توسط شناسه دستگاه منحصر به فرد. این مجموعه ای از اشیاء JSON است که کلیه دوربین های موجود در سازه را شامل می شود.
| جزئیات | |
|---|---|
https://developer-api.nest.com/structures/ structure_id /cameras | |
| برمی گردد | array مثال: [ "awJo6rH...",... ] |
| دسترسی | فقط خواندنی |
| قابل دسترسی در | ترموستات read / v4-v6 ترموستات خواندن / نوشتن / v4-v6 دود + CO بخوانید / v4-v5 دور خواندن / v2 دور خواندن / نوشتن / v2 ETA نوشتن / v2 دوربین خوانده شده / v1-v3 خواندن دوربین + تصاویر / v1-v4 دوربین خواندن / نوشتن / v1-v3 دوربین خواندن / نوشتن + تصاویر / v1-v4 |
دور
وضعیت اشغال سازه را نشان می دهد.
ساختارها دو حالت دارند که مربوط به حضور هستند: home یا away . وقتی که هیچ حرکتی است که در خانه احساس، ساختار از تغییر خواهد کرد home را به away .
| جزئیات | |
|---|---|
https://developer-api.nest.com/structures/ structure_id /away | |
| برمی گردد | string ارزش ها: "خانه" ، "دور" |
| دسترسی | خواندن / نوشتن |
| قابل دسترسی در | خواندن: ترموستات read / v1-v6 ترموستات خواندن / نوشتن / v1-v6 دود + CO بخوانید / v1-v5 دور خوانده شود / v1-v2 دور بخوانید / بنویسید / v1-v2 ETA write / v1-v2 نوشتن: دور بخوانید / بنویسید / v1-v2 |
نام
نام صفحه نمایش ساختار تعریف شده توسط کاربر.
| جزئیات | |
|---|---|
https://developer-api.nest.com/structures/ structure_id /name | |
| برمی گردد | string مثال: "خانه من" ، "خانه ساحل" ، "خانه کوه" |
| دسترسی | خواندن / نوشتن |
| قابل دسترسی در | خواندن: ترموستات read / v1-v6 ترموستات خواندن / نوشتن / v1-v6 دود + CO بخوانید / v1-v5 دور خوانده شود / v1-v2 دور بخوانید / بنویسید / v1-v2 ETA write / v1-v2 کد پستی خوانده شده / v2 دوربین خوانده شده / v1-v3 خواندن دوربین + تصاویر / v1-v4 دوربین خواندن / نوشتن / v1-v3 دوربین خواندن / نوشتن + تصاویر / v1-v4 انرژی خواندن / v2 ساختار خواندن / نوشتن / v1 نوشتن: ساختار خواندن / نوشتن / v1 |
کد کشور
کد کشور ، با فرمت ISO 3166 alpha-2 .
| جزئیات | |
|---|---|
https://developer-api.nest.com/structures/ structure_id /country_code | |
| برمی گردد | string مثالها: "US" ، "CA" ، "UK" |
| دسترسی | فقط خواندنی |
| قابل دسترسی در | ترموستات read / v1-v6 ترموستات خواندن / نوشتن / v1-v6 دود + CO بخوانید / v1-v5 دور خوانده شود / v1-v2 دور بخوانید / بنویسید / v1-v2 ETA write / 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" |
| دسترسی | فقط خواندنی |
| قابل دسترسی در | ترموستات read / 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" |
| دسترسی | فقط خواندنی |
| قابل دسترسی در | ترموستات read / v1-v6 ترموستات خواندن / نوشتن / v1-v6 انرژی خواندن / v1-v2 |
منطقه زمانی
منطقه زمانی در سازه ، با فرمت منطقه زمانی IANA .
| جزئیات | |
|---|---|
https://developer-api.nest.com/structures/ structure_id /time_zone | |
| برمی گردد | string مثال: "America / Los_Agegeles" |
| دسترسی | فقط خواندنی |
| قابل دسترسی در | ترموستات read / v1-v6 ترموستات خواندن / نوشتن / v1-v6 دود + CO بخوانید / v1-v5 دور خوانده شود / v1-v2 دور خواندن / نوشتن / v2 ETA write / v1-v2 |
و
ETA (زمان تقریبی رسیدن) شیئی است که می تواند روی یک ساختار تنظیم شود. این مورد برای آگاه سازی Nest است که انتظار می رود کاربر در زمان مشخصی به خانه برگردد. برای اطلاعات در مورد نحوه برقراری تماس ETA ، به راهنمای Away مراجعه کنید.
| جزئیات | |||||||
|---|---|---|---|---|---|---|---|
https://developer-api.nest.com/structures/ structure_id /eta | |||||||
| برمی گردد | object مثال: "myTripID1024" ، "2014-10-31T22: 42: 00.000Z" ، "2016-12-31T23: 59: 59.000Z" | ||||||
| مولفه های |
| ||||||
| دسترسی | فقط نوشتن | ||||||
| قابل دسترسی در | ETA write / 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_enrollment
وضعیت ثبت نام جوایز Rush Hour Rewards .
| جزئیات | |
|---|---|
https://developer-api.nest.com/structures/ structure_id /rhr_enrollment | |
| برمی گردد | boolean ارزش ها: درست ، غلط |
| دسترسی | فقط خواندنی |
| قابل دسترسی در | انرژی خواندن / v1-v2 |
wwn_securance_state
ساختار امنیتی دولت.
| جزئیات | |
|---|---|
https://developer-api.nest.com/structures/ structure_id /wwn_security_state | |
| تایپ کنید | string enum مقادیر: "خوب" ، "بازدارندگی" |
| دسترسی | فقط خواندنی |
| قابل دسترسی در | وضعیت امنیتی خوانده شده / v1 |
چرخ ها
یک شیء شامل که در آن شناسه ( where_id و name ) برای دستگاه های در ساختار. name نمایشگر دستگاه است. این می تواند به هر نام یک لیست از لیستی که ارائه می دهیم یا یک نام سفارشی باشد.
برای اطلاعات بیشتر در مورد wheres ، به راهنمای ساختار مراجعه کنید.
در مورد نام های Nest Thermostats ، Nest Protects و Nest Cams اطلاعات بیشتری کسب کنید.
| جزئیات | |
|---|---|
https://developer-api.nest.com/structures/ structure_id /wheres | |
| برمی گردد | object |
| دسترسی | فقط خواندنی |
| قابل دسترسی در | خواندن: ترموستات read / v3-v6 ترموستات خواندن / نوشتن / v3-v6 دود + CO بخوانید / v3-v5 دوربین خوانده شده / v1-v3 خواندن دوربین + تصاویر / v1-v4 دوربین خواندن / نوشتن / v1-v3 دوربین خواندن / نوشتن + تصاویر / v1-v4 |
کجا
شناسه منحصر به فرد و تولید شده توسط لانه که نشان دهنده name .
where_id به طور خودکار ایجاد شده و در طول تماس بازگشت به ایجاد name .
| جزئیات | |
|---|---|
https://developer-api.nest.com/structures/ structure_id /wheres/ where_id /where_id | |
| برمی گردد | string مثال: "Fqp6wJI ..." |
| دسترسی | فقط خواندنی |
| قابل دسترسی در | خواندن: ترموستات read / v3-v6 ترموستات خواندن / نوشتن / v3-v6 دود + CO بخوانید / v3-v5 دوربین خوانده شده / v1-v3 خواندن دوربین + تصاویر / v1-v4 دوربین خواندن / نوشتن / v1-v3 دوربین خواندن / نوشتن + تصاویر / v1-v4 |
نام
نام صفحه نمایش دستگاه.
| جزئیات | |
|---|---|
https://developer-api.nest.com/structures/ structure_id /wheres/ where_id /name | |
| برمی گردد | string مثال: "اتاق خواب" |
| دسترسی | خواندن / نوشتن |
| قابل دسترسی در | خواندن: ترموستات read / v3-v6 ترموستات خواندن / نوشتن / v3-v6 دود + CO بخوانید / 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 مقادیر: "خوب" ، "هشدار" ، "اضطراری" |
| دسترسی | فقط خواندنی |
| قابل دسترسی در | دود + CO بخوانید / v5 |
smoke_alarm_state
وضعیت زنگ دود.
| جزئیات | |
|---|---|
https://developer-api.nest.com/structures/ structure_id /smoke_alarm_state | |
| برمی گردد | string enum مقادیر: "خوب" ، "هشدار" ، "اضطراری" |
| دسترسی | فقط خواندنی |
| قابل دسترسی در | دود + CO بخوانید / v5 |