Programming Reference:BCI2000Remote Class - Revision history

Mellinger: /* string TelnetAddress="" (rw) */

2026-04-17T10:58:16Z

string TelnetAddress="" (rw)

← Older revision		Revision as of 10:58, 17 April 2026
Line 36:		Line 36:
	====string TelnetAddress="" (rw)====		====string TelnetAddress="" (rw)====
	Telnet address to use for connection to a remote machine. To connect to a remote machine, specify the machine's IP address, followed with BCI2000's listening port. You should take care to avoid specifying a port that is used by BCI2000's internal connections between Operator and core modules. By default, these are 4000, 4001, and 4002.		Telnet address to use for connection to a remote machine. To connect to a remote machine, specify the machine's IP address, followed with BCI2000's listening port. You should take care to avoid specifying a port that is used by BCI2000's internal connections between Operator and core modules. By default, these are 4000, 4001, and 4002.

			When ''OperatorPath'' is given and ''TelnetAddress'' is empty, BCI2000Remote will use a named pipe for communication with the Operator module. This is preferable for security reasons.

	=====bool WindowVisible=2 (rw)=====		=====bool WindowVisible=2 (rw)=====

Mellinger: /* string OperatorPath="" (rw) */

2026-04-17T10:56:51Z

string OperatorPath="" (rw)

← Older revision		Revision as of 10:56, 17 April 2026
Line 32:		Line 32:

	====string OperatorPath="" (rw)====		====string OperatorPath="" (rw)====
	Path to Operator module, or batch file. When empty, BCI2000Remote tries to connect to an already running Operator module which may be on a different machine.		Path to Operator module, or batch file. When empty, BCI2000Remote tries to connect to an already running Operator module which may be on a different machine, depending on the ''TelnetAddress'' setting. When ''OperatorPath'' is given and ''TelnetAddress'' is empty, BCI2000Remote will use a named pipe for communication with the Operator module.

	====string TelnetAddress="" (rw)====		====string TelnetAddress="" (rw)====
	Telnet address to use for connection to a remote machine. To connect to a remote machine, specify the machine's IP address, followed with BCI2000's listening port. You should take care to avoid specifying a port that is used by BCI2000's internal connections between Operator and core modules. By default, these are 4000, 4001, and 4002.		Telnet address to use for connection to a remote machine. To connect to a remote machine, specify the machine's IP address, followed with BCI2000's listening port. You should take care to avoid specifying a port that is used by BCI2000's internal connections between Operator and core modules. By default, these are 4000, 4001, and 4002.

Mellinger: /* string TelnetAddress="localhost:3999" (rw) */

2026-04-17T10:54:08Z

string TelnetAddress="localhost:3999" (rw)

← Older revision		Revision as of 10:54, 17 April 2026
Line 33:		Line 33:
	====string OperatorPath="" (rw)====		====string OperatorPath="" (rw)====
	Path to Operator module, or batch file. When empty, BCI2000Remote tries to connect to an already running Operator module which may be on a different machine.		Path to Operator module, or batch file. When empty, BCI2000Remote tries to connect to an already running Operator module which may be on a different machine.
	====string TelnetAddress="~~localhost:3999~~" (rw)====		====string TelnetAddress="" (rw)====
	Telnet address to use for connection~~. Defaults~~ to ~~localhost:3999. When an operator path is specified, this must be~~ a ~~local address which will be used for communication~~. To connect to a remote machine, specify the machine's IP address, followed with BCI2000's listening port. You should take care to avoid specifying a port that is used by BCI2000's internal connections between Operator and core modules. By default, these are 4000, 4001, and 4002.		Telnet address to use for connection to a remote machine. To connect to a remote machine, specify the machine's IP address, followed with BCI2000's listening port. You should take care to avoid specifying a port that is used by BCI2000's internal connections between Operator and core modules. By default, these are 4000, 4001, and 4002.

	=====bool WindowVisible=2 (rw)=====		=====bool WindowVisible=2 (rw)=====

Mellinger: /* bool GetControlSignal( int channel, int element, double& value ) */

2025-11-03T14:45:33Z

bool GetControlSignal( int channel, int element, double& value )

