chrome.hid

الوصف

استخدام chrome.hid API للتفاعل مع أجهزة 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

    سلسلة

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

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

  • reportDescriptor

    ArrayBuffer

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

  • serialNumber

    سلسلة

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

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

  • vendorId

    الرقم

    معرِّف المورّد.

الطُرق

connect()

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

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

المَعلمات

  • deviceId

    الرقم

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

  • معاودة الاتصال

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

    تبدو معلَمة callback على النحو التالي: 

    (connection: HidConnectInfo)=>void

المرتجعات

  • Promise<HidConnectInfo>

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

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

disconnect()

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

إلغاء الربط بجهاز. يُرجى العِلم أنّ عمليات الاستدعاء على أحد الأجهزة بعد طلبها إجراء آمن ولكن ليس لها أي تأثير.

المَعلمات

  • connectionId

    الرقم

    تم عرض connectionId من قِبل connect.

  • معاودة الاتصال

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

    تبدو معلَمة callback على النحو التالي: 

    ()=>void

المرتجعات

  • Promise<void>

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

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

getDevices()

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

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

المَعلمات

  • الخيارات

    GetDevicesOptions

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

  • معاودة الاتصال

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

    تبدو معلَمة callback على النحو التالي: 

    (devices: HidDeviceInfo[])=>void

المرتجعات

  • Promise<HidDeviceInfo[]>

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

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

receive()

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

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

المَعلمات

  • connectionId

    الرقم

    تم عرض connectionId من قِبل connect.

  • معاودة الاتصال

    الوظيفة

    تبدو معلَمة callback على النحو التالي: 

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

    • reportId

      الرقم

      رقم تعريف التقرير أو 0 إذا لم يحدث أيّ منهما.

    • البيانات

      ArrayBuffer

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

receiveFeatureReport()

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

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

المَعلمات

  • connectionId

    الرقم

    تم عرض connectionId من قِبل connect.

  • reportId

    الرقم

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

  • معاودة الاتصال

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

    تبدو معلَمة callback على النحو التالي: 

    (data: ArrayBuffer)=>void

    • البيانات

      ArrayBuffer

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

المرتجعات

  • Promise<ArrayBuffer>

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

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

send()

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

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

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

المَعلمات

  • connectionId

    الرقم

    تم عرض connectionId من قِبل connect.

  • reportId

    الرقم

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

  • البيانات

    ArrayBuffer

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

  • معاودة الاتصال

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

    تبدو معلَمة callback على النحو التالي: 

    ()=>void

المرتجعات

  • Promise<void>

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

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

sendFeatureReport()

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

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

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

المَعلمات

  • connectionId

    الرقم

    تم عرض connectionId من قِبل connect.

  • reportId

    الرقم

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

  • البيانات

    ArrayBuffer

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

  • معاودة الاتصال

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

    تبدو معلَمة callback على النحو التالي: 

    ()=>void

المرتجعات

  • Promise<void>

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

    لا تتوفّر الوعود إلا في الإصدار 3 من 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

      الرقم