Changes

Jump to navigation Jump to search
2,605 bytes added ,  14:09, 23 January 2023
Line 4: Line 4:  
| screenshot            =  
 
| screenshot            =  
 
| caption                =  
 
| caption                =  
| developer              = Christian Kothe; University of California San Diego.
+
| developer              = Christian Kothe; Chadwick Boulay.
 
| released              = <!-- {{Start date and age|YYYY|MM|DD|df=yes}} -->
 
| released              = <!-- {{Start date and age|YYYY|MM|DD|df=yes}} -->
 
| discontinued          =  
 
| discontinued          =  
Line 13: Line 13:  
| installed version      =  
 
| installed version      =  
 
| installed version date = <!-- {{Start date and age|YYYY|MM|DD|df=yes}} -->
 
| installed version date = <!-- {{Start date and age|YYYY|MM|DD|df=yes}} -->
| status                = in development
+
| status                = -in development-
 
| programming language  = C, C++, Python, Java, C#, MATLAB
 
| programming language  = C, C++, Python, Java, C#, MATLAB
 
| operating system      = Windows, Linux, MacOS, Android, iOS
 
| operating system      = Windows, Linux, MacOS, Android, iOS
Line 27: Line 27:  
     | downloads          =  
 
     | downloads          =  
 
     | manuals            = {{bulleted list
 
     | manuals            = {{bulleted list
         | [https://docs.unity3d.com/Manual/index.html Official Documentation]
+
         | [https://docs.openbci.com/ Documentation]
 +
        | [https://sccn.ucsd.edu/~mgrivich/LSL_Validation.html LSL Validation]
 +
        | [https://labstreaminglayer.readthedocs.io/info/supported_devices.html Supported Devices and Tools]
 +
    }}
 +
    | header2            = Templates
 +
    | data2              = {{bulleted list
 +
        | [https://surfdrive.surf.nl/files/index.php/s/qggfMMKsnUIDO0k example scripts (zip)]
 
     }}
 
     }}
 
   }}
 
   }}
Line 37: Line 43:     
==Installation==
 
==Installation==
We advise installing Unity via the [https://unity3d.com/get-unity/download Unity HUB]. This provides a handy overview of all your projects and allows you to easily switch between different Unity versions. You will be required to create an account.
+
Our support for LSL is mainly done in python. Download python here: [https://www.python.org/downloads/release/python-376/ Please choose a 64 bit version.]. Run the installer and make sure to add Python to the file path (it's an option in the installer).
 +
Open a command prompt, start with upgrading the pip installer by typing:<br/>
 +
<code style="background-color:#000; color:#fff; padding:1px 3px;">c:>python -m pip install --upgrade pip</code><br/>
 +
Then:<br/>
 +
<code style="background-color:#000; color:#fff; padding:1px 3px;">c:>pip install pylsl</code>
 +
 
 +
more info: [https://github.com/labstreaminglayer/liblsl-Python cross platform pylsl]
    
===Versions===
 
===Versions===
Unity is constantly updated, and new versions will frequently include Beta features that may not be super reliable and well documented yet. As such it is sometimes quite difficult to figure out which version to use. If you wish to create your own Unity projects, we advise to install the latest long term support (LTS) release. Beware that any tutorials, forum answers and plugins you find online may no longer be compatible with your version, so always check the date and official documentation. Of course you can also come to the TSG for help.
+
The TSG uses the version 1.15.0. Open a command and type the following to find the version used:
 +
 
 +
<code style="background-color:#000; color:#fff; padding:1px 3px;">c:>python</code><br/>
 +
<code style="background-color:#000; color:#fff; padding:1px 3px;">>>> import pylsl</code><br/>
 +
<code style="background-color:#000; color:#fff; padding:1px 3px;">>>> print(pylsl.__version__)</code><br/>
    
==Usage==
 
==Usage==
''(Under Construction)''<br/>
+
=== Python ===
We are working on templates and tips. Stay tuned!
+
A short example for sending lsl streaming data:
*[[Unity/Timing]]
+
<syntaxhighlight lang="python" line>
 +
#!/usr/bin/env python
 +
 
 +
import threading
 +
from pylsl import StreamInfo, StreamOutlet
 +
 
 +
def getData():
 +
    while running:
 +
        buffer_in = getSensorData()
 +
        send_data = True
 +
        time.sleep(0.001)
 +
 
 +
info = StreamInfo(
 +
    name='MyStream',
 +
    type='COP',
 +
    channel_count=4,
 +
    nominal_srate = 200,
 +
    source_id='BalanceBoard_stream'
 +
    )
 +
outlet = StreamOutlet(info)  
 +
 
 +
threading.Thread(target=getData).start()
 +
while running == True:
 +
if send_data:
 +
outlet.push_chunk(buffer_in)
 +
send_data = False
 +
</syntaxhighlight>
 +
 
 +
A short example for receiving lsl data:
 +
<syntaxhighlight lang="python" line>
 +
#!/usr/bin/env python
 +
 
 +
from pylsl import StreamInlet, resolve_stream
 +
 
 +
streams = resolve_stream('name', 'MyStream')
 +
#streams = resolve_streams()
 +
 
 +
inlet = StreamInlet(streams[0])
 +
while True:
 +
    sample, timestamp = inlet.pull_sample()
 +
    print(timestamp, sample)
 +
</syntaxhighlight>
 +
 
 +
=== Matlab ===
 +
Please, read the instructions on the GitHub labstreaminglayer website (https://github.com/labstreaminglayer/liblsl-Matlab) on how to prepare Matlab to work with LSL. You can either use the latest release for your Matlab version, or if that doesn't workout well, build it from the source files. Make sure to add the liblsl-Matlab folder to your path recursively to make it available to your own scripts.
 +
 
 +
A short example for sending lsl streaming data:
 +
<syntaxhighlight lang="matlab" line>
 +
%% instantiate the library
 +
disp('Loading library...');
 +
lib = lsl_loadlib();
 +
 
 +
% make a new stream outlet
 +
disp('Creating a new streaminfo...');
 +
info = lsl_streaminfo(lib,'BioSemi','EEG',8,100,'cf_float32','sdfwerr32432');
 +
 
 +
disp('Opening an outlet...');
 +
outlet = lsl_outlet(info);
 +
 
 +
% send data into the outlet, sample by sample
 +
disp('Now transmitting data...');
 +
while true
 +
    outlet.push_sample(randn(8,1));
 +
    pause(0.01);
 +
end
 +
</syntaxhighlight>
 +
 
 +
A short example for receiving lsl streaming data:
 +
<syntaxhighlight lang="matlab" line>
 +
%% instantiate the library
 +
disp('Loading the library...');
 +
lib = lsl_loadlib();
   −
===Builds===
+
% resolve a stream...
We advise not to run your experiment from the Unity Editor, this will cause unwanted overhead that harms the performance. You can create a PC Standalone build to run it on our [[Computers | lab computers]].
+
disp('Resolving an EEG stream...');
 +
result = {};
 +
while isempty(result)
 +
    result = lsl_resolve_byprop(lib,'type','EEG'); end
   −
==References==
+
% create a new inlet
<references />
+
disp('Opening an inlet...');
 +
inlet = lsl_inlet(result{1});
   −
==External Links== <!-- Optional -->
+
disp('Now receiving data...');
*{{Official website|https://unity3d.com}}
+
while true
*[https://docs.unity3d.com/Manual/index.html Official Documentation]
+
    % get data from the inlet
 +
    [vec,ts] = inlet.pull_sample();
 +
    % and display it
 +
    fprintf('%.2f\t',vec);
 +
    fprintf('%.5f\n',ts);
 +
end</syntaxhighlight>

Navigation menu