CameraEventImage Schema

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

sdm.devices.traits.CameraEventImage

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

فیلدها

There are no fields available for this trait.

دستورات

GenerateImage

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

This command supports the following events:

نوع عنصر توضیحات
رویداد Motion event of the CameraMotion trait Motion has been detected by the camera.
رویداد Person event of the CameraPerson trait A person has been detected by the camera.
رویداد Sound event of the CameraSound trait Sound has been detected by the camera.
رویداد Chime event of the DoorbellChime trait The doorbell has been pressed.
برای دریافت URL دانلود تصویر دوربین مربوط به آن رویداد، از eventId مربوط به یک رویداد پشتیبانی‌شده در درخواست دستور استفاده کنید.

GenerateImage request and response

درخواست 

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

پاسخ 

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

GenerateImage request fields

میدان توضیحات نوع داده
eventId شناسه رویداد برای درخواست تصویر دوربین مرتبط. string
Example: "TobqVtIOuaTJzBaj3W-TkVjPi2..."

GenerateImage response fields

میدان توضیحات نوع داده
url The URL to download the camera image from. string
مثال: "https:// domain /sdm_event_snapshot/dGNUlTU2CjY5Y3VKaTZwR3o4Y1..."
token توکنی که هنگام دانلود تصویر، در هدر HTTP Authorization استفاده می‌شود. string
مثال: "g.0.eventToken"

Download a camera image

Make a GET call to the url from a تولید تصویر پاسخ دستور، با استفاده از 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

Other restrictions to the download URL apply:

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

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

خطاها

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

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

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