User Reference:Module Command Line Options - Revision history

Mellinger: /* Special Options */

2024-10-07T12:14:29Z

Special Options

← Older revision		Revision as of 12:14, 7 October 2024
Line 32:		Line 32:
	*The ''LogKeyboard'', ''LogMouse'', and ''LogJoystick'' options will enable [[User Reference:Logging Input\|recording of key presses, mouse and joystick position]].		*The ''LogKeyboard'', ''LogMouse'', and ''LogJoystick'' options will enable [[User Reference:Logging Input\|recording of key presses, mouse and joystick position]].
	*The ''SavePrmFile'' option will save a [[Technical_Reference:Parameter_File\|parameter file]] for each run.		*The ''SavePrmFile'' option will save a [[Technical_Reference:Parameter_File\|parameter file]] for each run.
	*Normally, BCI2000 automatically chooses a suitable IP ~~address~~ for communication between SignalSource, SignalProcessing, and Application module. Sometimes however, you want a specific address to be used. This is possible using the ''~~SignalSourceIP/SignalProcessingIP/ApplicationIP~~'' ~~options~~. Note that ~~these~~ options must be specified on the command line of the respective module, e.g. the following lines will specify the localhost address for both the connection to the Operator module (first option), and the connection between core modules:		*Normally, BCI2000 automatically chooses suitable IP addresses for communication between SignalSource, SignalProcessing, and Application module. Sometimes however, you want a specific address to be used, e.g. if you distribute BCI2000 over multiple machines, and need a certain address to be used. This is possible using the ''ListeningAddress'' option. Note that this options must be specified on the command line of the respective module, e.g. the following lines will specify the localhost address for both the connection to the Operator module (first option), and the connection between core modules:
	start executable SignalSource 127.0.0.1 --~~SignalSourceIP~~=127.0.0.1		start executable SignalSource 127.0.0.1 --ListeningAddress=127.0.0.1
	start executable SignalProcessing 127.0.0.1 --~~SignalProcessingIP~~=127.0.0.1		start executable SignalProcessing 127.0.0.1 --ListeningAddress=127.0.0.1
	start executable Application 127.0.0.1 --~~ApplicationIP~~=127.0.0.1		start executable Application 127.0.0.1 --ListeningAddress=127.0.0.1
	*The ''--local'' option provides an alternative way to set a module's listening IP to 127.0.0.1.		*The ''--local'' option provides an alternative way to set a module's listening IP to 127.0.0.1.
	*By default, only one module of each kind may be running at a time. To allow for multiple instances of a module, specify the ''--AllowMultipleInstances'' option. This will also clean up any instance information that may have been left over from a crashing module.		*By default, only one module of each kind may be running at a time. To allow for multiple instances of a module, specify the ''--AllowMultipleInstances'' option. This will also clean up any instance information that may have been left over from a crashing module.

Mellinger: /* Operator Module */

2024-05-25T09:28:25Z

Operator Module

← Older revision		Revision as of 09:28, 25 May 2024
Line 63:		Line 63:
	--Telnet		--Telnet
	--Telnet 192.168.1.5:3999		--Telnet 192.168.1.5:3999
	~~--Title %~n0~~

	~~The last example shows how to display the name of the batch file from which the Operator Module was started under MS Windows.~~

	===--Title===		===--Title===

Mellinger: /* Operator Module */

2024-05-25T09:27:18Z

Operator Module

← Older revision		Revision as of 09:27, 25 May 2024
Line 61:		Line 61:
	--OnConnect "C:\scripts\onconnect.bciscript"		--OnConnect "C:\scripts\onconnect.bciscript"
	--OnConnect "-LOAD PARAMETERFILE ..\parms\myparms.prm"		--OnConnect "-LOAD PARAMETERFILE ..\parms\myparms.prm"
	--Telnet *:3999		--Telnet
			--Telnet 192.168.1.5:3999
	--Title %~n0		--Title %~n0

Mellinger: /* --WebSocket */

2024-05-25T09:07:50Z

--WebSocket

