GattClientScope

Kotlin |Java

public interface GattClientScope

Scope for operations as a GATT client role.

See also
`connectGatt`

Summary

Public methods
`abstract GattService`	`getService(@NonNull UUID uuid)` Gets the service of the remote device by UUID.
`default @NonNull List<@NonNull GattService>`	`getServices()` GATT services recently discovered from the remote device.
`abstract @NonNull StateFlow<@NonNull List<@NonNull GattService>>`	`getServicesFlow()` A flow of GATT services discovered from the remote device.
`abstract @NonNull Result<@NonNull byte[]>`	`readCharacteristic(@NonNull GattCharacteristic characteristic)` Reads the characteristic value from the server.
`abstract @NonNull Flow<@NonNull byte[]>`	`subscribeToCharacteristic(@NonNull GattCharacteristic characteristic)` Returns a cold `Flow` that contains the indicated value of the given characteristic.
`abstract @NonNull Result<Unit>`	`writeCharacteristic( @NonNull GattCharacteristic characteristic, @NonNull byte[] value )` Writes the characteristic value to the server.

abstract GattService getService(@NonNull UUID uuid)

Gets the service of the remote device by UUID.

If multiple instances of the same service exist, the first instance of the services is returned.

default @NonNull List<@NonNull GattService> getServices()

GATT services recently discovered from the remote device.

Note that this can be changed, subscribe to servicesFlow to get notified of services changes.

abstract @NonNull StateFlow<@NonNull List<@NonNull GattService>> getServicesFlow()

A flow of GATT services discovered from the remote device.

If the services of the remote device has changed, the new services will be discovered and emitted automatically.

abstract @NonNull Result<@NonNull byte[]> readCharacteristic(@NonNull GattCharacteristic characteristic)

Reads the characteristic value from the server.

Parameters
`@NonNull GattCharacteristic characteristic`	a remote `GattCharacteristic` to read

Returns
`@NonNull Result<@NonNull byte[]>`	the value of the characteristic

abstract @NonNull Flow<@NonNull byte[]> subscribeToCharacteristic(@NonNull GattCharacteristic characteristic)

Returns a cold Flow that contains the indicated value of the given characteristic.

abstract @NonNull Result<Unit> writeCharacteristic(
    @NonNull GattCharacteristic characteristic,
    @NonNull byte[] value
)

Writes the characteristic value to the server.

Parameters
`@NonNull GattCharacteristic characteristic`	a remote `GattCharacteristic` to write
`@NonNull byte[] value`	a value to be written.

Returns
`@NonNull Result<Unit>`	the result of the write operation

Throws
`kotlin.IllegalArgumentException`	if the `characteristic` doesn't have the write property or the length of the `value` is greater than the maximum attribute length (512)