يمكن للمستخدمين إضافة ثلاثة هياكل كحد أقصى ، مع أجهزة متعددة لكل هيكل.
تم العثور على جميع القيم أدناه تحت كل structures/ structure_id في وثيقة JSON.
معرف الهيكل
رقم معرف الهيكل. عند إجراء مكالمة إلى موقع البيانات هذا ، يمكنك الوصول إلى قيم البيانات في هذا الهيكل.
| تفاصيل | |
|---|---|
https://developer-api.nest.com/structures/ structure_id /structure_id | |
| عائدات | stringمثال: "VqFabWH21nw ..." |
| وصول | يقرأ فقط |
| متوفر في | قراءة الترموستات / v1-v6 قراءة / كتابة ترموستات / v1-v6 دخان + قراءة أول أكسيد الكربون / v1-v5.0 قراءة بالخارج / 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 دخان + قراءة أول أكسيد الكربون / v1-v5.0 قراءة بالخارج / v1-v2 قراءة / كتابة / v1-v2 ETA الكتابة / v1-v2 قراءة الكاميرا / v2-v3 قراءة الكاميرا + الصور / v2-v4 قراءة / كتابة الكاميرا / v2-v3 قراءة / كتابة الكاميرا + صور / v2-v4 |
دخان
قائمة إنذارات الدخان + أول أكسيد الكربون في الهيكل ، بواسطة معرف الجهاز الفريد. هذه مجموعة من كائنات JSON تتضمن جميع إنذارات الدخان + أول أكسيد الكربون في الهيكل.
| تفاصيل | |
|---|---|
https://developer-api.nest.com/structures/ structure_id /smoke_co_alarms | |
| عائدات | arrayمثال: [ "RTMTKxsQTCxzVcsySOHPxKoF4OyCifrs",... ] |
| وصول | يقرأ فقط |
| متوفر في | قراءة الترموستات / v1-v6 قراءة / كتابة ترموستات / v1-v6 دخان + قراءة أول أكسيد الكربون / v1-v5.0 قراءة بالخارج / 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 دخان + قراءة CO / v4-v5.0 قراءة بالخارج / 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القيم: "المنزل" ، "بعيدًا" |
| وصول | قراءة و كتابة |
| متوفر في | يقرأ: قراءة الترموستات / v1-v6 قراءة / كتابة ترموستات / v1-v6 دخان + قراءة أول أكسيد الكربون / v1-v5.0 قراءة بالخارج / v1-v2 قراءة / كتابة / v1-v2 ETA الكتابة / v1-v2 كتابة: قراءة / كتابة / v1-v2 |
اسم
اسم العرض المعرف من قبل المستخدم للهيكل.
| تفاصيل | |
|---|---|
https://developer-api.nest.com/structures/ structure_id /name | |
| عائدات | stringأمثلة: "منزلي" ، "بيت الشاطئ" ، "ماونتن هاوس" |
| وصول | قراءة و كتابة |
| متوفر في | يقرأ: قراءة الترموستات / v1-v6 قراءة / كتابة ترموستات / v1-v6 دخان + قراءة أول أكسيد الكربون / v1-v5.0 قراءة بالخارج / 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 دخان + قراءة أول أكسيد الكربون / v1-v5.0 قراءة بالخارج / 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 دخان + قراءة أول أكسيد الكربون / v1-v5.0 قراءة بالخارج / v1-v2 قراءة / كتابة / v2 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_enrollment
حالة التسجيل في 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 Cam .
| تفاصيل | |
|---|---|
https://developer-api.nest.com/structures/ structure_id /wheres | |
| عائدات | object |
| وصول | يقرأ فقط |
| متوفر في | يقرأ: قراءة الترموستات / v3-v6 قراءة / كتابة ترموستات / v3-v6 دخان + قراءة أول أكسيد الكربون / v3-v5.0 قراءة الكاميرا / v1-v3 قراءة الكاميرا + الصور / v1-v4 قراءة / كتابة الكاميرا / v1-v3 قراءة / كتابة الكاميرا + صور / v1-v4 |
where_id
معرّف فريد أنشأه 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 دخان + قراءة أول أكسيد الكربون / v3-v5.0 قراءة الكاميرا / 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 دخان + قراءة أول أكسيد الكربون / v3-v5.0 قراءة الكاميرا / v1-v3 قراءة الكاميرا + الصور / v1-v4 قراءة / كتابة الكاميرا / v1-v3 قراءة / كتابة الكاميرا + صور / v1-v4 |
co_alarm_state
حالة إنذار أول أكسيد الكربون.
| تفاصيل | |
|---|---|
https://developer-api.nest.com/structures/ structure_id /co_alarm_state | |
| عائدات | string enumالقيم: "موافق" ، "تحذير" ، "طارئ" |
| وصول | يقرأ فقط |
| متوفر في | Smoke + CO قراءة / v5.0 |
دخان_المنزل_دولة
حالة إنذار الدخان.
| تفاصيل | |
|---|---|
https://developer-api.nest.com/structures/ structure_id /smoke_alarm_state | |
| عائدات | string enumالقيم: "موافق" ، "تحذير" ، "طارئ" |
| وصول | يقرأ فقط |
| متوفر في | Smoke + CO قراءة / v5.0 |