com.mbientlab.metawear.impl

Class JseMetaWearBoard

java.lang.Object

com.mbientlab.metawear.impl.JseMetaWearBoard

All Implemented Interfaces:

MetaWearBoard

public class JseMetaWearBoard
extends java.lang.Object
implements MetaWearBoard

Platform agnostic implementation of the MetaWearBoard interface using only standard Java APIs. Platform specific functionality is abstracted with the IO and BtleGatt interfaces.

Nested Class Summary

Nested classes/interfaces inherited from interface com.mbientlab.metawear.MetaWearBoard

MetaWearBoard.Module, MetaWearBoard.UnexpectedDisconnectHandler

Field Summary

Fields inherited from interface com.mbientlab.metawear.MetaWearBoard

METABOOT_SERVICE, METAWEAR_GATT_SERVICE, METAWEAR_NOTIFY_CHAR

Constructor Summary

Constructors

Constructor and Description
JseMetaWearBoard(BtleGatt gatt, IO io, java.lang.String macAddress, java.lang.String libVersion) Constructs a JseMetaWearBoard object

Method Summary

Modifier and Type	Method and Description
bolts.Task<java.lang.Boolean>	checkForFirmwareUpdateAsync() Checks if there is a newer version of the firmware available for your board.
bolts.Task<java.lang.Void>	connectAsync() Establishes a Bluetooth Low Energy connection to the MetaWear board
bolts.Task<java.lang.Void>	connectAsync(long delay) Establishes a Bluetooth Low Energy connection to the MetaWear board
bolts.Task<java.lang.Void>	connectWithRetryAsync(int retries) Establishes a Bluetooth Low Energy connection to the MetaWear board
bolts.Task<AnonymousRoute[]>	createAnonymousRoutesAsync() Reads the current state of the board and creates anonymous routes based on what data is being logged
void	deserialize() Restore serialized state from the local disk if available
void	deserialize(java.io.InputStream ins) Restore serialized state from the provided input stream
bolts.Task<java.lang.Void>	disconnectAsync() Disconnects from the board and cancels pending MetaWearBoard.connectAsync() tasks
bolts.Task<java.io.File>	downloadFirmwareAsync(java.lang.String version) Downloads the specific firmware release for the board to your local device.
bolts.Task<java.util.List<java.io.File>>	downloadFirmwareUpdateFilesAsync() Retrieves the files needed to update the board to the latest available firmware.
bolts.Task<java.util.List<java.io.File>>	downloadFirmwareUpdateFilesAsync(java.lang.String version) Retrieves the files needed to update the board to the specific firmware version.
bolts.Task<java.util.List<java.io.File>>	downloadFirmwareUpdateFilesAsyncV2() Retrieves the files needed to update the board to the latest available firmware.
bolts.Task<java.util.List<java.io.File>>	downloadFirmwareUpdateFilesAsyncV2(java.lang.String version) Variant of MetaWearBoard.downloadFirmwareUpdateFilesAsyncV2() that lets the caller specify which firmware version to download
bolts.Task<java.io.File>	downloadLatestFirmwareAsync() Downloads the latest firmware release for the board to your local device.
bolts.Task<org.json.JSONObject>	dumpModuleInfo(org.json.JSONObject partial) Queries all info registers.
bolts.Task<java.lang.String>	findLatestAvailableFirmwareAsync() Checks if a newer firmware version is available for the current board.
java.lang.String	getFirmware()
java.lang.String	getMacAddress() Retrieves the MAC address of the board
Model	getModel() Determines the board model of the currently connected device
java.lang.String	getModelNumber()
java.lang.String	getModelString() Same behavior as MetaWearBoard.getModel() except the returned value is a friendly name rather than an enum
<T extends MetaWearBoard.Module> T	getModule(java.lang.Class<T> moduleClass) Retrieves a reference to the requested module if supported.
<T extends MetaWearBoard.Module> T	getModuleOrThrow(java.lang.Class<T> moduleClass) Retrieves a reference to the requested module if supported, throws a checked exception if the function fails.
boolean	inMetaBootMode() Checks if the board is in the MetaBoot (bootloader) mode.
boolean	isConnected() Gets the connection state
void	loadBoardAttributes()
Observer	lookupObserver(int id) Retrieves an observer
Route	lookupRoute(int id) Retrieves a route
void	onUnexpectedDisconnect(MetaWearBoard.UnexpectedDisconnectHandler handler) Set a handler for unexpected disconnects
bolts.Task<java.lang.Byte>	readBatteryLevelAsync() Reads the battery level characteristic
bolts.Task<DeviceInformation>	readDeviceInformationAsync() Reads supported characteristics from the Device Information service
bolts.Task<java.lang.Integer>	readRssiAsync() Reads the current RSSI value
void	serialize() Serialize object state and write the state to the local disk
void	serialize(java.io.OutputStream outs) Serialize object state and write the state to the provided output stream
void	tearDown() Removes all routes and resources allocated on the board (observers, data processors, timers, and loggers)

