ساختار API

کاربران می توانند حداکثر سه ساختار با چندین دستگاه در هر ساختار اضافه کنند.

همه کمتر از مقادیر در زیر هر یافت structures/ structure_id در سند JSON.

ساختار_امید

شماره شناسه سازه. وقتی با این مکان داده تماس می گیرید ، می توانید به مقادیر داده موجود در این ساختار دسترسی پیدا کنید.

جزئیات
https://developer-api.nest.com/structures/ structure_id /structure_id
برمی گردد	string مثال: "VqFabWH21nw ..."
دسترسی	فقط خواندنی
قابل دسترسی در	ترموستات read / v1-v6 خواندن / نوشتن ترموستات / v1-v6 دود + CO read / v1-v5 دور / v1-v2 را بخوانید خواندن / نوشتن / v1-v2 را فراموش نکنید ETA write / v1-v2 کد پستی read / v2 خواندن دوربین / v1-v3 خواندن دوربین + تصاویر / v1-v4 خواندن / نوشتن دوربین / v1-v3 خواندن / نوشتن دوربین + تصاویر / v1-v4 انرژی خواندن / v2

ترموستات

لیست ترموستات های موجود در ساختار ، توسط شناسه منحصر به فرد دستگاه. این آرایه ای از اشیا J JSON است که شامل تمام ترموستات های موجود در ساختار است.

جزئیات
https://developer-api.nest.com/structures/ structure_id /thermostats
برمی گردد	array مثال: [ "peyiJNo0IldT2YlIVtYaGQ",... ]
دسترسی	فقط خواندنی
قابل دسترسی در	ترموستات read / v1-v6 خواندن / نوشتن ترموستات / v1-v6 دود + CO read / v1-v5 / v1-v2 را بخوانید خواندن / نوشتن / v1-v2 را فراموش نکنید ETA write / v1-v2 خواندن دوربین / v2-v3 خواندن دوربین + تصاویر / v2-v4 خواندن / نوشتن دوربین / v2-v3 خواندن / نوشتن دوربین + تصاویر / v2-v4

دزدگیرها و دزدگیرها

لیست آلارم های دود + CO در ساختار ، توسط شناسه منحصر به فرد دستگاه. این آرایه ای از اشیا J JSON است که شامل تمام آلارم های دود + CO در ساختار می شود.

جزئیات
https://developer-api.nest.com/structures/ structure_id /smoke_co_alarms
برمی گردد	array مثال: [ "RTMTKxsQTCxzVcsySOHPxKoF4OyCifrs",... ]
دسترسی	فقط خواندنی
قابل دسترسی در	ترموستات read / v1-v6 خواندن / نوشتن ترموستات / v1-v6 دود + CO read / v1-v5 / v1-v2 را بخوانید خواندن / نوشتن / v1-v2 را فراموش نکنید ETA write / v1-v2 خواندن دوربین / v2-v3 خواندن دوربین + تصاویر / v2-v4 خواندن / نوشتن دوربین / v2-v3 خواندن / نوشتن دوربین + تصاویر / v2-v4

دوربین ها

لیست دوربین های موجود در ساختار ، توسط شناسه منحصر به فرد دستگاه. این آرایه ای از اشیا J JSON است که شامل تمام دوربین های موجود در ساختار است.

جزئیات
https://developer-api.nest.com/structures/ structure_id /cameras
برمی گردد	array مثال: [ "awJo6rH...",... ]
دسترسی	فقط خواندنی
قابل دسترسی در	ترموستات read / v4-v6 ترموستات خواندن / نوشتن / v4-v6 دود + CO read / v4-v5 دور بخوانید / v2 دور / خواندن / نوشتن / v2 ETA write / v2 خواندن دوربین / v1-v3 خواندن دوربین + تصاویر / v1-v4 خواندن / نوشتن دوربین / v1-v3 خواندن / نوشتن دوربین + تصاویر / v1-v4

دور

وضعیت اشغال سازه را نشان می دهد.

سازه وجود دو دولت مربوط به حضور: home و یا away . وقتی هیچ حرکتی در خانه احساس نشود ، ساختار از home به away تغییر می away .

جزئیات
https://developer-api.nest.com/structures/ structure_id /away
برمی گردد	string ارزش ها: "خانه" ، "خارج از خانه"
دسترسی	بخوان / بنویس
قابل دسترسی در	خواندن: ترموستات read / v1-v6 خواندن / نوشتن ترموستات / v1-v6 دود + CO read / 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 read / v1-v5 دور / v1-v2 را بخوانید خواندن / نوشتن / v1-v2 را فراموش نکنید ETA write / v1-v2 کد پستی read / 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 مثالها: "ایالات متحده" ، "CA" ، "UK"
دسترسی	فقط خواندنی
قابل دسترسی در	ترموستات read / v1-v6 خواندن / نوشتن ترموستات / v1-v6 دود + CO read / 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"
دسترسی	فقط خواندنی
قابل دسترسی در	کد پستی read / 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_Angeles"
دسترسی	فقط خواندنی
قابل دسترسی در	ترموستات read / v1-v6 خواندن / نوشتن ترموستات / v1-v6 دود + CO read / v1-v5 / v1-v2 را بخوانید دور / خواندن / نوشتن / v2 ETA write / v1-v2

اتا

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"
مولفه های	trip_id رشته ای که کاربر مشخص می کند سفر را مشخص می کند estimated_arrival_window_begin یک مهر زمان با فرمت ISO 8601 . باید بیشتر از NOW باشد. estimated_arrival_window_end یک مهر زمان با فرمت ISO 8601 . باید بیشتر از باشد estimated_arrival_window_begin .
دسترسی	فقط نوشتن
قابل دسترسی در	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 read / v1

ثبت نام

وضعیت ثبت نام پاداش Rush Hour .

جزئیات
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 مقادیر: "خوب" ، "بازدارنده"
دسترسی	فقط خواندنی
قابل دسترسی در	وضعیت امنیتی read / 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 read / v3-v5 خواندن دوربین / v1-v3 خواندن دوربین + تصاویر / v1-v4 خواندن / نوشتن دوربین / v1-v3 خواندن / نوشتن دوربین + تصاویر / v1-v4

کجا

شناسه منحصر به فرد و تولید شده از Nest که نشان دهنده 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 read / 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 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 مقادیر: "خوب" ، "هشدار" ، "اضطراری"
دسترسی	فقط خواندنی
قابل دسترسی در	دود + CO read / v5

دزدگیر_ایران

وضعیت هشدار دود.

جزئیات
https://developer-api.nest.com/structures/ structure_id /smoke_alarm_state
برمی گردد	string enum مقادیر: "خوب" ، "هشدار" ، "اضطراری"
دسترسی	فقط خواندنی
قابل دسترسی در	دود + CO read / v5