BCI2000 Wiki - Recent changes [en]

Technical Reference:Operator Library

Mellinger — Wed, 12 Aug 2026 14:34:44 GMT

BCI_OnQuitRequest( void* refdata, const char** pMsg )

← Older revision		Revision as of 14:34, 12 August 2026
Line 261:		Line 261:

	===BCI_OnQuitRequest( void* refdata, const char** pMsg )===		===BCI_OnQuitRequest( void* refdata, const char** pMsg )===
	This callback is executed when a script executes the QUIT command. ~~You~~ may abort the Quit command by returning a message through the pMsg pointer. Use the <tt>BCI_AllocateString()</tt> function to allocate such an error message.		This callback is executed when a script executes the QUIT command. It is the responsibility of your client program to shutdown the BCI2000 Operator library, and terminate the application. If you choose not to terminate, you may abort the Quit command by returning a message through the pMsg pointer. Use the <tt>BCI_AllocateString()</tt> function to allocate such an error message.

	===BCI_OnNextFilePart( void* refdata, int part )===		===BCI_OnNextFilePart( void* refdata, int part )===

User Reference:Operator Module Scripting

Mellinger — Sun, 09 Aug 2026 16:04:41 GMT

START WEBSOCKET , STOP WEBSOCKET

← Older revision		Revision as of 16:04, 9 August 2026
(One intermediate revision by the same user not shown)
Line 534:		Line 534:
	[[User_Reference:Operator_Notes#Note_storage_and_file_format\|"notes file"]].		[[User_Reference:Operator_Notes#Note_storage_and_file_format\|"notes file"]].

	=====START TELNET <address>, STOP TELNET <address>=====		=====START TELNET [<address>], STOP TELNET [<address>]=====
	Starts or stops a telnet server listening at the given address. The address is in <IP>:<port> format.		Starts or stops a telnet server listening at the given address. The address is in <IP>:<port> format. The default address is 127.0.0.1:3999.

	'''IMPORTANT:''' You should not use this command on global internet addresses, as there is no authentication performed. Only use addresses in the local network, such as 10.x.x.x, 172.x.x.x, or 192.168.x.x.		'''IMPORTANT:''' You should not use this command on global internet addresses, as there is no authentication performed. Only use addresses in the local network, such as 10.x.x.x, 172.x.x.x, or 192.168.x.x.

	=====START WEBSOCKET <address>, STOP WEBSOCKET <address>=====		=====START WEBSOCKET [<address>], STOP WEBSOCKET [<address>]=====
	Starts or stops a websocket server listening at the given address. The address is in <IP>:<port> format.		Starts or stops a websocket server listening at the given address. The address is in <IP>:<port> format. The default address is 127.0.0.1:3998.

	'''IMPORTANT:''' You should not use this command on global internet addresses, as there is no authentication performed. Only use addresses in the local network, such as 10.x.x.x, 172.x.x.x, or 192.168.x.x.		'''IMPORTANT:''' You should not use this command on global internet addresses, as there is no authentication performed. Only use addresses in the local network, such as 10.x.x.x, 172.x.x.x, or 192.168.x.x.

File:Event vs sample time gUSBamp.png

Mellinger — Thu, 30 Jul 2026 12:41:43 GMT

Mellinger uploaded a new version of File:Event vs sample time gUSBamp.png

New page

User Reference:Validating the Event Logging Mechanism

Mellinger — Thu, 30 Jul 2026 12:35:48 GMT

Data recorded with g.USBamp source module

← Older revision		Revision as of 12:35, 30 July 2026
Line 66:		Line 66:
	[[file:Event_vs_SourceTime_gUSBamp.png]]		[[file:Event_vs_SourceTime_gUSBamp.png]]

	Similarly to the ~~SignalSource~~ example above, the Event mechanism is working close to perfectly, with a jitter of +/-0.4 ms (standard deviation).		Similarly to the SignalGenerator example above, the Event mechanism is working close to perfectly with the g.UBSamp amplifier, with a jitter of +/-0.4 ms (standard deviation).

	[[file:Event_vs_sample_time_gUSBamp.png]]		[[file:Event_vs_sample_time_gUSBamp.png]]

Contributions:SecondaryBCI2000Controller

Mellinger — Thu, 30 Jul 2026 12:32:12 GMT

Source Code Revisions

← Older revision		Revision as of 12:32, 30 July 2026
Line 12:		Line 12:
	===Source Code Revisions===		===Source Code Revisions===
	*Initial development: 6819		*Initial development: 6819
	*Tested under: ~~6819~~		*Tested under: 9500
	*Known to compile under: ~~6819~~		*Known to compile under: 9500

	===Known Issues===		===Known Issues===

User Reference:Validating the Event Logging Mechanism

Mellinger — Wed, 29 Jul 2026 15:40:40 GMT

Synopsis

Show changes

User Reference:Contents

Mellinger — Tue, 28 Jul 2026 22:33:33 GMT

← Older revision		Revision as of 22:33, 28 July 2026
(One intermediate revision by the same user not shown)
Line 22:		Line 22:

	*[[User Reference:Parameter Changes for Version 2]] helps in migrating experiments from BCI2000 version 1 to version 2.		*[[User Reference:Parameter Changes for Version 2]] helps in migrating experiments from BCI2000 version 1 to version 2.

			==Verifying the Online System==
			*[[User Reference:Validating the Event Logging Mechanism]]: A description and validation instructions for BCI2000 events.
			*[[User Reference:BCI2000Certification]]: Measure a BCI2000 system's timing performance.

	==Using BCI2000 Tools==		==Using BCI2000 Tools==
	*[[User Reference:BCI2000Certification]]: Measure a BCI2000 system's timing performance.
	*[[User Reference:BCI2000Launcher]]: Conveniently start up BCI2000 modules from a graphical interface.		*[[User Reference:BCI2000Launcher]]: Conveniently start up BCI2000 modules from a graphical interface.
	*[[User Reference:BCI2000Watchdog]]: A tool to start up and monitor BCI2000 for long-term recordings.		*[[User Reference:BCI2000Watchdog]]: A tool to start up and monitor BCI2000 for long-term recordings.

User Reference:Validating the Event Logging Mechanism

Mellinger — Tue, 28 Jul 2026 22:28:09 GMT

Matlab Analysis Script

Show changes

File:Event vs sample time gUSBamp.png

Mellinger — Tue, 28 Jul 2026 21:48:28 GMT

Mellinger uploaded File:Event vs sample time gUSBamp.png

New page

File:Event vs SourceTime gUSBamp.png

Mellinger — Tue, 28 Jul 2026 21:48:13 GMT

Mellinger uploaded File:Event vs SourceTime gUSBamp.png

New page

File:Event vs sample time SignalGenerator.png

Mellinger — Tue, 28 Jul 2026 21:46:27 GMT

Mellinger uploaded File:Event vs sample time SignalGenerator.png

New page

File:Event vs SourceTime SignalGenerator.png

Mellinger — Tue, 28 Jul 2026 21:44:40 GMT

Mellinger uploaded File:Event vs SourceTime SignalGenerator.png

New page

User Reference:Validating the Event Logging Mechanism

Mellinger — Tue, 28 Jul 2026 21:42:32 GMT

Analyzing RefLogger Data

@@ Line 4: / Line 4: @@
 This page provides an overview over the general concept and implementation of events.
-Also, it describes the RefLogger, which allows to quantify how reliable event recording is, and shows a simple Matlab script to analyze RefLogger data, together with results from a reference system.
+Also, it describes the ''RefLogger'', which allows to quantify how reliable event recording is, and shows a simple Matlab script to analyze ''RefLogger'' data, together with results from a reference system.
 ==The Event Logging Mechanism==
 As described elsewhere, BCI2000 processes brain signal data in blocks of fixed size and duration.
 Whenever a block of data has been acquired from the main brain signal source, a time stamp is taken from the computer's clock.
@@ Line 12: / Line 13: @@
 Assuming a negligible time delay between sampling of the block's last sample, and transmission into the computer, we can say that this time stamp represents the time of sampling for the first sample of the following block.
 Knowing this time stamp, and the sampling rate of the brain signal source, we can thus associate each of the block's samples with a sample time.

User Reference:Validating the Event Logging Mechanism

Mellinger — Tue, 28 Jul 2026 15:57:28 GMT

Created page with "==Synopsis== BCI2000 is able to record asynchronous data, so called Events, that occur during a recording. These events are logged into BCI2000 states, which provide a universal way to store information associated with brain signal sample data. This page provides an overview over the general concept and implementation of events. Also, it describes the RefLogger, which allows to quantify how reliable event recording is, and shows a simple Matlab script to analyze RefLog..."

New page

==Synopsis==
BCI2000 is able to record asynchronous data, so called Events, that occur during a recording. These events are logged into BCI2000 states, which provide a universal way to store information associated with brain signal sample data.

This page provides an overview over the general concept and implementation of events.

Also, it describes the RefLogger, which allows to quantify how reliable event recording is, and shows a simple Matlab script to analyze RefLogger data, together with results from a reference system.

==The Event Logging Mechanism==
As described elsewhere, BCI2000 processes brain signal data in blocks of fixed size and duration.
Whenever a block of data has been acquired from the main brain signal source, a time stamp is taken from the computer's clock.
Note that this time stamp is taken after the data block has been sampled and transmitted from the hardware.
Assuming a negligible time delay between sampling of the block's last sample, and transmission into the computer, we can say that this time stamp represents the time of sampling for the first sample of the following block.
Knowing this time stamp, and the sampling rate of the brain signal source, we can thus associate each of the block's samples with a sample time.

Contributions:NeusenW4

Mellinger — Mon, 27 Jul 2026 07:38:03 GMT

← Older revision		Revision as of 07:38, 27 July 2026
Line 76:		Line 76:
	If set to "auto", and only a single NeusenW amplifier is available, that will be chosen.		If set to "auto", and only a single NeusenW amplifier is available, that will be chosen.
	If set to "auto" with more than one NeusenW amplifiers available, an error message will be issued.		If set to "auto" with more than one NeusenW amplifiers available, an error message will be issued.

			==See also==
			[[User Reference:DataIOFilter]], [[Programming Reference:GenericADC Class]]
			[[Category:Filters]][[Category:Data Acquisition]]