TKMBleLockScanner

The BLE (Bluetooth Low Energy) lock scanner provides means to scan for Tapkey locks via BLE. It can be used to scan for nearby locks and to determine whether a specific lock is nearby.

Use TKMServiceFactory to retrieve an instance of BleLockScanner.

  • Returns an Observable of a list of nearby locks along with their Bluetooth address. The observable will fire every time a new lock is discovered or a lock disappeared.

    The observable returns a Map of BleLocks with their Bluetooth addresses as keys. The Bluetooth address is a 48-bit identifier represented as a String of 6 bytes in hexadecimal separated by colons. For example, “00:11:22:AA:BB:CC”

  • Returns a map of nearby locks along with their Bluetooth address. The Bluetooth address is a 48-bit identifier represented as a String of 6 bytes in hexadecimal separated by colons. For example, “00:11:22:AA:BB:CC”. The lock is returned as an object of TKMBleLock.

    See also

    TKMBleLock
  • Starts scanning for nearby Tapkey locks. Results can be retrieved using TKMBleLockScanner.locks and TKMBleLockScanner.observable.

  • Returns the BLE lock representation of the lock with the specified lock ID. If multiple Bluetooth devices advertise the same lock id then the one with the greatest RSSI value will be returned.

    The physicalLockID parameter takes a base64-encoded representation of the lock’s physical lock ID.

  • Returns a list of BLE locks advertising the specified lock id. If multiple locks nearby advertise the specified lock id, then all of these locks will be returned and ordered by their RSSI value in descending order. I.e. the device with the greatest value representing the device with the strongest signal will come first.

  • Returns whether the Tapkey lock with the specified physical lock ID is nearby.

    The physicalLockID parameter takes a base64-encoded representation of the lock’s physical lock ID.

  • Same as TKMBleLockScanner.isLockNearby(physicalLockId:), but with configurable RSSI threshold. If the specified lock is discovered with an RSSI below rssiThreshold, it will not be reported as nearby. This method can be used to filter out locks with weak signal strength.