com.estimote.mgmtsdk.connection.api

Class BeaconConnection

java.lang.Object

com.estimote.mgmtsdk.connection.api.BeaconConnection

Deprecated.

@Deprecated
public class BeaconConnection
extends java.lang.Object

Responsible for reading and changing beacon's configuration. It establishes connection to the beacon and authorizes access to it.

In order to successfully authorize access to beacon, beacon needs to be registered to your Estimote Cloud. You need to provide Estimote Cloud credentials via EstimoteSDK.initialize(Context, String, String) prior to connecting to beacon.

Exposes methods to change beacon's UUID, major, minor, advertising advertisingInterval, broadcasting transmitPower, transmitPower modes values. You can only change those values only if there is established connection to beacon.

It is very important to close() connection when it is not needed.

Usage:

   BeaconConnection connection = new BeaconConnection(context, beacon, new BeaconConnection.ConnectionCallback() {
      @Override public void onConnected(BeaconInfo beaconInfo) {
       Log.d(TAG, "Authenticated to beacon. Info: " + beaconInfo);
       Log.d(TAG, "Advertising internal: " + connection.advertisingIntervalMillis().get());
       Log.d(TAG, "Broadcasting transmitPower: " + connection.broadcastingPower().get());
     }

      @Override public void onAuthenticationError(EstimoteDeviceException exception) {
       Log.d(TAG, "Authentication Error: " + exception);
     }

      @Override public void onDisconnected() {
       Log.d(TAG, "Disconnected");
     }
   });

   connection.authenticate();

   // Interact with beacon.

   // You can update beacon's properties in following way:
   connection.edit()
     .set(connection.proximityUuid(), newUuid)
     .set(connection.major(), newMajor)
     .set(connection.minor(), newMinor)
     .commit(new BeaconConnection.WriteCallback() {
         @Override public void onSuccess() {}
         @Override public void onError(EstimoteDeviceException exception) {}
     });

   // Do not forget to close connection.
   connection.close();
 

This class is deprecated. Please use DeviceConnection obtained from DeviceConnectionProvider.

Author:

wiktor@estimote.com (Wiktor Gworek)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	BeaconConnection.CheckFirmwareCallback Deprecated. Callback to indicate whether device needs update.
static interface	BeaconConnection.ConnectionCallback Deprecated. Callback used to indicate state of the connection to the beacon.
class	BeaconConnection.PropertyChanger Deprecated.
static interface	BeaconConnection.WriteCallback Deprecated. Callback used to indicate status of updating beacon characteristic.

Constructor Summary

Constructors

Constructor and Description
BeaconConnection(android.content.Context context, Beacon beacon, BeaconConnection.ConnectionCallback connectionCallback) Deprecated. Constructs new connection object based on Beacon object.
BeaconConnection(android.content.Context context, MacAddress macAddress) Deprecated. Constructs new connection object based on beacon's MAC address.
BeaconConnection(android.content.Context context, MacAddress macAddress, BeaconConnection.ConnectionCallback connectionCallback) Deprecated. Constructs new connection object based on beacon's MAC address.

Method Summary

