Documentation updates for PiPedal 2.0.
This commit is contained in:
Robin E.R. Davies
Vendored
+4
-1
@@ -171,7 +171,7 @@
|
||||
"cSpell.ignoreWords": [
|
||||
"nammodel"
|
||||
],
|
||||
"cSpell.enabled": false,
|
||||
"cSpell.enabled": true,
|
||||
|
||||
// Disable all automatic completion suggestions - only show when Ctrl+Space is pressed
|
||||
"editor.quickSuggestions": {
|
||||
@@ -191,5 +191,8 @@
|
||||
|
||||
// Disable parameter hints popup (optional)
|
||||
"editor.parameterHints.enabled": false,
|
||||
"cSpell.enabledFileTypes": {
|
||||
"markdown": true
|
||||
},
|
||||
|
||||
}
|
||||
+4
-3
@@ -18,8 +18,9 @@ layout: default
|
||||
</style>
|
||||
|
||||
<div class="container">
|
||||
<h1>404</h1>
|
||||
<h2>404 Page not found</h2>
|
||||
|
||||
<p><strong>Page not found :(</strong></p>
|
||||
<p>The requested page could not be found.</p>
|
||||
<p style="padding-top: 96px;border-radius: 4px; font-family: serif; font-style: italic; font-size: 1.0em;color:#0008">
|
||||
You step in the stream, but the water has moved on.
|
||||
</p>
|
||||
</div>
|
||||
|
||||
@@ -0,0 +1,53 @@
|
||||
<div style="position: relative">
|
||||
<img src="img/pipedal.png" style="width: 100%; height: 160px;object-fit: cover"/>
|
||||
</div>
|
||||
|
||||
<h2 style="font-weight: 300; font-size: 1.6em;line-height: 1em; padding-top: 32px; padding-bottom: 0px;margin-bottom: 4px">PiPedal 2.0 Guitar Effects Processor</h2>
|
||||
<p style="padding-top: 0px; opacity: 0.6; padding-bottom: 16px">A Raspberry Pi-based stomp box designed to be controlled from a phone or tablet.</p>
|
||||
|
||||
<span style="display: none">
|
||||
<a href="https://rerdavies.github.io/pipedal/ReleaseNotes"><img src="https://img.shields.io/github/v/release/rerdavies/pipedal?color=%23808080"/></a>
|
||||
</span>
|
||||
<a href="https://rerdavies.github.io/pipedal/download2"><img src="https://img.shields.io/badge/Download-008060" /></a>
|
||||
<a href="https://rerdavies.github.io/pipedal/Documentation"><img src="https://img.shields.io/badge/Documentation-0060d0"/></a>
|
||||
|
||||
_To download PiPedal v2.0.102-alpha, click [*here*](download.md).
|
||||
To view PiPedal documentation, click [*here*](Documentation.md)._
|
||||
|
||||
Use your Raspberry Pi as a guitar effects pedal. Configure and control PiPedal with your phone or tablet.
|
||||
PiPedal running on a Raspberry Pi 4 or Pi 5 provides stable super-low-latency audio via external USB audio devices, or internal Raspberry Pi audio hats.
|
||||
|
||||
PiPedal will also run on Ubuntu 22.x (amd64/x64 and aarch64). Make sure you follow the [Ubuntu post-install
|
||||
instructions](https://rerdavies.github.io/pipedal/Configuring.html) to make sure your Ubuntu OS is using a realtime-capable kernel.
|
||||
|
||||
PiPedal 2.0 adds support for Neural Amp Modeler A2 models—the next generation of the ground-breaking Neural Amp Modeler technology. NAM A2 models provide even more accurate and realistic amp emulation than the original NAM A1 modelling technology, with while requiring less CPU. "Slimmable" A2 models allow users to select the level of CPU use vs. emulation accuracy that best suits their needs Slim down models for lower CPU use; or use full models for the best possible emulation quality.
|
||||
|
||||
NAM A2 models are available as free downloads from Tone3000.com. PiPedal 2.0 now integrates with Tone3000.com services in order to allow you to easily download NAM A2 models and Cabinet Impulse Response Files directly into Pipedal right from within the PiPedal app. All existing NAM models on Tone3000.com have been retrained using the new A2 architecture, and are available as A2 models right now. There is also a rich ecosystem of professionally developed NAM models available for purchase on the Internet.
|
||||
|
||||
Whether you are looking for free models, or premium models, NAM A2 provides the best amp modelling available anywhere.
|
||||
|
||||
PiPedal 2.0 provides a new Channel Routing dialog, which replaces the Channel Selection Dialog in Pipedal 1.x. You can now globally (for all existing presets) route auxiliary input channels on your audio device (such as backing tracks or microphone inputs), or route clean unprocessed guitar input signals to otherwise-unused output audio channels for later re-amping later in a DAW.
|
||||
|
||||
|
||||
{% include gallery.html %}
|
||||
|
||||
PiPedal includes state-of-the-art AI-based guitar amp emulation plugins based on the famous Neural Amp Modeler (NAM) and ML libraries which provide amp modelling that will blow your mind.
|
||||
|
||||
{% include demo.html %}
|
||||
|
||||
PiPedal can be remotely controlled via a web interface over Ethernet, or Wi-Fi. If you don't have access to a Wi-Fi router, PiPedal can be configured to
|
||||
start a Wi-Fi hotspot automatically, whenever your Raspberry Pi can't connect to your home network.
|
||||
|
||||
Install the [PiPedal Remote Android app](https://play.google.com/store/apps/details?id=com.twoplay.pipedal) to get one-click access to PiPedal via Wi-Fi networks, or Wi-Fi hotspots. If you are using PiPedal away from home, you can configure PiPedal to automatically start a Wi-Fi hotspot on your Raspberry Pi
|
||||
whenever Pipedal is unable to detect your home network. The PiPedal Client Android app will allow to connect by simply launching the app, whether you are at home, or using a Wi-Fi auto-hotspot at a gig, when away from home.
|
||||
|
||||
PiPedal's user interface has been specifically designed to work well on small form-factor touch devices like phones or tablets. Clip a phone or tablet on your microphone stand on stage, and you're ready to play! Or connect via a desktop browser, for a slightly more luxurious experience. The PiPedal user-interface adapts to the screen size and orientation of your device, providing easy control of your guitar effects across a broad variety devices and screen sizes.
|
||||
|
||||
PiPedal includes a pre-installed selection of LV2 plugins from the ToobAmp collection of plugins; but it works with most LV2 Audio plugins. There are literally hundreds of free high-quality LV2 audio plugins that will work with PiPedal. Just install them on your Raspberry Pi, and they will show up in PiPedal.
|
||||
|
||||
If your USB audio adapter has MIDI connectors, you can use MIDI devices (keyboards, controllers, or midi floor boards) to control PiPedal while performing. A simple interface allows you to select how you would like to bind PiPedal controls to midi messages.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -5,15 +5,50 @@ page_icon: img/Requirements2.jpg
|
||||
|
||||
{% include pageIcon.html %}
|
||||
|
||||
* A Raspberry PI 5, PI 4B or PI 400, with at least 2GB of RAM to run (4GB recommended). PiPedal will run on a PI 3, but you will not be able to use some plugins due to excessive CPU use.
|
||||
* To build PiPedal, at least 8GB of RAM is required.
|
||||
* An external USB Audio Adapter, or a Pi audio hat with at least one audio input, and one audio output.
|
||||
### Processor and Memory Requirements
|
||||
|
||||
* An ARM64 or x86-64 CPU. Any of the following provide excellent performance.
|
||||
* Raspberry Pi 5, Pi 500, Pi 500+ (or equivalent ARM64 single-board computer). Recommended.
|
||||
* Intel N100-class NUCs or mini computers. Also recommended.
|
||||
* Most AMD/Intel laptop or desktop CPUs.
|
||||
* PiPedal will also run well on a Raspberry Pi 4.
|
||||
* A Raspberry Pi 3 (or equivalent SBC) can run PiPedal, but may struggle to keep up. Not recommended.
|
||||
* At least 2GB of RAM (4GB recommended).
|
||||
* To compile PiPedal from source, at least 8GB of RAM is required.
|
||||
|
||||
### Audio System Requirements:
|
||||
* On Raspberry Pi's, you will need an external USB Audio Adapter, or a Pi audio hat with at least one audio input. You cannot use the built-in audio inputs and outputs.
|
||||
* On x86-64 systems, any standard audio interface with at least one input and one output will work; but an external USB audio interfaces is highly recommended.
|
||||
|
||||
### Operating System Support
|
||||
|
||||
PiPedal has been tested on the following Operating Systems:
|
||||
|
||||
* Raspberry Pi OS 64-bit Bookworm
|
||||
* Raspberry Pi OS 64-bit Bookworm, or Trixie.
|
||||
* Ubuntu 24.x or later, 64-bit (amd64/x86-64 and aarch64). Make sure you follow the [Ubuntu post-install instructions](https://rerdavies.github.io/pipedal/Configuring.html) to ensure your Ubuntu OS is using a realtime kernel. Pipedal will also run on Ubuntu Server 24.x or later.
|
||||
|
||||
Older versions of PiPedal (v1.1.31) have been tested on the following operating systems, but are no longer supported:
|
||||
|
||||
PiPedal may also run on other Debian 12 or Debian 13-based Linux distributions, but these have not been tested, and we can provide only limited support for these distributions, since we are not able to locally test every possible Linux distribution.
|
||||
|
||||
You may be able to compile Pipedal from sources on non-Debian Linux distributions, but working out compiler and library dependencies on non-Debian-based Linux distributions may be difficult, and is not officially supported. If you do manage to compile PiPedal on a non-Debian-based Linux distribution, please let us know how you did it, and we will publish instructions for others that follow in your footsteps.
|
||||
|
||||
A Linux kernel version of 5.15 or later is required, since support for USB audio adapters is poor in prior kernel versions. A Linux kernel version of 6.15 or later is recommended.
|
||||
|
||||
PiPedal requires a realtime-capable Linux kernel (a PREEMPT_RT kernel). Current versions of Ubuntu can be configured to enable PREEMPT_RT at runtime. (See the [Ubuntu post-install instructions](https://rerdavies.github.io/pipedal/Configuring.html) for details). Raspberry Pi OS 64-bit Bookworm and Trixie include a PREEMPT_RT kernel by default, so no additional configuration is required to enable PREEMPT_RT on these OS versions.
|
||||
|
||||
### Headless Operation
|
||||
|
||||
PiPedal provides best performance and audio latency when controlled from a remote browser, since GPU activity can interfere with real-time audio processing. The PiPedal server does not require a graphical desktop, so headless installs are fully supported (and more-or-less recommended). You can completely install and configure PiPedal using Linux commandline alone; however, you may find it easier to set up, configure and maintain your PiPedal server if you have a desktop environment installed.
|
||||
|
||||
You should not run Pipedal using a browser on the same machine that is running the PiPedal server, unless you have a relatively performant desktop or laptop class machine.
|
||||
|
||||
The Pipedal server does update itself automatically (it prompts for permission from the browser interface if there is an update available). However, it does not take care of Operating System updates. You should make sure to keep your OS up to date, and to install security updates as they become available. You will need to do that yourself from a commandline terminal, or using a desktop environment on the machine running the PiPedal server.
|
||||
|
||||
You may find it much easier to set up and maintain your PiPedal server if you enable SSH access on the server machine.
|
||||
|
||||
### Older Versions of PiPedal
|
||||
|
||||
Older versions of PiPedal (v1.1.31) have been tested on the following operating systems, but are no longer supported (and are not really recommended):
|
||||
|
||||
* Ubuntu 21.04 or later, 64-bit
|
||||
* Raspberry PI OS 64-bit bullseye
|
||||
|
||||
+34
-6
@@ -1,12 +1,13 @@
|
||||
## Download
|
||||
|
||||
### Install for Ubuntu or Raspberry Pi OS (64-bit)
|
||||
# Download PiPedal 2.0.102-alpha
|
||||
|
||||
|
||||
Download the most recent Debian (.deb) package for your platform:
|
||||
|
||||
- [Raspberry Pi OS bookworm (aarch64) v2.0.102 Beta](https://github.com/rerdavies/pipedal/releases/download/v2.0.102/pipedal_2.0.102_arm64.deb)
|
||||
- [Raspberry Pi OS bookworm (aarch64) v2.0.102 Alpha](https://github.com/rerdavies/pipedal/releases/download/v2.0.102/pipedal_2.0.102_arm64.deb)
|
||||
- [Ubuntu 24.x, 25.04 (aarch64) v2.0.102 Alpha](https://github.com/rerdavies/pipedal/releases/download/v2.0.102/pipedal_2.0.102_arm64.deb)
|
||||
- [Ubuntu 24.x, 25.04 (amd64) v2.0.102 Alpha](https://github.com/rerdavies/pipedal/releases/download/v2.0.102/pipedal_2.0.102_amd64.deb)
|
||||
- [Ubuntu 24.x, 25.04 (amd64/x86_64) v2.0.102 Alpha](https://github.com/rerdavies/pipedal/releases/download/v2.0.102/pipedal_2.0.102_amd64.deb)
|
||||
|
||||
|
||||
Install the package by running
|
||||
@@ -14,9 +15,36 @@ Install the package by running
|
||||
```
|
||||
sudo apt update
|
||||
cd ~/Downloads
|
||||
sudo apt-get install ./pipedal_2.0.102_arm64.deb
|
||||
sudo apt install ./pipedal_2.0.102_arm64.deb
|
||||
# or ... _amd64.deb as appropriate for your platform
|
||||
```
|
||||
You MUST use `apt-get` to install the package. `apt install` will NOT install the package correctly. The message about missing permissions given by `apt-get` is
|
||||
expected, and can be safely ignored.
|
||||
The message about missing permissions given by `apt` is
|
||||
expected, and can be safely ignored. Apt is unable to unpack the debian package in a sandbox because the
|
||||
package is a local file, rather than a file from the Internet. This is a known issue with apt, and does not indicate any problem with the package or installation process.
|
||||
|
||||
Follow the instructions in [_Configuring PiPedal After Installation_](https://rerdavies.github.io/pipedal/Configuring.html) to complete the installation.
|
||||
|
||||
# Download PiPedal 1.5.99 Stable Release
|
||||
|
||||
Download the most recent Debian (.deb) package for your platform:
|
||||
|
||||
- [Raspberry Pi OS bookworm (aarch64) v1.5.99](https://github.com/rerdavies/pipedal/releases/download/v1.5.99/pipedal_1.5.99_arm64.deb)
|
||||
- [Ubuntu 24.x, 25.04 (aarch64) v1.5.99](https://github.com/rerdavies/pipedal/releases/download/v1.5.99/pipedal_1.5.99_arm64.deb)
|
||||
- [Ubuntu 24.x, 25.04 (amd64/x86_64) v1.5.99](https://github.com/rerdavies/pipedal/releases/download/v1.5.99/pipedal_1.5.99_amd64.deb)
|
||||
|
||||
|
||||
Install the package by running
|
||||
|
||||
```
|
||||
sudo apt update
|
||||
cd ~/Downloads
|
||||
sudo apt install ./pipedal_1.5.99_arm64.deb
|
||||
# or ... _amd64.deb as appropriate for your platform
|
||||
```
|
||||
The message about missing permissions given by `apt` is
|
||||
expected, and can be safely ignored. Apt is unable to unpack the debian package in a sandbox because the
|
||||
package is a local file, rather than a file from the Internet. This is a known issue with apt, and does not indicate any problem with the package or installation process.
|
||||
|
||||
|
||||
Follow the instructions in [_Configuring PiPedal After Installation_](https://rerdavies.github.io/pipedal/Configuring.html) to complete the installation.
|
||||
|
||||
|
||||
+35
-4
@@ -5,17 +5,48 @@
|
||||
<h2 style="font-weight: 300; font-size: 1.6em;line-height: 1em; padding-top: 32px; padding-bottom: 0px;margin-bottom: 4px">PiPedal Guitar Effects Processor</h2>
|
||||
<p style="padding-top: 0px; opacity: 0.6; padding-bottom: 16px">A Raspberry Pi-based stomp box designed to be controlled from a phone or tablet.</p>
|
||||
|
||||
<div style="padding-left:48px; padding-right: 48px; padding-top: 32px; padding-bottom: 16px;
|
||||
background-color: #DCDCFF; border-radius: 8px; border: 0px solid #555;
|
||||
margin-bottom: 48px; margin-top: 16px;
|
||||
margin-left: 16px; margin-right: 48px;
|
||||
box-shadow: 1px 4px 12px rgba(0, 0, 0, 0.3);">
|
||||
<div style="opacity: 0.8;">
|
||||
<h2 style='font-weight: 300; font-family: "Roboto Light", "Segoe UI", Roboto, Helvetica, Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji", "Segoe UI Symbol"; font-weight: 400; font-size: 1.3em;line-height: 1.2em; padding-top: 0px; padding-bottom: 16px;margin-bottom: 8px'
|
||||
>Announcing <a href="PiPedal2.html">PiPedal 2.0</a></h2>
|
||||
<p>
|
||||
The first public preview release of Pipedal version 2.0.102-alpha is now available!
|
||||
</p>
|
||||
|
||||
<p>This release includes </p>
|
||||
|
||||
<ul>
|
||||
<li style="margin-bottom: 8px">
|
||||
Support for Neural Amp Modeler A2 models—the next generation of the ground-breaking
|
||||
Neural Amp Modeler technology.</li>
|
||||
<li style="margin-bottom: 8px">
|
||||
Integration with Tone3000.com services for easy downloading of Neural Amp Modeler A2 models and IIRs.</li>
|
||||
<li style="margin-bottom: 8px">
|
||||
A new Channel Routing dialog for global routing of auxiliary input channels, and unprocessed re-amp output channels.</li>
|
||||
<li style="margin-bottom: 8px">
|
||||
Many other minor features, improvements, and bug fixes.</li>
|
||||
</ul>
|
||||
|
||||
<p>For more information, and to download PiPedal v2.0.102-alpha <a href="PiPedal2.html">click here</a>.
|
||||
</p>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<a href="https://rerdavies.github.io/pipedal/ReleaseNotes"><img src="https://img.shields.io/github/v/release/rerdavies/pipedal?color=%23808080"/></a>
|
||||
<a href="https://rerdavies.github.io/pipedal/download"><img src="https://img.shields.io/badge/Download-008060" /></a>
|
||||
<a href="https://rerdavies.github.io/pipedal/Documentation"><img src="https://img.shields.io/badge/Docmentation-0060d0"/></a>
|
||||
|
||||
_To download PiPedal, click [*here*](download.md).
|
||||
<a href="https://rerdavies.github.io/pipedal/Documentation"><img src="https://img.shields.io/badge/Documentation-0060d0"/></a>
|
||||
|
||||
_To download PiPedal v1.5.99, click [*here*](download.md).
|
||||
To view PiPedal documentation, click [*here*](Documentation.md)._
|
||||
|
||||
Use your Raspberry Pi as a guitar effects pedal. Configure and control PiPedal with your phone or tablet.
|
||||
PiPedal running on a Raspberry Pi 4 or Pi 5 provides stable super-low-latency audio via external USB audio devices, or internal Raspberry Pi audio hats.
|
||||
|
||||
PiPedal will also run on Ubuntu 22.x (amd64/x64 and aarch64). Make sure you follow the [Ubuntu post-install
|
||||
PiPedal will also run on Ubuntu 24.x or later (amd64/x86-64 and aarch64). Make sure you follow the [Ubuntu post-install
|
||||
instructions](https://rerdavies.github.io/pipedal/Configuring.html) to make sure your Ubuntu OS is using a realtime-capable kernel.
|
||||
|
||||
{% include gallery.html %}
|
||||
|
||||
Reference in New Issue
Block a user