io.flic.lib

Class FlicButton

java.lang.Object

io.flic.lib.FlicButton

public final class FlicButton
extends java.lang.Object

FlicButton. This class represents a Flic button. Instances of this class cannot be created directly but are returned from the manager. See FlicManager.initiateGrabButton(Activity), FlicManager.getButtonByDeviceId(String) and FlicManager.getKnownButtons().

Field Summary

Fields

Modifier and Type	Field and Description
static int	BUTTON_CONNECTION_COMPLETED
static int	BUTTON_CONNECTION_STARTED
static int	BUTTON_DISCONNECTED

Method Summary

Methods

Modifier and Type	Method and Description
void	addFlicButtonCallback(FlicButtonCallback callback) Add callbacks for this button.
java.lang.String	getButtonId() Get the MAC address of this button.
int	getCallbackFlags() Get the current callback flags.
java.lang.String	getColor() Get the color of this button.
int	getConnectionStatus() Get the connection status.
boolean	readRemoteRSSI() Read the current RSSI value of the button.
void	removeAllFlicButtonCallbacks() Remove all callbacks for this button.
void	removeFlicButtonCallback(FlicButtonCallback callback) Removes a callback for this button.
boolean	setActiveMode(boolean activeMode) Set the button to active mode.
boolean	setFlicButtonCallbackFlags(int flicButtonCallbackFlags) Set which button events to listen for.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

BUTTON_DISCONNECTED

public static final int BUTTON_DISCONNECTED

See Also:

Constant Field Values

BUTTON_CONNECTION_STARTED

public static final int BUTTON_CONNECTION_STARTED

See Also:

Constant Field Values

BUTTON_CONNECTION_COMPLETED

public static final int BUTTON_CONNECTION_COMPLETED

See Also:

Constant Field Values

Method Detail

addFlicButtonCallback

public void addFlicButtonCallback(FlicButtonCallback callback)

Add callbacks for this button. The callbacks remain valid during the lifetime of the application process or until you call FlicManager.forgetButton(FlicButton) for this button. Callbacks are not called during the manager is not in the initialized state.

Parameters:

callback - The callback object

removeFlicButtonCallback

public void removeFlicButtonCallback(FlicButtonCallback callback)

Removes a callback for this button.

Parameters:

callback - The callback object

removeAllFlicButtonCallbacks

public void removeAllFlicButtonCallbacks()

Remove all callbacks for this button.

setFlicButtonCallbackFlags

public boolean setFlicButtonCallbackFlags(int flicButtonCallbackFlags)

Set which button events to listen for. If you are concerned about low latencies and performance, only register the flags you actually use.

Parameters:

flicButtonCallbackFlags - A bitwise-or'ed value of FlicButtonCallbackFlags

Returns:

true on success, false if manager was in uninitialized state

getCallbackFlags

public int getCallbackFlags()

Get the current callback flags.

Returns:

Callback flags

getButtonId

public java.lang.String getButtonId()

Get the MAC address of this button.

Returns:

The MAC address

getConnectionStatus

public int getConnectionStatus()

Get the connection status.

Returns:

One of BUTTON_DISCONNECTED, BUTTON_CONNECTION_STARTED and BUTTON_CONNECTION_COMPLETED

getColor

public java.lang.String getColor()

Get the color of this button.

Returns:

The color as a string. Currently one of "black", "white", "turquoise", "yellow", "green" or "unknown".

readRemoteRSSI

public boolean readRemoteRSSI()

Read the current RSSI value of the button. FlicButtonCallback.onReadRemoteRSSI(FlicButton, int, int) will be called when a result is available.

Returns:

True if the read was successfully initiated

setActiveMode

public boolean setActiveMode(boolean activeMode)

Set the button to active mode. This decreases the delay, but will consume more battery power.

Parameters:

activeMode - True if to use active mode. False to use passive mode.

Returns:

True if successful. False if the manager was in uninitialized state.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object