chrome.bluetoothLowEnergy

תיאור

ממשק ה-API chrome.bluetoothLowEnergy משמש לתקשורת עם מכשירים עם Bluetooth חכם (צריכת אנרגיה נמוכה) באמצעות פרופיל המאפיינים הגנרי (GATT).

מניפסט

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

"bluetooth"

סוגים

Advertisement

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

מאפיינים

  • manufacturerData

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

    רשימת נתונים ספציפיים ליצרן שצריכים להיכלל בשדות 'נתונים ספציפיים ליצרן' של נתוני הפרסום.

  • serviceData

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

    רשימת נתוני השירות שכלולים בשדות 'נתוני שירות' של נתוני הפרסום.

  • serviceUuids

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

    רשימה של מזהים ייחודיים אוניברסליים (UUIDs) שצריך לכלול בשדה 'מזהי UUID של שירות' בנתוני הפרסום. מזהים UUID כאלה יכולים להיות בפורמטים של 16 ביט, 32 ביט או 128 ביט.

  • solicitUuids

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

    רשימה של מזהי UUID שרוצים לכלול בשדה 'בקשה לקבלת מזהי UUID' בנתוני הפרסום. מזהים UUID כאלה יכולים להיות בפורמטים של 16 ביט, 32 ביט או 128 ביט.

  • סוג המודעה.

AdvertisementType

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

סוג המודעה. אם בוחרים באפשרות 'שידור', סוג המודעה שנשלחת יהיה ADV_NONCONN_IND והמכשיר ישדר עם כתובת MAC אקראית. אם הערך מוגדר כ-'ציוד היקפי', סוג המודעה יהיה ADV_IND או ADV_SCAN_IND והמכשיר ישדר עם כתובת ה-MAC של מתאם ה-Bluetooth האמיתי.

Enum

"broadcast"

"peripheral"

Characteristic

מאפיינים

  • instanceId

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

    הפונקציה מחזירה את המזהה שהוקצה למאפיין הזה. משתמשים במזהה המכונה כדי להבדיל בין מאפיינים של התקן היקפי עם אותו מזהה UUID, וכדי לבצע קריאות פונקציה שמקבלות מזהה מאפיין. נוכח, אם המופע הזה מייצג מאפיין מרוחק.

  • נכסים

    CharacteristicProperty[]

    המאפיינים של המאפיין הזה.

  • שירות

    Service אופציונלי

    שירות ה-GATT שאליו שייכת המאפיין.

  • uuid

    מחרוזת

    מזהה ה-UUID של המאפיין, למשל 00002a37-0000-1000-8000-00805f9b34fb.

  • ערך

    ArrayBuffer אופציונלי

    ערך המאפיין שנשמר כרגע במטמון. הערך הזה מתעדכן כשהערך של המאפיין נקרא או מתעדכן באמצעות התראה או אינדיקציה.

CharacteristicProperty

ערכים שמייצגים את המאפיינים האפשריים של מאפיין. המערכת מסיקה את ההרשאות של המאפיינים מהנכסים האלה. כדי להבין את המשמעות של כל מאפיין, אפשר לעיין במפרט של Bluetooth 4.x.

Enum

"broadcast"

"read"

"writeWithoutResponse"

"write"

"notify"

"indicate"

"authenticatedSignedWrites"

"extendedProperties"

"reliableWrite"

"writableAuxiliaries"

"encryptRead"

"encryptWrite"

"encryptAuthenticatedRead"

"encryptAuthenticatedWrite"

ConnectProperties

מאפיינים

Descriptor

