Copyrights, initial deb packaging.

This commit is contained in:
Robin Davies
2021-08-23 19:17:38 -04:00
parent 1bb68548ba
commit 849001de46
188 changed files with 4028 additions and 560 deletions
+74 -5
View File
@@ -1,14 +1,84 @@
# PiPedal
PiPedal is a multi-effect guitar pedal that provides a compact web interface that's suitable for use on devices like phones and tablets.
PiPedal is a multi-effect guitar pedal that provides a clean compact web interface that's suitable for use on small-format devices
like phones and tablets, although it works gloriously with desktop browers as well.
PiPedal uses LV2 audio plugins. There are currently a wide variety of sources for excellent LV2 guitar plugins. You can add as many
plugins to your patch as your CPU will support (well over a dozen on a Raspberry Pi 4+). Audio signal chains
can have an arbitrary number of split chains, which maybe A/B-selected or mixed if you wish.
If you have a USB Midi Controller, you can bind Midi controls and notes to LV2 plugin controls using the Midi Bindings dialog.
This particularly useful if you have a USB Midi footccontroller or a small USB Midi controller such as the Korg Nano or AKAI \
midi controllers.
## Configuring PiPedal After Installation
After PiPedal is installed, you can connect to the web interface as follows: via the mDNS address "http://pipedal.local" (on Windows, Mac, or iPhone web
browsers), at http://127.0.0.1 if you are interactively logged into your Raspberry Pi device, or at port 80 of the current network address of your
Raspberry Pi, if you are connected from an Android device (which does not currently support mDNS).
To complete the initial configuration, you must either connect an Ethernet cable to your Raspberry pi so you can connect to the Web App (after which you should be able to connect to http://pipedal.local); or you must launch a web browser on your Raspberry pi device while logged in interactively.
Once connected, you can activate a WiFi hotspot on your Rasberry Pi which can be used to connect to PiPedal while it is not connected to an Ethernet network.
IMPORTANT NOTE: Activating the WiFi hotspot will DISABLE outbound Wi-Fi connections from the Raspberry Pi.
You will be able to access the PiPedal web interface through the hotspot connection, and make ssh and VNC
connections to the Raspberry Pi through the hotspot connection; but your Raspberry Pi will not have outbound access
to the Internet.
If you need access to the internet once the hotspot has been enabled, connect an Ethernet cable to
the Raspberry Pi.
Settings to configure the WiFi hotspot are available in the hamburger menu/Settings dialog.
There are a number of other useful settings in the hamburger menu/Settings dialog. For example, most USB audio devices route instrument
input onto the right channel of the USB audio inputs. So you probably want to configure PiPedal to use only the right USB audio input channel.
You can choose how to bind USB audio input and output channels (stereo, left only, right only) in the settings dialog.
## Command Line Configuration of PiPedal
The pipedalconfig program can be used to modify configuration of PiPedal from a shell command line. Run 'pipedalconfig --help' to view
available configuration commands, some of which are not avaialbe from the web interface. (For example, you can change the port number
of the Web App HTTP server if you need to, uusing pipedalconfig).
### Configuration
## LV2 PLugin Support
PiPedal uses standard LV2 audio plugins for effects. There are currently a wide variety of available LV2 guitar effect plugins, foremost of
which is the Guitarix plugin collection: https://guitarix.org/
But there are hundreds of other high-quality LV2 plugins that are suitable for use with PiPedal.
- Zam Plugins. http://www.zamaudio.com/
- Calf Plugins. http://calf-studio-gear.org/
Or visit https://lv2plug.in/pages/projects.html for a more complete list.
There is also a set of supplementary Gx effect plugins which did not make it into the main Guitarix distribution. You
have to build these plugins yourself, but the effort is well worthwhile.
- https://github.com/brummer10/GxPlugins.lv2
PiPedal will automatically detect installed LV2 plugins and make them selectable from the web app interface, as long as they meet the
following conditions:
- Must have mono or stereo audio inputs and outputs.
- Must not have MIDI or CV inputs.
- Must be remotely controllable (no hard dependency on GUI-only controls), which is true of the vast majority of LV2 plugins.
Most LV2 plugins have GUI interfaces, which are not used by PiPedal; but the LV2 plugin standard allows almost all LV2 plugins to
be controlled via PiPedal's web interface.
### Building and Installing PiPedal
PiPedal has only been tested on Raspbian. But we will gladly accept pull requests to correct problems with other versions of Linux.
To build PiPedal, a Raspberry Pi 4B, with at least 4GB of memory is recommended, although it's entirely possible that you may be
able to cross-compile using a Windows-hosted instance of VS Code.
To build PiPedal, a Raspberry Pi 4B, with at least 4GB of memory is recommended. You should be able to cross-compile PiPedal easily enough,
but we do not currently provide support for this. Consult CMake documentation on how to cross-compile source.
Run the following commands to install dependent components required by the PiPedal build.
@@ -21,7 +91,6 @@ of `node.js` installed already. Otherwise run the following commands as root to
curl -fsSL https://deb.nodesource.com/setup_lts.x | bash -
apt-get install -y nodejs
### Building PiPedal
PiPedal was developed using Visual Studio Code. If you open the PiPedal project as a folder in VS Code, Code will