← Older revision		Revision as of 14:45, 3 November 2025
Line 107:		Line 107:
	====bool GetSystemState( string& state )====		====bool GetSystemState( string& state )====
	Gets the current system state (i.e., state of operation). If no error occurred, the "state" output variable will contain the name of the current system state, which will be one of the names listed at [[User Reference:Operator Module Scripting#GET_SYSTEM_STATE]].		Gets the current system state (i.e., state of operation). If no error occurred, the "state" output variable will contain the name of the current system state, which will be one of the names listed at [[User Reference:Operator Module Scripting#GET_SYSTEM_STATE]].
			====bool GetControlSignalChannels( double& channels )====
			Copies the number of control signal channels into the "channels" output variable.

			====bool GetControlSignalElements( double& elements )====
			Copies the number of control signal elements into the "elements" output variable.

	====bool GetControlSignal( int channel, int element, double& value )====		====bool GetControlSignal( int channel, int element, double& value )====
	Copies the value of the control signal at the given indices into the "value" output variable. Indices are 1-based. Typically, the control signal has only a single element, and the number of output channels corresponds to the number of feedback dimensions in feedback experiments, or is 1 in evoked potential experiments.		Copies the value of the control signal at the given indices into the "value" output variable. Indices are 1-based. Typically, the control signal has only a single element, and the number of output channels corresponds to the number of feedback dimensions in feedback experiments, or is 1 in evoked potential experiments.

Mellinger: /* Dependencies */

2025-11-03T12:53:35Z

Dependencies

← Older revision		Revision as of 12:53, 3 November 2025
Line 156:		Line 156:
	BCI2000/src/core/Operator/BCI2000Remote/BCI2000Remote.cpp		BCI2000/src/core/Operator/BCI2000Remote/BCI2000Remote.cpp
	BCI2000/src/core/Operator/BCI2000Remote/BCI2000Connection.cpp		BCI2000/src/core/Operator/BCI2000Remote/BCI2000Connection.cpp
	BCI2000/src/shared/utils/Lib/~~sockstream~~.cpp		BCI2000/src/shared/utils/Lib/SockStream.cpp
	BCI2000/src/shared/utils/Lib/~~selfpipe~~.cpp		BCI2000/src/shared/utils/Lib/SelfPipe.cpp
	Also, on Windows you will need to link against this additional library:		Also, on Windows you will need to link against this additional library:
	WS2_32		WS2_32

Mellinger: /* See also */

2025-06-19T20:39:03Z

Mellinger at 20:35, 19 June 2025

2025-06-19T20:35:38Z

← Older revision		Revision as of 20:35, 19 June 2025
Line 4:		Line 4:
	BCI2000Remote is most useful when writing applications in C++, or in another language for which bindings to the [[#BCI2000RemoteLib\|BCI2000RemoteLib]] library exist, such as Python, or MATLAB through the <tt>loadlibrary</tt> command, specifying <tt>src/core/Operator/BCI2000Remote/BCI2000RemoteLib.h</tt> as the header file associated with the library.		BCI2000Remote is most useful when writing applications in C++, or in another language for which bindings to the [[#BCI2000RemoteLib\|BCI2000RemoteLib]] library exist, such as Python, or MATLAB through the <tt>loadlibrary</tt> command, specifying <tt>src/core/Operator/BCI2000Remote/BCI2000RemoteLib.h</tt> as the header file associated with the library.

	<!--For controlling BCI2000 under Windows from MATLAB, Windows Automation compatible scripting languages, or .NET languages, there exists a separate [[Contributions:BCI2000Automation\|automation interface]].--> For controlling BCI2000 from shell scripts (such as the Windows command interpreter, or Unix shells like bash), there exists a [[Contributions:BCI2000Command\|BCI2000 command executable]] and the [[User_Reference:BCI2000Shell\|BCI2000Shell]].		<!--For controlling BCI2000 under Windows from MATLAB, Windows Automation compatible scripting languages, or .NET languages, there exists a separate [[Contributions:BCI2000Automation\|automation interface]].-->
			For controlling BCI2000 from shell scripts (such as the Windows command interpreter, or Unix shells like bash), there exists a [[Contributions:BCI2000Command\|BCI2000 command executable]] and the [[User_Reference:BCI2000Shell\|BCI2000Shell]].

	==Location==		==Location==

Mellinger: /* Synopsis */

2025-06-19T20:35:18Z

Synopsis

← Older revision		Revision as of 20:35, 19 June 2025
Line 4:		Line 4:
	BCI2000Remote is most useful when writing applications in C++, or in another language for which bindings to the [[#BCI2000RemoteLib\|BCI2000RemoteLib]] library exist, such as Python, or MATLAB through the <tt>loadlibrary</tt> command, specifying <tt>src/core/Operator/BCI2000Remote/BCI2000RemoteLib.h</tt> as the header file associated with the library.		BCI2000Remote is most useful when writing applications in C++, or in another language for which bindings to the [[#BCI2000RemoteLib\|BCI2000RemoteLib]] library exist, such as Python, or MATLAB through the <tt>loadlibrary</tt> command, specifying <tt>src/core/Operator/BCI2000Remote/BCI2000RemoteLib.h</tt> as the header file associated with the library.

	For controlling BCI2000 under Windows from MATLAB, Windows Automation compatible scripting languages, or .NET languages, there exists a separate [[Contributions:BCI2000Automation\|automation interface]]. For controlling BCI2000 from shell scripts (such as the Windows command interpreter, or Unix shells like bash), there exists a [[Contributions:BCI2000Command\|BCI2000 command executable]] and the [[User_Reference:BCI2000Shell\|BCI2000Shell]].		<!--For controlling BCI2000 under Windows from MATLAB, Windows Automation compatible scripting languages, or .NET languages, there exists a separate [[Contributions:BCI2000Automation\|automation interface]].--> For controlling BCI2000 from shell scripts (such as the Windows command interpreter, or Unix shells like bash), there exists a [[Contributions:BCI2000Command\|BCI2000 command executable]] and the [[User_Reference:BCI2000Shell\|BCI2000Shell]].

	==Location==		==Location==

Wengelhardt: Point to examples on separate tutorial page

2025-04-22T17:09:15Z

Point to examples on separate tutorial page

@@ Line 159: / Line 159: @@
 Also, on Windows you will need to link against this additional library:
   WS2_32
 ==[[Technical Reference:BCI2000Remote Library|BCI2000RemoteLib]]==
@@ Line 171: / Line 168: @@
 Any function that returns a C string as a <tt>const char*</tt> may return a zero pointer, indicating failure, or a valid pointer to a C string, indicating success. If a valid pointer is returned, the associated memory has been allocated by the library, and will be invalidated by the next call to a C string returning function. Earlier versions of BCI2000RemoteLib required to call <tt>BCI2000Release()</tt> after receiving a C string. This is no longer the case. Instead, the memory allocated for the C string is deallocated on the next call that returns a C string.
 ==Python Variations==
@@ Line 224: / Line 177: @@
 *<b>GetListParameter(name)</b>: if the parameter is a list, this returns an array of the parameter values in the list
 *<b>GetMatrixParameter(name)</b>: if the parameter is a matrix, this returns a 2d array of the matrix
-===Python Example===
-<syntaxhighlight lang="python>
+==Examples==
-bci = BCI2000Remote()
+See the [[User Tutorial:BCI2000Remote|user tutorial page]] for C++, Matlab, and Python examples!
 ==See also==
-[[Contributions:BCI2000Automation]], [[Contributions:BCI2000PresentationLink]], [[Contributions:BCI2000Command]], [[Contributions:BCI2000PythonBindings]], [[Contributions:Applications]]
+[[User Tutorial:BCI2000Remote]], [[Contributions:BCI2000Automation]], [[Contributions:BCI2000PresentationLink]], [[Contributions:BCI2000Command]], [[Contributions:BCI2000PythonBindings]], [[Contributions:Applications]]
 [[Category:External Interfaces]]

Wengelhardt: /* C++ Example */

2025-04-22T16:58:56Z

C++ Example

@@ Line 161: / Line 161: @@
 ==C++ Example==
-<syntaxhighlight lang="cpp">
+[[User Tutorial:BCI2000Remote#C++ Tutorial|See the C++ user tutorial here]]
 ==[[Technical Reference:BCI2000Remote Library|BCI2000RemoteLib]]==

← Older revision		Revision as of 20:39, 19 June 2025
Line 184:		Line 184:

	==See also==		==See also==
	[[User Tutorial:BCI2000Remote]], [[Contributions:BCI2000Automation]], [[Contributions:BCI2000PresentationLink]], [[Contributions:BCI2000Command]], [[Contributions:BCI2000PythonBindings]], [[Contributions:Applications]]		[[User Tutorial:BCI2000Remote]], <!--[[Contributions:BCI2000Automation]],--> [[Contributions:BCI2000PresentationLink]], [[Contributions:BCI2000Command]], [[Contributions:BCI2000PythonBindings]], [[Contributions:Applications]]

	[[Category:External Interfaces]]		[[Category:External Interfaces]]