22 KiB
22 KiB
Supported Hardware
This document contains an incomplete list of device and display hardware combinations that have already been tested.
The release page has builds exclusively for arm64 and x64, but custom builds for other architectures can be made (see development), allowing the application to operate on any hardware. At least the minimal features, such as displaying a kiosk window (which doesn't necessarily need to be Home Assistant) will work.
Hardware
If you are running Linux with a graphical user interface (Wayland or X11), you should be well equipped to use the application. Additionally, any single board computer (SBC) clones of the Raspberry Pi that operate on Raspberry Pi OS (64-bit) are likely to function as well.
| Status | Notes | |
|---|---|---|
| 🟩 | Fully operational | Working display power, brightness and keyboard control via MQTT. |
| 🟨 | Partially operational | Display brightness control is not available via MQTT. |
| 🟧 | Partially operational | Display brightness and keyboard control is not available via MQTT. |
| 🟥 | Partially operational | Display power, brightness and keyboard control is not available via MQTT. |
| ⬜ | Somehow operational | Issues can occur and the overall performance is very slow. |
| ⬛ | Not operational | The house is on fire. |
DSI
| Device | System | Display | Status |
|---|---|---|---|
| Raspberry Pi 3 (arm64) | Raspberry Pi OS (64-bit), Wayland, X11 | Official 7" Touch Display 1 (800x480) | ⬜ |
| Raspberry Pi 3 (arm64) | Raspberry Pi OS (64-bit), Wayland, X11 | Official 7" Touch Display 2 (720x1280) | ⬜ |
| Raspberry Pi 4 (arm64) | Raspberry Pi OS (64-bit), Wayland, X11 | Official 7" Touch Display 1 (800x480) | 🟩 |
| Raspberry Pi 4 (arm64) | Raspberry Pi OS (64-bit), Wayland, X11 | Official 7" Touch Display 2 (720x1280) | 🟩 |
| Raspberry Pi 5 (arm64) | Raspberry Pi OS (64-bit), Wayland, X11 | Official 7" Touch Display 1 (800x480) | 🟩 |
| Raspberry Pi 5 (arm64) | Raspberry Pi OS (64-bit), Wayland, X11 | Official 7" Touch Display 2 (720x1280) | 🟩 |
| Raspberry Pi 5 (arm64) | Raspberry Pi OS (64-bit), Wayland, X11 | Waveshare 10.1" DSI Touch (800x1280) | 🟩 |
| Raspberry Pi 5 (arm64) | Raspberry Pi OS (64-bit), Wayland, X11 | Waveshare 12.3" DSI Touch (720x1920) | 🟩 |
HDMI
| Device | System | Display | Status |
|---|---|---|---|
| Raspberry Pi 4 (arm64) | Raspberry Pi OS (64-bit), Wayland, X11 | LAFVIN Touch Display 5" (800x480) | 🟨 |
| Raspberry Pi 4 (arm64) | Raspberry Pi OS (64-bit), Wayland, X11 | Waveshare 7EP-CAPLCD 7" (1280x800) | 🟨 |
| Raspberry Pi 4 (arm64) | Raspberry Pi OS (64-bit), Wayland, X11 | Waveshare CAPLCD 8" (768x1024) | 🟨 |
| Raspberry Pi 4 (arm64) | Raspberry Pi OS (64-bit), Wayland, X11 | EVICIV 10.1" Touch (1920x1200) | 🟨 |
| Raspberry Pi 4 (arm64) | Raspberry Pi OS (64-bit), Wayland, X11 | Hannspree HT225 21.5" (1920x1080) | 🟨 |
| Raspberry Pi CM 4 (arm64) | Raspberry Pi OS (64-bit), Wayland, X11 | Lenovo ThinkCentre 23.8" (1920x1080) | 🟨 |
| Raspberry Pi 400 (arm64) | Raspberry Pi OS (64-bit), Wayland, X11 | UPerfect Vertical Touch 15.6" (1920x1080) | 🟨 |
| Raspberry Pi 5 (arm64) | Raspberry Pi OS (64-bit), Wayland, X11 | GeeekPi Capacitive Touch 10.1" (1280x800) | 🟨 |
| Raspberry Pi 5 (arm64) | Raspberry Pi OS (64-bit), Wayland, X11 | ELECROW Portable Monitor 10.1" (1280x800) | 🟨 |
| Raspberry Pi 5 (arm64) | Raspberry Pi OS (64-bit), Wayland, X11 | Waveshare Capacitive Touch 14" (2160x1440) | 🟨 |
| Raspberry Pi 5 (arm64) | Raspberry Pi OS (64-bit), Wayland, X11 | Akntzcs Portable Touch HD 16" (1920x1200) | 🟨 |
| Raspberry Pi 5 (arm64) | Raspberry Pi OS (64-bit), Wayland, X11 | Prechen Portable Touch FHD 18.5" (1920x1080) | 🟨 |
| Raspberry Pi 5 (arm64) | Raspberry Pi OS (64-bit), Wayland, X11 | Generic Non-Touch | 🟨 |
| Generic PC (x64) | Debian KDE (64-bit), Wayland, X11 | Generic Non-Touch | 🟧 |
| Generic PC (x64) | Ubuntu XFCE (64-bit), X11 | Generic Non-Touch | 🟧 |
| Generic PC (x64) | Ubuntu GNOME (64-bit), X11 | Generic Non-Touch | 🟧 |
| Generic PC (x64) | Ubuntu GNOME (64-bit), Wayland | Generic Non-Touch | 🟥 |
Features
Minimal features are designed to run on any system without issues:
- A webview kiosk window launched in fullscreen mode and loading the specified
--web-urlwebsite should not cause any problems.
Extended features become available when the --mqtt-* arguments are provided and the hardware is supported:
- If your hardware is not fully compatible there should be no crashes, but you may miss some sensors.
Hardware support is verified during application startup and can be checked in the terminal or in the log file under the Supported section.
The necessary requirements for MQTT sensors to work are listed here:
| Name | Requirements | References |
|---|---|---|
| App (Update) | Requires sudo rights, .deb install and touchkio.service running . |
#70, #77 |
| Display (Status) | Working wlopm, kscreen-doctor or xset command. |
#38, #57 |
| Display (Brightness) | Requires sudo rights, device under /sys/class/backlight/*/brightness exists or working ddcutil command. |
#30, #101 |
| Keyboard | Raspberry Pi OS (Wayland) with squeekboard running. |
#7, #85 |
| Battery | Device under /sys/class/power_supply/*/capacity exists. |
#33 |
| Volume | Device (non-dummy) pactl get-default-sink exists. |
#82 |
| Reboot | Requires password-less sudo rights. |
#39 |
| Shutdown | Requires password-less sudo rights. |
#39 |
FAQ
Operating System
I have installed Ubuntu GNOME.
- On some Debian based systems (e.g. Ubuntu GNOME), the display status control is only available when using X11 (
xset). - GNOME is the least supported window manager.
- It's recommended to switch to KDE wayland, if you want better support for display status control (
kscreen-doctor).
- It's recommended to switch to KDE wayland, if you want better support for display status control (
I have installed Raspberry Pi OS on a RPI3.
- Raspberry Pi 3 devices have produced a bunch of issues in the past.
- It looks like the GPU is not properly supported by Electron.
- Running
touchkio --disable-gpumay improve the situation, but upgrading the hardware is the best solution.
- Running
I want to update APT packages automatically.
- The Package Upgrades MQTT sensor will show if
aptpackage upgrades are available, but updates are intentionally not triggered by TouchKio. - It's recommended to keep your system up to date for security and compatibility, as TouchKio primarily supports the latest OS versions.
- Consider configuring
sudo apt install unattended-upgradesfor automatic updates.
- Consider configuring
Display
Display status can't be controlled through MQTT.
- The following commands are currently implemented to modify the display status. Make sure that one of these works for your display when you run it directly on the terminal, otherwise the MQTT switch will not work either.
wlopm --[on,off] \*(Raspberry Pi OS, Wayland)kscreen-doctor --dpms [on,off](Debian KDE, Wayland)xset dpms force [on,off](Generic, X11)
Display brightness can't be controlled through MQTT.
- Have a look at the features section to check if all requirements are fulfilled.
- The Display MQTT control is a light entity with brightness support. So make sure to to click on the entity to check for brightness support.
- HDMI screens typically do not offer brightness control out of the box, so additional setup steps are required.
- Brightness support for ddcutil is build-in and checked on application startup.
- Alternatively installing ddcci-driver-linux or ddcci-dkms may also work.
- Make sure that one of these works for your display when you run it directly on the terminal, otherwise the MQTT switch will not work either.
sudo cat /sys/class/backlight/*/brightnessreturns some numeric value.sudo ddcutil setvcp 10 42changes the brightness to 42% without asking for a password.
Turning HDMI screen off via MQTT causes it to turn back on.
- There are certain HDMI screens (e.g. Viewsonic) where the MQTT display status command doesn't work as expected.
- The screen immediately turns on again, which may be caused by incompatible HDMI cables being used.
Touch
Automated screen blanking on inactivity.
- You can use Raspberry Pi's build-in screen blanking functionality, however, if the screen is turned on through Home Assistant after being automatically turned off, it will remain on indefinitely.
- It's recommended to either use the built-in screen blanking feature or implement a Home Assistant automation (e.g. presence detection or Last Active MQTT sensor) to manage the screen status.
Touch in multitouch mode not waking the screen.
- It's recommended to use Mouse Emulation for touch screens, otherwise touch based screen wake-up from display off state will fail, especially if build-in screen blanking is disabled.
Touch events may propagate through a display that is turned off.
- It's recommended to use Mouse Emulation for touch screens, otherwise Home Assistant actions could be triggered unintentionally on touch.
Network
Connecting via https/mqtts with a self-signed certificate.
- When connecting to a service with a custom certificate, ensure the specified FQDN matches.
- Using the
--ignore-certificate-errorsflag is not recommended for browsing external sites.
- Using the
Local DNS entries in /etc/hosts are ignored.
- Electron bypasses the system resolver stack, ignoring
/etc/hostsand local DNS servers.- To use the system resolver, modify
~/.config/systemd/user/touchkio.serviceto disable these features:
ExecStart=/usr/bin/touchkio --disable-features=UseDNSHttps,AsyncDns - To use the system resolver, modify
During VNC access the display turns gray.
- On Raspberry Pi OS the display command may fail with
ERROR: Setting power mode for output '[DSI-*,HDMI-*]' failed.- This can happen if you have
wayvncrunning for remote access and is caused by a known bug.
- This can happen if you have
Media
I need Music and Voice Assistant.
- Not planned, look for alternatives.
I need a camera stream from the device.
- Not planned, look for alternatives.
I need additional MQTT entities to control hardware.
- Not planned, look for alternatives.
Dependencies
Some of the MQTT controls are missing.
- Certain features from the MQTT integration may require elevated privileges to work correctly.
- Test if your local user has the necessary permissions to run
sudo -n truewithout being prompted for a password.
- Test if your local user has the necessary permissions to run
The ddcutil command doesn't seem to be used.
- Currently
ddcutilis only used for brightness control of HDMI screens.- Make sure that your screen is supporting continuous adjustments of brightness values.
The on-screen keyboard doesn't automatically pop-out.
- Most of the available on-screen keyboards will not render above any fullscreen window.
- There is a workaround for
squeekboard, which will only work on Raspberry Pi OS.- If the on-screen keyboard still doesn't automatically pop-out when entering a text field inside the webview you can use the side widget to toggle the visibility.
Errors
Terminal is full with "ERROR:gbm_wrapper.cc" messages.
- On the terminal you may see some ERROR:gbm_wrapper.cc messages.
- This appears to be a known issue that currently lacks a fix, but the webview still works.
CPU and RAM usage increases without reason.
- This was especially observed when the screen is permanently on and renders a dashboard with interactive elements (e.g. custom lovelace cards).
- Switching to another Page Url or turning the Display off during idle times improves resource usage.
- Alternatively a timed Refresh of the webview via MQTT can also help.
Error message "GPU Process abnormal-exit".
- GPU Process abnormal-exit (code 512) means that the Electron GPU process crashed, probably caused by some issues inside the webview.
- Disabling the GPU via
touchkio --disable-gpumay help.
- Disabling the GPU via
Error message "Render Process killed".
- Render Process killed (code 9) will lead to a temporary white screen.
- The problem likely stems from Electron’s calculated RAM limit (~2GB) and the dashboard using too much memory.
- Although there are flags to increase the limit, a standard webview shouldn’t require that much RAM.
Contributions
In case your hardware is not listed above don't worry, give it a try.
Running touchkio --web-url=https://demo.home-assistant.io will most likely just work.
The only problems that may arise are when controlling the display via the Home Assistant integration.
There is a possibility to test pre-releases if you would like to try upcoming versions before the official release is published.
These early builds are available to a smaller group of users who have chosen to take part in testing.
If you are interested in long-term testing, check out the related help request. When a pre-release is available and you want to test it on-demand, run:
bash <(wget -qO- https://raw.githubusercontent.com/leukipp/touchkio/main/install.sh) update early
- If you encounter any problems, please create a new issue.
- If you encounter any problems and are able to fix it yourself, feel free to create a pull request.
- If everything works as expected and your hardware is not yet listed, you are welcome to report it or create a pull request.