Contributions:How to use a Contributed Source Module - Revision history

Mellinger: /* Creating batch files */

2013-10-24T15:41:03Z

Creating batch files

← Older revision		Revision as of 15:41, 24 October 2013
Line 16:		Line 16:
	*Create a copy of that batch file, and rename it to reflect the name of the source module you would like to use, e.g. <tt>CursorTask_Neuroscan.bat</tt>.		*Create a copy of that batch file, and rename it to reflect the name of the source module you would like to use, e.g. <tt>CursorTask_Neuroscan.bat</tt>.
	*Open the newly created file in a text editor.		*Open the newly created file in a text editor.
	*Identify the line that refers to <tt>SignalGenerator~~.exe~~</tt>.		*Identify the line that refers to <tt>SignalGenerator</tt>.
	*There, replace <tt>SignalGenerator~~.exe~~</tt> with your source module's executable name, e.g. <tt>NeuroscanClient~~.exe~~</tt>.		*There, replace <tt>SignalGenerator</tt> with your source module's executable name, e.g. <tt>NeuroscanClient</tt>.
	*Save the batch file, and run it to start BCI2000 in the desired configuration.		*Save the batch file, and run it to start BCI2000 in the desired configuration.
	*If the batch file is unable to properly start BCI2000, you may debug it as follows:		*If the batch file is unable to properly start BCI2000, you may debug it as follows:

Mellinger: /* Creating batch files */

2013-04-30T15:04:56Z

Creating batch files

← Older revision		Revision as of 15:04, 30 April 2013
Line 24:		Line 24:
	**run the batch file from the command line -- on UNIX-type OSes, you will need to put a dot and a slash in front of the file name;		**run the batch file from the command line -- on UNIX-type OSes, you will need to put a dot and a slash in front of the file name;
	**you will be able to read the batch file's output in the terminal window.		**you will be able to read the batch file's output in the terminal window.
	*~~Repeat these steps~~ for ~~all paradigms~~ you intend to use.		*Create a separate batch file for each paradigm you intend to use.

	==Setting up your amplifier==		==Setting up your amplifier==

Mellinger: /* Creating batch files */

2013-04-30T15:04:24Z

Creating batch files

← Older revision		Revision as of 15:04, 30 April 2013
Line 22:		Line 22:
	**open a console/terminal window (in Windows, it's called cmd.exe);		**open a console/terminal window (in Windows, it's called cmd.exe);
	**use the "cd" command to navigate into the BCI2000/batch directory;		**use the "cd" command to navigate into the BCI2000/batch directory;
	**run the batch file from the command line -- on UNIX-type OSes, you will need to put a dot and a slash in front of the file name~~, it should not hurt on Windows either~~;		**run the batch file from the command line -- on UNIX-type OSes, you will need to put a dot and a slash in front of the file name;
	**you will be able to read the batch file's output in the terminal window.		**you will be able to read the batch file's output in the terminal window.
	*Repeat these steps for all paradigms you intend to use.		*Repeat these steps for all paradigms you intend to use.

Mellinger: /* Creating batch files */

2013-04-30T15:03:57Z

Creating batch files

