build: update version

.github/FUNDING.yaml

@@ -0,0 +1 @@
+github: leukipp

.gitignore

@@ -1,3 +1,4 @@
 node_modules/
 docs/
-out/
+out/
+build.json

HARDWARE.md

@@ -29,25 +29,62 @@ If you are running Linux with a graphical user interface (Wayland or X11), you s
 ### HDMI
 | 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 4 (arm64)    | Raspberry Pi OS (64-bit), Wayland, X11 | [LAFVIN Touch Display 5" (800x480)](https://www.amazon.de/gp/product/B0BWJ8YP7S)                                      | 🟨      |
-| Raspberry Pi 4 (arm64)    | Raspberry Pi OS (64-bit), Wayland, X11 | [Waveshare 8" CAPLCD (768x1024)](https://www.waveshare.com/wiki/8inch_768x1024_LCD)                                   | 🟨      |
+| Raspberry Pi 4 (arm64)    | Raspberry Pi OS (64-bit), Wayland, X11 | [Waveshare 7EP-CAPLCD 7" (1280x800)](https://www.waveshare.com/7ep-caplcd.htm)                                        | 🟨      |
-| Raspberry Pi 4 (arm64)    | Raspberry Pi OS (64-bit), Wayland, X11 | [Waveshare 7" 7EP-CAPLCD (1280x800)](https://www.waveshare.com/7ep-caplcd.htm)                                        | 🟨      |
+| Raspberry Pi 4 (arm64)    | Raspberry Pi OS (64-bit), Wayland, X11 | [Waveshare CAPLCD 8" (768x1024)](https://www.waveshare.com/wiki/8inch_768x1024_LCD)                                   | 🟨      |
 | Raspberry Pi 4 (arm64)    | Raspberry Pi OS (64-bit), Wayland, X11 | [Hannspree HT225 21.5" (1920x1080)](https://www.hannspree.eu/product/HT-225-HPB)                                      | 🟨      |
-| Raspberry Pi 400 (arm64)  | Raspberry Pi OS (64-bit), Wayland, X11 | [UPerfect Vertical Touch 15.6" (1920x1080)](https://uperfect.com/products/uperfect-y-vertical-monitor-15-6)           | 🟨      |
 | Raspberry Pi CM 4 (arm64) | Raspberry Pi OS (64-bit), Wayland, X11 | [Lenovo ThinkCentre 23.8" (1920x1080)](https://psref.lenovo.com/Detail/ThinkCentre_Tiny_In_One_24_Gen_5?M=12NBGAT1EU) | 🟨      |
-| 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 400 (arm64)  | Raspberry Pi OS (64-bit), Wayland, X11 | [UPerfect Vertical Touch 15.6" (1920x1080)](https://uperfect.com/products/uperfect-y-vertical-monitor-15-6)           | 🟨      |
-| Raspberry Pi 5 (arm64)    | Raspberry Pi OS (64-bit), Wayland, X11 | [Prechen Portable Touch 18.5" FHD (1920x1080)](https://www.amazon.de/dp/B0CT2KLDBQ)                                   | 🟨      |
+| Raspberry Pi 5 (arm64)    | Raspberry Pi OS (64-bit), Wayland, X11 | [GeeekPi Capacitive Touch 10.1" (1280x800)](https://www.amazon.nl/dp/B0DHV6DZC1)                                      | 🟨      |
-| Raspberry Pi 5 (arm64)    | Raspberry Pi OS (64-bit), Wayland, X11 | [Akntzcs Portable Touch 16" HD (1920x1200)](https://www.amazon.com/dp/B0CTGW6MQ6)                                     | 🟨      |
 | Raspberry Pi 5 (arm64)    | Raspberry Pi OS (64-bit), Wayland, X11 | [ELECROW Portable Monitor 10.1" (1280x800)](https://www.amazon.co.uk/dp/B0BHHQLKPY)                                   | 🟨      |
+| Raspberry Pi 5 (arm64)    | Raspberry Pi OS (64-bit), Wayland, X11 | [Waveshare Capacitive Touch 14" (2160x1440)](https://www.waveshare.com/14inch-2160x1440-lcd.htm)                      | 🟨      |
+| Raspberry Pi 5 (arm64)    | Raspberry Pi OS (64-bit), Wayland, X11 | [Akntzcs Portable Touch HD 16" (1920x1200)](https://www.amazon.com/dp/B0CTGW6MQ6)                                     | 🟨      |
+| Raspberry Pi 5 (arm64)    | Raspberry Pi OS (64-bit), Wayland, X11 | [Prechen Portable Touch FHD 18.5" (1920x1080)](https://www.amazon.de/dp/B0CT2KLDBQ)                                   | 🟨      |
 | 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-url` website should not cause any problems.
+- When connecting to an internal HTTPS site with a self-signed certificate, ensure the specified FQDN matches. Using the `--ignore-certificate-errors` flag is [not recommended](https://github.com/leukipp/touchkio/issues/76) for browsing external sites.
+
+**Extended features** become available when the `--mqtt-*` arguments are provided and the hardware is supported:
+
+- 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)
+- If your hardware is not fully compatible there should be no crashes, but you may miss some sensors.
+  - On some Debian based systems (e.g. Ubuntu GNOME), the display status control is only available when using X11 (`xset`).
+- There are certain HDMI screens (e.g. Viewsonic) where the display status command doesn't work as expected.
+  - The screen [immediately turns on again](https://github.com/leukipp/touchkio/issues/38), which may be caused by incompatible HDMI cables being used.
+- 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 `wayvnc` running for remote access and is caused by a [known bug](https://github.com/leukipp/touchkio/issues/78).
+- Certain commands from the MQTT integration may require elevated privileges to work correctly.
+  - Ensure that your local user has the [necessary permissions](https://github.com/leukipp/touchkio/issues/39) to run `sudo` without being prompted for a password.
+
+Hardware support is verified during application startup and can be seen 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](https://github.com/leukipp/touchkio/issues/70), [#77](https://github.com/leukipp/touchkio/issues/77) |
+| Display (Status)     | Working `wlopm`, `kscreen-doctor` or `xset` command.                    | [#38](https://github.com/leukipp/touchkio/issues/38), [#57](https://github.com/leukipp/touchkio/issues/57) |
+| Display (Brightness) | Device under `/sys/class/backlight/*/brightness` exists.                | [#30](https://github.com/leukipp/touchkio/issues/30), [#32](https://github.com/leukipp/touchkio/issues/32) |
+| Keyboard             | Raspberry Pi OS (Wayland) with `squeekboard` running.                   | [#7](https://github.com/leukipp/touchkio/issues/7), [#85](https://github.com/leukipp/touchkio/issues/85)   |
+| Battery              | Device under `/sys/class/power_supply/*/capacity` exists.               | [#33](https://github.com/leukipp/touchkio/issues/33)                                                       |
+| Volume               | Device (non-dummy) `pactl get-default-sink` exists.                     | [#82](https://github.com/leukipp/touchkio/issues/82)                                                       |
+| Reboot               | Requires password-less `sudo` rights.                                   | [#39](https://github.com/leukipp/touchkio/issues/39)                                                       |
+| Shutdown             | Requires password-less `sudo` rights.                                   | [#39](https://github.com/leukipp/touchkio/issues/39)                                                       |
+
+
 ## 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 or keyboard via the Home Assistant integration.
+The only problems that may arise are when controlling the display 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).

README.md

@@ -1,4 +1,10 @@
 # TouchKio
+![build](https://img.shields.io/github/actions/workflow/status/leukipp/touchkio/release.yaml?style=flat-square)
+![date](https://img.shields.io/github/release-date/leukipp/touchkio?style=flat-square)
+![platform](https://img.shields.io/badge/platform-%20arm64%20|%20x64%20-teal?style=flat-square)
+![downloads](https://img.shields.io/github/downloads/leukipp/touchkio/total?style=flat-square)
+[![sponsor](https://img.shields.io/github/sponsors/leukipp?color=red&logo=github&style=flat-square)](https://github.com/sponsors/leukipp)
+
 **TouchKio** is a Node.js application that utilizes Electron to create a kiosk mode window specifically designed for a Home Assistant dashboard.
 This tool is packaged as a **.deb** file, making it easy to launch the kiosk application on any Debian based Linux [hardware](https://github.com/leukipp/touchkio/blob/main/HARDWARE.md) (e.g. **Raspberry Pi**) equipped with a **DSI or HDMI** Touch Display.
 Additional releases for other Linux systems are available as **.zip** file.
@@ -12,18 +18,21 @@ Moreover, the device running the **kiosk application** also offers several **Hom
 - [x] Fast and easy setup.
 - [x] Remember login credentials.
 - [x] Touch optimized web browsing.
+- [x] Dynamic window status bar layout.
 - [x] Side panel widget for kiosk control.
 - [x] Navigation bar to switch between pages.
-- [x] Configurable browser zoom and theme support. 
+- [x] Adjustable browser zoom and theme support.
 - [x] Extended touch screen wake-up functionality.
 - [x] Remote controllable via MQTT.
-  - [x] Manage kiosk window status.
   - [x] Toggle the on-screen keyboard.
   - [x] Touch display power and brightness.
+  - [x] Manage kiosk window status and zoom.
+  - [x] Show network interfaces and addresses.
+  - [x] List all available system package upgrades.
   - [x] Multi-webpage switching and url navigation.
-  - [x] Monitor temperature, processor and memory usage.
+  - [x] Audio volume control for connected devices.
   - [x] Execute system reboot and shutdown commands.
-  - [x] Show available system package upgrades.
+  - [x] Monitor battery, temperature, processor and memory usage.
 
 The kiosk application can be executed with command line arguments to load a **Home Assistant dashboard in fullscreen** mode.
 Additionally, a **MQTT endpoint** can be defined, allowing the application to provide controls and sensors for the Linux device and the connected Touch Display.
@@ -43,7 +52,7 @@ For a comprehensive guide on setting up MQTT with Home Assistant, please refer t
 
 ## Installation
 On the first run of the application, you may encounter a **setup procedure** and the Home Assistant **login screen**.
-It's recommended to create a **dedicated user** (local access only) for your kiosk device.
+It's recommended to create a dedicated Home Assistant user (local access only) for your kiosk device.
 
 You might also need a physical keyboard or remote VNC access to input these credentials once.
 If your hardware is [supported](https://github.com/leukipp/touchkio/blob/main/HARDWARE.md) you may be able to activate the on-screen keyboard using the side [widget](https://github.com/leukipp/touchkio/issues/16).
@@ -56,7 +65,6 @@ bash <(wget -qO- https://raw.githubusercontent.com/leukipp/touchkio/main/install
 ```
 Make sure that you run this with your **standard user** and not with root (sudo).
 If you are paranoid, or smart, or both, have a look into the [install.sh](https://github.com/leukipp/touchkio/blob/main/install.sh) script before executing external code on your machine.
-This command can also be re-run to **update** an existing installation to the latest version.
 
 The systemd **user service** is enabled by default and the kiosk application should start automatically the next time you boot.
 If you need manual control use:
@@ -70,9 +78,8 @@ systemctl --user start|stop|status|restart touchkio.service
 When connected via SSH, it's necessary to export the display variables first, as outlined in the [development](https://github.com/leukipp/touchkio?tab=readme-ov-file#development) section.
 The [install.sh](https://github.com/leukipp/touchkio/blob/main/install.sh) script mentioned above performs the following tasks (and you just have to do it manually):
 - [Download](https://github.com/leukipp/touchkio/releases/latest) the latest version file that is suitable for your architecture (arm64 or x64).
-  - Debian (**deb**): Open a terminal and execute the following command to install the application, e.g:
+  - Debian (**deb**): Open a terminal and execute the following command to install the application, e.g: `sudo apt install ./touchkio_1.x.x_arm64.deb && touchkio --setup`
-`sudo apt install ./touchkio_1.x.x_arm64.deb && touchkio --setup`
+  - Others (**zip**): Extract the archive and run the binary, e.g: `unzip touchkio-linux-x64-1.x.x.zip && cd touchkio-linux-x64 && ./touchkio --setup`
-  - Others (**zip**): Extract the archive and run the binary, e.g:  `unzip touchkio-linux-x64-1.x.x.zip && cd touchkio-linux-x64 && ./touchkio --setup`
 - If you just want to load a Home Assistant dashboard without further control you are good to go, e.g: `touchkio --web-url=https://demo.home-assistant.io`
   - The `--web-url` doesn't necessarily need to be a Home Assistant url, any kind of website can be shown in kiosk mode.
   - Only when using the MQTT integration via `--mqtt-*`, a running Home Assistant instance is required.
@@ -89,12 +96,21 @@ yarn build
 
 </div></details>
 
+#### Update
+If you have already installed TouchKio and want to upgrade to the latest version, simply install the newer version over the existing one.
+
+The [install.sh](https://github.com/leukipp/touchkio/blob/main/install.sh) script can also be run to update an existing installation to the **latest version**.
+The setup procedure can be skipped to use the existing default arguments from the configuration file:
+```bash
+bash <(wget -qO- https://raw.githubusercontent.com/leukipp/touchkio/main/install.sh) update
+```
+
 ## Configuration
 Running `touchkio --setup` will prompt you to enter arguments that will be used when the application starts without any specified arguments.
 These default arguments are stored in `~/.config/touchkio/Arguments.json`, where they can also be modified.
 
 ### WEB
-The available arguments to control the kiosk application via terminal are as follows: 
+The available arguments to control the kiosk application via terminal are as follows:
 | Name                      | Default | Description                                                                                                |
 | ------------------------- | ------- | ---------------------------------------------------------------------------------------------------------- |
 | `--web-url` (Required)    | -       | Url of the Home Assistant instance<a id="ref1"></a><sup><a href="#foot1">[1]</a></sup> (HTTP(S)://IP:PORT) |
@@ -113,7 +129,7 @@ touchkio --web-url=http://192.168.1.42:8123 --web-theme=light --web-zoom=1.0
 > You can configure multiple pages by separating them with a comma:
 > `touchkio --web-url=https://demo.home-assistant.io,https://demo.immichkiosk.app`.
 
-In the `~/.config/touchkio/Arguments.json` file: 
+In the `~/.config/touchkio/Arguments.json` file:
 ```json
 {
   "web_url": [
@@ -143,7 +159,7 @@ touchkio --web-url=http://192.168.1.42:8123 --mqtt-url=mqtt://192.168.1.42:1883
 ## User Interface
 TouchKio provides a simple webview window designed specifically for Touch Displays. Electron apps are known to be resource intensive due to their architecture and the inclusion of a full web browser environment. If you just run the kiosk application without other heavy loads, everything should run smoothly.
 
-### Controls
+### Touch Controls
 Additional controls can be found along the right edge of the kiosk application. For more details, you may want to have a closer look here:
 | Name         | Description                                              |
 | ------------ | -------------------------------------------------------- |
@@ -154,14 +170,14 @@ Additional controls can be found along the right edge of the kiosk application.
 
 ### Keyboard Shortcuts
 The application also supports basic shortcuts to enhance navigation and usability for users who prefer or require non-touch input methods:
-| Name                        | Description                 |
+| Name                        | Description                  |
-| --------------------------- | --------------------------- |
+| --------------------------- | ---------------------------- |
-| `Control+Left`              | Navigate to previous page   |
+| `Control+Left`              | Navigate to previous page    |
-| `Control+Right`             | Navigate to next page       |
+| `Control+Right`             | Navigate to next page        |
-| `Control+Num_Subtract`      | Decrease the page zoom      |
+| `Control+Num_Subtract`      | Decrease the page zoom       |
-| `Control+Num_Add`           | Increase the page zoom      |
+| `Control+Num_Add`           | Increase the page zoom       |
-| `Alt+Left`/`Mouse+Back`     | Navigate back in history    |
+| `Alt+Left`/`Mouse+Back`     | Navigate backward in history |
-| `Alt+Right`/`Mouse+Forward` | Navigate forward in history |
+| `Alt+Right`/`Mouse+Forward` | Navigate forward in history  |
 
 ## Development
 To create your own local build, you first need to install [Node.js](https://pimylifeup.com/raspberry-pi-nodejs) and [Yarn](https://classic.yarnpkg.com/lang/en/docs/install).
@@ -181,7 +197,7 @@ To make this permanent, consider adding the export variables into the `~/.bashrc
 
 <details><summary>You probably won't need this.</summary><div></br>
 
-Incorporating custom extensions and external hardware (like motion sensors, ultrasonic sensors, cameras, relays and switches) via **Raspberry Pi's GPIO/USB** involves several steps. 
+Incorporating custom extensions and external hardware (like motion sensors, ultrasonic sensors, cameras, relays and switches) via **Raspberry Pi's GPIO/USB** involves several steps.
 While using external sensors that directly integrate with Home Assistant and by utilizing automation's to interact with **TouchKio via MQTT** is generally easier and **recommended**, here's a rough guide on how to proceed with custom hardware integration:
 
 1. **Install Node.js library**: Use Yarn to add a library that can interact with your hardware (GPIO, USB, etc.):
@@ -208,7 +224,7 @@ While using external sensors that directly integrate with Home Assistant and by
     ```javascript
     const init = async (args) => { ... }
     ```
-    From there, you will need to further refine your code by tinkering with sensor updates. This can be achieved through either periodic update calls or event based triggers. 
+    From there, you will need to further refine your code by tinkering with sensor updates. This can be achieved through either periodic update calls or event based triggers.
 
 </div></details>
 
@@ -216,8 +232,8 @@ While using external sensors that directly integrate with Home Assistant and by
 
 <details><summary>Don't waste your time reading this.</summary><div></br>
 
-The Raspberry Pi's **build-in on-screen keyboard** named `squeekboard` (it squeaks because some *Rust* got inside), is specifically designed for Wayland environments and features a **D-Bus interface** that allows applications to show or hide the keyboard as needed.
+The Raspberry Pi's **build-in on-screen keyboard** named `squeekboard` (it squeaks because some _Rust_ got inside), is specifically designed for Wayland environments and features a **D-Bus interface** that allows applications to show or hide the keyboard as needed.
-The kiosk application interacts with squeekboard via the `D-Bus` object path `/sm/puri/OSK0`, enabling the keyboard to be hidden or shown based on **MQTT** user input or system events. 
+The kiosk application interacts with squeekboard via the `D-Bus` object path `/sm/puri/OSK0`, enabling the keyboard to be hidden or shown based on **MQTT** user input or system events.
 
 The Raspberry Pi's **build-in screen blanking** function uses the command `swayidle -w timeout 600 'wlopm --off \*' resume 'wlopm --on \*' &` inside `~/.config/labwc/autostart` to blank the screen after **10 minutes**.
 The `wlopm --off \*` command changes the `bl_power` value to **4**, when setting the value to **0** the screen will turn on again.
@@ -228,7 +244,7 @@ I managed to achieve this for the `brightness` file by implementing a simple `fs
 However, I found that it **never triggered** for the `bl_power` file.
 Although the file content changes, none of the filesystem listeners where fired.
 This could be due to `swayidle`/`wlopm` performing write actions at a deeper level that are not detectable by file listeners.
-As a result, I went for a **polling solution**, checking the state of the file **every second** for any changes.
+As a result, I went for a **polling solution**, checking the state of the `brightness` and `dpms` file **every second** for any changes.
 While I understand this is not ideal, it's necessary to ensure proper functionality.
 
 The display power status and brightness can be adjusted via the MQTT integration.
@@ -242,9 +258,10 @@ Implementing stronger **security measures** would complicate the setup process a
 When using the kiosk application without initializing the default arguments, you will need to provide them with every command.
 This means that the password may be stored as plain text in various files, such as `touchkio.service`, `~/.bash_history`, etc.
 
-To resolve the issue where the first **touch** on a **turned-off screen** triggers a **click event**  (which could inadvertently activate Home Assistant actions), a workaround needed to be implemented.
+To address the problem where the first **touch** on a **turned-off screen** may trigger a **click event** (which could inadvertently activate Home Assistant actions), a workaround needed to be implemented.
-When the screen **turns off** the **focus** is removed from the kiosk window.
+When the screen **turns on/off**, the timestamps of these events are recorded.
-This way, the first click only turns the screen on and focuses the window, allowing subsequent clicks to work as expected.
+If a touch event is detected and the **timestamp** of the **last screen-off** is more recent than the **last screen-on** timestamp, the touch event is discarded and the screen is turned on instead.
+From that point onward, subsequent touch interactions will function normally as expected.
 
 Additionally, to address the problem that scrolling only works with the **web browser scrollbar** on the right, the application is configured to **simulate a touch device** using `Emulation.setEmitTouchEventsForMouse`.
 This adjustment provides a user experience similar to that of a proper mobile device.
@@ -252,33 +269,31 @@ This adjustment provides a user experience similar to that of a proper mobile de
 </div></details>
 
 ## Issues
-Please have a look into the [hardware](https://github.com/leukipp/touchkio/blob/main/HARDWARE.md) documentation if you ran into any issues. 
+Please review the [hardware](https://github.com/leukipp/touchkio/blob/main/HARDWARE.md) documentation first if you encounter any problems.
-
-**Minimal features** are designed to run on any system without issues:
-- A webview kiosk window launched in fullscreen mode and loading the specified `--web-url` website 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.
-    - On some Debian based systems (e.g. Ubuntu GNOME), the display status control may only be available when using X11.
-- The following commands are currently implemented to modify the display status.
-  - `wlopm --[on]/[off] *` (Raspberry Pi OS, Wayland) 
-  - `kscreen-doctor --dpms [on]/[off]` (Debian KDE, Wayland) 
-  - `xset dpms force [on]/[off]` (Generic, X11) 
 
 **Known Issues** that are by-design or for which there isn't a solution so far:
 - You can use Raspberry Pi's build-in [screen blanking](https://www.raspberrypi.com/documentation/computers/configuration.html#screen-blanking-3) 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) to manage the screen status.
+  - It's recommended to either use the built-in screen blanking feature or implement a Home Assistant [automation](https://www.home-assistant.io/docs/automation/basics) (e.g. presence detection) to manage the screen status.
-- When using a Raspberry Pi, the on-screen keyboard doesn't automatically pop-out when entering a text field inside the webview.
+  - An active VNC session can also interfere with the display state, you can find details about this in the features [section](https://github.com/leukipp/touchkio/blob/main/HARDWARE.md#features).
-  - As a current [workaround](https://github.com/leukipp/touchkio/issues/4) you can use the side [widget](https://github.com/leukipp/touchkio/issues/16) to toggle the keyboard visibility.
+- When using a Raspberry Pi, the on-screen keyboard doesn't [automatically pop-out](https://github.com/leukipp/touchkio/issues/4) when entering a text field inside the webview.
-- Certain commands from the MQTT integration may require elevated privileges to work correctly.
+  - As a current workaround you can use the side [widget](https://github.com/leukipp/touchkio/issues/16) to toggle the keyboard visibility.
-  - Ensure that your local user has the [necessary permissions](https://github.com/leukipp/touchkio/issues/39) to run `sudo` without being prompted for a password. 
+  - There is also an [experimental feature](https://github.com/leukipp/touchkio/issues/85) that uses a special Electron flag to address this problem.
-- On the terminal you may see some *ERROR:gbm_wrapper.cc* messages.
+- On the terminal you may see some _ERROR:gbm_wrapper.cc_ messages.
-  -  This appears to be a [known issue](https://github.com/electron/electron/issues/42322) that currently lacks a fix, but the webview still works.
+  - This appears to be a [known issue](https://github.com/electron/electron/issues/42322) that currently lacks a fix, but the webview still works.
+
+For debugging, stop the service and launch `touchkio` directly on the terminal to monitor the log output in real-time.
+This output is also written into `~/.config/touchkio/logs/main.log` for review.
+
+If you encounter any problems, please [create an issue](https://github.com/leukipp/touchkio/issues) and include the output of `touchkio --version`, additional information's about your system (such as operating system, hardware, etc.) and any relevant log files.
 
 ## Credits
+[Inspired by](https://www.jeffgeerling.com/blog/2024/home-assistant-and-carplay-pi-touch-display-2) the one and only Raspberry Pi Master, Jeff Geerling ([@geerlingguy](https://github.com/geerlingguy)).
+
 Thanks to Sebastian ([@pdsccode](https://github.com/pdsccode)) for his contributions on issues and [community](https://community.home-assistant.io/t/kiosk-mode-for-raspberry-pi-with-touch-display/821196) discussions.
 
-[Inspired by](https://www.jeffgeerling.com/blog/2024/home-assistant-and-carplay-pi-touch-display-2) the one and only Raspberry Pi Master, Jeff Geerling ([@geerlingguy](https://github.com/geerlingguy)).
+If you are looking for hardware or a well-designed mounting solution for the Raspberry Pi Display, check out the [blog post](https://www.thestockpot.net/videos/home-assistant-wall-display) from Dillan Stock ([@TheStockPot-AU](https://www.youtube.com/channel/UCmlzNHg8QiWVutUyFOV2UdQ)).
+
+[![What My Smart Home Was Missing](https://img.youtube.com/vi/uTxURzmrVtA/maxresdefault.jpg)](https://www.youtube.com/watch?v=uTxURzmrVtA)
 
 ## License
 [MIT](https://github.com/leukipp/touchkio/blob/main/LICENSE)

forge.config.js

@@ -1,4 +1,22 @@
 const fs = require("fs");
+const jszip = require("jszip");
+const crypto = require("crypto");
+const path = require("path");
+
+const date = new Date().toISOString();
+
+const generateBuildFile = (platform, arch, maker) => {
+  const package = fs.readFileSync(path.join(__dirname, "package.json"), "utf8");
+  const hash = crypto.createHash("sha256").update(package);
+  const data = {
+    id: hash.digest("hex").slice(-6),
+    platform: platform,
+    arch: arch,
+    maker: maker,
+    date: date,
+  };
+  return JSON.stringify(data, null, 2);
+};
 
 module.exports = {
   packagerConfig: {
@@ -33,10 +51,25 @@ module.exports = {
     },
   ],
   hooks: {
+    postPackage: async (config, results) => {
+      for (const outputPath of results.outputPaths) {
+        const [name, platform, arch] = path.basename(outputPath).split("-");
+        const buildFile = path.join(outputPath, "resources", "app", "build.json");
+        fs.writeFileSync(buildFile, generateBuildFile(platform, arch, "deb"), { encoding: "utf8" });
+      }
+    },
     postMake: async (config, results) => {
       for (const result of results) {
         const artifacts = [];
-        result.artifacts.forEach((artifact) => {
+        for (const artifact of result.artifacts) {
+          if (artifact.includes(".zip")) {
+            const [name, platform, arch] = path.basename(artifact).split("-");
+            const buildFile = path.join(`${name}-${platform}-${arch}`, "resources", "app", "build.json");
+            const options = { type: "nodebuffer", compression: "DEFLATE", compressionOptions: { level: 9 } };
+            const zip = await jszip.loadAsync(fs.readFileSync(artifact));
+            zip.file(buildFile, generateBuildFile(platform, arch, "zip"));
+            fs.writeFileSync(artifact, await zip.generateAsync(options));
+          }
           if (artifact.includes("amd64")) {
             const renamed = artifact.replace("amd64", "x64");
             fs.renameSync(artifact, renamed);
@@ -44,7 +77,7 @@ module.exports = {
           } else {
             artifacts.push(artifact);
           }
-        });
+        }
         result.artifacts = artifacts;
       }
     },

html/navigation.html

@@ -32,8 +32,8 @@
         align-items: center;
         width: 100vw;
         height: 100vh;
-        padding: 0 30px;
+        padding: 0 10px;
-        column-gap: 20px;
+        column-gap: 10px;
         list-style-type: none;
         border-top: 1px solid var(--border-color);
         background: var(--background-color);
@@ -74,6 +74,7 @@
         padding: 6px 10px;
         border-radius: 4px;
         font-size: 18px;
+        font-family: sans-serif;
         outline: none;
         border: none;
         cursor: text;
@@ -132,7 +133,7 @@
       </li>
       <li class="separator"></li>
       <li class="dynamic">
-        <input id="url" type="text" spellcheck="false" />
+        <input id="url" type="text" spellcheck="false" readonly="true" />
       </li>
       <li class="separator"></li>
       <li>
@@ -187,6 +188,9 @@
           });
         });
         document.querySelectorAll("input").forEach((input) => {
+          input.addEventListener("blur", (e) => {
+            ipcRenderer.send("input-blur", { id: e.target.id });
+          });
           input.addEventListener("focus", (e) => {
             ipcRenderer.send("input-focus", { id: e.target.id });
           });
@@ -205,16 +209,21 @@
         ipcRenderer.on("button-hidden", (e, button) => {
           document.getElementById(button.id).parentNode.classList.toggle("hidden", button.hidden);
         });
-        ipcRenderer.on("input-blur", (e, input) => {
+        ipcRenderer.on("input-readonly", (e, input) => {
-          document.getElementById(input.id).blur();
+          document.getElementById(input.id).readOnly = input.readonly;
-        });
-        ipcRenderer.on("input-select", (e, input) => {
-          document.getElementById(input.id).select();
         });
         ipcRenderer.on("input-text", (e, input) => {
           document.getElementById(input.id).value = input.text;
           document.getElementById(input.id).placeholder = input.placeholder;
         });
+        ipcRenderer.on("input-select", (e, input) => {
+          window.getSelection()?.removeAllRanges();
+          if (input.select) {
+            document.getElementById(input.id).select();
+          } else {
+            document.getElementById(input.id).blur();
+          }
+        });
         ipcRenderer.on("data-theme", (e, data) => {
           document.documentElement.setAttribute("data-theme", data.theme);
         });

html/pager.html

@@ -3,8 +3,6 @@
   <head>
     <style>
       [data-theme="hidden"] {
-        --primary-color: rgba(0, 0, 0, 0);
-        --border-color: rgba(0, 0, 0, 0);
         --background-color: rgba(0, 0, 0, 0);
       }
       ::-webkit-scrollbar {

html/status.html

@@ -0,0 +1,161 @@
+<!doctype html>
+<html>
+  <head>
+    <style>
+      [data-theme="dark"] {
+        --primary-color: rgba(229, 229, 229, 1);
+        --background-color: rgba(66, 67, 68, 1);
+        --minimize-color: rgba(52, 199, 89, 1);
+        --fullscreen-color: rgba(255, 149, 0, 1);
+        --terminate-color: rgba(255, 59, 48, 1);
+      }
+      [data-theme="light"] {
+        --primary-color: rgba(26, 26, 26, 1);
+        --background-color: rgba(237, 236, 235, 1);
+        --minimize-color: rgba(52, 199, 89, 1);
+        --fullscreen-color: rgba(255, 149, 0, 1);
+        --terminate-color: rgba(255, 59, 48, 1);
+      }
+      ::-webkit-scrollbar {
+        display: none;
+      }
+      * {
+        margin: 0;
+        padding: 0;
+        cursor: pointer;
+      }
+      body {
+        display: flex;
+        align-items: center;
+        width: 100vw;
+        height: 100vh;
+        background: var(--background-color);
+      }
+      header {
+        display: flex;
+        align-items: center;
+        flex: 1 1 0%;
+        height: 100vh;
+        -webkit-app-region: drag;
+      }
+      h1 {
+        position: absolute;
+        transform: translate(-50%, -50%);
+        top: 50%;
+        left: 50%;
+        font-size: 18px;
+        font-weight: 500;
+        font-family: sans-serif;
+        overflow: hidden;
+        white-space: nowrap;
+        text-overflow: ellipsis;
+        text-align: center;
+        user-select: none;
+        color: var(--primary-color);
+      }
+      menu {
+        display: flex;
+        flex-direction: row;
+        align-items: center;
+        flex: 0 0 auto;
+        height: 100vh;
+        min-width: 116px;
+        padding: 0px 10px;
+        column-gap: 10px;
+        list-style-type: none;
+        background: var(--background-color);
+        position: relative;
+        z-index: 1;
+      }
+      li {
+        display: flex;
+        align-items: center;
+        flex: 0 0 auto;
+      }
+      li.disabled {
+        opacity: 0.5;
+        cursor: not-allowed;
+        pointer-events: none;
+      }
+      button {
+        width: 32px;
+        height: 32px;
+        border: none;
+        background-color: transparent;
+      }
+      svg {
+        pointer-events: none;
+      }
+      #minimize > svg {
+        fill: var(--minimize-color);
+      }
+      #fullscreen > svg {
+        fill: var(--fullscreen-color);
+      }
+      #terminate > svg {
+        fill: var(--terminate-color);
+      }
+    </style>
+  </head>
+  <body>
+    <header>
+      <h1 id="title"></h1>
+    </header>
+    <menu>
+      <li>
+        <button id="minimize">
+          <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
+            <title>minus-circle</title>
+            <path d="M17,13H7V11H17M12,2A10,10 0 0,0 2,12A10,10 0 0,0 12,22A10,10 0 0,0 22,12A10,10 0 0,0 12,2Z" />
+          </svg>
+        </button>
+      </li>
+      <li>
+        <button id="fullscreen">
+          <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
+            <title>chevron-up-circle</title>
+            <path
+              d="M22,12A10,10 0 0,1 12,22A10,10 0 0,1 2,12A10,10 0 0,1 12,2A10,10 0 0,1 22,12M7.4,15.4L12,10.8L16.6,15.4L18,14L12,8L6,14L7.4,15.4Z"
+            />
+          </svg>
+        </button>
+      </li>
+      <li>
+        <button id="terminate">
+          <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
+            <title>close-circle</title>
+            <path
+              d="M12,2C17.53,2 22,6.47 22,12C22,17.53 17.53,22 12,22C6.47,22 2,17.53 2,12C2,6.47 6.47,2 12,2M15.59,7L12,10.59L8.41,7L7,8.41L10.59,12L7,15.59L8.41,17L12,13.41L15.59,17L17,15.59L13.41,12L17,8.41L15.59,7Z"
+            />
+          </svg>
+        </button>
+      </li>
+    </menu>
+    <script>
+      const { ipcRenderer } = require("electron");
+
+      const registerSendEvents = () => {
+        document.querySelectorAll("button").forEach((button) => {
+          button.addEventListener("click", (e) => {
+            ipcRenderer.send("button-click", { id: e.target.id });
+          });
+        });
+      };
+
+      const registerReceiveEvents = () => {
+        ipcRenderer.on("button-disabled", (e, button) => {
+          document.getElementById(button.id).parentNode.classList.toggle("disabled", button.disabled);
+        });
+        ipcRenderer.on("text-content", (e, text) => {
+          document.getElementById(text.id).textContent = text.content;
+        });
+        ipcRenderer.on("data-theme", (e, data) => {
+          document.documentElement.setAttribute("data-theme", data.theme);
+        });
+      };
+
+      registerSendEvents();
+      registerReceiveEvents();
+    </script>
+  </body>
+</html>

html/widget.html

@@ -68,16 +68,6 @@
   </head>
   <body>
     <menu>
-      <li>
-        <button id="keyboard">
-          <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
-            <title>keyboard-close-outline</title>
-            <path
-              d="M12 23L16 19H8M4 3C2.9 3 2 3.9 2 5V15C2 16.1 2.9 17 4 17H20C21.1 17 22 16.1 22 15V5C22 3.9 21.1 3 20 3H4M4 5H20V15H4V5M5 6V8H7V6H5M8 6V8H10V6H8M11 6V8H13V6H11M14 6V8H16V6H14M17 6V8H19V6H17M5 9V11H7V9H5M8 9V11H10V9H8M11 9V11H13V9H11M14 9V11H16V9H14M17 9V11H19V9H17M8 12V14H16V12H8Z"
-            />
-          </svg>
-        </button>
-      </li>
       <li>
         <button id="fullscreen">
           <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
@@ -89,11 +79,21 @@
         </button>
       </li>
       <li>
-        <button id="minimize">
+        <button id="theme">
           <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
-            <title>image-size-select-small</title>
+            <title>compare</title>
             <path
-              d="M23,15H21V17H23V15M23,11H21V13H23V11M23,19H21V21C22,21 23,20 23,19M15,3H13V5H15V3M23,7H21V9H23V7M21,3V5H23C23,4 22,3 21,3M3,21H11V15H1V19A2,2 0 0,0 3,21M3,7H1V9H3V7M15,19H13V21H15V19M19,3H17V5H19V3M19,19H17V21H19V19M3,3C2,3 1,4 1,5H3V3M3,11H1V13H3V11M11,3H9V5H11V3M7,3H5V5H7V3Z"
+              d="M19,3H14V5H19V18L14,12V21H19A2,2 0 0,0 21,19V5C21,3.89 20.1,3 19,3M10,18H5L10,12M10,3H5C3.89,3 3,3.89 3,5V19A2,2 0 0,0 5,21H10V23H12V1H10V3Z"
+            />
+          </svg>
+        </button>
+      </li>
+      <li>
+        <button id="keyboard">
+          <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
+            <title>keyboard-close-outline</title>
+            <path
+              d="M12 23L16 19H8M4 3C2.9 3 2 3.9 2 5V15C2 16.1 2.9 17 4 17H20C21.1 17 22 16.1 22 15V5C22 3.9 21.1 3 20 3H4M4 5H20V15H4V5M5 6V8H7V6H5M8 6V8H10V6H8M11 6V8H13V6H11M14 6V8H16V6H14M17 6V8H19V6H17M5 9V11H7V9H5M8 9V11H10V9H8M11 9V11H13V9H11M14 9V11H16V9H14M17 9V11H19V9H17M8 12V14H16V12H8Z"
             />
           </svg>
         </button>

index.js

@@ -5,9 +5,13 @@ const readline = require("readline/promises");
 const integration = require("./js/integration");
 const hardware = require("./js/hardware");
 const webview = require("./js/webview");
+const log = require("electron-log");
 const { app } = require("electron");
+const Events = require("events");
 
+global.APP = global.APP || {};
 global.ARGS = global.ARGS || {};
+global.EVENTS = global.EVENTS || new Events();
 
 if (!process.env.DISPLAY) {
   console.error(`\n$DISPLAY variable not set to run the GUI application, are you connected via SSH?\n`);
@@ -15,6 +19,7 @@ if (!process.env.DISPLAY) {
   console.error(`  systemctl --user start touchkio.service`);
   console.error(`Alternatively export the variables first:`);
   console.error(`  export DISPLAY=":0" && export WAYLAND_DISPLAY="wayland-0" && touchkio\n`);
+  process.exit(1);
 }
 
 /**
@@ -23,43 +28,16 @@ if (!process.env.DISPLAY) {
  * initialization tasks.
  */
 app.whenReady().then(async () => {
-  const lock = app.requestSingleInstanceLock();
+  if (!(await initApp()) || !(await initArgs()) || !(await initLog())) {
-  if (!lock) {
+    return;
-    console.error("TouchKio is already running");
-    return app.quit();
   }
-  let args = parseArgs(process);
-  let argsProvided = !!Object.keys(args).length;
-
-  let argsFilePath = path.join(app.getPath("userData"), "Arguments.json");
-  let argsFileExists = fs.existsSync(argsFilePath);
-
-  // Show version and release info
-  if ("help" in args || "version" in args) {
-    console.log(`${app.getName()}-v${app.getVersion()}, https://github.com/leukipp/touchkio`);
-    return app.quit();
-  }
-
-  // Setup arguments from file path
-  if ("setup" in args || (!argsProvided && !argsFileExists)) {
-    await sleep(3000);
-    do {
-      args = await promptArgs(process);
-    } while (!Object.keys(args).length);
-    writeArgs(argsFilePath, args);
-  } else if (!argsProvided && argsFileExists) {
-    args = readArgs(argsFilePath);
-  }
-
-  // Split url arguments
-  args.web_url = args.web_url || [];
-  if (!Array.isArray(args.web_url)) {
-    args.web_url = args.web_url.split(",").map((url) => url.trim());
-  }
-  global.ARGS = args;
 
   // Show used arguments
-  console.log(`Arguments: ${JSON.stringify(global.ARGS, null, 2)}\n`);
+  const args = Object.assign({}, ARGS);
+  if ("mqtt_password" in args) {
+    args.mqtt_password = "*".repeat((args.mqtt_password || "").length);
+  }
+  console.info(`Arguments: ${JSON.stringify(args, null, 2)}`);
 
   // Chained init functions
   const chained = [webview.init, hardware.init, integration.init];
@@ -70,6 +48,147 @@ app.whenReady().then(async () => {
   }
 });
 
+/**
+ * Initializes the global app object.
+ *
+ * @returns {bool} Returns true if the initialization was successful.
+ */
+const initApp = async () => {
+  const packageJsonPath = path.join(app.getAppPath(), "package.json");
+  const packageJson = JSON.parse(fs.readFileSync(packageJsonPath, "utf8"));
+
+  const buildJsonPath = path.join(app.getAppPath(), "build.json");
+  const buildFileExists = fs.existsSync(buildJsonPath);
+
+  // Set required app infos
+  APP.name = app.getName();
+  APP.title = packageJson.title;
+  APP.version = app.getVersion();
+  APP.path = app.getAppPath();
+  APP.icon = path.join(app.getAppPath(), "img", "icon.png");
+  APP.log = path.join(app.getPath("logs"), "main.log");
+  APP.config = app.getPath("userData");
+
+  // Set additional update infos
+  APP.homepage = `https://github.com/${packageJson.author}/${packageJson.name}`;
+  APP.releases = {
+    url: `https://api.github.com/repos/${packageJson.author}/${packageJson.name}/releases`,
+    latest: null,
+  };
+  APP.scripts = {
+    install: `https://raw.githubusercontent.com/${packageJson.author}/${packageJson.name}/main/install.sh`,
+  };
+
+  // Set additional build infos
+  APP.build = {};
+  if (buildFileExists) {
+    APP.build = JSON.parse(fs.readFileSync(buildJsonPath, "utf8"));
+  }
+
+  // Request single app instance lock
+  if (!app.requestSingleInstanceLock()) {
+    console.error(`${APP.title} is already running`);
+    return app.exit(1);
+  }
+
+  return true;
+};
+
+/**
+ * Initializes the global args object.
+ *
+ * @returns {bool} Returns true if the initialization was successful.
+ */
+const initArgs = async () => {
+  let args = parseArgs(process);
+  let argsProvided = !!Object.keys(args).length;
+
+  let argsFilePath = path.join(APP.config, "Arguments.json");
+  let argsFileExists = fs.existsSync(argsFilePath);
+
+  // Show version and release info
+  if ("help" in args || "version" in args) {
+    let build = "";
+    if (APP.build.id) {
+      build = ` (${APP.build.id}), built on ${APP.build.date} (${APP.build.platform}-${APP.build.arch}-${APP.build.maker})`;
+    }
+    console.info(`${APP.name}-v${APP.version}${build}\n${APP.homepage}`);
+    return app.exit(0);
+  }
+
+  // Setup arguments from file path
+  if ((!argsProvided && !argsFileExists) || "setup" in args) {
+    await sleep(3000);
+    do {
+      args = await promptArgs(process);
+    } while (!Object.keys(args).length);
+    writeArgs(argsFilePath, args);
+  } else if (argsFileExists) {
+    args = { ...readArgs(argsFilePath), ...args };
+  }
+
+  // Check arguments object
+  if (!Object.keys(args).length) {
+    console.error(`No arguments provided`);
+    return app.exit(1);
+  }
+
+  // Split url arguments
+  args.web_url = args.web_url || [];
+  if (!Array.isArray(args.web_url)) {
+    args.web_url = args.web_url.split(",").map((url) => url.trim());
+  }
+  ARGS = args;
+
+  return true;
+};
+
+/**
+ * Initializes the global log object.
+ *
+ * @returns {bool} Returns true if the initialization was successful.
+ */
+const initLog = async () => {
+  try {
+    if (fs.existsSync(APP.log)) {
+      fs.unlinkSync(APP.log);
+    }
+  } catch (error) {
+    console.error("Failed to delete log file:", error.message);
+  }
+
+  // Overwrite console log
+  APP.logs = [];
+  log.errorHandler.startCatching({
+    showDialog: false,
+    onError({ error }) {
+      console.error(`Uncaught Error: ${error.message} (${error.stack})`);
+      app.exit(1);
+    },
+  });
+  log.hooks.push((message, transport, type) => {
+    const text = message.data.join(" ");
+    if (!text.startsWith("(node:") && type === "console") {
+      APP.logs.unshift({
+        time: message.date,
+        level: message.level,
+        text: text,
+      });
+      if (APP.logs.length > 10) {
+        APP.logs.splice(10);
+      }
+      EVENTS.emit("consoleLog", APP.logs[0]);
+    }
+    return message;
+  });
+  log.transports.file.resolvePathFn = () => {
+    return APP.log;
+  };
+  Object.assign(console, log.functions);
+
+  return true;
+};
+
 /**
  * Parses command-line arguments from the given process object.
  *
@@ -155,34 +274,41 @@ const promptArgs = async (proc) => {
   // Prompt questions and wait for the answers
   let args = {};
   let ignore = [];
-  for (const { key, question, fallback } of prompts) {
+  try {
-    if (key === "mqtt") {
+    for (const { key, question, fallback } of prompts) {
-      const prompt = `${question} (${fallback}): `;
+      if (key === "mqtt") {
-      const answer = await read.question(prompt);
+        const prompt = `${question} (${fallback}): `;
-      const value = (answer.trim() || fallback.match(/[YN]/)[0]).toLowerCase();
+        const answer = await read.question(prompt);
-      if (!["y", "yes"].includes(value)) {
+        const value = (answer.trim() || fallback.match(/[YN]/)[0]).toLowerCase();
-        ignore = ignore.concat(["mqtt_url", "mqtt_user", "mqtt_password", "mqtt_discovery"]);
+        if (!["y", "yes"].includes(value)) {
-      }
+          ignore = ignore.concat(["mqtt_url", "mqtt_user", "mqtt_password", "mqtt_discovery"]);
-    } else if (key === "check") {
+        }
-      const json = JSON.stringify(args, null, 2);
+      } else if (key === "check") {
-      const prompt = `${question}\n${json}\n(${fallback}): `;
+        const json = JSON.stringify(args, null, 2);
-      const answer = await read.question(prompt);
+        const prompt = `${question}\n${json}\n(${fallback}): `;
-      const value = (answer.trim() || fallback.match(/[YN]/)[0]).toLowerCase();
+        const answer = await read.question(prompt);
-      if (!["y", "yes"].includes(value)) {
+        const value = (answer.trim() || fallback.match(/[YN]/)[0]).toLowerCase();
-        args = {};
+        if (!["y", "yes"].includes(value)) {
-      }
+          args = {};
-    } else if (!ignore.includes(key)) {
+        }
-      const prompt = `${question} (${fallback}): `;
+      } else if (!ignore.includes(key)) {
-      const answer = await read.question(prompt);
+        const prompt = `${question} (${fallback}): `;
-      const value = answer.trim() || fallback;
+        const answer = await read.question(prompt);
-      if (key === "web_url") {
+        const value = answer.trim() || fallback;
-        args[key] = value.split(",").map((v) => v.trim());
+        if (key === "web_url") {
-      } else {
+          args[key] = value.split(",").map((v) => v.trim());
-        args[key] = value;
+        } else {
+          args[key] = value;
+        }
       }
     }
+  } catch (error) {
+    console.error(`\n${error.message}`);
+    args = {};
+    app.exit(1);
+  } finally {
+    read.close();
   }
-  read.close();
 
   return args;
 };
@@ -194,11 +320,15 @@ const promptArgs = async (proc) => {
  * @param {Object} args - The arguments object.
  */
 const writeArgs = (path, args) => {
-  const argc = Object.assign({}, args);
+  try {
-  if ("mqtt_password" in argc) {
+    const argc = Object.assign({}, args);
-    argc.mqtt_password = encrypt(argc.mqtt_password);
+    if ("mqtt_password" in argc) {
+      argc.mqtt_password = encrypt(argc.mqtt_password);
+    }
+    fs.writeFileSync(path, JSON.stringify(argc, null, 2));
+  } catch (error) {
+    console.error(`Failed to write ${path}:`, error.message);
   }
-  fs.writeFileSync(path, JSON.stringify(argc, null, 2));
 };
 
 /**
@@ -208,11 +338,16 @@ const writeArgs = (path, args) => {
  * @returns {Object} The arguments object.
  */
 const readArgs = (path) => {
-  const args = JSON.parse(fs.readFileSync(path));
+  try {
-  if ("mqtt_password" in args) {
+    const args = JSON.parse(fs.readFileSync(path, "utf8"));
-    args.mqtt_password = decrypt(args.mqtt_password);
+    if ("mqtt_password" in args) {
+      args.mqtt_password = decrypt(args.mqtt_password);
+    }
+    return args;
+  } catch (error) {
+    console.error(`Failed to parse ${path}:`, error.message);
   }
-  return args;
+  return {};
 };
 
 /**
@@ -223,7 +358,7 @@ const readArgs = (path) => {
  */
 const encrypt = (value) => {
   const iv = crypto.randomBytes(16);
-  const key = crypto.scryptSync(hardware.getMachineId(), app.getName(), 32);
+  const key = crypto.scryptSync(hardware.getMachineId(), APP.name, 32);
   const cipher = crypto.createCipheriv("aes-256-cbc", key, iv);
   let encrypted = cipher.update(value, "utf8", "hex");
   encrypted += cipher.final("hex");
@@ -239,7 +374,7 @@ const encrypt = (value) => {
 const decrypt = (value) => {
   const p = Buffer.from(value, "base64").toString("utf8").split(":");
   const iv = Buffer.from(p.shift(), "hex");
-  const key = crypto.scryptSync(hardware.getMachineId(), app.getName(), 32);
+  const key = crypto.scryptSync(hardware.getMachineId(), APP.name, 32);
   const decipher = crypto.createDecipheriv("aes-256-cbc", key, iv);
   const buffer = Buffer.from(p.join(":"), "hex");
   let decrypted = decipher.update(buffer, "binary", "utf8");

install.sh

@@ -1,68 +1,60 @@
 #!/usr/bin/env bash
 
+# Read arguments
+ARG_EARLY=false
+ARG_UPDATE=false
+for arg in "$@"; do
+  case "$arg" in
+    early) ARG_EARLY=true ;;
+    update) ARG_UPDATE=true ;;
+  esac
+done
+
 # Determine system architecture
 echo -e "Determining system architecture..."
 
 BITS=$(getconf LONG_BIT)
 case "$(uname -m)" in
-    aarch64)
+    x86_64) ARCH="x64" ;;
-        ARCH="arm64"
+    aarch64) ARCH="arm64" ;;
-        ;;
+    *) { echo "Architecture $(uname -m) running $BITS-bit operating system is not supported."; exit 1; } ;;
-    x86_64)
-        ARCH="x64"
-        ;;
-    *)
-        echo "Architecture $(uname -m) running $BITS-bit operating system is not supported."
-        exit 1
-        ;;
 esac
 
-if [ "$BITS" -ne 64 ]; then
+[ "$BITS" -eq 64 ] || { echo "Architecture $ARCH running $BITS-bit operating system is not supported."; exit 1; }
-    echo "Architecture $ARCH running $BITS-bit operating system is not supported."
-    exit 1
-fi
-
 echo "Architecture $ARCH running $BITS-bit operating system is supported."
 
 # Download the latest .deb package
 echo -e "\nDownloading the latest release..."
 
-DEB_URL=$(wget -qO- https://api.github.com/repos/leukipp/touchkio/releases/latest | \
-grep -o "\"browser_download_url\": \"[^\"]*_${ARCH}\.deb\"" | \
-sed 's/"browser_download_url": "//;s/"//g')
-
 TMP_DIR=$(mktemp -d)
-DEB_PATH="${TMP_DIR}/$(basename "$DEB_URL")"
 chmod 755 "$TMP_DIR"
 
-if [ -z "$DEB_URL" ]; then
+JSON=$(wget -qO- "https://api.github.com/repos/leukipp/touchkio/releases" | tr -d '\r\n')
-    echo "Download url for .deb file not found."
+if $ARG_EARLY; then
-    exit 1
+  DEB_REG='"prerelease":\s*(true|false).*?"browser_download_url":\s*"\K[^\"]*_'$ARCH'\.deb'
+else
+  DEB_REG='"prerelease":\s*false.*?"browser_download_url":\s*"\K[^\"]*_'$ARCH'\.deb'
 fi
 
-if ! wget --show-progress -q -O "$DEB_PATH" "$DEB_URL"; then
+DEB_URL=$(echo "$JSON" | grep -oP "$DEB_REG" | head -n 1)
-    echo "Failed to download the .deb file."
+DEB_PATH="${TMP_DIR}/$(basename "$DEB_URL")"
-    exit 1
+
-fi
+[ -z "$DEB_URL" ] && { echo "Download url for .deb file not found."; exit 1; }
+wget --show-progress -q -O "$DEB_PATH" "$DEB_URL" || { echo "Failed to download the .deb file."; exit 1; }
 
 # Install the latest .deb package
 echo -e "\nInstalling the latest release..."
 
-if ! command -v apt &> /dev/null; then
+command -v apt &> /dev/null || { echo "Package manager apt was not found."; exit 1; }
-    echo "Package manager apt was not found."
+sudo apt install -y "$DEB_PATH" || { echo "Installation of .deb file failed."; exit 1; }
-    exit 1
-fi
-
-if ! sudo apt install "$DEB_PATH"; then
-    echo "Installation of .deb file failed."
-    exit 1
-fi
 
 # Create the systemd user service
 echo -e "\nCreating systemd user service..."
 
-SERVICE_FILE="$HOME/.config/systemd/user/touchkio.service"
+SERVICE_NAME="touchkio.service"
-mkdir -p "$(dirname "$SERVICE_FILE")" || { echo "Failed to create directory for $SERVICE_FILE"; exit 1; }
+SERVICE_FILE="$HOME/.config/systemd/user/$SERVICE_NAME"
+mkdir -p "$(dirname "$SERVICE_FILE")" || { echo "Failed to create directory for $SERVICE_FILE."; exit 1; }
+
 SERVICE_CONTENT="[Unit]
 Description=TouchKio
 After=graphical.target
@@ -76,20 +68,28 @@ RestartSec=5s
 [Install]
 WantedBy=default.target"
 
+if $ARG_UPDATE; then
+  if systemctl --user --quiet is-active "${SERVICE_NAME}"; then
+    systemctl --user restart "${SERVICE_NAME}"
+    echo "Existing $SERVICE_NAME restarted."
+  else
+    echo "Existing $SERVICE_NAME not running, start touchkio manually."
+  fi
+  exit 0
+fi
+
 SERVICE_CREATE=true
 if [ -f "$SERVICE_FILE" ]; then
     read -p "Service $SERVICE_FILE exists, overwrite? (y/N) " overwrite
-    if [[ ! ${overwrite:-n} == [Yy]* ]]; then
+    [[ ${overwrite:-n} == [Yy]* ]] || SERVICE_CREATE=false
-        SERVICE_CREATE=false
-    fi
 fi
 
-if [ "$SERVICE_CREATE" = true ]; then
+if $SERVICE_CREATE; then
-    echo "$SERVICE_CONTENT" > "$SERVICE_FILE" || { echo "Failed to write to $SERVICE_FILE"; exit 1; }
+    echo "$SERVICE_CONTENT" > "$SERVICE_FILE" || { echo "Failed to write to $SERVICE_FILE."; exit 1; }
-    systemctl --user enable "$(basename "$SERVICE_FILE")" || { echo "Failed to enable service $SERVICE_FILE"; exit 1; }
+    systemctl --user enable "$(basename "$SERVICE_FILE")" || { echo "Failed to enable service $SERVICE_FILE."; exit 1; }
-    echo "Service $SERVICE_FILE enabled"
+    echo "Service $SERVICE_FILE enabled."
 else
-    echo "Service $SERVICE_FILE not created"
+    echo "Service $SERVICE_FILE not created."
 fi
 
 # Export display variables
@@ -97,20 +97,21 @@ echo -e "\nExporting display variables..."
 
 if [ -z "$DISPLAY" ]; then
     export DISPLAY=":0"
-    echo "DISPLAY was not set, defaulting to \"$DISPLAY\""
+    echo "DISPLAY was not set, defaulting to \"$DISPLAY\"."
 else
-    echo "DISPLAY is set to \"$DISPLAY\""
+    echo "DISPLAY is set to \"$DISPLAY\"."
 fi
+
 if [ -z "$WAYLAND_DISPLAY" ]; then
     export WAYLAND_DISPLAY="wayland-0"
-    echo "WAYLAND_DISPLAY was not set, defaulting to \"$WAYLAND_DISPLAY\""
+    echo "WAYLAND_DISPLAY was not set, defaulting to \"$WAYLAND_DISPLAY\"."
 else
-    echo "WAYLAND_DISPLAY is set to \"$WAYLAND_DISPLAY\""
+    echo "WAYLAND_DISPLAY is set to \"$WAYLAND_DISPLAY\"."
 fi
 
 # Start the setup mode
-echo ""
+read -p $'\nStart touchkio setup? (Y/n) ' setup
-read -p "Start touchkio setup? (Y/n) " setup
+
 if [[ ${setup:-y} == [Yy]* ]]; then
     echo "/usr/bin/touchkio --setup"
     /usr/bin/touchkio --setup
@@ -118,3 +119,5 @@ else
     echo "/usr/bin/touchkio"
     /usr/bin/touchkio
 fi
+
+exit 0

js/hardware.js

@@ -3,13 +3,11 @@ const fs = require("fs");
 const path = require("path");
 const fsp = require("fs/promises");
 const cpr = require("child_process");
-const Events = require("events");
 
 global.HARDWARE = global.HARDWARE || {
   initialized: false,
-  events: new Events(),
-  session: {},
   support: {},
+  session: {},
   battery: {
     level: {
       path: null,
@@ -30,6 +28,9 @@ global.HARDWARE = global.HARDWARE || {
   keyboard: {
     visible: null,
   },
+  audio: {
+    device: null,
+  },
 };
 
 /**
@@ -39,11 +40,7 @@ global.HARDWARE = global.HARDWARE || {
  */
 const init = async () => {
   if (!compatibleSystem()) {
-    console.warn("Operating system is not supported\n");
+    console.error("Operating system is not supported");
-    return false;
-  }
-  if (!sessionRights()) {
-    console.warn(`User "${sessionUser()}" is missing password-less sudo rights\n`);
     return false;
   }
 
@@ -56,65 +53,92 @@ const init = async () => {
   HARDWARE.display.status.command = getDisplayStatusCommand();
   HARDWARE.display.brightness.path = getDisplayBrightnessPath();
   HARDWARE.display.brightness.max = getDisplayBrightnessMax();
+  HARDWARE.audio.device = getAudioDevice();
   HARDWARE.support = checkSupport();
   HARDWARE.initialized = true;
 
   // Show supported features
-  console.log(`Supported: ${JSON.stringify(HARDWARE.support, null, 2)}`);
+  process.stdout.write("\n");
+  console.info(`Supported: ${JSON.stringify(HARDWARE.support, null, 2)}`);
 
   // Show session infos
-  console.log("\nUser:", HARDWARE.session.user);
+  process.stdout.write("\n");
-  console.log("Session:", HARDWARE.session.type);
+  console.info("User:", HARDWARE.session.user);
-  console.log("Desktop:", HARDWARE.session.desktop);
+  console.info("Session:", HARDWARE.session.type);
+  console.info("Desktop:", HARDWARE.session.desktop);
 
   // Show device infos
-  console.log("\nModel:", getModel());
+  process.stdout.write("\n");
-  console.log("Vendor:", getVendor());
+  console.info("Model:", getModel());
-  console.log("Serial Number:", getSerialNumber());
+  console.info("Vendor:", getVendor());
-  console.log("Host Name:", getHostName());
+  console.info("Serial Number:", getSerialNumber());
+  console.info("Network Addresses:", getNetworkAddresses());
+  console.info("Host Name:", getHostName());
 
   // Show system infos
-  console.log("\nUp Time:", getUpTime());
+  process.stdout.write("\n");
-  console.log("Memory Size:", getMemorySize());
+  console.info("Up Time:", getUpTime());
-  console.log("Memory Usage:", getMemoryUsage());
+  console.info("Memory Size:", getMemorySize());
-  console.log("Processor Usage:", getProcessorUsage());
+  console.info("Memory Usage:", getMemoryUsage());
-  console.log("Processor Temperature:", getProcessorTemperature());
+  console.info("Processor Usage:", getProcessorUsage());
+  console.info("Processor Temperature:", getProcessorTemperature());
 
   // Show hardware infos
+  process.stdout.write("\n");
   const unsupported = "unsupported";
-  console.log(
+  console.info(`Battery Level [${HARDWARE.battery.level.path || unsupported}]:`, `${getBatteryLevel() || unsupported}`);
-    `\nBattery Level [${HARDWARE.battery.level.path || unsupported}]:`,
+  console.info(
-    `${getBatteryLevel() || unsupported}`,
-  );
-  console.log(
     `Display Status [${HARDWARE.display.status.path || unsupported}]:`,
     `${getDisplayStatus() || unsupported} (${HARDWARE.display.status.command || unsupported})`,
   );
-  console.log(
+  console.info(
     `Display Brightness [${HARDWARE.display.brightness.path || unsupported}]:`,
     `${getDisplayBrightness() || unsupported}`,
   );
-  console.log(
+  console.info(
-    `Keyboard Visibility [${HARDWARE.support.keyboardVisibility ? "squeekboard" : unsupported}]:`,
+    `Audio Volume [${HARDWARE.support.audioVolume ? HARDWARE.audio.device : unsupported}]:`,
-    `${getKeyboardVisibility() || unsupported}\n`,
+    `${getAudioVolume() || unsupported}`,
   );
+  console.info(
+    `Keyboard Visibility [${HARDWARE.support.keyboardVisibility ? "squeekboard" : unsupported}]:`,
+    `${getKeyboardVisibility() || unsupported}`,
+  );
+  process.stdout.write("\n");
 
-  // Check for keyboard visibility
+  // Monitor audio volume
-  setKeyboardVisibility("OFF", (reply, error) => {
+  if (HARDWARE.support.audioVolume) {
-    if (!reply || error) {
+    commandMonitor("pactl", ["subscribe"], (reply, error) => {
-      return;
+      if (!reply || error) {
-    }
-    dbusMonitor("/sm/puri/OSK0", (property, error) => {
-      if (!property || error) {
         return;
       }
-      HARDWARE.keyboard.visibility = property.Visible === "true";
+      if (reply.includes("'change' on sink")) {
-      HARDWARE.events.emit("updateKeyboard");
+        console.info("Update Audio Volume:", getAudioVolume());
+        EVENTS.emit("updateVolume");
+      }
     });
-  });
+  }
+
+  // Monitor keyboard visibility
+  if (HARDWARE.support.keyboardVisibility) {
+    setKeyboardVisibility("OFF", (reply, error) => {
+      if (!reply || error) {
+        return;
+      }
+      dbusMonitor("/sm/puri/OSK0", (property, error) => {
+        if (!property || error) {
+          return;
+        }
+        HARDWARE.keyboard.visibility = property.Visible === "true";
+        console.info("Update Keyboard Visibility:", getKeyboardVisibility());
+        EVENTS.emit("updateKeyboard");
+      });
+    });
+  }
 
   // Check for display changes
-  interval(update, 1000);
+  setDisplayStatus("ON", () => {
+    interval(update, 1000);
+  });
 
   return true;
 };
@@ -123,7 +147,7 @@ const init = async () => {
  * Updates the shared hardware properties.
  */
 const update = async () => {
-  if (!HARDWARE.initialized) {
+  if (!HARDWARE.initialized || APP.exiting) {
     return;
   }
 
@@ -131,9 +155,9 @@ const update = async () => {
   if (HARDWARE.support.displayStatus) {
     const status = (await fsp.readFile(`${HARDWARE.display.status.path}/dpms`, "utf8")).trim();
     if (status !== HARDWARE.display.status.value) {
-      console.log("Update Display Status:", getDisplayStatus());
+      console.info("Update Display Status:", getDisplayStatus());
       HARDWARE.display.status.value = status;
-      HARDWARE.events.emit("updateDisplay");
+      EVENTS.emit("updateDisplay");
     }
   }
 
@@ -141,9 +165,9 @@ const update = async () => {
   if (HARDWARE.support.displayBrightness) {
     const brightness = (await fsp.readFile(`${HARDWARE.display.brightness.path}/brightness`, "utf8")).trim();
     if (brightness !== HARDWARE.display.brightness.value) {
-      console.log("Update Display Brightness:", getDisplayBrightness());
+      console.info("Update Display Brightness:", getDisplayBrightness());
       HARDWARE.display.brightness.value = brightness;
-      HARDWARE.events.emit("updateDisplay");
+      EVENTS.emit("updateDisplay");
     }
   }
 };
@@ -161,19 +185,6 @@ const compatibleSystem = () => {
   return paths.every((path) => fs.existsSync(path));
 };
 
-/**
- * Verifies user rights to run sudo commands without a password.
- *
- * @returns {bool} Returns true if password-less sudo rights exists.
- */
-const sessionRights = () => {
-  if (!commandExists("sudo")) {
-    return false;
-  }
-  const result = execSyncCommand("sudo", ["-n", "true"]);
-  return result !== null && !result.includes("password is required");
-};
-
 /**
  * Gets the session user name using `os.userInfo()`.
  *
@@ -214,7 +225,7 @@ const sessionDesktop = () => {
 };
 
 /**
- * Checks supported features based on global properties.
+ * Checks supported features based on hardware and software.
  *
  * @returns {Object} Returns support object with boolean values.
  */
@@ -222,12 +233,19 @@ const checkSupport = () => {
   const battery = HARDWARE.battery.level;
   const status = HARDWARE.display.status;
   const brightness = HARDWARE.display.brightness;
+  const audio = HARDWARE.audio.device;
   const keyboard = processRuns("squeekboard");
+  const service = serviceRuns(APP.name);
+  const sudo = sudoRights();
+  const deb = APP.build.maker === "deb";
   return {
-    batteryLevel: battery.path !== null,
+    batteryLevel: !!battery.path,
-    displayStatus: status.path !== null && status.command !== null,
+    displayStatus: !!status.path && !!status.command,
-    displayBrightness: brightness.path !== null && brightness.max !== null,
+    displayBrightness: sudo && !!brightness.path && !!brightness.max,
-    keyboardVisibility: keyboard === true,
+    keyboardVisibility: keyboard,
+    audioVolume: !!audio,
+    sudoRights: sudo,
+    appUpdate: service && sudo && deb,
   };
 };
 
@@ -240,7 +258,7 @@ const getModel = () => {
   const paths = ["/sys/firmware/devicetree/base/model", "/sys/class/dmi/id/product_name"];
   for (const path of paths) {
     if (fs.existsSync(path)) {
-      return execSyncCommand("sudo", ["cat", path]) || "Generic";
+      return execSyncCommand("cat", [path]) || "Generic";
     }
   }
   return "Generic";
@@ -255,7 +273,7 @@ const getVendor = () => {
   const paths = ["/sys/class/dmi/id/board_vendor"];
   for (const path of paths) {
     if (fs.existsSync(path)) {
-      return execSyncCommand("sudo", ["cat", path]) || "Generic";
+      return execSyncCommand("cat", [path]) || "Generic";
     }
   }
   const model = getModel();
@@ -266,22 +284,22 @@ const getVendor = () => {
 };
 
 /**
- * Gets the serial number using `/sys/firmware/devicetree/base/serial-number` or `/sys/class/dmi/id/product_serial`.
+ * Gets the serial number using `/sys/firmware/devicetree/base/serial-number`.
  *
- * @returns {string} The serial number of the device or '123456' if not found.
+ * @returns {string} The serial number or machine id parts of the device or '123456' if not found.
  */
 const getSerialNumber = () => {
-  const paths = ["/sys/firmware/devicetree/base/serial-number", "/sys/class/dmi/id/product_serial"];
+  const paths = ["/sys/firmware/devicetree/base/serial-number"];
   for (const path of paths) {
     if (fs.existsSync(path)) {
-      return execSyncCommand("sudo", ["cat", path]) || "123456";
+      return execSyncCommand("cat", [path]) || "123456";
     }
   }
-  return "123456";
+  return getMachineId().slice(-6);
 };
 
 /**
- * Gets the host machine id using `/etc/machine-id`.
+ * Gets the machine id using `/etc/machine-id`.
  *
  * @returns {string} The machine id of the system or '123456' if not found.
  */
@@ -289,12 +307,38 @@ const getMachineId = () => {
   const paths = ["/etc/machine-id"];
   for (const path of paths) {
     if (fs.existsSync(path)) {
-      return execSyncCommand("sudo", ["cat", path]) || "123456";
+      return execSyncCommand("cat", [path]) || "123456";
     }
   }
   return "123456";
 };
 
+/**
+ * Gets the network interfaces addresses using `os.networkInterfaces()`.
+ *
+ * @returns {Object} The network addresses of all interfaces.
+ */
+const getNetworkAddresses = () => {
+  const addresses = {};
+  for (const [key, interfaces] of Object.entries(os.networkInterfaces())) {
+    for (const interface of interfaces) {
+      if (interface.internal || !interface.family || !interface.address) {
+        continue;
+      }
+      const name = key.charAt(0).toUpperCase() + key.slice(1);
+      if (!addresses[name]) {
+        addresses[name] = {};
+      }
+      const family = interface.family;
+      if (!addresses[name][family]) {
+        addresses[name][family] = [];
+      }
+      addresses[name][family].push(interface.address);
+    }
+  }
+  return addresses;
+};
+
 /**
  * Gets the host name of the current system using `os.hostname()`.
  *
@@ -354,7 +398,7 @@ const getProcessorTemperature = () => {
       continue;
     }
     const type = fs.readFileSync(typeFile, "utf8").trim();
-    if (["cpu-thermal", "x86_pkg_temp", "k10temp", "acpitz"].includes(type)) {
+    if (["cpu-thermal", "x86_pkg_temp", "k10temp", "acpitz", "cpu"].includes(type)) {
       return parseFloat(fs.readFileSync(tempFile, "utf8").trim()) / 1000;
     }
   }
@@ -451,22 +495,22 @@ const getDisplayStatus = () => {
     case "wlopm":
       const wlopm = execSyncCommand("wlopm", []);
       if (wlopm !== null) {
-        const out = wlopm.split("\n")[0].split(" ");
+        const output = wlopm.split("\n")[0].split(" ");
-        return out.pop().toUpperCase();
+        return output.pop().toUpperCase();
       }
       break;
     case "kscreen-doctor":
       const kdoc = execSyncCommand("kscreen-doctor", ["--dpms", "show"]);
       if (kdoc !== null) {
-        const out = kdoc.split("\n")[0].split(" ");
+        const output = kdoc.split("\n")[0].split(" ");
-        return out.pop().toUpperCase();
+        return output.pop().toUpperCase();
       }
       break;
     case "xset":
       const xset = execSyncCommand("xset", ["-q"]);
       if (xset !== null) {
-        const on = /Monitor is On/.test(xset);
+        const output = xset.includes("Monitor is On");
-        return on ? "ON" : "OFF";
+        return output ? "ON" : "OFF";
       }
       break;
   }
@@ -581,6 +625,65 @@ const setDisplayBrightness = (brightness, callback = null) => {
   proc.stdin.end();
 };
 
+/**
+ * Gets the default audio device using `pactl`.
+ *
+ * @returns {string|null} The default audio device or null if an error occurs.
+ */
+const getAudioDevice = () => {
+  if (!commandExists("pactl")) {
+    return null;
+  }
+  const output = execSyncCommand("pactl", ["get-default-sink"]);
+  if (!output) {
+    return null;
+  }
+  return !output.includes("auto_null") ? output.trim() : null;
+};
+
+/**
+ * Gets the default audio device volume using `pactl`.
+ *
+ * @returns {number|null} The default audio device volume as a percentage or null if an error occurs.
+ */
+const getAudioVolume = () => {
+  if (!HARDWARE.support.audioVolume) {
+    return null;
+  }
+  const mute = execSyncCommand("pactl", ["get-sink-mute", "@DEFAULT_SINK@"]);
+  const volume = execSyncCommand("pactl", ["get-sink-volume", "@DEFAULT_SINK@"]);
+  if (!mute || !volume) {
+    return null;
+  }
+  const match = volume.match(/\/(\s*(\d+)%)/);
+  if (match) {
+    return Math.max(0, Math.min(100, mute.includes("yes") ? 0 : parseInt(match[2])));
+  }
+  return null;
+};
+
+/**
+ * Sets the default audio device volume using `pactl`.
+ *
+ * This function takes a volume value between 0 to 100 percent and sends it to the device.
+ *
+ * @param {number} volume - The desired volume level (0-100).
+ * @param {Function} callback - A callback function that receives the output or error.
+ */
+const setAudioVolume = (volume, callback = null) => {
+  if (!HARDWARE.support.audioVolume) {
+    if (typeof callback === "function") callback(null, "Not supported");
+    return;
+  }
+  if (typeof volume !== "number" || volume < 0 || volume > 100) {
+    console.error("Volume must be a number between 0 and 100");
+    if (typeof callback === "function") callback(null, "Invalid volume");
+    return;
+  }
+  execAsyncCommand("pactl", ["set-sink-mute", "@DEFAULT_SINK@", volume === 0 ? "1" : "0"]);
+  execAsyncCommand("pactl", ["set-sink-volume", "@DEFAULT_SINK@", `${volume}%`], callback);
+};
+
 /**
  * Gets the keyboard visibility using global properties.
  *
@@ -641,6 +744,10 @@ const checkPackageUpgrades = () => {
  * @param {Function} callback - A callback function that receives the output or error.
  */
 const shutdownSystem = (callback = null) => {
+  if (!HARDWARE.support.sudoRights) {
+    if (typeof callback === "function") callback(null, "Not supported");
+    return;
+  }
   execAsyncCommand("sudo", ["shutdown", "-h", "now"], callback);
 };
 
@@ -653,9 +760,40 @@ const shutdownSystem = (callback = null) => {
  * @param {Function} callback - A callback function that receives the output or error.
  */
 const rebootSystem = (callback = null) => {
+  if (!HARDWARE.support.sudoRights) {
+    if (typeof callback === "function") callback(null, "Not supported");
+    return;
+  }
   execAsyncCommand("sudo", ["reboot"], callback);
 };
 
+/**
+ * Checks if sudo commands can run without a password.
+ *
+ * @returns {bool} Returns true if password-less sudo rights exists.
+ */
+const sudoRights = () => {
+  try {
+    cpr.execSync(`sudo -n true`, { encoding: "utf8", stdio: "ignore" });
+    return true;
+  } catch {}
+  return false;
+};
+
+/**
+ * Checks if a service is running using `systemctl`.
+ *
+ * @param {string} name - The service name to check.
+ * @returns {bool} Returns true if the service runs.
+ */
+const serviceRuns = (name) => {
+  try {
+    cpr.execSync(`systemctl --user is-active ${name}`, { encoding: "utf8", stdio: "ignore" });
+    return true;
+  } catch {}
+  return false;
+};
+
 /**
  * Checks if a process is running using `pidof`.
  *
@@ -664,7 +802,8 @@ const rebootSystem = (callback = null) => {
  */
 const processRuns = (name) => {
   try {
-    return !!cpr.execSync(`pidof ${name}`, { encoding: "utf8" });
+    cpr.execSync(`pidof ${name}`, { encoding: "utf8", stdio: "ignore" });
+    return true;
   } catch {}
   return false;
 };
@@ -677,7 +816,8 @@ const processRuns = (name) => {
  */
 const commandExists = (name) => {
   try {
-    return !!cpr.execSync(`which ${name}`, { encoding: "utf8" });
+    cpr.execSync(`which ${name}`, { encoding: "utf8", stdio: "ignore" });
+    return true;
   } catch {}
   return false;
 };
@@ -689,12 +829,12 @@ const commandExists = (name) => {
  * @param {Array<string>} args - The arguments for the command.
  * @returns {string|null} The output of the command or null if an error occurs.
  */
-const execSyncCommand = (cmd, args = []) => {
+const execSyncCommand = (cmd, args) => {
   try {
     const output = cpr.execSync([cmd, ...args].join(" "), { encoding: "utf8" });
     return output.trim().replace(/\0/g, "");
   } catch (error) {
-    console.error("Execute Sync:", error.message);
+    console.error(`Execute Sync: '${[cmd, ...args].join(" ")}' --> ${error.message}`);
   }
   return null;
 };
@@ -707,7 +847,7 @@ const execSyncCommand = (cmd, args = []) => {
  * @param {Function} callback - A callback function that receives the output or error.
  * @returns {Object} The spawned process object.
  */
-const execAsyncCommand = (cmd, args = [], callback = null) => {
+const execAsyncCommand = (cmd, args, callback = null) => {
   let errorOutput = "";
   let successOutput = "";
   let proc = cpr.spawn(cmd, args);
@@ -722,19 +862,131 @@ const execAsyncCommand = (cmd, args = [], callback = null) => {
     }
   });
   proc.on("close", (code) => {
+    const error = errorOutput.trim().replace(/\0/g, "");
+    const reply = successOutput.trim().replace(/\0/g, "");
+    if (code !== 0 || error) {
+      console.error(`Execute Async: '${[cmd, ...args].join(" ")}' --> ${error} (${code})`);
+      if (typeof callback === "function") callback(null, error);
+    } else {
+      if (typeof callback === "function") callback(reply, null);
+    }
+  });
+  return proc;
+};
+
+/**
+ * Executes a script command asynchronously.
+ *
+ * @param {string} cmd - The script to execute.
+ * @param {Array<string>} args - The arguments for the command.
+ * @param {Function} callback - A callback function that receives the progress or error.
+ * @returns {Object} The spawned process object.
+ */
+const execScriptCommand = (cmd, args, callback = null) => {
+  let progress = 1;
+  let proc = cpr.spawn(cmd, args);
+  if (typeof callback === "function") callback(progress, null);
+  proc.stdout.on("data", (data) => {
+    if (data) {
+      const output = data.toString().trim();
+      const lines = output.replace(/\n+/g, "\n").replace(/^\n+|\n+$|\0/g, "");
+      for (const line of lines.split("\n").filter(Boolean)) {
+        console.info(line);
+      }
+    }
+  });
+  proc.stderr.on("data", (data) => {
+    if (data) {
+      const output = data.toString().trim();
+      const lines = output.replace(/\n+/g, "\n").replace(/^\n+|\n+$|\0/g, "");
+      for (const line of lines.split("\n").filter(Boolean)) {
+        const matches = line.match(/(\d{1,3})%/g);
+        if (matches) {
+          const match = Math.max(...matches.map((p) => parseInt(p)));
+          const percent = Math.floor(match / 10) * 10;
+          if (percent > 10 && percent > progress) {
+            progress = percent;
+            if (typeof callback === "function") callback(progress - 10, null);
+          }
+        }
+      }
+    }
+  });
+  proc.on("close", (code) => {
+    if (code !== 0) {
+      console.error(`Script exited with error code (${code}).`);
+      if (typeof callback === "function") callback(null, code);
+    } else {
+      console.info("Script exited successfully.");
+      if (typeof callback === "function") callback(100, null);
+    }
+  });
+};
+
+/**
+ * Monitors a command asynchronously.
+ *
+ * @param {string} cmd - The command to monitor.
+ * @param {Array<string>} args - The arguments for the command.
+ * @param {Function} callback - A callback function that receives the output or error.
+ * @returns {Object} The spawned process object.
+ */
+const commandMonitor = (cmd, args, callback) => {
+  const proc = cpr.spawn(cmd, args);
+  proc.stdout.on("data", (data) => {
+    if (data) {
+      const output = data.toString().trim().replace(/\0/g, "");
+      if (typeof callback === "function") callback(output, null);
+    }
+  });
+  proc.stderr.on("data", (data) => {
+    if (data) {
+      const output = data.toString().trim().replace(/\0/g, "");
+      if (typeof callback === "function") callback(null, output);
+    }
+  });
+  return proc;
+};
+
+/**
+ * Monitors D-Bus property changes asynchronously using `dbus-monitor`.
+ *
+ * @param {string} path - The D-Bus object path.
+ * @param {Function} callback - A callback function that receives the changed property.
+ * @returns {Object} The spawned process object.
+ */
+const dbusMonitor = (path, callback) => {
+  const cmd = "dbus-monitor";
+  const args = [`interface='org.freedesktop.DBus.Properties',member='PropertiesChanged',path='${path}'`];
+  const proc = cpr.spawn(cmd, args);
+  proc.stdout.on("data", (data) => {
     try {
-      if (typeof callback === "function") {
+      const signal = data.toString();
-        if (code === 0) {
+      if (signal.includes(`string "Visible"`)) {
-          callback(successOutput.trim().replace(/\0/g, ""), null);
+        const dicts = [...signal.matchAll(/dict entry\(\s*([^)]*?)\)/g)].map((dict) => dict[1].trim());
+        if (dicts.length) {
+          dicts.forEach((dict) => {
+            const key = dict.match(/string "(.*?)"/);
+            const value = dict.match(/(?<=variant\s+)(.*)/);
+            if (key && value) {
+              const property = { [key[1].trim()]: value[1].trim().split(" ").pop() };
+              if (typeof callback === "function") callback(property, null);
+            }
+          });
         } else {
-          callback(null, errorOutput.trim().replace(/\0/g, ""));
+          const property = { Visible: `${HARDWARE.keyboard.visibility}` };
+          if (typeof callback === "function") callback(property, null);
         }
       }
     } catch (error) {
-      console.error("Execute Async:", error.message);
+      console.error("Monitor D-Bus:", error.message);
-      if (typeof callback === "function") {
+      if (typeof callback === "function") callback(null, error.message);
-        callback(null, error.message);
+    }
-      }
+  });
+  proc.stderr.on("data", (data) => {
+    if (data) {
+      console.error("Monitor D-Bus:", data.toString());
+      if (typeof callback === "function") callback(null, data.toString());
     }
   });
   return proc;
@@ -755,63 +1007,13 @@ const dbusCall = (path, method, values, callback = null) => {
   const args = ["--print-reply", "--type=method_call", `--dest=${dest}`];
   try {
     const output = cpr.execSync([cmd, ...args].join(" ").trim(), { encoding: "utf8" });
-    if (typeof callback === "function") {
+    if (typeof callback === "function") callback(output.trim().replace(/\0/g, ""), null);
-      callback(output.trim().replace(/\0/g, "").split("\n").slice(1).join("\n").trim(), null);
-    }
   } catch (error) {
     console.error("Call D-Bus:", error.message);
-    if (typeof callback === "function") {
+    if (typeof callback === "function") callback(null, error.message);
-      callback(null, error.message);
-    }
   }
 };
 
-/**
- * Monitors D-Bus property changes asynchronously using `dbus-monitor`.
- *
- * @param {string} path - The D-Bus object path.
- * @param {Function} callback - A callback function that receives the changed property.
- * @returns {Object} The spawned process object.
- */
-const dbusMonitor = (path, callback) => {
-  const cmd = "dbus-monitor";
-  const args = [`interface='org.freedesktop.DBus.Properties',member='PropertiesChanged',path='${path}'`];
-  const proc = cpr.spawn(cmd, args);
-  proc.stdout.on("data", (data) => {
-    try {
-      const signal = data.toString();
-      if (signal.includes("member=PropertiesChanged") && signal.includes(`path=${path}`)) {
-        const dicts = [...signal.matchAll(/dict entry\(\s*([^)]*?)\)/g)].map((dict) => dict[1].trim());
-        if (dicts.length) {
-          dicts.forEach((dict) => {
-            const key = dict.match(/string "(.*?)"/);
-            const value = dict.match(/(?<=variant\s+)(.*)/);
-            if (key && value && typeof callback === "function") {
-              callback({ [key[1].trim()]: value[1].trim().split(" ").pop() }, null);
-            }
-          });
-        } else {
-          callback({ Visible: `${HARDWARE.keyboard.visibility}` }, null);
-        }
-      }
-    } catch (error) {
-      console.error("Monitor D-Bus:", error.message);
-      if (typeof callback === "function") {
-        callback(null, error.message);
-      }
-    }
-  });
-  proc.stderr.on("data", (data) => {
-    if (data) {
-      console.error("Monitor D-Bus:", data.toString());
-      if (typeof callback === "function") {
-        callback(null, data.toString());
-      }
-    }
-  });
-  return proc;
-};
-
 /**
  * Helper function for asynchronous interval calls.
  *
@@ -839,6 +1041,7 @@ module.exports = {
   getVendor,
   getSerialNumber,
   getMachineId,
+  getNetworkAddresses,
   getHostName,
   getUpTime,
   getMemorySize,
@@ -850,9 +1053,14 @@ module.exports = {
   setDisplayStatus,
   getDisplayBrightness,
   setDisplayBrightness,
+  getAudioVolume,
+  setAudioVolume,
   getKeyboardVisibility,
   setKeyboardVisibility,
   checkPackageUpgrades,
   shutdownSystem,
   rebootSystem,
+  execSyncCommand,
+  execAsyncCommand,
+  execScriptCommand,
 };

js/integration.js

@@ -1,11 +1,9 @@
 const mqtt = require("mqtt");
 const hardware = require("./hardware");
 const { app } = require("electron");
-const Events = require("events");
 
 global.INTEGRATION = global.INTEGRATION || {
   initialized: false,
-  events: new Events(),
 };
 
 /**
@@ -39,33 +37,43 @@ const init = async () => {
   // Init globals
   INTEGRATION.discovery = discovery;
   INTEGRATION.node = `rpi_${deviceId}`;
-  INTEGRATION.root = `${app.getName()}/${INTEGRATION.node}`;
+  INTEGRATION.root = `${APP.name}/${INTEGRATION.node}`;
   INTEGRATION.device = {
-    name: `TouchKio ${deviceName}`,
+    name: `${APP.title} ${deviceName}`,
     model: model,
     manufacturer: vendor,
     serial_number: serialNumber,
     identifiers: [INTEGRATION.node],
-    sw_version: `${app.getName()}-v${app.getVersion()}`,
+    sw_version: `${APP.name}-v${APP.version}`,
+    configuration_url: APP.homepage,
   };
 
-  // Connection settings
+  // Init options
-  const options = user === null || password === null ? null : { username: user, password: password };
+  const masked = password === null ? null : "*".repeat(password.length);
-  const masked = password === null ? "null" : "*".repeat(password.length);
+  const options = user === null || password === null ? {} : { username: user, password: password };
-  console.log("MQTT Connecting:", `${user}:${masked}@${url.toString()}`);
+  options.will = { topic: `${INTEGRATION.root}/kiosk/state`, payload: "Terminated", qos: 1, retain: true };
+  options.rejectUnauthorized = !("ignore_certificate_errors" in ARGS);
+
+  // Client connect
+  console.info("MQTT Connecting:", `${user}:${masked}@${url.toString()}`);
   INTEGRATION.client = mqtt.connect(url.toString(), options);
+  INTEGRATION.client.setMaxListeners(20);
 
   // Client connected
   INTEGRATION.client
     .once("connect", () => {
-      console.log(`MQTT Connected: ${url.toString()}\n`);
+      console.info(`MQTT Connected: ${url.toString()}`);
+      process.stdout.write("\n");
 
       // Init client controls
+      initApp();
       initShutdown();
       initReboot();
       initRefresh();
       initKiosk();
+      initTheme();
       initDisplay();
+      initVolume();
       initKeyboard();
       initPageNumber();
       initPageZoom();
@@ -75,6 +83,7 @@ const init = async () => {
       initModel();
       initSerialNumber();
       initHostName();
+      initNetworkAddress();
       initUpTime();
       initMemorySize();
       initMemoryUsage();
@@ -82,33 +91,55 @@ const init = async () => {
       initProcessorTemperature();
       initBatteryLevel();
       initPackageUpgrades();
-      initHeartbeat();
       initLastActive();
 
+      // Init client diagnostic
+      initHeartbeat();
+      initErrors();
+      initVersion();
+
       // Integration initialized
       INTEGRATION.initialized = true;
+
+      // Register global events
+      EVENTS.on("updateDisplay", () => {
+        updateDisplay();
+        updateLastActive();
+      });
+      EVENTS.on("updateStatus", updateKiosk);
+      EVENTS.on("updateTheme", updateTheme);
+      EVENTS.on("updateVolume", updateVolume);
+      EVENTS.on("updateKeyboard", updateKeyboard);
+      EVENTS.on("consoleLog", updateErrors);
     })
     .on("error", (error) => {
       console.error("MQTT", error.message);
     });
 
-  // Update sensor states from events
-  HARDWARE.events.on("updateDisplay", updateDisplay);
-  HARDWARE.events.on("updateKeyboard", updateKeyboard);
-
   // Update time sensors periodically (30s)
   setInterval(() => {
-    updateHeartbeat();
+    if (APP.exiting) {
+      return;
+    }
     updateLastActive();
+    updateHeartbeat();
+    updateErrors();
   }, 30 * 1000);
 
   // Update system sensors periodically (1min)
   setInterval(() => {
+    if (APP.exiting) {
+      return;
+    }
     update();
   }, 60 * 1000);
 
-  // Update package sensors periodically (60min)
+  // Update upgrade sensors periodically (1h)
   setInterval(() => {
+    if (APP.exiting) {
+      return;
+    }
+    updateApp();
     updatePackageUpgrades();
   }, 3600 * 1000);
 
@@ -119,15 +150,15 @@ const init = async () => {
  * Updates the shared integration properties.
  */
 const update = async () => {
-  if (!INTEGRATION.initialized) {
+  if (!INTEGRATION.initialized || APP.exiting) {
     return;
   }
 
   // Update client sensors
-  updateKiosk();
   updatePageNumber();
   updatePageZoom();
   updatePageUrl();
+  updateNetworkAddress();
   updateUpTime();
   updateLastActive();
   updateMemoryUsage();
@@ -136,6 +167,22 @@ const update = async () => {
   updateBatteryLevel();
 };
 
+/**
+ * Removes the auto-discovery config via the mqtt connection.
+ *
+ *  @param {string} type - The entity type name.
+ *  @param {Object} config - The configuration object.
+ *  @returns {Object} Instance of the mqtt client.
+ */
+const removeConfig = (type, config) => {
+  if (type === null || config === null) {
+    return INTEGRATION.client;
+  }
+  const path = config.unique_id.replace(`${INTEGRATION.node}_`, "");
+  const root = `${INTEGRATION.discovery}/${type}/${INTEGRATION.node}/${path}/config`;
+  return INTEGRATION.client.publish(root, JSON.stringify({}), { qos: 1, retain: true });
+};
+
 /**
  * Publishes the auto-discovery config via the mqtt connection.
  *
@@ -182,6 +229,63 @@ const publishState = (path, state) => {
   return INTEGRATION.client.publish(root, `${state}`, { qos: 1, retain: true });
 };
 
+/**
+ * Initializes the app update entity and handles the execute logic.
+ */
+const initApp = () => {
+  const root = `${INTEGRATION.root}/app`;
+  const config = {
+    name: "App",
+    unique_id: `${INTEGRATION.node}_app`,
+    command_topic: `${root}/install`,
+    state_topic: `${root}/version/state`,
+    payload_install: "app_early" in ARGS ? "update early" : "update",
+    device: INTEGRATION.device,
+  };
+  if (!HARDWARE.support.appUpdate) {
+    removeConfig("update", config);
+    return;
+  }
+  publishConfig("update", config)
+    .on("message", (topic, message) => {
+      if (topic === config.command_topic) {
+        console.info("Update App...");
+        hardware.setDisplayStatus("ON", () => {
+          const args = ["-c", `bash <(wget -qO- ${APP.scripts.install}) ${message.toString()}`];
+          hardware.execScriptCommand("bash", args, (progress, error) => {
+            if (progress) {
+              console.info(`Progress: ${progress}%`);
+            }
+            updateApp(progress);
+          });
+        });
+      }
+    })
+    .subscribe(config.command_topic);
+  updateApp();
+};
+
+/**
+ * Updates the app update entity via the mqtt connection.
+ */
+const updateApp = async (progress = 0) => {
+  const latest = APP.releases.latest;
+  if (!HARDWARE.support.appUpdate || !latest || !latest.summary) {
+    return;
+  }
+  const summary = latest.summary.length > 250 ? latest.summary.slice(0, 250) + "..." : latest.summary;
+  const version = {
+    title: latest.title,
+    latest_version: latest.version,
+    installed_version: APP.version,
+    release_summary: summary,
+    release_url: latest.url,
+    update_percentage: progress || null,
+    in_progress: progress && progress > 0 && progress < 100,
+  };
+  publishState("app/version", JSON.stringify(version));
+};
+
 /**
  * Initializes the shutdown button and handles the execute logic.
  */
@@ -194,12 +298,17 @@ const initShutdown = () => {
     icon: "mdi:power",
     device: INTEGRATION.device,
   };
+  if (!HARDWARE.support.sudoRights) {
+    removeConfig("button", config);
+    return;
+  }
   publishConfig("button", config)
     .on("message", (topic, message) => {
       if (topic === config.command_topic) {
-        console.log("Shutdown system...");
+        console.verbose("Shutdown system...");
-        hardware.setDisplayStatus("ON");
+        hardware.setDisplayStatus("ON", () => {
-        hardware.shutdownSystem();
+          hardware.shutdownSystem();
+        });
       }
     })
     .subscribe(config.command_topic);
@@ -217,12 +326,17 @@ const initReboot = () => {
     icon: "mdi:restart",
     device: INTEGRATION.device,
   };
+  if (!HARDWARE.support.sudoRights) {
+    removeConfig("button", config);
+    return;
+  }
   publishConfig("button", config)
     .on("message", (topic, message) => {
       if (topic === config.command_topic) {
-        console.log("Rebooting system...");
+        console.verbose("Rebooting system...");
-        hardware.setDisplayStatus("ON");
+        hardware.setDisplayStatus("ON", () => {
-        hardware.rebootSystem();
+          hardware.rebootSystem();
+        });
       }
     })
     .subscribe(config.command_topic);
@@ -243,9 +357,10 @@ const initRefresh = () => {
   publishConfig("button", config)
     .on("message", (topic, message) => {
       if (topic === config.command_topic) {
-        console.log("Refreshing webview...");
+        console.verbose("Refreshing webview...");
-        hardware.setDisplayStatus("ON");
+        hardware.setDisplayStatus("ON", () => {
-        WEBVIEW.events.emit("reloadView");
+          EVENTS.emit("reloadView");
+        });
       }
     })
     .subscribe(config.command_topic);
@@ -270,32 +385,10 @@ const initKiosk = () => {
     .on("message", (topic, message) => {
       if (topic === config.command_topic) {
         const status = message.toString();
-        console.log("Set Kiosk Status:", status);
+        console.verbose("Set Kiosk Status:", status);
-        hardware.setDisplayStatus("ON");
+        hardware.setDisplayStatus("ON", () => {
-        switch (status) {
+          WEBVIEW.window.setStatus(status);
-          case "Framed":
+        });
-            WEBVIEW.window.restore();
-            WEBVIEW.window.unmaximize();
-            WEBVIEW.window.setFullScreen(false);
-            break;
-          case "Fullscreen":
-            WEBVIEW.window.restore();
-            WEBVIEW.window.unmaximize();
-            WEBVIEW.window.setFullScreen(true);
-            break;
-          case "Maximized":
-            WEBVIEW.window.restore();
-            WEBVIEW.window.setFullScreen(false);
-            WEBVIEW.window.maximize();
-            break;
-          case "Minimized":
-            WEBVIEW.window.restore();
-            WEBVIEW.window.setFullScreen(false);
-            WEBVIEW.window.minimize();
-            break;
-          case "Terminated":
-            app.quit();
-        }
       }
     })
     .subscribe(config.command_topic);
@@ -305,18 +398,50 @@ const initKiosk = () => {
 /**
  * Updates the kiosk status via the mqtt connection.
  */
-const updateKiosk = () => {
+const updateKiosk = async () => {
-  const kiosk = WEBVIEW.status;
+  const kiosk = WEBVIEW.tracker.window.status;
   publishState("kiosk", kiosk);
 };
 
+/**
+ * Initializes the application theme and handles the execute logic.
+ */
+const initTheme = () => {
+  const root = `${INTEGRATION.root}/theme`;
+  const config = {
+    name: "Theme",
+    unique_id: `${INTEGRATION.node}_theme`,
+    command_topic: `${root}/set`,
+    state_topic: `${root}/state`,
+    value_template: "{{ value }}",
+    options: ["Light", "Dark"],
+    icon: "mdi:compare",
+    device: INTEGRATION.device,
+  };
+  publishConfig("select", config)
+    .on("message", (topic, message) => {
+      if (topic === config.command_topic) {
+        const theme = message.toString();
+        console.verbose("Set Application Theme:", theme);
+        WEBVIEW.theme.set(theme);
+      }
+    })
+    .subscribe(config.command_topic);
+  updateTheme();
+};
+
+/**
+ * Updates the application theme via the mqtt connection.
+ */
+const updateTheme = async () => {
+  const theme = WEBVIEW.theme.get();
+  publishState("theme", theme.charAt(0).toUpperCase() + theme.slice(1));
+};
+
 /**
  * Initializes the display status, brightness and handles the execute logic.
  */
 const initDisplay = () => {
-  if (!HARDWARE.support.displayStatus) {
-    return;
-  }
   const root = `${INTEGRATION.root}/display`;
   const config = {
     name: "Display",
@@ -332,26 +457,30 @@ const initDisplay = () => {
       brightness_scale: 100,
     }),
   };
+  if (!HARDWARE.support.displayStatus) {
+    removeConfig("light", config);
+    return;
+  }
   publishConfig("light", config)
     .on("message", (topic, message) => {
       if (topic === config.command_topic) {
         const status = message.toString();
-        console.log("Set Display Status:", status);
+        console.verbose("Set Display Status:", status);
         hardware.setDisplayStatus(status, (reply, error) => {
-          if (error) {
+          if (!error) {
-            console.warn("Failed:", error);
-          } else {
             hardware.update();
+          } else {
+            console.warn("Command Failed:", error);
           }
         });
       } else if (topic === config.brightness_command_topic) {
         const brightness = parseInt(message, 10);
-        console.log("Set Display Brightness:", brightness);
+        console.verbose("Set Display Brightness:", brightness);
         hardware.setDisplayBrightness(brightness, (reply, error) => {
-          if (error) {
+          if (!error) {
-            console.warn("Failed:", error);
-          } else {
             hardware.update();
+          } else {
+            console.warn("Command Failed:", error);
           }
         });
       }
@@ -364,20 +493,59 @@ const initDisplay = () => {
 /**
  * Updates the display status, brightness via the mqtt connection.
  */
-const updateDisplay = () => {
+const updateDisplay = async () => {
   const status = hardware.getDisplayStatus();
   const brightness = hardware.getDisplayBrightness();
   publishState("display/power", status);
   publishState("display/brightness", brightness);
 };
 
+/**
+ * Initializes the audio volume and handles the execute logic.
+ */
+const initVolume = () => {
+  const root = `${INTEGRATION.root}/volume`;
+  const config = {
+    name: "Volume",
+    unique_id: `${INTEGRATION.node}_volume`,
+    command_topic: `${root}/set`,
+    state_topic: `${root}/state`,
+    value_template: "{{ value | int }}",
+    mode: "slider",
+    min: 0,
+    max: 100,
+    unit_of_measurement: "%",
+    icon: "mdi:volume-high",
+    device: INTEGRATION.device,
+  };
+  if (!HARDWARE.support.audioVolume) {
+    removeConfig("number", config);
+    return;
+  }
+  publishConfig("number", config)
+    .on("message", (topic, message) => {
+      if (topic === config.command_topic) {
+        const volume = parseInt(message, 10);
+        console.verbose("Set Audio Volume:", volume);
+        hardware.setAudioVolume(volume);
+      }
+    })
+    .subscribe(config.command_topic);
+  updateVolume();
+};
+
+/**
+ * Updates the audio volume via the mqtt connection.
+ */
+const updateVolume = async () => {
+  const volume = hardware.getAudioVolume();
+  publishState("volume", volume);
+};
+
 /**
  * Initializes the keyboard visibility and handles the execute logic.
  */
 const initKeyboard = () => {
-  if (!HARDWARE.support.keyboardVisibility) {
-    return;
-  }
   const root = `${INTEGRATION.root}/keyboard`;
   const config = {
     name: "Keyboard",
@@ -387,24 +555,18 @@ const initKeyboard = () => {
     icon: "mdi:keyboard-close-outline",
     device: INTEGRATION.device,
   };
+  if (!HARDWARE.support.keyboardVisibility) {
+    removeConfig("switch", config);
+    return;
+  }
   publishConfig("switch", config)
     .on("message", (topic, message) => {
       if (topic === config.command_topic) {
         const status = message.toString();
-        console.log("Set Keyboard Visibility:", status);
+        console.verbose("Set Keyboard Visibility:", status);
-        hardware.setKeyboardVisibility(status);
+        hardware.setDisplayStatus("ON", () => {
-        switch (status) {
+          hardware.setKeyboardVisibility(status);
-          case "OFF":
+        });
-            WEBVIEW.window.restore();
-            WEBVIEW.window.unmaximize();
-            WEBVIEW.window.setFullScreen(true);
-            break;
-          case "ON":
-            WEBVIEW.window.restore();
-            WEBVIEW.window.setFullScreen(false);
-            WEBVIEW.window.maximize();
-            break;
-        }
       }
     })
     .subscribe(config.command_topic);
@@ -414,7 +576,7 @@ const initKeyboard = () => {
 /**
  * Updates the keyboard visibility via the mqtt connection.
  */
-const updateKeyboard = () => {
+const updateKeyboard = async () => {
   const visibility = hardware.getKeyboardVisibility();
   publishState("keyboard", visibility);
 };
@@ -423,9 +585,6 @@ const updateKeyboard = () => {
  * Initializes the page number and handles the execute logic.
  */
 const initPageNumber = () => {
-  if (WEBVIEW.viewUrls.length < 3) {
-    return;
-  }
   const root = `${INTEGRATION.root}/page_number`;
   const config = {
     name: "Page Number",
@@ -440,13 +599,17 @@ const initPageNumber = () => {
     icon: "mdi:page-next",
     device: INTEGRATION.device,
   };
+  if (WEBVIEW.viewUrls.length <= 2) {
+    removeConfig("number", config);
+    return;
+  }
   publishConfig("number", config)
     .on("message", (topic, message) => {
       if (topic === config.command_topic) {
         const number = parseInt(message, 10);
-        console.log("Set Page Number:", number);
+        console.verbose("Set Page Number:", number);
         WEBVIEW.viewActive = number || 1;
-        WEBVIEW.events.emit("updateView");
+        EVENTS.emit("updateView");
       }
     })
     .subscribe(config.command_topic);
@@ -456,8 +619,8 @@ const initPageNumber = () => {
 /**
  * Updates the page number via the mqtt connection.
  */
-const updatePageNumber = () => {
+const updatePageNumber = async () => {
-  const pageNumber = WEBVIEW.viewActive || 1;
+  const pageNumber = WEBVIEW.viewUrls.length <= 2 ? null : WEBVIEW.viewActive || 1;
   publishState("page_number", pageNumber);
 };
 
@@ -472,9 +635,10 @@ const initPageZoom = () => {
     command_topic: `${root}/set`,
     state_topic: `${root}/state`,
     value_template: "{{ value | int }}",
-    mode: "slider",
+    mode: "box",
     min: 25,
     max: 400,
+    step: 5,
     unit_of_measurement: "%",
     icon: "mdi:magnify-plus",
     device: INTEGRATION.device,
@@ -483,9 +647,9 @@ const initPageZoom = () => {
     .on("message", (topic, message) => {
       if (topic === config.command_topic) {
         const zoom = parseInt(message, 10);
-        console.log("Set Page Zoom:", zoom);
+        console.verbose("Set Page Zoom:", zoom);
         WEBVIEW.views[WEBVIEW.viewActive || 1].webContents.setZoomFactor(zoom / 100.0);
-        WEBVIEW.events.emit("updateView");
+        EVENTS.emit("updateView");
       }
     })
     .subscribe(config.command_topic);
@@ -495,7 +659,7 @@ const initPageZoom = () => {
 /**
  * Updates the page zoom via the mqtt connection.
  */
-const updatePageZoom = () => {
+const updatePageZoom = async () => {
   const pageZoom = Math.round(WEBVIEW.views[WEBVIEW.viewActive || 1].webContents.getZoomFactor() * 100.0);
   publishState("page_zoom", pageZoom);
 };
@@ -519,7 +683,7 @@ const initPageUrl = () => {
     .on("message", (topic, message) => {
       if (topic === config.command_topic) {
         const url = message.toString();
-        console.log("Set Page Url:", url);
+        console.verbose("Set Page Url:", url);
         WEBVIEW.views[WEBVIEW.viewActive || 1].webContents.loadURL(url);
       }
     })
@@ -530,7 +694,7 @@ const initPageUrl = () => {
 /**
  * Updates the page url via the mqtt connection.
  */
-const updatePageUrl = () => {
+const updatePageUrl = async () => {
   const defaultUrl = WEBVIEW.viewUrls[WEBVIEW.viewActive || 1];
   const currentUrl = WEBVIEW.views[WEBVIEW.viewActive || 1].webContents.getURL();
   const pageUrl = !currentUrl || currentUrl.startsWith("data:") ? defaultUrl : currentUrl;
@@ -546,6 +710,7 @@ const initModel = () => {
     name: "Model",
     unique_id: `${INTEGRATION.node}_model`,
     state_topic: `${root}/state`,
+    json_attributes_topic: `${root}/attributes`,
     value_template: "{{ value }}",
     icon: "mdi:raspberry-pi",
     device: INTEGRATION.device,
@@ -557,9 +722,10 @@ const initModel = () => {
 /**
  * Updates the model sensor via the mqtt connection.
  */
-const updateModel = () => {
+const updateModel = async () => {
   const model = hardware.getModel();
   publishState("model", model);
+  publishAttributes("model", HARDWARE.support);
 };
 
 /**
@@ -582,11 +748,41 @@ const initSerialNumber = () => {
 /**
  * Updates the serial number sensor via the mqtt connection.
  */
-const updateSerialNumber = () => {
+const updateSerialNumber = async () => {
   const serialNumber = hardware.getSerialNumber();
   publishState("serial_number", serialNumber);
 };
 
+/**
+ * Initializes the network address sensor.
+ */
+const initNetworkAddress = () => {
+  const root = `${INTEGRATION.root}/network_address`;
+  const config = {
+    name: "Network Address",
+    unique_id: `${INTEGRATION.node}_network_address`,
+    state_topic: `${root}/state`,
+    json_attributes_topic: `${root}/attributes`,
+    value_template: "{{ value }}",
+    icon: "mdi:ip-network",
+    device: INTEGRATION.device,
+  };
+  publishConfig("sensor", config);
+  updateNetworkAddress();
+};
+
+/**
+ * Updates the network address sensor via the mqtt connection.
+ */
+const updateNetworkAddress = async () => {
+  const networkAddresses = hardware.getNetworkAddresses();
+  const [name] = Object.keys(networkAddresses);
+  const [family] = name ? Object.keys(networkAddresses[name]) : [];
+  const networkAddress = networkAddresses[name]?.[family]?.[0] || null;
+  publishState("network_address", networkAddress);
+  publishAttributes("network_address", networkAddresses);
+};
+
 /**
  * Initializes the host name sensor.
  */
@@ -607,7 +803,7 @@ const initHostName = () => {
 /**
  * Updates the host name sensor via the mqtt connection.
  */
-const updateHostName = () => {
+const updateHostName = async () => {
   const hostName = hardware.getHostName();
   publishState("host_name", hostName);
 };
@@ -621,6 +817,7 @@ const initUpTime = () => {
     name: "Up Time",
     unique_id: `${INTEGRATION.node}_up_time`,
     state_topic: `${root}/state`,
+    json_attributes_topic: `${root}/attributes`,
     value_template: "{{ (value | float) | round(0) }}",
     unit_of_measurement: "min",
     icon: "mdi:timeline-clock",
@@ -633,9 +830,13 @@ const initUpTime = () => {
 /**
  * Updates the up time sensor via the mqtt connection.
  */
-const updateUpTime = () => {
+const updateUpTime = async () => {
   const upTime = hardware.getUpTime();
+  const bootTime = {
+    boot: new Date(new Date().getTime() - upTime * 60 * 1000),
+  };
   publishState("up_time", upTime);
+  publishAttributes("up_time", bootTime);
 };
 
 /**
@@ -659,7 +860,7 @@ const initMemorySize = () => {
 /**
  * Updates the memory size sensor via the mqtt connection.
  */
-const updateMemorySize = () => {
+const updateMemorySize = async () => {
   const memorySize = hardware.getMemorySize();
   publishState("memory_size", memorySize);
 };
@@ -685,7 +886,7 @@ const initMemoryUsage = () => {
 /**
  * Updates the memory usage sensor via the mqtt connection.
  */
-const updateMemoryUsage = () => {
+const updateMemoryUsage = async () => {
   const memoryUsage = hardware.getMemoryUsage();
   publishState("memory_usage", memoryUsage);
 };
@@ -711,7 +912,7 @@ const initProcessorUsage = () => {
 /**
  * Updates the processor usage sensor via the mqtt connection.
  */
-const updateProcessorUsage = () => {
+const updateProcessorUsage = async () => {
   const processorUsage = hardware.getProcessorUsage();
   publishState("processor_usage", processorUsage);
 };
@@ -737,7 +938,7 @@ const initProcessorTemperature = () => {
 /**
  * Updates the processor temperature sensor via the mqtt connection.
  */
-const updateProcessorTemperature = () => {
+const updateProcessorTemperature = async () => {
   const processorTemperature = hardware.getProcessorTemperature();
   publishState("processor_temperature", processorTemperature);
 };
@@ -746,9 +947,6 @@ const updateProcessorTemperature = () => {
  * Initializes the battery level sensor.
  */
 const initBatteryLevel = () => {
-  if (!HARDWARE.support.batteryLevel) {
-    return;
-  }
   const root = `${INTEGRATION.root}/battery_level`;
   const config = {
     name: "Battery Level",
@@ -759,6 +957,10 @@ const initBatteryLevel = () => {
     icon: "mdi:battery-medium",
     device: INTEGRATION.device,
   };
+  if (!HARDWARE.support.batteryLevel) {
+    removeConfig("sensor", config);
+    return;
+  }
   publishConfig("sensor", config);
   updateBatteryLevel();
 };
@@ -766,7 +968,7 @@ const initBatteryLevel = () => {
 /**
  * Updates the battery level sensor via the mqtt connection.
  */
-const updateBatteryLevel = () => {
+const updateBatteryLevel = async () => {
   const batteryLevel = hardware.getBatteryLevel();
   publishState("battery_level", batteryLevel);
 };
@@ -792,41 +994,16 @@ const initPackageUpgrades = () => {
 /**
  * Updates the package upgrades sensor via the mqtt connection.
  */
-const updatePackageUpgrades = () => {
+const updatePackageUpgrades = async () => {
   const packages = hardware.checkPackageUpgrades();
-  const attributes = {
+  const upgrades = {
-    total: packages.length,
+    packages: packages.map((pkg) => {
-    packages: packages.map((pkg) => pkg.replace(/\s*\[.*?\]\s*/g, "").trim()),
+      const [name, version] = pkg.replace(/\s*\[.*?\]\s*/g, "").split(/\s+/, 2);
+      return { [name]: version };
+    }),
   };
-  publishAttributes("package_upgrades", attributes);
+  publishState("package_upgrades", packages.length);
-  publishState("package_upgrades", attributes.total);
+  publishAttributes("package_upgrades", upgrades);
-};
-
-/**
- * Initializes the heartbeat sensor.
- */
-const initHeartbeat = () => {
-  const root = `${INTEGRATION.root}/heartbeat`;
-  const config = {
-    name: "Heartbeat",
-    unique_id: `${INTEGRATION.node}_heartbeat`,
-    state_topic: `${root}/state`,
-    value_template: "{{ value }}",
-    icon: "mdi:heart-flash",
-    device: INTEGRATION.device,
-  };
-  publishConfig("sensor", config);
-  updateHeartbeat();
-};
-
-/**
- * Updates the heartbeat sensor via the mqtt connection.
- */
-const updateHeartbeat = () => {
-  const now = new Date();
-  const local = new Date(now.getTime() - now.getTimezoneOffset() * 60 * 1000);
-  const heartbeat = local.toISOString().replace(/\.\d{3}Z$/, "");
-  publishState("heartbeat", heartbeat);
 };
 
 /**
@@ -838,6 +1015,7 @@ const initLastActive = () => {
     name: "Last Active",
     unique_id: `${INTEGRATION.node}_last_active`,
     state_topic: `${root}/state`,
+    json_attributes_topic: `${root}/attributes`,
     value_template: "{{ (value | float) | round(0) }}",
     unit_of_measurement: "min",
     icon: "mdi:gesture-tap-hold",
@@ -850,11 +1028,111 @@ const initLastActive = () => {
 /**
  * Updates the last active sensor via the mqtt connection.
  */
-const updateLastActive = () => {
+const updateLastActive = async () => {
   const now = new Date();
-  const then = WEBVIEW.pointer.time;
+  const then = WEBVIEW.tracker.pointer.time;
-  const lastActive = Math.abs(now - then) / (1000 * 60);
+  const lastActive = (now - then) / (1000 * 60);
+  const tracker = {
+    ...WEBVIEW.tracker.pointer.position,
+    ...WEBVIEW.tracker.display,
+  };
   publishState("last_active", lastActive);
+  publishAttributes("last_active", tracker);
+};
+
+/**
+ * Initializes the heartbeat sensor.
+ */
+const initHeartbeat = () => {
+  const root = `${INTEGRATION.root}/heartbeat`;
+  const config = {
+    name: "Heartbeat",
+    unique_id: `${INTEGRATION.node}_heartbeat`,
+    state_topic: `${root}/state`,
+    json_attributes_topic: `${root}/attributes`,
+    value_template: "{{ value }}",
+    entity_category: "diagnostic",
+    icon: "mdi:heart-flash",
+    device: INTEGRATION.device,
+  };
+  publishConfig("sensor", config);
+  updateHeartbeat();
+};
+
+/**
+ * Updates the heartbeat sensor via the mqtt connection.
+ */
+const updateHeartbeat = async () => {
+  const now = new Date();
+  const local = new Date(now.getTime() - now.getTimezoneOffset() * 60 * 1000);
+  const heartbeat = local.toISOString().replace(/\.\d{3}Z$/, "");
+  const attributes = { date: now };
+  publishState("heartbeat", heartbeat);
+  publishAttributes("heartbeat", attributes);
+};
+
+/**
+ * Initializes the error log sensor.
+ */
+const initErrors = () => {
+  const root = `${INTEGRATION.root}/errors`;
+  const config = {
+    name: "Errors",
+    unique_id: `${INTEGRATION.node}_errors`,
+    state_topic: `${root}/state`,
+    json_attributes_topic: `${root}/attributes`,
+    value_template: "{{ value | int }}",
+    entity_category: "diagnostic",
+    icon: "mdi:alert-circle",
+    device: INTEGRATION.device,
+  };
+  publishConfig("sensor", config);
+  updateErrors();
+};
+
+/**
+ * Updates the error log sensor via the mqtt connection.
+ */
+const updateErrors = async () => {
+  const logs = APP.logs.slice().reverse();
+  const errors = logs.filter((log) => log.level === "error");
+  const history = logs.reduce((acc, log) => {
+    const time = log.time.toISOString().slice(0, 16);
+    if (!acc[time]) {
+      acc[time] = [];
+    }
+    acc[time].push({ [log.level.toUpperCase()]: log.text });
+    return acc;
+  }, {});
+  publishState("errors", errors.length);
+  publishAttributes("errors", history);
+};
+
+/**
+ * Initializes the version sensor.
+ */
+const initVersion = () => {
+  const root = `${INTEGRATION.root}/version`;
+  const config = {
+    name: "Version",
+    unique_id: `${INTEGRATION.node}_version`,
+    state_topic: `${root}/state`,
+    json_attributes_topic: `${root}/attributes`,
+    value_template: "{{ value }}",
+    entity_category: "diagnostic",
+    icon: "mdi:application-braces",
+    device: INTEGRATION.device,
+  };
+  publishConfig("sensor", config);
+  updateVersion();
+};
+
+/**
+ * Updates the version sensor via the mqtt connection.
+ */
+const updateVersion = async () => {
+  publishState("version", APP.version);
+  publishAttributes("version", APP.build);
 };
 
 module.exports = {

package.json

@@ -1,28 +1,31 @@
 {
     "name": "touchkio",
+    "title": "TouchKio",
     "description": "Home Assistant Touch Kiosk",
     "homepage": "https://github.com/leukipp/touchkio",
     "author": "leukipp",
-    "version": "1.2.1",
+    "version": "1.4.0",
     "license": "MIT",
     "main": "index.js",
     "scripts": {
-        "start": "electron . --web-url=https://demo.home-assistant.io,https://demo.immichkiosk.app --app-debug=false --trace-warnings",
+        "start": "electron . --web-url=https://demo.home-assistant.io,https://demo.immichkiosk.app --trace-warnings",
         "build": "electron-forge make"
     },
     "prettier": {
         "printWidth": 120
     },
     "devDependencies": {
-        "@electron-forge/cli": "^7.8.3",
+        "@electron-forge/cli": "^7.10.0",
-        "@electron-forge/maker-deb": "^7.8.3",
+        "@electron-forge/maker-deb": "^7.10.0",
-        "@electron-forge/maker-zip": "^7.8.3",
+        "@electron-forge/maker-zip": "^7.10.0",
-        "@electron-forge/publisher-github": "^7.8.3",
+        "@electron-forge/publisher-github": "^7.10.0",
-        "electron": "^37.4.0",
+        "electron": "^38.2.2",
+        "jszip": "^3.10.1",
         "prettier": "^3.6.2"
     },
     "dependencies": {
-        "axios": "^1.11.0",
+        "axios": "^1.12.2",
-        "mqtt": "^5.14.0"
+        "electron-log": "^5.4.3",
+        "mqtt": "^5.14.1"
     }
 }