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.serviceRead only-
Returns the
BluetoothRemoteGATTServicethis characteristic belongs to. BluetoothRemoteGATTCharacteristic.uuidRead only-
Returns a string 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.
Instance methods
BluetoothRemoteGATTCharacteristic.getDescriptor()-
Returns a
Promisethat resolves to the firstBluetoothRemoteGATTDescriptorfor a given descriptor UUID. BluetoothRemoteGATTCharacteristic.getDescriptors()-
Returns a
Promisethat resolves to anArrayof allBluetoothRemoteGATTDescriptorobjects for a given descriptor UUID. BluetoothRemoteGATTCharacteristic.readValue()-
Returns a
Promisethat resolves to aDataViewholding a duplicate of thevalueproperty if it is available and supported. Otherwise it throws an error. BluetoothRemoteGATTCharacteristic.writeValue()-
Sets the
valueproperty to the bytes contained in a givenArrayBuffer, writes the characteristic value with optional response, and returns the resultingPromise. BluetoothRemoteGATTCharacteristic.writeValueWithResponse()-
Sets the
valueproperty to the bytes contained in a givenArrayBuffer, writes the characteristic value with required response, and returns the resultingPromise. BluetoothRemoteGATTCharacteristic.writeValueWithoutResponse()-
Sets the
valueproperty to the bytes contained in a givenArrayBuffer, writes the characteristic value without response, and returns the resultingPromise. BluetoothRemoteGATTCharacteristic.startNotifications()-
Returns a
Promisethat resolves whennavigator.bluetoothis added to the active notification context. BluetoothRemoteGATTCharacteristic.stopNotifications()-
Returns a
Promisethat resolves whennavigator.bluetoothis removed from the active notification context.
Events
characteristicvaluechanged-
Fired on a
BluetoothRemoteGATTCharacteristicwhen its value changes.
Specifications
| Specification |
|---|
| Web Bluetooth # bluetoothgattcharacteristic-interface |
Browser compatibility
| desktop | mobile | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
BluetoothRemoteGATTCharacteristic
|
|
|
|
|
|
|
|
|
|
|
|
|
characteristicvaluechanged event
|
|
|
|
|
|
|
|
|
|
|
|
|
getDescriptor
|
|
|
|
|
|
|
|
|
|
|
|
|
getDescriptors
|
|
|
|
|
|
|
|
|
|
|
|
|
properties
|
|
|
|
|
|
|
|
|
|
|
|
|
readValue
|
|
|
|
|
|
|
|
|
|
|
|
|
service
|
|
|
|
|
|
|
|
|
|
|
|
|
startNotifications
|
|
|
|
|
|
|
|
|
|
|
|
|
stopNotifications
|
|
|
|
|
|
|
|
|
|
|
|
|
uuid
|
|
|
|
|
|
|
|
|
|
|
|
|
value
|
|
|
|
|
|
|
|
|
|
|
|
|
writeValue
|
|
|
|
|
|
|
|
|
|
|
|
|
writeValueWithResponse
|
|
|
|
|
|
|
|
|
|
|
|
|
writeValueWithoutResponse
|
|
|
|
|
|
|
|
|
|
|
|
|
Legend
Tip: you can click/tap on a cell for more information.
- Full support
- Full support
- Partial support
- Partial support
- No support
- No support
- Experimental. Expect behavior to change in the future.
- Deprecated. Not for use in new websites.
- See implementation notes.
- Has more compatibility info.