صفات

یک ویژگی در SDM API شامل فیلدها ، دستورات و رویدادها است.

فیلدها

فیلدها مقادیری با انواع داده های رایج مانند عدد یا رشته هستند. برای مثال، یک فیلد ممکن است حاوی حالت فعلی یا رطوبت محیط ترموستات Google Nest باشد.

ویژگی ها و زمینه ها را می توان با یک تماس GET به نقطه پایانی API مورد نظر مشاهده کرد:

GET /enterprises/project-id/devices/device-id
{
  "name" : "enterprises/project-id/devices/device-id",
  "type" : "sdm.devices.types.device-type",
  "traits" : { ... },
  "parentRelations" : [
    {
      "parent" : "enterprises/project-id/structures/structure-id/rooms/room-id",
      "displayName" : "Lobby"
    }
  ]
}

انواع دستگاه

sdm.devices.types. device-type بازگردانده شده توسط SDM API نباید برای استنباط یا استنتاج عملکرد دستگاه واقعی که به آن اختصاص داده شده است استفاده شود. هیچ تضمینی وجود ندارد که نوع دستگاه برای یک دستگاه خاص ثابت بماند زیرا ویژگی‌های بیشتری به SDM API اضافه می‌شود. در عوض، از ویژگی های برگشتی برای دستگاه استفاده کنید.

روابط والدین

شی parentRelations منبع اصلی منبع فعلی را نشان می دهد، چه ساختار یا اتاق. نام نمایشی مربوط به قسمت customName استویژگی اطلاعات برای دستگاه هایی با والد ساختار یاویژگی RoomInfo برای دستگاه هایی با والدین اتاق.

دستورات

فرمان ها درخواست هایی هستند که با یک ویژگی مرتبط هستند. به عنوان مثال، تغییر حالت فعلی یا نقطه تنظیم دما در ترموستات Google Nest.

یک دستور توسط یک فراخوانی executeCommand API ارسال می شود:

POST /enterprises/project-id/devices/device-id:executeCommand
{
  "command" : "command-name",
  "params" : {
    "field" : "value"
  }
}

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

رویدادها

رویدادها ناهمزمان هستند و توسط Google Cloud Pub/Sub در یک موضوع واحد مدیریت می‌شوند Project شناسه

رویدادها به طور پیش فرض برای هر تغییری در مقدار یک فیلد صفت ارسال می شوند. آنها همچنین می توانند در پاسخ به اقدامات خاص دستگاه یا تغییرات در تخصیص منابع ارسال شوند. برای اطلاعات بیشتر به رویدادها مراجعه کنید.

دسته بندی صفات

ساختار

صفات
اطلاعات
sdm.structures.traits.Info
این ویژگی به هر ساختاری برای اطلاعات مربوط به ساختار تعلق دارد.
RoomInfo
sdm.structures.traits.RoomInfo
این ویژگی به هر اتاقی برای اطلاعات مربوط به اتاق تعلق دارد.

دستگاه

صفات
قابلیت اتصال
sdm.devices.traits.Connectivity
این ویژگی متعلق به هر دستگاهی است که اطلاعات اتصال را داشته باشد.
فن
sdm.devices.traits.Fan
این ویژگی متعلق به هر دستگاهی است که توانایی سیستم کنترل فن را داشته باشد.
رطوبت
sdm.devices.traits.Humidity
این ویژگی متعلق به هر دستگاهی است که دارای سنسور اندازه گیری رطوبت باشد.
اطلاعات
sdm.devices.traits.Info
این ویژگی به هر وسیله ای برای اطلاعات مربوط به دستگاه تعلق دارد.
تنظیمات
sdm.devices.traits.Settings
این ویژگی به هر دستگاهی برای اطلاعات تنظیمات مربوط به دستگاه تعلق دارد.
دما
sdm.devices.traits.Temperature
این ویژگی متعلق به هر دستگاهی است که دارای سنسور اندازه گیری دما باشد.

ترموستات

صفات
ترموستات اکو
sdm.devices.traits.ThermostatEco
این ویژگی متعلق به انواع دستگاه ترموستات است که از حالت های ECO پشتیبانی می کند.
ترموستات Hvac
sdm.devices.traits.ThermostatHvac
این ویژگی متعلق به انواع دستگاه ترموستات است که می تواند جزئیات HVAC را گزارش کند.
حالت ترموستات
sdm.devices.traits.ThermostatMode
این ویژگی متعلق به انواع دستگاه ترموستات است که از حالت های مختلف ترموستات پشتیبانی می کند.
ترموستاتTemperatureSetpoint
sdm.devices.traits.ThermostatTemperatureSetpoint
این ویژگی متعلق به انواع دستگاه ترموستات است که از تنظیم دمای هدف و محدوده دما پشتیبانی می کند.

دوربین

صفات
CameraClipPreview
sdm.devices.traits.CameraClipPreview
این ویژگی متعلق به هر دستگاهی است که از دانلود پیش نمایش کلیپ پشتیبانی می کند.
CameraEventImage
sdm.devices.traits.CameraEventImage
این ویژگی متعلق به هر دستگاهی است که از تولید تصاویر از رویدادها پشتیبانی می کند.
CameraImage
sdm.devices.traits.CameraImage
این ویژگی متعلق به هر دستگاهی است که از گرفتن عکس پشتیبانی می کند.
CameraLiveStream
sdm.devices.traits.CameraLiveStream
این ویژگی متعلق به هر دستگاهی است که از پخش زنده پشتیبانی می کند.
CameraMotion
sdm.devices.traits.CameraMotion
این ویژگی متعلق به هر دستگاهی است که از رویدادهای تشخیص حرکت پشتیبانی می کند.
CameraPerson
sdm.devices.traits.CameraPerson
این ویژگی متعلق به هر دستگاهی است که از رویدادهای شناسایی افراد پشتیبانی می کند.
صدای دوربین
sdm.devices.traits.CameraSound
این ویژگی متعلق به هر دستگاهی است که از رویدادهای تشخیص صدا پشتیبانی می کند.

زنگ در

صفات
زنگ در
sdm.devices.traits.DoorbellChime
این ویژگی متعلق به هر دستگاهی است که از صدای زنگ در و رویدادهای مطبوعاتی مرتبط پشتیبانی می کند.