Contributions:gSTIMbox - Revision history

Ignatp: /* OutputList */

2013-05-21T23:11:13Z

OutputList

← Older revision		Revision as of 23:11, 21 May 2013
Line 63:		Line 63:
	* State -- 0 or 1 meaning port disabled or port enabled respectively		* State -- 0 or 1 meaning port disabled or port enabled respectively
	* Mode -- 0 or 1 meaning on off mode or frequency modulation mode respectively		* Mode -- 0 or 1 meaning on off mode or frequency modulation mode respectively
	* ~~Frequency~~ -- 1-50, integer number of Hz port is modulated on if mode is 1.		* Freq -- 1-50, integer number of Hz port is modulated on if mode is 1.

	* Default -- When a port is not triggered		* Default(State/Mode/Freq) -- When a port is not triggered this sets its (State/Mode/Freq)
	* Triggered -- When a port is triggered by the OutputTriggerList		* Triggered(State/Mode/Freq) -- When a port is triggered by the OutputTriggerList this sets its (State/Mode/Freq)


Line 73:		Line 73:

	{\| class="wikitable"		{\| class="wikitable"
	\| '''Channel''' \|\| '''~~Default State~~''' \|\| '''~~Default Mode~~''' \|\| '''~~Default Freq~~''' \|\| '''~~Triggered State~~''' \|\| '''~~Triggered Mode~~''' \|\| '''~~Triggered Freq~~''' \|\|		\| '''Channel''' \|\| '''DefaultState''' \|\| '''DefaultMode''' \|\| '''DefaultFreq''' \|\| '''TriggeredState''' \|\| '''TriggeredMode''' \|\| '''TriggeredFreq''' \|\|
	\|-		\|-
	\| 1 \|\| 1 \|\| 0 \|\| 0 \|\| 0 \|\| 0 \|\| 0		\| 1 \|\| 1 \|\| 0 \|\| 0 \|\| 0 \|\| 0 \|\| 0

Ignatp: /* OutputList */

2013-05-21T23:10:13Z

OutputList

← Older revision		Revision as of 23:10, 21 May 2013
Line 69:		Line 69:


	~~For example~~		Example:


	{\| class="wikitable"		{\| class="wikitable"
	\| '''Channel''' \|\| '''Default State''' \|\| '''Default Mode''' \|\| '''Default Freq''' \|\| '''Triggered State''' \|\| '''Triggered Mode''' \|\| '''Triggered Freq''' \|\|		\| '''Channel''' \|\| '''Default State''' \|\| '''Default Mode''' \|\| '''Default Freq''' \|\| '''Triggered State''' \|\| '''Triggered Mode''' \|\| '''Triggered Freq''' \|\|

Ignatp: /* OutputMatrix */

2013-05-21T23:09:44Z

OutputMatrix

← Older revision		Revision as of 23:09, 21 May 2013
Line 56:		Line 56:
	\|}		\|}

	===~~OutputMatrix~~===		===OutputList===

	~~The output~~ matrix describes output states, and how they react to being triggered. For example		A matrix that describes output port states, and how they react to being triggered.

			* Channel -- Output Channel of the gSTIMbox
			* State -- 0 or 1 meaning port disabled or port enabled respectively
			* Mode -- 0 or 1 meaning on off mode or frequency modulation mode respectively
			* Frequency -- 1-50, integer number of Hz port is modulated on if mode is 1.

			* Default -- When a port is not triggered
			* Triggered -- When a port is triggered by the OutputTriggerList


			For example
	{\| class="wikitable"		{\| class="wikitable"
	\| '''Channel''' \|\| '''Default State''' \|\| '''Default Mode''' \|\|		\| '''Channel''' \|\| '''Default State''' \|\| '''Default Mode''' \|\| '''Default Freq''' \|\| '''Triggered State''' \|\| '''Triggered Mode''' \|\| '''Triggered Freq''' \|\|
			\|-
			\| 1 \|\| 1 \|\| 0 \|\| 0 \|\| 0 \|\| 0 \|\| 0
			\|-
			\| 2 \|\| 0 \|\| 0 \|\| 0 \|\| 1 \|\| 0 \|\| 0
			\|-
			\| 3 \|\| 1 \|\| 1 \|\| 30 \|\| 1 \|\| 1 \|\| 50
			\|-
			\| 4 \|\| 1 \|\| 0 \|\| 0 \|\| 1 \|\| 1 \|\| 15
	\|}		\|}


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

Ignatp: /* OutputTriggerList */

2013-05-21T23:02:15Z

OutputTriggerList

← Older revision		Revision as of 23:02, 21 May 2013
Line 26:		Line 26:
	The output trigger list is a matrix, where each row is an entry binding an output channel to a trigger. All fields in this matrix are required. The channel corresponds to output channels on the gSTIMbox. The table below describes the function of the other matrix parameters.		The output trigger list is a matrix, where each row is an entry binding an output channel to a trigger. All fields in this matrix are required. The channel corresponds to output channels on the gSTIMbox. The table below describes the function of the other matrix parameters.
	* Channel -- output channel of gSTIMbox (1-16)		* Channel -- output channel of gSTIMbox (1-16)
	* TriggerType -- 1, ~~2, or 3 / 4 corresponding to gSTIMbox input, EEG input, State Respectively~~		* TriggerType -- The type of trigger, see table below.
	* TriggerName -- Values dependent on TriggerType see table below.		* TriggerName -- The identifier of the trigger. Values dependent on TriggerType, see table below.
	* Threshold -- Threshold to quantify if a output is in the triggered state. Values dependent on TriggerType see table below.		* Threshold -- Threshold to quantify if a output is in the triggered state. Values dependent on TriggerType, see table below.

Ignatp: /* OutputTriggerList */

2013-05-21T23:00:36Z

OutputTriggerList

← Older revision		Revision as of 23:00, 21 May 2013
Line 26:		Line 26:
	The output trigger list is a matrix, where each row is an entry binding an output channel to a trigger. All fields in this matrix are required. The channel corresponds to output channels on the gSTIMbox. The table below describes the function of the other matrix parameters.		The output trigger list is a matrix, where each row is an entry binding an output channel to a trigger. All fields in this matrix are required. The channel corresponds to output channels on the gSTIMbox. The table below describes the function of the other matrix parameters.
	* Channel -- output channel of gSTIMbox (1-16)		* Channel -- output channel of gSTIMbox (1-16)
	* TriggerType -- 1, 2, or 3/4 corresponding to gSTIMbox input, EEG input, State Respectively		* TriggerType -- 1, 2, or 3 / 4 corresponding to gSTIMbox input, EEG input, State Respectively
	* TriggerName -- Values dependent on TriggerType see table below.		* TriggerName -- Values dependent on TriggerType see table below.
	* Threshold -- Threshold to quantify if a output is in the triggered state. Values dependent on TriggerType see table below.		* Threshold -- Threshold to quantify if a output is in the triggered state. Values dependent on TriggerType see table below.

Ignatp: /* OutputTriggerList */

2013-05-21T23:00:24Z

OutputTriggerList

← Older revision		Revision as of 23:00, 21 May 2013
Line 26:		Line 26:
	The output trigger list is a matrix, where each row is an entry binding an output channel to a trigger. All fields in this matrix are required. The channel corresponds to output channels on the gSTIMbox. The table below describes the function of the other matrix parameters.		The output trigger list is a matrix, where each row is an entry binding an output channel to a trigger. All fields in this matrix are required. The channel corresponds to output channels on the gSTIMbox. The table below describes the function of the other matrix parameters.
	* Channel -- output channel of gSTIMbox (1-16)		* Channel -- output channel of gSTIMbox (1-16)
	* TriggerType -- 1, 2 or 3 corresponding to gSTIMbox input, EEG input, or State Respectively		* TriggerType -- 1, 2, or 3/4 corresponding to gSTIMbox input, EEG input, State Respectively
	* TriggerName -- Values dependent on TriggerType see table below.		* TriggerName -- Values dependent on TriggerType see table below.
	* Threshold -- Threshold to quantify if a output is in the triggered state. Values dependent on TriggerType see table below.		* Threshold -- Threshold to quantify if a output is in the triggered state. Values dependent on TriggerType see table below.
Line 55:		Line 55:
	\| 4 \|\| 3 \|\| SomeState \|\| 13		\| 4 \|\| 3 \|\| SomeState \|\| 13
	\|}		\|}






	===OutputMatrix===		===OutputMatrix===

