l10n l10n

طرحواره CameraEventImage

Nest Cam (قدیمی) Nest Hub Max Nest Doorbell (قدیمی)

sdm.devices.traits.CameraEventImage

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

زمینه های

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

دستورات

GenerateImage

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

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

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

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

درخواست

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

واکنش

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

ایجاد فیلدهای درخواست تصویر

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

ایجاد زمینه های پاسخ تصویر

رشته شرح نوع داده
url URL برای دانلود تصویر دوربین از. string
مثال: "https:// domain /sdm_event_snapshot/dGNUlTU2CjY5Y3VKaTZwR3o4Y1..."
token رمزی برای استفاده در هدر مجوز HTTP هنگام بارگیری تصویر. string
مثال: "g.0.eventToken"

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

برای دانلود تصویر دوربین، با استفاده از token موجود در سرصفحه مجوز HTTP با مجوز Basic، از یک GenerateImage با url GET تماس بگیرید:

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

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

به عنوان مثال، اگر نسبت تصویر دوربین 4:3 است، برای دانلود تصویر دوربین با وضوح 480 در 360 عرض یا ارتفاع را مشخص کنید:

عرض

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 ارائه نشده باشد، مقدار پیش فرض 480 برای width انتخاب می شود.

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

خطاها

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

پیغام خطا RPC عیب یابی
تصویر دوربین دیگر برای دانلود در دسترس نیست. DEADLINE_EXCEEDED تصاویر رویداد 30 ثانیه پس از انتشار رویداد منقضی می شوند. حتما قبل از انقضا تصویر را دانلود کنید.
شناسه رویداد به دوربین تعلق ندارد. FAILED_PRECONDITION eventID صحیحی که توسط رویداد دوربین برگردانده شده است استفاده کنید.

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