Contributions:BCI2000RemoteNET - Revision history

Tytbutler: Added info about the Execute method

2024-05-24T23:01:41Z

Added info about the Execute method

@@ Line 187: / Line 187: @@
+   }
 </pre>
 ==Examples==

Tytbutler at 20:54, 24 May 2024

2024-05-24T20:54:34Z

← Older revision		Revision as of 20:54, 24 May 2024
Line 64:		Line 64:
	//Connect to operator at address 11.11.11.11:3999		//Connect to operator at address 11.11.11.11:3999
	conn.Connect(address: "11.11.11.11");		conn.Connect(address: "11.11.11.11");

			BCI2000Remote bci = new(conn);

	</pre>		</pre>

Tytbutler: Fixed start up modules documentation

2024-05-24T20:53:34Z

Fixed start up modules documentation

← Older revision		Revision as of 20:53, 24 May 2024
Line 97:		Line 97:
	BCI2000 modules are started using the <code>StartModules()</code> method, given a dictionary of module names and argument lists. For example, to open SignalGenerator, DummySignalProcessing, and DummyApplication with keyboard and mouse logging:		BCI2000 modules are started using the <code>StartModules()</code> method, given a dictionary of module names and argument lists. For example, to open SignalGenerator, DummySignalProcessing, and DummyApplication with keyboard and mouse logging:
	<pre>		<pre>
	bci.StartupModules(new Dictionary<string, ~~List~~<string>?>()		bci.StartupModules(new Dictionary<string, IEnumerable<string>?>()
	{		{
	{"SignalGenerator", new List<string>() {"LogKeyboard=1", "LogMouse=1"}},		{"SignalGenerator", new List<string>() {"LogKeyboard=1", "LogMouse=1"}},
Line 218:		Line 218:
	bci.connection.Connect();		bci.connection.Connect();
	bci.LoadParameters("../parms/examples/StimulusPresentation_SignalGenerator.prm");		bci.LoadParameters("../parms/examples/StimulusPresentation_SignalGenerator.prm");
	bci.StartupModules(new() {		bci.StartupModules(new Dictionary<string, IEnumerable<string>?> {
	{"SignalGenerator", new() {"LogKeyboard=1", "SpinningWheel=1", "ShowDisplayStatistics=1"}},		{"SignalGenerator", new() {"LogKeyboard=1", "SpinningWheel=1", "ShowDisplayStatistics=1"}},
	{"P3SignalProcessing", null},		{"P3SignalProcessing", null},

Tytbutler: Change wording of future plans

2024-05-21T14:31:16Z

Change wording of future plans

← Older revision		Revision as of 14:31, 21 May 2024
Line 250:		Line 250:

	==Note On Security==		==Note On Security==
	The BCI2000 command line interface can be used to run arbitrary system shell commands. It is also entirely unsecured and unencrypted. Anyone who has access to it effectively has full access to the computer on which it runs. This is not a problem if running locally, and is generally not a problem if running on a firewalled local network. However, due to the unsecured nature of the interface, running BCI2000 across the internet is highly discouraged. That is, if you set BCI2000 to listen at an address of an external network interface, or to listen at all connections by passing the address <code>0.0.0.0</code>, make sure that port 3999 (or whichever port BCI2000 is listening on), is not forwarded beyond the local network by your router. Support for ~~interfacing with~~ BCI2000 ~~over TLS~~ is planned~~, so that safe connection can be made over~~ the ~~internet~~.		The BCI2000 command line interface can be used to run arbitrary system shell commands. It is also entirely unsecured and unencrypted. Anyone who has access to it effectively has full access to the computer on which it runs. This is not a problem if running locally, and is generally not a problem if running on a firewalled local network. However, due to the unsecured nature of the interface, running BCI2000 across the internet is highly discouraged. That is, if you set BCI2000 to listen at an address of an external network interface, or to listen at all connections by passing the address <code>0.0.0.0</code>, make sure that port 3999 (or whichever port BCI2000 is listening on), is not forwarded beyond the local network by your router. Support for securely connecting to BCI2000 is planned for the future.

Tytbutler: added F# example

2024-05-17T21:21:53Z

added F# example

← Older revision		Revision as of 21:21, 17 May 2024
Line 220:		Line 220:
	bci.StartupModules(new() {		bci.StartupModules(new() {
	{"SignalGenerator", new() {"LogKeyboard=1", "SpinningWheel=1", "ShowDisplayStatistics=1"}},		{"SignalGenerator", new() {"LogKeyboard=1", "SpinningWheel=1", "ShowDisplayStatistics=1"}},
	{"P3SignalProcessing", null}		{"P3SignalProcessing", null},
	{"StimulusPresentation", null}		{"StimulusPresentation", null}
	});		});
Line 226:		Line 226:

	C# startup scripts have access to all of the constructs of the C# language, so different actions can be taken depending on conditions such as the operating system, as seen in the above script, or take other input such as command line options.		C# startup scripts have access to all of the constructs of the C# language, so different actions can be taken depending on conditions such as the operating system, as seen in the above script, or take other input such as command line options.
			Note that this will need to be part of a C# project, created via <code>dotnet new console</code> with its accompanied <code>.csproj</code> file.

	~~This startup~~ script can then be ~~compiled to a~~ .~~NET executable~~:		An alternative would be to instead use a PowerShell or F# script, which can then be run via <code>pwsh</code> or <code>dotnet fsi</code>. This is the equivalent F# code:
	~~Windows:~~		<pre>/batch/StimulusPresentation_SignalGenerator.fsx</pre>
			<pre>
	<~~code~~>~~csc~~.~~exe~~ /r:"~~path/to~~/BCI2000RemoteNET.dll" ~~StimulusPresentation_SignalGenerator~~.~~cs</code>~~		#r "../BCI2000RemoteNET.dll"
			open BCI2000RemoteNET
	~~Non-~~Windows:		open System.Runtime.InteropServices
			let bci = new BCI2000Remote(new BCI2000Connection()) in
	</~~code>csc~~ /r:"~~path~~/to/~~BCI2000RemoteNET~~.~~dll~~" ~~StimulusPresentation_SignalGenerator~~.cs<~~/code>~~		let isWindows = RuntimeInformation.IsOSPlatform(OSPlatform.Windows) in
			let operatorPath = "../../bci2000/prog/Operator" + if isWindows then ".exe" else "" in
	~~The resulting executable can be run directly on Windows:~~		bci.connection.StartOperator operatorPath;
			bci.connection.Connect ();
	~~<code>./StimulusPresentation_SignalGenerator.exe~~</~~code~~>		bci.LoadParameters "../parms/examples/StimulusPresentation_SignalGenerator.prm";
			bci.StartupModules <\| Map [
	~~or via Mono on other platforms~~:		("SignalGenerator", ["LogKeyboard=1"; "SpinningWheel=1"; "ShowDisplayStatistics=1"]);
			("P3SignalProcessing", null);
	<code>~~mono ./~~StimulusPresentation_SignalGenerator.~~exe~~</code>		("StimulusPresentation", null);
			]
			</pre>
			This can be run directly:
			<code>dotnet fsi StimulusPresentation_SignalGenerator.fsx</code>

	==Note On Security==		==Note On Security==
	The BCI2000 command line interface can be used to run arbitrary system shell commands. It is also entirely unsecured and unencrypted. Anyone who has access to it effectively has full access to the computer on which it runs. This is not a problem if running locally, and is generally not a problem if running on a firewalled local network. However, due to the unsecured nature of the interface, running BCI2000 across the internet is highly discouraged. That is, if you set BCI2000 to listen at an address of an external network interface, or to listen at all connections by passing the address <code>0.0.0.0</code>, make sure that port 3999 (or whichever port BCI2000 is listening on), is not forwarded beyond the local network by your router. Support for interfacing with BCI2000 over TLS is planned, so that safe connection can be made over the internet.		The BCI2000 command line interface can be used to run arbitrary system shell commands. It is also entirely unsecured and unencrypted. Anyone who has access to it effectively has full access to the computer on which it runs. This is not a problem if running locally, and is generally not a problem if running on a firewalled local network. However, due to the unsecured nature of the interface, running BCI2000 across the internet is highly discouraged. That is, if you set BCI2000 to listen at an address of an external network interface, or to listen at all connections by passing the address <code>0.0.0.0</code>, make sure that port 3999 (or whichever port BCI2000 is listening on), is not forwarded beyond the local network by your router. Support for interfacing with BCI2000 over TLS is planned, so that safe connection can be made over the internet.

Tytbutler: Fixed spacing

2024-05-17T19:47:29Z

Fixed spacing

← Older revision		Revision as of 19:47, 17 May 2024
Line 229:		Line 229:
	This startup script can then be compiled to a .NET executable:		This startup script can then be compiled to a .NET executable:
	Windows:		Windows:

	<code>csc.exe /r:"path/to/BCI2000RemoteNET.dll" StimulusPresentation_SignalGenerator.cs</code>		<code>csc.exe /r:"path/to/BCI2000RemoteNET.dll" StimulusPresentation_SignalGenerator.cs</code>

	Non-Windows:		Non-Windows:

	</code>csc /r:"path/to/BCI2000RemoteNET.dll" StimulusPresentation_SignalGenerator.cs</code>		</code>csc /r:"path/to/BCI2000RemoteNET.dll" StimulusPresentation_SignalGenerator.cs</code>

	The resulting executable can be run directly on Windows:		The resulting executable can be run directly on Windows:

	<code>./StimulusPresentation_SignalGenerator.exe</code>		<code>./StimulusPresentation_SignalGenerator.exe</code>

	or via Mono on other platforms:		or via Mono on other platforms:

	<code>mono ./StimulusPresentation_SignalGenerator.exe</code>		<code>mono ./StimulusPresentation_SignalGenerator.exe</code>

	==Note On Security==		==Note On Security==
	The BCI2000 command line interface can be used to run arbitrary system shell commands. It is also entirely unsecured and unencrypted. Anyone who has access to it effectively has full access to the computer on which it runs. This is not a problem if running locally, and is generally not a problem if running on a firewalled local network. However, due to the unsecured nature of the interface, running BCI2000 across the internet is highly discouraged. That is, if you set BCI2000 to listen at an address of an external network interface, or to listen at all connections by passing the address <code>0.0.0.0</code>, make sure that port 3999 (or whichever port BCI2000 is listening on), is not forwarded beyond the local network by your router. Support for interfacing with BCI2000 over TLS is planned, so that safe connection can be made over the internet.		The BCI2000 command line interface can be used to run arbitrary system shell commands. It is also entirely unsecured and unencrypted. Anyone who has access to it effectively has full access to the computer on which it runs. This is not a problem if running locally, and is generally not a problem if running on a firewalled local network. However, due to the unsecured nature of the interface, running BCI2000 across the internet is highly discouraged. That is, if you set BCI2000 to listen at an address of an external network interface, or to listen at all connections by passing the address <code>0.0.0.0</code>, make sure that port 3999 (or whichever port BCI2000 is listening on), is not forwarded beyond the local network by your router. Support for interfacing with BCI2000 over TLS is planned, so that safe connection can be made over the internet.

Tytbutler: Added example

2024-05-17T19:46:59Z

Added example

@@ Line 185: / Line 185: @@
+   }
 </pre>
 ==Note On Security==
 The BCI2000 command line interface can be used to run arbitrary system shell commands. It is also entirely unsecured and unencrypted. Anyone who has access to it effectively has full access to the computer on which it runs. This is not a problem if running locally, and is generally not a problem if running on a firewalled local network. However, due to the unsecured nature of the interface, running BCI2000 across the internet is highly discouraged. That is, if you set BCI2000 to listen at an address of an external network interface, or to listen at all connections by passing the address <code>0.0.0.0</code>, make sure that port 3999 (or whichever port BCI2000 is listening on), is not forwarded beyond the local network by your router. Support for interfacing with BCI2000 over TLS is planned, so that safe connection can be made over the internet.

Tytbutler: Fixed formatting

2024-05-17T19:13:09Z

Fixed formatting

Show changes

Tytbutler: New version

2024-05-17T19:03:17Z

New version

Show changes

Tytbutler at 01:33, 28 September 2021

2021-09-28T01:33:18Z

← Older revision		Revision as of 01:33, 28 September 2021
Line 1:		Line 1:
	==Synopsis==		==Synopsis==
	BCI2000RemoteNET is an implementation of [[Programming_Reference:BCI2000Remote_Class\|BCI2000Remote]] as a .NET Standard assembly, for use within .NET languages such as C#, as well as associated applications such as Unity (See [[Contributions:UnityBCI2000\|UnityBCI2000]]). Similarly to BCI2000Remote, it sends [[User_Reference:Operator_Module_Scripting\|Operator Scripting Commands]] over TCP to a running [[User_Reference:Operator_Module\|Operator Module]], or starts up BCI2000 on its own.		BCI2000RemoteNET is an implementation of [[Programming_Reference:BCI2000Remote_Class\|BCI2000Remote]] as a .NET Standard assembly, for use within .NET languages such as C#, as well as associated applications such as Unity (See [[Contributions:UnityBCI2000\|UnityBCI2000]]). Similarly to BCI2000Remote, it sends [[User_Reference:Operator_Module_Scripting\|Operator Scripting Commands]] over TCP to a running [[User_Reference:Operator_Module\|Operator Module]], or starts up BCI2000 on its own. It does not depends on the BCI2000 Framework, but requires a .NET environment (.NET Framework, .NET Core, Mono) to run.

			==Description==
			BCI2000RemoteNET contains a class, BCI2000Remote, which handles connection and communication with the Operator.
			To start, instantiate a BCI2000Remote object, set the operator path if starting a new Operator, and call the Connect() method.