User Reference:Logging Input - Revision history

Mellinger: /* LogJoystick */

2026-02-18T15:21:00Z

LogJoystick

← Older revision		Revision as of 15:21, 18 February 2026
Line 28:		Line 28:
	--LogJoystick=1		--LogJoystick=1
	When set to 1 from the command line, this parameter enables recording of joystick state. To select which joystick is used, go to "Control Panel->Game Controllers," and click the "Advanced..." button. The device in the "Preferred device:" drop-down menu will be used in BCI2000.		When set to 1 from the command line, this parameter enables recording of joystick state. To select which joystick is used, go to "Control Panel->Game Controllers," and click the "Advanced..." button. The device in the "Preferred device:" drop-down menu will be used in BCI2000.

			On '''Linux''', no joystick logger is available.

	==States==		==States==

Mellinger at 15:20, 18 February 2026

2026-02-18T15:20:27Z

← Older revision		Revision as of 15:20, 18 February 2026
Line 13:		Line 13:
	On '''Linux''', no system-wide API is available for receiving key press and mouse movement information. Instead, raw input events need to be read from <tt>/dev/input/eventX</tt>, and translated into virtual key codes by applying a keyboard layout. Also, the user must be member of a the group that owns the raw keyboard devices, typically <tt>input</tt> or <tt>plugdev</tt>.		On '''Linux''', no system-wide API is available for receiving key press and mouse movement information. Instead, raw input events need to be read from <tt>/dev/input/eventX</tt>, and translated into virtual key codes by applying a keyboard layout. Also, the user must be member of a the group that owns the raw keyboard devices, typically <tt>input</tt> or <tt>plugdev</tt>.

	~~Due to these difficulties~~, ~~BCI2000 currently does not provide~~ a ~~Linux implementation~~ of the mouse and ~~keyboard logger~~.		For relative pointing devices, such as a typical mouse, only relative movement information is received from <tt>/dev/input/eventX</tt>. At the same time, modern desktop compositors such as Wayland, the successor of X11, no longer allow retrieving global mouse coordinates for security reasons. Thus, the Linux input logger cannot provide accurate mouse position, and integrates up relative mouse movement information instead.

	==Parameters==		==Parameters==
	Logging parameters need to be specified from the command line that starts up the signal source module. For more information about command line options, see the [[User_Reference:Module_Command_Line_Options\|Module Command Line Options]] page.		Logging parameters need to be specified from the command line that starts up the signal source module. For more information about command line options, see the [[User_Reference:Module_Command_Line_Options\|Module Command Line Options]] page.

Mellinger at 15:10, 13 February 2026

2026-02-13T15:10:29Z

← Older revision		Revision as of 15:10, 13 February 2026
Line 11:		Line 11:
	Logging input works in both Microsoft Windows, and macOS. On macOS, macOS specific key codes are translated into Windows virtual key codes.		Logging input works in both Microsoft Windows, and macOS. On macOS, macOS specific key codes are translated into Windows virtual key codes.

	On '''Linux''', no system-wide API is available for receiving key press and mouse movement information. Instead, raw input events need to be read from <tt>/dev/input/eventX</tt>, and translated into virtual key codes by applying a keyboard layout.		On '''Linux''', no system-wide API is available for receiving key press and mouse movement information. Instead, raw input events need to be read from <tt>/dev/input/eventX</tt>, and translated into virtual key codes by applying a keyboard layout. Also, the user must be member of a the group that owns the raw keyboard devices, typically <tt>input</tt> or <tt>plugdev</tt>.

			Due to these difficulties, BCI2000 currently does not provide a Linux implementation of the mouse and keyboard logger.
	==Parameters==		==Parameters==
	Logging parameters need to be specified from the command line that starts up the signal source module. For more information about command line options, see the [[User_Reference:Module_Command_Line_Options\|Module Command Line Options]] page.		Logging parameters need to be specified from the command line that starts up the signal source module. For more information about command line options, see the [[User_Reference:Module_Command_Line_Options\|Module Command Line Options]] page.

Mellinger at 15:08, 13 February 2026

2026-02-13T15:08:06Z

← Older revision		Revision as of 15:08, 13 February 2026
Line 11:		Line 11:
	Logging input works in both Microsoft Windows, and macOS. On macOS, macOS specific key codes are translated into Windows virtual key codes.		Logging input works in both Microsoft Windows, and macOS. On macOS, macOS specific key codes are translated into Windows virtual key codes.

	On '''Linux''', no system-wide API is available for receiving key press and mouse movement information. Instead, raw input events ~~may~~ be read from <tt>/dev/input/eventX</tt>.		On '''Linux''', no system-wide API is available for receiving key press and mouse movement information. Instead, raw input events need to be read from <tt>/dev/input/eventX</tt>, and translated into virtual key codes by applying a keyboard layout.

	==Parameters==		==Parameters==

Mellinger at 15:01, 13 February 2026

2026-02-13T15:01:06Z

