BCI2000 Wiki - User contributions [en]

Contributions:RHX

2025-08-13T20:51:42Z

Rlellis: /* Parameters */

==Synopsis==

The Intan RHS has four SPI ports (with each port labelled A,B,C,D) which can program, stimulate, and record data from connected RHS chips. Each chip controls 16 channels, with up to two chips per port. Over all four ports, a total of 8 chips (128 channels) can be simultaneously controlled.
<gallery mode="packed" widths=75px heights=75px>
File:Intanheadstage.jpg|RHS2116 Amplifier chip on 32 channel headstage
</gallery>
The expansion board includes up to 16 digital input and output channels and 8 analog input (ADC) and output channels (DAC). The digital and analog outputs can be programmed for stimulation, and the data from the digital and analog inputs can be recorded.

The digital input and output data are recorded in two streams ("DigIn" and "DigOut", respectively). These streams consist of 16 bit unsigned integers with each bit representing the logic input/output. These values are computed in MSb format, with the greatest bit being controlled by channel 0. For example, a logic pulse recorded by channel 0 would result in a value of 2^15 (=1000 0000 0000 0000), while a logic pulse recorded from channel 15 would result in a value of 2^0 (=0000 0000 0000 0001).

Similarly, stimulation information from each headstage is recorded in the streams:
"HeadstageAStim": The bit for the corresponding channel is set to 1 if stimulating, 0 otherwise.
"HeadstageAChargeRecov": The bit for the corresponding channel is set to 1 if charge recovery is active, 0 otherwise
"HeadstageAStimPol": The bit for the corresponding channel is set to 1 if the stimulation current is positive, 0 if negative or inactive
"HeadstageAAmpSettle": The bit for the corresponding channel is set to 1 if the amplifier settle circuitry is active, 0 otherwise.
... (Repeated for headstages A-D)

Each of these streams contains a 32 bit unsigned integer, with a similar format to the "DigIn" and "DigOut" streams--for example, if channel 0 on headstage A is currently stimulating, a value of 2^31 will be recorded to "HeadstageAStim", and if channel 31 on headstage A is currently stimulating a value of 2^0 will be recorded to "HeadstageAStim".

==Parameters==

SamplingRate: Due to the RHS's ability to only take on discrete sampling rates, a value matching one of the following must be used for this parameter (given in Hz): 1000, 1250, 1500, 2000, 2500, 3000, 3333, 4000, 5000, 6250, 8000, 10000, 12500, 15000,20000 ,25000, 30000.

SampleBlockSize: The API provided by Intan only reads data in chunks of 128. Therefore, values that are multiples of 128 must be used for this parameter.

RHSAmpChannels: A list of headtsage channels which will be recorded from. The value of the first channel on headstage A is taken to be 0, and the final channel on headstage D is taken to be 127. Accepted formats are of the following form:
For a range of sequential channels, an input of "A-B" will result in the configuration being uploaded to channels A,A+1...B. For a single channel, one may simply input the channel number as "A".
For channels that are not sequential, one may input "{A-B,C,D-E,..}". This will upload the configuration to channels A,A+1..B,C,D,D+1...E... . Lists of this form must use commas to separate channel values/ranges.

For example, an entry of {0-8,32-35} will record from the first 9 channels on headstage A, and the first 4 channels on headstage B.

Stimulation Configuration Parameters (note: all text is case insensitive, and any non-applicable parameters can be left empty. Further, all values are rounded to multiples of the sampling period and stimulation step size!):

Channels: Specifies the channels which the configuration applies to. The accepted formats are the same as for RHSAmpChannels.

Trigger: Specifies the source which triggers stimulation. This can either be one of the digital or analog inputs, or a state. Accepted input is: "digx", "anax", or "state", where x is an integer between 1 and 8 (all independent of capitalization). If "state" is used, "State Trigger Value" must be specified.

Trigger State: The name of the expression to trigger stimulation. This does not necessarily have to be a state, for example the "KeyDown" is a valid entry. If not using a state trigger, this can be left empty.

State Trigger Value: If using a state as a trigger, this section determines the condition for the state to trigger stimulation. If not, this can be left as empty.

Edge/Level: Specifies whether stimulation is edge or level triggered. Supported entries are "edge" or "level".

High/Low: Specifies whether stimulation is triggered on high or low. Supported entries are "high" or "low".

Trigger Delay: Specifies the duration of time between the trigger and first phase of stimulation. The expected format is a value along with a unit, for example "10ms", "10 ms", "100 us". Accepted units are ns,us,ms,s. If no unit is provided, the default is us.

Amp Settle Start: Specifies the time before the first phase of stimulation in which the amplifier settle circuitry is activated. This value must not exceed Trigger Delay. The expected format is the same as Trigger Delay.

Phase 1 Duration: Specifies the duration for the first phase of stimulation. The expected format is the same as Trigger Delay.

Phase 2 Duration: Specifies the duration for the second phase of stimulation. The expected format is the same as Trigger Delay.

Phase 3 Duration: Specifies the duration for the third phase of stimulation. The expected format is the same as Trigger Delay. This parameter only needs to be defined for a triphasic waveform, otherwise can be left blank.

Amp Settle End: Specifies the duration after the final phase of stimulation at which the amplifier settle circuitry is deactivated. The expected format is the same as Trigger Delay.

Num Pulses: Specifies the number of stimulation pulses after a trigger event.

Pulse Period: Specifies the period of the stimulation waveform. The trigger delay is not factored. For example, a biphasic waveform with a phase 1 duration of 100us, a phase 2 duration of 100us, and a pulse period of 300us will look like a biphasic waveform with a 100us delay following the second phase before repeating (regardless of the trigger delay).

Post Stim Recovery Delay: Specifies the duration after the last phase of the final pulse at which the charge recovery circuitry will be activated. The expected format is the same as Trigger Delay.

Post Stim Recovery Duration: Specifies the duration for which charge recovery will be active. The expected format is the same as Trigger Delay.

Refractory Duration: Specifies the duration after either charge recovery is deactivated (if this charge recovery parameters were set), or after the end of stimulation (otherwise).

Contributions:RHX

2025-08-13T20:04:55Z

Rlellis: /* Parameters */

Contributions:RHX

2025-08-12T20:57:57Z

Rlellis: /* Synopsis */

Contributions:RHX

2025-08-12T20:57:36Z

Rlellis: /* Synopsis */

Contributions:RHX

2025-06-18T20:06:43Z

Rlellis: /* Parameters */

Contributions:RHX

2024-09-06T17:43:06Z

Rlellis: /* Parameters */

==Synopsis==

The Intan RHS has four SPI ports (with each port labelled A,B,C,D) which sends data to a FPGA. These ports communicate with the chips located on supported headstages. Each port has four output signals responsible for communication with the amplifier chips, two of which (MISO1,MISO2) are used to transmit data. Each chip controls 16 channels, and each chip transmits data over a single MISO line. Over all four ports, this means there are 8 lines over which data can be sent.
<gallery mode="packed" widths=75px heights=75px>
File:Intanheadstage.jpg|RHS2116 Amplifier chip on 32 channel headstage
</gallery>
Attatched to the FPGA is an Opal Kelly XEM6010 USB/FPGA interface which can be used to read data in the FPGA via USB. This module has 128MByte SDRAM

==Parameters==

SamplingRate: Due to the RHS's ability to only take on discrete sampling rates, a value matching one of the following must be used for this parameter (given in Hz): 1000, 1250, 1500, 2000, 2500, 3000, 3333, 4000, 5000, 6250, 8000, 10000, 12500, 15000,20000 ,25000, 30000.

SampleBlockSize: The API provided by Intan only reads data in chunks of 128. Therefore, values that are multiples of 128 must be used for this parameter.

ConnectionType: Determines type of connection to be used. For devices with a XEM7310 module (which can be found via the connected device list given in the Intan RHX application or by looking at the specifications for the device in use), use ControllerStimRecord. Otherwise, depending on the USB connection, choose USB2 or USB3.

~To be added~

Trigger parameters:

TriggerEnable: enables or disables the trigger function

TriggerType: Edge triggered: triggers stimulation upon change from inactive to active state. Level triggered: repeats stimulation while in an active state (i.e. can activate multiple times while the trigger condition is met, without needing to switch)

TriggerState: Allows the user to enter a state that will be used as a trigger condition (i.e. can use KeyboardMonitor)

TriggerValue: The value in which TriggerCondition will be compared to.

TriggerCondition: The condition which TriggerState must satisfy in relation to TriggerValue in order to switch to an active state.

Pulse train parameters:

PulseTrainEnable: True: enables pulse train. False: sets stimulation to only a single pulse of the waveform.

PulseTrainNumPulses: Number of pulses to be executed upon trigger activation

PulseTrainPeriod: time elapsed between the start of two subsequent pulses (i.e. stimulus duration+interstimulus interval)

PostTriggerDelay: Time between trigger activation and execution of pulse train

RefractoryPeriod: Rest period after pulse train finishes executing during which stimulation will not execute

Waveform parameters:
A1: Magnitude of first phase current (nA)
A2: Magnitude of second phase current (nA)
Polarity: Anodic: supplies positive current first. Cathodic: supplies negative current first
D1: Duration of first phase
D2: Duration of second phase
DP: Interphase delay duration (Only applicable for Biphasic with Delay stimulation shape)

Shape:
Biphasic: supplies current (with polarity determined by the Polarity parameter) for time determined by D1 and magnitude determined by A1, then supplies the opposite sign of current for time determined by D2 and magnitude determined by A2
Biphasic with delay: supplies current (with polarity determined by the Polarity parameter) for time determined by D1 and magnitude determined by A1, then supplies no current for time specified by DP, then supplies the opposite sign of current for time determined by D2 and magnitude determined by A2
Triphasic: supplies current (with polarity determined by the Polarity parameter) for time determined by D1 and magnitude determined by A1, then supplies the opposite sign of current for time determined by D2 and magnitude determined by A2, then repeats the first phase (current of initial polarity for duration D1 and amplitude A1)

Contributions:RHX

2024-09-06T17:42:48Z

Rlellis: /* Parameters */

==Synopsis==

The Intan RHS has four SPI ports (with each port labelled A,B,C,D) which sends data to a FPGA. These ports communicate with the chips located on supported headstages. Each port has four output signals responsible for communication with the amplifier chips, two of which (MISO1,MISO2) are used to transmit data. Each chip controls 16 channels, and each chip transmits data over a single MISO line. Over all four ports, this means there are 8 lines over which data can be sent.
<gallery mode="packed" widths=75px heights=75px>
File:Intanheadstage.jpg|RHS2116 Amplifier chip on 32 channel headstage
</gallery>
Attatched to the FPGA is an Opal Kelly XEM6010 USB/FPGA interface which can be used to read data in the FPGA via USB. This module has 128MByte SDRAM

==Parameters==

SamplingRate: Due to the RHS's ability to only take on discrete sampling rates, a value matching one of the following must be used for this parameter (given in Hz): 1000, 1250, 1500, 2000, 2500, 3000, 3333, 4000, 5000, 6250, 8000, 10000, 12500, 15000,20000 ,25000, 30000.

SampleBlockSize: The API provided by Intan only reads data in chunks of 128. Therefore, values that are multiples of 128 must be used for this parameter.

ConnectionType: Determines type of connection to be used. For devices with a XEM7310 module (which can be found via the connected device list given in the Intan RHX application or by looking at the specifications for the device in use), use ControllerStimRecord. Otherwise, depending on the USB connection, choose USB2 or USB3.

Trigger parameters:

TriggerEnable: enables or disables the trigger function

TriggerType: Edge triggered: triggers stimulation upon change from inactive to active state. Level triggered: repeats stimulation while in an active state (i.e. can activate multiple times while the trigger condition is met, without needing to switch)

TriggerState: Allows the user to enter a state that will be used as a trigger condition (i.e. can use KeyboardMonitor)

TriggerValue: The value in which TriggerCondition will be compared to.

TriggerCondition: The condition which TriggerState must satisfy in relation to TriggerValue in order to switch to an active state.

Pulse train parameters:

PulseTrainEnable: True: enables pulse train. False: sets stimulation to only a single pulse of the waveform.

PulseTrainNumPulses: Number of pulses to be executed upon trigger activation

PulseTrainPeriod: time elapsed between the start of two subsequent pulses (i.e. stimulus duration+interstimulus interval)

PostTriggerDelay: Time between trigger activation and execution of pulse train

RefractoryPeriod: Rest period after pulse train finishes executing during which stimulation will not execute

Waveform parameters:
A1: Magnitude of first phase current (nA)
A2: Magnitude of second phase current (nA)
Polarity: Anodic: supplies positive current first. Cathodic: supplies negative current first
D1: Duration of first phase
D2: Duration of second phase
DP: Interphase delay duration (Only applicable for Biphasic with Delay stimulation shape)

Shape:
Biphasic: supplies current (with polarity determined by the Polarity parameter) for time determined by D1 and magnitude determined by A1, then supplies the opposite sign of current for time determined by D2 and magnitude determined by A2
Biphasic with delay: supplies current (with polarity determined by the Polarity parameter) for time determined by D1 and magnitude determined by A1, then supplies no current for time specified by DP, then supplies the opposite sign of current for time determined by D2 and magnitude determined by A2
Triphasic: supplies current (with polarity determined by the Polarity parameter) for time determined by D1 and magnitude determined by A1, then supplies the opposite sign of current for time determined by D2 and magnitude determined by A2, then repeats the first phase (current of initial polarity for duration D1 and amplitude A1)

Contributions:RHX

2024-08-09T19:43:48Z

Rlellis: /* Parameters */

==Synopsis==

The Intan RHS has four SPI ports (with each port labelled A,B,C,D) which sends data to a FPGA. These ports communicate with the chips located on supported headstages. Each port has four output signals responsible for communication with the amplifier chips, two of which (MISO1,MISO2) are used to transmit data. Each chip controls 16 channels, and each chip transmits data over a single MISO line. Over all four ports, this means there are 8 lines over which data can be sent.
<gallery mode="packed" widths=75px heights=75px>
File:Intanheadstage.jpg|RHS2116 Amplifier chip on 32 channel headstage
</gallery>
Attatched to the FPGA is an Opal Kelly XEM6010 USB/FPGA interface which can be used to read data in the FPGA via USB. This module has 128MByte SDRAM

==Parameters==

Trigger parameters:

TriggerEnable: enables or disables the trigger function

TriggerType: Edge triggered: triggers stimulation upon change from inactive to active state. Level triggered: repeats stimulation while in an active state (i.e. can activate multiple times while the trigger condition is met, without needing to switch)

TriggerState: Allows the user to enter a state that will be used as a trigger condition (i.e. can use KeyboardMonitor)

TriggerValue: The value in which TriggerCondition will be compared to.

TriggerCondition: The condition which TriggerState must satisfy in relation to TriggerValue in order to switch to an active state.

Pulse train parameters:

PulseTrainEnable: True: enables pulse train. False: sets stimulation to only a single pulse of the waveform.

PulseTrainNumPulses: Number of pulses to be executed upon trigger activation

PulseTrainPeriod: time elapsed between the start of two subsequent pulses (i.e. stimulus duration+interstimulus interval)

PostTriggerDelay: Time between trigger activation and execution of pulse train

RefractoryPeriod: Rest period after pulse train finishes executing during which stimulation will not execute

Waveform parameters:
A1: Magnitude of first phase current (nA)
A2: Magnitude of second phase current (nA)
Polarity: Anodic: supplies positive current first. Cathodic: supplies negative current first
D1: Duration of first phase
D2: Duration of second phase
DP: Interphase delay duration (Only applicable for Biphasic with Delay stimulation shape)

Shape:
Biphasic: supplies current (with polarity determined by the Polarity parameter) for time determined by D1 and magnitude determined by A1, then supplies the opposite sign of current for time determined by D2 and magnitude determined by A2
Biphasic with delay: supplies current (with polarity determined by the Polarity parameter) for time determined by D1 and magnitude determined by A1, then supplies no current for time specified by DP, then supplies the opposite sign of current for time determined by D2 and magnitude determined by A2
Triphasic: supplies current (with polarity determined by the Polarity parameter) for time determined by D1 and magnitude determined by A1, then supplies the opposite sign of current for time determined by D2 and magnitude determined by A2, then repeats the first phase (current of initial polarity for duration D1 and amplitude A1)

Contributions:RHX

2024-08-07T22:23:32Z

Rlellis: /* Synopsis */

Contributions:RHX

2024-08-06T21:35:35Z

Rlellis: Created page with "==Synopsis== The Intan RHS has four SPI ports (with each port labelled A,B,C,D) which sends data to a FPGA. These ports communicate with the chips located on supported headstages. Each port has four output signals responsible for communication with the amplifier chips, two of which (MISO1,MISO2) are used to transmit data. Each chip controls 16 channels, and each chip transmits data over a single MISO line. Over all four ports, this means there are 8 lines over which dat..."

File:Intanheadstage.jpg

2024-08-06T20:32:08Z

Rlellis:

Contributions:BrainFlow

2024-05-21T22:06:03Z

Rlellis:

[[File:Brainflowpic.png|300px|thumb|right]]
==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.

==BrainFlow Installation/Setup==
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===
'''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/compilation process can be automated using this script located in SignalSource\BrainFlow:
<gallery mode="packed" widths=75px heights=75px>
File:BFLibInstall.JPG|BrainFlow library install script
</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 "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).

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==
===BoardID===
Identifier for the board in use, compatible with any board able to be used with BrainFlow.

===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 [https://brainflow.readthedocs.io/en/stable/SupportedBoards.html 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 systems 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.

Contributions:BrainFlow

2024-05-21T22:05:36Z

Rlellis:

[[File:Brainflowpic.png|400px|thumb|right]]
==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.

==BrainFlow Installation/Setup==
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===
'''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/compilation process can be automated using this script located in SignalSource\BrainFlow:
<gallery mode="packed" widths=75px heights=75px>
File:BFLibInstall.JPG|BrainFlow library install script
</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 "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).

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==
===BoardID===
Identifier for the board in use, compatible with any board able to be used with BrainFlow.

