SerialToOSC-Bridge

Simple Python application to transform Serial data into OSC messages.

The current purpose is to be a compatibility layer between hardware trackers providing serial data and software applications expecting OSC messages. The tracking data can be utilized to incorporate the instantaneous head orientation and position in applications for binaural synthesis. See the usage examples section for currently supported hardware and software configurations.

Requirements

• Conda installation (miniconda is sufficient)
• Python installation (tested with 3.7 to 3.9; recommended way to get Python is to use Conda as described in the setup section)
• Installation of the required Python packages (see environment for the full list, recommended way is to use Conda as described in the setup section)

Setup

• Clone repository with command line or any other git client:
  git clone https://github.com/AppliedAcousticsChalmers/SerialToOSC-Bridge.git
• Navigate into the repository (the directory containing setup.py):
  cd SerialToOSC-Bridge/
• Install required Python packages i.e., Conda is recommended:
  • Make sure that Conda is up to date:
    conda update conda
  • Create new Conda environment from the specified requirements (--force to overwrite potentially existing outdated environment):
    conda env create --file environment.yml --force
  • Activate created Conda environment:
    conda activate SerialToOSC-Bridge

Usage Examples

• Review the available command line arguments:
  python SerialToOSC-Bridge.py --help
• to be continued ...
  python SerialToOSC-Bridge.py ...

Credits

Written by Hannes Helmholz.

License

This software is licensed under a Non-Commercial Software License (see LICENSE for full details).

Copyright (c) 2021
Division of Applied Acoustics
Chalmers University of Technology