com.kontakt.sdk.android.ble.connection

Class KontaktDeviceServiceStore

java.lang.Object

com.kontakt.sdk.android.ble.connection.KontaktDeviceServiceStore

public class KontaktDeviceServiceStore
extends java.lang.Object

Acts as a container of characteristics requested before authorization.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	KontaktDeviceServiceStore.StoreType Type of store KontaktDeviceServiceStore.StoreType.NORMAL if beacon firmware revision is lower than 4.0 KontaktDeviceServiceStore.StoreType.SECURE if beacon firmware revision is 4.0 and greater

Constructor Summary

Constructors

Constructor and Description
KontaktDeviceServiceStore(java.util.List<android.bluetooth.BluetoothGattService> gattServices, KontaktDeviceServiceStore.StoreType storeType) Instantiates a new Service store.

Method Summary

Modifier and Type	Method and Description
void	clear() Clears cache
boolean	contains(KontaktDeviceService service) Checks if KontaktDeviceService was found during service discovery
BluetoothDeviceCharacteristic	getAccelerometerCharacteristic() Provides accelerometer wrapper.
BluetoothDeviceCharacteristic	getActiveProfileCharacteristic() Gets active profile wrapper.
BluetoothDeviceCharacteristic	getAdvertisingIntervalCharacteristic() Gets advertising interval wrapper.
BluetoothDeviceCharacteristic	getBatteryLevelCharacteristic() Gets battery level wrapper.
BluetoothDeviceCharacteristic	getBootloaderCharacteristic() Gets bootloader wrapper.
BluetoothDeviceCharacteristic	getDefaultSettingsCharacteristic() Gets default settings wrapper.
BluetoothDeviceCharacteristic	getDeviceNameCharacteristic() Gets device name wrapper.
BluetoothDeviceCharacteristic	getFirmwareRevisionCharacteristic() Gets firmware revision wrapper.
BluetoothDeviceCharacteristic	getHardwareRevisionCharacteristic() Gets hardware revision wrapper.
BluetoothDeviceCharacteristic	getInstanceIdCharacteristic() Provides instance id wrapper.
BluetoothDeviceCharacteristic	getMajorCharacteristic() Gets major wrapper.
BluetoothDeviceCharacteristic	getManufacturerNameCharacteristic() Gets manufacturer name wrapper.
BluetoothDeviceCharacteristic	getMasterPasswordCharacteristic() Provides master password wrapper.
BluetoothDeviceCharacteristic	getMinorCharacteristic() Gets minor wrapper.
BluetoothDeviceCharacteristic	getNamespaceIdCharacteristic() Provides namespace id wrapper.
BluetoothDeviceCharacteristic	getNonConnectableCharacteristic() Gets non connectable wrapper.
BluetoothDeviceCharacteristic	getPasswordCharacteristic() Gets password wrapper.
BluetoothDeviceCharacteristic	getPowerLevelCharacteristic() Gets power level wrapper.
BluetoothDeviceCharacteristic	getPropagatedDeviceNameCharacteristic() Gets propagated device name wrapper.
BluetoothDeviceCharacteristic	getProximityCharacteristic() Gets proximity wrapper.
java.util.Collection<BluetoothDeviceCharacteristic>	getReadableCharacteristics() Gets all readable characteristic found during service discovery
BluetoothDeviceCharacteristic	getResetCharacteristic() Gets reset wrapper.
BluetoothDeviceCharacteristic	getSecureControlPointCharacteristic() Gets secure control point wrapper
BluetoothDeviceCharacteristic	getSecureLastProcessedRequestTokenCharacteristic() Gets last processed requet token wrapper
BluetoothDeviceCharacteristic	getSecureResponseCharacteristic() Gets secure write response wrapper
BluetoothDeviceCharacteristic	getSecureWriteCharacteristic() Gets secure write wrapper
BluetoothDeviceCharacteristic	getSensorOnCharacteristic() Provides sensor on wrapper.
BluetoothDeviceCharacteristic	getSetNewPasswordCharacteristic() Gets set new password wrapper.
BluetoothDeviceCharacteristic	getShuffleIntervalCharacteristic() Provides shuffle interval wrapper.
BluetoothDeviceCharacteristic	getShuffleKeyCharacteristic() Provides shuffle key wrapper.
KontaktDeviceServiceStore.StoreType	getStoreType() Gets type of store
BluetoothDeviceCharacteristic	getUniqueIdCharacteristic() Provides unique id wrapper.
BluetoothDeviceCharacteristic	getUrlCharacteristic() Provides url wrapper.
void	replace(BluetoothDeviceCharacteristic characteristicWrapper) Replaces provided characteristic in cache

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

KontaktDeviceServiceStore

public KontaktDeviceServiceStore(java.util.List<android.bluetooth.BluetoothGattService> gattServices,
                                 KontaktDeviceServiceStore.StoreType storeType)
                          throws android.os.RemoteException

