chrome.bluetoothLowEnergy

תיאור

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

מניפסט

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

"bluetooth"

סוגים

Advertisement

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

תכונות

  • manufacturerData

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

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

  • serviceData

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

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

  • serviceUuids

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

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

  • solicitUuids

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

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

  • סוג הפרסומת.

AdvertisementType

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

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

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

Characteristic

תכונות

  • instanceId

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

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

  • נכסים

    CharacteristicProperty[]

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

  • שירות

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

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

  • uuid

    מחרוזת

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

  • value

    ArrayBuffer אופציונלי

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

CharacteristicProperty

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

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

"writeWithoutResponse"

"authenticatedSignedWrites"

"reliableWrite"

ConnectProperties

תכונות

Descriptor

תכונות

  • מאפיין

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

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

  • instanceId

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

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

  • הרשאות

    DescriptorPermission[]

    Chrome 52 ומעלה

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

  • uuid

    מחרוזת

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

  • value

    ArrayBuffer אופציונלי

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

DescriptorPermission

Chrome 52 ומעלה

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

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

"encryptedAuthenticatedWrite"

Device

Chrome 52 ומעלה

תכונות

  • כתובת

    מחרוזת

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

  • deviceClass

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

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

  • name

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

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

ManufacturerData

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

תכונות

  • נתונים

    מספר[]

  • id

    מספר

Notification

Chrome 52 ומעלה

תכונות

  • shouldIndicate

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

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

  • value

    ArrayBuffer

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

NotificationProperties

תכונות

  • מתמיד

    boolean

    סימון שמציין אם האפליקציה צריכה לקבל התראות כשמתבצעת טעינה של דף האירוע של האפליקציה (עיין בניהול מחזור החיים של אפליקציה). ערך ברירת המחדל הוא false.

Request

Chrome 52 ומעלה

תכונות

  • מכשיר

    מכשיר

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

  • requestId

    מספר

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

  • value

    ArrayBuffer אופציונלי

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

Response

Chrome 52 ומעלה

תכונות

  • isError

    boolean

    אם זו תגובת שגיאה, זה צריך להיות נכון.

  • requestId

    מספר

    המזהה של הבקשה שזו תשובה לה.

  • value

    ArrayBuffer אופציונלי

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

Service

תכונות

  • deviceAddress

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

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

  • instanceId

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

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

  • isPrimary

    boolean

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

  • uuid

    מחרוזת

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

ServiceData

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

תכונות

  • נתונים

    מספר[]

  • uuid

    מחרוזת

שיטות

connect()

הבטחה 
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 ומעלה

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

createCharacteristic()

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

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

פרמטרים

  • מאפיין

    מאפיין

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

  • serviceId

    מחרוזת

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

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

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

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

    (characteristicId: string)=>void

    • characteristicId

      מחרוזת

החזרות

  • הבטחה<string>

    Chrome 91 ומעלה

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

createDescriptor()

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

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

פרמטרים

  • תיאור

    תיאור

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

  • characteristicId

    מחרוזת

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

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

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

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

    (descriptorId: string)=>void

    • descriptorId

      מחרוזת

החזרות

  • הבטחה<string>

    Chrome 91 ומעלה

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

createService()

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

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

פרמטרים

  • שירות

    שירות

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

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

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

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

    (serviceId: string)=>void

    • serviceId

      מחרוזת

החזרות

  • הבטחה<string>

    Chrome 91 ומעלה

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

disconnect()

הבטחה 
chrome.bluetoothLowEnergy.disconnect(
  deviceAddress: string,
  callback?: function,
)

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

פרמטרים

  • deviceAddress

    מחרוזת

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

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

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

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

    ()=>void

החזרות

  • Promise<void>

    Chrome 91 ומעלה

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

getCharacteristic()

הבטחה 
chrome.bluetoothLowEnergy.getCharacteristic(
  characteristicId: string,
  callback?: function,
)

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

פרמטרים

  • characteristicId

    מחרוזת

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

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

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

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

    (result: Characteristic)=>void

החזרות

  • Promise<Characteristic>

    Chrome 91 ומעלה

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

getCharacteristics()

הבטחה 
chrome.bluetoothLowEnergy.getCharacteristics(
  serviceId: string,
  callback?: function,
)

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

פרמטרים

  • serviceId

    מחרוזת

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

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

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

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

    (result: Characteristic[])=>void

החזרות

  • Promise<Characteristic[]>

    Chrome 91 ומעלה

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

getDescriptor()

הבטחה 
chrome.bluetoothLowEnergy.getDescriptor(
  descriptorId: string,
  callback?: function,
)

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

פרמטרים

  • descriptorId

    מחרוזת

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

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

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

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

    (result: Descriptor)=>void

החזרות

  • Promise<Descriptor>

    Chrome 91 ומעלה

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

getDescriptors()

הבטחה 
chrome.bluetoothLowEnergy.getDescriptors(
  characteristicId: string,
  callback?: function,
)

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

פרמטרים

  • characteristicId

    מחרוזת

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

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

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

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

    (result: Descriptor[])=>void

החזרות

  • Promise<Descriptor[]>

    Chrome 91 ומעלה

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

getIncludedServices()

הבטחה 
chrome.bluetoothLowEnergy.getIncludedServices(
  serviceId: string,
  callback?: function,
)

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

פרמטרים

  • serviceId

    מחרוזת

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

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

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

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

    (result: Service[])=>void

החזרות

  • הבטחה<שירות[]>

    Chrome 91 ומעלה

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

getService()

הבטחה 
chrome.bluetoothLowEnergy.getService(
  serviceId: string,
  callback?: function,
)

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