Methods inherited from class java.lang.Object

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

Constructor Detail

JseMetaWearBoard

public JseMetaWearBoard(BtleGatt gatt,
                        IO io,
                        java.lang.String macAddress,
                        java.lang.String libVersion)

Constructs a JseMetaWearBoard object

Parameters:

gatt - Object for handing Bluetooth LE GATT operations

io - Object for handling IO operations

macAddress - Device's MAC address

Method Detail

getFirmware

public java.lang.String getFirmware()

getModelNumber

public java.lang.String getModelNumber()

getModel

public Model getModel()

Description copied from interface: MetaWearBoard

Determines the board model of the currently connected device

Specified by:

getModel in interface MetaWearBoard

Returns:

Board model, null if unable to determine

getModelString

public java.lang.String getModelString()

Description copied from interface: MetaWearBoard

Same behavior as MetaWearBoard.getModel() except the returned value is a friendly name rather than an enum

Specified by:

getModelString in interface MetaWearBoard

Returns:

Board model as string, null if unable to determine

getMacAddress

public java.lang.String getMacAddress()

Description copied from interface: MetaWearBoard

Retrieves the MAC address of the board

Specified by:

getMacAddress in interface MetaWearBoard

Returns:

Board's MAC address

readRssiAsync

public bolts.Task<java.lang.Integer> readRssiAsync()

Description copied from interface: MetaWearBoard

Reads the current RSSI value

Specified by:

readRssiAsync in interface MetaWearBoard

Returns:

Task holding the returned RSSI value

readBatteryLevelAsync

public bolts.Task<java.lang.Byte> readBatteryLevelAsync()

Description copied from interface: MetaWearBoard

Reads the battery level characteristic

Specified by:

readBatteryLevelAsync in interface MetaWearBoard

Returns:

Task holding the battery level

readDeviceInformationAsync

public bolts.Task<DeviceInformation> readDeviceInformationAsync()

Description copied from interface: MetaWearBoard

Reads supported characteristics from the Device Information service

Specified by:

readDeviceInformationAsync in interface MetaWearBoard

Returns:

Task holding the device information

downloadFirmwareUpdateFilesAsync

public bolts.Task<java.util.List<java.io.File>> downloadFirmwareUpdateFilesAsync(java.lang.String version)

Description copied from interface: MetaWearBoard

Retrieves the files needed to update the board to the specific firmware version. A connection must be first established before calling this function. When uploading the files, ensure that they are uploaded in the same order as the returned list

Specified by:

downloadFirmwareUpdateFilesAsync in interface MetaWearBoard

Parameters:

version - Firmware revision to download, null to retrieve the latest version

Returns:

Task containing the list of files to upload

downloadFirmwareUpdateFilesAsync

public bolts.Task<java.util.List<java.io.File>> downloadFirmwareUpdateFilesAsync()

Description copied from interface: MetaWearBoard

Retrieves the files needed to update the board to the latest available firmware. A connection must be first established before calling this function.

Specified by:

downloadFirmwareUpdateFilesAsync in interface MetaWearBoard

Returns:

Task containing the list of files to upload

downloadFirmwareUpdateFilesAsyncV2

public bolts.Task<java.util.List<java.io.File>> downloadFirmwareUpdateFilesAsyncV2(java.lang.String version)

Description copied from interface: MetaWearBoard

Variant of MetaWearBoard.downloadFirmwareUpdateFilesAsyncV2() that lets the caller specify which firmware version to download

Specified by:

downloadFirmwareUpdateFilesAsyncV2 in interface MetaWearBoard

Parameters:

version - Firmware revision to download, null to retrieve the latest version

Returns:

Task containing the list of files to upload

downloadFirmwareUpdateFilesAsyncV2

public bolts.Task<java.util.List<java.io.File>> downloadFirmwareUpdateFilesAsyncV2()

Description copied from interface: MetaWearBoard

