Class BluetoothGatt

Provides access to the Bluetooth connection.

Hierarchy (View Summary)

ScriptObject
- BluetoothGatt

Index

Properties

connectionState mtu onConnectionStateChangedEvent onMtuChangedEvent

Methods

close connect disconnect getService getServices getTypeName isOfType isSame

Properties

`Readonly` `Experimental`connectionState

connectionState: ConnectionState

The state of the GATT connection represented as a Bluetooth.ConnectionState enum.

Snap OS

`Readonly` `Experimental`mtu

mtu: number

The current Maximum Transmission Unit (MTU).

Snap OS

`Readonly` `Experimental`onConnectionStateChangedEvent

onConnectionStateChangedEvent: event1<ConnectionStateChangedEvent, void>

Event to observe changes in connection state.

Snap OS

`Readonly` `Experimental`onMtuChangedEvent

onMtuChangedEvent: event1<MtuChangedEvent, void>

Event to observe changes in Maximum Transmission Unit (MTU).

Snap OS

Methods

close

close(): void
Experimental
Terminate the Bluetooth client connection, disconnection included if applicable.

Returns void
Snap OS

connect

connect(): void
Experimental
Re-establish connection to the device. Asynchronous call: to detect when the device is connected listen on the Bluetooth.BluetoothGatt.onConnectionStateChangedEvent.

Returns void
Snap OS

disconnect

disconnect(): void
Experimental
Unpair or disconnect from the device. Asynchronous call: to detect when the device is disconnected listen on the Bluetooth.BluetoothGatt.onConnectionStateChangedEvent.

Returns void
Snap OS

getService

getService(serviceUUID: string): BluetoothGattService
Experimental
Retrieve a specific Bluetooth.BluetoothGattService using its UUID from the GATT server.
Parameters
- serviceUUID: string
Returns BluetoothGattService
Snap OS

getServices

getServices(): BluetoothGattService[]
Experimental
Retrieve all available services from the GATT server.

Returns BluetoothGattService[]
Snap OS

getTypeName

getTypeName(): string
Returns the name of this object's type.

Returns string
Inherited from ScriptObject.getTypeName

isOfType

isOfType(type: string): boolean
Returns true if the object matches or derives from the passed in type.
Parameters
- type: string
Returns boolean
Inherited from ScriptObject.isOfType

isSame

isSame(other: ScriptObject): boolean
Returns true if this object is the same as other. Useful for checking if two references point to the same thing.
Parameters
- other: ScriptObject
Returns boolean
Inherited from ScriptObject.isSame