chrome.hid

الوصف

يمكنك استخدام واجهة برمجة تطبيقات chrome.hid للتفاعل مع أجهزة HID المتصلة. توفّر واجهة برمجة التطبيقات هذه إمكانية الوصول إلى عمليات الواجهة البشرية (HID) من داخل سياق التطبيق. باستخدام واجهة برمجة التطبيقات هذه، يمكن للتطبيقات العمل كبرامج تشغيل للأجهزة. يتم الإبلاغ عن الأخطاء التي تنتج عن واجهة برمجة التطبيقات هذه من خلال ضبط runtime.lastError وتنفيذ طلب معاودة الاتصال العادي للدالة. وستكون المعلمات العادية لمعاودة الاتصال غير محدّدة في هذه الحالة.

الأذونات

hid

الأنواع

DeviceFilter

أماكن إقامة

  • productId

    الرقم اختياري

    معرّف منتج الجهاز، لا يتم التحقّق منه إلا في حال تطابق رقم تعريف المورّد.

  • الاستخدام

    الرقم اختياري

    معرّف استخدام أجهزة HID لا يتم اختياره إلا في حال تطابق صفحة استخدام الواجهة البشرية (HID)

  • usagePage

    الرقم اختياري

    معرِّف صفحة استخدام أجهزة HID

  • vendorId

    الرقم اختياري

    رقم تعريف مورِّد الجهاز

GetDevicesOptions

أماكن إقامة

  • الفلاتر

    DeviceFilter[] اختيارية

    سيتم عرض جهاز يطابق أي فلتر معيَّن. ستعرض قائمة فلاتر فارغة جميع الأجهزة التي تم منح التطبيق الإذن لها.

  • productId

    الرقم اختياري

    متوقّفة نهائيًا

    يعادل الإعداد DeviceFilter.productId.

  • vendorId

    الرقم اختياري

    متوقّفة نهائيًا

    يعادل الإعداد DeviceFilter.vendorId.

HidCollectionInfo

أماكن إقامة

  • reportIds

    رقم[]

    أرقام تعريف التقارير الخاصة بالمجموعة والتابعة لها

  • الاستخدام

    الرقم

    معرّف الاستخدام المحدّد من خلال الصفحة

  • usagePage

    الرقم

    معرِّف صفحة استخدام أجهزة HID

HidConnectInfo

أماكن إقامة

  • connectionId

    الرقم

    رقم التعريف المبهم المستخدَم لتحديد هذا الاتصال في جميع الدوال الأخرى.

HidDeviceInfo

أماكن إقامة

  • مجموعات

    HidCollectionInfo[]

    مجموعات المستوى الأعلى من أدوات وصف تقارير هذا الجهاز.

  • deviceId

    الرقم

    رقم تعريف الجهاز معتم.

  • maxFeatureReportSize

    الرقم

    الحد الأقصى لحجم تقرير الميزة لمجموعة المستوى الأعلى

  • maxInputReportSize

    الرقم

    الحد الأقصى لحجم تقرير إدخال مجموعة المستوى الأعلى.

  • maxOutputReportSize

    الرقم

    الحد الأقصى لحجم تقرير الناتج لمجموعة المستوى الأعلى.

  • productId

    الرقم

    معرّف المنتج.

  • productName

    سلسلة

    الإصدار 46 من Chrome أو الإصدارات الأحدث

    اسم المنتج المقروء من الجهاز، إذا كان متاحًا.

  • reportDescriptor

    مخزن المصفوفات

    واصف تقرير الجهاز الأولي (غير متاح على نظام التشغيل Windows)

  • serialNumber

    سلسلة

    الإصدار 46 من Chrome أو الإصدارات الأحدث

    الرقم التسلسلي الذي تتم قراءته من الجهاز، إذا كان متاحًا

  • vendorId

    الرقم

    رقم تعريف المورّد

الطُرق

connect()

وعود 
chrome.hid.connect(
  deviceId: number,
  callback?: function,
)

افتح اتصالاً بجهاز HID للتواصل.

المعلمات

  • deviceId

    الرقم

    HidDeviceInfo.deviceId للجهاز المطلوب فتحه.

  • رد الاتصال

    الدالة اختيارية

    تظهر المَعلمة callback على النحو التالي: 

    (connection: HidConnectInfo) => void

المرتجعات

  • Promise<HidConnectInfo>

    الإصدار 117 من Chrome أو الإصدارات الأحدث

    لا تتوفّر الوعود إلا مع إصدار Manifest V3 والإصدارات الأحدث، وتحتاج الأنظمة الأساسية الأخرى إلى استخدام عمليات معاودة الاتصال.

disconnect()

وعود 
chrome.hid.disconnect(
  connectionId: number,
  callback?: function,
)

إلغاء الربط بجهاز. يُعد استدعاء العمليات على الجهاز بعد الاتصال بهذا الإجراء آمنًا ولكن ليس له تأثير.

المعلمات

  • connectionId

    الرقم

    تم إرجاع مبلغ connectionId من قِبل connect.

  • رد الاتصال

    الدالة اختيارية

    تظهر المَعلمة callback على النحو التالي: 

    () => void

