This is a port of 9and3r's original TFT Touchscreen extension for Mopidy to Mopidy 3.2, Python3 and SDL2. A number of other changes have been applied as well, see below. But it still looks the same:
Extension for displaying track info and controlling Mopidy from a touch screen using PyGame/SDL.
Album Cover images are downloaded from the Cover Art Archive https://coverartarchive.org/ with the help of MusicBrainz https://musicbrainz.org/ and the musicbrainzngs module https://python-musicbrainzngs.readthedocs.io/en/v0.7.1/
Mopidy>= 3.2Pykka>= 3.0pygame>= 2.1musicbrainzngs>= 0.7.1SDL2>= 2.0.21 (see below for required patch)
Install by running:
python3 setup.py install
Before starting Mopidy, you must add configuration for Mopidy-Touchscreen to your Mopidy configuration file:
[touchscreen] enabled = true screen_width = 320 screen_height = 240 resolution_factor = 8 cursor = True fullscreen = False cache_dir = $XDG_CACHE_DIR/mopidy/touchscreen
The following configuration values are available:
touchscreen/enabled: If the Touchscreen extension should be enabled or not.touchscreen/screen_width: The width of the resolution you want to use in pixels.touchscreen/screen_height: The width of the resolution you want to use in pixels.touchscreen/resolution_factor: This value sets how big content is shown. Smaller values will make content bigger and less content will be displayed at once.touchscreen/cursor: If the mouse cursor should be shown. (If you use a touchscreen it should be false)touchscreen/fullscreen: If you want to be shown as a window or in fullscreen.touchscreen/cache_dir: The folder to be used as cache. Defaults to$XDG_CACHE_DIR/mopidy/touchscreen, which usually means ~/.cache/mopidy/touchscreen`sdl_videodriver: Sets theSDL_VIDEODRIVERenvironment variable.sdl_video_render_driver: Sets the renderer for the video driver (e.g.,opengl,opengles,opengles2orsoftware) via theSDL_RENDER_DRIVERenvironment variable.sdl_video_device_index: Sets the number of the DRI device, if libSDL2 has been patched accordingly to support theSDL_VIDEO_DEVICEenv var (counts from zero, which is usually the HDMI output of an RPi)sdl_video_device: Sometimes the numbering is not stable, though. Use the basename of /dev/dri/by-path/platform-*-card for persistent names over reboots.sdl_audiodriver: Sets theSDL_AUDIODRIVERenvironment variablesdl_path_dsp: Sets theSDL_PATH_DSPenvironment variablesdl_mousedriver: Sets theSDL_MOUSEDRVenvironment variable. This has been renamed fromsdl_mousdrvsdl_mousedev: Sets theSDL_MOUSEDEVenvironment variable. This has been renamed fromsdl_mousdev.start_screen: The menu screen Mopidy shows on start can be configured. Valid options aresearch,player,tracklist,library,playlistsandmenumain_screen: This is the menu screen Mopidy will return to after twenty seconds of no tap, button or key press. Choices as withstart_screen, plusnoneto disable.
Use the basic configuration to setup as most standard screens works fine without further configuration.
It's recommended to create an unprivileged user mopdiy. Add this user to the video and input groups.
If you are using a LCD Shield in Raspberry Pi you need to config your LCD:
Framebuffer devices are about to go away and being replaced by KMSDRM. As of now (March 2022, Debian release 11,
"bullseye"), you'll have to modify and build libSDL from Git, as the one delivered with Debian stale crashes, and even
the upstream version does not support multiple display adapters yet. The latter can be rectified with PR 5276 by user
"substring", libsdl-org/SDL#5276 A rebased version of the patch for 6d1c3cd is in file
sdl2-device-index-env.diff in this repository.
Debian "bullseye" does not come with a device tree overlay for the ILI9341 tinydrm driver yet (rpi-display is for the
old framebuffer driver.) The file ili9341-tiny-display.dts contains the source of an adjusted overlay file, based
on a suggestion by user "6by9" of forums.raspberrypi.com. Unfortunately, it doesn't allow setting the brightness of the
backlight, only turning it on.
Compile the overlay with
dtc -I dts ili9341-tiny-display.dts -o /boot/overlays/ili9341-tiny-display.dtbo -O dtb
And configure the driver in /boot/config.txt, for example with:
dtoverlay=ili9341-tiny-display
The overlay comes with support for an ADS7846 touch controller on SPI 1.
Add to the config the next variables:
[touchscreen] sdl_videodriver = kmsdrm sdl_video_render_driver = software sdl_video_device = platform-3f204000.spi-cs-0-card
This is just an example. It may work but each LCD Shield seems to have its own configuration.
Native GPIO support has been removed, you can define GPIO inputs as input devices in /boot/config.txt these days, for example:
dtoverlay=gpio-key,gpio=13,keycode=105,active_low=1,gpio_pull=up # left dtoverlay=gpio-key,gpio=6,keycode=106,active_low=1,gpio_pull=up # right dtoverlay=gpio-key,gpio=19,keycode=103,active_low=1,gpio_pull=up # up dtoverlay=gpio-key,gpio=26,keycode=108,active_low=1,gpio_pull=up # down dtoverlay=gpio-key,gpio=1,keycode=28,active_low=1,gpio_pull=up # enter dtoverlay=gpio-key,gpio=0,keycode=114,active_low=1,gpio_pull=up # - dtoverlay=gpio-key,gpio=5,keycode=115,active_low=1,gpio_pull=up # + dtoverlay=gpio-key,gpio=3,keycode=116,active_low=1,gpio_pull=up # shutdown
The actual GPIO port (BCM numbering for RPi) depends on your wiring. See https://pinout.xyz/ if unsure.
As you can see from this example, pins should be active low (ie, button press connects the pin to ground)
The audio setup has changed with bullseye, if you're using the current VC4 (vc4-kms-v3d) DRM video driver and
need HDMI sound output. In this case you may want to disable the BCM2835 line out by commenting out
dtparam=audio=on in /boot/config.txt. More importantly, VC4 HDMI audio has no built-in conversion from any
commonly used data formats, it expects all sound data in IEC958 LE ("raw" S/PDIF) format. Do not use the legacy
FKMS (/dev/fb*) based vc4-fkms-v3d driver, it will stop working eventually. Raspberrypi OS comes with an ALSA
configuration that contains a converter, but it's a PITA to use. I'm using pulseaudio run as a system service, here's
a systemd unit file:
[Unit] Description=PulseAudio Daemon [Install] WantedBy=sound.target [Service] Type=simple PrivateTmp=true ExecStart=/usr/bin/pulseaudio --system --realtime --no-cpu-limit
Don't forget to set up the Unix groups properly as described in https://www.freedesktop.org/wiki/Software/PulseAudio/Documentation/User/SystemWide/
You can use it with a touchscreen or mouse clicking on the icons.
In case you are using a keyboard use arrow keys to navigate and enter to select. The GPIO and LIRC (IR remote control) buttons simulate keyboard keys so the use is exactly the same as using a keyboard.
- See track info (track name, album, artist, cover image)
- Seek Track
- Play/Pause/Stop
- Mute/Unmute
- Change volume
- Next/Previous track
- Library
- Menu (exit mopidy, restart...)
- Shuffle on/off
- Repeat one/on/off
- Playback list and song selection
- Playlists
- Use keyboard. GPIO buttons or IR remote control instead of touchscreen
Example video running the extension
- 9and3r (http://github.com/9and3r): Original author and maintainer for many years. Thanks!
- Joerg Reuter (http://github.com/woelfisch): Port to Python 3, Mopidy 3.2, bug fixes, new bugs
- libSDL2 has support for KMSDRM now. Yay. libSDL2 still needs a patch to use other video devices than the first. Boo. Supporting additional SDL environment variables
- Added rebase of said patch
- Subsequently, removed support for /dev/fb* again
- Removed evdev support again, SDL2 handles the GPIO keys and lirc/ir_keytable remotes just fine
- Added device tree overlay source for tinydrm version of the ILI9341 driver
- move pygame initialization to pygame event loop thread as neither pygame nor SDL is thread safe and eglMakeCurrent may throw an EGL_BAD_ACCESS exception on pygame.display.blit()
- Updated instructions
- last.fm cover art service has been dead for how long? Use MusicBrainz.
- Code cleanup
- Require Mopidy v3.2.x and Python 3.7
- Restructure source code to avoid circular imports
- Adjust to current Mopidy Core API
- Port to Python 3 (mainly fix formerly implicit float to int conversions)
- Use Enums god*mmit...
- Search for Artist and Album broken, apparently Mopidy Core issue
- Write directly to framebuffer device
- Add support to automatically return to configurable menu screen
- Make start menu screen configurable
- Add more LIRC / Keyboard actions
- Support evdev (LIRC uinput, gpio-key drivers) devices
- Drop GPIO driver
- Require Mopidy v1.0
- Update to work with changed core playback API in Mopidy 1.0
- Search working
- GPIO and Keyboard support
- Resolution factor to adapt the interface for different screen sizes (Thanks to Syco54645)
- Background image
- Lower CPU usage (Update screen only when needed)
- Bug Fixes
- Bug Fixes
- UI changes
- Smooth text scrolling
- Search albums, artist or songs (Not fully implemented. Basic functionality)
- Font will be included on installation
- First working version