מאפיינים

  • מאפיין

    מאפיין אופציונלי

    מאפיין ה-GATT שהתיאורים האלה שייכים אליו.

  • instanceId

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

    הפונקציה מחזירה את המזהה שהוקצה לתיאור הזה. משתמשים במזהה המכונה כדי להבדיל בין מתארים ממכשיר היקפי עם אותו מזהה UUID, וכדי לבצע קריאות פונקציה שמקבלות מזהה מתאר. נוכח, אם המופע הזה מייצג מאפיין מרוחק.

  • permissions

    DescriptorPermission[]

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

    ההרשאות של התיאור הזה.

  • uuid

    מחרוזת

    מזהה ה-UUID של מתאר המאפיין, למשל 00002902-0000-1000-8000-00805f9b34fb.

  • ערך

    ArrayBuffer אופציונלי

    ערך המתאר שנשמר כרגע במטמון. הערך הזה מתעדכן כשקוראים את הערך של המתאר.

DescriptorPermission

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

ערכים שמייצגים הרשאות אפשריות לתיאור. כדי להבין את המשמעות של כל הרשאה, אפשר לעיין במפרט של Bluetooth 4.x.

Enum

"read"

"write"

"encryptedRead"

"encryptedWrite"

"encryptedAuthenticatedRead"

"encryptedAuthenticatedWrite"

Device

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

מאפיינים

  • כתובת

    מחרוזת

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

  • deviceClass

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

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

  • שם

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

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

ManufacturerData

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

מאפיינים

  • נתונים

    number[]

  • id [מזהה]

    number

Notification

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

מאפיינים

  • shouldIndicate

    boolean אופציונלי

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

  • ערך

    ArrayBuffer

    הערך החדש של המאפיין.

NotificationProperties

מאפיינים

Request

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

מאפיינים

  • מכשיר

    מכשיר

    המכשיר ששלח את הבקשה הזו.

  • requestId

    number

    מזהה ייחודי של הבקשה הזו. יש להשתמש במזהה הזה בתשובה לבקשה הזו.

  • ערך

    ArrayBuffer אופציונלי

    הערך לכתיבה (אם זוהי בקשת כתיבה).

Response

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

מאפיינים

  • isError

    בוליאני

    אם זו תגובה לשגיאה, הערך צריך להיות true.

  • requestId

    number

    המזהה של הבקשה שהתשובה הזו מתייחסת אליה.

  • ערך

    ArrayBuffer אופציונלי

    ערך התגובה. בקשות כתיבה ותשובות לשגיאות יתעלמו מהפרמטר הזה.

Service

מאפיינים

  • deviceAddress

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

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

  • instanceId

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

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

  • isPrimary

    בוליאני

    מציין אם סוג השירות הוא ראשי או משני.

  • uuid

    מחרוזת

    ה-UUID של השירות, למשל 0000180d-0000-1000-8000-00805f9b34fb.

ServiceData

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

מאפיינים

  • נתונים

    number[]

  • uuid

    מחרוזת

Methods

connect()

Promise 
chrome.bluetoothLowEnergy.connect(
  deviceAddress: string,
  properties?: ConnectProperties,
  callback?: function,
)

יוצר חיבור בין האפליקציה לבין המכשיר באמצעות הכתובת שצוינה. יכול להיות שמכשיר כבר מחובר ושירותי ה-GATT שלו זמינים בלי להפעיל את connect. עם זאת, אפליקציה שרוצה לגשת לשירותי ה-GATT של מכשיר צריכה להפעיל את הפונקציה הזו כדי לוודא שהחיבור למכשיר נשמר. אם המכשיר לא מחובר, כל שירותי ה-GATT של המכשיר יתגלו אחרי קריאה מוצלחת ל-connect.

פרמטרים

  • deviceAddress

    מחרוזת

    כתובת ה-Bluetooth של המכשיר המרוחק שאליו צריך לפתוח חיבור GATT.

  • נכסים

    ConnectProperties אופציונלי

    מאפייני החיבור (אופציונליים).

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

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

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

    () => void

החזרות

  • Promise<void>

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

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

createCharacteristic()

Promise Chrome מגרסה 52 ואילך 
chrome.bluetoothLowEnergy.createCharacteristic(
  characteristic: Characteristic,
  serviceId: string,
  callback?: function,
)

