io.flic.poiclib

Class FlicManager

java.lang.Object

io.flic.poiclib.FlicManager

public final class FlicManager
extends java.lang.Object

Flic button manager. To initialize the library, run init(Context, String, String) with an app context, and then run getManager() to get the singleton FlicManager object.

Field Summary

Fields

Modifier and Type	Field and Description
static int	BLUETOOTH_STATE_OFF Indicates the local Bluetooth adapter is off.
static int	BLUETOOTH_STATE_ON Indicates the local Bluetooth adapter is on, and ready for use.
static int	BLUETOOTH_STATE_TURNING_OFF Indicates the local Bluetooth adapter is turning off.
static int	BLUETOOTH_STATE_TURNING_ON Indicates the local Bluetooth adapter is turning on.

Method Summary

Methods

Modifier and Type	Method and Description
void	disconnectAll() Disconnect all known buttons.
void	forgetButton(FlicButton button) Forget a button.
int	getBluetoothState() Get the current Bluetooth state.
FlicButton	getButtonByBdAddr(java.lang.String bdAddr) Get a button by its BD address.
java.util.List<FlicButton>	getKnownButtons() Get all previously known buttons.
static FlicManager	getManager() Get an instance of the FlicManager.
int	getMinimumSignalStrength() Get the minimum signal strength for a Bluetooth device to be found.
FlicScanWizard	getScanWizard() Get the FlicScanWizard singleton instance.
static void	init(Context appContext, java.lang.String appId, java.lang.String appSecret) Init the library.
boolean	isButtonKnown(java.lang.String bdAddr) Checks whether the device is known by the FlicManager.
boolean	isScanning() Is scanning.
void	restartBluetooth() Restarts bluetooth.
void	setEventListener(FlicManagerListener listener) Set the event listener for this instance of the Flic library.
void	setMinimumSignalStrength(int minSignalStrength) Set the minimum signal strength for a Bluetooth device to be found.
void	startScan() Start a scan for Flic buttons.
void	stopScan() Stop scanning for Flic buttons.

Methods inherited from class java.lang.Object

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

Field Detail

BLUETOOTH_STATE_OFF

public static final int BLUETOOTH_STATE_OFF

Indicates the local Bluetooth adapter is off.

See Also:

Constant Field Values

BLUETOOTH_STATE_TURNING_ON

public static final int BLUETOOTH_STATE_TURNING_ON

Indicates the local Bluetooth adapter is turning on.

See Also:

Constant Field Values

BLUETOOTH_STATE_ON

public static final int BLUETOOTH_STATE_ON

Indicates the local Bluetooth adapter is on, and ready for use.

See Also:

Constant Field Values

BLUETOOTH_STATE_TURNING_OFF

public static final int BLUETOOTH_STATE_TURNING_OFF

Indicates the local Bluetooth adapter is turning off.

See Also:

Constant Field Values

Method Detail

getManager

public static FlicManager getManager()

Get an instance of the FlicManager. This instance is shared across the entire application.

Returns:

A shared instance of FlicManager.

setMinimumSignalStrength

public void setMinimumSignalStrength(int minSignalStrength)

Set the minimum signal strength for a Bluetooth device to be found. To disable this feature enter value 0; This instance is shared across the entire application.

getMinimumSignalStrength

public int getMinimumSignalStrength()

Get the minimum signal strength for a Bluetooth device to be found. This instance is shared across the entire application. Default value is 0, which indicates no filtering is done.

Returns:

Minimum signal strength for a Bluetooth device to be found.

init

public static void init(Context appContext,
        java.lang.String appId,
        java.lang.String appSecret)

Init the library. This method must be called to initialize the library before using any other library methods that requires Bluetooth.

Parameters:

appContext - a valid Android Context

appId - app id

appSecret - app secret

disconnectAll

public void disconnectAll()

Disconnect all known buttons. This should be done before quitting the App to ensure that the connection is not "eaten up" by buggy Android Bluetooth libraries after the App has quit, or to release BLE resources held by the library.

setEventListener

public void setEventListener(FlicManagerListener listener)

Set the event listener for this instance of the Flic library.

Parameters:

listener - An event listener implementing the FlicManagerListener interface.

isScanning

public boolean isScanning()

Is scanning.

Returns:

true if there is a pending scan, else false.

startScan

public void startScan()

Start a scan for Flic buttons. If a scan is already in progress then that scan will restart and previously discovered Flic buttons will be rediscovered. [FIXME: implementation does not conform to the docs]

stopScan

public void stopScan()

Stop scanning for Flic buttons. If no scan is in progress then this is a no-op.

getScanWizard

public FlicScanWizard getScanWizard()

Get the FlicScanWizard singleton instance.

Returns:

The scan wizard

getKnownButtons

public java.util.List<FlicButton> getKnownButtons()

Get all previously known buttons. The returned Button objects may or may not be in a connected state.

Returns:

A list of all previously known buttons. This object is a newly created copy of the library's internal list.

getButtonByBdAddr

public FlicButton getButtonByBdAddr(java.lang.String bdAddr)

Get a button by its BD address. The returned Button object may or may not be in a connected state. The button may or may not be known previously. If the button is not known previously, it is created using the bdAddr (BD address) and added to the internal list of known buttons.

Parameters:

bdAddr - The BD address to lookup

Returns:

The button

isButtonKnown

public boolean isButtonKnown(java.lang.String bdAddr)

Checks whether the device is known by the FlicManager.

Parameters:

bdAddr - The BD address to lookup

Returns:

true/false

forgetButton

public void forgetButton(FlicButton button)

Forget a button. This disconnects the button and completely removes the FlicButton from the manager.

Parameters:

button -

restartBluetooth

public void restartBluetooth()

Restarts bluetooth. Pending connection requests will be restarted after bluetooth has turned on again. Active connections will be disconnected and not restarted. If you want to restart active connections, you can call .connect() in the disconnect callbacks that will soon be called. Note that this affects all running apps on the device.

getBluetoothState

public int getBluetoothState()

Get the current Bluetooth state. See also FlicManagerListener.onBluetoothStateChange(int).

Returns:

One of BLUETOOTH_STATE_TURNING_OFF, BLUETOOTH_STATE_OFF, BLUETOOTH_STATE_TURNING_ON, BLUETOOTH_STATE_ON