MetaWearBoard

```
public interface MetaWearBoard
```
Controller for communicating with a MetaWear board

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static class`	`MetaWearBoard.ConnectionStateHandler` Class for handling Bluetooth LE connection events
`static interface`	`MetaWearBoard.DeviceInformation` Wrapper class around the data from the device information service
`static interface`	`MetaWearBoard.DfuProgressHandler` Deprecated. The API will no longer perform firmware updates in future releases. Instead, the dfu will be handled with Nordic's Android DFU library.
`static interface`	`MetaWearBoard.Module` Base class for on-board sensors or features supported by the board's firmware

Field Summary

Fields
Modifier and Type	Field and Description
`static java.util.UUID`	`META_WEAR_SERVICE_UUID` Deprecated.
`static java.util.UUID`	`METABOOT_SERVICE_UUID` Service UUID identifying a MetaWear board in MetaBoot mode
`static java.util.UUID`	`METAWEAR_SERVICE_UUID` Service UUID identifying a MetaWear board.

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`abortFirmwareUpdate()` Deprecated. The API will no longer perform firmware updates in future releases. Instead, the dfu will be handled with Nordic's Android DFU library.
`AsyncOperation<java.lang.Boolean>`	`checkForFirmwareUpdate()` Checks if there is a newer version of the firmware available for your board.
`void`	`connect()` Establish a connection to the board and prepare the API to communicate with the board.
`void`	`deserializeState(byte[] state)` Updates the internal state with the values in the byte array
`void`	`disconnect()` Close the connection to the board
`AsyncOperation<java.io.File>`	`downloadLatestFirmware()` Downloads the latest firmware release for the board to your Android device.
`java.lang.String`	`getMacAddress()` Retrieves the MAC address of the board
`<T extends MetaWearBoard.Module> T`	`getModule(java.lang.Class<T> moduleClass)` Retrieves a pointer to the requested module, if supported by the current board and firmware, and the board is not in MetaBoot mode.
`RouteManager`	`getRouteManager(int id)` Retrieves a route manager
`boolean`	`inMetaBootMode()` Checks if the board is in MetaBoot mode
`boolean`	`isConnected()` Retrieves the connection state
`<T extends MetaWearBoard.Module> T`	`lookupModule(java.lang.Class<T> moduleClass)` Variant of #`getModule(Class)` that does not throw a checked exception.
`AsyncOperation<java.lang.Byte>`	`readBatteryLevel()` Reads the battery level characteristic
`AsyncOperation<MetaWearBoard.DeviceInformation>`	`readDeviceInformation()` Reads supported characteristics from the Device Information service
`AsyncOperation<java.lang.Integer>`	`readRssi()` Reads the current RSSI value
`void`	`removeRoutes()` Remove all data routes
`byte[]`	`serializeState()` Serializes the internal state of the class
`void`	`setConnectionStateHandler(MetaWearBoard.ConnectionStateHandler handler)` Sets the connection state handler
`void`	`tearDown()` Removes all routes and timers from the board.
`AsyncOperation<java.lang.Void>`	`updateFirmware(java.io.File firmwareHexPath, MetaWearBoard.DfuProgressHandler handler)` Deprecated. The API will no longer perform firmware updates in future releases. Instead, the dfu will be handled with Nordic's Android DFU library.
`AsyncOperation<java.lang.Void>`	`updateFirmware(java.io.InputStream firmwareStream, MetaWearBoard.DfuProgressHandler handler)` Deprecated. The API will no longer perform firmware updates in future releases. Instead, the dfu will be handled with Nordic's Android DFU library.
`AsyncOperation<java.lang.Void>`	`updateFirmware(MetaWearBoard.DfuProgressHandler handler)` Deprecated. The API will no longer perform firmware updates in future releases. Instead, the dfu will be handled with Nordic's Android DFU library.

- Field Detail
  - METAWEAR_SERVICE_UUID
```
static final java.util.UUID METAWEAR_SERVICE_UUID
```
    Service UUID identifying a MetaWear board. This uuid can be used to filter non MetaWear devices from a Bluetooth LE scan.
  - META_WEAR_SERVICE_UUID
```
@Deprecated
static final java.util.UUID META_WEAR_SERVICE_UUID
```
    Deprecated.
    
    Old name for the MetaWear service UUID, replaced in v2.1.0 #deprecated Used METAWEAR_SERVICE_UUID instead
  - METABOOT_SERVICE_UUID
```
static final java.util.UUID METABOOT_SERVICE_UUID
```
    Service UUID identifying a MetaWear board in MetaBoot mode
- Method Detail
  - getMacAddress
```
java.lang.String getMacAddress()
```
    Retrieves the MAC address of the board
    
    Returns:
    
    Board's MAC address
  - inMetaBootMode
```
boolean inMetaBootMode()
```
    Checks if the board is in MetaBoot mode
    
    Returns:
    
    True if it is in MetaBoot mode
  - updateFirmware
```
@Deprecated
AsyncOperation<java.lang.Void> updateFirmware(MetaWearBoard.DfuProgressHandler handler)
```
    Deprecated. The API will no longer perform firmware updates in future releases. Instead, the dfu will be handled with Nordic's Android DFU library.
    
    Updates the firmware on the board to the latest available release. The update requires an active internet connection on your Android device and will terminate the Bluetooth connection when completed without calling the disconnected() callback function. You must be connected to the board before calling this function, otherwise, it will fail.
    
    Parameters:
    
    handler - Handler for processing DFU progress notifications
    
    Returns:
    
    Result of the operation that will be available when the DFU is finished
    
    See Also:
    
    downloadLatestFirmware()
  - updateFirmware
```
@Deprecated
AsyncOperation<java.lang.Void> updateFirmware(java.io.File firmwareHexPath,
                                                          MetaWearBoard.DfuProgressHandler handler)
