chrome.bluetoothLowEnergy

תיאור

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

מניפסט

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

"bluetooth"

סוגים

Advertisement

‫Chrome 47 ואילך

מאפיינים

  • manufacturerData

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

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

  • serviceData

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

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

  • serviceUuids

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

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

  • solicitUuids

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

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

  • סוג הפרסום.

AdvertisementType

‫Chrome 47 ואילך

סוג הפרסום. אם בוחרים באפשרות broadcast, סוג הפרסום שיישלח יהיה 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 ואילך

    ההרשאות של רכיב ה-descriptor הזה.

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

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

פרמטרים

  • deviceAddress

    מחרוזת

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

  • נכסים

    ‫ConnectProperties אופציונלי

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

  • callback

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

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

    () => void

החזרות

  • Promise<void>

    ‫Chrome 91 ואילך

    ההבטחות נתמכות רק ב-Manifest V3 ובגרסאות מאוחרות יותר. בפלטפורמות אחרות צריך להשתמש בפונקציות Callback.

createCharacteristic()

Promise Chrome 52+ 
chrome.bluetoothLowEnergy.createCharacteristic(
  characteristic: Characteristic,
  serviceId: string,
  callback?: function,
): Promise<string>

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

פרמטרים

  • מאפיין

    מאפיין

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

  • serviceId

    מחרוזת

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

  • callback

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

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

    (characteristicId: string) => void

    • characteristicId

      מחרוזת

החזרות

  • Promise<string>

    ‫Chrome 91 ואילך

    ההבטחות נתמכות רק ב-Manifest V3 ובגרסאות מאוחרות יותר. בפלטפורמות אחרות צריך להשתמש בפונקציות Callback.

createDescriptor()

Promise Chrome 52+ 
chrome.bluetoothLowEnergy.createDescriptor(
  descriptor: Descriptor,
  characteristicId: string,
  callback?: function,
): Promise<string>

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

פרמטרים

  • descriptor

    Descriptor

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

  • characteristicId

    מחרוזת

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

  • callback

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

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

    (descriptorId: string) => void

    • descriptorId

      מחרוזת

החזרות

  • Promise<string>

    ‫Chrome 91 ואילך

    ההבטחות נתמכות רק ב-Manifest V3 ובגרסאות מאוחרות יותר. בפלטפורמות אחרות צריך להשתמש בפונקציות Callback.

createService()

Promise Chrome 52+ 
chrome.bluetoothLowEnergy.createService(
  service: Service,
  callback?: function,
): Promise<string>

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

פרמטרים

  • שירות

    Service

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

  • callback

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

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

    (serviceId: string) => void

    • serviceId

      מחרוזת

החזרות

  • Promise<string>

    ‫Chrome 91 ואילך

    ההבטחות נתמכות רק ב-Manifest V3 ובגרסאות מאוחרות יותר. בפלטפורמות אחרות צריך להשתמש בפונקציות Callback.

disconnect()

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

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

פרמטרים

  • deviceAddress

    מחרוזת

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

  • callback

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

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

    () => void

החזרות

  • Promise<void>

    ‫Chrome 91 ואילך

    ההבטחות נתמכות רק ב-Manifest V3 ובגרסאות מאוחרות יותר. בפלטפורמות אחרות צריך להשתמש בפונקציות Callback.

getCharacteristic()

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

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

פרמטרים

  • characteristicId

    מחרוזת

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

  • callback

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

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

    (result: Characteristic) => void

החזרות

  • Promise<Characteristic>

    ‫Chrome 91 ואילך

    ההבטחות נתמכות רק ב-Manifest V3 ובגרסאות מאוחרות יותר. בפלטפורמות אחרות צריך להשתמש בפונקציות Callback.

getCharacteristics()

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

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

פרמטרים

  • serviceId

    מחרוזת

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

  • callback

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

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

    (result: Characteristic[]) => void

החזרות

  • Promise<Characteristic[]>

    ‫Chrome 91 ואילך

    ההבטחות נתמכות רק ב-Manifest V3 ובגרסאות מאוחרות יותר. בפלטפורמות אחרות צריך להשתמש בפונקציות Callback.

getDescriptor()

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

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

