From 257dab8d7fe9714da343106f2c97eaf0e77bbc48 Mon Sep 17 00:00:00 2001 From: leukipp Date: Sun, 2 Feb 2025 23:49:41 +0100 Subject: [PATCH] docs: add hardware --- HARDWARE.md | 47 ++++++++++++++++++++++++++++------------------- 1 file changed, 28 insertions(+), 19 deletions(-) diff --git a/HARDWARE.md b/HARDWARE.md index c3714e6..d621470 100644 --- a/HARDWARE.md +++ b/HARDWARE.md @@ -1,36 +1,45 @@ -# TouchKio - Supported Hardware +# Supported Hardware This document contains an incomplete list of device and display hardware combinations that are either intended to be tested or have already been tested. -The [release](https://github.com/leukipp/touchkio/releases) page has builds exclusively for **arm64** and **x64**, but custom builds for other architectures can be made (see [Development](https://github.com/leukipp/touchkio?tab=readme-ov-file#development)), allowing the application to operate on any hardware. +The [release](https://github.com/leukipp/touchkio/releases) page has builds exclusively for **arm64** and **x64**, but custom builds for other architectures can be made (see [development](https://github.com/leukipp/touchkio?tab=readme-ov-file#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 properly as well. +| | Status | Notes | +| --- | --------------------- | ------------------------------------------------------------------------- | +| ⬜ | Unknown | Who knows. | +| 🟩 | 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. | +| ⬛ | Crashed | The house is on fire. | + ### DSI -| Device | Display | Tested | Status | Notes | -| -------------- | ----------------------------------------------------------------------------------------------- | ------ | ----------------- | ---------------------------------------------------------------- | -| Raspberry Pi 3 | [Official 7" Touch Display 1](https://www.raspberrypi.com/products/raspberry-pi-touch-display/) | ❌ | Unknown | 99% chance that it is slow and the resolution sucks. | -| Raspberry Pi 3 | [Official 7" Touch Display 2](https://www.raspberrypi.com/products/touch-display-2/) | ❌ | Unknown | 99% chance that it is slow. | -| Raspberry Pi 4 | [Official 7" Touch Display 1](https://www.raspberrypi.com/products/raspberry-pi-touch-display/) | ❌ | Unknown | 99% chance that the resolution sucks. | -| Raspberry Pi 4 | [Official 7" Touch Display 2](https://www.raspberrypi.com/products/touch-display-2/) | ❌ | Optimistic | 99% chance that it fully works. | -| Raspberry Pi 5 | [Official 7" Touch Display 1](https://www.raspberrypi.com/products/raspberry-pi-touch-display/) | ❌ | Unknown | 99% chance that the resolution sucks. | -| Raspberry Pi 5 | [Official 7" Touch Display 2](https://www.raspberrypi.com/products/touch-display-2/) | ✅ | Fully operational | Working display power, brightness and keyboard control via MQTT. | +| Device | System | Display | Status | +| ---------------------- | -------------------------------------- | --------------------------------------------------------------------------------------------------------- | ------ | +| Raspberry Pi 3 (arm64) | Raspberry Pi OS (64-bit), Wayland, X11 | [Official 7" Touch Display 1 (800x480)](https://www.raspberrypi.com/products/raspberry-pi-touch-display/) | ⬜ | +| Raspberry Pi 3 (arm64) | Raspberry Pi OS (64-bit), Wayland, X11 | [Official 7" Touch Display 2 (720x1280)](https://www.raspberrypi.com/products/touch-display-2/) | ⬜ | +| Raspberry Pi 4 (arm64) | Raspberry Pi OS (64-bit), Wayland, X11 | [Official 7" Touch Display 1 (800x480)](https://www.raspberrypi.com/products/raspberry-pi-touch-display/) | 🟩 | +| Raspberry Pi 4 (arm64) | Raspberry Pi OS (64-bit), Wayland, X11 | [Official 7" Touch Display 2 (720x1280)](https://www.raspberrypi.com/products/touch-display-2/) | 🟩 | +| Raspberry Pi 5 (arm64) | Raspberry Pi OS (64-bit), Wayland, X11 | [Official 7" Touch Display 1 (800x480)](https://www.raspberrypi.com/products/raspberry-pi-touch-display/) | 🟩 | +| Raspberry Pi 5 (arm64) | Raspberry Pi OS (64-bit), Wayland, X11 | [Official 7" Touch Display 2 (720x1280)](https://www.raspberrypi.com/products/touch-display-2/) | 🟩 | ### HDMI -| Device | Display | Tested | Status | Notes | -| -------------- | -------------------------------------------------------------------------------- | ------- | --------------------- | ------------------------------------------------------------------ | -| Raspberry Pi 4 | [LAFVIN 5" Touch Display](https://www.amazon.de/gp/product/B0BWJ8YP7S) | ✅ | Partially operational | Display brightness control is not available via MQTT. | -| Raspberry Pi 5 | Generic Non-Touch | ✅ | Partially operational | Display brightness control is not available via MQTT. | -| Generic Ubuntu | Generic Non-Touch | ✅ | Partially operational | Display brightness and keyboard control is not available via MQTT. | -| Raspberry Pi 5 | [GeeekPi 10.1" Capacitive Touch / 1280X800](https://www.amazon.nl/dp/B0DHV6DZC1) | ✅ | Partially operational | Display brightness control is not available via MQTT, Working Display power | - +| Device | System | Display | Status | +| ---------------------- | -------------------------------------- | -------------------------------------------------------------------------------- | ------ | +| Raspberry Pi 4 (arm64) | Raspberry Pi OS (64-bit), Wayland, X11 | [LAFVIN 5" Touch Display (800x480)](https://www.amazon.de/gp/product/B0BWJ8YP7S) | 🟨 | +| Raspberry Pi 5 (arm64) | Raspberry Pi OS (64-bit), Wayland, X11 | [GeeekPi 10.1" Capacitive Touch (1280x800)](https://www.amazon.nl/dp/B0DHV6DZC1) | 🟨 | +| Raspberry Pi 5 (arm64) | Raspberry Pi OS (64-bit), Wayland, X11 | Generic Non-Touch | 🟨 | +| Generic PC (x64) | Ubuntu (64-bit), X11 | Generic Non-Touch | 🟧 | +| Generic PC (x64) | Ubuntu (64-bit), Wayland | Generic Non-Touch | 🟥 | ## 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. +The only problems that may arise are when controlling the display or keyboard via the Home Assistant integration. - If you encounter any problems, please create a new [issue](https://github.com/leukipp/touchkio/issues). - If you encounter any problems and are able to fix it yourself, feel free to create a [pull request](https://github.com/leukipp/touchkio/pulls). -- If everything works as expected and your hardware is not yet listed, you are welcome to add it and create a [pull request](https://github.com/leukipp/touchkio/pulls). +- If everything works as expected and your hardware is not yet listed, you are welcome to [report](https://github.com/leukipp/touchkio/issues/12) it or create a [pull request](https://github.com/leukipp/touchkio/pulls).