פרמטרים

  • serviceId

    מחרוזת

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

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

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

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

    (result: Service)=>void

החזרות

  • הבטחה<שירות>

    Chrome 91 ומעלה

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

getServices()

הבטחה 
chrome.bluetoothLowEnergy.getServices(
  deviceAddress: string,
  callback?: function,
)

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

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

פרמטרים

  • deviceAddress

    מחרוזת

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

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

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

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

    (result: Service[])=>void

החזרות

  • הבטחה<שירות[]>

    Chrome 91 ומעלה

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

notifyCharacteristicValueChanged()

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

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

פרמטרים

  • characteristicId

    מחרוזת

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

  • notification

    התראה

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

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

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

    ()=>void

החזרות

  • Promise<void>

    Chrome 91 ומעלה

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

readCharacteristicValue()

הבטחה 
chrome.bluetoothLowEnergy.readCharacteristicValue(
  characteristicId: string,
  callback?: function,
)

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

פרמטרים

  • characteristicId

    מחרוזת

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

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

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

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

    (result: Characteristic)=>void

החזרות

  • Promise<Characteristic>

    Chrome 91 ומעלה

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

readDescriptorValue()

הבטחה 
chrome.bluetoothLowEnergy.readDescriptorValue(
  descriptorId: string,
  callback?: function,
)

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

פרמטרים

  • descriptorId

    מחרוזת

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

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

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

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

    (result: Descriptor)=>void

החזרות

  • Promise<Descriptor>

    Chrome 91 ומעלה

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

registerAdvertisement()

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

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

פרמטרים

  • פרסומת

    פרסומת

    הפרסומת שצריך לפרסם.

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

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

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

    (advertisementId: number)=>void

    • advertisementId

      מספר

החזרות

  • הבטחה<number>

    Chrome 91 ומעלה

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

registerService()

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

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

פרמטרים

  • serviceId

    מחרוזת

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

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

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

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

    ()=>void

החזרות

  • Promise<void>

    Chrome 91 ומעלה

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

removeService()

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

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

פרמטרים

  • serviceId

    מחרוזת

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

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

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

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

    ()=>void

החזרות

  • Promise<void>

    Chrome 91 ומעלה

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

resetAdvertising()

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

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

פרמטרים

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

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

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

    ()=>void

החזרות

  • Promise<void>

    Chrome 91 ומעלה

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

sendRequestResponse()

Chrome 52 ומעלה 
chrome.bluetoothLowEnergy.sendRequestResponse(
  response: Response,
)

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

פרמטרים

setAdvertisingInterval()

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

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

פרמטרים

  • minInterval

    מספר

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

  • maxInterval

    מספר

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

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

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

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

    ()=>void

החזרות

  • Promise<void>

    Chrome 91 ומעלה

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

startCharacteristicNotifications()

הבטחה 
chrome.bluetoothLowEnergy.startCharacteristicNotifications(
  characteristicId: string,
  properties?: NotificationProperties,
  callback?: function,
)

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

פרמטרים

  • characteristicId

    מחרוזת

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

  • נכסים

    NotificationProperties אופציונלי

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

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

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

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

    ()=>void

החזרות

  • Promise<void>

    Chrome 91 ומעלה

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

stopCharacteristicNotifications()

הבטחה 
chrome.bluetoothLowEnergy.stopCharacteristicNotifications(
  characteristicId: string,
  callback?: function,
)

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

פרמטרים

  • characteristicId

    מחרוזת

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

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

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

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

    ()=>void

החזרות

  • Promise<void>

    Chrome 91 ומעלה

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

unregisterAdvertisement()

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

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

פרמטרים

  • advertisementId

    מספר

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

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

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

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

    ()=>void

החזרות

  • Promise<void>

    Chrome 91 ומעלה

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

unregisterService()

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

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

פרמטרים

  • serviceId

    מחרוזת

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

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

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

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

    ()=>void

החזרות

  • Promise<void>

    Chrome 91 ומעלה

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

writeCharacteristicValue()

הבטחה 
chrome.bluetoothLowEnergy.writeCharacteristicValue(
  characteristicId: string,
  value: ArrayBuffer,
  callback?: function,
)

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

פרמטרים

  • characteristicId

    מחרוזת

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

  • value

    ArrayBuffer

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

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

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

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

    ()=>void

החזרות

  • Promise<void>

    Chrome 91 ומעלה

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

writeDescriptorValue()

הבטחה 
chrome.bluetoothLowEnergy.writeDescriptorValue(
  descriptorId: string,
  value: ArrayBuffer,
  callback?: function,
)

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

פרמטרים

  • descriptorId

    מחרוזת

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

  • value

    ArrayBuffer

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

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

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

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

    ()=>void

החזרות

  • Promise<void>

    Chrome 91 ומעלה

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

אירועים

onCharacteristicReadRequest

Chrome 52 ומעלה 
chrome.bluetoothLowEnergy.onCharacteristicReadRequest.addListener(
  callback: function,
)

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

פרמטרים

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

    פונקציה

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

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

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:ציוד היקפי מוגדרות כ-true. ייתכן שההרשאה לציוד ההיקפי לא תהיה זמינה לכל האפליקציות.

פרמטרים

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

    פונקציה

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

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

onDescriptorReadRequest

Chrome 52 ומעלה 
chrome.bluetoothLowEnergy.onDescriptorReadRequest.addListener(
  callback: function,
)

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

פרמטרים

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

    פונקציה

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

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

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:ציוד היקפי מוגדרות כ-true. ייתכן שההרשאה לציוד ההיקפי לא תהיה זמינה לכל האפליקציות.

פרמטרים

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

    פונקציה

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

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

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