frog.plugin.bluetooth
Class BluetoothPlugin

java.lang.Object
  frog.plugin.bluetooth.BluetoothPlugin

All Implemented Interfaces:

Plugin

public class BluetoothPlugin
extends Object
implements Plugin

Author:

TCU Mobile HCI Lab

Field Summary

(package private) int

test

Constructor Summary

BluetoothPlugin()
Constructor can only have one instance per run.

Method Summary

void	addFilter(Device arg0, int arg1, String arg2) Instruct the device to add a new filter to its filtering pipeline.
void	calibrate(Device arg0) Calibrates the accelerometers of the target device.
void	connect(Device device) Formally connect to a specified device.
void	disconnect(Device arg0) Disconnect a connected device.
void	disconnectAll() Disconnect from all devices known to this Plugin.
void	discover(Vector<Device> arg0) A non-blocking method for finding nearby discoverable devices.
String[]	getActiveFilters(Device arg0) Returns a list of filters currently active on the device.
String[]	getAvailFilters() Returns a list of available filters that this device supports.
static BluetoothPlugin	getInstance()
int	getSampleRate(Device arg0) Gets the current sampling rate of this Device in hertz.
void	kill(Device arg0)
void	killAll()
void	removeFilter(Device arg0, int arg1) Removes a filter from the list of active filters on the Device.
void	resetFilters(Device arg0) Removes any filters currently active on the Device.
void	send(Device device, String s)
void	setSampleRate(Device arg0, int arg1) Instructs this device to sample at a given rate.

Methods inherited from class java.lang.Object

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

Field Detail

test

int test

Constructor Detail

BluetoothPlugin

public BluetoothPlugin()
                throws Throwable

Constructor can only have one instance per run.

Throws:

Throwable

Method Detail

getInstance

public static BluetoothPlugin getInstance()

send

public void send(Device device,
                 String s)

kill

public void kill(Device arg0)

killAll

public void killAll()

addFilter

public void addFilter(Device arg0,
                      int arg1,
                      String arg2)
               throws IOException

Description copied from interface: Plugin

Instruct the device to add a new filter to its filtering pipeline. If the device supports on-board filtering, this method should communicate both what type of filter to use as well as an argument string for that filter. The id should come from the getAvailFilters method (it is the index of the array of the desired filter).

Specified by:

addFilter in interface Plugin

Parameters:

arg0 - the device to send the new filter information to

arg1 - the filter desired. This should be the index from the array of filters.

arg2 - the argument String for this filter

Throws:

IOException - if any communication error occurs

See Also:

Plugin.getAvailFilters(), Device.addFilter(int, String)

calibrate

public void calibrate(Device arg0)
               throws IOException

Description copied from interface: Plugin

Calibrates the accelerometers of the target device. If the device requires calibration or any adjustment before use, this method can be called to provide a custom GUI instructing the user on how to set up their device (such as setting it flat on a table or throwing it out a window).

Specified by:

calibrate in interface Plugin

Parameters:

arg0 - the device to be calibrated

Throws:

IOException - if any communication error occurs

See Also:

Device.calibrate()

connect

public void connect(Device device)
             throws IOException

Description copied from interface: Plugin

Formally connect to a specified device. After the user has been presented with a list of discovered devices, the one they pick must be connected to so that a formal connection (and probably a new Thread) can be established and they can begin using the device.

Specified by:

connect in interface Plugin

Parameters:

device - the device to connect to

Throws:

IOException - if any communication error occurs. It should be assumed that if this exception is thrown, the device is NOT connected.

See Also:

Device.connect(DeviceListener)

disconnect

public void disconnect(Device arg0)
                throws IOException

Description copied from interface: Plugin

Disconnect a connected device. This method should tear down any facilities that were set up to support the device. This should be called by the user when they wish to disconnect the device.

Unlike unexpected disconnects (disconnects resulting from battery or communication failure), the disconnect() method should not notify DeviceListeners of anything. A call to this method means the disconnect is deliberate and expected.

Specified by:

disconnect in interface Plugin

Parameters:

arg0 - the device to disconnect from

Throws:

IOException - if the device cannot be sent a disconnect signal. Regardless, a best attempt must be made to tear down any local resources tied to this device.

See Also:

Device.disconnect()

disconnectAll

public void disconnectAll()
                   throws IOException

Description copied from interface: Plugin

Disconnect from all devices known to this Plugin. Convenience method for FROG. Most likely to be called when FROG is in the process of shutting down.

Specified by:

disconnectAll in interface Plugin

Throws:

IOException - if any of the connected devices could not be sent a disconnect message. Regardless, FROG is probably shutting down and any local resources should be freed.

discover

public void discover(Vector<Device> arg0)
              throws IOException

Description copied from interface: Plugin

A non-blocking method for finding nearby discoverable devices. Ideally this Plugin should broadcast a message looking for nearby devices. As devices are found, they should be placed on the deviceList. Implementing classes are encouraged to try and make the discovery of devices within 10 seconds. Devices that are found should not be connected to, but rather added to the given Vector<Device> so that the caller can view devices as they become available.

This method is expected to be non-blocking. That is, a Plugin should launch the discovery process in a separate Thread to allow other Plugins to perform their respective discoveries simultaneously.

Specified by:

discover in interface Plugin

Throws:

IOException - any catastrophic errors occur. Should ideally be thrown if the radio or other hardware is missing. Communication errors between the plugin and a device are not a sufficient cause to throw this exception.

getActiveFilters

public String[] getActiveFilters(Device arg0)

Description copied from interface: Plugin

Returns a list of filters currently active on the device. If the Device does not support on-device filtering, a null or empty array may be returned.

Specified by:

getActiveFilters in interface Plugin

Returns:

the list of currently active filters on the device in the order in which they were instantiated

See Also:

Device.getActiveFilters()

getAvailFilters

public String[] getAvailFilters()

Description copied from interface: Plugin

Returns a list of available filters that this device supports. The array of strings returned by this method should be in a specific order as the index of the array will be used to communicate with the device later.

Specified by:

getAvailFilters in interface Plugin

Returns:

a list of Strings containing the names of the filters supported

See Also:

Device.getAvailFilters()

getSampleRate

public int getSampleRate(Device arg0)

Description copied from interface: Plugin

Gets the current sampling rate of this Device in hertz.

Specified by:

getSampleRate in interface Plugin

Returns:

the sampling rate of this device in hertz

See Also:

Device.getSampleRate()

removeFilter

public void removeFilter(Device arg0,
                         int arg1)

Description copied from interface: Plugin

Removes a filter from the list of active filters on the Device. This method does nothing at all if on-device filtering is not supported.

Specified by:

removeFilter in interface Plugin

Parameters:

arg0 - the Device to delete a filter from

arg1 - the position on the Device's active filters list to remove

resetFilters

public void resetFilters(Device arg0)
                  throws IOException

Description copied from interface: Plugin

Removes any filters currently active on the Device. This method makes it possible for the user to edit or remove filters the Device is performing. This method does nothing if on-device filtering cannot be done by this type of Device.

Specified by:

resetFilters in interface Plugin

Parameters:

arg0 - the Device to clear the filters on

Throws:

IOException - if any communication error occurs

See Also:

Plugin.addFilter(Device, int, String), Device.resetFilters()

setSampleRate

public void setSampleRate(Device arg0,
                          int arg1)
                   throws IOException

Description copied from interface: Plugin

Instructs this device to sample at a given rate. If this device is incompatible with setting a different sampling rate, this method does nothing.

Specified by:

setSampleRate in interface Plugin

arg1 - the rate to sample at in hertz

Throws:

IOException - if any communication error occurs