Update documentation for PiPedal v1.4.76, including new Ubuntu support and improved installation instructions
This commit is contained in:
Robin E. R. Davies
@@ -1,18 +1,18 @@
|
||||
|
||||
<img src='docs/GithubBanner.png' width="100%" /><br/>
|
||||
|
||||
<a href="https://rerdavies.github.io/pipedal/download.html"><img src="https://img.shields.io/github/v/release/rerdavies/pipedal?color=%23808080"/></a>
|
||||
<a href="#"><img src="https://img.shields.io/github/downloads/rerdavies/pipedal/total?color=%23808080&link=https%3A%2F%2Frerdavies.github.io%2Fpipedal%2Fdownload.html"/></a>
|
||||
<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>
|
||||
<a href="https://rerdavies.github.io/pipedal/LicensePiPedal.html"><img src="https://img.shields.io/badge/MIT-MIT?label=license&color=%23808080"/></a>
|
||||
<a href="https://github.com/rerdavies/pipedal/actions"><img src="https://img.shields.io/github/actions/workflow/status/rerdavies/pipedal/cmake.yml?branch=main"/></a>
|
||||
<img src="https://img.shields.io/github/downloads/rerdavies/pipedal/total?color=%23808080&link=https%3A%2F%2Frerdavies.github.io%2Fpipedal%2Fdownload.html"/>
|
||||
|
||||
|
||||
Download: <a href='https://rerdavies.github.io/pipedal/download.html'>v1.4.76</a>
|
||||
Website: [https://rerdavies.github.io/pipedal](https://rerdavies.github.io/pipedal).
|
||||
Documentation: [https://rerdavies.github.io/pipedal/Documentation.html](https://rerdavies.github.io/pipedal/Documentation.html).
|
||||
|
||||
_Important notice_: [PatchStorage.com](https:///patchstorage.com) has added support for [PiPedal](https://patchstorage.com/platform/pipedal/). We urgently need your support! If you could please upload patches [here](https://patchstorage.com/platform/pipedal/) I would be enormously grateful. Note that media and model files are included in patch files, so you can share patches that
|
||||
include model files or audio samples. If you make use of plugins that are not included in the PiPedal distribution, please include a link to the plugin in the patch description.
|
||||
|
||||
#### NEW version 1.4.76 Release. See the [release notes](https://rerdavies.github.io/pipedal/ReleaseNotes) for details. New Phaser and Graphic Equalizer plugins.
|
||||
|
||||
|
||||
@@ -47,6 +47,8 @@ https://github.com/user-attachments/assets/9a9fd0c6-78fc-4284-8b44-6a1929c00cc6
|
||||
### [What PiPedal Is](https://rerdavies.github.io/pipedal/AboutPiPedal.html)
|
||||
### [System Requirements](https://rerdavies.github.io/pipedal/SystemRequirements.html)
|
||||
### [Installing PiPedal](https://rerdavies.github.io/pipedal/Installing.html)
|
||||
### [PiPedal on Ubuntu](https://rerdavies.github.io/pipedal/Ubuntu.html)
|
||||
|
||||
### [Configuring PiPedal After Installation](https://rerdavies.github.io/pipedal/Configuring.html)
|
||||
### [An Intro to Snapshots](https://rerdavies.github.io/pipedal/Snapshots.html)
|
||||
### [Choosing a USB Audio Adapter](https://rerdavies.github.io/pipedal/ChoosingAUsbAudioAdapter.html)
|
||||
|
||||
+1
-33
@@ -3,41 +3,9 @@ page_icon: img/Setup.jpg
|
||||
icon_width: 320px
|
||||
icon_float: left
|
||||
---
|
||||
## Selecting a real-time kernel on Ubuntu 24.x
|
||||
|
||||
This step is unneccesary on Raspberry Pi OS, which installs an RT_PREEMPT kernel by default.
|
||||
|
||||
By default, Ubuntu installs a PREEMT_DYNAMIC kernel, configured to run with volutary preemption. You will need to change this. PREEMPT_DYNAMIC/preempt=voluntary kernels are not capable of supporting real-time audio. You can do this by running the following command-line command after you have installed PiPedal:
|
||||
|
||||
```
|
||||
pipedal_kconfig
|
||||
```
|
||||
|
||||
In order to support real-time audio processing, select Preempt=full.
|
||||
|
||||
An RT_PREEMPT kernel provides slightly better realtime audio than a PREEMPT_DYNAMIC/preempt=full kernel, but the PREEMPT_DYNAMIC should be perfectly adequate. If you are having problems with intermittent audio dropouts, you may want to try an RT_PREEMPT kernel instead. Ubuntu provides a pre-built RT_PREEMPT kernel; but on our test systems, you can acheive stable low-latency audio using only the PREEMPT_DYNAMIC/preempt=full kernel. The pre-built Ubuntu RT_PREEMPT kernel can be installed using `apt` but is only available if you have an Ubuntu Pro subscription. Ubuntu Pro is free for non-commercial use. Reportedly, it is relatively easy to build the Ubuntu RT_PREEMPT kernel from source; but that is outside the scope of this document. We recommend using the PREEMPT_DYNAMIC/preempt=full Ubuntu kernel.
|
||||
|
||||
## Support for WIFI Auto-Hotspots on Ubuntu Server
|
||||
|
||||
The following information applies when installing PiPedal on Ubuntu Server 24.0x only. This information does not apply
|
||||
to Unbuntu Desktop installs or Raspberry Pi OS Lite installs, which use the Network Manager TCP/IP stack by default.
|
||||
|
||||
PiPedal's Auto-Hotspot feature only works on Linux systems that are using the Network Manager network services stack.
|
||||
Ubuntu Server 24.x (and probably other server-specific installs on other Debian distros) uses the Netplan network services stack by instead. It does so because the Netplan network stack is the preferred network stack when managing
|
||||
farms of cloud servers.
|
||||
|
||||
It's easy enough to reconfigure Ubuntu Server to run the Network Manager network stack instead. However you should be
|
||||
aware that Netplan TCP/IP configuration settings will not be migrated to Network Manager. If you perform this step on a server on which changes have beeen made to Netplan configuration files, you will lose those configuration changes, and will need to reimplement them in Network Manager. If you are
|
||||
a Netplan configuration (or are working with a clean install), then the default Network Manager configuration will work perfectly well too.
|
||||
|
||||
To reconfigure Ubuntu Server to use the Network Manager network stack (and therefore enable PiPedal's Auto-Hotspot feature), run the following command:
|
||||
|
||||
sudo apt install network-manager
|
||||
|
||||
|
||||
## Configuring PiPedal After Installation
|
||||
|
||||
|
||||
Before using PiPedal, you will need to configure settings for the audio device that PiPedal will use.
|
||||
|
||||
{% include pageIconL.html %}
|
||||
@@ -219,4 +187,4 @@ When the Raspberry Pi hosts the hotspot, mDNS discovery is definitely enabled; s
|
||||
|
||||
|
||||
--------
|
||||
[<< Installing PiPedal](Installing.md) | [Up](Documentation.md) | | [An Intro to Snapshots >>](Snapshots.md)
|
||||
[<< PiPedal on Ubuntu](Ubuntu.md) | [Up](Documentation.md) | | [An Intro to Snapshots >>](Snapshots.md)
|
||||
|
||||
@@ -8,7 +8,7 @@
|
||||
#### [System Requirements](SystemRequirements.md)
|
||||
|
||||
#### [Installing PiPedal](Installing.md)
|
||||
|
||||
#### [PiPedal on Ubuntu](Ubuntu.md)
|
||||
#### [Configuring PiPedal After Installation](Configuring.md)
|
||||
#### [An intro to Snapshots](Snapshots.md)
|
||||
#### [Choosing a USB Audio Adapter](ChoosingAUsbAudioAdapter.md)
|
||||
|
||||
+10
-7
@@ -13,27 +13,30 @@ page_icon: img/Install4.jpg
|
||||
|
||||
Download the most recent Debian (.deb) package for your platform:
|
||||
|
||||
- [Raspberry Pi OS bookworm (aarch64) v1.4.76 Beta](https://github.com/rerdavies/pipedal/releases/download/v1.4.76/pipedal_1.4.76_arm64.deb)
|
||||
- [Ubuntu 24.x (aarch64) v1.4.76 Alpha](https://github.com/rerdavies/pipedal/releases/download/v1.4.76/pipedal_1.4.76_arm64.deb)
|
||||
- [Ubuntu 24.x (amd64) v1.4.76 Alpha](https://github.com/rerdavies/pipedal/releases/download/v1.4.76/pipedal_1.4.76_amd64.deb)
|
||||
- [Raspberry Pi OS bookworm (aarch64) v1.4.76](https://github.com/rerdavies/pipedal/releases/download/v1.4.76/pipedal_1.4.76_arm64.deb)
|
||||
- [Ubuntu 24.x (aarch64) v1.4.76](https://github.com/rerdavies/pipedal/releases/download/v1.4.76/pipedal_1.4.76_arm64.deb)
|
||||
- [Ubuntu 24.x (amd64) v1.4.76](https://github.com/rerdavies/pipedal/releases/download/v1.4.76/pipedal_1.4.76_amd64.deb)
|
||||
|
||||
|
||||
Version 1.4.76 has been tested on Raspberry Pi OS bookworm, Ubuntu 24.04 (amd64), and Ubuntu 24.10 (aarch64). Download the appropriate package for your platform, and install using the following procedure:
|
||||
|
||||
```
|
||||
sudo apt update
|
||||
sudo apt upgrade
|
||||
cd ~/Downloads
|
||||
sudo apt-get install pipedal_1.4.76_arm64.deb
|
||||
sudo apt-get install ./pipedal_1.4.76_arm64.deb
|
||||
```
|
||||
You MUST use `apt-get`. `apt` will not install downloaded packages; and `dpkg-i` will not install dependencies.
|
||||
You MUST use `apt-get`. `apt` will not install downloaded packages; and `dpkg -i` will not install dependencies.
|
||||
|
||||
On Raspberry Pi OS, if you have a graphical desktop installed, you can also install the package by double-clicking on the downloaded package in the File Manager.
|
||||
|
||||
If you are using Ubuntu, there are additional post-installation steps you must take to reconfigure the Ubuntu kernel to
|
||||
provide support for low-latency real-time audio. Proced to [PiPedal support for Ubuntu](Ubuntu.md).
|
||||
|
||||
After installing, follow the instructions in [Configuring PiPedal after Installation](Configuring.md). If
|
||||
If you are using Raspberry Pi OS, procede directly to [Configuring PiPedal after Installation](Configuring.md). If
|
||||
you are using Ubuntu, there are additional post-installation steps you must take to reconfigure the Ubuntu kernel
|
||||
to provide support for low-latency real-time audio.
|
||||
|
||||
|
||||
--------
|
||||
[<< System Requirements](SystemRequirements.md) | [Up](Documentation.md) | [Configuring PiPedal after Installation >>](Configuring.md)
|
||||
[<< System Requirements](SystemRequirements.md) | [Up](Documentation.md) | [PiPedal on Ubuntu >>](Ubuntu.md)
|
||||
|
||||
@@ -0,0 +1,59 @@
|
||||
---
|
||||
page_icon: img/ubuntu.jpg
|
||||
icon_width: 120px
|
||||
icon_float: right
|
||||
---
|
||||
## PiPedal on Ubuntu
|
||||
|
||||
{% include pageIcon.html %}
|
||||
|
||||
PiPedal will run on Ubuntu 24.04, and 24.10 (both aarch64 and amd64/x64) as well as Raspberry Pi OS. We recommend using Ubuntu Desktop, but Raspberry Pi OS will also run on an Ubuntu Server install. Ubuntu Studio would also be a fine choice.
|
||||
|
||||
For best audio latency, you should not use PiPedal with an active desktop. See the Running Headless section below.
|
||||
|
||||
You might want to consider purchasing a tiny N95, N100 or N150 micro-pc on which to run PiPedal. They are cheap, provide plenty of CPU power, and are exactly the sort of hardware you need to run PiPedal at a gig, or away from home where you don't have access to a wi-fi network, or a monitor, or a keyboard. N100-series micro-pcs are in many ways preferrable to a Raspberry Pi 5. They provide significantly more compute power, and cost only slightly more.
|
||||
|
||||
PiPedal runs as a systemd service, rather than as a desktop application. By design, it is an IoT sort of device. You plugin in (or power on) your computer, and PiPedal starts up automatically. This may seem a bit odd on a laptop or a desktop computer; but it makes a great deal of sense if you are using a Raspberry Pi or tiny N100 mini pc to host PiPedal. And it makes a great deal of sense when you are using PiPedal onstage without access to a keyboard or a monitor. Just clip your phone onto your microphone stand, and you're set!
|
||||
|
||||
## Configuring a preempt=full Kernel on Ubuntu 24.x
|
||||
|
||||
By default, Ubuntu installs a PREEMT_DYNAMIC kernel, configured to run with volutary preemption. PREEMPT_DYNAMIC/preempt=voluntary kernels are not capable of supporting real-time audio. To run low-latency realtime audio on Ubuntu, you must reconfigure Ubuntu to use a PREEMPT_DYNAMIC/preempt=full kernel. The PiPedal installer includes a convenient command-line utility that allows you to make the change without having to do painful editing of intimidating system files. Although this is a relatively harmless change, it seemed inappropriate to reconfigure the kernel in the Pipedal package installer. Run the following command-line command after you have installed PiPedal:
|
||||
|
||||
```
|
||||
pipedal_kconfig
|
||||
```
|
||||
|
||||
and then select Preempt=full. Switching between PREEMPT_DYNAMIC kernels is a configuration-only change, and does not install new components. The switch actually takes place at runtime. Astonishingly, you do not even need to reboot!
|
||||
|
||||
Full realtime kernels (RT_PREEMPT) may provide slightly better realtime audio than a PREEMPT_DYNAMIC/preempt=full kernel, but the PREEMPT_DYNAMIC kernel should be perfectly adequate. As a point of reference, current versions of Ubuntu Studio uses a PREEMPT_DYNMAIC/preempt=full kernel, and the maintainers of Ubuntu Studio consciously chose to not install an RT_PREEMPT kernel by default. If you are having problems with intermittent audio dropouts that occur very infrequently, you may want to try an RT_PREEMPT kernel instead. A pre-built Ubuntu RT_PREEMPT kernel can be installed using `apt` but is only available if you have an Ubuntu Pro subscription. Ubuntu Pro is free for non-commercial use.
|
||||
|
||||
## Support for WIFI Auto-Hotspots on Ubuntu Server
|
||||
|
||||
The following information applies when installing PiPedal on Ubuntu Server 24.0x only. This information does not apply
|
||||
to Unbuntu Desktop installs or to Raspberry Pi OS or Raspberry Pi OS Lite installs, which use the Network Manager TCP/IP stack by default.
|
||||
|
||||
PiPedal's Auto-Hotspot feature only works on Linux systems that are using the Network Manager network services stack.
|
||||
Ubuntu Server 24.x (and probably other server-specific installs on other Debian distros) uses the Netplan network services stack instead. It does so because the Netplan network stack is the preferred network stack when managing farms of cloud servers.
|
||||
|
||||
It's easy enough to reconfigure Ubuntu Server to run the Network Manager network stack instead. However you should be
|
||||
aware that Netplan TCP/IP configuration settings will not be migrated to Network Manager. If you perform this step on a server on which changes have beeen made to Netplan configuration files, you will lose those configuration changes, and will need to reimplement them in Network Manager. If you are
|
||||
using a default Netplan configuration (or are working with a clean install), then the default Network Manager configuration should work without problems. On a clean install, or for ordinary home use, switching network stacks is pretty low risk.
|
||||
|
||||
To reconfigure Ubuntu Server to use the Network Manager network stack (and therefore enable PiPedal's Auto-Hotspot feature), run the following command:
|
||||
|
||||
sudo apt install network-manager
|
||||
|
||||
PiPedal runs perfectly well with the netplan network stack; but the auto-hotspot will be disabled (and actually won't even show up in the UI).
|
||||
|
||||
## Running Headless
|
||||
|
||||
To get the best possible audio latency, you should run your Ubuntu computer headless. GPU activity interferes with low-latency audio. Drawing to the screen (or even moving the mouse) can cause audio underruns. This does not mean that you cannot use a desktop install; but it does mean that you should not be using the desktop when using PiPedal. Use a browser on a remote machine, or use a phone or tablet to control PiPedal.
|
||||
|
||||
It is not entirely clear why GPUs don't play well with realtime low-latency audio. It's probably not caused by interrupts, but may be caused by contention for system memory and various system buses. If you are running a very powerful PC with a GPU that doesn't share system memory, you may be able to run a desktop while using PiPedal; but if you are not getting the latency you think you should, try going back to headless operation.
|
||||
|
||||
Headless, in this context means: nothing is using the GPU. On a Raspberry Pi, it is sufficient to just disconnect the HDMI cables, and not be using a remote desktop connection. It is uncertain whether Ubuntu will stop using the GPU if there is an active desktop that is (for example) updating status indicators on the status bar. If in doubt, try disabling automatic login. The system will then stop at the login screen, which does not do any drawing until you start typing credentials. Configuring your Ubuntu desktop to use a text-mode interface instead of a graphical interface would, of course, be perfect; but it seems unnecessarily inconvenient. On an Ubuntu server install, there is no graphical desktop, so this is not a problem. But see the section above about configuring Ubuntu Server before you choose a Server install of Ubuntu Desktop.
|
||||
|
||||
|
||||
--------
|
||||
[<< Installing PiPedal](Installing.md) | [Up](Documentation.md) | [Configuring PiPedal after Installation >>](Configuring.md)
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
<audio controls="margin-top: 16px" >
|
||||
<audio controls="margin-top: 16px;margin-left: 24px;" >
|
||||
<!-- Replace this source with your actual audio file path -->
|
||||
<source src="img/DemoTrack.mp3" type="audio/mpeg">
|
||||
Your browser does not support the audio element.
|
||||
</audio>
|
||||
<div style='font-size: 0.9em; font-style: italic; color: #888;margin-left: 32px'>
|
||||
<div style='font-size: 0.9em; font-style: italic; color: #888;margin-left: 56px'>
|
||||
Audio demo</div>
|
||||
|
||||
@@ -46,7 +46,7 @@
|
||||
<span style="margin-right: 60px" > </span>
|
||||
|
||||
<a rel="me" href="https://rerdavies.github.io" target="_blank" title="rerdavies.github.io"><img
|
||||
class="svg-icon" src="img/rerdavies.svg" />
|
||||
class="svg-icon" src="img/rerdavies.png" />
|
||||
</img>rerdavies.github.io</a>
|
||||
|
||||
|
||||
@@ -89,4 +89,4 @@
|
||||
-->
|
||||
</div>
|
||||
|
||||
</footer>
|
||||
</footer>
|
||||
|
||||
@@ -213,7 +213,7 @@
|
||||
document.writeln("</div>");
|
||||
}
|
||||
document.writeln("</div>");
|
||||
document.writeln("<div id='gallery_caption_frame' style='margin-left: 20px; width: " + frameWidth + "px; display: flex; flex-flow: row nowrap; margin-top: 8px; padding-left: 60px'>");
|
||||
document.writeln("<div id='gallery_caption_frame' style='margin-bottom: 16px; margin-left: 20px; width: " + frameWidth + "px; display: flex; flex-flow: row nowrap; margin-top: 8px; padding-left: 60px'>");
|
||||
document.writeln("<div> <span id='gallery_caption' style='font-size: 0.9em; font-style: italic; color: #888;'> "
|
||||
+ galleryIndent +captions[0] + "</span></div></div>");
|
||||
|
||||
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 32 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 64 KiB |
+13
-10
@@ -1,26 +1,29 @@
|
||||
<a href="Installing.html"><i>v1.4.76</i></a>
|
||||
<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 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>
|
||||
|
||||
<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).
|
||||
To view PiPedal documentation, click [*here*](Documentation.md)._
|
||||
|
||||
_Important notice_: [PatchStorage.com](https:///patchstorage.com) has added support for [PiPedal](https://patchstorage.com/platform/pipedal/). We urgently need your support! If you could please upload patches [here](https://patchstorage.com/platform/pipedal/) I would be enormously grateful. Note that media and model files are included in patch files, so you can share patches that
|
||||
include model files or audio samples. If you make use of plugins that are not included in the PiPedal distribution, please include a link to the plugin in the patch description.
|
||||
|
||||
#### NEW version 1.4.76 Release. See the [release notes](https://rerdavies.github.io/pipedal/ReleaseNotes) for details. New Phaser and Graphic Equalizer plugins.
|
||||
|
||||
|
||||
|
||||
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.
|
||||
|
||||
{% 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 %}
|
||||
|
||||
{% include gallery.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.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user