chrome.hid

توضیحات

از chrome.hid API برای تعامل با دستگاه های HID متصل استفاده کنید. این API دسترسی به عملیات HID را از درون زمینه یک برنامه فراهم می کند. با استفاده از این API، برنامه ها می توانند به عنوان درایور برای دستگاه های سخت افزاری عمل کنند. خطاهای ایجاد شده توسط این API با تنظیم runtime.lastError و اجرای فراخوان معمولی تابع گزارش می شود. در این مورد، پارامترهای عادی تماس برگشتی تعریف نشده خواهند بود.

مجوزها

hid

انواع

DeviceFilter

خواص

  • شناسه محصول

    شماره اختیاری

    شناسه محصول دستگاه، فقط در صورتی بررسی می‌شود که شناسه فروشنده مطابقت داشته باشد.

  • استفاده

    شماره اختیاری

    شناسه استفاده HID، فقط در صورتی بررسی می‌شود که صفحه استفاده از HID مطابقت داشته باشد.

  • صفحه استفاده

    شماره اختیاری

    شناسه صفحه استفاده HID.

  • شناسه فروشنده

    شماره اختیاری

    شناسه فروشنده دستگاه

GetDevicesOptions

خواص

  • فیلترها

    DeviceFilter [] اختیاری است

    دستگاهی که با هر فیلتری مطابقت داشته باشد بازگردانده می شود. یک لیست فیلتر خالی، همه دستگاه‌هایی را که برنامه برای آنها مجوز دارد، برمی‌گرداند.

  • شناسه محصول

    شماره اختیاری

    منسوخ شده است

    معادل تنظیم DeviceFilter.productId .

  • شناسه فروشنده

    شماره اختیاری

    منسوخ شده است

    معادل تنظیم DeviceFilter.vendorId .

HidCollectionInfo

خواص

  • شناسه های گزارش

    شماره[]

    شناسه های مربوط به مجموعه و فرزندان آن را گزارش دهید.

  • استفاده

    شماره

    شناسه استفاده از صفحه تعریف شده است.

  • صفحه استفاده

    شماره

    شناسه صفحه استفاده HID.

HidConnectInfo

خواص

  • شناسه اتصال

    شماره

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

HidDeviceInfo

خواص

  • مجموعه ها

    HidCollectionInfo []

    مجموعه های سطح بالا از توصیفگرهای گزارش این دستگاه.

  • شناسه دستگاه

    شماره

    شناسه دستگاه غیر شفاف

  • maxFeatureReportSize

    شماره

    حداکثر اندازه گزارش ویژگی مجموعه سطح بالا.

  • maxInputReportSize

    شماره

    حداکثر اندازه گزارش ورودی مجموعه سطح بالا.

  • maxOutputReportSize

    شماره

    حداکثر اندازه گزارش خروجی مجموعه سطح بالا.

  • شناسه محصول

    شماره

    شناسه محصول

  • نام محصول

    رشته

    Chrome 46+

    در صورت موجود بودن، نام محصول از دستگاه خوانده می شود.

  • گزارش توصیفگر

    ArrayBuffer

    توصیفگر گزارش دستگاه خام (در ویندوز موجود نیست).

  • شماره سریال

    رشته

    Chrome 46+

    شماره سریال خوانده شده از دستگاه، در صورت وجود.

  • شناسه فروشنده

    شماره

    شناسه فروشنده

روش ها

connect()

قول بده
chrome.hid.connect(
  deviceId: number,
  callback?: function,
)

برای برقراری ارتباط، اتصال به دستگاه HID را باز کنید.

پارامترها

  • شناسه دستگاه

    شماره

    HidDeviceInfo.deviceId دستگاه برای باز کردن.

  • پاسخ به تماس

    عملکرد اختیاری

    پارامتر callback به نظر می رسد: 

    (connection: HidConnectInfo) => void

برمی گرداند

  • Promise< HidConnectInfo >

    Chrome 117+

    Promises فقط برای Manifest V3 و نسخه های جدیدتر پشتیبانی می شود، پلتفرم های دیگر نیاز به استفاده از callback دارند.

disconnect()

قول بده
chrome.hid.disconnect(
  connectionId: number,
  callback?: function,
)

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

پارامترها

  • شناسه اتصال

    شماره

    connectionId توسط connect برگردانده شد.

  • پاسخ به تماس

    عملکرد اختیاری

    پارامتر callback به نظر می رسد: 

    () => void

برمی گرداند

  • قول<باطل>

    Chrome 117+

    Promises فقط برای Manifest V3 و نسخه های جدیدتر پشتیبانی می شود، پلتفرم های دیگر نیاز به استفاده از callback دارند.

getDevices()

قول بده
chrome.hid.getDevices(
  options: GetDevicesOptions,
  callback?: function,
)

دستگاه های HID متصل را برشمارید.

پارامترها

  • گزینه ها

    GetDevicesOptions

    ویژگی هایی که باید در دستگاه های هدف جستجو کنید.

  • پاسخ به تماس

    عملکرد اختیاری

    پارامتر callback به نظر می رسد: 

    (devices: HidDeviceInfo[]) => void

