All Implemented Interfaces:
```
public abstract class BleDeviceSession

                    
```
Bluetooth le device class, contains all essential api's for sufficient usage of bluetooth le device

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public enum`	`BleDeviceSession.DisconnectReason`
`public enum`	`BleDeviceSession.DeviceCommand`	Device-control command that a DEVICE_COMMAND disconnect is expected to follow.
`public enum`	`BleDeviceSession.DeviceSessionState`	Connection state

Field Summary

Fields
Modifier and Type	Field	Description
`private final BleDeviceSession.DisconnectReason`	`disconnectReason`
`private final Integer`	`disconnectStatus`
`private final Boolean`	`isIntentionalDisconnect`
`private final Long`	`deviceCommandDisconnectDeadlineMs`
`private final BleDeviceSession.DeviceCommand`	`pendingDeviceCommand`
`private final Boolean`	`wasBondedAtConnection`
`private final Boolean`	`hasEstablishedBond`
`private final Integer`	`securityRecoveryAttempts`
`private final Boolean`	`securityRecoveryExhausted`
`private BleDeviceSession.DeviceSessionState`	`sessionState`
`private final BleDeviceSession.DeviceSessionState`	`previousState`
`private BleAdvertisementContent`	`advertisementContent`
`private final BleAdvertisementContent`	`getAdvertisementContent`
`private List<String>`	`connectionUuids`
`private final Boolean`	`isNonConnectableAdvertisement`
`private final Boolean`	`isConnectableAdvertisement`
`private final String`	`address`
`private final Boolean`	`isAuthenticated`
`private final BluetoothDevice`	`bluetoothDevice`
`private final String`	`name`
`private final String`	`polarDeviceId`
`private final String`	`polarDeviceType`
`private final Long`	`polarDeviceIdInt`
`private final Integer`	`medianRssi`
`private final Integer`	`rssi`
`private final BlePolarHrAdvertisement`	`blePolarHrAdvertisement`

Constructor Summary

Constructors
Constructor	Description

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final BleDeviceSession.DisconnectReason`	`getDisconnectReason()`
`final Integer`	`getDisconnectStatus()`
`final Boolean`	`isIntentionalDisconnect()`
`final Long`	`getDeviceCommandDisconnectDeadlineMs()`
`final BleDeviceSession.DeviceCommand`	`getPendingDeviceCommand()`
`final Boolean`	`getWasBondedAtConnection()`
`final Boolean`	`getHasEstablishedBond()`
`final Integer`	`getSecurityRecoveryAttempts()`
`final Boolean`	`getSecurityRecoveryExhausted()`
`final BleDeviceSession.DeviceSessionState`	`getSessionState()`	Members
`final Unit`	`setSessionState(BleDeviceSession.DeviceSessionState sessionState)`	Members
`final BleDeviceSession.DeviceSessionState`	`getPreviousState()`
`final BleAdvertisementContent`	`getAdvertisementContent()`
`final Unit`	`setAdvertisementContent(BleAdvertisementContent advertisementContent)`
`final BleAdvertisementContent`	`getGetAdvertisementContent()`
`final List<String>`	`getConnectionUuids()`
`final Unit`	`setConnectionUuids(List<String> connectionUuids)`
`abstract Boolean`	`isNonConnectableAdvertisement()`
`final Boolean`	`isConnectableAdvertisement()`
`abstract String`	`getAddress()`
`abstract Boolean`	`isAuthenticated()`
`abstract BluetoothDevice`	`getBluetoothDevice()`
`final String`	`getName()`
`final String`	`getPolarDeviceId()`
`String`	`getPolarDeviceType()`
`final Long`	`getPolarDeviceIdInt()`
`final Integer`	`getMedianRssi()`
`final Integer`	`getRssi()`
`final BlePolarHrAdvertisement`	`getBlePolarHrAdvertisement()`
`final Unit`	`markBondedAtConnection(Boolean bonded)`
`final Boolean`	`recordSecurityRecoveryAttempt(Integer maxAttempts)`
`final Unit`	`markDisconnect(BleDeviceSession.DisconnectReason reason, Integer status)`
`final Unit`	`markIntentionalDisconnect()`
`final Unit`	`markExpectedDeviceCommandDisconnect(BleDeviceSession.DeviceCommand command, Long validForMs)`	Call right after a device-control command's success path (e.g.
`final Boolean`	`isExpectedDeviceCommandDisconnectStillValid()`
`final Unit`	`clearDisconnectReason()`
`final Boolean`	`isDeviceAlive(Long time, TimeUnit timeUnit)`
`final Boolean`	`isAdvertising(Long time, TimeUnit timeUnit)`
`abstract Unit`	`authenticate()`	start pairing and optionally bonding procedure with the device
`abstract Deferred<List<UUID>>`	`monitorServicesDiscovered(Boolean checkConnection)`	Monitor services discovered
`abstract Boolean`	`clearGattCache()`
`abstract Deferred<Integer>`	`readRssiValue()`
`abstract Pair<Boolean, Integer>`	`getIndicatesPairingProblem()`	Checks if session indicates pairing problem.
`final BleGattBase`	`fetchClient(UUID uuid)`
`final Unit`	`clientsReady(Boolean checkConnection)`	Helper to combine all available/desired clients ready.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
- Method Detail
 - getDisconnectReason