```
    Deprecated. The API will no longer perform firmware updates in future releases. Instead, the dfu will be handled with Nordic's Android DFU library.
    
    Updates the firmware on the board with a user specified firmware file. Executing this function will terminate the Bluetooth connection without calling the disconnected() callback function. You must be connected to the board before calling this feature, otherwise, it will fail.
    
    Parameters:
    
    firmwareHexPath - Path to the firmware file
    
    handler - Handler for processing DFU progress notifications
    
    Returns:
    
    Result of the operation that will be available when the DFU is finished
    
    See Also:
    
    downloadLatestFirmware()
  - updateFirmware
```
@Deprecated
AsyncOperation<java.lang.Void> updateFirmware(java.io.InputStream firmwareStream,
                                                          MetaWearBoard.DfuProgressHandler handler)
```
    Deprecated. The API will no longer perform firmware updates in future releases. Instead, the dfu will be handled with Nordic's Android DFU library.
    
    Updates the firmware on the board using data from the provided input stream. Executing this function will terminate the Bluetooth connection without calling the disconnected() callback function. You must be connected to the board before calling this feature, otherwise, it will fail.
    
    Parameters:
    
    firmwareStream - Path to the firmware file
    
    handler - Handler for processing DFU progress notifications
    
    Returns:
    
    Result of the operation that will be available when the DFU is finished
    
    See Also:
    
    downloadLatestFirmware()
  - abortFirmwareUpdate
```
@Deprecated
void abortFirmwareUpdate()
```
    Deprecated. The API will no longer perform firmware updates in future releases. Instead, the dfu will be handled with Nordic's Android DFU library.
    
    Terminates a DFU in progress, resulting in a failure. Does nothing if no DFU is in progress
    
    See Also:
    
    downloadLatestFirmware()
  - downloadLatestFirmware
```
AsyncOperation<java.io.File> downloadLatestFirmware()
```
    Downloads the latest firmware release for the board to your Android device. You must be connected to the board before calling this function.
    
    Returns:
    
    Path to where the firmware resides on the Android device, available when the download is completed
  - checkForFirmwareUpdate
```
AsyncOperation<java.lang.Boolean> checkForFirmwareUpdate()
```
    Checks if there is a newer version of the firmware available for your board. If a newer firmware version exists, the operation will return true. The firmware check requires an active internet connection on your Android device.
    
    Returns:
    
    Result of operation that will be available when the firmware check is completed
  - getModule
```
<T extends MetaWearBoard.Module> T getModule(java.lang.Class<T> moduleClass)
                                      throws UnsupportedModuleException