יצירת מאפיין GATT שמתארח באופן מקומי. המאפיין הזה חייב להיות מתארח בשירות תקין. אם מזהה השירות לא תקין, המערכת תגדיר את lastError. הפונקציה הזו זמינה רק אם לאפליקציה מוגדרות ההרשאות bluetooth:low_energy ו-bluetooth:peripheral כ-true. יכול להיות שההרשאה לציוד היקפי לא תהיה זמינה לכל האפליקציות.

פרמטרים

  • מאפיין

    מאפיין

    המאפיין שרוצים ליצור.

  • serviceId

    מחרוזת

    המזהה של השירות שעבורו רוצים ליצור את המאפיין הזה.

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

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

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

    (characteristicId: string) => void

    • characteristicId

      מחרוזת

החזרות

  • Promise<string>

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

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

createDescriptor()

Promise Chrome מגרסה 52 ואילך 
chrome.bluetoothLowEnergy.createDescriptor(
  descriptor: Descriptor,
  characteristicId: string,
  callback?: function,
)

יצירת מתאר GATT שמתארח באופן מקומי. התיאור הזה חייב להתארח במסגרת מאפיין חוקי. אם מזהה המאפיין לא תקין, המערכת תגדיר את lastError. הפונקציה הזו זמינה רק אם לאפליקציה מוגדרות ההרשאות bluetooth:low_energy ו-bluetooth:peripheral כ-true. יכול להיות שההרשאה לציוד היקפי לא תהיה זמינה לכל האפליקציות.

פרמטרים

  • תיאור

    תיאור

    התיאור שייווצר.

  • characteristicId

    מחרוזת

    המזהה של המאפיין שעבורו רוצים ליצור את המתאר הזה.

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

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

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

    (descriptorId: string) => void

    • descriptorId

      מחרוזת

החזרות

  • Promise<string>

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

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

createService()

Promise Chrome מגרסה 52 ואילך 
chrome.bluetoothLowEnergy.createService(
  service: Service,
  callback?: function,
)

יצירת שירות GATT שמתארח באופן מקומי. אפשר לרשום את השירות הזה כדי שיהיה זמין בשרת GATT מקומי. הפונקציה הזו זמינה רק אם לאפליקציה מוגדרות ההרשאות bluetooth:low_energy ו-bluetooth:peripheral כ-true. יכול להיות שההרשאה לציוד היקפי לא תהיה זמינה לכל האפליקציות.

פרמטרים

  • שירות

    שירות

    השירות שייווצר.

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

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

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

    (serviceId: string) => void

    • serviceId

      מחרוזת

החזרות

  • Promise<string>

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

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

disconnect()

Promise 
chrome.bluetoothLowEnergy.disconnect(
  deviceAddress: string,
  callback?: function,
)

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

פרמטרים

  • deviceAddress

    מחרוזת

    כתובת ה-Bluetooth של המכשיר המרוחק.

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

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

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

    () => void

החזרות

  • Promise<void>

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

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

getCharacteristic()

Promise 
chrome.bluetoothLowEnergy.getCharacteristic(
  characteristicId: string,
  callback?: function,
)

אחזור המאפיין של GATT עם מזהה המכונה שצוין, ששייך לשירות GATT שצוין, אם המאפיין קיים.

פרמטרים

  • characteristicId

    מחרוזת

    מזהה המופע של מאפיין ה-GATT המבוקש.

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

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

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

    (result: Characteristic) => void

החזרות

  • Promise<Characteristic>

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

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

getCharacteristics()

Promise 
chrome.bluetoothLowEnergy.getCharacteristics(
  serviceId: string,
  callback?: function,
)

הצגת רשימה של כל מאפייני ה-GATT שזוהו וששייכים לשירות הנתון.

