com.tapkey.mobile.model

Class BleLock

java.lang.Object

com.tapkey.mobile.model.BleLock

All Implemented Interfaces:

Serializable

public class BleLock
extends Object
implements Serializable

A nearby Tapkey lock discovered via Bluetooth. Do not instantiate but use BleLockScanner to get nearby Tapkey locks.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
BleLock(byte[] incompleteLockId, boolean isLockIdComplete, String bluetoothAddress, Date lastSeen, int rssi)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
String	getBluetoothAddress() Returns the lock's Bluetooth address.
byte[]	getIncompleteLockId() The lock ID.
Date	getLastSeen() Returns at what time the lock was last seen nearby.
int	getRssi() Returns the RSSI of the lock when it was last seen.
int	hashCode()
boolean	isLockIdComplete() Returns whether the lock ID is complete or not.

Methods inherited from class java.lang.Object

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

Constructor Detail

BleLock

public BleLock(byte[] incompleteLockId,
               boolean isLockIdComplete,
               String bluetoothAddress,
               Date lastSeen,
               int rssi)

Method Detail

getIncompleteLockId

public byte[] getIncompleteLockId()

The lock ID. Use isLockIdComplete() to determine if the lock ID is complete or truncated. The lock ID has the following format:

LLX

• LL: The length of the actual ID (X), encoded in 2 bytes, little endian.
• X: The actual ID.

The following, exemplary lock ID has two bytes of length header and four bytes of ID payload:

04001234BFFB

In case the ID is not complete, it is truncated from the start. Given the exemplary six-byte ID above, if the BLE advertising can only fit five bytes of ID, this method will return

001234BFFB

instead. Note, that it is not possible to determine whether the leading 00 is part of the actual ID or a length header.

Returns:

the lock ID.

See Also:

https://developers.tapkey.io/mobile/concepts/lock_ids/

isLockIdComplete

public boolean isLockIdComplete()

Returns whether the lock ID is complete or not. The actual lock ID can be retrieved using getIncompleteLockId(). Due to limited BLE advertising packet length, lock IDs that exceed a certain length may arrive truncated. This method can be used to determine if the lock ID is complete or not.

Returns:

true if the lock ID is complete, false if not.

See Also:

https://developers.tapkey.io/mobile/concepts/lock_ids/

getBluetoothAddress

public String getBluetoothAddress()

Returns the lock's Bluetooth address.

Returns:

the lock's 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".

getLastSeen

public Date getLastSeen()

Returns at what time the lock was last seen nearby.

Returns:

the time the lock was last seen.

getRssi

public int getRssi()

Returns the RSSI of the lock when it was last seen.

Returns:

the RSSI of the lock. In dBm. The valid range is [-127, 126].

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object