labrecorder 1.0.0rc0__cp312-cp312-win_amd64.whl

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2012 Christian Kothe
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

LabRecorder.cfg

@@ -0,0 +1,69 @@
+; === Storage Location ===
+; the default file name can be something like C:\\Recordings\\untitled.xdf, but can also contain
+; placeholders. Two placeholder formats are supported: Legacy and BIDS.
+;
+; For BIDS format, only a StudyRoot can be provided.
+; If the full StorageLocation or PathTemplate is provided
+; then it will be assumed that a non-BIDS format is being used.
+;
+; Legacy may contain a running number (incremented per experiment session) called %n, and a 
+; placeholder for a "block" label %b (if the config script provides a list of block names that 
+; consitute a session.
+;
+; For BIDS, the path may contain %p for participant label, %s for session label,
+; %b for task label (same as block in Legacy), %a for name of acquisition parameter set, and %r index.
+; The BIDS syntax is: path/to/StudyRoot/sub-%p/ses-%s/eeg/sub-%p_ses-%s_task-%b[_acq-%a]_run-%r_eeg.xdf
+;
+; If neither StorageLocation or StudyRoot is provided then the default root is QStandardPaths::DocumentsLocation/CurrentStudy/
+; If neither StorageLocation or PathTemplate are provided, then the BIDS format is assumed, or the file template exp%n/block_%b.xdf if BIDS is unchecked.
+
+; StorageLocation=C:/Recordings/CurrentStudy/sub-%p/ses-%s/behav/sub-%p_ses-%s_task-%b_acq-%a_run-%r_eeg.xdf
+; StudyRoot=C:/Recordings/CurrentStudy/
+; PathTemplate=exp%n/block_%b.xdf
+
+; === Block Names ===
+; This is optionally a list of blocks that make up a recording session. The blocks are displayed in 
+; a list box where the experiment can select a block before pressing record. If used, the blocks 
+; may serve as a reminder of where they are in the experiment, but more practically, can be 
+; used to determine the file name of the recording. Power users can define scriptable actions 
+; associated with selecting a block or pressing Start/Stop for a given block (e.g., for remote 
+; control).
+; The syntax is as in: SessionBlocks = "Training","PreBaseline","MainSection","PostBaseline"
+; SessionBlocks="T1", "T2", "T3" 
+
+; === BIDS modalities ===
+; This is optionally a list of BIDS modalities to be added to the default list defined in the source code. 
+; Defaults are: "eeg", "ieeg", "meg", "beh"
+; The selected value will replace the %m placeholder in the filename template. 
+; physio is an example from:
+; https://bids-specification.readthedocs.io/en/stable/04-modality-specific-files/06-physiological-and-other-continuous-recordings.html
+; BidsModalities="eeg", "ieeg", "meg", "beh", "physio"
+
+; === Required Streams ===
+; This is optionally a list of streams that are required for the recording; 
+; a warning is issued if one of the streams is not present when the record button is pressed
+; The syntax is as in: RequiredStreams = "BioSemi (MyHostname)","PhaseSpace (MyHostname)","Eyelink (AnotherHostname)"
+; where the format is identical to what the LabRecorder displays in the "Record from streams" list.
+; There must not be any spaces within the parentheses.
+; RequiredStreams="RequiredExample (PC-HOSTNAME)" 
+
+; === Online Sync ===
+; A list of sync settings. Each setting follows the following format: "SrcStreamName (SrcHostName) post_FLAG"
+; where post_FLAG is described here: https://github.com/sccn/liblsl/blob/master/src/common.h#L77-L89
+; Note that it is not necessary to set any flags for correct storage because all of the post-processing synchronization
+; can be achieved during file import using either the Matlab or Python importers.
+; Examples:
+;     OnlineSync="ActiChamp-0 (DM-Laptop) post_ALL", "LiveAmpSN-054211-0237 (User-PC) post_ALL"
+;     OnlineSync=["ActiChamp-0 (User-PC)" post_ALL]
+; OnlineSync="SendDataC (Testpc) post_ALL", "Test (Testpc) post_clocksync"
+
+; === Remote Control Socket ===
+; A list of options containing 2 possible values: 
+; RCSEnabled to control the state of the remote control stream on launch : 1/0; default 1
+; RCSPort to set the port number for the socket; default 22345
+RCSEnabled=1
+RCSPort=22345
+
+; === Auto Start Recording ===
+; Set AutoStart to 1 to automatically start recording as soon as the config file has concluded parsing.
+; AutoStart=1

README.md

@@ -0,0 +1,184 @@
+# Overview
+
+The LabRecorder is the default recording program that comes with LSL. It allows to record all streams on the lab network (or a subset) into a single file, with time synchronization between streams.
+
+# File Format
+
+The file format used by the LabRecorder is XDF. This is an open general-purpose format that was designed concurrently with LSL and supports all features of LSL streams. The project page is [here](https://github.com/sccn/xdf). There are importers for MATLAB, EEGLAB, BCILAB, Python, and MoBILAB.
+
+# Getting LabRecorder
+
+The [releases page](https://github.com/labstreaminglayer/App-LabRecorder/releases) contains archives of past LabRecorder builds. Try downloading and installing an archive that matches your platform. Note for Ubuntu users: The deb will install LabRecorder to `/usr/LabRecorder` though we might change this to `/usr/local/bin/LabRecorder` in the future.
+
+If there are no archives matching your target platform, or the ones available don't run, then continue reading below. If the instructions don't help then please post an issue to the [repo's issues page](https://github.com/labstreaminglayer/App-LabRecorder/issues).
+
+## Dependencies
+
+For LabRecorder to work on your system, you might need to first install some dependencies, specifically liblsl and optionally Qt.
+
+### Windows
+
+The Windows archives ship with nearly all required dependencies. If you have not already installed it via another program, you may need to install the [Visual C++ Runtime Redistributable](https://learn.microsoft.com/en-us/cpp/windows/latest-supported-vc-redist?view=msvc-170).
+
+If you suspect you are missing a dependency, try running [DependenciesGui.exe](https://github.com/lucasg/Dependencies/releases) then navigating to the LabRecorder.exe. It's important to launch Dependencies.exe from the same environment that you would use to launch this application: if you launch this application by double-clicking the executable in Windows' finder then do the same on the Dependencies.exe icon; if you launch this application in a Terminal window, then use that same Terminal to launch Dependencies.
+
+### MacOS
+
+In the near future, many LSL Apps (especially LabRecorder) will not ship with their dependencies and will look for the dependencies to be installed on the system. The easiest way to manage the dependencies is by using [homebrew](https://brew.sh/):
+
+* Install homebrew: `/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"`
+* `brew install labstreaminglayer/tap/lsl`
+* `brew install qt`
+
+You can then install LabRecorder directly from homebrew: `brew install labrecorder`
+
+Run it with `open /usr/local/opt/labrecorder/LabRecorder/LabRecorder.app`
+
+### Linux Ubuntu
+
+The Ubuntu releases do not typically ship with their dependencies, so you must download and install those:
+
+* Download, extract, and install the latest [liblsl-{version}-{target}_amd64.deb from its release page](https://github.com/sccn/liblsl/releases)
+    * We hope to make this available via a package manager soon.
+      * Quick ref Ubuntu 24.04: `curl -L https://github.com/sccn/liblsl/releases/download/v1.17.4/liblsl-1.17.4-noble_amd64.deb -o liblsl.deb`
+      * Quick ref Ubuntu 22.04: `curl -L https://github.com/sccn/liblsl/releases/download/v1.17.4/liblsl-1.17.4-jammy_amd64.deb -o liblsl.deb`
+    * You can install liblsl directly by double-clicking on the deb, or with `sudo dpkg -i {filename}.deb` or `sudo apt install {filename}.deb`
+* See the bottom of the [lsl build env docs](https://labstreaminglayer.readthedocs.io/dev/build_env.html).
+    * For most cases, this will amount to installing Qt and its dependencies:
+      * Ubuntu >= 22.04: `sudo apt-get install qt6-base-dev freeglut3-dev`
+
+# Usage
+
+The LabRecorder displays a list of currently present device streams under "Record from Streams". If you have turned on a device after you have already started the recorder, click the "Update" button to update the list (this takes ca. 2 seconds).
+> For testing, you can use a "dummy" device from the `lslexamples` found in the [liblsl release assets](https://github.com/sccn/liblsl/releases) (for example SendData<!--, SendStringMarkers, and SendDataSimple-->).
+
+If you cannot see streams that are provided on another computer, read the section Network Troubleshooting on the NetworkConnectivity page.
+
+You can select which streams you want to record from and which not by checking the checkboxes next to them.
+> ![labrecorder-default.png](doc/labrecorder-default.png)
+
+Note that if you have multiple streams with the same name and host, it is impossible to check only 1. If any is checked then they will all be recorded.
+
+The entry in "Saving to..." shows you the file name (or file name template) where your recording will be stored. You can change this by modifying the Study Root folder (e.g., by clicking the browse button) and the `File Name / Template` field. If the respective directory does not yet exist, it will be created automatically (except if you do not have the permissions to create it). The file name string may contain placeholders that will be replaced by the values in the fields below. Checking the BIDS box will automatically change the filename template to be BIDS compliant. If the file that you are trying to record to already exists, the existing file will be renamed (the string `_oldX` will be appended where X is the lowest number that is not yet occupied by another existing file). This way, it is impossible to accidentally overwrite data.
+
+The Block/Task field can be overwriten or selected among a list of items found in the configuration file.
+
+<!--If the checkbox "Enable scripted actions" is checked, then scripted actions that are defined in your current config file will be automatically invoked when you click Start, Stop, or select a block. This check box is by normally unchecked unless you have custom-tailored a configuration to your experiment or experimentation environment.-->
+
+Click "Start" to start a recording. If everything goes well, the status bar will now display the time since you started the recording, and more importantly, the current file size (the number before the kb) will grow slowly. This is a way to check whether you are still in fact recording data. The recording program cannot be closed while you are recording (as a safety measure).
+
+When you are done recording, click the "Stop" button. You can now close the program. See [the xdf repository](https://github.com/sccn/xdf) for tools and information on how to use the XDF files.
+
+## Preparing a Full Study
+
+When preparing a new study, it is a good idea to make a custom configuration file which at least sets up a custom storage location for the study. See the documentation in the file `LabRecorder.cfg` for how to do this -- it is very easy! <!--The file `sample_config.cfg` contains a somewhat more advanced setup for reference. By default, the file `default_config.cfg` is loaded at startup.--> You can override this by making a shortcut for the LabRecorder program (e.g. on the desktop) and appending in its properties the command-line arguments `-c name_of_you_config.cfg`. You can also create a batch script. You can also load the config while the program is already running, but this can easily be forgotten during an experiment, so we recommend to follow the shortcut route.
+
+In addition to the storage location, if your experiment has multiple blocks (e.g., SubjectTraining, PreBaseline, MainBlock, PostBaseline or the like) you can make the recording process even more straightforward for the experimenters by setting up a default list of block names. Again, take a look at the existing config files.
+
+Since it is too easy to forget to turn on or check all necessary recording devices for a study, we recommend to also make a list of "required" streams (by their name) and put it into the config file. These streams will be pre-checked when starting the program, and any missing stream will be displayed in red. If such a stream is still not green when starting the recording, the experimenter will get a message box to confirm that he/she really wants to record without including the device.
+
+<!--Advanced users might consider automating further steps in the recording process (for example starting the experiment script itself), which can be done by assinging scripted actions in the configuration file. The file `sample_config.cfg` contains pre-defined actions to remote-control the SNAP experimentation environment. In particular, when you click a block, the corresponding SNAP .cfg file will be loaded, and when you click start, the module will be started. Keep in mind, however, that homegrown scripted actions carry the risk of accidentally crashing the recording program, so they need to be carefully tested. One subtle consideration is that the module definitions happen in the context of the main class of the LabRecorder.-->
+
+<!--The following picture shows the the recorder fully configured for a particular study. The BioSemi device is displayed in red because it is not yet turned on. The file naming scheme is customized, and there are four blocks pre-configured with associated scripted actions.
+> ![labrecorder-study.png](labrecorder-study.png)-->
+
+## Remote Control
+
+If you check the box to EnableRCS then LabRecorder exposes some rudimentary controls via TCP socket.
+
+Currently supported commands include:
+
+* `select all`
+* `select none`
+* `start`
+* `stop`
+* `update`
+* `filename ...`
+
+`filename` is followed by a series of space-delimited options enclosed in curly braces. e.g. {root:C:\root_data_dir}
+
+* `root` - Sets the root data directory.
+* `template` - sets the File Name / Template. Will unselect BIDS option. May contain wildcards.
+* `task` - will replace %b in template
+* `run` - will replace %n in template (not working?)
+* `participant` - will replace %p in template
+* `session` - will replace %s in template
+* `acquisition` - will replace %a in template
+* `modality` - will replace %m in template. suggested values: eeg, ieeg, meg, beh
+
+
+For example, in Python:
+
+```python
+import socket
+s = socket.create_connection(("localhost", 22345))
+s.sendall(b"select all\n")
+s.sendall(b"filename {root:C:\\Data\\} {template:exp%n\\%p_block_%b.xdf} {run:2} {participant:P003} {task:MemoryGuided}\n")
+s.sendall(b"start\n")
+```
+
+```Matlab
+lr = tcpip('localhost', 22345); 
+fopen(lr)
+fprintf(lr, 'select all');
+fprintf(lr, ['filename {root:C:\Data\} '...
+            '{task:MemoryGuided} ' ...
+            '{template:s_%p_%n.xdf ' ...
+            '{modality:ieeg}']); 
+fprintf(lr, 'start');
+```
+
+## Misc Features
+
+The LabRecorder has some useful features that can add robustness if things go wrong during the experiment:
+
+If a network connectivity error happens while recording (e.g., a network cable pops out that connects to the source of a data stream), you have usually 6 minutes (think 5) to plug it back it in during which the data will be buffered on the sending machine. If it takes you longer to fix the problem, you will have some gap in your recording.
+
+If a device program or computer crashes while recording, you will for sure lose data, but any device program that transmits an associated device serial number will be picked up automatically by the recorder when it comes back online (these programs are called "recoverable"), without a need to stop and re-start the recording.
+
+You should check the health of your device to be sure, however, for example using an online stream viewer program (see, for example, ViewingStreamsInMatlab). Also, be sure to test whether it is in fact recoverable before relying on this feature (you can test this with a viewer by turning the device app off and back on).
+
+If a device is displayed in red when you start recording (and it is checked), it will be added to the ongoing recording by the time when it comes online. This can be useful when a device can only be turned on while the recording is already in progress. Again, it is advisable to check that the device is in fact discoverable and added. The LabRecorder brings up a console window in the background which shows a list of all streams that are added to the recording -- this is a good place to check whether a late stream did get picked up successfully during a live recording.
+
+# Build Instructions
+
+Please follow the general [LSL App build instructions](https://labstreaminglayer.readthedocs.io/dev/app_build.html).
+
+## Python bindings
+
+LabRecorder includes optional Python bindings for the `recording` class (module name: `labrecorder`).
+Enable them with `-DLABRECORDER_BUILD_PYTHON=ON` and make sure `pybind11` is installed on your system.
+
+### Install pybind11
+
+* macOS (Homebrew): `brew install pybind11`
+* Ubuntu/Debian: `sudo apt-get install pybind11-dev`
+* Windows: use vcpkg (`vcpkg install pybind11`) or a pybind11 CMake package on your PATH
+
+### Configure + build
+
+```bash
+cmake -S . -B build -DLABRECORDER_BUILD_PYTHON=ON
+cmake --build build --target labrecorder
+```
+
+### Usage (with pylsl)
+
+```python
+import sys
+from pylsl import resolve_streams
+
+sys.path.append("build")
+import labrecorder
+
+streams = resolve_streams()
+with labrecorder.Recording("out.xdf", streams):
+    input("Recording... press Enter to stop\n")
+```
+
+### Publish to PyPI
+
+```bash
+uv build
+uv publish
+```

labrecorder-1.0.0rc0.dist-info/METADATA

@@ -0,0 +1,193 @@
+Metadata-Version: 2.2
+Name: labrecorder
+Version: 1.0.0rc0
+Summary: Python bindings for LabRecorder recording
+Author: LabStreamingLayer Developers
+License: MIT
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+
+# Overview
+
+The LabRecorder is the default recording program that comes with LSL. It allows to record all streams on the lab network (or a subset) into a single file, with time synchronization between streams.
+
+# File Format
+
+The file format used by the LabRecorder is XDF. This is an open general-purpose format that was designed concurrently with LSL and supports all features of LSL streams. The project page is [here](https://github.com/sccn/xdf). There are importers for MATLAB, EEGLAB, BCILAB, Python, and MoBILAB.
+
+# Getting LabRecorder
+
+The [releases page](https://github.com/labstreaminglayer/App-LabRecorder/releases) contains archives of past LabRecorder builds. Try downloading and installing an archive that matches your platform. Note for Ubuntu users: The deb will install LabRecorder to `/usr/LabRecorder` though we might change this to `/usr/local/bin/LabRecorder` in the future.
+
+If there are no archives matching your target platform, or the ones available don't run, then continue reading below. If the instructions don't help then please post an issue to the [repo's issues page](https://github.com/labstreaminglayer/App-LabRecorder/issues).
+
+## Dependencies
+
+For LabRecorder to work on your system, you might need to first install some dependencies, specifically liblsl and optionally Qt.
+
+### Windows
+
+The Windows archives ship with nearly all required dependencies. If you have not already installed it via another program, you may need to install the [Visual C++ Runtime Redistributable](https://learn.microsoft.com/en-us/cpp/windows/latest-supported-vc-redist?view=msvc-170).
+
+If you suspect you are missing a dependency, try running [DependenciesGui.exe](https://github.com/lucasg/Dependencies/releases) then navigating to the LabRecorder.exe. It's important to launch Dependencies.exe from the same environment that you would use to launch this application: if you launch this application by double-clicking the executable in Windows' finder then do the same on the Dependencies.exe icon; if you launch this application in a Terminal window, then use that same Terminal to launch Dependencies.
+
+### MacOS
+
+In the near future, many LSL Apps (especially LabRecorder) will not ship with their dependencies and will look for the dependencies to be installed on the system. The easiest way to manage the dependencies is by using [homebrew](https://brew.sh/):
+
+* Install homebrew: `/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"`
+* `brew install labstreaminglayer/tap/lsl`
+* `brew install qt`
+
+You can then install LabRecorder directly from homebrew: `brew install labrecorder`
+
+Run it with `open /usr/local/opt/labrecorder/LabRecorder/LabRecorder.app`
+
+### Linux Ubuntu
+
+The Ubuntu releases do not typically ship with their dependencies, so you must download and install those:
+
+* Download, extract, and install the latest [liblsl-{version}-{target}_amd64.deb from its release page](https://github.com/sccn/liblsl/releases)
+    * We hope to make this available via a package manager soon.
+      * Quick ref Ubuntu 24.04: `curl -L https://github.com/sccn/liblsl/releases/download/v1.17.4/liblsl-1.17.4-noble_amd64.deb -o liblsl.deb`
+      * Quick ref Ubuntu 22.04: `curl -L https://github.com/sccn/liblsl/releases/download/v1.17.4/liblsl-1.17.4-jammy_amd64.deb -o liblsl.deb`
+    * You can install liblsl directly by double-clicking on the deb, or with `sudo dpkg -i {filename}.deb` or `sudo apt install {filename}.deb`
+* See the bottom of the [lsl build env docs](https://labstreaminglayer.readthedocs.io/dev/build_env.html).
+    * For most cases, this will amount to installing Qt and its dependencies:
+      * Ubuntu >= 22.04: `sudo apt-get install qt6-base-dev freeglut3-dev`
+
+# Usage
+
+The LabRecorder displays a list of currently present device streams under "Record from Streams". If you have turned on a device after you have already started the recorder, click the "Update" button to update the list (this takes ca. 2 seconds).
+> For testing, you can use a "dummy" device from the `lslexamples` found in the [liblsl release assets](https://github.com/sccn/liblsl/releases) (for example SendData<!--, SendStringMarkers, and SendDataSimple-->).
+
+If you cannot see streams that are provided on another computer, read the section Network Troubleshooting on the NetworkConnectivity page.
+
+You can select which streams you want to record from and which not by checking the checkboxes next to them.
+> ![labrecorder-default.png](doc/labrecorder-default.png)
+
+Note that if you have multiple streams with the same name and host, it is impossible to check only 1. If any is checked then they will all be recorded.
+
+The entry in "Saving to..." shows you the file name (or file name template) where your recording will be stored. You can change this by modifying the Study Root folder (e.g., by clicking the browse button) and the `File Name / Template` field. If the respective directory does not yet exist, it will be created automatically (except if you do not have the permissions to create it). The file name string may contain placeholders that will be replaced by the values in the fields below. Checking the BIDS box will automatically change the filename template to be BIDS compliant. If the file that you are trying to record to already exists, the existing file will be renamed (the string `_oldX` will be appended where X is the lowest number that is not yet occupied by another existing file). This way, it is impossible to accidentally overwrite data.
+
+The Block/Task field can be overwriten or selected among a list of items found in the configuration file.
+
+<!--If the checkbox "Enable scripted actions" is checked, then scripted actions that are defined in your current config file will be automatically invoked when you click Start, Stop, or select a block. This check box is by normally unchecked unless you have custom-tailored a configuration to your experiment or experimentation environment.-->
+
+Click "Start" to start a recording. If everything goes well, the status bar will now display the time since you started the recording, and more importantly, the current file size (the number before the kb) will grow slowly. This is a way to check whether you are still in fact recording data. The recording program cannot be closed while you are recording (as a safety measure).
+
+When you are done recording, click the "Stop" button. You can now close the program. See [the xdf repository](https://github.com/sccn/xdf) for tools and information on how to use the XDF files.
+
+## Preparing a Full Study
+
+When preparing a new study, it is a good idea to make a custom configuration file which at least sets up a custom storage location for the study. See the documentation in the file `LabRecorder.cfg` for how to do this -- it is very easy! <!--The file `sample_config.cfg` contains a somewhat more advanced setup for reference. By default, the file `default_config.cfg` is loaded at startup.--> You can override this by making a shortcut for the LabRecorder program (e.g. on the desktop) and appending in its properties the command-line arguments `-c name_of_you_config.cfg`. You can also create a batch script. You can also load the config while the program is already running, but this can easily be forgotten during an experiment, so we recommend to follow the shortcut route.
+
+In addition to the storage location, if your experiment has multiple blocks (e.g., SubjectTraining, PreBaseline, MainBlock, PostBaseline or the like) you can make the recording process even more straightforward for the experimenters by setting up a default list of block names. Again, take a look at the existing config files.
+
+Since it is too easy to forget to turn on or check all necessary recording devices for a study, we recommend to also make a list of "required" streams (by their name) and put it into the config file. These streams will be pre-checked when starting the program, and any missing stream will be displayed in red. If such a stream is still not green when starting the recording, the experimenter will get a message box to confirm that he/she really wants to record without including the device.
+
+<!--Advanced users might consider automating further steps in the recording process (for example starting the experiment script itself), which can be done by assinging scripted actions in the configuration file. The file `sample_config.cfg` contains pre-defined actions to remote-control the SNAP experimentation environment. In particular, when you click a block, the corresponding SNAP .cfg file will be loaded, and when you click start, the module will be started. Keep in mind, however, that homegrown scripted actions carry the risk of accidentally crashing the recording program, so they need to be carefully tested. One subtle consideration is that the module definitions happen in the context of the main class of the LabRecorder.-->
+
+<!--The following picture shows the the recorder fully configured for a particular study. The BioSemi device is displayed in red because it is not yet turned on. The file naming scheme is customized, and there are four blocks pre-configured with associated scripted actions.
+> ![labrecorder-study.png](labrecorder-study.png)-->
+
+## Remote Control
+
+If you check the box to EnableRCS then LabRecorder exposes some rudimentary controls via TCP socket.
+
+Currently supported commands include:
+
+* `select all`
+* `select none`
+* `start`
+* `stop`
+* `update`
+* `filename ...`
+
+`filename` is followed by a series of space-delimited options enclosed in curly braces. e.g. {root:C:\root_data_dir}
+
+* `root` - Sets the root data directory.
+* `template` - sets the File Name / Template. Will unselect BIDS option. May contain wildcards.
+* `task` - will replace %b in template
+* `run` - will replace %n in template (not working?)
+* `participant` - will replace %p in template
+* `session` - will replace %s in template
+* `acquisition` - will replace %a in template
+* `modality` - will replace %m in template. suggested values: eeg, ieeg, meg, beh
+
+
+For example, in Python:
+
+```python
+import socket
+s = socket.create_connection(("localhost", 22345))
+s.sendall(b"select all\n")
+s.sendall(b"filename {root:C:\\Data\\} {template:exp%n\\%p_block_%b.xdf} {run:2} {participant:P003} {task:MemoryGuided}\n")
+s.sendall(b"start\n")
+```
+
+```Matlab
+lr = tcpip('localhost', 22345); 
+fopen(lr)
+fprintf(lr, 'select all');
+fprintf(lr, ['filename {root:C:\Data\} '...
+            '{task:MemoryGuided} ' ...
+            '{template:s_%p_%n.xdf ' ...
+            '{modality:ieeg}']); 
+fprintf(lr, 'start');
+```
+
+## Misc Features
+
+The LabRecorder has some useful features that can add robustness if things go wrong during the experiment:
+
+If a network connectivity error happens while recording (e.g., a network cable pops out that connects to the source of a data stream), you have usually 6 minutes (think 5) to plug it back it in during which the data will be buffered on the sending machine. If it takes you longer to fix the problem, you will have some gap in your recording.
+
+If a device program or computer crashes while recording, you will for sure lose data, but any device program that transmits an associated device serial number will be picked up automatically by the recorder when it comes back online (these programs are called "recoverable"), without a need to stop and re-start the recording.
+
+You should check the health of your device to be sure, however, for example using an online stream viewer program (see, for example, ViewingStreamsInMatlab). Also, be sure to test whether it is in fact recoverable before relying on this feature (you can test this with a viewer by turning the device app off and back on).
+
+If a device is displayed in red when you start recording (and it is checked), it will be added to the ongoing recording by the time when it comes online. This can be useful when a device can only be turned on while the recording is already in progress. Again, it is advisable to check that the device is in fact discoverable and added. The LabRecorder brings up a console window in the background which shows a list of all streams that are added to the recording -- this is a good place to check whether a late stream did get picked up successfully during a live recording.
+
+# Build Instructions
+
+Please follow the general [LSL App build instructions](https://labstreaminglayer.readthedocs.io/dev/app_build.html).
+
+## Python bindings
+
+LabRecorder includes optional Python bindings for the `recording` class (module name: `labrecorder`).
+Enable them with `-DLABRECORDER_BUILD_PYTHON=ON` and make sure `pybind11` is installed on your system.
+
+### Install pybind11
+
+* macOS (Homebrew): `brew install pybind11`
+* Ubuntu/Debian: `sudo apt-get install pybind11-dev`
+* Windows: use vcpkg (`vcpkg install pybind11`) or a pybind11 CMake package on your PATH
+
+### Configure + build
+
+```bash
+cmake -S . -B build -DLABRECORDER_BUILD_PYTHON=ON
+cmake --build build --target labrecorder
+```
+
+### Usage (with pylsl)
+
+```python
+import sys
+from pylsl import resolve_streams
+
+sys.path.append("build")
+import labrecorder
+
+streams = resolve_streams()
+with labrecorder.Recording("out.xdf", streams):
+    input("Recording... press Enter to stop\n")
+```
+
+### Publish to PyPI
+
+```bash
+uv build
+uv publish
+```

labrecorder-1.0.0rc0.dist-info/RECORD

@@ -0,0 +1,11 @@
+LabRecorder.cfg,sha256=Tev-IBoSpDvvjCoqTa-ZH-QbRL9beqUygKwSk3TF84k,4144
+labrecorder.cp312-win_amd64.pyd,sha256=GCT3k7GXT2Wxxj8RqOP8iwlh_MHh19TkXmw5XxUR6ig,274944
+LabRecorderCLI.exe,sha256=4KwWo6fkE-Ectq2uDOseAnXzl-XFi2QEAI1VIn3jNJY,117248
+LICENSE,sha256=ump1McoxhpxPSQlEhVIyPxLDx00e04r_aDE7lTbVkdw,1093
+lsl.dll,sha256=GogCu2igOyUiD9EzL2UNZ5Cq4MxRA-1YfzU173_-0vA,577024
+README.md,sha256=w-1OQiC03y08t4Bk878n9wJu64lNLm7pfJKPi3wEB0k,13493
+xdfwriter.lib,sha256=-fUN9W3wfkyS_XygN8EC7ZYufa1ztt3eeaaCjZ5Ncc4,238714
+labrecorder-1.0.0rc0.dist-info/METADATA,sha256=C3PQ8FNrPs3_Czf1FyD8NmHA0WlrwRXHguxRgsjSKI0,13532
+labrecorder-1.0.0rc0.dist-info/WHEEL,sha256=chqeLhPBtPdrOoreR34YMcofSk3yWDQhkrsDJ2n48LU,106
+labrecorder-1.0.0rc0.dist-info/licenses/LICENSE,sha256=ump1McoxhpxPSQlEhVIyPxLDx00e04r_aDE7lTbVkdw,1093
+labrecorder-1.0.0rc0.dist-info/RECORD,,

labrecorder-1.0.0rc0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: scikit-build-core 0.11.6
+Root-Is-Purelib: false
+Tag: cp312-cp312-win_amd64
+

labrecorder-1.0.0rc0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2012 Christian Kothe
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.