Ignatp at 22:59, 21 May 2013

2013-05-21T22:59:23Z

← Older revision		Revision as of 22:59, 21 May 2013
Line 43:		Line 43:
	\|}		\|}

	An example OutputTriggerList which triggers the first output channel on the first input channel of the gSTIMbox when the value is 1, the second output channel on the first EEG channel when the value is greater than or equal to 125 mV, the third output channel when the space bar is pressed, the fourth output channel when the value of SomeState is greater than or equal to 13.		Below is an example OutputTriggerList which triggers the first output channel on the first input channel of the gSTIMbox when the value is 1, the second output channel on the first EEG channel when the value is greater than or equal to 125 mV, the third output channel when the space bar is pressed, the fourth output channel when the value of SomeState is greater than or equal to 13.
	{\| class="wikitable"		{\| class="wikitable"
	\| '''Channel''' \|\| '''TriggerType''' \|\| '''TriggerName''' \|\| '''Threshold'''		\| '''Channel''' \|\| '''TriggerType''' \|\| '''TriggerName''' \|\| '''Threshold'''
Line 52:		Line 52:
	\|-		\|-
	\| 3 \|\| 2 \|\| KeyDown \|\| 20		\| 3 \|\| 2 \|\| KeyDown \|\| 20
			\|-
	\| 4 \|\| 3 \|\| SomeState \|\| 13		\| 4 \|\| 3 \|\| SomeState \|\| 13
	\|}		\|}

	~~The channel corresponds to the output channel of the gSTIMbox (1-16).~~

	~~The table below describes the other parameters.~~

