READ ME

Please 

Hi Researcher :)

Thank you for using stimDesigner. This software is used to trigger stimulators (electrical, magnetic, etc) by delivering individually designed waveforms custom built by you. 

STEP 1: Enter parameters

This software will initiate a series of TTL pulses that drives your stimulator. In order to do this, you must input your desired waveform parameters into the GUI. 
These parameters are visualized in the demo waveform figure on the right hand side of the GUI and listed below:

	1- Frequency (Hz). This is the number of pulses delivered per second. 
	2- Train Length - This is the "ON" time of each stimulation train (Input in Seconds)
	3- Inter-train interval - This is the "OFF" time between train. (Input in Seconds)
	4- Total Duration- This is the length of your desired experimental stimulation period. (Input in MINUTES)

Advanced users may choose to do burst patterns. In that case, please check "burst mode" and the parameters will change to include burst parameters.

STEP 2: Inspect your waveform.

After inputting desired parameters into the GUI, click "PRODUCE FIGURE" to visualize you waveform. This will appear below the demo waveform on the right side of the GUI. 

To zoom and inspect your waveform use the magnifier button on the very top tool bar (top left) of the GUI. After clicking this button, use your cursor to drag and inspect the waveform.

STEP 3: Initiate Stimulation

After verifying your waveform is correct in step 2, click "verify" to confirm and subsequently press "ok" in the dialog box. Only after these two steps are complete can you then click "START"

Key Features:

	1) There is a running clock that starts as soon as you hit the START button. This counts up to your total session duration.

	2) There is a STOP button to stop the triggers. You cannot restart after hitting start, but ensure that you have noted the time you stopped stimulation, exit the GUI, and restart.


Thank you for using stimDesigner. Go forth and stimulate safely. Please cite our manuscript listed below when you use our software. It helps us out! 

Badran BW, Yu AB, Adair DKP, et al. Methodological Description of the Laboratory Administration of Transcutaneous Auricular Vagus Nerve Stimulation (taVNS) in Humans: Technique, Targeting and Considerations. 
Journal of Visualized Experiments (JoVE). 2018.

-----------------------------------------------------------------------------------------------------
FAQs and Considerations


In order to properly use stimDesigner, you will need the following software and hardware:

Software:
	1- Matlab (tested and built on v2017 but will likely work on other modern versions post-2014)
	2- Data Acquisition Toolbox (Matlab toolbox)
	3- Update drivers from National Instruments (These drivers are to ensure proper computer/DAQ connectivity)
	4- stimDesigner.m & stimDesigner.fig (please keep all files in the root stimDesigner folder)

Hardware
	1- PC Computer that can run Matlab (This has not been tested on Linux/Unix/Mac)
	2- DAQ (our group uses the NI-DAQmx from national instruments)
	3- Stimulator that accepts TTL pulses in for triggering (eg: Digitimer, Grass, Soterix, Magventure, etc)
	4- USB cable (PC to DAQ) and a BNC cable (DAQ to Stimulator)

-> Please note this is a research investigational tool for IRB approved investigational studies in the research setting. 

-> Test your output waveform before delivering it to any research participants. Please follow all local guidelines for safe administration of any form of brain stimulation.

Refer to all stimulation safety guidelines to assist in determination of safe stimulation parameters.


Triggering information:
Voltage of the TTL pulse is 5V rising edge (5 microsecond pulse width) 

Need Help?
This GUI was designed by Devin Adair of the Neural Engineering Group at CCNY. Feel free to contact her with questions:
dadair@gradcenter.cuny.edu