BCI2000 Wiki - User contributions [en]

Contributions:NIDAQFilter

2010-09-07T22:07:36Z

Jrenga:

==Synopsis==
A filter that outputs different statesr from BCI2000 to outputs connected to a National Instruments Board running DAQmx 8.5 or higher.
==Location==
The file(s) should be in the following directory:
http://{{SERVERNAME}}/svn/trunk/src/shared/modules/signalsource/

==Versioning==
===Author===
Justin Renga (justin.renga@gmail.com)
===Version History===
1.0
===Source Code Revision===
Not Applicable
==Functional Description==
The NIDAQFilter uses any DAQmx 8.5 or higher compliant board and allows the user to pipe state data from BCI2000 through the board. All necesary components must be connected to the BCI computer before initiating a module using the filter.
==Adding and Compiling==
To add and compile the NIDAQFilter module, make sure the latest NIDAQ MX drivers are installed on your computer. When that is done, go into the C:\Program Files\National Instruments\NI-DAQ\DAQmx ANSI C Dev\ folder. Inside are two folders: lib and include. The lib folder will contain the NIDAQmx.lib file (inside of the folder msvc). Copy that into the project's library folder. Inside of the include folder is the NIDAQmx.h file, which contains the function prototypes needed to use the NIDAQLogger module. Move this file into the project's include folder. Make sure the project links the new .lib file, and that the NIDAQFilter.h and NIDAQFilter.cpp files include the NIDAQmx.h file correctly. The NIDAQFiltershould now be able to compile normally.
==Parameters==
The NIDAQFilter uses command line parameters to initialize the device(s) and set up the active ports. It then uses BCI2000 parameters for finer controls over the device, such as changing the sampling rate of the device.
===Command Line Parameters===
====Initializing the NIDAQFilter====
To begin using the NIDAQFilter, use the <code>--LogNIDAQout</code> flag and set it equal to 1. To activate device(s) for specific functions, use the following flags:
*<code>--LogDigiOut</code> --> Enable the device to use digital output characteristics
*<code>--LogAnaOut</code> --> Enable the device to use analog output characteristics
The format for the outputs for above flags is as follows:
<center><code>[flag]="[device specification]-[port specifications]"</code></center>
Please note that if <code>--LogNIDAQout</code> is enabled, then at least one of the above flags MUST be used.
====Device Specification====
The device name is to be written as "Dev1" or "Dev2" (without the quotes) in the first part of the parameter value. After the device name is specified, use a hyphen (-) to indicate the device name is finished. For example, the first part of the parameter value would look like this: <code> "Dev1-</code>.

If the device numbers are unclear, run the filter with just the <code>--LogNIDAQout</code> flag specified. The device names (along with their familiar names) will appear in the operator log.
====Port Specifications====
There are two acceptable states that the user can specify for each port that they are going to use:

*0 --> the associated port WILL NOT be used
*1 --> the associated port WILL be used

The values will be used for every single port that the user wants to use. For example, if the user wants to use ports 3 and 5 on a device with 10 ports, then the port specification for that device will be the following:

<center><code>0010100000</code></center>

Notice how even though the user wants to use only 2 ports, all 10 ports have been indicated. This is required. Any port that is not needed should be marked with a 0. If the number of ports specified in the parameter file does not match the number of ports found on the device, an error will be thrown, showing the number of ports were specified and how many ports there are for that device function.

Important: If both the NIDAQLogger([[Contributions:NIDAQLogger]]) and the NIDAQFilter are being used, and both are using the digital lines on the same device, make sure that any port that is being referenced in a parameter is referenced only once. One port cannot use both digital input and digital output functionality, and will cause BCI2000 to throw an error, saying that the line is RESERVED.
====A Completed Flag====
The following is the completed flag, whose parts were described above:

<center><code>--LogAnaOut="Dev1-0010100000"</code></center>

The above flag tells the filter that the user wants to use the analog output ports on Device 1, which has 10 ports on it. The user wants to use the 3rd and 5th ports on the device, but leave everything else unused.
===BCI2000 Parameters===
After the commandline parameters have been set, more parameters may be configured in the Configuration dialog box in BCI2000. Under the header NIDAQFilter, the following parameters MAY appear, as some of them are dependant on flags being used:
*#OVRanges [ENUMERATION] --> This parameter tells the user if there are multiple output voltage ranges that are acceptable for use. If not, then the parameter will NOT show up. The parameter is activated by the <code>--LogAnaOut</code> flag.
*FilterExpressions [MATRIX] --> This parameter allows the user to associate different states to individual output lines on the board. By clicking on the Edit Matrix button, the user will see a list of the lines that are active on the board, and a space to put an expression. This parameter will always show up, regardless of the flags being used.
==States==
===Template===
The states are constructed in a contextual manner, that is to say, they are created based on the channels that the user decides to use. The template of the state names is shown below:
<center><code>NI[device name][A:D]OUTPUT[port number-1]</code></center>
Some key things about the template:
*[device name] -> the name of the device to which the port is associated to (for example, if Device 4 is being used, then there will be a state that begins with NIDev4 will exist)
*[A:D] -> analog or digital state (an analog state has a bit width of 16, while a digital state has a bit width of 1). This is dependant on the way the device is being used, and is not settable by the user.
*[port number - 1] -> the number of the port being used (the states begin at port 0, so when port 4 is being used, the number in the state will be 3)
===Example===
If the following parameter list were used as a user's command line parameter:
<center><code>--LogNIDAQout=1 --LogAnaOut="Dev1-00100010100" --LogDigiOut="Dev2-00100001010"</code></center>
Then the following states would be produced:
<center><code>
NIDev1AOUTPUT2 NIDev1AOUTPUT6 NIDev1AOUTPUT8
NIDev2DOUTPUT2 NIDev2DOUTPUT7 NIDev2DOUTPUT9
</code></center>

Contributions:NIDAQLogger

2010-09-07T22:07:33Z

Jrenga:

==Synopsis==
National Instruments Data Acquisition Module

==Location==
The file(s) should be in the following directory:
http://{{SERVERNAME}}/svn/trunk/src/shared/modules/signalsource/

==Versioning==
===Author===
Justin Renga (justin.renga@gmail.com)
===Version History===
===Source Code Revisions===
*Initial development: --
*Tested under: --
*Known to compile under: --
*Broken since: --

==Testing==
The NIDAQLogger has been tested with the USB-6009 and PCI-6024E National Instruments boards at sampling rates up to and including 4096Hz, with sample block sizes up to and including 1024 samples/block. Both devices were running under DAQmx driver version 8.9.5 .

==Known Issues==
There are a couple of known issues with the NIDAQLogger that are listed below:
*Occasional "glitching" may occur : the condition known as "glitching" is when some data gets swapped with slightly older data, producing a result that looks wrong.
*The NIDAQLogger, when coupled with the NIDAQmx Source Module, does not currently work at sampling rates above 8192Hz.
*Poor results may occur if the NIDAQLogger is used within 5 minutes of starting the BCI2000 computer up.

==Functional Description==
Acquires signals using National Instruments Data Acquisition boards, other devices, and the computer. Device(s) must be connected to computer beforehand.

==Adding and Compiling==
To add and compile the NIDAQLogger module, make sure the latest NIDAQ MX drivers are installed on your computer.
When that is done, go into the C:\Program Files\National Instruments\NI-DAQ\DAQmx ANSI C Dev\ folder. Inside are two folders: lib and include. The lib folder will contain the NIDAQmx.lib file (inside of the folder msvc). Copy that into the project's library folder. Inside of the include folder is the NIDAQmx.h file, which contains the function prototypes needed to use the NIDAQLogger module. Move this file into the project's include folder. Make sure the project links the new .lib file, and that the NIDAQLogger.h and NIDAQLogger.cpp files include the NIDAQmx.h file correctly. The NIDAQLogger should now be able to compile normally.

==Parameters==
===Command Line Parameters===
====Initializing NIDAQLogger====
To begin using the NIDAQLogger module, use the <code>--LogNIDAQin</code> flag, and set it equal to 1.
To activate device(s) for specific functions, use the following flags:
*<code>--LogDigiIn</code> (for digital input)
*<code>--LogAnaIn</code> (for analog input)
The format for the inputs for the above flags is as follows: <code>[flag]="[device name]-[port specification]"</code>
Note that if <code>--LogNIDAQ</code> is used, that at least one of the two above flags MUST be used.
====Device Specification====
The device name (usually) is to be written as "Dev1" or "Dev2" (without the ""). Afterwards, use a - to indicate the device name is finished. If the device number is unclear, run the program with the <code>--LogNIDAQin</code> flag activated, and look at the Operator Log. The devices (along with their number) will be listed.
====Port Specifications====
There are two acceptable states that the user can specify for each port:
*0 - this indicates the port is INACTIVE.
*1 - this indicates the port is ACTIVE

Important: If both the NIDAQLogger and the NIDAQFilter (see [[Contributions:NIDAQFilter]]) are being used, and both are using the digital lines on the same device, make sure that any port that is being referenced in a parameter is referenced only once. One port cannot use both digital input and digital output functionality, and will cause BCI2000 to throw an error, saying that the line is RESERVED. 
====Example====
Let's assume that the user wants to use one device for both analog and digital input. The device has 8 Analog Input ports and 12 Digital I/O ports.
The user also wants to use the 3rd and 4th analog input ports, and the 4th and 10th digital ports for digital input.