المرتجعات

  • وعود <باطلة>

    الإصدار 117 من Chrome أو الإصدارات الأحدث

    لا تتوفّر الوعود إلا مع إصدار Manifest V3 والإصدارات الأحدث، وتحتاج الأنظمة الأساسية الأخرى إلى استخدام عمليات معاودة الاتصال.

getDevices()

وعود 
chrome.hid.getDevices(
  options: GetDevicesOptions,
  callback?: function,
)

تعداد أجهزة HID المتصلة

المعلمات

  • الخيارات

    GetDevicesOptions

    السمات المطلوب البحث عنها على الأجهزة المستهدَفة.

  • رد الاتصال

    الدالة اختيارية

    تظهر المَعلمة callback على النحو التالي: 

    (devices: HidDeviceInfo[]) => void

المرتجعات

  • Promise&lt;HidDeviceInfo[]&gt;

    الإصدار 117 من Chrome أو الإصدارات الأحدث

    لا تتوفّر الوعود إلا مع إصدار Manifest V3 والإصدارات الأحدث، وتحتاج الأنظمة الأساسية الأخرى إلى استخدام عمليات معاودة الاتصال.

receive()

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

تلقّي تقرير الإدخال التالي من الجهاز.

المعلمات

  • connectionId

    الرقم

    تم إرجاع مبلغ connectionId من قِبل connect.

  • رد الاتصال

    دالة

    تظهر المَعلمة callback على النحو التالي: 

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

    • reportId

      الرقم

      رقم تعريف التقرير أو 0 إذا لم يكن متوفّرًا.

    • البيانات

      مخزن المصفوفات

      بيانات التقرير، وتمت إزالة بادئة رقم تعريف التقرير (إن وجدت).

receiveFeatureReport()

وعود 
chrome.hid.receiveFeatureReport(
  connectionId: number,
  reportId: number,
  callback?: function,
)

اطلب تقريرًا عن الميزات من الجهاز.

المعلمات

  • connectionId

    الرقم

    تم إرجاع مبلغ connectionId من قِبل connect.

  • reportId

    الرقم

    رقم تعريف التقرير أو 0 إذا لم يكن متوفّرًا.

  • رد الاتصال

    الدالة اختيارية

    تظهر المَعلمة callback على النحو التالي: 

    (data: ArrayBuffer) => void

    • البيانات

      مخزن المصفوفات

      بيانات التقرير، بما في ذلك بادئة معرّف التقرير إذا كان الجهاز يرسلها.

المرتجعات

  • وعد <ArrayBuffer>

    الإصدار 117 من Chrome أو الإصدارات الأحدث

    لا تتوفّر الوعود إلا مع إصدار Manifest V3 والإصدارات الأحدث، وتحتاج الأنظمة الأساسية الأخرى إلى استخدام عمليات معاودة الاتصال.

send()

وعود 
chrome.hid.send(
  connectionId: number,
  reportId: number,
  data: ArrayBuffer,
  callback?: function,
)

إرسال تقرير إخراج إلى الجهاز

ملاحظة: لا تُدرِج بادئة رقم تعريف التقرير في data. ستتم إضافته إذا لزم الأمر.

المعلمات

  • connectionId

    الرقم

    تم إرجاع مبلغ connectionId من قِبل connect.

  • reportId

    الرقم

    رقم تعريف التقرير المطلوب استخدامه، أو 0 إذا لم يكن متوفّرًا.

  • البيانات

    مخزن المصفوفات

    بيانات التقرير.

  • رد الاتصال

    الدالة اختيارية

    تظهر المَعلمة callback على النحو التالي: 

    () => void

المرتجعات

  • وعود <باطلة>

    الإصدار 117 من Chrome أو الإصدارات الأحدث

    لا تتوفّر الوعود إلا مع إصدار Manifest V3 والإصدارات الأحدث، وتحتاج الأنظمة الأساسية الأخرى إلى استخدام عمليات معاودة الاتصال.

sendFeatureReport()

وعود 
chrome.hid.sendFeatureReport(
  connectionId: number,
  reportId: number,
  data: ArrayBuffer,
  callback?: function,
)

إرسال تقرير ميزة إلى الجهاز.

ملاحظة: لا تُدرِج بادئة رقم تعريف التقرير في data. ستتم إضافته إذا لزم الأمر.

المعلمات

  • connectionId

    الرقم

    تم إرجاع مبلغ connectionId من قِبل connect.

  • reportId

    الرقم

    رقم تعريف التقرير المطلوب استخدامه، أو 0 إذا لم يكن متوفّرًا.

  • البيانات

    مخزن المصفوفات

    بيانات التقرير.

  • رد الاتصال

    الدالة اختيارية

    تظهر المَعلمة callback على النحو التالي: 

    () => void

المرتجعات

  • وعود <باطلة>

    الإصدار 117 من Chrome أو الإصدارات الأحدث

    لا تتوفّر الوعود إلا مع إصدار Manifest V3 والإصدارات الأحدث، وتحتاج الأنظمة الأساسية الأخرى إلى استخدام عمليات معاودة الاتصال.

فعاليات

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

    • deviceId

      الرقم