chrome.bluetooth

תיאור

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

מניפסט

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

"bluetooth"

סוגים

AdapterState

מאפיינים

  • כתובת

    מחרוזת

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

  • זמין

    בוליאני

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

  • כדאי לגלות

    בוליאני

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

  • שם

    מחרוזת

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

  • מופעל

    בוליאני

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

BluetoothFilter

‫Chrome 67 ואילך

מאפיינים

  • filterType

    ‫FilterType אופציונלי

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

  • הגבלה

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

    המספר המקסימלי של מכשירי 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

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

    ‫Chrome 44 ואילך

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

  • inquiryTxPower

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

    ‫Chrome 44 ואילך

    רמת ההספק המשודרת. השדה הזה זמין רק במכשירי LE שכוללים את השדה הזה בנתוני הפרסום. היא זמינה ותקפה רק במהלך איתור המקורות.

  • שם

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

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

  • מותאם

    ‫boolean אופציונלי

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

  • productId

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

  • תחבורה

    Transport אופציונלי

    ‫Chrome 76 ואילך

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

  • סוג

    ‫DeviceType אופציונלי

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

  • uuids

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

    מזהי UUID של פרוטוקולים, פרופילים ושירותים שמפורסמים על ידי המכשיר. במכשירי Bluetooth קלאסיים, הרשימה הזו מתקבלת מנתוני EIR ומטבלאות SDP. במכשירי Low Energy, הרשימה הזו מתקבלת משירותים ראשיים של 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,
): Promise<AdapterState>

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

פרמטרים

  • callback

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

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

    (adapterInfo: AdapterState) => void

    • adapterInfo

      AdapterState

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

החזרות

  • Promise<AdapterState>

    ‫Chrome 91 ואילך

    ההבטחות נתמכות רק ב-Manifest V3 ובגרסאות מאוחרות יותר. בפלטפורמות אחרות צריך להשתמש בפונקציות Callback.

getDevice()

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

קבלת מידע על מכשיר Bluetooth שהמערכת מכירה.

פרמטרים

  • deviceAddress

    מחרוזת

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

  • callback

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

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

    (deviceInfo: Device) => void

    • deviceInfo

      מכשיר

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

החזרות

  • Promise<Device>

    ‫Chrome 91 ואילך

    ההבטחות נתמכות רק ב-Manifest V3 ובגרסאות מאוחרות יותר. בפלטפורמות אחרות צריך להשתמש בפונקציות Callback.

getDevices()

Promise 
chrome.bluetooth.getDevices(
  filter?: BluetoothFilter,
  callback?: function,
): Promise<Device[]>

לקבל רשימה של מכשירי Bluetooth שהמערכת מכירה, כולל מכשירים שהותאמו ומכשירים שהתגלו לאחרונה.

פרמטרים

  • סינון

    ‫BluetoothFilter אופציונלי

    ‫Chrome 67 ואילך

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

  • callback

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

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

    (deviceInfos: Device[]) => void

    • deviceInfos

      מכשיר[]

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

החזרות

  • Promise<Device[]>

    ‫Chrome 91 ואילך

    ההבטחות נתמכות רק ב-Manifest V3 ובגרסאות מאוחרות יותר. בפלטפורמות אחרות צריך להשתמש בפונקציות Callback.

startDiscovery()

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

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

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

פרמטרים

  • callback

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

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

    () => void

החזרות

  • Promise<void>

    ‫Chrome 91 ואילך

    ההבטחות נתמכות רק ב-Manifest V3 ובגרסאות מאוחרות יותר. בפלטפורמות אחרות צריך להשתמש בפונקציות Callback.

stopDiscovery()

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

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

פרמטרים

  • callback

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

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

    () => void

החזרות

  • Promise<void>

    ‫Chrome 91 ואילך

    ההבטחות נתמכות רק ב-Manifest V3 ובגרסאות מאוחרות יותר. בפלטפורמות אחרות צריך להשתמש בפונקציות Callback.

אירועים

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