bluetooth/annotations/com.splendo.kaluga.bluetooth.annotations

Package-level declarations

Types

@Target(allowedTargets = [AnnotationTarget.PROPERTY])

annotation class Advertising

Marks a BluetoothService property of a Bluetooth device so that its UUID is included in the service UUIDs a generated server advertises.

AdvertisingName

@Target(allowedTargets = [AnnotationTarget.CLASS])

annotation class AdvertisingName(val name: String)

The local name a generated server advertises for a Bluetooth device.

Bluetooth

@Target(allowedTargets = [AnnotationTarget.CLASS])

annotation class Bluetooth

Marks a class as the definition of a Bluetooth device. The com.splendo.kaluga.bluetooth.plugin generates a typed client and/or server (and their Bluetooth and Simulated implementations) from it, derived from the BluetoothService properties the class exposes.

BluetoothCharacteristic

@Target(allowedTargets = [AnnotationTarget.CLASS])

annotation class BluetoothCharacteristic(val uuid: String)

Marks a class as a GATT characteristic of a BluetoothService. Its properties, annotated with access markers such as Readable, Writable, Notifiable or Indicatable, define the characteristic's value(s) and how they may be accessed.

BluetoothClientName

@Target(allowedTargets = [AnnotationTarget.CLASS])

annotation class BluetoothClientName(val name: String)

Overrides the simple name of the client type generated for a Bluetooth device. Defaults to <DeviceName>Client.

BluetoothDescriptor

@Target(allowedTargets = [AnnotationTarget.CLASS])

annotation class BluetoothDescriptor(val uuid: String)

Marks a class as a GATT descriptor of a BluetoothCharacteristic. Like a characteristic, its properties define the descriptor's value(s) and access.

BluetoothServerName

@Target(allowedTargets = [AnnotationTarget.CLASS])

annotation class BluetoothServerName(val name: String)

Overrides the simple name of the server type generated for a Bluetooth device. Defaults to <DeviceName>Server.

BluetoothService

@Target(allowedTargets = [AnnotationTarget.CLASS])

annotation class BluetoothService(val uuid: String)

Marks a class as a GATT service of a Bluetooth device. The BluetoothCharacteristic properties it exposes define the service's characteristics.

Encrypted

@Target(allowedTargets = [AnnotationTarget.PROPERTY])

annotation class Encrypted

Marks a characteristic or descriptor property as requiring an encrypted (bonded) connection to access.

Indicatable

@Target(allowedTargets = [AnnotationTarget.PROPERTY])

annotation class Indicatable

Marks a characteristic property as indicatable: like Notifiable, but each pushed value change is acknowledged by the client.

Notifiable

@Target(allowedTargets = [AnnotationTarget.PROPERTY])

annotation class Notifiable

Marks a characteristic property as notifiable: the server can push value changes to subscribed clients without acknowledgement, and the client can observe them.

Readable

@Target(allowedTargets = [AnnotationTarget.PROPERTY])

annotation class Readable

Marks a characteristic or descriptor property as readable, generating a GATT read for it.

Writable

@Target(allowedTargets = [AnnotationTarget.PROPERTY])

annotation class Writable

Marks a characteristic or descriptor property as writable with a response, generating a GATT write for it.

WritableSigned

@Target(allowedTargets = [AnnotationTarget.PROPERTY])

annotation class WritableSigned

Marks a characteristic or descriptor property as writable with an authenticated signed write.

WritableWithoutResponse

@Target(allowedTargets = [AnnotationTarget.PROPERTY])

annotation class WritableWithoutResponse

Marks a characteristic or descriptor property as writable without a response, generating a GATT write-without-response for it.