طرحواره تصویر رویداد دوربین

دوربین نست (قدیمی) نست هاب مکس زنگ درب نست (قدیمی)

sdm.devices.traits.CameraEventImage

این ویژگی متعلق به هر دستگاهی است که از تولید تصاویر از رویدادها پشتیبانی می‌کند.

فیلدها

هیچ فیلدی برای این ویژگی موجود نیست.

دستورات

تولید تصویر

یک URL برای دانلود تصویر دوربین ارائه می‌دهد.

این دستور از رویدادهای زیر پشتیبانی می‌کند:

نوع عنصر توضیحات
رویداد رویداد حرکت از ویژگی CameraMotion حرکت توسط دوربین تشخیص داده شده است.
رویداد رویداد Person از ویژگی CameraPerson یک نفر توسط دوربین شناسایی شده است.
رویداد رویداد صدا از ویژگی CameraSound صدا توسط دوربین شناسایی شده است.
رویداد رویداد Chime از ویژگی DoorbellChime زنگ در فشرده شده است.
برای دریافت URL دانلود تصویر دوربین مربوط به آن رویداد، از eventId مربوط به یک رویداد پشتیبانی‌شده در درخواست دستور استفاده کنید.

درخواست و پاسخ GenerateImage

درخواست 

POST /enterprises/project-id/devices/device-id:executeCommand
{
  "command" : "sdm.devices.commands.CameraEventImage.GenerateImage",
  "params" : {
    "eventId" : "vdXwhRr_VMq9H8yd6i9sDzScED..."
  }
}

پاسخ 

{
  "results" : {
    "url" : "https://domain/sdm_event_snapshot/dGNUlTU2CjY5Y3VKaTZwR3o4Y1...",
    "token" : "g.0.eventToken"
  }
}

فیلدهای درخواست GenerateImage

میدان توضیحات نوع داده
eventId شناسه رویداد برای درخواست تصویر دوربین مرتبط. string
مثال: "vdXwhRr_VMq9H8yd6i9sDzScED..."

فیلدهای پاسخ تصویر را تولید کنید

میدان توضیحات نوع داده
url آدرس اینترنتی (URL) برای دانلود تصویر دوربین. string
مثال: "https:// domain /sdm_event_snapshot/dGNUlTU2CjY5Y3VKaTZwR3o4Y1..."
token توکنی که هنگام دانلود تصویر، در هدر HTTP Authorization استفاده می‌شود. string
مثال: "g.0.eventToken"

دانلود تصویر دوربین

از یک url ، یک فراخوانی GET انجام دهید. تولید تصویر پاسخ دستور، با استفاده از token موجود در هدر HTTP Authorization با مجوز Basic، برای دانلود تصویر دوربین:

curl -H "Authorization: Basic g.0.eventToken" \
      https://domain/sdm_event_snapshot/dGNUlTU2CjY5Y3VKaTZwR3o4Y1...

از پارامترهای کوئری width یا height برای سفارشی‌سازی وضوح تصویر دانلود شده استفاده کنید. فقط یکی از این پارامترها باید مشخص شود. پارامتر دیگر به طور خودکار با توجه به نسبت ابعاد دوربین مقیاس‌بندی می‌شود.

برای مثال، اگر نسبت تصویر دوربین ۴:۳ باشد، برای دانلود تصویر دوربین با وضوح ۴۸۰ در ۳۶۰، عرض یا ارتفاع را مشخص کنید:

عرض 

curl -H "Authorization: Basic g.0.eventToken" \
      https://domain/sdm_event_snapshot/dGNUlTU2CjY5Y3VKaTZwR3o4Y1...?width=480

ارتفاع 

curl -H "Authorization: Basic g.0.eventToken" \
      https://domain/sdm_event_snapshot/dGNUlTU2CjY5Y3VKaTZwR3o4Y1...?height=360

محدودیت‌های دیگری نیز برای URL دانلود اعمال می‌شود:

  • اگر هر دو پارامتر در URL ارائه شوند، width استفاده می‌شود و height نادیده گرفته می‌شود.
  • اگر هیچ یک از پارامترها در URL ارائه نشوند، مقدار پیش‌فرض ۴۸۰ برای width انتخاب می‌شود.

ببینید دوربین ایمیج ویژگی برای اطلاعات در مورد ویژگی‌های تصویر.

خطاها

کد(های) خطای زیر ممکن است در رابطه با این ویژگی برگردانده شوند:

پیام خطا آر پی سی عیب‌یابی
تصویر دوربین دیگر برای دانلود در دسترس نیست. DEADLINE_EXCEEDED تصاویر رویداد ۳۰ ثانیه پس از انتشار رویداد منقضی می‌شوند. حتماً قبل از انقضا، تصویر را دانلود کنید.
شناسه رویداد متعلق به دوربین نیست. FAILED_PRECONDITION از eventID صحیح برگردانده شده توسط رویداد دوربین استفاده کنید.

برای مشاهده لیست کامل کدهای خطای API به مرجع کدهای خطای API مراجعه کنید.