com.mbientlab.metawear.api

Interface MetaWearController

public interface MetaWearController

Controller that issues commands to a MetaWear board

Author:

Eric Tsai

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	MetaWearController.DeviceCallbacks Callbacks for general Bluetooth Le events
static interface	MetaWearController.ModuleCallbacks Callback functions for MetaWear specific events.
static interface	MetaWearController.ModuleController Generic type for classes that communicate with a MetaWear module

Method Summary

Methods

Modifier and Type	Method and Description
MetaWearController	addDeviceCallback(MetaWearController.DeviceCallbacks callback) Add a device callback for the broadcast receiver
MetaWearController	addModuleCallback(MetaWearController.ModuleCallbacks callback) Add a module callback for the broadcast receiver
void	clearCallbacks() Remove all callbacks associated with this controller
void	close(boolean notify) Immediately close the connection to the board this controller is attached to
void	close(boolean notify, boolean wait) Deprecated. As of v1.4, use the waitToClose(boolean) method instead
void	connect() Connect to the board this controller is attached to
MetaWearController.ModuleController	getModuleController(Module module) Get the controller for the desired module.
boolean	isConnected() Gets the connection statue to a board
void	readBatteryLevel() Reads the battery level characteristic.
void	readDeviceInformation() Reads general device information from the MetaWear board.
void	readRemoteRSSI() Reads the remote RSSI value of the connected device.
void	reconnect(boolean notify) Reset the connection to the board this controller is attached to
void	removeDeviceCallback(MetaWearController.DeviceCallbacks callback) Remove specific device callback
void	removeModuleCallback(MetaWearController.ModuleCallbacks callback) Remove specific module callback
void	setRetainState(boolean retain) Sets how to handle the device state when the board disconnects.
void	waitToClose(boolean notify) Wait for queued BLE commands to finish communicating with the board before closing the connection

Method Detail

getModuleController

MetaWearController.ModuleController getModuleController(Module module)

Get the controller for the desired module.

Parameters:

module - Module to control

Returns:

Controller for the desired module

readDeviceInformation

void readDeviceInformation()

Reads general device information from the MetaWear board. The information available is listed in the DeviceInformation enum and the receivedGATTCharacteristic function will be called for each characteristic that has been read

See Also:

MetaWearController.DeviceCallbacks.receivedGATTCharacteristic(com.mbientlab.metawear.api.GATT.GATTCharacteristic, byte[]), DeviceInformation

readBatteryLevel

void readBatteryLevel()

Reads the battery level characteristic. When data is received, the MetaWearController.DeviceCallbacks.receivedGATTCharacteristic(com.mbientlab.metawear.api.GATT.GATTCharacteristic, byte[]) callback function will be called with the BATTERY_LEVEL GATT characteristic

See Also:

Battery

readRemoteRSSI

void readRemoteRSSI()

Reads the remote RSSI value of the connected device. When data is received, the MetaWearController.DeviceCallbacks.receivedRemoteRSSI(int) callback function will be called with the RSSI value.

addModuleCallback

MetaWearController addModuleCallback(MetaWearController.ModuleCallbacks callback)

Add a module callback for the broadcast receiver

Parameters:

callback - Module callback to add

Returns:

The calling object

addDeviceCallback

MetaWearController addDeviceCallback(MetaWearController.DeviceCallbacks callback)

Add a device callback for the broadcast receiver

Parameters:

callback - Device callback to add

Returns:

The calling object

clearCallbacks

void clearCallbacks()

Remove all callbacks associated with this controller

removeModuleCallback

void removeModuleCallback(MetaWearController.ModuleCallbacks callback)

Remove specific module callback

Parameters:

callback -

removeDeviceCallback

void removeDeviceCallback(MetaWearController.DeviceCallbacks callback)

Remove specific device callback

Parameters:

callback -

setRetainState

void setRetainState(boolean retain)

Sets how to handle the device state when the board disconnects. If the device state is not retained, the state is reset and all references to the state are discarded upon disconnecting. Users can continue using the controller provided they obtained a controller from MetaWearBleService#getMetaWearController(android.bluetooth.BluetoothDevice) and reconnected to the board via the connect() function

Parameters:

retain - False if internal state should be discarded when the device disconnects

connect

void connect()

Connect to the board this controller is attached to

close

void close(boolean notify)

Immediately close the connection to the board this controller is attached to

Parameters:

notify - True to make a call to the MetaWearController.DeviceCallbacks.disconnected() callback function

close

@Deprecated
void close(boolean notify,
                    boolean wait)

Deprecated. As of v1.4, use the waitToClose(boolean) method instead

Close the connection to the board this controller is attached to

Parameters:

notify - True to make a call to the MetaWearController.DeviceCallbacks.disconnected() callback function

wait - True if any pending commands should be broadcasted before closing. Any commands queued after this function call are ignored

waitToClose

void waitToClose(boolean notify)

Wait for queued BLE commands to finish communicating with the board before closing the connection

Parameters:

notify - True to make a call to the MetaWearController.DeviceCallbacks.disconnected() call back function

reconnect

void reconnect(boolean notify)

Reset the connection to the board this controller is attached to

Parameters:

notify - True to make a call to the MetaWearController.DeviceCallbacks.disconnected() callback function

isConnected

boolean isConnected()

Gets the connection statue to a board

Returns:

True if connected to a board