BluetoothRemoteGATTCharacteristic

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

The BluetoothRemoteGattCharacteristic interface of the Web Bluetooth API represents a GATT Characteristic, which is a basic data element that provides further information about a peripheral’s service.

Interface

interface BluetoothRemoteGATTCharacteristic {
  readonly attribute BluetoothRemoteGATTService service;
  readonly attribute UUID uuid;
  readonly attribute BluetoothCharacteristicProperties properties;
  readonly attribute DataView? value;
  Promise<BluetoothRemoteGATTDescriptor> getDescriptor(BluetoothDescriptorUUID descriptor);
  Promise<sequence<BluetoothRemoteGATTDescriptor>>
    getDescriptors(optional BluetoothDescriptorUUID descriptor);
  Promise<DataView> readValue();
  Promise<void> writeValue(BufferSource value);
  Promise<void> startNotifications();
  Promise<void> stopNotifications();
};
BluetoothRemoteGATTCharacteristic implements EventTarget;
BluetoothRemoteGATTCharacteristic implements CharacteristicEventHandlers;

Properties

BluetoothRemoteGATTCharacteristic.serviceRead only
Returns the BluetoothGATTService this characteristic belongs to.
BluetoothRemoteGATTCharacteristic.uuidRead only
Returns a DOMString containing the UUID of the characteristic, for example '00002a37-0000-1000-8000-00805f9b34fb' for the Heart Rate Measurement characteristic.
BluetoothRemoteGATTCharacteristic.propertiesRead only
Returns the properties of this characteristic.
BluetoothRemoteGATTCharacteristic.valueRead only
The currently cached characteristic value. This value gets updated when the value of the characteristic is read or updated via a notification or indication.

Methods

BluetoothRemoteGATTCharacteristic.getDescriptor()
Returns a Promise that resolves to the first BluetoothGATTDescriptor for a given descriptor UUID.
BluetoothRemoteGATTCharacteristic.getDescriptors()
Returns a Promise that resolves to an Array of all BluetoothGATTDescriptor objects for a given descriptor UUID.
BluetoothRemoteGATTCharacteristic.readValue()
Returns a Promise that resolves to an ArrayBuffer holding a duplicate of the value property if it is available and supported. Otherwise it throws an error.
BluetoothRemoteGATTCharacteristic.writeValue()
Sets the value property to the bytes contained in an ArrayBuffer and returns a Promise.
BluetoothRemoteGATTCharacteristic.startNotifications()
Returns a Promise when navigator.bluetooth is added to the active notification context.
BluetoothRemoteGATTCharacteristic.stopNotifications()
Returns a Promise when navigator.bluetooth is removed from the active notification context.

Specifications

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

Browser compatibility