פרמטרים

  • serviceId

    מחרוזת

    מזהה המכונה של שירות ה-GATT שצריך להחזיר את המאפיינים שלו.

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

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

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

    (result: Characteristic[]) => void

החזרות

  • Promise<Characteristic[]>

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

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

getDescriptor()

Promise 
chrome.bluetoothLowEnergy.getDescriptor(
  descriptorId: string,
  callback?: function,
)

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

פרמטרים

  • descriptorId

    מחרוזת

    מזהה המופע של מתאר המאפיין של GATT המבוקש.

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

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

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

    (result: Descriptor) => void

החזרות

  • Promise<Descriptor>

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

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

getDescriptors()

Promise 
chrome.bluetoothLowEnergy.getDescriptors(
  characteristicId: string,
  callback?: function,
)

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

פרמטרים

  • characteristicId

    מחרוזת

    מזהה המכונה של מאפיין ה-GATT שצריך להחזיר את מתאריו.

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

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

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

    (result: Descriptor[]) => void

החזרות

  • Promise<Descriptor[]>

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

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

getIncludedServices()

Promise 
chrome.bluetoothLowEnergy.getIncludedServices(
  serviceId: string,
  callback?: function,
)

הצגת רשימה של שירותי GATT שכלולים בשירות הנתון.

פרמטרים

  • serviceId

    מחרוזת

    מזהה המכונה של שירות ה-GATT שצריך להחזיר את השירותים הכלולים בו.

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

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

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

    (result: Service[]) => void

החזרות

  • Promise<Service[]>

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

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

getService()

Promise 
chrome.bluetoothLowEnergy.getService(
  serviceId: string,
  callback?: function,
)

אחזור של שירות ה-GATT עם מזהה המכונה הנתון.

פרמטרים

  • serviceId

    מחרוזת

    מזהה המכונה של שירות ה-GATT המבוקש.

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

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

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

    (result: Service) => void

החזרות

  • Promise<Service>

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

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

getServices()

Promise 
chrome.bluetoothLowEnergy.getServices(
  deviceAddress: string,
  callback?: function,
)

אחזור של כל שירותי ה-GATT שזוהו במכשיר המרוחק באמצעות כתובת המכשיר שצוינה.

הערה: אם תהליך גילוי השירותים עדיין לא הושלם במכשיר, ה-API הזה יחזיר קבוצת משנה (שעשויה להיות ריקה) של שירותים. פתרון אפשרי הוא להוסיף עיכוב מבוסס-זמן ו/או לבצע קריאה חוזרת עד שמקבלים את מספר השירותים הצפוי.

פרמטרים

  • deviceAddress

    מחרוזת

    כתובת ה-Bluetooth של המכשיר המרוחק ששירותי ה-GATT שלו צריכים להוחזר.

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

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

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

    (result: Service[]) => void

החזרות

  • Promise<Service[]>

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

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

notifyCharacteristicValueChanged()

Promise Chrome מגרסה 52 ואילך 
chrome.bluetoothLowEnergy.notifyCharacteristicValueChanged(
  characteristicId: string,
  notification: Notification,
  callback?: function,
)

שליחת הודעה למכשיר מרוחק על ערך חדש של מאפיין. אם הדגל shouldIndicate באובייקט ההתראה מקבל את הערך True, תישלח אינדיקציה במקום התראה. חשוב לזכור: כדי שהקריאה הזו תצליח, צריך להגדיר בצורה נכונה את המאפיין notify או indicate במהלך היצירה של המאפיין. הפונקציה הזו זמינה רק אם לאפליקציה מוגדרות ההרשאות bluetooth:low_energy ו-bluetooth:peripheral כ-true. יכול להיות שההרשאה לציוד היקפי לא תהיה זמינה לכל האפליקציות.

פרמטרים

  • characteristicId

    מחרוזת

    המאפיין שעבורו צריך לשלוח את ההתראה.

  • notification

    התראה

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

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

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

    () => void

