TherapSID

This is the Atmega1284 firmware for the TherapSID synthesizer.

Find the official releases at the official product page or the github release page.

Building and flashing the source code:

Install platformio and python2. (Yes. I am so sorry :(.)

To compile the firmware and to generate the firmware update sysex, run:

make firmware.syx

Then put the device into bootloader mode by holding down the "filter" button while turning it on, and send the sysex. Note that you need to wait about 200msec between each sysex.

Unit tests

Parts of the code can be tested on your development machine. We use the Catch2 unit testing framework. To run the tests that live in the test/ folder, just type:

make test

Note that the tests also serve as a kind of documentation, as the section names usually give a good hint of what the class is supposed to do.

Contributing

If you want to fix a bug, add a feature or contribute in any other way to the development of this firmware, we are glad to accept a pull request in this repository! Please make sure your contribution adheres to the following:

• Please update CHANGELOG.md to contain a brief description of your changes.
• Ensure you do not break loading of old patches.
• Format your code using make fmt before submitting.
• Run the unit tests using make test before submitting.

Thank you, we are looking forward to your contribution! :)

License

The TherapSID firmware under src/ and include/ is free software. It is released under the terms of the ISC License. The libraries and tools distributed in the 3rdparty/ and lib/ directories have their own copyright and license notes.