BluetoothDevice

This is an experimental technology
Check the Browser compatibility table carefully before using this in production.

The BluetoothDevice interface of the Web Bluetooth API represents a Bluetooth device inside a particular script execution environment.

Interface

interface BluetoothDevice {
  readonly attribute DOMString id;
  readonly attribute DOMString? name;
  readonly attribute BluetoothRemoteGATTServer? gatt;
  readonly attribute FrozenArray uuids;

  Promise watchAdvertisements();
  void unwatchAdvertisements();
  readonly attribute boolean watchingAdvertisements;
};
BluetoothDevice implements EventTarget;
BluetoothDevice implements BluetoothDeviceEventHandlers;
BluetoothDevice implements CharacteristicEventHandlers;
BluetoothDevice implements ServiceEventHandlers;

Properties

BluetoothDevice.id Read only
A DOMString that uniquely identifies a device.
BluetoothDevice.name Read only
A DOMString that provices a human-readable name for the device.
BluetoothDevice.gatt  Read only
A reference to the device's BluetoothRemoteGATTServer.
BluetoothDevice.uuids  Read only
Lists the UUID's of GATT services provided by the device, that the current origin is allowed to access.
BluetoothDevice.watchingAdvertisements  Read only
If advertisments were activated using BluetoothDevice.watchAdvertisements().

Non-standard Chrome OS properties

Non-standard
This feature is non-standard and is not on a standards track. Do not use it on production sites facing the Web: it will not work for every user. There may also be large incompatibilities between implementations and the behavior may change in the future.

These properties were only implemented on Google’s Chrome OS 45 and removed from Chrome 52.

BluetoothDevice.adData Read only
An instance of BluetoothAdvertisingData containing the most recent advertising data received for the device.
BluetoothDevice.deviceClass Read only
A number representing the Bluetooth devices "Class of Device".
BluetoothDevice.vendorIDSource  Read only
The Vendor ID Source field in the pnp_id characteristic in the device_information service.
BluetoothDevice.vendorID  Read only
The 16-bit Vendor ID field in the pnp_id characteristic in the device_information service.
BluetoothDevice.productID  Read only
The 16-bit Product ID field in the pnp_id characteristic in the device_information service.
BluetoothDevice.productVersion  Read only
The 16-bit Product Version field in the pnp_id characteristic in the device_information service.
BluetoothDevice.paired  Read only
A Boolean value indicating whether the device is paired with the system.
BluetoothDevice.gattServer  Read only
A reference to the device's GATT server or null if the device is disconnected.

Methods

BluetoothDevice.watchAdvertisments() 
A Promise that resolves to undefined or is rejected with an error if advetisments can’t shown for any reason.
BluetoothDevice.unwatchAdvertisments() 
Stops watching for advertisments.
BluetoothDevice.connectGATT() 
A Promise that resolves to an instance of BluetoothGATTRemoteServer.

Specifications

Specification Status Comment
Web Bluetooth
The definition of 'BluetoothDevice' in that specification.
Draft Initial definition.

Browser compatibility

FeatureChromeEdgeFirefoxInternet ExplorerOperaSafari
Basic support

521

452

? ? ? ? ?
adData45 — 522 ? ? ? ? ?
connectGATT45 — 522 ? ? ? ? ?
deviceClass45 — 522 ? ? ? ? ?
gatt

521

452

? ? ? ? ?
gattServer45 — 522 ? ? ? ? ?
id

521

452

? ? ? ? ?
name

521

452

? ? ? ? ?
paired45 — 522 ? ? ? ? ?
productID45 — 522 ? ? ? ? ?
productVersion45 — 522 ? ? ? ? ?
unwatchAdvertisements

521

452

? ? ? ? ?
uuids

521

452

? ? ? ? ?
vendorID45 — 522 ? ? ? ? ?
vendorIDSource45 — 522 ? ? ? ? ?
watchAdvertisements

521

452

? ? ? ? ?
watchingAdvertisements

521

452

? ? ? ? ?
FeatureAndroid webviewChrome for AndroidEdge mobileFirefox for AndroidOpera AndroidiOS SafariSamsung Internet
Basic support No521 ? ? ? ? ?
adData No No ? ? ? ? ?
connectGATT No No ? ? ? ? ?
deviceClass No No ? ? ? ? ?
gatt No521 ? ? ? ? ?
gattServer No No ? ? ? ? ?
id No521 ? ? ? ? ?
name No521 ? ? ? ? ?
paired No No ? ? ? ? ?
productID No No ? ? ? ? ?
productVersion No No ? ? ? ? ?
unwatchAdvertisements No521 ? ? ? ? ?
uuids No521 ? ? ? ? ?
vendorID No No ? ? ? ? ?
vendorIDSource No No ? ? ? ? ?
watchAdvertisements No521 ? ? ? ? ?
watchingAdvertisements No521 ? ? ? ? ?

1. Chrome origin trials only.

2. Behind a flag. Chrome OS only.

Document Tags and Contributors

Contributors to this page: ExE-Boss, fscholz, jpmedley, chrisdavidmills
Last updated by: ExE-Boss,