Contributions:BCI2000Command - Revision history

Admin: /* See also */

2025-06-19T20:43:27Z

See also

← Older revision		Revision as of 20:43, 19 June 2025
Line 143:		Line 143:

	==See also==		==See also==
	[[Programming Reference:BCI2000Remote Class]], [[Contributions:BCI2000PresentationLink]], [[Contributions:BCI2000Automation]], [[Contributions:BCI2000PythonBindings]], [[User Reference:BCI2000Shell]], [[Contributions:Applications]]		[[Programming Reference:BCI2000Remote Class]], [[Contributions:BCI2000PresentationLink]],<!-- [[Contributions:BCI2000Automation]], -->[[Contributions:BCI2000PythonBindings]], [[User Reference:BCI2000Shell]], [[Contributions:Applications]]

	[[Category:Contributions]][[Category:User Application]][[Category:External Interfaces]]		[[Category:Contributions]][[Category:User Application]][[Category:External Interfaces]]

Mellinger: /* Execute */

2013-03-10T13:43:22Z

Execute <scripting command>

@@ Line 101: / Line 101: @@
 ====Execute <scripting command>====
 Executes a scripting command. Scripting commands with arguments must enclosed in quotes to be seen as a single argument.
-The meaning of the return value depends on which command has been executed, so it is necessary to be aware of a command's possible responses.
+The meaning of the return value depends on which command has been executed, and is the ''exit code'' of the command, as defined in the [[Programming_Reference:BCI2000Remote_Class#bool_Execute.28_string_command.2C_int.2A_exitCode_.3D_0_.29|BCI2000Remote Class Document]].
 A full documentation of BCI2000 Operator scripting commands is available under [[User Reference:Operator Module Scripting]].

Mellinger: /* Execute */

2013-03-09T22:46:34Z

Execute <scripting command>

@@ Line 101: / Line 101: @@
 ====Execute <scripting command>====
 Executes a scripting command. Scripting commands with arguments must enclosed in quotes to be seen as a single argument.
 ====SetScript <event> <scripting commands>====

Jhill at 21:34, 14 November 2012

2012-11-14T21:34:58Z

← Older revision		Revision as of 21:34, 14 November 2012
Line 32:		Line 32:

	==BCI2000Command vs. BCI2000Shell==		==BCI2000Command vs. BCI2000Shell==
	BCI2000Command provides functionality similar to BCI2000Shell, which is a shell that executes [[User Reference:Operator Module Scripting\|Operator scripting commands]]. The choice between the two is mainly a choice between writing a shell script vs. writing a BCI2000 Operator script. One would choose BCI2000Command to integrate BCI2000 remote control into an existing system of shell scripts, whereas one would choose BCI2000Shell to use Operator scripting as the main language. However, some amount of overlap exists: BCI2000Command is able to execute arbitrary Operator scripting commands, and BCI2000Shell's ''-c'' option allows it to be run within shell scripts in a way similar to BCI2000Command. Still, BCI2000Command provides a higher-level interface than BCI2000Shell does.		BCI2000Command provides functionality similar to [[User Reference:BCI2000Shell\|BCI2000Shell]], which is a shell that executes [[User Reference:Operator Module Scripting\|Operator scripting commands]]. The choice between the two is mainly a choice between writing a shell script vs. writing a BCI2000 Operator script. One would choose BCI2000Command to integrate BCI2000 remote control into an existing system of shell scripts, whereas one would choose BCI2000Shell to use Operator scripting as the main language. However, some amount of overlap exists: BCI2000Command is able to execute arbitrary Operator scripting commands, and BCI2000Shell's ''-c'' option allows it to be run within shell scripts in a way similar to BCI2000Command. Still, BCI2000Command provides a higher-level interface than BCI2000Shell does.

	==Reference==		==Reference==

Mellinger: /* See also */

2012-07-05T18:15:50Z

See also

← Older revision		Revision as of 18:15, 5 July 2012
Line 142:		Line 142:
	[[Programming Reference:BCI2000Remote Class]], [[Contributions:BCI2000PresentationLink]], [[Contributions:BCI2000Automation]], [[Contributions:BCI2000PythonBindings]], [[User Reference:BCI2000Shell]], [[Contributions:Applications]]		[[Programming Reference:BCI2000Remote Class]], [[Contributions:BCI2000PresentationLink]], [[Contributions:BCI2000Automation]], [[Contributions:BCI2000PythonBindings]], [[User Reference:BCI2000Shell]], [[Contributions:Applications]]

	[[Category:Contributions]][[Category:User Application]]		[[Category:Contributions]][[Category:User Application]][[Category:External Interfaces]]

Mellinger: /* Functional Description */

2012-06-04T18:46:51Z

Functional Description

← Older revision		Revision as of 18:46, 4 June 2012
Line 30:		Line 30:

	Once you are done using BCI2000, you may quit the Operator module using "BCI2000Command Quit".		Once you are done using BCI2000, you may quit the Operator module using "BCI2000Command Quit".

			==BCI2000Command vs. BCI2000Shell==
			BCI2000Command provides functionality similar to BCI2000Shell, which is a shell that executes [[User Reference:Operator Module Scripting\|Operator scripting commands]]. The choice between the two is mainly a choice between writing a shell script vs. writing a BCI2000 Operator script. One would choose BCI2000Command to integrate BCI2000 remote control into an existing system of shell scripts, whereas one would choose BCI2000Shell to use Operator scripting as the main language. However, some amount of overlap exists: BCI2000Command is able to execute arbitrary Operator scripting commands, and BCI2000Shell's ''-c'' option allows it to be run within shell scripts in a way similar to BCI2000Command. Still, BCI2000Command provides a higher-level interface than BCI2000Shell does.

	==Reference==		==Reference==

Mellinger: /* See also */

2012-06-04T18:25:57Z

See also

← Older revision		Revision as of 18:25, 4 June 2012
Line 137:		Line 137:

	==See also==		==See also==
	[[Programming Reference:BCI2000Remote Class]], [[Contributions:BCI2000PresentationLink]], [[Contributions:BCI2000Automation]], [[Contributions:BCI2000PythonBindings]], [[Contributions:Applications]]		[[Programming Reference:BCI2000Remote Class]], [[Contributions:BCI2000PresentationLink]], [[Contributions:BCI2000Automation]], [[Contributions:BCI2000PythonBindings]], [[User Reference:BCI2000Shell]], [[Contributions:Applications]]

	[[Category:Contributions]][[Category:User Application]]		[[Category:Contributions]][[Category:User Application]]

Mellinger: /* See also */

2012-06-04T17:23:20Z

See also

← Older revision		Revision as of 17:23, 4 June 2012
Line 137:		Line 137:

	==See also==		==See also==
	[[Programming Reference:BCI2000Remote Class]], [[Contributions:BCI2000PresentationLink]], [[Contributions:BCI2000Automation]]		[[Programming Reference:BCI2000Remote Class]], [[Contributions:BCI2000PresentationLink]], [[Contributions:BCI2000Automation]], [[Contributions:BCI2000PythonBindings]], [[Contributions:Applications]]
	[[Contributions:Applications]]

	[[Category:Contributions]][[Category:User Application]]		[[Category:Contributions]][[Category:User Application]]

Mellinger at 11:32, 27 April 2012

2012-04-27T11:32:09Z

@@ Line 56: / Line 56: @@
 ====Quit====
 Terminates BCI2000.
 ====StartupModules <module1> <module2> ...====
 Starts up BCI2000 modules.
 ====SetConfig====
@@ Line 84: / Line 69: @@
 Stops the current run (recording).
-====GetSystemState====
+====GetParameter <name>====
-Returns the current system state (i.e., state of operation). This will be one of Unavailable, Idle, Startup, Initialization, Resting, Suspended, ParamsModified, Running, Termination, Busy.
+Returns the value of the specified parameter.
 ====GetStateVariable <variable name>====
@@ Line 92: / Line 89: @@
 ====SetStateVariable <variable name> <variable value>====
 Sets the value of the named BCI2000 state variable.
 ====GetControlSignal <channel index> <element index>====
 Gets the value of the BCI2000 control signal. Indices are 1-based.
 ==Examples==