Feat lsl output

[produceconsumerobot]

Description

• Adds LSL output
• Adds EmotiBitLsl module to handle nuts & bolts
• Refactors usage of Patchboard

Notes to include with Release

The LSL output relays data for each EmotiBit stream plotted in the EmotiBit Oscilloscope. Please note, however, that the LSL timestamps are presently not corrected for the device-to-computer time-of-flight because this correction can require some degree of nuance for gracefully handling changes in the clock-to-clock estimation. Recording LSL Marker inputs with EmotiBit Oscilloscope followed by using the EmotiBit DataParser to parse raw data files recorded on the EmotiBit SD card provides the highest degree of timestamp accuracy to compare EmotiBit signals with signals from other devices.

ToDo

• [X] Refactor patchboard to PatchboardJson
• [X] fix linkage to ofxPatchboard in EmotiBit Oscilloscope
• [X] fix linkage to ofxPatchboard in oscOscilloscopeExample
• [X] move addToPayload to EmotiBitPacket
• [X] Add comments to EmotiBit LSL
• [x] Retest marker inputs working
• [x] Retest UDP output working
• [x] Add streamviewer instructions to biometric lib
• [x] Add testing matrix
• [x] Create feature tests
• [ ] Add update to documentation

Requirements

• https://github.com/produceconsumerobot/ofxOscilloscope/pull/6
• https://github.com/EmotiBit/EmotiBit_XPlat_Utils/pull/26

Issues Referenced

• Closes #150

Documentation update

[ToDo]

• Add output section to:https://github.com/EmotiBit/EmotiBit_Docs/blob/6922a26196f47bbe490ed0d94c70976faa19cd01/Learn_more_about_emotibit.md#a-note-on-lsl
• crop asset to LSL section in https://github.com/EmotiBit/EmotiBit_Docs/blob/master/Working_with_emotibit_data.md#using-lsl-with-emotibit-oscilloscope

New files to be added with release

• bin/data/lslOutputSettings.json

Notes for Reviewer

To achieve a draft/pre-release Windows installer, let's do a mini review testing functional on Windows. A more in-depth code review, complete testing notes and results across platforms as well as documentation update can be performed subsequently.

Testing

• [x] LSL output verified with LSL Stream Viewer (see https://github.com/EmotiBit/EmotiBit_Biometric_Lib/pull/33)
• [x] LSL marker input working
• [x] OSC output verified working with oscOscilloscopeExample

Results

[ToDo]

Feature Tests

● Oscilloscope UDP output ● Oscilloscope OSC output ● Oscilloscope LSL output ● Oscilloscope LSL Marker Input

Steps to test

All feature tests should be performed for each platform

Checklist to allow merge

• [ ] All dependent repositories used were on branch master
• Software
  • [ ] Get approval from the reviewer
  • [ ] Passed testing on Windows
  • [ ] Passed testing on macOS (for major changes/GUI changes/ PRs adding files distributed with the EmotiBit software)
  • [ ] Passed testing on linux (ubuntu) (for major changes/GUI changes/ PRs adding files distributed with the EmotiBit software)
  • [ ] Update software bundle version in ofxEmotiBitVersion.h
• Firmware
  • [ ] Set testingMode to TestingMode::NONE
  • [ ] Set const bool DIGITAL_WRITE_DEBUG = false (if set true while testing)
  • [ ] Update version in EmotiBit.h
  • [ ] Update library.properties to the correct version (should match EmotiBit.h)
• [ ] doxygen style comments included for new code snippets
• [ ] Required documentation updated

Screenshots:

[nitin710]

Review 01

• ✔️ Verify LSL output working with LSL Stream Viewer
  • ✔️ Even if LSL is toggled OFF (in the Oscilloscope), it keeps transmitting.
  • ✔️ LSL output works in combination with ingesting marker stream
  • 
  • ✔️ PPG
  • ✔️ ACC_GYRO
  • 
  • ✔️ EDA
  • 
  • ✔️ MA_TEMP
  • 
• ✔️ Verify LSL marker input working with marker generator python script.
  • 
• ✔️ Verify OSC output working with oscOscilloscopeExample
  • 
• ✔️ Verify UDP output working with modified networkUdpReceiverExample
  • 

[nitin710]

See comments for lsl-viewer here

[nitin710]

@produceconsumerobot Should I wait for a fix for this before testing? https://github.com/EmotiBit/ofxEmotiBit/issues/234

[produceconsumerobot]

@nitin710 you can test LSL streaming independent of the Markers issue

[produceconsumerobot]

from datalog.txt

887204,15942,8,LM,1,100,LR,542485.4,LM,542485.4,LC,542485.4,LD,Hello, 887326,15962,4,TX,1,100,LR,542485.4,LM,542485.4,LC,542485.4,LD,Hello,LC,542485.4,LM,542485.4, 887339,15963,4,TX,1,100,LR,542485.4,LM,542485.4,LC,542485.4,LD,Hello,LC,542485.4,LM,542485.4,TL,2024-03-22_12-11-53-155553,LC,542485.4,

LSL Marker packets from a working data file

387896,60604,8,LM,1,100,LR,207191.0339737,LM,405672.1322546,LC,207191.0798633,LD,1681684929.248634,30.00000000000000,1681684929.248634, 388265,60669,4,TX,1,100,LC,207191.0339737,LM,405672.1322546 388271,60670,4,TX,1,100,TL,2023-04-16_15-42-08-392790,LC,207191.0838676

@nitin710 this should be fixed now

[nitin710]

• ✔️ LSL marker stream
  • Oscilloscope can ingest LSL stream and correctly add LM packets to the data
  • Data parser correctly parses the data+adds LC and LM time columns
• ✔️ LSL streams viewed on LSL-Stream-Viewer

[nitin710]

This PR is already merged into dev. Will be merged to master once build on linux is resolved.