io.flic.fliclib.javaclient

Class ScanWizard

java.lang.Object

io.flic.fliclib.javaclient.ScanWizard

public abstract class ScanWizard
extends java.lang.Object

Scan wizard class. This class will scan for a new button and pair it automatically. There are internal timeouts that make sure operations don't take too long time. Inherit this class and override the methods. Then add this scan wizard to a FlicClient using FlicClient.addScanWizard(ScanWizard) to start it. You can cancel by calling FlicClient.cancelScanWizard(ScanWizard).

Constructor Summary

Constructors

Constructor and Description
ScanWizard()

Method Summary

Methods

Modifier and Type	Method and Description
abstract void	onButtonConnected(Bdaddr bdaddr, java.lang.String name) This will be called once the bluetooth connection has been established.
abstract void	onCompleted(ScanWizardResult result, Bdaddr bdaddr, java.lang.String name) Scan wizard completed.
abstract void	onFoundPrivateButton() This will be called once if a private button is found.
abstract void	onFoundPublicButton(Bdaddr bdaddr, java.lang.String name) This will be called once a public button is found.

Methods inherited from class java.lang.Object

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

Constructor Detail

ScanWizard

public ScanWizard()

Method Detail

onFoundPrivateButton

public abstract void onFoundPrivateButton()
                                   throws java.io.IOException

This will be called once if a private button is found. Tell the user to hold down the button for 7 seconds in order to make it public.

Throws:

java.io.IOException

onFoundPublicButton

public abstract void onFoundPublicButton(Bdaddr bdaddr,
                       java.lang.String name)
                                  throws java.io.IOException

This will be called once a public button is found. Now a connection attempt will be made to the device in order to pair and verify it.

Parameters:

bdaddr - Bluetooth Device Address

name - Advertising name

Throws:

java.io.IOException

onButtonConnected

public abstract void onButtonConnected(Bdaddr bdaddr,
                     java.lang.String name)
                                throws java.io.IOException

This will be called once the bluetooth connection has been established. Now a pair attempt will be made.

Parameters:

bdaddr - Bluetooth Device Address

name - Advertising name

Throws:

java.io.IOException

onCompleted

public abstract void onCompleted(ScanWizardResult result,
               Bdaddr bdaddr,
               java.lang.String name)
                          throws java.io.IOException

Scan wizard completed. If the result is success, you can now create a connection channel to the button. The ScanWizard is now detached from the FlicClient and can now be recycled.

Parameters:

result - Result of the scan wizard

bdaddr - Bluetooth Device Address or null, depending on if onFoundPublicButton(io.flic.fliclib.javaclient.Bdaddr, java.lang.String) has been called or not

name - Advertising name or null, depending on if onFoundPublicButton(io.flic.fliclib.javaclient.Bdaddr, java.lang.String) has been called or not

Throws:

java.io.IOException