פרמטרים

  • descriptorId

    מחרוזת

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

  • callback

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

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

    (result: Descriptor) => void

החזרות

  • Promise<Descriptor>

    ‫Chrome 91 ואילך

    ההבטחות נתמכות רק ב-Manifest V3 ובגרסאות מאוחרות יותר. בפלטפורמות אחרות צריך להשתמש בפונקציות Callback.

getDescriptors()

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

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

פרמטרים

  • characteristicId

    מחרוזת

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

  • callback

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

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

    (result: Descriptor[]) => void

החזרות

  • Promise<Descriptor[]>

    ‫Chrome 91 ואילך

    ההבטחות נתמכות רק ב-Manifest V3 ובגרסאות מאוחרות יותר. בפלטפורמות אחרות צריך להשתמש בפונקציות Callback.

getIncludedServices()

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

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

פרמטרים

  • serviceId

    מחרוזת

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

  • callback

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

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

    (result: Service[]) => void

החזרות

  • Promise<Service[]>

    ‫Chrome 91 ואילך

    ההבטחות נתמכות רק ב-Manifest V3 ובגרסאות מאוחרות יותר. בפלטפורמות אחרות צריך להשתמש בפונקציות Callback.

getService()

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

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

פרמטרים

  • serviceId

    מחרוזת

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

  • callback

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

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

    (result: Service) => void

החזרות

  • Promise<Service>

    ‫Chrome 91 ואילך

    ההבטחות נתמכות רק ב-Manifest V3 ובגרסאות מאוחרות יותר. בפלטפורמות אחרות צריך להשתמש בפונקציות Callback.

getServices()

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

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

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

פרמטרים

  • deviceAddress

    מחרוזת

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

  • callback

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

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

    (result: Service[]) => void

החזרות

  • Promise<Service[]>

    ‫Chrome 91 ואילך

    ההבטחות נתמכות רק ב-Manifest V3 ובגרסאות מאוחרות יותר. בפלטפורמות אחרות צריך להשתמש בפונקציות Callback.

notifyCharacteristicValueChanged()

Promise Chrome 52+ 
chrome.bluetoothLowEnergy.notifyCharacteristicValueChanged(
  characteristicId: string,
  notification: Notification,
  callback?: function,
): Promise<void>

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

פרמטרים

  • characteristicId

    מחרוזת

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

  • התראה

    התראה

  • callback

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

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

    () => void

החזרות

  • Promise<void>

    ‫Chrome 91 ואילך

    ההבטחות נתמכות רק ב-Manifest V3 ובגרסאות מאוחרות יותר. בפלטפורמות אחרות צריך להשתמש בפונקציות Callback.

readCharacteristicValue()

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

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

פרמטרים

  • characteristicId

    מחרוזת

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

  • callback

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

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

    (result: Characteristic) => void

החזרות

  • Promise<Characteristic>

    ‫Chrome 91 ואילך

    ההבטחות נתמכות רק ב-Manifest V3 ובגרסאות מאוחרות יותר. בפלטפורמות אחרות צריך להשתמש בפונקציות Callback.

readDescriptorValue()

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

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

פרמטרים

  • descriptorId

    מחרוזת

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

  • callback

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

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

    (result: Descriptor) => void

החזרות

  • Promise<Descriptor>

    ‫Chrome 91 ואילך

    ההבטחות נתמכות רק ב-Manifest V3 ובגרסאות מאוחרות יותר. בפלטפורמות אחרות צריך להשתמש בפונקציות Callback.

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 Low Energy).

פרמטרים

  • פרסומת

    פרסומת

    המודעה לפרסום.

  • callback

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

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

    (advertisementId: number) => void

    • advertisementId

      number

החזרות

  • Promise<number>

    ‫Chrome 91 ואילך

    ההבטחות נתמכות רק ב-Manifest V3 ובגרסאות מאוחרות יותר. בפלטפורמות אחרות צריך להשתמש בפונקציות Callback.

registerService()

Promise Chrome 52+ 
chrome.bluetoothLowEnergy.registerService(
  serviceId: string,
  callback?: function,
): Promise<void>

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

פרמטרים

  • serviceId

    מחרוזת

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

  • callback

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

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

    () => void

