BCI2000 Wiki - User contributions [en]

Contributions:NeuralynxADC

2022-10-24T20:48:16Z

Madamek2: /* Acquisition via low-latency connection */

==Synopsis==
The NeuralynxNetComADC allows data acquisition from [https://neuralynx.com/ Neuralynx] Cheetah or Pegasus system. 
The module is able to record data with two different modes: 
(1) Acquisition via the NetCom interface, which connects to Cheetah/Pegasus. 
(2) Low-latency data acquisition via a fiber cable directly connected to the Acquisition amplifier. 
===Known Issues===
BCI2000 will not be able to keep up for high sampling rates & channel counts. This will result in a high roundtrip time and increasing memory usage over time, as incoming data is buffered but not processed in time.
If the low latency data acquisition is used, make sure to downsample data from 32kHz if you use all 512 Channels.

This module requires the VS2012 C++ runtime to be installed (https://www.microsoft.com/en-us/download/details.aspx?id=30679). If the runtime is not installed you will get an error for a missing DLL!

==Location==

==Versioning==

===Authors===

Markus Adamek

===Version History===

===Source Code Revisions===
*Initial development: 6024
*Tested under: 6082
*Known to compile under: 6082
*Broken since: --

==Hardware Configuration==
This Acquisition module has two ways to stream data from a Pegasus/Cheetah System.
===Acquisition via the NetCom Interface===
To acquire data via the NetCom interface the experimental Computer (Running BCI2000) has to be connected to the Pegasus/Cheetah System (Running the Acquisition Software) via Ethernet.

(1) Make sure that both computers are on the same subnet and that the Acquisition Software is running on the Pegasus/Cheetah System (You don't need to start an acquisition or recording). 
(2) Configure BCI2000 with the correct IP address (ServerName). Be aware that the Pegasus/Cheetah System has multiple Network ports! 
(3) After pressing Set Config in BCI2000 it should seamlessly connect to the Pegasus/Cheetah System. BCI2000 will automatically start data acquisition. 
You can check if BCI2000 has connected correctly by opening the Acquisition System Status on the Pegasus/Cheetah System. In this window you should see a field called NetCom Clients. If BCI2000 is connected, it should be listed. 

[[File:Netcominterface.png]]

===Acquisition via low-latency connection===
The low-latency stream allows us to tap directly into the data streamed from the ADC without the Pegasus/Cheetah System. This approach significantly reduces latency and increases the stability of the timebase.
While data is streamed directly from the amplifier, configuration still requires the Pegasus/Cheetah System and connection via the NetCom interface. You can follow the steps above to ensure that you are able to connect to the NetCom Interface.

The low-latency stream requires direct connection to the amplifier via a fiber optic ethernet connection. Therefore, the BCI2000 computer requires an optical ethernet interface.
The optical ethernet card has to be configured identical to the card installed in the Pegasus/Cheetah System.

(1) Obtain the IP address, subnet mask as well as the MAC address.
To get this information open a command window on the Pegasus/Cheetah System (To find the command prompt type cmd in the Windows 10 search bar).
Type <code>ipconfig -all</code> which will give you information of all Network adapters.
You will need to find the physical port that connects the amplifier with the Pegasus/Cheetah System. A good way to ensure that you chose the correct adapter is to turn of the amplifier and check which adapter changed.
Your result might look different than the example below.

<syntaxhighlight lang="bash">
Ethernet adapter Ethernet:
Connection-specific DNS Suffix . :
Description . . . . . . . . . . . : Intel(R) Ethernet Server Adapter I350-F2
Physical Address. . . . . . . . . : 48-2A-E3-40-45-DB
Link-local IPv6 Address . . . . . : fe80::cc21:7e8e:f65a:158e%11
IPv4 Address. . . . . . . . . . . : 172.20.2.144
Subnet Mask . . . . . . . . . . . : 255.255.0.0
Lease Obtained. . . . . . . . . . : Wednesday, July 15, 2020 8:25:32 AM
Lease Expires . . . . . . . . . . : Thursday, July 16, 2020 8:25:25 AM
Default Gateway . . . . . . . . . : 172.20.1.1
DHCP Server . . . . . . . . . . . : 172.20.1.1
DHCPv6 IAID . . . . . . . . . . . : 105392867
DHCPv6 Client DUID. . . . . . . . : 00-01-00-01-24-67-EF-14-48-2A-E3-40-45-DB
DNS Servers . . . . . . . . . . . : 172.20.1.1
NetBIOS over Tcpip. . . . . . . . : Enabled

</syntaxhighlight>
You will need the information shown in Physical Address (MAC address), IPv4 Address, and Subnet Mask.

(2) Change the settings of the fiber card Network Adapter on your BCI2000 machine.
To change the MAC address you can use a tool like the [https://technitium.com/tmac/ Technitium MAC Address Changer]. Make sure that you are changing the correct Network connection!

(3) Replace your current MAC address with the Physical Address obtained from the Pegasus/Cheetah System.
To change IP address and Subnet mask you can follow a tutorial like this one:[https://www.wikihow.com/Change-Your-IP-Address Change IP Address (Start at step 3) ].

(4) Connect the BCI2000 computer to the Amplifier with an appropriate fiber cable. The BCI2000 machine should be connected via the free fiber-cable ethernet port on the amplifier. Make sure that you plugged the fiber cable into the free port on the amplifier and not the free fiber port on the Pegasus/Cheetah System.

(5) Check if the data gets streamed to the BCI2000 computer. If you have configured everything correctly, data should now be streamed to your computer if the acquisition is started on the Pegasus/Cheetah System.
The easiest way to check this is to open the Task Manager (Ctrl+Shift+Esc) on the BCI2000 system. In the performance tab, you can monitor incoming and outgoing traffic on your network adapters. If you were successful, you should see a steady inflow of data on the ethernet port which connects your computer to the amplifier. If you are unsure, open the task manager on the Pegasus/Cheetah System, you should see the same type of data usage.

(6) Start BCI2000 and enable UseDirectUDPStream for the Low-Latency stream.

==Parameters==
===Signal Properties===
Signal Properties describe Settings common to most Amplifiers.
* '''SourceCh:''' The number of channels that the Neuralynx software reads.
* '''SampleBlockSize:''' Samples per channel per digitized block. Together with the sampling rate, this parameter determines how often per second data is collected, processed, and feedback is updated.
* '''SamplingRate:''' Sampling rate of the data. The SamplingRate has to be an integer fraction of 32kHz.
* '''ChannelNames:''' List of Names for Channels. Space-separated list; Must be the same length as Number of Channels. If set to auto, BCI2000 will query the Names from the Neuralynx system.
* '''SourceChOffset:''' Setting is not used in this module, default is 0
* '''SourceChGain:''' This is also not used, default is 1
===NeuralynxNetCom===
This Section describes Settings Necessary to communicate with the Cheetah/Pegasus System via the NetCom Interface
* '''ServerName:''' IP Address of the NetCom server (Typically the IP of your Cheetah/Pegasus System)

===NeuralynxUDPStream===
Settings if you want to use the Low Latency Stream. This requires a fiber-optic connection between the Amplifier and the BCI2000 computer.

* '''Boards:''' The Number of Boards which are connected in the Neuralynx Chassis
* '''SourceChnList:''' List of transmitted Channels. This allows you to only submit a subset of Channels. Its a list of channel ids (starting from 0). If set to auto, all channels will be transmitted.
* '''UseDirectUDPSTream:''' Easy way to switch the UDP stream on or off. This has to be enabled for low latency communication
* '''UDPStreamPort:''' Port through which the BCI2000 computer receives data from the Neuralynx System. This port is provided by Neuralynx.
* '''DecimationFactor:''' Decimation Factor for incoming Data. Incoming Data is sampled at 32kHz. If Decimation Factor is set, SamplingRate has to match or has to be set to auto. similarly, if SamplingRate is set, DecimationFactor can be set to auto and the system will determine the correct decimation factor automatically. The following Decimation factors are supported: 2, 4, 5, 8, 10, 16, 20, 25, 32, 40, 50, 64, 80, 100, 125, 128. Downsampling is done after an antialiasing filter is applied to the original signal. The filter depends on the decimation factor.
* '''NRDStreamingFile:''' Leave Empty. This can be used to stream data from a Neuralynx NRD file for debugging purposes.

==States==

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

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

Contributions:NeuralynxADC

2022-07-12T21:02:28Z

Madamek2: /* Parameters */

==Synopsis==
The NeuralynxNetComADC allows data acquisition from [https://neuralynx.com/ Neuralynx] Cheetah or Pegasus system. 
The module is able to record data with two different modes: 
(1) Acquisition via the NetCom interface, which connects to Cheetah/Pegasus. 
(2) Low-latency data acquisition via a fiber cable directly connected to the Acquisition amplifier. 
===Known Issues===
BCI2000 will not be able to keep up for high sampling rates & channel counts. This will result in a high roundtrip time and increasing memory usage over time, as incoming data is buffered but not processed in time.
If the low latency data acquisition is used, make sure to downsample data from 32kHz if you use all 512 Channels.

This module requires the VS2012 C++ runtime to be installed (https://www.microsoft.com/en-us/download/details.aspx?id=30679). If the runtime is not installed you will get an error for a missing DLL!

==Location==

==Versioning==

===Authors===

Markus Adamek

===Version History===

===Source Code Revisions===
*Initial development: 6024
*Tested under: 6082
*Known to compile under: 6082
*Broken since: --

==Hardware Configuration==
This Acquisition module has two ways to stream data from a Pegasus/Cheetah System.
===Acquisition via the NetCom Interface===
To acquire data via the NetCom interface the experimental Computer (Running BCI2000) has to be connected to the Pegasus/Cheetah System (Running the Acquisition Software) via Ethernet.

(1) Make sure that both computers are on the same subnet and that the Acquisition Software is running on the Pegasus/Cheetah System (You don't need to start an acquisition or recording). 
(2) Configure BCI2000 with the correct IP address (ServerName). Be aware that the Pegasus/Cheetah System has multiple Network ports! 
(3) After pressing Set Config in BCI2000 it should seamlessly connect to the Pegasus/Cheetah System. BCI2000 will automatically start data acquisition. 
You can check if BCI2000 has connected correctly by opening the Acquisition System Status on the Pegasus/Cheetah System. In this window you should see a field called NetCom Clients. If BCI2000 is connected, it should be listed. 

[[File:Netcominterface.png]]

===Acquisition via low-latency connection===
The low-latency stream allows us to tap directly into the data streamed from the ADC without the Pegasus/Cheetah System. This approach significantly reduces latency and increases the stability of the timebase.
While data is streamed directly from the amplifier, configuration still requires the Pegasus/Cheetah System and connection via the NetCom interface. You can follow the steps above to ensure that you are able to connect to the NetCom Interface.

The low-latency stream requires direct connection to the amplifier via a fiber optic ethernet connection. Therefore, the BCI2000 computer requires an optical ethernet interface.
The optical ethernet card has to be configured identical to the card installed in the Pegasus/Cheetah System.

(1) Obtain the IP address, subnet mask as well as the MAC address.
To get this information open a command window on the Pegasus/Cheetah System (To find the command prompt type cmd in the Windows 10 search bar).
Type <code>ipconfig -all</code> which will give you information of all Network adapters.
You will need to find the physical port that connects the amplifier with the Pegasus/Cheetah System. A good way to ensure that you chose the correct adapter is to turn of the amplifier and check which adapter changed.
Your result might look different than the example below.

<syntaxhighlight lang="bash">
Ethernet adapter Ethernet:
Connection-specific DNS Suffix . :
Description . . . . . . . . . . . : Intel(R) Ethernet Server Adapter I350-F2
Physical Address. . . . . . . . . : 48-2A-E3-40-45-DB
Link-local IPv6 Address . . . . . : fe80::cc21:7e8e:f65a:158e%11
IPv4 Address. . . . . . . . . . . : 172.20.2.144
Subnet Mask . . . . . . . . . . . : 255.255.0.0
Lease Obtained. . . . . . . . . . : Wednesday, July 15, 2020 8:25:32 AM
Lease Expires . . . . . . . . . . : Thursday, July 16, 2020 8:25:25 AM
Default Gateway . . . . . . . . . : 172.20.1.1
DHCP Server . . . . . . . . . . . : 172.20.1.1
DHCPv6 IAID . . . . . . . . . . . : 105392867
DHCPv6 Client DUID. . . . . . . . : 00-01-00-01-24-67-EF-14-48-2A-E3-40-45-DB
DNS Servers . . . . . . . . . . . : 172.20.1.1
NetBIOS over Tcpip. . . . . . . . : Enabled

</syntaxhighlight>
You will need the information shown in Physical Address (MAC address), IPv4 Address, and Subnet Mask.

(2) Change the settings of the fiber card Network Adapter on your BCI2000 machine.
To change the MAC address you can use a tool like the [https://technitium.com/tmac/ Technitium MAC Address Changer]. Make sure that you are changing the correct Network connection!

(3) Replace your current MAC address with the Physical Address obtained from the Pegasus/Cheetah System.
To change IP address and Subnet mask you can follow a tutorial like this one:[https://www.professionaltutorial.com/change-ip-address-in-windows-10/ Change IP Address (Start at step 3) ].

(4) Connect the BCI2000 computer to the Amplifier with an appropriate fiber cable. The BCI2000 machine should be connected via the free fiber-cable ethernet port on the amplifier. Make sure that you plugged the fiber cable into the free port on the amplifier and not the free fiber port on the Pegasus/Cheetah System.

(5) Check if the data gets streamed to the BCI2000 computer. If you have configured everything correctly, data should now be streamed to your computer if the acquisition is started on the Pegasus/Cheetah System.
The easiest way to check this is to open the Task Manager (Ctrl+Shift+Esc) on the BCI2000 system. In the performance tab, you can monitor incoming and outgoing traffic on your network adapters. If you were successful, you should see a steady inflow of data on the ethernet port which connects your computer to the amplifier. If you are unsure, open the task manager on the Pegasus/Cheetah System, you should see the same type of data usage.

(6) Start BCI2000 and enable UseDirectUDPStream for the Low-Latency stream.

==Parameters==
===Signal Properties===
Signal Properties describe Settings common to most Amplifiers.
* '''SourceCh:''' The number of channels that the Neuralynx software reads.
* '''SampleBlockSize:''' Samples per channel per digitized block. Together with the sampling rate, this parameter determines how often per second data is collected, processed, and feedback is updated.
* '''SamplingRate:''' Sampling rate of the data. The SamplingRate has to be an integer fraction of 32kHz.
* '''ChannelNames:''' List of Names for Channels. Space-separated list; Must be the same length as Number of Channels. If set to auto, BCI2000 will query the Names from the Neuralynx system.
* '''SourceChOffset:''' Setting is not used in this module, default is 0
* '''SourceChGain:''' This is also not used, default is 1
===NeuralynxNetCom===
This Section describes Settings Necessary to communicate with the Cheetah/Pegasus System via the NetCom Interface
* '''ServerName:''' IP Address of the NetCom server (Typically the IP of your Cheetah/Pegasus System)

===NeuralynxUDPStream===
Settings if you want to use the Low Latency Stream. This requires a fiber-optic connection between the Amplifier and the BCI2000 computer.

* '''Boards:''' The Number of Boards which are connected in the Neuralynx Chassis
* '''SourceChnList:''' List of transmitted Channels. This allows you to only submit a subset of Channels. Its a list of channel ids (starting from 0). If set to auto, all channels will be transmitted.
* '''UseDirectUDPSTream:''' Easy way to switch the UDP stream on or off. This has to be enabled for low latency communication
* '''UDPStreamPort:''' Port through which the BCI2000 computer receives data from the Neuralynx System. This port is provided by Neuralynx.
* '''DecimationFactor:''' Decimation Factor for incoming Data. Incoming Data is sampled at 32kHz. If Decimation Factor is set, SamplingRate has to match or has to be set to auto. similarly, if SamplingRate is set, DecimationFactor can be set to auto and the system will determine the correct decimation factor automatically. The following Decimation factors are supported: 2, 4, 5, 8, 10, 16, 20, 25, 32, 40, 50, 64, 80, 100, 125, 128. Downsampling is done after an antialiasing filter is applied to the original signal. The filter depends on the decimation factor.
* '''NRDStreamingFile:''' Leave Empty. This can be used to stream data from a Neuralynx NRD file for debugging purposes.

==States==

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

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

Contributions:NeuralynxADC

2022-07-03T15:51:19Z

Madamek2: /* Known Issues */

==Synopsis==
The NeuralynxNetComADC allows data acquisition from [https://neuralynx.com/ Neuralynx] Cheetah or Pegasus system. 
The module is able to record data with two different modes: 
(1) Acquisition via the NetCom interface, which connects to Cheetah/Pegasus. 
(2) Low-latency data acquisition via a fiber cable directly connected to the Acquisition amplifier. 
===Known Issues===
BCI2000 will not be able to keep up for high sampling rates & channel counts. This will result in a high roundtrip time and increasing memory usage over time, as incoming data is buffered but not processed in time.
If the low latency data acquisition is used, make sure to downsample data from 32kHz if you use all 512 Channels.

This module requires the VS2012 C++ runtime to be installed (https://www.microsoft.com/en-us/download/details.aspx?id=30679). If the runtime is not installed you will get an error for a missing DLL!

==Location==

==Versioning==

===Authors===

Markus Adamek

===Version History===

===Source Code Revisions===
*Initial development: 6024
*Tested under: 6082
*Known to compile under: 6082
*Broken since: --

==Hardware Configuration==
This Acquisition module has two ways to stream data from a Pegasus/Cheetah System.
===Acquisition via the NetCom Interface===
To acquire data via the NetCom interface the experimental Computer (Running BCI2000) has to be connected to the Pegasus/Cheetah System (Running the Acquisition Software) via Ethernet.

(1) Make sure that both computers are on the same subnet and that the Acquisition Software is running on the Pegasus/Cheetah System (You don't need to start an acquisition or recording). 
(2) Configure BCI2000 with the correct IP address (ServerName). Be aware that the Pegasus/Cheetah System has multiple Network ports! 
(3) After pressing Set Config in BCI2000 it should seamlessly connect to the Pegasus/Cheetah System. BCI2000 will automatically start data acquisition. 
You can check if BCI2000 has connected correctly by opening the Acquisition System Status on the Pegasus/Cheetah System. In this window you should see a field called NetCom Clients. If BCI2000 is connected, it should be listed. 

[[File:Netcominterface.png]]

===Acquisition via low-latency connection===
The low-latency stream allows us to tap directly into the data streamed from the ADC without the Pegasus/Cheetah System. This approach significantly reduces latency and increases the stability of the timebase.
While data is streamed directly from the amplifier, configuration still requires the Pegasus/Cheetah System and connection via the NetCom interface. You can follow the steps above to ensure that you are able to connect to the NetCom Interface.

The low-latency stream requires direct connection to the amplifier via a fiber optic ethernet connection. Therefore, the BCI2000 computer requires an optical ethernet interface.
The optical ethernet card has to be configured identical to the card installed in the Pegasus/Cheetah System.

(1) Obtain the IP address, subnet mask as well as the MAC address.
To get this information open a command window on the Pegasus/Cheetah System (To find the command prompt type cmd in the Windows 10 search bar).
Type <code>ipconfig -all</code> which will give you information of all Network adapters.
You will need to find the physical port that connects the amplifier with the Pegasus/Cheetah System. A good way to ensure that you chose the correct adapter is to turn of the amplifier and check which adapter changed.
Your result might look different than the example below.

<syntaxhighlight lang="bash">
Ethernet adapter Ethernet:
Connection-specific DNS Suffix . :
Description . . . . . . . . . . . : Intel(R) Ethernet Server Adapter I350-F2
Physical Address. . . . . . . . . : 48-2A-E3-40-45-DB
Link-local IPv6 Address . . . . . : fe80::cc21:7e8e:f65a:158e%11
IPv4 Address. . . . . . . . . . . : 172.20.2.144
Subnet Mask . . . . . . . . . . . : 255.255.0.0
Lease Obtained. . . . . . . . . . : Wednesday, July 15, 2020 8:25:32 AM
Lease Expires . . . . . . . . . . : Thursday, July 16, 2020 8:25:25 AM
Default Gateway . . . . . . . . . : 172.20.1.1
DHCP Server . . . . . . . . . . . : 172.20.1.1
DHCPv6 IAID . . . . . . . . . . . : 105392867
DHCPv6 Client DUID. . . . . . . . : 00-01-00-01-24-67-EF-14-48-2A-E3-40-45-DB
DNS Servers . . . . . . . . . . . : 172.20.1.1
NetBIOS over Tcpip. . . . . . . . : Enabled

</syntaxhighlight>
You will need the information shown in Physical Address (MAC address), IPv4 Address, and Subnet Mask.

(2) Change the settings of the fiber card Network Adapter on your BCI2000 machine.
To change the MAC address you can use a tool like the [https://technitium.com/tmac/ Technitium MAC Address Changer]. Make sure that you are changing the correct Network connection!

(3) Replace your current MAC address with the Physical Address obtained from the Pegasus/Cheetah System.
To change IP address and Subnet mask you can follow a tutorial like this one:[https://www.professionaltutorial.com/change-ip-address-in-windows-10/ Change IP Address (Start at step 3) ].

(4) Connect the BCI2000 computer to the Amplifier with an appropriate fiber cable. The BCI2000 machine should be connected via the free fiber-cable ethernet port on the amplifier. Make sure that you plugged the fiber cable into the free port on the amplifier and not the free fiber port on the Pegasus/Cheetah System.

(5) Check if the data gets streamed to the BCI2000 computer. If you have configured everything correctly, data should now be streamed to your computer if the acquisition is started on the Pegasus/Cheetah System.
The easiest way to check this is to open the Task Manager (Ctrl+Shift+Esc) on the BCI2000 system. In the performance tab, you can monitor incoming and outgoing traffic on your network adapters. If you were successful, you should see a steady inflow of data on the ethernet port which connects your computer to the amplifier. If you are unsure, open the task manager on the Pegasus/Cheetah System, you should see the same type of data usage.

(6) Start BCI2000 and enable UseDirectUDPStream for the Low-Latency stream.

==Parameters==
===Signal Properties===
Signal Properties describe Settings common to most Amplifiers.
* '''SourceCh:''' The number of channels that the Neuralynx software reads.
* '''SampleBlockSize:''' Samples per channel per digitized block. Together with the sampling rate, this parameter determines how often per second data is collected, processed, and feedback is updated.
* '''SamplingRate:''' Sampling rate of the data. The SamplingRate has to be an integer fraction of 32kHz.
* '''ChannelNames:''' List of Names for Channels. Space-separated list; Must be the same length as Number of Channels. If set to auto, BCI2000 will query the Names from the Neuralynx system.
* '''SourceChOffset:''' Setting is not used in this module, default is 0
* '''SourceChGain:''' This is also not used, default is 1
===NeuralynxNetCom===
This Section describes Settings Necessary to communicate with the Cheetah/Pegasus System via the NetCom Interface
* '''ServerName:''' IP Address of the NetCom server (Typically the IP of your Cheetah/Pegasus System)

===NeuralynxUDPStream===
Settings if you want to use the Low Latency Stream. This requires a fiber-optic connection between the Amplifier and the BCI2000 computer.

* '''Boards:''' The Number of Boards which are connected in the Neuralynx Chassis
* '''SourceChnList:''' List of transmitted Channels. This allows you to only submit a subset of Channels. Its a list of channel ids (starting from 0). If set to auto, all channels will be transmitted.
* '''UseDirectUDPSTream:''' Easy way to switch the UDP stream on or off. This has to be enabled for low latency communication
* '''UDPStreamPort:''' Port through which the BCI2000 computer receives data from the Neuralynx System. This port is provided by Neuralynx.
* '''DecimationFactor:''' Decimation Factor for incoming Data. Incoming Data is sampled at 32kHz. If Decimation Factor is set, SamplingRate has to match or has to be set to auto. similarly, if SamplingRate is set, DecimationFactor can be set to auto and the system will determine the correct decimation factor automatically. Downsampling will be achieved by a simple moving average filter.
* '''NRDStreamingFile:''' Leave Empty. This can be used to stream data from a Neuralynx NRD file for debugging purposes.

==States==

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

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

Contributions:NihonKohdenSource

2022-06-22T14:33:58Z

Madamek2:

==Synopsis==
The Nihon Kohden JE-120A amplifier is a clinical monitoring system capable of acquiring EEG or ECoG signals from up to 256 channels.
Paired with the QI-123A LAN converter box, this system can provide a research data stream in addition to the clinical data stream.
The research data stream can be sampled at up to 2kHz for 256 channels, 5kHz for 128 channels or 10kHz for 64 channels.

==Location==
http://{{SERVERNAME}}/svn/trunk/src/private/SignalSource/NihonKohdenSource

==Versioning==

===Authors===
Griffin Milsap (griffin.milsap@gmail.com)
Johns Hopkins University

Peter Brunner (brunner@neurotechcenter.org)
Washington University in St. Louis

Markus Adamek (adamek@neurotechcenter.org)
Washington University in St. Louis

Alexander Belsten (belsten@neurotechcenter.org)
Washington University in St. Louis

===Version History===
# Version 1.0 (r4913): November 2015 - Initial release.
# Version 1.1 (r6245): March 2021 - Updated to support x64.

===Source Code Revisions===
*Initial development: 4913
*Tested under: 6245
*Known to compile under: 6245
*Broken since: --

==Functional Description==
This setup requires the following components:
* '''JE-120A amplifier''':
* '''QI-123A LAN converter''':

The amplifier is a clinical monitoring system capable of acquiring EEG or ECoG signals from up to 256 channels. Paired with the QI-123A LAN converter box, this system can provide a research data stream in addition to the clinical data stream. The research data stream can be sampled at up to 2kHz for 256 channels, 5kHz for 128 channels or 10kHz for 64 channels.

* '''Input range''': ±3.2 mV or ±12.8 mV (selectable)
* '''Effective resolution''': 16 bit (97.65 nV/LSB) or 16 bit (390.62 nV/LSB) (selectable)
* '''Input impedance''': 200 MΩ
* '''Sampling Rates''': 100Hz, 200Hz, 500Hz, 1000Hz, 2000Hz, 5000Hz, 10000Hz

==Clinical Setup==

==Installation==
This source module is located in a private directory of BCI2000. To build the source, you must have the necessary credentials, enable <code>BUILD_PRIVATE</code> in CMake, and modify the CMakeLists.txt in the private and SignalSource directories to build to NihonKohdenSource.

==Parameters==
* '''SourceCh''' total number of channels to be acquired from the source module or auto for all channels enabled in the Neuroworkbench
* '''SampleBlockSize''' number of samples acquired in each block or auto for default setting (1/10th of sampling rate)
** '''NOTE:''' Only specific combinations of SampleBlockSize and SampleRate are valid! See [[#Valid Operating Modes]]
* '''SampleRate''' determines the rate at which the device samples data. 
** '''NOTE:''' Only specific combinations of SampleBlockSize and SampleRate are valid! See [[#Valid Operating Modes]]
* '''ChannelNames''' is a convenience parameter. Name channels here and they can be referenced by these names later.
* '''SourceChOffset''' auto for default settings (0 for each channel).
* '''SourceChGain''' auto for default settings (1 for each channel).
* '''SourceChList''' list of channels that should be acquired or auto for all channels enabled in the Neuroworkbench
* '''SourceBufferSize'''

===Valid Operating Modes===
The NihonKohdenSource only accepts specific sampling rates. The number of channels acquired is limited at sampling rates of 5000 Hz and above. The following table shows all valid combinations of sample rate and maximum number of channels.

{| border="1"
!SamplingRate
!Max SourceCh
!Aliasing Filter Cut-Off
|-
![samples/sec]
![channels]
![Hz]
|-
|100
|256
|30 or 35
|-
|200
|256
|60 or 70
|-
|500
|256
|120
|-
|1000
|256
|300
|-
|2000
|256
|600
|-
|5000
|128
|1200
|-
|10000
|64
|3000
|}

===Valid Operating Modes===

===State Variables===
* '''DC01''' to '''DC16''' DC Input data
** Digital Range: 0 to 65535
** Analog Range: 0xFFFF(Max)-0x8000(0V)-0x0000(Min). (Signed.)
** 1LSB: 366.3uV
* '''SpO2'''
** Digital Range: 0 to 100
** 0 means 0%, 100 means 100%
* '''EtCO2'''
** Digital Range: 0 to 100
** 0 means 0mmHg, 100 means 100mmHg
* '''BP1''' to '''BP2'''
** not implemented
* '''DigitalMark1''' to '''DigitalMark2'''
** not implemented

==DC Input From Other Devices==
Analog data from a g.TRIGbox and parallel port can be obtained though the JE120A's DC inputs. A parallel port Y-splitter and a custom cable is necessary. Connection of the custom cables and Y-splitter is outlined in the image below.

[[File:Parrallel Ports to JE120A.jpg|700px|alt text]]

The outputs from the g.TRIGbox and parallel port to the DC input of the JE120A are defined below. Note that the g.TRIGbox trigger outputs are the TTL pins. See [[Contributions:ParallelPortFilter]] for information on how to set the outputs of a parallel port from BCI2000.
{| class="wikitable"
! JE120A
!
! g.TRIGbox
!
! Parallel Port
!
|-
| Pin No.
| Signal
| Pin No.
| Signal
| Pin No.
| Signal
|-
| 1
| DC01
| 2
| Output A
| -
| -
|-
| 2
| DC02
| 3
| Output B
| -
| -
|-
| 3
| DC03
| 4
| Output C
| -
| -
|-
| 4
| DC04
| 5
| Output D
| -
| -
|-
| 5
| DC05
| 8
| Encoded Output
| -
| -
|-
| 6
| DC06
| -
| -
| -
| -
|-
| 7
| DC07
| -
| -
| -
| -
|-
| 8
| DC08
| -
| -
| -
| -
|-
| 9
| DC09
| -
| -
| 2
| Data0
|-
| 10
| DC10
| -
| -
| 3
| Data1
|-
| 11
| DC11
| -
| -
| 4
| Data2
|-
| 12
| DC12
| -
| -
| 5
| Data3
|-
| 13
| DC13
| -
| -
| 6
| Data4
|-
| 14
| DC14
| -
| -
| 7
| Data5
|-
| 15
| DC15
| -
| -
| 8
| Data6
|-
| 16
| DC16
| -
| -
| 9
| Data7
|-
| 24
| GND
| 1
| GND
| 24
| GND
|}

==Certification Results==
The Nihon Kohden certification was performed to give a better understanding of the restraints that must be placed on the system when using this device. Certification success criteria was determined internally and without rigor, and reflects our experience with psychophysical experiments and the performance we expect to need for the system. More information about certification testing can be found on the [[User Reference:BCI2000Certification|certification wiki page]].

===PC Specifications===
*Lenovo Thinkpad E580 (https://www.lenovo.com/us/en/laptops/thinkpad/thinkpad-e-series/ThinkPad-E580/p/22TP2TEE580)
*Processor: Intel(R) Core(TM) i5-7200U CPU @ 2.50GHz 2.7GHz
*Installed Ram: 8.00 GB
*Graphics Card: Intel(R) HD Graphics 620
*System Type: 64-bit operating system, x64-based processor
*BCI2000 compiled with MSVC2019 and Qt 5.15.2
*g.USBamp UB with driver version 3.16.00 installed

===Certification Tests Performed===
Certification testing varied number of channels (4, 8, 16) task (P3Spell (7x7 grid), P3Spell (1x1 grid), CursorTask, CursorTaskLow, and StimulusPresentation), and tested audio and video latency, for a total of 15 performed tasks.

===Success Criteria and Overall Results===
{|border="1"
|Name
|Actual Latency
|Success Criteria
|Result
|-
|Timestamp Latency Mean
|2.81 µs
|1 ms
|passed
|-
|Timestamp Latency STD
|2.75 ms
|5 ms
|passed
|-
|Processing Latency Mean
|35 ms
|20 ms
|failed
|-
|Processing Latency STD
|164 ms
|10 ms
|failed
|-
|Video Latency Mean
|66.9 ms
|65 ms
|failed
|-
|Video Latency STD
|6.31 ms
|20 ms
|passed
|-
|Audio Latency Mean
|76.2 ms
|65 ms
|failed
|-
|Audio Latency STD
|3.94 ms
|20 ms
|passed
|}



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

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

Contributions:NihonKohdenSource

2022-06-22T14:33:00Z

Madamek2: /* Parameters */

==Synopsis==
The Nihon Kohden JE-120A amplifier is a clinical monitoring system capable of acquiring EEG or ECoG signals from up to 256 channels.
Paired with the QI-123A LAN converter box, this system can provide a research data stream in addition to the clinical data stream.
The research data stream can be sampled at up to 2kHz for 256 channels, 5kHz for 128 channels or 10kHz for 64 channels.

==Location==
http://{{SERVERNAME}}/svn/trunk/src/private/SignalSource/NihonKohdenSource

==Versioning==

===Authors===
Griffin Milsap (griffin.milsap@gmail.com)
Johns Hopkins University

Peter Brunner (brunner@neurotechcenter.org)
Washington University in St. Louis

Markus Adamek (adamek@neurotechcenter.org)
Washington University in St. Louis

Alexander Belsten (belsten@neurotechcenter.org)
Washington University in St. Louis

===Version History===
# Version 1.0 (r4913): November 2015 - Initial release.
# Version 1.1 (r6245): March 2021 - Updated to support x64.

===Source Code Revisions===
*Initial development: 4913
*Tested under: 6245
*Known to compile under: 6245
*Broken since: --

==Functional Description==
This setup requires the following components:
* '''JE-120A amplifier''':
* '''QI-123A LAN converter''':

The amplifier is a clinical monitoring system capable of acquiring EEG or ECoG signals from up to 256 channels. Paired with the QI-123A LAN converter box, this system can provide a research data stream in addition to the clinical data stream. The research data stream can be sampled at up to 2kHz for 256 channels, 5kHz for 128 channels or 10kHz for 64 channels.

* '''Input range''': ±3.2 mV or ±12.8 mV (selectable)
* '''Effective resolution''': 16 bit (97.65 nV/LSB) or 16 bit (390.62 nV/LSB) (selectable)
* '''Input impedance''': 200 MΩ
* '''Sampling Rates''': 100Hz, 200Hz, 500Hz, 1000Hz, 2000Hz, 5000Hz, 10000Hz

==Clinical Setup==

==Installation==
This source module is located in a private directory of BCI2000. To build the source, you must have the necessary credentials, enable <code>BUILD_PRIVATE</code> in CMake, and modify the CMakeLists.txt in the private and SignalSource directories to build to NihonKohdenSource.

==Parameters==
* '''SourceCh''' total number of channels to be acquired from the source module or auto for all channels enabled in the Neurworkbench
* '''SampleBlockSize''' number of samples acquired in each block or auto for default setting (1/10th of sampling rate)
** '''NOTE:''' Only specific combinations of SampleBlockSize and SampleRate are valid! See [[#Valid Operating Modes]]
* '''SampleRate''' determines the rate at which the device samples data. 
** '''NOTE:''' Only specific combinations of SampleBlockSize and SampleRate are valid! See [[#Valid Operating Modes]]
* '''ChannelNames''' is a convenience parameter. Name channels here and they can be referenced by these names later.
* '''SourceChOffset''' auto for default settings (0 for each channel).
* '''SourceChGain''' auto for default settings (1 for each channel).
* '''SourceChList''' list of channels that should be acquired or auto for all channels enabled in the Neurworkbench
* '''SourceBufferSize'''

===Valid Operating Modes===
The NihonKohdenSource only accepts specific sampling rates. The number of channels acquired is limited at sampling rates of 5000 Hz and above. The following table shows all valid combinations of sample rate and maximum number of channels.

{| border="1"
!SamplingRate
!Max SourceCh
!Aliasing Filter Cut-Off
|-
![samples/sec]
![channels]
![Hz]
|-
|100
|256
|30 or 35
|-
|200
|256
|60 or 70
|-
|500
|256
|120
|-
|1000
|256
|300
|-
|2000
|256
|600
|-
|5000
|128
|1200
|-
|10000
|64
|3000
|}

===Valid Operating Modes===

===State Variables===
* '''DC01''' to '''DC16''' DC Input data
** Digital Range: 0 to 65535
** Analog Range: 0xFFFF(Max)-0x8000(0V)-0x0000(Min). (Signed.)
** 1LSB: 366.3uV
* '''SpO2'''
** Digital Range: 0 to 100
** 0 means 0%, 100 means 100%
* '''EtCO2'''
** Digital Range: 0 to 100
** 0 means 0mmHg, 100 means 100mmHg
* '''BP1''' to '''BP2'''
** not implemented
* '''DigitalMark1''' to '''DigitalMark2'''
** not implemented

==DC Input From Other Devices==
Analog data from a g.TRIGbox and parallel port can be obtained though the JE120A's DC inputs. A parallel port Y-splitter and a custom cable is necessary. Connection of the custom cables and Y-splitter is outlined in the image below.

[[File:Parrallel Ports to JE120A.jpg|700px|alt text]]

The outputs from the g.TRIGbox and parallel port to the DC input of the JE120A are defined below. Note that the g.TRIGbox trigger outputs are the TTL pins. See [[Contributions:ParallelPortFilter]] for information on how to set the outputs of a parallel port from BCI2000.
{| class="wikitable"
! JE120A
!
! g.TRIGbox
!
! Parallel Port
!
|-
| Pin No.
| Signal
| Pin No.
| Signal
| Pin No.
| Signal
|-
| 1
| DC01
| 2
| Output A
| -
| -
|-
| 2
| DC02
| 3
| Output B
| -
| -
|-
| 3
| DC03
| 4
| Output C
| -
| -
|-
| 4
| DC04
| 5
| Output D
| -
| -
|-
| 5
| DC05
| 8
| Encoded Output
| -
| -
|-
| 6
| DC06
| -
| -
| -
| -
|-
| 7
| DC07
| -
| -
| -
| -
|-
| 8
| DC08
| -
| -
| -
| -
|-
| 9
| DC09
| -
| -
| 2
| Data0
|-
| 10
| DC10
| -
| -
| 3
| Data1
|-
| 11
| DC11
| -
| -
| 4
| Data2
|-
| 12
| DC12
| -
| -
| 5
| Data3
|-
| 13
| DC13
| -
| -
| 6
| Data4
|-
| 14
| DC14
| -
| -
| 7
| Data5
|-
| 15
| DC15
| -
| -
| 8
| Data6
|-
| 16
| DC16
| -
| -
| 9
| Data7
|-
| 24
| GND
| 1
| GND
| 24
| GND
|}

==Certification Results==
The Nihon Kohden certification was performed to give a better understanding of the restraints that must be placed on the system when using this device. Certification success criteria was determined internally and without rigor, and reflects our experience with psychophysical experiments and the performance we expect to need for the system. More information about certification testing can be found on the [[User Reference:BCI2000Certification|certification wiki page]].

===PC Specifications===
*Lenovo Thinkpad E580 (https://www.lenovo.com/us/en/laptops/thinkpad/thinkpad-e-series/ThinkPad-E580/p/22TP2TEE580)
*Processor: Intel(R) Core(TM) i5-7200U CPU @ 2.50GHz 2.7GHz
*Installed Ram: 8.00 GB
*Graphics Card: Intel(R) HD Graphics 620
*System Type: 64-bit operating system, x64-based processor
*BCI2000 compiled with MSVC2019 and Qt 5.15.2
*g.USBamp UB with driver version 3.16.00 installed

===Certification Tests Performed===
Certification testing varied number of channels (4, 8, 16) task (P3Spell (7x7 grid), P3Spell (1x1 grid), CursorTask, CursorTaskLow, and StimulusPresentation), and tested audio and video latency, for a total of 15 performed tasks.

===Success Criteria and Overall Results===
{|border="1"
|Name
|Actual Latency
|Success Criteria
|Result
|-
|Timestamp Latency Mean
|2.81 µs
|1 ms
|passed
|-
|Timestamp Latency STD
|2.75 ms
|5 ms
|passed
|-
|Processing Latency Mean
|35 ms
|20 ms
|failed
|-
|Processing Latency STD
|164 ms
|10 ms
|failed
|-
|Video Latency Mean
|66.9 ms
|65 ms
|failed
|-
|Video Latency STD
|6.31 ms
|20 ms
|passed
|-
|Audio Latency Mean
|76.2 ms
|65 ms
|failed
|-
|Audio Latency STD
|3.94 ms
|20 ms
|passed
|}



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

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

Programming Reference:NatusADC

2021-11-10T20:29:57Z

Madamek2:

NatusADC module has 3 main classes - NatusPackageInterface, NatusDataServer and NatusClient. The overview of the NatusADC working is shown in the image below.
[[File:Prog_Ref_NatusADC_NatusWorking.png|center|800px|Overview of NatusADC working]]

NatusDataServer processes and sends signal from the device to the client application. A project named XLDataExportClient reads signals from the device and calls the NatusDataServer's functions to send the signal to the client. NatusClient is the client application within the BCI2000 that receives the signals and does the initial processing. NatusPackageInterface contains the implementation of data transfer protocol between serve/device and client and is used by NatusClient and NatusDataServer to communicate with each other over TCP and UDP. NatusDataServer and NatusPackageInterface are independent of the BCI2000 where as NatusClient relies on BCI2000.

The below image explains the context in which packet, blocks, samples and channels are used in this project. A packet may have one or block, a block may have one or more samples and a sample contains values for all the channels.
[[File:NatusPacketImage.png|center|600px|Packet, block and samples relationship]]

== NatusPackageInterface ==
This class handles the communication between the server/device and the client. It should be included with both - NatusDataServer and NatusClient Class. The class performs the following functions -constructing TCP and UDP packets, sending the packets over TCP/UDP port, receiving packets over TCP/UDP Port, reconstructing the data from the packets and listening for connections on device/server-side.
 
The format of the packets constructed along with each field size is as follows:

{| class="wikitable"
|+ Caption: Package
|-
! PacketLength
! Command
! Payload
!
|-
| uint32
| uint8
| Variable Length
| uint8 (always 0)
|}

=== TCP Commands ===
The commands through which the NatusDataServer and NatusClient communicate are as follows:
; CMD_Ping : To check if the connection is successful and data can be sent and received.
* Command Number: 0x01
* Parameters/Payload: 0xff
* Return Value: returns payload

; CMD_GetInformation : To send the device information such as the number of channels and sampling rate to the client application.
* Command Number: 0x02
* Parameters/Payload: NULL
* Return Value: struct NatusDeviceInformation which contains the number of channels, sampling rate, and device identifier.

; CMD_GetChannelNames : To send the channel names as set by the device to the client application. If no channel names are set, NULL is sent.
* Command Number: 0x03
* Parameters/Payload: NULL
* Return Value: struct NatusChannelInformation which contains all the channels and stream names.

; CMD_StartStream : To start sending channel data over UDP port.
* Command Number: 0x10
* Parameters/Payload: NULL
* Return Value: NULL

; CMD_StopStream : To stop sending channel data
* Command Number: 0x1F
* Parameters/Payload: NULL
* Return Value: NULL

; CMD_SelectChannels : To send data only for the channels numbers mentioned in the payload. It corresponds to the SourceChList parameter.
* Command Number: 0x20
* Parameters/Payload: a list of channel numbers separated by space and stored in a string
* Return Value: NULL

; CMD_SetBlockSize : To set the number of blocks to send per packet. It corresponds to the SeverBlockSize parameter.
* Command Number: 0x21
* Parameters/Payload: number of blocks to send per packet stored in uint32_t datatype.
* Return Value: NULL

; CMD_GetDecimationFactor : To get the current decimation factor of the device/server.
* Command Number: 0x22
* Parameters/Payload: decimation factor stored in uint32_t datatype.
* Return Value: NULL

; CMD_SetDecimationFactor : To set the decimation factor of the device/server.
* Command Number: 0x23
* Parameters/Payload: NULL
* Return Value: decimation factor stored in uint32_t datatype but casted into uint8_t datatype for transmission over TCP.

; CMD_ERR : The command is sent if there is any type of error.
* Command Number: 0xFF
* Parameters/Payload: command which caused the error and the payload generated by the function handling the command.
* Return Value: NULL
Note: The packet format for this command is as follows:
{| class="wikitable"
|+ Caption: Error Package
|-
! PacketLength
! CMD_ERR (0xFF)
! Command
! Payload
!
|-
| uint32
| uint8
| uint8
| Variable Length
| uint8 (always 0)
|}

=== UDP Commands ===
; CMD_StreamPackage: The command is sent from the server/device to the client application when only 1 block per packet is sent.
* Command Number: 0x11
* Parameters/Payload: Channel data of 1 block
* Return Value: NULL

; CMD_VariableSizeStreamPackage: The command is sent from the server/device to the client application when more than 1 block per packet is sent.
* Command Number: 0x12
* Parameters/Payload: Channel data of more than 1 block (number of blocks as set by the CMD_SetBlockSize command)
* Return Value: NULL

=== Functions and Variables ===
The public and protected functions and variables defined in this class are as follows:
* '''void Poll ()''' - The function runs on server/device and continuously waits for any command from the NatusClient over the TCP protocol.
* '''void send_data (uint8_t cmd, uint8_t* payload, uint32_t len_payload, bool isError=false, PackageType t = Control)''' - The function creates a packet using cmd (the command) and the payload. The default values for isError is false (i.e., no error) and PackageType is Control (TCP prototcol). The channel data is sent over Stream PackageType (i.e., UDP Protocol).
* '''virtual void data_received (CmdStruct * payload) = 0''' - The function should be implemented in the child classes to ensure proper processing, in respect ot the child class, of the data recieved via TCP or UDP protocol is done.
* '''void printMessage (std::string)''' - Print the string parameter on the warning window.
* '''CmdStruct* getNextPackage ()''' - The function gets a TCP packet (from the server or from the Client, as the case may be) and store in struct CmdStruct. Definietion of CmdStruct can be found in ''NatusPackageInterface.h'' file.
* '''CmdStruct* getNextUDPPackage ()''' - The function is same as CmdStruct* getNextPackage(), except that it received packet over UDP protocol.
* '''void delete_cmdstruct (CmdStruct* )''' - The function frees the memory occupied by a CmdStruct pointer.
* '''void initWSA ()''' - The function initializes the Winsock.
* '''SOCKET connection''' - It stores the TCP socket connection, i.e, in server/device - the connection to the client and in client - the connection to the server/device.
* '''SOCKET udpSocket''' - It stores the UDP socket connection.
* '''sockaddr_in _udpReceiver''' - It stores the socket address for IPv4.

== NatusDataServer ==
This class handles the server-side processing. It performs the following functions - starts-up the TCP and UDP server, check for new connections, gracefully disconnects from the client, registers various callbacks on client connection and deregister the callbacks when the client disconnects and responds to the commands (described in the NatusPackageInterface section) from the client via TCP protocol.

=== Functions and Variables ===
The public and protected functions and variables defined in this class are as follows:
* '''void Startup (std::uint16_t port)''' - The function starts up the server and listens for a TCP connection on the port number specified by ''port'' and a UDP connection on the port number ''port+1''.
* '''void CheckForConnection ()''' - The function checks for a client connection request and accept it if there is one.
* '''void RegisterDataStreamCallback (NatusDataStreamRequest, void*)''' - The function registers the callbacks to start & stop streams.
* '''void RegisterInformationCallback (NatusInformationRequest, void*)''' - The function registers the callback to get the device information.
* '''void RegisterChannelInformationCallback (NatusChannelInfoRequest, void*)''' - The function registers the callback to get the device's channels' names.
* '''void RegisterErrorCallback (NatusResponse, void*)''' - The function registers the callback to call incase of any error.
* '''void UnregisterCallbacks ()''' - The function deregisters all the callbacks. It is called before closing the connection with the client.
* '''void SendStreamData (float* data, uint32_t numdata)''' - The function accepts the channel ''data'' and the number of channels ''numdata'' and prepares the data by decimating it (if decimation factor is set) and by making packets with required number of blocks which are then sent to the client.
* '''void Disconnect ()''' - The function gracefully closes the UDP and TCP connection with the client.
* '''bool HasClient ()''' - The function checks if there is a client connected to the server/device.
* '''int _channelsToStream[MAX_NUM_CHANNELS]''' - It stores the channel numbers which are to be streamed. The end of the array is defined by storing the last element as -1.
* '''int _numberOfChannelsToStream''' - It stores the number of channels to stream.
* '''void data_received (CmdStruct *payload)''' - The function checks for the command received from the client and calls the appropriate function to fulfill the client's request.
* '''void start_UDP_sever (std::uint16_t port)''' - The function opens up a UDP connection at the ''port''.

== NatusClient ==
This class handles the client-side processing. It connects with the server/device, gets data from the operator module of the NatusADC and sends it to the server/device. It uses various commands as described in the NatusDataServer to set different parameters. Another important function of this class 'interpolateMissingBlocks' linearly interpolates the missing UDP packets which contain the channel data values. Eg. 
Consider the scenario where for a single channel with 1 sample per block, 1 block per packet is sent with decimation factor is 1. Suppose we received packet 1 and 3, packet 2 was lost. Data for packet 2 is interpolated as follows:
 Interpolation formula
''Interpolated Value = ((Current Packet value – Previous Packet value) / (Current Packet Number – Previous Packet Number)) * (Interpolated Packet Number – Previous Packet Number) + Previous Packet Value''
[[File:Programming_Reference_NatusADC_Interpolation.png|center|500px|Linear Interpolation example]]

=== Functions and Variables ===
The public and protected functions and variables defined in this class are as follows:
* '''NatusDeviceInformation GetInformation ()''' - The function sends a CMD_GetInformation command to the server/device over TCP to query the sampling rate and number of channels of the device. It stores the received information in the ''NatusDeviceInformation'' struct type variable.
* '''void Connect (std::string server_name, int port)''' - The function establishes a TCP connection with the ''server_name'' server at port number ''port'' and calls the ''init_udp'' function to establish a UDP connection at port ''port+1''.
* '''bool TryConnect (std::string server_name, int port)''' - The function tries to establish a TCP and UDP connection again with the ''server_name'' if the connection is lost and returns ''true'' if the connection is successful otherwise ''false''.
* '''void Disconnect ()''' - The function gracefully closes the TCP and UDP connection with the server/device.
* '''void StartStream ()''' - The function sends the CMD_StartStream command to the server/device to request the channel stream data, which the server/device sends over the UDP.
* '''void StopStream ()''' - The function sends the CMD_StopStream command to the server/device.
* '''uint8_t Ping (uint8_t ping)''' - The function sends a CMD_PING command to the sever/device with data stored in ''ping'' as payload.
* '''NatusSampleBlock* ReadStream ()''' - The function gets channel data blocks from the server/device through a UDP protocol, calls the ''interpolateMissingBlocks'' if there is any missing blocks, adds the block to the ''_receivequeue'' and returns the first block from the ''_receivequeue''.
* '''NatusSampleBlock* create_natus_sampleblock (uint8_t* payload)''' - The function creates and returns a NatusSampleBlock structure variable from the payload passes. NatusSampleBlock contains block number, number of samples, samples and a boolean specifying whether the block was recieved from the server/device or was interpolated.
* '''void DeleteSampleBlock (NatusSampleBlock*)''' - The function free the space occupied by the NatusSampleBlock variable passed to it.
* '''void SetSampleBlockSize (uint32_t blocksize)''' - The function sends CMD_SetBlockSize command to the server/device to set number of blocks to be sent in a packet as ''blocksize''.
* '''void SetDecimationFactor (uint32_t decimationFactor)''' - The function sends CMD_SetDecimationFactor command to the server/device to set the decimation factor as ''decimationFactor''.
* '''NatusChannelInformation GetChannelInfo ()''' - The function sends CMD_GetChannelNames command to the server/device to query the channel and stream names of the device and stores them in a NatusChannelInformation structure.
* '''int GetDecimationFactor ()''' - The function queries from the server/device over TCP, the current decimation factor and returns it.
* '''int SelectChannelsToStream (std::string channels)''' - The function sends CMD_SelectChannels command to the server/device along with the channels to stream stored in a space separated ''channels'' string.
* '''int _channelsToStream[MAX_NUM_CHANNELS]''' - It stores the channel numbers which are to be streamed.
* '''NatusChannelInformation channelInfo''' - The structure stores the channel and stream names of the device. The NatusChannelInformation structure definition can be found in ''NatusPackageInterface.h'' file.
* '''void data_received (CmdStruct *payload)''' - The function checks if the data received from the server/device does not contain a CMD_ERR code.
* '''CmdStruct* blockForPackage(uint32_t timeout)''' - The function waits to receive a TCP packet from server/device for the time specified by the ''timeout'' variable.
* '''std::queue<NatusSampleBlock*> _receivequeue''' - The queue stores the blocks received for processing.
* '''bool init_udp (int port)''' - The function creates and binds a UDP socket. If completed successfully, it returns ''true'', otherwise ''false''.
* '''NatusSampleBlock _prevblock''' - It stores the last data block received from the server/device and is used to check if any block is lost in between, when the client receives a new data block.
* '''void interpolateMissingBlocks (NatusSampleBlock*)''' - The function linearly interpolates any number of missing blocks between the current received data block and the last recieved data block.
* '''void emptyReceiveQueue ()''' - The function frees the memory occupied by the queue ''_receivequeue'' whenever the connection is closed or restarted.

== See also ==
[[Contributions:NatusADC]], [[User Reference:DataIOFilter]], [[Programming Reference:GenericADC Class]]
[[Category:Filters]][[Category:Data Acquisition]]

Programming Reference:NatusADC

2021-11-10T20:22:07Z

Madamek2: /* NatusPackageInterface */

NatusADC module has 3 main classes - NatusPackageInterface, NatusDataServer and NatusClient. The overview of the NatusADC working is shown in the image below.
[[File:Prog_Ref_NatusADC_NatusWorking.png|center|800px|Overview of NatusADC working]]

NatusDataServer processes and sends signal from the device to the client application. A project named XLDataExportClient reads signals from the device and calls the NatusDataServer's functions to send the signal to the client. NatusClient is the client application within the BCI2000 that receives the signals and does the initial processing. NatusPackageInterface contains the implementation of data transfer protocol between serve/device and client and is used by NatusClient and NatusDataServer to communicate with each other over TCP and UDP. NatusDataServer and NatusPackageInterface are independent of the BCI2000 where as NatusClient relies on BCI2000.

The below image explains the context in which packet, blocks, samples and channels are used in this project. A packet may have one or block, a block may have one or more samples and a sample contains values for all the channels.
[[File:NatusPacketImage.png|center|600px|Packet, block and samples relationship]]

== NatusPackageInterface ==
This class handles the communication between the server/device and the client. It should be included with both - NatusDataServer and NatusClient Class. The class performs the following functions -constructing TCP and UDP packets, sending the packets over TCP/UDP port, receiving packets over TCP/UDP Port, reconstructing the data from the packets and listening for connections on device/server-side. ''Note - The file limits the maximum number of channels for a device (stored in MAX_NUM_CHANNELS in NatusPackageInterface.h) to 100.''
 
The format of the packets constructed along with each field size is as follows:

{| class="wikitable"
|+ Caption: Package
|-
! PacketLength
! Command
! Payload
!
|-
| uint32
| uint8
| Variable Length
| uint8 (always 0)
|}

=== TCP Commands ===
The commands through which the NatusDataServer and NatusClient communicate are as follows:
; CMD_Ping : To check if the connection is successful and data can be sent and received.
* Command Number: 0x01
* Parameters/Payload: 0xff
* Return Value: returns payload

; CMD_GetInformation : To send the device information such as the number of channels and sampling rate to the client application.
* Command Number: 0x02
* Parameters/Payload: NULL
* Return Value: struct NatusDeviceInformation which contains the number of channels, sampling rate, and device identifier.

; CMD_GetChannelNames : To send the channel names as set by the device to the client application. If no channel names are set, NULL is sent.
* Command Number: 0x03
* Parameters/Payload: NULL
* Return Value: struct NatusChannelInformation which contains all the channels and stream names.

; CMD_StartStream : To start sending channel data over UDP port.
* Command Number: 0x10
* Parameters/Payload: NULL
* Return Value: NULL

; CMD_StopStream : To stop sending channel data
* Command Number: 0x1F
* Parameters/Payload: NULL
* Return Value: NULL

; CMD_SelectChannels : To send data only for the channels numbers mentioned in the payload. It corresponds to the SourceChList parameter.
* Command Number: 0x20
* Parameters/Payload: a list of channel numbers separated by space and stored in a string
* Return Value: NULL

; CMD_SetBlockSize : To set the number of blocks to send per packet. It corresponds to the SeverBlockSize parameter.
* Command Number: 0x21
* Parameters/Payload: number of blocks to send per packet stored in uint32_t datatype.
* Return Value: NULL

; CMD_GetDecimationFactor : To get the current decimation factor of the device/server.
* Command Number: 0x22
* Parameters/Payload: decimation factor stored in uint32_t datatype.
* Return Value: NULL

; CMD_SetDecimationFactor : To set the decimation factor of the device/server.
* Command Number: 0x23
* Parameters/Payload: NULL
* Return Value: decimation factor stored in uint32_t datatype but casted into uint8_t datatype for transmission over TCP.

; CMD_ERR : The command is sent if there is any type of error.
* Command Number: 0xFF
* Parameters/Payload: command which caused the error and the payload generated by the function handling the command.
* Return Value: NULL
Note: The packet format for this command is as follows:
{| class="wikitable"
|+ Caption: Error Package
|-
! PacketLength
! CMD_ERR (0xFF)
! Command
! Payload
!
|-
| uint32
| uint8
| uint8
| Variable Length
| uint8 (always 0)
|}

=== UDP Commands ===
; CMD_StreamPackage: The command is sent from the server/device to the client application when only 1 block per packet is sent.
* Command Number: 0x11
* Parameters/Payload: Channel data of 1 block
* Return Value: NULL

; CMD_VariableSizeStreamPackage: The command is sent from the server/device to the client application when more than 1 block per packet is sent.
* Command Number: 0x12
* Parameters/Payload: Channel data of more than 1 block (number of blocks as set by the CMD_SetBlockSize command)
* Return Value: NULL

=== Functions and Variables ===
The public and protected functions and variables defined in this class are as follows:
* '''void Poll ()''' - The function runs on server/device and continuously waits for any command from the NatusClient over the TCP protocol.
* '''void send_data (uint8_t cmd, uint8_t* payload, uint32_t len_payload, bool isError=false, PackageType t = Control)''' - The function creates a packet using cmd (the command) and the payload. The default values for isError is false (i.e., no error) and PackageType is Control (TCP prototcol). The channel data is sent over Stream PackageType (i.e., UDP Protocol).
* '''virtual void data_received (CmdStruct * payload) = 0''' - The function should be implemented in the child classes to ensure proper processing, in respect ot the child class, of the data recieved via TCP or UDP protocol is done.
* '''void printMessage (std::string)''' - Print the string parameter on the warning window.
* '''CmdStruct* getNextPackage ()''' - The function gets a TCP packet (from the server or from the Client, as the case may be) and store in struct CmdStruct. Definietion of CmdStruct can be found in ''NatusPackageInterface.h'' file.
* '''CmdStruct* getNextUDPPackage ()''' - The function is same as CmdStruct* getNextPackage(), except that it received packet over UDP protocol.
* '''void delete_cmdstruct (CmdStruct* )''' - The function frees the memory occupied by a CmdStruct pointer.
* '''void initWSA ()''' - The function initializes the Winsock.
* '''SOCKET connection''' - It stores the TCP socket connection, i.e, in server/device - the connection to the client and in client - the connection to the server/device.
* '''SOCKET udpSocket''' - It stores the UDP socket connection.
* '''sockaddr_in _udpReceiver''' - It stores the socket address for IPv4.

== NatusDataServer ==
This class handles the server-side processing. It performs the following functions - starts-up the TCP and UDP server, check for new connections, gracefully disconnects from the client, registers various callbacks on client connection and deregister the callbacks when the client disconnects and responds to the commands (described in the NatusPackageInterface section) from the client via TCP protocol.

=== Functions and Variables ===
The public and protected functions and variables defined in this class are as follows:
* '''void Startup (std::uint16_t port)''' - The function starts up the server and listens for a TCP connection on the port number specified by ''port'' and a UDP connection on the port number ''port+1''.
* '''void CheckForConnection ()''' - The function checks for a client connection request and accept it if there is one.
* '''void RegisterDataStreamCallback (NatusDataStreamRequest, void*)''' - The function registers the callbacks to start & stop streams.
* '''void RegisterInformationCallback (NatusInformationRequest, void*)''' - The function registers the callback to get the device information.
* '''void RegisterChannelInformationCallback (NatusChannelInfoRequest, void*)''' - The function registers the callback to get the device's channels' names.
* '''void RegisterErrorCallback (NatusResponse, void*)''' - The function registers the callback to call incase of any error.
* '''void UnregisterCallbacks ()''' - The function deregisters all the callbacks. It is called before closing the connection with the client.
* '''void SendStreamData (float* data, uint32_t numdata)''' - The function accepts the channel ''data'' and the number of channels ''numdata'' and prepares the data by decimating it (if decimation factor is set) and by making packets with required number of blocks which are then sent to the client.
* '''void Disconnect ()''' - The function gracefully closes the UDP and TCP connection with the client.
* '''bool HasClient ()''' - The function checks if there is a client connected to the server/device.
* '''int _channelsToStream[MAX_NUM_CHANNELS]''' - It stores the channel numbers which are to be streamed. The end of the array is defined by storing the last element as -1.
* '''int _numberOfChannelsToStream''' - It stores the number of channels to stream.
* '''void data_received (CmdStruct *payload)''' - The function checks for the command received from the client and calls the appropriate function to fulfill the client's request.
* '''void start_UDP_sever (std::uint16_t port)''' - The function opens up a UDP connection at the ''port''.

== NatusClient ==
This class handles the client-side processing. It connects with the server/device, gets data from the operator module of the NatusADC and sends it to the server/device. It uses various commands as described in the NatusDataServer to set different parameters. Another important function of this class 'interpolateMissingBlocks' linearly interpolates the missing UDP packets which contain the channel data values. Eg. 
Consider the scenario where for a single channel with 1 sample per block, 1 block per packet is sent with decimation factor is 1. Suppose we received packet 1 and 3, packet 2 was lost. Data for packet 2 is interpolated as follows:
 Interpolation formula
''Interpolated Value = ((Current Packet value – Previous Packet value) / (Current Packet Number – Previous Packet Number)) * (Interpolated Packet Number – Previous Packet Number) + Previous Packet Value''
[[File:Programming_Reference_NatusADC_Interpolation.png|center|500px|Linear Interpolation example]]

=== Functions and Variables ===
The public and protected functions and variables defined in this class are as follows:
* '''NatusDeviceInformation GetInformation ()''' - The function sends a CMD_GetInformation command to the server/device over TCP to query the sampling rate and number of channels of the device. It stores the received information in the ''NatusDeviceInformation'' struct type variable.
* '''void Connect (std::string server_name, int port)''' - The function establishes a TCP connection with the ''server_name'' server at port number ''port'' and calls the ''init_udp'' function to establish a UDP connection at port ''port+1''.
* '''bool TryConnect (std::string server_name, int port)''' - The function tries to establish a TCP and UDP connection again with the ''server_name'' if the connection is lost and returns ''true'' if the connection is successful otherwise ''false''.
* '''void Disconnect ()''' - The function gracefully closes the TCP and UDP connection with the server/device.
* '''void StartStream ()''' - The function sends the CMD_StartStream command to the server/device to request the channel stream data, which the server/device sends over the UDP.
* '''void StopStream ()''' - The function sends the CMD_StopStream command to the server/device.
* '''uint8_t Ping (uint8_t ping)''' - The function sends a CMD_PING command to the sever/device with data stored in ''ping'' as payload.
* '''NatusSampleBlock* ReadStream ()''' - The function gets channel data blocks from the server/device through a UDP protocol, calls the ''interpolateMissingBlocks'' if there is any missing blocks, adds the block to the ''_receivequeue'' and returns the first block from the ''_receivequeue''.
* '''NatusSampleBlock* create_natus_sampleblock (uint8_t* payload)''' - The function creates and returns a NatusSampleBlock structure variable from the payload passes. NatusSampleBlock contains block number, number of samples, samples and a boolean specifying whether the block was recieved from the server/device or was interpolated.
* '''void DeleteSampleBlock (NatusSampleBlock*)''' - The function free the space occupied by the NatusSampleBlock variable passed to it.
* '''void SetSampleBlockSize (uint32_t blocksize)''' - The function sends CMD_SetBlockSize command to the server/device to set number of blocks to be sent in a packet as ''blocksize''.
* '''void SetDecimationFactor (uint32_t decimationFactor)''' - The function sends CMD_SetDecimationFactor command to the server/device to set the decimation factor as ''decimationFactor''.
* '''NatusChannelInformation GetChannelInfo ()''' - The function sends CMD_GetChannelNames command to the server/device to query the channel and stream names of the device and stores them in a NatusChannelInformation structure.
* '''int GetDecimationFactor ()''' - The function queries from the server/device over TCP, the current decimation factor and returns it.
* '''int SelectChannelsToStream (std::string channels)''' - The function sends CMD_SelectChannels command to the server/device along with the channels to stream stored in a space separated ''channels'' string.
* '''int _channelsToStream[MAX_NUM_CHANNELS]''' - It stores the channel numbers which are to be streamed.
* '''NatusChannelInformation channelInfo''' - The structure stores the channel and stream names of the device. The NatusChannelInformation structure definition can be found in ''NatusPackageInterface.h'' file.
* '''void data_received (CmdStruct *payload)''' - The function checks if the data received from the server/device does not contain a CMD_ERR code.
* '''CmdStruct* blockForPackage(uint32_t timeout)''' - The function waits to receive a TCP packet from server/device for the time specified by the ''timeout'' variable.
* '''std::queue<NatusSampleBlock*> _receivequeue''' - The queue stores the blocks received for processing.
* '''bool init_udp (int port)''' - The function creates and binds a UDP socket. If completed successfully, it returns ''true'', otherwise ''false''.
* '''NatusSampleBlock _prevblock''' - It stores the last data block received from the server/device and is used to check if any block is lost in between, when the client receives a new data block.
* '''void interpolateMissingBlocks (NatusSampleBlock*)''' - The function linearly interpolates any number of missing blocks between the current received data block and the last recieved data block.
* '''void emptyReceiveQueue ()''' - The function frees the memory occupied by the queue ''_receivequeue'' whenever the connection is closed or restarted.

== See also ==
[[Contributions:NatusADC]], [[User Reference:DataIOFilter]], [[Programming Reference:GenericADC Class]]
[[Category:Filters]][[Category:Data Acquisition]]

Programming Howto:Download the BCI2000 Sourcecode

2021-02-22T19:13:15Z

Madamek2: /* Choose a checkout directory */

==Back==
To [[Programming Howto:Building and Customizing BCI2000|this howto's overview page]].

==Choose a checkout directory==
Right-click a Windows explorer window, and choose "SVN Checkout..." from the context menu. Use <code>https://www.bci2000.org/svn/trunk</code> as the repository URL.

[[File:SVN_3-2294.png.png|center]]

Enter the desired checkout directory in the dialog that comes up.

[[File:SVN_4-2294.png|center]]

==Enter user name and password==
When prompted, enter user name and password as chosen in the registration step.
Check "Save authentication" if you don't like to enter your credentials each time you check out or update BCI2000.

[[File:SVN_3-2315.png|center]]

==Wait for the checkout to complete==
A list of files will scroll by while the source code is downloaded.

[[File:SVN_4-2326.png|center]]

Once the download has been finished, click "OK" to dismiss the checkout dialog.

[[File:SVN_5-2333.png|center]]

==Next step==
As a next step, learn how to [[Programming Howto:Configure BCI2000 for Compilation|configure BCI2000 for compilation]].

==See also==
[[Programming Howto:Building and Customizing BCI2000]]

[[Category:Howto]]

Programming Howto:Configure BCI2000 for Compilation

2020-09-02T17:48:42Z

Madamek2: /* Tell CMake which Qt installation to use */

==Back==
To [[Programming Howto:Building and Customizing BCI2000|this howto's overview page]].

==Run the CMake GUI==
Double-click "Configure.sh.cmd" in your BCI2000 build directory.

[[File:use_cmake_1.PNG|center]]

==Tell CMake which Qt installation to use==
Click "AddEntry" in the CMake window ...

[[File:use_cmake_2.PNG|center]]

... and enter the path to a Qt directory that is consistent with the compiler you are going to use. Use Qt5_DIR as the name for the new entry. Be aware that the entry is case sensitive

[[File:use_cmake_3.PNG|center]]

==Perform the configuration step==
In the CMake window, click "Configure" ...

[[File:use_cmake_4.PNG|center]]

... and choose a generator that is consistent with your compiler, and the Qt directory chosen above. Then click "Finish" to perform the configuration step.

[[File:use_cmake_5.PNG|center]]

You will see a list of targets scrolling by, and a number of new entries in the variable list at the top of the window, marked in red.

[[File:use_cmake_6.PNG|center]]

==Choose build options==
Make sure the "Grouped" checkbox is checked, and configure the build by customizing values in the "BUILD" ...

[[File:use_cmake_7.PNG|center]]

... and "EXTENSIONS" group. Then, click "Generate" to create build files.

[[File:use_cmake_8.PNG|center]]

When CMake displays its "Generating done" message, ...

[[File:use_cmake_9.PNG|center]]

... your BCI2000 build directory will now contain a VisualStudio solution file, as well as a number of additional CMake-generated files.

[[File:use_cmake_10.PNG|center]]

==Next step==
As a next step, learn how to [[Programming Howto:Compile BCI2000|compile BCI2000]].

==See also==
[[Programming Howto:Building and Customizing BCI2000]]

[[Category:Howto]]

Contributions:NeuralynxADC

2020-07-15T17:29:59Z

Madamek2: /* Acquisition via low-latency connection */

==Synopsis==
The NeuralynxNetComADC allows data acquisition from [https://neuralynx.com/ Neuralynx] Cheetah or Pegasus system. 
The module is able to record data with two different modes: 
(1) Acquisition via the NetCom interface, which connects to Cheetah/Pegasus. 
(2) Low-latency data acquisition via a fiber cable directly connected to the Acquisition amplifier. 
===Known Issues===
BCI2000 will not be able to keep up for high sampling rates & channel counts. This will result in a high roundtrip time and increasing memory usage over time, as incoming data is buffered but not processed in time.
If the low latency data acquisition is used, make sure to downsample data from 32kHz if you use all 512 Channels.

==Location==

==Versioning==

===Authors===

Markus Adamek

===Version History===

===Source Code Revisions===
*Initial development: 6024
*Tested under: 6082
*Known to compile under: 6082
*Broken since: --

==Hardware Configuration==
This Acquisition module has two ways to stream data from a Pegasus/Cheetah System.
===Acquisition via the NetCom Interface===
To acquire data via the NetCom interface the experimental Computer (Running BCI2000) has to be connected to the Pegasus/Cheetah System (Running the Acquisition Software) via Ethernet.

(1) Make sure that both computers are on the same subnet and that the Acquisition Software is running on the Pegasus/Cheetah System (You don't need to start an acquisition or recording). 
(2) Configure BCI2000 with the correct IP address (ServerName). Be aware that the Pegasus/Cheetah System has multiple Network ports! 
(3) After pressing Set Config in BCI2000 it should seamlessly connect to the Pegasus/Cheetah System. BCI2000 will automatically start data acquisition. 
You can check if BCI2000 has connected correctly by opening the Acquisition System Status on the Pegasus/Cheetah System. In this window you should see a field called NetCom Clients. If BCI2000 is connected, it should be listed. 

[[File:Netcominterface.png]]

===Acquisition via low-latency connection===
The low-latency stream allows us to tap directly into the data streamed from the ADC without the Pegasus/Cheetah System. This approach significantly reduces latency and increases the stability of the timebase.
While data is streamed directly from the amplifier, configuration still requires the Pegasus/Cheetah System and connection via the NetCom interface. You can follow the steps above to ensure that you are able to connect to the NetCom Interface.

The low-latency stream requires direct connection to the amplifier via a fiber optic ethernet connection. Therefore, the BCI2000 computer requires an optical ethernet interface.
The optical ethernet card has to be configured identical to the card installed in the Pegasus/Cheetah System.

(1) Obtain the IP address, subnet mask as well as the MAC address.
To get this information open a command window on the Pegasus/Cheetah System (To find the command prompt type cmd in the Windows 10 search bar).
Type <code>ipconfig -all</code> which will give you information of all Network adapters.
You will need to find the physical port that connects the amplifier with the Pegasus/Cheetah System. A good way to ensure that you chose the correct adapter is to turn of the amplifier and check which adapter changed.
Your result might look different than the example below.

<syntaxhighlight lang="bash">
Ethernet adapter Ethernet:
Connection-specific DNS Suffix . :
Description . . . . . . . . . . . : Intel(R) Ethernet Server Adapter I350-F2
Physical Address. . . . . . . . . : 48-2A-E3-40-45-DB
Link-local IPv6 Address . . . . . : fe80::cc21:7e8e:f65a:158e%11
IPv4 Address. . . . . . . . . . . : 172.20.2.144
Subnet Mask . . . . . . . . . . . : 255.255.0.0
Lease Obtained. . . . . . . . . . : Wednesday, July 15, 2020 8:25:32 AM
Lease Expires . . . . . . . . . . : Thursday, July 16, 2020 8:25:25 AM
Default Gateway . . . . . . . . . : 172.20.1.1
DHCP Server . . . . . . . . . . . : 172.20.1.1
DHCPv6 IAID . . . . . . . . . . . : 105392867
DHCPv6 Client DUID. . . . . . . . : 00-01-00-01-24-67-EF-14-48-2A-E3-40-45-DB
DNS Servers . . . . . . . . . . . : 172.20.1.1
NetBIOS over Tcpip. . . . . . . . : Enabled

</syntaxhighlight>
You will need the information shown in Physical Address (MAC address), IPv4 Address, and Subnet Mask.

(2) Change the settings of the fiber card Network Adapter on your BCI2000 machine.
To change the MAC address you can use a tool like the [https://technitium.com/tmac/ Technitium MAC Address Changer]. Make sure that you are changing the correct Network connection!

(3) Replace your current MAC address with the Physical Address obtained from the Pegasus/Cheetah System.
To change IP address and Subnet mask you can follow a tutorial like this one:[https://www.professionaltutorial.com/change-ip-address-in-windows-10/ Change IP Address (Start at step 3) ].

(4) Connect the BCI2000 computer to the Amplifier with an appropriate fiber cable. The BCI2000 machine should be connected via the free fiber-cable ethernet port on the amplifier. Make sure that you plugged the fiber cable into the free port on the amplifier and not the free fiber port on the Pegasus/Cheetah System.

(5) Check if the data gets streamed to the BCI2000 computer. If you have configured everything correctly, data should now be streamed to your computer if the acquisition is started on the Pegasus/Cheetah System.
The easiest way to check this is to open the Task Manager (Ctrl+Shift+Esc) on the BCI2000 system. In the performance tab, you can monitor incoming and outgoing traffic on your network adapters. If you were successful, you should see a steady inflow of data on the ethernet port which connects your computer to the amplifier. If you are unsure, open the task manager on the Pegasus/Cheetah System, you should see the same type of data usage.

(6) Start BCI2000 and enable UseDirectUDPStream for the Low-Latency stream.

==Parameters==
===Signal Properties===
Signal Properties describe Settings common to most Amplifiers.
* '''SourceCh:''' The number of channels that the Neuralynx software reads.
* '''SampleBlockSize:''' Samples per channel per digitized block. Together with the sampling rate, this parameter determines how often per second data is collected, processed, and feedback is updated.
* '''SamplingRate:''' Sampling rate of the data. The SamplingRate has to be an integer fraction of 32kHz.
* '''ChannelNames:''' List of Names for Channels. Space-separated list; Must be the same length as Number of Channels. If set to auto, BCI2000 will query the Names from the Neuralynx system.
* '''SourceChOffset:''' Setting is not used in this module, default is 0
* '''SourceChGain:''' This is also not used, default is 1
===NeuralynxNetCom===
This Section describes Settings Necessary to communicate with the Cheetah/Pegasus System via the NetCom Interface
* '''ServerName:''' IP Address of the NetCom server (Typically the IP of your Cheetah/Pegasus System)

===NeuralynxUDPStream===
Settings if you want to use the Low Latency Stream. This requires a fiber-optic connection between the Amplifier and the BCI2000 computer.

* '''Boards:''' The Number of Boards which are connected in the Neuralynx Chassis
* '''SourceChnList:''' List of transmitted Channels. This allows you to only submit a subset of Channels. Its a list of channel ids (starting from 0). If set to auto, all channels will be transmitted.
* '''UseDirectUDPSTream:''' Easy way to switch the UDP stream on or off. This has to be enabled for low latency communication
* '''UDPStreamPort:''' Port through which the BCI2000 computer receives data from the Neuralynx System. This port is provided by Neuralynx.
* '''DecimationFactor:''' Decimation Factor for incoming Data. Incoming Data is sampled at 32kHz. If Decimation Factor is set, SamplingRate has to match or has to be set to auto. similarly, if SamplingRate is set, DecimationFactor can be set to auto and the system will determine the correct decimation factor automatically. Downsampling will be achieved by a simple moving average filter.
* '''NRDStreamingFile:''' Leave Empty. This can be used to stream data from a Neuralynx NRD file for debugging purposes.

==States==

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

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

Contributions:NeuralynxADC

2020-07-15T17:29:32Z

Madamek2: /* Acquisition via low-latency connection */

==Synopsis==
The NeuralynxNetComADC allows data acquisition from [https://neuralynx.com/ Neuralynx] Cheetah or Pegasus system. 
The module is able to record data with two different modes: 
(1) Acquisition via the NetCom interface, which connects to Cheetah/Pegasus. 
(2) Low-latency data acquisition via a fiber cable directly connected to the Acquisition amplifier. 
===Known Issues===
BCI2000 will not be able to keep up for high sampling rates & channel counts. This will result in a high roundtrip time and increasing memory usage over time, as incoming data is buffered but not processed in time.
If the low latency data acquisition is used, make sure to downsample data from 32kHz if you use all 512 Channels.

==Location==

==Versioning==

===Authors===

Markus Adamek

===Version History===

===Source Code Revisions===
*Initial development: 6024
*Tested under: 6082
*Known to compile under: 6082
*Broken since: --

==Hardware Configuration==
This Acquisition module has two ways to stream data from a Pegasus/Cheetah System.
===Acquisition via the NetCom Interface===
To acquire data via the NetCom interface the experimental Computer (Running BCI2000) has to be connected to the Pegasus/Cheetah System (Running the Acquisition Software) via Ethernet.

(1) Make sure that both computers are on the same subnet and that the Acquisition Software is running on the Pegasus/Cheetah System (You don't need to start an acquisition or recording). 
(2) Configure BCI2000 with the correct IP address (ServerName). Be aware that the Pegasus/Cheetah System has multiple Network ports! 
(3) After pressing Set Config in BCI2000 it should seamlessly connect to the Pegasus/Cheetah System. BCI2000 will automatically start data acquisition. 
You can check if BCI2000 has connected correctly by opening the Acquisition System Status on the Pegasus/Cheetah System. In this window you should see a field called NetCom Clients. If BCI2000 is connected, it should be listed. 

[[File:Netcominterface.png]]

===Acquisition via low-latency connection===
The low-latency stream allows us to tap directly into the data streamed from the ADC without the Pegasus/Cheetah System. This approach significantly reduces latency and increases the stability of the timebase.
While data is streamed directly from the amplifier, configuration still requires the Pegasus/Cheetah System and connection via the NetCom interface. You can follow the steps above to ensure that you are able to connect to the NetCom Interface.

The low-latency stream requires direct connection to the amplifier via a fiber optic ethernet connection. Therefore, the BCI2000 computer requires an optical ethernet interface.
The optical ethernet card has to be configured identical to the card installed in the Pegasus/Cheetah System.

(1) Obtain the IP address, subnet mask as well as the MAC address.
To get this information open a command window on the Pegasus/Cheetah System (To find the command prompt type cmd in the Windows 10 search bar).
Type <code>ipconfig -all</code> which will give you information of all Network adapters.
You will need to find the physical port that connects the amplifier with the Pegasus/Cheetah System. A good way to ensure that you chose the correct adapter is to turn of the amplifier and check which adapter changed.
Your result might look different than the example below.

<syntaxhighlight lang="bash">
Ethernet adapter Ethernet:
Connection-specific DNS Suffix . :
Description . . . . . . . . . . . : Intel(R) Ethernet Server Adapter I350-F2
Physical Address. . . . . . . . . : 48-2A-E3-40-45-DB
Link-local IPv6 Address . . . . . : fe80::cc21:7e8e:f65a:158e%11
IPv4 Address. . . . . . . . . . . : 172.20.2.144
Subnet Mask . . . . . . . . . . . : 255.255.0.0
Lease Obtained. . . . . . . . . . : Wednesday, July 15, 2020 8:25:32 AM
Lease Expires . . . . . . . . . . : Thursday, July 16, 2020 8:25:25 AM
Default Gateway . . . . . . . . . : 172.20.1.1
DHCP Server . . . . . . . . . . . : 172.20.1.1
DHCPv6 IAID . . . . . . . . . . . : 105392867
DHCPv6 Client DUID. . . . . . . . : 00-01-00-01-24-67-EF-14-48-2A-E3-40-45-DB
DNS Servers . . . . . . . . . . . : 172.20.1.1
NetBIOS over Tcpip. . . . . . . . : Enabled

</syntaxhighlight>
You will need the information shown in Physical Address (MAC address), IPv4 Address, and Subnet Mask.

(2) Change the settings of the fiber card Network Adapter on your BCI2000 machine.
To change the MAC address you can use a tool like the [https://technitium.com/tmac/ Technitium MAC Address Changer]. Make sure that you are changing the correct Network connection!

(3)Replace your current MAC address with the Physical Address obtained from the Pegasus/Cheetah System.
To change IP address and Subnet mask you can follow a tutorial like this one:[https://www.professionaltutorial.com/change-ip-address-in-windows-10/ Change IP Address (Start at step 3) ].

(4) Connect the BCI2000 computer to the Amplifier with an appropriate fiber cable. The BCI2000 machine should be connected via the free fiber-cable ethernet port on the amplifier. Make sure that you plugged the fiber cable into the free port on the amplifier and not the free fiber port on the Pegasus/Cheetah System.

(5) Check if the data gets streamed to the BCI2000 computer. If you have configured everything correctly, data should now be streamed to your computer if the acquisition is started on the Pegasus/Cheetah System.
The easiest way to check this is to open the Task Manager (Ctrl+Shift+Esc) on the BCI2000 system. In the performance tab, you can monitor incoming and outgoing traffic on your network adapters. If you were successful, you should see a steady inflow of data on the ethernet port which connects your computer to the amplifier. If you are unsure, open the task manager on the Pegasus/Cheetah System, you should see the same type of data usage.

(6) Start BCI2000 and enable UseDirectUDPStream for the Low-Latency stream.

==Parameters==
===Signal Properties===
Signal Properties describe Settings common to most Amplifiers.
* '''SourceCh:''' The number of channels that the Neuralynx software reads.
* '''SampleBlockSize:''' Samples per channel per digitized block. Together with the sampling rate, this parameter determines how often per second data is collected, processed, and feedback is updated.
* '''SamplingRate:''' Sampling rate of the data. The SamplingRate has to be an integer fraction of 32kHz.
* '''ChannelNames:''' List of Names for Channels. Space-separated list; Must be the same length as Number of Channels. If set to auto, BCI2000 will query the Names from the Neuralynx system.
* '''SourceChOffset:''' Setting is not used in this module, default is 0
* '''SourceChGain:''' This is also not used, default is 1
===NeuralynxNetCom===
This Section describes Settings Necessary to communicate with the Cheetah/Pegasus System via the NetCom Interface
* '''ServerName:''' IP Address of the NetCom server (Typically the IP of your Cheetah/Pegasus System)

===NeuralynxUDPStream===
Settings if you want to use the Low Latency Stream. This requires a fiber-optic connection between the Amplifier and the BCI2000 computer.

* '''Boards:''' The Number of Boards which are connected in the Neuralynx Chassis
* '''SourceChnList:''' List of transmitted Channels. This allows you to only submit a subset of Channels. Its a list of channel ids (starting from 0). If set to auto, all channels will be transmitted.
* '''UseDirectUDPSTream:''' Easy way to switch the UDP stream on or off. This has to be enabled for low latency communication
* '''UDPStreamPort:''' Port through which the BCI2000 computer receives data from the Neuralynx System. This port is provided by Neuralynx.
* '''DecimationFactor:''' Decimation Factor for incoming Data. Incoming Data is sampled at 32kHz. If Decimation Factor is set, SamplingRate has to match or has to be set to auto. similarly, if SamplingRate is set, DecimationFactor can be set to auto and the system will determine the correct decimation factor automatically. Downsampling will be achieved by a simple moving average filter.
* '''NRDStreamingFile:''' Leave Empty. This can be used to stream data from a Neuralynx NRD file for debugging purposes.

==States==

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

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

Contributions:NeuralynxADC

2020-07-15T17:28:56Z

Madamek2:

==Synopsis==
The NeuralynxNetComADC allows data acquisition from [https://neuralynx.com/ Neuralynx] Cheetah or Pegasus system. 
The module is able to record data with two different modes: 
(1) Acquisition via the NetCom interface, which connects to Cheetah/Pegasus. 
(2) Low-latency data acquisition via a fiber cable directly connected to the Acquisition amplifier. 
===Known Issues===
BCI2000 will not be able to keep up for high sampling rates & channel counts. This will result in a high roundtrip time and increasing memory usage over time, as incoming data is buffered but not processed in time.
If the low latency data acquisition is used, make sure to downsample data from 32kHz if you use all 512 Channels.

==Location==

==Versioning==

===Authors===

Markus Adamek

===Version History===

===Source Code Revisions===
*Initial development: 6024
*Tested under: 6082
*Known to compile under: 6082
*Broken since: --

==Hardware Configuration==
This Acquisition module has two ways to stream data from a Pegasus/Cheetah System.
===Acquisition via the NetCom Interface===
To acquire data via the NetCom interface the experimental Computer (Running BCI2000) has to be connected to the Pegasus/Cheetah System (Running the Acquisition Software) via Ethernet.

(1) Make sure that both computers are on the same subnet and that the Acquisition Software is running on the Pegasus/Cheetah System (You don't need to start an acquisition or recording). 
(2) Configure BCI2000 with the correct IP address (ServerName). Be aware that the Pegasus/Cheetah System has multiple Network ports! 
(3) After pressing Set Config in BCI2000 it should seamlessly connect to the Pegasus/Cheetah System. BCI2000 will automatically start data acquisition. 
You can check if BCI2000 has connected correctly by opening the Acquisition System Status on the Pegasus/Cheetah System. In this window you should see a field called NetCom Clients. If BCI2000 is connected, it should be listed. 

[[File:Netcominterface.png]]

===Acquisition via low-latency connection===
The low-latency stream allows us to tap directly into the data streamed from the ADC without the Pegasus/Cheetah System. This approach significantly reduces latency and increases the stability of the timebase.
While data is streamed directly from the amplifier, configuration still requires the Pegasus/Cheetah System and connection via the NetCom interface. You can follow the steps above to ensure that you are able to connect to the NetCom Interface.

The low-latency stream requires direct connection to the amplifier via a fiber optic ethernet connection. Therefore, the BCI2000 computer requires an optical ethernet interface.
The optical ethernet card has to be configured identical to the card installed in the Pegasus/Cheetah System.

(1) Obtain the IP address, subnet mask as well as the MAC address.
To get this information open a command window on the Pegasus/Cheetah System (To find the command prompt type cmd in the Windows 10 search bar).
Type <code>ipconfig -all</code> which will give you information of all Network adapters.
You will need to find the physical port that connects the amplifier with the Pegasus/Cheetah System. A good way to ensure that you chose the correct adapter is to turn of the amplifier and check which adapter changed.
Your result might look different than the example below.

<syntaxhighlight lang="bash">
Ethernet adapter Ethernet:
Connection-specific DNS Suffix . :
Description . . . . . . . . . . . : Intel(R) Ethernet Server Adapter I350-F2
Physical Address. . . . . . . . . : 48-2A-E3-40-45-DB
Link-local IPv6 Address . . . . . : fe80::cc21:7e8e:f65a:158e%11
IPv4 Address. . . . . . . . . . . : 172.20.2.144
Subnet Mask . . . . . . . . . . . : 255.255.0.0
Lease Obtained. . . . . . . . . . : Wednesday, July 15, 2020 8:25:32 AM
Lease Expires . . . . . . . . . . : Thursday, July 16, 2020 8:25:25 AM
Default Gateway . . . . . . . . . : 172.20.1.1
DHCP Server . . . . . . . . . . . : 172.20.1.1
DHCPv6 IAID . . . . . . . . . . . : 105392867
DHCPv6 Client DUID. . . . . . . . : 00-01-00-01-24-67-EF-14-48-2A-E3-40-45-DB
DNS Servers . . . . . . . . . . . : 172.20.1.1
NetBIOS over Tcpip. . . . . . . . : Enabled

</syntaxhighlight>
You will need the information shown in Physical Address (MAC address), IPv4 Address, and Subnet Mask.

(2) Change the settings of the fiber card Network Adapter on your BCI2000 machine.
To change the MAC address you can use a tool like the [https://technitium.com/tmac/ Technitium MAC Address Changer]. Make sure that you are changing the correct Network connection!

(3)Replace your current MAC address with the Physical Address obtained from the Pegasus/Cheetah System.
To change IP address and Subnet mask you can follow a tutorial like this one:[Change IP Address (Start at step 3) https://www.professionaltutorial.com/change-ip-address-in-windows-10/].

(4) Connect the BCI2000 computer to the Amplifier with an appropriate fiber cable. The BCI2000 machine should be connected via the free fiber-cable ethernet port on the amplifier. Make sure that you plugged the fiber cable into the free port on the amplifier and not the free fiber port on the Pegasus/Cheetah System.

(5) Check if the data gets streamed to the BCI2000 computer. If you have configured everything correctly, data should now be streamed to your computer if the acquisition is started on the Pegasus/Cheetah System.
The easiest way to check this is to open the Task Manager (Ctrl+Shift+Esc) on the BCI2000 system. In the performance tab, you can monitor incoming and outgoing traffic on your network adapters. If you were successful, you should see a steady inflow of data on the ethernet port which connects your computer to the amplifier. If you are unsure, open the task manager on the Pegasus/Cheetah System, you should see the same type of data usage.

(6) Start BCI2000 and enable UseDirectUDPStream for the Low-Latency stream.

==Parameters==
===Signal Properties===
Signal Properties describe Settings common to most Amplifiers.
* '''SourceCh:''' The number of channels that the Neuralynx software reads.
* '''SampleBlockSize:''' Samples per channel per digitized block. Together with the sampling rate, this parameter determines how often per second data is collected, processed, and feedback is updated.
* '''SamplingRate:''' Sampling rate of the data. The SamplingRate has to be an integer fraction of 32kHz.
* '''ChannelNames:''' List of Names for Channels. Space-separated list; Must be the same length as Number of Channels. If set to auto, BCI2000 will query the Names from the Neuralynx system.
* '''SourceChOffset:''' Setting is not used in this module, default is 0
* '''SourceChGain:''' This is also not used, default is 1
===NeuralynxNetCom===
This Section describes Settings Necessary to communicate with the Cheetah/Pegasus System via the NetCom Interface
* '''ServerName:''' IP Address of the NetCom server (Typically the IP of your Cheetah/Pegasus System)

===NeuralynxUDPStream===
Settings if you want to use the Low Latency Stream. This requires a fiber-optic connection between the Amplifier and the BCI2000 computer.

* '''Boards:''' The Number of Boards which are connected in the Neuralynx Chassis
* '''SourceChnList:''' List of transmitted Channels. This allows you to only submit a subset of Channels. Its a list of channel ids (starting from 0). If set to auto, all channels will be transmitted.
* '''UseDirectUDPSTream:''' Easy way to switch the UDP stream on or off. This has to be enabled for low latency communication
* '''UDPStreamPort:''' Port through which the BCI2000 computer receives data from the Neuralynx System. This port is provided by Neuralynx.
* '''DecimationFactor:''' Decimation Factor for incoming Data. Incoming Data is sampled at 32kHz. If Decimation Factor is set, SamplingRate has to match or has to be set to auto. similarly, if SamplingRate is set, DecimationFactor can be set to auto and the system will determine the correct decimation factor automatically. Downsampling will be achieved by a simple moving average filter.
* '''NRDStreamingFile:''' Leave Empty. This can be used to stream data from a Neuralynx NRD file for debugging purposes.

==States==

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

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

Contributions:NeuralynxADC

2020-07-15T17:08:56Z

Madamek2: /* Functional Description */

==Synopsis==
The NeuralynxNetComADC allows data acquisition from [https://neuralynx.com/ Neuralynx] Cheetah or Pegasus system. 
The module is able to record data with two different modes: 
(1) Acquisition via the NetCom interface, which connects to Cheetah/Pegasus. 
(2) Low-latency data acquisition via a fiber cable directly connected to the Acquisition amplifier. 
===Known Issues===
BCI2000 will not be able to keep up for high sampling rates & channel counts. This will result in a high roundtrip time and increasing memory usage over time, as incoming data is buffered but not processed in time.
If the low latency data acquisition is used, make sure to downsample data from 32kHz if you use all 512 Channels.

==Location==

==Versioning==

===Authors===

Markus Adamek

===Version History===

===Source Code Revisions===
*Initial development: 6024
*Tested under: 6082
*Known to compile under: 6082
*Broken since: --

==Hardware Configuration==
This Acquisition module has two ways to stream data from a Pegasus/Cheetah System.
===Acquisition via the NetCom Interface===
To acquire data via the NetCom interface the experimental Computer (Running BCI2000) has to be connected to the Pegasus/Cheetah System (Running the Acquisition Software) via Ethernet.

(1) Make sure that both computers are on the same subnet and that the Acquisition Software is running on the Pegasus/Cheetah System (You don't need to start an acquisition or recording). 
(2) Configure BCI2000 with the correct IP address (ServerName). Be aware that the Pegasus/Cheetah System has multiple Network ports! 
(3) After pressing Set Config in BCI2000 it should seamlessly connect to the Pegasus/Cheetah System. BCI2000 will automatically start data acquisition. 
You can check if BCI2000 has connected correctly by opening the Acquisition System Status on the Pegasus/Cheetah System. In this window you should see a field called NetCom Clients. If BCI2000 is connected, it should be listed. 

[[File:Netcominterface.png]]

===Acquisition via low-latency connection===
The low-latency stream allows us to tap directly into the data streamed from the ADC without the Pegasus/Cheetah System. This approach significantly reduces latency and increases the stability of the timebase.
While data is streamed directly from the amplifier, configuration still requires the Pegasus/Cheetah System and connection via the NetCom interface. You can follow the steps above to ensure that you are able to connect to the NetCom Interface.

The low-latency stream requires direct connection to the amplifier via a fiber optic ethernet connection. Therefore, the BCI2000 computer requires an optical ethernet interface.
The optical ethernet card has to be configured identical to the card installed in the Pegasus/Cheetah System.
(1) Obtain the IP address, subnet mask as well as the MAC address.
To get this information open a command window on the Pegasus/Cheetah System (To find the command prompt type cmd in the Windows 10 search bar).
Type <code>ipconfig -all</code> which will give you information of all Network adapters.
You will need to find the physical port that connects the amplifier with the Pegasus/Cheetah System. A good way to ensure that you chose the correct adapter is to turn of the amplifier and check which adapter changed.
Your result might look different than the example below.
<code>
Ethernet adapter Ethernet:

Connection-specific DNS Suffix . :
Description . . . . . . . . . . . : Intel(R) Ethernet Server Adapter I350-F2
Physical Address. . . . . . . . . : 48-2A-E3-40-45-DB
Link-local IPv6 Address . . . . . : fe80::cc21:7e8e:f65a:158e%11
IPv4 Address. . . . . . . . . . . : 172.20.2.144
Subnet Mask . . . . . . . . . . . : 255.255.0.0
Lease Obtained. . . . . . . . . . : Wednesday, July 15, 2020 8:25:32 AM
Lease Expires . . . . . . . . . . : Thursday, July 16, 2020 8:25:25 AM
Default Gateway . . . . . . . . . : 172.20.1.1
DHCP Server . . . . . . . . . . . : 172.20.1.1
DHCPv6 IAID . . . . . . . . . . . : 105392867
DHCPv6 Client DUID. . . . . . . . : 00-01-00-01-24-67-EF-14-48-2A-E3-40-45-DB
DNS Servers . . . . . . . . . . . : 172.20.1.1
NetBIOS over Tcpip. . . . . . . . : Enabled
</code>

You will need the information shown in Physical Address (MAC address), IPv4 Address and Subnet Mask.
(2) Change the settings of the fiber card Network Adapter on your BCI2000 machine.
To change the MAC address you can use a tool like the [https://technitium.com/tmac/ Technitium MAC Address Changer]. Make sure that you are changing the correct Network connection!
(3)Replace your current MAC address with the Physical Address obtained from the Pegasus/Cheetah System.
To change IP address and Subnet mask you can follow a tutorial like this one:[Change IP Address (Start at step 3) https://www.professionaltutorial.com/change-ip-address-in-windows-10/].
(4) Connect the BCI2000 computer to the Amplifier with an appropriate fiber cable. The BCI2000 machine should be connected via the free fiber-cable ethernet port on the amplifier. Make sure that you plugged the fiber cable into the free port on the amplifier and not the free fiber port on the Pegasus/Cheetah System.
(5) Check if the data gets streamed to the BCI2000 computer. If you have configured everything correctly, data should now be streamed to your computer if the acquisition is started on the Pegasus/Cheetah System.
The easiest way to check this is to open the Task Manager (Ctrl+Shift+Esc) on the BCI2000 system. In the performance tab, you can monitor incoming and outgoing traffic on your network adapters. If you were successful, you should see a steady inflow of data on the ethernet port which connects your computer to the amplifier. If you are unsure, open the task manager on the Pegasus/Cheetah System, you should see the same type of data usage.
(6) Start BCI2000 and enable UseDirectUDPStream for the Low-Latency stream.

==Parameters==
===Signal Properties===
Signal Properties describe Settings common to most Amplifiers.
* '''SourceCh:''' The number of channels that the Neuralynx software reads.
* '''SampleBlockSize:''' Samples per channel per digitized block. Together with the sampling rate, this parameter determines how often per second data is collected, processed, and feedback is updated.
* '''SamplingRate:''' Sampling rate of the data. The SamplingRate has to be an integer fraction of 32kHz.
* '''ChannelNames:''' List of Names for Channels. Space-separated list; Must be the same length as Number of Channels. If set to auto, BCI2000 will query the Names from the Neuralynx system.
* '''SourceChOffset:''' Setting is not used in this module, default is 0
* '''SourceChGain:''' This is also not used, default is 1
===NeuralynxNetCom===
This Section describes Settings Necessary to communicate with the Cheetah/Pegasus System via the NetCom Interface
* '''ServerName:''' IP Address of the NetCom server (Typically the IP of your Cheetah/Pegasus System)

===NeuralynxUDPStream===
Settings if you want to use the Low Latency Stream. This requires a fiber-optic connection between the Amplifier and the BCI2000 computer.

* '''Boards:''' The Number of Boards which are connected in the Neuralynx Chassis
* '''SourceChnList:''' List of transmitted Channels. This allows you to only submit a subset of Channels. Its a list of channel ids (starting from 0). If set to auto, all channels will be transmitted.
* '''UseDirectUDPSTream:''' Easy way to switch the UDP stream on or off. This has to be enabled for low latency communication
* '''UDPStreamPort:''' Port through which the BCI2000 computer receives data from the Neuralynx System. This port is provided by Neuralynx.
* '''DecimationFactor:''' Decimation Factor for incoming Data. Incoming Data is sampled at 32kHz. If Decimation Factor is set, SamplingRate has to match or has to be set to auto. similarly, if SamplingRate is set, DecimationFactor can be set to auto and the system will determine the correct decimation factor automatically. Downsampling will be achieved by a simple moving average filter.
* '''NRDStreamingFile:''' Leave Empty. This can be used to stream data from a Neuralynx NRD file for debugging purposes.

==States==

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

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

File:Netcominterface.png

2020-07-15T16:15:25Z

Madamek2: Shows BCI2000 successfully connected to A Pegasus/Cheetah Client

== Summary ==
Shows BCI2000 successfully connected to A Pegasus/Cheetah Client

Contributions:NeuralynxADC

2020-07-15T15:59:20Z

Madamek2: /* Source Code Revisions */

Contributions:NeuralynxADC

2020-07-15T15:58:33Z

Madamek2: /* Known Issues */

Contributions:NeuralynxADC

2020-07-15T15:56:45Z

Madamek2:

Contributions:NeuralynxADC

2019-11-11T19:59:32Z

Madamek2: Created page with "==Synopsis== The NeuralynxNetComADC allows data acquisition from [https://neuralynx.com/ Neuralynx] Cheetah or Pegasus system. The module is able to record data with two..."