Contributions:RippleADC - Revision history

Nluczak at 00:33, 20 December 2025

2025-12-20T00:33:38Z

← Older revision		Revision as of 00:33, 20 December 2025
Line 10:		Line 10:
	===Authors===		===Authors===
	* Nicholas Luczak (luczak@neurotechcenter org)		* Nicholas Luczak (luczak@neurotechcenter org)

			* Luciano Branco (lrfbranco@gmail com)

	===Version History===		===Version History===
Line 17:		Line 19:

	===Source Code Revisions===		===Source Code Revisions===
	* Initial development: ~~XXXX~~		* Initial development: 8600
	* Tested under: ~~XXXX~~		* Tested under: 9072
	* Known to compile under: ~~XXXX~~		* Known to compile under: 9072
	* Broken since: --		* Broken since: --
	==Dependencies==		==Dependencies==

Nluczak at 15:42, 9 December 2025

2025-12-09T15:42:21Z

← Older revision		Revision as of 15:42, 9 December 2025
Line 21:		Line 21:
	* Known to compile under: XXXX		* Known to compile under: XXXX
	* Broken since: --		* Broken since: --
			==Dependencies==
			Other than BCI2000, all you should need is the [https://rippleneuro.com/trellis-eeg-software/ Trellis software that comes with your Ripple device]
	==Source Parameters==		==Source Parameters==
	These parameters can be found in the "Source" tab of the BCI2000 config window.		These parameters can be found in the "Source" tab of the BCI2000 config window.
Line 112:		Line 113:
	===StimulationTriggers===		===StimulationTriggers===
	This parameter defines when stimulation is applied, what pulse is used, how many pulses are applied, and the source and destination locations of the stimulation. These parameters are defined in the rows of this matrix with labels		This parameter defines when stimulation is applied, what pulse is used, how many pulses are applied, and the source and destination locations of the stimulation. These parameters are defined in the rows of this matrix with labels
			====Triggers====
			This must be a [https://www.bci2000.org/mediawiki/index.php/User_Reference:Expression_Syntax BCI2000 expression]. When this expression evaluates true during the run, the stimulation is applied.


	==Device Parameters==		==Device Parameters==
Line 178:		Line 182:
	[[File:RippleControlPanel.png\|800px\|thumb\|center\|Image of example monophasic waveform]]		[[File:RippleControlPanel.png\|800px\|thumb\|center\|Image of example monophasic waveform]]

			====Ripple GUI Configuration Files====
			In order to easily configure and save complex stimulation parameters within the Matlab GUI tool, a CSV can be used to save and load desired stimulation parameters. You can find different example files [https://wustl.box.com/s/hl25jzr4ay5chhfmsw3g8ud219jn8m1l here.]
			[[File:RippleCSV.png\|800px\|thumb\|center\|Image of an example CSV file for monophasic stimulation]]
	==See also==		==See also==
	[[User Reference:Filters]], [[Contributions:ADCs]]		[[User Reference:Filters]], [[Contributions:ADCs]]
	[[Category:Contributions]][[Category:Data Acquisition]]		[[Category:Contributions]][[Category:Data Acquisition]]

Nluczak: /* Native BCI2000 */

2025-12-05T20:21:48Z

Native BCI2000

← Older revision		Revision as of 20:21, 5 December 2025
Line 167:		Line 167:
	A step by step tutorial with screenshots can be found here:		A step by step tutorial with screenshots can be found here:
	[https://scribehow.com/viewer/Macro_Raw__DSjk-3QJRxe7EQVS8cSx4A Stimulation instructions]		[https://scribehow.com/viewer/Macro_Raw__DSjk-3QJRxe7EQVS8cSx4A Stimulation instructions]
	===Matlab GUI tool==-		===Matlab GUI tool===
	This tool, developed by Luciano Branco at the Mayo Clinic is a much more advanced tool for driving stimulation which allows you to inspect your stimulation trains visually and also drive stimulation. The parameters for stimulation are identical to those within BCI2000		This tool, developed by Luciano Branco at the Mayo Clinic is a much more advanced tool for driving stimulation which allows you to inspect your stimulation trains visually and also drive stimulation. The parameters for stimulation are identical to those within BCI2000

	[[File:~~RippleGUISettings~~.png\|800px\|thumb\|center\|Image of settings possible to configure Ripple cnelStim tool]]		[[File:RippleStimulationParameters.png\|800px\|thumb\|center\|Image of settings possible to configure Ripple cnelStim tool]]

	After configuring your various stimulation configurations you can inspect each train of stimulations.		After configuring your various stimulation configurations you can inspect each train of stimulations.
Line 177:		Line 177:
	Once you are happy with your different waveforms and have confirmed that they are appropriate you can proceed to the Control Panel which allows you to define if you want to do bipolar stimulation, whether you want to drive stimulation from the cathode first, and other extra features. Once you are happy with the configuration and you have BCI2000 running you're ready to start stimulation. You can either drive the cnelStim tool by simply clicking the "Start Stimulation" button, or you can configure it to drive stimulation using a BCI2000 state which is pulled from BCI2000 using BCI2000Remote.		Once you are happy with your different waveforms and have confirmed that they are appropriate you can proceed to the Control Panel which allows you to define if you want to do bipolar stimulation, whether you want to drive stimulation from the cathode first, and other extra features. Once you are happy with the configuration and you have BCI2000 running you're ready to start stimulation. You can either drive the cnelStim tool by simply clicking the "Start Stimulation" button, or you can configure it to drive stimulation using a BCI2000 state which is pulled from BCI2000 using BCI2000Remote.
	[[File:RippleControlPanel.png\|800px\|thumb\|center\|Image of example monophasic waveform]]		[[File:RippleControlPanel.png\|800px\|thumb\|center\|Image of example monophasic waveform]]

	==See also==		==See also==
	[[User Reference:Filters]], [[Contributions:ADCs]]		[[User Reference:Filters]], [[Contributions:ADCs]]
	[[Category:Contributions]][[Category:Data Acquisition]]		[[Category:Contributions]][[Category:Data Acquisition]]

Nluczak at 20:20, 5 December 2025

2025-12-05T20:20:31Z

← Older revision		Revision as of 20:20, 5 December 2025
Line 155:		Line 155:

	[[File:RippleStimulationWaveform.png\|800px\|thumb\|center\|Figure 3. Example monophasic stimulation waveform]]		[[File:RippleStimulationWaveform.png\|800px\|thumb\|center\|Figure 3. Example monophasic stimulation waveform]]



	===Network Protocol===		===Network Protocol===
	The module uses Ripple's xipplib library to communicate with the Grapevine processor over TCP/IP. All data is transmitted in real-time with timestamps for synchronization.		The module uses Ripple's xipplib library to communicate with the Grapevine processor over TCP/IP. All data is transmitted in real-time with timestamps for synchronization.

			==Stimulation How-to==
			We have implemented and are distributing two different methods of stimulation through the Ripple device. One is a native implementation within BCI2000. The more capable method of driving stimulation is through a tool made using Matlab. This tool was created by Luciano Branco at the Mayo Clinic. This tool is distributed with BCI2000 and should be accessible through our SVN under src/contrib/SignalSource/RippleADC/cnel_stim. The tool allows you to create a wide range of stimulation configurations while visualising it and driving the stimulation in tandem with BCI2000 so that all of the relevant information is recorded.
			===Native BCI2000===
			In order to use stimulation through BCI2000, you simply need to go into the configuration window after launching a batch file with the RippleADC as your source. There, all you need to do is go to the Source tab, then scroll down until you see the stimulation section, then click the checkbox to enable stimulation and configure your stimulation parameters. These stimulation parameters will allow you to specify step size, frequency, amplitude, duration, burst length, interburst length, pulse width, interpulse width, and the gap until the next stimulation (if you're setting things up for multiple blocks of stimulation). The final relevant parameter is the StimulationTriggers parameter which allows you to define a trigger for your different configured stimulation patterns. For example, one could use a state such as stimulusCode to trigger stimulation based on when a stimulus is presented, or one could use some signal as a threshold for stimulation.
			A step by step tutorial with screenshots can be found here:
			[https://scribehow.com/viewer/Macro_Raw__DSjk-3QJRxe7EQVS8cSx4A Stimulation instructions]
			===Matlab GUI tool==-
			This tool, developed by Luciano Branco at the Mayo Clinic is a much more advanced tool for driving stimulation which allows you to inspect your stimulation trains visually and also drive stimulation. The parameters for stimulation are identical to those within BCI2000

			[[File:RippleGUISettings.png\|800px\|thumb\|center\|Image of settings possible to configure Ripple cnelStim tool]]

			After configuring your various stimulation configurations you can inspect each train of stimulations.
			[[File:RippleStimulationWaveform.png\|800px\|thumb\|center\|Image of example monophasic waveform]]

			Once you are happy with your different waveforms and have confirmed that they are appropriate you can proceed to the Control Panel which allows you to define if you want to do bipolar stimulation, whether you want to drive stimulation from the cathode first, and other extra features. Once you are happy with the configuration and you have BCI2000 running you're ready to start stimulation. You can either drive the cnelStim tool by simply clicking the "Start Stimulation" button, or you can configure it to drive stimulation using a BCI2000 state which is pulled from BCI2000 using BCI2000Remote.
			[[File:RippleControlPanel.png\|800px\|thumb\|center\|Image of example monophasic waveform]]
	==See also==		==See also==
	[[User Reference:Filters]], [[Contributions:ADCs]]		[[User Reference:Filters]], [[Contributions:ADCs]]
	[[Category:Contributions]][[Category:Data Acquisition]]		[[Category:Contributions]][[Category:Data Acquisition]]

Nluczak: /* Version History */

2025-11-18T03:35:08Z

Version History

← Older revision		Revision as of 03:35, 18 November 2025
Line 14:		Line 14:
	* 04/29/2025 - Initial version		* 04/29/2025 - Initial version
	* 06/10/2025 - Added stimulation support		* 06/10/2025 - Added stimulation support
			* 11/15/2025 - Added Luciano's Tool, added new important states, and improved Stimulation matrix configuration

	===Source Code Revisions===		===Source Code Revisions===

Nluczak: /* Stimulation Parameters */

2025-11-15T06:34:39Z

Stimulation Parameters

← Older revision		Revision as of 06:34, 15 November 2025
Line 51:		Line 51:

	==Stimulation Parameters==		==Stimulation Parameters==
	These parameters can be found in the "Stimulation" tab and in both the BCI2000 config window and the Ripple Stimulation Tool.		These parameters can be found in the "Stimulation" tab and in both the BCI2000 config window and the Ripple Stimulation Tool. Parameters are checked and will throw a warning if they exceed device's safety limits or capabilities in both BCI2000 and the Ripple Stimulation Tool.
	[[File:RippleStimulationParameters.png\|600px\|thumb\|center\|upright=2.5\|Figure 2. Stimulation parameters for the RippleADC]]		[[File:RippleStimulationParameters.png\|600px\|thumb\|center\|upright=2.5\|Figure 2. Stimulation parameters for the RippleADC]]

Nluczak: /* StimEnable */

2025-11-15T06:33:37Z

StimEnable

← Older revision		Revision as of 06:33, 15 November 2025
Line 56:		Line 56:
	===StimEnable===		===StimEnable===
	Enable/disable stimulation functionality (0 or 1).		Enable/disable stimulation functionality (0 or 1).


	===Step Size===		===Step Size===

Nluczak: /* Stimulation Parameters */

2025-11-15T06:33:31Z

Stimulation Parameters

@@ Line 51: / Line 51: @@
 ==Stimulation Parameters==
-These parameters can be found in the "Stimulation" tab and matrixes of the BCI2000 config window and the Ripple Stimulation Tool.
+These parameters can be found in the "Stimulation" tab and in both the BCI2000 config window and the Ripple Stimulation Tool.
 [[File:RippleStimulationParameters.png|600px|thumb|center|upright=2.5|Figure 2. Stimulation parameters for the RippleADC]]
@@ Line 57: / Line 57: @@
 Enable/disable stimulation functionality (0 or 1).
-===StimFrequency===
+===Step Size===
-===StimDuration===
+This parameter defines the amplitude resolution of the stimulator in µA.
-Duration of each stimulation phase in milliseconds (0.01-10 range).
+It indicates the granularity with which the stimulation amplitude may be adjusted. The allowed values depend on the hardware and are typically fixed by the front-end.
-===StimAmplitude===
+===Frequency===
-===StimTrainLength===
+This parameter defines the frequency of stimulation pulses in Hz.
-Total length of stimulation train in milliseconds.
+It specifies how many biphasic pulses occur per second during stimulation. Controls the pulse rate within a stimulation train. Higher frequencies produce temporally denser stimulation.
-===StimDelay===
+===Amplitude===
-Delay before stimulation starts in milliseconds.
 ==Device Parameters==

Nluczak: /* Supported Front Ends */

2025-11-15T06:17:35Z

Supported Front Ends

← Older revision		Revision as of 06:17, 15 November 2025
Line 106:		Line 106:
	===Supported Front Ends===		===Supported Front Ends===
	{\| class="wikitable"		{\| class="wikitable"
	! Front End Type !! Channels ~~!! Resolution~~ !! Supported Sampling Rates		! Front End Type !! Channels !! Supported Sampling Rates
	\|-		\|-
	\| Stimulation \|\| 32 ~~\|\| 22 nV~~ \|\| HiRes (2kHz), HiFreq (15kHz)		\| Stimulation \|\| 32 \|\| HiRes (2kHz), HiFreq (15kHz)
	\|-		\|-
	\| Raw \|\| 32 ~~\|\| 250 nV~~ \|\| LFP (1kHz), HiRes (2kHz), Raw (30kHz)		\| Raw \|\| 32 \|\| LFP (1kHz), HiRes (2kHz), Raw (30kHz)
	\|}		\|}

Nluczak: /* StimulusType */

2025-11-15T06:14:58Z

StimulusType

← Older revision		Revision as of 06:14, 15 November 2025
Line 97:		Line 97:

	===StimulusType===		===StimulusType===
	16-bit state that indicates stimulation status ~~(0 = off, 1 = on)~~.		16-bit state that indicates stimulation status.

	===ConnectionStatus===		===ConnectionStatus===