Retrieves the files needed to update the board to the latest available firmware. A connection must be first established before calling this function. Depending on how far the download proceeded, the board may be in MetaBoot mode when the task completes, check the board state with MetaWearBoard.inMetaBootMode().

Specified by:

downloadFirmwareUpdateFilesAsyncV2 in interface MetaWearBoard

Returns:

Task containing the list of files to upload

findLatestAvailableFirmwareAsync

public bolts.Task<java.lang.String> findLatestAvailableFirmwareAsync()

Description copied from interface: MetaWearBoard

Checks if a newer firmware version is available for the current board. A connection must be first established before calling this function.

Specified by:

findLatestAvailableFirmwareAsync in interface MetaWearBoard

Returns:

Task containing the version string, contains null if no update is available

downloadFirmwareAsync

public bolts.Task<java.io.File> downloadFirmwareAsync(java.lang.String version)

Description copied from interface: MetaWearBoard

Downloads the specific firmware release for the board to your local device. You must be connected to the board before calling this function.

Specified by:

downloadFirmwareAsync in interface MetaWearBoard

Parameters:

version - Firmware revision to download, null to retrieve the latest version

Returns:

Task holding the file pointing to where the downloaded firmware resides on the local device

downloadLatestFirmwareAsync

public bolts.Task<java.io.File> downloadLatestFirmwareAsync()

Description copied from interface: MetaWearBoard

Downloads the latest firmware release for the board to your local device. You must be connected to the board before calling this function.

Specified by:

downloadLatestFirmwareAsync in interface MetaWearBoard

Returns:

Task holding the file pointing to where the downloaded firmware resides on the local device

checkForFirmwareUpdateAsync

public bolts.Task<java.lang.Boolean> checkForFirmwareUpdateAsync()

Description copied from interface: MetaWearBoard

Checks if there is a newer version of the firmware available for your board. The firmware check requires you to be connected to your board and an active internet connection on your local device.

Specified by:

checkForFirmwareUpdateAsync in interface MetaWearBoard

Returns:

Task holding the result of the firmware check, true if a firmware update is available

loadBoardAttributes

public void loadBoardAttributes()
                         throws java.io.IOException,
                                java.lang.ClassNotFoundException

Throws:

java.io.IOException

java.lang.ClassNotFoundException

connectAsync

public bolts.Task<java.lang.Void> connectAsync()

Description copied from interface: MetaWearBoard

Establishes a Bluetooth Low Energy connection to the MetaWear board

Specified by:

connectAsync in interface MetaWearBoard

Returns:

Task holding the result of the connect attempt

connectWithRetryAsync

public bolts.Task<java.lang.Void> connectWithRetryAsync(int retries)

Description copied from interface: MetaWearBoard

Establishes a Bluetooth Low Energy connection to the MetaWear board

Specified by:

connectWithRetryAsync in interface MetaWearBoard

Parameters:

retries - Number of retry attempts before completing the task with an error

Returns:

Task holding the result of the connect attempt

connectAsync

public bolts.Task<java.lang.Void> connectAsync(long delay)

Description copied from interface: MetaWearBoard

Establishes a Bluetooth Low Energy connection to the MetaWear board

Specified by:

connectAsync in interface MetaWearBoard

Parameters:

delay - How long to wait (in milliseconds) before attempting to connect

Returns:

Task holding the result of the connect attempt

disconnectAsync

public bolts.Task<java.lang.Void> disconnectAsync()

Description copied from interface: MetaWearBoard

Disconnects from the board and cancels pending MetaWearBoard.connectAsync() tasks

Specified by:

disconnectAsync in interface MetaWearBoard

Returns:

Task holding the result of the disconnect attempt

onUnexpectedDisconnect

public void onUnexpectedDisconnect(MetaWearBoard.UnexpectedDisconnectHandler handler)

Description copied from interface: MetaWearBoard

Set a handler for unexpected disconnects

Specified by:

onUnexpectedDisconnect in interface MetaWearBoard

Parameters:

handler - Handler for unexpected disconnects

isConnected

public boolean isConnected()

Description copied from interface: MetaWearBoard

Gets the connection state

Specified by:

isConnected in interface MetaWearBoard

Returns:

True if a btle connection is active, false otherwise

inMetaBootMode

public boolean inMetaBootMode()

Description copied from interface: MetaWearBoard

Checks if the board is in the MetaBoot (bootloader) mode. If it is, you will not be able to interact with the board outside of reading RSSI values and updating firmware.

