Olimex OpenEEG - Revision history

Admin at 23:18, 24 June 2025

2025-06-24T23:18:28Z

@@ Line 178: / Line 178: @@
 REM sleep is usually easy to identify in the spectrogram, especially within the core of a sleep cycle. REM episodes occur between NREM stages and are marked by a distinctive bow-shaped frequency band around 20–25 Hz near the end of the cycle.
 == References == <!--T:3-->
@@ Line 195: / Line 211: @@
 <ref name="nrem">{{cite web |url=https://neupsykey.com/introduction-to-sleep-and-polysomnography-3/ |title=
 Introduction to Sleep and Polysomnography	 |website=Neupsy Key |access-date=2025-06-22}}</ref>
 }}

Admin at 09:03, 22 June 2025

2025-06-22T09:03:02Z

← Older revision		Revision as of 09:03, 22 June 2025
Line 157:		Line 157:
	[[File:Sample Olimex data.jpg\|thumb\|Sleep stages in Olimex]]		[[File:Sample Olimex data.jpg\|thumb\|Sleep stages in Olimex]]

	Follow the instructions in the section [[https://polysleep.org/wiki/Olimex_OpenEEG#Running_SleepEEGTools_to_mark_sleep\|Running SleepEEGTools to mark sleep]] to launch the SleepEEGTools program and select a recording. This will open the marking window. From there, you can choose a sleep stage and click on different parts of the spectrogram to mark the stages manually. Once you're finished, click Save and Quit to store your annotations.		Follow the instructions in the section [https://polysleep.org/wiki/Olimex_OpenEEG#Running_SleepEEGTools_to_mark_sleep\|Running SleepEEGTools to mark sleep] to launch the SleepEEGTools program and select a recording. This will open the marking window. From there, you can choose a sleep stage and click on different parts of the spectrogram to mark the stages manually. Once you're finished, click Save and Quit to store your annotations.

	If you're unsure about how to mark sleep stages or have atypical recordings, feel free to join our [https://discord.com/invite/2kzXcg7Juf Discord server] and ask for help from experienced community members.		If you're unsure about how to mark sleep stages or have atypical recordings, feel free to join our [https://discord.com/invite/2kzXcg7Juf Discord server] and ask for help from experienced community members.

Admin at 09:02, 22 June 2025

2025-06-22T09:02:19Z

@@ Line 154: / Line 154: @@
 == Sleep stage identification ==
 == References == <!--T:3-->
@@ Line 169: / Line 193: @@
 <ref name="skinprep">{{cite web |url=https://thephysiologist.org/study-materials/electrodes-and-interference/ |title=Electrodes and Skin Prep	 |website=The Student Physiologist |access-date=2025-06-21}}</ref>
 <ref name="openvibedownload">{{cite web |url=https://openvibe.inria.fr/downloads/ |title=OpenViBE Downloads	 |website=OpenViBE |access-date=2025-06-21}}</ref>
 }}

Admin at 19:34, 21 June 2025

2025-06-21T19:34:46Z

← Older revision		Revision as of 19:34, 21 June 2025
Line 67:		Line 67:
	=== Electrode placement solutions ===		=== Electrode placement solutions ===

	~~''Electrode placement picture''~~		[[File:Sleep mask.webp\|thumb\|Sleep mask electrode setup by a polyphasic community member]]

	The electrodes need to remain attached to the head during sleep to record data. There are several ways to keep them in place, some of which are described below.		The electrodes need to remain attached to the head during sleep to record data. There are several ways to keep them in place, some of which are described below.
Line 147:		Line 147:
	Alternatively, you can run <code>python open.py openvibe <file name></code> to open the recording directly and skip the file selection dialog.		Alternatively, you can run <code>python open.py openvibe <file name></code> to open the recording directly and skip the file selection dialog.

	From there, you can manually analyze and mark the sleep stages. Detailed instructions for this process are provided in the [[Olimex_OpenEEG#Sleep_Stage_Identification\|Sleep stage identification]] section.		From there, you can manually analyze and mark the sleep stages. Detailed instructions for this process are provided in the [[Olimex_OpenEEG#Sleep_Stage_Identification\|Sleep stage identification]] section.

	=== MacOS ===		=== MacOS ===

Admin at 19:30, 21 June 2025

2025-06-21T19:30:54Z

← Older revision		Revision as of 19:30, 21 June 2025
Line 143:		Line 143:
	==== Running SleepEEGTools to mark sleep ====		==== Running SleepEEGTools to mark sleep ====

	Navigate to the SleepEEGTools project directory. If you set up a virtual environment in the previous step, activate it by running <code>source venv/bin/activate</code>. Then, run <code>python open.py</code>. This will open a file browser window. Select a recording file to open the sleep marking interface. From there, you can manually analyze and mark the sleep stages. Detailed instructions for this process are provided in the [[Olimex_OpenEEG#Sleep_Stage_Identification\|Sleep stage identification]] section.		Navigate to the SleepEEGTools project directory. If you set up a virtual environment in the previous step, activate it by running <code>source venv/bin/activate</code>. Then, run <code>python open.py</code>. This will open a file browser window. Select a recording file to open the sleep marking interface.

			Alternatively, you can run <code>python open.py openvibe <file name></code> to open the recording directly and skip the file selection dialog.

			From there, you can manually analyze and mark the sleep stages. Detailed instructions for this process are provided in the [[Olimex_OpenEEG#Sleep_Stage_Identification\|Sleep stage identification]] section.

	=== MacOS ===		=== MacOS ===

Admin at 19:00, 21 June 2025

2025-06-21T19:00:58Z

← Older revision		Revision as of 19:00, 21 June 2025
Line 143:		Line 143:
	==== Running SleepEEGTools to mark sleep ====		==== Running SleepEEGTools to mark sleep ====

	Navigate to the SleepEEGTools project directory ~~and~~ run <code>python open.py</code>. This will open a file browser window. Select a recording file to open the sleep marking interface. From there, you can manually analyze and mark the sleep stages. Detailed instructions for this process are provided in the [[Olimex_OpenEEG#Sleep_Stage_Identification\|Sleep stage identification]] section.		Navigate to the SleepEEGTools project directory. If you set up a virtual environment in the previous step, activate it by running <code>source venv/bin/activate</code>. Then, run <code>python open.py</code>. This will open a file browser window. Select a recording file to open the sleep marking interface. From there, you can manually analyze and mark the sleep stages. Detailed instructions for this process are provided in the [[Olimex_OpenEEG#Sleep_Stage_Identification\|Sleep stage identification]] section.

	=== MacOS ===		=== MacOS ===

Admin at 09:37, 21 June 2025

2025-06-21T09:37:39Z

← Older revision		Revision as of 09:37, 21 June 2025
Line 140:		Line 140:

	Run <code>git clone https://github.com/polyphasicdev/SleepEEGTools</code> to clone the SleepEEGTools repository. Then, navigate into the project directory by running <code>cd SleepEEGTools</code>. To set up a virtual environment, run <code>python -m venv venv</code> and <code>source venv/bin/activate</code>. Next, try running the program: <code>python open.py</code>. If it fails due to missing dependencies, install them using <code>pip install <package name></code> (replace <code><package name></code> with the actual missing package listed in the error). Once everything is installed, the program should run correctly. When you're finished, deactivate the environment by running <code>deactivate</code>.		Run <code>git clone https://github.com/polyphasicdev/SleepEEGTools</code> to clone the SleepEEGTools repository. Then, navigate into the project directory by running <code>cd SleepEEGTools</code>. To set up a virtual environment, run <code>python -m venv venv</code> and <code>source venv/bin/activate</code>. Next, try running the program: <code>python open.py</code>. If it fails due to missing dependencies, install them using <code>pip install <package name></code> (replace <code><package name></code> with the actual missing package listed in the error). Once everything is installed, the program should run correctly. When you're finished, deactivate the environment by running <code>deactivate</code>.

			==== Running SleepEEGTools to mark sleep ====

			Navigate to the SleepEEGTools project directory and run <code>python open.py</code>. This will open a file browser window. Select a recording file to open the sleep marking interface. From there, you can manually analyze and mark the sleep stages. Detailed instructions for this process are provided in the [[Olimex_OpenEEG#Sleep_Stage_Identification\|Sleep stage identification]] section.

	=== MacOS ===		=== MacOS ===

Admin at 09:21, 21 June 2025

2025-06-21T09:21:45Z

← Older revision		Revision as of 09:21, 21 June 2025
Line 139:		Line 139:
	==== Installing SleepEEGTools ====		==== Installing SleepEEGTools ====

			Run <code>git clone https://github.com/polyphasicdev/SleepEEGTools</code> to clone the SleepEEGTools repository. Then, navigate into the project directory by running <code>cd SleepEEGTools</code>. To set up a virtual environment, run <code>python -m venv venv</code> and <code>source venv/bin/activate</code>. Next, try running the program: <code>python open.py</code>. If it fails due to missing dependencies, install them using <code>pip install <package name></code> (replace <code><package name></code> with the actual missing package listed in the error). Once everything is installed, the program should run correctly. When you're finished, deactivate the environment by running <code>deactivate</code>.

	=== MacOS ===		=== MacOS ===

Admin at 08:42, 21 June 2025

2025-06-21T08:42:33Z

← Older revision		Revision as of 08:42, 21 June 2025
Line 127:		Line 127:
	==== Running OpenViBE ====		==== Running OpenViBE ====

	To record your sleep, enter the <code>build/</code> directory of OpenViBE and run <code>./bin/openvibe-acquisition-server</code>. In the Acquisition server window, click Connect, then Play.		To record your sleep, enter the <code>build/</code> directory of OpenViBE and run <code>./bin/openvibe-acquisition-server</code>. In the Acquisition server window, click Connect, then Play. Next, use another terminal tab to run <code>./bin/openvibe-designer</code>. In the Designer window, click the Play button to start recording. You should see the signal being captured in real time.

	Next, use another terminal tab to run <code>./bin/openvibe-designer</code>. In the Designer window, click the Play button to start recording. You should see the signal being captured in real time.

	Do not unplug the device while recording, as this may cause the program to hang.		Do not unplug the device while recording, as this may cause the program to hang.

	When you're finished:		When you're finished:
	1. Press Stop in the Designer window.		# Press Stop in the Designer window.
	2. Then press Stop and Disconnect in the Acquisition Server window.		# Then press Stop and Disconnect in the Acquisition Server window.

	After that, you can navigate to the folder you selected earlier to save your recordings. You’ll find the raw sleep data files there.		After that, you can navigate to the folder you selected earlier to save your recordings. You’ll find the raw sleep data files there.

			==== Installing SleepEEGTools ====



	=== MacOS ===		=== MacOS ===

Admin at 08:37, 21 June 2025

2025-06-21T08:37:59Z

← Older revision		Revision as of 08:37, 21 June 2025
Line 103:		Line 103:
	Run <code>sude dmesg -w</code> and plug in your device. This will help you identify the correct port (e.g. ttyUSB0).		Run <code>sude dmesg -w</code> and plug in your device. This will help you identify the correct port (e.g. ttyUSB0).

	Navigate to the <code>build/</code> directory of OpenViBE, then run <code>./bin/openvibe-~~designer~~</code>. Click Driver Properties, set Number of channels to 2, and set Device to the port you identified earlier (e.g. ttyUSB0).		Navigate to the <code>build/</code> directory of OpenViBE, then run <code>./bin/openvibe-acquisition-server</code>. Click Driver Properties, set Number of channels to 2, and set Device to the port you identified earlier (e.g. ttyUSB0).

	You may also want to add your user to the <code>uucp</code> group and reboot to ensure proper permissions (<code>sudo usermod -a -G uucp <username></code>).		You may also want to add your user to the <code>uucp</code> group and reboot to ensure proper permissions (<code>sudo usermod -a -G uucp <username></code>).
Line 127:		Line 127:
	==== Running OpenViBE ====		==== Running OpenViBE ====

	To record your sleep, enter the <code>build/</code> directory of OpenViBE~~. Then,~~ run <code>./bin/openvibe-~~designer~~</code>. ~~Press~~ Connect ~~and~~ Play. ~~Then~~, use another terminal tab to run		To record your sleep, enter the <code>build/</code> directory of OpenViBE and run <code>./bin/openvibe-acquisition-server</code>. In the Acquisition server window, click Connect, then Play.

			Next, use another terminal tab to run <code>./bin/openvibe-designer</code>. In the Designer window, click the Play button to start recording. You should see the signal being captured in real time.

			Do not unplug the device while recording, as this may cause the program to hang.

			When you're finished:
			1. Press Stop in the Designer window.
			2. Then press Stop and Disconnect in the Acquisition Server window.

			After that, you can navigate to the folder you selected earlier to save your recordings. You’ll find the raw sleep data files there.

	=== MacOS ===		=== MacOS ===