คำอธิบาย
chrome.bluetoothLowEnergy
API ใช้เพื่อสื่อสารกับอุปกรณ์บลูทูธสมาร์ท (พลังงานต่ำ) โดยใช้ Generic Attribute Profile (GATT)
ไฟล์ Manifest
ประเภท
Advertisement
พร็อพเพอร์ตี้
-
manufacturerData
ManufacturerData[] ไม่บังคับ
รายการข้อมูลที่เฉพาะเจาะจงของผู้ผลิตที่จะรวมไว้ในช่อง "ข้อมูลที่เฉพาะเจาะจงของผู้ผลิต" ของข้อมูลการโฆษณา
-
serviceData
ServiceData[] ไม่บังคับ
รายการข้อมูลบริการที่จะรวมไว้ในช่อง "ข้อมูลบริการ" ของข้อมูลการโฆษณา
-
serviceUuids
string[] ไม่บังคับ
รายการ UUID ที่จะรวมไว้ในช่อง "UUID ของบริการ" ของข้อมูลการโฆษณา UUID เหล่านี้อาจเป็นรูปแบบ 16 บิต 32 บิต หรือ 128 บิต
-
solicitUuids
string[] ไม่บังคับ
รายการ UUID ที่จะรวมไว้ในช่อง "ขอ UUID" ของข้อมูลการโฆษณา UUID เหล่านี้อาจเป็นรูปแบบ 16 บิต 32 บิต หรือ 128 บิต
-
ประเภท
ประเภทโฆษณา
AdvertisementType
ประเภทโฆษณา หากเลือก "broadcast" ประเภทโฆษณาที่ส่งจะเป็น ADV_NONCONN_IND และอุปกรณ์จะออกอากาศด้วยที่อยู่ MAC แบบสุ่ม หากตั้งค่าเป็น "อุปกรณ์ต่อพ่วง" ประเภทการโฆษณาจะเป็น ADV_IND หรือ ADV_SCAN_IND และอุปกรณ์จะกระจายสัญญาณด้วยที่อยู่ MAC ของอะแดปเตอร์บลูทูธจริง
ค่าแจกแจง
"broadcast"
"peripheral"
Characteristic
พร็อพเพอร์ตี้
-
instanceId
สตริง ไม่บังคับ
แสดงผลตัวระบุที่กำหนดให้กับลักษณะนี้ ใช้รหัสอินสแตนซ์เพื่อแยกแยะลักษณะจากอุปกรณ์ต่อพ่วงที่มี UUID เดียวกัน และเพื่อเรียกใช้ฟังก์ชันที่รับตัวระบุลักษณะ แสดง หากอินสแตนซ์นี้แสดงลักษณะระยะไกล
-
พร็อพเพอร์ตี้
พร็อพเพอร์ตี้ของลักษณะนี้
-
บริการ
บริการ ไม่บังคับ
บริการ GATT ที่ลักษณะนี้อยู่
-
uuid
สตริง
UUID ของลักษณะ เช่น 00002a37-0000-1000-8000-00805f9b34fb
-
value
ArrayBuffer ไม่บังคับ
ค่าลักษณะที่แคชไว้ในปัจจุบัน ค่านี้จะอัปเดตเมื่ออ่านหรืออัปเดตค่าของลักษณะผ่านการแจ้งเตือนหรือตัวบ่งชี้
CharacteristicProperty
ค่าที่แสดงถึงคุณสมบัติที่เป็นไปได้ของลักษณะ ระบบจะอนุมานสิทธิ์ของลักษณะจากพร็อพเพอร์ตี้เหล่านี้ โปรดดูความหมายของพร็อพเพอร์ตี้แต่ละรายการในข้อกำหนด Bluetooth 4.x
ค่าแจกแจง
"broadcast"
"read"
"writeWithoutResponse"
"write"
"notify"
"indicate"
"authenticatedSignedWrites"
"extendedProperties"
"reliableWrite"
"writableAuxiliaries"
"encryptRead"
"encryptWrite"
"encryptAuthenticatedRead"
"encryptAuthenticatedWrite"
ConnectProperties
พร็อพเพอร์ตี้
-
ถาวร
บูลีน
แฟล็กที่ระบุว่าการเชื่อมต่อกับอุปกรณ์จะเปิดอยู่หรือไม่เมื่อระบบยกเลิกการโหลดหน้าเหตุการณ์ของแอปพลิเคชัน (ดูจัดการวงจรของแอป) ค่าเริ่มต้นคือ
false.
Descriptor
พร็อพเพอร์ตี้
-
ลักษณะ
ลักษณะ ไม่บังคับ
ลักษณะ GATT ที่ตัวบ่งชี้นี้อยู่
-
instanceId
สตริง ไม่บังคับ
แสดงตัวระบุที่กำหนดให้กับข้อบ่งชี้นี้ ใช้รหัสอินสแตนซ์เพื่อแยกความแตกต่างระหว่างตัวระบุจากอุปกรณ์ต่อพ่วงที่มี UUID เดียวกัน และเพื่อเรียกใช้ฟังก์ชันที่รับตัวระบุตัวระบุ แสดง หากอินสแตนซ์นี้แสดงลักษณะระยะไกล
-
สิทธิ์Chrome 52 ขึ้นไป
สิทธิ์ของข้อบ่งชี้นี้
-
uuid
สตริง
UUID ของตัวบ่งชี้ลักษณะ เช่น 00002902-0000-1000-8000-00805f9b34fb
-
value
ArrayBuffer ไม่บังคับ
ค่าตัวระบุที่แคชไว้ในปัจจุบัน ค่านี้จะอัปเดตเมื่ออ่านค่าของข้อบ่งชี้
DescriptorPermission
ค่าที่แสดงถึงสิทธิ์ที่เป็นไปได้สำหรับข้อบ่งชี้ โปรดดูความหมายของสิทธิ์แต่ละรายการในข้อกำหนดของบลูทูธ 4.x
ค่าแจกแจง
"read"
"write"
"encryptedRead"
"encryptedWrite"
"encryptedAuthenticatedRead"
"encryptedAuthenticatedWrite"
Device
พร็อพเพอร์ตี้
-
ที่อยู่
สตริง
ที่อยู่ของอุปกรณ์ในรูปแบบ "XX:XX:XX:XX:XX:XX"
-
deviceClass
ตัวเลข ไม่บังคับ
คลาสของอุปกรณ์ ซึ่งเป็นฟิลด์บิตที่กําหนดโดย http://www.bluetooth.org/en-us/specification/assigned-numbers/baseband
-
ชื่อ
สตริง ไม่บังคับ
ชื่อที่มนุษย์อ่านได้ของอุปกรณ์
ManufacturerData
พร็อพเพอร์ตี้
-
ข้อมูล
number[]
-
id
ตัวเลข
Notification
พร็อพเพอร์ตี้
-
shouldIndicate
บูลีน ไม่บังคับ
แฟล็กที่ไม่บังคับสำหรับการส่งการบ่งชี้แทนการแจ้งเตือน
-
value
ArrayBuffer
ค่าใหม่ของลักษณะ
NotificationProperties
พร็อพเพอร์ตี้
-
ถาวร
บูลีน
แฟล็กที่ระบุว่าแอปควรได้รับการแจ้งเตือนเมื่อระบบยกเลิกการโหลดหน้ากิจกรรมของแอปพลิเคชันหรือไม่ (ดูจัดการวงจรของแอป) ค่าเริ่มต้นคือ
false
Request
พร็อพเพอร์ตี้
-
อุปกรณ์
อุปกรณ์ที่ส่งคําขอนี้
-
requestId
ตัวเลข
รหัสที่ไม่ซ้ำกันสำหรับคำขอนี้ ใช้รหัสนี้เมื่อตอบกลับคำขอนี้
-
value
ArrayBuffer ไม่บังคับ
ค่าที่จะเขียน (หากเป็นคําขอเขียน)
Response
พร็อพเพอร์ตี้
-
isError
บูลีน
หากเป็นคำตอบที่แสดงข้อผิดพลาด ค่านี้ควรเป็น "จริง"
-
requestId
ตัวเลข
รหัสของคำขอที่การตอบกลับนี้อ้างอิงถึง
-
value
ArrayBuffer ไม่บังคับ
ค่าการตอบกลับ คำขอเขียนและการตอบกลับข้อผิดพลาดจะไม่สนใจพารามิเตอร์นี้
Service
พร็อพเพอร์ตี้
-
deviceAddress
สตริง ไม่บังคับ
ที่อยู่อุปกรณ์ของอุปกรณ์ต่อพ่วงระยะไกลที่เป็นของบริการ GATT แสดงอยู่ หากอินสแตนซ์นี้แสดงบริการระยะไกล
-
instanceId
สตริง ไม่บังคับ
แสดงผลตัวระบุที่กำหนดให้กับบริการนี้ ใช้รหัสอินสแตนซ์เพื่อแยกความแตกต่างระหว่างบริการจากอุปกรณ์ต่อพ่วงที่มี UUID เดียวกัน และเพื่อทำการเรียกฟังก์ชันที่รับตัวระบุบริการ แสดงอยู่ หากอินสแตนซ์นี้แสดงบริการระยะไกล
-
isPrimary
บูลีน
ระบุว่าประเภทของบริการนี้เป็นบริการหลักหรือรอง
-
uuid
สตริง
UUID ของบริการ เช่น 0000180d-0000-1000-8000-00805f9b34fb
ServiceData
พร็อพเพอร์ตี้
-
ข้อมูล
number[]
-
uuid
สตริง
เมธอด
connect()
chrome.bluetoothLowEnergy.connect(
deviceAddress: string,
properties?: ConnectProperties,
callback?: function,
)
สร้างการเชื่อมต่อระหว่างแอปพลิเคชันกับอุปกรณ์ด้วยที่อยู่ที่กำหนด อุปกรณ์อาจเชื่อมต่ออยู่แล้วและบริการ GATT ของอุปกรณ์พร้อมใช้งานโดยไม่ต้องเรียกใช้ connect
แต่แอปที่ต้องการเข้าถึงบริการ GATT ของอุปกรณ์ควรเรียกใช้ฟังก์ชันนี้เพื่อให้การเชื่อมต่อกับอุปกรณ์ยังคงอยู่ หากอุปกรณ์ไม่ได้เชื่อมต่อ ระบบจะค้นหาบริการ GATT ทั้งหมดของอุปกรณ์หลังจากเรียกใช้ connect
สำเร็จ
พารามิเตอร์
-
deviceAddress
สตริง
ที่อยู่บลูทูธของอุปกรณ์ระยะไกลที่ควรเปิดการเชื่อมต่อ GATT
-
พร็อพเพอร์ตี้
ConnectProperties ไม่บังคับ
พร็อพเพอร์ตี้การเชื่อมต่อ (ไม่บังคับ)
-
Callback
ฟังก์ชัน ไม่บังคับ
พารามิเตอร์
callback
จะมีลักษณะดังนี้() => void
การคืนสินค้า
-
Promise<void>
Chrome 91 ขึ้นไประบบรองรับ Promises สำหรับไฟล์ Manifest V3 ขึ้นไปเท่านั้น ส่วนแพลตฟอร์มอื่นๆ ต้องใช้การเรียกกลับ
createCharacteristic()
chrome.bluetoothLowEnergy.createCharacteristic(
characteristic: Characteristic,
serviceId: string,
callback?: function,
)
สร้างแอตทริบิวต์ GATT ที่โฮสต์ในเครื่อง ลักษณะนี้ต้องโฮสต์ภายใต้บริการที่ถูกต้อง หากรหัสบริการไม่ถูกต้อง ระบบจะตั้งค่า lastError ฟังก์ชันนี้จะใช้งานได้ก็ต่อเมื่อแอปตั้งค่าทั้งสิทธิ์ bluetooth:low_energy และ bluetooth:peripheral เป็น "จริง" สิทธิ์อุปกรณ์ต่อพ่วงอาจไม่พร้อมใช้งานสำหรับบางแอป
พารามิเตอร์
-
ลักษณะ
ลักษณะที่จะสร้าง
-
serviceId
สตริง
รหัสของบริการที่จะสร้างลักษณะนี้
-
Callback
ฟังก์ชัน ไม่บังคับ
พารามิเตอร์
callback
จะมีลักษณะดังนี้(characteristicId: string) => void
-
characteristicId
สตริง
-
การคืนสินค้า
-
Promise<string>
Chrome 91 ขึ้นไประบบรองรับ Promises สำหรับไฟล์ Manifest V3 ขึ้นไปเท่านั้น ส่วนแพลตฟอร์มอื่นๆ ต้องใช้การเรียกกลับ
createDescriptor()
chrome.bluetoothLowEnergy.createDescriptor(
descriptor: Descriptor,
characteristicId: string,
callback?: function,
)
สร้างตัวบ่งชี้ GATT ที่โฮสต์ในเครื่อง เครื่องมืออธิบายนี้ต้องโฮสต์ภายใต้ลักษณะที่ถูกต้อง หากรหัสลักษณะไม่ถูกต้อง ระบบจะตั้งค่า lastError ฟังก์ชันนี้จะใช้งานได้ก็ต่อเมื่อแอปตั้งค่าทั้งสิทธิ์ bluetooth:low_energy และ bluetooth:peripheral เป็น "จริง" สิทธิ์อุปกรณ์ต่อพ่วงอาจไม่พร้อมใช้งานสำหรับบางแอป
พารามิเตอร์
-
ข้อบ่งชี้
ตัวระบุที่จะสร้าง
-
characteristicId
สตริง
รหัสของลักษณะที่จะสร้างตัวบ่งชี้นี้
-
Callback
ฟังก์ชัน ไม่บังคับ
พารามิเตอร์
callback
จะมีลักษณะดังนี้(descriptorId: string) => void
-
descriptorId
สตริง
-
การคืนสินค้า
-
Promise<string>
Chrome 91 ขึ้นไประบบรองรับ Promises สำหรับไฟล์ Manifest V3 ขึ้นไปเท่านั้น ส่วนแพลตฟอร์มอื่นๆ ต้องใช้การเรียกกลับ
createService()
chrome.bluetoothLowEnergy.createService(
service: Service,
callback?: function,
)
สร้างบริการ GATT ที่โฮสต์ในเครื่อง บริการนี้สามารถลงทะเบียนให้พร้อมใช้งานบนเซิร์ฟเวอร์ GATT ในพื้นที่ได้ ฟังก์ชันนี้จะใช้งานได้ก็ต่อเมื่อแอปตั้งค่าทั้งสิทธิ์ bluetooth:low_energy และ bluetooth:peripheral เป็น "จริง" สิทธิ์อุปกรณ์ต่อพ่วงอาจไม่พร้อมใช้งานสำหรับบางแอป
พารามิเตอร์
-
บริการ
บริการที่จะสร้าง
-
Callback
ฟังก์ชัน ไม่บังคับ
พารามิเตอร์
callback
จะมีลักษณะดังนี้(serviceId: string) => void
-
serviceId
สตริง
-
การคืนสินค้า
-
Promise<string>
Chrome 91 ขึ้นไประบบรองรับ Promises สำหรับไฟล์ Manifest V3 ขึ้นไปเท่านั้น ส่วนแพลตฟอร์มอื่นๆ ต้องใช้การเรียกกลับ
disconnect()
chrome.bluetoothLowEnergy.disconnect(
deviceAddress: string,
callback?: function,
)
ปิดการเชื่อมต่อของแอปกับอุปกรณ์ด้วยที่อยู่ที่กำหนด โปรดทราบว่าการดำเนินการนี้ไม่ได้ทำลายลิงก์จริงเสมอไป เนื่องจากอาจมีแอปอื่นๆ ที่มีการเชื่อมต่อที่เปิดอยู่
พารามิเตอร์
-
deviceAddress
สตริง
ที่อยู่บลูทูธของอุปกรณ์ระยะไกล
-
Callback
ฟังก์ชัน ไม่บังคับ
พารามิเตอร์
callback
จะมีลักษณะดังนี้() => void
การคืนสินค้า
-
Promise<void>
Chrome 91 ขึ้นไประบบรองรับ Promises สำหรับไฟล์ Manifest V3 ขึ้นไปเท่านั้น ส่วนแพลตฟอร์มอื่นๆ ต้องใช้การเรียกกลับ
getCharacteristic()
chrome.bluetoothLowEnergy.getCharacteristic(
characteristicId: string,
callback?: function,
)
รับแอตทริบิวต์ GATT ที่มีรหัสอินสแตนซ์ที่ระบุซึ่งเป็นของบริการ GATT ที่ระบุ หากมีแอตทริบิวต์ดังกล่าว
พารามิเตอร์
-
characteristicId
สตริง
รหัสอินสแตนซ์ของลักษณะ GATT ที่ขอ
-
Callback
ฟังก์ชัน ไม่บังคับ
พารามิเตอร์
callback
จะมีลักษณะดังนี้(result: Characteristic) => void
-
ผลลัพธ์
-
การคืนสินค้า
-
Promise<Characteristic>
Chrome 91 ขึ้นไประบบรองรับ Promises สำหรับไฟล์ Manifest V3 ขึ้นไปเท่านั้น ส่วนแพลตฟอร์มอื่นๆ ต้องใช้การเรียกกลับ
getCharacteristics()
chrome.bluetoothLowEnergy.getCharacteristics(
serviceId: string,
callback?: function,
)
รับรายการลักษณะ GATT ที่ค้นพบทั้งหมดซึ่งอยู่ในบริการที่ระบุ
พารามิเตอร์
-
serviceId
สตริง
รหัสอินสแตนซ์ของบริการ GATT ที่ควรแสดงลักษณะ
-
Callback
ฟังก์ชัน ไม่บังคับ
พารามิเตอร์
callback
จะมีลักษณะดังนี้(result: Characteristic[]) => void
-
ผลลัพธ์
-
การคืนสินค้า
-
Promise<Characteristic[]>
Chrome 91 ขึ้นไประบบรองรับ Promises สำหรับไฟล์ Manifest V3 ขึ้นไปเท่านั้น ส่วนแพลตฟอร์มอื่นๆ ต้องใช้การเรียกกลับ
getDescriptor()
chrome.bluetoothLowEnergy.getDescriptor(
descriptorId: string,
callback?: function,
)
รับตัวบ่งชี้ลักษณะ GATT ที่มีรหัสอินสแตนซ์ที่ระบุ
พารามิเตอร์
-
descriptorId
สตริง
รหัสอินสแตนซ์ของตัวบ่งชี้ลักษณะ GATT ที่ขอ
-
Callback
ฟังก์ชัน ไม่บังคับ
พารามิเตอร์
callback
จะมีลักษณะดังนี้(result: Descriptor) => void
-
ผลลัพธ์
-
การคืนสินค้า
-
Promise<Descriptor>
Chrome 91 ขึ้นไประบบรองรับ Promises สำหรับไฟล์ Manifest V3 ขึ้นไปเท่านั้น ส่วนแพลตฟอร์มอื่นๆ ต้องใช้การเรียกกลับ
getDescriptors()
chrome.bluetoothLowEnergy.getDescriptors(
characteristicId: string,
callback?: function,
)
รับรายการตัวบ่งชี้ลักษณะ GATT ของลักษณะหนึ่งๆ
พารามิเตอร์
-
characteristicId
สตริง
รหัสอินสแตนซ์ของลักษณะ GATT ที่ควรแสดงผลตัวบ่งชี้
-
Callback
ฟังก์ชัน ไม่บังคับ
พารามิเตอร์
callback
จะมีลักษณะดังนี้(result: Descriptor[]) => void
-
ผลลัพธ์
-
การคืนสินค้า
-
Promise<Descriptor[]>
Chrome 91 ขึ้นไประบบรองรับ Promises สำหรับไฟล์ Manifest V3 ขึ้นไปเท่านั้น ส่วนแพลตฟอร์มอื่นๆ ต้องใช้การเรียกกลับ
getIncludedServices()
chrome.bluetoothLowEnergy.getIncludedServices(
serviceId: string,
callback?: function,
)
ดูรายการบริการ GATT ที่รวมอยู่ในบริการที่ระบุ
พารามิเตอร์
การคืนสินค้า
-
Promise<Service[]>
Chrome 91 ขึ้นไประบบรองรับ Promises สำหรับไฟล์ Manifest V3 ขึ้นไปเท่านั้น ส่วนแพลตฟอร์มอื่นๆ ต้องใช้การเรียกกลับ
getService()
chrome.bluetoothLowEnergy.getService(
serviceId: string,
callback?: function,
)
รับบริการ GATT ด้วยรหัสอินสแตนซ์ที่ระบุ
พารามิเตอร์
-
serviceId
สตริง
รหัสอินสแตนซ์ของบริการ GATT ที่ขอ
-
Callback
ฟังก์ชัน ไม่บังคับ
พารามิเตอร์
callback
จะมีลักษณะดังนี้(result: Service) => void
-
ผลลัพธ์
-
การคืนสินค้า
-
Promise<Service>
Chrome 91 ขึ้นไประบบรองรับ Promises สำหรับไฟล์ Manifest V3 ขึ้นไปเท่านั้น ส่วนแพลตฟอร์มอื่นๆ ต้องใช้การเรียกกลับ
getServices()
chrome.bluetoothLowEnergy.getServices(
deviceAddress: string,
callback?: function,
)
รับบริการ GATT ทั้งหมดที่ค้นพบในอุปกรณ์ระยะไกลด้วยที่อยู่อุปกรณ์ที่ระบุ
หมายเหตุ: หากการค้นหาบริการในอุปกรณ์ยังไม่เสร็จสมบูรณ์ API นี้จะแสดงผลบริการย่อย (อาจว่างเปล่า) วิธีแก้ปัญหาคือเพิ่มการหน่วงเวลาตามเวลาและ/หรือเรียกซ้ำจนกว่าระบบจะแสดงบริการตามจำนวนที่ต้องการ
พารามิเตอร์
การคืนสินค้า
-
Promise<Service[]>
Chrome 91 ขึ้นไประบบรองรับ Promises สำหรับไฟล์ Manifest V3 ขึ้นไปเท่านั้น ส่วนแพลตฟอร์มอื่นๆ ต้องใช้การเรียกกลับ
notifyCharacteristicValueChanged()
chrome.bluetoothLowEnergy.notifyCharacteristicValueChanged(
characteristicId: string,
notification: Notification,
callback?: function,
)
แจ้งค่าใหม่สำหรับลักษณะไปยังอุปกรณ์ระยะไกล หาก Flag shouldIndicate ในออบเจ็กต์การแจ้งเตือนเป็น "จริง" ระบบจะส่งการบ่งชี้แทนการแจ้งเตือน โปรดทราบว่าแอตทริบิวต์ต้องตั้งค่าพร็อพเพอร์ตี้ "notify" หรือ "indicate" อย่างถูกต้องในระหว่างการสร้างเพื่อให้การเรียกใช้นี้สําเร็จ ฟังก์ชันนี้จะใช้งานได้ก็ต่อเมื่อแอปตั้งค่าทั้งสิทธิ์ bluetooth:low_energy และ bluetooth:peripheral เป็น "จริง" สิทธิ์อุปกรณ์ต่อพ่วงอาจไม่พร้อมใช้งานสำหรับบางแอป
พารามิเตอร์
-
characteristicId
สตริง
ลักษณะที่จะส่งการแจ้งเตือน
-
การแจ้งเตือน
-
Callback
ฟังก์ชัน ไม่บังคับ
พารามิเตอร์
callback
จะมีลักษณะดังนี้() => void
การคืนสินค้า
-
Promise<void>
Chrome 91 ขึ้นไประบบรองรับ Promises สำหรับไฟล์ Manifest V3 ขึ้นไปเท่านั้น ส่วนแพลตฟอร์มอื่นๆ ต้องใช้การเรียกกลับ
readCharacteristicValue()
chrome.bluetoothLowEnergy.readCharacteristicValue(
characteristicId: string,
callback?: function,
)
เรียกค่าของลักษณะที่ระบุจากอุปกรณ์ต่อพ่วงระยะไกล
พารามิเตอร์
-
characteristicId
สตริง
รหัสอินสแตนซ์ของลักษณะ GATT ที่ควรอ่านค่าจากอุปกรณ์ระยะไกล
-
Callback
ฟังก์ชัน ไม่บังคับ
พารามิเตอร์
callback
จะมีลักษณะดังนี้(result: Characteristic) => void
-
ผลลัพธ์
-
การคืนสินค้า
-
Promise<Characteristic>
Chrome 91 ขึ้นไประบบรองรับ Promises สำหรับไฟล์ Manifest V3 ขึ้นไปเท่านั้น ส่วนแพลตฟอร์มอื่นๆ ต้องใช้การเรียกกลับ
readDescriptorValue()
chrome.bluetoothLowEnergy.readDescriptorValue(
descriptorId: string,
callback?: function,
)
ดึงค่าของข้อบ่งชี้ลักษณะที่ระบุจากอุปกรณ์ต่อพ่วงระยะไกล
พารามิเตอร์
-
descriptorId
สตริง
รหัสอินสแตนซ์ของตัวบ่งชี้ลักษณะ GATT ที่ควรอ่านค่าจากอุปกรณ์ระยะไกล
-
Callback
ฟังก์ชัน ไม่บังคับ
พารามิเตอร์
callback
จะมีลักษณะดังนี้(result: Descriptor) => void
-
ผลลัพธ์
-
การคืนสินค้า
-
Promise<Descriptor>
Chrome 91 ขึ้นไประบบรองรับ Promises สำหรับไฟล์ Manifest V3 ขึ้นไปเท่านั้น ส่วนแพลตฟอร์มอื่นๆ ต้องใช้การเรียกกลับ
registerAdvertisement()
chrome.bluetoothLowEnergy.registerAdvertisement(
advertisement: Advertisement,
callback?: function,
)
สร้างโฆษณาและลงทะเบียนเพื่อลงโฆษณา หากต้องการเรียกใช้ฟังก์ชันนี้ แอปต้องตั้งค่าสิทธิ์ bluetooth:low_energy และ bluetooth:peripheral เป็น "จริง" นอกจากนี้ API นี้ใช้ได้กับแอปที่เปิดโดยอัตโนมัติในโหมดคีออสก์เท่านั้น หรือตั้งค่าสวิตช์บรรทัดคำสั่ง "--enable-ble-advertising-in-apps" ดูที่ https://developer.chrome.com/apps/manifest/bluetooth หมายเหตุ: ฮาร์ดแวร์บางรุ่นรองรับโหมดกลางและอุปกรณ์ต่อพ่วงพร้อมกัน แต่ฮาร์ดแวร์ที่ไม่รองรับการเรียกใช้นี้จะเปลี่ยนอุปกรณ์เป็นโหมดอุปกรณ์ต่อพ่วง ในกรณีที่ฮาร์ดแวร์ไม่รองรับทั้งโหมดอุปกรณ์หลักและอุปกรณ์ต่อพ่วง การพยายามใช้อุปกรณ์ในทั้ง 2 โหมดจะทําให้อุปกรณ์ทํางานอย่างไม่ถูกต้องหรือทําให้แอปพลิเคชันอื่นๆ ที่มีบทบาทหลักทํางานไม่ถูกต้อง (รวมถึงการค้นหาอุปกรณ์บลูทูธพลังงานต่ำ)
พารามิเตอร์
-
โฆษณา
โฆษณาที่จะแสดง
-
Callback
ฟังก์ชัน ไม่บังคับ
พารามิเตอร์
callback
จะมีลักษณะดังนี้(advertisementId: number) => void
-
advertisementId
ตัวเลข
-
การคืนสินค้า
-
Promise<number>
Chrome 91 ขึ้นไประบบรองรับ Promises สำหรับไฟล์ Manifest V3 ขึ้นไปเท่านั้น ส่วนแพลตฟอร์มอื่นๆ ต้องใช้การเรียกกลับ
registerService()
chrome.bluetoothLowEnergy.registerService(
serviceId: string,
callback?: function,
)
ลงทะเบียนบริการที่ระบุกับเซิร์ฟเวอร์ GATT ในพื้นที่ หากรหัสบริการไม่ถูกต้อง ระบบจะตั้งค่า lastError ฟังก์ชันนี้จะใช้งานได้ก็ต่อเมื่อแอปตั้งค่าทั้งสิทธิ์ bluetooth:low_energy และ bluetooth:peripheral เป็น "จริง" สิทธิ์อุปกรณ์ต่อพ่วงอาจไม่พร้อมใช้งานสำหรับบางแอป
พารามิเตอร์
-
serviceId
สตริง
รหัสที่ไม่ซ้ำกันของบริการที่สร้าง
-
Callback
ฟังก์ชัน ไม่บังคับ
พารามิเตอร์
callback
จะมีลักษณะดังนี้() => void
การคืนสินค้า
-
Promise<void>
Chrome 91 ขึ้นไประบบรองรับ Promises สำหรับไฟล์ Manifest V3 ขึ้นไปเท่านั้น ส่วนแพลตฟอร์มอื่นๆ ต้องใช้การเรียกกลับ
removeService()
chrome.bluetoothLowEnergy.removeService(
serviceId: string,
callback?: function,
)
นำบริการที่ระบุออกและยกเลิกการลงทะเบียนหากมีการลงทะเบียน หากรหัสบริการไม่ถูกต้อง ระบบจะตั้งค่า lastError ฟังก์ชันนี้จะใช้งานได้ก็ต่อเมื่อแอปตั้งค่าทั้งสิทธิ์ bluetooth:low_energy และ bluetooth:peripheral เป็น "จริง" สิทธิ์อุปกรณ์ต่อพ่วงอาจไม่พร้อมใช้งานสำหรับบางแอป
พารามิเตอร์
-
serviceId
สตริง
รหัสที่ไม่ซ้ำกันของบริการที่ลงทะเบียนในปัจจุบัน
-
Callback
ฟังก์ชัน ไม่บังคับ
พารามิเตอร์
callback
จะมีลักษณะดังนี้() => void
การคืนสินค้า
-
Promise<void>
Chrome 91 ขึ้นไประบบรองรับ Promises สำหรับไฟล์ Manifest V3 ขึ้นไปเท่านั้น ส่วนแพลตฟอร์มอื่นๆ ต้องใช้การเรียกกลับ
resetAdvertising()
chrome.bluetoothLowEnergy.resetAdvertising(
callback?: function,
)
รีเซ็ตการโฆษณาในอุปกรณ์ปัจจุบัน ซึ่งจะยกเลิกการลงทะเบียนและหยุดโฆษณาที่มีอยู่ทั้งหมด
พารามิเตอร์
-
Callback
ฟังก์ชัน ไม่บังคับ
พารามิเตอร์
callback
จะมีลักษณะดังนี้() => void
การคืนสินค้า
-
Promise<void>
Chrome 91 ขึ้นไประบบรองรับ Promises สำหรับไฟล์ Manifest V3 ขึ้นไปเท่านั้น ส่วนแพลตฟอร์มอื่นๆ ต้องใช้การเรียกกลับ
sendRequestResponse()
chrome.bluetoothLowEnergy.sendRequestResponse(
response: Response,
)
ส่งการตอบกลับสําหรับคําขออ่าน/เขียนลักษณะหรือข้อบ่งชี้ ฟังก์ชันนี้จะใช้งานได้ก็ต่อเมื่อแอปตั้งค่าทั้งสิทธิ์ bluetooth:low_energy และ bluetooth:peripheral เป็น "จริง" สิทธิ์อุปกรณ์ต่อพ่วงอาจไม่พร้อมใช้งานสำหรับบางแอป
พารามิเตอร์
-
การตอบกลับ
การตอบกลับคำขอ
setAdvertisingInterval()
chrome.bluetoothLowEnergy.setAdvertisingInterval(
minInterval: number,
maxInterval: number,
callback?: function,
)
ตั้งค่าเป็นช่วงเวลาระหว่างโฆษณา 2 รายการติดต่อกัน หมายเหตุ: เราพยายามดำเนินการอย่างเต็มความสามารถ ช่วงเวลาจริงอาจแตกต่างจากช่วงเวลาที่ขอ ในฮาร์ดแวร์บางรุ่น ช่วงเวลาขั้นต่ำคือ 100 มิลลิวินาที ค่าต่ำสุดและสูงสุดต้องไม่เกินช่วงที่ข้อกำหนด Bluetooth 4.2 อนุญาต
พารามิเตอร์
-
minInterval
ตัวเลข
ช่วงเวลาขั้นต่ำระหว่างโฆษณา (เป็นมิลลิวินาที) ซึ่งต้องไม่ต่ำกว่า 20 มิลลิวินาที (ตามข้อมูลจำเพาะ)
-
maxInterval
ตัวเลข
ช่วงเวลาสูงสุดระหว่างโฆษณา (เป็นมิลลิวินาที) ซึ่งต้องไม่เกิน 10240 มิลลิวินาที (ตามข้อมูลจำเพาะ)
-
Callback
ฟังก์ชัน ไม่บังคับ
พารามิเตอร์
callback
จะมีลักษณะดังนี้() => void
การคืนสินค้า
-
Promise<void>
Chrome 91 ขึ้นไประบบรองรับ Promises สำหรับไฟล์ Manifest V3 ขึ้นไปเท่านั้น ส่วนแพลตฟอร์มอื่นๆ ต้องใช้การเรียกกลับ
startCharacteristicNotifications()
chrome.bluetoothLowEnergy.startCharacteristicNotifications(
characteristicId: string,
properties?: NotificationProperties,
callback?: function,
)
เปิดใช้การแจ้งเตือน/การบ่งชี้ค่าจากลักษณะที่ระบุ เมื่อเปิดใช้แล้ว แอปพลิเคชันจะฟังการแจ้งเตือนได้โดยใช้เหตุการณ์ onCharacteristicValueChanged
พารามิเตอร์
-
characteristicId
สตริง
รหัสอินสแตนซ์ของแอตทริบิวต์ GATT ที่ควรเปิดใช้การแจ้งเตือน
-
พร็อพเพอร์ตี้
NotificationProperties ไม่บังคับ
พร็อพเพอร์ตี้เซสชันการแจ้งเตือน (ไม่บังคับ)
-
Callback
ฟังก์ชัน ไม่บังคับ
พารามิเตอร์
callback
จะมีลักษณะดังนี้() => void
การคืนสินค้า
-
Promise<void>
Chrome 91 ขึ้นไประบบรองรับ Promises สำหรับไฟล์ Manifest V3 ขึ้นไปเท่านั้น ส่วนแพลตฟอร์มอื่นๆ ต้องใช้การเรียกกลับ
stopCharacteristicNotifications()
chrome.bluetoothLowEnergy.stopCharacteristicNotifications(
characteristicId: string,
callback?: function,
)
ปิดใช้การแจ้งเตือน/การบ่งชี้ค่าจากลักษณะที่ระบุ หลังจากเรียกใช้เสร็จแล้ว แอปพลิเคชันจะหยุดได้รับการแจ้งเตือน/บ่งชี้จากลักษณะนี้
พารามิเตอร์
-
characteristicId
สตริง
รหัสอินสแตนซ์ของลักษณะ GATT ที่ควรหยุดเซสชันการแจ้งเตือนของแอปนี้
-
Callback
ฟังก์ชัน ไม่บังคับ
พารามิเตอร์
callback
จะมีลักษณะดังนี้() => void
การคืนสินค้า
-
Promise<void>
Chrome 91 ขึ้นไประบบรองรับ Promises สำหรับไฟล์ Manifest V3 ขึ้นไปเท่านั้น ส่วนแพลตฟอร์มอื่นๆ ต้องใช้การเรียกกลับ
unregisterAdvertisement()
chrome.bluetoothLowEnergy.unregisterAdvertisement(
advertisementId: number,
callback?: function,
)
ยกเลิกการลงทะเบียนโฆษณาและหยุดการโฆษณา หากโฆษณาลงทะเบียนไม่สำเร็จ วิธีเดียวที่จะหยุดโฆษณาได้อาจเป็นการรีสตาร์ทอุปกรณ์
พารามิเตอร์
-
advertisementId
ตัวเลข
รหัสของโฆษณาที่จะยกเลิกการลงทะเบียน
-
Callback
ฟังก์ชัน ไม่บังคับ
พารามิเตอร์
callback
จะมีลักษณะดังนี้() => void
การคืนสินค้า
-
Promise<void>
Chrome 91 ขึ้นไประบบรองรับ Promises สำหรับไฟล์ Manifest V3 ขึ้นไปเท่านั้น ส่วนแพลตฟอร์มอื่นๆ ต้องใช้การเรียกกลับ
unregisterService()
chrome.bluetoothLowEnergy.unregisterService(
serviceId: string,
callback?: function,
)
ยกเลิกการลงทะเบียนบริการที่ระบุกับเซิร์ฟเวอร์ GATT ในพื้นที่ หากรหัสบริการไม่ถูกต้อง ระบบจะตั้งค่า lastError ฟังก์ชันนี้จะใช้งานได้ก็ต่อเมื่อแอปตั้งค่าทั้งสิทธิ์ bluetooth:low_energy และ bluetooth:peripheral เป็น "จริง" สิทธิ์อุปกรณ์ต่อพ่วงอาจไม่พร้อมใช้งานสำหรับบางแอป
พารามิเตอร์
-
serviceId
สตริง
รหัสที่ไม่ซ้ำกันของบริการที่ลงทะเบียนในปัจจุบัน
-
Callback
ฟังก์ชัน ไม่บังคับ
พารามิเตอร์
callback
จะมีลักษณะดังนี้() => void
การคืนสินค้า
-
Promise<void>
Chrome 91 ขึ้นไประบบรองรับ Promises สำหรับไฟล์ Manifest V3 ขึ้นไปเท่านั้น ส่วนแพลตฟอร์มอื่นๆ ต้องใช้การเรียกกลับ
writeCharacteristicValue()
chrome.bluetoothLowEnergy.writeCharacteristicValue(
characteristicId: string,
value: ArrayBuffer,
callback?: function,
)
เขียนค่าของลักษณะที่ระบุจากอุปกรณ์ต่อพ่วงระยะไกล
พารามิเตอร์
-
characteristicId
สตริง
รหัสอินสแตนซ์ของลักษณะ GATT ที่ควรเขียนค่า
-
value
ArrayBuffer
ค่าที่ควรส่งไปยังลักษณะระยะไกลเป็นส่วนหนึ่งของคำขอเขียน
-
Callback
ฟังก์ชัน ไม่บังคับ
พารามิเตอร์
callback
จะมีลักษณะดังนี้() => void
การคืนสินค้า
-
Promise<void>
Chrome 91 ขึ้นไประบบรองรับ Promises สำหรับไฟล์ Manifest V3 ขึ้นไปเท่านั้น ส่วนแพลตฟอร์มอื่นๆ ต้องใช้การเรียกกลับ
writeDescriptorValue()
chrome.bluetoothLowEnergy.writeDescriptorValue(
descriptorId: string,
value: ArrayBuffer,
callback?: function,
)
เขียนค่าของข้อบ่งชี้ลักษณะที่ระบุจากอุปกรณ์ต่อพ่วงระยะไกล
พารามิเตอร์
-
descriptorId
สตริง
รหัสอินสแตนซ์ของตัวบ่งชี้ลักษณะ GATT ที่ควรเขียนค่า
-
value
ArrayBuffer
ค่าที่ควรส่งไปยังตัวระบุระยะไกลเป็นส่วนหนึ่งของคำขอเขียน
-
Callback
ฟังก์ชัน ไม่บังคับ
พารามิเตอร์
callback
จะมีลักษณะดังนี้() => void
การคืนสินค้า
-
Promise<void>
Chrome 91 ขึ้นไประบบรองรับ Promises สำหรับไฟล์ Manifest V3 ขึ้นไปเท่านั้น ส่วนแพลตฟอร์มอื่นๆ ต้องใช้การเรียกกลับ
กิจกรรม
onCharacteristicReadRequest
chrome.bluetoothLowEnergy.onCharacteristicReadRequest.addListener(
callback: function,
)
เรียกใช้เมื่ออุปกรณ์ส่วนกลางที่เชื่อมต่ออยู่ส่งคําขออ่านค่าของลักษณะที่ลงทะเบียนไว้ในเซิร์ฟเวอร์ GATT ในพื้นที่ การไม่ตอบกลับคําขอนี้เป็นเวลานานอาจทําให้การเชื่อมต่อถูกตัด เหตุการณ์นี้จะพร้อมใช้งานก็ต่อเมื่อแอปตั้งค่าทั้ง 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.bluetoothLowEnergy.onCharacteristicWriteRequest.addListener(
callback: function,
)
เรียกใช้เมื่ออุปกรณ์ส่วนกลางที่เชื่อมต่ออยู่ส่งคำขอเขียนค่าของลักษณะที่ลงทะเบียนไว้ในเซิร์ฟเวอร์ GATT ในพื้นที่ การไม่ตอบกลับคําขอนี้เป็นเวลานานอาจทําให้การเชื่อมต่อถูกตัด เหตุการณ์นี้จะพร้อมใช้งานก็ต่อเมื่อแอปตั้งค่าทั้ง bluetooth:low_energy และ bluetooth:peripheral เป็น "จริง" สิทธิ์อุปกรณ์ต่อพ่วงอาจไม่พร้อมใช้งานสำหรับบางแอป
พารามิเตอร์
-
Callback
ฟังก์ชัน
พารามิเตอร์
callback
จะมีลักษณะดังนี้(request: Request, characteristicId: string) => void
-
ส่งคำขอ
-
characteristicId
สตริง
-
onDescriptorReadRequest
chrome.bluetoothLowEnergy.onDescriptorReadRequest.addListener(
callback: function,
)
เรียกใช้เมื่ออุปกรณ์ส่วนกลางที่เชื่อมต่ออยู่ขออ่านค่าของข้อบ่งชี้ที่ลงทะเบียนไว้ในเซิร์ฟเวอร์ GATT ในพื้นที่ การไม่ตอบกลับคําขอนี้เป็นเวลานานอาจทําให้การเชื่อมต่อถูกตัด เหตุการณ์นี้จะพร้อมใช้งานก็ต่อเมื่อแอปตั้งค่าทั้ง bluetooth:low_energy และ bluetooth:peripheral เป็น "จริง" สิทธิ์อุปกรณ์ต่อพ่วงอาจไม่พร้อมใช้งานสำหรับบางแอป
พารามิเตอร์
-
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: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 ที่ค้นพบก่อนหน้านี้ในอุปกรณ์ระยะไกลออก