The operating system currently supported for pi-Stomp is PatchboxOS created by Blokas Labs and based on Rpi OS Lite. On top of that, you need to install the pi-stomp specific software/firmware.
PatchboxOS will either present an adhoc hotspot or it will try to connect to a router, not both. It initially will present the hotspot (named Patchbox). We'll use this so we can connect then configure wifi networking for connecting to your router which we'll need for downloading software.
172.24.1.1instead of patchbox.local
Now you should have a command prompt.
sudo systemctl mask --now pisound-btn.service
Then execute the following and substitute your router ID (name), country code and router password. (If any of the fields includes non-alphanumic characters, you may need to surround the field with double quotes)
patchbox wifi connect --name SSID --country CC --password PASSWORD
This will restart wifi on the pi (switching from hotspot to router). Your current session will end.
If your pi-Stomp connected to your home router successfully, you likely won't need to know the actual IP address and you can use
patchbox.local for the following steps. If you cannot ssh using
patchbox.local, then come back here and try some of these discovery methods. Fing, Ping or AngryIP are recommended.
If you are not able to discover the IP, it's possible that your pi is not within range of your router, you have restrictive security settings (eg. whitelisted devices), or your patchbox wifi config info is incorrect. To try again, power cycle the pi-stomp, then repeat steps #2 through #6 above.
Once you know the IP, start a new SSH session:
ssh patch@YOUR-IP-ADDRESS (password:
IP Address from above, Login:
Once connected, run the following commands to download, setup and install the software and audio plugins. It could take about a half hour.
git clone -b v2.0.2-patchboxOS-based https://github.com/TreeFallSound/pi-stomp.git cd pi-stomp
If your system will eventually include a serial MIDI add-on, run setup with the '-m' option to enable the ttymidi service
Otherwise, just run setup
If all went well, now you can reboot
Once the system comes back on line, you should see the LCD display “pi-Stomp!”. If all the services start correctly, it'll eventually display the initial pedalboard and audio should then pass. If this is not the case, check out the Troubleshooting Guide
For optimal processing, you want the input signal to be strong enough, but not to the point of clipping. Distortion and dynamics plugins will perform less ideally if the signal is weak, and clipping just sounds like crap. When first installed, the gain is set to unity, meaning no extra gain or reduction. This might be fine for most instruments, but if your guitar has extra hot or low-output pickups, you'll want to change the gain. Here's how:
You should be able to use your pi-Stomp indefinitely without updates, but should you decide you require bug-fixes, new features or new starter pedalboards, the following should get you there.
In order to pull from the internet, updates can only be done when the pi-Stomp is in “router” wifi mode, not “hotspot” mode.
To switch modes:
Updates can currently only be done via ssh:
The pi-Stomp software changes frequently and you are generally encouraged to pull new updates.
Once connected via ssh, run:
cd pi-stomp git pull sudo systemctl restart jack
If your pi-Stomp display goes blank after this, it's possible that a recently added python library needs installing
sudo pip3 install pyalsaaudio
If that doesn't help run the following to see log output from the mod-ala-pi-stomp service
Patchbox is the base operating system created by blokas.io. It doesn't change often and unless there is a specific problem, updates are generally not necessary or recommended.
When necessary, once connected via ssh, run:
To improve the out-of-box experience we will be adding starter pedalboards occasionally. These aren't meant to be spot-on, but get you in the ballpark so you can start tweaking your own tone.
To update, once connected via ssh, run:
cd /var/modep/pedalboards sudo -u modep git pull sudo systemctl restart jack
You can use git as revision control for your pedalboards. Because the pedalboard directory is owned by a user named “modep”, you'll need to preface all git commands with
sudo -u modep
A commit workflow might look something like:
cd /var/modep/pedalboards sudo -u modep git add MY_PEDALBOARD sudo -u modep git commit -m "adding MY_PEDALBOARD"
If you have a great pedalboard that you'd like to contribute with the community, please do. Just keep in mind that many other users will have it installed on their pi-Stomps so please follow a few guideslines:
Additions and changes to the public repo should be done on your own branch. To create and work in that branch:
cd /var/modep/pedalboards sudo -u modep git branch MY_BRANCH sudo -u modep git checkout MY_BRANCH
Where MY_BRANCH is the name of your new personal branch
For committing, you'll need to tell git who you are:
sudo -u modep git config user.name "MY NAME" sudo -u modep git config user.email MY_EMAIL
Once your pedalboard is complete (saved via the MOD web UI), commit your changes to your local repository. Please make sure you add just the specific pedalboard that you intend to share.
cd /var/modep/pedalboards sudo -u modep git add MY_PEDALBOARD.pedalboard sudo -u modep git commit -m "adding MY_PEDALBOARD"
You'll need to generate a github personal access token if you don't already have one.
Now specify the remote github repository using that token
sudo -u modep git remote remove origin sudo -u modep git remote add origin https://TOKEN@github.com/TreeFallSound/pi-stomp-pedalboards
Now you can push your commit(s) to your branch on github
sudo -u modep git push origin MY_BRANCH
The new pedalboard will now be on github in your branch. To have it merged to the master branch, create a Pull Request. Once tested and accepted, it'll be merged to the master branch.