#181038299 ; acquisition module docs #217
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
tab-cmd
approved these changes
Apr 28, 2022
bcipy/acquisition/README.md
Outdated
|
|
||
| ## Supported Devices | ||
|
|
||
| The acquisition module connects with hardware devices using the Lab Streaming Layer (LSL) library. Each device should provide its own LSL driver / application to use for streaming data. The streamer should be started prior to running the `bcipy` application. |
There was a problem hiding this comment.
Examples could be helpful here and/or a link to an app!
Apps: https://labstreaminglayer.readthedocs.io/info/supported_devices.html
If your device does not have a supported app see https://labstreaminglayer.readthedocs.io/dev/app_build.html
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Overview
Updated documentation for the acquisition module.
Ticket
https://www.pivotaltracker.com/story/show/181038299
Contributions
Discussion
I decided to defer the removal of the v1 DataAcquisitionClient and related classes to rc2, since it will require additional system testing to ensure that those classes are not being used (ex. in viewer related code, demos, tests, etc). For the meantime I updated the documentation. I will create a followup ticket to remove the deprecated code.