Ignatp at 22:58, 21 May 2013

2013-05-21T22:58:29Z

← Older revision		Revision as of 22:58, 21 May 2013
Line 32:		Line 32:

	{\| class="wikitable"		{\| class="wikitable"
	\| '''Allowed of TriggerTypes ''' \|\| '''Meaning''' \|\| '''Allowable TriggerName for TriggerType''' \|\| '''Allowable Threshold for TriggerType'''		\| '''Allowed of TriggerTypes ''' \|\| '''Meaning''' \|\| '''Allowable TriggerName for TriggerType''' \|\| '''Allowable Threshold for TriggerType''' \|\| '''Triggered When'''
	\|-		\|-
	\| 0 \|\| gSTIMbox Input Channel \|\| 1-14 corresponding to gSTIMbox Inputs \|\| 1 or 0~~; triggered when~~ channel value == threshold value		\| 0 \|\| gSTIMbox Input Channel \|\| 1-14 corresponding to gSTIMbox Inputs \|\| 1 or 0 \|\| channel value == threshold value
	\|-		\|-
	\| 1 \|\| EEG Input Channel \|\| 1 - Signal Channel Size, corresponding to EEG channels \|\| a BCI2000 recognized voltage (e.g. 125mV)~~; triggered when~~ channel value >= threshold value		\| 1 \|\| EEG Input Channel \|\| 1 - Signal Channel Size, corresponding to EEG channels \|\| a BCI2000 recognized voltage (e.g. 125mV) \|\| channel value >= threshold value
	\|-		\|-
	\| 2 \|\| State \|\| Valid State Name \|\| any integer value~~; triggered when~~ state value == threshold value		\| 2 \|\| State With Equality Threshold \|\| Valid State Name \|\| any integer value \|\| state value == threshold value
			\|-
			\| 3 \|\| State With Inequality Threshold \|\| Valid State Name \|\| any integer value \|\| state value >= threshold value
	\|}		\|}

	An example OutputTriggerList which triggers the first output channel on the first input channel of the gSTIMbox when the value is 1, the second output channel on the first EEG channel when the value is greater than or equal to 125 mV, ~~and~~ the third output channel when the space bar is pressed.		An example OutputTriggerList which triggers the first output channel on the first input channel of the gSTIMbox when the value is 1, the second output channel on the first EEG channel when the value is greater than or equal to 125 mV, the third output channel when the space bar is pressed, the fourth output channel when the value of SomeState is greater than or equal to 13.
	{\| class="wikitable"		{\| class="wikitable"
	\| '''Channel''' \|\| '''TriggerType''' \|\| '''TriggerName''' \|\| '''Threshold'''		\| '''Channel''' \|\| '''TriggerType''' \|\| '''TriggerName''' \|\| '''Threshold'''
Line 50:		Line 52:
	\|-		\|-
	\| 3 \|\| 2 \|\| KeyDown \|\| 20		\| 3 \|\| 2 \|\| KeyDown \|\| 20
			\| 4 \|\| 3 \|\| SomeState \|\| 13
	\|}		\|}

Ignatp at 22:54, 21 May 2013

2013-05-21T22:54:50Z