```
 final BleDeviceSession.DisconnectReason getDisconnectReason()
```
 - getDisconnectStatus
```
 final Integer getDisconnectStatus()
```
 - isIntentionalDisconnect
```
 final Boolean isIntentionalDisconnect()
```
 - getDeviceCommandDisconnectDeadlineMs
```
 final Long getDeviceCommandDisconnectDeadlineMs()
```
 - getPendingDeviceCommand
```
 final BleDeviceSession.DeviceCommand getPendingDeviceCommand()
```
 - getWasBondedAtConnection
```
 final Boolean getWasBondedAtConnection()
```
 - getHasEstablishedBond
```
 final Boolean getHasEstablishedBond()
```
 - getSecurityRecoveryAttempts
```
 final Integer getSecurityRecoveryAttempts()
```
 - getSecurityRecoveryExhausted
```
 final Boolean getSecurityRecoveryExhausted()
```
 - getSessionState
```
 final BleDeviceSession.DeviceSessionState getSessionState()
```
 Members
 - setSessionState
```
 final Unit setSessionState(BleDeviceSession.DeviceSessionState sessionState)
```
 Members
 - getPreviousState
```
 final BleDeviceSession.DeviceSessionState getPreviousState()
```
 Returns:
 
 state before current one
 - getAdvertisementContent
```
 final BleAdvertisementContent getAdvertisementContent()
```
 - setAdvertisementContent
```
 final Unit setAdvertisementContent(BleAdvertisementContent advertisementContent)
```
 - getGetAdvertisementContent
```
 final BleAdvertisementContent getGetAdvertisementContent()
```
 - getConnectionUuids
```
 final List<String> getConnectionUuids()
```
 Returns:
 
 current connection uuid's needed for connection attempt
 - setConnectionUuids
```
 final Unit setConnectionUuids(List<String> connectionUuids)
```
 Parameters:
 
 connectionUuids - set connection uuid's
 - isNonConnectableAdvertisement
```
 abstract Boolean isNonConnectableAdvertisement()
```
 Returns:
 
 true if device is in non-connectable advertisement Notes: Depending on Android API version,it's impossible to know this. So this would work only for Polar Devices that follows Polar BLE Advertising data spec
 - isConnectableAdvertisement
```
 final Boolean isConnectableAdvertisement()
```
 Returns:
 
 true if device is connectable advertisement Notes: Depending on Android API version,it's impossible to know this. So this would work only for Polar Devices that follows Polar BLE Advertising data spec
 - getAddress
```
 abstract String getAddress()
```
 Returns:
 
 bluetooth device address in string format
 - isAuthenticated
```
 abstract Boolean isAuthenticated()
```
 Returns:
 
 true if session is bonded device
 - getBluetoothDevice
```
 abstract BluetoothDevice getBluetoothDevice()
```
 Returns:
 
 android bluetooth device instance
 - getName
```
 final String getName()
```
 - getPolarDeviceId
```
 final String getPolarDeviceId()
```
 Returns:
 
 polar device id
 - getPolarDeviceType
```
 String getPolarDeviceType()
```
 Returns:
 
 polar device type
 - getPolarDeviceIdInt
```
 final Long getPolarDeviceIdInt()
```
 Returns:
 
 polar device id in int
 - getMedianRssi
```
 final Integer getMedianRssi()
```
 Returns:
 
 current median rssi value
 - getRssi
```
 final Integer getRssi()
```
 Returns:
 
 instant rssi value
 - getBlePolarHrAdvertisement