החזרות

  • Promise<void>

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

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

readCharacteristicValue()

Promise 
chrome.bluetoothLowEnergy.readCharacteristicValue(
  characteristicId: string,
  callback?: function,
)

אחזור הערך של מאפיין ספציפי ממכשיר היקפי מרוחק.

פרמטרים

  • characteristicId

    מחרוזת

    מזהה המכונה של מאפיין ה-GATT שצריך לקרוא את הערך שלו מהמכשיר המרוחק.

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

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

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

    (result: Characteristic) => void

החזרות

  • Promise<Characteristic>

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

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

readDescriptorValue()

Promise 
chrome.bluetoothLowEnergy.readDescriptorValue(
  descriptorId: string,
  callback?: function,
)

אחזור הערך של מאפיין תיאורי ספציפי מהתקן היקפי מרוחק.

פרמטרים

  • descriptorId

    מחרוזת

    מזהה המכונה של מתאר המאפיין של GATT שצריך לקרוא את הערך שלו מהמכשיר המרוחק.

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

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

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

    (result: Descriptor) => void

החזרות

  • Promise<Descriptor>

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

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

registerAdvertisement()

Promise Chrome מגרסה 47 ואילך 
chrome.bluetoothLowEnergy.registerAdvertisement(
  advertisement: Advertisement,
  callback?: function,
)

יוצרים מודעה ומרשמים אותה לפרסום. כדי לקרוא לפונקציה הזו, ההרשאות bluetooth:low_energy ו-bluetooth:peripheral צריכות להיות מוגדרות כ-true באפליקציה. בנוסף, ה-API הזה זמין רק לאפליקציות שמופעלות באופן אוטומטי במצב קיוסק, או על ידי הגדרת המתג '--enable-ble-advertising-in-apps' בשורת הפקודה. אפשר לעיין במאמר בנושא https://developer.chrome.com/apps/manifest/bluetooth. הערה: בחלק מהחומרה יש תמיכה במצבים 'מרכזי' ו'ציוד היקפי' בו-זמנית, אבל בחומרה שלא תומכת בכך, ביצוע הקריאה הזו יעביר את המכשיר למצב 'ציוד היקפי'. אם מדובר בחומרה שלא תומכת גם במצב מרכזי וגם במצב היקפי, ניסיון להשתמש במכשיר בשני המצבים יוביל להתנהגות לא מוגדרת או ימנע מאפליקציות אחרות עם תפקיד מרכזי לפעול בצורה תקינה (כולל זיהוי של מכשירים עם צריכת אנרגיה נמוכה ב-Bluetooth).

פרמטרים

  • פרסומת

    מודעה

    המודעה שרוצים לפרסם.

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

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

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

    (advertisementId: number) => void

    • advertisementId

      number

החזרות

  • Promise<number>

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

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

registerService()

Promise Chrome מגרסה 52 ואילך 
chrome.bluetoothLowEnergy.registerService(
  serviceId: string,
  callback?: function,
)

רישום השירות הנתון בשרת ה-GATT המקומי. אם מזהה השירות לא חוקי, המערכת תגדיר את lastError. הפונקציה הזו זמינה רק אם לאפליקציה מוגדרות ההרשאות bluetooth:low_energy ו-bluetooth:peripheral כ-true. יכול להיות שההרשאה לציוד היקפי לא תהיה זמינה לכל האפליקציות.

פרמטרים

  • serviceId

    מחרוזת

    המזהה הייחודי של שירות שנוצר.

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

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

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

    () => void

החזרות

  • Promise<void>

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

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

removeService()

Promise Chrome מגרסה 52 ואילך 
chrome.bluetoothLowEnergy.removeService(
  serviceId: string,
  callback?: function,
)

