ezbeq 0.9.0

A small webapp which can send beqcatalogue filters to a DSP device

ezbeq

A simple web browser for beqcatalogue which integrates with minidsp-rs for local remote control of a minidsp or HTP-1.

Setup

Windows / MacOS

Python is required so use an appropriate package manager to install it.

chocolatey is a convenient choice for Windows homebrew is the equivalent for MacOS

Linux

Use your distro package manager to install python.

Installation

Example is provided for rpi users

$ ssh pi@myrpi
$ sudo apt install python3 python3-venv python3-pip libyaml-dev
$ mkdir python
$ cd python
$ python3 -m venv ezbeq
$ cd ezbeq
$ . bin/activate
$ pip install ezbeq

Using with a Minidsp

Install minidsp-rs as per the provided instructionshttps://github.com/mrene/minidsp-rs#installation

Using with a Monolith HTP-1

See the configuration section below

Upgrade

$ ssh pi@myrpi
$ cd python/ezbeq
$ . bin/activate
$ pip install --upgrade --force-reinstall ezbeq

then restart the app

Running the app manually

$ ssh pi@myrpi
$ cd python/ezbeq
$ . bin/activate
$ ./bin/ezbeq
  Loading config from /home/pi/.ezbeq/ezbeq.yml
  2021-01-16 08:43:15,374 - twisted - INFO - __init__ - Serving ui from /home/pi/python/ezbeq/lib/python3.8/site-packages/ezbeq/ui

Now open http://youripaddress:8080/index.html in your browser

Configuration

See $HOME/.ezbeq/ezbeq.yml

The only intended option for override is the port option which sets the port the UI and API is accessible on. This defaults to 8080.

Configuring Devices

The devices section contains a list of supported device, the format varies by the type of device and each item is a named device with the name subsequently appearing the UI (if multiple devices are listed)

Minidsp

Default values are shown, the only required value is the type field

  minidsp:
    cmdTimeout: 10
    exe: minidsp
    ignoreRetcode: false
    options: ''
    type: minidsp

• cmdTime: default timeout in seconds for a command sent to minidsp-rs to complete
• exe: location of the minidsp-rs executable
• ignoreRetcode: if true, errors generated by minidsp-rs will be ignored (for debugging/local testing only)
• options: additional command line switches to pass to minidsp-rs (refer to minidsp-rs docs for details)
• type: minidsp

Monolith HTP1

  htp1:
    ip: 192.168.1.181
    channels:
    - sub1

• ip: ip address of the HTP1
• channels: list of channels to apply filters to (sub1, sub2 and sub3 are the standard subwoofer channels in the HTP1)

JRiver Media Center

NB: Media Network must be enabled

  jriver:
    address: 192.168.1.181:52199
    auth:
      user: foo
      pass: thisismypass
    secure: true  
    channels:
    - SW
    - C9
    - C10
    block: 2

• address: the ip and port on which the Media Center media network is listening
• auth is optional, leave this out if MCWS is not secured
• secure is optional, leave this out if SSL is not used
• supported channels are L R C SW SL SR RL RR and C9 upto C32 (if more than 8 channel output is used)
• block is 1 or 2 and refers to the dsp slots Parametric Equalizer and Parametric Equalizer 2 respectively

This information is not validated, it is left to the user to configure the output format on the zone to match the supplied configuration.

Starting ezbeq on bootup

This is optional but recommended, it ensures the app starts automatically whenever the rpi boots up and makes sure it restarts automatically if it ever crashes.

We will achieve this by creating and enabling a systemd service.

1. Create a file ezbeq.service in the appropriate location for your distro (e.g. /etc/systemd/system/ for debian)::

[Unit]
Description=ezbeq
After=network.target

[Service]
Type=simple
User=pi
WorkingDirectory=/home/pi
ExecStart=/home/pi/python/ezbeq/bin/ezbeq
Restart=always
RestartSec=1

[Install]
WantedBy=multi-user.target

2. enable the service and start it up::

$ sudo systemctl enable ezbeq.service
$ sudo service ezbeq start
$ sudo journalctl -u ezbeq.service
-- Logs begin at Sat 2019-08-17 12:17:02 BST, end at Sun 2019-08-18 21:58:43 BST. --
Aug 18 21:58:36 swoop systemd[1]: Started ezbeq.

3. reboot and repeat step 2 to verify the recorder has automatically started