ה- API של Nest עובד עם כל דגמי Nest Cam ™.
משתמשים יכולים להוסיף מספר מצלמות Nest לקבוצת devices/cameras
, עד למקסימום למבנה . כשאתה מתקשר למיקום נתונים זה, אתה יכול לגשת לנתוני Nest Cam (ערכי נתונים למכשירים במבנה).
כל הערכים שלהלן נמצאים תחת כל devices/cameras/ device_id
במסמך JSON.
device_id
מזהה ייחודי של Nest Cam.
פרטים | |
---|---|
https://developer-api.nest.com/devices/cameras/ device_id /device_id | |
החזרות | string דוגמה: "awJo6rH ..." |
גִישָׁה | לקריאה בלבד |
אפשר להשיג ב | קריאת מצלמה / v1-v3 מצלמת קריאה + תמונות / v1-v4 מצלמת קריאה / כתיבה / v1-v3 מצלמת קריאה / כתיבה + תמונות / v1-v4 |
גרסת תוכנה
גרסת תוכנה.
פרטים | |
---|---|
https://developer-api.nest.com/devices/cameras/ device_id /software_version | |
החזרות | string דוגמה: "4.0" |
גִישָׁה | לקריאה בלבד |
אפשר להשיג ב | קריאת מצלמה / v1-v3 מצלמת קריאה + תמונות / v1-v4 מצלמה קריאה / כתיבה / v1-v3 מצלמת קריאה / כתיבה + תמונות / v1-v4 |
מבנה_יד
מזהה ייחודי של מבנה.
פרטים | |
---|---|
https://developer-api.nest.com/devices/cameras/ device_id /structure_id | |
החזרות | string דוגמה: "VqFabWH21nw ..." |
גִישָׁה | לקריאה בלבד |
אפשר להשיג ב | קריאת מצלמה / v1-v3 מצלמת קריאה + תמונות / v1-v4 מצלמת קריאה / כתיבה / v1-v3 מצלמת קריאה / כתיבה + תמונות / v1-v4 |
איפה_יד
מזהה ייחודי שנוצר על ידי Nest המייצג את name
, שם התצוגה של המכשיר.
למידע נוסף על היכן שמות עבור Nest Thermostats ,Nest Protects ו- Nest Cams .
פרטים | |
---|---|
https://developer-api.nest.com/devices/cameras/ device_id /where_id | |
החזרות | string דוגמה: "d6reb_OZTM ..." |
גִישָׁה | לקריאה בלבד |
אפשר להשיג ב | קריאת מצלמה / v1-v3 מצלמת קריאה + תמונות / v1-v4 מצלמת קריאה / כתיבה / v1-v3 מצלמת קריאה / כתיבה + תמונות / v1-v4 |
איפה_שם
שם התצוגה של המכשיר. משויך where_id
הקן where_id
. יכול להיות כל שם חדרים מתוך רשימה שאנו מספקים, או שם מותאם אישית. למידע נוסף על היכן שמות עבור Nest Thermostats ,Nest Protects ו- Nest Cams .
פרטים | |
---|---|
https://developer-api.nest.com/devices/cameras/ device_id /where_name | |
החזרות | string דוגמה: "מסדרון" |
גִישָׁה | לקריאה בלבד |
אפשר להשיג ב | קריאת מצלמה / v3 מצלמת קריאה + תמונות / v4 מצלמה לקרוא / לכתוב / v3 מצלמת קריאה / כתיבה + תמונות / v4 |
שֵׁם
שם התצוגה של המכשיר; יכול להיות כל שם חדרים מתוך רשימה שאנו מספקים, או שם מותאם אישית.
פרטים | |
---|---|
https://developer-api.nest.com/devices/cameras/ device_id /name | |
החזרות | string דוגמה: "מסדרון" |
גִישָׁה | לקריאה בלבד |
אפשר להשיג ב | קריאת מצלמה / v1-v3 מצלמת קריאה + תמונות / v1-v4 מצלמה קריאה / כתיבה / v1-v3 מצלמת קריאה / כתיבה + תמונות / v1-v4 |
שם_ארוך
שם תצוגה ארוך של המכשיר. כולל מנהג (תווית), נוצר על ידי המשתמש, או באמצעות wheres
.
פרטים | |
---|---|
https://developer-api.nest.com/devices/cameras/ device_id /name_long | |
החזרות | string דוגמה: "מסדרון קן מסדרון (למעלה)" |
גִישָׁה | לקריאה בלבד |
אפשר להשיג ב | קריאת מצלמה / v1-v3 מצלמת קריאה + תמונות / v1-v4 מצלמת קריאה / כתיבה / v1-v3 מצלמת קריאה / כתיבה + תמונות / v1-v4 |
מחובר
סטטוס חיבור המכשיר עם שירות Nest.
פרטים | |
---|---|
https://developer-api.nest.com/devices/cameras/ device_id /is_online | |
החזרות | boolean ערכים: נכון, שקר |
גִישָׁה | לקריאה בלבד |
אפשר להשיג ב | קריאת מצלמה / v1-v3 מצלמת קריאה + תמונות / v1-v4 מצלמת קריאה / כתיבה / v1-v3 מצלמת קריאה / כתיבה + תמונות / v1-v4 |
is_streaming
מצב המצלמה, מופעל או זורם באופן פעיל או מושבת. ראה כיצד המצלמה שלך עובדת בעזרת Home / Away Assist לקבלת מידע נוסף.
פרטים | |
---|---|
https://developer-api.nest.com/devices/cameras/ device_id /is_streaming | |
החזרות | boolean ערכים: נכון, שקר |
גִישָׁה | קרוא וכתוב |
אפשר להשיג ב | קריאת מצלמה / v1-v3 מצלמת קריאה + תמונות / v1-v4 מצלמה קריאה / כתיבה / v1-v3 מצלמת קריאה / כתיבה + תמונות / v1-v4 |
is_audio_input_enabled
מצב המיקרופון של המצלמה, מופעל או מאזין, או כבוי. למידע נוסף על הגדרות שמע של Nest Cam .
פרטים | |
---|---|
https://developer-api.nest.com/devices/cameras/ device_id /is_audio_input_enabled | |
החזרות | boolean ערכים: נכון, שקר |
גִישָׁה | לקריאה בלבד |
אפשר להשיג ב | קריאת מצלמה / v1-v3 מצלמת קריאה + תמונות / v1-v4 מצלמת קריאה / כתיבה / v1-v3 מצלמת קריאה / כתיבה + תמונות / v1-v4 |
האחרון_יש_מקוון_חלפה
חותמת זמן שמזהה את השינוי האחרון בסטטוס המקוון, בפורמט ISO 8601 .
פרטים | |
---|---|
https://developer-api.nest.com/devices/cameras/ device_id /last_is_online_change | |
החזרות | string דוגמה: "2016-12-29T18: 42: 00.000Z" |
גִישָׁה | לקריאה בלבד |
אפשר להשיג ב | קריאת מצלמה / v1-v3 מצלמת קריאה + תמונות / v1-v4 מצלמת קריאה / כתיבה / v1-v3 מצלמת קריאה / כתיבה + תמונות / v1-v4 |
is_video_history_enabled
סטטוס מנוי של Nest Aware (מינוי פעיל או לא).
פרטים | |
---|---|
https://developer-api.nest.com/devices/cameras/ device_id /is_video_history_enabled | |
החזרות | boolean ערכים: נכון, שקר |
גִישָׁה | לקריאה בלבד |
אפשר להשיג ב | קריאת מצלמה / v1-v3 מצלמת קריאה + תמונות / v1-v4 מצלמה קריאה / כתיבה / v1-v3 מצלמת קריאה / כתיבה + תמונות / v1-v4 |
web_url
כתובת אתר אינטרנט (קישור עמוק) לזרם הווידאו החי בכתובת home.nest.com .
פרטים | |
---|---|
https://developer-api.nest.com/devices/cameras/ device_id /web_url | |
החזרות | string דוגמה: " https://home.nest.com/cameras/ device_id ?auth= camera_token " |
גִישָׁה | לקריאה בלבד |
אפשר להשיג ב | קריאת מצלמה / v1-v3 מצלמת קריאה + תמונות / v1-v4 מצלמת קריאה / כתיבה / v1-v3 מצלמת קריאה / כתיבה + תמונות / v1-v4 |
app_url
כתובת אתר של אפליקציה (קישור עמוק) לזרם הווידאו החי באפליקציית Nest.
פרטים | |
---|---|
https://developer-api.nest.com/devices/cameras/ device_id /app_url | |
החזרות | string דוגמה: " nestmobile://cameras/ device_id ?auth= camera_token " |
גִישָׁה | לקריאה בלבד |
אפשר להשיג ב | קריאת מצלמה / v1-v3 מצלמת קריאה + תמונות / v1-v4 מצלמת קריאה / כתיבה / v1-v3 מצלמת קריאה / כתיבה + תמונות / v1-v4 |
is_public_share_enabled
משתמשים יכולים לבחור לשתף את הסרטון שלהם ולהפוך אותו לצפוי לכל אחד. כאשר השיתוף הציבורי מופעל, תוכל לקרוא את public_share_url
.
פרטים | |
---|---|
https://developer-api.nest.com/devices/cameras/ device_id /is_public_share_enabled | |
החזרות | boolean ערכים: נכון, שקר |
גִישָׁה | לקריאה בלבד |
אפשר להשיג ב | מצלמת קריאה + תמונות / v3-v4 מצלמת קריאה / כתיבה + תמונות / v3-v4 |
אזורי פעילות
מחזירה מערך של כל אזורי הפעילות שהוגדרו.
אזורי פעילות משמשים לניטור אירועי תנועה באזורים המוגדרים על ידי המשתמש בזרם הווידאו. דורש את Nest Aware .
פרטים | |
---|---|
https://developer-api.nest.com/devices/cameras/ device_id /activity_zones | |
החזרות | array דוגמה: [ {"name" : " string1 ", "id" : " string2 "},... ] • string1 הוא שם האזור, מוגדר על ידי המשתמש או נוצר אוטומטית בעת יצירת האזור.• string2 הוא מזהה שהוקצה על ידי Nest בעת יצירת אזור הפעילות. |
גִישָׁה | לקריאה בלבד |
אפשר להשיג ב | מצלמת קריאה + תמונות / v3-v4 מצלמת קריאה / כתיבה + תמונות / v3-v4 |
public_share_url
תוכל לגשת לכתובת אתר זו כאשר משתמש הופך את זרם הווידיאו שלו לציבורי .
פרטים | |
---|---|
https://developer-api.nest.com/devices/cameras/ device_id /public_share_url | |
החזרות | string דוגמה: " https://video.nest.com/live/ string1 ? string2 "string1 הוא שם זרם הווידאו, מוגדר על ידי המשתמש או נוצר באופן אוטומטי כאשר הזרם מוגדר לציבורי. |
גִישָׁה | לקריאה בלבד |
אפשר להשיג ב | מצלמת קריאה + תמונות / v3-v4 מצלמת קריאה / כתיבה + תמונות / v3-v4 |
snapshot_url
צלם תמונה לפי דרישה. מחזירה את כתובת האתר של תמונה שנלכדה מזרם הווידאו החי. דורש שהמצלמה מופעלת וזורם באופן פעיל.
השתמש בשדה זה כדי לקבל תמונת מצב מזרם הווידאו החי.
-
snapshot_url
- מחזיר את כתובת האתר של תמונה שנלכדה מזרם הווידאו החי - דורש שהמצלמה מופעלת וזורם באופן פעיל
איכות תמונת המצב מממשק ה- API היא תפוקת 1080p בלבד אם אתה:
- צפייה פעילה בזרם המצלמה ביישום (
web_url
) - צופה באופן פעיל בזרם הציבורי (
app_url
) - נרשם ל- Nest Aware
אם אינך צופה בזרם פעיל או שאין לך מנוי ל- Nest Aware, ל- API אין מקור 1080p ממנו ניתן לאחזר תמונת מצב ברזולוציה זו ויוצר תמונה באיכות נמוכה יותר. כמו כן, רוחב פס של רשת מקומית נמוכה עלול לגרום לרזולוציית תמונת המצב של ה- API לרדת מתחת ל -1080 p עם נוכחות Nest Aware.
למידע נוסף על דרישות רוחב הפס עבור מצלמות Nest .
מגבלות התעריף חלות על שיחה זו, תלוי בסטטוס המנוי של Nest Aware.
פרטים | |
---|---|
https://developer-api.nest.com/devices/cameras/ device_id /snapshot_url | |
החזרות | string דוגמה: " string1 / device_id / string2 ?auth= camera_token " |
גִישָׁה | לקריאה בלבד |
אפשר להשיג ב | מצלמת קריאה + תמונות / v3-v4 מצלמת קריאה / כתיבה + תמונות / v3-v4 |
אירוע אחרון
אובייקט זה לוכד מידע על האירוע האחרון שהפעיל התראה.
בחלק מהשדות וכמה שילובי הרשאות נדרש מנוי ל- Nest Aware כדי לגשת למידע על האירוע האחרון.
כל ערכים מתחת נמצאים תחת כל devices/cameras/ device_id /last_event
במסמך JSON.
יש_צליל
אירוע צליל - זוהה צליל.
פרטים | |
---|---|
https://developer-api.nest.com/devices/cameras/ device_id /last_event/has_sound | |
החזרות | boolean ערכים: נכון, שקר |
גִישָׁה | לקריאה בלבד |
אפשר להשיג ב | קריאת מצלמה / v1-v3 מצלמת קריאה + תמונות / v1-v4 מצלמה קריאה / כתיבה / v1-v3 מצלמת קריאה / כתיבה + תמונות / v1-v4 |
יש_רגש
אירוע תנועה - זוהתה תנועה.
פרטים | |
---|---|
https://developer-api.nest.com/devices/cameras/ device_id /last_event/has_motion | |
החזרות | boolean ערכים: נכון, שקר |
גִישָׁה | לקריאה בלבד |
אפשר להשיג ב | קריאת מצלמה / v1-v3 מצלמת קריאה + תמונות / v1-v4 מצלמת קריאה / כתיבה / v1-v3 מצלמת קריאה / כתיבה + תמונות / v1-v4 |
has_person
אירוע של אדם - אדם זוהה.
פרטים | |
---|---|
https://developer-api.nest.com/devices/cameras/ device_id /last_event/has_person | |
החזרות | boolean ערכים: נכון, שקר |
גִישָׁה | לקריאה בלבד |
אפשר להשיג ב | קריאת מצלמה / v1-v3 מצלמת קריאה + תמונות / v1-v4 מצלמת קריאה / כתיבה / v1-v3 מצלמת קריאה / כתיבה + תמונות / v1-v4 |
שעת התחלה
שעת התחלת האירוע, בפורמט ISO 8601 .
פרטים | |
---|---|
https://developer-api.nest.com/devices/cameras/ device_id /last_event/start_time | |
החזרות | string דוגמה: "2016-12-29T00: 00: 00.000Z" |
גִישָׁה | לקריאה בלבד |
אפשר להשיג ב | קריאת מצלמה / v1-v3 מצלמת קריאה + תמונות / v1-v4 מצלמת קריאה / כתיבה / v1-v3 מצלמת קריאה / כתיבה + תמונות / v1-v4 |
זמן סיום
שעת סיום האירוע בפורמט ISO 8601 .
פרטים | |
---|---|
https://developer-api.nest.com/devices/cameras/ device_id /last_event/end_time | |
החזרות | string דוגמה: "2016-12-29T00: 00: 00.000Z" |
גִישָׁה | לקריאה בלבד |
אפשר להשיג ב | קריאת מצלמה / v1-v3 מצלמת קריאה + תמונות / v1-v4 מצלמה קריאה / כתיבה / v1-v3 מצלמת קריאה / כתיבה + תמונות / v1-v4 |
urls_expire_time
חותמת זמן, בפורמט ISO 8601 , המזהה את תפוגת כתובות האתרים הקשורות לאירועים אלה:
זמן התפוגה מחושב כ: last_event/start_time
+ n ימים (כאשר n = 10 או 30 יום, תלוי בתכנית המנויים של Nest Aware).
דורש את Nest Aware .
פרטים | |
---|---|
https://developer-api.nest.com/devices/cameras/ device_id /last_event/urls_expire_time | |
החזרות | string דוגמה: "2016-12-29T00: 00: 00.000Z" |
גִישָׁה | לקריאה בלבד |
אפשר להשיג ב | קריאת מצלמה / v1-v3 מצלמת קריאה + תמונות / v1-v4 מצלמת קריאה / כתיבה / v1-v3 מצלמת קריאה / כתיבה + תמונות / v1-v4 |
web_url
כתובת אתר אינטרנט (קישור עמוק) לאירוע הסאונד או התנועה האחרון בבית. nest.com . משמש להצגת האירוע שהוקלט לאחרונה ומחייב את המשתמש בכניסה לחשבון.
דורש את Nest Aware . אם פג תוקף כתובת האתר לאירוע או שאין למכשיר מנוי פעיל, ערך זה אינו נכלל בעומס התשלום.
ראה last_event/urls_expire_time
למידע על זמן התפוגה של כתובת אתר זו.
פרטים | |
---|---|
https://developer-api.nest.com/devices/cameras/ device_id /last_event/web_url | |
החזרות | string דוגמה: " https://home.nest.com/cameras/ device_id /cuepoints/ string ?auth= camera_token " |
גִישָׁה | לקריאה בלבד |
אפשר להשיג ב | קריאת מצלמה / v1-v3 מצלמת קריאה + תמונות / v1-v4 מצלמת קריאה / כתיבה / v1-v3 מצלמת קריאה / כתיבה + תמונות / v1-v4 |
app_url
כתובת האתר של אפליקציית Nest (קישור עמוק) לאירוע הצליל או התנועה האחרון. משמש להצגת האירוע שהוקלט לאחרונה ומחייב את המשתמש בכניסה לחשבון.
דורש את Nest Aware . אם פג תוקף כתובת האתר לאירוע או שאין למכשיר מנוי פעיל, ערך זה אינו נכלל בעומס התשלום.
ראה last_event/urls_expire_time
למידע על זמן התפוגה של כתובת אתר זו.
פרטים | |
---|---|
https://developer-api.nest.com/devices/cameras/ device_id /last_event/app_url | |
החזרות | string דוגמה: " nestmobile://cameras/ device_id /cuepoints/ string ?auth= camera_token " |
גִישָׁה | לקריאה בלבד |
אפשר להשיג ב | קריאת מצלמה / v1-v3 מצלמת קריאה + תמונות / v1-v4 מצלמת קריאה / כתיבה / v1-v3 מצלמת קריאה / כתיבה + תמונות / v1-v4 |
כתובת אתר של תמונה
URL (קישור) לקובץ התמונה שצולם לאירוע קול או תנועה.
דורש את Nest Aware . ראה last_event/urls_expire_time
למידע על זמן התפוגה של כתובת אתר זו.
פרטים | |
---|---|
https://developer-api.nest.com/devices/cameras/ device_id /last_event/image_url | |
החזרות | string דוגמא: " https://www.dropcam.com/api/wwn.get_image/ string1 / device_id / string2 ?auth= camera_token " |
גִישָׁה | לקריאה בלבד |
אפשר להשיג ב | מצלמת קריאה + תמונות / v1-v4 מצלמת קריאה / כתיבה + תמונות / v1-v4 |
animated_image_url
URL (קישור) לקובץ ה- gif שצולם לאירוע קול או תנועה.
דורש את Nest Aware .
פרטים | |
---|---|
https://developer-api.nest.com/devices/cameras/ device_id /last_event/animated_image_url | |
החזרות | string דוגמה: " https://www.dropcam.com/api/wwn.get_image/ string1 / device_id / string2 ?auth= camera_token " |
גִישָׁה | לקריאה בלבד |
אפשר להשיג ב | מצלמת קריאה + תמונות / v1-v4 מצלמת קריאה / כתיבה + תמונות / v1-v4 |
פעילות_איזור_יידים
מזהים של אזורי פעילות שזיהו אירוע תנועה.
דורש את Nest Aware . כאשר משתמשים בו במערך activity_zones
, אתה יכול לקבל את שם האזור ממזהים אלה.
-
true
= מחזיר את מזהי אזור הפעילות שזיהו אירוע תנועה -
false
= מחזיר מערך ריק
פרטים | |
---|---|
https://developer-api.nest.com/devices/cameras/ device_id /last_event/activity_zone_ids | |
החזרות | array דוגמה: [ string1 , string2 ,... ] |
גִישָׁה | לקריאה בלבד |
אפשר להשיג ב | מצלמת קריאה + תמונות / v3-v4 מצלמת קריאה / כתיבה + תמונות / v3-v4 |