Instantiates a new Service store. If services sent are not compatible with the ones propagated by kontakt.io beacons(services list does not contain all required services: Service 1, Service 2, Service 3, Service 4, Service 5, Service 6, Service 7) then the RemoteException (informing that the beacon is not a property of kontakt.io) is thrown.

Parameters:

gattServices - beacon services list

storeType - store type

Throws:

android.os.RemoteException - the remote exception thrown if services list does not match the specification of kontakt.io beacon

Method Detail

getFirmwareRevisionCharacteristic

public BluetoothDeviceCharacteristic getFirmwareRevisionCharacteristic()
                                                                throws ServiceAbsentException,
                                                                       CharacteristicAbsentException

Gets firmware revision wrapper.

Returns:

BluetoothDeviceCharacteristic characteristic wrapper

Throws:

ServiceAbsentException - if service not found

CharacteristicAbsentException - if characteristic not found

getHardwareRevisionCharacteristic

public BluetoothDeviceCharacteristic getHardwareRevisionCharacteristic()
                                                                throws ServiceAbsentException,
                                                                       CharacteristicAbsentException

Gets hardware revision wrapper.

Returns:

BluetoothDeviceCharacteristic characteristic wrapper

Throws:

ServiceAbsentException - if service not found

CharacteristicAbsentException - if characteristic not found

getManufacturerNameCharacteristic

public BluetoothDeviceCharacteristic getManufacturerNameCharacteristic()
                                                                throws ServiceAbsentException,
                                                                       CharacteristicAbsentException

Gets manufacturer name wrapper.

Returns:

BluetoothDeviceCharacteristic characteristic wrapper

Throws:

ServiceAbsentException - if service not found

CharacteristicAbsentException - if characteristic not found

getDeviceNameCharacteristic

public BluetoothDeviceCharacteristic getDeviceNameCharacteristic()
                                                          throws ServiceAbsentException,
                                                                 CharacteristicAbsentException

Gets device name wrapper.

Returns:

BluetoothDeviceCharacteristic characteristic wrapper

Throws:

ServiceAbsentException - if service not found

CharacteristicAbsentException - if characteristic not found

getPropagatedDeviceNameCharacteristic

public BluetoothDeviceCharacteristic getPropagatedDeviceNameCharacteristic()
                                                                    throws ServiceAbsentException,
                                                                           CharacteristicAbsentException

Gets propagated device name wrapper.

Returns:

BluetoothDeviceCharacteristic characteristic wrapper

Throws:

ServiceAbsentException - if service not found

CharacteristicAbsentException - if characteristic not found

getMinorCharacteristic

public BluetoothDeviceCharacteristic getMinorCharacteristic()
                                                     throws ServiceAbsentException,
                                                            CharacteristicAbsentException

Gets minor wrapper.

Returns:

BluetoothDeviceCharacteristic characteristic wrapper

Throws:

ServiceAbsentException - if service not found

CharacteristicAbsentException - if characteristic not found

getNonConnectableCharacteristic

public BluetoothDeviceCharacteristic getNonConnectableCharacteristic()
                                                              throws ServiceAbsentException,
                                                                     CharacteristicAbsentException

Gets non connectable wrapper. The Non-connectable characteristic was added with "2.6" firmware. If beacon has lower firmware, then it returns null.

Returns:

BluetoothDeviceCharacteristic characteristic wrapper

Throws:

ServiceAbsentException - if service not found

CharacteristicAbsentException - if characteristic not found

getShuffleIntervalCharacteristic

public BluetoothDeviceCharacteristic getShuffleIntervalCharacteristic()
                                                               throws ServiceAbsentException,
                                                                      CharacteristicAbsentException

Provides shuffle interval wrapper.

Returns:

BluetoothDeviceCharacteristic characteristic wrapper

Throws:

ServiceAbsentException - if service not found

CharacteristicAbsentException - if characteristic not found

getShuffleKeyCharacteristic

public BluetoothDeviceCharacteristic getShuffleKeyCharacteristic()
                                                          throws ServiceAbsentException,
                                                                 CharacteristicAbsentException

Provides shuffle key wrapper.

Returns:

BluetoothDeviceCharacteristic characteristic wrapper

Throws:

ServiceAbsentException - if service not found

CharacteristicAbsentException - if characteristic not found

getSensorOnCharacteristic

public BluetoothDeviceCharacteristic getSensorOnCharacteristic()
                                                        throws ServiceAbsentException,
                                                               CharacteristicAbsentException

Provides sensor on wrapper.

Returns:

BluetoothDeviceCharacteristic characteristic wrapper

Throws:

ServiceAbsentException - if service not found

CharacteristicAbsentException - if characteristic not found

getAccelerometerCharacteristic

