com.mbientlab.metawear.module

Interface Logging

All Superinterfaces:

MetaWearBoard.Module

public interface Logging
extends MetaWearBoard.Module

Firmware feature that saves data to the on-board flash memory

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Logging.DownloadError Types of errors encountered during a log download
static interface	Logging.LogDownloadErrorHandler Handler for processing download errors
static interface	Logging.LogDownloadUpdateHandler Handler for processing download updates

Method Summary

Modifier and Type	Method and Description
void	clearEntries() Clear all stored logged data from the board.
bolts.Task<java.lang.Void>	downloadAsync() Download saved data from the flash memory with no progress updates nor error handling
bolts.Task<java.lang.Void>	downloadAsync(int nUpdates, Logging.LogDownloadUpdateHandler updateHandler) Download saved data from the flash memory with periodic progress updates
bolts.Task<java.lang.Void>	downloadAsync(int nUpdates, Logging.LogDownloadUpdateHandler updateHandler, Logging.LogDownloadErrorHandler errorHandler) Download saved data from the flash memory with periodic progress updates and error handling
bolts.Task<java.lang.Void>	downloadAsync(Logging.LogDownloadErrorHandler errorHandler) Download saved data from the flash memory with no progress updates
void	flushPage() Flushes logging data (pending writes) to the MMS memory.
void	start(boolean overwrite) Start logging sensor data
void	stop() Stop logging sensor data

Method Detail

start

void start(boolean overwrite)

Start logging sensor data

Parameters:

overwrite - True if older entries should be overwritten when the logger is full

stop

void stop()

Stop logging sensor data

downloadAsync

bolts.Task<java.lang.Void> downloadAsync(int nUpdates,
                                         Logging.LogDownloadUpdateHandler updateHandler,
                                         Logging.LogDownloadErrorHandler errorHandler)

Download saved data from the flash memory with periodic progress updates and error handling

Parameters:

nUpdates - How many progress updates to send to Logging.LogDownloadUpdateHandler.receivedUpdate(long, long)

updateHandler - Handler to accept download notifications

errorHandler - Handler to process errors encountered during the download

Returns:

Task that will complete when the download has finished

downloadAsync

bolts.Task<java.lang.Void> downloadAsync(int nUpdates,
                                         Logging.LogDownloadUpdateHandler updateHandler)

Download saved data from the flash memory with periodic progress updates

Parameters:

nUpdates - How many progress updates to send to Logging.LogDownloadUpdateHandler.receivedUpdate(long, long)

updateHandler - Handler to accept download notifications

Returns:

Task that will complete when the download has finished

downloadAsync

bolts.Task<java.lang.Void> downloadAsync(Logging.LogDownloadErrorHandler errorHandler)

Download saved data from the flash memory with no progress updates

Parameters:

errorHandler - Handler to process encountered errors during the download

Returns:

Task that will complete when the download has finished

downloadAsync

bolts.Task<java.lang.Void> downloadAsync()

Download saved data from the flash memory with no progress updates nor error handling

Returns:

Task that will complete when the download has finished

clearEntries

void clearEntries()

Clear all stored logged data from the board. The erase operation will not be performed until you disconnect from the board.

flushPage

void flushPage()

Flushes logging data (pending writes) to the MMS memory. For MMS only. Should be called for the MMS when done with logging and ready to download data