```
    Retrieves a pointer to the requested module, if supported by the current board and firmware, and the board is not in MetaBoot mode. The API must be connected to the board to use this function.
    
    Parameters:
    
    moduleClass - Module class to lookup
    
    Returns:
    
    Reference to the requested module, null if the BLE connection is not active
    
    Throws:
    
    UnsupportedModuleException - if the module is not available on the board, or the board is in MetaBoot mode
  - lookupModule
```
<T extends MetaWearBoard.Module> T lookupModule(java.lang.Class<T> moduleClass)
```
    Variant of #getModule(Class) that does not throw a checked exception. The API must be connected to the board to use this function.
    
    Parameters:
    
    moduleClass - Module class to lookup
    
    Returns:
    
    Reference to the module class, null if not supported, board is in MetaBoot mode, or the API is not connected to the board
  - readDeviceInformation
```
AsyncOperation<MetaWearBoard.DeviceInformation> readDeviceInformation()
```
    Reads supported characteristics from the Device Information service
    
    Returns:
    
    DeviceInformation object that will be available when the read operation completes
  - readRssi
```
AsyncOperation<java.lang.Integer> readRssi()
```
    Reads the current RSSI value
    
    Returns:
    
    RSSI value that will be available when the read operation completes
  - readBatteryLevel
```
AsyncOperation<java.lang.Byte> readBatteryLevel()
```
    Reads the battery level characteristic
    
    Returns:
    
    Battery level that will be available when the read operation completes
  - setConnectionStateHandler
```
void setConnectionStateHandler(MetaWearBoard.ConnectionStateHandler handler)
```
    Sets the connection state handler
    
    Parameters:
    
    handler - Handler to use for connection events
  - connect
```
void connect()
```
    Establish a connection to the board and prepare the API to communicate with the board. If this is not completed within a timeout interval, the failure callback function will be called with a TimeoutException
  - disconnect
```
void disconnect()
```
    Close the connection to the board
  - isConnected
```
boolean isConnected()
```
    Retrieves the connection state
    
    Returns:
    
    True if a connection is currently established
  - getRouteManager
```
RouteManager getRouteManager(int id)
```
    Retrieves a route manager
    
    Parameters:
    
    id - Numerical ID to look up
    
    Returns:
    
    Manager corresponding to the specified ID, null if none can be found
  - removeRoutes
```
void removeRoutes()
```
    Remove all data routes
  - tearDown
```
void tearDown()
```
    Removes all routes and timers from the board. It does not reset the board so any configuration changes are preserved
  - serializeState
```
byte[] serializeState()
```
    Serializes the internal state of the class
    
    Returns:
    
    Byte array representing the class' state
  - deserializeState
```
void deserializeState(byte[] state)
```
    Updates the internal state with the values in the byte array
    
    Parameters:
    
    state - New state of the class

Interface MetaWearBoard

Nested Class Summary

Field Summary

Method Summary

Field Detail

METAWEAR_SERVICE_UUID

META_WEAR_SERVICE_UUID

METABOOT_SERVICE_UUID

Method Detail

getMacAddress

inMetaBootMode

updateFirmware

updateFirmware

updateFirmware

abortFirmwareUpdate

downloadLatestFirmware

checkForFirmwareUpdate

getModule

lookupModule

readDeviceInformation

readRssi

readBatteryLevel

setConnectionStateHandler

connect

disconnect

isConnected

getRouteManager

removeRoutes

tearDown

serializeState

deserializeState