← Older revision		Revision as of 15:03, 30 April 2013
Line 19:		Line 19:
	*There, replace <tt>SignalGenerator.exe</tt> with your source module's executable name, e.g. <tt>NeuroscanClient.exe</tt>.		*There, replace <tt>SignalGenerator.exe</tt> with your source module's executable name, e.g. <tt>NeuroscanClient.exe</tt>.
	*Save the batch file, and run it to start BCI2000 in the desired configuration.		*Save the batch file, and run it to start BCI2000 in the desired configuration.
			*If the batch file is unable to properly start BCI2000, you may debug it as follows:
			**open a console/terminal window (in Windows, it's called cmd.exe);
			**use the "cd" command to navigate into the BCI2000/batch directory;
			**run the batch file from the command line -- on UNIX-type OSes, you will need to put a dot and a slash in front of the file name, it should not hurt on Windows either;
			**you will be able to read the batch file's output in the terminal window.
	*Repeat these steps for all paradigms you intend to use.		*Repeat these steps for all paradigms you intend to use.

Mellinger: /* Setting up your amplifier */

2011-09-07T12:18:31Z

Setting up your amplifier

← Older revision		Revision as of 12:18, 7 September 2011
Line 22:		Line 22:

	==Setting up your amplifier==		==Setting up your amplifier==
	After creating one or more batch files for use with your amplifier, you might create a parameter file that only contains settings specific to your amplifier and EEG setup. You can do this by starting up from one of your newly created batch files, clicking "Config", and then going to the "Source" tab. There, adjust all settings as appropriate. Then, click "Configure Save", and ~~select all parameters ''except'' the ones you modified under~~ the "Source" tab. Finally, click "Save Parameters...", and save your subset of parameters under <tt>parms/amplifiers/<your_amplifier>.prm</tt>. After that, don't forget to click "Configure Save" again, and to ~~deselect~~ all parameters, to make sure you can save full parameter files as usual.		After creating one or more batch files for use with your amplifier, you might create a parameter file that only contains settings specific to your amplifier and EEG setup. You can do this by starting up from one of your newly created batch files, clicking "Config", and then going to the "Source" tab. There, adjust all settings as appropriate. Then, click "Configure Save", and make sure that only those from the "Source" tab are selected. Finally, click "Save Parameters...", and save your subset of parameters under <tt>parms/amplifiers/<your_amplifier>.prm</tt>. After that, don't forget to click "Configure Save" again, and to re-select all parameters, to make sure you can save full parameter files as usual.

	~~Using the "Configure Save" functionality in the Operator module may be tedious and cumbersome.~~ When you are comfortable with a text editor, you ~~can somewhat simplify~~ the "Save" step as follows:		When you are comfortable with a text editor, you may alternatively perform the "Save" step as follows:
	*First, save the full parameter file without using "Configure Save".		*First, save the full parameter file without using "Configure Save".
	*Then, open the new parameter file in a text editor such as Windows Notepad.		*Then, open the new parameter file in a text editor such as Windows Notepad.

Mellinger: /* Creating batch files */

2011-08-25T17:00:29Z

Creating batch files

← Older revision		Revision as of 17:00, 25 August 2011
Line 20:		Line 20:
	*Save the batch file, and run it to start BCI2000 in the desired configuration.		*Save the batch file, and run it to start BCI2000 in the desired configuration.
	*Repeat these steps for all paradigms you intend to use.		*Repeat these steps for all paradigms you intend to use.

			==Setting up your amplifier==
			After creating one or more batch files for use with your amplifier, you might create a parameter file that only contains settings specific to your amplifier and EEG setup. You can do this by starting up from one of your newly created batch files, clicking "Config", and then going to the "Source" tab. There, adjust all settings as appropriate. Then, click "Configure Save", and select all parameters ''except'' the ones you modified under the "Source" tab. Finally, click "Save Parameters...", and save your subset of parameters under <tt>parms/amplifiers/<your_amplifier>.prm</tt>. After that, don't forget to click "Configure Save" again, and to deselect all parameters, to make sure you can save full parameter files as usual.

			Using the "Configure Save" functionality in the Operator module may be tedious and cumbersome. When you are comfortable with a text editor, you can somewhat simplify the "Save" step as follows:
			*First, save the full parameter file without using "Configure Save".
			*Then, open the new parameter file in a text editor such as Windows Notepad.
			*You will see a list of parameters, with each parameter corresponding to a single line. These are sorted by tabs in the operator's config dialog where the individual parameters appear. Thus, it is simple to remove all parameter lines except the ones referring to the "Source" tab.

	==See also==		==See also==

Mellinger: /* Creating batch files */

2011-04-26T16:43:17Z

Creating batch files

← Older revision		Revision as of 16:43, 26 April 2011
Line 17:		Line 17:
	*Open the newly created file in a text editor.		*Open the newly created file in a text editor.
	*Identify the line that refers to <tt>SignalGenerator.exe</tt>.		*Identify the line that refers to <tt>SignalGenerator.exe</tt>.
	*There, replace <tt>SignalGenerator.exe</tt> with your source module's executable name, e.g. <tt>~~Neuroscan~~.exe</tt>.		*There, replace <tt>SignalGenerator.exe</tt> with your source module's executable name, e.g. <tt>NeuroscanClient.exe</tt>.
	*Save the batch file, and run it to start BCI2000 in the desired configuration.		*Save the batch file, and run it to start BCI2000 in the desired configuration.
	*Repeat these steps for all paradigms you intend to use.		*Repeat these steps for all paradigms you intend to use.

Jhill at 22:01, 24 April 2011

2011-04-24T22:01:01Z

← Older revision		Revision as of 22:01, 24 April 2011
Line 13:		Line 13:

	There is one such batch file for each combination of a source module, and a BCI paradigm. In order to use a contributed source module with a certain BCI paradigm, perform these steps:		There is one such batch file for each combination of a source module, and a BCI paradigm. In order to use a contributed source module with a certain BCI paradigm, perform these steps:
	*Identify the batch file in <tt>BCI2000/~~parms~~</tt> that provides the desired paradigm using the ''SignalGenerator'' source module. For the cursor feedback paradigm, this would be <tt>CursorTask_SignalGenerator.bat</tt>.		*Identify the batch file in <tt>BCI2000/batch</tt> that provides the desired paradigm using the ''SignalGenerator'' source module. For the cursor feedback paradigm, this would be <tt>CursorTask_SignalGenerator.bat</tt>.
	*Create a copy of that batch file, and rename it to reflect the name of the source module you would like to use, e.g. <tt>CursorTask_Neuroscan.bat</tt>.		*Create a copy of that batch file, and rename it to reflect the name of the source module you would like to use, e.g. <tt>CursorTask_Neuroscan.bat</tt>.
	*Open the newly created file in a text editor.		*Open the newly created file in a text editor.

Mellinger: /* See also */

2008-10-24T16:02:50Z

Mellinger at 16:02, 24 October 2008

2008-10-24T16:02:35Z

New page

For maintenance reasons, BCI2000 supports only a limited number of [[User_Reference:Filters#Data_Acquisition|amplifiers in its core distribution]].
In addition to these fully supported amplifiers, a larger and growing number of data acquisition systems is supported in form of contributed code, written and maintained by BCI2000 users.
[[Contributions:ADCs]] provides an overview of source modules currently available.

In comparison to using an amplifier from the core distribution, you will need to perform a few additional, simple steps in order to use a contributed source module.

==Obtaining a binary version of a Contributed Source Module==
Binary versions of contributed source modules are available in the [[BCI2000_Binaries#Contributed_Code|extended binary distribution]] of BCI2000.
Alternatively, you can build contributed source modules from the BCI2000 source code as described [[Programming_Howto:Building_BCI2000#Building_Contributions|here]].

==Creating batch files==
BCI2000 consists of a number of modules that need to be started up in a certain sequence. Typically, this is done using scripts (batch files) located in <tt>BCI2000/batch</tt> (see [[User Reference:BCI2000Launcher]] for a graphical alternative to batch files).

There is one such batch file for each combination of a source module, and a BCI paradigm. In order to use a contributed source module with a certain BCI paradigm, perform these steps:
*Identify the batch file in <tt>BCI2000/parms</tt> that provides the desired paradigm using the ''SignalGenerator'' source module. For the cursor feedback paradigm, this would be <tt>CursorTask_SignalGenerator.bat</tt>.
*Create a copy of that batch file, and rename it to reflect the name of the source module you would like to use, e.g. <tt>CursorTask_Neuroscan.bat</tt>.
*Open the newly created file in a text editor.
*Identify the line that refers to <tt>SignalGenerator.exe</tt>.
*There, replace <tt>SignalGenerator.exe</tt> with your source module's executable name, e.g. <tt>Neuroscan.exe</tt>.
*Save the batch file, and run it to start BCI2000 in the desired configuration.
*Repeat these steps for all paradigms you intend to use.

==See also==
[[Contributions:ADCs]], [[BCI2000 Binaries]], [[Programming Howto:Building BCI2000]]

[[Category:Howto]] [[Category:Contribution]]

← Older revision		Revision as of 16:02, 24 October 2008
Line 24:		Line 24:
	[[Contributions:ADCs]], [[BCI2000 Binaries]], [[Programming Howto:Building BCI2000]]		[[Contributions:ADCs]], [[BCI2000 Binaries]], [[Programming Howto:Building BCI2000]]

	[[Category:Howto]] [[Category:~~Contribution~~]]		[[Category:Howto]] [[Category:Contributions]]