← Older revision		Revision as of 09:07, 25 May 2024
Line 81:		Line 81:
	===--WebSocket===		===--WebSocket===
	Similar to the ''--Telnet'' option, the ''--WebSocket'' option expects an IP:Port combination for incoming [https://en.wikipedia.org/wiki/WebSocket WebSocket] connections, defaulting to "localhost:3998" (the WebSocket URL would be "ws://localhost:3998/"). The WebSocket port exposes the same functionality as the Telnet port, but wrapped into the WebSocket protocol, allowing browser clients to communicate with BCI2000 in JavaScript (for security reasons, browser-based JavaScript cannot use raw TCP or UDP sockets).		Similar to the ''--Telnet'' option, the ''--WebSocket'' option expects an IP:Port combination for incoming [https://en.wikipedia.org/wiki/WebSocket WebSocket] connections, defaulting to "localhost:3998" (the WebSocket URL would be "ws://localhost:3998/"). The WebSocket port exposes the same functionality as the Telnet port, but wrapped into the WebSocket protocol, allowing browser clients to communicate with BCI2000 in JavaScript (for security reasons, browser-based JavaScript cannot use raw TCP or UDP sockets).

			'''NOTE:''' You should not use this option on global internet addresses, as there is no authentication performed. Be especially careful with the "*" address, as it opens all addresses, possibly open internet addresses as well.

	===--StartupIdle===		===--StartupIdle===

Mellinger: /* --Telnet */

2024-05-25T09:07:39Z

--Telnet

← Older revision		Revision as of 09:07, 25 May 2024
Line 73:		Line 73:

	===--Telnet===		===--Telnet===
	The ''--Telnet'' option expects an IP:Port combination on which to listen for incoming connections, defaulting to "localhost:3999". Logging into the Operator Module's telnet server allows you to execute script commands interactively, or to remotely control BCI2000 from an external application using script commands. When you intend to connect to the Operator Module from a different machine, you will need to specify either an asterisk () in place of the IP address: ":3999" to indicate that it should listen on all available addresses, or the listening machine's external IP address, e.g. "~~134~~.2.~~131~~.~~152~~:3999".		The ''--Telnet'' option expects an IP:Port combination on which to listen for incoming connections, defaulting to "localhost:3999". Logging into the Operator Module's telnet server allows you to execute script commands interactively, or to remotely control BCI2000 from an external application using script commands. When you intend to connect to the Operator Module from a different machine, you will need to specify either an asterisk () in place of the IP address: ":3999" to indicate that it should listen on all available addresses, or the listening machine's external IP address, e.g. "192.168.1.5:3999".

	Multiple ''--Telnet'' options may be given to start multiple telnet servers on different addresses.		Multiple ''--Telnet'' options may be given to start multiple telnet servers on different addresses.

			'''NOTE:''' You should not use this option on global internet addresses, as there is no authentication performed. Be especially careful with the "*" address, as it opens all addresses, possibly open internet addresses as well.

	===--WebSocket===		===--WebSocket===

Mellinger: /* Special Options */

2024-05-10T18:35:46Z

Special Options

← Older revision		Revision as of 18:35, 10 May 2024
Line 26:		Line 26:
	====Special Options====		====Special Options====
	*Specifying ''--version'' will display version information, and then quit.		*Specifying ''--version'' will display version information, and then quit.
			*Specifying ''--Extensions'' will display a list of extensions present in the module, along with their "enabler" parameters.
	*The ''FileFormat'' option will switch between [[User Reference:Data File Formats\|File Formats]] used for data recording. The output file format is determined at module startup, and cannot be changed by modifying the FileFormat parameter from the operator module's parameter dialog.		*The ''FileFormat'' option will switch between [[User Reference:Data File Formats\|File Formats]] used for data recording. The output file format is determined at module startup, and cannot be changed by modifying the FileFormat parameter from the operator module's parameter dialog.
	*The ''DebugLevel'' option will make a module send [[Programming Reference:Debug Output\|Debug Messages]] that appear in the operator module's log window. By default, the debug level will be set to 1; providing a larger number, as in ''DebugLevel=5,'' will increase verbosity of debug output.		*The ''DebugLevel'' option will make a module send [[Programming Reference:Debug Output\|Debug Messages]] that appear in the operator module's log window. By default, the debug level will be set to 1; providing a larger number, as in ''DebugLevel=5,'' will increase verbosity of debug output.

Mellinger: /* --Telnet */

2024-04-29T17:26:51Z

--Telnet

← Older revision		Revision as of 17:26, 29 April 2024
Line 73:		Line 73:
	===--Telnet===		===--Telnet===
	The ''--Telnet'' option expects an IP:Port combination on which to listen for incoming connections, defaulting to "localhost:3999". Logging into the Operator Module's telnet server allows you to execute script commands interactively, or to remotely control BCI2000 from an external application using script commands. When you intend to connect to the Operator Module from a different machine, you will need to specify either an asterisk () in place of the IP address: ":3999" to indicate that it should listen on all available addresses, or the listening machine's external IP address, e.g. "134.2.131.152:3999".		The ''--Telnet'' option expects an IP:Port combination on which to listen for incoming connections, defaulting to "localhost:3999". Logging into the Operator Module's telnet server allows you to execute script commands interactively, or to remotely control BCI2000 from an external application using script commands. When you intend to connect to the Operator Module from a different machine, you will need to specify either an asterisk () in place of the IP address: ":3999" to indicate that it should listen on all available addresses, or the listening machine's external IP address, e.g. "134.2.131.152:3999".

			Multiple ''--Telnet'' options may be given to start multiple telnet servers on different addresses.

	===--WebSocket===		===--WebSocket===

Mellinger: /* Operator Module */

2023-02-20T18:13:16Z

Operator Module

← Older revision		Revision as of 18:13, 20 February 2023
Line 48:		Line 48:
	--OnResume		--OnResume
	--OnStart		--OnStart
			--OnStartRun
			--OnStopRun
	--Title		--Title
	--Hide		--Hide

Mellinger: /* --InstancePrefix */

2022-10-07T13:35:26Z

--InstancePrefix

← Older revision		Revision as of 13:35, 7 October 2022
Line 87:		Line 87:

	===--InstancePrefix===		===--InstancePrefix===
	A prefix to use in Operator module window title bars. This is useful when running multiple instances of the Operator module at the same time. Also, the instance prefix will be used to separate settings in the Operator .ini file (such as window position and size).		A prefix to use in Operator module window title bars. This is useful when running multiple instances of the Operator module at the same time. Also, the instance prefix will be used to separate persistent settings in the Operator .ini file (such as window position and size) by storing them to a different .ini file named ''<prefix> Operator.ini''.

Mellinger: /* --AllowMultipleInstances */

2022-10-07T13:23:54Z

--AllowMultipleInstances

← Older revision		Revision as of 13:23, 7 October 2022
Line 85:		Line 85:
	===--AllowMultipleInstances===		===--AllowMultipleInstances===
	By default, only one instance of the Operator module may be running on a system at a time. To allow for multiple Operator instances, specify the ''--AllowMultipleInstances'' option.		By default, only one instance of the Operator module may be running on a system at a time. To allow for multiple Operator instances, specify the ''--AllowMultipleInstances'' option.

			===--InstancePrefix===
			A prefix to use in Operator module window title bars. This is useful when running multiple instances of the Operator module at the same time. Also, the instance prefix will be used to separate settings in the Operator .ini file (such as window position and size).