Firmware feature that saves data to the on-board flash memory. More...
Inheritance diagram for MbientLab.MetaWear.Core.ILogging:
Public Member Functions | |
| void | Start (bool overwrite=false) |
| Start logging data More... | |
| void | Stop () |
| Stop logging data More... | |
| void | ClearEntries () |
| Clear all stored logged data from the board. The erase operation will not be performed until you disconnect from the board. More... | |
| Task | DownloadAsync (uint nUpdates, Action< uint, uint > updateHandler) |
| Download saved data from the flash memory with periodic progress updates More... | |
| Task | DownloadAsync (Action< LogDownloadError, byte, DateTime, byte[]> errorHandler) |
| Download saved data from the flash memory with error handling but no progress updates More... | |
| Task | DownloadAsync (uint nUpdates, Action< uint, uint > updateHandler, Action< LogDownloadError, byte, DateTime, byte[]> errorHandler) |
| Download saved data from the flash memory with periodic progress updates and error handling More... | |
| Task | DownloadAsync () |
| Download saved data from the flash memory with no progress updates nor error handling More... | |
Detailed Description
Firmware feature that saves data to the on-board flash memory.
This module is used in conjunction with the data route's log component
Member Function Documentation
◆ ClearEntries()
| void MbientLab.MetaWear.Core.ILogging.ClearEntries | ( | ) |
Clear all stored logged data from the board. The erase operation will not be performed until you disconnect from the board.
◆ DownloadAsync() [1/4]
| Task MbientLab.MetaWear.Core.ILogging.DownloadAsync | ( | uint | nUpdates, |
| Action< uint, uint > | updateHandler | ||
| ) |
Download saved data from the flash memory with periodic progress updates
- Parameters
-
nUpdates How many progress updates to send during the download updateHandler Handler to accept download notifications
- Returns
- Task that will complete when the download has finished
◆ DownloadAsync() [2/4]
| Task MbientLab.MetaWear.Core.ILogging.DownloadAsync | ( | Action< LogDownloadError, byte, DateTime, byte[]> | errorHandler | ) |
Download saved data from the flash memory with error handling but no progress updates
- Parameters
-
errorHandler Handler to process encountered errors during the download
- Returns
- Task that will complete when the download has finished
◆ DownloadAsync() [3/4]
| Task MbientLab.MetaWear.Core.ILogging.DownloadAsync | ( | uint | nUpdates, |
| Action< uint, uint > | updateHandler, | ||
| Action< LogDownloadError, byte, DateTime, byte[]> | errorHandler | ||
| ) |
Download saved data from the flash memory with periodic progress updates and error handling
- Parameters
-
nUpdates How many progress updates to send during the download updateHandler Handler to accept download notifications errorHandler Handler to process encountered errors during the download
- Returns
- Task that will complete when the download has finished
◆ DownloadAsync() [4/4]
| Task MbientLab.MetaWear.Core.ILogging.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
◆ Start()
| void MbientLab.MetaWear.Core.ILogging.Start | ( | bool | overwrite = false | ) |
Start logging data
- Parameters
-
overwrite True if older entries should be overwritten when the logger is full, defaults to false
◆ Stop()
| void MbientLab.MetaWear.Core.ILogging.Stop | ( | ) |
Stop logging data
The documentation for this interface was generated from the following file:
- MetaWear/Core/ILogging.cs
