ni / niveristand-embedded-data-logger-custom-device

VeriStand embedded data logger custom device
MIT License
3 stars 10 forks source link

File span support #13

Closed debryant closed 4 years ago

debryant commented 4 years ago

What does this Pull Request accomplish?

Add file spanning support to the embedded data logger custom device such that a tdms file can optionally be closed and a new one opened after a defined time has passed or the tdms file reaches a defined size.

Why should this Pull Request be merged?

Some tests may execute over an extended period of time, which can issue in a very large tdms file when only a single file is generated to contain all of the logged data. Very large files can be unmanageable, taking longer times to load into a viewer or search for particular data sets. Allowing files to be broken into manageable chunks can increase usability and access of the tdms data.

Fixes #2

What testing has been done?

Created new unit tests for the feature and ran the full set of existing tests.

niveristand-diff-bot commented 4 years ago

Bleep bloop!

LabVIEW Diff Robot here with some diffs served up hot for your pull request.

Notice something funny? Help fix me on my GitHub repo.

Embedded Data Logger Engine.lvlib--Asynchronous Logging Loop.vi.png ![capture](https://raw.githubusercontent.com/niveristand-diff-bot/diff-images/master/VeriStand/ni/niveristand-embedded-data-logger-custom-device/PR-13/2020-02-19/12%3A31%3A21/Embedded%20Data%20Logger%20Engine.lvlib--Asynchronous%20Logging%20Loop.vi.png)
Embedded Data Logger Engine.lvlib--Compute if Should Span.vi.png ![capture](https://raw.githubusercontent.com/niveristand-diff-bot/diff-images/master/VeriStand/ni/niveristand-embedded-data-logger-custom-device/PR-13/2020-02-19/12%3A31%3A21/Embedded%20Data%20Logger%20Engine.lvlib--Compute%20if%20Should%20Span.vi.png)
Embedded Data Logger Engine.lvlib--Flush Close Archive File.vi.png ![capture](https://raw.githubusercontent.com/niveristand-diff-bot/diff-images/master/VeriStand/ni/niveristand-embedded-data-logger-custom-device/PR-13/2020-02-19/12%3A31%3A21/Embedded%20Data%20Logger%20Engine.lvlib--Flush%20Close%20Archive%20File.vi.png)
Embedded Data Logger Engine.lvlib--Get Data Log Directory Settings.vi.png ![capture](https://raw.githubusercontent.com/niveristand-diff-bot/diff-images/master/VeriStand/ni/niveristand-embedded-data-logger-custom-device/PR-13/2020-02-19/12%3A31%3A21/Embedded%20Data%20Logger%20Engine.lvlib--Get%20Data%20Log%20Directory%20Settings.vi.png)
Embedded Data Logger Engine.lvlib--Get Data Log File Settings.vi.png ![capture](https://raw.githubusercontent.com/niveristand-diff-bot/diff-images/master/VeriStand/ni/niveristand-embedded-data-logger-custom-device/PR-13/2020-02-19/12%3A31%3A21/Embedded%20Data%20Logger%20Engine.lvlib--Get%20Data%20Log%20File%20Settings.vi.png)
Embedded Data Logger Engine.lvlib--Initialize Logging Data.vi.png ![capture](https://raw.githubusercontent.com/niveristand-diff-bot/diff-images/master/VeriStand/ni/niveristand-embedded-data-logger-custom-device/PR-13/2020-02-19/12%3A31%3A21/Embedded%20Data%20Logger%20Engine.lvlib--Initialize%20Logging%20Data.vi.png)
Embedded Data Logger Shared.lvlib--Constants.vi.png ![capture](https://raw.githubusercontent.com/niveristand-diff-bot/diff-images/master/VeriStand/ni/niveristand-embedded-data-logger-custom-device/PR-13/2020-02-19/12%3A31%3A21/Embedded%20Data%20Logger%20Shared.lvlib--Constants.vi.png)
Embedded Data Logger Shared.lvlib--Get Data Log File Span Settings.vi.png ![capture](https://raw.githubusercontent.com/niveristand-diff-bot/diff-images/master/VeriStand/ni/niveristand-embedded-data-logger-custom-device/PR-13/2020-02-19/12%3A31%3A21/Embedded%20Data%20Logger%20Shared.lvlib--Get%20Data%20Log%20File%20Span%20Settings.vi.png)
Embedded Data Logger System Explorer.lvlib--Enable or Disable.vi.png ![capture](https://raw.githubusercontent.com/niveristand-diff-bot/diff-images/master/VeriStand/ni/niveristand-embedded-data-logger-custom-device/PR-13/2020-02-19/12%3A31%3A21/Embedded%20Data%20Logger%20System%20Explorer.lvlib--Enable%20or%20Disable.vi.png)
Embedded Data Logger System Explorer.lvlib--File Page.vi.png ![capture](https://raw.githubusercontent.com/niveristand-diff-bot/diff-images/master/VeriStand/ni/niveristand-embedded-data-logger-custom-device/PR-13/2020-02-19/12%3A31%3A21/Embedded%20Data%20Logger%20System%20Explorer.lvlib--File%20Page.vi.png)
Post Error.vi.png ![capture](https://raw.githubusercontent.com/niveristand-diff-bot/diff-images/master/VeriStand/ni/niveristand-embedded-data-logger-custom-device/PR-13/2020-02-19/12%3A31%3A21/Post%20Error.vi.png)
Post Information.vi.png ![capture](https://raw.githubusercontent.com/niveristand-diff-bot/diff-images/master/VeriStand/ni/niveristand-embedded-data-logger-custom-device/PR-13/2020-02-19/12%3A31%3A21/Post%20Information.vi.png)

The following VIs could not be diffed:

niphilj commented 4 years ago

@debryant , in the situation where you configure a new log file based on a time span, the time then elapses to create a new file but no data was ever written to previous log file. Do you expect that a new file will be created regardless, potentially creating a set of empty files?

Whatever the decision, to be ok with empty files, or only generate new files when the previous file is >0kb, please add a test that validates that behavior.

niveristand-diff-bot commented 4 years ago

Bleep bloop!

LabVIEW Diff Robot here with some diffs served up hot for your pull request.

Notice something funny? Help fix me on my GitHub repo.

Embedded Data Logger Engine.lvlib--Asynchronous Logging Loop.vi.png ![capture](https://raw.githubusercontent.com/niveristand-diff-bot/diff-images/master/VeriStand/ni/niveristand-embedded-data-logger-custom-device/PR-13/2020-02-21/18%3A33%3A10/Embedded%20Data%20Logger%20Engine.lvlib--Asynchronous%20Logging%20Loop.vi.png)
Embedded Data Logger Engine.lvlib--Compute if Should Span.vi.png ![capture](https://raw.githubusercontent.com/niveristand-diff-bot/diff-images/master/VeriStand/ni/niveristand-embedded-data-logger-custom-device/PR-13/2020-02-21/18%3A33%3A10/Embedded%20Data%20Logger%20Engine.lvlib--Compute%20if%20Should%20Span.vi.png)
Embedded Data Logger Engine.lvlib--Flush Close Archive File.vi.png ![capture](https://raw.githubusercontent.com/niveristand-diff-bot/diff-images/master/VeriStand/ni/niveristand-embedded-data-logger-custom-device/PR-13/2020-02-21/18%3A33%3A10/Embedded%20Data%20Logger%20Engine.lvlib--Flush%20Close%20Archive%20File.vi.png)
Embedded Data Logger Engine.lvlib--Flush File Data.vi.png ![capture](https://raw.githubusercontent.com/niveristand-diff-bot/diff-images/master/VeriStand/ni/niveristand-embedded-data-logger-custom-device/PR-13/2020-02-21/18%3A33%3A10/Embedded%20Data%20Logger%20Engine.lvlib--Flush%20File%20Data.vi.png)
Embedded Data Logger Engine.lvlib--Get Data Log Directory Settings.vi.png ![capture](https://raw.githubusercontent.com/niveristand-diff-bot/diff-images/master/VeriStand/ni/niveristand-embedded-data-logger-custom-device/PR-13/2020-02-21/18%3A33%3A10/Embedded%20Data%20Logger%20Engine.lvlib--Get%20Data%20Log%20Directory%20Settings.vi.png)
Embedded Data Logger Engine.lvlib--Get Data Log File Settings.vi.png ![capture](https://raw.githubusercontent.com/niveristand-diff-bot/diff-images/master/VeriStand/ni/niveristand-embedded-data-logger-custom-device/PR-13/2020-02-21/18%3A33%3A10/Embedded%20Data%20Logger%20Engine.lvlib--Get%20Data%20Log%20File%20Settings.vi.png)
Embedded Data Logger Engine.lvlib--Initialize Logging Data.vi.png ![capture](https://raw.githubusercontent.com/niveristand-diff-bot/diff-images/master/VeriStand/ni/niveristand-embedded-data-logger-custom-device/PR-13/2020-02-21/18%3A33%3A10/Embedded%20Data%20Logger%20Engine.lvlib--Initialize%20Logging%20Data.vi.png)
Embedded Data Logger Shared.lvlib--Constants.vi.png ![capture](https://raw.githubusercontent.com/niveristand-diff-bot/diff-images/master/VeriStand/ni/niveristand-embedded-data-logger-custom-device/PR-13/2020-02-21/18%3A33%3A10/Embedded%20Data%20Logger%20Shared.lvlib--Constants.vi.png)
Embedded Data Logger Shared.lvlib--Get Data Log File Span Settings.vi.png ![capture](https://raw.githubusercontent.com/niveristand-diff-bot/diff-images/master/VeriStand/ni/niveristand-embedded-data-logger-custom-device/PR-13/2020-02-21/18%3A33%3A10/Embedded%20Data%20Logger%20Shared.lvlib--Get%20Data%20Log%20File%20Span%20Settings.vi.png)
Embedded Data Logger System Explorer.lvlib--Enable or Disable.vi.png ![capture](https://raw.githubusercontent.com/niveristand-diff-bot/diff-images/master/VeriStand/ni/niveristand-embedded-data-logger-custom-device/PR-13/2020-02-21/18%3A33%3A10/Embedded%20Data%20Logger%20System%20Explorer.lvlib--Enable%20or%20Disable.vi.png)
Embedded Data Logger System Explorer.lvlib--File Page.vi.png ![capture](https://raw.githubusercontent.com/niveristand-diff-bot/diff-images/master/VeriStand/ni/niveristand-embedded-data-logger-custom-device/PR-13/2020-02-21/18%3A33%3A10/Embedded%20Data%20Logger%20System%20Explorer.lvlib--File%20Page.vi.png)
Embedded Data Logger System Explorer.lvlib--Get Segment File Size Control Caption.vi.png ![capture](https://raw.githubusercontent.com/niveristand-diff-bot/diff-images/master/VeriStand/ni/niveristand-embedded-data-logger-custom-device/PR-13/2020-02-21/18%3A33%3A10/Embedded%20Data%20Logger%20System%20Explorer.lvlib--Get%20Segment%20File%20Size%20Control%20Caption.vi.png)
Post Error.vi.png ![capture](https://raw.githubusercontent.com/niveristand-diff-bot/diff-images/master/VeriStand/ni/niveristand-embedded-data-logger-custom-device/PR-13/2020-02-21/18%3A33%3A10/Post%20Error.vi.png)
Post Information.vi.png ![capture](https://raw.githubusercontent.com/niveristand-diff-bot/diff-images/master/VeriStand/ni/niveristand-embedded-data-logger-custom-device/PR-13/2020-02-21/18%3A33%3A10/Post%20Information.vi.png)

The following VIs could not be diffed:

niveristand-diff-bot commented 4 years ago

Bleep bloop!

LabVIEW Diff Robot here with some diffs served up hot for your pull request.

Notice something funny? Help fix me on my GitHub repo.

Embedded Data Logger Engine.lvlib--Asynchronous Logging Loop.vi.png ![capture](https://raw.githubusercontent.com/niveristand-diff-bot/diff-images/master/VeriStand/ni/niveristand-embedded-data-logger-custom-device/PR-13/2020-02-23/18%3A32%3A38/Embedded%20Data%20Logger%20Engine.lvlib--Asynchronous%20Logging%20Loop.vi.png)
Embedded Data Logger Engine.lvlib--Compute if Should Span.vi.png ![capture](https://raw.githubusercontent.com/niveristand-diff-bot/diff-images/master/VeriStand/ni/niveristand-embedded-data-logger-custom-device/PR-13/2020-02-23/18%3A32%3A38/Embedded%20Data%20Logger%20Engine.lvlib--Compute%20if%20Should%20Span.vi.png)
Embedded Data Logger Engine.lvlib--Flush Close Archive File.vi.png ![capture](https://raw.githubusercontent.com/niveristand-diff-bot/diff-images/master/VeriStand/ni/niveristand-embedded-data-logger-custom-device/PR-13/2020-02-23/18%3A32%3A38/Embedded%20Data%20Logger%20Engine.lvlib--Flush%20Close%20Archive%20File.vi.png)
Embedded Data Logger Engine.lvlib--Flush File Data.vi.png ![capture](https://raw.githubusercontent.com/niveristand-diff-bot/diff-images/master/VeriStand/ni/niveristand-embedded-data-logger-custom-device/PR-13/2020-02-23/18%3A32%3A38/Embedded%20Data%20Logger%20Engine.lvlib--Flush%20File%20Data.vi.png)
Embedded Data Logger Engine.lvlib--Get Data Log Directory Settings.vi.png ![capture](https://raw.githubusercontent.com/niveristand-diff-bot/diff-images/master/VeriStand/ni/niveristand-embedded-data-logger-custom-device/PR-13/2020-02-23/18%3A32%3A38/Embedded%20Data%20Logger%20Engine.lvlib--Get%20Data%20Log%20Directory%20Settings.vi.png)
Embedded Data Logger Engine.lvlib--Get Data Log File Settings.vi.png ![capture](https://raw.githubusercontent.com/niveristand-diff-bot/diff-images/master/VeriStand/ni/niveristand-embedded-data-logger-custom-device/PR-13/2020-02-23/18%3A32%3A38/Embedded%20Data%20Logger%20Engine.lvlib--Get%20Data%20Log%20File%20Settings.vi.png)
Embedded Data Logger Engine.lvlib--Initialize Logging Data.vi.png ![capture](https://raw.githubusercontent.com/niveristand-diff-bot/diff-images/master/VeriStand/ni/niveristand-embedded-data-logger-custom-device/PR-13/2020-02-23/18%3A32%3A38/Embedded%20Data%20Logger%20Engine.lvlib--Initialize%20Logging%20Data.vi.png)
Embedded Data Logger Shared.lvlib--Constants.vi.png ![capture](https://raw.githubusercontent.com/niveristand-diff-bot/diff-images/master/VeriStand/ni/niveristand-embedded-data-logger-custom-device/PR-13/2020-02-23/18%3A32%3A38/Embedded%20Data%20Logger%20Shared.lvlib--Constants.vi.png)
Embedded Data Logger Shared.lvlib--Get Data Log File Span Settings.vi.png ![capture](https://raw.githubusercontent.com/niveristand-diff-bot/diff-images/master/VeriStand/ni/niveristand-embedded-data-logger-custom-device/PR-13/2020-02-23/18%3A32%3A38/Embedded%20Data%20Logger%20Shared.lvlib--Get%20Data%20Log%20File%20Span%20Settings.vi.png)
Embedded Data Logger System Explorer.lvlib--Enable or Disable.vi.png ![capture](https://raw.githubusercontent.com/niveristand-diff-bot/diff-images/master/VeriStand/ni/niveristand-embedded-data-logger-custom-device/PR-13/2020-02-23/18%3A32%3A38/Embedded%20Data%20Logger%20System%20Explorer.lvlib--Enable%20or%20Disable.vi.png)
Embedded Data Logger System Explorer.lvlib--File Page.vi.png ![capture](https://raw.githubusercontent.com/niveristand-diff-bot/diff-images/master/VeriStand/ni/niveristand-embedded-data-logger-custom-device/PR-13/2020-02-23/18%3A32%3A38/Embedded%20Data%20Logger%20System%20Explorer.lvlib--File%20Page.vi.png)
Embedded Data Logger System Explorer.lvlib--Get Segment File Size Control Caption.vi.png ![capture](https://raw.githubusercontent.com/niveristand-diff-bot/diff-images/master/VeriStand/ni/niveristand-embedded-data-logger-custom-device/PR-13/2020-02-23/18%3A32%3A38/Embedded%20Data%20Logger%20System%20Explorer.lvlib--Get%20Segment%20File%20Size%20Control%20Caption.vi.png)
Post Error.vi.png ![capture](https://raw.githubusercontent.com/niveristand-diff-bot/diff-images/master/VeriStand/ni/niveristand-embedded-data-logger-custom-device/PR-13/2020-02-23/18%3A32%3A38/Post%20Error.vi.png)
Post Information.vi.png ![capture](https://raw.githubusercontent.com/niveristand-diff-bot/diff-images/master/VeriStand/ni/niveristand-embedded-data-logger-custom-device/PR-13/2020-02-23/18%3A32%3A38/Post%20Information.vi.png)

The following VIs could not be diffed:

debryant commented 4 years ago

Done. Thanks for catching these :)

niveristand-diff-bot commented 4 years ago

Bleep bloop!

LabVIEW Diff Robot here with some diffs served up hot for your pull request.

Notice something funny? Help fix me on my GitHub repo.

Embedded Data Logger Engine.lvlib--Asynchronous Logging Loop.vi.png ![capture](https://raw.githubusercontent.com/niveristand-diff-bot/diff-images/master/VeriStand/ni/niveristand-embedded-data-logger-custom-device/PR-13/2020-02-25/16%3A32%3A58/Embedded%20Data%20Logger%20Engine.lvlib--Asynchronous%20Logging%20Loop.vi.png)
Embedded Data Logger Engine.lvlib--Compute if Should Span.vi.png ![capture](https://raw.githubusercontent.com/niveristand-diff-bot/diff-images/master/VeriStand/ni/niveristand-embedded-data-logger-custom-device/PR-13/2020-02-25/16%3A32%3A58/Embedded%20Data%20Logger%20Engine.lvlib--Compute%20if%20Should%20Span.vi.png)
Embedded Data Logger Engine.lvlib--Flush Close Archive File.vi.png ![capture](https://raw.githubusercontent.com/niveristand-diff-bot/diff-images/master/VeriStand/ni/niveristand-embedded-data-logger-custom-device/PR-13/2020-02-25/16%3A32%3A58/Embedded%20Data%20Logger%20Engine.lvlib--Flush%20Close%20Archive%20File.vi.png)
Embedded Data Logger Engine.lvlib--Flush File Data.vi.png ![capture](https://raw.githubusercontent.com/niveristand-diff-bot/diff-images/master/VeriStand/ni/niveristand-embedded-data-logger-custom-device/PR-13/2020-02-25/16%3A32%3A58/Embedded%20Data%20Logger%20Engine.lvlib--Flush%20File%20Data.vi.png)
Embedded Data Logger Engine.lvlib--Get Data Log Directory Settings.vi.png ![capture](https://raw.githubusercontent.com/niveristand-diff-bot/diff-images/master/VeriStand/ni/niveristand-embedded-data-logger-custom-device/PR-13/2020-02-25/16%3A32%3A58/Embedded%20Data%20Logger%20Engine.lvlib--Get%20Data%20Log%20Directory%20Settings.vi.png)
Embedded Data Logger Engine.lvlib--Get Data Log File Settings.vi.png ![capture](https://raw.githubusercontent.com/niveristand-diff-bot/diff-images/master/VeriStand/ni/niveristand-embedded-data-logger-custom-device/PR-13/2020-02-25/16%3A32%3A58/Embedded%20Data%20Logger%20Engine.lvlib--Get%20Data%20Log%20File%20Settings.vi.png)
Embedded Data Logger Engine.lvlib--Initialize Logging Data.vi.png ![capture](https://raw.githubusercontent.com/niveristand-diff-bot/diff-images/master/VeriStand/ni/niveristand-embedded-data-logger-custom-device/PR-13/2020-02-25/16%3A32%3A58/Embedded%20Data%20Logger%20Engine.lvlib--Initialize%20Logging%20Data.vi.png)
Embedded Data Logger Shared.lvlib--Constants.vi.png ![capture](https://raw.githubusercontent.com/niveristand-diff-bot/diff-images/master/VeriStand/ni/niveristand-embedded-data-logger-custom-device/PR-13/2020-02-25/16%3A32%3A58/Embedded%20Data%20Logger%20Shared.lvlib--Constants.vi.png)
Embedded Data Logger Shared.lvlib--Get Data Log File Span Settings.vi.png ![capture](https://raw.githubusercontent.com/niveristand-diff-bot/diff-images/master/VeriStand/ni/niveristand-embedded-data-logger-custom-device/PR-13/2020-02-25/16%3A32%3A58/Embedded%20Data%20Logger%20Shared.lvlib--Get%20Data%20Log%20File%20Span%20Settings.vi.png)
Embedded Data Logger System Explorer.lvlib--Enable or Disable.vi.png ![capture](https://raw.githubusercontent.com/niveristand-diff-bot/diff-images/master/VeriStand/ni/niveristand-embedded-data-logger-custom-device/PR-13/2020-02-25/16%3A32%3A58/Embedded%20Data%20Logger%20System%20Explorer.lvlib--Enable%20or%20Disable.vi.png)
Embedded Data Logger System Explorer.lvlib--File Page.vi.png ![capture](https://raw.githubusercontent.com/niveristand-diff-bot/diff-images/master/VeriStand/ni/niveristand-embedded-data-logger-custom-device/PR-13/2020-02-25/16%3A32%3A58/Embedded%20Data%20Logger%20System%20Explorer.lvlib--File%20Page.vi.png)
Embedded Data Logger System Explorer.lvlib--Get Segment File Size Control Caption.vi.png ![capture](https://raw.githubusercontent.com/niveristand-diff-bot/diff-images/master/VeriStand/ni/niveristand-embedded-data-logger-custom-device/PR-13/2020-02-25/16%3A32%3A58/Embedded%20Data%20Logger%20System%20Explorer.lvlib--Get%20Segment%20File%20Size%20Control%20Caption.vi.png)

The following VIs could not be diffed: