Contributions:CommunicationTask - Revision history

Lingling: /* States */

2025-10-10T16:20:59Z

States

← Older revision		Revision as of 16:20, 10 October 2025
Line 187:		Line 187:
	==States==		==States==
	Shared states are converted to BCI2000 states asynchronously through events using the HyperscanningApplicationBase class. We declared shared states in the batch file as "--SharedStates=state1_name,state1_size&state2_name,state2_size&...", which is appended to the end of the application module.		Shared states are converted to BCI2000 states asynchronously through events using the HyperscanningApplicationBase class. We declared shared states in the batch file as "--SharedStates=state1_name,state1_size&state2_name,state2_size&...", which is appended to the end of the application module.

			===TrialStart===
			The onset time of the beginning of trial

	===PhaseNumber===		===PhaseNumber===

Lingling: /* Local Parameters */

2025-10-09T20:42:21Z

Local Parameters

← Older revision		Revision as of 20:42, 9 October 2025
Line 115:		Line 115:

	===Local Parameters===		===Local Parameters===

			====PreTrialFlash====
			Have the patch on the left bottom corner of the screen only flash before the trial starts:<br/>
			- The square is white by default<br/>
			- 500 ms before trial start, the square switches to black<br/>
			- At trial start, the square switches back to white and stays white until next trial<br/>

	====StimuliWidth====		====StimuliWidth====

Lingling: /* Deploy the Server */

2025-04-29T20:12:39Z

Deploy the Server

← Older revision		Revision as of 20:12, 29 April 2025
Line 37:		Line 37:

	4. Pull the code from GitHub.<br>		4. Pull the code from GitHub.<br>
	<pre>git clone https://github.com/~~MaxwellMarcus~~/hyperscanning-backend</pre>		<pre>git clone https://github.com/neurotechcenter/hyperscanning-backend</pre>

	5. Navigate to the server directory:<br>		5. Navigate to the server directory:<br>

Lingling: /* TrialNumber */

2025-04-24T16:26:20Z

TrialNumber

← Older revision		Revision as of 16:26, 24 April 2025
Line 194:		Line 194:
	===TrialNumber===		===TrialNumber===
	Index of trials. (8 bits)		Index of trials. (8 bits)

			===StimulusCode===
			The stimulus ID

			===Photodiode===
			The photodiode state. 1: flash, 0: no flash

			===SampleBlockCounter===
			Count the block number in one phase

	===BarOneValue===		===BarOneValue===

Lingling: /* Deploy the Server */

2025-04-23T16:39:06Z

Deploy the Server

← Older revision		Revision as of 16:39, 23 April 2025
Line 27:		Line 27:
	===Deploy the Server===		===Deploy the Server===
	To run the server, you’ll need a Linux or macOS machine—Windows is not supported at this time. The steps below walk you through deploying the server on AWS.<br>		To run the server, you’ll need a Linux or macOS machine—Windows is not supported at this time. The steps below walk you through deploying the server on AWS.<br>
	1. Prepare the ~~SSH~~ key.<br>		1. Prepare the AWS key.<br>

	2. In your terminal or shell, run<br>		2. In your terminal or shell, run<br>

Lingling: /* Deploy the Server */

2025-04-23T15:16:16Z

Deploy the Server

← Older revision		Revision as of 15:16, 23 April 2025
Line 26:		Line 26:
	==Set up==		==Set up==
	===Deploy the Server===		===Deploy the Server===
	~~You will~~ need a Linux or macOS ~~computer to run the server. Currently, the Windows OS~~ is not supported. The ~~following~~ steps ~~outline the process for~~ deploying the server on AWS.<br>		To run the server, you’ll need a Linux or macOS machine—Windows is not supported at this time. The steps below walk you through deploying the server on AWS.<br>
	1. Prepare the SSH key.<br>		1. Prepare the SSH key.<br>

Lingling: /* Versioning */

2025-04-23T15:11:57Z

Versioning

← Older revision		Revision as of 15:11, 23 April 2025
Line 22:		Line 22:
	===Authors===		===Authors===
	Anais Llorens (anaisllorens@hotmail.com) and Athina Tzovara (athina.tzovara@unibe.ch) conceived this paradigm. <br>		Anais Llorens (anaisllorens@hotmail.com) and Athina Tzovara (athina.tzovara@unibe.ch) conceived this paradigm. <br>
	~~Max Marcus (bigmaxmarcus@gmail.com),~~ Huiling Huang (huiling@neurotechcenter.org), and Sigurd Alnes (sigurd.alnes@unibe.ch) implemented the paradigm into BCI2000. <br>		Huiling Huang (huiling@neurotechcenter.org), Max Marcus (bigmaxmarcus@gmail.com) and Sigurd Alnes (sigurd.alnes@unibe.ch) implemented the paradigm into BCI2000. <br>

	==Set up==		==Set up==

