طرح‌های نمونه و مدل دستگاه

مدل دستگاه

مدل دستگاه با فیلدهای این بخش تعریف می‌شود.

فیلدهای مدل دستگاه فقط می‌تواند حاوی حروف، اعداد، و نمادهای زیر باشد: نقطه (.)، خط تیره (-)، زیرخط (_)، فاصله ( )، و علامت جمع (+). اولین نویسه فیلد باید حرف یا عدد باشد.

{
  "project_id": "my-devices-project",
  "device_model_id": "my-devices-project-prototype-light-v1",
  "manifest": {
    "manufacturer": "Assistant SDK developer",
    "product_name": "Assistant SDK light",
    "device_description": "Assistant SDK light device"
  },
  "device_type": "action.devices.types.LIGHT",
  "traits": ["action.devices.traits.OnOff"]
}

{
  "project_id": string,
  "device_model_id": string,
  "manifest": {
    "manufacturer": string,
    "product_name": string,
    "device_description": string
  },
  "device_type": string,
  "traits": [ string ]
}

• project_id: (رشته) الزامی. شناسه پروژه Google Cloud Platform مربوط به پروژه «کنسول Actions» برای مرتبط کردن با این مدل دستگاه. یک پروژه می‌تواند شامل چندین مدل دستگاه باشد.
• device_model_id: (رشته) الزامی. شناسه منحصربه‌فرد جهانی برای این مدل دستگاه؛ از project_id به‌عنوان پیشوند استفاده کنید تا از تداخل در محدوده همه پروژه‌ها جلوگیری شود. در سنجه‌ها و هنگام ثبت دستگاه استفاده می‌شود.
• ‫manifest: (شیء(مانیفست)) الزامی. فراداده‌ای که مدل و سازنده دستگاه را توصیف می‌کند. این ممکن است در کنسول کیت توسعه نرم‌افزار (آینده)، داشبوردهای سنجه‌ها، و دیگر میاناهای دیداری مرتبط نشان داده شود.
  • manifest.manufacturer: (رشته) الزامی. نام سازنده دستگاه.
  • manifest.product_name: (رشته) الزامی. نام محصول مشتری‌پسند برای این مدل دستگاه.
  • manifest.device_description: (رشته) اختیاری. شرح این مدل دستگاه.
• device_type: (رشته) الزامی. نوع سخت‌افزار دستگاه. از بین موارد زیر انتخاب کنید:
  • action.devices.types.CAMERA
  • action.devices.types.DISHWASHER
  • action.devices.types.DRYER
  • action.devices.types.LIGHT
  • action.devices.types.OUTLET
  • action.devices.types.PHONE
  • action.devices.types.REFRIGERATOR
  • action.devices.types.SCENE
  • action.devices.types.SOUNDBAR
  • action.devices.types.SPEAKER
  • action.devices.types.SWITCH
  • action.devices.types.THERMOSTAT
  • action.devices.types.TV
  • action.devices.types.VACUUM
  • action.devices.types.WASHER
• traits: (Array<String>) اختیاری. فهرست ویژگی‌هایی که دستگاه پشتیبانی می‌کند. ویژگی‌ها شامل فرمان‌ها، مشخصه‌ها، و وضعیت‌های دستگاه است. برای استفاده از ویژگی‌های داخلی.

نمونه دستگاه

نمونه دستگاه با فیلدهای این بخش تعریف می‌شود.

فیلدهای نمونه دستگاه باید با حرف یا عدد شروع شود. شناسه دستگاه فقط می‌تواند حاوی حروف، اعداد، و نمادهای زیر باشد: نقطه (.)، خط تیره (-)، زیرخط (_)، و علامت جمع (+). نام مستعار دستگاه فقط می‌تواند حاوی اعداد، حروف، و نماد فاصله ( ) باشد.

  {
    "id": "my_led_1",
    "model_id": "my-devices-project-prototype-light-v1",
    "nickname": "My Assistant Light",
    "client_type": "SDK_LIBRARY"
  }

  {
    "id": string,
    "model_id": string,
    "nickname": string,
    "client_type": string
  }

• id: (رشته) الزامی. شناسه دستگاه آزمایشی. باید در همه دستگاه‌های ثبت‌شده تحت همان پروژه Google Developer منحصربه‌فرد باشد.
• model_id: (رشته) الزامی. شناسه مدل دستگاه؛ باید با device_model_id منسوب به این دستگاه آزمایشی یکسان باشد. مدل دستگاه باید قبلاً ثبت شده باشد.
• nickname: (رشته) اختیاری. نام مستعار دستگاه. از این نام برای اشاره به دستگاه در واسط‌های دیداری مثل تنظیمات «دستیار» استفاده خواهد شد.
• client_type: (رشته) الزامی. نوع دستگاه کارخواه. باید یکی از موارد زیر باشد: SDK_SERVICE یا SDK_LIBRARY.