Metadata-Version: 2.4
Name: pysio-hermes-cometa
Version: 0.0.3
Summary: A Cometa sEMG support module for HERMES
Author: e-Media Research Lab @ KU Leuven
Author-email: Maxim Yudayev <maxim.yudayev@gmail.com>
License-Expression: MIT
Project-URL: Homepage, https://maximyudayev.github.io/hermes
Project-URL: Documentation, https://maximyudayev.github.io/hermes
Project-URL: Repository, https://github.com/maximyudayev/hermes-cometa.git
Project-URL: Issues, https://github.com/maximyudayev/hermes/issues
Project-URL: Changelog, https://github.com/maximyudayev/hermes-cometa/blob/main/CHANGELOG.md
Keywords: embedded ai,wearables,sensors,emg,cometa,streaming,realtime processing,physiology
Platform: win32
Platform: win-amd64
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: Microsoft :: Windows
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.7
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: pysio-hermes
Requires-Dist: pysio-pyemg-cometa
Dynamic: license-file

# HERMES - Cometa WavePlus sEMG

Support package to interface the [Cometa WavePlus](https://www.cometasystems.com/waveplus/) commercial Mini Wave or Pico sEMG sensors in [HERMES](https://github.com/maximyudayev/hermes) via the [OEM C# shared libraries](https://www.cometasystems.com/sdk-and-integrations/).

> [!NOTE]
> Cometa WavePlus is a system of up to 16 wearable sEMG sensors, and a receiver base station connected to a Windows PC, with a practical range of ~20 meters. Lost packets are filled by the base station with repeated most recently received values. Ensure the person stays in range or the base station is moved around for this device.

> [!NOTE]
> While [it says](https://www.cometasystems.com/sdk-and-integrations/) that Cometa has a Python integration, it's a community driven package. You can access a work-in-progress Python binding, [pyemg-cometa](https://github.com/maximyudayev/pyemg-cometa), to the C# OEM DLLs that powers this package and is suitable for out-of-the-box realtime streaming acquisition. The same binding and OEM DLLs are packaged within submodules of this project for convenience and will become an external dependency later.

## Installation
The package interfaces identically the Mini Wave and the Pico sensors, whichever are on and connected to the Cometa WavePlus base station, under the same namespace `hermes.cometa` package, as `CometaProducer`.

Install WavePlus drivers (`EmgMDrivers` and `EmgMUsbDrivers`) for Windows after registering on the [Cometa website](https://www.cometasystems.com/my-account/).

> [!NOTE]
> The latest distributed sEMG drivers marked for Windows 8.1 are compatible with Windows 10/11 and have been validated. The distributed USB drivers marked for Windows 10 are also compatible Windows 11.

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

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

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

Verify in EMG Motion Tools Windows desktop application that sensors are attached, impedance is checked, and the qulity of the signal is good. Close the application.

> [!IMPORTANT]
> Only 1 connection to the base station can be done at a time, either EMG Motion Tools app, or HERMES. Else the device won't connect.

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