يمكن للمستخدمين إضافة ثلاثة هياكل كحد أقصى ، مع أجهزة متعددة لكل هيكل.
تم العثور على جميع القيم أدناه تحت كل structures/ structure_id في وثيقة JSON.
معرّف_هيكل
رقم هوية الهيكل. عند إجراء مكالمة إلى موقع البيانات هذا ، يمكنك الوصول إلى قيم البيانات في هذه البنية.
| تفاصيل | |
|---|---|
https://developer-api.nest.com/structures/ structure_id /structure_id | |
| عائدات | string مثال: "VqFabWH21nw ..." |
| التمكن من | يقرأ فقط |
| متوفر في | قراءة الحرارة / v1-v6 ترموستات قراءة / كتابة / v1-v6 Smoke + CO read / v1-v5 قراءة بعيدا / 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 قراءة بعيدا / v1-v2 بعيدا قراءة / كتابة / v1-v2 كتابة ETA / v1-v2 قراءة الكاميرا / v2-v3 قراءة الكاميرا + صور / v2-v4 قراءة / كتابة الكاميرا / v2-v3 قراءة / كتابة الكاميرا + صور / v2-v4 |
دخان
قائمة بمنبهات الدخان + أول أكسيد الكربون في الهيكل ، من خلال معرف الجهاز الفريد. هذه مجموعة من كائنات JSON تتضمن جميع إنذارات الدخان + CO في الهيكل.
| تفاصيل | |
|---|---|
https://developer-api.nest.com/structures/ structure_id /smoke_co_alarms | |
| عائدات | array مثال: [ "RTMTKxsQTCxzVcsySOHPxKoF4OyCifrs",... ] |
| التمكن من | يقرأ فقط |
| متوفر في | قراءة الحرارة / v1-v6 ترموستات قراءة / كتابة / v1-v6 Smoke + CO read / v1-v5 قراءة بعيدا / 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 قراءة بعيدا / v2 القراءة / الكتابة / الإصدار 2 بعيدًا كتابة ETA / الإصدار 2 قراءة الكاميرا / 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 قراءة بعيدا / v1-v2 بعيدا قراءة / كتابة / v1-v2 كتابة ETA / v1-v2 كتابة: بعيدا قراءة / كتابة / v1-v2 |
اسم
اسم عرض معرّف من قبل المستخدم للهيكل.
| تفاصيل | |
|---|---|
https://developer-api.nest.com/structures/ structure_id /name | |
| عائدات | string أمثلة: "My Home" و "Beach House" و "Mountain House" |
| التمكن من | قراءة و كتابة |
| متوفر في | اقرأ: قراءة الحرارة / v1-v6 ترموستات قراءة / كتابة / v1-v6 Smoke + CO read / v1-v5 قراءة بعيدا / v1-v2 بعيدا قراءة / كتابة / v1-v2 كتابة ETA / 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" |
| التمكن من | يقرأ فقط |
| متوفر في | قراءة الحرارة / v1-v6 ترموستات قراءة / كتابة / v1-v6 Smoke + CO read / v1-v5 قراءة بعيدا / 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 قراءة بعيدا / v1-v2 القراءة / الكتابة / الإصدار 2 بعيدًا كتابة ETA / 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" | ||||||
| المعلمات |
| ||||||
| التمكن من | للكتابة فقط | ||||||
| متوفر في | كتابة 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_enroll
حالة التسجيل في 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 القيم: "موافق" ، "ردع" |
| التمكن من | يقرأ فقط |
| متوفر في | قراءة حالة الأمان / v1 |
اين
عنصر يحتوي على مكان معرفات ( where_id و name ) للأجهزة في الهيكل. name هو name العرض الخاص بالجهاز. يمكن أن يكون أي اسم غرفة من قائمة نقدمها ، أو اسم مخصص.
لمزيد من المعلومات حول wheres ، راجع دليل الهيكل .
تعرف على مزيد من المعلومات حول مكان أسماء Nest Thermostats و Nest Protects و Nest Cams .
| تفاصيل | |
|---|---|
https://developer-api.nest.com/structures/ structure_id /wheres | |
| عائدات | object |
| التمكن من | يقرأ فقط |
| متوفر في | اقرأ: قراءة الحرارة / v3-v6 ترموستات قراءة / كتابة / v3-v6 Smoke + CO read / v3-v5 قراءة الكاميرا / v1-v3 قراءة الكاميرا + صور / v1-v4 قراءة / كتابة الكاميرا / v1-v3 قراءة / كتابة الكاميرا + صور / v1-v4 |
حيث
معرّف فريد من نوعه يتم إنشاؤه بواسطة Nest يمثل name .
where_id يتم where_id تلقائيًا أثناء المكالمة لإنشاء name .
| تفاصيل | |
|---|---|
https://developer-api.nest.com/structures/ structure_id /wheres/ where_id /where_id | |
| عائدات | string مثال: "Fqp6wJI ..." |
| التمكن من | يقرأ فقط |
| متوفر في | اقرأ: قراءة الحرارة / v3-v6 ترموستات قراءة / كتابة / v3-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 ترموستات قراءة / كتابة / v3-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 القيم: "موافق" ، "تحذير" ، "طوارئ" |
| التمكن من | يقرأ فقط |
| متوفر في | Smoke + CO read / v5 |
دخان_الارم
حالة إنذار الدخان.
| تفاصيل | |
|---|---|
https://developer-api.nest.com/structures/ structure_id /smoke_alarm_state | |
| عائدات | string enum القيم: "موافق" ، "تحذير" ، "طوارئ" |
| التمكن من | يقرأ فقط |
| متوفر في | Smoke + CO read / v5 |