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.
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file ezmsg_lsl-1.12.0.tar.gz.
File metadata
- Download URL: ezmsg_lsl-1.12.0.tar.gz
- Upload date:
- Size: 27.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
uv/0.11.32 {"installer":{"name":"uv","version":"0.11.32","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}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
936e54cb35d0b57bb35a1d10f6b358d8ec328aa6dc9e7e4882cdb657b0cee2bf
|
|
| MD5 |
af94a2b47ea4d1020fe1a3ef93a34f32
|
|
| BLAKE2b-256 |
6198d4665bf65c6c5eff8fb1a5531512f6f8e87927f8462779b12f9ba32d1e6e
|
File details
Details for the file ezmsg_lsl-1.12.0-py3-none-any.whl.
File metadata
- Download URL: ezmsg_lsl-1.12.0-py3-none-any.whl
- Upload date:
- Size: 14.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
uv/0.11.32 {"installer":{"name":"uv","version":"0.11.32","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}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
ae3c01ba8596db6e116d742aefbbd007466b4b649433e68f099b6806796c28d6
|
|
| MD5 |
91088474b4b715170aa70be1a4bc3b27
|
|
| BLAKE2b-256 |
45c54f98dbe893cb664630684a0c8ec6806f434a59af4d23989d276d8b274c3e
|