The user needs to use 3 flags to accomplish this:
*<code>--LogNIDAQin=1</code> -> This flag activates the NIDAQLogger for use.
*<code>--LogDigiIn="Dev1-000100000100"</code> -> This flag indicates that the user wants to use digital I/O. "Dev1" is the name of the device connected to the computer that she wants to use. <code>0001000000100</code> indicates that the user wants ports 4 and 10 (the 1's) as ACTIVE.
*<code>--LogAnaIn="Dev1-00011000"</code> -> This flag indicates that she wants to use analog output. "Dev1" is the name of the device connected to the computer that she wants to use. <code>00011000</code> indicates that she wants to the use ports 3 and 4 on analog input.
The full command (assuming she uses this with SignalGenerator.exe) that the user would use is the following:

<code>SignalGenerator.exe --LogNIDAQin=1 --LogDigiIn="Dev1-000100000100" --LogAnaIn="Dev1-00011000"</code>

===BCI2000 Parameters===
There are two possible parameters that the user will be able to use. They are outlined below:
*#IVRanges - the available voltage ranges for analog input for the given device (where # will be replaced by the device name)
**This parameter will only be enabled if the <code>--LogAnaIn</code> flag is being used.
*#InSampleRate - the sampling rate for the NIDAQLogger
**This parameter will be here if the <code>--LogNIDAQ</code> flag is being used.

The parameters will be located under the Source tab, in the section labeled NILogger.

==States==
The states that are available are dependent on the port specifications declared in the command line parameters. The format for the states is the following:

NIDev#[A:D]INPUT#

*The first # refers to the device number.
*The second # refers to the line number (starting at 0).
*The [A:D] denotes if the state refers to an analog (A) or a digital (D) channel.

For example, if the command parameters look like this:

<code>SignalGenerator.exe --LogNIDAQin=1 --LogDigiIn="Dev1-000100000100" --LogAnaIn="Dev1-10011000"</code>

the states that will be created are the following:

<code>
NIDev1DINPUT3 NIDev1DINPUT9 NIDev1AINPUT0
NIDev1AINPUT2 NIDev1AINPUT3
</code>
==Acquired Data==
The data (analog) that is acquired by the device is translated to make sure that all of the data will fit inside of the state's parameters. Due to this fact, the data needs to be translated back in order to return it to units of milliVolts (mV). This can be done by subtracting the data by (2000*upper voltage bound). For example, if the data was logged with the range -10V to 10V, then the data must be subtracted by 20,000.

Contributions:ADCs

2010-08-31T23:26:38Z

Jrenga:

The following data acquisition filters are available in the [[Contributions:Contents|Contributions]] section of BCI2000:

*[[Contributions:AmpServerProADC]]: Interface to the EGI AmpServerPro.
*[[Contributions:BioRadioADC]]: Interface to the BioRadio amplifer.
*[[Contributions:Biosemi2ADC]]: Interface to the Biosemi amplifier.
*[[Contributions:DAS_ADC]]: Interface to MeasurementComputing AD cards.
*[[Contributions:DTADC]]: Interface to Data Translation boards.
*[[Contributions:Emotiv]]: Interface to the Emotiv EPOC.
*[[Contributions:MicromedADC]]: Interface to the Micromed EEG system.
*[[Contributions:ModularEEG]]: Interface to the ModularEEG system.
*[[Contributions:NIADC]]: Interface to National Instruments boards.
*[[Contributions:NIDAQ-MX]]: Interface to National Instruments boards using the MX driver.
*[[Contributions:NeuroscanADC]]: Neuroscan Acquire socket protocol client.
*[[Contributions:NeuroscanAccessSDK]]: Interface to Neuroscan Direct Access SDK.
*[[Contributions:NeuroSky]]: Interface to Neurosky MindSet.
*[[Contributions:NicoletOne]]: Interface to NicoletOne nEEG series amplifiers.
*[[Contributions:ctfneurod]]: CTF RealTime to Neuroscan Acquire relay.
*[[Contributions:RDAClientADC]]: Brain Vision RDA socket protocol client.
*[[Contributions:TDTADC]]: Interface to Tucker-Davis Pentusa systems.
*[[Contributions:TMSiADC]]: Interface to TMSi Refa and Porti systems.
*[[Contributions:vAmpADC]]: Interface to Brain Products V-amp systems.
*[[Contributions:EnobioADC]]: Interface to Enobio sensor.
*[[Contributions:NIDAQLogger]]: Interface to multiple National Instruments DAQ boards using MX driver (INPUT ONLY)
*[[Contributions:NIDAQFilter]]: Interface to multiple National Instruments DAQ boards using MX driver (OUTPUT ONLY)

==See also==
[[User Reference:Filters]], [[Contributions:How to use a Contributed Source Module]]

[[Category:Contents]][[Category:Data Acquisition]]

Contributions:NIDAQFilter

2010-08-31T23:24:34Z

Jrenga: /* Location */

==Synopsis==
A filter that outputs different statesr from BCI2000 to outputs connected to a National Instruments Board running DAQmx 8.5 or higher.
==Location==
The file(s) should be in the following directory:
http://{{SERVERNAME}}/svn/trunk/src/shared/modules/signalsource/

==Versioning==
===Author===
Justin Renga (justin.renga@gmail.com)
===Version History===
1.0
===Source Code Revision===
Not Applicable
==Functional Description==
The NIDAQFilter uses any DAQmx 8.5 or higher compliant board and allows the user to pipe state data from BCI2000 through the board. All necesary components must be connected to the BCI computer before initiating a module using the filter.
==Parameters==
The NIDAQFilter uses command line parameters to initialize the device(s) and set up the active ports. It then uses BCI2000 parameters for finer controls over the device, such as changing the sampling rate of the device.
===Command Line Parameters===
====Initializing the NIDAQFilter====
To begin using the NIDAQFilter, use the <code>--LogNIDAQout</code> flag and set it equal to 1. To activate device(s) for specific functions, use the following flags:
*<code>--LogDigiOut</code> --> Enable the device to use digital output characteristics
*<code>--LogAnaOut</code> --> Enable the device to use analog output characteristics
The format for the outputs for above flags is as follows:
<center><code>[flag]="[device specification]-[port specifications]"</code></center>
Please note that if <code>--LogNIDAQout</code> is enabled, then at least one of the above flags MUST be used.
====Device Specification====
The device name is to be written as "Dev1" or "Dev2" (without the quotes) in the first part of the parameter value. After the device name is specified, use a hyphen (-) to indicate the device name is finished. For example, the first part of the parameter value would look like this: <code> "Dev1-</code>.

If the device numbers are unclear, run the filter with just the <code>--LogNIDAQout</code> flag specified. The device names (along with their familiar names) will appear in the operator log.
====Port Specifications====
There are two acceptable states that the user can specify for each port that they are going to use:

*0 --> the associated port WILL NOT be used
*1 --> the associated port WILL be used

The values will be used for every single port that the user wants to use. For example, if the user wants to use ports 3 and 5 on a device with 10 ports, then the port specification for that device will be the following:

<center><code>0010100000</code></center>

Notice how even though the user wants to use only 2 ports, all 10 ports have been indicated. This is required. Any port that is not needed should be marked with a 0. If the number of ports specified in the parameter file does not match the number of ports found on the device, an error will be thrown, showing the number of ports were specified and how many ports there are for that device function.

Important: If both the NIDAQLogger([[Contributions:NIDAQLogger]]) and the NIDAQFilter are being used, and both are using the digital lines on the same device, make sure that any port that is being referenced in a parameter is referenced only once. One port cannot use both digital input and digital output functionality, and will cause BCI2000 to throw an error, saying that the line is RESERVED.
====A Completed Flag====
The following is the completed flag, whose parts were described above:

<center><code>--LogAnaOut="Dev1-0010100000"</code></center>

The above flag tells the filter that the user wants to use the analog output ports on Device 1, which has 10 ports on it. The user wants to use the 3rd and 5th ports on the device, but leave everything else unused.
===BCI2000 Parameters===
After the commandline parameters have been set, more parameters may be configured in the Configuration dialog box in BCI2000. Under the header NIDAQFilter, the following parameters MAY appear, as some of them are dependant on flags being used:
*#OVRanges [ENUMERATION] --> This parameter tells the user if there are multiple output voltage ranges that are acceptable for use. If not, then the parameter will NOT show up. The parameter is activated by the <code>--LogAnaOut</code> flag.
*FilterExpressions [MATRIX] --> This parameter allows the user to associate different states to individual output lines on the board. By clicking on the Edit Matrix button, the user will see a list of the lines that are active on the board, and a space to put an expression. This parameter will always show up, regardless of the flags being used.
==States==
===Template===
The states are constructed in a contextual manner, that is to say, they are created based on the channels that the user decides to use. The template of the state names is shown below:
<center><code>NI[device name][A:D]OUTPUT[port number-1]</code></center>
Some key things about the template:
*[device name] -> the name of the device to which the port is associated to (for example, if Device 4 is being used, then there will be a state that begins with NIDev4 will exist)
*[A:D] -> analog or digital state (an analog state has a bit width of 16, while a digital state has a bit width of 1). This is dependant on the way the device is being used, and is not settable by the user.
*[port number - 1] -> the number of the port being used (the states begin at port 0, so when port 4 is being used, the number in the state will be 3)
===Example===
If the following parameter list were used as a user's command line parameter:
<center><code>--LogNIDAQout=1 --LogAnaOut="Dev1-00100010100" --LogDigiOut="Dev2-00100001010"</code></center>
Then the following states would be produced:
<center><code>
NIDev1AOUTPUT2 NIDev1AOUTPUT6 NIDev1AOUTPUT8
NIDev2DOUTPUT2 NIDev2DOUTPUT7 NIDev2DOUTPUT9
</code></center>

Contributions:NIDAQLogger

2010-08-31T23:24:05Z

Jrenga: /* Location */

==Synopsis==
National Instruments Data Acquisition Module

==Location==
The file(s) should be in the following directory:
http://{{SERVERNAME}}/svn/trunk/src/shared/modules/signalsource/

==Versioning==
===Author===
Justin Renga (justin.renga@gmail.com)
===Version History===
===Source Code Revisions===
*Initial development: --
*Tested under: --
*Known to compile under: --
*Broken since: --

==Testing==
The NIDAQLogger has been tested with the USB-6009 and PCI-6024E National Instruments boards at sampling rates up to and including 4096Hz, with sample block sizes up to and including 1024 samples/block. Both devices were running under DAQmx driver version 8.9.5 .

==Known Issues==
There are a couple of known issues with the NIDAQLogger that are listed below:
*Occasional "glitching" may occur : the condition known as "glitching" is when some data gets swapped with slightly older data, producing a result that looks wrong.
*The NIDAQLogger, when coupled with the NIDAQmx Source Module, does not currently work at sampling rates above 8192Hz.
*Poor results may occur if the NIDAQLogger is used within 5 minutes of starting the BCI2000 computer up.

==Functional Description==
Acquires signals using National Instruments Data Acquisition boards, other devices, and the computer. Device(s) must be connected to computer beforehand.

==Parameters==
===Command Line Parameters===
====Initializing NIDAQLogger====
To begin using the NIDAQLogger module, use the <code>--LogNIDAQin</code> flag, and set it equal to 1.
To activate device(s) for specific functions, use the following flags:
*<code>--LogDigiIn</code> (for digital input)
*<code>--LogAnaIn</code> (for analog input)
The format for the inputs for the above flags is as follows: <code>[flag]="[device name]-[port specification]"</code>
Note that if <code>--LogNIDAQ</code> is used, that at least one of the two above flags MUST be used.
====Device Specification====
The device name (usually) is to be written as "Dev1" or "Dev2" (without the ""). Afterwards, use a - to indicate the device name is finished. If the device number is unclear, run the program with the <code>--LogNIDAQin</code> flag activated, and look at the Operator Log. The devices (along with their number) will be listed.
====Port Specifications====
There are two acceptable states that the user can specify for each port:
*0 - this indicates the port is INACTIVE.
*1 - this indicates the port is ACTIVE

Important: If both the NIDAQLogger and the NIDAQFilter (see [[Contributions:NIDAQFilter]]) are being used, and both are using the digital lines on the same device, make sure that any port that is being referenced in a parameter is referenced only once. One port cannot use both digital input and digital output functionality, and will cause BCI2000 to throw an error, saying that the line is RESERVED. 
====Example====
Let's assume that the user wants to use one device for both analog and digital input. The device has 8 Analog Input ports and 12 Digital I/O ports.
The user also wants to use the 3rd and 4th analog input ports, and the 4th and 10th digital ports for digital input.

The user needs to use 3 flags to accomplish this:
*<code>--LogNIDAQin=1</code> -> This flag activates the NIDAQLogger for use.
*<code>--LogDigiIn="Dev1-000100000100"</code> -> This flag indicates that the user wants to use digital I/O. "Dev1" is the name of the device connected to the computer that she wants to use. <code>0001000000100</code> indicates that the user wants ports 4 and 10 (the 1's) as ACTIVE.
*<code>--LogAnaIn="Dev1-00011000"</code> -> This flag indicates that she wants to use analog output. "Dev1" is the name of the device connected to the computer that she wants to use. <code>00011000</code> indicates that she wants to the use ports 3 and 4 on analog input.
The full command (assuming she uses this with SignalGenerator.exe) that the user would use is the following:

<code>SignalGenerator.exe --LogNIDAQin=1 --LogDigiIn="Dev1-000100000100" --LogAnaIn="Dev1-00011000"</code>

===BCI2000 Parameters===
There are two possible parameters that the user will be able to use. They are outlined below:
*#IVRanges - the available voltage ranges for analog input for the given device (where # will be replaced by the device name)
**This parameter will only be enabled if the <code>--LogAnaIn</code> flag is being used.
*#InSampleRate - the sampling rate for the NIDAQLogger
**This parameter will be here if the <code>--LogNIDAQ</code> flag is being used.

The parameters will be located under the Source tab, in the section labeled NILogger.

==States==
The states that are available are dependent on the port specifications declared in the command line parameters. The format for the states is the following:

NIDev#[A:D]INPUT#

*The first # refers to the device number.
*The second # refers to the line number (starting at 0).
*The [A:D] denotes if the state refers to an analog (A) or a digital (D) channel.

For example, if the command parameters look like this:

<code>SignalGenerator.exe --LogNIDAQin=1 --LogDigiIn="Dev1-000100000100" --LogAnaIn="Dev1-10011000"</code>

the states that will be created are the following:

<code>
NIDev1DINPUT3 NIDev1DINPUT9 NIDev1AINPUT0
NIDev1AINPUT2 NIDev1AINPUT3
</code>
==Acquired Data==
The data (analog) that is acquired by the device is translated to make sure that all of the data will fit inside of the state's parameters. Due to this fact, the data needs to be translated back in order to return it to units of milliVolts (mV). This can be done by subtracting the data by (2000*upper voltage bound). For example, if the data was logged with the range -10V to 10V, then the data must be subtracted by 20,000.

Contributions:NIDAQLogger

2010-08-03T20:34:25Z

Jrenga:

==Synopsis==
National Instruments Data Acquisition Module

==Location==
Not yet in the repository.
(It would be in the following directory:
http://{{SERVERNAME}}/svn/trunk/src/contrib/SignalSource/NIDAQLogger)

==Versioning==
===Author===
Justin Renga (justin.renga@gmail.com)
===Version History===
===Source Code Revisions===
*Initial development: --
*Tested under: --
*Known to compile under: --
*Broken since: --

==Testing==
The NIDAQLogger has been tested with the USB-6009 and PCI-6024E National Instruments boards at sampling rates up to and including 4096Hz, with sample block sizes up to and including 1024 samples/block. Both devices were running under DAQmx driver version 8.9.5 .

==Known Issues==
There are a couple of known issues with the NIDAQLogger that are listed below:
*Occasional "glitching" may occur : the condition known as "glitching" is when some data gets swapped with slightly older data, producing a result that looks wrong.
*The NIDAQLogger, when coupled with the NIDAQmx Source Module, does not currently work at sampling rates above 8192Hz.
*Poor results may occur if the NIDAQLogger is used within 5 minutes of starting the BCI2000 computer up.

==Functional Description==
Acquires signals using National Instruments Data Acquisition boards, other devices, and the computer. Device(s) must be connected to computer beforehand.

==Parameters==
===Command Line Parameters===
====Initializing NIDAQLogger====
To begin using the NIDAQLogger module, use the <code>--LogNIDAQin</code> flag, and set it equal to 1.
To activate device(s) for specific functions, use the following flags:
*<code>--LogDigiIn</code> (for digital input)
*<code>--LogAnaIn</code> (for analog input)
The format for the inputs for the above flags is as follows: <code>[flag]="[device name]-[port specification]"</code>
Note that if <code>--LogNIDAQ</code> is used, that at least one of the two above flags MUST be used.
====Device Specification====
The device name (usually) is to be written as "Dev1" or "Dev2" (without the ""). Afterwards, use a - to indicate the device name is finished. If the device number is unclear, run the program with the <code>--LogNIDAQin</code> flag activated, and look at the Operator Log. The devices (along with their number) will be listed.
====Port Specifications====
There are two acceptable states that the user can specify for each port:
*0 - this indicates the port is INACTIVE.
*1 - this indicates the port is ACTIVE

Important: If both the NIDAQLogger and the NIDAQFilter (see [[Contributions:NIDAQFilter]]) are being used, and both are using the digital lines on the same device, make sure that any port that is being referenced in a parameter is referenced only once. One port cannot use both digital input and digital output functionality, and will cause BCI2000 to throw an error, saying that the line is RESERVED. 
====Example====
Let's assume that the user wants to use one device for both analog and digital input. The device has 8 Analog Input ports and 12 Digital I/O ports.
The user also wants to use the 3rd and 4th analog input ports, and the 4th and 10th digital ports for digital input.

The user needs to use 3 flags to accomplish this:
*<code>--LogNIDAQin=1</code> -> This flag activates the NIDAQLogger for use.
*<code>--LogDigiIn="Dev1-000100000100"</code> -> This flag indicates that the user wants to use digital I/O. "Dev1" is the name of the device connected to the computer that she wants to use. <code>0001000000100</code> indicates that the user wants ports 4 and 10 (the 1's) as ACTIVE.
*<code>--LogAnaIn="Dev1-00011000"</code> -> This flag indicates that she wants to use analog output. "Dev1" is the name of the device connected to the computer that she wants to use. <code>00011000</code> indicates that she wants to the use ports 3 and 4 on analog input.
The full command (assuming she uses this with SignalGenerator.exe) that the user would use is the following:

<code>SignalGenerator.exe --LogNIDAQin=1 --LogDigiIn="Dev1-000100000100" --LogAnaIn="Dev1-00011000"</code>

===BCI2000 Parameters===
There are two possible parameters that the user will be able to use. They are outlined below:
*#IVRanges - the available voltage ranges for analog input for the given device (where # will be replaced by the device name)
**This parameter will only be enabled if the <code>--LogAnaIn</code> flag is being used.
*#InSampleRate - the sampling rate for the NIDAQLogger
**This parameter will be here if the <code>--LogNIDAQ</code> flag is being used.

The parameters will be located under the Source tab, in the section labeled NILogger.

==States==
The states that are available are dependent on the port specifications declared in the command line parameters. The format for the states is the following:

NIDev#[A:D]INPUT#

*The first # refers to the device number.
*The second # refers to the line number (starting at 0).
*The [A:D] denotes if the state refers to an analog (A) or a digital (D) channel.

For example, if the command parameters look like this:

<code>SignalGenerator.exe --LogNIDAQin=1 --LogDigiIn="Dev1-000100000100" --LogAnaIn="Dev1-10011000"</code>

the states that will be created are the following:

<code>
NIDev1DINPUT3 NIDev1DINPUT9 NIDev1AINPUT0
NIDev1AINPUT2 NIDev1AINPUT3
</code>
==Acquired Data==
The data (analog) that is acquired by the device is translated to make sure that all of the data will fit inside of the state's parameters. Due to this fact, the data needs to be translated back in order to return it to units of milliVolts (mV). This can be done by subtracting the data by (2000*upper voltage bound). For example, if the data was logged with the range -10V to 10V, then the data must be subtracted by 20,000.

Contributions:NIDAQFilter

2010-07-27T20:50:59Z

Jrenga:

==Synopsis==
A filter that outputs different statesr from BCI2000 to outputs connected to a National Instruments Board running DAQmx 8.5 or higher.
==Location==
Not yet in the repository.
==Versioning==
===Author===
Justin Renga (justin.renga@gmail.com)
===Version History===
1.0
===Source Code Revision===
Not Applicable
==Functional Description==
The NIDAQFilter uses any DAQmx 8.5 or higher compliant board and allows the user to pipe state data from BCI2000 through the board. All necesary components must be connected to the BCI computer before initiating a module using the filter.
==Parameters==
The NIDAQFilter uses command line parameters to initialize the device(s) and set up the active ports. It then uses BCI2000 parameters for finer controls over the device, such as changing the sampling rate of the device.
===Command Line Parameters===
====Initializing the NIDAQFilter====
To begin using the NIDAQFilter, use the <code>--LogNIDAQout</code> flag and set it equal to 1. To activate device(s) for specific functions, use the following flags:
*<code>--LogDigiOut</code> --> Enable the device to use digital output characteristics
*<code>--LogAnaOut</code> --> Enable the device to use analog output characteristics
The format for the outputs for above flags is as follows:
<center><code>[flag]="[device specification]-[port specifications]"</code></center>
Please note that if <code>--LogNIDAQout</code> is enabled, then at least one of the above flags MUST be used.
====Device Specification====
The device name is to be written as "Dev1" or "Dev2" (without the quotes) in the first part of the parameter value. After the device name is specified, use a hyphen (-) to indicate the device name is finished. For example, the first part of the parameter value would look like this: <code> "Dev1-</code>.

If the device numbers are unclear, run the filter with just the <code>--LogNIDAQout</code> flag specified. The device names (along with their familiar names) will appear in the operator log.
====Port Specifications====
There are two acceptable states that the user can specify for each port that they are going to use:

*0 --> the associated port WILL NOT be used
*1 --> the associated port WILL be used

The values will be used for every single port that the user wants to use. For example, if the user wants to use ports 3 and 5 on a device with 10 ports, then the port specification for that device will be the following:

<center><code>0010100000</code></center>

Notice how even though the user wants to use only 2 ports, all 10 ports have been indicated. This is required. Any port that is not needed should be marked with a 0. If the number of ports specified in the parameter file does not match the number of ports found on the device, an error will be thrown, showing the number of ports were specified and how many ports there are for that device function.

Important: If both the NIDAQLogger([[Contributions:NIDAQLogger]]) and the NIDAQFilter are being used, and both are using the digital lines on the same device, make sure that any port that is being referenced in a parameter is referenced only once. One port cannot use both digital input and digital output functionality, and will cause BCI2000 to throw an error, saying that the line is RESERVED.
====A Completed Flag====
The following is the completed flag, whose parts were described above:

<center><code>--LogAnaOut="Dev1-0010100000"</code></center>

The above flag tells the filter that the user wants to use the analog output ports on Device 1, which has 10 ports on it. The user wants to use the 3rd and 5th ports on the device, but leave everything else unused.
===BCI2000 Parameters===
After the commandline parameters have been set, more parameters may be configured in the Configuration dialog box in BCI2000. Under the header NIDAQFilter, the following parameters MAY appear, as some of them are dependant on flags being used:
*#OVRanges [ENUMERATION] --> This parameter tells the user if there are multiple output voltage ranges that are acceptable for use. If not, then the parameter will NOT show up. The parameter is activated by the <code>--LogAnaOut</code> flag.
*FilterExpressions [MATRIX] --> This parameter allows the user to associate different states to individual output lines on the board. By clicking on the Edit Matrix button, the user will see a list of the lines that are active on the board, and a space to put an expression. This parameter will always show up, regardless of the flags being used.
==States==
===Template===
The states are constructed in a contextual manner, that is to say, they are created based on the channels that the user decides to use. The template of the state names is shown below:
<center><code>NI[device name][A:D]OUTPUT[port number-1]</code></center>
Some key things about the template:
*[device name] -> the name of the device to which the port is associated to (for example, if Device 4 is being used, then there will be a state that begins with NIDev4 will exist)
*[A:D] -> analog or digital state (an analog state has a bit width of 16, while a digital state has a bit width of 1). This is dependant on the way the device is being used, and is not settable by the user.
*[port number - 1] -> the number of the port being used (the states begin at port 0, so when port 4 is being used, the number in the state will be 3)
===Example===
If the following parameter list were used as a user's command line parameter:
<center><code>--LogNIDAQout=1 --LogAnaOut="Dev1-00100010100" --LogDigiOut="Dev2-00100001010"</code></center>
Then the following states would be produced:
<center><code>
NIDev1AOUTPUT2 NIDev1AOUTPUT6 NIDev1AOUTPUT8
NIDev2DOUTPUT2 NIDev2DOUTPUT7 NIDev2DOUTPUT9
</code></center>

Contributions:NIDAQFilter

2010-07-27T20:48:46Z

Jrenga:

=Synopsis=
A filter that outputs different statesr from BCI2000 to outputs connected to a National Instruments Board running DAQmx 8.5 or higher.
=Location=
Not yet in the repository.
=Versioning=
==Author==
Justin Renga (justin.renga@gmail.com)
==Version History==
1.0
==Source Code Revision==
Not Applicable
=Functional Description=
The NIDAQFilter uses any DAQmx 8.5 or higher compliant board and allows the user to pipe state data from BCI2000 through the board. All necesary components must be connected to the BCI computer before initiating a module using the filter.
=Parameters=
The NIDAQFilter uses command line parameters to initialize the device(s) and set up the active ports. It then uses BCI2000 parameters for finer controls over the device, such as changing the sampling rate of the device.
==Command Line Parameters==
===Initializing the NIDAQFilter===
To begin using the NIDAQFilter, use the <code>--LogNIDAQout</code> flag and set it equal to 1. To activate device(s) for specific functions, use the following flags:
*<code>--LogDigiOut</code> --> Enable the device to use digital output characteristics
*<code>--LogAnaOut</code> --> Enable the device to use analog output characteristics
The format for the outputs for above flags is as follows:
<center><code>[flag]="[device specification]-[port specifications]"</code></center>
Please note that if <code>--LogNIDAQout</code> is enabled, then at least one of the above flags MUST be used.
===Device Specification===
The device name is to be written as "Dev1" or "Dev2" (without the quotes) in the first part of the parameter value. After the device name is specified, use a hyphen (-) to indicate the device name is finished. For example, the first part of the parameter value would look like this: <code> "Dev1-</code>.

If the device numbers are unclear, run the filter with just the <code>--LogNIDAQout</code> flag specified. The device names (along with their familiar names) will appear in the operator log.
===Port Specifications===
There are two acceptable states that the user can specify for each port that they are going to use:

*0 --> the associated port WILL NOT be used
*1 --> the associated port WILL be used

The values will be used for every single port that the user wants to use. For example, if the user wants to use ports 3 and 5 on a device with 10 ports, then the port specification for that device will be the following:

<center><code>0010100000</code></center>

Notice how even though the user wants to use only 2 ports, all 10 ports have been indicated. This is required. Any port that is not needed should be marked with a 0. If the number of ports specified in the parameter file does not match the number of ports found on the device, an error will be thrown, showing the number of ports were specified and how many ports there are for that device function.

Important: If both the NIDAQLogger([[Contributions:NIDAQLogger]]) and the NIDAQFilter are being used, and both are using the digital lines on the same device, make sure that any port that is being referenced in a parameter is referenced only once. One port cannot use both digital input and digital output functionality, and will cause BCI2000 to throw an error, saying that the line is RESERVED.
===A Completed Flag===
The following is the completed flag, whose parts were described above:

<center><code>--LogAnaOut="Dev1-0010100000"</code></center>

The above flag tells the filter that the user wants to use the analog output ports on Device 1, which has 10 ports on it. The user wants to use the 3rd and 5th ports on the device, but leave everything else unused.
==BCI2000 Parameters==
After the commandline parameters have been set, more parameters may be configured in the Configuration dialog box in BCI2000. Under the header NIDAQFilter, the following parameters MAY appear, as some of them are dependant on flags being used:
*#OVRanges [ENUMERATION] --> This parameter tells the user if there are multiple output voltage ranges that are acceptable for use. If not, then the parameter will NOT show up. The parameter is activated by the <code>--LogAnaOut</code> flag.
*FilterExpressions [MATRIX] --> This parameter allows the user to associate different states to individual output lines on the board. By clicking on the Edit Matrix button, the user will see a list of the lines that are active on the board, and a space to put an expression. This parameter will always show up, regardless of the flags being used.
=States=
==Template==
The states are constructed in a contextual manner, that is to say, they are created based on the channels that the user decides to use. The template of the state names is shown below:
<center><code>NI[device name][A:D]OUTPUT[port number-1]</code></center>
Some key things about the template:
*[device name] -> the name of the device to which the port is associated to (for example, if Device 4 is being used, then there will be a state that begins with NIDev4 will exist)
*[A:D] -> analog or digital state (an analog state has a bit width of 16, while a digital state has a bit width of 1). This is dependant on the way the device is being used, and is not settable by the user.
*[port number - 1] -> the number of the port being used (the states begin at port 0, so when port 4 is being used, the number in the state will be 3)
==Example==
If the following parameter list were used as a user's command line parameter:
<center><code>--LogNIDAQout=1 --LogAnaOut="Dev1-00100010100" --LogDigiOut="Dev2-00100001010"</code></center>
Then the following states would be produced:
<center><code>
NIDev1AOUTPUT2 NIDev1AOUTPUT6 NIDev1AOUTPUT8
NIDev2DOUTPUT2 NIDev2DOUTPUT7 NIDev2DOUTPUT9
</code></center>

Contributions:NIDAQLogger

2010-07-27T20:40:23Z

Jrenga:

==Synopsis==
National Instruments Data Acquisition Module

==Location==
Not yet in the repository.
(It would be in the following directory:
http://{{SERVERNAME}}/svn/trunk/src/contrib/SignalSource/NIDAQLogger)

==Versioning==
===Author===
Justin Renga (justin.renga@gmail.com)
===Version History===
===Source Code Revisions===
*Initial development: --
*Tested under: --
*Known to compile under: --
*Broken since: --

==Functional Description==
Acquires signals using National Instruments Data Acquisition boards, other devices, and the computer. Device must be connected to computer beforehand.

==Parameters==
===Command Line Parameters===
====Initializing NIDAQLogger====
To begin using the NIDAQLogger module, use the <code>--LogNIDAQin</code> flag, and set it equal to 1.
To activate device(s) for specific functions, use the following flags:
*<code>--LogDigiIn</code> (for digital input)
*<code>--LogAnaIn</code> (for analog input)
The format for the inputs for the above flags is as follows: <code>[flag]="[device name]-[port specification]"</code>
Note that if <code>--LogNIDAQ</code> is used, that at least one of the two above flags MUST be used.
====Device Specification====
The device name (usually) is to be written as "Dev1" or "Dev2" (without the ""). Afterwards, use a - to indicate the device name is finished. If the device number is unclear, run the program with the <code>--LogNIDAQin</code> flag activated, and look at the Operator Log. The devices (along with their number) will be listed.
====Port Specifications====
There are two acceptable states that the user can specify for each port:
*0 - this indicates the port is INACTIVE.
*1 - this indicates the port is ACTIVE

Important: If both the NIDAQLogger and the NIDAQFilter[[Contributions:NIDAQFilter]] are being used, and both are using the digital lines on the same device, make sure that any port that is being referenced in a parameter is referenced only once. One port cannot use both digital input and digital output functionality, and will cause BCI2000 to throw an error, saying that the line is RESERVED. 
====Example====
Let's assume that the user wants to use one device for both analog and digital input. The device has 8 Analog Input ports and 12 Digital I/O ports.
The user also wants to use the 3rd and 4th analog input ports, and the 4th and 10th digital ports for digital input.

The user needs to use 3 flags to accomplish this:
*<code>--LogNIDAQin=1</code> -> This flag activates the NIDAQLogger for use.
*<code>--LogDigiIn="Dev1-000100000100"</code> -> This flag indicates that the user wants to use digital I/O. "Dev1" is the name of the device connected to the computer that she wants to use. <code>0001000000100</code> indicates that the user wants ports 4 and 10 (the 1's) as ACTIVE.
*<code>--LogAnaIn="Dev1-00011000"</code> -> This flag indicates that she wants to use analog output. "Dev1" is the name of the device connected to the computer that she wants to use. <code>00011000</code> indicates that she wants to the use ports 3 and 4 on analog input.
The full command (assuming she uses this with SignalGenerator.exe) that the user would use is the following:

<code>SignalGenerator.exe --LogNIDAQin=1 --LogDigiIn="Dev1-000100000100" --LogAnaIn="Dev1-00011000"</code>

===BCI2000 Parameters===
There are two possible parameters that the user will be able to use. They are outlined below:
*#IVRanges - the available voltage ranges for analog input for the given device (where # will be replaced by the device name)
**This parameter will only be enabled if the <code>--LogAnaIn</code> flag is being used.
*#InSampleRate - the sampling rate for the NIDAQLogger
**This parameter will be here if the <code>--LogNIDAQ</code> flag is being used.

The parameters will be located under the Source tab, in the section labeled NILogger.

==States==
The states that are available are dependent on the port specifications declared in the command line parameters. The format for the states is the following:

NIDev#[A:D]INPUT#

*The first # refers to the device number.
*The second # refers to the line number (starting at 0).
*The [A:D] denotes if the state refers to an analog (A) or a digital (D) channel.

For example, if the command parameters look like this:

<code>SignalGenerator.exe --LogNIDAQin=1 --LogDigiIn="Dev1-000100000100" --LogAnaIn="Dev1-10011000"</code>

the states that will be created are the following:

<code>
NIDev1DINPUT3 NIDev1DINPUT9 NIDev1AINPUT0
NIDev1AINPUT2 NIDev1AINPUT3
</code>
==Acquired Data==
The data (analog) that is acquired by the device is translated to make sure that all of the data will fit inside of the state's parameters. Due to this fact, the data needs to be translated back in order to return it to units of milliVolts (mV). This can be done by subtracting the data by (2000*upper voltage bound). For example, if the data was logged with the range -10V to 10V, then the data must be subtracted by 20,000.

Contributions:NIDAQFilter

2010-07-27T20:12:13Z

Jrenga:

=Synopsis=
A filter that outputs different statesr from BCI2000 to outputs connected to a National Instruments Board running DAQmx 8.5 or higher.
=Location=
Not yet in the repository.
=Versioning=
==Author==
Justin Renga (justin.renga@gmail.com)
==Version History==
1.0
==Source Code Revision==
=Functional Description=
The NIDAQFilter uses any DAQmx 8.5 or higher compliant board and allows the user to pipe state data from BCI2000 through the board. All necesary components must be connected to the BCI computer before initiating a module using the filter.
=Parameters=
The NIDAQFilter uses command line parameters to initialize the device(s) and set up the active ports. It then uses BCI2000 parameters for finer controls over the device, such as changing the sampling rate of the device.
==Command Line Parameters==
===Initializing the NIDAQFilter===
To begin using the NIDAQFilter, use the <code>--LogNIDAQout</code> flag and set it equal to 1. To activate device(s) for specific functions, use the following flags:
*<code>--LogDigiOut</code> --> Enable the device to use digital output characteristics
*<code>--LogAnaOut</code> --> Enable the device to use analog output characteristics
The format for the outputs for above flags is as follows:
<center><code>[flag]="[device specification]-[port specifications]"</code></center>
Please note that if <code>--LogNIDAQout</code> is enabled, then at least one of the above flags MUST be used.
===Device Specification===
The device name is to be written as "Dev1" or "Dev2" (without the quotes) in the first part of the parameter value. After the device name is specified, use a hyphen (-) to indicate the device name is finished. For example, the first part of the parameter value would look like this: <code> "Dev1-</code>.

If the device numbers are unclear, run the filter with just the <code>--LogNIDAQout</code> flag specified. The device names (along with their familiar names) will appear in the operator log.
===Port Specifications===
There are two acceptable states that the user can specify for each port that they are going to use:
*0 --> the associated port WILL NOT be used
*1 --> the associated port WILL be used

The values will be used for every single port that the user wants to use. For example, if the user wants to use ports 3 and 5 on a device with 10 ports, then the port specification for that device will be the following:
<center><code>0010100000</code></center>

Notice how even though the user wants to use only 2 ports, all 10 ports have been indicated. This is required. Any port that is not needed should be marked with a 0. If the number of ports specified in the parameter file does not match the number of ports found on the device, an error will be thrown, showing the number of ports were specified and how many ports there are for that device function.

Important: If both the NIDAQLogger([[Contributions:NIDAQLogger]]) and the NIDAQFilter are being used, and both are using the digital lines on the same device, make sure that any port that is being referenced in a parameter is referenced only once. One port cannot use both digital input and digital output functionality, and will cause BCI2000 to throw an error, saying that the line is RESERVED.
===A Completed Flag===
The following is the completed flag, whose parts were described above:
<center><code>--LogAnaOut="Dev1-0010100000"</code></center>

The above flag tells the filter that the user wants to use the analog output ports on Device 1, which has 10 ports on it. The user wants to use the 3rd and 5th ports on the device, but leave everything else unused.
==BCI2000 Parameters==
After the commandline parameters have been set, more parameters may be configured in the Configuration dialog box in BCI2000. Under the header NIDAQFilter, the following parameters MAY appear, as some of them are dependant on flags being used:
*#OVRanges --> This parameter tells the user if there are multiple output voltage ranges that are acceptable for use. If not, then the parameter will NOT show up. The parameter is an enumeration, and is activated by the <code>--LogAnaOut</code> flag.
*#OutSamplingRate
*FilterExpressions
=States=
==Template==
The states are constructed in a contextual manner, that is to say, they are created based on the channels that the user decides to use. The template of the state names is shown below:
<center><code>NI[device name][A:D]OUTPUT[port number-1]</code></center>
Some key things about the template:
*[device name] -> the name of the device to which the port is associated to (for example, if Device 4 is being used, then there will be a state that begins with NIDev4 will exist)
*[A:D] -> analog or digital state (an analog state has a bit width of 16, while a digital state has a bit width of 1). This is dependant on the way the device is being used, and is not settable by the user.
*[port number - 1] -> the number of the port being used (the states begin at port 0, so when port 4 is being used, the number in the state will be 3)
==Example==
If the following parameter list were used as a user's command line parameter:
<center><code>--LogNIDAQout=1 --LogAnaOut="Dev1-00100010100" --LogDigiOut="Dev2-00100001010"</code></center>
Then the following states would be produced:
<center><code>
NIDev1AOUTPUT2 NIDev1AOUTPUT6 NIDev1AOUTPUT8
NIDev2DOUTPUT2 NIDev2DOUTPUT7 NIDev2DOUTPUT9
</code></center>

Contributions:NIDAQFilter

2010-07-27T19:53:01Z

Jrenga:

=Synopsis=
A filter that outputs different statesr from BCI2000 to outputs connected to a National Instruments Board running DAQmx 8.5 or higher.
=Location=
Not yet in the repository.
=Versioning=
==Author==
Justin Renga (justin.renga@gmail.com)
==Version History==
1.0
==Source Code Revision==
=Functional Description=
=Parameters=
The NIDAQFilter uses command line parameters to initialize the device(s) and set up the active ports. It then uses BCI2000 parameters for finer controls over the device, such as changing the sampling rate of the device.
==Command Line Parameters==
===Initializing the NIDAQFilter===
To begin using the NIDAQFilter, use the <code>--LogNIDAQout</code> flag and set it equal to 1. To activate device(s) for specific functions, use the following flags:
*<code>--LogDigiOut</code> --> Enable the device to use digital output characteristics
*<code>--LogAnaOut</code> --> Enable the device to use analog output characteristics
The format for the outputs for above flags is as follows:
<center><code>[flag]="[device specification]-[port specifications]"</code></center>
Please note that if <code>--LogNIDAQout</code> is enabled, then at least one of the above flags MUST be used.
===Device Specification===
The device name is to be written as "Dev1" or "Dev2" (without the quotes) in the first part of the parameter value. After the device name is specified, use a hyphen (-) to indicate the device name is finished. For example, the first part of the parameter value would look like this: <code> "Dev1-</code>.

If the device numbers are unclear, run the filter with just the <code>--LogNIDAQout</code> flag specified. The device names (along with their familiar names) will appear in the operator log.
===Port Specifications===
There are two acceptable states that the user can specify for each port that they are going to use:
*0 --> the associated port WILL NOT be used
*1 --> the associated port WILL be used

The values will be used for every single port that the user wants to use. For example, if the user wants to use ports 3 and 5 on a device with 10 ports, then the port specification for that device will be the following:
<center><code>0010100000</code></center>

Notice how even though the user wants to use only 2 ports, all 10 ports have been indicated. This is required. Any port that is not needed should be marked with a 0. If the number of ports specified in the parameter file does not match the number of ports found on the device, an error will be thrown, showing the number of ports were specified and how many ports there are for that device function.

Important: If both the NIDAQLogger([[Contributions:NIDAQLogger]]) and the NIDAQFilter are being used, and both are using the digital lines on the same device, make sure that any port that is being referenced in a parameter is referenced only once. One port cannot use both digital input and digital output functionality, and will cause BCI2000 to throw an error, saying that the line is RESERVED.
===A Completed Flag===
The following is the completed flag, whose parts were described above:
<center><code>--LogAnaOut="Dev1-0010100000"</code></center>

The above flag tells the filter that the user wants to use the analog output ports on Device 1, which has 10 ports on it. The user wants to use the 3rd and 5th ports on the device, but leave everything else unused.
==BCI2000 Parameters==
After the commandline parameters have been set, more parameters may be configured in the Configuration dialog box in BCI2000. Under the header NIDAQFilter, the following parameters MAY appear, as some of them are dependant on flags being used:
*#OVRanges --> This parameter tells the user if there are multiple output voltage ranges that are acceptable for use. If not, then the parameter will NOT show up. The parameter is an enumeration, and is activated by the <code>--LogAnaOut</code> flag.
*#OutSamplingRate
*FilterExpressions
=States=
==Template==
The states are constructed in a contextual manner, that is to say, they are created based on the channels that the user decides to use. The template of the state names is shown below:
<center><code>NI[device name][A:D]OUTPUT[port number-1]</code></center>
Some key things about the template:
*[device name] -> the name of the device to which the port is associated to (for example, if Device 4 is being used, then there will be a state that begins with NIDev4 will exist)
*[A:D] -> analog or digital state (an analog state has a bit width of 16, while a digital state has a bit width of 1). This is dependant on the way the device is being used, and is not settable by the user.
*[port number - 1] -> the number of the port being used (the states begin at port 0, so when port 4 is being used, the number in the state will be 3)
==Example==
If the following parameter list were used as a user's command line parameter:
<center><code>--LogNIDAQout=1 --LogAnaOut="Dev1-00100010100" --LogDigiOut="Dev2-00100001010"</code></center>
Then the following states would be produced:
<center><code>
NIDev1AOUTPUT2 NIDev1AOUTPUT6 NIDev1AOUTPUT8
NIDev2DOUTPUT2 NIDev2DOUTPUT7 NIDev2DOUTPUT9
</code></center>

Contributions:NIDAQFilter

2010-07-27T19:08:33Z

Jrenga:

Contributions:NIDAQLogger

2010-07-26T20:40:26Z

Jrenga:

==Synopsis==
National Instruments Data Acquisition Module

==Location==
Not yet in the repository.
(It would be in the following directory:
http://{{SERVERNAME}}/svn/trunk/src/contrib/SignalSource/NIDAQLogger)

==Versioning==
===Author===
Justin Renga (justin.renga@gmail.com)
===Version History===
===Source Code Revisions===
*Initial development: --
*Tested under: --
*Known to compile under: --
*Broken since: --

==Functional Description==
Acquires signals using National Instruments Data Acquisition boards, other devices, and the computer. Device must be connected to computer beforehand.

==Parameters==
===Command Line Parameters===
====Initializing NIDAQLogger====
To begin using the NIDAQLogger module, use the <code>--LogNIDAQin</code> flag, and set it equal to 1.
To activate device(s) for specific functions, use the following flags:
*<code>--LogDigiIn</code> (for digital input)
*<code>--LogAnaIn</code> (for analog input)
The format for the inputs for the above flags is as follows: <code>[flag]="[device name]-[port specification]"</code>
Note that if <code>--LogNIDAQ</code> is used, that at least one of the three above flags MUST be used.
====Device Specification====
The device name (usually) is to be written as "Dev1" or "Dev2" (without the ""). Afterwards, use a - to indicate the device name is finished. If the device number is unclear, run the program with the <code>--LogNIDAQin</code> flag activated, and look at the Operator Log. The devices (along with their number) will be listed.
====Port Specifications====
There are two acceptable states that the user can specify for each port:
*0 - this indicates the port is INACTIVE.
*1 - this indicates the port is ACTIVE

Important Note: If using the logger with the NIDAQFilter and using digital input / output, make sure only one of the programs uses a specified digital line. If both programs attempt to use the same channel for conflicting purposes, the programs will throw errors indicating the line is RESERVED.
====Example====
Let's assume that the user wants to use one device for both analog and digital input. The device has 8 Analog Input ports and 12 Digital I/O ports.
The user also wants to use the 3rd and 4th analog input ports, and the 4th and 10th digital ports for digital input.

The user needs to use 3 flags to accomplish this:
*<code>--LogNIDAQin=1</code>
**This flag activates the NIDAQLogger for use.
*<code>--LogDigiIn="Dev1-000100000100"</code>
**This flag indicates that the user wants to use digital I/O.
**"Dev1" is the name of the device connected to the computer that she wants to use.
**<code>0001000000100</code> indicates that the user wants ports 4 and 10 (the 1's) as ACTIVE.
*<code>--LogAnaIn="Dev1-00011000"</code>
**This flag indicates that she wants to use analog output.
**"Dev1" is the name of the device connected to the computer that she wants to use.
**<code>00011000</code> indicates that she wants to the use ports 3 and 4 on analog input.
The full command (assuming she uses this with SignalGenerator.exe) that the user would use is the following:

<code>SignalGenerator.exe --LogNIDAQin=1 --LogDigiIn="Dev1-000100000100" --LogAnaIn="Dev1-00011000"</code>

===BCI2000 Parameters===
There are two possible parameters that the user will be able to use. They are outlined below:
*#IVRanges - the available voltage ranges for analog input for the given device (where # will be replaced by the device name)
**This parameter will only be enabled if the <code>--LogAnaIn</code> flag is being used.
*#InSampleRate - the sampling rate for the NIDAQLogger
**This parameter will be here if the <code>--LogNIDAQ</code> flag is being used.

The parameters will be located under the Source tab, in the section labeled LogNIDAQ.

==States==
The states that are available are dependent on the port specifications declared in the command line parameters. The format for the states is the following:

NIDev#[A:D]INPUT#

*The first # refers to the device number.
*The second # refers to the line number (starting at 0).
*The [A:D] denotes if the state refers to an analog (A) or a digital (D) channel.

For example, if the command parameters look like this:

<code>SignalGenerator.exe --LogNIDAQin=1 --LogDigiIn="Dev1-000100000100" --LogAnaIn="Dev1-10011000"</code>

the states that will be created are the following:

*NIDev1DINPUT3
*NIDev1DINPUT9
*NIDev1AINPUT0
*NIDev1AINPUT2
*NIDev1AINPUT3

==Acquired Data==
The data (analog) that is acquired by the device is translated to make sure that all of the data will fit inside of the state's parameters. Due to this fact, the data needs to be translated back in order to return it to units of milliVolts (mV). This can be done by subtracting the data by (2000*upper voltage bound). For example, if the data was logged with the range -10V to 10V, then the data must be subtracted by 20,000.

Contributions:NIDAQLogger

2010-07-26T20:33:02Z

Jrenga:

==Synopsis==
National Instruments Data Acquisition Module

==Location==
Not yet in the repository.
(It would be in the following directory:
http://{{SERVERNAME}}/svn/trunk/src/contrib/SignalSource/NIDAQLogger)

==Versioning==
===Author===
Justin Renga (justin.renga@gmail.com)
===Version History===
===Source Code Revisions===
*Initial development: --
*Tested under: --
*Known to compile under: --
*Broken since: --

==Functional Description==
Acquires signals using National Instruments Data Acquisition boards, other devices, and the computer. Device must be connected to computer beforehand.

==Parameters==
===Command Line Parameters===
====Initializing NIDAQLogger====
To begin using the NIDAQLogger module, use the <code>--LogNIDAQin</code> flag, and set it equal to 1.
To activate device(s) for specific functions, use the following flags:
*<code>--LogDigiIn</code> (for digital input)
*<code>--LogAnaIn</code> (for analog input)
The format for the inputs for the above flags is as follows: <code>[flag]="[device name]-[port specification]"</code>
Note that if <code>--LogNIDAQ</code> is used, that at least one of the three above flags MUST be used.
====Device Specification====
The device name (usually) is to be written as "Dev1" or "Dev2" (without the ""). Afterwards, use a - to indicate the device name is finished. If the device number is unclear, run the program with the <code>--LogNIDAQin</code> flag activated, and look at the Operator Log. The devices (along with their number) will be listed.
====Port Specifications====
There are two acceptable states that the user can specify for each port:
*0 - this indicates the port is INACTIVE.
*1 - this indicates the port is ACTIVE
====Example====
Let's assume that the user wants to use one device for both analog and digital input. The device has 8 Analog Input ports and 12 Digital I/O ports.
The user also wants to use the 3rd and 4th analog input ports, and the 4th and 10th digital ports for digital input.

The user needs to use 3 flags to accomplish this:
*<code>--LogNIDAQin=1</code>
**This flag activates the NIDAQLogger for use.
*<code>--LogDigiIn="Dev1-000100000100"</code>
**This flag indicates that the user wants to use digital I/O.
**"Dev1" is the name of the device connected to the computer that she wants to use.
**<code>0001000000100</code> indicates that the user wants ports 4 and 10 (the 1's) as ACTIVE.
*<code>--LogAnaIn="Dev1-00011000"</code>
**This flag indicates that she wants to use analog output.
**"Dev1" is the name of the device connected to the computer that she wants to use.
**<code>00011000</code> indicates that she wants to the use ports 3 and 4 on analog input.
The full command (assuming she uses this with SignalGenerator.exe) that the user would use is the following:

<code>SignalGenerator.exe --LogNIDAQin=1 --LogDigiIn="Dev1-000100000100" --LogAnaIn="Dev1-00011000"</code>

===BCI2000 Parameters===
There are two possible parameters that the user will be able to use. They are outlined below:
*#IVRanges - the available voltage ranges for analog input for the given device (where # will be replaced by the device name)
**This parameter will only be enabled if the <code>--LogAnaIn</code> flag is being used.
*#InSampleRate - the sampling rate for the NIDAQLogger
**This parameter will be here if the <code>--LogNIDAQ</code> flag is being used.

The parameters will be located under the Source tab, in the section labeled LogNIDAQ.

==States==
The states that are available are dependent on the port specifications declared in the command line parameters. The format for the states is the following:

NIDev#[A:D]INPUT#

*The first # refers to the device number.
*The second # refers to the line number (starting at 0).
*The [A:D] denotes if the state refers to an analog (A) or a digital (D) channel.

For example, if the command parameters look like this:

<code>SignalGenerator.exe --LogNIDAQin=1 --LogDigiIn="Dev1-000100000100" --LogAnaIn="Dev1-10011000"</code>

the states that will be created are the following:

*NIDev1DINPUT3
*NIDev1DINPUT9
*NIDev1AINPUT0
*NIDev1AINPUT2
*NIDev1AINPUT3

==Acquired Data==
The data (analog) that is acquired by the device is translated to make sure that all of the data will fit inside of the state's parameters. Due to this fact, the data needs to be translated back in order to return it to units of milliVolts (mV). This can be done by subtracting the data by (2000*upper voltage bound). For example, if the data was logged with the range -10V to 10V, then the data must be subtracted by 20,000.

Contributions:NIDAQLogger

2010-07-22T20:31:15Z

Jrenga:

==Synopsis==
National Instruments Data Acquisition Module

==Location==
Not yet in the repository.
(It would be in the following directory:
http://{{SERVERNAME}}/svn/trunk/src/contrib/SignalSource/NIDAQLogger)

==Versioning==
===Author===
Justin Renga (justin.renga@gmail.com)
===Version History===
===Source Code Revisions===
*Initial development: --
*Tested under: --
*Known to compile under: --
*Broken since: --

==Functional Description==
Acquires signals using National Instruments Data Acquisition boards, other devices, and the computer. Device must be connected to computer beforehand.

==Parameters==
===Command Line Parameters===
====Initializing NIDAQLogger====
To begin using the NIDAQLogger module, use the <code>--LogNIDAQin</code> flag, and set it equal to 1.
To activate device(s) for specific functions, use the following flags:
*<code>--LogDigiIn</code> (for digital input)
*<code>--LogAnaIn</code> (for analog input)
The format for the inputs for the above flags is as follows: <code>[flag]="[device name]-[port specification]"</code>
Note that if <code>--LogNIDAQ</code> is used, that at least one of the three above flags MUST be used.
====Device Specification====
The device name (usually) is to be written as "Dev1" or "Dev2" (without the ""). Afterwards, use a - to indicate the device name is finished. If the device number is unclear, run the program with the <code>--LogNIDAQin</code> flag activated, and look at the Operator Log. The devices (along with their number) will be listed.
====Port Specifications====
There are three acceptable states that the user can specify for each port:
*0 - this indicates the port is INACTIVE.
*1 - this indicates the port is ACTIVE
====Example====
Let's assume that the user wants to use one device for both analog and digital input. The device has 8 Analog Input ports and 12 Digital I/O ports.
The user also wants to use the 3rd and 4th analog input ports, and the 4th and 10th digital ports for digital input.

The user needs to use 3 flags to accomplish this:
*<code>--LogNIDAQin=1</code>
**This flag activates the NIDAQLogger for use.
*<code>--LogDigiIn="Dev1-000100000100"</code>
**This flag indicates that the user wants to use digital I/O.
**"Dev1" is the name of the device connected to the computer that she wants to use.
**<code>0001000000100</code> indicates that the user wants ports 4 and 10 (the 1's) as ACTIVE.
*<code>--LogAnaIn="Dev1-00011000"</code>
**This flag indicates that she wants to use analog output.
**"Dev1" is the name of the device connected to the computer that she wants to use.
**<code>00011000</code> indicates that she wants to the use ports 3 and 4 on analog input.
The full command (assuming she uses this with SignalGenerator.exe) that the user would use is the following:

<code>SignalGenerator.exe --LogNIDAQin=1 --LogDigiIn="Dev1-000100000100" --LogAnaIn="Dev1-00011000"</code>

===BCI2000 Parameters===
There are three possible parameters that the user will be able to use. They are outlined below:
*#IVRanges - the available voltage ranges for analog input for the given device (where # will be replaced by the device name)
**This parameter will only be enabled if the <code>--LogAnaIn</code> flag is being used..
*#InSampleRate - the sampling rate for the NIDAQLogger
**This parameter will be here if the <code>--LogNIDAQ</code> flag is being used.

The parameters will be located under the Source tab, in the section labeled LogNIDAQ.

==States==
The states that are available are dependent on the port specifications declared in the command line parameters. The format for the states is the following:

NIDev#[A:D]INPUT#

*The first # refers to the device number.
*The second # refers to the line number (starting at 0).
*The [A:D] denotes if the state refers to an analog (A) or a digital (D) channel.

For example, if the command parameters look like this:

<code>SignalGenerator.exe --LogNIDAQin=1 --LogDigiIn="Dev1-000100000100" --LogAnaIn="Dev1-10011000"</code>

the states that will be created are the following:

*NIDev1DINPUT3
*NIDev1DINPUT9
*NIDev1AINPUT0
*NIDev1AINPUT2
*NIDev1AINPUT3

==Acquired Data==
The data (analog) that is acquired by the device is translated to make sure that all of the data will fit inside of the state's parameters. Due to this fact, the data needs to be translated back in order to return it to units of milliVolts (mV). This can be done by subtracting the data by (2000*upper voltage bound). For example, if the data was logged with the range -10V to 10V, then the data must be subtracted by 20,000.

Contributions:Emotiv

2010-06-30T17:56:28Z

Jrenga:

==Synopsis==
The Emotiv DAQ is an in-expensive yet fully featured EEG device. It is aimed toward the gaming market, but with a purchase of the "Research Edition" of the Emotiv SDK, raw EEG can be acquired from the device for use in BCI2000. This documentation details the Emotiv source module.

==Location==
http://{{SERVERNAME}}/svn/branches/3.0/src/contrib/SignalSource/Emotiv

==Versioning==

===Authors===
Griffin Milsap (griffin.milsap@gmail.com)
Rensselaer Polytechnic Institute

===Version History===

===Source Code Revisions===

==Functional Description==
Acquires signal data from the Emotiv device. Also captures gyro data and writes it to states.

The output from the Emotiv is in muV, however it has quite a large DC Offset of about 4000~4200 units. The remaining DC offset comes from such factors as stored potential in the subject, and offsets added in the library to facilitate plotting. As such, a 0.1 Hz high pass filter is applied in the source module to the output signal. This effectively eliminates extra DC Offset. You will notice a "Settling Time" before the signals all reach an approximate 0 DC Offset. This time is about 10 to 15 seconds. It would be advisable to wait until the signal has settled out before proceeding.

==Installation==
Compile the Emotiv module using CMake and your compiler. Currently only Visual Studio libraries for the Emotiv API are provided. The resulting Emotiv.exe should be placed in the prog directory automatically.
Copy the '''edk.dll''' and '''edk_utils.dll''' found in http://{{SERVERNAME}}/svn/branches/3.0/src/contrib/SignalSource/Emotiv/dll to the prog directory for the module to work.

==Parameters==
* '''SourceCh''' must be set to 14. The Emotiv has 14 channels not counting the ground and ref.
* '''SamplingRate''' must be set to 128. The current Emotiv device only outputs 128 samples per second, though its internal sample rate before filtering is 2048 Hz.
* '''SampleBlockSize''' is the number of samples to acquire for every system clock. The recommended value here is 4, causing 128/4 or 32 system clocks per second.
* '''ChannelNames''' is a list of names for the channels in the output signal. According to the 10-20 International system, '''this should be set to "AF3 F7 F3 FC5 T7 P7, O1, O2 P8 T8 FC6 F4 F8 AF4" '''. You can set the channel names to whatever you would like, but the module will still warn you if the channel names are not set likewise.
* '''SourceChOffset''' is a list of DC offsets to be applied to the signal output before the signal leaves the source module. Due to the filtering done by the source module, '''a DC Offset of 0 is required for each channel'''
* '''SourceChGain''' is a list of signal gains which transform the signal output to muV. The API already provides output in muV. The SourceChGain '''must be set to 1 for each channel'''.
* '''ConnectionType''' defines the way you would like to connect to the device. If you're using SDKLite, you'll need to connect to the device through the EmoComposer program. If you choose "EmoComposer" for this parameter, you must also set EmoComposerIP. If you're using a direct connection and you have a research edition of the Emotiv device connected to the same computer, just leave this parameter as "Direct". NOTE: EmoComposer connections are untested in this program, though they should work. It should be noted, however, that connecting to the device through EmoComposer may result in poor system performance due to the nature of a socketed connection to another program which is acquiring the signal.
* '''EmoComposerIP''' is where you put the IP of the computer running the EmoComposer software. '''This parameter is NOT REQUIRED if you're using a "Direct" connection.''' See '''"ConnectionType"''' for more details.

==States==
* '''EmotivGyroX''' is a 32 bit floating point number which represents the x axis of the onboard Emotiv gyro.
* '''EmotivGyroY''' is a 32 bit floating point number which represents the y axis of the onboard Emotiv gyro.
These states are helpful for distinguishing head movements and using them to filter artifacts from your signal. '''Note: These states are interpreted by the BCI2000 system to be 32 bit integers. If you interpret these numbers at the bit level to be IEEE 754 Floating point numbers, you get the gyro output.

States regarding contact quality, and artifact causing physical motions are in the works.

==Future Work==
A visualization panel which shows real time contact quality is in the works. This panel will allow the experimenter to see the current quality of the seating of the Emotiv on the subject's head, as well as important figures such as signal quality, head movement, and battery life of the device.

Due to the nature of the signal processing that the Emotiv Software suite provides, it is possible to record facial movements such as eye blinks and jaw clenching into the states as well. This could allow for detailed filtering of signal artifacts from the output and could greatly enhance the quality of the final recording. These states are in the works.

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

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

Contributions:NIDAQLogger

2010-06-29T18:30:54Z

Jrenga:

==Synopsis==
National Instruments Data Acquisition Module

==Location==
Not yet in the repository.
(It would be in the following directory:
http://{{SERVERNAME}}/svn/trunk/src/contrib/SignalSource/NIDAQLogger)

==Versioning==
===Author===
Justin Renga (justin.renga@gmail.com)
===Version History===
===Source Code Revisions===
*Initial development: --
*Tested under: --
*Known to compile under: --
*Broken since: --

==Functional Description==
Acquires/Generates signals to/from National Instruments Data Acquisition boards, other devices, and the computer. Device must be connected to computer beforehand.

==Parameters==
===Command Line Parameters===
====Initializing NIDAQLogger====
To begin using the NIDAQLogger module, use the <code>--LogNIDAQ</code> flag (on SignalGenerator.exe), set equal to 1.
To activate device(s) for specific functions, use the following flags:
*<code>--LogNIDIO</code> (for digital input/output)
*<code>--LogNIAI</code> (for analog input)
*<code>--LogNIAO</code> (for analog output)
The format for the inputs for the above flags is as follows: <code>[flag]="[device name]-[port specification]"</code>
Note that if <code>--LogNIDAQ</code> is used, that at least one of the three above flags MUST be used.
====Device Specification====
The device name (usually) is to be written as "dev1" or "dev2" (without the ""). Afterwards, use a - to indicate the device name is finished.
====Digital Port Specifications====
There are three acceptable states that the user can specify for each digital port:
*0 - this indicates the port is INACTIVE.
*1 - this indicates the port is to be used as INPUT
*2 - this indicates the port is to be used as OUTPUT
====Analog Port Specifications====
There are two acceptable states that the user can specify for each analog port (both input and output):
*0 - this indicates the port is INACTIVE
*1 - this indicates the port is ACTIVE
====Example====
Let's assume that the user wants to use one device for both digital input/output and analog output. The device has 2 Analog Output ports and 12 Digital I/O ports.
The user also wants to use the 1st analog output port, the 7th digital port as Digital Output, and the 4th and 10th digital ports as Digital Input.

The user needs to use 3 flags to accomplish this:
*<code>--LogNIDAQ=1</code>
**This flag activates the NIDAQLogger for use.
*<code>--LogNIDIO="dev1-000100200100"</code>
**This flag indicates that the user wants to use digital I/O.
**"dev1" is the name of the device connected to the computer that she wants to use.
**<code>0001000200100</code> indicates that the user wants to use ports 4 and 10 (the 1's) as INPUT, and port 7 (the 2) as OUTPUT
*<code>--LogNIAO="dev1-10"</code>
**This flag indicates that she wants to use analog output.
**"dev1" is the name of the device connected to the computer that she wants to use.
**<code>10</code> indicates that she wants to the use port 1 on analog output.

The full command that the user would use is the following:

<code>SignalGenerator.exe --LogNIDAQ=1 --LogNIDIO="dev1-000100200100" --LogNIAO="dev1-10"</code>
===BCI2000 Parameters===
There are three possible parameters that the user will be able to use. They are outlined below:
*#IVRange - the available voltage ranges for analog input for the given device (where # will be replaced by the device name)
**This parameter will only be enabled if the <code>--LogNIAI</code> flag is being used.
*#OVRange - the available voltage ranges for analog output for the given device (where # will be replaced by the device name)
**This parameter will only be enabled if the <code>--LogNIAO</code> flag is being used, or there are multiple possible ranges.
*NIDAQSampleRate - the sampling rate for the NIDAQLogger
**This parameter will be here if the <code>--LogNIDAQ</code> flag is being used.

The parameters will be located under the Source tab, in the section labeled LogNIDAQ.

==States==
The states that are available are dependent on the port specifications declared in the command line parameters. The format for the states is the following:

NIdev#[A:D][INPUT:OUTPUT]#

*The first # refers to the device number.
*The second # refers to the line number (starting at 0).
*The [A:D] denotes if the state refers to an analog (A) or a digital (D) channel.
*The [INPUT:OUTPUT] denotes if the state refers to an input or output channel.

For example, if the command parameters look like this:

<code>SignalGenerator.exe --LogNIDAQ=1 --LogNIDIO="dev1-000100200100" --LogNIAO="dev1-10"</code>

the states that will be created are the following:

*NIdev1DINPUT3
*NIdev1DOUTPUT6
*NIdev1DINPUT9
*NIdev1AOUTPUT0

Contributions:NIDAQLogger

2010-06-24T20:45:57Z

Jrenga:

==Synopsis==
National Instruments Data Acquisition Module

==Location==
Not yet in the repository.
(It would be in the following directory:
http://{{SERVERNAME}}/svn/trunk/src/contrib/SignalSource/NIDAQLogger)

==Versioning==
===Author===
Justin Renga (justin.renga@gmail.com)
===Version History===
===Source Code Revisions===
*Initial development: --
*Tested under: --
*Known to compile under: --
*Broken since: --

==Functional Description==
Acquires/Generates signals to/from National Instruments Data Acquisition boards, other devices, and the computer. Device must be connected to computer beforehand.

==Parameters==
===Command Line Parameters===
====Initializing NIDAQLogger====
To begin using the NIDAQLogger module, use the <code>--LogNIDAQ</code> flag (on SignalGenerator.exe), set equal to 1.
To activate device(s) for specific functions, use the following flags:
*<code>--LogNIDIO</code> (for digital input/output)
*<code>--LogNIAI</code> (for analog input)
*<code>--LogNIAO</code> (for analog output)
The format for the inputs for the above flags is as follows: <code>[flag]="[device name]-[port specification]"</code>
Note that if <code>--LogNIDAQ</code> is used, that at least one of the three above flags MUST be used.
====Device Specification====
The device name (usually) is to be written as "dev1" or "dev2" (without the ""). Afterwards, use a - to indicate the device name is finished.
====Digital Port Specifications====
There are three acceptable states that the user can specify for each digital port:
*0 - this indicates the port is INACTIVE.
*1 - this indicates the port is to be used as INPUT
*2 - this indicates the port is to be used as OUTPUT
====Analog Port Specifications====
There are two acceptable states that the user can specify for each analog port (both input and output):
*0 - this indicates the port is INACTIVE
*1 - this indicates the port is ACTIVE
====Example====
Let's assume that the user wants to use one device for both digital input/output and analog output. The device has 2 Analog Output ports and 12 Digital I/O ports.
The user also wants to use the 1st analog output port, the 7th digital port as Digital Output, and the 4th and 10th digital ports as Digital Input.

The user needs to use 3 flags to accomplish this:
*<code>--LogNIDAQ=1</code>
**This flag activates the NIDAQLogger for use.
*<code>--LogNIDIO="dev1-000100200100"</code>
**This flag indicates that the user wants to use digital I/O.
**"dev1" is the name of the device connected to the computer that she wants to use.
**<code>0001000200100</code> indicates that the user wants to use ports 4 and 10 (the 1's) as INPUT, and port 7 (the 2) as OUTPUT
*<code>--LogNIAO="dev1-10"</code>
**This flag indicates that she wants to use analog output.
**"dev1" is the name of the device connected to the computer that she wants to use.
**<code>10</code> indicates that she wants to the use port 1 on analog output.

The full command that the user would use is the following:

<code>SignalGenerator.exe --LogNIDAQ=1 --LogNIDIO="dev1-000100200100" --LogNIAO="dev1-10"</code>
===BCI2000 Parameters===
If either the <code>--LogNIAI</code> or the <code>--LogNIAO</code> flags are used, there will be a parameter in the configuration box (under Source)
that will allow users to specify the voltage range they want the device to work under. There will be as many range parameters as there are devices connected
that use analog functionality. It will be labeled as dev#VRanges, where # represents the device number.

==States==
The states that are available are dependent on the port specifications declared in the command line parameters. The format for the states is the following:

NIdev#[A:D][INPUT:OUTPUT]#

*The first # refers to the device number.
*The second # refers to the line number (starting at 0).
*The [A:D] denotes if the state refers to an analog (A) or a digital (D) channel.
*The [INPUT:OUTPUT] denotes if the state refers to an input or output channel.

For example, if the command parameters look like this:

<code>SignalGenerator.exe --LogNIDAQ=1 --LogNIDIO="dev1-000100200100" --LogNIAO="dev1-10"</code>

the states that will be created are the following:

*NIdev1DINPUT3
*NIdev1DOUTPUT6
*NIdev1DINPUT9
*NIdev1AOUTPUT0

Contributions:NIDAQLogger

2010-06-24T19:38:13Z

Jrenga:

Contributions:NIDAQLogger

2010-06-24T19:37:34Z

Jrenga: /* Parameters */

Contributions:NIDAQLogger

2010-06-24T19:28:18Z

Jrenga: