BluetoothRemoteGATTCharacteristic
Bluetooth API
Bluetooth API
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
- : Returns the BluetoothRemoteGATTService this characteristic belongs to.
- BluetoothRemoteGATTCharacteristic.uuid
- : Returns a string containing the UUID of the characteristic, for example
'00002a37-0000-1000-8000-00805f9b34fb'for the Heart Rate Measurement characteristic. - BluetoothRemoteGATTCharacteristic.properties
- : Returns the properties of this characteristic.
- BluetoothRemoteGATTCharacteristic.value
- : 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 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 a DataView holding a duplicate of the
valueproperty if it is available and supported. Otherwise it throws an error. - BluetoothRemoteGATTCharacteristic.writeValue()
- : Sets the
valueproperty to the bytes contained in a given ArrayBuffer, writes the characteristic value with optional response, and returns the resulting Promise. - BluetoothRemoteGATTCharacteristic.writeValueWithResponse()
- : Sets the
valueproperty to the bytes contained in a given ArrayBuffer, writes the characteristic value with required response, and returns the resulting Promise. - BluetoothRemoteGATTCharacteristic.writeValueWithoutResponse()
- : Sets the
valueproperty to the bytes contained in a given ArrayBuffer, writes the characteristic value without response, and returns the resulting Promise. - BluetoothRemoteGATTCharacteristic.startNotifications()
- : Returns a Promise that resolves when
navigator.bluetoothis added to the active notification context. - BluetoothRemoteGATTCharacteristic.stopNotifications()
- : Returns a Promise that resolves when
navigator.bluetoothis removed from the active notification context.
Events
- characteristicvaluechanged
- : Fired on a
BluetoothRemoteGATTCharacteristicwhen its value changes.