BluetoothRemoteGATTCharacteristic
Limited availability
This feature is not Baseline because it does not work in some of the most widely-used browsers.
Experimental: This is an experimental technology
Check the Browser compatibility table carefully before using this in production.
Secure context: This feature is available only in secure contexts (HTTPS), in some or all supporting browsers.
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.
Instance properties
BluetoothRemoteGATTCharacteristic.service
Read only Experimental-
Returns the
BluetoothRemoteGATTService
this characteristic belongs to. BluetoothRemoteGATTCharacteristic.uuid
Read only Experimental-
Returns a string containing the UUID of the characteristic, for example
'00002a37-0000-1000-8000-00805f9b34fb'
for the Heart Rate Measurement characteristic. BluetoothRemoteGATTCharacteristic.properties
Read only Experimental-
Returns the properties of this characteristic.
BluetoothRemoteGATTCharacteristic.value
Read only Experimental-
The currently cached characteristic value. This value gets updated when the value of the characteristic is read or updated via a notification or indication.
Instance methods
BluetoothRemoteGATTCharacteristic.getDescriptor()
Experimental-
Returns a
Promise
that resolves to the firstBluetoothRemoteGATTDescriptor
for a given descriptor UUID. BluetoothRemoteGATTCharacteristic.getDescriptors()
Experimental-
Returns a
Promise
that resolves to anArray
of allBluetoothRemoteGATTDescriptor
objects for a given descriptor UUID. BluetoothRemoteGATTCharacteristic.readValue()
Experimental-
Returns a
Promise
that resolves to anDataView
holding a duplicate of thevalue
property if it is available and supported. Otherwise it throws an error. BluetoothRemoteGATTCharacteristic.writeValue()
Deprecated Experimental-
Sets the
value
property to the bytes contained in a givenArrayBuffer
, writes the characteristic value with optional response, and returns the resultingPromise
. BluetoothRemoteGATTCharacteristic.writeValueWithResponse()
Experimental-
Sets the
value
property to the bytes contained in a givenArrayBuffer
, writes the characteristic value with required response, and returns the resultingPromise
. BluetoothRemoteGATTCharacteristic.writeValueWithoutResponse()
Experimental-
Sets the
value
property to the bytes contained in a givenArrayBuffer
, writes the characteristic value without response, and returns the resultingPromise
. BluetoothRemoteGATTCharacteristic.startNotifications()
Experimental-
Returns a
Promise
that resolves whennavigator.bluetooth
is added to the active notification context. BluetoothRemoteGATTCharacteristic.stopNotifications()
Experimental-
Returns a
Promise
that resolves whennavigator.bluetooth
is removed from the active notification context.
Events
characteristicvaluechanged
Experimental-
Fired on a
BluetoothRemoteGATTCharacteristic
when its value changes.
Specifications
Specification |
---|
Web Bluetooth # bluetoothgattcharacteristic-interface |
Browser compatibility
BCD tables only load in the browser