1.3.1

• Improve handling of warnings throughout the codebase to improve the feedback received by @mscheltienne in #243

Full Changelog: 1.3.0...1.3.1

1.3.0

What's Changed

• Add IIR filters to a Stream object through the methods Stream.filter and Stream.notch_filter by @mscheltienne and @larsoner in #218 and #226
• Improve logging and level handling by @mscheltienne in #219
• Add n_repeat argument to Player by @mscheltienne in #223
• Improve documentation of performance differences between pylsl and mne.lsl by @mscheltienne in #231

Full Changelog: 1.2.0...1.3.0

1.2.0

• Implement MNE's design philosophy by returning self in methods modifying a StreamLSL -> enables method chaining stream.pick("eeg").set_eeg_reference("average")
• Add argument annotations to PlayerLSL to stream annotations on a separate irregularly sampled stream
• Add support for loaded Raw objects as input to a PlayerLSL
• Improve deletion or low-level resources
• Improve discovery and download of existing liblsl on the system
• Fix reading of yRange through settings in legacy StreamViewer

Full Changelog: 1.1.1...1.2.0

1.1.1

• Fix parsing of incomplete StreamInfo into an mne.Info object by @mscheltienne in #179
• Remove pytest related files from the distribution by @mscheltienne in #180

Full Changelog: 1.1.0...1.1.1

1.1.0

What's Changed

• Remove legacy setup.py by @mscheltienne in #167
• Improve documentation workflow by @mscheltienne in #170
• Add support for 'timestamp' array in a push operation by @mscheltienne in #172
• Add local sphinx-remove-toctrees extension by @mscheltienne in #173
• Improve type-hints by @mscheltienne in #175
• MAINT: Make tests less flaky by @larsoner in #168
• Improve test coverage on load-liblsl and on datasets by @mscheltienne in #176
• Improve test coverage, structure and checks for strean connection in properties by @mscheltienne in #177
• Match argument order between BasePlayer and PlayerLSL by @mscheltienne in #178

New Contributors

• @larsoner made their first contribution in #168

Full Changelog: 1.0.0...1.1.0

Please report encountered issues on the tracker.

1.0.0

Initial release of mne-lsl for Python 3.9 to 3.12. MNE-LSL integrates tightly LSL streams with MNE-Python. It replaces the LSLClient in mne_realtime with 2 main objects:

• mne_lsl.stream.StreamLSL: connects to an LSL stream and acts as a Raw object which underlying data array is a ringbuffer continuously updated.
• mne_lsl.player.PlayerLSL: create a fake LSL stream from any MNE-readable file.

player = mne_lsl.player.PlayerLSL(...)
player.start()
stream = mne_lsl.stream.StreamLSL(...)
stream.connect()
stream.pick("eeg")
stream.set_eeg_reference("average")
data, ts = stream.get_data()
stream.disconnect()
player.stop()

Additionally, the low-level mne_lsl.lsl module re-implements a faster version of pylsl with convenience methods to set and retrieve metadata, for instance from an mne.Info object.

sinfo = mne_lsl.lsl.StreamInfo(...)
sinfo.set_channel_info(info)
info = sinfo.get_channel_info()

Please report encountered issues on the tracker.