Modifier and Type	Method and Description
void	addConnectionCallback(BeaconConnection.ConnectionCallback callback) Deprecated. Adds new connection callback to connection.
<any>	advertisingIntervalMillis() Deprecated.
void	authenticate() Deprecated. Starts connection flow to device with 10s timeout.
<any>	basicPowerMode() Deprecated.
<any>	broadcastingPower() Deprecated.
<any>	broadcastingScheme() Deprecated. Broadcasting scheme controls what packet type beacon is broadcasting.
void	checkFirmwareUpdate(BeaconConnection.CheckFirmwareCallback callback) Deprecated. Checks whether beacon needs firmware update.
void	clearCallbacks() Deprecated. Removes all callbacks from connection.
void	close() Deprecated. Closes connection to beacon or cancels in-flight connection flow.
<any>	conditionalBroadcasting() Deprecated. Property responsible for setting Flip To Sleep mode.
protected BeaconNoCloudConnection	createNoCloudConnection(android.content.Context context, MacAddress macAddress) Deprecated.
<any>	eddystoneInstance() Deprecated. Eddystone-UID instance property is 12 hex characters (6 bytes).
<any>	eddystoneNamespace() Deprecated. Eddystone-UID namespace property is 20 hex characters (10 bytes).
<any>	eddystoneUrl() Deprecated. Eddystone-URL's URL property can be at max 17 characters.
BeaconConnection.PropertyChanger	edit() Deprecated.
java.lang.Integer	getBatteryPercent() Deprecated.
java.lang.String	getHardwareVersion() Deprecated.
protected InternalEstimoteCloud	getInternalEstimoteCloud() Deprecated.
MacAddress	getMacAddress() Deprecated.
java.lang.String	getSoftwareVersion() Deprecated.
boolean	isConnected() Deprecated.
<any>	major() Deprecated.
<any>	minor() Deprecated.
<any>	motionDetectionEnabled() Deprecated. Enables or disables the accelerometer allowing to detect if beacon is in motion.
<any>	motionState() Deprecated. A flag indicating if the beacon is in motion or not.
<any>	proximityUuid() Deprecated.
void	removeConnectionCallback(BeaconConnection.ConnectionCallback callback) Deprecated. Removes callback from connection.
<any>	secureUUID() Deprecated. Property for enabling/disabling Secure UUID.
void	setMotionListener(<any> callback) Deprecated. Sets listener to beacon's motion changes.
<any>	smartPowerMode() Deprecated.
<any>	temperature() Deprecated. Property for reading temperature value from beacon.
<any>	temperatureCalibration() Deprecated. Calibrates the beacon’s thermometer sensor.
void	updateBeacon(BeaconOta.Callback callback) Deprecated. Updates beacon's firmware.
void	writeLocationName(java.lang.String locationName, BeaconConnection.WriteCallback writeCallback) Deprecated. Changes location value of the beacon.

Methods inherited from class java.lang.Object

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

Constructor Detail

BeaconConnection

public BeaconConnection(android.content.Context context,
                        Beacon beacon,
                        BeaconConnection.ConnectionCallback connectionCallback)

Deprecated.

Constructs new connection object based on Beacon object.

Parameters:

context - Android context.

beacon - Beacon to connect to.

connectionCallback - Connection callback.

BeaconConnection

public BeaconConnection(android.content.Context context,
                        MacAddress macAddress,
                        BeaconConnection.ConnectionCallback connectionCallback)

Deprecated.

Constructs new connection object based on beacon's MAC address.

Parameters:

context - Android context.

macAddress - MAC address of the beacon.

connectionCallback - Connection callback.

BeaconConnection

public BeaconConnection(android.content.Context context,
                        MacAddress macAddress)

Deprecated.

Constructs new connection object based on beacon's MAC address.

Parameters:

context - Android context.

macAddress - MAC address of the beacon.

Method Detail

addConnectionCallback

public void addConnectionCallback(BeaconConnection.ConnectionCallback callback)

Deprecated.

Adds new connection callback to connection.

Parameters:

callback - Adds new callback to connection.

removeConnectionCallback

public void removeConnectionCallback(BeaconConnection.ConnectionCallback callback)

Deprecated.

Removes callback from connection.

Parameters:

callback - Callback to be removed.

clearCallbacks

public void clearCallbacks()

Deprecated.

Removes all callbacks from connection.

authenticate

public void authenticate()

Deprecated.

Starts connection flow to device with 10s timeout.

close

public void close()

Deprecated.

Closes connection to beacon or cancels in-flight connection flow.

isConnected

public boolean isConnected()

Deprecated.

Returns:

True if connection is successfully established with the beacon.

getMacAddress

public MacAddress getMacAddress()

Deprecated.

Returns:

MAC address of a device.

getBatteryPercent

public java.lang.Integer getBatteryPercent()

Deprecated.

Returns:

Battery level in percent.

getSoftwareVersion

public java.lang.String getSoftwareVersion()

Deprecated.

Returns:

Version of operating system.

getHardwareVersion

public java.lang.String getHardwareVersion()

Deprecated.

Returns:

Revision of hardware.

broadcastingPower

public <any> broadcastingPower()

Deprecated.

Returns:

Broadcasting transmitPower property.

advertisingIntervalMillis

public <any> advertisingIntervalMillis()

Deprecated.

Returns:

Advertising advertisingInterval in milliseconds property.

proximityUuid

public <any> proximityUuid()

Deprecated.

Returns:

Beacon's proximity UUID property.

major

public <any> major()

Deprecated.

Returns:

Beacon's major property.

minor

public <any> minor()

Deprecated.

Returns:

Beacon's minor property.

basicPowerMode

public <any> basicPowerMode()

Deprecated.

Returns:

Beacon's basic transmitPower property.

See Also:

More info about transmitPower modes

smartPowerMode

public <any> smartPowerMode()

