Contributions:BrainFlow: Difference between revisions
No edit summary |
|||
| (12 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
[[File:Brainflowpic.png|300px|thumb|right]] | |||
==Synopsis== | ==Synopsis== | ||
This module integrates the data aquistion capabilities from [https://brainflow.readthedocs.io/en/stable/ BrainFlow] into BCI2000, allowing for compatibility with several new boards. | This module integrates the data aquistion capabilities from [https://brainflow.readthedocs.io/en/stable/ BrainFlow] into BCI2000, allowing for compatibility with several new boards, especially boards from the OpenBCI hardware project. | ||
==Location== | |||
http://{{SERVERNAME}}/svn/trunk/src/contrib/SignalSource/BrainFlow | |||
<!-- | |||
==BrainFlow Installation/Setup== | ==BrainFlow Installation/Setup== | ||
Before installation, please install [https://gitforwindows.org/ git bash] and [https://www.python.org/downloads/ python]. | Before installation, please install [https://gitforwindows.org/ git bash] and [https://www.python.org/downloads/ python]. Note that VS2022 is not compatible with this module. | ||
===Automatic Installation=== | ===Automatic Installation=== | ||
'''Note that instillation will take around | '''Note that instillation will take around 125MB. Also ensure that you are using VS2019.''' | ||
Libraries generated from BrainFlow are needed for this module, which requires the user to download and build the project. The download process | Libraries generated from BrainFlow are needed for this module, which requires the user to download and build the project. The download/compilation process can be automated using this script located in SignalSource\BrainFlow: | ||
<gallery mode="packed" widths=75px heights=75px> | <gallery mode="packed" widths=75px heights=75px> | ||
File:BFLibInstall.JPG|BrainFlow library install script | File:BFLibInstall.JPG|BrainFlow library install script | ||
</gallery> | </gallery> | ||
All that needs to be done to use this scripts is: locate them in {BCI2000 Folder}\src\contrib\SignalSource\BrainFlow, and double click on " | All that needs to be done to use this scripts is: locate them in {BCI2000 Folder}\src\contrib\SignalSource\BrainFlow, and double click on "GenerateLibraries.bat". This will clone the [https://github.com/brainflow-dev/brainflow BrainFlow repository] into src\extlib. The script will build libraries for both debug and release configurations, so there will be two folders installed. '''Make sure to press enter when indicated. Do not exit the console until everything has finished installing--just follow the prompts given by the console.''' After each set of libraries are installed, you will be told to add the directories {BCI2000 Folder}\src\extlib\brainflowDebug\installed\lib and {BCI2000 Folder}\src\extlib\brainflow\installed\lib to your systems PATH | ||
(please follow [https://www.youtube.com/watch?v=91SGaK7_eeY this] tutorial if you are unsure how to do this) | (please follow [https://www.youtube.com/watch?v=91SGaK7_eeY this] tutorial if you are unsure how to do this). | ||
In CMake, make sure under "BUILD" that "BUILD_ALL_SOURCEMODULES" is selected. In the batch file to be used, append '''start executable BrainFlowADC --local''' to the line corresponding to the source module. | |||
--> | |||
==Parameters== | ==Parameters== | ||
===BoardID=== | ===BoardID=== | ||
Identifier for the board in use, compatible with any board able to be used with BrainFlow. | Identifier for the board in use, compatible with any board able to be used with BrainFlow. | ||
BoardIDs are listed the parameter's commentary, and boards are displayed by name in the parameter GUI. | |||
===RecordingChannels=== | ===RecordingChannels=== | ||
| Line 26: | Line 32: | ||
'''The following information might not be needed for specific boards. Search for your board [https://brainflow.readthedocs.io/en/stable/SupportedBoards.html here] to see | '''The following information might not be needed for specific boards. Search for your board [https://brainflow.readthedocs.io/en/stable/SupportedBoards.html here] to see which parameters are necessary.''' | ||
===COM=== | ===COM=== | ||
Specifies the port the device is connected to (this must be found by the user--the program will not search ports to find which the device is connected to. Open your | Specifies the port the device is connected to (this must be found by the user--the program will not search ports to find which the device is connected to. Open your system's device manager to determine this) if needed. If not needed, leave as auto. | ||
===MAC=== | ===MAC=== | ||
| Line 39: | Line 45: | ||
===SerialNumber=== | ===SerialNumber=== | ||
Specifies the serial number of the device if needed. If not needed, leave as auto. | Specifies the serial number of the device if needed. If not needed, leave as auto. | ||
==See also== | |||
[[User Reference:Filters]], [[Contributions:ADCs]] | |||
[[Category:Contributions]][[Category:Data Acquisition]] | |||
Latest revision as of 12:31, 17 December 2024
Synopsis
This module integrates the data aquistion capabilities from BrainFlow into BCI2000, allowing for compatibility with several new boards, especially boards from the OpenBCI hardware project.
Location
http://www.bci2000.org/svn/trunk/src/contrib/SignalSource/BrainFlow
Parameters
BoardID
Identifier for the board in use, compatible with any board able to be used with BrainFlow. BoardIDs are listed the parameter's commentary, and boards are displayed by name in the parameter GUI.
RecordingChannels
Sets which board channels will be used for data acquisition. Some boards will not have all listed channel types, in which case no data will be collected from such types. If channels are found and ChannelNames is set to auto, listed channels will be given their designated names.
The following information might not be needed for specific boards. Search for your board here to see which parameters are necessary.
COM
Specifies the port the device is connected to (this must be found by the user--the program will not search ports to find which the device is connected to. Open your system's device manager to determine this) if needed. If not needed, leave as auto.
MAC
Specifies the MAC address of the device if needed. If not needed, leave as auto.
IPPort
Specifies the address of an IP port if needed. If not needed, leave as auto.
SerialNumber
Specifies the serial number of the device if needed. If not needed, leave as auto.