תיאור
יש להשתמש ב-API של chrome.hid
כדי לקיים אינטראקציה עם מכשירי ממשק אנושי (HID) מחוברים. ה-API הזה מספק גישה לפעולות ממשק אנושי (HID) מתוך הקשר של אפליקציה. באמצעות ה-API הזה, אפליקציות יכולות לתפקד כמנהלי התקנים עבור מכשירי חומרה. שגיאות שנוצרות על ידי ה-API הזה מדווחות על ידי הגדרה של 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
תכונות
-
אוספים
אוספים ברמה עליונה מתיאורי הדוחות של המכשיר הזה.
-
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)
פונקציה אופציונלי
הפרמטר
callback
נראה כך:(connection: HidConnectInfo) => void
-
חיבור
-
החזרות
-
Promise<HidConnectInfo>
Chrome 117 ומעלההבטחות נתמכות רק במניפסט מגרסה V3 ואילך. בפלטפורמות אחרות צריך להשתמש בקריאות חוזרות (callback).
disconnect()
chrome.hid.disconnect(
connectionId: number,
callback?: function,
)
להתנתק ממכשיר. הפעלת פעולות במכשיר אחרי השיחה היא בטוחה, אבל אין לה השפעה.
פרמטרים
-
connectionId
מספר
הערך
connectionId
הוחזר על ידיconnect
. -
קריאה חוזרת (callback)
פונקציה אופציונלי
הפרמטר
callback
נראה כך:() => void
החזרות
-
Promise<void>
Chrome 117 ומעלההבטחות נתמכות רק במניפסט מגרסה V3 ואילך. בפלטפורמות אחרות צריך להשתמש בקריאות חוזרות (callback).
getDevices()
chrome.hid.getDevices(
options: GetDevicesOptions,
callback?: function,
)
ציון של מכשירי ממשק אנושי (HID) מחוברים.
פרמטרים
-
אפשרויות
הנכסים שצריך לחפש במכשירי היעד.
-
קריאה חוזרת (callback)
פונקציה אופציונלי
הפרמטר
callback
נראה כך:(devices: HidDeviceInfo[]) => void
-
מכשירים
-
החזרות
-
Promise<HidDeviceInfo[]>
Chrome 117 ומעלההבטחות נתמכות רק במניפסט מגרסה V3 ואילך. בפלטפורמות אחרות צריך להשתמש בקריאות חוזרות (callback).
receive()
chrome.hid.receive(
connectionId: number,
callback: function,
)
קבלת דוח הקלט הבא מהמכשיר.
פרמטרים
-
connectionId
מספר
הערך
connectionId
הוחזר על ידיconnect
. -
קריאה חוזרת (callback)
פונקציה
הפרמטר
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)
פונקציה אופציונלי
הפרמטר
callback
נראה כך:(data: ArrayBuffer) => void
-
נתונים
ArrayBuffer
נתוני הדוח, כולל קידומת של מזהה דיווח, אם המכשיר שולח קידומת כזו.
-
החזרות
-
Promise<ArrayBuffer>
Chrome 117 ומעלההבטחות נתמכות רק במניפסט מגרסה V3 ואילך. בפלטפורמות אחרות צריך להשתמש בקריאות חוזרות (callback).
send()
chrome.hid.send(
connectionId: number,
reportId: number,
data: ArrayBuffer,
callback?: function,
)
שליחת דוח פלט למכשיר.
הערה: אין לכלול קידומת של מזהה דיווח ב-data
. היא תתווסף במקרה הצורך.
פרמטרים
-
connectionId
מספר
הערך
connectionId
הוחזר על ידיconnect
. -
reportId
מספר
מזהה הדוח לשימוש. אם אין מזהה,
0
. -
נתונים
ArrayBuffer
נתוני הדוח.
-
קריאה חוזרת (callback)
פונקציה אופציונלי
הפרמטר
callback
נראה כך:() => void
החזרות
-
Promise<void>
Chrome 117 ומעלההבטחות נתמכות רק במניפסט מגרסה V3 ואילך. בפלטפורמות אחרות צריך להשתמש בקריאות חוזרות (callback).
sendFeatureReport()
chrome.hid.sendFeatureReport(
connectionId: number,
reportId: number,
data: ArrayBuffer,
callback?: function,
)
שליחת דוח תכונות למכשיר.
הערה: אין לכלול קידומת של מזהה דיווח ב-data
. היא תתווסף במקרה הצורך.
פרמטרים
-
connectionId
מספר
הערך
connectionId
הוחזר על ידיconnect
. -
reportId
מספר
מזהה הדוח לשימוש. אם אין מזהה,
0
. -
נתונים
ArrayBuffer
נתוני הדוח.
-
קריאה חוזרת (callback)
פונקציה אופציונלי
הפרמטר
callback
נראה כך:() => void
החזרות
-
Promise<void>
Chrome 117 ומעלההבטחות נתמכות רק במניפסט מגרסה V3 ואילך. בפלטפורמות אחרות צריך להשתמש בקריאות חוזרות (callback).
אירועים
onDeviceAdded
chrome.hid.onDeviceAdded.addListener(
callback: function,
)
אירוע שנוצר כשמכשיר נוסף למערכת. אירועים משודרים רק לאפליקציות ולתוספים שיש להם הרשאת גישה למכשיר. יכול להיות שהוענקה הרשאה בזמן ההתקנה או כשהמשתמש אישר הרשאה אופציונלית (פרטים נוספים זמינים ב-permissions.request
).
פרמטרים
-
קריאה חוזרת (callback)
פונקציה
הפרמטר
callback
נראה כך:(device: HidDeviceInfo) => void
-
מכשיר
-
onDeviceRemoved
chrome.hid.onDeviceRemoved.addListener(
callback: function,
)
אירוע שנוצר כשמסירים מכשיר מהמערכת. למידע נוסף על האירועים שמועברים, אפשר לראות ב-onDeviceAdded
.
פרמטרים
-
קריאה חוזרת (callback)
פונקציה
הפרמטר
callback
נראה כך:(deviceId: number) => void
-
deviceId
מספר
-