chrome.bluetoothLowEnergy

תיאור

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

זמינות

ChromeOS בלבד

מניפסט

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

"bluetooth"

סוגים

Advertisement

‫Chrome 47 ואילך

מאפיינים

  • manufacturerData

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

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

  • serviceData

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

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

  • serviceUuids

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

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

  • solicitUuids

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

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

  • סוג המודעה.

AdvertisementType

‫Chrome 47 ואילך

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

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

"broadcast"

"peripheral"

Characteristic

מאפיינים

  • instanceId

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

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

  • נכסים

    CharacteristicProperty[]

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

  • שירות

    שירות אופציונלי

    שירות ה-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

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

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

  • ערך

    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,
): Promise<void>

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

פרמטרים

  • deviceAddress

    מחרוזת

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

  • נכסים

    ConnectProperties אופציונלי

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

  • callback

    function optional

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

    () => void

החזרות

  • Promise<void>

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

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

createCharacteristic()

Promise Chrome 52 ואילך 
chrome.bluetoothLowEnergy.createCharacteristic(
  characteristic: Characteristic,
  serviceId: string,
  callback?: function,
): Promise<string>

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

פרמטרים

  • מאפיין

    מאפיין

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

  • serviceId

    מחרוזת

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

  • callback

    function optional

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

    (characteristicId: string) => void

    • characteristicId

      מחרוזת

החזרות

  • Promise<string>

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

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

createDescriptor()

Promise Chrome 52 ואילך 
chrome.bluetoothLowEnergy.createDescriptor(
  descriptor: Descriptor,
  characteristicId: string,
  callback?: function,
): Promise<string>

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

פרמטרים

  • תיאור

    תיאור

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

  • characteristicId

    מחרוזת

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

  • callback

    function optional

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

    (descriptorId: string) => void

    • descriptorId

      מחרוזת

החזרות

  • Promise<string>

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

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

createService()

Promise Chrome 52 ואילך 
chrome.bluetoothLowEnergy.createService(
  service: Service,
  callback?: function,
): Promise<string>

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

פרמטרים

  • שירות

    Service

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

  • callback

    function optional

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

    (serviceId: string) => void

    • serviceId

      מחרוזת

החזרות

  • Promise<string>

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

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

disconnect()

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

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

פרמטרים

  • deviceAddress

    מחרוזת

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

  • callback

    function optional

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

    () => void

החזרות

  • Promise<void>

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

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

getCharacteristic()

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

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

פרמטרים

  • characteristicId

    מחרוזת

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

  • callback

    function optional

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

    (result: Characteristic) => void

החזרות

  • Promise<Characteristic>

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

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

getCharacteristics()

Promise 
chrome.bluetoothLowEnergy.getCharacteristics(
  serviceId: string,
  callback?: function,
): Promise<Characteristic[]>

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

פרמטרים

  • serviceId

    מחרוזת

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

  • callback

    function optional

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

    (result: Characteristic[]) => void

החזרות

  • Promise<Characteristic[]>

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

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

getDescriptor()

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

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

פרמטרים

  • descriptorId

    מחרוזת

    מזהה המכונה של מתאר המאפיינים המבוקש של GATT.

  • callback

    function optional

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

    (result: Descriptor) => void

החזרות

  • Promise<Descriptor>

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

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

getDescriptors()

Promise 
chrome.bluetoothLowEnergy.getDescriptors(
  characteristicId: string,
  callback?: function,
): Promise<Descriptor[]>

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

פרמטרים

  • characteristicId

    מחרוזת

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

  • callback

    function optional

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

    (result: Descriptor[]) => void

החזרות

  • Promise<Descriptor[]>

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

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

getIncludedServices()

Promise 
chrome.bluetoothLowEnergy.getIncludedServices(
  serviceId: string,
  callback?: function,
): Promise<Service[]>

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

פרמטרים

  • serviceId

    מחרוזת

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

  • callback

    function optional

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

    (result: Service[]) => void

החזרות

  • Promise<Service[]>

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

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

getService()

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

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

פרמטרים

  • serviceId

    מחרוזת

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

  • callback

    function optional

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

    (result: Service) => void

החזרות

  • thought Promise<Service>

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

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

getServices()

Promise 
chrome.bluetoothLowEnergy.getServices(
  deviceAddress: string,
  callback?: function,
): Promise<Service[]>

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

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

פרמטרים

  • deviceAddress

    מחרוזת

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

  • callback

    function optional

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

    (result: Service[]) => void

החזרות

  • Promise<Service[]>

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

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

notifyCharacteristicValueChanged()

Promise Chrome 52 ואילך 
chrome.bluetoothLowEnergy.notifyCharacteristicValueChanged(
  characteristicId: string,
  notification: Notification,
  callback?: function,
): Promise<void>

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

פרמטרים

  • characteristicId

    מחרוזת

    המאפיין שלגביו תישלח ההתראה.

  • התראה

    התראה

  • callback

    function optional

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

    () => void

החזרות

  • Promise<void>

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

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

