io.flic.fliclib.javaclient

Class FlicClient

java.lang.Object

io.flic.fliclib.javaclient.FlicClient

public class FlicClient
extends java.lang.Object

Implements a FlicClient over a TCP Socket. When this class is constructed, a socket connection is established. You may then send commands to the server and set timers. Once you are ready with the initialization you must call the handleEvents() method which is a main loop that never exits, unless the socket is closed. For a more detailed description of all commands, events and enums, check the protocol specification.

Constructor Summary

Constructors

Constructor and Description
FlicClient(java.lang.String hostName) Create a FlicClient and connect to the specified hostName using the default TCP port
FlicClient(java.lang.String hostName, int port) Create a FlicClient and connect to the specified hostName and TCP port

Method Summary

Methods

Modifier and Type	Method and Description
void	addConnectionChannel(ButtonConnectionChannel channel) Adds a connection channel to a specific Flic button.
void	addScanner(ButtonScanner buttonScanner) Add a scanner.
void	addScanWizard(ScanWizard scanWizard) Add a scan wizard.
void	cancelScanWizard(ScanWizard scanWizard) Cancel a scan wizard.
void	close() Close the socket.
void	forceDisconnect(Bdaddr bdaddr) Force disconnection or cancel pending connection of a specific Flic button.
void	getButtonUUID(Bdaddr bdaddr, GetButtonUUIDResponseCallback callback) Get button uuid for a verified button.
void	getInfo(GetInfoResponseCallback callback) Get info about the current state of the server.
void	handleEvents() Start the main loop for this client.
void	removeConnectionChannel(ButtonConnectionChannel channel) Remove a connection channel.
void	removeScanner(ButtonScanner buttonScanner) Remove a scanner.
void	runOnHandleEventsThread(TimerTask task) Run a task on the thread that handles the events.
void	setGeneralCallbacks(GeneralCallbacks callbacks) Set general callbacks to be called upon receiving some specific events.
void	setTimer(int timeoutMillis, TimerTask timerTask) Set a timer.

Methods inherited from class java.lang.Object

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

Constructor Detail

FlicClient

public FlicClient(java.lang.String hostName,
          int port)
           throws java.net.UnknownHostException,
                  java.io.IOException

Create a FlicClient and connect to the specified hostName and TCP port

Parameters:

hostName -

port -

Throws:

java.net.UnknownHostException

java.io.IOException

FlicClient

public FlicClient(java.lang.String hostName)
           throws java.net.UnknownHostException,
                  java.io.IOException

Create a FlicClient and connect to the specified hostName using the default TCP port

Parameters:

hostName -

Throws:

java.net.UnknownHostException

java.io.IOException

Method Detail

close

public void close()
           throws java.io.IOException

Close the socket. From this point any use of this FlicClient is illegal. The handleEvents() will return as soon as the closing is done.

Throws:

java.io.IOException

setGeneralCallbacks

public void setGeneralCallbacks(GeneralCallbacks callbacks)

Set general callbacks to be called upon receiving some specific events.

Parameters:

callbacks -

getInfo

public void getInfo(GetInfoResponseCallback callback)
             throws java.io.IOException

Get info about the current state of the server. The server will send back its information directly and the callback will be called once the response arrives.

Parameters:

callback -

Throws:

java.io.IOException

getButtonUUID

public void getButtonUUID(Bdaddr bdaddr,
                 GetButtonUUIDResponseCallback callback)
                   throws java.io.IOException

Get button uuid for a verified button. The server will send back its information directly and the callback will be called once the response arrives. Responses will arrive in the same order as requested. If the button isn't verified, the uuid sent to callback will be null.

Parameters:

bdaddr - The bluetooth address.

callback - Callback for the response.

Throws:

java.io.IOException

addScanner

public void addScanner(ButtonScanner buttonScanner)
                throws java.io.IOException

Add a scanner. The scan will start directly once the scanner is added.

Parameters:

buttonScanner -

Throws:

java.io.IOException

removeScanner

public void removeScanner(ButtonScanner buttonScanner)
                   throws java.io.IOException

Remove a scanner.

Parameters:

buttonScanner - The same scanner that was used in addScanner(ButtonScanner)

Throws:

java.io.IOException

addScanWizard

public void addScanWizard(ScanWizard scanWizard)
                   throws java.io.IOException

Add a scan wizard. The scan wizard will start directly once the scan wizard is added.

Parameters:

scanWizard -

Throws:

java.io.IOException

cancelScanWizard

public void cancelScanWizard(ScanWizard scanWizard)
                      throws java.io.IOException

Cancel a scan wizard. This will cancel an ongoing scan wizard. If cancelled due to this request, the result of the scan wizard will be WizardCancelledByUser.

Parameters:

scanWizard - The same scan wizard that was used in addScanWizard(ScanWizard)

Throws:

java.io.IOException

addConnectionChannel

public void addConnectionChannel(ButtonConnectionChannel channel)
                          throws java.io.IOException

Adds a connection channel to a specific Flic button. This will start listening for a specific Flic button's connection and button events. Make sure the Flic is either in public mode (by holding it down for 7 seconds) or already verified before calling this method. The ButtonConnectionChannel.Callbacks.onCreateConnectionChannelResponse(io.flic.fliclib.javaclient.ButtonConnectionChannel, io.flic.fliclib.javaclient.enums.CreateConnectionChannelError, io.flic.fliclib.javaclient.enums.ConnectionStatus) method will be called after this command has been received by the server. You may have as many connection channels as you wish for a specific Flic Button.

Parameters:

channel -

Throws:

java.io.IOException

removeConnectionChannel

public void removeConnectionChannel(ButtonConnectionChannel channel)
                             throws java.io.IOException

Remove a connection channel. This will stop listening for new events for a specific connection channel that has previously been added. Note: The effect of this command will take place at the time the ButtonConnectionChannel.Callbacks.onRemoved(io.flic.fliclib.javaclient.ButtonConnectionChannel, io.flic.fliclib.javaclient.enums.RemovedReason) event arrives.

Parameters:

channel -

Throws:

java.io.IOException

forceDisconnect

public void forceDisconnect(Bdaddr bdaddr)
                     throws java.io.IOException

Force disconnection or cancel pending connection of a specific Flic button. This removes all connection channels for all clients connected to the server for this specific Flic button.

Parameters:

bdaddr -

Throws:

java.io.IOException

setTimer

public void setTimer(int timeoutMillis,
            TimerTask timerTask)
              throws java.io.IOException

Set a timer. This timer task will run after the specified timeoutMillis on the thread that handles the events.

Parameters:

timeoutMillis -

timerTask -

Throws:

java.io.IOException

runOnHandleEventsThread

public void runOnHandleEventsThread(TimerTask task)
                             throws java.io.IOException

Run a task on the thread that handles the events.

Parameters:

task -

Throws:

java.io.IOException

handleEvents

public void handleEvents()
                  throws java.io.IOException

Start the main loop for this client. This method will not return until the socket has been closed. Once it has returned, any use of this FlicClient is illegal.

Throws:

java.io.IOException