chrome.bluetooth

תיאור

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

זמינות

ChromeOS בלבד

מניפסט

כדי להשתמש ב-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 ואילך

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

  • ניתן לחיבור

    בוליאני אופציונלי

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

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

  • מחובר

    בוליאני אופציונלי

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

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

    בוליאני אופציונלי

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

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

  • deviceClass

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

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

  • deviceId

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

  • inquiryRssi

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

    ‫Chrome מגרסה 44 ואילך

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

  • inquiryTxPower

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

    ‫Chrome מגרסה 44 ואילך

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

  • שם

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

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

  • מותאם

    בוליאני אופציונלי

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

  • productId

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

  • תחבורה

    Transport אופציונלי

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

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

  • סוג

    ‫DeviceType אופציונלי

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

  • מזהי UUID

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

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

  • vendorId

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

  • vendorIdSource

    ‫VendorIdSource אופציונלי

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

DeviceType

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

טיפוסים בני מנייה (enum)

"computer"

"phone"

"modem"

"audio"

"carAudio"

"video"

"peripheral"

"ג'ויסטיק"

"gamepad"

"keyboard"

"mouse"

"טאבלט"

"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

    function optional

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

    (adapterInfo: AdapterState) => void

    • adapterInfo

      AdapterState

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

החזרות

  • Promise<AdapterState>

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

    הבטחות נתמכות רק ב-Manifest V3 ואילך, בפלטפורמות אחרות צריך להשתמש בקריאות חוזרות (callbacks).

getDevice()

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

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

פרמטרים

  • deviceAddress

    מחרוזת

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

  • callback

    function optional

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

    (deviceInfo: Device) => void

    • deviceInfo

      מכשיר

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

החזרות

  • Promise<Device>

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

    הבטחות נתמכות רק ב-Manifest V3 ואילך, בפלטפורמות אחרות צריך להשתמש בקריאות חוזרות (callbacks).

getDevices()

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

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

פרמטרים

  • סינון

    ‫BluetoothFilter אופציונלי

    Chrome 67 ואילך

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

  • callback

    function optional

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

    (deviceInfos: Device[]) => void

    • deviceInfos

      מכשיר[]

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

החזרות

  • Promise<Device[]>

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

    הבטחות נתמכות רק ב-Manifest V3 ואילך, בפלטפורמות אחרות צריך להשתמש בקריאות חוזרות (callbacks).

startDiscovery()

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

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

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

פרמטרים

  • callback

    function optional

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

    () => void

החזרות

  • Promise<void>

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

    הבטחות נתמכות רק ב-Manifest V3 ואילך, בפלטפורמות אחרות צריך להשתמש בקריאות חוזרות (callbacks).

stopDiscovery()

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

הפסקת החיפוש.

פרמטרים

  • callback

    function optional

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

    () => void

החזרות

  • Promise<void>

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

    הבטחות נתמכות רק ב-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