Spell check!

.vscode/settings.json

@@ -93,5 +93,13 @@
 
 
 
-    }
+    },
+    "cSpell.words": [
+        "Guitarix",
+        "hostapd",
+        "pipedalconfig",
+        "pipedald",
+        "pipedalshutdownd",
+        "pipedaltest"
+    ]
 }

docs/AudioLatency.md

@@ -1,22 +1,22 @@
 ## Optimizing Audio Latency
 
-Note that Pipedal is not intended for use when logged in to Raspbian. Screen updates and heavy filesystem activity will cause audio dropouts. For best results, access PiPedal using the web interface remotely, through the Wi-Fi hotspot. Accessing the web interface via Wi-Fi has little or no effect on audio latency or dropouts.
+Note that PiPedal is not intended for use when logged in to Raspbian. Screen updates and heavy filesystem activity will cause audio dropouts. For best results, access PiPedal using the web interface remotely, through the Wi-Fi hotspot. Accessing the web interface via Wi-Fi has little or no effect on audio latency or dropouts.
 
 With a good USB audio device, PiPedal should be able to provide stable audio with 4ms (good), or 2ms (excellent) latency on a Raspberry Pi 4 when running on a stock PREEMPT kernel. Your actual results may vary.
 
-The current Linux kernel provides best latency on USB audio devices when they are configured with a sampling rate of 48kHz, and 3 buffers. Cheap USB audio devices (e.g. M-Audio  M-Track Solo, available for less than $60) should be able to run without dropouts at 48kHz with 3x64 sample buffers. Most devices in this class use the same Burr-Brown chipset. Premium USB Audio devices should run stably at 48kHZ 3x32 sample buffers (about 2ms latency). I personally use the MOTU M2 USB audio adapter, which I highly recommmend -- stable, quiet, low-latency, great controls, and built like a tank).
+The current Linux kernel provides best latency on USB audio devices when they are configured with a sampling rate of 48kHz, and 3 buffers. Cheap USB audio devices (e.g. M-Audio  M-Track Solo, available for less than $60) should be able to run without dropouts at 48kHz with 3x64 sample buffers. Most devices in this class use the same Burr-Brown chipset. Premium USB Audio devices should run stably at 48kHZ 3x32 sample buffers (about 2ms latency). I personally use the MOTU M2 USB audio adapter, which I highly recommend -- stable, quiet, low-latency, great controls, and built like a tank).
 
 Make sure your system is fully updated, and that you are running with a kernel version of 5.10 or later, since version 5.10 of the Linux kernel provides improved support for class-compliant USB audio. The MOTU M2 (and many other USB audio adapters) will not work on versions of the kernel prior to 5.10.
 
 Prefer 64-bit operating systems to 32-bit operating systems. ARM processors execute 64-bit code about 40% faster than 32-bit code providing the same functionality.
 
