ezmsg-lsl

Interface to Lab Streaming Layer LSL in ezmsg.

Installation

pip install ezmsg-lsl

Or install the latest development version:

pip install git+https://github.com/ezmsg-org/ezmsg-lsl@dev

Dependencies

• ezmsg
• pylsl
• numpy

Usage

See the examples folder for more details.

LSL Outlet

LSLOutletUnit publishes incoming AxisArray messages to an LSL stream. Key settings (LSLOutletSettings):

• stream_name / stream_type — name and type advertised on the LSL stream.
• use_message_timestamp (default True) — push samples with the incoming message timestamps, or with pylsl.local_clock() when False.
• assume_lsl_clock (default False) — when use_message_timestamp is True, whether the incoming timestamps are already in the LSL clock (otherwise they are converted from the system clock).
• sync_blocking (default False) — when True, the outlet is created with the pylsl.transp_sync_blocking transport flag, enabling the synchronous (zero-copy) outlet mode for high-bandwidth streams. Requires pylsl >= 1.18.3b1. Leave False for the standard asynchronous transport.

from ezmsg.lsl.outlet import LSLOutletUnit

outlet = LSLOutletUnit(
    stream_name="my_stream",
    stream_type="EEG",
    sync_blocking=True,  # synchronous zero-copy transport
)

Developers

We use uv for development. It is not strictly required, but if you intend to contribute to ezmsg-lsl then using uv will lead to the smoothest collaboration.

1. Install uv if not already installed.
2. Fork ezmsg-lsl and clone your fork to your local computer.
3. Open a terminal and cd to the cloned folder.
4. uv sync to create a .venv and install dependencies.
5. (Optional) Install pre-commit hooks: uv run pre-commit install
6. After editing code and making commits, Run the test suite before making a PR: uv run pytest tests
   • Currently, there are no substantial tests.