برمی گرداند

  • Promise< HidDeviceInfo []>

    Chrome 117+

    Promises فقط برای Manifest V3 و نسخه های جدیدتر پشتیبانی می شود، پلتفرم های دیگر نیاز به استفاده از callback دارند.

receive()

chrome.hid.receive(
  connectionId: number,
  callback: function,
)

گزارش ورودی بعدی را از دستگاه دریافت کنید.

پارامترها

  • شناسه اتصال

    شماره

    connectionId توسط connect برگردانده شد.

  • پاسخ به تماس

    تابع

    پارامتر callback به نظر می رسد: 

    (reportId: number, data: ArrayBuffer) => void

    • شناسه گزارش

      شماره

      شناسه گزارش یا 0 در صورت عدم وجود.

    • داده ها

      ArrayBuffer

      داده های گزارش، پیشوند شناسه گزارش (در صورت وجود) حذف می شود.

receiveFeatureReport()

قول بده
chrome.hid.receiveFeatureReport(
  connectionId: number,
  reportId: number,
  callback?: function,
)

درخواست گزارش ویژگی از دستگاه.

پارامترها

  • شناسه اتصال

    شماره

    connectionId توسط connect برگردانده شد.

  • شناسه گزارش

    شماره

    شناسه گزارش یا 0 در صورت عدم وجود.

  • پاسخ به تماس

    عملکرد اختیاری

    پارامتر callback به نظر می رسد: 

    (data: ArrayBuffer) => void

    • داده ها

      ArrayBuffer

      داده های گزارش، از جمله پیشوند شناسه گزارش اگر توسط دستگاه ارسال شود.

برمی گرداند

  • Promise<ArrayBuffer>

    Chrome 117+

    Promises فقط برای Manifest V3 و نسخه های جدیدتر پشتیبانی می شود، پلتفرم های دیگر نیاز به استفاده از callback دارند.

send()

قول بده
chrome.hid.send(
  connectionId: number,
  reportId: number,
  data: ArrayBuffer,
  callback?: function,
)

یک گزارش خروجی به دستگاه ارسال کنید.

توجه: پیشوند شناسه گزارش را در data وارد نکنید. در صورت لزوم اضافه خواهد شد.

پارامترها

  • شناسه اتصال

    شماره

    connectionId توسط connect برگردانده شد.

  • شناسه گزارش

    شماره

    شناسه گزارش برای استفاده، یا 0 در صورت عدم وجود.

  • داده ها

    ArrayBuffer

    داده های گزارش

  • پاسخ به تماس

    عملکرد اختیاری

    پارامتر callback به نظر می رسد: 

    () => void

برمی گرداند

  • قول<باطل>

    Chrome 117+

    Promises فقط برای Manifest V3 و نسخه های جدیدتر پشتیبانی می شود، پلتفرم های دیگر نیاز به استفاده از callback دارند.

sendFeatureReport()

قول بده
chrome.hid.sendFeatureReport(
  connectionId: number,
  reportId: number,
  data: ArrayBuffer,
  callback?: function,
)

گزارش ویژگی را به دستگاه ارسال کنید.

توجه: پیشوند شناسه گزارش را در data وارد نکنید. در صورت لزوم اضافه خواهد شد.

پارامترها

  • شناسه اتصال

    شماره

    connectionId توسط connect برگردانده شد.

  • شناسه گزارش

    شماره

    شناسه گزارش برای استفاده، یا 0 در صورت عدم وجود.

  • داده ها

    ArrayBuffer

    داده های گزارش

  • پاسخ به تماس

    عملکرد اختیاری

    پارامتر callback به نظر می رسد: 

    () => void

برمی گرداند

  • قول<باطل>

    Chrome 117+

    Promises فقط برای Manifest V3 و نسخه های جدیدتر پشتیبانی می شود، پلتفرم های دیگر نیاز به استفاده از callback دارند.

رویدادها

onDeviceAdded

chrome.hid.onDeviceAdded.addListener(
  callback: function,
)

هنگامی که دستگاهی به سیستم اضافه می شود، رویداد ایجاد می شود. رویدادها فقط برای برنامه‌ها و برنامه‌های افزودنی پخش می‌شوند که مجوز دسترسی به دستگاه را دارند. ممکن است مجوز در زمان نصب یا زمانی که کاربر یک مجوز اختیاری را پذیرفته است اعطا شده باشد (به permissions.request مراجعه کنید).

پارامترها

  • پاسخ به تماس

    تابع

    پارامتر callback به نظر می رسد: 

    (device: HidDeviceInfo) => void

onDeviceRemoved

chrome.hid.onDeviceRemoved.addListener(
  callback: function,
)

زمانی که دستگاهی از سیستم حذف می‌شود، رویداد ایجاد می‌شود. onDeviceAdded ببینید که برای کدام رویدادها ارائه می شود.

پارامترها

  • پاسخ به تماس

    تابع

    پارامتر callback به نظر می رسد: 

    (deviceId: number) => void

    • شناسه دستگاه

      شماره