← Older revision		Revision as of 22:54, 21 May 2013
Line 24:		Line 24:

	===OutputTriggerList===		===OutputTriggerList===
	The output trigger list is a matrix, where each row is an entry binding an output channel to a trigger.		The output trigger list is a matrix, where each row is an entry binding an output channel to a trigger. All fields in this matrix are required. The channel corresponds to output channels on the gSTIMbox. The table below describes the function of the other matrix parameters.
			* Channel -- output channel of gSTIMbox (1-16)
			* TriggerType -- 1, 2 or 3 corresponding to gSTIMbox input, EEG input, or State Respectively
			* TriggerName -- Values dependent on TriggerType see table below.
			* Threshold -- Threshold to quantify if a output is in the triggered state. Values dependent on TriggerType see table below.


			{\| class="wikitable"
			\| '''Allowed of TriggerTypes ''' \|\| '''Meaning''' \|\| '''Allowable TriggerName for TriggerType''' \|\| '''Allowable Threshold for TriggerType'''
			\|-
			\| 0 \|\| gSTIMbox Input Channel \|\| 1-14 corresponding to gSTIMbox Inputs \|\| 1 or 0; triggered when channel value == threshold value
			\|-
			\| 1 \|\| EEG Input Channel \|\| 1 - Signal Channel Size, corresponding to EEG channels \|\| a BCI2000 recognized voltage (e.g. 125mV); triggered when channel value >= threshold value
			\|-
			\| 2 \|\| State \|\| Valid State Name \|\| any integer value; triggered when state value == threshold value
			\|}

			An example OutputTriggerList which triggers the first output channel on the first input channel of the gSTIMbox when the value is 1, the second output channel on the first EEG channel when the value is greater than or equal to 125 mV, and the third output channel when the space bar is pressed.
	{\| class="wikitable"		{\| class="wikitable"
	\| '''Channel''' \|\| '''TriggerType''' \|\| '''TriggerName''' \|\| '''Threshold'''		\| '''Channel''' \|\| '''TriggerType''' \|\| '''TriggerName''' \|\| '''Threshold'''
	\|-		\|-
	\| 1 \|\| 0 \|\| 0 \|\| 1		\| 1 \|\| 0 \|\| 1 \|\| 1
	\|-		\|-
	\| 2 \|\| 1 \|\| 0 \|\| 125mV		\| 2 \|\| 1 \|\| 1 \|\| 125mV
	\|-		\|-
	\| 3 \|\| 2 \|\| KeyDown \|\| 1		\| 3 \|\| 2 \|\| KeyDown \|\| 20
	\|}		\|}

Line 40:		Line 56:
	The table below describes the other parameters.		The table below describes the other parameters.





			===OutputMatrix===

			The output matrix describes output states, and how they react to being triggered. For example
	{\| class="wikitable"		{\| class="wikitable"
	\| '''~~Allowed of TriggerTypes~~ ''' \|\| '''~~Meaning''' \|\| '''Allowable TriggerName for TriggerType~~''' \|\| '''~~Allowable Threshold for TriggerTYpe~~'''		\| '''Channel''' \|\| '''Default State''' \|\| '''Default Mode''' \|\|
	\|-
	~~\| 0 \|\| gSTIMbox Input Channel \|\| 1-14 corresponding to gSTIMbox Inputs \|\| 1 or 0~~
	\|-
	~~\| 1 \|\| EEG Input Channel \|\| 1 - Signal Channel Size, corresponding to EEG channels \|\| a BCI2000 recognized voltage (e.g. 125mV)~~
	\|-
	~~\| 2 \|\| State \|\| Valid State Name~~ \|\| ~~any integer value~~
	\|}		\|}

	~~Thresholds are compared on a less than or equal to basis.~~

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

Ignatp: Created page with "==Synopsis== The gSTIMbox is a digital signal acquisition device with 14 digital inputs and 16 digital outputs. This page currently serves as a technical specification to a fu..."

2013-05-21T22:43:05Z

Created page with "==Synopsis== The gSTIMbox is a digital signal acquisition device with 14 digital inputs and 16 digital outputs. This page currently serves as a technical specification to a fu..."

New page

==Synopsis==
The gSTIMbox is a digital signal acquisition device with 14 digital inputs and 16 digital outputs. This page currently serves as a technical specification to a future module.

==Location==
'''Unreleased'''

~~http://{{SERVERNAME}}/svn/trunk/src/contrib/SignalSource/gSTIMbox~~

==Versioning==

===Authors===
Paul Ignatenko (paul dot ignatenko at gmail dot com)

==Functional Description==
Allows the gSTIMbox to run as a co-Source module, allowing you to monitor inputs, and trigger outputs.

==Installation==

Compile the gSTIMbox module using [[Programming_Reference:Build_System#How_To_Build_Using_CMake|CMake and your compiler]].

==Parameters==

===OutputTriggerList===
The output trigger list is a matrix, where each row is an entry binding an output channel to a trigger.

{| class="wikitable"
| '''Channel''' || '''TriggerType''' || '''TriggerName''' || '''Threshold'''
|-
| 1 || 0 || 0 || 1
|-
| 2 || 1 || 0 || 125mV
|-
| 3 || 2 || KeyDown || 1
|}

The channel corresponds to the output channel of the gSTIMbox (1-16).

The table below describes the other parameters.

{| class="wikitable"
| '''Allowed of TriggerTypes ''' || '''Meaning''' || '''Allowable TriggerName for TriggerType''' || '''Allowable Threshold for TriggerTYpe'''
|-
| 0 || gSTIMbox Input Channel || 1-14 corresponding to gSTIMbox Inputs || 1 or 0
|-
| 1 || EEG Input Channel || 1 - Signal Channel Size, corresponding to EEG channels || a BCI2000 recognized voltage (e.g. 125mV)
|-
| 2 || State || Valid State Name || any integer value
|}

Thresholds are compared on a less than or equal to basis.

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

[[Category:Contributions]][[Category:Data Acquisition]]