===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 [https://brainflow.readthedocs.io/en/stable/SupportedBoards.html 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 systems 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.

File:Brainflowpic.png

2024-05-21T22:04:28Z

Rlellis:

Contributions:BrainFlow

2024-05-21T22:01:42Z

Rlellis: /* Parameters */

Contributions:BrainFlow

2024-05-21T22:00:47Z

Rlellis: /* Automatic Installation */

Contributions:BrainFlow

2024-05-03T23:12:07Z

Rlellis: /* BrainFlow Installation/Setup */

Contributions:BrainFlow

2024-03-29T21:51:44Z

Rlellis: /* BrainFlow Installation/Setup */

Contributions:BrainFlow

2024-03-29T21:50:51Z

Rlellis:

Contributions:BrainFlow

2024-03-29T21:50:17Z

Rlellis: /* Parameters */

Contributions:BrainFlow

2024-03-29T20:51:44Z

Rlellis: /* Automatic Installation */

Contributions:BrainFlow

2024-03-29T20:32:14Z

Rlellis: /* Automatic Installation */

Contributions:BrainFlow

2024-03-29T20:31:24Z

Rlellis: /* COM */

Contributions:BrainFlow

2024-03-25T20:52:16Z

Rlellis: /* BrainFlow Installation/Setup */

File:BFLibInstall.JPG

2024-03-25T20:44:04Z

Rlellis:

Contributions:BrainFlow

2024-02-01T22:38:33Z

Rlellis: /* BrainFlow Installation/Setup */

==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.

==BrainFlow Installation/Setup==
Before installation, please install [https://gitforwindows.org/ git bash] and [https://www.python.org/downloads/ python].

'''Please note that after generating the libraries for debug or release, you may ONLY build in that configuration! To switch to the other configuration you must rebuild the libraries, which can quickly be done through the BrainFlowBuild.py script in the SignalSource\BrainFlow folder'''
===Automatic Installation===

Libraries generated from BrainFlow are needed for this module, which requires the user to download and build the project. The download process (and configuring the solution) can be automated using these scripts located in SignalSource\BrainFlow:
<gallery mode="packed" widths=75px heights=75px>
File:BFModules.JPG|BrainFlow installation/configuration automation scripts
</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 "BrainFlowInstall.bat". This will clone the [https://github.com/brainflow-dev/brainflow BrainFlow repository] into the correct location (which will be one folder outside of BCI2000--if your BCI2000 copy has directory User\BCI2000, then this script will create User\brainflow). The BrainFlowBuild.py script will generate compiled libraries for either debug or release, depending on what you enter upon being prompted (0=debug, 1=release).

Afterward, you will need to add the generated libraries to your systems path. ("Compiled/{Release and/or Debug}"). This can be done by searching for "Path" in the windows search bar (which will give you the option "Edit the system environment variables"), which upon opening will open up a window labelled "System Properties". Open the "Environment Variables" tab and under the "System Variables" window click on "Path", and press edit. At the bottom of the list, enter the folder ...\brainflow\compiled.

In BCI2000's CMake window (build\Configure.sh.cmd), press the blue "Add Entry" arrow in the top right corner. In the dropdown menu for "Type:", select "PATH", then in "Name:" enter: "CMAKE_PREFIX_PATH". For the value, enter the entire file location of ...\brainflow\installed\lib\cmake\brainflow (go to the folder your BCI2000 folder resides in, a folder named "brainflow" will be located there. You can append the the location of this folder with this location so your entire file location looks like C:\Users...\{Folder containing BCI2000 folder}\brainflow\installed\lib\cmake\brainflow). After these three fields are filled out (you may leave the "Description" field blank), press "OK". Make sure under "BUILD" that "BUILD_ALL_SOURCEMODULES" is selected, and '''you will also need to deselect "USE_DYNAMIC_CRT" under "USE"'''--if this is selected, BCI2000 will fail to build. In the batch file to be used, append '''start executable BrainFlowADC --local''' to the line corresponding to the source module.

===Manual Installation===

First, in the same folder containing your working copy of BCI2000, create a folder named 'brainflow'. For example, if the location of your copy of BCI2000 is C:\Users\Bob\Desktop\BCI2000, your folder will be C:\Users\Bob\Desktop\brainflow. In this new folder, open [https://gitforwindows.org/ git bash], and enter 'git clone https://github.com/brainflow-dev/brainflow.git'. After installation is complete, navigate to the 'tools' folder, and run build.py. This will create the solution needed to generate the libraries for EITHER debug or release.

Afterward, you will need to add the generated libraries to your systems path. ("brainflow\compiled\{Release and/or Debug}")

If you wish to use debug mode, open build.py and search for 'config' until you find a section that looks like this:

def build(args):
if platform.system() == 'Windows':
config = 'Release'

'config' determines how the solution is built, so adjust this according to which version you plan to use ("Release" or "Debug"), then run it.

Afterward, you will need to add the generated libraries to your systems path. ("Compiled/{Release and/or Debug}"). This can be done by searching for "Path" in the windows search bar, which will show "Edit the system environment variables", which upon opening will open up a tab labelled system properties. Open the "Environment" tab and click on "Path" under the "System Variables" window, and press edit. At the bottom of the list, enter the folder ...\brainflow\compiled.

In BCI2000's CMake window (build\Configure.sh.cmd), press the blue "Add Entry" arrow in the top right corner. In the dropdown menu for "Type:", select "PATH", then in "Name:" enter: "CMAKE_PREFIX_PATH". For the value, enter the entire file location of brainflow\installed\lib\cmake\brainflow (go to the folder your BCI2000 folder resides in, a folder named "brainflow" will be located there. You can append the the location of this folder with this location so your entire file location looks like C:\Users...\{Folder containing BCI2000 folder}\brainflow\installed\lib\cmake\brainflow). After these three fields are filled out, press "OK". Make sure under "BUILD" that "BUILD_ALL_SOURCEMODULES" is selected, '''and you will also need to deselect "USE_DYNAMIC_CRT" under "USE"'''. In the batch file to be used, append '''start executable BrainFlowADC --local''' to the line corresponding to the source module.

==Parameters==
===BoardID===
Identifier for the boad in use, compatable with any board able to be used with BrainFlow.

===RecordingChannels===
Sets which board channels will be used for data aquisition. Some boards will not have all listed channel types, in which case no data will be collected from such types.

===COM===
Specifies the port the device is connected to

===MAC===
Specifies the MAC address of the device

Contributions:BrainFlow

2024-01-17T21:43:43Z

Rlellis: /* Manual Installation */

==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.

==BrainFlow Installation/Setup==
Before installation, please install [https://gitforwindows.org/ git bash] and [https://www.python.org/downloads/ python].

'''Please note that after generating the libraries for debug or release, you may ONLY build in that configuration! To switch to the other configuration you must rebuild the libraries, which can quickly be done through the BrainFlowBuild.py script in the SignalSource\BrainFlow folder'''
===Automatic Installation===

Libraries generated from BrainFlow are needed for this module, which requires the user to download and build the project. The download process (and configuring the solution) can be automated using these scripts located in SignalSource\BrainFlow:
<gallery mode="packed" widths=75px heights=75px>
File:BFModules.JPG|BrainFlow installation/configuration automation scripts
</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 "BrainFlowInstall.bat". This will clone the [https://github.com/brainflow-dev/brainflow BrainFlow repository] into the correct location (which will be one folder outside of BCI2000--if your BCI2000 copy has directory User\BCI2000, then this script will create User\brainflow). The BrainFlowBuild.py script will generate compiled libraries for either debug or release, depending on what you enter upon being prompted (0=debug, 1=release).

Afterward, you will need to add the generated libraries to your systems path. ("Compiled/{Release and/or Debug}"). This can be done by searching for "Path" in the windows search bar, which will show "Edit the system environment variables", which upon opening will open up a tab labelled system properties. Open the "Environment" tab and click on "Path" under the "System Variables" window, and press edit. At the bottom of the list, enter the folder ...\brainflow\compiled.

In BCI2000's CMake window (build\Configure.sh.cmd), press the blue "Add Entry" arrow in the top right corner. In the dropdown menu for "Type:", select "PATH", then in "Name:" enter: "CMAKE_PREFIX_PATH". For the value, enter the entire file location of ...\brainflow\installed\lib\cmake\brainflow (go to the folder your BCI2000 folder resides in, a folder named "brainflow" will be located there. You can append the the location of this folder with this location so your entire file location looks like C:\Users...\{Folder containing BCI2000 folder}\brainflow\installed\lib\cmake\brainflow). After these three fields are filled out, press "OK". Make sure under "BUILD" that "BUILD_ALL_SOURCEMODULES" is selected, and '''you will also need to deselect "USE_DYNAMIC_CRT" under "USE"'''--if this is selected, BCI2000 will fail to build. In the batch file to be used, append '''start executable BrainFlowADC --local''' to the line corresponding to the source module.

===Manual Installation===

First, in the same folder containing your working copy of BCI2000, create a folder named 'brainflow'. For example, if the location of your copy of BCI2000 is C:\Users\Bob\Desktop\BCI2000, your folder will be C:\Users\Bob\Desktop\brainflow. In this new folder, open [https://gitforwindows.org/ git bash], and enter 'git clone https://github.com/brainflow-dev/brainflow.git'. After installation is complete, navigate to the 'tools' folder, and run build.py. This will create the solution needed to generate the libraries for EITHER debug or release.

Afterward, you will need to add the generated libraries to your systems path. ("brainflow\compiled\{Release and/or Debug}")

If you wish to use debug mode, open build.py and search for 'config' until you find a section that looks like this:

def build(args):
if platform.system() == 'Windows':
config = 'Release'

'config' determines how the solution is built, so adjust this according to which version you plan to use ("Release" or "Debug"), then run it.

Afterward, you will need to add the generated libraries to your systems path. ("Compiled/{Release and/or Debug}"). This can be done by searching for "Path" in the windows search bar, which will show "Edit the system environment variables", which upon opening will open up a tab labelled system properties. Open the "Environment" tab and click on "Path" under the "System Variables" window, and press edit. At the bottom of the list, enter the folder ...\brainflow\compiled.

In BCI2000's CMake window (build\Configure.sh.cmd), press the blue "Add Entry" arrow in the top right corner. In the dropdown menu for "Type:", select "PATH", then in "Name:" enter: "CMAKE_PREFIX_PATH". For the value, enter the entire file location of brainflow\installed\lib\cmake\brainflow (go to the folder your BCI2000 folder resides in, a folder named "brainflow" will be located there. You can append the the location of this folder with this location so your entire file location looks like C:\Users...\{Folder containing BCI2000 folder}\brainflow\installed\lib\cmake\brainflow). After these three fields are filled out, press "OK". Make sure under "BUILD" that "BUILD_ALL_SOURCEMODULES" is selected, '''and you will also need to deselect "USE_DYNAMIC_CRT" under "USE"'''. In the batch file to be used, append '''start executable BrainFlowADC --local''' to the line corresponding to the source module.

==Parameters==
===BoardID===
Identifier for the boad in use, compatable with any board able to be used with BrainFlow.

===RecordingChannels===
Sets which board channels will be used for data aquisition. Some boards will not have all listed channel types, in which case no data will be collected from such types.

===COM===
Specifies the port the device is connected to

===MAC===
Specifies the MAC address of the device

Contributions:BrainFlow

2024-01-17T21:43:23Z

Rlellis: /* Manual Installation */

==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.

==BrainFlow Installation/Setup==
Before installation, please install [https://gitforwindows.org/ git bash] and [https://www.python.org/downloads/ python].

'''Please note that after generating the libraries for debug or release, you may ONLY build in that configuration! To switch to the other configuration you must rebuild the libraries, which can quickly be done through the BrainFlowBuild.py script in the SignalSource\BrainFlow folder'''
===Automatic Installation===

Libraries generated from BrainFlow are needed for this module, which requires the user to download and build the project. The download process (and configuring the solution) can be automated using these scripts located in SignalSource\BrainFlow:
<gallery mode="packed" widths=75px heights=75px>
File:BFModules.JPG|BrainFlow installation/configuration automation scripts
</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 "BrainFlowInstall.bat". This will clone the [https://github.com/brainflow-dev/brainflow BrainFlow repository] into the correct location (which will be one folder outside of BCI2000--if your BCI2000 copy has directory User\BCI2000, then this script will create User\brainflow). The BrainFlowBuild.py script will generate compiled libraries for either debug or release, depending on what you enter upon being prompted (0=debug, 1=release).

Afterward, you will need to add the generated libraries to your systems path. ("Compiled/{Release and/or Debug}"). This can be done by searching for "Path" in the windows search bar, which will show "Edit the system environment variables", which upon opening will open up a tab labelled system properties. Open the "Environment" tab and click on "Path" under the "System Variables" window, and press edit. At the bottom of the list, enter the folder ...\brainflow\compiled.

In BCI2000's CMake window (build\Configure.sh.cmd), press the blue "Add Entry" arrow in the top right corner. In the dropdown menu for "Type:", select "PATH", then in "Name:" enter: "CMAKE_PREFIX_PATH". For the value, enter the entire file location of ...\brainflow\installed\lib\cmake\brainflow (go to the folder your BCI2000 folder resides in, a folder named "brainflow" will be located there. You can append the the location of this folder with this location so your entire file location looks like C:\Users...\{Folder containing BCI2000 folder}\brainflow\installed\lib\cmake\brainflow). After these three fields are filled out, press "OK". Make sure under "BUILD" that "BUILD_ALL_SOURCEMODULES" is selected, and '''you will also need to deselect "USE_DYNAMIC_CRT" under "USE"'''--if this is selected, BCI2000 will fail to build. In the batch file to be used, append '''start executable BrainFlowADC --local''' to the line corresponding to the source module.

===Manual Installation===

First, in the same folder containing your working copy of BCI2000, create a folder named 'brainflow'. For example, if the location of your copy of BCI2000 is C:\Users\Bob\Desktop\BCI2000, your folder will be C:\Users\Bob\Desktop\brainflow. In this new folder, open [https://gitforwindows.org/ git bash], and enter 'git clone https://github.com/brainflow-dev/brainflow'. After installation is complete, navigate to the 'tools' folder, and run build.py. This will create the solution needed to generate the libraries for EITHER debug or release.

Afterward, you will need to add the generated libraries to your systems path. ("brainflow\compiled\{Release and/or Debug}")

If you wish to use debug mode, open build.py and search for 'config' until you find a section that looks like this:

def build(args):
if platform.system() == 'Windows':
config = 'Release'

'config' determines how the solution is built, so adjust this according to which version you plan to use ("Release" or "Debug"), then run it.

Afterward, you will need to add the generated libraries to your systems path. ("Compiled/{Release and/or Debug}"). This can be done by searching for "Path" in the windows search bar, which will show "Edit the system environment variables", which upon opening will open up a tab labelled system properties. Open the "Environment" tab and click on "Path" under the "System Variables" window, and press edit. At the bottom of the list, enter the folder ...\brainflow\compiled.

In BCI2000's CMake window (build\Configure.sh.cmd), press the blue "Add Entry" arrow in the top right corner. In the dropdown menu for "Type:", select "PATH", then in "Name:" enter: "CMAKE_PREFIX_PATH". For the value, enter the entire file location of brainflow\installed\lib\cmake\brainflow (go to the folder your BCI2000 folder resides in, a folder named "brainflow" will be located there. You can append the the location of this folder with this location so your entire file location looks like C:\Users...\{Folder containing BCI2000 folder}\brainflow\installed\lib\cmake\brainflow). After these three fields are filled out, press "OK". Make sure under "BUILD" that "BUILD_ALL_SOURCEMODULES" is selected, '''and you will also need to deselect "USE_DYNAMIC_CRT" under "USE"'''. In the batch file to be used, append '''start executable BrainFlowADC --local''' to the line corresponding to the source module.

==Parameters==
===BoardID===
Identifier for the boad in use, compatable with any board able to be used with BrainFlow.

===RecordingChannels===
Sets which board channels will be used for data aquisition. Some boards will not have all listed channel types, in which case no data will be collected from such types.

===COM===
Specifies the port the device is connected to

===MAC===
Specifies the MAC address of the device

Contributions:BrainFlow

2024-01-17T21:37:54Z

Rlellis: /* Parameters */

==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.

==BrainFlow Installation/Setup==
Before installation, please install [https://gitforwindows.org/ git bash] and [https://www.python.org/downloads/ python].

'''Please note that after generating the libraries for debug or release, you may ONLY build in that configuration! To switch to the other configuration you must rebuild the libraries, which can quickly be done through the BrainFlowBuild.py script in the SignalSource\BrainFlow folder'''
===Automatic Installation===

Libraries generated from BrainFlow are needed for this module, which requires the user to download and build the project. The download process (and configuring the solution) can be automated using these scripts located in SignalSource\BrainFlow:
<gallery mode="packed" widths=75px heights=75px>
File:BFModules.JPG|BrainFlow installation/configuration automation scripts
</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 "BrainFlowInstall.bat". This will clone the [https://github.com/brainflow-dev/brainflow BrainFlow repository] into the correct location (which will be one folder outside of BCI2000--if your BCI2000 copy has directory User\BCI2000, then this script will create User\brainflow). The BrainFlowBuild.py script will generate compiled libraries for either debug or release, depending on what you enter upon being prompted (0=debug, 1=release).

Afterward, you will need to add the generated libraries to your systems path. ("Compiled/{Release and/or Debug}"). This can be done by searching for "Path" in the windows search bar, which will show "Edit the system environment variables", which upon opening will open up a tab labelled system properties. Open the "Environment" tab and click on "Path" under the "System Variables" window, and press edit. At the bottom of the list, enter the folder ...\brainflow\compiled.

In BCI2000's CMake window (build\Configure.sh.cmd), press the blue "Add Entry" arrow in the top right corner. In the dropdown menu for "Type:", select "PATH", then in "Name:" enter: "CMAKE_PREFIX_PATH". For the value, enter the entire file location of ...\brainflow\installed\lib\cmake\brainflow (go to the folder your BCI2000 folder resides in, a folder named "brainflow" will be located there. You can append the the location of this folder with this location so your entire file location looks like C:\Users...\{Folder containing BCI2000 folder}\brainflow\installed\lib\cmake\brainflow). After these three fields are filled out, press "OK". Make sure under "BUILD" that "BUILD_ALL_SOURCEMODULES" is selected, and '''you will also need to deselect "USE_DYNAMIC_CRT" under "USE"'''--if this is selected, BCI2000 will fail to build. In the batch file to be used, append '''start executable BrainFlowADC --local''' to the line corresponding to the source module.

===Manual Installation===

First, in the same folder containing your working copy of BCI2000, create a folder named 'brainflow'. For example, if the location of your copy of BCI2000 is C:\Users\Bob\Desktop\BCI2000, your folder will be C:\Users\Bob\Desktop\brainflow. In this new folder, open [https://gitforwindows.org/ git bash], and enter 'git clone https://github.com/OpenBCI/brainflow.git' ([https://github.com/OpenBCI/brainflow/tree/master BrainFlow]). After installation is complete, navigate to the 'tools' folder, and run build.py. This will create the solution needed to generate the libraries for EITHER debug or release.

Afterward, you will need to add the generated libraries to your systems path. ("brainflow\compiled\{Release and/or Debug}")

If you wish to use debug mode, open build.py and search for 'config' until you find a section that looks like this:

def build(args):
if platform.system() == 'Windows':
config = 'Release'

'config' determines how the solution is built, so adjust this according to which version you plan to use ("Release" or "Debug"), then run it.

Afterward, you will need to add the generated libraries to your systems path. ("Compiled/{Release and/or Debug}"). This can be done by searching for "Path" in the windows search bar, which will show "Edit the system environment variables", which upon opening will open up a tab labelled system properties. Open the "Environment" tab and click on "Path" under the "System Variables" window, and press edit. At the bottom of the list, enter the folder ...\brainflow\compiled.

In BCI2000's CMake window (build\Configure.sh.cmd), press the blue "Add Entry" arrow in the top right corner. In the dropdown menu for "Type:", select "PATH", then in "Name:" enter: "CMAKE_PREFIX_PATH". For the value, enter the entire file location of brainflow\installed\lib\cmake\brainflow (go to the folder your BCI2000 folder resides in, a folder named "brainflow" will be located there. You can append the the location of this folder with this location so your entire file location looks like C:\Users...\{Folder containing BCI2000 folder}\brainflow\installed\lib\cmake\brainflow). After these three fields are filled out, press "OK". Make sure under "BUILD" that "BUILD_ALL_SOURCEMODULES" is selected, '''and you will also need to deselect "USE_DYNAMIC_CRT" under "USE"'''. In the batch file to be used, append '''start executable BrainFlowADC --local''' to the line corresponding to the source module.

==Parameters==
===BoardID===
Identifier for the boad in use, compatable with any board able to be used with BrainFlow.

===RecordingChannels===
Sets which board channels will be used for data aquisition. Some boards will not have all listed channel types, in which case no data will be collected from such types.

===COM===
Specifies the port the device is connected to

===MAC===
Specifies the MAC address of the device

Contributions:BrainFlow

2024-01-17T21:37:25Z

Rlellis: /* Automatic Installation */

==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.

==BrainFlow Installation/Setup==
Before installation, please install [https://gitforwindows.org/ git bash] and [https://www.python.org/downloads/ python].

'''Please note that after generating the libraries for debug or release, you may ONLY build in that configuration! To switch to the other configuration you must rebuild the libraries, which can quickly be done through the BrainFlowBuild.py script in the SignalSource\BrainFlow folder'''
===Automatic Installation===

Libraries generated from BrainFlow are needed for this module, which requires the user to download and build the project. The download process (and configuring the solution) can be automated using these scripts located in SignalSource\BrainFlow:
<gallery mode="packed" widths=75px heights=75px>
File:BFModules.JPG|BrainFlow installation/configuration automation scripts
</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 "BrainFlowInstall.bat". This will clone the [https://github.com/brainflow-dev/brainflow BrainFlow repository] into the correct location (which will be one folder outside of BCI2000--if your BCI2000 copy has directory User\BCI2000, then this script will create User\brainflow). The BrainFlowBuild.py script will generate compiled libraries for either debug or release, depending on what you enter upon being prompted (0=debug, 1=release).

Afterward, you will need to add the generated libraries to your systems path. ("Compiled/{Release and/or Debug}"). This can be done by searching for "Path" in the windows search bar, which will show "Edit the system environment variables", which upon opening will open up a tab labelled system properties. Open the "Environment" tab and click on "Path" under the "System Variables" window, and press edit. At the bottom of the list, enter the folder ...\brainflow\compiled.

In BCI2000's CMake window (build\Configure.sh.cmd), press the blue "Add Entry" arrow in the top right corner. In the dropdown menu for "Type:", select "PATH", then in "Name:" enter: "CMAKE_PREFIX_PATH". For the value, enter the entire file location of ...\brainflow\installed\lib\cmake\brainflow (go to the folder your BCI2000 folder resides in, a folder named "brainflow" will be located there. You can append the the location of this folder with this location so your entire file location looks like C:\Users...\{Folder containing BCI2000 folder}\brainflow\installed\lib\cmake\brainflow). After these three fields are filled out, press "OK". Make sure under "BUILD" that "BUILD_ALL_SOURCEMODULES" is selected, and '''you will also need to deselect "USE_DYNAMIC_CRT" under "USE"'''--if this is selected, BCI2000 will fail to build. In the batch file to be used, append '''start executable BrainFlowADC --local''' to the line corresponding to the source module.

===Manual Installation===

First, in the same folder containing your working copy of BCI2000, create a folder named 'brainflow'. For example, if the location of your copy of BCI2000 is C:\Users\Bob\Desktop\BCI2000, your folder will be C:\Users\Bob\Desktop\brainflow. In this new folder, open [https://gitforwindows.org/ git bash], and enter 'git clone https://github.com/OpenBCI/brainflow.git' ([https://github.com/OpenBCI/brainflow/tree/master BrainFlow]). After installation is complete, navigate to the 'tools' folder, and run build.py. This will create the solution needed to generate the libraries for EITHER debug or release.

Afterward, you will need to add the generated libraries to your systems path. ("brainflow\compiled\{Release and/or Debug}")

If you wish to use debug mode, open build.py and search for 'config' until you find a section that looks like this:

def build(args):
if platform.system() == 'Windows':
config = 'Release'

'config' determines how the solution is built, so adjust this according to which version you plan to use ("Release" or "Debug"), then run it.

Afterward, you will need to add the generated libraries to your systems path. ("Compiled/{Release and/or Debug}"). This can be done by searching for "Path" in the windows search bar, which will show "Edit the system environment variables", which upon opening will open up a tab labelled system properties. Open the "Environment" tab and click on "Path" under the "System Variables" window, and press edit. At the bottom of the list, enter the folder ...\brainflow\compiled.

In BCI2000's CMake window (build\Configure.sh.cmd), press the blue "Add Entry" arrow in the top right corner. In the dropdown menu for "Type:", select "PATH", then in "Name:" enter: "CMAKE_PREFIX_PATH". For the value, enter the entire file location of brainflow\installed\lib\cmake\brainflow (go to the folder your BCI2000 folder resides in, a folder named "brainflow" will be located there. You can append the the location of this folder with this location so your entire file location looks like C:\Users...\{Folder containing BCI2000 folder}\brainflow\installed\lib\cmake\brainflow). After these three fields are filled out, press "OK". Make sure under "BUILD" that "BUILD_ALL_SOURCEMODULES" is selected, '''and you will also need to deselect "USE_DYNAMIC_CRT" under "USE"'''. In the batch file to be used, append '''start executable BrainFlowADC --local''' to the line corresponding to the source module.

==Parameters==
===BoardID===
Identifier for the boad in use, compatable with any board able to be used with BrainFlow.

===RecordingChannels===
Sets which board channels will be used for data aquisition. Some boards will not have all listed channel types, in which case no data will be collected from such types.

===COM===
Specifies the port the device is connected to

===MAC===
Specifies the MAC address of the device

C:/Users/Robbie/Documents/BCI2000folder/brainflow/installed/lib/cmake/brainflow

C:/Users/Robbie/Documents/BCI2000folder/brainflow/installed/lib/Brainflow.lib
C:/Users/Robbie/Documents/BCI2000folder/brainflow/compiled/Debug/BoardController.lib
C:/Users/Robbie/Documents/BCI2000folder/brainflow/compiled/Debug/DataHandler.lib
C:/Users/Robbie/Documents/BCI2000folder/brainflow/compiled/Debug/MLModule.lib
C:\Users\Robbie\Documents\BCI2000folder\brainflow\installed\lib\cmake\brainflow

Contributions:BrainFlow

2024-01-17T21:36:32Z

Rlellis: /* Automatic Installation */

==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.

==BrainFlow Installation/Setup==
Before installation, please install [https://gitforwindows.org/ git bash] and [https://www.python.org/downloads/ python].

'''Please note that after generating the libraries for debug or release, you may ONLY build in that configuration! To switch to the other configuration you must rebuild the libraries, which can quickly be done through the BrainFlowBuild.py script in the SignalSource\BrainFlow folder'''
===Automatic Installation===

Libraries generated from BrainFlow are needed for this module, which requires the user to download and build the project. The download process (and configuring the solution) can be automated using these scripts located in SignalSource\BrainFlow:
<gallery mode="packed" widths=75px heights=75px>
File:BFModules.JPG|BrainFlow installation/configuration automation scripts
</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 "BrainFlowInstall.bat". This will clone the [https://github.com/brainflow-dev/brainflow BrainFlow repository] into the correct location (which will be one folder outside of BCI2000--if your BCI2000 copy has directory User\BCI2000, then this script will create User\brainflow) as well as run the BrainFlowBuild.py script, which will generate compiled libraries for either debug or release, depending on what you enter upon being prompted (0=debug, 1=release).

Afterward, you will need to add the generated libraries to your systems path. ("Compiled/{Release and/or Debug}"). This can be done by searching for "Path" in the windows search bar, which will show "Edit the system environment variables", which upon opening will open up a tab labelled system properties. Open the "Environment" tab and click on "Path" under the "System Variables" window, and press edit. At the bottom of the list, enter the folder ...\brainflow\compiled.

In BCI2000's CMake window (build\Configure.sh.cmd), press the blue "Add Entry" arrow in the top right corner. In the dropdown menu for "Type:", select "PATH", then in "Name:" enter: "CMAKE_PREFIX_PATH". For the value, enter the entire file location of ...\brainflow\installed\lib\cmake\brainflow (go to the folder your BCI2000 folder resides in, a folder named "brainflow" will be located there. You can append the the location of this folder with this location so your entire file location looks like C:\Users...\{Folder containing BCI2000 folder}\brainflow\installed\lib\cmake\brainflow). After these three fields are filled out, press "OK". Make sure under "BUILD" that "BUILD_ALL_SOURCEMODULES" is selected, and '''you will also need to deselect "USE_DYNAMIC_CRT" under "USE"'''--if this is selected, BCI2000 will fail to build. In the batch file to be used, append '''start executable BrainFlowADC --local''' to the line corresponding to the source module.

===Manual Installation===

First, in the same folder containing your working copy of BCI2000, create a folder named 'brainflow'. For example, if the location of your copy of BCI2000 is C:\Users\Bob\Desktop\BCI2000, your folder will be C:\Users\Bob\Desktop\brainflow. In this new folder, open [https://gitforwindows.org/ git bash], and enter 'git clone https://github.com/OpenBCI/brainflow.git' ([https://github.com/OpenBCI/brainflow/tree/master BrainFlow]). After installation is complete, navigate to the 'tools' folder, and run build.py. This will create the solution needed to generate the libraries for EITHER debug or release.

Afterward, you will need to add the generated libraries to your systems path. ("brainflow\compiled\{Release and/or Debug}")

If you wish to use debug mode, open build.py and search for 'config' until you find a section that looks like this:

def build(args):
if platform.system() == 'Windows':
config = 'Release'

'config' determines how the solution is built, so adjust this according to which version you plan to use ("Release" or "Debug"), then run it.

Afterward, you will need to add the generated libraries to your systems path. ("Compiled/{Release and/or Debug}"). This can be done by searching for "Path" in the windows search bar, which will show "Edit the system environment variables", which upon opening will open up a tab labelled system properties. Open the "Environment" tab and click on "Path" under the "System Variables" window, and press edit. At the bottom of the list, enter the folder ...\brainflow\compiled.

In BCI2000's CMake window (build\Configure.sh.cmd), press the blue "Add Entry" arrow in the top right corner. In the dropdown menu for "Type:", select "PATH", then in "Name:" enter: "CMAKE_PREFIX_PATH". For the value, enter the entire file location of brainflow\installed\lib\cmake\brainflow (go to the folder your BCI2000 folder resides in, a folder named "brainflow" will be located there. You can append the the location of this folder with this location so your entire file location looks like C:\Users...\{Folder containing BCI2000 folder}\brainflow\installed\lib\cmake\brainflow). After these three fields are filled out, press "OK". Make sure under "BUILD" that "BUILD_ALL_SOURCEMODULES" is selected, '''and you will also need to deselect "USE_DYNAMIC_CRT" under "USE"'''. In the batch file to be used, append '''start executable BrainFlowADC --local''' to the line corresponding to the source module.

==Parameters==
===BoardID===
Identifier for the boad in use, compatable with any board able to be used with BrainFlow.

===RecordingChannels===
Sets which board channels will be used for data aquisition. Some boards will not have all listed channel types, in which case no data will be collected from such types.

===COM===
Specifies the port the device is connected to

===MAC===
Specifies the MAC address of the device

C:/Users/Robbie/Documents/BCI2000folder/brainflow/installed/lib/cmake/brainflow

C:/Users/Robbie/Documents/BCI2000folder/brainflow/installed/lib/Brainflow.lib
C:/Users/Robbie/Documents/BCI2000folder/brainflow/compiled/Debug/BoardController.lib
C:/Users/Robbie/Documents/BCI2000folder/brainflow/compiled/Debug/DataHandler.lib
C:/Users/Robbie/Documents/BCI2000folder/brainflow/compiled/Debug/MLModule.lib
C:\Users\Robbie\Documents\BCI2000folder\brainflow\installed\lib\cmake\brainflow

Contributions:BrainFlow

2024-01-17T21:36:12Z

Rlellis: /* BrainFlow Installation/Setup */

==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.

==BrainFlow Installation/Setup==
Before installation, please install [https://gitforwindows.org/ git bash] and [https://www.python.org/downloads/ python].

'''Please note that after generating the libraries for debug or release, you may ONLY build in that configuration! To switch to the other configuration you must rebuild the libraries, which can quickly be done through the BrainFlowBuild.py script in the SignalSource\BrainFlow folder'''
===Automatic Installation===

Libraries generated from BrainFlow are needed for this module, which requires the user to download and build the project. The download process (and configuring the solution) can be automated using these scripts located in SignalSource\BrainFlow:
<gallery mode="packed" widths=75px heights=75px>
File:BFModules.JPG|BrainFlow installation/configuration automation scripts
</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 "BrainFlowInstall.bat". This will clone the [https://github.com/brainflow-dev/brainflow BrainFlow repository]*** into the correct location (which will be one folder outside of BCI2000--if your BCI2000 copy has directory User\BCI2000, then this script will create User\brainflow) as well as run the BrainFlowBuild.py script, which will generate compiled libraries for either debug or release, depending on what you enter upon being prompted (0=debug, 1=release).

Afterward, you will need to add the generated libraries to your systems path. ("Compiled/{Release and/or Debug}"). This can be done by searching for "Path" in the windows search bar, which will show "Edit the system environment variables", which upon opening will open up a tab labelled system properties. Open the "Environment" tab and click on "Path" under the "System Variables" window, and press edit. At the bottom of the list, enter the folder ...\brainflow\compiled.

In BCI2000's CMake window (build\Configure.sh.cmd), press the blue "Add Entry" arrow in the top right corner. In the dropdown menu for "Type:", select "PATH", then in "Name:" enter: "CMAKE_PREFIX_PATH". For the value, enter the entire file location of ...\brainflow\installed\lib\cmake\brainflow (go to the folder your BCI2000 folder resides in, a folder named "brainflow" will be located there. You can append the the location of this folder with this location so your entire file location looks like C:\Users...\{Folder containing BCI2000 folder}\brainflow\installed\lib\cmake\brainflow). After these three fields are filled out, press "OK". Make sure under "BUILD" that "BUILD_ALL_SOURCEMODULES" is selected, and '''you will also need to deselect "USE_DYNAMIC_CRT" under "USE"'''--if this is selected, BCI2000 will fail to build. In the batch file to be used, append '''start executable BrainFlowADC --local''' to the line corresponding to the source module.

===Manual Installation===

First, in the same folder containing your working copy of BCI2000, create a folder named 'brainflow'. For example, if the location of your copy of BCI2000 is C:\Users\Bob\Desktop\BCI2000, your folder will be C:\Users\Bob\Desktop\brainflow. In this new folder, open [https://gitforwindows.org/ git bash], and enter 'git clone https://github.com/OpenBCI/brainflow.git' ([https://github.com/OpenBCI/brainflow/tree/master BrainFlow]). After installation is complete, navigate to the 'tools' folder, and run build.py. This will create the solution needed to generate the libraries for EITHER debug or release.

Afterward, you will need to add the generated libraries to your systems path. ("brainflow\compiled\{Release and/or Debug}")

If you wish to use debug mode, open build.py and search for 'config' until you find a section that looks like this:

def build(args):
if platform.system() == 'Windows':
config = 'Release'

'config' determines how the solution is built, so adjust this according to which version you plan to use ("Release" or "Debug"), then run it.

Afterward, you will need to add the generated libraries to your systems path. ("Compiled/{Release and/or Debug}"). This can be done by searching for "Path" in the windows search bar, which will show "Edit the system environment variables", which upon opening will open up a tab labelled system properties. Open the "Environment" tab and click on "Path" under the "System Variables" window, and press edit. At the bottom of the list, enter the folder ...\brainflow\compiled.

In BCI2000's CMake window (build\Configure.sh.cmd), press the blue "Add Entry" arrow in the top right corner. In the dropdown menu for "Type:", select "PATH", then in "Name:" enter: "CMAKE_PREFIX_PATH". For the value, enter the entire file location of brainflow\installed\lib\cmake\brainflow (go to the folder your BCI2000 folder resides in, a folder named "brainflow" will be located there. You can append the the location of this folder with this location so your entire file location looks like C:\Users...\{Folder containing BCI2000 folder}\brainflow\installed\lib\cmake\brainflow). After these three fields are filled out, press "OK". Make sure under "BUILD" that "BUILD_ALL_SOURCEMODULES" is selected, '''and you will also need to deselect "USE_DYNAMIC_CRT" under "USE"'''. In the batch file to be used, append '''start executable BrainFlowADC --local''' to the line corresponding to the source module.

==Parameters==
===BoardID===
Identifier for the boad in use, compatable with any board able to be used with BrainFlow.

===RecordingChannels===
Sets which board channels will be used for data aquisition. Some boards will not have all listed channel types, in which case no data will be collected from such types.

===COM===
Specifies the port the device is connected to

===MAC===
Specifies the MAC address of the device

C:/Users/Robbie/Documents/BCI2000folder/brainflow/installed/lib/cmake/brainflow

C:/Users/Robbie/Documents/BCI2000folder/brainflow/installed/lib/Brainflow.lib
C:/Users/Robbie/Documents/BCI2000folder/brainflow/compiled/Debug/BoardController.lib
C:/Users/Robbie/Documents/BCI2000folder/brainflow/compiled/Debug/DataHandler.lib
C:/Users/Robbie/Documents/BCI2000folder/brainflow/compiled/Debug/MLModule.lib
C:\Users\Robbie\Documents\BCI2000folder\brainflow\installed\lib\cmake\brainflow

Contributions:BrainFlow

2024-01-17T21:35:21Z

Rlellis: /* Automatic Installation */

==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.

==BrainFlow Installation/Setup==
Before installation, please install [https://gitforwindows.org/ git bash] and [https://www.python.org/downloads/ python].

'''Please note that after generating the libraries for debug or release, you may ONLY build in that configuration! To switch to the other configuration you must rebuild the libraries, which can quickly be done through the BrainFlowBuild.py script in the SignalSource\BrainFlow folder'''
===Automatic Installation===

Libraries generated from BrainFlow are needed for this module, which requires the user to download and build the project. The download process (and configuring the solution) can be automated using these scripts:
<gallery mode="packed" widths=75px heights=75px>
File:BFModules.JPG|BrainFlow installation/configuration automation scripts
</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 "BrainFlowInstall.bat". This will clone the [https://github.com/brainflow-dev/brainflow BrainFlow repository]*** into the correct location (which will be one folder outside of BCI2000--if your BCI2000 copy has directory User\BCI2000, then this script will create User\brainflow) as well as run the BrainFlowBuild.py script, which will generate compiled libraries for either debug or release, depending on what you enter upon being prompted (0=debug, 1=release).

Afterward, you will need to add the generated libraries to your systems path. ("Compiled/{Release and/or Debug}"). This can be done by searching for "Path" in the windows search bar, which will show "Edit the system environment variables", which upon opening will open up a tab labelled system properties. Open the "Environment" tab and click on "Path" under the "System Variables" window, and press edit. At the bottom of the list, enter the folder ...\brainflow\compiled.

In BCI2000's CMake window (build\Configure.sh.cmd), press the blue "Add Entry" arrow in the top right corner. In the dropdown menu for "Type:", select "PATH", then in "Name:" enter: "CMAKE_PREFIX_PATH". For the value, enter the entire file location of ...\brainflow\installed\lib\cmake\brainflow (go to the folder your BCI2000 folder resides in, a folder named "brainflow" will be located there. You can append the the location of this folder with this location so your entire file location looks like C:\Users...\{Folder containing BCI2000 folder}\brainflow\installed\lib\cmake\brainflow). After these three fields are filled out, press "OK". Make sure under "BUILD" that "BUILD_ALL_SOURCEMODULES" is selected, and '''you will also need to deselect "USE_DYNAMIC_CRT" under "USE"'''--if this is selected, BCI2000 will fail to build. In the batch file to be used, append '''start executable BrainFlowADC --local''' to the line corresponding to the source module.

===Manual Installation===

First, in the same folder containing your working copy of BCI2000, create a folder named 'brainflow'. For example, if the location of your copy of BCI2000 is C:\Users\Bob\Desktop\BCI2000, your folder will be C:\Users\Bob\Desktop\brainflow. In this new folder, open [https://gitforwindows.org/ git bash], and enter 'git clone https://github.com/OpenBCI/brainflow.git' ([https://github.com/OpenBCI/brainflow/tree/master BrainFlow]). After installation is complete, navigate to the 'tools' folder, and run build.py. This will create the solution needed to generate the libraries for EITHER debug or release.

Afterward, you will need to add the generated libraries to your systems path. ("brainflow\compiled\{Release and/or Debug}")

If you wish to use debug mode, open build.py and search for 'config' until you find a section that looks like this:

def build(args):
if platform.system() == 'Windows':
config = 'Release'

'config' determines how the solution is built, so adjust this according to which version you plan to use ("Release" or "Debug"), then run it.

Afterward, you will need to add the generated libraries to your systems path. ("Compiled/{Release and/or Debug}"). This can be done by searching for "Path" in the windows search bar, which will show "Edit the system environment variables", which upon opening will open up a tab labelled system properties. Open the "Environment" tab and click on "Path" under the "System Variables" window, and press edit. At the bottom of the list, enter the folder ...\brainflow\compiled.

In BCI2000's CMake window (build\Configure.sh.cmd), press the blue "Add Entry" arrow in the top right corner. In the dropdown menu for "Type:", select "PATH", then in "Name:" enter: "CMAKE_PREFIX_PATH". For the value, enter the entire file location of brainflow\installed\lib\cmake\brainflow (go to the folder your BCI2000 folder resides in, a folder named "brainflow" will be located there. You can append the the location of this folder with this location so your entire file location looks like C:\Users...\{Folder containing BCI2000 folder}\brainflow\installed\lib\cmake\brainflow). After these three fields are filled out, press "OK". Make sure under "BUILD" that "BUILD_ALL_SOURCEMODULES" is selected, '''and you will also need to deselect "USE_DYNAMIC_CRT" under "USE"'''. In the batch file to be used, append '''start executable BrainFlowADC --local''' to the line corresponding to the source module.

==Parameters==
===BoardID===
Identifier for the boad in use, compatable with any board able to be used with BrainFlow.

===RecordingChannels===
Sets which board channels will be used for data aquisition. Some boards will not have all listed channel types, in which case no data will be collected from such types.

===COM===
Specifies the port the device is connected to

===MAC===
Specifies the MAC address of the device

C:/Users/Robbie/Documents/BCI2000folder/brainflow/installed/lib/cmake/brainflow

C:/Users/Robbie/Documents/BCI2000folder/brainflow/installed/lib/Brainflow.lib
C:/Users/Robbie/Documents/BCI2000folder/brainflow/compiled/Debug/BoardController.lib
C:/Users/Robbie/Documents/BCI2000folder/brainflow/compiled/Debug/DataHandler.lib
C:/Users/Robbie/Documents/BCI2000folder/brainflow/compiled/Debug/MLModule.lib
C:\Users\Robbie\Documents\BCI2000folder\brainflow\installed\lib\cmake\brainflow

Contributions:BrainFlow

2024-01-17T21:35:14Z

Rlellis: /* Automatic Installation */

==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.

==BrainFlow Installation/Setup==
Before installation, please install [https://gitforwindows.org/ git bash] and [https://www.python.org/downloads/ python].

'''Please note that after generating the libraries for debug or release, you may ONLY build in that configuration! To switch to the other configuration you must rebuild the libraries, which can quickly be done through the BrainFlowBuild.py script in the SignalSource\BrainFlow folder'''
===Automatic Installation===

Libraries generated from BrainFlow are needed for this module, which requires the user to download and build the project. The download process (and configuring the solution) can be automated using these scripts:
<gallery mode="packed" widths=75px heights=75px>
File:BFModules.JPG|BrainFlow installation/configuration automation scripts
</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 "BrainFlowInstall.bat". This will clone the [https://github.com/brainflow-dev/brainflow BrainFlow repository]*** into the correct location (which will be one folder outside of BCI2000--if your BCI2000 copy has directory User\BCI2000, then this script will create User\brainflow) as well as run the BrainFlowBuild.py script, which will generate compiled libraries for either debug or release, depending on what you enter upon being prompted (0=debug, 1=release).

Afterward, you will need to add the generated libraries to your systems path. ("Compiled/{Release and/or Debug}"). This can be done by searching for "Path" in the windows search bar, which will show "Edit the system environment variables", which upon opening will open up a tab labelled system properties. Open the "Environment" tab and click on "Path" under the "System Variables" window, and press edit. At the bottom of the list, enter the folder ...\brainflow\compiled.

In BCI2000's CMake window (build\Configure.sh.cmd), press the blue "Add Entry" arrow in the top right corner. In the dropdown menu for "Type:", select "PATH", then in "Name:" enter: "CMAKE_PREFIX_PATH". For the value, enter the entire file location of ...\brainflow\installed\lib\cmake\brainflow (go to the folder your BCI2000 folder resides in, a folder named "brainflow" will be located there. You can append the the location of this folder with this location so your entire file location looks like C:\Users...\{Folder containing BCI2000 folder}\brainflow\installed\lib\cmake\brainflow). After these three fields are filled out, press "OK". Make sure under "BUILD" that "BUILD_ALL_SOURCEMODULES" is selected, and '''you will also need to deselect "USE_DYNAMIC_CRT" under "USE"'''--if this is selected, BCI2000 will fail to build. In the batch file to be used, append '''start executable BrainFlowADC --local''' to the line corresponding to the source module.

===Manual Installation===

First, in the same folder containing your working copy of BCI2000, create a folder named 'brainflow'. For example, if the location of your copy of BCI2000 is C:\Users\Bob\Desktop\BCI2000, your folder will be C:\Users\Bob\Desktop\brainflow. In this new folder, open [https://gitforwindows.org/ git bash], and enter 'git clone https://github.com/OpenBCI/brainflow.git' ([https://github.com/OpenBCI/brainflow/tree/master BrainFlow]). After installation is complete, navigate to the 'tools' folder, and run build.py. This will create the solution needed to generate the libraries for EITHER debug or release.

Afterward, you will need to add the generated libraries to your systems path. ("brainflow\compiled\{Release and/or Debug}")

If you wish to use debug mode, open build.py and search for 'config' until you find a section that looks like this:

def build(args):
if platform.system() == 'Windows':
config = 'Release'

'config' determines how the solution is built, so adjust this according to which version you plan to use ("Release" or "Debug"), then run it.

Afterward, you will need to add the generated libraries to your systems path. ("Compiled/{Release and/or Debug}"). This can be done by searching for "Path" in the windows search bar, which will show "Edit the system environment variables", which upon opening will open up a tab labelled system properties. Open the "Environment" tab and click on "Path" under the "System Variables" window, and press edit. At the bottom of the list, enter the folder ...\brainflow\compiled.

In BCI2000's CMake window (build\Configure.sh.cmd), press the blue "Add Entry" arrow in the top right corner. In the dropdown menu for "Type:", select "PATH", then in "Name:" enter: "CMAKE_PREFIX_PATH". For the value, enter the entire file location of brainflow\installed\lib\cmake\brainflow (go to the folder your BCI2000 folder resides in, a folder named "brainflow" will be located there. You can append the the location of this folder with this location so your entire file location looks like C:\Users...\{Folder containing BCI2000 folder}\brainflow\installed\lib\cmake\brainflow). After these three fields are filled out, press "OK". Make sure under "BUILD" that "BUILD_ALL_SOURCEMODULES" is selected, '''and you will also need to deselect "USE_DYNAMIC_CRT" under "USE"'''. In the batch file to be used, append '''start executable BrainFlowADC --local''' to the line corresponding to the source module.

==Parameters==
===BoardID===
Identifier for the boad in use, compatable with any board able to be used with BrainFlow.

===RecordingChannels===
Sets which board channels will be used for data aquisition. Some boards will not have all listed channel types, in which case no data will be collected from such types.

===COM===
Specifies the port the device is connected to

===MAC===
Specifies the MAC address of the device

C:/Users/Robbie/Documents/BCI2000folder/brainflow/installed/lib/cmake/brainflow

C:/Users/Robbie/Documents/BCI2000folder/brainflow/installed/lib/Brainflow.lib
C:/Users/Robbie/Documents/BCI2000folder/brainflow/compiled/Debug/BoardController.lib
C:/Users/Robbie/Documents/BCI2000folder/brainflow/compiled/Debug/DataHandler.lib
C:/Users/Robbie/Documents/BCI2000folder/brainflow/compiled/Debug/MLModule.lib
C:\Users\Robbie\Documents\BCI2000folder\brainflow\installed\lib\cmake\brainflow

Contributions:BrainFlow

2024-01-17T21:35:00Z

Rlellis: /* BrainFlow Installation/Setup */

==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.

==BrainFlow Installation/Setup==
Before installation, please install [https://gitforwindows.org/ git bash] and [https://www.python.org/downloads/ python].

'''Please note that after generating the libraries for debug or release, you may ONLY build in that configuration! To switch to the other configuration you must rebuild the libraries, which can quickly be done through the BrainFlowBuild.py script in the SignalSource\BrainFlow folder'''
===Automatic Installation===

Libraries generated from BrainFlow are needed for this module, which requires the user to download and build the project. The download process (and configuring the solution) can be automated using these scripts:
<gallery mode="packed" widths=75px heights=75px>
File:BFModules.JPG|BrainFlow installation/configuration automation scripts
</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 "BrainFlowInstall.bat". This will clone the [https://github.com/brainflow-dev/brainflow BrainFlow repository]*** into the correct location (which will be one folder outside of BCI2000--if your BCI2000 copy has directory User\BCI2000, then this script will create User\brainflow) as well as run the BrainFlowBuild.py script, which will generate compiled libraries for either debug or release, depending on what you enter upon being prompted (0=debug, 1=release).

Afterward, you will need to add the generated libraries to your systems path. ("Compiled/{Release and/or Debug}"). This can be done by searching for "Path" in the windows search bar, which will show "Edit the system environment variables", which upon opening will open up a tab labelled system properties. Open the "Environment" tab and click on "Path" under the "System Variables" window, and press edit. At the bottom of the list, enter the folder ...\brainflow\compiled.

C:\Users\Robbie\Documents\BCI2000folder\brainflow\installed\lib

In BCI2000's CMake window (build\Configure.sh.cmd), press the blue "Add Entry" arrow in the top right corner. In the dropdown menu for "Type:", select "PATH", then in "Name:" enter: "CMAKE_PREFIX_PATH". For the value, enter the entire file location of ...\brainflow\installed\lib\cmake\brainflow (go to the folder your BCI2000 folder resides in, a folder named "brainflow" will be located there. You can append the the location of this folder with this location so your entire file location looks like C:\Users...\{Folder containing BCI2000 folder}\brainflow\installed\lib\cmake\brainflow). After these three fields are filled out, press "OK". Make sure under "BUILD" that "BUILD_ALL_SOURCEMODULES" is selected, and '''you will also need to deselect "USE_DYNAMIC_CRT" under "USE"'''--if this is selected, BCI2000 will fail to build. In the batch file to be used, append '''start executable BrainFlowADC --local''' to the line corresponding to the source module.

===Manual Installation===

First, in the same folder containing your working copy of BCI2000, create a folder named 'brainflow'. For example, if the location of your copy of BCI2000 is C:\Users\Bob\Desktop\BCI2000, your folder will be C:\Users\Bob\Desktop\brainflow. In this new folder, open [https://gitforwindows.org/ git bash], and enter 'git clone https://github.com/OpenBCI/brainflow.git' ([https://github.com/OpenBCI/brainflow/tree/master BrainFlow]). After installation is complete, navigate to the 'tools' folder, and run build.py. This will create the solution needed to generate the libraries for EITHER debug or release.

Afterward, you will need to add the generated libraries to your systems path. ("brainflow\compiled\{Release and/or Debug}")

If you wish to use debug mode, open build.py and search for 'config' until you find a section that looks like this:

def build(args):
if platform.system() == 'Windows':
config = 'Release'

'config' determines how the solution is built, so adjust this according to which version you plan to use ("Release" or "Debug"), then run it.

Afterward, you will need to add the generated libraries to your systems path. ("Compiled/{Release and/or Debug}"). This can be done by searching for "Path" in the windows search bar, which will show "Edit the system environment variables", which upon opening will open up a tab labelled system properties. Open the "Environment" tab and click on "Path" under the "System Variables" window, and press edit. At the bottom of the list, enter the folder ...\brainflow\compiled.

In BCI2000's CMake window (build\Configure.sh.cmd), press the blue "Add Entry" arrow in the top right corner. In the dropdown menu for "Type:", select "PATH", then in "Name:" enter: "CMAKE_PREFIX_PATH". For the value, enter the entire file location of brainflow\installed\lib\cmake\brainflow (go to the folder your BCI2000 folder resides in, a folder named "brainflow" will be located there. You can append the the location of this folder with this location so your entire file location looks like C:\Users...\{Folder containing BCI2000 folder}\brainflow\installed\lib\cmake\brainflow). After these three fields are filled out, press "OK". Make sure under "BUILD" that "BUILD_ALL_SOURCEMODULES" is selected, '''and you will also need to deselect "USE_DYNAMIC_CRT" under "USE"'''. In the batch file to be used, append '''start executable BrainFlowADC --local''' to the line corresponding to the source module.

==Parameters==
===BoardID===
Identifier for the boad in use, compatable with any board able to be used with BrainFlow.

===RecordingChannels===
Sets which board channels will be used for data aquisition. Some boards will not have all listed channel types, in which case no data will be collected from such types.

===COM===
Specifies the port the device is connected to

===MAC===
Specifies the MAC address of the device

C:/Users/Robbie/Documents/BCI2000folder/brainflow/installed/lib/cmake/brainflow

C:/Users/Robbie/Documents/BCI2000folder/brainflow/installed/lib/Brainflow.lib
C:/Users/Robbie/Documents/BCI2000folder/brainflow/compiled/Debug/BoardController.lib
C:/Users/Robbie/Documents/BCI2000folder/brainflow/compiled/Debug/DataHandler.lib
C:/Users/Robbie/Documents/BCI2000folder/brainflow/compiled/Debug/MLModule.lib
C:\Users\Robbie\Documents\BCI2000folder\brainflow\installed\lib\cmake\brainflow

Contributions:BrainFlow

2024-01-17T21:34:42Z

Rlellis: /* BrainFlow Installation/Setup */

==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.

==BrainFlow Installation/Setup==
Before installation, please install [https://gitforwindows.org/ git bash] and [https://www.python.org/downloads/ python].
'''Please note that after generating the libraries for debug or release, you may ONLY build in that configuration! To switch to the other configuration you must rebuild the libraries, which can quickly be done through the BrainFlowBuild.py script in the SignalSource\BrainFlow folder'''
===Automatic Installation===

Libraries generated from BrainFlow are needed for this module, which requires the user to download and build the project. The download process (and configuring the solution) can be automated using these scripts:
<gallery mode="packed" widths=75px heights=75px>
File:BFModules.JPG|BrainFlow installation/configuration automation scripts
</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 "BrainFlowInstall.bat". This will clone the [https://github.com/brainflow-dev/brainflow BrainFlow repository]*** into the correct location (which will be one folder outside of BCI2000--if your BCI2000 copy has directory User\BCI2000, then this script will create User\brainflow) as well as run the BrainFlowBuild.py script, which will generate compiled libraries for either debug or release, depending on what you enter upon being prompted (0=debug, 1=release).

Afterward, you will need to add the generated libraries to your systems path. ("Compiled/{Release and/or Debug}"). This can be done by searching for "Path" in the windows search bar, which will show "Edit the system environment variables", which upon opening will open up a tab labelled system properties. Open the "Environment" tab and click on "Path" under the "System Variables" window, and press edit. At the bottom of the list, enter the folder ...\brainflow\compiled.

C:\Users\Robbie\Documents\BCI2000folder\brainflow\installed\lib

In BCI2000's CMake window (build\Configure.sh.cmd), press the blue "Add Entry" arrow in the top right corner. In the dropdown menu for "Type:", select "PATH", then in "Name:" enter: "CMAKE_PREFIX_PATH". For the value, enter the entire file location of ...\brainflow\installed\lib\cmake\brainflow (go to the folder your BCI2000 folder resides in, a folder named "brainflow" will be located there. You can append the the location of this folder with this location so your entire file location looks like C:\Users...\{Folder containing BCI2000 folder}\brainflow\installed\lib\cmake\brainflow). After these three fields are filled out, press "OK". Make sure under "BUILD" that "BUILD_ALL_SOURCEMODULES" is selected, and '''you will also need to deselect "USE_DYNAMIC_CRT" under "USE"'''--if this is selected, BCI2000 will fail to build. In the batch file to be used, append '''start executable BrainFlowADC --local''' to the line corresponding to the source module.

===Manual Installation===

First, in the same folder containing your working copy of BCI2000, create a folder named 'brainflow'. For example, if the location of your copy of BCI2000 is C:\Users\Bob\Desktop\BCI2000, your folder will be C:\Users\Bob\Desktop\brainflow. In this new folder, open [https://gitforwindows.org/ git bash], and enter 'git clone https://github.com/OpenBCI/brainflow.git' ([https://github.com/OpenBCI/brainflow/tree/master BrainFlow]). After installation is complete, navigate to the 'tools' folder, and run build.py. This will create the solution needed to generate the libraries for EITHER debug or release.

Afterward, you will need to add the generated libraries to your systems path. ("brainflow\compiled\{Release and/or Debug}")

If you wish to use debug mode, open build.py and search for 'config' until you find a section that looks like this:

def build(args):
if platform.system() == 'Windows':
config = 'Release'

'config' determines how the solution is built, so adjust this according to which version you plan to use ("Release" or "Debug"), then run it.

Afterward, you will need to add the generated libraries to your systems path. ("Compiled/{Release and/or Debug}"). This can be done by searching for "Path" in the windows search bar, which will show "Edit the system environment variables", which upon opening will open up a tab labelled system properties. Open the "Environment" tab and click on "Path" under the "System Variables" window, and press edit. At the bottom of the list, enter the folder ...\brainflow\compiled.

In BCI2000's CMake window (build\Configure.sh.cmd), press the blue "Add Entry" arrow in the top right corner. In the dropdown menu for "Type:", select "PATH", then in "Name:" enter: "CMAKE_PREFIX_PATH". For the value, enter the entire file location of brainflow\installed\lib\cmake\brainflow (go to the folder your BCI2000 folder resides in, a folder named "brainflow" will be located there. You can append the the location of this folder with this location so your entire file location looks like C:\Users...\{Folder containing BCI2000 folder}\brainflow\installed\lib\cmake\brainflow). After these three fields are filled out, press "OK". Make sure under "BUILD" that "BUILD_ALL_SOURCEMODULES" is selected, '''and you will also need to deselect "USE_DYNAMIC_CRT" under "USE"'''. In the batch file to be used, append '''start executable BrainFlowADC --local''' to the line corresponding to the source module.

==Parameters==
===BoardID===
Identifier for the boad in use, compatable with any board able to be used with BrainFlow.

===RecordingChannels===
Sets which board channels will be used for data aquisition. Some boards will not have all listed channel types, in which case no data will be collected from such types.

===COM===
Specifies the port the device is connected to

===MAC===
Specifies the MAC address of the device

C:/Users/Robbie/Documents/BCI2000folder/brainflow/installed/lib/cmake/brainflow

C:/Users/Robbie/Documents/BCI2000folder/brainflow/installed/lib/Brainflow.lib
C:/Users/Robbie/Documents/BCI2000folder/brainflow/compiled/Debug/BoardController.lib
C:/Users/Robbie/Documents/BCI2000folder/brainflow/compiled/Debug/DataHandler.lib
C:/Users/Robbie/Documents/BCI2000folder/brainflow/compiled/Debug/MLModule.lib
C:\Users\Robbie\Documents\BCI2000folder\brainflow\installed\lib\cmake\brainflow

Contributions:BrainFlow

2024-01-17T21:34:21Z

Rlellis: /* BrainFlow Installation/Setup */

==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.

==BrainFlow Installation/Setup==
Before installation, please install [https://gitforwindows.org/ git bash] and [https://www.python.org/downloads/ python].

===Automatic Installation===
'''Please note that after generating the libraries for debug or release, you may ONLY build in that configuration! To switch to the other configuration you must rebuild the libraries, which can quickly be done through the BrainFlowBuild.py script in the SignalSource\BrainFlow folder'''

Libraries generated from BrainFlow are needed for this module, which requires the user to download and build the project. The download process (and configuring the solution) can be automated using these scripts:
<gallery mode="packed" widths=75px heights=75px>
File:BFModules.JPG|BrainFlow installation/configuration automation scripts
</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 "BrainFlowInstall.bat". This will clone the [https://github.com/brainflow-dev/brainflow BrainFlow repository]*** into the correct location (which will be one folder outside of BCI2000--if your BCI2000 copy has directory User\BCI2000, then this script will create User\brainflow) as well as run the BrainFlowBuild.py script, which will generate compiled libraries for either debug or release, depending on what you enter upon being prompted (0=debug, 1=release).

Afterward, you will need to add the generated libraries to your systems path. ("Compiled/{Release and/or Debug}"). This can be done by searching for "Path" in the windows search bar, which will show "Edit the system environment variables", which upon opening will open up a tab labelled system properties. Open the "Environment" tab and click on "Path" under the "System Variables" window, and press edit. At the bottom of the list, enter the folder ...\brainflow\compiled.

C:\Users\Robbie\Documents\BCI2000folder\brainflow\installed\lib

In BCI2000's CMake window (build\Configure.sh.cmd), press the blue "Add Entry" arrow in the top right corner. In the dropdown menu for "Type:", select "PATH", then in "Name:" enter: "CMAKE_PREFIX_PATH". For the value, enter the entire file location of ...\brainflow\installed\lib\cmake\brainflow (go to the folder your BCI2000 folder resides in, a folder named "brainflow" will be located there. You can append the the location of this folder with this location so your entire file location looks like C:\Users...\{Folder containing BCI2000 folder}\brainflow\installed\lib\cmake\brainflow). After these three fields are filled out, press "OK". Make sure under "BUILD" that "BUILD_ALL_SOURCEMODULES" is selected, and '''you will also need to deselect "USE_DYNAMIC_CRT" under "USE"'''--if this is selected, BCI2000 will fail to build. In the batch file to be used, append '''start executable BrainFlowADC --local''' to the line corresponding to the source module.

===Manual Installation===

First, in the same folder containing your working copy of BCI2000, create a folder named 'brainflow'. For example, if the location of your copy of BCI2000 is C:\Users\Bob\Desktop\BCI2000, your folder will be C:\Users\Bob\Desktop\brainflow. In this new folder, open [https://gitforwindows.org/ git bash], and enter 'git clone https://github.com/OpenBCI/brainflow.git' ([https://github.com/OpenBCI/brainflow/tree/master BrainFlow]). After installation is complete, navigate to the 'tools' folder, and run build.py. This will create the solution needed to generate the libraries for EITHER debug or release.

Afterward, you will need to add the generated libraries to your systems path. ("brainflow\compiled\{Release and/or Debug}")

If you wish to use debug mode, open build.py and search for 'config' until you find a section that looks like this:

def build(args):
if platform.system() == 'Windows':
config = 'Release'

'config' determines how the solution is built, so adjust this according to which version you plan to use ("Release" or "Debug"), then run it.

Afterward, you will need to add the generated libraries to your systems path. ("Compiled/{Release and/or Debug}"). This can be done by searching for "Path" in the windows search bar, which will show "Edit the system environment variables", which upon opening will open up a tab labelled system properties. Open the "Environment" tab and click on "Path" under the "System Variables" window, and press edit. At the bottom of the list, enter the folder ...\brainflow\compiled.

In BCI2000's CMake window (build\Configure.sh.cmd), press the blue "Add Entry" arrow in the top right corner. In the dropdown menu for "Type:", select "PATH", then in "Name:" enter: "CMAKE_PREFIX_PATH". For the value, enter the entire file location of brainflow\installed\lib\cmake\brainflow (go to the folder your BCI2000 folder resides in, a folder named "brainflow" will be located there. You can append the the location of this folder with this location so your entire file location looks like C:\Users...\{Folder containing BCI2000 folder}\brainflow\installed\lib\cmake\brainflow). After these three fields are filled out, press "OK". Make sure under "BUILD" that "BUILD_ALL_SOURCEMODULES" is selected, '''and you will also need to deselect "USE_DYNAMIC_CRT" under "USE"'''. In the batch file to be used, append '''start executable BrainFlowADC --local''' to the line corresponding to the source module.

==Parameters==
===BoardID===
Identifier for the boad in use, compatable with any board able to be used with BrainFlow.

===RecordingChannels===
Sets which board channels will be used for data aquisition. Some boards will not have all listed channel types, in which case no data will be collected from such types.

===COM===
Specifies the port the device is connected to

===MAC===
Specifies the MAC address of the device

C:/Users/Robbie/Documents/BCI2000folder/brainflow/installed/lib/cmake/brainflow

C:/Users/Robbie/Documents/BCI2000folder/brainflow/installed/lib/Brainflow.lib
C:/Users/Robbie/Documents/BCI2000folder/brainflow/compiled/Debug/BoardController.lib
C:/Users/Robbie/Documents/BCI2000folder/brainflow/compiled/Debug/DataHandler.lib
C:/Users/Robbie/Documents/BCI2000folder/brainflow/compiled/Debug/MLModule.lib
C:\Users\Robbie\Documents\BCI2000folder\brainflow\installed\lib\cmake\brainflow

Contributions:BrainFlow

2023-12-11T23:26:43Z

Rlellis: /* BrainFlow Installation/Setup */

==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.

==BrainFlow Installation/Setup==
Before installation, please install [https://gitforwindows.org/ git bash] and [https://www.python.org/downloads/ python].

===Automatic Installation===

Libraries generated from BrainFlow are needed for this module, which requires the user to download and build the project. The download process (and configuring the solution) can be automated using these scripts:
<gallery mode="packed" widths=75px heights=75px>
File:BFModules.JPG|BrainFlow installation/configuration automation scripts
</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 "BrainFlowInstall.bat". This will clone the [https://github.com/brainflow-dev/brainflow BrainFlow repository]*** into the correct location as well as run the BrainFlowBuild.py script, which will generate compiled libraries for either debug or release, depending on what you enter upon being prompted (0=debug, 1=release).

Afterward, you will need to add the generated libraries to your systems path. ("Compiled/{Release and/or Debug}")

In BCI2000's CMake window (build\Configure.sh.cmd), press the blue "Add Entry" arrow in the top right corner. In the dropdown menu for "Type:", select "PATH", then in "Name:" enter: "CMAKE_PREFIX_PATH". For the value, enter the entire file location of brainflow\installed\lib\cmake\brainflow (go to the folder your BCI2000 folder resides in, a folder named "brainflow" will be located there. You can append the the location of this folder with this location so your entire file location looks like C:\Users...\{Folder containing BCI2000 folder}\brainflow\installed\lib\cmake\brainflow). After these three fields are filled out, press "OK". Make sure under "BUILD" that "BUILD_ALL_SOURCEMODULES" is selected, and '''you will also need to deselect "USE_DYNAMIC_CRT" under "USE"'''. In the batch file to be used, append '''start executable BrainFlowADC --local''' to the line corresponding to the source module.

===Manual Installation===

First, in the same folder containing your working copy of BCI2000, create a folder named 'brainflow'. For example, if the location of your copy of BCI2000 is C:\Users\Bob\Desktop\BCI2000, your folder will be C:\Users\Bob\Desktop\brainflow. In this new folder, open [https://gitforwindows.org/ git bash], and enter 'git clone https://github.com/OpenBCI/brainflow.git' ([https://github.com/OpenBCI/brainflow/tree/master BrainFlow]). After installation is complete, navigate to the 'tools' folder, and run build.py. This will create the solution needed to generate the libraries for EITHER debug or release.

Afterward, you will need to add the generated libraries to your systems path. ("brainflow\compiled\{Release and/or Debug}")

If you wish to use debug mode, open build.py and search for 'config' until you find a section that looks like this:

def build(args):
if platform.system() == 'Windows':
config = 'Release'

'config' determines how the solution is built, so adjust this according to which version you plan to use ("Release" or "Debug"), then run it.

Next, go to brainflow\build and open 'brainflow.sln'. Set the version to match the config used above (release or debug), and build the solution.

In BCI2000's CMake window (build\Configure.sh.cmd), press the blue "Add Entry" arrow in the top right corner. In the dropdown menu for "Type:", select "PATH", then in "Name:" enter: "CMAKE_PREFIX_PATH". For the value, enter the entire file location of brainflow\installed\lib\cmake\brainflow (go to the folder your BCI2000 folder resides in, a folder named "brainflow" will be located there. You can append the the location of this folder with this location so your entire file location looks like C:\Users...\{Folder containing BCI2000 folder}\brainflow\installed\lib\cmake\brainflow). After these three fields are filled out, press "OK". Make sure under "BUILD" that "BUILD_ALL_SOURCEMODULES" is selected, '''and you will also need to deselect "USE_DYNAMIC_CRT" under "USE"'''. In the batch file to be used, append '''start executable BrainFlowADC --local''' to the line corresponding to the source module.

==Parameters==
===BoardID===
Identifier for the boad in use, compatable with any board able to be used with BrainFlow.

===RecordingChannels===
Sets which board channels will be used for data aquisition. Some boards will not have all listed channel types, in which case no data will be collected from such types.

===COM===
Specifies the port the device is connected to

===MAC===
Specifies the MAC address of the device

C:/Users/Robbie/Documents/BCI2000folder/brainflow/installed/lib/cmake/brainflow

C:/Users/Robbie/Documents/BCI2000folder/brainflow/installed/lib/Brainflow.lib
C:/Users/Robbie/Documents/BCI2000folder/brainflow/compiled/Debug/BoardController.lib
C:/Users/Robbie/Documents/BCI2000folder/brainflow/compiled/Debug/DataHandler.lib
C:/Users/Robbie/Documents/BCI2000folder/brainflow/compiled/Debug/MLModule.lib
C:\Users\Robbie\Documents\BCI2000folder\brainflow\installed\lib\cmake\brainflow

Contributions:BrainFlow

2023-12-11T23:26:01Z

Rlellis: /* BrainFlow Installation/Setup */

==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.

==BrainFlow Installation/Setup==
Before installation, please install [https://gitforwindows.org/ git bash] and [https://www.python.org/downloads/ python].

===Automatic Installation===

Libraries generated from BrainFlow are needed for this module, which requires the user to download and build the project. The download process (and configuring the solution) can be automated using these scripts:
<gallery mode="packed" widths=75px heights=75px>
File:BFModules.JPG|BrainFlow installation/configuration automation scripts
</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 "BrainFlowInstall.bat". This will clone the [https://github.com/brainflow-dev/brainflow BrainFlow repository]*** into the correct location as well as run the BrainFlowBuild.py script, which will generate compiled libraries for either debug or release, depending on what you enter upon being prompted (0=debug, 1=release).

Afterward, you will need to add the generated libraries to your systems path. ("Compiled/{Release and/or Debug}")

In BCI2000's CMake window (build\Configure.sh.cmd), press the blue "Add Entry" arrow in the top right corner. In the dropdown menu for "Type:", select "PATH", then in "Name:" enter: "CMAKE_PREFIX_PATH". For the value, enter the entire file location of brainflow\installed\lib\cmake\brainflow (go to the folder your BCI2000 folder resides in, a folder named "brainflow" will be located there. You can append the the location of this folder with this location so your entire file location looks like C:\Users...\{Folder containing BCI2000 folder}\brainflow\installed\lib\cmake\brainflow). After these three fields are filled out, press "OK". Make sure under "BUILD" that "BUILD_ALL_SOURCEMODULES" is selected, and '''you will also need to deselect "USE_DYNAMIC_CRT" under "USE"'''. In the batch file to be used, append '''start executable BrainFlowADC --local''' to the line corresponding to the source module to be used.

===Manual Installation===

First, in the same folder containing your working copy of BCI2000, create a folder named 'brainflow'. For example, if the location of your copy of BCI2000 is C:\Users\Bob\Desktop\BCI2000, your folder will be C:\Users\Bob\Desktop\brainflow. In this new folder, open [https://gitforwindows.org/ git bash], and enter 'git clone https://github.com/OpenBCI/brainflow.git' ([https://github.com/OpenBCI/brainflow/tree/master BrainFlow]). After installation is complete, navigate to the 'tools' folder, and run build.py. This will create the solution needed to generate the libraries for EITHER debug or release.

Afterward, you will need to add the generated libraries to your systems path. ("brainflow\compiled\{Release and/or Debug}")

If you wish to use debug mode, open build.py and search for 'config' until you find a section that looks like this:

def build(args):
if platform.system() == 'Windows':
config = 'Release'

'config' determines how the solution is built, so adjust this according to which version you plan to use ("Release" or "Debug"), then run it.

Next, go to brainflow\build and open 'brainflow.sln'. Set the version to match the config used above (release or debug), and build the solution.

In BCI2000's CMake window (build\Configure.sh.cmd), press the blue "Add Entry" arrow in the top right corner. In the dropdown menu for "Type:", select "PATH", then in "Name:" enter: "CMAKE_PREFIX_PATH". For the value, enter the entire file location of brainflow\installed\lib\cmake\brainflow (go to the folder your BCI2000 folder resides in, a folder named "brainflow" will be located there. You can append the the location of this folder with this location so your entire file location looks like C:\Users...\{Folder containing BCI2000 folder}\brainflow\installed\lib\cmake\brainflow). After these three fields are filled out, press "OK". Make sure under "BUILD" that "BUILD_ALL_SOURCEMODULES" is selected, '''and you will also need to deselect "USE_DYNAMIC_CRT" under "USE"'''. In the batch file to be used, append '''start executable BrainFlowADC --local''' to the line corresponding to the source module to be used.

==Parameters==
===BoardID===
Identifier for the boad in use, compatable with any board able to be used with BrainFlow.

===RecordingChannels===
Sets which board channels will be used for data aquisition. Some boards will not have all listed channel types, in which case no data will be collected from such types.

===COM===
Specifies the port the device is connected to

===MAC===
Specifies the MAC address of the device

C:/Users/Robbie/Documents/BCI2000folder/brainflow/installed/lib/cmake/brainflow

C:/Users/Robbie/Documents/BCI2000folder/brainflow/installed/lib/Brainflow.lib
C:/Users/Robbie/Documents/BCI2000folder/brainflow/compiled/Debug/BoardController.lib
C:/Users/Robbie/Documents/BCI2000folder/brainflow/compiled/Debug/DataHandler.lib
C:/Users/Robbie/Documents/BCI2000folder/brainflow/compiled/Debug/MLModule.lib
C:\Users\Robbie\Documents\BCI2000folder\brainflow\installed\lib\cmake\brainflow

Contributions:BrainFlow

2023-12-11T23:19:48Z

Rlellis: /* Installation */

==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.

==BrainFlow Installation/Setup==
Before installation, please install [https://gitforwindows.org/ git bash] and [https://www.python.org/downloads/ python].

===Automatic Installation===

Libraries generated from BrainFlow are needed for this module, which requires the user to download and build the project. The download process (and configuring the solution) can be automated using these scripts:
<gallery mode="packed" widths=75px heights=75px>
File:BFModules.JPG|BrainFlow installation/configuration automation scripts
</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 "BrainFlowInstall.bat". This will clone the [https://github.com/brainflow-dev/brainflow BrainFlow repository]*** into the correct location as well as run the BrainFlowBuild.py script, which will generate compiled libraries for either debug or release, depending on what you enter upon being prompted (0=debug, 1=release).

Afterward, you will need to add the generated libraries to your systems path. ("Compiled/{Release and/or Debug}")

In BCI2000's CMake window (build\Configure.sh.cmd), press the blue "Add Entry" arrow in the top right corner. In the dropdown menu for "Type:", select "PATH", then in "Name:" enter: "CMAKE_PREFIX_PATH". For the value, enter the entire file location of brainflow\installed\lib\cmake\brainflow (go to the folder your BCI2000 folder resides in, a folder named "brainflow" will be located there. You can append the the location of this folder with this location so your entire file location looks like C:\Users...\{Folder containing BCI2000 folder}\brainflow\installed\lib\cmake\brainflow). After these three fields are filled out, press "OK". Make sure under "BUILD" that "BUILD_ALL_SOURCEMODULES" is selected, and '''you will also need to deselect "USE_DYNAMIC_CRT" under "USE"'''.

===Manual Installation===

First, in the same folder containing your working copy of BCI2000, create a folder named 'brainflow'. For example, if the location of your copy of BCI2000 is C:\Users\Bob\Desktop\BCI2000, your folder will be C:\Users\Bob\Desktop\brainflow. In this new folder, open [https://gitforwindows.org/ git bash], and enter 'git clone https://github.com/OpenBCI/brainflow.git' ([https://github.com/OpenBCI/brainflow/tree/master BrainFlow]). After installation is complete, navigate to the 'tools' folder, and run build.py. This will create the solution needed to generate the libraries for EITHER debug or release.

Afterward, you will need to add the generated libraries to your systems path. ("brainflow\compiled\{Release and/or Debug}")

If you wish to use debug mode, open build.py and search for 'config' until you find a section that looks like this:

def build(args):
if platform.system() == 'Windows':
config = 'Release'

'config' determines how the solution is built, so adjust this according to which version you plan to use ("Release" or "Debug"), then run it.

Next, go to brainflow\build and open 'brainflow.sln'. Set the version to match the config used above (release or debug), and build the solution.

In BCI2000's CMake window (build\Configure.sh.cmd), press the blue "Add Entry" arrow in the top right corner. In the dropdown menu for "Type:", select "PATH", then in "Name:" enter: "CMAKE_PREFIX_PATH". For the value, enter the entire file location of brainflow\installed\lib\cmake\brainflow (go to the folder your BCI2000 folder resides in, a folder named "brainflow" will be located there. You can append the the location of this folder with this location so your entire file location looks like C:\Users...\{Folder containing BCI2000 folder}\brainflow\installed\lib\cmake\brainflow). After these three fields are filled out, press "OK". Make sure under "BUILD" that "BUILD_ALL_SOURCEMODULES" is selected, '''and you will also need to deselect "USE_DYNAMIC_CRT" under "USE"'''.

==Parameters==
===BoardID===
Identifier for the boad in use, compatable with any board able to be used with BrainFlow.

===RecordingChannels===
Sets which board channels will be used for data aquisition. Some boards will not have all listed channel types, in which case no data will be collected from such types.

===COM===
Specifies the port the device is connected to

===MAC===
Specifies the MAC address of the device

C:/Users/Robbie/Documents/BCI2000folder/brainflow/installed/lib/cmake/brainflow

C:/Users/Robbie/Documents/BCI2000folder/brainflow/installed/lib/Brainflow.lib
C:/Users/Robbie/Documents/BCI2000folder/brainflow/compiled/Debug/BoardController.lib
C:/Users/Robbie/Documents/BCI2000folder/brainflow/compiled/Debug/DataHandler.lib
C:/Users/Robbie/Documents/BCI2000folder/brainflow/compiled/Debug/MLModule.lib
C:\Users\Robbie\Documents\BCI2000folder\brainflow\installed\lib\cmake\brainflow

Contributions:BrainFlow

2023-12-11T23:19:31Z

Rlellis: /* BrainFlow Installation/Setup */

==Installation==
==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.

==BrainFlow Installation/Setup==
Before installation, please install [https://gitforwindows.org/ git bash] and [https://www.python.org/downloads/ python].

===Automatic Installation===

Libraries generated from BrainFlow are needed for this module, which requires the user to download and build the project. The download process (and configuring the solution) can be automated using these scripts:
<gallery mode="packed" widths=75px heights=75px>
File:BFModules.JPG|BrainFlow installation/configuration automation scripts
</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 "BrainFlowInstall.bat". This will clone the [https://github.com/brainflow-dev/brainflow BrainFlow repository]*** into the correct location as well as run the BrainFlowBuild.py script, which will generate compiled libraries for either debug or release, depending on what you enter upon being prompted (0=debug, 1=release).

Afterward, you will need to add the generated libraries to your systems path. ("Compiled/{Release and/or Debug}")

In BCI2000's CMake window (build\Configure.sh.cmd), press the blue "Add Entry" arrow in the top right corner. In the dropdown menu for "Type:", select "PATH", then in "Name:" enter: "CMAKE_PREFIX_PATH". For the value, enter the entire file location of brainflow\installed\lib\cmake\brainflow (go to the folder your BCI2000 folder resides in, a folder named "brainflow" will be located there. You can append the the location of this folder with this location so your entire file location looks like C:\Users...\{Folder containing BCI2000 folder}\brainflow\installed\lib\cmake\brainflow). After these three fields are filled out, press "OK". Make sure under "BUILD" that "BUILD_ALL_SOURCEMODULES" is selected, and '''you will also need to deselect "USE_DYNAMIC_CRT" under "USE"'''.

===Manual Installation===

First, in the same folder containing your working copy of BCI2000, create a folder named 'brainflow'. For example, if the location of your copy of BCI2000 is C:\Users\Bob\Desktop\BCI2000, your folder will be C:\Users\Bob\Desktop\brainflow. In this new folder, open [https://gitforwindows.org/ git bash], and enter 'git clone https://github.com/OpenBCI/brainflow.git' ([https://github.com/OpenBCI/brainflow/tree/master BrainFlow]). After installation is complete, navigate to the 'tools' folder, and run build.py. This will create the solution needed to generate the libraries for EITHER debug or release.

Afterward, you will need to add the generated libraries to your systems path. ("brainflow\compiled\{Release and/or Debug}")

If you wish to use debug mode, open build.py and search for 'config' until you find a section that looks like this:

def build(args):
if platform.system() == 'Windows':
config = 'Release'

'config' determines how the solution is built, so adjust this according to which version you plan to use ("Release" or "Debug"), then run it.

Next, go to brainflow\build and open 'brainflow.sln'. Set the version to match the config used above (release or debug), and build the solution.

In BCI2000's CMake window (build\Configure.sh.cmd), press the blue "Add Entry" arrow in the top right corner. In the dropdown menu for "Type:", select "PATH", then in "Name:" enter: "CMAKE_PREFIX_PATH". For the value, enter the entire file location of brainflow\installed\lib\cmake\brainflow (go to the folder your BCI2000 folder resides in, a folder named "brainflow" will be located there. You can append the the location of this folder with this location so your entire file location looks like C:\Users...\{Folder containing BCI2000 folder}\brainflow\installed\lib\cmake\brainflow). After these three fields are filled out, press "OK". Make sure under "BUILD" that "BUILD_ALL_SOURCEMODULES" is selected, '''and you will also need to deselect "USE_DYNAMIC_CRT" under "USE"'''.

==Parameters==
===BoardID===
Identifier for the boad in use, compatable with any board able to be used with BrainFlow.

===RecordingChannels===
Sets which board channels will be used for data aquisition. Some boards will not have all listed channel types, in which case no data will be collected from such types.

===COM===
Specifies the port the device is connected to

===MAC===
Specifies the MAC address of the device

C:/Users/Robbie/Documents/BCI2000folder/brainflow/installed/lib/cmake/brainflow

C:/Users/Robbie/Documents/BCI2000folder/brainflow/installed/lib/Brainflow.lib
C:/Users/Robbie/Documents/BCI2000folder/brainflow/compiled/Debug/BoardController.lib
C:/Users/Robbie/Documents/BCI2000folder/brainflow/compiled/Debug/DataHandler.lib
C:/Users/Robbie/Documents/BCI2000folder/brainflow/compiled/Debug/MLModule.lib
C:\Users\Robbie\Documents\BCI2000folder\brainflow\installed\lib\cmake\brainflow

Contributions:BrainFlow

2023-12-11T23:19:13Z

Rlellis: /* MAC */

==Installation==
==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.

==BrainFlow Installation/Setup==
Before installation, please install [https://gitforwindows.org/ git bash] and [https://www.python.org/downloads/ python].

*'''Automatic Installation''':

Libraries generated from BrainFlow are needed for this module, which requires the user to download and build the project. The download process (and configuring the solution) can be automated using these scripts:
<gallery mode="packed" widths=75px heights=75px>
File:BFModules.JPG|BrainFlow installation/configuration automation scripts
</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 "BrainFlowInstall.bat". This will clone the [https://github.com/brainflow-dev/brainflow BrainFlow repository]*** into the correct location as well as run the BrainFlowBuild.py script, which will generate compiled libraries for either debug or release, depending on what you enter upon being prompted (0=debug, 1=release).

Afterward, you will need to add the generated libraries to your systems path. ("Compiled/{Release and/or Debug}")

In BCI2000's CMake window (build\Configure.sh.cmd), press the blue "Add Entry" arrow in the top right corner. In the dropdown menu for "Type:", select "PATH", then in "Name:" enter: "CMAKE_PREFIX_PATH". For the value, enter the entire file location of brainflow\installed\lib\cmake\brainflow (go to the folder your BCI2000 folder resides in, a folder named "brainflow" will be located there. You can append the the location of this folder with this location so your entire file location looks like C:\Users...\{Folder containing BCI2000 folder}\brainflow\installed\lib\cmake\brainflow). After these three fields are filled out, press "OK". Make sure under "BUILD" that "BUILD_ALL_SOURCEMODULES" is selected, and '''you will also need to deselect "USE_DYNAMIC_CRT" under "USE"'''.

*'''Manual Installation''':

First, in the same folder containing your working copy of BCI2000, create a folder named 'brainflow'. For example, if the location of your copy of BCI2000 is C:\Users\Bob\Desktop\BCI2000, your folder will be C:\Users\Bob\Desktop\brainflow. In this new folder, open [https://gitforwindows.org/ git bash], and enter 'git clone https://github.com/OpenBCI/brainflow.git' ([https://github.com/OpenBCI/brainflow/tree/master BrainFlow]). After installation is complete, navigate to the 'tools' folder, and run build.py. This will create the solution needed to generate the libraries for EITHER debug or release.

Afterward, you will need to add the generated libraries to your systems path. ("brainflow\compiled\{Release and/or Debug}")

If you wish to use debug mode, open build.py and search for 'config' until you find a section that looks like this:

def build(args):
if platform.system() == 'Windows':
config = 'Release'

'config' determines how the solution is built, so adjust this according to which version you plan to use ("Release" or "Debug"), then run it.

Next, go to brainflow\build and open 'brainflow.sln'. Set the version to match the config used above (release or debug), and build the solution.

In BCI2000's CMake window (build\Configure.sh.cmd), press the blue "Add Entry" arrow in the top right corner. In the dropdown menu for "Type:", select "PATH", then in "Name:" enter: "CMAKE_PREFIX_PATH". For the value, enter the entire file location of brainflow\installed\lib\cmake\brainflow (go to the folder your BCI2000 folder resides in, a folder named "brainflow" will be located there. You can append the the location of this folder with this location so your entire file location looks like C:\Users...\{Folder containing BCI2000 folder}\brainflow\installed\lib\cmake\brainflow). After these three fields are filled out, press "OK". Make sure under "BUILD" that "BUILD_ALL_SOURCEMODULES" is selected, '''and you will also need to deselect "USE_DYNAMIC_CRT" under "USE"'''.

==Parameters==
===BoardID===
Identifier for the boad in use, compatable with any board able to be used with BrainFlow.

===RecordingChannels===
Sets which board channels will be used for data aquisition. Some boards will not have all listed channel types, in which case no data will be collected from such types.

===COM===
Specifies the port the device is connected to

===MAC===
Specifies the MAC address of the device

C:/Users/Robbie/Documents/BCI2000folder/brainflow/installed/lib/cmake/brainflow

C:/Users/Robbie/Documents/BCI2000folder/brainflow/installed/lib/Brainflow.lib
C:/Users/Robbie/Documents/BCI2000folder/brainflow/compiled/Debug/BoardController.lib
C:/Users/Robbie/Documents/BCI2000folder/brainflow/compiled/Debug/DataHandler.lib
C:/Users/Robbie/Documents/BCI2000folder/brainflow/compiled/Debug/MLModule.lib
C:\Users\Robbie\Documents\BCI2000folder\brainflow\installed\lib\cmake\brainflow

Contributions:BrainFlow

2023-12-11T23:19:07Z

Rlellis: /* COM */

==Installation==
==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.

==BrainFlow Installation/Setup==
Before installation, please install [https://gitforwindows.org/ git bash] and [https://www.python.org/downloads/ python].

*'''Automatic Installation''':

Libraries generated from BrainFlow are needed for this module, which requires the user to download and build the project. The download process (and configuring the solution) can be automated using these scripts:
<gallery mode="packed" widths=75px heights=75px>
File:BFModules.JPG|BrainFlow installation/configuration automation scripts
</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 "BrainFlowInstall.bat". This will clone the [https://github.com/brainflow-dev/brainflow BrainFlow repository]*** into the correct location as well as run the BrainFlowBuild.py script, which will generate compiled libraries for either debug or release, depending on what you enter upon being prompted (0=debug, 1=release).

Afterward, you will need to add the generated libraries to your systems path. ("Compiled/{Release and/or Debug}")

In BCI2000's CMake window (build\Configure.sh.cmd), press the blue "Add Entry" arrow in the top right corner. In the dropdown menu for "Type:", select "PATH", then in "Name:" enter: "CMAKE_PREFIX_PATH". For the value, enter the entire file location of brainflow\installed\lib\cmake\brainflow (go to the folder your BCI2000 folder resides in, a folder named "brainflow" will be located there. You can append the the location of this folder with this location so your entire file location looks like C:\Users...\{Folder containing BCI2000 folder}\brainflow\installed\lib\cmake\brainflow). After these three fields are filled out, press "OK". Make sure under "BUILD" that "BUILD_ALL_SOURCEMODULES" is selected, and '''you will also need to deselect "USE_DYNAMIC_CRT" under "USE"'''.

*'''Manual Installation''':

First, in the same folder containing your working copy of BCI2000, create a folder named 'brainflow'. For example, if the location of your copy of BCI2000 is C:\Users\Bob\Desktop\BCI2000, your folder will be C:\Users\Bob\Desktop\brainflow. In this new folder, open [https://gitforwindows.org/ git bash], and enter 'git clone https://github.com/OpenBCI/brainflow.git' ([https://github.com/OpenBCI/brainflow/tree/master BrainFlow]). After installation is complete, navigate to the 'tools' folder, and run build.py. This will create the solution needed to generate the libraries for EITHER debug or release.

Afterward, you will need to add the generated libraries to your systems path. ("brainflow\compiled\{Release and/or Debug}")

If you wish to use debug mode, open build.py and search for 'config' until you find a section that looks like this:

def build(args):
if platform.system() == 'Windows':
config = 'Release'

'config' determines how the solution is built, so adjust this according to which version you plan to use ("Release" or "Debug"), then run it.

Next, go to brainflow\build and open 'brainflow.sln'. Set the version to match the config used above (release or debug), and build the solution.

In BCI2000's CMake window (build\Configure.sh.cmd), press the blue "Add Entry" arrow in the top right corner. In the dropdown menu for "Type:", select "PATH", then in "Name:" enter: "CMAKE_PREFIX_PATH". For the value, enter the entire file location of brainflow\installed\lib\cmake\brainflow (go to the folder your BCI2000 folder resides in, a folder named "brainflow" will be located there. You can append the the location of this folder with this location so your entire file location looks like C:\Users...\{Folder containing BCI2000 folder}\brainflow\installed\lib\cmake\brainflow). After these three fields are filled out, press "OK". Make sure under "BUILD" that "BUILD_ALL_SOURCEMODULES" is selected, '''and you will also need to deselect "USE_DYNAMIC_CRT" under "USE"'''.

==Parameters==
===BoardID===
Identifier for the boad in use, compatable with any board able to be used with BrainFlow.

===RecordingChannels===
Sets which board channels will be used for data aquisition. Some boards will not have all listed channel types, in which case no data will be collected from such types.

===COM===
Specifies the port the device is connected to

==MAC==
Specifies the MAC address of the device

C:/Users/Robbie/Documents/BCI2000folder/brainflow/installed/lib/cmake/brainflow

C:/Users/Robbie/Documents/BCI2000folder/brainflow/installed/lib/Brainflow.lib
C:/Users/Robbie/Documents/BCI2000folder/brainflow/compiled/Debug/BoardController.lib
C:/Users/Robbie/Documents/BCI2000folder/brainflow/compiled/Debug/DataHandler.lib
C:/Users/Robbie/Documents/BCI2000folder/brainflow/compiled/Debug/MLModule.lib
C:\Users\Robbie\Documents\BCI2000folder\brainflow\installed\lib\cmake\brainflow

Contributions:BrainFlow

2023-12-11T23:19:02Z

Rlellis: /* RecordingChannels */

==Installation==
==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.

==BrainFlow Installation/Setup==
Before installation, please install [https://gitforwindows.org/ git bash] and [https://www.python.org/downloads/ python].

*'''Automatic Installation''':

Libraries generated from BrainFlow are needed for this module, which requires the user to download and build the project. The download process (and configuring the solution) can be automated using these scripts:
<gallery mode="packed" widths=75px heights=75px>
File:BFModules.JPG|BrainFlow installation/configuration automation scripts
</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 "BrainFlowInstall.bat". This will clone the [https://github.com/brainflow-dev/brainflow BrainFlow repository]*** into the correct location as well as run the BrainFlowBuild.py script, which will generate compiled libraries for either debug or release, depending on what you enter upon being prompted (0=debug, 1=release).

Afterward, you will need to add the generated libraries to your systems path. ("Compiled/{Release and/or Debug}")

In BCI2000's CMake window (build\Configure.sh.cmd), press the blue "Add Entry" arrow in the top right corner. In the dropdown menu for "Type:", select "PATH", then in "Name:" enter: "CMAKE_PREFIX_PATH". For the value, enter the entire file location of brainflow\installed\lib\cmake\brainflow (go to the folder your BCI2000 folder resides in, a folder named "brainflow" will be located there. You can append the the location of this folder with this location so your entire file location looks like C:\Users...\{Folder containing BCI2000 folder}\brainflow\installed\lib\cmake\brainflow). After these three fields are filled out, press "OK". Make sure under "BUILD" that "BUILD_ALL_SOURCEMODULES" is selected, and '''you will also need to deselect "USE_DYNAMIC_CRT" under "USE"'''.

*'''Manual Installation''':

First, in the same folder containing your working copy of BCI2000, create a folder named 'brainflow'. For example, if the location of your copy of BCI2000 is C:\Users\Bob\Desktop\BCI2000, your folder will be C:\Users\Bob\Desktop\brainflow. In this new folder, open [https://gitforwindows.org/ git bash], and enter 'git clone https://github.com/OpenBCI/brainflow.git' ([https://github.com/OpenBCI/brainflow/tree/master BrainFlow]). After installation is complete, navigate to the 'tools' folder, and run build.py. This will create the solution needed to generate the libraries for EITHER debug or release.

Afterward, you will need to add the generated libraries to your systems path. ("brainflow\compiled\{Release and/or Debug}")

If you wish to use debug mode, open build.py and search for 'config' until you find a section that looks like this:

def build(args):
if platform.system() == 'Windows':
config = 'Release'

'config' determines how the solution is built, so adjust this according to which version you plan to use ("Release" or "Debug"), then run it.

Next, go to brainflow\build and open 'brainflow.sln'. Set the version to match the config used above (release or debug), and build the solution.

In BCI2000's CMake window (build\Configure.sh.cmd), press the blue "Add Entry" arrow in the top right corner. In the dropdown menu for "Type:", select "PATH", then in "Name:" enter: "CMAKE_PREFIX_PATH". For the value, enter the entire file location of brainflow\installed\lib\cmake\brainflow (go to the folder your BCI2000 folder resides in, a folder named "brainflow" will be located there. You can append the the location of this folder with this location so your entire file location looks like C:\Users...\{Folder containing BCI2000 folder}\brainflow\installed\lib\cmake\brainflow). After these three fields are filled out, press "OK". Make sure under "BUILD" that "BUILD_ALL_SOURCEMODULES" is selected, '''and you will also need to deselect "USE_DYNAMIC_CRT" under "USE"'''.

==Parameters==
===BoardID===
Identifier for the boad in use, compatable with any board able to be used with BrainFlow.

===RecordingChannels===
Sets which board channels will be used for data aquisition. Some boards will not have all listed channel types, in which case no data will be collected from such types.

==COM==
Specifies the port the device is connected to

==MAC==
Specifies the MAC address of the device

C:/Users/Robbie/Documents/BCI2000folder/brainflow/installed/lib/cmake/brainflow

C:/Users/Robbie/Documents/BCI2000folder/brainflow/installed/lib/Brainflow.lib
C:/Users/Robbie/Documents/BCI2000folder/brainflow/compiled/Debug/BoardController.lib
C:/Users/Robbie/Documents/BCI2000folder/brainflow/compiled/Debug/DataHandler.lib
C:/Users/Robbie/Documents/BCI2000folder/brainflow/compiled/Debug/MLModule.lib
C:\Users\Robbie\Documents\BCI2000folder\brainflow\installed\lib\cmake\brainflow

Contributions:BrainFlow

2023-12-11T23:18:57Z

Rlellis: /* BoardID */

==Installation==
==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.

==BrainFlow Installation/Setup==
Before installation, please install [https://gitforwindows.org/ git bash] and [https://www.python.org/downloads/ python].

*'''Automatic Installation''':

Libraries generated from BrainFlow are needed for this module, which requires the user to download and build the project. The download process (and configuring the solution) can be automated using these scripts:
<gallery mode="packed" widths=75px heights=75px>
File:BFModules.JPG|BrainFlow installation/configuration automation scripts
</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 "BrainFlowInstall.bat". This will clone the [https://github.com/brainflow-dev/brainflow BrainFlow repository]*** into the correct location as well as run the BrainFlowBuild.py script, which will generate compiled libraries for either debug or release, depending on what you enter upon being prompted (0=debug, 1=release).

Afterward, you will need to add the generated libraries to your systems path. ("Compiled/{Release and/or Debug}")

In BCI2000's CMake window (build\Configure.sh.cmd), press the blue "Add Entry" arrow in the top right corner. In the dropdown menu for "Type:", select "PATH", then in "Name:" enter: "CMAKE_PREFIX_PATH". For the value, enter the entire file location of brainflow\installed\lib\cmake\brainflow (go to the folder your BCI2000 folder resides in, a folder named "brainflow" will be located there. You can append the the location of this folder with this location so your entire file location looks like C:\Users...\{Folder containing BCI2000 folder}\brainflow\installed\lib\cmake\brainflow). After these three fields are filled out, press "OK". Make sure under "BUILD" that "BUILD_ALL_SOURCEMODULES" is selected, and '''you will also need to deselect "USE_DYNAMIC_CRT" under "USE"'''.

*'''Manual Installation''':

First, in the same folder containing your working copy of BCI2000, create a folder named 'brainflow'. For example, if the location of your copy of BCI2000 is C:\Users\Bob\Desktop\BCI2000, your folder will be C:\Users\Bob\Desktop\brainflow. In this new folder, open [https://gitforwindows.org/ git bash], and enter 'git clone https://github.com/OpenBCI/brainflow.git' ([https://github.com/OpenBCI/brainflow/tree/master BrainFlow]). After installation is complete, navigate to the 'tools' folder, and run build.py. This will create the solution needed to generate the libraries for EITHER debug or release.

Afterward, you will need to add the generated libraries to your systems path. ("brainflow\compiled\{Release and/or Debug}")

If you wish to use debug mode, open build.py and search for 'config' until you find a section that looks like this:

def build(args):
if platform.system() == 'Windows':
config = 'Release'

'config' determines how the solution is built, so adjust this according to which version you plan to use ("Release" or "Debug"), then run it.

Next, go to brainflow\build and open 'brainflow.sln'. Set the version to match the config used above (release or debug), and build the solution.

In BCI2000's CMake window (build\Configure.sh.cmd), press the blue "Add Entry" arrow in the top right corner. In the dropdown menu for "Type:", select "PATH", then in "Name:" enter: "CMAKE_PREFIX_PATH". For the value, enter the entire file location of brainflow\installed\lib\cmake\brainflow (go to the folder your BCI2000 folder resides in, a folder named "brainflow" will be located there. You can append the the location of this folder with this location so your entire file location looks like C:\Users...\{Folder containing BCI2000 folder}\brainflow\installed\lib\cmake\brainflow). After these three fields are filled out, press "OK". Make sure under "BUILD" that "BUILD_ALL_SOURCEMODULES" is selected, '''and you will also need to deselect "USE_DYNAMIC_CRT" under "USE"'''.

==Parameters==
===BoardID===
Identifier for the boad in use, compatable with any board able to be used with BrainFlow.

==RecordingChannels==
Sets which board channels will be used for data aquisition. Some boards will not have all listed channel types, in which case no data will be collected from such types.

==COM==
Specifies the port the device is connected to

==MAC==
Specifies the MAC address of the device

C:/Users/Robbie/Documents/BCI2000folder/brainflow/installed/lib/cmake/brainflow

C:/Users/Robbie/Documents/BCI2000folder/brainflow/installed/lib/Brainflow.lib
C:/Users/Robbie/Documents/BCI2000folder/brainflow/compiled/Debug/BoardController.lib
C:/Users/Robbie/Documents/BCI2000folder/brainflow/compiled/Debug/DataHandler.lib
C:/Users/Robbie/Documents/BCI2000folder/brainflow/compiled/Debug/MLModule.lib
C:\Users\Robbie\Documents\BCI2000folder\brainflow\installed\lib\cmake\brainflow

Contributions:BrainFlow

2023-12-11T23:18:46Z

Rlellis: /* Parameters */

==Installation==
==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.

==BrainFlow Installation/Setup==
Before installation, please install [https://gitforwindows.org/ git bash] and [https://www.python.org/downloads/ python].

*'''Automatic Installation''':

Libraries generated from BrainFlow are needed for this module, which requires the user to download and build the project. The download process (and configuring the solution) can be automated using these scripts:
<gallery mode="packed" widths=75px heights=75px>
File:BFModules.JPG|BrainFlow installation/configuration automation scripts
</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 "BrainFlowInstall.bat". This will clone the [https://github.com/brainflow-dev/brainflow BrainFlow repository]*** into the correct location as well as run the BrainFlowBuild.py script, which will generate compiled libraries for either debug or release, depending on what you enter upon being prompted (0=debug, 1=release).

Afterward, you will need to add the generated libraries to your systems path. ("Compiled/{Release and/or Debug}")

In BCI2000's CMake window (build\Configure.sh.cmd), press the blue "Add Entry" arrow in the top right corner. In the dropdown menu for "Type:", select "PATH", then in "Name:" enter: "CMAKE_PREFIX_PATH". For the value, enter the entire file location of brainflow\installed\lib\cmake\brainflow (go to the folder your BCI2000 folder resides in, a folder named "brainflow" will be located there. You can append the the location of this folder with this location so your entire file location looks like C:\Users...\{Folder containing BCI2000 folder}\brainflow\installed\lib\cmake\brainflow). After these three fields are filled out, press "OK". Make sure under "BUILD" that "BUILD_ALL_SOURCEMODULES" is selected, and '''you will also need to deselect "USE_DYNAMIC_CRT" under "USE"'''.

*'''Manual Installation''':

First, in the same folder containing your working copy of BCI2000, create a folder named 'brainflow'. For example, if the location of your copy of BCI2000 is C:\Users\Bob\Desktop\BCI2000, your folder will be C:\Users\Bob\Desktop\brainflow. In this new folder, open [https://gitforwindows.org/ git bash], and enter 'git clone https://github.com/OpenBCI/brainflow.git' ([https://github.com/OpenBCI/brainflow/tree/master BrainFlow]). After installation is complete, navigate to the 'tools' folder, and run build.py. This will create the solution needed to generate the libraries for EITHER debug or release.

Afterward, you will need to add the generated libraries to your systems path. ("brainflow\compiled\{Release and/or Debug}")

If you wish to use debug mode, open build.py and search for 'config' until you find a section that looks like this:

def build(args):
if platform.system() == 'Windows':
config = 'Release'

'config' determines how the solution is built, so adjust this according to which version you plan to use ("Release" or "Debug"), then run it.

Next, go to brainflow\build and open 'brainflow.sln'. Set the version to match the config used above (release or debug), and build the solution.

In BCI2000's CMake window (build\Configure.sh.cmd), press the blue "Add Entry" arrow in the top right corner. In the dropdown menu for "Type:", select "PATH", then in "Name:" enter: "CMAKE_PREFIX_PATH". For the value, enter the entire file location of brainflow\installed\lib\cmake\brainflow (go to the folder your BCI2000 folder resides in, a folder named "brainflow" will be located there. You can append the the location of this folder with this location so your entire file location looks like C:\Users...\{Folder containing BCI2000 folder}\brainflow\installed\lib\cmake\brainflow). After these three fields are filled out, press "OK". Make sure under "BUILD" that "BUILD_ALL_SOURCEMODULES" is selected, '''and you will also need to deselect "USE_DYNAMIC_CRT" under "USE"'''.

==Parameters==
==BoardID==
Identifier for the boad in use, compatable with any board able to be used with BrainFlow.

==RecordingChannels==
Sets which board channels will be used for data aquisition. Some boards will not have all listed channel types, in which case no data will be collected from such types.

==COM==
Specifies the port the device is connected to

==MAC==
Specifies the MAC address of the device

C:/Users/Robbie/Documents/BCI2000folder/brainflow/installed/lib/cmake/brainflow

C:/Users/Robbie/Documents/BCI2000folder/brainflow/installed/lib/Brainflow.lib
C:/Users/Robbie/Documents/BCI2000folder/brainflow/compiled/Debug/BoardController.lib
C:/Users/Robbie/Documents/BCI2000folder/brainflow/compiled/Debug/DataHandler.lib
C:/Users/Robbie/Documents/BCI2000folder/brainflow/compiled/Debug/MLModule.lib
C:\Users\Robbie\Documents\BCI2000folder\brainflow\installed\lib\cmake\brainflow

Contributions:BrainFlow

2023-12-11T23:18:25Z

Rlellis: /* BrainFlow Installation/Setup */

==Installation==
==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.

==BrainFlow Installation/Setup==
Before installation, please install [https://gitforwindows.org/ git bash] and [https://www.python.org/downloads/ python].

*'''Automatic Installation''':

Libraries generated from BrainFlow are needed for this module, which requires the user to download and build the project. The download process (and configuring the solution) can be automated using these scripts:
<gallery mode="packed" widths=75px heights=75px>
File:BFModules.JPG|BrainFlow installation/configuration automation scripts
</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 "BrainFlowInstall.bat". This will clone the [https://github.com/brainflow-dev/brainflow BrainFlow repository]*** into the correct location as well as run the BrainFlowBuild.py script, which will generate compiled libraries for either debug or release, depending on what you enter upon being prompted (0=debug, 1=release).

Afterward, you will need to add the generated libraries to your systems path. ("Compiled/{Release and/or Debug}")

In BCI2000's CMake window (build\Configure.sh.cmd), press the blue "Add Entry" arrow in the top right corner. In the dropdown menu for "Type:", select "PATH", then in "Name:" enter: "CMAKE_PREFIX_PATH". For the value, enter the entire file location of brainflow\installed\lib\cmake\brainflow (go to the folder your BCI2000 folder resides in, a folder named "brainflow" will be located there. You can append the the location of this folder with this location so your entire file location looks like C:\Users...\{Folder containing BCI2000 folder}\brainflow\installed\lib\cmake\brainflow). After these three fields are filled out, press "OK". Make sure under "BUILD" that "BUILD_ALL_SOURCEMODULES" is selected, and '''you will also need to deselect "USE_DYNAMIC_CRT" under "USE"'''.

*'''Manual Installation''':

First, in the same folder containing your working copy of BCI2000, create a folder named 'brainflow'. For example, if the location of your copy of BCI2000 is C:\Users\Bob\Desktop\BCI2000, your folder will be C:\Users\Bob\Desktop\brainflow. In this new folder, open [https://gitforwindows.org/ git bash], and enter 'git clone https://github.com/OpenBCI/brainflow.git' ([https://github.com/OpenBCI/brainflow/tree/master BrainFlow]). After installation is complete, navigate to the 'tools' folder, and run build.py. This will create the solution needed to generate the libraries for EITHER debug or release.

Afterward, you will need to add the generated libraries to your systems path. ("brainflow\compiled\{Release and/or Debug}")

If you wish to use debug mode, open build.py and search for 'config' until you find a section that looks like this:

def build(args):
if platform.system() == 'Windows':
config = 'Release'

'config' determines how the solution is built, so adjust this according to which version you plan to use ("Release" or "Debug"), then run it.

Next, go to brainflow\build and open 'brainflow.sln'. Set the version to match the config used above (release or debug), and build the solution.

In BCI2000's CMake window (build\Configure.sh.cmd), press the blue "Add Entry" arrow in the top right corner. In the dropdown menu for "Type:", select "PATH", then in "Name:" enter: "CMAKE_PREFIX_PATH". For the value, enter the entire file location of brainflow\installed\lib\cmake\brainflow (go to the folder your BCI2000 folder resides in, a folder named "brainflow" will be located there. You can append the the location of this folder with this location so your entire file location looks like C:\Users...\{Folder containing BCI2000 folder}\brainflow\installed\lib\cmake\brainflow). After these three fields are filled out, press "OK". Make sure under "BUILD" that "BUILD_ALL_SOURCEMODULES" is selected, '''and you will also need to deselect "USE_DYNAMIC_CRT" under "USE"'''.

==Parameters==
*BoardID
Identifier for the boad in use, compatable with any board able to be used with BrainFlow.

*RecordingChannels
Sets which board channels will be used for data aquisition. Some boards will not have all listed channel types, in which case no data will be collected from such types.

*COM
Specifies the port the device is connected to

*MAC
Specifies the MAC address of the device

C:/Users/Robbie/Documents/BCI2000folder/brainflow/installed/lib/cmake/brainflow

C:/Users/Robbie/Documents/BCI2000folder/brainflow/installed/lib/Brainflow.lib
C:/Users/Robbie/Documents/BCI2000folder/brainflow/compiled/Debug/BoardController.lib
C:/Users/Robbie/Documents/BCI2000folder/brainflow/compiled/Debug/DataHandler.lib
C:/Users/Robbie/Documents/BCI2000folder/brainflow/compiled/Debug/MLModule.lib
C:\Users\Robbie\Documents\BCI2000folder\brainflow\installed\lib\cmake\brainflow

Contributions:BrainFlow

2023-12-11T23:18:00Z

Rlellis: /* BrainFlow Install */

==Installation==
==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.

==BrainFlow Installation/Setup==
Before installation, please install [https://gitforwindows.org/ git bash] and [https://www.python.org/downloads/ python].

*Automatic Installation:

Libraries generated from BrainFlow are needed for this module, which requires the user to download and build the project. The download process (and configuring the solution) can be automated using these scripts:
<gallery mode="packed" widths=75px heights=75px>
File:BFModules.JPG|BrainFlow installation/configuration automation scripts
</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 "BrainFlowInstall.bat". This will clone the [https://github.com/brainflow-dev/brainflow BrainFlow repository]*** into the correct location as well as run the BrainFlowBuild.py script, which will generate compiled libraries for either debug or release, depending on what you enter upon being prompted (0=debug, 1=release).

Afterward, you will need to add the generated libraries to your systems path. ("Compiled/{Release and/or Debug}")

In BCI2000's CMake window (build\Configure.sh.cmd), press the blue "Add Entry" arrow in the top right corner. In the dropdown menu for "Type:", select "PATH", then in "Name:" enter: "CMAKE_PREFIX_PATH". For the value, enter the entire file location of brainflow\installed\lib\cmake\brainflow (go to the folder your BCI2000 folder resides in, a folder named "brainflow" will be located there. You can append the the location of this folder with this location so your entire file location looks like C:\Users...\{Folder containing BCI2000 folder}\brainflow\installed\lib\cmake\brainflow). After these three fields are filled out, press "OK". Make sure under "BUILD" that "BUILD_ALL_SOURCEMODULES" is selected, and '''you will also need to deselect "USE_DYNAMIC_CRT" under "USE"'''.

*Manual Installation:

First, in the same folder containing your working copy of BCI2000, create a folder named 'brainflow'. For example, if the location of your copy of BCI2000 is C:\Users\Bob\Desktop\BCI2000, your folder will be C:\Users\Bob\Desktop\brainflow. In this new folder, open [https://gitforwindows.org/ git bash], and enter 'git clone https://github.com/OpenBCI/brainflow.git' ([https://github.com/OpenBCI/brainflow/tree/master BrainFlow]). After installation is complete, navigate to the 'tools' folder, and run build.py. This will create the solution needed to generate the libraries for EITHER debug or release.

Afterward, you will need to add the generated libraries to your systems path. ("brainflow\compiled\{Release and/or Debug}")

If you wish to use debug mode, open build.py and search for 'config' until you find a section that looks like this:

def build(args):
if platform.system() == 'Windows':
config = 'Release'

'config' determines how the solution is built, so adjust this according to which version you plan to use ("Release" or "Debug"), then run it.

Next, go to brainflow\build and open 'brainflow.sln'. Set the version to match the config used above (release or debug), and build the solution.

In BCI2000's CMake window (build\Configure.sh.cmd), press the blue "Add Entry" arrow in the top right corner. In the dropdown menu for "Type:", select "PATH", then in "Name:" enter: "CMAKE_PREFIX_PATH". For the value, enter the entire file location of brainflow\installed\lib\cmake\brainflow (go to the folder your BCI2000 folder resides in, a folder named "brainflow" will be located there. You can append the the location of this folder with this location so your entire file location looks like C:\Users...\{Folder containing BCI2000 folder}\brainflow\installed\lib\cmake\brainflow). After these three fields are filled out, press "OK". Make sure under "BUILD" that "BUILD_ALL_SOURCEMODULES" is selected, '''and you will also need to deselect "USE_DYNAMIC_CRT" under "USE"'''.

==Parameters==
*BoardID
Identifier for the boad in use, compatable with any board able to be used with BrainFlow.

*RecordingChannels
Sets which board channels will be used for data aquisition. Some boards will not have all listed channel types, in which case no data will be collected from such types.

*COM
Specifies the port the device is connected to

*MAC
Specifies the MAC address of the device

C:/Users/Robbie/Documents/BCI2000folder/brainflow/installed/lib/cmake/brainflow

C:/Users/Robbie/Documents/BCI2000folder/brainflow/installed/lib/Brainflow.lib
C:/Users/Robbie/Documents/BCI2000folder/brainflow/compiled/Debug/BoardController.lib
C:/Users/Robbie/Documents/BCI2000folder/brainflow/compiled/Debug/DataHandler.lib
C:/Users/Robbie/Documents/BCI2000folder/brainflow/compiled/Debug/MLModule.lib
C:\Users\Robbie\Documents\BCI2000folder\brainflow\installed\lib\cmake\brainflow

Contributions:BrainFlow

2023-12-11T22:47:26Z

Rlellis: /* BrainFlow Install */

==Installation==
===BrainFlow Install===
Before installation, please install [https://gitforwindows.org/ git bash] and [https://www.python.org/downloads/ python].

*Automatic Installation:

Libraries generated from BrainFlow are needed for this module, which requires the user to download and build the project. The download process (and configuring the solution) can be automated using these scripts:
<gallery mode="packed" widths=75px heights=75px>
File:BFModules.JPG|BrainFlow installation/configuration automation scripts
</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 "BrainFlowInstall.bat". This will clone the [https://github.com/brainflow-dev/brainflow BrainFlow repository]*** into the correct location as well as run the BrainFlowBuild.py script, which will generate compiled libraries for either debug or release, depending on what you enter upon being prompted (0=debug, 1=release).

Afterward, you will need to add the generated libraries to your systems path. ("Compiled/{Release and/or Debug}")

In BCI2000's CMake window (build\Configure.sh.cmd), press the blue "Add Entry" arrow in the top right corner. In the dropdown menu for "Type:", select "PATH", then in "Name:" enter: "CMAKE_PREFIX_PATH". For the value, enter the entire file location of brainflow\installed\lib\cmake\brainflow (go to the folder your BCI2000 folder resides in, a folder named "brainflow" will be located there. You can append the the location of this folder with this location so your entire file location looks like C:\Users...\{Folder containing BCI2000 folder}\brainflow\installed\lib\cmake\brainflow). After these three fields are filled out, press "OK". Make sure under "BUILD" that "BUILD_ALL_SOURCEMODULES" is selected, and '''you will also need to deselect "USE_DYNAMIC_CRT" under "USE"'''.

*Manual Installation:

First, in the same folder containing your working copy of BCI2000, create a folder named 'brainflow'. For example, if the location of your copy of BCI2000 is C:\Users\Bob\Desktop\BCI2000, your folder will be C:\Users\Bob\Desktop\brainflow. In this new folder, open [https://gitforwindows.org/ git bash], and enter 'git clone https://github.com/OpenBCI/brainflow.git' ([https://github.com/OpenBCI/brainflow/tree/master BrainFlow]). After installation is complete, navigate to the 'tools' folder, and run build.py. This will create the solution needed to generate the libraries for EITHER debug or release.

Afterward, you will need to add the generated libraries to your systems path. ("brainflow\compiled\{Release and/or Debug}")

If you wish to use debug mode, open build.py and search for 'config' until you find a section that looks like this:

def build(args):
if platform.system() == 'Windows':
config = 'Release'

'config' determines how the solution is built, so adjust this according to which version you plan to use ("Release" or "Debug"), then run it.

Next, go to brainflow\build and open 'brainflow.sln'. Set the version to match the config used above (release or debug), and build the solution.

In BCI2000's CMake window (build\Configure.sh.cmd), press the blue "Add Entry" arrow in the top right corner. In the dropdown menu for "Type:", select "PATH", then in "Name:" enter: "CMAKE_PREFIX_PATH". For the value, enter the entire file location of brainflow\installed\lib\cmake\brainflow (go to the folder your BCI2000 folder resides in, a folder named "brainflow" will be located there. You can append the the location of this folder with this location so your entire file location looks like C:\Users...\{Folder containing BCI2000 folder}\brainflow\installed\lib\cmake\brainflow). After these three fields are filled out, press "OK". Make sure under "BUILD" that "BUILD_ALL_SOURCEMODULES" is selected, '''and you will also need to deselect "USE_DYNAMIC_CRT" under "USE"'''.

C:/Users/Robbie/Documents/BCI2000folder/brainflow/installed/lib/cmake/brainflow

C:/Users/Robbie/Documents/BCI2000folder/brainflow/installed/lib/Brainflow.lib
C:/Users/Robbie/Documents/BCI2000folder/brainflow/compiled/Debug/BoardController.lib
C:/Users/Robbie/Documents/BCI2000folder/brainflow/compiled/Debug/DataHandler.lib
C:/Users/Robbie/Documents/BCI2000folder/brainflow/compiled/Debug/MLModule.lib
C:\Users\Robbie\Documents\BCI2000folder\brainflow\installed\lib\cmake\brainflow

Contributions:BrainFlow

2023-11-03T22:58:17Z

Rlellis: /* BrainFlow Install */

==Installation==
===BrainFlow Install===
Before installation, please install [https://gitforwindows.org/ git bash] and [https://www.python.org/downloads/ python].

Libraries generated from BrainFlow are needed for this module, which requires the user to download and build the project. The download process (and configuring the solution) can be automated using these scripts:
<gallery mode="packed" widths=75px heights=75px>
File:BFModules.JPG|BrainFlow installation/configuration automation scripts
</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 "BrainFlowInstall.bat". This will clone the [https://github.com/brainflow-dev/brainflow BrainFlow repository]*** into the correct location as well as run the BrainFlowBuild.py script, which will generate compiled libraries for either debug or release, depending on what you enter upon being prompted (0=debug, 1=release).

Afterward, you will need to add the generated libraries to your systems path. ("Compiled/{Release and/or Debug}")

In the CMake GUI opened from BCI2000/build, press the

First, in the same folder containing your working copy of BCI2000, create a folder named 'brainflow'. For example, if the location of your copy of BCI2000 is C:\Users\Bob\Desktop\BCI2000, your folder will be C:\Users\Bob\Desktop\brainflow. In this new folder, open [https://gitforwindows.org/ git bash], and enter 'git clone https://github.com/OpenBCI/brainflow.git' ([https://github.com/OpenBCI/brainflow/tree/master BrainFlow]). After installation is complete, navigate to the 'tools' folder, and run build.py. This will create the solution needed to generate the libraries for EITHER debug or release.

Afterward, you will need to add the generated libraries to your systems path. ("brainflow\compiled\{Release and/or Debug}")

If you wish to use debug mode, open build.py and search for 'config' until you find a section that looks like this:

def build(args):
if platform.system() == 'Windows':
config = 'Release'

'config' determines how the solution is built, so adjust this according to which version you plan to use ("Release" or "Debug"), then run it.

Next, go to brainflow\build and open 'brainflow.sln'. Set the version to match the config used above (release or debug), and build the solution.

In BCI2000's CMake window (build\Configure.sh.cmd), press the blue "Add Entry" arrow in the top right corner. In the dropdown menu for "Type:", select "PATH", then in "Name:" enter: "CMAKE_PREFIX_PATH". For the value, enter the entire file location of brainflow\installed\lib\cmake\brainflow (go to the folder your BCI2000 folder resides in, a folder named "brainflow" will be located there. You can append the the location of this folder with this location so your entire file location looks like C:\Users...\{Folder containing BCI2000 folder}\brainflow\installed\lib\cmake\brainflow). After these three fields are filled out, press "OK". Make sure under "BUILD" that "BUILD_ALL_SOURCEMODULES" is selected, and you will also need to deselect "USE_DYNAMIC_CRT" under "USE".

C:/Users/Robbie/Documents/BCI2000folder/brainflow/installed/lib/cmake/brainflow

C:/Users/Robbie/Documents/BCI2000folder/brainflow/installed/lib/Brainflow.lib
C:/Users/Robbie/Documents/BCI2000folder/brainflow/compiled/Debug/BoardController.lib
C:/Users/Robbie/Documents/BCI2000folder/brainflow/compiled/Debug/DataHandler.lib
C:/Users/Robbie/Documents/BCI2000folder/brainflow/compiled/Debug/MLModule.lib
C:\Users\Robbie\Documents\BCI2000folder\brainflow\installed\lib\cmake\brainflow