← Older revision		Revision as of 15:01, 13 February 2026
Line 8:		Line 8:

	In Microsoft Windows, keyboard, mouse and joystick devices attached via USB are limited to a polling rate of 125Hz, corresponding to a temporal resolution of 8ms. When better timing resolution is required, you might consider recording into an additional analog channel, or using the amplifier's trigger input when available.		In Microsoft Windows, keyboard, mouse and joystick devices attached via USB are limited to a polling rate of 125Hz, corresponding to a temporal resolution of 8ms. When better timing resolution is required, you might consider recording into an additional analog channel, or using the amplifier's trigger input when available.

			Logging input works in both Microsoft Windows, and macOS. On macOS, macOS specific key codes are translated into Windows virtual key codes.

			On '''Linux''', no system-wide API is available for receiving key press and mouse movement information. Instead, raw input events may be read from <tt>/dev/input/eventX</tt>.

	==Parameters==		==Parameters==

Mellinger: /* See also */

2011-09-21T16:36:14Z

Mellinger: /* Parameters */

2011-09-21T16:35:45Z

Parameters

← Older revision		Revision as of 16:35, 21 September 2011
Line 10:		Line 10:

	==Parameters==		==Parameters==
			Logging parameters need to be specified from the command line that starts up the signal source module. For more information about command line options, see the [[User_Reference:Module_Command_Line_Options\|Module Command Line Options]] page.
	===LogKeyboard===		===LogKeyboard===
	--LogKeyboard=1		--LogKeyboard=1
	When set to 1 from the command line ~~that starts up the signal source module~~, this parameter enables recording of keyboard events into the ''KeyDown'' and ''KeyUp'' state variables.		When set to 1 from the command line, this parameter enables recording of keyboard events into the ''KeyDown'' and ''KeyUp'' state variables.

	===LogMouse===		===LogMouse===
	--LogMouse=1		--LogMouse=1
	When set to 1 from the command line ~~that starts up the signal source module~~, this parameter enables recording of mouse events.		When set to 1 from the command line, this parameter enables recording of mouse events.

	===LogJoystick===		===LogJoystick===
	--LogJoystick=1		--LogJoystick=1
	When set to 1 from the command line ~~that starts up the signal source module~~, this parameter enables recording of joystick state. To select which joystick is used, go to "Control Panel->Game Controllers," and click the "Advanced..." button. The device in the "Preferred device:" drop-down menu will be used in BCI2000.		When set to 1 from the command line, this parameter enables recording of joystick state. To select which joystick is used, go to "Control Panel->Game Controllers," and click the "Advanced..." button. The device in the "Preferred device:" drop-down menu will be used in BCI2000.

	==States==		==States==

Mellinger: /* LogMouse */

2011-09-21T16:33:14Z

LogMouse

← Older revision		Revision as of 16:33, 21 September 2011
Line 16:		Line 16:
	===LogMouse===		===LogMouse===
	--LogMouse=1		--LogMouse=1
	When set to 1 from the command line that starts up the source module, this parameter enables recording of mouse events.		When set to 1 from the command line that starts up the signal source module, this parameter enables recording of mouse events.

	===LogJoystick===		===LogJoystick===

Mellinger: /* LogKeyboard */

2011-09-21T16:33:03Z

LogKeyboard

← Older revision		Revision as of 16:33, 21 September 2011
Line 12:		Line 12:
	===LogKeyboard===		===LogKeyboard===
	--LogKeyboard=1		--LogKeyboard=1
	When set to 1 from the command line that starts up the source module, this parameter enables recording of keyboard events into the ''KeyDown'' and ''KeyUp'' state variables.		When set to 1 from the command line that starts up the signal source module, this parameter enables recording of keyboard events into the ''KeyDown'' and ''KeyUp'' state variables.

	===LogMouse===		===LogMouse===

Mellinger: /* LogJoystick */

2011-09-21T16:32:53Z

LogJoystick

← Older revision		Revision as of 16:32, 21 September 2011
Line 20:		Line 20:
	===LogJoystick===		===LogJoystick===
	--LogJoystick=1		--LogJoystick=1
	When set to 1 from the command line, this parameter enables recording of joystick state. To select which joystick is used, go to "Control Panel->Game Controllers," and click the "Advanced..." button. The device in the "Preferred device:" drop-down menu will be used in BCI2000.		When set to 1 from the command line that starts up the signal source module, this parameter enables recording of joystick state. To select which joystick is used, go to "Control Panel->Game Controllers," and click the "Advanced..." button. The device in the "Preferred device:" drop-down menu will be used in BCI2000.

	==States==		==States==

← Older revision		Revision as of 16:36, 21 September 2011
Line 40:		Line 40:

	==See also==		==See also==
	[[User Reference:KeystrokeFilter]], [[Programming Tutorial:Implementing an Input Logger]]		[[User Reference:KeystrokeFilter]], [[Programming Tutorial:Implementing an Input Logger]], [[User Reference:Module Command Line Options]]

	[[Category:Human Interface Devices]]		[[Category:Human Interface Devices]]