chrome.bluetooth

תיאור

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

מניפסט

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

"bluetooth"

סוגים

AdapterState

תכונות

  • כתובת

    מחרוזת

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

  • זמין

    boolean

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

  • גילוי

    boolean

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

  • name

    מחרוזת

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

  • מופעל

    boolean

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

BluetoothFilter

Chrome 67 ומעלה

תכונות

  • filterType

    FilterType אופציונלי

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

  • הגבלה

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

    המספר המקסימלי של מכשירי bluetoth שיש להחזיר. אם לא צוין ערך, ברירת המחדל היא 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. השדה הזה זמין ותקף רק במהלך הגילוי. מחוץ לגילוי, הערך שלו לא מצוין.

  • inquiryTxPower

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

    Chrome 44 ואילך

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

  • name

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

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

  • מותאמות

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

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

  • productId

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

  • תחבורה

    העברה אופציונלי

    Chrome 76 ומעלה

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

  • סוג

    DeviceType אופציונלי

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

  • Uuids

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

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

  • vendorId

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

  • vendorIdSource

    VendorIdSource אופציונלי

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

DeviceType

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

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

"modem"

"gamepad"

"keyboardMouseCombo"

FilterType

Chrome 67 ומעלה

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

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

Transport

Chrome 76 ומעלה

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

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

"le"

"dual"

VendorIdSource

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

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

"usb"

שיטות

getAdapterState()

הבטחה 
chrome.bluetooth.getAdapterState(
  callback?: function,
)

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

פרמטרים

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

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

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

    (adapterInfo: AdapterState)=>void

    • adapterInfo

      AdapterState

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

החזרות

  • Promise<AdapterState>

    Chrome 91 ומעלה

    הבטחות נתמכות רק במניפסט מגרסה V3 ואילך. בפלטפורמות אחרות צריך להשתמש בקריאות חוזרות (callback).

getDevice()

הבטחה 
chrome.bluetooth.getDevice(
  deviceAddress: string,
  callback?: function,
)

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

פרמטרים

  • deviceAddress

    מחרוזת

    הכתובת של המכשיר שיש להשיג.

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

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

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

    (deviceInfo: Device)=>void

    • deviceInfo

      מכשיר

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

החזרות

  • הבטחה<מכשיר>

    Chrome 91 ומעלה

    הבטחות נתמכות רק במניפסט מגרסה V3 ואילך. בפלטפורמות אחרות צריך להשתמש בקריאות חוזרות (callback).

getDevices()

הבטחה 
chrome.bluetooth.getDevices(
  filter?: BluetoothFilter,
  callback?: function,
)

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

פרמטרים

  • סינון

    BluetoothFilter אופציונלי

    Chrome 67 ומעלה

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

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

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

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

    (deviceInfos: Device[])=>void

    • deviceInfos

      המכשיר[]

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

החזרות

  • הבטחה<מכשיר[]>

    Chrome 91 ומעלה

    הבטחות נתמכות רק במניפסט מגרסה V3 ואילך. בפלטפורמות אחרות צריך להשתמש בקריאות חוזרות (callback).

startDiscovery()

הבטחה 
chrome.bluetooth.startDiscovery(
  callback?: function,
)

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

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

פרמטרים

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

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

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

    ()=>void

החזרות

  • Promise<void>

    Chrome 91 ומעלה

    הבטחות נתמכות רק במניפסט מגרסה V3 ואילך. בפלטפורמות אחרות צריך להשתמש בקריאות חוזרות (callback).

stopDiscovery()

הבטחה 
chrome.bluetooth.stopDiscovery(
  callback?: function,
)

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

פרמטרים

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

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

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

    ()=>void

החזרות

  • Promise<void>

    Chrome 91 ומעלה

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