com.estimote.sdk.connection.scanner

Class ConfigurableDevicesScanner

java.lang.Object

com.estimote.sdk.connection.scanner.ConfigurableDevicesScanner

public class ConfigurableDevicesScanner
extends java.lang.Object

Finds available physical devices than can be configured using DeviceConnectionProvider. It does not create a connection by itself, but provides ConfigurableDevice data object that can be used to obtain DeviceConnection.

Note: This scanner should not be used for long term scanning (in background). It will drain battery quickly, because it uses low latency scanning. It is intended to be used for displaying available devices in UI. It should be started in Activity.onResume() and stopped in Activity.onPause().

       ConfigurableDevicesScanner deviceScanner = new ConfigurableDevicesScanner(context);
       // Scan for devices own by currently logged user.
       deviceScanner.setOwnDevicesFiltering(true);
       // Scan only for second generation beacons.
       deviceScanner.setDeviceTypes(DeviceType.LOCATION_BEACON);
       deviceScanner.scanForDevices(new ConfigurableDevicesScanner.ScannerCallback() {
             @Override public void onDevicesFound(List devices) {
                for(ScanResultItem item : devices) {
                  displayDevice(item.device);
                }
         }
       });

 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ConfigurableDevicesScanner.ScannerCallback
static class	ConfigurableDevicesScanner.ScanResultItem Information about configurable device that was found during scanning.

Constructor Summary

Constructors

Constructor and Description
ConfigurableDevicesScanner(android.content.Context context) Constructs new scanner based on Context object.

Method Summary

Modifier and Type	Method and Description
void	disableBulkFirmwareUpdate() Stops bulk updater from updating firmware
void	enableBulkFirmwareUpdate(BulkUpdater.BulkUpdaterCallback callback) Enables bulk updater
boolean	isOwnDevicesFiltering()
boolean	isScanning() Returns if scan is in progress
boolean	scanForDevices(ConfigurableDevicesScanner.ScannerCallback callback) Starts scanning for configurable devices.
void	setDeviceTypes(java.util.Collection<DeviceType> deviceTypes) Sets types of accepted configurable devices.
void	setDeviceTypes(DeviceType... deviceTypes) Sets types of accepted configurable devices.
void	setOwnDevicesFiltering(boolean ownDevicesFiltering) Sets filtering for owned devices.
void	setScanPeriodMillis(long scanPeriodMillis) Sets scan period.
void	stopScanning() Stops configurable devices scanning (only when it was previously started).

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfigurableDevicesScanner

public ConfigurableDevicesScanner(android.content.Context context)

Constructs new scanner based on Context object.

Parameters:

context - Android context object.

Method Detail

setDeviceTypes

public void setDeviceTypes(java.util.Collection<DeviceType> deviceTypes)

Sets types of accepted configurable devices.

Parameters:

deviceTypes - Collection of supported device types.

setScanPeriodMillis

public void setScanPeriodMillis(long scanPeriodMillis)

Sets scan period.

Parameters:

scanPeriodMillis - Scan period in milliseconds.

setDeviceTypes

public void setDeviceTypes(DeviceType... deviceTypes)

Sets types of accepted configurable devices.

Parameters:

deviceTypes - Array of supported device types.

isOwnDevicesFiltering

public boolean isOwnDevicesFiltering()

setOwnDevicesFiltering

public void setOwnDevicesFiltering(boolean ownDevicesFiltering)

Sets filtering for owned devices. Enabling this method requires Estimote Cloud credentials to be set using EstimoteSDK.initialize(Context, String, String).

Parameters:

ownDevicesFiltering - If true only devices owned by user will be returned by scanner.

enableBulkFirmwareUpdate

public void enableBulkFirmwareUpdate(BulkUpdater.BulkUpdaterCallback callback)

Enables bulk updater

disableBulkFirmwareUpdate

public void disableBulkFirmwareUpdate()

Stops bulk updater from updating firmware

scanForDevices

public boolean scanForDevices(ConfigurableDevicesScanner.ScannerCallback callback)

Starts scanning for configurable devices. Single scanner can perform one scan at the time.

Parameters:

callback - Callback object that will be returning found devices.

Returns:

True if scanning has started.

isScanning

public boolean isScanning()

Returns if scan is in progress

Returns:

stopScanning

public void stopScanning()

Stops configurable devices scanning (only when it was previously started).