client-core-android/no.nordicsemi.kotlin.ble.client.android/Peripheral

Peripheral

open class Peripheral(scope: CoroutineScope, impl: Peripheral.Executor) : Peripheral<String, Peripheral.Executor>

Android-specific implementation of a peripheral.

This class extends Peripheral and adds Android-specific methods.

Parameters

scope

scope The coroutine scope.

impl

The executor that provides methods to interact with the peripheral.

Inheritors

PreviewPeripheral

Constructors

Peripheral

constructor(scope: CoroutineScope, impl: Peripheral.Executor)

Types

Executor

interface Executor : Peripheral.Executor<String>

An interface that provides methods to interact with the peripheral.

Properties

address

val address: String

MAC address of the peripheral as String, alias for Peripheral.identifier.

bondState

val bondState: StateFlow<BondState>

Returns the current bond state as StateFlow.

connectionParameters

val connectionParameters: StateFlow<ConnectionParameters?>

The current connection parameters as StateFlow.

hasBondInformation

val hasBondInformation: Boolean

Returns whether the system has bond information associated with this peripheral.

identifier

open override val identifier: String

isConnected

val isConnected: Boolean

isDisconnected

val isDisconnected: Boolean

name

val name: String?

phy

val phy: StateFlow<PhyInUse?>

The current PHY in use for transmitting and receiving data.

state

val state: StateFlow<ConnectionState>

type

val type: PeripheralType

The Bluetooth device type of the remote device.

Functions

abortReliableWrite

suspend fun abortReliableWrite()

Aborts the reliable write transaction started using beginReliableWrite.

beginReliableWrite

fun beginReliableWrite()

Initiates a reliable write transaction.

createBond

suspend fun createBond()

Initiates bonding with the peripheral.

disconnect

suspend fun disconnect()

equals

open operator override fun equals(other: Any?): Boolean

executeReliableWrite

suspend fun executeReliableWrite()

Executes all write with response operations queued since beginReliableWrite was called.

hashCode

open override fun hashCode(): Int

maximumWriteValueLength

open override fun maximumWriteValueLength(type: WriteType): Int

The maximum amount of data, in bytes, that can be send to a characteristic in a single write operation.

readPhy

suspend fun readPhy(): PhyInUse

Read the current transmitter PHY and receiver PHY of the connection.

readRssi

suspend fun readRssi(): Int

refreshCache

suspend fun refreshCache()

Refreshes the cached GATT database associated with the peripheral and starts new service discovery automatically.

removeBond

suspend fun removeBond()

Removes the bond information associated with the peripheral.

requestConnectionPriority

suspend fun requestConnectionPriority(priority: ConnectionPriority): ConnectionParameters

Requests new connection parameters.

requestHighestValueLength

suspend fun requestHighestValueLength()

Requests the highest possible MTU (517).

services

fun services(uuids: List<Uuid>): StateFlow<List<RemoteService>?>

setPreferredPhy

suspend fun setPreferredPhy(txPhy: Phy, rxPhy: Phy = txPhy, phyOptions: PhyOption = PhyOption.NO_PREFERRED): PhyInUse

Set the preferred connection PHY.

toString

open override fun toString(): String