החזרות

  • Promise<void>

    ‫Chrome 91 ואילך

    ההבטחות נתמכות רק ב-Manifest V3 ובגרסאות מאוחרות יותר. בפלטפורמות אחרות צריך להשתמש בפונקציות Callback.

removeService()

Promise Chrome 52+ 
chrome.bluetoothLowEnergy.removeService(
  serviceId: string,
  callback?: function,
): Promise<void>

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

פרמטרים

  • serviceId

    מחרוזת

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

  • callback

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

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

    () => void

החזרות

  • Promise<void>

    ‫Chrome 91 ואילך

    ההבטחות נתמכות רק ב-Manifest V3 ובגרסאות מאוחרות יותר. בפלטפורמות אחרות צריך להשתמש בפונקציות Callback.

resetAdvertising()

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

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

פרמטרים

  • callback

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

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

    () => void

החזרות

  • Promise<void>

    ‫Chrome 91 ואילך

    ההבטחות נתמכות רק ב-Manifest V3 ובגרסאות מאוחרות יותר. בפלטפורמות אחרות צריך להשתמש בפונקציות Callback.

sendRequestResponse()

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

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

פרמטרים

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,240ms (בהתאם למפרט).

  • callback

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

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

    () => void

החזרות

  • Promise<void>

    ‫Chrome 91 ואילך

    ההבטחות נתמכות רק ב-Manifest V3 ובגרסאות מאוחרות יותר. בפלטפורמות אחרות צריך להשתמש בפונקציות Callback.

startCharacteristicNotifications()

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

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

פרמטרים

  • characteristicId

    מחרוזת

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

  • נכסים

    ‫NotificationProperties אופציונלי

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

  • callback

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

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

    () => void

החזרות

  • Promise<void>

    ‫Chrome 91 ואילך

    ההבטחות נתמכות רק ב-Manifest V3 ובגרסאות מאוחרות יותר. בפלטפורמות אחרות צריך להשתמש בפונקציות Callback.

stopCharacteristicNotifications()

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

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

פרמטרים

  • characteristicId

    מחרוזת

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

  • callback

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

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

    () => void

החזרות

  • Promise<void>

    ‫Chrome 91 ואילך

    ההבטחות נתמכות רק ב-Manifest V3 ובגרסאות מאוחרות יותר. בפלטפורמות אחרות צריך להשתמש בפונקציות Callback.

unregisterAdvertisement()

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

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

פרמטרים

  • advertisementId

    number

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

  • callback

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

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

    () => void

החזרות

  • Promise<void>

    ‫Chrome 91 ואילך

    ההבטחות נתמכות רק ב-Manifest V3 ובגרסאות מאוחרות יותר. בפלטפורמות אחרות צריך להשתמש בפונקציות Callback.

unregisterService()

Promise Chrome 52+ 
chrome.bluetoothLowEnergy.unregisterService(
  serviceId: string,
  callback?: function,
): Promise<void>

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

פרמטרים

  • serviceId

    מחרוזת

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

  • callback

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

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

    () => void

החזרות

  • Promise<void>

    ‫Chrome 91 ואילך

    ההבטחות נתמכות רק ב-Manifest V3 ובגרסאות מאוחרות יותר. בפלטפורמות אחרות צריך להשתמש בפונקציות Callback.

writeCharacteristicValue()

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

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

פרמטרים

  • characteristicId

    מחרוזת

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

  • ערך

    ArrayBuffer

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

  • callback

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

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

    () => void

החזרות

  • Promise<void>

    ‫Chrome 91 ואילך

    ההבטחות נתמכות רק ב-Manifest V3 ובגרסאות מאוחרות יותר. בפלטפורמות אחרות צריך להשתמש בפונקציות Callback.

writeDescriptorValue()

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

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

פרמטרים

  • descriptorId

    מחרוזת

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

  • ערך

    ArrayBuffer

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

  • callback

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

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

    () => void

החזרות

  • Promise<void>

    ‫Chrome 91 ואילך

    ההבטחות נתמכות רק ב-Manifest V3 ובגרסאות מאוחרות יותר. בפלטפורמות אחרות צריך להשתמש בפונקציות Callback.

אירועים

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