DesktopMobile
ChromeEdgeFirefoxInternet ExplorerOperaSafariAndroid webviewChrome for AndroidFirefox for AndroidOpera for AndroidSafari on iOSSamsung Internet
BluetoothRemoteGATTCharacteristic
Experimental
Chrome Full support 56
Notes
Full support 56
Notes
Notes macOS only.
Full support 56
Notes Disabled
Notes Linux and versions of Windows earlier than 10.
Disabled From version 56: this feature is behind the #enable-experimental-web-platform-features preference (needs to be set to enabled). To change preferences in Chrome, visit chrome://flags.
Full support 70
Notes
Notes Windows 10.
Edge Full support ≤79
Notes
Full support ≤79
Notes
Notes macOS only.
Full support ≤79
Notes Disabled
Notes Linux and versions of Windows earlier than 10.
Disabled From version ≤79: this feature is behind the #enable-experimental-web-platform-features preference (needs to be set to enabled).
Full support ≤79
Notes
Notes Windows 10.
Firefox No support NoIE No support NoOpera Full support 43
Notes
Full support 43
Notes
Notes macOS only.
Full support 43
Notes Disabled
Notes Linux and versions of Windows earlier than 10.
Disabled From version 43: this feature is behind the #enable-experimental-web-platform-features preference (needs to be set to enabled).
Full support 57
Notes
Notes Windows 10.
Safari No support NoWebView Android No support NoChrome Android Full support 56Firefox Android No support NoOpera Android Full support 43Safari iOS No support NoSamsung Internet Android Full support 6.0
getDescriptor
Experimental
Chrome Full support 56
Notes
Full support 56
Notes
Notes macOS only.
Full support 56
Notes Disabled
Notes Linux and versions of Windows earlier than 10.
Disabled From version 56: this feature is behind the #enable-experimental-web-platform-features preference (needs to be set to enabled). To change preferences in Chrome, visit chrome://flags.
Full support 70
Notes
Notes Windows 10.
Edge Full support ≤79
Notes
Full support ≤79
Notes
Notes macOS only.
Full support ≤79
Notes Disabled
Notes Linux and versions of Windows earlier than 10.
Disabled From version ≤79: this feature is behind the #enable-experimental-web-platform-features preference (needs to be set to enabled).
Full support ≤79
Notes
Notes Windows 10.
Firefox No support NoIE No support NoOpera Full support 43
Notes
Full support 43
Notes
Notes macOS only.
Full support 43
Notes Disabled
Notes Linux and versions of Windows earlier than 10.
Disabled From version 43: this feature is behind the #enable-experimental-web-platform-features preference (needs to be set to enabled).
Full support 57
Notes
Notes Windows 10.
Safari No support NoWebView Android No support NoChrome Android Full support 56Firefox Android No support NoOpera Android Full support 43Safari iOS No support NoSamsung Internet Android Full support 6.0
getDescriptors
Experimental
Chrome Full support 56
Notes
Full support 56
Notes
Notes macOS only.
Full support 56
Notes Disabled
Notes Linux and versions of Windows earlier than 10.
Disabled From version 56: this feature is behind the #enable-experimental-web-platform-features preference (needs to be set to enabled). To change preferences in Chrome, visit chrome://flags.
Full support 70
Notes
Notes Windows 10.
Edge Full support ≤79
Notes
Full support ≤79
Notes
Notes macOS only.
Full support ≤79
Notes Disabled
Notes Linux and versions of Windows earlier than 10.
Disabled From version ≤79: this feature is behind the #enable-experimental-web-platform-features preference (needs to be set to enabled).
Full support ≤79
Notes
Notes Windows 10.
Firefox No support NoIE No support NoOpera Full support 43
Notes
Full support 43
Notes
Notes macOS only.
Full support 43
Notes Disabled
Notes Linux and versions of Windows earlier than 10.
Disabled From version 43: this feature is behind the #enable-experimental-web-platform-features preference (needs to be set to enabled).
Full support 57
Notes
Notes Windows 10.
Safari No support NoWebView Android No support NoChrome Android Full support 56Firefox Android No support NoOpera Android Full support 43Safari iOS No support NoSamsung Internet Android Full support 6.0
properties
Experimental
Chrome Full support 56
Notes
Full support 56
Notes
Notes macOS only.
Full support 56
Notes Disabled
Notes Linux and versions of Windows earlier than 10.
Disabled From version 56: this feature is behind the #enable-experimental-web-platform-features preference (needs to be set to enabled). To change preferences in Chrome, visit chrome://flags.
Full support 70
Notes
Notes Windows 10.
Edge Full support ≤79
Notes
Full support ≤79
Notes
Notes macOS only.
Full support ≤79
Notes Disabled
Notes Linux and versions of Windows earlier than 10.
Disabled From version ≤79: this feature is behind the #enable-experimental-web-platform-features preference (needs to be set to enabled).
Full support ≤79
Notes
Notes Windows 10.
Firefox No support NoIE No support NoOpera Full support 43
Notes
Full support 43
Notes
Notes macOS only.
Full support 43
Notes Disabled
Notes Linux and versions of Windows earlier than 10.
Disabled From version 43: this feature is behind the #enable-experimental-web-platform-features preference (needs to be set to enabled).
Full support 57
Notes
Notes Windows 10.
Safari No support NoWebView Android No support NoChrome Android Full support 56Firefox Android No support NoOpera Android Full support 43Safari iOS No support NoSamsung Internet Android Full support 6.0
readValue
Experimental
Chrome Full support 56
Notes
Full support 56
Notes
Notes macOS only.
Full support 56
Notes Disabled
Notes Linux and versions of Windows earlier than 10.
Disabled From version 56: this feature is behind the #enable-experimental-web-platform-features preference (needs to be set to enabled). To change preferences in Chrome, visit chrome://flags.
Full support 70
Notes
Notes Windows 10.
Edge Full support ≤79
Notes
Full support ≤79
Notes
Notes macOS only.
Full support ≤79
Notes Disabled
Notes Linux and versions of Windows earlier than 10.
Disabled From version ≤79: this feature is behind the #enable-experimental-web-platform-features preference (needs to be set to enabled).
Full support ≤79
Notes
Notes Windows 10.
Firefox No support NoIE No support NoOpera Full support 43
Notes
Full support 43
Notes
Notes macOS only.
Full support 43
Notes Disabled
Notes Linux and versions of Windows earlier than 10.
Disabled From version 43: this feature is behind the #enable-experimental-web-platform-features preference (needs to be set to enabled).
Full support 57
Notes
Notes Windows 10.
Safari No support NoWebView Android No support NoChrome Android Full support 56Firefox Android No support NoOpera Android Full support 43Safari iOS No support NoSamsung Internet Android Full support 6.0
service
Experimental
Chrome Full support 56
Notes
Full support 56
Notes
Notes macOS only.
Full support 56
Notes Disabled
Notes Linux and versions of Windows earlier than 10.
Disabled From version 56: this feature is behind the #enable-experimental-web-platform-features preference (needs to be set to enabled). To change preferences in Chrome, visit chrome://flags.
Full support 70
Notes
Notes Windows 10.
Edge Full support ≤79
Notes
Full support ≤79
Notes
Notes macOS only.
Full support ≤79
Notes Disabled
Notes Linux and versions of Windows earlier than 10.
Disabled From version ≤79: this feature is behind the #enable-experimental-web-platform-features preference (needs to be set to enabled).
Full support ≤79
Notes
Notes Windows 10.
Firefox No support NoIE No support NoOpera Full support 43
Notes
Full support 43
Notes
Notes macOS only.
Full support 43
Notes Disabled
Notes Linux and versions of Windows earlier than 10.
Disabled From version 43: this feature is behind the #enable-experimental-web-platform-features preference (needs to be set to enabled).
Full support 57
Notes
Notes Windows 10.
Safari No support NoWebView Android No support NoChrome Android Full support 56Firefox Android No support NoOpera Android Full support 43Safari iOS No support NoSamsung Internet Android Full support 6.0
startNotifications
Experimental
Chrome Full support 56
Notes
Full support 56
Notes
Notes macOS only.
Full support 56
Notes Disabled
Notes Linux and versions of Windows earlier than 10.
Disabled From version 56: this feature is behind the #enable-experimental-web-platform-features preference (needs to be set to enabled). To change preferences in Chrome, visit chrome://flags.
Full support 70
Notes
Notes Windows 10.
Edge Full support ≤79
Notes
Full support ≤79
Notes
Notes macOS only.
Full support ≤79
Notes Disabled
Notes Linux and versions of Windows earlier than 10.
Disabled From version ≤79: this feature is behind the #enable-experimental-web-platform-features preference (needs to be set to enabled).
Full support ≤79
Notes
Notes Windows 10.
Firefox No support NoIE No support NoOpera Full support 43
Notes
Full support 43
Notes
Notes macOS only.
Full support 43
Notes Disabled
Notes Linux and versions of Windows earlier than 10.
Disabled From version 43: this feature is behind the #enable-experimental-web-platform-features preference (needs to be set to enabled).
Full support 57
Notes
Notes Windows 10.
Safari No support NoWebView Android No support NoChrome Android Full support 56Firefox Android No support NoOpera Android Full support 43Safari iOS No support NoSamsung Internet Android Full support 6.0
stopNotifications
Experimental
Chrome Full support 56
Notes
Full support 56
Notes
Notes macOS only.
Full support 56
Notes Disabled
Notes Linux and versions of Windows earlier than 10.
Disabled From version 56: this feature is behind the #enable-experimental-web-platform-features preference (needs to be set to enabled). To change preferences in Chrome, visit chrome://flags.
Full support 70
Notes
Notes Windows 10.
Edge Full support ≤79
Notes
Full support ≤79
Notes
Notes macOS only.
Full support ≤79
Notes Disabled
Notes Linux and versions of Windows earlier than 10.
Disabled From version ≤79: this feature is behind the #enable-experimental-web-platform-features preference (needs to be set to enabled).
Full support ≤79
Notes
Notes Windows 10.
Firefox No support NoIE No support NoOpera Full support 43
Notes
Full support 43
Notes
Notes macOS only.
Full support 43
Notes Disabled
Notes Linux and versions of Windows earlier than 10.
Disabled From version 43: this feature is behind the #enable-experimental-web-platform-features preference (needs to be set to enabled).
Full support 57
Notes
Notes Windows 10.
Safari No support NoWebView Android No support NoChrome Android Full support 56Firefox Android No support NoOpera Android Full support 43Safari iOS No support NoSamsung Internet Android Full support 6.0
uuid
Experimental
Chrome Full support 56
Notes
Full support 56
Notes
Notes macOS only.
Full support 56
Notes Disabled
Notes Linux and versions of Windows earlier than 10.
Disabled From version 56: this feature is behind the #enable-experimental-web-platform-features preference (needs to be set to enabled). To change preferences in Chrome, visit chrome://flags.
Full support 70
Notes
Notes Windows 10.
Edge Full support ≤79
Notes
Full support ≤79
Notes
Notes macOS only.
Full support ≤79
Notes Disabled
Notes Linux and versions of Windows earlier than 10.
Disabled From version ≤79: this feature is behind the #enable-experimental-web-platform-features preference (needs to be set to enabled).
Full support ≤79
Notes
Notes Windows 10.
Firefox No support NoIE No support NoOpera Full support 43
Notes
Full support 43
Notes
Notes macOS only.
Full support 43
Notes Disabled
Notes Linux and versions of Windows earlier than 10.
Disabled From version 43: this feature is behind the #enable-experimental-web-platform-features preference (needs to be set to enabled).
Full support 57
Notes
Notes Windows 10.
Safari No support NoWebView Android No support NoChrome Android Full support 56Firefox Android No support NoOpera Android Full support 43Safari iOS No support NoSamsung Internet Android Full support 6.0
value
Experimental
Chrome Full support 56
Notes
Full support 56
Notes
Notes macOS only.
Full support 56
Notes Disabled
Notes Linux and versions of Windows earlier than 10.
Disabled From version 56: this feature is behind the #enable-experimental-web-platform-features preference (needs to be set to enabled). To change preferences in Chrome, visit chrome://flags.
Full support 70
Notes
Notes Windows 10.
Edge Full support ≤79
Notes
Full support ≤79
Notes
Notes macOS only.
Full support ≤79
Notes Disabled
Notes Linux and versions of Windows earlier than 10.
Disabled From version ≤79: this feature is behind the #enable-experimental-web-platform-features preference (needs to be set to enabled).
Full support ≤79
Notes
Notes Windows 10.
Firefox No support NoIE No support NoOpera Full support 43
Notes
Full support 43
Notes
Notes macOS only.
Full support 43
Notes Disabled
Notes Linux and versions of Windows earlier than 10.
Disabled From version 43: this feature is behind the #enable-experimental-web-platform-features preference (needs to be set to enabled).
Full support 57
Notes
Notes Windows 10.
Safari No support NoWebView Android No support NoChrome Android Full support 56Firefox Android No support NoOpera Android Full support 43Safari iOS No support NoSamsung Internet Android Full support 6.0
writeValue
Experimental
Chrome Full support 56
Notes
Full support 56
Notes
Notes macOS only.
Full support 56
Notes Disabled
Notes Linux and versions of Windows earlier than 10.
Disabled From version 56: this feature is behind the #enable-experimental-web-platform-features preference (needs to be set to enabled). To change preferences in Chrome, visit chrome://flags.
Full support 70
Notes
Notes Windows 10.
Edge Full support ≤79
Notes
Full support ≤79
Notes
Notes macOS only.
Full support ≤79
Notes Disabled
Notes Linux and versions of Windows earlier than 10.
Disabled From version ≤79: this feature is behind the #enable-experimental-web-platform-features preference (needs to be set to enabled).
Full support ≤79
Notes
Notes Windows 10.
Firefox No support NoIE No support NoOpera Full support 43
Notes
Full support 43
Notes
Notes macOS only.
Full support 43
Notes Disabled
Notes Linux and versions of Windows earlier than 10.
Disabled From version 43: this feature is behind the #enable-experimental-web-platform-features preference (needs to be set to enabled).
Full support 57
Notes
Notes Windows 10.
Safari No support NoWebView Android No support NoChrome Android Full support 56Firefox Android No support NoOpera Android Full support 43Safari iOS No support NoSamsung Internet Android Full support 6.0

Legend

Full support
Full support
No support
No support
Experimental. Expect behavior to change in the future.
Experimental. Expect behavior to change in the future.
See implementation notes.
See implementation notes.
User must explicitly enable this feature.
User must explicitly enable this feature.