Technical Reference:App Connector - Revision history

Mellinger: /* For more information about controlling BCI2000 from other applications, see */

2023-12-07T14:07:11Z

For more information about controlling BCI2000 from other applications, see

← Older revision		Revision as of 14:07, 7 December 2023
Line 30:		Line 30:
	[[User Reference:Module Command Line Options#Operator Module]]		[[User Reference:Module Command Line Options#Operator Module]]

			[[Programming Reference:SignalSharingDemo Signal Processing]]

	=Obsolete AppConnector documentation=		=Obsolete AppConnector documentation=

Mellinger: /* To efficiently transport signal data from BCI2000 into other applications: */

2023-12-07T14:06:37Z

To efficiently transport signal data from BCI2000 into other applications:

← Older revision		Revision as of 14:06, 7 December 2023
Line 16:		Line 16:
	===To efficiently transport signal data from BCI2000 into other applications:===		===To efficiently transport signal data from BCI2000 into other applications:===
	Send a shared GenericSignal object through a TCP connection as demonstrated in		Send a shared GenericSignal object through a TCP connection as demonstrated in
	[Programming Reference:SignalSharingDemo].		[[Programming Reference:SignalSharingDemo Signal Processing]].

	===For more information about controlling BCI2000 from other applications, see===		===For more information about controlling BCI2000 from other applications, see===

Mellinger: /* Instead of AppConnector ConnectorInput, use a TCP connection as follows: */

2023-12-07T14:05:41Z

Instead of AppConnector ConnectorInput, use a TCP connection as follows:

← Older revision		Revision as of 14:05, 7 December 2023
Line 13:		Line 13:
	SET STATE TargetCode 3		SET STATE TargetCode 3
	in order to set <tt>TargetCode</tt> to 3.		in order to set <tt>TargetCode</tt> to 3.

			===To efficiently transport signal data from BCI2000 into other applications:===
			Send a shared GenericSignal object through a TCP connection as demonstrated in
			[Programming Reference:SignalSharingDemo].

	===For more information about controlling BCI2000 from other applications, see===		===For more information about controlling BCI2000 from other applications, see===

Mellinger at 09:46, 5 June 2023

2023-06-05T09:46:12Z

← Older revision		Revision as of 09:46, 5 June 2023
Line 135:		Line 135:
	==Examples==		==Examples==
	===BCI2000 example code===		===BCI2000 example code===
	* A simple few-line program that uses AppConnector information from BCI2000 to control the state of the parallel port is found at [~~http~~://{{SERVERNAME}}/tracproj/browser/trunk/src/contrib/AppConnectorApplications/ParallelSwitch/ParallelSwitch.cpp BCI2000/src/contrib/AppConnectorApplications/ParallelSwitch/].		* A simple few-line program that uses AppConnector information from BCI2000 to control the state of the parallel port is found at [https://{{SERVERNAME}}/tracproj/browser/trunk/src/contrib/AppConnectorApplications/ParallelSwitch/ParallelSwitch.cpp BCI2000/src/contrib/AppConnectorApplications/ParallelSwitch/].
	* A GUI application that allows to interactively play with BCI2000 states is found at [~~http~~://{{SERVERNAME}}/tracproj/browser/trunk/src/contrib/AppConnectorApplications/AppConnectorExample BCI2000/src/contrib/AppConnectorApplications/AppConnectorExample].		* A GUI application that allows to interactively play with BCI2000 states is found at [https://{{SERVERNAME}}/tracproj/browser/trunk/src/contrib/AppConnectorApplications/AppConnectorExample BCI2000/src/contrib/AppConnectorApplications/AppConnectorExample].
	* A MATLAB example is available at [~~http~~://{{SERVERNAME}}/tracproj/browser/trunk/src/contrib/AppConnectorApplications/readudp.m BCI2000/src/contrib/AppConnectorApplications/readudp.m].		* A MATLAB example is available at [https://{{SERVERNAME}}/tracproj/browser/trunk/src/contrib/AppConnectorApplications/readudp.m BCI2000/src/contrib/AppConnectorApplications/readudp.m].
	* A minimal C++ program forwarding BCI2000 AppConnector messages to stdout (using the BCI2000 <code>sockstream</code> class) reads		* A minimal C++ program forwarding BCI2000 AppConnector messages to stdout (using the BCI2000 <code>sockstream</code> class) reads
	<pre>		<pre>

Mellinger at 14:30, 15 June 2020

2020-06-15T14:30:12Z

← Older revision		Revision as of 14:30, 15 June 2020
Line 2:		Line 2:
	The '''AppConnector''' interface has been '''superseded''' by a variety of BCI2000 scripting and remote control options. It is being kept for backward compatibility.		The '''AppConnector''' interface has been '''superseded''' by a variety of BCI2000 scripting and remote control options. It is being kept for backward compatibility.

			===Instead of AppConnector ConnectorOutput, use WATCHes as follows:===
	As a functional equivalent to the <tt>ConnectorOutput</tt> filter, execute the following [[User_Reference:Operator_Module_Scripting\|scripting code]] at startup, e.g., from a batch file:		As a functional equivalent to the <tt>ConnectorOutput</tt> filter, execute the following [[User_Reference:Operator_Module_Scripting\|scripting code]] at startup, e.g., from a batch file:
	ADD WATCH State1 State2 State3 ... StateN AT localhost:12345		ADD WATCH State1 State2 State3 ... StateN AT localhost:12345
Line 8:		Line 9:
	ADD WATCH ResultCode AT localhost:2007		ADD WATCH ResultCode AT localhost:2007

			===Instead of AppConnector ConnectorInput, use a TCP connection as follows:===
	As a functional equivalent to the <tt>ConnectorInput</tt> filter, you may establish a TCP connection to <tt>localhost:3999</tt> and issue a SET STATE command, e.g.		As a functional equivalent to the <tt>ConnectorInput</tt> filter, you may establish a TCP connection to <tt>localhost:3999</tt> and issue a SET STATE command, e.g.
	SET STATE TargetCode 3		SET STATE TargetCode 3
	in order to set <tt>TargetCode</tt> to 3.		in order to set <tt>TargetCode</tt> to 3.

	For more information about controlling BCI2000 from other applications, see		===For more information about controlling BCI2000 from other applications, see===

	[[User Reference:Operator Module Scripting#Commands operating on States]]		[[User Reference:Operator Module Scripting#Commands operating on States]]
Line 24:		Line 26:
	[[User Reference:Module Command Line Options#Operator Module]]		[[User Reference:Module Command Line Options#Operator Module]]


			=Obsolete AppConnector documentation=
	==Introduction==		==Introduction==
	The BCI2000 external application interface provides a bi-directional link to exchange		The BCI2000 external application interface provides a bi-directional link to exchange

Mellinger at 13:31, 1 June 2016

2016-06-01T13:31:26Z

← Older revision		Revision as of 13:31, 1 June 2016
Line 1:		Line 1:
			==NOTE==
			The '''AppConnector''' interface has been '''superseded''' by a variety of BCI2000 scripting and remote control options. It is being kept for backward compatibility.

			As a functional equivalent to the <tt>ConnectorOutput</tt> filter, execute the following [[User_Reference:Operator_Module_Scripting\|scripting code]] at startup, e.g., from a batch file:
			ADD WATCH State1 State2 State3 ... StateN AT localhost:12345
			As a result, the values of the state variables listed will be sent to the named UDP port whenever one of them changes. Multiple ADD WATCH commands may be used to send change notifications for different states (or expressions) to different UDP ports:
			ADD WATCH TargetCode AT localhost:2006
			ADD WATCH ResultCode AT localhost:2007

			As a functional equivalent to the <tt>ConnectorInput</tt> filter, you may establish a TCP connection to <tt>localhost:3999</tt> and issue a SET STATE command, e.g.
			SET STATE TargetCode 3
			in order to set <tt>TargetCode</tt> to 3.

			For more information about controlling BCI2000 from other applications, see

			[[User Reference:Operator Module Scripting#Commands operating on States]]

			[[User Reference:Operator Module Scripting#Commands operating on Events]]

			[[User Reference:Operator Module Scripting#Commands operating on Watches]]

			[[Programming Reference:BCI2000Remote Class]]

			[[User Reference:Module Command Line Options#Operator Module]]

	==Introduction==		==Introduction==
	The BCI2000 external application interface provides a bi-directional link to exchange		The BCI2000 external application interface provides a bi-directional link to exchange

Mellinger: /* BCI2000 example code */

2011-10-11T15:32:54Z

BCI2000 example code

← Older revision		Revision as of 15:32, 11 October 2011
Line 108:		Line 108:
	* A simple few-line program that uses AppConnector information from BCI2000 to control the state of the parallel port is found at [http://{{SERVERNAME}}/tracproj/browser/trunk/src/contrib/AppConnectorApplications/ParallelSwitch/ParallelSwitch.cpp BCI2000/src/contrib/AppConnectorApplications/ParallelSwitch/].		* A simple few-line program that uses AppConnector information from BCI2000 to control the state of the parallel port is found at [http://{{SERVERNAME}}/tracproj/browser/trunk/src/contrib/AppConnectorApplications/ParallelSwitch/ParallelSwitch.cpp BCI2000/src/contrib/AppConnectorApplications/ParallelSwitch/].
	* A GUI application that allows to interactively play with BCI2000 states is found at [http://{{SERVERNAME}}/tracproj/browser/trunk/src/contrib/AppConnectorApplications/AppConnectorExample BCI2000/src/contrib/AppConnectorApplications/AppConnectorExample].		* A GUI application that allows to interactively play with BCI2000 states is found at [http://{{SERVERNAME}}/tracproj/browser/trunk/src/contrib/AppConnectorApplications/AppConnectorExample BCI2000/src/contrib/AppConnectorApplications/AppConnectorExample].
	* A MATLAB example is available at		* A MATLAB example is available at [http://{{SERVERNAME}}/tracproj/browser/trunk/src/contrib/AppConnectorApplications/readudp.m BCI2000/src/contrib/AppConnectorApplications/readudp.m].
	[http://{{SERVERNAME}}/tracproj/browser/trunk/src/contrib/AppConnectorApplications/readudp.m BCI2000/src/contrib/AppConnectorApplications/readudp.m].
	* A minimal C++ program forwarding BCI2000 AppConnector messages to stdout (using the BCI2000 <code>sockstream</code> class) reads		* A minimal C++ program forwarding BCI2000 AppConnector messages to stdout (using the BCI2000 <code>sockstream</code> class) reads
	<pre>		<pre>

Mellinger: /* BCI2000 example code */

2011-10-11T15:31:10Z

BCI2000 example code

← Older revision		Revision as of 15:31, 11 October 2011
Line 108:		Line 108:
	* A simple few-line program that uses AppConnector information from BCI2000 to control the state of the parallel port is found at [http://{{SERVERNAME}}/tracproj/browser/trunk/src/contrib/AppConnectorApplications/ParallelSwitch/ParallelSwitch.cpp BCI2000/src/contrib/AppConnectorApplications/ParallelSwitch/].		* A simple few-line program that uses AppConnector information from BCI2000 to control the state of the parallel port is found at [http://{{SERVERNAME}}/tracproj/browser/trunk/src/contrib/AppConnectorApplications/ParallelSwitch/ParallelSwitch.cpp BCI2000/src/contrib/AppConnectorApplications/ParallelSwitch/].
	* A GUI application that allows to interactively play with BCI2000 states is found at [http://{{SERVERNAME}}/tracproj/browser/trunk/src/contrib/AppConnectorApplications/AppConnectorExample BCI2000/src/contrib/AppConnectorApplications/AppConnectorExample].		* A GUI application that allows to interactively play with BCI2000 states is found at [http://{{SERVERNAME}}/tracproj/browser/trunk/src/contrib/AppConnectorApplications/AppConnectorExample BCI2000/src/contrib/AppConnectorApplications/AppConnectorExample].
			* A MATLAB example is available at
			[http://{{SERVERNAME}}/tracproj/browser/trunk/src/contrib/AppConnectorApplications/readudp.m BCI2000/src/contrib/AppConnectorApplications/readudp.m].
	* A minimal C++ program forwarding BCI2000 AppConnector messages to stdout (using the BCI2000 <code>sockstream</code> class) reads		* A minimal C++ program forwarding BCI2000 AppConnector messages to stdout (using the BCI2000 <code>sockstream</code> class) reads
	<pre>		<pre>

Mellinger: /* BCI2000 example code */

2010-10-13T13:32:35Z

BCI2000 example code

← Older revision		Revision as of 13:32, 13 October 2010
Line 108:		Line 108:
	* A simple few-line program that uses AppConnector information from BCI2000 to control the state of the parallel port is found at [http://{{SERVERNAME}}/tracproj/browser/trunk/src/contrib/AppConnectorApplications/ParallelSwitch/ParallelSwitch.cpp BCI2000/src/contrib/AppConnectorApplications/ParallelSwitch/].		* A simple few-line program that uses AppConnector information from BCI2000 to control the state of the parallel port is found at [http://{{SERVERNAME}}/tracproj/browser/trunk/src/contrib/AppConnectorApplications/ParallelSwitch/ParallelSwitch.cpp BCI2000/src/contrib/AppConnectorApplications/ParallelSwitch/].
	* A GUI application that allows to interactively play with BCI2000 states is found at [http://{{SERVERNAME}}/tracproj/browser/trunk/src/contrib/AppConnectorApplications/AppConnectorExample BCI2000/src/contrib/AppConnectorApplications/AppConnectorExample].		* A GUI application that allows to interactively play with BCI2000 states is found at [http://{{SERVERNAME}}/tracproj/browser/trunk/src/contrib/AppConnectorApplications/AppConnectorExample BCI2000/src/contrib/AppConnectorApplications/AppConnectorExample].
	* A ~~minimum~~ C++ program forwarding BCI2000 AppConnector messages to stdout (using the BCI2000 <code>sockstream</code> class) reads		* A minimal C++ program forwarding BCI2000 AppConnector messages to stdout (using the BCI2000 <code>sockstream</code> class) reads
	<pre>		<pre>
	#include <iostream>		#include <iostream>

Mellinger: /* Description */

2010-03-05T14:26:55Z

Description

← Older revision		Revision as of 14:26, 5 March 2010
Line 65:		Line 65:
	This ensures that changes resulting from user choices are sent out immediately, and that		This ensures that changes resulting from user choices are sent out immediately, and that
	received information will immediately be available to the task filter.		received information will immediately be available to the task filter.
	IP addresses and ports used are user-configurable. Sending and receiving ~~need~~ not use the same address and port.		IP addresses and ports used are user-configurable. Sending and receiving may not use the same address and port.

	==Protocol==		==Protocol==