Metadata-Version: 2.4
Name: pysio-hermes-vicon
Version: 0.2.0
Summary: A Vicon Data Streaming support module for HERMES
Author-email: Maxim Yudayev <maxim.yudayev@gmail.com>, "e-Media Research Lab @ KU Leuven" <emedia@kuleuven.be>
License-Expression: MIT
Project-URL: Homepage, https://yudayev.com/hermes
Project-URL: Documentation, https://yudayev.com/hermes
Project-URL: Repository, https://github.com/maximyudayev/hermes-vicon.git
Project-URL: Issues, https://github.com/maximyudayev/hermes/issues
Project-URL: Changelog, https://github.com/maximyudayev/hermes-vicon/blob/main/CHANGELOG.md
Keywords: embedded ai,wearables,sensors,vicon,streaming,realtime processing,physiology
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Healthcare Industry
Classifier: Intended Audience :: Education
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Classifier: Topic :: Scientific/Engineering :: Medical Science Apps.
Classifier: Topic :: System :: Distributed Computing
Requires-Python: <3.14,>=3.7
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: pysio-hermes>=0.4.0
Dynamic: license-file

# HERMES - Vicon

Support package to interface the realtime [Vicon](https://www.vicon.com/) commercial sensing system data in [HERMES](https://github.com/maximyudayev/hermes), through the [DataStream SDK](https://www.vicon.com/software/datastream-sdk/).

## Installation
Node available under the same HERMES namespace of `hermes.vicon` as `ViconProducer`. Download and unarchive the official [DataStream SDK](https://www.vicon.com/software/datastream-sdk/). Install it into the Python environment with or according to the [official instructions](https://help.vicon.com/space/DSSDK112/10027198/Vicon+DataStream+SDK+Quick+Start+Guide+for+Python):
```bash
pip install <path_to_downloaded_[vicon_dssdk]_folder>
```
> ![IMPORTANT]
> Vicon Datastream SDK 1.11, 1.12, 1.13 have been tested. Only Python >= 3.7, < 3.14 are supported at the moment.

### From PyPI
```bash
pip install pysio-hermes-vicon
```

### From source
```bash
git clone https://github.com/maximyudayev/hermes-vicon.git
pip install -e hermes-vicon
```

## Usage
Using the device follows the standard [configuration file specification](https://yudayev.com/hermes) process of HERMES nodes.

Turn on Vicon Nexus desktop application to configure all capturing devices and their names. Fill in those sensor mappings exactly the same way in your HERMES YAML file.

> [!IMPORTANT]
> Ensure the names in Nexus correspond exactly to the mapping in the HERMES config YAML file, [example](https://github.com/maximyudayev/hermes-vicon/blob/main/examples/vicon.yml#L57-L78).

> [!IMPORTANT]
> Currently, `vicon.yml` config file and the `ViconStream` datastructure are only configured for 16-channels analog sEMG signals. Update the stream class manually to capture all other desired data.

## Citation
When using any parts of this repository outside of its intended use, please cite the parent project [HERMES](https://github.com/maximyudayev/hermes).
