Skip to content

antoinercbs/tesla-synth-web-player

Repository files navigation

Tesla Coil Synterrupter Web Player

This project is a MIDI player web app specifically designed for operating musical Tesla Coils running on the wonderful MMMZZZ's Syntherrupter, a polyphonic/multi-coils interrupter.

This project was initialy developped for the high voltage team of the Clubelek (the electronics student club of INSA Lyon, a french engineering school) and its 3 Tesla coils.

It aims to provide a simple but yet complete interface to define a Syntherrupter configuration for each song (MIDI channels mapping, on times & duty-cycles configuration...) and playing these songs on the Syntherrupter.

The goal was to avoid using complex MIDI editors for registering the SYSEX commands, to have a centralized platform for our MIDIs/configs and to be able to operate our coils fastly during shows.

tesla player interface

Features

The main features of this tool are:

  • A web MIDI player able to play MIDI on 1 or 2 of the computer MIDI outputs
  • A MIDI channel filtering option to map channels to each of the 2 outputs (for using another synth in parrallel of the Tesla coils)
  • A playlist editor
  • A MIDI file uploader/manager
  • The integration of a modded version of Signal, a powerful online MIDI editor to edit and test the MIDI directly into your navigator
  • A song editor/creator (a "song" is an association of configuration commands and of a MIDI file)
  • A Syntherrupter SYSEX command creator (implementing MMMZZZZ's Syfoh under the hood) to create syntherrupter configs and add them to songs

Documentation

We are currently working on it :)

See the Syfoh and Syntherrupter documentation in order to understand the Syntherrupter SYSEX (system exclusive) MIDI commands. (Links in the Credits section)

Song example configuration

tesla player song config example

In this example, we have a setup of 3 Tesla coils, the coil 0 and 1 are playing the channel 1 (2 = 0000 0000 000 0010) and the coil 2 is playing the channel 0 (1 = 0000 0000 000 0001) of the provided MIDI file.

The Tesla coils are respectively running with maximum on-times of 40/30µs and duty-cycles of 3%/2.1%.

All the 16 channels are allowed on both outputs.

Installation and launch

Standalone app (recommanded if intended to use on a standalone computer/easiest to use

Just download and unzip the last release (matching your OS) and just run the TeslaPlayer.exe (or equivalent) :)

Python script (recommanded for local network run or best performances)

In order to run the app, use a local release from this repository, unzip it and enter the follwing terminal commands in the resulting folder. (You must have Python3 and PIP installed)

The first time:

mkdir uploads
pip3 install -r requirements.txt
python3 init_db.py
python3 app.py

Any other time:

python3 app.py

The web server is now running on localhost:5000 and the songs/configuration are saved in this this folder.

You can now connect to http://localhost:5000 with your web navigator ! (IMPORTANT: Firefox, Safari and Internet Explorer are not implementing the WebMIDI API and the web app will therefore not work on these navigators)

Dockerized install (recommanded for web hosting)

In order to deploy to your server (in order to have an hosted/shared instance), we strongly advice you to use a docker-compose release. The provided Dockerfile recompile the frontend code to match the URL that you provide in the docker-compose.yml config file.

You just have to download and unzip a docker-compose release and enter:

docker-compose up

You can now connect to http://localhost:5000 with your web navigator !

You only have to modify this docker-compose config file (and to rebuild the if you change the config after the first launch) to match your server configuration (reverse proxy, DNS, etc).

Important note: This dockerization is still under progress. All features are working properly except one: saving a MIDI to the server from the Signal MIDI Track editor.

Authentication (advices)

In order to perform authentication, we strongly advice you to use this web app docker image. We advice you to use a Docker proxy such as Traefik's native basicauth feature or Keycloak Gatekeeper (if you are using a Keycloak SSO)

Internationalization

This tool is currently available in the following languages:

  • English
  • French

If you want to contribute, feel free to reach us ! It requires no programming skills ;)

Contributing

This project is fully open source, feel free to modify it! Any contribution (using Github pull requests) are obviously welcome.

We well also be glad to ear your features requests and comments using Github issues.

Credits

MMMZZZ's Syntherrupter

MMMZZZZ's Syfoh

Ryohey's Signal MIDI editor

Ryoyakawai's smfplayer

About

A web MIDI player specifically designed for the MMMZZZZ's Syntherrupter (Tesla Coil controller)

Resources

License

Stars

Watchers

Forks

Packages

No packages published