bluetooth-base/com.splendo.kaluga.bluetooth

Package-level declarations

Types

The Attribute Protocol allows a device referred to as the server to expose a set of attributes and their associated values to a peer device referred to as the client. These attributes exposed by the server can be discovered, read, and written by a client, and can be indicated and notified by the server.

BluetoothMonitor

actual interface BluetoothMonitor : ServiceMonitor

A ServiceMonitor that monitors whether Bluetooth is enabled

actual interface BluetoothMonitor : ServiceMonitor

A ServiceMonitor that monitors whether Bluetooth is enabled

expect interface BluetoothMonitor : ServiceMonitor

A ServiceMonitor that monitors whether Bluetooth is enabled

actual interface BluetoothMonitor : ServiceMonitor

A ServiceMonitor that monitors whether Bluetooth is enabled

actual interface BluetoothMonitor : ServiceMonitor

A ServiceMonitor that monitors whether Bluetooth is enabled, shared by the JS family (js + wasmJs).

Characteristic

interface Characteristic : Attribute

A Characteristic is an Attribute that contains the value of a single piece of data and any required descriptors that describe the value. It is a value used in a service along with properties and configuration information about how the value is accessed and information about how the value is displayed or represented. A Characteristic may contain one or more Descriptor.

CharacteristicProperty

sealed class CharacteristicProperty

A CharacteristicProperty determines how a Characteristic Value can be used, or how the Descriptor can be accessed.

DefaultBluetoothMonitor

class DefaultBluetoothMonitor : DefaultServiceMonitor, BluetoothMonitor

A default implementation of BluetoothMonitor

class DefaultBluetoothMonitor : DefaultServiceMonitor, BluetoothMonitor

A default implementation of BluetoothMonitor

class DefaultBluetoothMonitor : DefaultServiceMonitor, BluetoothMonitor

A default implementation of BluetoothMonitor

class DefaultBluetoothMonitor : DefaultServiceMonitor, BluetoothMonitor

Default BluetoothMonitor for the JS family. Web Bluetooth's powered-on/adapter state is only available asynchronously (navigator.bluetooth.getAvailability()), so this uses the presence of the Web Bluetooth API as a synchronous proxy for "enabled" — sufficient to gate the scanner, which surfaces the real availability when the user opens the device picker.

Descriptor

interface Descriptor : Attribute

Characteristic descriptors are used to contain related information about the Characteristic Value. The GATT profile defines a standard set of characteristic descriptors that can be used by higher layer profiles. Higher layer profiles may define additional characteristic descriptors that are profile specific.

FailedToReadException

class FailedToReadException(val reason: GattResponse.ReadError) : Exception

An Exception thrown when RemoteAttribute.read could not read into a data object

GattResponse

sealed interface GattResponse

Response given when performing a Bluetooth Gatt Request

MTU

typealias MTU = Int

The maximum transmission unit size

RSSI

typealias RSSI = Int

The Received signal strength indication (RSSI)

Service

interface Service : Attribute

A GATT Service is an Attribute that forms collection of data and associated behaviors to accomplish a particular function or feature. In GATT, a service is defined by its service definition. A service definition may contain included services, mandatory characteristics, and optional characteristics.

TxPower

typealias TxPower = Int

The transmission power level in dBm

UUID

actual typealias UUID = java.util.UUID

typealias UUID = java.util.UUID

The Unique Identifier of a Bluetooth property

actual typealias UUID = CBUUID

typealias UUID = CBUUID

The Unique Identifier of a Bluetooth property

expect class UUID

The Unique Identifier of a Bluetooth property

actual data class UUID

The Unique Identifier of a Bluetooth property. On the JS family it wraps the canonical 128-bit lowercase string form that the Web Bluetooth API uses (e.g. BluetoothRemoteGATTService.uuid).

UUIDException

sealed class UUIDException : Exception

An Exception dealing with issues to the Unique identifier

Value

actual typealias Value = ByteArray

typealias Value = ByteArray

The value of a bluetooth attribute

actual typealias Value = NSData

typealias Value = NSData

The value of a bluetooth attribute

expect class Value

The value of a platform specific bluetooth attribute

actual typealias Value = ByteArray

typealias Value = ByteArray

The value of a bluetooth attribute. On the JS family GATT values are read as DataViews; they are converted to a ByteArray at the interop boundary, so Value is simply the bytes.