Interacting with NIC
In this page we describe how you can interact with NIC (Neuroelectrics Instrument Controller, the software for control with NE devices) using other software.
Contents
About Synchronization: general principles
Sending Markers to NIC from other software or hardware
Sending Markers using TCP/IP
NIC provides a server that other software can connect to in order to send markers. Those received markers are synchronized with the EEG streaming for further analysis.
This NIC server is running in the TCP/IP port 1234. Up to five clients can simultaneously send markers to NIC by making a TCP/IP connection to this port.
Once a client is connected it needs to send the following string in order to send a marker:
<TRIGGER>XXXX</TRIGGER>
Where XXXX can represent any integer number different from zero (from -2147483647 to +2147483647). This marker will be co-registered in the output files generated by NIC to the corresponding EEG sample. For instance, in the output tabulated text file, the column just after the timestamp one is filled with zeros if no markers are received. When a marker is received its corresponding number is set to that column. See the following example:
... 26748 -27675 35631 42398 532666 64345 12376 40988 0 1382432459788 26865 -26683 35685 42450 532711 64821 12376 41046 0 1382432459790 26810 -26821 35531 41997 532821 64945 13164 41099 0 1382432459792 26749 -26995 35325 42008 532712 64377 13478 41286 0 1382432459794 26796 -27245 35932 42391 532923 64245 13620 41117 300 1382432459796 <-- Reception of the marker #300 26622 -27510 35501 42630 532876 64193 13031 40986 0 1382432459798 26751 -27912 35611 42003 532345 64344 12967 40731 0 1382432459800 ...
Please take as an example this Matlab code which connects to NIC to send markers every time a tone is played back through the sound card. If you connected the output of the computer sound card to one of the Enobio electrodes you would be able to see the alignment between the markers and the played tones.
Sending markers using LSL
NIC is compliant with the Lab Streaming Layer (LSL) protocol so makers can be co-registered with the EEG signal by setting up a LSL marker outlet (see this example).
The LSL handles both the networking and time-synchronization isues between the sender and receiver hosts obtaining reliability on order of 1 ms (see the time-synchronization validation tests).
NIC needs little configuration in order to receive the markers from a LSL outlet present in the local network. When the LSL marker outlet sends integer-type markers only the name of the outlet needs to be configured in NIC.
Please go to "EEG Setup -> Settings -> Markers from Lab Streaming Layer" and set the name that your LSL marker outlet has. NIC will automatically look for a marker outlet with this name and will connect to it. If the outlet sends integer-type integers then no further configuration is needed. All the received makers will be co-registered along with the EEG signal to the output files.
In case the outlet sends string-type markers then there are some considerations that have to be taken into account. The LSL outlet sending string-type markers has to format them as XML tags. The following example is taken from the string markers that the Presentation software sends when the LSL extension manager is installed (see the Working with ERPs section). You can see that NIC will decode the string looking for the tag that is configured in the "EEG Setup -> Settings -> Markers from Lab Streaming Layer" settings, ecode in this case. The marker number 37 will be registered at the reception of this string:
<pevent><etype>Picture</etype><ecode>37</ecode><unc>209.638092041016</unc>test</pevent>
Receiving data streams from NIC
Receiving data streams using TCP/IP
The NIC software has a TCP/IP server that streams the EEG data received from Enobio. Up to 5 clients can connect to that server simultaneously in order to receive the EEG data ans perform the desired operations in real time.
The software clients that want to receive the EEG data in real time from NIC need to connect to the TCP/IP port 1234 of the host where the NIC software is running. Once the client software is connected to the server, it will receive the EEG data streaming according to the following format:
------------------------------------------------------------------------------------------- | Channel 1 | ... | Channel N | ------------------------------------------------------------------------------------------- | (MSB) Byte#1 | Byte#2 | Byte#3 | (LSB) Byte#4 | ... | Byte#1 | Byte#2 | Byte#3 | Byte#4 | -------------------------------------------------------------------------------------------
Each EEG sample is sent as a two-complement 4 byte value. The unit of the EEG sample is nano volts and its range is from -400000000 to +400000000 nV. The most significant byte is sent first. The following code in 'C' shows how to decode the streaming from the received bytes to EEG sample values. The example assumes that the computer architecture is little-endian.
// byte3 = 0xFF, byte2 = 0x8F, byte1 = 0x99, byte0 = 0x61 signed int32_t sample = 0; sample += byte3; sample = sample << 8; sample += byte2; sample = sample << 8; sample += byte1; sample = sample << 8; sample += byte0; // sample = -141584031 nV
The client will receive first the four bytes from channel 1, then the next four bytes from channel 2 and so on till receiving the four bytes from the last channel of Enobio (8 or 20 depending of the type of Enobio/Starstim NIC handles). Then channel 1 bytes are receiving again.
The following links are a Java and a Matlab example clients that connects to NIC and receive the EEG streaming: Java client, Matlab client
Receiving data streams using LSL
NIC streams the received EEG data from Enobio usign the Lab Streaming Layer. NIC creates a LSL outlet with the following settings:
Name: Enobio Type: EEG Channel count: 8 or 20 depending of the Enobio NIC handles Nominal sample rate: 500 Channel format: float_32 Unique source ID: The Enobio type plus its mac address
An LSL client software needs to connect to this outlet in order to receive the EEG streaming data. The received values are expressed in nanovolts and its range is from -400000000 to +400000000.
Using LSL is possible to access to the accelerometer data too. The outlet the LSL clients need to connect to has the following settings:
Name: Enobio Type: Accelerometer Channel count: 3 Nominal sample rate: 100 Channel format: float_32 Unique source ID: The Enobio type plus its mac address plus the "Acc" string