readCharacteristicValue()

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

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

פרמטרים

  • characteristicId

    מחרוזת

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

  • callback

    function optional

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

    (result: Characteristic) => void

החזרות

  • Promise<Characteristic>

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

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

readDescriptorValue()

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

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

פרמטרים

  • descriptorId

    מחרוזת

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

  • callback

    function optional

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

    (result: Descriptor) => void

החזרות

  • Promise<Descriptor>

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

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

registerAdvertisement()

Promise Chrome 47+‎ 
chrome.bluetoothLowEnergy.registerAdvertisement(
  advertisement: Advertisement,
  callback?: function,
): Promise<number>

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

פרמטרים

  • פרסומת

    מודעה

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

  • callback

    function optional

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

    (advertisementId: number) => void

    • advertisementId

      number

החזרות

  • Promise<number>

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

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

registerService()

Promise Chrome 52 ואילך 
chrome.bluetoothLowEnergy.registerService(
  serviceId: string,
  callback?: function,
): Promise<void>

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

פרמטרים

  • serviceId

    מחרוזת

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

  • callback

    function optional

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

    () => void

החזרות

  • Promise<void>

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

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

removeService()

Promise Chrome 52 ואילך 
chrome.bluetoothLowEnergy.removeService(
  serviceId: string,
  callback?: function,
): Promise<void>

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

פרמטרים

  • serviceId

    מחרוזת

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

  • callback

    function optional

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

    () => void

החזרות

  • Promise<void>

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

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

resetAdvertising()

Promise Chrome 61 ואילך 
chrome.bluetoothLowEnergy.resetAdvertising(
  callback?: function,
): Promise<void>

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

פרמטרים

  • callback

    function optional

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

    () => void

החזרות

  • Promise<void>

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

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

sendRequestResponse()

Chrome 52 ואילך 
chrome.bluetoothLowEnergy.sendRequestResponse(
  response: Response,
): void

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

פרמטרים

setAdvertisingInterval()

Promise Chrome 55 ואילך 
chrome.bluetoothLowEnergy.setAdvertisingInterval(
  minInterval: number,
  maxInterval: number,
  callback?: function,
): Promise<void>

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

פרמטרים

  • minInterval

    number

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

  • maxInterval

    number

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

  • callback

    function optional

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

    () => void

החזרות

  • Promise<void>

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

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

startCharacteristicNotifications()

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

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

פרמטרים

  • characteristicId

    מחרוזת

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

  • נכסים

    NotificationProperties אופציונלי

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

  • callback

    function optional

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

    () => void

החזרות

  • Promise<void>

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

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

stopCharacteristicNotifications()

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

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

פרמטרים

  • characteristicId

    מחרוזת

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

  • callback

    function optional

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

    () => void

החזרות

  • Promise<void>

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

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

unregisterAdvertisement()

Promise Chrome 47+‎ 
chrome.bluetoothLowEnergy.unregisterAdvertisement(
  advertisementId: number,
  callback?: function,
): Promise<void>

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

פרמטרים

  • advertisementId

    number

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

  • callback

    function optional

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

    () => void

החזרות

  • Promise<void>

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

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

unregisterService()

Promise Chrome 52 ואילך 
chrome.bluetoothLowEnergy.unregisterService(
  serviceId: string,
  callback?: function,
): Promise<void>

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

פרמטרים

  • serviceId

    מחרוזת

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

  • callback

    function optional

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

    () => void

החזרות

  • Promise<void>

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

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

writeCharacteristicValue()

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

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

פרמטרים

  • characteristicId

    מחרוזת

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

  • ערך

    ArrayBuffer

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

  • callback

    function optional

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

    () => void

החזרות

  • Promise<void>

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

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

writeDescriptorValue()

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

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

פרמטרים

  • descriptorId

    מחרוזת

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

  • ערך

    ArrayBuffer

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

  • callback

    function optional

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

    () => void

החזרות

  • Promise<void>

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

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

אירועים

onCharacteristicReadRequest

Chrome 52 ואילך 
chrome.bluetoothLowEnergy.onCharacteristicReadRequest.addListener(
  callback: function,
)

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

פרמטרים

  • 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 המקומי. אם לא תגיבו לבקשה הזו במשך זמן רב, יכול להיות שהחיבור ינותק. האירוע הזה זמין רק אם באפליקציה מוגדר הערך True גם בהרשאה bluetooth:low_energy וגם בהרשאה bluetooth:peripheral. יכול להיות שההרשאה לציוד היקפי לא תהיה זמינה לכל האפליקציות.

פרמטרים

  • 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 המקומי. אם לא תגיבו לבקשה הזו במשך זמן רב, יכול להיות שהחיבור ינותק. האירוע הזה זמין רק אם באפליקציה מוגדר הערך True גם בהרשאה bluetooth:low_energy וגם בהרשאה bluetooth:peripheral. יכול להיות שההרשאה לציוד היקפי לא תהיה זמינה לכל האפליקציות.

פרמטרים

  • 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