public BluetoothDeviceCharacteristic getAccelerometerCharacteristic()
                                                             throws ServiceAbsentException,
                                                                    CharacteristicAbsentException

Provides accelerometer wrapper.

Returns:

BluetoothDeviceCharacteristic characteristic wrapper

Throws:

ServiceAbsentException - if service not found

CharacteristicAbsentException - if characteristic not found

getActiveProfileCharacteristic

public BluetoothDeviceCharacteristic getActiveProfileCharacteristic()
                                                             throws ServiceAbsentException,
                                                                    CharacteristicAbsentException

Gets active profile wrapper. The active profile characteristic wrapper. The wrapper was added in "3.0" firmware version. If beacon has lower firmware, then null is returned.

Returns:

BluetoothDeviceCharacteristic characteristic wrapper

Throws:

ServiceAbsentException - if service not found

CharacteristicAbsentException - if characteristic not found

getMajorCharacteristic

public BluetoothDeviceCharacteristic getMajorCharacteristic()
                                                     throws ServiceAbsentException,
                                                            CharacteristicAbsentException

Gets major wrapper.

Returns:

BluetoothDeviceCharacteristic characteristic wrapper

Throws:

ServiceAbsentException - if service not found

CharacteristicAbsentException - if characteristic not found

getProximityCharacteristic

public BluetoothDeviceCharacteristic getProximityCharacteristic()
                                                         throws ServiceAbsentException,
                                                                CharacteristicAbsentException

Gets proximity wrapper.

Returns:

BluetoothDeviceCharacteristic characteristic wrapper

Throws:

ServiceAbsentException - if service not found

CharacteristicAbsentException - if characteristic not found

getPowerLevelCharacteristic

public BluetoothDeviceCharacteristic getPowerLevelCharacteristic()
                                                          throws ServiceAbsentException,
                                                                 CharacteristicAbsentException

Gets power level wrapper.

Returns:

BluetoothDeviceCharacteristic characteristic wrapper

Throws:

ServiceAbsentException - if service not found

CharacteristicAbsentException - if characteristic not found

getBatteryLevelCharacteristic

public BluetoothDeviceCharacteristic getBatteryLevelCharacteristic()
                                                            throws ServiceAbsentException,
                                                                   CharacteristicAbsentException

Gets battery level wrapper.

Returns:

BluetoothDeviceCharacteristic characteristic wrapper

Throws:

ServiceAbsentException - if service not found

CharacteristicAbsentException - if characteristic not found

getPasswordCharacteristic

public BluetoothDeviceCharacteristic getPasswordCharacteristic()
                                                        throws ServiceAbsentException,
                                                               CharacteristicAbsentException

Gets password wrapper.

Returns:

BluetoothDeviceCharacteristic characteristic wrapper

Throws:

ServiceAbsentException - if service not found

CharacteristicAbsentException - if characteristic not found

getMasterPasswordCharacteristic

public BluetoothDeviceCharacteristic getMasterPasswordCharacteristic()
                                                              throws ServiceAbsentException,
                                                                     CharacteristicAbsentException

Provides master password wrapper.

Returns:

BluetoothDeviceCharacteristic characteristic wrapper

Throws:

ServiceAbsentException - if service not found

CharacteristicAbsentException - if characteristic not found

getSetNewPasswordCharacteristic

public BluetoothDeviceCharacteristic getSetNewPasswordCharacteristic()
                                                              throws ServiceAbsentException,
                                                                     CharacteristicAbsentException

Gets set new password wrapper.

Returns:

BluetoothDeviceCharacteristic characteristic wrapper

Throws:

ServiceAbsentException - if service not found

CharacteristicAbsentException - if characteristic not found

getAdvertisingIntervalCharacteristic

public BluetoothDeviceCharacteristic getAdvertisingIntervalCharacteristic()
                                                                   throws ServiceAbsentException,
                                                                          CharacteristicAbsentException

Gets advertising interval wrapper.

Returns:

BluetoothDeviceCharacteristic characteristic wrapper

Throws:

ServiceAbsentException - if service not found

CharacteristicAbsentException - if characteristic not found

getResetCharacteristic

public BluetoothDeviceCharacteristic getResetCharacteristic()
                                                     throws ServiceAbsentException,
                                                            CharacteristicAbsentException

Gets reset wrapper.

Returns:

BluetoothDeviceCharacteristic characteristic wrapper

Throws:

ServiceAbsentException - if service not found

CharacteristicAbsentException - if characteristic not found

getBootloaderCharacteristic

public BluetoothDeviceCharacteristic getBootloaderCharacteristic()
                                                          throws ServiceAbsentException,
                                                                 CharacteristicAbsentException

Gets bootloader wrapper.

Returns:

BluetoothDeviceCharacteristic characteristic wrapper

Throws:

ServiceAbsentException - if service not found

