pysio-hermes 0.1.0__tar.gz

pysio_hermes-0.1.0/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Maxim Yudayev [https://yudayev.com] and KU Leuven eMedia Lab.
+
+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.

pysio_hermes-0.1.0/PKG-INFO

@@ -0,0 +1,178 @@
+Metadata-Version: 2.4
+Name: pysio-hermes
+Version: 0.1.0
+Summary: A realtime physiological sensing and edge AI processing framework
+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.git
+Project-URL: Issues, https://github.com/maximyudayev/hermes/issues
+Project-URL: Changelog, https://github.com/maximyudayev/hermes/blob/main/CHANGELOG.md
+Keywords: embedded ai,wearables,sensors,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.7
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: pyzmq
+Requires-Dist: msgpack
+Requires-Dist: ffmpeg-python
+Requires-Dist: h5py
+Requires-Dist: numpy
+Requires-Dist: pandas
+Requires-Dist: pyyaml
+Requires-Dist: pyusb
+Requires-Dist: pyserial
+Requires-Dist: pyperclip
+Requires-Dist: openpyxl
+Requires-Dist: orjson
+Provides-Extra: build
+Requires-Dist: build; extra == "build"
+Requires-Dist: twine; extra == "build"
+Provides-Extra: docs
+Requires-Dist: mkdocs-material; extra == "docs"
+Requires-Dist: mkdocstrings-python; extra == "docs"
+Dynamic: license-file
+
+<h1 align="center">
+  <img src="https://raw.githubusercontent.com/maximyudayev/hermes/refs/heads/main/images/logo.png" alt="HERMES: Heterogeneous Edge Realtime Measurement and Execution System" width="60%">
+
+  <br>
+  Heterogeneous Edge Realtime Measurement and Execution System
+</h1>
+
+<h4 align="center">A Unified Open-Source Framework for Realtime Multimodal Physiological Sensing, Edge AI, and Intervention in Closed-Loop Smart Healthcare Applications
+</h4>
+
+<div align="center">
+
+  ![Windows](https://img.shields.io/badge/Windows-0078D6?style=for-the-badge&logo=windows&logoColor=white)
+  ![Linux](https://img.shields.io/badge/Linux-FCC624?style=for-the-badge&logo=linux&logoColor=black)
+  ![macOS](https://img.shields.io/badge/mac%20os-000000?style=for-the-badge&logo=macos&logoColor=F0F0F0)
+
+</div>
+
+<p align="center">
+  <a href="#installation">Quickstart</a> •
+  <a href="https://maximyudayev.github.io/hermes">Docs</a> •
+  <a href="#data-annotation">GUI</a> •
+  <a href="#showcase">Showcase</a> •
+  <a href="#citation">Cite</a> •
+  <a href="#contact">Contact</a>
+</p>
+
+HERMES for the Greek mythology analogy of the god of communication and speed, protector of information, the gods' herald. He embodies the nature of smooth and reliable communication. His role accurately resonates with the vision of this framework: facilitate reliable and fast exchange of continuously generated multimodal physiological and external data across distributed wireless and wired multi-sensor hosts for synchronized realtime data collection, in-the-loop AI stream processing, and analysis, in intelligent med- and health-tech (wearable) applications.
+
+<div align="center"><img src="https://raw.githubusercontent.com/maximyudayev/hermes/refs/heads/main/images/overview.png" alt="Overview of the system architecture on one of the distributed hosts" width="80%"></div>
+<br>
+
+HERMES offers out-of-the-box streaming integrations to a number of commercial sensor devices and systems, high resolution cameras, templates for extension with custom user devices, and a ready-made wrapper for easy PyTorch AI model insertion. It reliably and synchronously captures heterogeneous data across distributed interconnected devices on a local network in a continuous manner, and enables realtime AI processing at the edge toward personalized intelligent closed-loop interventions of the user. All continuously acquired data is periodically flushed to disk for as long as the system has disk space, as MKV/MP4 and HDF5 files, for video and sensor data, respectively.
+
+# Quickstart
+## Core
+Create a Python 3 virtual environment `python -m venv .venv` (python >= 3.7).
+
+Activate it with `.venv/bin/activate` for Linux or `.venv\Scripts\activate` for Windows.
+
+Single-command install HERMES into your project along other dependendices. 
+```bash
+pip install pysio-hermes
+```
+
+## Extra
+All the integrated, validated and supported sensor devices are separately installable as `pysio-hermes-<subpackage_name>`, like:
+```bash
+pip install pysio-hermes-torch
+```
+Will install the AI processing subpackage to wrap user-specified PyTorch models.
+
+<details>
+  <summary>List of supported devices <i>(continuously updated)</i></summary>
+Some subpackages require OEM software installation, check each below for detailed prerequisites.
+
+- `torch` [Wrapper for PyTorch AI models](https://github.com/maximyudayev/hermes-torch)
+- `pupillabs` [Pupil Labs Core smartglasses](https://github.com/maximyudayev/hermes-pupillabs)
+- `basler` [Basler cameras](https://github.com/maximyudayev/hermes-basler)
+- `dots` [Movella DOTs IMUs](https://github.com/maximyudayev/hermes-dots)
+- `mvn` [Xsens MVN Analyze MoCap suit](https://github.com/maximyudayev/hermes-mvn)
+- `awinda` [Xsens Awinda IMUs](https://github.com/maximyudayev/hermes-awinda)
+- `cometa` [Cometa WavePlus sEMG](https://github.com/maximyudayev/hermes-cometa)
+- `moticon` [Moticon OpenGo pressure insoles](https://github.com/maximyudayev/hermes-moticon)
+- `tmsi` [TMSi SAGA physiological signals](https://github.com/maximyudayev/hermes-tmsi)
+- `vicon` [Vicon Nexus capture system](https://github.com/maximyudayev/hermes-vicon)
+- `moxy` [Moxy muscle oxygenation monitor](https://github.com/maximyudayev/hermes-moxy)
+
+The following subpackages are in development.
+- `gui` [Live monitoring dashboard](https://github.com/maximyudayev/hermes-gui)
+- `mic` [PC-attached generic microphone](https://github.com/maximyudayev/hermes-mic)
+
+</details>
+<br>
+
+# Documentation
+Check out the [full documentation site](https://maximyudayev.github.io/hermes) for more usage examples, architecture overview, detailed extension guide, and FAQs.
+
+# Data Annotation
+<div align="center"><img src="https://raw.githubusercontent.com/maximyudayev/hermes/refs/heads/main/images/gui.png" alt="Pysioviz: A dashboard for visualization and annotation of collected multimodal data for AI workflows" width="80%"></div>
+<br>
+
+We developed [PysioViz](https://github.com/maximyudayev/pysioviz) a complementary dashboard based on [Dash Plotly](https://dash.plotly.com/) for analysis and annotation of the collected multimodal data. We use it ourselves to generate ground truth labels for the AI training workflows. Check it out and leave feedback!
+
+# Showcase
+These are some of our own projects enabled by HERMES to excite you to adopt it in your smart closed-looop healthtech usecases.
+
+<details>
+  <summary>AI-enabled intent prediction for high-level locomotion mode selection in a smart leg prosthesis</summary>
+</details>
+<br>
+
+<details>
+  <summary>Realtime automated cueing for freezing-of-gait Parkinson's patients in free-living conditions</summary>
+</details>
+<br>
+
+<details>
+  <summary>Personalized level of assistance in prolong use rehabilitation and support exoskeletons</summary>
+</details>
+<br>
+
+# License
+This project is licensed under the MIT license - see the [LICENSE](/LICENSE) file for details.
+
+# Citation
+When using in your project, research, or product, please cite the following and notify us so we can update the index of success stories enabled by HERMES.
+
+<!-- <a href="https://arxiv.org/abs/..." style="display:inline-block;">
+  <img src="http://img.shields.io/badge/paper-arxiv.x-B31B1B.svg" height="20" >
+</a>
+```bibtex
+@inproceedings{yudayev2025hermes,
+  title={HERMES: A Unified Open-Source Framework for Realtime Multimodal Physiological Sensing, Edge AI, and Intervention in Closed-Loop Smart Healthcare Applications},
+  author={Yudayev, Maxim and Carlon, Juha and Lamsal, Diwas and Vanrumste, Bart, and Filtjens, Benjamin},
+  booktitle={},
+  year={2025}
+}
+``` -->
+
+# Acknowledgement
+This project was primarily written by Maxim Yudayev while at the Department of Electrical Engineering, KU Leuven.
+
+This study was funded, in part, by the AidWear project funded by the Federal Public Service for Policy and Support, 
+the AID-FOG project by the Michael J. Fox Foundation for Parkinson’s Research under Grant No.: MJFF-024628, 
+and the Flemish Government under the Flanders AI Research Program (FAIR).
+
+HERMES is a "Ship of Theseus"[[1](https://en.wikipedia.org/wiki/Ship_of_Theseus)] of [ActionSense](https://github.com/delpreto/ActionNet) that started as a fork and became a complete architectural rewrite of the system from the ground up to bridge the fundamental gaps in the state-of-the-art, and to match our research group's needs in realtime deployments and reliable data acquisition.
+Although there is no part of ActionSense in HERMES, we believe that its authors deserve recognition as inspiration for our system.
+
+Special thanks for contributions, usage, bug reports, good times, and feature requests to Juha Carlon (KU Leuven), Stefano Nuzzo (VUB), Diwas Lamsal (KU Leuven), Vayalet Stefanova (KU Leuven), Léonore Foguenne (ULiège).

pysio_hermes-0.1.0/README.md

@@ -0,0 +1,131 @@
+<h1 align="center">
+  <img src="https://raw.githubusercontent.com/maximyudayev/hermes/refs/heads/main/images/logo.png" alt="HERMES: Heterogeneous Edge Realtime Measurement and Execution System" width="60%">
+
+  <br>
+  Heterogeneous Edge Realtime Measurement and Execution System
+</h1>
+
+<h4 align="center">A Unified Open-Source Framework for Realtime Multimodal Physiological Sensing, Edge AI, and Intervention in Closed-Loop Smart Healthcare Applications
+</h4>
+
+<div align="center">
+
+  ![Windows](https://img.shields.io/badge/Windows-0078D6?style=for-the-badge&logo=windows&logoColor=white)
+  ![Linux](https://img.shields.io/badge/Linux-FCC624?style=for-the-badge&logo=linux&logoColor=black)
+  ![macOS](https://img.shields.io/badge/mac%20os-000000?style=for-the-badge&logo=macos&logoColor=F0F0F0)
+
+</div>
+
+<p align="center">
+  <a href="#installation">Quickstart</a> •
+  <a href="https://maximyudayev.github.io/hermes">Docs</a> •
+  <a href="#data-annotation">GUI</a> •
+  <a href="#showcase">Showcase</a> •
+  <a href="#citation">Cite</a> •
+  <a href="#contact">Contact</a>
+</p>
+
+HERMES for the Greek mythology analogy of the god of communication and speed, protector of information, the gods' herald. He embodies the nature of smooth and reliable communication. His role accurately resonates with the vision of this framework: facilitate reliable and fast exchange of continuously generated multimodal physiological and external data across distributed wireless and wired multi-sensor hosts for synchronized realtime data collection, in-the-loop AI stream processing, and analysis, in intelligent med- and health-tech (wearable) applications.
+
+<div align="center"><img src="https://raw.githubusercontent.com/maximyudayev/hermes/refs/heads/main/images/overview.png" alt="Overview of the system architecture on one of the distributed hosts" width="80%"></div>
+<br>
+
+HERMES offers out-of-the-box streaming integrations to a number of commercial sensor devices and systems, high resolution cameras, templates for extension with custom user devices, and a ready-made wrapper for easy PyTorch AI model insertion. It reliably and synchronously captures heterogeneous data across distributed interconnected devices on a local network in a continuous manner, and enables realtime AI processing at the edge toward personalized intelligent closed-loop interventions of the user. All continuously acquired data is periodically flushed to disk for as long as the system has disk space, as MKV/MP4 and HDF5 files, for video and sensor data, respectively.
+
+# Quickstart
+## Core
+Create a Python 3 virtual environment `python -m venv .venv` (python >= 3.7).
+
+Activate it with `.venv/bin/activate` for Linux or `.venv\Scripts\activate` for Windows.
+
+Single-command install HERMES into your project along other dependendices. 
+```bash
+pip install pysio-hermes
+```
+
+## Extra
+All the integrated, validated and supported sensor devices are separately installable as `pysio-hermes-<subpackage_name>`, like:
+```bash
+pip install pysio-hermes-torch
+```
+Will install the AI processing subpackage to wrap user-specified PyTorch models.
+
+<details>
+  <summary>List of supported devices <i>(continuously updated)</i></summary>
+Some subpackages require OEM software installation, check each below for detailed prerequisites.
+
+- `torch` [Wrapper for PyTorch AI models](https://github.com/maximyudayev/hermes-torch)
+- `pupillabs` [Pupil Labs Core smartglasses](https://github.com/maximyudayev/hermes-pupillabs)
+- `basler` [Basler cameras](https://github.com/maximyudayev/hermes-basler)
+- `dots` [Movella DOTs IMUs](https://github.com/maximyudayev/hermes-dots)
+- `mvn` [Xsens MVN Analyze MoCap suit](https://github.com/maximyudayev/hermes-mvn)
+- `awinda` [Xsens Awinda IMUs](https://github.com/maximyudayev/hermes-awinda)
+- `cometa` [Cometa WavePlus sEMG](https://github.com/maximyudayev/hermes-cometa)
+- `moticon` [Moticon OpenGo pressure insoles](https://github.com/maximyudayev/hermes-moticon)
+- `tmsi` [TMSi SAGA physiological signals](https://github.com/maximyudayev/hermes-tmsi)
+- `vicon` [Vicon Nexus capture system](https://github.com/maximyudayev/hermes-vicon)
+- `moxy` [Moxy muscle oxygenation monitor](https://github.com/maximyudayev/hermes-moxy)
+
+The following subpackages are in development.
+- `gui` [Live monitoring dashboard](https://github.com/maximyudayev/hermes-gui)
+- `mic` [PC-attached generic microphone](https://github.com/maximyudayev/hermes-mic)
+
+</details>
+<br>
+
+# Documentation
+Check out the [full documentation site](https://maximyudayev.github.io/hermes) for more usage examples, architecture overview, detailed extension guide, and FAQs.
+
+# Data Annotation
+<div align="center"><img src="https://raw.githubusercontent.com/maximyudayev/hermes/refs/heads/main/images/gui.png" alt="Pysioviz: A dashboard for visualization and annotation of collected multimodal data for AI workflows" width="80%"></div>
+<br>
+
+We developed [PysioViz](https://github.com/maximyudayev/pysioviz) a complementary dashboard based on [Dash Plotly](https://dash.plotly.com/) for analysis and annotation of the collected multimodal data. We use it ourselves to generate ground truth labels for the AI training workflows. Check it out and leave feedback!
+
+# Showcase
+These are some of our own projects enabled by HERMES to excite you to adopt it in your smart closed-looop healthtech usecases.
+
+<details>
+  <summary>AI-enabled intent prediction for high-level locomotion mode selection in a smart leg prosthesis</summary>
+</details>
+<br>
+
+<details>
+  <summary>Realtime automated cueing for freezing-of-gait Parkinson's patients in free-living conditions</summary>
+</details>
+<br>
+
+<details>
+  <summary>Personalized level of assistance in prolong use rehabilitation and support exoskeletons</summary>
+</details>
+<br>
+
+# License
+This project is licensed under the MIT license - see the [LICENSE](/LICENSE) file for details.
+
+# Citation
+When using in your project, research, or product, please cite the following and notify us so we can update the index of success stories enabled by HERMES.
+
+<!-- <a href="https://arxiv.org/abs/..." style="display:inline-block;">
+  <img src="http://img.shields.io/badge/paper-arxiv.x-B31B1B.svg" height="20" >
+</a>
+```bibtex
+@inproceedings{yudayev2025hermes,
+  title={HERMES: A Unified Open-Source Framework for Realtime Multimodal Physiological Sensing, Edge AI, and Intervention in Closed-Loop Smart Healthcare Applications},
+  author={Yudayev, Maxim and Carlon, Juha and Lamsal, Diwas and Vanrumste, Bart, and Filtjens, Benjamin},
+  booktitle={},
+  year={2025}
+}
+``` -->
+
+# Acknowledgement
+This project was primarily written by Maxim Yudayev while at the Department of Electrical Engineering, KU Leuven.
+
+This study was funded, in part, by the AidWear project funded by the Federal Public Service for Policy and Support, 
+the AID-FOG project by the Michael J. Fox Foundation for Parkinson’s Research under Grant No.: MJFF-024628, 
+and the Flemish Government under the Flanders AI Research Program (FAIR).
+
+HERMES is a "Ship of Theseus"[[1](https://en.wikipedia.org/wiki/Ship_of_Theseus)] of [ActionSense](https://github.com/delpreto/ActionNet) that started as a fork and became a complete architectural rewrite of the system from the ground up to bridge the fundamental gaps in the state-of-the-art, and to match our research group's needs in realtime deployments and reliable data acquisition.
+Although there is no part of ActionSense in HERMES, we believe that its authors deserve recognition as inspiration for our system.
+
+Special thanks for contributions, usage, bug reports, good times, and feature requests to Juha Carlon (KU Leuven), Stefano Nuzzo (VUB), Diwas Lamsal (KU Leuven), Vayalet Stefanova (KU Leuven), Léonore Foguenne (ULiège).

pysio_hermes-0.1.0/examples/main.py

@@ -0,0 +1,223 @@
+############
+#
+# Copyright (c) 2024 Maxim Yudayev and KU Leuven eMedia Lab
+#
+# 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.
+#
+# Created 2024-2025 for the KU Leuven AidWear, AidFOG, and RevalExo projects
+# by Maxim Yudayev [https://yudayev.com].
+#
+# ############
+
+import threading
+import os
+import yaml
+import argparse
+import sys
+
+
+sys.path.append("./src")
+
+from hermes.base.nodes import Node
+from hermes.base.broker import Broker
+from hermes.utils.mp_utils import launch_callable
+from hermes.utils.node_utils import search_node_class
+from hermes.utils.time_utils import *
+from hermes.utils.zmq_utils import *
+from hermes.utils.argparse_utils import *
+
+
+__version = 'v0.1.0'
+
+HERMES = r"""
+______  ________________________  ___________________
+___  / / /__  ____/__  __ \__   |/  /__  ____/_  ___/
+__  /_/ /__  __/  __  /_/ /_  /|_/ /__  __/  _____ \ 
+_  __  / _  /___  _  _, _/_  /  / / _  /___  ____/ / 
+/_/ /_/  /_____/  /_/ |_| /_/  /_/  /_____/  /____/  
+                                                     
+"""
+
+if __name__ == '__main__':
+  parser = argparse.ArgumentParser(prog='HERMES',
+                                   description='Heterogeneous edge realtime measurement and execution system '
+                                               'for continual multimodal data acquisition and processing.',
+                                   epilog='Copyright (c) 2024 Maxim Yudayev and KU Leuven eMedia Lab.\n'
+                                          'Created 2024-2025 at KU Leuven for the AidWear, AID-FOG, and RevalExo '
+                                          'projects of prof. Bart Vanrumste, by Maxim Yudayev [https://yudayev.com].',
+                                  formatter_class=argparse.RawTextHelpFormatter)
+  parser.add_argument('--verbose', '-v',
+                      action='count',
+                      default=0,
+                      help='increase level of logging verbosity [0,3]')
+  parser.add_argument('--version',
+                      action='version',
+                      version='%(prog)s ' + __version)
+
+  parser.add_argument('--experiment',
+                      nargs='*',
+                      action=ParseExperimentKwargs,
+                      help='key-value pair tags detailing the experiment, used for '
+                           'directory creation and metadata on files')
+  parser.add_argument('--time', '-t',
+                      type=float,
+                      dest='log_time_s',
+                      default=get_time(),
+                      help='master start time of the system')
+  parser.add_argument('--duration', '-d',
+                      type=int,
+                      dest='duration_s',
+                      default=None,
+                      help='duration in seconds, if using for recording only (to be used only by master)')
+  parser.add_argument('--config_file',
+                      type=validate_path,
+                      default=None,
+                      help='path to the configuration file for the current host device, '
+                           'instead of the CLI arguments')
+
+  # parser.add_argument('--host_ip',
+  #                     type=validate_ip,
+  #                     help='LAN IPv4 address of the host device')
+  # parser.add_argument('--is_master',
+  #                     dest='is_master_broker',
+  #                     action='store_true',
+  #                     help='flag to set host as Master Broker that others connect to')
+  # parser.add_argument('--subscriber_ips',
+  #                     nargs='*',
+  #                     dest='remote_subscriber_ips',
+  #                     type=validate_ip,
+  #                     default=list(),
+  #                     help='list of IPv4 devices listening to data of the host')
+  # parser.add_argument('--publisher_ips',
+  #                     nargs='*',
+  #                     dest='remote_publisher_ips',
+  #                     type=validate_ip,
+  #                     default=list(),
+  #                     help='list of IPv4 devices to listen to for their data')
+  # parser.add_argument('--kill',
+  #                     dest='is_remote_kill',
+  #                     action='store_true',
+  #                     help='flag to set host to listen to remote KILLSIG (only for slave devices)')
+  # parser.add_argument('--kill_ip',
+  #                     dest='remote_kill_ip',
+  #                     type=validate_ip,
+  #                     help='LAN IPv4 address of device delegating KILLSIG (only for slave devices)')
+
+
+  # parser.add_argument('--logging_spec',
+  #                     nargs='*',
+  #                     action=ParseLoggingKwargs,
+  #                     help='key-value pair tags configuring logging modules of each Node')
+
+  # parser.add_argument('--producer_specs',
+  #                     nargs='*',
+  #                     action=ParseNodeKwargs,
+  #                     default=list(),
+  #                     help='key-value pair tags detailing local producer Nodes of the host')
+  # parser.add_argument('--consumer_specs',
+  #                     nargs='*',
+  #                     action=ParseNodeKwargs,
+  #                     default=list(),
+  #                     help='key-value pair tags detailing local consumer Nodes of the host')
+  # parser.add_argument('--pipeline_specs',
+  #                     nargs='*',
+  #                     action=ParseNodeKwargs,
+  #                     default=list(),
+  #                     help='key-value pair tags detailing local pipeline Nodes of the host')
+
+
+  # Parse launch arguments.
+  args = parser.parse_args()
+
+  # Override CLI arguments with a config file.
+  if args.config_file is not None:
+    with open(args.config_file, "r") as f:
+      try:
+        config: dict = yaml.safe_load(f)
+        parser.set_defaults(**config)
+      except yaml.YAMLError as e:
+        print(e)
+        exit('Error parsing CLI inputs.')
+    args = parser.parse_args()
+
+  # Load video codec spec.
+  if 'stream_video' in args.logging_spec and args.logging_spec['stream_video']:
+    with open(args.logging_spec['video_codec_config_filepath'], "r") as f:
+      try:
+        args.logging_spec['video_codec'] = yaml.safe_load(f)
+      except yaml.YAMLError as e:
+        print(e)
+
+  # Initialize folders and other chore data, and share programmatically across Node specs.
+  script_dir: str = os.path.dirname(os.path.realpath(__file__))
+  (log_time_str, log_time_s) = get_time_str(time_s=args.log_time_s, return_time_s=True)
+  log_dir: str = os.path.join(script_dir,
+                              'data',
+                              *map(lambda tup: '_'.join(tup), args.experiment.items()))
+  # Initialize a file for writing the log history of all printouts/messages.
+  log_history_filepath: str = os.path.join(log_dir, '%s.log'%args.host_ip)
+
+  try:
+    os.makedirs(log_dir)
+  except OSError:
+    exit("'%s' already exists. Update experiment YML file with correct data for this subject."%log_dir)
+
+  args.logging_spec['log_dir'] = log_dir
+  args.logging_spec['experiment'] = args.experiment
+  args.logging_spec['log_time_s'] = log_time_s
+
+  node_specs: list[dict] = args.producer_specs + args.consumer_specs + args.pipeline_specs
+  for spec in node_specs:
+    spec['settings']['logging_spec'] = args.logging_spec
+    spec['settings']['log_history_filepath'] = log_history_filepath
+    spec['settings']['host_ip'] = args.host_ip
+    spec['settings']['port_pub'] = PORT_BACKEND
+    spec['settings']['port_sub'] = PORT_FRONTEND
+    spec['settings']['port_sync'] = PORT_SYNC_HOST
+    spec['settings']['port_killsig'] = PORT_KILL
+
+  # Create the broker and manage all the components of the experiment.
+  local_broker: Broker = Broker(host_ip=args.host_ip,
+                                node_specs=node_specs,
+                                is_master_broker=args.is_master_broker)
+
+  # Connect broker to remote publishers at the wearable PC to get data from the wearable sensors.
+  for ip in args.remote_publisher_ips:
+    local_broker.connect_to_remote_broker(addr=ip)
+
+  # Expose local wearable data to remote subscribers (e.g. lab PC in AidFOG project).
+  if args.remote_subscriber_ips:
+    local_broker.expose_to_remote_broker(args.remote_subscriber_ips)
+  
+  # Subscribe to the KILL signal of a remote machine.
+  if args.is_remote_kill:
+    local_broker.subscribe_to_killsig(addr=args.remote_kill_ip)
+
+  # Only the master broker can terminate the experiment via the terminal command.
+  if args.is_master_broker:
+    is_quit = False
+    # Run broker's main until user exits in GUI or 'q' in terminal.
+    t = threading.Thread(target=launch_callable, args=(local_broker, args.duration_s))
+    t.start()
+    while not is_quit:
+      is_quit = input("Enter 'q' to exit: ") == 'q'
+    local_broker.set_is_quit()
+    t.join()
+  else:
+    local_broker()

pysio_hermes-0.1.0/pyproject.toml

@@ -0,0 +1,64 @@
+[build-system]
+requires = ["setuptools"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "pysio-hermes"
+version = "0.1.0"
+requires-python = ">=3.7"
+authors = [
+  { name="Maxim Yudayev", email="maxim.yudayev@gmail.com" },
+  { name="e-Media Research Lab @ KU Leuven" },
+]
+description = "A realtime physiological sensing and edge AI processing framework"
+keywords = ["embedded ai", "wearables", "sensors", "streaming", "realtime processing", "physiology"]
+readme = { file = "README.md", content-type = "text/markdown" }
+license = "MIT"
+license-files = ["LICEN[CS]E*", "AUTHORS.md"]
+classifiers = [
+  "Programming Language :: Python :: 3",
+  "Operating System :: OS Independent",
+  "Development Status :: 4 - Beta",
+  "Intended Audience :: Healthcare Industry",
+  "Intended Audience :: Education",
+  "Intended Audience :: Developers",
+  "Intended Audience :: Science/Research",
+  "Topic :: Scientific/Engineering",
+  "Topic :: Scientific/Engineering :: Artificial Intelligence",
+  "Topic :: Scientific/Engineering :: Medical Science Apps.",
+  "Topic :: System :: Distributed Computing"
+]
+dependencies = [
+  "pyzmq",
+  "msgpack",
+  "ffmpeg-python",
+  "h5py",
+  "numpy",
+  "pandas",
+  "pyyaml",
+  "pyusb",
+  "pyserial",
+  "pyperclip",
+  "openpyxl",
+  "orjson",
+]
+
+[project.optional-dependencies]
+build = [
+  "build",
+  "twine"
+]
+docs = [
+  "mkdocs-material",
+  "mkdocstrings-python"
+]
+
+[tool.setuptools.packages.find]
+exclude = ["docs*", ".vscode*", ".venv*", "images*"]
+
+[project.urls]
+Homepage = "https://maximyudayev.github.io/hermes"
+Documentation = "https://maximyudayev.github.io/hermes"
+Repository = "https://github.com/maximyudayev/hermes.git"
+Issues = "https://github.com/maximyudayev/hermes/issues"
+Changelog = "https://github.com/maximyudayev/hermes/blob/main/CHANGELOG.md"