BluetoothRemoteGATTCharacteristic

Experimental: 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.

Properties

BluetoothRemoteGATTCharacteristic.serviceRead only

Returns the BluetoothRemoteGATTService 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 BluetoothRemoteGATTDescriptor for a given descriptor UUID.

BluetoothRemoteGATTCharacteristic.getDescriptors()

Returns a Promise that resolves to an Array of all BluetoothRemoteGATTDescriptor 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(value)

Sets the value property to the bytes contained in a given ArrayBuffer, calls WriteCharacteristicValue(this=this, value=value, response="optional"), and returns the resulting Promise.

BluetoothRemoteGATTCharacteristic.writeValueWithResponse(value)

Sets the value property to the bytes contained in a given ArrayBuffer, calls WriteCharacteristicValue(this=this, value=value, response="required"), and returns the resulting Promise.

BluetoothRemoteGATTCharacteristic.writeValueWithoutResponse(value)

Sets the value property to the bytes contained in a given ArrayBuffer, calls WriteCharacteristicValue(this=this, value=value, response="never"), and returns the resulting 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
Web Bluetooth
# bluetoothgattcharacteristic-interface

Browser compatibility

Desktop Mobile
Chrome Edge Firefox Internet Explorer Opera Safari WebView Android Chrome Android Firefox for Android Opera Android Safari on IOS Samsung Internet
BluetoothRemoteGATTCharacteristic
56
Before Chrome 70, this feature was only supported in macOS. In Chrome 70, support was added for Windows 10. Linux support is not enabled by default.
56
In Linux and versions of Windows earlier than 10, this flag must be enabled.
79
Supported by default only on macOS and Windows 10. Linux support is not enabled by default.
79
In Linux and versions of Windows earlier than 10, this flag must be enabled.
No
No
43
Before Opera 57, this feature was only supported in macOS. In Opera 57, support was added for Windows 10. Linux support is not enabled by default.
43
In Linux and versions of Windows earlier than 10, this flag must be enabled.
No
No
56
No
43
No
6.0
getDescriptor
56
79
No
No
43
No
No
56
No
43
No
6.0
getDescriptors
56
79
No
No
43
No
No
56
No
43
No
6.0
oncharacteristicvaluechanged
56
79
No
No
43
No
No
56
No
43
No
6.0
properties
56
79
No
No
43
No
No
56
No
43
No
6.0
readValue
56
79
No
No
43
No
No
56
No
43
No
6.0
service
56
79
No
No
43
No
No
56
No
43
No
6.0
startNotifications
56
79
No
No
43
No
No
56
No
43
No
6.0
stopNotifications
56
79
No
No
43
No
No
56
No
43
No
6.0
uuid
56
79
No
No
43
No
No
56
No
43
No
6.0
value
56
79
No
No
43
No
No
56
No
43
No
6.0
writeValue
56
79
No
No
43
No
No
56
No
43
No
6.0
writeValueWithoutResponse
85
85
No
No
71
No
No
85
No
60
No
14.0
writeValueWithResponse
85
85
No
No
71
No
No
85
No
60
No
14.0

© 2005–2021 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Web/API/BluetoothRemoteGATTCharacteristic