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
ezmsgpylslnumpy
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(defaultTrue) — push samples with the incoming message timestamps, or withpylsl.local_clock()whenFalse.assume_lsl_clock(defaultFalse) — whenuse_message_timestampisTrue, whether the incoming timestamps are already in the LSL clock (otherwise they are converted from the system clock).sync_blocking(defaultFalse) — whenTrue, the outlet is created with thepylsl.transp_sync_blockingtransport flag, enabling the synchronous (zero-copy) outlet mode for high-bandwidth streams. Requirespylsl >= 1.18.3b1. LeaveFalsefor 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.
- Install
uvif not already installed. - Fork ezmsg-lsl and clone your fork to your local computer.
- Open a terminal and
cdto the cloned folder. uv syncto create a .venv and install dependencies.- (Optional) Install pre-commit hooks:
uv run pre-commit install - After editing code and making commits, Run the test suite before making a PR:
uv run pytest tests- Currently, there are no substantial tests.
Metadata
Release files for ezmsg-lsl 1.17.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| ezmsg_lsl-1.17.0.tar.gz | 38.6 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| ezmsg_lsl-1.17.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 58.5 kB
Release files / ezmsg_lsl-1.17.0.tar.gz
| Download URL | ezmsg_lsl-1.17.0.tar.gz |
|---|---|
| Size | 38.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
a89cb63e042ee0475ccc3ef34f6dbb4f05e1913c623a0d5755e20be4f064019c
|
|
BLAKE2b-256 checksum How to use checksums |
4bff2697b0d06d2df74ebf87133aaeae71b53cdeb1bae9c3acb264947097688d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
uv/0.12.23 {"installer":{"name":"uv","version":"0.12.23","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
Release files / ezmsg_lsl-1.17.0-py3-none-any.whl
| Download URL | ezmsg_lsl-1.17.0-py3-none-any.whl |
|---|---|
| Size | 19.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
9592a20d3346cd1b88f6cc74ab7240ede8b3a18bbc6751c6aee376a974e49393
|
|
BLAKE2b-256 checksum How to use checksums |
0e298364ea9cd4ae46dc90d6feeb42f4b781033fd1a2dd4008c1b21d2bf15688
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
uv/0.12.23 {"installer":{"name":"uv","version":"0.12.23","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