מסירים את השירות שצוין, ומבטלים את הרישום שלו אם הוא היה רשום. אם מזהה השירות לא חוקי, המערכת תגדיר את lastError. הפונקציה הזו זמינה רק אם לאפליקציה מוגדרות ההרשאות bluetooth:low_energy ו-bluetooth:peripheral כ-true. יכול להיות שההרשאה לציוד היקפי לא תהיה זמינה לכל האפליקציות.

פרמטרים

  • serviceId

    מחרוזת

    המזהה הייחודי של שירות רשום נוכחי.

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

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

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

    () => void

החזרות

  • Promise<void>

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

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

resetAdvertising()

Promise Chrome מגרסה 61 ואילך 
chrome.bluetoothLowEnergy.resetAdvertising(
  callback?: function,
)

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

פרמטרים

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

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

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

    () => void

החזרות

  • Promise<void>

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

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

sendRequestResponse()

Chrome מגרסה 52 ואילך 
chrome.bluetoothLowEnergy.sendRequestResponse(
  response: Response,
)

שליחת תשובה לבקשת קריאה/כתיבה של מאפיין או מתאר. הפונקציה הזו זמינה רק אם לאפליקציה מוגדרות ההרשאות bluetooth:low_energy ו-bluetooth:peripheral כ-true. יכול להיות שההרשאה לציוד היקפי לא תהיה זמינה לכל האפליקציות.

פרמטרים

setAdvertisingInterval()

Promise Chrome מגרסה 55 ואילך 
chrome.bluetoothLowEnergy.setAdvertisingInterval(
  minInterval: number,
  maxInterval: number,
  callback?: function,
)

הגדרת המרווח בין שתי מודעות רצופות. הערה: אנחנו עושים כמיטב יכולתנו. ייתכן שהמרווח בפועל יהיה שונה באופן משמעותי מהמרווחים המבוקשים. בחומרה מסוימת, יש מרווח זמן מינימלי של 100 אלפיות השנייה. ערכי המינימום והמקסימום לא יכולים לחרוג מהטווח המותר במפרט של Bluetooth 4.2.

פרמטרים

  • minInterval

    number

    מרווח הזמן המינימלי בין מודעות (באלפיות השנייה). הערך לא יכול להיות נמוך מ-20ms (בהתאם למפרט).

  • maxInterval

    number

    מרווח הזמן המקסימלי בין מודעות (באלפיות השנייה). הערך לא יכול להיות גדול מ-10,240ms (לפי המפרט).

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

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

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

    () => void

החזרות

  • Promise<void>

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

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

startCharacteristicNotifications()

Promise 
chrome.bluetoothLowEnergy.startCharacteristicNotifications(
  characteristicId: string,
  properties?: NotificationProperties,
  callback?: function,
)

הפעלת התראות/אינדיקציות לגבי ערך מהמאפיין שצוין. אחרי ההפעלה, האפליקציה יכולה להאזין להתראות באמצעות האירוע onCharacteristicValueChanged.

פרמטרים

  • characteristicId

    מחרוזת

    מזהה המכונה של מאפיין ה-GATT שבו צריך להפעיל את ההתראות.

  • נכסים

    NotificationProperties אופציונלי

    מאפייני סשן של התראה (אופציונלי).

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

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

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

    () => void

החזרות

  • Promise<void>

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

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

stopCharacteristicNotifications()

Promise 
chrome.bluetoothLowEnergy.stopCharacteristicNotifications(
  characteristicId: string,
  callback?: function,
)

השבתת ההתראות/האינדיקציות לגבי הערך מהמאפיין שצוין. אחרי שיחה מוצלחת, האפליקציה תפסיק לקבל התראות או אינדיקציות מהמאפיין הזה.

פרמטרים

  • characteristicId

    מחרוזת

    מזהה המופע של מאפיין ה-GATT שבו צריך להפסיק את סשן ההתראות של האפליקציה הזו.

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

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

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

    () => void

החזרות

  • Promise<void>

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

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

unregisterAdvertisement()

