MetaWearBoard

All Known Implementing Classes:

JseMetaWearBoard
```
public interface MetaWearBoard
```
Object representing a MetaWear board

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static interface`	`MetaWearBoard.Module` Sensor, peripheral, or firmware feature
`static interface`	`MetaWearBoard.UnexpectedDisconnectHandler` Handler for when the API is not expecting a disconnect event

Field Summary

Fields
Modifier and Type	Field and Description
`static java.util.UUID`	`METABOOT_SERVICE` UUID identifying MetaBoot boards.
`static java.util.UUID`	`METAWEAR_GATT_SERVICE` UUID identifying the MetaWear GATT service and the advertising UUID.
`static java.util.UUID`	`METAWEAR_NOTIFY_CHAR` Deprecated. Not needed by developers

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
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 `connectAsync()` tasks
`bolts.Task<java.io.File>`	`downloadFirmwareAsync(java.lang.String version)` Deprecated. Since v3.5.0, use `downloadFirmwareUpdateFilesAsync(String)` instead
`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 `downloadFirmwareUpdateFilesAsyncV2()` that lets the caller specify which firmware version to download
`bolts.Task<java.io.File>`	`downloadLatestFirmwareAsync()` Deprecated. Since v3.5.0, use `downloadFirmwareUpdateFilesAsync()` instead
`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`	`getMacAddress()` Retrieves the MAC address of the board
`Model`	`getModel()` Determines the board model of the currently connected device
`java.lang.String`	`getModelString()` Same behavior as `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
`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)

- Field Detail
  - METAWEAR_GATT_SERVICE
```
static final java.util.UUID METAWEAR_GATT_SERVICE
```
    UUID identifying the MetaWear GATT service and the advertising UUID. This UUID can be used to remove non MetaWear devices from a Bluetooth LE scan.
  - METAWEAR_NOTIFY_CHAR
```
@Deprecated
static final java.util.UUID METAWEAR_NOTIFY_CHAR
```
    Deprecated. Not needed by developers
  - METABOOT_SERVICE
```
static final java.util.UUID METABOOT_SERVICE
```
    UUID identifying MetaBoot boards. A MetaWear board advertising with this UUID indicates it is in MetaBoot mode.
- Method Detail
  - getModel
```
Model getModel()
```
    Determines the board model of the currently connected device
    
    Returns:
    
    Board model, null if unable to determine
  - getModelString
```
java.lang.String getModelString()
```
    Same behavior as getModel() except the returned value is a friendly name rather than an enum
    
    Returns:
    
    Board model as string, null if unable to determine
  - getMacAddress
```
java.lang.String getMacAddress()
```
    Retrieves the MAC address of the board
    
    Returns:
    
    Board's MAC address
  - readRssiAsync
```
bolts.Task<java.lang.Integer> readRssiAsync()
```
    Reads the current RSSI value
    
    Returns:
    
    Task holding the returned RSSI value
  - readBatteryLevelAsync
```
bolts.Task<java.lang.Byte> readBatteryLevelAsync()
```
    Reads the battery level characteristic
    
    Returns:
    
    Task holding the battery level
  - readDeviceInformationAsync
```
bolts.Task<DeviceInformation> readDeviceInformationAsync()
```
    Reads supported characteristics from the Device Information service
    
    Returns:
    
    Task holding the device information
  - downloadFirmwareUpdateFilesAsync