Deprecated.

Returns:

Beacon's smart transmitPower property.

See Also:

More info about transmitPower modes

conditionalBroadcasting

public <any> conditionalBroadcasting()

Deprecated.

Property responsible for setting Flip To Sleep mode.

Returns:

Beacon's conditional broadcasting property.

See Also:

More info about conditional broadcasting

temperature

public <any> temperature()

Deprecated.

Property for reading temperature value from beacon. Value is reported in Celsius.

Note that Property#get() will return cached value. If you want to read most up to date temperature value, do use Property#getAsync(Property.Callback).

This property is read-only. If you try to write a value, an UnsupportedOperationException will be thrown.

Returns:

Beacon's temperature property (read-only).

See Also:

temperatureCalibration()

temperatureCalibration

public <any> temperatureCalibration()

Deprecated.

Calibrates the beacon’s thermometer sensor.

Beacons are basically calibrated out of the box, but additional manual calibration is recommended in order to minimize measurement error. When the sensor is not calibrated, measurement error is ±4 Celsius degrees. After calibration it’s ±2 Celsius degrees.

To perform calibration you need to keep the beacon at room temperature for a couple of minutes. Use a separate thermometer to read the actual value (in Celsius degrees) and pass it.

This property is write only. If you try to read it, an UnsupportedOperationException will be thrown.

Returns:

Beacon's temperature calibration (write-only).

motionDetectionEnabled

public <any> motionDetectionEnabled()

Deprecated.

Enables or disables the accelerometer allowing to detect if beacon is in motion.

Returns:

Beacon's accelerometer enabled property.

motionState

public <any> motionState()

Deprecated.

A flag indicating if the beacon is in motion or not.

This property is read only. If you try to write to it, an UnsupportedOperationException will be thrown.

Returns:

Beacon's accelerometer state (in motion or not in motion).

secureUUID

public <any> secureUUID()

Deprecated.

Property for enabling/disabling Secure UUID.

Read more @see What security features does Estimote offer? How does Secure UUID work?

Returns:

Beacon's secure UUID state (is enabled or disabled).

writeLocationName

public void writeLocationName(java.lang.String locationName,
                              BeaconConnection.WriteCallback writeCallback)

Deprecated.

Changes location value of the beacon.

Parameters:

locationName - Location name to be set.

writeCallback - Callback to be invoked when write is completed.

checkFirmwareUpdate

public void checkFirmwareUpdate(BeaconConnection.CheckFirmwareCallback callback)

Deprecated.

Checks whether beacon needs firmware update.

Parameters:

callback - Callback to indicate firmware status.

broadcastingScheme

public <any> broadcastingScheme()

Deprecated.

Broadcasting scheme controls what packet type beacon is broadcasting.

Returns:

Device's broadcasting scheme.

eddystoneNamespace

public <any> eddystoneNamespace()

Deprecated.

Eddystone-UID namespace property is 20 hex characters (10 bytes).

Returns:

Eddystone's namespace property.

eddystoneInstance

public <any> eddystoneInstance()

Deprecated.

Eddystone-UID instance property is 12 hex characters (6 bytes).

Returns:

Eddystone's instance property.

eddystoneUrl

public <any> eddystoneUrl()

Deprecated.

Eddystone-URL's URL property can be at max 17 characters. Note that some predefined substrings can be treated as one special character. Those are: http://www. https://www. http:// https:// .com .com/ .org .org/ .edu .edu/ .net .net/ .info .info/ .biz .biz/ .gov .gov/

Returns:

Eddystone's URL property.

updateBeacon

public void updateBeacon(BeaconOta.Callback callback)

Deprecated.

Updates beacon's firmware.

Parameters:

callback - Callback to indicate status of update.

createNoCloudConnection

protected BeaconNoCloudConnection createNoCloudConnection(android.content.Context context,
                                                          MacAddress macAddress)

Deprecated.

getInternalEstimoteCloud

protected InternalEstimoteCloud getInternalEstimoteCloud()

Deprecated.

setMotionListener

public void setMotionListener(<any> callback)

Deprecated.

Sets listener to beacon's motion changes. When beacon starts to move, information about it will be dispatched immediately. Information about beacon's no movements will be dispatched after 2 seconds of remaining still. This method should be called when connection is established (@isConnected() returns true). Call it with a null callback object and listener will be unregistered (no need to be connected is this case).

Parameters:

callback - Motion listener callback.

edit

public BeaconConnection.PropertyChanger edit()

Deprecated.