Promise Chrome מגרסה 47 ואילך 
chrome.bluetoothLowEnergy.unregisterAdvertisement(
  advertisementId: number,
  callback?: function,
)

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

פרמטרים

  • advertisementId

    number

    המזהה של המודעה שרוצים לבטל את הרישום שלה.

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

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

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

    () => void

החזרות

  • Promise<void>

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

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

unregisterService()

Promise Chrome מגרסה 52 ואילך 
chrome.bluetoothLowEnergy.unregisterService(
  serviceId: string,
  callback?: function,
)

ביטול הרישום של השירות הנתון בשרת ה-GATT המקומי. אם מזהה השירות לא חוקי, המערכת תגדיר את lastError. הפונקציה הזו זמינה רק אם לאפליקציה מוגדרות ההרשאות bluetooth:low_energy ו-bluetooth:peripheral כ-true. יכול להיות שההרשאה לציוד היקפי לא תהיה זמינה לכל האפליקציות.

פרמטרים

  • serviceId

    מחרוזת

    המזהה הייחודי של שירות רשום נוכחי.

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

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

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

    () => void

החזרות

  • Promise<void>

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

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

writeCharacteristicValue()

Promise 
chrome.bluetoothLowEnergy.writeCharacteristicValue(
  characteristicId: string,
  value: ArrayBuffer,
  callback?: function,
)

כתיבת הערך של מאפיין מסוים ממכשיר היקפי מרוחק.

פרמטרים

  • characteristicId

    מחרוזת

    מזהה המכונה של מאפיין ה-GATT שצריך לכתוב אליו את הערך.

  • ערך

    ArrayBuffer

    הערך שצריך לשלוח למאפיין המרוחק כחלק מבקשת הכתיבה.

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

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

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

    () => void

החזרות

  • Promise<void>

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

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

writeDescriptorValue()

Promise 
chrome.bluetoothLowEnergy.writeDescriptorValue(
  descriptorId: string,
  value: ArrayBuffer,
  callback?: function,
)

כתיבת הערך של מאפיין תיאורי ספציפי ממכשיר היקפי מרוחק.

פרמטרים

  • descriptorId

    מחרוזת

    מזהה המכונה של מתאר המאפיין של GATT שצריך לכתוב אליו את הערך.

  • ערך

    ArrayBuffer

    הערך שצריך לשלוח לתיאור המרוחק כחלק מבקשת הכתיבה.

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

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

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

    () => void

החזרות

  • Promise<void>

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

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

אירועים

onCharacteristicReadRequest

Chrome מגרסה 52 ואילך 
chrome.bluetoothLowEnergy.onCharacteristicReadRequest.addListener(
  callback: function,
)

האירוע הזה מופעל כשמכשיר מרכזי מחובר מבקש לקרוא את הערך של מאפיין שמירשם בשרת ה-GATT המקומי. אם לא תגיבו לבקשה הזו במשך זמן רב, יכול להיות שתושבת ההתחברות. האירוע הזה זמין רק אם ההרשאות bluetooth:low_energy ו-bluetooth:peripheral מוגדרות כ-true באפליקציה. יכול להיות שההרשאה לציוד היקפי לא תהיה זמינה לכל האפליקציות.

פרמטרים

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

    פונקציה

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

    (request: Request, characteristicId: string) => void

    • בקשה

      בקשה

    • characteristicId

      מחרוזת

onCharacteristicValueChanged

chrome.bluetoothLowEnergy.onCharacteristicValueChanged.addListener(
  callback: function,
)

האירוע הזה מופעל כשהערך של מאפיין GATT מרוחק משתנה, כתוצאה מבקשת קריאה או מהודעה/אינדיקציה על שינוי ערך. האירוע הזה נשלח רק אם האפליקציה הפעלה התראות באמצעות קריאה ל-startCharacteristicNotifications.

פרמטרים

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

    פונקציה

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

    (characteristic: Characteristic) => void

onCharacteristicWriteRequest