CharacteristicAbsentException - if characteristic not found

getUniqueIdCharacteristic

public BluetoothDeviceCharacteristic getUniqueIdCharacteristic()
                                                        throws ServiceAbsentException,
                                                               CharacteristicAbsentException

Provides unique id wrapper.

Returns:

BluetoothDeviceCharacteristic characteristic wrapper

Throws:

ServiceAbsentException - if service not found

CharacteristicAbsentException - if characteristic not found

getNamespaceIdCharacteristic

public BluetoothDeviceCharacteristic getNamespaceIdCharacteristic()
                                                           throws ServiceAbsentException,
                                                                  CharacteristicAbsentException

Provides namespace id wrapper.

Returns:

BluetoothDeviceCharacteristic characteristic wrapper

Throws:

ServiceAbsentException - if service not found

CharacteristicAbsentException - if characteristic not found

getInstanceIdCharacteristic

public BluetoothDeviceCharacteristic getInstanceIdCharacteristic()
                                                          throws ServiceAbsentException,
                                                                 CharacteristicAbsentException

Provides instance id wrapper.

Returns:

BluetoothDeviceCharacteristic characteristic wrapper

Throws:

ServiceAbsentException - if service not found

CharacteristicAbsentException - if characteristic not found

getUrlCharacteristic

public BluetoothDeviceCharacteristic getUrlCharacteristic()
                                                   throws ServiceAbsentException,
                                                          CharacteristicAbsentException

Provides url wrapper.

Returns:

BluetoothDeviceCharacteristic characteristic wrapper

Throws:

ServiceAbsentException - if service not found

CharacteristicAbsentException - if characteristic not found

getDefaultSettingsCharacteristic

public BluetoothDeviceCharacteristic getDefaultSettingsCharacteristic()
                                                               throws ServiceAbsentException,
                                                                      CharacteristicAbsentException

Gets default settings wrapper.

Returns:

BluetoothDeviceCharacteristic characteristic wrapper

Throws:

ServiceAbsentException - if service not found

CharacteristicAbsentException - if characteristic not found

getSecureLastProcessedRequestTokenCharacteristic

public BluetoothDeviceCharacteristic getSecureLastProcessedRequestTokenCharacteristic()
                                                                               throws ServiceAbsentException,
                                                                                      CharacteristicAbsentException

Gets last processed requet token wrapper

Characteristic added in firmware revision 4.0, on lower firmware revision throws exception

Returns:

BluetoothDeviceCharacteristic characteristic wrapper

Throws:

ServiceAbsentException - if service not found

CharacteristicAbsentException - if characteristic not found

getSecureWriteCharacteristic

public BluetoothDeviceCharacteristic getSecureWriteCharacteristic()
                                                           throws ServiceAbsentException,
                                                                  CharacteristicAbsentException

Gets secure write wrapper

Characteristic added in firmware revision 4.0, on lower firmware revision throws exception

Returns:

BluetoothDeviceCharacteristic characteristic wrapper

Throws:

ServiceAbsentException - if service not found

CharacteristicAbsentException - if characteristic not found

getSecureResponseCharacteristic

public BluetoothDeviceCharacteristic getSecureResponseCharacteristic()
                                                              throws ServiceAbsentException,
                                                                     CharacteristicAbsentException

Gets secure write response wrapper

Characteristic added in firmware revision 4.0, on lower firmware revision throws exception

Returns:

BluetoothDeviceCharacteristic characteristic wrapper

Throws:

ServiceAbsentException - if service not found

CharacteristicAbsentException - if characteristic not found

getSecureControlPointCharacteristic

public BluetoothDeviceCharacteristic getSecureControlPointCharacteristic()
                                                                  throws ServiceAbsentException,
                                                                         CharacteristicAbsentException

Gets secure control point wrapper

Characteristic added in firmware revision 4.0, on lower firmware revision throws exception

Returns:

BluetoothDeviceCharacteristic characteristic wrapper

Throws:

ServiceAbsentException - if service not found

CharacteristicAbsentException - if characteristic not found

getStoreType

public KontaktDeviceServiceStore.StoreType getStoreType()

Gets type of store

Returns:

KontaktDeviceServiceStore.StoreType

contains

public boolean contains(KontaktDeviceService service)

Checks if KontaktDeviceService was found during service discovery

Parameters:

service - model to find

Returns:

true or false

replace

public void replace(BluetoothDeviceCharacteristic characteristicWrapper)
             throws ServiceAbsentException

Replaces provided characteristic in cache

Parameters:

characteristicWrapper - new characteristic

Throws:

ServiceAbsentException - if service not found

clear

public void clear()

Clears cache

getReadableCharacteristics

public final java.util.Collection<BluetoothDeviceCharacteristic> getReadableCharacteristics()

Gets all readable characteristic found during service discovery

Returns:

Collection of readable characteristic