OSC2MQTT/README.md
2024-12-03 00:49:14 +01:00

29 lines
970 B
Markdown

# OSC2MQTT
This OSC2MQTT translates any OSC message on a server to MQTT.
The server will listen to ALL OSC messages coming in at a specified port, and forwards these to an MQTT address.
If the OSC address is /synthesizer/volume, it will be forwarded to the MQTADDRESS of OSC/synthesizer/volume, so make sure to subscribe to OSC.
Be aware, It's OSC2MQTT, not MQTT2OSC!
I would like to create MIDI2MQTT
### Running
1. Create a secrets.py with the following
```
mqtt_username = "yourusername"
mqtt_password = "yourpass"
```
2. Need to create a virtual environment for python? `python -m venv venv` & activate using `source venv/bin/activate`
3. Install the needed packages using `pip install -r requirements.txt`
4. Set your OSC & MQTT information in app.py
5. Run `python app.py`
### Testing
I've included a small pure data script that can trigger some OSC messages, for testing purposes. Of course, you are more then welcome to use any OSC software you'd like!