Package-level declarations

Core types and interfaces for Bluetooth Low Energy clients and server implementations.

Types

Link copied to clipboard
open class AdvertisingDataDefinition(val serviceUuids: List<Uuid>? = null)

Advertising data packet container for Bluetooth LE advertising.

Link copied to clipboard

An enum with AD Flag values.

Link copied to clipboard

Common scope for building advertising data.

Link copied to clipboard

Advertising Data types (AD types).

Link copied to clipboard

Recommended advertising intervals.

Link copied to clipboard

This class specifies parameters for Bluetooth LE advertising.

Link copied to clipboard
interface AnyService<C : Characteristic<*>> : Service<C>

An interface representing a primary or an included service.

Link copied to clipboard
class Bluetooth5AdvertisingSetParameters(val connectable: Boolean, val discoverable: Boolean = connectable, val interval: Duration = AdvertisingInterval.MEDIUM, val txPowerLevel: Int = TxPowerLevel.MEDIUM, val includeTxPowerLevel: Boolean = false, val primaryPhy: PrimaryPhy = PrimaryPhy.PHY_LE_1M, val secondaryPhy: Phy = Phy.PHY_LE_1M, val anonymous: Boolean = false, val scannable: Boolean = false) : AdvertisingSetParameters

The advertising parameters for advertising using Advertising Extension from Bluetooth 5.

Link copied to clipboard

Defines available bonding states.

Link copied to clipboard

Interface representing a Bluetooth GATT characteristic.

Link copied to clipboard

Enumeration of properties of GATT characteristics.

Link copied to clipboard

Scope of a characteristic.

Link copied to clipboard

Bluetooth LE connection parameters.

Link copied to clipboard
sealed class ConnectionState

Connection state of a Bluetooth LE device.

Link copied to clipboard
interface Descriptor

Interface representing a Bluetooth GATT descriptor.

Link copied to clipboard

An interface representing a service included in another service.

Link copied to clipboard
class LegacyAdvertisingSetParameters(val connectable: Boolean, val discoverable: Boolean = connectable, val interval: Duration = AdvertisingInterval.MEDIUM, val txPowerLevel: Int = TxPowerLevel.MEDIUM) : AdvertisingSetParameters

The advertising parameters for legacy advertising.

Link copied to clipboard
interface Manager : Closeable

A base interface for a manager.

Link copied to clipboard

Gatt operation status.

Link copied to clipboard
interface Peer<ID : Any>

Class representing a Bluetooth LE peer device or a mock.

Link copied to clipboard

The Bluetooth device type of the remote device.

Link copied to clipboard

Permissions representing read/write operation restrictions.

Link copied to clipboard
enum Phy : Enum<Phy>

At the bottom of the Bluetooth LE stack is the physical layer (PHY). PHY refers to the physical layer radio specifications that govern the operation of the Bluetooth LE radio. This layer defines different modulation and coding schemes adopted by Bluetooth LE radio transmitters that affect things like the throughput of the radio. This in turn changes the battery consumption of the device or the range of the connection.

Link copied to clipboard
data class PhyInUse(val txPhy: Phy, val rxPhy: Phy)

A class that holds the PHYs in use for a connection.

Link copied to clipboard

PHY coded option.

Link copied to clipboard

Primary PHY for an advertisement.

Link copied to clipboard

An interface representing a primary service.

Link copied to clipboard
interface ServerScope

Scope for building a GATT server.

Link copied to clipboard
sealed interface Service<C : Characteristic<*>>

Interface representing a Bluetooth GATT service.

Link copied to clipboard
interface ServiceScope

Scope of a GATT service.

Link copied to clipboard

Recommended TX power levels for transmission power of the advertising packet.

Link copied to clipboard

Defines available Bluetooth LE write types.

Properties

Link copied to clipboard
const val ATT_MTU_DEFAULT: Int = 23

The default ATT MTU size.

Link copied to clipboard
const val ATT_MTU_MAX: Int = 517

The maximum ATT MTU size.

Link copied to clipboard

Returns the default write type for the given list of properties.

Link copied to clipboard

Returns the value of the flags as a bitfield.

Functions

Link copied to clipboard
Link copied to clipboard

Parses the AD type value as flags.