Skip to content

Getting Started

Jump to bottom
David Berry edited this page Oct 27, 2024 · 9 revisions

MicroController

The first part you will need for this project is a microcontroller. The microcontroller is the core of your Device and will determine how accurately you can generate pitch and the number of instruments you can support per device. Some microcontrollers can also support additional features such as Save Configurations, Addressable LEDs, and Wireless Connection. *Note that currently only ESP32s are supported but more microcontrollers will be coming soon.

Add-ons

  • LocalStorage allows a device to save its current configuration on loss of power.
  • Addressable LEDs allow for LED strips to illuminate active instruments.
  • Wireless allows a wifi connection to be used to control a group of devices.

ESP32

  • 16 Usable pins and medium clock rate
  • Addressable LEDs, LocalStorage, Wireless

(Binaries)

Software (*NOTE* For Developers. Use at own risk. Subject to change at any time. Please wait for an official release ~Winter 2024)

1. Download VScode and Install the Platform IO extension.

2. Download ESP32_Client_V1.0 from this Repo and open it in VS code.

3. In VS code click the Home Icon to open platform IO, Select Boards, Search for your Dev Kit, and open the link.

image

4. On the open webpage scroll down to configuration and copy the text, Paste this in the platformio.ini file at the root of the project making sure to replace or comment out the existing microcontroller configuration.

image image

5. In src/Configs/ Create a new Configuration file or modify an existing one. Leave ADDRESSABLE_LEDS disabled. Make sure to change your MAX_NUM_INSTRUMENTS and pins making sure the number of pins matches the number of pins listed in the array.

image

6. In src/Device.h #include your config file.

image

7. Plug in your microcontroller and select the upload button. *Note if this step fails you might need to install a driver for your platform. Verify your device shows as a Serial Port connection in Device Manager. Refer to the manufacturer for more details.

image

8. After Uploading simply open the GUI.

9. In the GUI click Add Device and select your device's serial port.

image

10. Once your Device is connected select it and add a Distributor. The Distributor evenly distributes notes across a pool of instruments. Connected Midi devices should automatically show under MIDI IN when the page loads. Download Loop Midi if you want to play music from a DAW such as Ableton or Studio One. You can also upload midi files to be played in the browser. (The seek bar is a bit glitchy but otherwise functional).

image

If you encounter any issues create an Issue on GitHub. Note This is an in-development project so expect changes, quarks, and bugs.

Clone this wiki locally