All Implemented Interfaces:


public final class BleBattClient
extends BleGattBase

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public class`	`BleBattClient.Companion`

Field Summary

Fields
Modifier and Type	Field	Description
`public final static UUID`	`BATTERY_SERVICE`
`public final BleGattTxInterface`	`txInterface`
`public Boolean`	`isPrimaryService`
`private final Boolean`	`isEncryptionRequired`
`private final Boolean`	`isServiceDiscovered`
`public final static BleBattClient.Companion`	`Companion`

Constructor Summary

Constructors
Constructor	Description
`BleBattClient(BleGattTxInterface txInterface)`

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`Unit`	`reset()`
`Unit`	`processServiceData(UUID characteristic, ByteArray data, Integer status, Boolean notifying)`	Callback for GATT service characteristic data processing
`Unit`	`processServiceDataWritten(UUID characteristic, Integer status)`
`final Flow<Integer>`	`monitorBatteryStatus(Boolean checkConnection)`	Get flow for monitoring battery status updates on connected device
`final Flow<ChargeState>`	`monitorChargingStatus(Boolean checkConnection)`	Get flow for monitoring charging status updates on connected device.
`final Flow<PowerSourcesState>`	`monitorPowerSourcesState(Boolean checkConnection)`	Get flow for monitoring power sources updates on connected device.
`final Integer`	`getBatteryLevel()`	Get last observed battery status on connected device Requires BLE BAS v1.
`final ChargeState`	`getChargerStatus()`	Get last observed charge status on connected device Requires BLE BAS v1.

Methods inherited from class com.polar.androidcommunications.api.ble.model.gatt.BleGattBase
addCharacteristicNotification, authenticationCompleted, authenticationFailed, clientReady, containsCharacteristic, containsCharacteristicRead, containsNotifyCharacteristic, descriptorWritten, getAvailableCharacteristics, getNotificationAtomicInteger, isAutomatic, isAutomaticRead, isEncryptionRequired, isServiceDiscovered, processCharacteristicDiscovered, processServiceDataWrittenWithResponse, removeCharacteristicNotification, serviceBelongsToClient, setMtuSize, setServiceDiscovered, waitNotificationEnabled, waitServiceDiscovered
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - BleBattClient
```
BleBattClient(BleGattTxInterface txInterface)
```
- Method Detail
  - reset
```
 Unit reset()
```
  - processServiceData
```
 Unit processServiceData(UUID characteristic, ByteArray data, Integer status, Boolean notifying)
```
    Callback for GATT service characteristic data processing
    
    Parameters:
    
    characteristic - characteristic UUID
    
    data - data in byte array
    
    status - status code of processed data
    
    notifying - if true data is notification data from GATT service
  - processServiceDataWritten
```
 Unit processServiceDataWritten(UUID characteristic, Integer status)
```
  - monitorBatteryStatus
```
 final Flow<Integer> monitorBatteryStatus(Boolean checkConnection)
```
    Get flow for monitoring battery status updates on connected device
    
    Parameters:
    
    checkConnection - false = connection is not check before observer added, true = connection is check
    
    Returns:
    
    Flow stream
  - monitorChargingStatus
```
 final Flow<ChargeState> monitorChargingStatus(Boolean checkConnection)
```
    Get flow for monitoring charging status updates on connected device. Requires BLE BAS v1.1
    
    Parameters:
    
    checkConnection - false = connection is not check before observer added, true = connection is check
    
    Returns:
    
    Flow stream emitting ChargeState
  - monitorPowerSourcesState
```
 final Flow<PowerSourcesState> monitorPowerSourcesState(Boolean checkConnection)
```
    Get flow for monitoring power sources updates on connected device. Requires BLE BAS v1.1. Exposes battery present, wired and wireless power source connected statuses.
    
    Parameters:
    
    checkConnection - false = connection is not check before observer added, true = connection is check
    
    Returns:
    
    Flow stream emitting PowerSourcesState
  - getBatteryLevel
```
 final Integer getBatteryLevel()
```
    Get last observed battery status on connected device Requires BLE BAS v1.1
    
    Returns:
    
    Returns the last known battery level as a percentage from 0% to 100% or -1 if value is not set
  - getChargerStatus
```
 final ChargeState getChargerStatus()
```
    Get last observed charge status on connected device Requires BLE BAS v1.1
    
    Returns:
    
    Returns the last known charge status as ChargeState

Class BleBattClient

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class com.polar.androidcommunications.api.ble.model.gatt.BleGattBase

Methods inherited from class java.lang.Object

Constructor Detail

BleBattClient

Method Detail

reset

processServiceData

processServiceDataWritten

monitorBatteryStatus

monitorChargingStatus

monitorPowerSourcesState

getBatteryLevel

getChargerStatus