Specified by:

inMetaBootMode in interface MetaWearBoard

Returns:

True if the board is in MetaBoot mode, false otherwise

getModule

public <T extends MetaWearBoard.Module> T getModule(java.lang.Class<T> moduleClass)

Description copied from interface: MetaWearBoard

Retrieves a reference to the requested module if supported. You must connected to the board before calling this function and the board must not be in MetaBoot mode

Specified by:

getModule in interface MetaWearBoard

Type Parameters:

T - Runtime type the return value is casted as

Parameters:

moduleClass - Module class to lookup

Returns:

Reference to the requested module, null if the board is not connected, module not supported, or board is in MetaBoot mode

getModuleOrThrow

public <T extends MetaWearBoard.Module> T getModuleOrThrow(java.lang.Class<T> moduleClass)
                                                    throws UnsupportedModuleException

Description copied from interface: MetaWearBoard

Retrieves a reference to the requested module if supported, throws a checked exception if the function fails. You must connected to the board before calling this function and the board must not be in MetaBoot mode

Specified by:

getModuleOrThrow in interface MetaWearBoard

Type Parameters:

T - Runtime type the return value is casted as

Parameters:

moduleClass - ModuleId class to lookup

Returns:

Reference to the requested module

Throws:

UnsupportedModuleException - If the requested module is not supported or the board is in MetaBoot mode

lookupRoute

public Route lookupRoute(int id)

Description copied from interface: MetaWearBoard

Retrieves a route

Specified by:

lookupRoute in interface MetaWearBoard

Parameters:

id - Numerical ID to look up

Returns:

Route corresponding to the specified ID, null if none can be found

lookupObserver

public Observer lookupObserver(int id)

Description copied from interface: MetaWearBoard

Retrieves an observer

Specified by:

lookupObserver in interface MetaWearBoard

Parameters:

id - Numerical ID to look up

Returns:

Observer corresponding to the specified ID, null if none can be found

tearDown

public void tearDown()

Description copied from interface: MetaWearBoard

Removes all routes and resources allocated on the board (observers, data processors, timers, and loggers)

Specified by:

tearDown in interface MetaWearBoard

serialize

public void serialize()
               throws java.io.IOException

Description copied from interface: MetaWearBoard

Serialize object state and write the state to the local disk

Specified by:

serialize in interface MetaWearBoard

Throws:

java.io.IOException - If the internal OutputStream throws an exception

serialize

public void serialize(java.io.OutputStream outs)
               throws java.io.IOException

Description copied from interface: MetaWearBoard

Serialize object state and write the state to the provided output stream

Specified by:

serialize in interface MetaWearBoard

Parameters:

outs - Output stream to write to

Throws:

java.io.IOException - If the provided OutputStream throws an exception

deserialize

public void deserialize()
                 throws java.io.IOException,
                        java.lang.ClassNotFoundException

Description copied from interface: MetaWearBoard

Restore serialized state from the local disk if available

Specified by:

deserialize in interface MetaWearBoard

Throws:

java.io.IOException - If the internal InputStream throws an exception

java.lang.ClassNotFoundException - Class of a serialized object cannot be found

deserialize

public void deserialize(java.io.InputStream ins)
                 throws java.io.IOException,
                        java.lang.ClassNotFoundException

Description copied from interface: MetaWearBoard

Restore serialized state from the provided input stream

Specified by:

deserialize in interface MetaWearBoard

Parameters:

ins - Input stream to read from

Throws:

java.io.IOException - If the provided InputStream throws an exception

java.lang.ClassNotFoundException - Class of a serialized object cannot be found

dumpModuleInfo

public bolts.Task<org.json.JSONObject> dumpModuleInfo(org.json.JSONObject partial)

Description copied from interface: MetaWearBoard

Queries all info registers. If the task times out, you can run the task again using the partially completed result from the previous execution so the function does not need to query all modules again.

Specified by:

dumpModuleInfo in interface MetaWearBoard

Parameters:

partial - Map of previously queries module info results, set to null to query all modules

Returns:

Task that is completed once the query is completed

createAnonymousRoutesAsync

public bolts.Task<AnonymousRoute[]> createAnonymousRoutesAsync()

Description copied from interface: MetaWearBoard

Reads the current state of the board and creates anonymous routes based on what data is being logged

Specified by:

createAnonymousRoutesAsync in interface MetaWearBoard

Returns:

Task that is completed when the anonymous routes are created