com.estimote.sdk

Class Utils

java.lang.Object

com.estimote.sdk.Utils

public class Utils
extends java.lang.Object

Grab bag of utilities.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Utils.Proximity Defines distance relationship between beacon and the device.
static interface	Utils.RestartCompletedListener Interface used to notify called that Bluetooth stack has been restarted.

Constructor Summary

Constructors

Constructor and Description
Utils()

Method Summary

Modifier and Type	Method and Description
static Beacon	beaconFromLeScan(android.bluetooth.BluetoothDevice device, int rssi, ScanRecord scanRecord) Parses scanRecord to look for manufacturer specific data, verifies that and constructs Beacon.
static double	computeAccuracy(Beacon beacon) Returns distance in meters based on beacon's RSSI and measured transmitPower.
static double	computeAccuracy(ConfigurableDevicesScanner.ScanResultItem resultItem)
static double	computeAccuracy(Eddystone eddystone)
static double	computeAccuracy(EstimoteLocation location)
static Utils.Proximity	computeProximity(Beacon beacon)
static Utils.Proximity	computeProximity(ConfigurableDevicesScanner.ScanResultItem scanResultItem)
static Utils.Proximity	computeProximity(Eddystone eddystone)
static Utils.Proximity	computeProximity(EstimoteLocation location)
static Utils.Proximity	computeProximity(Nearable nearable)
static boolean	isBeaconInRegion(Beacon beacon, Region region) Returns true if beacon matches the region.
static java.lang.String	normalizeProximityUUID(java.lang.String proximityUUID) Normalizes location UUID by making it lowercase and in format XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX.
static int	parseInt(java.lang.String numberAsString) Parses string to integer.
static Utils.Proximity	proximityFromAccuracy(double accuracy) Computes Utils.Proximity based on distance in meters.
static void	restartBluetooth(android.content.Context context, Utils.RestartCompletedListener listener) Restarts Bluetooth stack on the device.
static byte[]	revertBytes(byte[] bytes) Reverts given byte array.

Methods inherited from class java.lang.Object

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

Constructor Detail

Utils

public Utils()

Method Detail

beaconFromLeScan

public static Beacon beaconFromLeScan(android.bluetooth.BluetoothDevice device,
                                      int rssi,
                                      ScanRecord scanRecord)

Parses scanRecord to look for manufacturer specific data, verifies that and constructs Beacon.

Parameters:

device - Bluetooth device found by BluetoothAdapter.

scanRecord - Bluetooth advertisement data.

rssi - Current RSSI between devices.

Returns:

Constructed Beacon or null if scanRecord could not have been parsed.

normalizeProximityUUID

public static java.lang.String normalizeProximityUUID(java.lang.String proximityUUID)

Normalizes location UUID by making it lowercase and in format XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX. Validates if there are 32 characters (not counting dashes).

isBeaconInRegion

public static boolean isBeaconInRegion(Beacon beacon,
                                       Region region)

Returns true if beacon matches the region. That is region's location UUID, major, minor matches beacon's ones. Or if region uses wildcard for any of those properties.

computeAccuracy

public static double computeAccuracy(Beacon beacon)

Returns distance in meters based on beacon's RSSI and measured transmitPower. Returns -1 when cannot compute accuracy.

computeAccuracy

public static double computeAccuracy(Eddystone eddystone)

computeAccuracy

public static double computeAccuracy(ConfigurableDevicesScanner.ScanResultItem resultItem)

computeAccuracy

public static double computeAccuracy(EstimoteLocation location)

proximityFromAccuracy

public static Utils.Proximity proximityFromAccuracy(double accuracy)

Computes Utils.Proximity based on distance in meters. Current distance ranges:

• immediate: 0 - 0.5m
• near: 0.5m - 3.0m
• far: 3.0m - ...

Parameters:

accuracy - Distance in meters.

Returns:

Location between device and beacon.

computeProximity

public static Utils.Proximity computeProximity(ConfigurableDevicesScanner.ScanResultItem scanResultItem)

computeProximity

public static Utils.Proximity computeProximity(Beacon beacon)

computeProximity

public static Utils.Proximity computeProximity(Eddystone eddystone)

computeProximity

public static Utils.Proximity computeProximity(EstimoteLocation location)

computeProximity

public static Utils.Proximity computeProximity(Nearable nearable)

parseInt

public static int parseInt(java.lang.String numberAsString)

Parses string to integer. If string cannot be parsed, returns 0.

Parameters:

numberAsString - String to be parsed.

Returns:

Integer value or 0 if string cannot be parsed.

restartBluetooth

public static void restartBluetooth(android.content.Context context,
                                    Utils.RestartCompletedListener listener)

Restarts Bluetooth stack on the device.

Never invoke this method without user's explicit consent that Bluetooth on the device is going to be restarted.

Parameters:

context - Context.

listener - Listener to be invoked when Bluetooth stack is restarted.

revertBytes

public static byte[] revertBytes(byte[] bytes)

Reverts given byte array.

Parameters:

bytes - to revert

Returns:

reverted array of bytes