chrome.bluetooth

תיאור

שימוש ב-API של chrome.bluetooth כדי להתחבר למכשיר Bluetooth. כל הפונקציות מדווחות על כשלים באמצעות chrome.runtime.lastError.

מניפסט

כדי להשתמש ב-API הזה, צריך להצהיר על המפתחות הבאים במניפסט.

"bluetooth"

סוגים

AdapterState

מאפיינים

  • כתובת

    מחרוזת

    הכתובת של המתאם, בפורמט 'XX:XX:XX:XX:XX:XX'.

  • זמין

    בוליאני

    מציין אם המתאם זמין (כלומר מופעל) או לא.

  • כדאי לגלות

    בוליאני

    מציין אם המתאם מבצע כרגע תהליך גילוי או לא.

  • שם

    מחרוזת

    השם של המתאם, שקריא לבני אדם.

  • מופעל

    בוליאני

    מראה אם יש מתח במתאם או לא.

BluetoothFilter

Chrome מגרסה 67 ואילך

מאפיינים

  • filterType

    FilterType אופציונלי

    סוג המסנן שרוצים להחיל על רשימת המכשירים. ברירת המחדל היא 'הכול'.

  • הגבלה

    מספר אופציונלי

    המספר המקסימלי של מכשירי Bluetooth שיוחזרו. אם לא צוין ערך, ערך ברירת המחדל הוא 0 (ללא מגבלה).

Device

מאפיינים

  • כתובת

    מחרוזת

    הכתובת של המכשיר, בפורמט 'XX:XX:XX:XX:XX:XX'.

  • batteryPercentage

    מספר אופציונלי

    Chrome מגרסה 77 ואילך

    רמת הטעינה שנותרה בסוללה של המכשיר.

  • ניתן לחבר

    boolean אופציונלי

    Chrome מגרסה 48 ואילך

    מציין אם אפשר לחבר את המכשיר.

  • מחובר

    boolean אופציונלי

    מציין אם המכשיר מחובר כרגע למערכת.

  • עם עצירות ביניים

    boolean אופציונלי

    Chrome מגרסה 48 ואילך

    מציין אם המכשיר מתחבר כרגע למערכת.

  • deviceClass

    מספר אופציונלי

    הכיתה של המכשיר, שדה ביט שמוגדר על ידי http://www.bluetooth.org/en-us/specification/assigned-numbers/baseband.

  • deviceId

    מספר אופציונלי

  • inquiryRssi

    מספר אופציונלי

    גרסה 44 ואילך של Chrome

    עוצמת האות המתקבל, ב-dBm. השדה הזה זמין ותקף רק במהלך תהליך הגילוי. מחוץ ל-Discovery, הערך שלו לא מצוין.

  • inquiryTxPower

    מספר אופציונלי

    גרסה 44 ואילך של Chrome

    רמת העוצמה המועברת. השדה הזה זמין רק למכשירי LE שכוללים את השדה הזה ב-AD. הוא זמין ותקף רק במהלך תהליך הגילוי.

  • שם

    מחרוזת אופציונלי

    השם של המכשיר, שקריא לבני אדם.

  • מותאם

    boolean אופציונלי

    מראה אם המכשיר מותאם למערכת או לא.

  • productId

    מספר אופציונלי

  • תחבורה

    תחבורה אופציונלי

    Chrome מגרסה 76 ואילך

    סוג התעבורה של מכשיר ה-Bluetooth.

  • סוג

    DeviceType אופציונלי

    סוג המכשיר, אם Chrome מזהה אותו. השדה הזה מתקבל מהשדה deviceClass ומייצג רק חלק קטן מסוגי המכשירים האפשריים. אם יש לכם ספק, כדאי להשתמש בשדה deviceClass ישירות.

  • uuids

    string[] אופציונלי

    מזהי UUID של פרוטוקולים, פרופילים ושירותים שמפורסמים על ידי המכשיר. במכשירי Bluetooth רגילים, הרשימה הזו מתקבלת מנתוני EIR וטבלאות SDP. במכשירים עם צריכת אנרגיה נמוכה, הרשימה הזו מתקבלת משירותי AD ו-GATT ראשיים. במכשירים עם שני מצבים, אפשר לקבל את המידע משניהם.

  • vendorId

    מספר אופציונלי

  • vendorIdSource

    VendorIdSource אופציונלי

    הרשומה של מזהה המכשיר, אם היא זמינה.

DeviceType

סוגי מכשירים נפוצים ש-Chrome מזהה.

Enum

"computer"

"phone"

"modem"

"audio"

"carAudio"

"video"

"peripheral"

"joystick"

"gamepad"

"keyboard"

"mouse"

"tablet"

"keyboardMouseCombo"

FilterType

Chrome מגרסה 67 ואילך

סוגי סינון של מכשירי Bluetooth.

Enum

"all"

"known"

Transport

Chrome מגרסה 76 ואילך

סוג התעבורה של מכשיר ה-Bluetooth.

Enum

"invalid"

"classic"

"le"

"dual"

VendorIdSource

הרשאות הקצאה למזהי ספקים.

Enum

"bluetooth"

"usb"

Methods

getAdapterState()

Promise 
chrome.bluetooth.getAdapterState(
  callback?: function,
)

קבלת מידע על מתאם ה-Bluetooth.

פרמטרים

  • קריאה חוזרת (callback)

    פונקציה אופציונלי

    הפרמטר callback נראה כך: 

    (adapterInfo: AdapterState) => void

    • adapterInfo

      AdapterState

      אובייקט שמכיל את פרטי המתאם.

