BluetoothRemoteGATTCharacteristic
A GATT characteristic — the fundamental unit of data exchange with a remote Bluetooth LE device.
See
https://developer.mozilla.org/docs/Web/API/BluetoothRemoteGATTCharacteristic
Extends
Properties
| Property | Type |
|---|---|
oncharacteristicvaluechanged | null | (this, ev) => any |
Accessors
properties
get properties(): BluetoothCharacteristicProperties
Returns
BluetoothCharacteristicProperties
service
get service(): BluetoothRemoteGATTService
Returns
uuid
get uuid(): string
Returns
string
value
get value(): undefined | DataView
The most recent value read from (or notified by) the characteristic.
Returns
undefined | DataView
Methods
addEventListener()
addEventListener(type, callback, options?): void
Appends an event listener for events whose type attribute value is type. The callback argument sets the callback that will be invoked when the event is dispatched.
The options argument sets listener-specific options. For compatibility this can be a boolean, in which case the method behaves exactly as if the value was specified as options's capture.
When set to true, options's capture prevents callback from being invoked when the event's eventPhase attribute value is BUBBLING_PHASE. When false (or not present), callback will not be invoked when event's eventPhase attribute value is CAPTURING_PHASE. Either way, callback will be invoked if event's eventPhase attribute value is AT_TARGET.
When set to true, options's passive indicates that the callback will not cancel the event by invoking preventDefault(). This is used to enable performance optimizations described in § 2.8 Observing event listeners.
When set to true, options's once indicates that the callback will only be invoked once after which the event listener will be removed.
If an AbortSignal is passed for options's signal, then the event listener will be removed when signal is aborted.
The event listener is appended to target's event listener list and is not appended if it has the same type, callback, and capture.
Parameters
| Parameter | Type |
|---|---|
type | string |
callback | null | EventListenerOrEventListenerObject<any> |
options? | boolean | AddEventListenerOptions |
Returns
void
Inherited from
See
https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener
dispatchEvent()
dispatchEvent(event): boolean
Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.
Parameters
| Parameter | Type |
|---|---|
event | Event |
Returns
boolean
Overrides
See
https://developer.mozilla.org/docs/Web/API/EventTarget/dispatchEvent
readValue()
Reads the characteristic's value from the remote device.
Returns
See
https://developer.mozilla.org/docs/Web/API/BluetoothRemoteGATTCharacteristic/readValue
removeEventListener()
removeEventListener(type, callback, options?): void
Removes the event listener in target's event listener list with the same type, callback, and options.
Parameters
| Parameter | Type |
|---|---|
type | string |
callback | null | EventListenerOrEventListenerObject<any> |
options? | boolean | EventListenerOptions |
Returns
void
Inherited from
EventTarget.removeEventListener
See
https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener
startNotifications()
startNotifications(): Promise<BluetoothRemoteGATTCharacteristic>
Subscribes to value change notifications/indications. Also writes the Client Characteristic Configuration descriptor, like browsers do.
Returns
Promise<BluetoothRemoteGATTCharacteristic>
See
https://developer.mozilla.org/docs/Web/API/BluetoothRemoteGATTCharacteristic/startNotifications
stopNotifications()
stopNotifications(): Promise<BluetoothRemoteGATTCharacteristic>
Unsubscribes from value change notifications.
Returns
Promise<BluetoothRemoteGATTCharacteristic>
See
https://developer.mozilla.org/docs/Web/API/BluetoothRemoteGATTCharacteristic/stopNotifications
writeValue()
writeValue(value): Promise<void>
Writes to the characteristic (legacy alias of
writeValueWithResponse()).
Parameters
| Parameter | Type |
|---|---|
value | BufferSource |
Returns
Promise<void>
See
https://developer.mozilla.org/docs/Web/API/BluetoothRemoteGATTCharacteristic/writeValue
writeValueWithoutResponse()
writeValueWithoutResponse(value): Promise<void>
Writes to the characteristic using Write Without Response.
Parameters
| Parameter | Type |
|---|---|
value | BufferSource |
Returns
Promise<void>
See
writeValueWithResponse()
writeValueWithResponse(value): Promise<void>
Writes to the characteristic using Write With Response.
Parameters
| Parameter | Type |
|---|---|
value | BufferSource |
Returns
Promise<void>
See
https://developer.mozilla.org/docs/Web/API/BluetoothRemoteGATTCharacteristic/writeValueWithResponse