Class BluetoothRemoteGATTCharacteristic

Bluetooth Remote GATT Characteristic class

Events

Name	Event	Description
`characteristicvaluechanged`	Event	The value of a BLE Characteristic has changed.

Hierarchy

EventTarget
- BluetoothRemoteGATTCharacteristic

Implements

BluetoothRemoteGATTCharacteristic

Index

Constructors

Properties

properties service uuid

Accessors

oncharacteristicvaluechanged value

Methods

getDescriptor getDescriptors readValue startNotifications stopNotifications writeValue writeValueWithoutResponse writeValueWithResponse

Constructors

constructor

new BluetoothRemoteGATTCharacteristic(
init: BluetoothRemoteGATTCharacteristicInit,
service: BluetoothRemoteGATTService,
): BluetoothRemoteGATTCharacteristic
Characteristic constructor
Parameters
- init: BluetoothRemoteGATTCharacteristicInit
  A partial class to initialise values
- service: BluetoothRemoteGATTService
Returns BluetoothRemoteGATTCharacteristic
Overrides EventTarget.constructor
- Defined in src/characteristic.ts:90

Properties

`Readonly`properties

properties: BluetoothCharacteristicProperties

The properties of the characteristic

`Readonly`service

service: BluetoothRemoteGATTService

The service the characteristic is related to

`Readonly`uuid

uuid: string

The unique identifier of the characteristic

Accessors

oncharacteristicvaluechanged

set oncharacteristicvaluechanged(fn: (ev: Event) => void): void
Parameters
- fn: (ev: Event) => void
Returns void
Implementation of BluetoothRemoteGATTCharacteristic.oncharacteristicvaluechanged
- Defined in src/characteristic.ts:75

value

get value(): DataView<ArrayBufferLike> | undefined
The value of the characteristic

Returns DataView<ArrayBufferLike> | undefined
Implementation of BluetoothRemoteGATTCharacteristic.value
- Defined in src/characteristic.ts:64

Methods

getDescriptor

getDescriptor(
descriptor: string | number,
): Promise<BluetoothRemoteGATTDescriptor>
Gets a single characteristic descriptor
Parameters
- descriptor: string | number
  descriptor UUID
Returns Promise<BluetoothRemoteGATTDescriptor>
Promise containing the descriptor
Implementation of BluetoothRemoteGATTCharacteristic.getDescriptor
- Defined in src/characteristic.ts:117

getDescriptors

getDescriptors(
descriptor?: string | number,
): Promise<BluetoothRemoteGATTDescriptor[]>
Gets a list of the characteristic's descriptors
Parameters
- Optionaldescriptor: string | number
  descriptor UUID
Returns Promise<BluetoothRemoteGATTDescriptor[]>
Promise containing an array of descriptors
Implementation of BluetoothRemoteGATTCharacteristic.getDescriptors
- Defined in src/characteristic.ts:139

readValue

readValue(): Promise<DataView<ArrayBufferLike>>
Gets the value of the characteristic

Returns Promise<DataView<ArrayBufferLike>>
Promise containing the value
Implementation of BluetoothRemoteGATTCharacteristic.readValue
- Defined in src/characteristic.ts:167

startNotifications

startNotifications(): Promise<BluetoothRemoteGATTCharacteristic>
Start notifications of changes for the characteristic

Returns Promise<BluetoothRemoteGATTCharacteristic>
Promise containing the characteristic
Implementation of BluetoothRemoteGATTCharacteristic.startNotifications
- Defined in src/characteristic.ts:229

stopNotifications

stopNotifications(): Promise<BluetoothRemoteGATTCharacteristic>
Stop notifications of changes for the characteristic

Returns Promise<BluetoothRemoteGATTCharacteristic>
Promise containing the characteristic
Implementation of BluetoothRemoteGATTCharacteristic.stopNotifications
- Defined in src/characteristic.ts:245

writeValue

writeValue(value: ArrayBuffer | ArrayBufferView<ArrayBufferLike>): Promise<void>
Updates the value of the characteristic
Parameters
- value: ArrayBuffer | ArrayBufferView<ArrayBufferLike>
  The value to write
Returns Promise<void>
Implementation of BluetoothRemoteGATTCharacteristic.writeValue
- Defined in src/characteristic.ts:181

writeValueWithoutResponse

writeValueWithoutResponse(
value: ArrayBuffer | ArrayBufferView<ArrayBufferLike>,
): Promise<void>
Updates the value of the characteristic without waiting for a response
Parameters
- value: ArrayBuffer | ArrayBufferView<ArrayBufferLike>
  The value to write
Returns Promise<void>
Implementation of BluetoothRemoteGATTCharacteristic.writeValueWithoutResponse
- Defined in src/characteristic.ts:213

writeValueWithResponse

writeValueWithResponse(
value: ArrayBuffer | ArrayBufferView<ArrayBufferLike>,
): Promise<void>
Updates the value of the characteristic and waits for a response
Parameters
- value: ArrayBuffer | ArrayBufferView<ArrayBufferLike>
  The value to write
Returns Promise<void>
Implementation of BluetoothRemoteGATTCharacteristic.writeValueWithResponse
- Defined in src/characteristic.ts:197