```
 final BlePolarHrAdvertisement getBlePolarHrAdvertisement()
```
 Returns:
 
 polar hr advertisement content @see BlePolarHrAdvertisement
 - markBondedAtConnection
```
 final Unit markBondedAtConnection(Boolean bonded)
```
 - recordSecurityRecoveryAttempt
```
 final Boolean recordSecurityRecoveryAttempt(Integer maxAttempts)
```
 - markDisconnect
```
 final Unit markDisconnect(BleDeviceSession.DisconnectReason reason, Integer status)
```
 - markIntentionalDisconnect
```
 final Unit markIntentionalDisconnect()
```
 - markExpectedDeviceCommandDisconnect
```
 final Unit markExpectedDeviceCommandDisconnect(BleDeviceSession.DeviceCommand command, Long validForMs)
```
 Call right after a device-control command's success path (e.g. GATT write acked) to mark the disconnect that is expected to follow as non-actionable.
 - isExpectedDeviceCommandDisconnectStillValid
```
 final Boolean isExpectedDeviceCommandDisconnectStillValid()
```
 - clearDisconnectReason
```
 final Unit clearDisconnectReason()
```
 - isDeviceAlive
```
 final Boolean isDeviceAlive(Long time, TimeUnit timeUnit)
```
 Parameters:
 
 time - max time for the last advertisement event
 
 timeUnit - desired timeunit
 
 Returns:
 
 true, device is still somewhat considered "alive"
 - isAdvertising
```
 final Boolean isAdvertising(Long time, TimeUnit timeUnit)
```
 Parameters:
 
 time - max time for the last advertisement event
 
 timeUnit - desired timeunit
 
 Returns:
 
 true if device is advertising in the required timespan
 - authenticate
```
 abstract Unit authenticate()
```
 start pairing and optionally bonding procedure with the device
 
 Returns:
 
 Either produces complete for already bonded device or starts pairing/bonding procedure or onError on failure case
 - monitorServicesDiscovered
```
 abstract Deferred<List<UUID>> monitorServicesDiscovered(Boolean checkConnection)
```
 Monitor services discovered
 
 Returns:
 
 Deferred result
 - clearGattCache
```
 abstract Boolean clearGattCache()
```
 Returns:
 
 true if current gatt cache clear was ok
 - readRssiValue
```
 abstract Deferred<Integer> readRssiValue()
```
 Returns:
 
 Deferred result for rssi values
 - getIndicatesPairingProblem
```
 abstract Pair<Boolean, Integer> getIndicatesPairingProblem()
```
 Checks if session indicates pairing problem. This is a helper method to check if the session is in a state where pairing problems are likely, for example due to failed authentication attempts or other issues that may arise during the pairing process.
 
 Returns:
 
 Boolean indicating if the session indicates a pairing problem. True if there are indications of a pairing problem, false otherwise. Int value contains Bluetooth error code if there is a pairing problem, otherwise it is -1 (not set).
 - fetchClient
```
 final BleGattBase fetchClient(UUID uuid)
```
 Parameters:
 
 uuid - service uuid
 
 Returns:
 
 get a specific client from the list
 - clientsReady
```
 final Unit clientsReady(Boolean checkConnection)
```
 Helper to combine all available/desired clients ready.
 
 Parameters:
 
 checkConnection - check initial connection

Class BleDeviceSession

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Method Detail

getDisconnectReason

getDisconnectStatus

isIntentionalDisconnect

getDeviceCommandDisconnectDeadlineMs

getPendingDeviceCommand

getWasBondedAtConnection

getHasEstablishedBond

getSecurityRecoveryAttempts

getSecurityRecoveryExhausted

getSessionState

setSessionState

getPreviousState

getAdvertisementContent

setAdvertisementContent

getGetAdvertisementContent

getConnectionUuids

setConnectionUuids

isNonConnectableAdvertisement

isConnectableAdvertisement

getAddress

isAuthenticated

getBluetoothDevice

getName

getPolarDeviceId

getPolarDeviceType

getPolarDeviceIdInt

getMedianRssi

getRssi

getBlePolarHrAdvertisement

markBondedAtConnection

recordSecurityRecoveryAttempt

markDisconnect

markIntentionalDisconnect

markExpectedDeviceCommandDisconnect

isExpectedDeviceCommandDisconnectStillValid

clearDisconnectReason

isDeviceAlive

isAdvertising

authenticate

monitorServicesDiscovered

clearGattCache

readRssiValue

getIndicatesPairingProblem

fetchClient

clientsReady