Chrome מגרסה 52 ואילך 
chrome.bluetoothLowEnergy.onCharacteristicWriteRequest.addListener(
  callback: function,
)

האירוע הזה מופעל כשמכשיר מרכזי מחובר מבקש לכתוב את הערך של מאפיין שמירשם בשרת ה-GATT המקומי. אם לא תגיבו לבקשה הזו במשך זמן רב, יכול להיות שתושבת ההתחברות. האירוע הזה זמין רק אם ההרשאות bluetooth:low_energy ו-bluetooth:peripheral מוגדרות כ-true באפליקציה. יכול להיות שההרשאה לציוד היקפי לא תהיה זמינה לכל האפליקציות.

פרמטרים

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

    פונקציה

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

    (request: Request, characteristicId: string) => void

    • בקשה

      בקשה

    • characteristicId

      מחרוזת

onDescriptorReadRequest

Chrome מגרסה 52 ואילך 
chrome.bluetoothLowEnergy.onDescriptorReadRequest.addListener(
  callback: function,
)

האירוע הזה מופעל כשמכשיר מרכזי מחובר מבקש לקרוא את הערך של מתאר שרשום בשרת ה-GATT המקומי. אם לא תגיבו לבקשה הזו במשך זמן רב, יכול להיות שתושבת ההתחברות. האירוע הזה זמין רק אם ההרשאות bluetooth:low_energy ו-bluetooth:peripheral מוגדרות כ-true באפליקציה. יכול להיות שההרשאה לציוד היקפי לא תהיה זמינה לכל האפליקציות.

פרמטרים

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

    פונקציה

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

    (request: Request, descriptorId: string) => void

    • בקשה

      בקשה

    • descriptorId

      מחרוזת

onDescriptorValueChanged

chrome.bluetoothLowEnergy.onDescriptorValueChanged.addListener(
  callback: function,
)

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

פרמטרים

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

    פונקציה

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

    (descriptor: Descriptor) => void

onDescriptorWriteRequest

Chrome מגרסה 52 ואילך 
chrome.bluetoothLowEnergy.onDescriptorWriteRequest.addListener(
  callback: function,
)

האירוע הזה מופעל כשמכשיר מרכזי מחובר מבקש לכתוב את הערך של מתאר שרשום בשרת ה-GATT המקומי. אם לא תגיבו לבקשה הזו במשך זמן רב, יכול להיות שתושבת ההתחברות. האירוע הזה זמין רק אם ההרשאות bluetooth:low_energy ו-bluetooth:peripheral מוגדרות כ-true באפליקציה. יכול להיות שההרשאה לציוד היקפי לא תהיה זמינה לכל האפליקציות.

פרמטרים

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

    פונקציה

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

    (request: Request, descriptorId: string) => void

    • בקשה

      בקשה

    • descriptorId

      מחרוזת

onServiceAdded

chrome.bluetoothLowEnergy.onServiceAdded.addListener(
  callback: function,
)

הפונקציה מופעלת כששירות GATT חדש זוהה במכשיר מרוחק.

פרמטרים

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

    פונקציה

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

    (service: Service) => void

onServiceChanged

chrome.bluetoothLowEnergy.onServiceChanged.addListener(
  callback: function,
)

האירוע מופעל כשהסטטוס של שירות GATT מרוחק משתנה. העדכונים האלה כוללים מאפיינים ו/או תיאורים שנוספו או הוסרו מהשירות, וגם התראות מסוג 'ServiceChanged' מהמכשיר המרוחק.

פרמטרים

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

    פונקציה

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

    (service: Service) => void

onServiceRemoved

chrome.bluetoothLowEnergy.onServiceRemoved.addListener(
  callback: function,
)

האירוע הזה מופעל כששירות GATT שזוהה בעבר במכשיר מרוחק הוסר.

פרמטרים

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

    פונקציה

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

    (service: Service) => void