BCI2000 Wiki - Recent changes [en]

User Reference:Operator Module Scripting

Mellinger — Thu, 23 May 2013 19:38:52 GMT

‎Commands operating on Expressions:

Programming Howto:SVN Client Setup

Mellinger — Thu, 23 May 2013 14:43:52 GMT

‎Setting up TortoiseSVN to access the BCI2000 code repository:

Programming Reference:BCI2000 Source Code

Mellinger — Thu, 23 May 2013 14:37:22 GMT

‎Stable Versions and Branches:

Programming Howto:SVN Client Setup

Mellinger — Thu, 23 May 2013 13:39:32 GMT

‎Setting up TortoiseSVN to access the BCI2000 code repository:

Programming Reference:BCI2000 Source Code

Mellinger — Thu, 23 May 2013 13:36:48 GMT

‎Stable Versions and Branches:

User Reference:TransmissionFilter

Mellinger — Wed, 22 May 2013 19:08:15 GMT

‎Examples:

Contributions:gSTIMbox

Ignatp — Tue, 21 May 2013 23:11:13 GMT

‎OutputList:

Contributions:gSTIMbox

Ignatp — Tue, 21 May 2013 22:43:05 GMT

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]]

@@ Line 168: / Line 168: @@
 =====CLEAR EXPRESSION VARIABLE <name>=====
 Clears the named expression variable from storage.
 ====Commands operating on Files, Directories, and Paths====

@@ Line 4: / Line 4: @@
 * Create or pick an empty folder located on your machine’s harddrive. This will hold your working copy of the BCI2000 source tree, in an automatically created subfolder called "BCI2000."
 * Right-click the folder you picked in the last step. From the context menu, choose the "SVN Checkout..." option – a dialog window appears.
-* In the dialog window, enter the repository URL: <code><nowiki>http://www.bci2000.org/svn/tags/releases/current</nowiki></code>, choose "HEAD revision", and click OK.
+* In the dialog window, enter the repository URL: <code><nowiki>http://www.bci2000.org/svn/tags/releases/current</nowiki></code>, choose "HEAD revision" and "include externals". Then, click OK.
 * You will be prompted for your user name and password. This account is the same that you use to log into [http://{{SERVERNAME}}/tracproj Trac] and [[special:userlogin|into this Wiki]].
 == Checking out older versions ==
-If you think that the current version of BCI2000 is not working properly, or would like to work with an older version for some other reason, you may enter a "Revision number" into the checkout dialog.
+If you think that the current version of BCI2000 is not working properly, or would like to work with an older version for some other reason, you should first check whether one of the releases in <tt>http://www.bci2000.org/svn/tags/releases</tt> suits you needs.
 The "Show Log" button will provide you with an overview of the latest changes and their associated revision numbers.

@@ Line 5: / Line 5: @@
 ==Stable Versions and Branches==
-For each upcoming major release of BCI2000, a branch is created in /svn/branches. Development of the new version occurs there, and only bug fixes are committed to /svn/trunk. Between major releases, some amount of development occurs in the trunk directory in addition to fixing bugs. Thus, it may be that the trunk does not build on all compilers, or contains unfixed bugs. To obtain a stable, tested version of the BCI2000 source code, please checkout one of the tagged release versions from /svn/tags/releases. These correspond to binary distributions as listed on the [[BCI2000_Binaries#Version_History|binary distribution page]].
+For each upcoming major release of BCI2000, a branch is created in <tt>/svn/branches</tt>. Development of the new version occurs there, and only bug fixes are committed to /svn/trunk. Between major releases, some amount of development occurs in the trunk directory in addition to fixing bugs. Thus, it may be that the trunk does not build on all compilers, or contains unfixed bugs. To obtain a stable, tested version of the BCI2000 source code, please checkout one of the tagged release versions from <tt>/svn/tags/releases</tt>. These correspond to binary distributions as listed on the [[BCI2000_Binaries#Version_History|binary distribution page]]. The version corresponding to the most current binary distribution is available by checking out <tt>/svn/tags/releases/current</tt>. By doing an "SVN update" on the checkout folder, you will then be able to update to the latest stable version of the source code.
 ==Browsing the Source Code Repository Online==

@@ Line 4: / Line 4: @@
 * Create or pick an empty folder located on your machine’s harddrive. This will hold your working copy of the BCI2000 source tree, in an automatically created subfolder called "BCI2000."
 * Right-click the folder you picked in the last step. From the context menu, choose the "SVN Checkout..." option – a dialog window appears.
-* In the dialog window, enter the repository URL: <code><nowiki>http://www.bci2000.org/svn/trunk</nowiki></code>, choose "HEAD revision", and click OK.
+* In the dialog window, enter the repository URL: <code><nowiki>http://www.bci2000.org/svn/tags/releases/current</nowiki></code>, choose "HEAD revision", and click OK.
 * You will be prompted for your user name and password. This account is the same that you use to log into [http://{{SERVERNAME}}/tracproj Trac] and [[special:userlogin|into this Wiki]].

@@ Line 5: / Line 5: @@
 ==Stable Versions and Branches==
-For each upcoming major release of BCI2000, a branch is created in /svn/branches. Development of the new version occurs there, and only bug fixes are committed to /svn/trunk. Between major releases, some amount of development occurs in the trunk directory in addition to fixing bugs. Thus, it may be that the trunk does not build on all compilers, or contains unfixed bugs. To obtain a stable, tested version of the BCI2000 source code, please download the source code revision ("changeset") listed with the latest binary distribution on the [[BCI2000_Binaries#Version_History|binary distribution page]].
+For each upcoming major release of BCI2000, a branch is created in /svn/branches. Development of the new version occurs there, and only bug fixes are committed to /svn/trunk. Between major releases, some amount of development occurs in the trunk directory in addition to fixing bugs. Thus, it may be that the trunk does not build on all compilers, or contains unfixed bugs. To obtain a stable, tested version of the BCI2000 source code, please checkout one of the tagged release versions from /svn/tags/releases. These correspond to binary distributions as listed on the [[BCI2000_Binaries#Version_History|binary distribution page]].
 ==Browsing the Source Code Repository Online==

@@ Line 5: / Line 5: @@
 ==Parameters==
 ===TransmitChList===
-A list of input channels to be forwarded to the filter's output. Channels may be specified by ordinal number, or textual label if available.
+A list of input channels to be forwarded to the filter's output.
 Channel labels are forwarded if present for the input signal.
 ==States==

@@ Line 24: / Line 24: @@
 ===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.
 {| class="wikitable"
 | '''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
 |}
-The channel corresponds to the output channel of the gSTIMbox (1-16).
+===OutputList===
 {| class="wikitable"
-| '''Allowed of TriggerTypes ''' || '''Meaning''' || '''Allowable TriggerName for TriggerType''' || '''Allowable Threshold for TriggerTYpe'''
+| '''Channel''' || '''DefaultState''' || '''DefaultMode''' ||  '''DefaultFreq''' || '''TriggeredState''' || '''TriggeredMode''' ||  '''TriggeredFreq''' ||
 |-
-| 0 || gSTIMbox Input Channel || 1-14 corresponding to gSTIMbox Inputs || 1 or 0
+| 1 || 1 || 0 || 0 || 0 || 0 || 0
 |-
-| 1 || EEG Input Channel || 1 - Signal Channel Size, corresponding to EEG channels || a BCI2000 recognized voltage (e.g. 125mV)
+| 2 || 0 || 0 || 0 || 1 || 0 || 0
 |-
-| 2 || State || Valid State Name || any integer value
+| 3 || 1 || 1 || 30 || 1 || 1 || 50
 |}
 ==See also==