op-pedal/docs/Configuring.md

Configuring PiPedal After Installation

Note: Because PiPedal Remote Android app has just been released on Google Play, you won't be able to find it in the search listings yet. Use the following URL to directly access and install PiPedal Remote:     https://play.google.com/store/apps/details?id=com.twoplay.pipedal

Before using PiPedal, you will need to configure settings for the audio device that PiPedal will use.

You will also want to configure PiPedal to provide a Wi-Fi Direct access point (hotspot) that you can connect to using your phone. It's fine to use your home Wi-Fi network to connect to PiPedal when you're at home; but don't forget that when you take PiPedal out to a gig, you will need to ensure that the Wi-Fi Direct access point is enabled before you do.

PiPedal uses LV2 audio plugins. There are literally thousands of freely available high-quality LV2 plugins that are suitable for use as guitar effects.

By default, PiPedal comes with a few plugins from the ToobAmp plugin collection. You will probably want to install more.

See Using LV2 Plugins for more details, and for some concrete recommendations of LV2 Plugin collections that you might want to use with PiPedal.

Installing the PiPedal Remote Android app

Install PiPedal Remote on your Android device. PiPepedal Remote can connect to PiPedal on your Raspberry Pi device as long as your Android device and Raspberry Pi are connected to the same network via a normal Wi-Fi access point, or via an Ethernet connection.

First Connection

You can complete the initial configuration procedure using any of the following methods:

1. Log on to the Raspberry Pi device. Launch a web browser, and connect to http:://127.0.0.1/

2. Connect Raspberry Pi to a Wi-Fi or Ethernet network, and connect from your laptop or desktop. Connect to http://raspberrypi.local/ (substitute the host name of your Raspberry Pi if you have changed it from the default).

3. From your Android device. Install PiPedal Remote on your Android device. Connect your Raspberry Pi to your home router using a Wi-Fi or Ethernet connection. Launch PiPedal Remote on your Android device.

4. From a LINUX command prompt. As a last resort, you can configure the Wi-Fi Direct access point using the pipedalconfig program. Type pipedalconfig --help at a command prompt on your Raspberry Pi.

If you already have another web server on port 80, see How to Change the Web Server Port.

Configuring Audio

Once connected, select the Settings menu item on the Hamburger menu at the top left corner of the display. Click on Audio Device Settings to select and configure the audio device you want to use.

IMPORTANT NOTE: If you are using a USB audio device, you *MUST* set the number of buffers to 3, and you *MUST* set the sample rate to 48,000 in order to acheive reasonable latency. For other devices, you probably want to use 2 buffers.

You may also need to choose which audio input and output channels you will use for guitar signals, once you have selected and configured an audio device. Most external USB audio devices that have two inputs provide the guitar signal on the right channel only, so you will set the audio input chanels to "Right Only". If your USB audio adapter has more than two input or output channels, you will be offered a list of channels to choose from.

Activating the P2P (Wi-Fi Direct) Hotspot

The preferred way to connect to a PiPedal host device is via Wi-Fi Direct connections. Doing so allows you to use your PiPedal device when you are away from home.

Enable PiPedal's Wi-Fi Direct hotspot connection from the Settings dialog (Click on the hamburger icon; click on Settings; click on Wi-Fi Direct Hotspot). You will need to select a PIN and enable the connection before you can use it. The PiPedal hotspot will be visible to anyone with Wi-Fi distance; so choose your PIN carefully. Do NOT use trivial PINs like 12345678, or 00000000! Note that when connecting via Wi-Fi direct, you only have to enter the PIN once on the device you are connecting from; and it will be remembered automatically for subsequent connections.

Best practice would be to generate a random PIN (using the Generate Random Pin button in the setup dialog), and then tape a label to the bottom of your Raspberry PI (not the top) with the PIN written on it, in case you ever need to connect to PiPedal with a device that hasn't been previously set up.

Wi-Fi Direct connections differ in a couple of ways from normal Wi-Fi connections

• You only have to enter the pin once; the device you connect from will remember the PIN and connect without a PIN after that.

• You can have a simultaneous connection to your Wi-Fi router when using a Wi-Fi Direct connection to your Raspberry Pi. The device you are connecting from will continue use the Internet over your Wi-Fi router, and only use the Wi-Fi Direct connection to communication with your Raspberry Pi.

• You can use a Wi-Fi Direct connection even when you don't have a Wi-Fi router connection. Android phones will continue to communicate with the Internet over their data connections, even when a Wi-Fi Direct connection is active.

• More than one device can connect to the Wi-Fi Direct connection on the Raspberry Pi when it is active/

• Your Raspberry Pi can also have simultaneous access to a Wi-Fi router access point when the Wi-Fi Direct connection is enabled.

• Wi-Fi Direct connections are backward compatible with Wi-Fi access points if you are using an older device. Look for the DIRECT-xx-YourDeviceName access point. But if you use a legacy connection, the connecting device cannot have a simultanous Wi-Fi router connection.

If you use the PiPedal Android app (coming VERY soon - being pushed up for distribution now), the Android app will manage discovery and setting up of Wi-Fi direct connections to your Raspberry Pi device automatically.

PC support for Wi-Fi Direct connections varies dramatically. Modern PCs support Wi-Fi Direct; but you may find it easier to communicate with PiPedal via your Wi-Fi router. Configure PiPedal to use a Wi-Fi connection as well as a Wi-Fi Direct access point (or connect an ethernet cable to your Raspberry Pi). Just remember to configure your phone to use a Wi-Fi Diret connection before you take PiPedal out on a gig, because you won't have a Wi-Fi router then.

PiPedal advertises the address of the Raspberry Pi host machine via Multi-cast DNS (M-DNS). You should be able to establish web connections to the Raspberry Pi using the address http://<hostname-of-your-pi>.local/, no matter how you are connected.

Older devices may not support Wi-Fi Direct connections; but they will be able to use the Wi-Fi Direct connection as an ordinary Wi-Fi Hotspot. But they won't have access to the Internet over your Wi-Fi router while they have a connection with your Raspberry Pi.

You must select the correct country when setting up your Wi-Fi Direct connection. Regulations for use of Wi-Fi vary greatly from coutry to country, and define both the channels you are allowed to use, and the features and signal strength of Wi-Fi connections on those channels.

For best results, you should select Wi-Fi channel 1, 6 or 11 (referred to as the "Wi-Fi Direct Social Channels"). Doing so reduces the time it takes for other devices to discover the Raspberry Pi. While it is possible to use 5Ghz channels for Wi-Fi Direct, it may take some time for connecting devices to find your PiPedal device.

Support for Apple/IOS devices: a client for Apple/IoS devices is in long-term development plans; but I don't own any Apple device on which to do development and testing. If you'd like to see an Apple/IOS client, your sponsorship would help. (The client performs discovery and set up of Wi-Fi direct connections, and relies on the Web interface after that. Not difficult. Just expensive.

---

<< Installing PiPedal | Up | | Choosing a USB Audio Adapter >>