-RT_PREEMPT realtime kernels (when available) are preferred but not required. (As if Februrary 2022, there aren't any good sources for latest versions of Ubuntu or Rasbian). PiPedal provides better (but not dramatically better) latency when running on a Raspbian Realtime kernel. Stock Raspbian provides PREEMPT real-time scheduling, but does not currently have all of the realtime patches, so interrupt latency is slightly more variable on stock Rasbian than on custom builds of Raspbian with RT_PREEMPT patches applied.
+RT_PREEMPT realtime kernels (when available) are preferred but not required. (As if February 2022, there aren't any good sources for latest versions of Ubuntu or Raspberry Pi OS). PiPedal provides better (but not dramatically better) latency when running on a Raspbian Realtime kernel. Stock Raspbian provides PREEMPT real-time scheduling, but does not currently have all of the realtime patches, so interrupt latency is slightly more variable on stock Raspberry Pi OS than on custom builds of Raspbian with RT_PREEMPT patches applied.
 
-The Ubuntu Studio installer will install a realtime kernel if there is one avialable. But -- at least for Ubuntu 21.04 -- there is no stock RT_PREEMPT kernel for ARM aarch64.
+The Ubuntu Studio installer will install a realtime kernel if there is one available. But -- at least for Ubuntu 21.04 -- there is no stock RT_PREEMPT kernel for ARM aarch64.
 
-On a Raspberry Pi 4 device, Wi-Fi, USB 2.0, USB 3.0 and SDCARD access are performed over separate buses (which is not true for previous versions of Raspberry Pi). It's therefore a good idea to ensure that your USB audio device is either the only device connected to the USB 2.0 ports, or the only device connected to the UBS 3.0 ports. There's no significant advantage to using USB 3.0 over USB 2.0 for USB audio. Network traffic does not seem to adversely affect USB audio operations on Raspberry Pi 4 (which isn't true on previous versions of Raspberry Pi). Filesystem activity does affect USB audio operation on Rasbian, even with an RT_PREEMPT kernel; but interestingly, filesystem activity has much less effect on UBS audio on Ubuntu 21.04, even on a plain PREEMPT kernel. 
+On a Raspberry Pi 4 device, Wi-Fi, USB 2.0, USB 3.0 and SD Card access are performed over separate buses (which is not true for previous versions of Raspberry Pi). It's therefore a good idea to ensure that your USB audio device is either the only device connected to the USB 2.0 ports, or the only device connected to the UBS 3.0 ports. There's no significant advantage to using USB 3.0 over USB 2.0 for USB audio. Network traffic does not seem to adversely affect USB audio operations on Raspberry Pi 4 (which isn't true on previous versions of Raspberry Pi). Filesystem activity does affect USB audio operation on Raspberry Pi OS, even with an RT_PREEMPT kernel; but interestingly, filesystem activity has much less effect on UBS audio on Ubuntu 21.04, even on a plain PREEMPT kernel. 
 
-There is some reason to beleive that there are outstanding issues with the Broadcom 2711 PCI Express bus drivers on Rasbian realtime kernels, but as of September 2021, this is still a research issue. If you are brave, there is strong annecdotal evidence that these issues arise when the Pi 4 PCI-express bus goes into and out of power-saving mode, which can be prevented by building a realtime kernel with all power-saving options disabled. But this is currently unconfirmed speculation. And building realtime kernels is well outside the scope of this document. (source: a youtube video on horrendously difficult bugs encountered while supporting RT_PREEMPT, by one of the RT_PREEMPT team members).
+There is some reason to believe that there are outstanding issues with the Broadcom 2711 PCI Express bus drivers on Raspberry Pi OS realtime kernels, but as of September 2021, this is still a research issue. If you are brave, there is strong anecdotal evidence that these issues arise when the Pi 4 PCI-express bus goes into and out of power-saving mode, which can be prevented by building a realtime kernel with all power-saving options disabled. But this is currently unconfirmed speculation. And building realtime kernels is well outside the scope of this document. (source: a youtube video on horrendously difficult bugs encountered while supporting RT_PREEMPT, by one of the RT_PREEMPT team members).
 
 For the meantime, for best results, log off from your Raspberry Pi, and use the web interface only.
 

docs/BuildPrerequisites.md

@@ -14,7 +14,7 @@ of `node.js` installed already. Otherwise run the following commands as root to
 If your distribution doesn't provide a suitable version of nodejs, you can install the current LTS version of nodejs
 with
 
-    # install NodeJS lastest LTS release.
+    # install NodeJS latest LTS release.
     curl -fsSL https://deb.nodesource.com/setup_14.x | sudo -E bash -
     sudo apt-get install -y nodejs
 

docs/BuildingPiPedalFromSource.md

@@ -1,10 +1,10 @@
 ## Building PiPedal From Source
 
-PiPedal has only been tested on Raspbian, and Ubuntu, but should run with little or no modification on most Linux distros. Pull requests to correct problems with building PiPedal on other versions of Linux are welcome. 
+PiPedal has only been tested on Raspbian, and Ubuntu, but should run with little or no modification on most Linux distributions. Pull requests to correct problems with building PiPedal on other versions of Linux are welcome. 
 
 To build PiPedal, a Raspberry Pi 4B, with at least 4GB of memory is required (8GB recommended). You can build PiPedal from the command-line using CMake; but the project was originally build using
 Microsoft Visual Studio Code. If you use VSCode, you will almost definitely need to hav 8GB of RAM.
 
 You should also be able to cross-compile PiPedal easily enough, but we do not currently provide support on how to do this. Visual Studio Code provides excellent support for cross-compiling, and good support for remote
-and cross-platform debugging, all of which should work with the PiPedal CMake build. In early development, PiPedal was built and debugged remotely on a Raspberry Pi, from a Windows desktop syustem. This should still 
+and cross-platform debugging, all of which should work with the PiPedal CMake build. In early development, PiPedal was built and debugged remotely on a Raspberry Pi, from a Windows desktop system. This should still 
 more-or-less work, although you may have to scramble a bit to install some of the build dependencies.

docs/Configuring.md

@@ -4,7 +4,7 @@ After PiPedal is installed, you can connect to the web interface as follows: via
 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). 
 
-Android devices do not support mDNS. If you are connecting to PiPedal with an Android device, via the Host Access Point, PiPedal, the PiPedal user interace can be reached at http://172.22.1.1 If you are connecting via the Raspberry Pi's Ethernet port, connect to http://*address of your Pi*:80
+Android devices do not support mDNS. If you are connecting to PiPedal with an Android device, via the Host Access Point, PiPedal, the PiPedal user interface can be reached at http://172.22.1.1 If you are connecting via the Raspberry Pi's Ethernet port, connect to http://*address of your Pi*:80
 
 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. 
      
@@ -14,7 +14,9 @@ Once connected, select the Settings menu item on the Hamburger menu at the top l
 
 You can also activate PiPedal's Wi-Fi hotspot connection from the Settings dialog. Click on the Wifi Hotspot menu item in the Settings dialog.
 
-     IMPORTANT NOTE: Activating the WiFi hotspot will DISABLE outbound Wi-Fi connections from the Raspberry Pi.
+-    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, unless an Ethernet cable is connected to the Raspberry Pi.

docs/Debugging.md

@@ -1,11 +1,11 @@
 ### How to Debug PiPedal.
 
-PipPedal consists of the following subprojects:
+PipPedal consists of the following components:
 
 *    A web application build in React, found in the react subdirectory.
 
 *    `pipedald`: a Web server, written in C++, serving a web socket, and pre-built HTML components from the React app.
-     All audio services are provided by the pipedal process.
+     All audio services are provided by the pipedald process.
 
 *   `pipedalshutdownd`: A service to execute operations that require root credentials on behalf of pipedald. (e.g. shutdown, reboot,
     and pushing configuration changes).
@@ -15,7 +15,7 @@ PipPedal consists of the following subprojects:
 *   `pipedaltest`: Test cases for pipedald, built using the Catch2 framework.
 
 
-You must stop the pipdeal service before launching a debug instance of pipedald:
+You must stop the pipedald service before launching a debug instance of pipedald:
 
     sudo systemctl stop pipedald
 
@@ -24,7 +24,7 @@ or
     pipedalconfig -stop  #Stops the Jack service as well.
 
 But there's no harm in running a debug react server that's configured to connect to the web 
-socket of a production instance of pipedal on port 80, if you aren't planning to debug C++ code.
+socket of a production instance of pipedald on port 80, if you aren't planning to debug C++ code.
 
 In production, the pipedald web server serves the PiPedal web socket, as well as static HTML from the  built 
 react components. But while debugging, it is much more convenient to use the React debug server for 
@@ -43,12 +43,12 @@ files:
 
 followed by `sudo sysctl -p`. Note that VS Code and the React framework both need this change.
 
-By default, the React app will attempt to contact the pipedal server on ws:*:8080 -- the address on which
+By default, the React app will attempt to contact the pipedald server on ws:*:8080 -- the address on which
-the debug version of systemctld listens on. This can be reconfigured
+the debug version of pipedald listens on. This can be reconfigured
 in the file react/src/public/var/config.json if desired. If you connect to the the pipedald server port, pipedald intercepts requests for this file and 
 points the react app at itself, so the file has no effect when running in production. 
 
-The React app will display the message "Error: Failed to connect to the server", until you start the pipedal websocket server in the VSCode debugger. It's quite reasonable to point the react debug app at a production instance of the pipedal server instead.
+The React app will display the message "Error: Failed to connect to the server", until you start the pipedald websocket server in the VSCode debugger. It's quite reasonable to point the react debug app at a production instance of the pipedald server instead.
 
     react/public/var/config.json: 
     {
@@ -70,8 +70,8 @@ Once CMake has configured itself, build and debug commands are available on the
 bottom of the Visual Studio Code window. Set the build variant to debug. Set the debug target to "pipedald". 
 Click on the Build button to build the app. Click on the Debug button to launch a debugger.
 
-To get the debugger to launch and run correctly, you will need to set commandline parameters for pipedald. 
+To get the debugger to launch and run correctly, you will need to set command-line parameters for pipedald. 
-Commandline arguments can be set in the file .vscode/settings.json: 
+Command-line arguments can be set in the file .vscode/settings.json: 
 
     {
         ...

docs/Installing.md

@@ -4,7 +4,7 @@
 
 Download the most recent Debian (.deb) package for your platform:
 
-- [Ubuntu or Rasbian (64-bit)](https://github.com/rerdavies/pipedal/releases/download/v0.1.3-alpha.2/pipedal_0.1.3_arm64.deb) v0.1.3-alpha.2
+- [Ubuntu or Raspberry Pi OS (64-bit)](https://github.com/rerdavies/pipedal/releases/download/v0.1.3-alpha.2/pipedal_0.1.3_arm64.deb) v0.1.3-alpha.2
 
 Install the package by running 
 

docs/Sponsor.md

@@ -1,15 +0,0 @@
-## Sponsor
-
-### Install for Ubuntu or Rasbian (64-bit)
-
-Download the most recent Debian (.deb) package for your platform:
-
-- [Ubuntu or Rasbian (64-bit)](https://github.com/rerdavies/pipedal/releases/download/v0.1.3-alpha.2/pipedal_0.1.3_arm64.deb) v0.1.3-alpha.2
-
-Install the package by running 
-
-```
-  sudo apt update
-  cd ~/Downloads  
-  sudo apt-get install ./pipedal_0.1.3_arm64.deb
-```

docs/SystemRequirements.md

@@ -6,10 +6,9 @@
 
 PiPedal has been tested on the following Operating Systems:
 
-* Ubuntu 21.04 or later, 64-bit (recommended)
+* Ubuntu 21.04 or later, 64-bit
-* Ubuntu 21.04 or later, 32-bit.
+* Raspberry Pi OS 64-bit
-* Raspbian 64-bit or 32-bit
 
 64-bit operating systems are preferred, as they delivery significantly higher performance than 32-bit platforms.
 
-If you are using Rasbian, make sure to upgrade to the latest version, because versions of the Linux kernel later than 5.10 provide important bug fixes for USB audio devices.
+If you are using Raspberry Pi OS, make sure to upgrade to the latest version, because versions of the Linux kernel later than 5.10 provide important bug fixes for USB audio devices.

docs/UsingLv2Plugins.md

@@ -3,8 +3,6 @@
 PiPedal uses standard LV2 audio plugins for effects. There's a huge variety of LV2 guitar effect plugins, and plugins collections, many 
 of which are specifically intended for use as guitar effect plugins. Ubuntu Studio comes with an enormous collection of LV2 plugins preinstalled. On Rasbian, you will have to manually select and install the plugins you want to use.
 
-On stock Ubuntu, you can install Ubuntu Studio addons (sudo apt install ubuntu-studio-install), and ask it to install Audio Plugins. This will install a large collection of LV2 plugins, which will be automatically detected by PiPedal. Or you can choose your LV2 plugin collections manually, as for Rasbian.
-
 The following LV2 Plugin collections (all recommended) are available on both Rasbian and Ubuntu.
 
   sudo apt install guitarix-lv2     # https://guitarix.org/
@@ -22,7 +20,7 @@ But there are many more.
 Visit https://lv2plug.in/pages/projects.html for more suggestions.
 
 There is also a set of supplementary Gx effect plugins which did not make it into the main Guitarix distribution. You will
-have to compile these plugins yourself, as they are not currently avaiable via apt. But if you are comfortable building
+have to compile these plugins yourself, as they are not currently available via apt. But if you are comfortable building
 packages on Raspbian, the effort is well worthwhile. The GxPlugins collection provides a number of excellent boutique amp emulations,
 as well as emulations of famous distortion effect pedals that are not part of the main Guitarix distribution.
 

docs/_config.yml

@@ -29,7 +29,6 @@ github_repository: rerdavies/pipedal
 
 header_pages:
   - download.md
-  - Sponsor.md
 
 # Build settings
 theme: minima

docs/_includes/footer.html

@@ -3,7 +3,23 @@
   
     <div class="wrapper">
   
+
+      <a rel="me" href="https://github.com/rerdavies/pipedal" 
+      target="_blank" title="rerdavies/pipedal">
+        <svg class="svg-icon grey"><use xlink:href="{{ '/assets/minima-social-icons.svg#github' | relative_url }}"></use>
+        </svg>
+        rerdavies/pipedal
+      </a>
   
+      <span style="margin-right: 60px" >&nbsp;</span>
+
+
+      <a rel="me" href="https://github.com/rerdavies" target="_blank" title="rerdavies"><svg 
+        class="svg-icon grey"><use xlink:href="{{ '/assets/minima-social-icons.svg#github' | relative_url }}"></use>
+      </svg>rerdavies</a>
+
+
+    <!--
       <div class="footer-col-wrapper">
         <div class="footer-col footer-col-1">
           <ul class="contact-list">
@@ -13,12 +29,26 @@
           </ul>
         </div>
   
+
         <div class="footer-col footer-col-2">
-          {%- include social.html -%}
+          <ul class="social-media-list">
+            <li><a rel="me" href="https://github.com/rerdavies" target="_blank" title="rerdavies"><svg 
+              class="svg-icon grey"><use xlink:href="{{ '/assets/minima-social-icons.svg#github' | relative_url }}"></use>
+            </svg>rerdavies</a></li>
+
+            <li>
+              <a rel="me" href="https://github.com/rerdavies/pipedal" 
+                  target="_blank" title="rerdavies/pipedal">
+                  <svg class="svg-icon grey"><use xlink:href="{{ '/assets/minima-social-icons.svg#github' | relative_url }}"></use>
+                  </svg>
+                  rerdavies/pipedal
+                </a>
+              </li>
+            </ul>
         </div>
   
       </div>
-  
+  -->
     </div>
   
   </footer>

docs/_includes/header.html

@@ -26,15 +26,15 @@
               <a class="page-link" href="{{ my_page.url | relative_url }}">{{ my_page.title | escape }}</a>
               {%- endif -%}
             {%- endfor -%}
-              <a class="page-link" href="https://github.com/sponsor/rerdavies">
+            <a class="page-link" href="https://github.com/sponsors/rerdavies">
-                  Sponsor
+                Sponsor
-                  <span style="vertical-align: center">
+                <span style="vertical-align: center">
-                      <svg aria-hidden="true" height="16" viewBox="0 0 16 16" version="1.1" width="16"
+                    <svg aria-hidden="true" height="12" viewBox="0 0 16 16" version="1.1" width="12" 
-                           >
+                          >
-                        <path fill-rule="evenodd" d="M4.25 2.5c-1.336 0-2.75 1.164-2.75 3 0 2.15 1.58 4.144 3.365 5.682A20.565 20.565 0 008 13.393a20.561 20.561 0 003.135-2.211C12.92 9.644 14.5 7.65 14.5 5.5c0-1.836-1.414-3-2.75-3-1.373 0-2.609.986-3.029 2.456a.75.75 0 01-1.442 0C6.859 3.486 5.623 2.5 4.25 2.5zM8 14.25l-.345.666-.002-.001-.006-.003-.018-.01a7.643 7.643 0 01-.31-.17 22.075 22.075 0 01-3.434-2.414C2.045 10.731 0 8.35 0 5.5 0 2.836 2.086 1 4.25 1 5.797 1 7.153 1.802 8 3.02 8.847 1.802 10.203 1 11.75 1 13.914 1 16 2.836 16 5.5c0 2.85-2.045 5.231-3.885 6.818a22.08 22.08 0 01-3.744 2.584l-.018.01-.006.003h-.002L8 14.25zm0 0l.345.666a.752.752 0 01-.69 0L8 14.25z"></path>
+                      <path fill="red" fill-rule="evenodd" d="M4.25 2.5c-1.336 0-2.75 1.164-2.75 3 0 2.15 1.58 4.144 3.365 5.682A20.565 20.565 0 008 13.393a20.561 20.561 0 003.135-2.211C12.92 9.644 14.5 7.65 14.5 5.5c0-1.836-1.414-3-2.75-3-1.373 0-2.609.986-3.029 2.456a.75.75 0 01-1.442 0C6.859 3.486 5.623 2.5 4.25 2.5zM8 14.25l-.345.666-.002-.001-.006-.003-.018-.01a7.643 7.643 0 01-.31-.17 22.075 22.075 0 01-3.434-2.414C2.045 10.731 0 8.35 0 5.5 0 2.836 2.086 1 4.25 1 5.797 1 7.153 1.802 8 3.02 8.847 1.802 10.203 1 11.75 1 13.914 1 16 2.836 16 5.5c0 2.85-2.045 5.231-3.885 6.818a22.08 22.08 0 01-3.744 2.584l-.018.01-.006.003h-.002L8 14.25zm0 0l.345.666a.752.752 0 01-.69 0L8 14.25z"></path>
-                    </svg>
+                  </svg>
-                  </span>
+                </span>
-              </a>
+            </a>
           </div>
         </nav>
       {%- endif -%}

docs/download.md

@@ -4,7 +4,7 @@
 
 Download the most recent Debian (.deb) package for your platform:
 
-- [Ubuntu or Rasbian (64-bit)](https://github.com/rerdavies/pipedal/releases/download/v0.1.3-alpha.2/pipedal_0.1.3_arm64.deb) v0.1.3-alpha.2
+- [Ubuntu or Raspberry Pi OS (64-bit)](https://github.com/rerdavies/pipedal/releases/download/v0.1.3-alpha.2/pipedal_0.1.3_arm64.deb) v0.1.3-alpha.2
 
 Install the package by running