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.

Events

oncharacteristicvaluechanged: Event handler for the characteristicvaluechanged event.

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

BCD tables only load in the browser