```
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. 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
    
    Parameters:
    
    version - Firmware revision to download, null to retrieve the latest version
    
    Returns:
    
    Task containing the list of files to upload
  - downloadFirmwareUpdateFilesAsync
```
bolts.Task<java.util.List<java.io.File>> downloadFirmwareUpdateFilesAsync()
```
    Retrieves the files needed to update the board to the latest available firmware. A connection must be first established before calling this function.
    
    Returns:
    
    Task containing the list of files to upload
  - downloadFirmwareUpdateFilesAsyncV2
```
bolts.Task<java.util.List<java.io.File>> downloadFirmwareUpdateFilesAsyncV2()
```
    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 inMetaBootMode().
    
    Returns:
    
    Task containing the list of files to upload
  - downloadFirmwareUpdateFilesAsyncV2
```
bolts.Task<java.util.List<java.io.File>> downloadFirmwareUpdateFilesAsyncV2(java.lang.String version)
```
    Variant of downloadFirmwareUpdateFilesAsyncV2() that lets the caller specify which firmware version to download
    
    Parameters:
    
    version - Firmware revision to download, null to retrieve the latest version
    
    Returns:
    
    Task containing the list of files to upload
  - findLatestAvailableFirmwareAsync
```
bolts.Task<java.lang.String> findLatestAvailableFirmwareAsync()
```
    Checks if a newer firmware version is available for the current board. A connection must be first established before calling this function.
    
    Returns:
    
    Task containing the version string, contains null if no update is available
  - downloadFirmwareAsync
```
@Deprecated
bolts.Task<java.io.File> downloadFirmwareAsync(java.lang.String version)
```
    Deprecated. Since v3.5.0, use downloadFirmwareUpdateFilesAsync(String) instead
    
    Downloads the specific firmware release for the board to your local device. You must be connected to the board before calling this function.
    
    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
```
@Deprecated
bolts.Task<java.io.File> downloadLatestFirmwareAsync()
```
    Deprecated. Since v3.5.0, use downloadFirmwareUpdateFilesAsync() instead
    
    Downloads the latest firmware release for the board to your local device. You must be connected to the board before calling this function.
    
    Returns:
    
    Task holding the file pointing to where the downloaded firmware resides on the local device
  - checkForFirmwareUpdateAsync
```
bolts.Task<java.lang.Boolean> checkForFirmwareUpdateAsync()
```
    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.
    
    Returns:
    
    Task holding the result of the firmware check, true if a firmware update is available
  - connectAsync
```
bolts.Task<java.lang.Void> connectAsync()
```
    Establishes a Bluetooth Low Energy connection to the MetaWear board
    
    Returns:
    
    Task holding the result of the connect attempt
  - connectWithRetryAsync
```
bolts.Task<java.lang.Void> connectWithRetryAsync(int retries)
```
    Establishes a Bluetooth Low Energy connection to the MetaWear board
    
    Parameters:
    
    retries - Number of retry attempts before completing the task with an error
    
    Returns:
    
    Task holding the result of the connect attempt
  - connectAsync
```
bolts.Task<java.lang.Void> connectAsync(long delay)
```
    Establishes a Bluetooth Low Energy connection to the MetaWear board
    
    Parameters:
    
    delay - How long to wait (in milliseconds) before attempting to connect
    
    Returns:
    
    Task holding the result of the connect attempt
  - disconnectAsync
```
bolts.Task<java.lang.Void> disconnectAsync()
```
    Disconnects from the board and cancels pending connectAsync() tasks
    
    Returns:
    
    Task holding the result of the disconnect attempt
  - onUnexpectedDisconnect
```
void onUnexpectedDisconnect(MetaWearBoard.UnexpectedDisconnectHandler handler)
```
    Set a handler for unexpected disconnects
    
    Parameters:
    
    handler - Handler for unexpected disconnects
  - isConnected
```
boolean isConnected()
```
    Gets the connection state
    
    Returns:
    
    True if a btle connection is active, false otherwise
  - inMetaBootMode
```
boolean inMetaBootMode()
```
    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.
    
    Returns:
    
    True if the board is in MetaBoot mode, false otherwise
  - getModule
```
<T extends MetaWearBoard.Module> T getModule(java.lang.Class<T> moduleClass)
```
    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
    
    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
```
<T extends MetaWearBoard.Module> T getModuleOrThrow(java.lang.Class<T> moduleClass)
                                             throws UnsupportedModuleException
```
    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
    
    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
  - createAnonymousRoutesAsync
```
bolts.Task<AnonymousRoute[]> createAnonymousRoutesAsync()
```
    Reads the current state of the board and creates anonymous routes based on what data is being logged
    
    Returns:
    
    Task that is completed when the anonymous routes are created
  - lookupRoute
```
Route lookupRoute(int id)
```
    Retrieves a route
    
    Parameters:
    
    id - Numerical ID to look up
    
    Returns:
    
    Route corresponding to the specified ID, null if none can be found
  - lookupObserver
```
Observer lookupObserver(int id)
```
    Retrieves an observer
    
    Parameters:
    
    id - Numerical ID to look up
    
    Returns:
    
    Observer corresponding to the specified ID, null if none can be found
  - tearDown
```
void tearDown()
```
    Removes all routes and resources allocated on the board (observers, data processors, timers, and loggers)
  - serialize
```
void serialize()
        throws java.io.IOException
```
    Serialize object state and write the state to the local disk
    
    Throws:
    
    java.io.IOException - If the internal OutputStream throws an exception
  - serialize
```
void serialize(java.io.OutputStream outs)
        throws java.io.IOException
```
    Serialize object state and write the state to the provided output stream
    
    Parameters:
    
    outs - Output stream to write to
    
    Throws:
    
    java.io.IOException - If the provided OutputStream throws an exception
  - deserialize
```
void deserialize()
          throws java.io.IOException,
                 java.lang.ClassNotFoundException
```
    Restore serialized state from the local disk if available
    
    Throws:
    
    java.io.IOException - If the internal InputStream throws an exception
    
    java.lang.ClassNotFoundException - Class of a serialized object cannot be found
  - deserialize
```
void deserialize(java.io.InputStream ins)
          throws java.io.IOException,
                 java.lang.ClassNotFoundException
```
    Restore serialized state from the provided input stream
    
    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
```
bolts.Task<org.json.JSONObject> dumpModuleInfo(org.json.JSONObject partial)
```
    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.
    
    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

Interface MetaWearBoard

Nested Class Summary

Field Summary

Method Summary

Field Detail

METAWEAR_GATT_SERVICE

METAWEAR_NOTIFY_CHAR

METABOOT_SERVICE

Method Detail

getModel

getModelString

getMacAddress

readRssiAsync

readBatteryLevelAsync

readDeviceInformationAsync

downloadFirmwareUpdateFilesAsync

downloadFirmwareUpdateFilesAsync

downloadFirmwareUpdateFilesAsyncV2

downloadFirmwareUpdateFilesAsyncV2

findLatestAvailableFirmwareAsync

downloadFirmwareAsync

downloadLatestFirmwareAsync

checkForFirmwareUpdateAsync

connectAsync

connectWithRetryAsync

connectAsync

disconnectAsync

onUnexpectedDisconnect

isConnected

inMetaBootMode

getModule

getModuleOrThrow

createAnonymousRoutesAsync

lookupRoute

lookupObserver

tearDown

serialize

serialize

deserialize

deserialize

dumpModuleInfo