Lingling: /* Deploy the Server */

2025-04-23T15:11:15Z

Deploy the Server

← Older revision		Revision as of 15:11, 23 April 2025
Line 26:		Line 26:
	==Set up==		==Set up==
	===Deploy the Server===		===Deploy the Server===
	You will need a Linux or macOS computer to run the server. Currently, the Windows OS is not supported. The following steps ~~are~~ for deploying ~~the server on the local network. If you want to deploy~~ the server on AWS~~, please refer to https://www~~.~~bci2000~~.~~org/mediawiki/index.php/BCI2000_Hyperscanning#Important_Notes_2~~.<br>		You will need a Linux or macOS computer to run the server. Currently, the Windows OS is not supported. The following steps outline the process for deploying the server on AWS.<br>
	~~First, please ensure all the computers are connected to the same local network~~. ~~Then open the~~ terminal~~(Mac OS~~ or ~~Linux) and~~ run the ~~command below~~ to ~~clone~~ the server code from GitHub.		1. Prepare the SSH key.<br>

			2. In your terminal or shell, run<br>
			<pre> chmod 400 <key_path> </pre>
			to make the key file read-only for the owner.<br>

			3. Connect to the AWS server using SSH:<br>
			<pre> ssh -i <key path> <user-name>@<ip-address> </pre>

			4. Pull the code from GitHub.<br>
	<pre>git clone https://github.com/MaxwellMarcus/hyperscanning-backend</pre>		<pre>git clone https://github.com/MaxwellMarcus/hyperscanning-backend</pre>
	Go the ~~hyperscanning~~ directory
	<pre>cd hyperscanning</pre>		5. Navigate to the server directory:<br>
	~~Compile~~ the project by		<pre>cd hyperscanning-backend</pre>

			6. To compile the project, run:
	<pre>make -B</pre>		<pre>make -B</pre>
	<gallery mode="packed" widths=600px heights=350px>		<gallery mode="packed" widths=600px heights=350px>
	File:CommunicationTask server set up.png\|Figure 3: Download and Compile the Server.		File:CommunicationTask server set up.png\|Figure 3: Download and Compile the Server.
	</gallery>		</gallery>
	~~Run~~ the server ~~with~~
			5. Launch the server by running:<br>
	<pre>./application</pre>		<pre>./application</pre>
	<gallery mode="packed" widths=600px heights=100px>		<gallery mode="packed" widths=600px heights=100px>
	File:CommunicationTask_server_launched.png\|Figure 4: Launch the Server.		File:CommunicationTask_server_launched.png\|Figure 4: Launch the Server.
	</gallery>		</gallery>
	The application ~~will only run as long as the experiment and will have to~~ be restarted.		The application must be restarted after BCI2000 has been closed.
			<br>

	===Batch File===		===Batch File===

Lingling: /* Timeline */

2025-01-28T22:12:31Z

Timeline

← Older revision		Revision as of 22:12, 28 January 2025
Line 3:		Line 3:

	The two clients exchange information through the hyperScanning backend, which uses a client-server model to share the states. Each client has a separate state machine. The server only forwards the information between two clients. Shared states are converted to BCI2000 states asynchronously through events using the HyperscanningApplicationBase class, which is the parent class of the application module. For more information, please refer to the hyperScanning framework wiki page: https://www.bci2000.org/mediawiki/index.php/BCI2000_Hyperscanning.		The two clients exchange information through the hyperScanning backend, which uses a client-server model to share the states. Each client has a separate state machine. The server only forwards the information between two clients. Shared states are converted to BCI2000 states asynchronously through events using the HyperscanningApplicationBase class, which is the parent class of the application module. For more information, please refer to the hyperScanning framework wiki page: https://www.bci2000.org/mediawiki/index.php/BCI2000_Hyperscanning.

			==Video Overview==
			<br>
			<youtube alignment="center">https://youtu.be/I1sSamSsTK4</youtube>
			<br>

	==Timeline==		==Timeline==

Lingling: /* Authors */

2024-03-28T21:13:20Z

Authors

← Older revision		Revision as of 21:13, 28 March 2024
Line 16:		Line 16:
	==Versioning==		==Versioning==
	===Authors===		===Authors===
	~~Huiling Huang~~ (~~huiling~~@~~neurotechcenter~~.~~org~~)<br>		Anais Llorens (anaisllorens@hotmail.com) and Athina Tzovara (athina.tzovara@unibe.ch) conceived this paradigm. <br>
	Max Marcus (bigmaxmarcus@gmail.com)		Max Marcus (bigmaxmarcus@gmail.com), Huiling Huang (huiling@neurotechcenter.org), and Sigurd Alnes (sigurd.alnes@unibe.ch) implemented the paradigm into BCI2000. <br>

	==Set up==		==Set up==