החזרות

  • Promise<AdapterState>

    Chrome מגרסה 91 ואילך

    יש תמיכה ב-Promises רק ב-Manifest V3 ואילך. בפלטפורמות אחרות צריך להשתמש ב-callbacks.

getDevice()

Promise 
chrome.bluetooth.getDevice(
  deviceAddress: string,
  callback?: function,
)

אחזור מידע על מכשיר Bluetooth שהמערכת מכירה.

פרמטרים

  • deviceAddress

    מחרוזת

    הכתובת של המכשיר שרוצים לקבל.

  • קריאה חוזרת (callback)

    פונקציה אופציונלי

    הפרמטר callback נראה כך: 

    (deviceInfo: Device) => void

    • deviceInfo

      מכשיר

      אובייקט שמכיל את פרטי המכשיר.

החזרות

  • Promise<Device>

    Chrome מגרסה 91 ואילך

    יש תמיכה ב-Promises רק ב-Manifest V3 ואילך. בפלטפורמות אחרות צריך להשתמש ב-callbacks.

getDevices()

Promise 
chrome.bluetooth.getDevices(
  filter?: BluetoothFilter,
  callback?: function,
)

הצגת רשימה של מכשירי Bluetooth הידועים למערכת, כולל מכשירים מותאמים ומכשירים שזוהו לאחרונה.

פרמטרים

  • סינון

    BluetoothFilter אופציונלי

    Chrome מגרסה 67 ואילך

    קריטריונים לסינון רשימת מכשירי ה-Bluetooth שהוחזרו. אם המסנן לא מוגדר או מוגדר לערך {}, רשימת המכשירים שתוחזר תכיל את כל מכשירי ה-Bluetooth. בשלב הזה, האפשרות הזו נתמכת רק ב-ChromeOS. בפלטפורמות אחרות, המערכת תחזיר רשימה מלאה.

  • קריאה חוזרת (callback)

    פונקציה אופציונלי

    הפרמטר callback נראה כך: 

    (deviceInfos: Device[]) => void

    • deviceInfos

      מכשיר[]

      מערך של אובייקט שמכיל מידע על המכשיר.

החזרות

  • Promise<Device[]>

    Chrome מגרסה 91 ואילך

    יש תמיכה ב-Promises רק ב-Manifest V3 ואילך. בפלטפורמות אחרות צריך להשתמש ב-callbacks.

startDiscovery()

Promise 
chrome.bluetooth.startDiscovery(
  callback?: function,
)

מתחילים את תהליך הגילוי. מכשירים חדשים שזוהו יחזרו דרך האירוע onDeviceAdded. כדי לקבל מידע על מכשירים שהתגלו בעבר וידועים למתאם, צריך להשתמש ב-getDevices. המידע על המכשירים האלה יתעדכן באמצעות האירוע onDeviceChanged רק אם הוא ישתנה.

הפעלת Discovery תיכשל אם האפליקציה הזו כבר הפעילה את startDiscovery. Discovery יכול להיות מוגזם במשאבים: צריך לקרוא ל-stopDiscovery בהקדם האפשרי.

פרמטרים

  • קריאה חוזרת (callback)

    פונקציה אופציונלי

    הפרמטר callback נראה כך: 

    () => void

החזרות

  • Promise<void>

    Chrome מגרסה 91 ואילך

    יש תמיכה ב-Promises רק ב-Manifest V3 ואילך. בפלטפורמות אחרות צריך להשתמש ב-callbacks.

stopDiscovery()

Promise 
chrome.bluetooth.stopDiscovery(
  callback?: function,
)

להפסיק את הגילוי.

פרמטרים

  • קריאה חוזרת (callback)

    פונקציה אופציונלי

    הפרמטר callback נראה כך: 

    () => void

החזרות

  • Promise<void>

    Chrome מגרסה 91 ואילך

    יש תמיכה ב-Promises רק ב-Manifest V3 ואילך. בפלטפורמות אחרות צריך להשתמש ב-callbacks.

אירועים

onAdapterStateChanged

chrome.bluetooth.onAdapterStateChanged.addListener(
  callback: function,
)

האירוע מופעל כשהסטטוס של מתאם ה-Bluetooth משתנה.

פרמטרים

  • קריאה חוזרת (callback)

    פונקציה

    הפרמטר callback נראה כך: 

    (state: AdapterState) => void

onDeviceAdded

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

האירוע מופעל כשיש מידע על מכשיר Bluetooth חדש.

פרמטרים

  • קריאה חוזרת (callback)

    פונקציה

    הפרמטר callback נראה כך: 

    (device: Device) => void

onDeviceChanged

chrome.bluetooth.onDeviceChanged.addListener(
  callback: function,
)

האירוע מופעל כשיש שינוי בפרטי מכשיר Bluetooth מוכר.

פרמטרים

  • קריאה חוזרת (callback)

    פונקציה

    הפרמטר callback נראה כך: 

    (device: Device) => void

onDeviceRemoved

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

האירוע מופעל כשמכשיר Bluetooth שזוהה בעבר היה מחוץ לטווח למשך זמן מספיק כדי להיחשב ללא זמין שוב, וכשמכשיר מותאם מוסר.

פרמטרים

  • קריאה חוזרת (callback)

    פונקציה

    הפרמטר callback נראה כך: 

    (device: Device) => void