User Tutorial:BCI2000Unity OUTDATED - Revision history

Tytbutler: Tytbutler moved page User Tutorial:BCI2000Unity to User Tutorial:BCI2000Unity OUTDATED

2024-05-29T19:43:03Z

Tytbutler moved page User Tutorial:BCI2000Unity to User Tutorial:BCI2000Unity OUTDATED

← Older revision		Revision as of 19:43, 29 May 2024
(No difference)

Swiftj: /* Using BCI2000 Control Signal */

2024-04-22T20:49:16Z

Using BCI2000 Control Signal

← Older revision		Revision as of 20:49, 22 April 2024
Line 133:		Line 133:
	bci.GetSignal("ChannelNumber",1);		bci.GetSignal("ChannelNumber",1);
	</tt>		</tt>

			[[File:UnityGetSignal.png\|500px\|alt="Unity Get Signal"\|Unity Get Signal]]

	==See also==		==See also==

	[[Category:Tutorial]]		[[Category:Tutorial]]

Swiftj: /* Tutorial */

2024-04-22T20:31:48Z

Tutorial

← Older revision		Revision as of 20:31, 22 April 2024
Line 13:		Line 13:


	This tutorial will walk through an example cursor control task, making use of the mouse position recorded from BCI2000 to control the cursor position in Unity. First, download UnityBCI2000 from this [https://github.com/neurotechcenter/UnityBCI2000 GitHub] page and download the tutorial project from this [https://github.com/neurotechcenter/ExperimentalDesignDemos GitHub] page ~~(MWE_UnityBCI2000CursorDemo)~~. Copy the UnityBCI2000.cs and BCI2000RemoteNET.dll files into the Assets folder of your Unity project.		This tutorial will walk through an example cursor control task, making use of the mouse position recorded from BCI2000 to control the cursor position in Unity. First, download UnityBCI2000 from this [https://github.com/neurotechcenter/UnityBCI2000 GitHub] page and download the MWE_UnityBCI2000CursorDemo tutorial project from this [https://github.com/neurotechcenter/ExperimentalDesignDemos GitHub] page. Copy the UnityBCI2000.cs and BCI2000RemoteNET.dll files into the Assets folder of your Unity project.

			[[File:UnityMoveAssets.png\|500px\|alt="Unity Move Assets"\|Unity Move Assets]]

	===Connect to an Instance of BCI2000===		===Connect to an Instance of BCI2000===
Line 20:		Line 22:

	1. Create a BCI2000 GameObject.		1. Create a BCI2000 GameObject.

			[[File:UnityBCI2000GameObject.png\|600px\|alt="Unity BCI2000 Game Object"\|Unity BCI2000 Game Object]]

	2. Add UnityBCI2000.cs to the GameObject as a Script Component.		2. Add UnityBCI2000.cs to the GameObject as a Script Component.

			[[File:UnityBCI2000ScriptComponent.png\|600px\|alt="Unity BCI2000 Script Component"\|Unity BCI2000 Script Component]]

	3. Use the Operator Path field to specify the path to the BCI2000 Operator.exe (usually in the C:/bci2000/prog/ directory). If you already have an instance of the operator running, use the Telnet IP and Telnet Port fields to specify the IP and port it is listening on instead.		3. Use the Operator Path field to specify the path to the BCI2000 Operator.exe (usually in the C:/bci2000/prog/ directory). If you already have an instance of the operator running, use the Telnet IP and Telnet Port fields to specify the IP and port it is listening on instead.
Line 31:		Line 37:
	</tt>		</tt>

	5. Specify the name of the log file to store the BCI2000 system log. '''NOTE: There is a known issue with writing to the log file, this is remedied by changing the name of the file to write to. This is an issue with BCI2000RemoteNET, and will be fixed in upcoming updates.'''		5. Specify the name of the log file to store the BCI2000 system log. '''NOTE: There is a known issue with writing to the log file; this is remedied by changing the name of the file to which to write. This is an issue with BCI2000RemoteNET and will be fixed in upcoming updates.'''

			[[File:UnityBCI2000Modules.png\|400px\|alt="Unity BCI2000 Modules"\|Unity BCI2000 Modules]]

	===Save Unity Events in BCI2000===		===Save Unity Events in BCI2000===
Line 37:		Line 45:
	Next, we will modify a script to create new BCI2000 events and send event change information to BCI2000.		Next, we will modify a script to create new BCI2000 events and send event change information to BCI2000.

	1. Open the TargetControl script (or any script you would like to send information to BCI2000 ~~from~~).		1. Open the TargetControl script (or any script from which you would like to send information to BCI2000).

	2. In the class definition, instantiate BCI2000 with		2. In the class definition, instantiate BCI2000 with
Line 68:		Line 76:
	bci.ExecuteCommand("Set variable LogLevel 0");		bci.ExecuteCommand("Set variable LogLevel 0");
	</tt>		</tt>

			[[File:UnityTargetControlScript.png\|500px\|alt="Unity Target Control Script"\|Unity Target Control Script]]

	7. Update the event value according to some change in the experiment using the bci.SetEvent() function in the Update() function. For example, change a target hit event "t1hit" to 1 every time a target is hit by a cursor. Note that events must be set as unsigned integers.		7. Update the event value according to some change in the experiment using the bci.SetEvent() function in the Update() function. For example, change a target hit event "t1hit" to 1 every time a target is hit by a cursor. Note that events must be set as unsigned integers.
Line 74:		Line 84:
	bci.SetEvent("t1hit",(int)(1));		bci.SetEvent("t1hit",(int)(1));
	</tt>		</tt>

			[[File:UnitySetEvent.png\|400px\|alt="Unity Set Event"\|Unity Set Event]]

	===Access BCI2000 Events for Control===		===Access BCI2000 Events for Control===

	We can also get event information from BCI2000 to use ~~in Unity~~. For example, you may want to control the Unity cursor position with a BCI2000 event, such as the mouse position. This example makes use of a BallMouseControl.cs script.		We can also get event information from BCI2000 for Unity use. For example, you may want to control the Unity cursor position with a BCI2000 event, such as the mouse position. This example makes use of a BallMouseControl.cs script.

	First you will need to instantiate BCI2000 and set the BCI2000 reference as in the TargetControl.cs script		First you will need to instantiate BCI2000 and set the BCI2000 reference as in the TargetControl.cs script
Line 94:		Line 106:
	bci = GameObject.Find("BCI2000").GetComponent<UnityBCI2000>();		bci = GameObject.Find("BCI2000").GetComponent<UnityBCI2000>();
	</tt>		</tt>

			[[File:UnityBallMouseControlScript.png\|400px\|alt="Unity Ball Mouse Control Script"\|Unity Ball Mouse Control Script]]

	4. Get the value of the BCI2000 event using the bci.GetEvent() function and store the result in some variable		4. Get the value of the BCI2000 event using the bci.GetEvent() function and store the result in some variable
Line 103:		Line 117:

	This value can then be used in Unity to influence the game activity.		This value can then be used in Unity to influence the game activity.

			[[File:UnityGetEvent.png\|400px\|alt="Unity Get Event"\|Unity Get Event]]

	===Compile===		===Compile===

Swiftj: /* Tutorial */

2024-04-19T20:44:19Z

Tutorial

← Older revision		Revision as of 20:44, 19 April 2024
Line 13:		Line 13:


	This tutorial will walk through an example cursor control task, making use of the mouse position recorded from BCI2000 to control the cursor position in Unity. First, download UnityBCI2000 from [https://github.com/neurotechcenter/UnityBCI2000 GitHub] and download the tutorial project from ~~'''~~(~~INSERT TUTORIAL PROJECT LINK HERE~~)~~'''~~. Copy the UnityBCI2000.cs and BCI2000RemoteNET.dll files into the Assets folder of your Unity project.		This tutorial will walk through an example cursor control task, making use of the mouse position recorded from BCI2000 to control the cursor position in Unity. First, download UnityBCI2000 from this [https://github.com/neurotechcenter/UnityBCI2000 GitHub] page and download the tutorial project from this [https://github.com/neurotechcenter/ExperimentalDesignDemos GitHub] page (MWE_UnityBCI2000CursorDemo). Copy the UnityBCI2000.cs and BCI2000RemoteNET.dll files into the Assets folder of your Unity project.

	===Connect to an Instance of BCI2000===		===Connect to an Instance of BCI2000===

Swiftj: /* Using BCI2000 Control Signal */

2024-04-19T19:30:32Z

Using BCI2000 Control Signal

← Older revision		Revision as of 19:30, 19 April 2024
Line 111:		Line 111:

	The above example makes use of the BCI2000 Mouse Position events to control the Unity cursor position. However, the BCI2000 control signal can also be used in Unity. This is particularly useful for online experiments (for example, a neurofeedback task to move a cursor on the screen based on the decoded alpha power). In the demo script, navigate to the CursorTaskSignal Scene to see how the BCI2000 control signal can be utilized in Unity. Note that this only seems to work when the scene has been compiled!		The above example makes use of the BCI2000 Mouse Position events to control the Unity cursor position. However, the BCI2000 control signal can also be used in Unity. This is particularly useful for online experiments (for example, a neurofeedback task to move a cursor on the screen based on the decoded alpha power). In the demo script, navigate to the CursorTaskSignal Scene to see how the BCI2000 control signal can be utilized in Unity. Note that this only seems to work when the scene has been compiled!

			Access the control signal using the function

			<tt>
			bci.GetSignal("ChannelNumber",1);
			</tt>

	==See also==		==See also==

	[[Category:Tutorial]]		[[Category:Tutorial]]

Swiftj: /* Video */

2024-04-19T19:25:10Z

Video

← Older revision		Revision as of 19:25, 19 April 2024
Line 3:		Line 3:

	==Video==		==Video==
			This video is currently out of date. An updated video is coming soon!

	<youtube alignment="center">https://www.youtube.com/watch?v=nZG70HSR8v8</youtube>		<youtube alignment="center">https://www.youtube.com/watch?v=nZG70HSR8v8</youtube>

Swiftj: /* See also */

2024-04-19T19:24:38Z

Swiftj: /* Tutorial */

2024-04-19T19:24:07Z

Tutorial

Show changes

Emilycohen: /* Video */

2022-04-21T17:42:43Z

Video

← Older revision		Revision as of 17:42, 21 April 2022
Line 3:		Line 3:

	==Video==		==Video==
	~~PLACEHOLDER VIDEO~~		<youtube alignment="center">https://www.youtube.com/watch?v=nZG70HSR8v8</youtube>
	<youtube alignment="center">https://~~youtu~~.be/~~uLK3yl5MNu0~~</youtube>

	==Tutorial==		==Tutorial==

Nluczak: /* Video */

2021-10-10T23:19:06Z

Video

← Older revision		Revision as of 23:19, 10 October 2021
Line 3:		Line 3:

	==Video==		==Video==
			PLACEHOLDER VIDEO
	<youtube alignment="center">https://youtu.be/uLK3yl5MNu0</youtube>		<youtube alignment="center">https://youtu.be/uLK3yl5MNu0</youtube>

← Older revision		Revision as of 19:24, 19 April 2024
Line 111:		Line 111:

	==See also==		==See also==
	~~Also see the [https://bci2000.org/mediawiki/index.php/BCPy2000 BCPy2000] page for more details on the installation process, APIs, and hooks.~~

	~~[[Contributions:BCPy2000]]~~

	[[Category:Tutorial]]		[[Category:Tutorial]]