תיאור
ה-API של chrome.bluetoothLowEnergy
משמש לתקשורת עם מכשירי Bluetooth Smart (עם צריכת אנרגיה נמוכה) באמצעות כללי פרופיל המאפיינים הכללי (GATT).
מניפסט
סוגים
Advertisement
מאפיינים
-
manufacturerData
ManufacturerData[] אופציונלי
רשימת נתונים ספציפיים של היצרן שייכללו ב"נתונים ספציפיים ליצרן" בשדות של נתוני הפרסום.
-
serviceData
ServiceData[] אופציונלי
רשימה של נתוני שירות שייכללו ב'נתוני שירות' בשדות של נתוני הפרסום.
-
serviceUuids
string[] אופציונלי
רשימה של מזהים ייחודיים אוניברסליים (UUID) שצריך לכלול במזהי UUID של השירות בשדה 'נתוני פרסום'. מזהי UUID האלה יכולים להיות בפורמטים של 16 ביט, 32 ביט או 128 ביט.
-
solicitUuids
string[] אופציונלי
רשימה של מזהים ייחודיים אוניברסליים (UUID) שצריך לכלול במזהי UUID מסוג Solicit UUID בשדה 'נתוני פרסום'. מזהי UUID האלה יכולים להיות בפורמטים של 16 ביט, 32 ביט או 128 ביט.
-
סוג המודעה.
AdvertisementType
סוג המודעה. אם האפשרות 'שידור' נבחר, סוג המודעה שנשלחת יהיה ADV_NONCONN_IND והמכשיר ישודר עם כתובת MAC אקראית. אם ההגדרה היא 'ציוד היקפי', סוג המודעה יהיה ADV_IND או ADV_SCAN_IND, והמכשיר ישדר דרך כתובת ה-MAC של מתאם Bluetooth אמיתי.
Enum
"broadcast"
"ציוד היקפי"
Characteristic
מאפיינים
-
instanceId
מחרוזת אופציונלי
הפונקציה מחזירה את המזהה שהוקצה למאפיין הזה. אפשר להשתמש במזהה המכונה כדי להבחין בין מאפיינים של ציוד היקפי עם אותו UUID וכדי לבצע הפעלות של פונקציות שמקבלות מזהה מאפיין. נוכחות, אם המופע הזה מייצג מאפיין מרוחק.
-
נכסים
המאפיינים של המאפיין הזה.
-
שירות
שירות אופציונלי
שירות GATT שאליו שייך המאפיין הזה.
-
Uuid
מחרוזת
ה-UUID של המאפיין, למשל 00002a37-0000-1000-8000-00805f9b34fb.
-
ערך
ArrayBuffer אופציונלי
ערך המאפיין שנשמר במטמון כרגע. הערך הזה מתעדכן כשקוראים את הערך של המאפיין או מעדכנים אותו באמצעות התראה או אינדיקציה.
CharacteristicProperty
ערכים שמייצגים את המאפיינים האפשריים של מאפיין. המערכת מסיקה הרשאות אופייניות מהנכסים האלה. יש לעיין במפרט של Bluetooth 4.x כדי לראות את המשמעות של כל נכס בנפרד.
Enum
"broadcast"
"קריאה"
"writeWithoutResponse"
"כתיבה"
"notify"
"ציון"
"authenticatedatedWrites"
"extendedProperties"
"reliableWrite"
"writableAuxiliaries"
"encryptRead"
"encryptWrite"
"encryptAuthenticatedRead"
"encryptAuthenticatedWrite"
ConnectProperties
מאפיינים
-
מתמיד
בוליאני
סימון שמציין אם החיבור למכשיר נשאר פתוח אחרי הסרת הטעינה של דף האירוע של האפליקציה (מידע נוסף זמין בניהול מחזור החיים של אפליקציה). ערך ברירת המחדל הוא
false.
Descriptor
מאפיינים
-
מאפיין
מאפיין אופציונלי
מאפיין GATT שאליו שייך התיאור הזה.
-
instanceId
מחרוזת אופציונלי
הפונקציה מחזירה את המזהה שהוקצה לתיאור הזה. אפשר להשתמש במזהה המכונה כדי להבחין בין מתארים לבין ציוד היקפי עם אותו UUID וכדי לבצע הפעלות של פונקציות שמקבלות מזהה מתאר. נוכחות, אם המופע הזה מייצג מאפיין מרוחק.
-
permissionsChrome 52+
ההרשאות של המתאר הזה.
-
Uuid
מחרוזת
ה-UUID של מתאר המאפיין, למשל: 00002902-0000-1000-8000-00805f9b34fb.
-
ערך
ArrayBuffer אופציונלי
ערך התיאור ששמור במטמון כרגע. הערך הזה מתעדכן כשקוראים את הערך של התיאור.
DescriptorPermission
ערכים שמייצגים הרשאות אפשריות לתיאור. יש לעיין במפרט של Bluetooth 4.x כדי לראות את המשמעות של כל הרשאה בנפרד.
Enum
"קריאה"
"כתיבה"
"EncryptionRead"
"EncryptWrite"
"EncryptionAuthenticatedRead"
"EncryptionAuthenticatedWrite"
Device
מאפיינים
-
כתובת
מחרוזת
כתובת המכשיר, בפורמט 'XX:XX:XX:XX:XX:XX'.
-
deviceClass
מספר אופציונלי
המחלקה של המכשיר, שדה ביט המוגדר על ידי http://www.bluetooth.org/en-us/specification/assigned-numbers/baseband.
-
שם
מחרוזת אופציונלי
שם המכשיר שקריא לאנשים.
ManufacturerData
מאפיינים
-
נתונים
מספר[]
-
id [מזהה]
number
Notification
מאפיינים
-
shouldIndicate
ערך בוליאני אופציונלי
סימון אופציונלי לשליחת אינדיקציה במקום התראה.
-
ערך
ArrayBuffer
הערך החדש של המאפיין.
NotificationProperties
מאפיינים
-
מתמיד
בוליאני
סימון שמציין אם האפליקציה צריכה לקבל התראות לאחר הסרת דף האירוע של האפליקציה (מידע נוסף זמין בניהול מחזור החיים של אפליקציה). ערך ברירת המחדל הוא
false
.
Request
מאפיינים
-
מכשיר
המכשיר ששלח את הבקשה הזו.
-
requestId
number
המזהה הייחודי של הבקשה. צריך להשתמש במזהה הזה כשמגיבים לבקשה הזו.
-
ערך
ArrayBuffer אופציונלי
ערך לכתיבה (אם זו בקשת כתיבה).
Response
מאפיינים
-
isError
בוליאני
אם זו תגובת שגיאה, הערך אמור להיות נכון.
-
requestId
number
המזהה של הבקשה שאליה נשלחה תשובה.
-
ערך
ArrayBuffer אופציונלי
ערך התשובה. בקשות כתיבה ותגובות לשגיאות יתעלמו מהפרמטר הזה.
Service
מאפיינים
-
deviceAddress
מחרוזת אופציונלי
כתובת המכשיר של הציוד ההיקפי המרוחק שאליו שייך שירות GATT. הצגה, אם המופע הזה מייצג שירות מרוחק.
-
instanceId
מחרוזת אופציונלי
מחזירה את המזהה שהוקצה לשירות הזה. אתם יכולים להשתמש במזהה המכונה כדי להבחין בין שירותים לבין ציוד היקפי עם אותו UUID וכדי לבצע הפעלות של פונקציות שמקבלות מזהה שירות. הצגה, אם המופע הזה מייצג שירות מרוחק.
-
ראשי
בוליאני
מציין אם סוג השירות הזה הוא ראשי או משני.
-
Uuid
מחרוזת
המזהה הייחודי של השירות (UUID), למשל 0000180d-0000-1000-8000-00805f9b34fb.
ServiceData
מאפיינים
-
נתונים
מספר[]
-
Uuid
מחרוזת
שיטות
connect()
chrome.bluetoothLowEnergy.connect(
deviceAddress: string,
properties?: ConnectProperties,
callback?: function,
)
יוצר חיבור בין האפליקציה למכשיר באמצעות הכתובת הנתונה. ייתכן שהמכשיר כבר חובר ושירותי ה-GATT שלו זמינים בלי לקרוא ל-connect
. עם זאת, אפליקציה שרוצה לגשת לשירותי GATT של מכשיר צריכה לבצע קריאה לפונקציה הזו כדי לוודא שהחיבור למכשיר נשמר. אם המכשיר לא מחובר, כל שירותי GATT של המכשיר יתגלו לאחר שיחה מוצלחת אל connect
.
פרמטרים
-
deviceAddress
מחרוזת
כתובת ה-Bluetooth של המכשיר המרוחק שאליו יש לפתוח חיבור GATT.
-
נכסים
ConnectProperties אופציונלי
מאפייני חיבור (אופציונלי).
-
קריאה חוזרת (callback)
פונקציה אופציונלית
הפרמטר
callback
נראה כך:() => void
החזרות
-
הבטחה<Empty>
Chrome מגרסה 91 ואילךהבטחות נתמכות רק במניפסט מגרסה V3 ואילך, בפלטפורמות אחרות צריך להשתמש בקריאות חוזרות (callback).
createCharacteristic()
chrome.bluetoothLowEnergy.createCharacteristic(
characteristic: Characteristic,
serviceId: string,
callback?: function,
)
יצירת מאפיין GATT שמתארח בפלטפורמה מקומית. המאפיין הזה חייב להתארח בשירות תקין. אם מזהה השירות לא חוקי, תוגדר השגיאה lastError. הפונקציה הזו זמינה רק אם באפליקציה מוגדרות הרשאות Bluetooth:low_energy וגם הרשאות Bluetooth:ציוד היקפי מוגדרות כ-True. יכול להיות שהרשאת הציוד ההיקפי לא תהיה זמינה לכל האפליקציות.
פרמטרים
-
מאפיין
המאפיין שצריך ליצור.
-
serviceId
מחרוזת
המזהה של השירות שעבורו רוצים ליצור את המאפיין הזה.
-
קריאה חוזרת (callback)
פונקציה אופציונלית
הפרמטר
callback
נראה כך:(characteristicId: string) => void
-
characteristicId
מחרוזת
-
החזרות
-
Promise<string>
Chrome מגרסה 91 ואילךהבטחות נתמכות רק במניפסט מגרסה V3 ואילך, בפלטפורמות אחרות צריך להשתמש בקריאות חוזרות (callback).
createDescriptor()
chrome.bluetoothLowEnergy.createDescriptor(
descriptor: Descriptor,
characteristicId: string,
callback?: function,
)
יצירת מתאר GATT שמתארח באופן מקומי. המתאר הזה חייב להתארח במאפיין חוקי. אם מזהה המאפיין אינו חוקי, תוגדר השגיאה lastError. הפונקציה הזו זמינה רק אם באפליקציה מוגדרות הרשאות Bluetooth:low_energy וגם הרשאות Bluetooth:ציוד היקפי מוגדרות כ-True. יכול להיות שהרשאת הציוד ההיקפי לא תהיה זמינה לכל האפליקציות.
פרמטרים
-
מתאר
המתאר ליצירה.
-
characteristicId
מחרוזת
המזהה של המאפיין שעבורו רוצים ליצור את התיאור הזה.
-
קריאה חוזרת (callback)
פונקציה אופציונלית
הפרמטר
callback
נראה כך:(descriptorId: string) => void
-
descriptorId
מחרוזת
-
החזרות
-
Promise<string>
Chrome מגרסה 91 ואילךהבטחות נתמכות רק במניפסט מגרסה V3 ואילך, בפלטפורמות אחרות צריך להשתמש בקריאות חוזרות (callback).
createService()
chrome.bluetoothLowEnergy.createService(
service: Service,
callback?: function,
)
יצירת שירות GATT שמתארח באופן מקומי. ניתן לרשום את השירות הזה כזמין בשרת GATT מקומי. הפונקציה הזו זמינה רק אם באפליקציה מוגדרות הרשאות Bluetooth:low_energy וגם הרשאות Bluetooth:ציוד היקפי מוגדרות כ-True. יכול להיות שהרשאת הציוד ההיקפי לא תהיה זמינה לכל האפליקציות.
פרמטרים
-
שירות
השירות שיש ליצור.
-
קריאה חוזרת (callback)
פונקציה אופציונלית
הפרמטר
callback
נראה כך:(serviceId: string) => void
-
serviceId
מחרוזת
-
החזרות
-
Promise<string>
Chrome מגרסה 91 ואילךהבטחות נתמכות רק במניפסט מגרסה V3 ואילך, בפלטפורמות אחרות צריך להשתמש בקריאות חוזרות (callback).
disconnect()
chrome.bluetoothLowEnergy.disconnect(
deviceAddress: string,
callback?: function,
)
הלחצן סוגר את החיבור של האפליקציה למכשיר עם הכתובת הנתונה. הערה: הפעולה הזו לא תמיד תשמיד את הקישור הפיזי עצמו, כי יכול להיות שיש אפליקציות אחרות עם חיבורים פתוחים.
פרמטרים
-
deviceAddress
מחרוזת
כתובת ה-Bluetooth של המכשיר המחובר לרשת אחרת.
-
קריאה חוזרת (callback)
פונקציה אופציונלית
הפרמטר
callback
נראה כך:() => void
החזרות
-
הבטחה<Empty>
Chrome מגרסה 91 ואילךהבטחות נתמכות רק במניפסט מגרסה V3 ואילך, בפלטפורמות אחרות צריך להשתמש בקריאות חוזרות (callback).
getCharacteristic()
chrome.bluetoothLowEnergy.getCharacteristic(
characteristicId: string,
callback?: function,
)
מקבלים את מאפיין ה-GATT עם מזהה המכונה הנתון ששייך לשירות GATT הנתון, אם המאפיין קיים.
פרמטרים
-
characteristicId
מחרוזת
מזהה המכונה של מאפיין ה-GATT המבוקש.
-
קריאה חוזרת (callback)
פונקציה אופציונלית
הפרמטר
callback
נראה כך:(result: Characteristic) => void
-
תוצאה
-
החזרות
-
התחייבות<Characteristic>
Chrome מגרסה 91 ואילךהבטחות נתמכות רק במניפסט מגרסה V3 ואילך, בפלטפורמות אחרות צריך להשתמש בקריאות חוזרות (callback).
getCharacteristics()
chrome.bluetoothLowEnergy.getCharacteristics(
serviceId: string,
callback?: function,
)
קבלת רשימה של כל מאפייני GATT שנמצאו ושייכים לשירות הנתון.
פרמטרים
-
serviceId
מחרוזת
מזהה המכונה של שירות ה-GATT שאת המאפיינים שלו צריך להחזיר.
-
קריאה חוזרת (callback)
פונקציה אופציונלית
הפרמטר
callback
נראה כך:(result: Characteristic[]) => void
-
תוצאה
מאפיין[]
-
החזרות
-
הבטחה<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 שכלולים בשירות הנתון.
פרמטרים
החזרות
-
הבטחה<שירות[]>
Chrome מגרסה 91 ואילךהבטחות נתמכות רק במניפסט מגרסה V3 ואילך, בפלטפורמות אחרות צריך להשתמש בקריאות חוזרות (callback).
getService()
chrome.bluetoothLowEnergy.getService(
serviceId: string,
callback?: function,
)
מקבלים את שירות GATT עם מזהה המכונה הנתון.
פרמטרים
-
serviceId
מחרוזת
מזהה המכונה של שירות GATT המבוקש.
-
קריאה חוזרת (callback)
פונקציה אופציונלית
הפרמטר
callback
נראה כך:(result: Service) => void
-
תוצאה
-
החזרות
-
Promise<Service>
Chrome מגרסה 91 ואילךהבטחות נתמכות רק במניפסט מגרסה V3 ואילך, בפלטפורמות אחרות צריך להשתמש בקריאות חוזרות (callback).
getServices()
chrome.bluetoothLowEnergy.getServices(
deviceAddress: string,
callback?: function,
)
קבלת כל שירותי GATT שזוהו במכשיר המחובר לרשת אחרת עם כתובת המכשיר הנתונה.
הערה: אם זיהוי השירות עדיין לא הושלם במכשיר, ה-API הזה יחזיר קבוצת משנה (כנראה ריקה) של שירותים. הדרך לעקוף את הבעיה היא להוסיף עיכוב מבוסס-זמן ו/או לבצע שיחה שוב ושוב עד לקבלת המספר הצפוי של השירותים.
פרמטרים
החזרות
-
הבטחה<שירות[]>
Chrome מגרסה 91 ואילךהבטחות נתמכות רק במניפסט מגרסה V3 ואילך, בפלטפורמות אחרות צריך להשתמש בקריאות חוזרות (callback).
notifyCharacteristicValueChanged()
chrome.bluetoothLowEnergy.notifyCharacteristicValueChanged(
characteristicId: string,
notification: Notification,
callback?: function,
)
שליחת הודעה למכשיר מרוחק לגבי ערך חדש של מאפיין. אם הדגל צריך לציין באובייקט ההתראה מתקיים, יישלח אינדיקציה במקום התראה. הערה: המאפיין צריך להגדיר את ה'התראה' בצורה נכונה או 'ציון' במהלך היצירה כדי שהקריאה הזו תצליח. הפונקציה הזו זמינה רק אם באפליקציה מוגדרות הרשאות Bluetooth:low_energy וגם הרשאות Bluetooth:ציוד היקפי מוגדרות כ-True. יכול להיות שהרשאת הציוד ההיקפי לא תהיה זמינה לכל האפליקציות.
פרמטרים
-
characteristicId
מחרוזת
המאפיין שלגביו יש לשלוח את ההערה.
-
notification
-
קריאה חוזרת (callback)
פונקציה אופציונלית
הפרמטר
callback
נראה כך:() => void
החזרות
-
הבטחה<Empty>
Chrome מגרסה 91 ואילךהבטחות נתמכות רק במניפסט מגרסה V3 ואילך, בפלטפורמות אחרות צריך להשתמש בקריאות חוזרות (callback).
readCharacteristicValue()
chrome.bluetoothLowEnergy.readCharacteristicValue(
characteristicId: string,
callback?: function,
)
מאחזרים את הערך של מאפיין שצוין מציוד היקפי מרוחק.
פרמטרים
-
characteristicId
מחרוזת
מזהה המכונה של מאפיין ה-GATT שאת הערך שלו צריך לקרוא מהמכשיר המרוחק.
-
קריאה חוזרת (callback)
פונקציה אופציונלית
הפרמטר
callback
נראה כך:(result: Characteristic) => void
-
תוצאה
-
החזרות
-
מבטיח<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()
chrome.bluetoothLowEnergy.registerAdvertisement(
advertisement: Advertisement,
callback?: function,
)
יוצרים מודעה ורושמים אותה לפרסום. כדי לקרוא לפונקציה הזו, צריך להגדיר לאפליקציה את ההרשאות Bluetooth:low_energy ו-Bluetooth:ציוד היקפי כ-true. בנוסף, ה-API הזה זמין רק לאפליקציות שמופעלות אוטומטית במצב קיוסק או על ידי הגדרת האפשרות ' --enable-ble- משחק-in-apps' מתג שורת פקודה. פרטים נוספים זמינים בכתובת https://developer.chrome.com/apps/manifest/bluetooth הערה: בחלק ממצבי החומרה, הציוד ההיקפי והמצב המרכזי נתמכים בו-זמנית, אבל בחומרה שלא תומכת בכך, הקריאה הזו תעביר את המכשיר למצב ציוד היקפי. במקרה של חומרה שלא תומכת גם במצב מרכזי וגם במצב היקפי, ניסיון להשתמש במכשיר בשני המצבים יוביל להתנהגות לא מוגדרת או ימנע מאפליקציות אחרות בתפקיד מרכזי לפעול (כולל גילוי של מכשירי Bluetooth עם צריכת אנרגיה נמוכה).
פרמטרים
-
פרסומת
הפרסומת שצריך לפרסם.
-
קריאה חוזרת (callback)
פונקציה אופציונלית
הפרמטר
callback
נראה כך:(advertisementId: number) => void
-
advertisementId
number
-
החזרות
-
Promise<number>
Chrome מגרסה 91 ואילךהבטחות נתמכות רק במניפסט מגרסה V3 ואילך, בפלטפורמות אחרות צריך להשתמש בקריאות חוזרות (callback).
registerService()
chrome.bluetoothLowEnergy.registerService(
serviceId: string,
callback?: function,
)
לרשום את השירות הנתון בשרת GATT המקומי. אם מזהה השירות לא תקין, תוגדר השגיאה lastError. הפונקציה הזו זמינה רק אם באפליקציה מוגדרות הרשאות Bluetooth:low_energy וגם הרשאות Bluetooth:ציוד היקפי מוגדרות כ-True. יכול להיות שהרשאת הציוד ההיקפי לא תהיה זמינה לכל האפליקציות.
פרמטרים
-
serviceId
מחרוזת
המזהה הייחודי של השירות שנוצר.
-
קריאה חוזרת (callback)
פונקציה אופציונלית
הפרמטר
callback
נראה כך:() => void
החזרות
-
הבטחה<Empty>
Chrome מגרסה 91 ואילךהבטחות נתמכות רק במניפסט מגרסה V3 ואילך, בפלטפורמות אחרות צריך להשתמש בקריאות חוזרות (callback).
removeService()
chrome.bluetoothLowEnergy.removeService(
serviceId: string,
callback?: function,
)
מסירים את השירות שצוין ומבטלים את הרישום שלו אם הוא רשום. אם מזהה השירות לא תקין, תוגדר השגיאה lastError. הפונקציה הזו זמינה רק אם באפליקציה מוגדרות הרשאות Bluetooth:low_energy וגם הרשאות Bluetooth:ציוד היקפי מוגדרות כ-True. יכול להיות שהרשאת הציוד ההיקפי לא תהיה זמינה לכל האפליקציות.
פרמטרים
-
serviceId
מחרוזת
המזהה הייחודי של שירות רשום כרגע.
-
קריאה חוזרת (callback)
פונקציה אופציונלית
הפרמטר
callback
נראה כך:() => void
החזרות
-
הבטחה<Empty>
Chrome מגרסה 91 ואילךהבטחות נתמכות רק במניפסט מגרסה V3 ואילך, בפלטפורמות אחרות צריך להשתמש בקריאות חוזרות (callback).
resetAdvertising()
chrome.bluetoothLowEnergy.resetAdvertising(
callback?: function,
)
איפוס הפרסום במכשיר הנוכחי. הפעולה הזו תבטל את הרישום ותפסיק את כל המודעות הקיימות.
פרמטרים
-
קריאה חוזרת (callback)
פונקציה אופציונלית
הפרמטר
callback
נראה כך:() => void
החזרות
-
הבטחה<Empty>
Chrome מגרסה 91 ואילךהבטחות נתמכות רק במניפסט מגרסה V3 ואילך, בפלטפורמות אחרות צריך להשתמש בקריאות חוזרות (callback).
sendRequestResponse()
chrome.bluetoothLowEnergy.sendRequestResponse(
response: Response,
)
שליחת תשובה לבקשת קריאה/כתיבה של מאפיין או של תיאור. הפונקציה הזו זמינה רק אם לאפליקציה יש גם הגדרת Bluetooth:low_energy וגם הרשאות Bluetooth:ציוד היקפי מוגדרות כ-True. יכול להיות שהרשאת הציוד ההיקפי לא תהיה זמינה לכל האפליקציות.
פרמטרים
-
תשובה
התגובה לבקשה.
setAdvertisingInterval()
chrome.bluetoothLowEnergy.setAdvertisingInterval(
minInterval: number,
maxInterval: number,
callback?: function,
)
זוהי מרווח הזמן בין שתי מודעות ברצף. הערה: מומלץ לעשות זאת. המרווח בפועל עשוי להשתנות באופן לא טריוויאלי ממרווחי הזמן המבוקשים. ברכיבי חומרה מסוימים יש מרווח זמן מינימלי של 100 אלפיות השנייה. ערכי המינימום והמקסימום לא יכולים לחרוג מהטווח המותר על פי מפרט Bluetooth 4.2.
פרמטרים
-
minInterval
number
מרווח מינימלי בין מודעות (באלפיות שנייה). משך הזמן לא יכול להיות פחות מ-20 אלפיות שנייה (לפי המפרט).
-
maxInterval
number
מרווח מקסימלי בין פרסומות (באלפיות שנייה). האורך המקסימלי הוא 10,240 אלפיות השנייה (לפי המפרט).
-
קריאה חוזרת (callback)
פונקציה אופציונלית
הפרמטר
callback
נראה כך:() => void
החזרות
-
הבטחה<Empty>
Chrome מגרסה 91 ואילךהבטחות נתמכות רק במניפסט מגרסה V3 ואילך, בפלטפורמות אחרות צריך להשתמש בקריאות חוזרות (callback).
startCharacteristicNotifications()
chrome.bluetoothLowEnergy.startCharacteristicNotifications(
characteristicId: string,
properties?: NotificationProperties,
callback?: function,
)
הפעלת התראות/אינדיקטורים של ערכים מהמאפיין שצוין. לאחר ההפעלה, האפליקציה תוכל להאזין להתראות באמצעות האירוע onCharacteristicValueChanged
.
פרמטרים
-
characteristicId
מחרוזת
מזהה המכונה של מאפיין ה-GATT שבו צריך להפעיל את ההתראות.
-
נכסים
NotificationProperties אופציונלי
מאפייני סשן של התראות (אופציונלי).
-
קריאה חוזרת (callback)
פונקציה אופציונלית
הפרמטר
callback
נראה כך:() => void
החזרות
-
הבטחה<Empty>
Chrome מגרסה 91 ואילךהבטחות נתמכות רק במניפסט מגרסה V3 ואילך, בפלטפורמות אחרות צריך להשתמש בקריאות חוזרות (callback).
stopCharacteristicNotifications()
chrome.bluetoothLowEnergy.stopCharacteristicNotifications(
characteristicId: string,
callback?: function,
)
משביתים התראות או אינדיקטורים של ערכים מהמאפיין שצוין. אחרי שהשיחה תסתיים בהצלחה, האפליקציה תפסיק לקבל התראות או אינדיקטורים מהמאפיין הזה.
פרמטרים
-
characteristicId
מחרוזת
מזהה המופע של מאפיין ה-GATT שבו צריך להפסיק את סשן ההתראות של האפליקציה הזו.
-
קריאה חוזרת (callback)
פונקציה אופציונלית
הפרמטר
callback
נראה כך:() => void
החזרות
-
הבטחה<Empty>
Chrome מגרסה 91 ואילךהבטחות נתמכות רק במניפסט מגרסה V3 ואילך, בפלטפורמות אחרות צריך להשתמש בקריאות חוזרות (callback).
unregisterAdvertisement()
chrome.bluetoothLowEnergy.unregisterAdvertisement(
advertisementId: number,
callback?: function,
)
מבטל את הרישום של פרסומת ומפסיק את הפרסום שלה. אם ביטול הרישום של המודעה נכשל, הדרך היחידה להפסיק את הפרסום היא להפעיל מחדש את המכשיר.
פרמטרים
-
advertisementId
number
המזהה של המודעה שצריך לבטל את הרישום שלה.
-
קריאה חוזרת (callback)
פונקציה אופציונלית
הפרמטר
callback
נראה כך:() => void
החזרות
-
הבטחה<Empty>
Chrome מגרסה 91 ואילךהבטחות נתמכות רק במניפסט מגרסה V3 ואילך, בפלטפורמות אחרות צריך להשתמש בקריאות חוזרות (callback).
unregisterService()
chrome.bluetoothLowEnergy.unregisterService(
serviceId: string,
callback?: function,
)
ביטול הרישום של השירות הנתון בשרת GATT המקומי. אם מזהה השירות לא תקין, תוגדר השגיאה lastError. הפונקציה הזו זמינה רק אם באפליקציה מוגדרות הרשאות Bluetooth:low_energy וגם הרשאות Bluetooth:ציוד היקפי מוגדרות כ-True. יכול להיות שהרשאת הציוד ההיקפי לא תהיה זמינה לכל האפליקציות.
פרמטרים
-
serviceId
מחרוזת
המזהה הייחודי של שירות רשום כרגע.
-
קריאה חוזרת (callback)
פונקציה אופציונלית
הפרמטר
callback
נראה כך:() => void
החזרות
-
הבטחה<Empty>
Chrome מגרסה 91 ואילךהבטחות נתמכות רק במניפסט מגרסה V3 ואילך, בפלטפורמות אחרות צריך להשתמש בקריאות חוזרות (callback).
writeCharacteristicValue()
chrome.bluetoothLowEnergy.writeCharacteristicValue(
characteristicId: string,
value: ArrayBuffer,
callback?: function,
)
כתיבת הערך של מאפיין מסוים מציוד היקפי מרוחק.
פרמטרים
-
characteristicId
מחרוזת
מזהה המכונה של מאפיין ה-GATT שאליו צריך לכתוב את הערך.
-
ערך
ArrayBuffer
הערך שיש לשלוח למאפיין המרוחק כחלק מבקשת הכתיבה.
-
קריאה חוזרת (callback)
פונקציה אופציונלית
הפרמטר
callback
נראה כך:() => void
החזרות
-
הבטחה<Empty>
Chrome מגרסה 91 ואילךהבטחות נתמכות רק במניפסט מגרסה V3 ואילך, בפלטפורמות אחרות צריך להשתמש בקריאות חוזרות (callback).
writeDescriptorValue()
chrome.bluetoothLowEnergy.writeDescriptorValue(
descriptorId: string,
value: ArrayBuffer,
callback?: function,
)
כתיבת הערך של מתאר מאפיין ספציפי מציוד היקפי מרוחק.
פרמטרים
-
descriptorId
מחרוזת
מזהה המכונה של מתאר מאפיין GATT שאליו צריך לכתוב את הערך.
-
ערך
ArrayBuffer
הערך שצריך לשלוח למתאר מרחוק כחלק מבקשת הכתיבה.
-
קריאה חוזרת (callback)
פונקציה אופציונלית
הפרמטר
callback
נראה כך:() => void
החזרות
-
הבטחה<Empty>
Chrome מגרסה 91 ואילךהבטחות נתמכות רק במניפסט מגרסה V3 ואילך, בפלטפורמות אחרות צריך להשתמש בקריאות חוזרות (callback).
אירועים
onCharacteristicReadRequest
chrome.bluetoothLowEnergy.onCharacteristicReadRequest.addListener(
callback: function,
)
מופעל כשמכשיר מרכזי מחובר מבקש לקרוא את הערך של מאפיין שרשום בשרת GATT המקומי. אם לא תגיבו לבקשה הזו למשך זמן רב, היא עלולה לגרום לניתוק. האירוע הזה זמין רק אם לאפליקציה יש גם הרשאת Bluetooth:low_energy וגם הרשאות Bluetooth:ציוד היקפי מוגדרות כ-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.bluetoothLowEnergy.onCharacteristicWriteRequest.addListener(
callback: function,
)
מופעל כשמכשיר מרכזי מחובר מבקש לכתוב את הערך של מאפיין שרשום בשרת GATT המקומי. אם לא תגיבו לבקשה הזו למשך זמן רב, היא עלולה לגרום לניתוק. האירוע הזה זמין רק אם לאפליקציה יש גם הרשאת Bluetooth:low_energy וגם הרשאות Bluetooth:ציוד היקפי מוגדרות כ-True. יכול להיות שהרשאת הציוד ההיקפי לא תהיה זמינה לכל האפליקציות.
פרמטרים
-
קריאה חוזרת (callback)
פונקציה
הפרמטר
callback
נראה כך:(request: Request, characteristicId: string) => void
-
בקשה
-
characteristicId
מחרוזת
-
onDescriptorReadRequest
chrome.bluetoothLowEnergy.onDescriptorReadRequest.addListener(
callback: function,
)
מופעל כשמכשיר מרכזי מחובר מבקש לקרוא את הערך של מתאר שרשום בשרת GATT המקומי. אם לא תגיבו לבקשה הזו למשך זמן רב, היא עלולה לגרום לניתוק. האירוע הזה זמין רק אם לאפליקציה יש גם הרשאת Bluetooth:low_energy וגם הרשאות Bluetooth:ציוד היקפי מוגדרות כ-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.bluetoothLowEnergy.onDescriptorWriteRequest.addListener(
callback: function,
)
מופעל כשמכשיר מרכזי מחובר מבקש לכתוב את הערך של מתאר שרשום בשרת GATT המקומי. אם לא תגיבו לבקשה הזו למשך זמן רב, היא עלולה לגרום לניתוק. האירוע הזה זמין רק אם לאפליקציה יש גם הרשאת Bluetooth:low_energy וגם הרשאות Bluetooth:ציוד היקפי מוגדרות כ-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 התגלה בעבר במכשיר מרוחק הוסר.