Skip to content

Commit 2b9aa2d

Browse files
committed
Update README
1 parent 6f73db2 commit 2b9aa2d

File tree

1 file changed

+6
-18
lines changed

1 file changed

+6
-18
lines changed

README.md

+6-18
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,17 @@
11
# Lab Streaming Layer I/O
22

3-
![lsl-inlet-screenshot](Resources/lsl-inlet.png)
3+
![lsl-inlet-screenshot](https://open-ephys.github.io/gui-docs/_images/lslinlet-01.png)
44

55
Creates a lab streaming layer (LSL) client for streaming continuous data into the Open Ephys GUI. An LSL Outlet plugin may be released in the future.
66

77
## Installation
88

9-
This plugin will soon be available via the Open Ephys GUI Plugin Installer. To access the Plugin Installer, press **ctrl-P** or **⌘P** from inside the GUI. Once the installer is loaded, browse to the "Ephys Socket" plugin and click "Install."
10-
11-
12-
## Development history
13-
14-
This plugin was developed and opened to the community with :heart: by [AE Studio](https://ae.studio/) and [Chadwick Boulay](https://github.com/cboulay). The original repository can be found at https://github.com/labstreaminglayer/OpenEphysLSL-Inlet
9+
This plugin can be added via the Open Ephys GUI's built-in Plugin Installer. Press **ctrl-P** or **⌘P** to open the Plugin Installer, browse to "Lab Streaming Layer IO", and click the "Install" button. The LSL Inlet plugin should now be available to use.
1510

1611

1712
## Usage
1813

19-
Before starting the data acquisition process a data stream needs to be selected. The list of available data streams (and marker streams) is updated every time the button `Refresh streams` is pressed. During data acquisition samples can be scaled in real time by adjusting the `Scale` factor.
20-
21-
A marker stream can be optionally selected. The list of marker streams only shows streams that have an irregular rate and a single channel. When a marker is received it is broadcasted to the entire signal chain. For a marker to be shown in the LFP view, a `markers to TTL mapping` is required. This is a json file that should contain a set of Key-Value pairs of markers and corresponding TTL values, for example:
22-
```
23-
{
24-
"Marker_1": 1,
25-
"Marker_2": 2
26-
}
27-
```
14+
Instructions for using the LSL Inlet Plugin are available [here](https://open-ephys.github.io/gui-docs/User-Manual/Plugins/LSL-Inlet.html).
2815

2916
## Building from source
3017

@@ -68,8 +55,6 @@ From the `Build` directory, enter:
6855

6956
```bash
7057
cmake -G "Unix Makefiles" ..
71-
cd Debug
72-
make -j
7358
make install
7459
```
7560

@@ -90,3 +75,6 @@ Next, launch Xcode and open the `lab-streaming-layer-io.xcodeproj` file that now
9075

9176
Running the `ALL_BUILD` scheme will compile the plugin; running the `INSTALL` scheme will install the `.bundle` file to `/Users/<username>/Library/Application Support/open-ephys/plugins-api8`. The LSL Inlet plugin should be available the next time you launch the GUI from Xcode.
9277

78+
## Attribution
79+
80+
This plugin was developed and opened to the community with :heart: by [AE Studio](https://ae.studio/) and [Chadwick Boulay](https://github.com/cboulay). The original repository can be found at https://github.com/labstreaminglayer/OpenEphysLSL-Inlet

0 commit comments

Comments
 (0)