Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
099fe5a714 | ||
|
|
b63f2aee34 | ||
|
|
9d88a9ba38 | ||
|
|
bae0ef26fe | ||
|
|
f0438d7c88 | ||
|
|
f46649780c | ||
|
|
73edbaedb7 | ||
|
|
3b150fc540 | ||
|
|
7c96fbf427 | ||
|
|
fc31721ae0 | ||
|
|
fb841cce14 | ||
|
|
d5caffe9fd | ||
|
|
2442d4a681 | ||
|
|
ab0c1284fb | ||
|
|
55e528d95b | ||
|
|
ffcc9517f2 | ||
|
|
3ea4921861 | ||
|
|
1e91b7aa27 | ||
|
|
eb4b101f45 | ||
|
|
290e524901 | ||
|
|
4b010925ed | ||
|
|
910001f0e1 | ||
|
|
61628b1864 | ||
|
|
1a79ffd855 | ||
|
|
5423239e62 | ||
|
|
44a4fa9d2d | ||
|
|
26494e6844 | ||
|
|
4f8a9c307c | ||
|
|
a3860ebd69 | ||
|
|
b3a787d03d | ||
|
|
41e4c2d434 | ||
|
|
77cb962e6f | ||
|
|
c85055a222 | ||
|
|
81b4c30aa2 | ||
|
|
e6d8c537f2 | ||
|
|
0c51c1c1ff | ||
|
|
45ea309f3b | ||
|
|
e195a56739 | ||
|
|
d86a5385a8 | ||
|
|
3ce1265c8a | ||
|
|
c2bf551834 | ||
|
|
785a97721a | ||
|
|
05c9d98b61 | ||
|
|
9c26d9d8bb | ||
|
|
ad7d3fd3ff | ||
|
|
f666ed57ab | ||
|
|
c0b1a6e9ce | ||
|
|
19e51e349c | ||
|
|
5d012bd637 | ||
|
|
01c7411ddc | ||
|
|
3e4d96536f | ||
|
|
4bcb2c4e89 | ||
|
|
b2b87888e4 | ||
|
|
164ef2838c | ||
|
|
ae2633800d | ||
|
|
552f0e19a4 | ||
|
|
890c84d69d | ||
|
|
ac69dee387 | ||
|
|
ac62dc17ce | ||
|
|
f2f80e7d52 | ||
|
|
10e7ff078a | ||
|
|
e677fff160 | ||
|
|
63db26611e | ||
|
|
5ec6577b5a | ||
|
|
0359742e70 | ||
|
|
b70f4074e5 | ||
|
|
a4c300407b | ||
|
|
758f64ced4 | ||
|
|
7ab803d4ca | ||
|
|
092697850d | ||
|
|
422e92dd89 | ||
|
|
a15c0fc91d | ||
|
|
358fa3ca9c | ||
|
|
10722fa217 | ||
|
|
7267fafb97 | ||
|
|
b5e95936dc | ||
|
|
047b38a41b | ||
|
|
a93fbb2ad3 | ||
|
|
0b927a3ef6 | ||
|
|
d35cf27de9 | ||
|
|
19348b4b60 | ||
|
|
ce1eed391d | ||
|
|
fe6fe92656 | ||
|
|
3aea938cfb | ||
|
|
c39428fa42 | ||
|
|
7caa5bfc8a | ||
|
|
5f69961a9f | ||
|
|
f44d998016 | ||
|
|
3ea65a4af8 | ||
|
|
2ad49c3167 | ||
|
|
ef2093a25e | ||
|
|
2737eabd8a | ||
|
|
b8f809c50e | ||
|
|
c3e625a8f6 | ||
|
|
7c15707e3b | ||
|
|
dbd3756793 | ||
|
|
85fe5a910a | ||
|
|
d78088e6af | ||
|
|
bf77d9b2a0 | ||
|
|
f4ca7bc412 | ||
|
|
d0ea377ead | ||
|
|
9a829f72e3 | ||
|
|
482a56c9b9 | ||
|
|
32409983b2 | ||
|
|
fe0667919e | ||
|
|
0037a892cd | ||
|
|
ad22dd3215 | ||
|
|
619179c3c8 | ||
|
|
7e5e669b09 | ||
|
|
437c4ab1c5 |
@@ -0,0 +1,116 @@
|
||||
name: Report a bug in the application
|
||||
description: I encountered a bug that was not reported before.
|
||||
title: "[Bug]: "
|
||||
labels: ["bug"]
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
This issue form is for reporting unknown bugs only!
|
||||
- [x] I promise to have read the [FAQ](https://github.com/leukipp/touchkio/blob/main/HARDWARE.md#faq) section in the hardware documentation first! 🤞
|
||||
- [x] I promise to have read the [ISSUES](https://github.com/leukipp/touchkio?tab=readme-ov-file#issues) section and know how to debug the application! 🤞
|
||||
- [x] I also swear to have searched for similar open and closed issues on [GITHUB](https://github.com/leukipp/touchkio/issues?q=is%3Aissue) first! 🤞
|
||||
- type: textarea
|
||||
id: problem_description
|
||||
validations:
|
||||
required: true
|
||||
attributes:
|
||||
label: Problem description
|
||||
placeholder: problem description
|
||||
description: |
|
||||
Describe the issue you are experiencing and how to reproduce it.
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
## Details
|
||||
- type: input
|
||||
id: app_version
|
||||
validations:
|
||||
required: true
|
||||
attributes:
|
||||
label: What version of touchkio is used?
|
||||
placeholder: v
|
||||
description: >
|
||||
Can be found on the MQTT device under `Diagnostics > Version`.
|
||||
- type: input
|
||||
id: operating_system
|
||||
validations:
|
||||
required: true
|
||||
attributes:
|
||||
label: What operating system and version is used?
|
||||
description: >
|
||||
Raspberry Pi OS (Trixie), Ubuntu (24.04), etc.
|
||||
- type: dropdown
|
||||
id: display_server
|
||||
validations:
|
||||
required: true
|
||||
attributes:
|
||||
label: Which display server is configured on the system?
|
||||
description: >
|
||||
Use `loginctl show-session $(loginctl show-user $(whoami) -p Display --value) -p Type --value` to find out.
|
||||
options:
|
||||
- Wayland
|
||||
- X11
|
||||
- Other
|
||||
- type: input
|
||||
id: system_hardware
|
||||
validations:
|
||||
required: true
|
||||
attributes:
|
||||
label: Which system hardware is used?
|
||||
description: >
|
||||
Raspberry Pi 5 (8GB RAM), Intel NUC 14 (16GB RAM), etc.
|
||||
- type: input
|
||||
id: screen_hardware
|
||||
validations:
|
||||
required: true
|
||||
attributes:
|
||||
label: Which screen hardware is used?
|
||||
description: >
|
||||
Waveshare 8" CAPLCD (768x1024), Raspberry Pi 7" Touch Display 2 (720x1280), etc.
|
||||
- type: dropdown
|
||||
id: screen_connection
|
||||
validations:
|
||||
required: true
|
||||
attributes:
|
||||
label: Which screen connection type is used?
|
||||
description: >
|
||||
Choose the connection type between your screen and the host machine.
|
||||
options:
|
||||
- DSI
|
||||
- HDMI
|
||||
- HDMI + USB
|
||||
- Other
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
## Diagnostics
|
||||
- type: textarea
|
||||
id: arguments_json
|
||||
validations:
|
||||
required: false
|
||||
attributes:
|
||||
label: Used arguments
|
||||
placeholder: arguments json
|
||||
description: |
|
||||
You can use `cat ~/.config/touchkio/Arguments.json` to get the file content.
|
||||
render: json
|
||||
- type: textarea
|
||||
id: log_file
|
||||
validations:
|
||||
required: false
|
||||
attributes:
|
||||
label: Log file
|
||||
placeholder: drag-and-drop the file or copy-and-paste the full content here
|
||||
description: |
|
||||
From the host machine use `scp USER@IP:~/.config/touchkio/logs/main.log main.log` to download the log file.
|
||||
Alternatively, you can use `cat ~/.config/touchkio/logs/main.log` on a ssh connection to get the file content.
|
||||
- type: textarea
|
||||
id: additional_information
|
||||
validations:
|
||||
required: false
|
||||
attributes:
|
||||
label: Additional information
|
||||
placeholder: additional information
|
||||
description: |
|
||||
If you have any additional information that might be useful, use this field.
|
||||
@@ -0,0 +1,82 @@
|
||||
name: Request a new feature for the application
|
||||
description: I want to request a new feature that is not yet available.
|
||||
title: "[Feature]: "
|
||||
labels: ["enhancement"]
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
This issue form is for requesting new features only!
|
||||
- [x] I promise to have read the [FAQ](https://github.com/leukipp/touchkio/blob/main/HARDWARE.md#faq) section in the hardware documentation first! 🤞
|
||||
- [x] I also swear to have searched for similar open and closed feature requests on [GITHUB](https://github.com/leukipp/touchkio/issues?q=is%3Aissue) first! 🤞
|
||||
- type: textarea
|
||||
id: feature_description
|
||||
validations:
|
||||
required: true
|
||||
attributes:
|
||||
label: Feature description
|
||||
placeholder: feature description
|
||||
description: |
|
||||
Describe the feature you want to request and why it would be useful for others.
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
## Details
|
||||
- type: input
|
||||
id: app_version
|
||||
validations:
|
||||
required: true
|
||||
attributes:
|
||||
label: What version of touchkio is used?
|
||||
placeholder: v
|
||||
description: >
|
||||
Can be found on the MQTT device under `Diagnostics > Version`.
|
||||
- type: input
|
||||
id: operating_system
|
||||
validations:
|
||||
required: true
|
||||
attributes:
|
||||
label: What operating system and version is used?
|
||||
description: >
|
||||
Raspberry Pi OS (Trixie), Ubuntu (24.04), etc.
|
||||
- type: dropdown
|
||||
id: display_server
|
||||
validations:
|
||||
required: true
|
||||
attributes:
|
||||
label: Which display server is configured on the system?
|
||||
description: >
|
||||
Use `loginctl show-session $(loginctl show-user $(whoami) -p Display --value) -p Type --value` to find out.
|
||||
options:
|
||||
- Wayland
|
||||
- X11
|
||||
- Other
|
||||
- type: input
|
||||
id: system_hardware
|
||||
validations:
|
||||
required: true
|
||||
attributes:
|
||||
label: Which system hardware is used?
|
||||
description: >
|
||||
Raspberry Pi 5 (8GB RAM), Intel NUC 14 (16GB RAM), etc.
|
||||
- type: input
|
||||
id: screen_hardware
|
||||
validations:
|
||||
required: true
|
||||
attributes:
|
||||
label: Which screen hardware is used?
|
||||
description: >
|
||||
Waveshare 8" CAPLCD (768x1024), Raspberry Pi 7" Touch Display 2 (720x1280), etc.
|
||||
- type: dropdown
|
||||
id: screen_connection
|
||||
validations:
|
||||
required: true
|
||||
attributes:
|
||||
label: Which screen connection type is used?
|
||||
description: >
|
||||
Choose the connection type between your screen and the host machine.
|
||||
options:
|
||||
- DSI
|
||||
- HDMI
|
||||
- HDMI + USB
|
||||
- Other
|
||||
@@ -0,0 +1,82 @@
|
||||
name: General inquiry or suggestion for the project
|
||||
description: I want to ask a question or improve the documentation.
|
||||
title: "[General]: "
|
||||
labels: ["question"]
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
This issue form is for general inquiries only!
|
||||
- [x] I promise that the `Report a bug in the application` issue form isn't suitable for my inquiry! 🤞
|
||||
- [x] I promise that the `Request a new feature for the application` issue form isn't suitable for my inquiry! 🤞
|
||||
- type: textarea
|
||||
id: general_comment
|
||||
validations:
|
||||
required: true
|
||||
attributes:
|
||||
label: General comment
|
||||
placeholder: general comment
|
||||
description: |
|
||||
Ask a question, request some help, leave a general information or suggest an improvement for the documentation.
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
## Details (optional)
|
||||
- type: input
|
||||
id: app_version
|
||||
validations:
|
||||
required: false
|
||||
attributes:
|
||||
label: What version of touchkio is used?
|
||||
placeholder: v
|
||||
description: >
|
||||
Can be found on the MQTT device under `Diagnostics > Version`.
|
||||
- type: input
|
||||
id: operating_system
|
||||
validations:
|
||||
required: false
|
||||
attributes:
|
||||
label: What operating system and version is used?
|
||||
description: >
|
||||
Raspberry Pi OS (Trixie), Ubuntu (24.04), etc.
|
||||
- type: dropdown
|
||||
id: display_server
|
||||
validations:
|
||||
required: false
|
||||
attributes:
|
||||
label: Which display server is configured on the system?
|
||||
description: >
|
||||
Use `loginctl show-session $(loginctl show-user $(whoami) -p Display --value) -p Type --value` to find out.
|
||||
options:
|
||||
- Wayland
|
||||
- X11
|
||||
- Other
|
||||
- type: input
|
||||
id: system_hardware
|
||||
validations:
|
||||
required: false
|
||||
attributes:
|
||||
label: Which system hardware is used?
|
||||
description: >
|
||||
Raspberry Pi 5 (8GB RAM), Intel NUC 14 (16GB RAM), etc.
|
||||
- type: input
|
||||
id: screen_hardware
|
||||
validations:
|
||||
required: false
|
||||
attributes:
|
||||
label: Which screen hardware is used?
|
||||
description: >
|
||||
Waveshare 8" CAPLCD (768x1024), Raspberry Pi 7" Touch Display 2 (720x1280), etc.
|
||||
- type: dropdown
|
||||
id: screen_connection
|
||||
validations:
|
||||
required: false
|
||||
attributes:
|
||||
label: Which screen connection type is used?
|
||||
description: >
|
||||
Choose the connection type between your screen and the host machine.
|
||||
options:
|
||||
- DSI
|
||||
- HDMI
|
||||
- HDMI + USB
|
||||
- Other
|
||||
@@ -0,0 +1 @@
|
||||
blank_issues_enabled: false
|
||||
@@ -0,0 +1 @@
|
||||
github: leukipp
|
||||
@@ -1,3 +1,4 @@
|
||||
node_modules/
|
||||
docs/
|
||||
out/
|
||||
build.json
|
||||
|
||||
+237
-16
@@ -18,34 +18,255 @@ If you are running Linux with a graphical user interface (Wayland or X11), you s
|
||||
|
||||
### DSI
|
||||
| Device | System | Display | Status |
|
||||
| ---------------------- | -------------------------------------- | --------------------------------------------------------------------------------------------------------- | ------ |
|
||||
| Raspberry Pi 3 (arm64) | Raspberry Pi OS (64-bit), Wayland, X11 | [Official 7" Touch Display 1 (800x480)](https://www.raspberrypi.com/products/raspberry-pi-touch-display/) | ⬜ |
|
||||
| Raspberry Pi 3 (arm64) | Raspberry Pi OS (64-bit), Wayland, X11 | [Official 7" Touch Display 2 (720x1280)](https://www.raspberrypi.com/products/touch-display-2/) | ⬜ |
|
||||
| Raspberry Pi 4 (arm64) | Raspberry Pi OS (64-bit), Wayland, X11 | [Official 7" Touch Display 1 (800x480)](https://www.raspberrypi.com/products/raspberry-pi-touch-display/) | 🟩 |
|
||||
| Raspberry Pi 4 (arm64) | Raspberry Pi OS (64-bit), Wayland, X11 | [Official 7" Touch Display 2 (720x1280)](https://www.raspberrypi.com/products/touch-display-2/) | 🟩 |
|
||||
| Raspberry Pi 5 (arm64) | Raspberry Pi OS (64-bit), Wayland, X11 | [Official 7" Touch Display 1 (800x480)](https://www.raspberrypi.com/products/raspberry-pi-touch-display/) | 🟩 |
|
||||
| Raspberry Pi 5 (arm64) | Raspberry Pi OS (64-bit), Wayland, X11 | [Official 7" Touch Display 2 (720x1280)](https://www.raspberrypi.com/products/touch-display-2/) | 🟩 |
|
||||
| ---------------------- | -------------------------------------- | -------------------------------------------------------------------------------------------------------- | ------ |
|
||||
| Raspberry Pi 3 (arm64) | Raspberry Pi OS (64-bit), Wayland, X11 | [Official 7" Touch Display 1 (800x480)](https://www.raspberrypi.com/products/raspberry-pi-touch-display) | ⬜ |
|
||||
| Raspberry Pi 3 (arm64) | Raspberry Pi OS (64-bit), Wayland, X11 | [Official 7" Touch Display 2 (720x1280)](https://www.raspberrypi.com/products/touch-display-2) | ⬜ |
|
||||
| Raspberry Pi 4 (arm64) | Raspberry Pi OS (64-bit), Wayland, X11 | [Official 7" Touch Display 1 (800x480)](https://www.raspberrypi.com/products/raspberry-pi-touch-display) | 🟩 |
|
||||
| Raspberry Pi 4 (arm64) | Raspberry Pi OS (64-bit), Wayland, X11 | [Official 7" Touch Display 2 (720x1280)](https://www.raspberrypi.com/products/touch-display-2) | 🟩 |
|
||||
| Raspberry Pi 5 (arm64) | Raspberry Pi OS (64-bit), Wayland, X11 | [Official 7" Touch Display 1 (800x480)](https://www.raspberrypi.com/products/raspberry-pi-touch-display) | 🟩 |
|
||||
| Raspberry Pi 5 (arm64) | Raspberry Pi OS (64-bit), Wayland, X11 | [Official 7" Touch Display 2 (720x1280)](https://www.raspberrypi.com/products/touch-display-2) | 🟩 |
|
||||
| Raspberry Pi 5 (arm64) | Raspberry Pi OS (64-bit), Wayland, X11 | [Waveshare 10.1" DSI Touch (800x1280)](https://www.waveshare.com/10.1-dsi-touch-a.htm) | 🟩 |
|
||||
| Raspberry Pi 5 (arm64) | Raspberry Pi OS (64-bit), Wayland, X11 | [Waveshare 12.3" DSI Touch (720x1920)](https://www.waveshare.com/12.3-dsi-touch-a.htm) | 🟩 |
|
||||
|
||||
### 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 | [Waveshare 8" CAPLCD (768x1024)](https://www.waveshare.com/wiki/8inch_768x1024_LCD) | 🟨 |
|
||||
| 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 | [LAFVIN Touch Display 5" (800x480)](https://www.amazon.de/gp/product/B0BWJ8YP7S) | 🟨 |
|
||||
| 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 CAPLCD 8" (768x1024)](https://www.waveshare.com/wiki/8inch_768x1024_LCD) | 🟨 |
|
||||
| Raspberry Pi 4 (arm64) | Raspberry Pi OS (64-bit), Wayland, X11 | [EVICIV 10.1" Touch (1920x1200)](https://de.aliexpress.com/item/1005001870058398.html?spm=a2g0o.order_list.order_list_main.10.21ef5c5fCTxEDm&gatewayAdapt=glo2deu) | 🟨 |
|
||||
| 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 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 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 | [GeeekPi 10.1" Capacitive Touch (1280x800)](https://www.amazon.nl/dp/B0DHV6DZC1) | 🟨 |
|
||||
| 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 | [Akntzcs Portable Touch 16" HD (1920x1200)](https://www.amazon.com/dp/B0CTGW6MQ6) | 🟨 |
|
||||
| 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 | [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), 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.
|
||||
|
||||
**Extended features** become available when the `--mqtt-*` arguments are provided and the hardware is supported:
|
||||
- If your hardware is not fully compatible there should be no crashes, but you may miss some sensors.
|
||||
|
||||
Hardware support is verified during application startup and can be checked in the terminal or in the log file under the `Supported` section.
|
||||
The necessary requirements for MQTT sensors to work are listed here:
|
||||
| Name | Requirements | References |
|
||||
| -------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------ |
|
||||
| App (Update) | Requires `sudo` rights, `.deb` install and `touchkio.service` running . | [#70](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) | Requires `sudo` rights, device under `/sys/class/backlight/*/brightness` exists or working `ddcutil` command. | [#30](https://github.com/leukipp/touchkio/issues/30), [#101](https://github.com/leukipp/touchkio/issues/101) |
|
||||
| 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) |
|
||||
|
||||
## FAQ
|
||||
|
||||
### Operating System
|
||||
|
||||
<details><summary>I have installed Ubuntu GNOME.</summary>
|
||||
|
||||
- On some Debian based systems (e.g. Ubuntu GNOME), the display status control is only available when using X11 (`xset`).
|
||||
- GNOME is the least supported window manager.
|
||||
- It's recommended to switch to KDE wayland, if you want better support for display status control (`kscreen-doctor`).
|
||||
|
||||
</details>
|
||||
|
||||
<details><summary>I have installed Raspberry Pi OS on a RPI3.</summary>
|
||||
|
||||
- Raspberry Pi 3 devices have produced a bunch of issues in the past.
|
||||
- [RPI 3B thermostat card issue](https://github.com/leukipp/touchkio/issues/17).
|
||||
- [RPI 3B wayland rendering issue](https://github.com/leukipp/touchkio/issues/104).
|
||||
- [Webpage cards don't work (RPI 3B)](https://github.com/leukipp/touchkio/issues/24).
|
||||
- It looks like the GPU is not properly supported by Electron.
|
||||
- Running `touchkio --disable-gpu` may improve the situation, but upgrading the hardware is the best solution.
|
||||
|
||||
</details>
|
||||
|
||||
<details><summary>I want to update APT packages automatically.</summary>
|
||||
|
||||
- The **Package Upgrades** MQTT sensor will show if `apt` package upgrades are available, but updates are [intentionally](https://github.com/leukipp/touchkio/issues/7) not triggered by TouchKio.
|
||||
- It's recommended to keep your system up to date for security and compatibility, as TouchKio primarily supports the latest OS versions.
|
||||
- Consider configuring `sudo apt install unattended-upgrades` for automatic updates.
|
||||
|
||||
</details>
|
||||
|
||||
### Display
|
||||
|
||||
<details><summary>Display status can't be controlled through MQTT.</summary>
|
||||
|
||||
- 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)
|
||||
|
||||
</details>
|
||||
|
||||
<details><summary>Display brightness can't be controlled through MQTT.</summary>
|
||||
|
||||
- Have a look at the [features](https://github.com/leukipp/touchkio/blob/main/HARDWARE.md#features) section to check if all requirements are fulfilled.
|
||||
- The **Display** MQTT control is a light entity with brightness support. So make sure to to [click on the entity](https://github.com/leukipp/touchkio/issues/75) to check for brightness support.
|
||||
- HDMI screens typically do not offer brightness control out of the box, so additional setup steps are required.
|
||||
- Brightness support for [ddcutil](https://github.com/leukipp/touchkio/issues/101#issuecomment-3521247263) is build-in and checked on application startup.
|
||||
- Alternatively installing [ddcci-driver-linux](https://github.com/leukipp/touchkio/issues/132#issue-3659009749) or [ddcci-dkms](https://github.com/leukipp/touchkio/issues/101#issuecomment-3571523927) may also work.
|
||||
- Make sure that one of these works for your display when you run it directly on the terminal, otherwise the MQTT switch will not work either.
|
||||
- `sudo cat /sys/class/backlight/*/brightness` returns some numeric value.
|
||||
- `sudo ddcutil setvcp 10 42` changes the brightness to 42% without asking for a password.
|
||||
|
||||
</details>
|
||||
|
||||
<details><summary>Turning HDMI screen off via MQTT causes it to turn back on.</summary>
|
||||
|
||||
- There are certain HDMI screens (e.g. Viewsonic) where the MQTT display status command doesn't work as expected.
|
||||
- The screen [immediately turns on again](https://github.com/leukipp/touchkio/issues/38), which may be caused by incompatible HDMI cables being used.
|
||||
|
||||
</details>
|
||||
|
||||
### Touch
|
||||
|
||||
<details><summary>Automated screen blanking on inactivity.</summary>
|
||||
|
||||
- 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](https://www.home-assistant.io/docs/automation/basics) (e.g. presence detection or **Last Active** MQTT sensor) to manage the screen status.
|
||||
|
||||
</details>
|
||||
|
||||
<details><summary>Touch in multitouch mode not waking the screen.</summary>
|
||||
|
||||
- It's recommended to use **Mouse Emulation** for touch screens, otherwise touch based [screen wake-up](https://github.com/leukipp/touchkio/issues/127) from display off state will fail, especially if build-in [screen blanking](https://www.raspberrypi.com/documentation/computers/configuration.html#screen-blanking-3) is disabled.
|
||||
|
||||
</details>
|
||||
|
||||
<details><summary>Touch events may propagate through a display that is turned off.</summary>
|
||||
|
||||
- It's recommended to use **Mouse Emulation** for touch screens, otherwise Home Assistant actions could be triggered [unintentionally](https://github.com/leukipp/touchkio/issues/61) on touch.
|
||||
|
||||
</details>
|
||||
|
||||
### Network
|
||||
|
||||
<details><summary>Connecting via https/mqtts with a self-signed certificate.</summary>
|
||||
|
||||
- When connecting to a service with a [custom certificate](https://github.com/leukipp/touchkio/issues/42#issuecomment-3041870215), 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.
|
||||
|
||||
</details>
|
||||
|
||||
<details><summary>Local DNS entries in /etc/hosts are ignored.</summary>
|
||||
|
||||
- Electron bypasses the system resolver stack, ignoring `/etc/hosts` and local DNS servers.
|
||||
- To use the system resolver, modify `~/.config/systemd/user/touchkio.service` to disable these features:
|
||||
```bash
|
||||
ExecStart=/usr/bin/touchkio --disable-features=UseDNSHttps,AsyncDns
|
||||
```
|
||||
|
||||
</details>
|
||||
|
||||
<details><summary>During VNC access the display turns gray.</summary>
|
||||
|
||||
- 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).
|
||||
|
||||
</details>
|
||||
|
||||
### Media
|
||||
|
||||
<details><summary>I need Music and Voice Assistant.</summary>
|
||||
|
||||
- Not planned, look for [alternatives](https://github.com/leukipp/touchkio/issues/88#issuecomment-3366659265).
|
||||
|
||||
</details>
|
||||
|
||||
<details><summary>I need a camera stream from the device.</summary>
|
||||
|
||||
- Not planned, look for [alternatives](https://github.com/leukipp/touchkio/issues/130#issuecomment-3591770594).
|
||||
|
||||
</details>
|
||||
|
||||
<details><summary>I need additional MQTT entities to control hardware.</summary>
|
||||
|
||||
- Not planned, look for [alternatives](https://github.com/leukipp/touchkio/issues/138#issuecomment-3591784725).
|
||||
|
||||
</details>
|
||||
|
||||
### Dependencies
|
||||
|
||||
<details><summary>Some of the MQTT controls are missing.</summary>
|
||||
|
||||
- Certain [features](https://github.com/leukipp/touchkio/blob/main/HARDWARE.md#features) from the MQTT integration may require elevated privileges to work correctly.
|
||||
- Test if your local user has the [necessary permissions](https://github.com/leukipp/touchkio/issues/39) to run `sudo -n true` without being [prompted for a password](https://github.com/leukipp/touchkio/issues/116#issuecomment-3471566411).
|
||||
|
||||
</details>
|
||||
|
||||
<details><summary>The ddcutil command doesn't seem to be used.</summary>
|
||||
|
||||
- Currently `ddcutil` is only used for brightness control of HDMI screens.
|
||||
- Make sure that your screen is supporting [continuous](https://github.com/leukipp/touchkio/issues/101#issuecomment-3521247263) adjustments of brightness values.
|
||||
|
||||
</details>
|
||||
|
||||
<details><summary>The on-screen keyboard doesn't automatically pop-out.</summary>
|
||||
|
||||
- Most of the available on-screen keyboards will not render above any [fullscreen window](https://forums.raspberrypi.com/viewtopic.php?p=2327148).
|
||||
- There is a [workaround](https://github.com/leukipp/touchkio/issues/85) for `squeekboard`, which will only work on Raspberry Pi OS.
|
||||
- If the on-screen keyboard still doesn't [automatically pop-out](https://github.com/leukipp/touchkio/issues/4) when entering a text field inside the webview you can use the side [widget](https://github.com/leukipp/touchkio/issues/16) to toggle the visibility.
|
||||
|
||||
</details>
|
||||
|
||||
### Errors
|
||||
|
||||
<details><summary>Terminal is full with "ERROR:gbm_wrapper.cc" messages.</summary>
|
||||
|
||||
- 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.
|
||||
|
||||
</details>
|
||||
|
||||
<details><summary>CPU and RAM usage increases without reason.</summary>
|
||||
|
||||
- This was [especially observed](https://github.com/leukipp/touchkio/issues/123) when the screen is permanently on and renders a dashboard with interactive elements (e.g. custom lovelace cards).
|
||||
- Switching to another **Page Url** or turning the **Display** off during idle times improves resource usage.
|
||||
- Alternatively a timed **Refresh** of the webview via MQTT can also help.
|
||||
|
||||
</details>
|
||||
|
||||
<details><summary>Error message "GPU Process abnormal-exit".</summary>
|
||||
|
||||
- _GPU Process abnormal-exit (code 512)_ means that the Electron GPU process crashed, probably caused by some issues inside the webview.
|
||||
- Disabling the GPU via `touchkio --disable-gpu` may help.
|
||||
|
||||
</details>
|
||||
|
||||
<details><summary>Error message "Render Process killed".</summary>
|
||||
|
||||
- _Render Process killed (code 9)_ will lead to a temporary [white screen](https://github.com/leukipp/touchkio/issues/115).
|
||||
- The problem likely stems from Electron’s calculated RAM limit (~2GB) and the dashboard using too much memory.
|
||||
- Although there are flags to [increase the limit](https://github.com/leukipp/touchkio/issues/36#issuecomment-3406441947), a standard webview shouldn’t require that much RAM.
|
||||
|
||||
</details>
|
||||
|
||||
## 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.
|
||||
|
||||
There is a possibility to test `pre-releases` if you would like to try upcoming versions before the official release is published.
|
||||
These early builds are available to a smaller group of users who have chosen to take part in testing.
|
||||
|
||||
If you are interested in long-term testing, check out the related [help request](https://github.com/leukipp/touchkio/issues/96).
|
||||
When a [pre-release](https://github.com/leukipp/touchkio/releases) is available and you want to test it on-demand, run:
|
||||
```bash
|
||||
bash <(wget -qO- https://raw.githubusercontent.com/leukipp/touchkio/main/install.sh) update early
|
||||
```
|
||||
|
||||
- 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).
|
||||
|
||||
@@ -1,4 +1,10 @@
|
||||
# TouchKio
|
||||
[](https://github.com/leukipp/touchkio/actions)
|
||||
[](https://github.com/leukipp/touchkio/releases)
|
||||
[](https://github.com/leukipp/touchkio/releases)
|
||||
[](https://github.com/leukipp/touchkio/releases)
|
||||
[](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,22 @@ 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] Screenshot image of the kiosk webview.
|
||||
- [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] Volume control for connected audio outputs.
|
||||
- [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.
|
||||
@@ -42,11 +52,12 @@ This setup allows seamless communication between your kiosk device and Home Assi
|
||||
For a comprehensive guide on setting up MQTT with Home Assistant, please refer to the official documentation available here: https://www.home-assistant.io/integrations/mqtt.
|
||||
|
||||
## 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.
|
||||
On the first run of the application, you will encounter a **setup procedure (CLI)** and the Home Assistant **login screen (UI)**.
|
||||
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).
|
||||
After the first login the Home Assistant credentials are stored inside the `~/.config/touchkio/` folder.
|
||||
|
||||
#### Option 1 - The easy way
|
||||
Run this command to download and install the latest **.deb** (arm64 or x64) release.
|
||||
@@ -56,7 +67,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,8 +80,7 @@ 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:
|
||||
`sudo apt install ./touchkio_1.x.x_arm64.deb && touchkio --setup`
|
||||
- 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`
|
||||
- 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.
|
||||
@@ -89,6 +98,15 @@ 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.
|
||||
@@ -109,16 +127,16 @@ For example:
|
||||
touchkio --web-url=http://192.168.1.42:8123 --web-theme=light --web-zoom=1.0
|
||||
```
|
||||
|
||||
> <a href="#ref1">↩ </a><a id="foot1"></a>**[1]:** Not necessarily a Home Assistant Url.
|
||||
> You can load multiple pages by separating them with a comma:
|
||||
> `touchkio --web-url=https://demo.home-assistant.io,https://imvbh.github.io/FlipClock`.
|
||||
> <a id="foot1"></a><a href="#ref1">[1]</a>: This doesn't necessarily have to be a Home Assistant Url.
|
||||
> 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:
|
||||
```json
|
||||
{
|
||||
"web_url": [
|
||||
"https://demo.home-assistant.io",
|
||||
"https://imvbh.github.io/FlipClock"
|
||||
"https://demo.immichkiosk.app"
|
||||
]
|
||||
}
|
||||
```
|
||||
@@ -140,6 +158,29 @@ For example:
|
||||
touchkio --web-url=http://192.168.1.42:8123 --mqtt-url=mqtt://192.168.1.42:1883 --mqtt-user=kiosk --mqtt-password=password
|
||||
```
|
||||
|
||||
## 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.
|
||||
|
||||
### 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 |
|
||||
| ------------ | -------------------------------------------------------- |
|
||||
| `Widget` | [See #16](https://github.com/leukipp/touchkio/issues/16) |
|
||||
| `Navigation` | [See #45](https://github.com/leukipp/touchkio/issues/45) |
|
||||
| `Pager` | [See #64](https://github.com/leukipp/touchkio/issues/64) |
|
||||
|
||||
|
||||
### 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 |
|
||||
| --------------------------- | ---------------------------- |
|
||||
| `Control+Left` | Navigate to previous page |
|
||||
| `Control+Right` | Navigate to next page |
|
||||
| `Control+Num_Subtract` | Decrease the page zoom |
|
||||
| `Control+Num_Add` | Increase the page zoom |
|
||||
| `Alt+Left`/`Mouse+Back` | Navigate backward 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).
|
||||
|
||||
@@ -193,24 +234,26 @@ 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 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.
|
||||
The `wlopm --off \*` command changes the `/sys/class/backlight/*/bl_power` value to **4**, when setting the value to **0** the screen will turn on again.
|
||||
However, `swayidle` still seems to consider the screen to be off and as a result it will not turn off again unless there is some interaction in the meantime.
|
||||
|
||||
When using the MQTT integration, the kiosk application must be able to **detect changes** made on the **device** itself.
|
||||
I managed to achieve this for the `brightness` file by implementing a simple `fs.watch(..)` file listener.
|
||||
However, I found that it **never triggered** for the `bl_power` file.
|
||||
I managed to achieve this for the `/sys/class/backlight/*/brightness` file by implementing a simple `fs.watch(..)` file listener.
|
||||
However, I found that it **never triggered** for the `/sys/class/backlight/*/bl_power` or the `/sys/class/drm/*/dpms` 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 `/sys/class/backlight/*/brightness` and `/sys/class/drm/*/dpms` file **every second** for any changes.
|
||||
In case `ddcutil` is installed the file `~/.config/touchkio/Cache/Brightness.vcp` will be written/monitored to support brightness support for HDMI screens.
|
||||
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.
|
||||
**Support** for changing the power status on **DSI and HDMI** displays is achieved by checking for connected screens in `/sys/class/drm/*/status`.
|
||||
Support for changing the brightness of connected display is implemented by using `/sys/class/backlight/*/brightness`.
|
||||
Support for changing the brightness of a connected display is implemented by using `sudo tee /sys/class/backlight/*/brightness` or `sudo ddcutil setvcp 10`.
|
||||
In cases where no supported backlight device is found, the Home Assistant light entity will only show an on/off switch without brightness control.
|
||||
|
||||
Keep in mind that default arguments are stored as plain text in `~/.config/touchkio/Arguments.json`.
|
||||
@@ -219,39 +262,55 @@ 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.
|
||||
When the screen **turns off** the **focus** is removed from the kiosk window.
|
||||
This way, the first click only turns the screen on and focuses the window, allowing subsequent clicks to work as expected.
|
||||
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 on/off**, the timestamps of these events are recorded.
|
||||
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.
|
||||
|
||||
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.
|
||||
|
||||
</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.
|
||||
> [!NOTE]
|
||||
> ### Please read the hardware [FAQ](https://github.com/leukipp/touchkio/blob/main/HARDWARE.md#faq) section first if you encounter any issues.
|
||||
|
||||
**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.
|
||||
For basic debugging **(TouchKio)**, 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.
|
||||
|
||||
**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), the display status control may only be available when using X11.
|
||||
For extended logging **(Electron)** you can run `touchkio --enable-logging`, which will write an additional log file into `~/.config/touchkio/logs/electron.log`.
|
||||
Refer to the [--log-level=[0-3]](https://www.electronjs.org/docs/latest/api/command-line-switches#--log-leveln) and [--v=[0-3]](https://www.electronjs.org/docs/latest/api/command-line-switches#--vlog_level) options to adjust the logging verbosity.
|
||||
|
||||
**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 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.
|
||||
- When using a Raspberry Pi, the on-screen keyboard doesn't automatically pop-out when entering a text field inside the webview.
|
||||
- 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.
|
||||
- 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.
|
||||
If you need to debug the webview **(Chrome DevTools)** use `touchkio --app-debug`.
|
||||
|
||||
In case [undocumented problems](https://github.com/leukipp/touchkio/blob/main/HARDWARE.md#faq) arise, please [create an issue](https://github.com/leukipp/touchkio/issues) and include the output of `touchkio --version`, additional information 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)).
|
||||
### Tutorials
|
||||
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/@TheStockPot-AU)):
|
||||
|
||||
<a href="https://www.youtube.com/watch?v=uTxURzmrVtA">
|
||||
<img src="https://img.youtube.com/vi/uTxURzmrVtA/maxresdefault.jpg" alt="What My Smart Home Was Missing" title="@TheStockPot-AU" style="width:100%">
|
||||
</a>
|
||||
|
||||
Also, have a look at this curated collection of helpful videos contributed by the community:
|
||||
|
||||
<p align="center" style="width:100%">
|
||||
<a href="https://www.youtube.com/watch?v=_adl1fiXlgk">
|
||||
<img src="https://img.youtube.com/vi/_adl1fiXlgk/mqdefault.jpg" alt="Building a Home Assistant Kiosk - Why Did I Wait So Long?" title="@Jims-Garage" style="width:32%">
|
||||
</a>
|
||||
<a href="https://www.youtube.com/watch?v=uXcjx-zL_UU">
|
||||
<img src="https://img.youtube.com/vi/uXcjx-zL_UU/mqdefault.jpg" alt="Touch Display for Home Assistant with TouchKIO" title="@haus_automation" style="width:32%">
|
||||
</a>
|
||||
<a href="https://www.youtube.com/watch?v=t2YQm7GPmpY">
|
||||
<img src="https://img.youtube.com/vi/t2YQm7GPmpY/mqdefault.jpg" alt="DIY Home Assistant Kiosk Build: Raspberry Pi & 3D Printing Livestream" title="@homeautomatorza" style="width:32%">
|
||||
</a>
|
||||
</p>
|
||||
|
||||
## License
|
||||
[MIT](https://github.com/leukipp/touchkio/blob/main/LICENSE)
|
||||
|
||||
+35
-2
@@ -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;
|
||||
}
|
||||
},
|
||||
|
||||
+77
-14
@@ -1,6 +1,7 @@
|
||||
<!doctype html>
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Security-Policy" content="default-src 'unsafe-inline'" />
|
||||
<style>
|
||||
[data-theme="dark"] {
|
||||
--primary-color: rgba(225, 225, 225, 1);
|
||||
@@ -32,8 +33,8 @@
|
||||
align-items: center;
|
||||
width: 100vw;
|
||||
height: 100vh;
|
||||
padding: 0 30px;
|
||||
column-gap: 20px;
|
||||
padding: 0 10px;
|
||||
column-gap: 10px;
|
||||
list-style-type: none;
|
||||
border-top: 1px solid var(--border-color);
|
||||
background: var(--background-color);
|
||||
@@ -46,11 +47,19 @@
|
||||
li.dynamic {
|
||||
flex: 1 1 0%;
|
||||
}
|
||||
li.separator {
|
||||
height: 32px;
|
||||
border: 1px solid var(--border-color);
|
||||
}
|
||||
li.separator:has(+ li.hidden) {
|
||||
display: none;
|
||||
}
|
||||
li.hidden {
|
||||
display: none;
|
||||
}
|
||||
li.disabled {
|
||||
opacity: 0.5;
|
||||
cursor: not-allowed;
|
||||
pointer-events: none;
|
||||
}
|
||||
button {
|
||||
@@ -62,12 +71,14 @@
|
||||
input {
|
||||
width: 100%;
|
||||
min-width: 0;
|
||||
margin: 0 10px;
|
||||
margin: 0 5px;
|
||||
padding: 6px 10px;
|
||||
border-radius: 4px;
|
||||
font-size: 18px;
|
||||
font-family: sans-serif;
|
||||
outline: none;
|
||||
border: none;
|
||||
cursor: text;
|
||||
box-sizing: border-box;
|
||||
color: var(--primary-color);
|
||||
background-color: var(--border-color);
|
||||
@@ -91,7 +102,28 @@
|
||||
</button>
|
||||
</li>
|
||||
<li>
|
||||
<button id="pager">
|
||||
<button id="refresh">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
|
||||
<title>refresh-circle</title>
|
||||
<path
|
||||
d="M12 2A10 10 0 1 0 22 12A10 10 0 0 0 12 2M18 11H13L14.81 9.19A3.94 3.94 0 0 0 12 8A4 4 0 1 0 15.86 13H17.91A6 6 0 1 1 12 6A5.91 5.91 0 0 1 16.22 7.78L18 6Z"
|
||||
/>
|
||||
</svg>
|
||||
</button>
|
||||
</li>
|
||||
<li class="separator"></li>
|
||||
<li>
|
||||
<button id="previous">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
|
||||
<title>page-previous</title>
|
||||
<path
|
||||
d="M4,21H19A2,2 0 0,0 21,19V13H17V15L13,12L17,9V11H21V5A2,2 0 0,0 19,3H4A2,2 0 0,0 2,5V19A2,2 0 0,0 4,21M4,15H8V17H4V15M4,11H11V13H4V11M4,7H11V9H4V7M21,11H24V13H21V11Z"
|
||||
/>
|
||||
</svg>
|
||||
</button>
|
||||
</li>
|
||||
<li>
|
||||
<button id="next">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
|
||||
<title>page-next</title>
|
||||
<path
|
||||
@@ -100,15 +132,17 @@
|
||||
</svg>
|
||||
</button>
|
||||
</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>
|
||||
<button id="backward">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
|
||||
<title>arrow-left-circle</title>
|
||||
<title>history</title>
|
||||
<path
|
||||
d="M2,12A10,10 0 0,1 12,2A10,10 0 0,1 22,12A10,10 0 0,1 12,22A10,10 0 0,1 2,12M18,11H10L13.5,7.5L12.08,6.08L6.16,12L12.08,17.92L13.5,16.5L10,13H18V11Z"
|
||||
d="M13.5,8H12V13L16.28,15.54L17,14.33L13.5,12.25V8M13,3A9,9 0 0,0 4,12H1L4.96,16.03L9,12H6A7,7 0 0,1 13,5A7,7 0 0,1 20,12A7,7 0 0,1 13,19C11.07,19 9.32,18.21 8.06,16.94L6.64,18.36C8.27,20 10.5,21 13,21A9,9 0 0,0 22,12A9,9 0 0,0 13,3"
|
||||
/>
|
||||
</svg>
|
||||
</button>
|
||||
@@ -116,9 +150,30 @@
|
||||
<li>
|
||||
<button id="forward">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
|
||||
<title>arrow-right-circle</title>
|
||||
<title>update</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,12M6,13H14L10.5,16.5L11.92,17.92L17.84,12L11.92,6.08L10.5,7.5L14,11H6V13Z"
|
||||
d="M21,10.12H14.22L16.96,7.3C14.23,4.6 9.81,4.5 7.08,7.2C4.35,9.91 4.35,14.28 7.08,17C9.81,19.7 14.23,19.7 16.96,17C18.32,15.65 19,14.08 19,12.1H21C21,14.08 20.12,16.65 18.36,18.39C14.85,21.87 9.15,21.87 5.64,18.39C2.14,14.92 2.11,9.28 5.62,5.81C9.13,2.34 14.76,2.34 18.27,5.81L21,3V10.12M12.5,8V12.25L16,14.33L15.28,15.54L11,13V8H12.5Z"
|
||||
/>
|
||||
</svg>
|
||||
</button>
|
||||
</li>
|
||||
<li class="separator"></li>
|
||||
<li>
|
||||
<button id="minus">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
|
||||
<title>magnify-minus</title>
|
||||
<path
|
||||
d="M9,2A7,7 0 0,1 16,9C16,10.57 15.5,12 14.61,13.19L15.41,14H16L22,20L20,22L14,16V15.41L13.19,14.61C12,15.5 10.57,16 9,16A7,7 0 0,1 2,9A7,7 0 0,1 9,2M5,8V10H13V8H5Z"
|
||||
/>
|
||||
</svg>
|
||||
</button>
|
||||
</li>
|
||||
<li>
|
||||
<button id="plus">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
|
||||
<title>magnify-plus</title>
|
||||
<path
|
||||
d="M9,2A7,7 0 0,1 16,9C16,10.57 15.5,12 14.61,13.19L15.41,14H16L22,20L20,22L14,16V15.41L13.19,14.61C12,15.5 10.57,16 9,16A7,7 0 0,1 2,9A7,7 0 0,1 9,2M8,5V8H5V10H8V13H10V10H13V8H10V5H8Z"
|
||||
/>
|
||||
</svg>
|
||||
</button>
|
||||
@@ -134,6 +189,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 });
|
||||
});
|
||||
@@ -152,16 +210,21 @@
|
||||
ipcRenderer.on("button-hidden", (e, button) => {
|
||||
document.getElementById(button.id).parentNode.classList.toggle("hidden", button.hidden);
|
||||
});
|
||||
ipcRenderer.on("input-blur", (e, input) => {
|
||||
document.getElementById(input.id).blur();
|
||||
});
|
||||
ipcRenderer.on("input-select", (e, input) => {
|
||||
document.getElementById(input.id).select();
|
||||
ipcRenderer.on("input-readonly", (e, input) => {
|
||||
document.getElementById(input.id).readOnly = input.readonly;
|
||||
});
|
||||
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);
|
||||
});
|
||||
|
||||
+103
@@ -0,0 +1,103 @@
|
||||
<!doctype html>
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Security-Policy" content="default-src 'unsafe-inline'" />
|
||||
<style>
|
||||
[data-theme="dark"] {
|
||||
--background-color: rgba(225, 225, 225, 0.15);
|
||||
--previous-cursor: w-resize;
|
||||
--next-cursor: e-resize;
|
||||
}
|
||||
[data-theme="light"] {
|
||||
--background-color: rgba(33, 33, 33, 0.15);
|
||||
--previous-cursor: w-resize;
|
||||
--next-cursor: e-resize;
|
||||
}
|
||||
[data-theme="hidden"] {
|
||||
--background-color: rgba(0, 0, 0, 0);
|
||||
--previous-cursor: none;
|
||||
--next-cursor: none;
|
||||
}
|
||||
::-webkit-scrollbar {
|
||||
display: none;
|
||||
}
|
||||
* {
|
||||
margin: 0;
|
||||
padding: 0;
|
||||
cursor: none;
|
||||
}
|
||||
body {
|
||||
display: flex;
|
||||
align-items: center;
|
||||
width: 100vw;
|
||||
height: 100vh;
|
||||
}
|
||||
menu {
|
||||
display: flex;
|
||||
flex-direction: column;
|
||||
align-items: center;
|
||||
width: 100vw;
|
||||
height: 100vh;
|
||||
list-style-type: none;
|
||||
}
|
||||
li {
|
||||
display: flex;
|
||||
align-items: center;
|
||||
flex: 0 0 auto;
|
||||
}
|
||||
li:not(.disabled) #previous {
|
||||
cursor: var(--previous-cursor);
|
||||
}
|
||||
li:not(.disabled) #next {
|
||||
cursor: var(--next-cursor);
|
||||
}
|
||||
button {
|
||||
width: 100vw;
|
||||
height: 50vh;
|
||||
border: none;
|
||||
cursor: not-allowed;
|
||||
background-color: transparent;
|
||||
}
|
||||
button:not(:active) {
|
||||
transition: background-color 500ms step-end;
|
||||
}
|
||||
menu:has(button:active) button {
|
||||
background-color: var(--background-color);
|
||||
transition-duration: 0ms;
|
||||
}
|
||||
</style>
|
||||
</head>
|
||||
<body>
|
||||
<menu>
|
||||
<li>
|
||||
<button id="previous"></button>
|
||||
</li>
|
||||
<li>
|
||||
<button id="next"></button>
|
||||
</li>
|
||||
</menu>
|
||||
<script>
|
||||
const { ipcRenderer } = require("electron");
|
||||
|
||||
const registerSendEvents = () => {
|
||||
document.querySelectorAll("button").forEach((button) => {
|
||||
button.addEventListener("pointerdown", (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("data-theme", (e, data) => {
|
||||
document.documentElement.setAttribute("data-theme", data.theme);
|
||||
});
|
||||
};
|
||||
|
||||
registerSendEvents();
|
||||
registerReceiveEvents();
|
||||
</script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,162 @@
|
||||
<!doctype html>
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Security-Policy" content="default-src 'unsafe-inline'" />
|
||||
<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">TouchKio</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>
|
||||
+14
-13
@@ -1,6 +1,7 @@
|
||||
<!doctype html>
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Security-Policy" content="default-src 'unsafe-inline'" />
|
||||
<style>
|
||||
[data-theme="dark"] {
|
||||
--primary-color: rgba(225, 225, 225, 1);
|
||||
@@ -68,16 +69,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 +80,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>
|
||||
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 154 KiB After Width: | Height: | Size: 152 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 69 KiB After Width: | Height: | Size: 90 KiB |
@@ -5,50 +5,189 @@ const readline = require("readline/promises");
|
||||
const integration = require("./js/integration");
|
||||
const hardware = require("./js/hardware");
|
||||
const webview = require("./js/webview");
|
||||
const { app } = require("electron");
|
||||
const log = require("electron-log");
|
||||
const { app, powerMonitor } = require("electron");
|
||||
const Events = require("events");
|
||||
|
||||
global.APP = global.APP || {};
|
||||
global.ARGS = global.ARGS || {};
|
||||
global.EVENTS = global.EVENTS || new Events();
|
||||
|
||||
// Check display environment variable
|
||||
if (!process.env.DISPLAY) {
|
||||
console.error(`\n$DISPLAY variable not set to run the GUI application, are you connected via SSH?\n`);
|
||||
console.error(`If you have installed the service use:`);
|
||||
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);
|
||||
}
|
||||
|
||||
// Move electron log file
|
||||
const elog = path.join(app.getPath("logs"), "electron.log");
|
||||
try {
|
||||
if (fs.existsSync(elog)) {
|
||||
fs.renameSync(elog, elog.replace(".log", ".old.log"));
|
||||
}
|
||||
console.debug = () => {};
|
||||
} catch (error) {
|
||||
console.error("Failed to move electron log file:", error.message);
|
||||
}
|
||||
app.commandLine.appendSwitch("log-file", elog);
|
||||
|
||||
/**
|
||||
* This promise resolves when the app has finished initializing,
|
||||
* allowing to safely create browser windows and perform other
|
||||
* initialization tasks.
|
||||
*/
|
||||
app.whenReady().then(async () => {
|
||||
const lock = app.requestSingleInstanceLock();
|
||||
if (!lock) {
|
||||
console.error("TouchKio is already running");
|
||||
return app.quit();
|
||||
if (!(await initApp()) || !(await initArgs()) || !(await initLog())) {
|
||||
return;
|
||||
}
|
||||
|
||||
// Show used arguments
|
||||
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)}`);
|
||||
process.stdout.write("\n");
|
||||
|
||||
// Chained init functions
|
||||
const chained = [
|
||||
["webview.js", webview.init],
|
||||
["hardware.js", hardware.init],
|
||||
["integration.js", integration.init],
|
||||
];
|
||||
for (const [name, init] of chained) {
|
||||
console.debug(`${name}: init()`);
|
||||
if (!(await init())) {
|
||||
console.debug(`${name}: init() --> aborted`);
|
||||
break;
|
||||
}
|
||||
}
|
||||
});
|
||||
|
||||
/**
|
||||
* 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.cache = path.join(app.getPath("userData"), "Cache");
|
||||
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.issues = `https://github.com/${packageJson.author}/${packageJson.name}/issues`;
|
||||
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);
|
||||
}
|
||||
|
||||
// Register app quit events
|
||||
app.on("before-quit", () => {
|
||||
APP.exiting = true;
|
||||
});
|
||||
app.on("will-quit", (e) => {
|
||||
e.preventDefault();
|
||||
process.exitCode = process.exitCode !== 0 ? 1 : 0;
|
||||
const level = process.exitCode === 0 ? "warn" : "error";
|
||||
console[level](`${APP.title} Terminated (${process.exitCode})`);
|
||||
app.exit(process.exitCode);
|
||||
});
|
||||
|
||||
// Register process exit events
|
||||
["SIGINT", "SIGTERM", "SIGQUIT", "exit"].forEach((signal) => {
|
||||
process.on(signal, () => {
|
||||
if (APP.exiting) {
|
||||
return;
|
||||
}
|
||||
process.exitCode = 0;
|
||||
APP.exiting = true;
|
||||
app.quit();
|
||||
});
|
||||
});
|
||||
powerMonitor.on("shutdown", () => {
|
||||
if (APP.exiting) {
|
||||
return;
|
||||
}
|
||||
process.exitCode = 0;
|
||||
APP.exiting = true;
|
||||
app.quit();
|
||||
});
|
||||
|
||||
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.getPath("userData"), "Arguments.json");
|
||||
let argsFilePath = path.join(APP.config, "Arguments.json");
|
||||
let argsFileExists = fs.existsSync(argsFilePath);
|
||||
|
||||
let argsFileHashPath = path.join(APP.cache, "Arguments.hash");
|
||||
let argsFileHashExists = fs.existsSync(argsFileHashPath);
|
||||
|
||||
// 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();
|
||||
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 ("setup" in args || (!argsProvided && !argsFileExists)) {
|
||||
if ((!argsProvided && !argsFileExists) || "setup" in args) {
|
||||
await sleep(3000);
|
||||
do {
|
||||
args = await promptArgs(process);
|
||||
} while (!Object.keys(args).length);
|
||||
writeArgs(argsFilePath, args);
|
||||
} else if (!argsProvided && argsFileExists) {
|
||||
args = readArgs(argsFilePath);
|
||||
} 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
|
||||
@@ -56,19 +195,89 @@ app.whenReady().then(async () => {
|
||||
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)}`);
|
||||
// Calculate arguments hash
|
||||
const argsFileHash = crypto.createHash("sha256").update(JSON.stringify(args)).digest("hex");
|
||||
const argsUpdated = argsFileHashExists && argsFileHash !== fs.readFileSync(argsFileHashPath, "utf8");
|
||||
if (argsUpdated && !("app_reset" in args)) {
|
||||
args.app_reset = "arguments";
|
||||
}
|
||||
if (fs.existsSync(APP.cache)) {
|
||||
fs.writeFileSync(argsFileHashPath, argsFileHash);
|
||||
}
|
||||
|
||||
// Chained init functions
|
||||
const chained = [webview.init, hardware.init, integration.init];
|
||||
for (const init of chained) {
|
||||
if (!(await init())) {
|
||||
break;
|
||||
// Set global arguments
|
||||
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.renameSync(APP.log, APP.log.replace(".log", ".old.log"));
|
||||
}
|
||||
} catch (error) {
|
||||
console.error("Failed to move main log file:", error.message);
|
||||
}
|
||||
});
|
||||
|
||||
// Set log level and path
|
||||
const level = "enable_logging" in ARGS ? "silly" : "app_debug" in ARGS ? "debug" : "verbose";
|
||||
log.transports.file.level = level;
|
||||
log.transports.console.level = level;
|
||||
log.transports.file.resolvePathFn = () => {
|
||||
return APP.log;
|
||||
};
|
||||
|
||||
// Catch unhandled errors
|
||||
log.errorHandler.startCatching({
|
||||
showDialog: false,
|
||||
onError({ error, versions }) {
|
||||
if (!error?.message?.includes("Object has been destroyed")) {
|
||||
const build = { ...APP.build, ...versions };
|
||||
const whoopsie = "💥 Whoopsie!";
|
||||
const section2 = `# Description\n- Hardware information?\n- How to reproduce?\n- Additional logs?\n`;
|
||||
const section3 = `# Error\n\`\`\`bash\n${new Date().toISOString()}: ${error.stack}\n\`\`\`\n`;
|
||||
const section4 = `# Application\n\`\`\`json\n${JSON.stringify(build, null, 2)}\n\`\`\`\n`;
|
||||
const title = encodeURIComponent(`${whoopsie} - ${error}`);
|
||||
const body = encodeURIComponent(`${section2}\n${section3}\n${section4}`);
|
||||
console.error(`${whoopsie} -`, error, build);
|
||||
console.info(`🪲 Report issue --> ${APP.issues}/new?title=${title}&body=${body}`);
|
||||
}
|
||||
app.quit();
|
||||
},
|
||||
});
|
||||
|
||||
// Emit console log
|
||||
APP.logs = [];
|
||||
log.hooks.push((message, transport, type) => {
|
||||
const data = message.data.map((d) => (typeof d === "object" ? String(d?.message) || JSON.stringify(d) : String(d)));
|
||||
const text = data.filter((s) => s && s.trim()).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;
|
||||
});
|
||||
|
||||
// Overwrite console log
|
||||
Object.assign(console, log.functions);
|
||||
console.silly("Welcome To The Jungle!");
|
||||
|
||||
return true;
|
||||
};
|
||||
|
||||
/**
|
||||
* Parses command-line arguments from the given process object.
|
||||
@@ -155,6 +364,7 @@ const promptArgs = async (proc) => {
|
||||
// Prompt questions and wait for the answers
|
||||
let args = {};
|
||||
let ignore = [];
|
||||
try {
|
||||
for (const { key, question, fallback } of prompts) {
|
||||
if (key === "mqtt") {
|
||||
const prompt = `${question} (${fallback}): `;
|
||||
@@ -182,7 +392,13 @@ const promptArgs = async (proc) => {
|
||||
}
|
||||
}
|
||||
}
|
||||
} catch (error) {
|
||||
console.error(`\n${error.message}`);
|
||||
args = {};
|
||||
app.exit(1);
|
||||
} finally {
|
||||
read.close();
|
||||
}
|
||||
|
||||
return args;
|
||||
};
|
||||
@@ -194,11 +410,15 @@ const promptArgs = async (proc) => {
|
||||
* @param {Object} args - The arguments object.
|
||||
*/
|
||||
const writeArgs = (path, args) => {
|
||||
try {
|
||||
const argc = Object.assign({}, args);
|
||||
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);
|
||||
}
|
||||
};
|
||||
|
||||
/**
|
||||
@@ -208,11 +428,16 @@ const writeArgs = (path, args) => {
|
||||
* @returns {Object} The arguments object.
|
||||
*/
|
||||
const readArgs = (path) => {
|
||||
const args = JSON.parse(fs.readFileSync(path));
|
||||
try {
|
||||
const args = JSON.parse(fs.readFileSync(path, "utf8"));
|
||||
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 {};
|
||||
};
|
||||
|
||||
/**
|
||||
@@ -223,7 +448,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 +464,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");
|
||||
|
||||
+65
-51
@@ -1,73 +1,64 @@
|
||||
#!/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)
|
||||
ARCH="arm64"
|
||||
;;
|
||||
x86_64)
|
||||
ARCH="x64"
|
||||
;;
|
||||
*)
|
||||
echo "Architecture $(uname -m) running $BITS-bit operating system is not supported."
|
||||
exit 1
|
||||
;;
|
||||
x86_64) ARCH="x64" ;;
|
||||
aarch64) ARCH="arm64" ;;
|
||||
*) { echo "Architecture $(uname -m) running $BITS-bit operating system is not supported."; exit 1; } ;;
|
||||
esac
|
||||
|
||||
if [ "$BITS" -ne 64 ]; then
|
||||
echo "Architecture $ARCH running $BITS-bit operating system is not supported."
|
||||
exit 1
|
||||
fi
|
||||
|
||||
[ "$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 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
|
||||
echo "Download url for .deb file not found."
|
||||
exit 1
|
||||
JSON=$(wget -qO- "https://api.github.com/repos/leukipp/touchkio/releases" | tr -d '\r\n')
|
||||
if $ARG_EARLY; then
|
||||
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
|
||||
echo "Failed to download the .deb file."
|
||||
exit 1
|
||||
fi
|
||||
DEB_URL=$(echo "$JSON" | grep -oP "$DEB_REG" | head -n 1)
|
||||
DEB_PATH="${TMP_DIR}/$(basename "$DEB_URL")"
|
||||
|
||||
[ -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
|
||||
echo "Package manager apt was not found."
|
||||
exit 1
|
||||
fi
|
||||
|
||||
if ! sudo apt install "$DEB_PATH"; then
|
||||
echo "Installation of .deb file failed."
|
||||
exit 1
|
||||
fi
|
||||
command -v apt &> /dev/null || { echo "Package manager apt was not found."; exit 1; }
|
||||
sudo apt install -y "$DEB_PATH" || { echo "Installation of .deb file failed."; exit 1; }
|
||||
|
||||
# Create the systemd user service
|
||||
echo -e "\nCreating systemd user service..."
|
||||
|
||||
SERVICE_FILE="$HOME/.config/systemd/user/touchkio.service"
|
||||
mkdir -p "$(dirname "$SERVICE_FILE")" || { echo "Failed to create directory for $SERVICE_FILE"; exit 1; }
|
||||
SERVICE_NAME="touchkio.service"
|
||||
SERVICE_FILE="$HOME/.config/systemd/user/$SERVICE_NAME"
|
||||
mkdir -p "$(dirname "$SERVICE_FILE")" || { echo "Failed to create directory for $SERVICE_FILE."; exit 1; }
|
||||
|
||||
bash -c "cat << EOF > \"$SERVICE_FILE\"
|
||||
[Unit]
|
||||
SERVICE_CONTENT="[Unit]
|
||||
Description=TouchKio
|
||||
After=graphical.target
|
||||
Wants=network-online.target
|
||||
|
||||
[Service]
|
||||
ExecStart=/usr/bin/touchkio
|
||||
@@ -75,35 +66,58 @@ Restart=on-failure
|
||||
RestartSec=5s
|
||||
|
||||
[Install]
|
||||
WantedBy=default.target
|
||||
EOF"
|
||||
WantedBy=default.target"
|
||||
|
||||
systemctl --user enable "$(basename "$SERVICE_FILE")" || { echo "Failed to enable service $SERVICE_FILE"; exit 1; }
|
||||
echo "Service $SERVICE_FILE enabled"
|
||||
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
|
||||
[[ ${overwrite:-n} == [Yy]* ]] || SERVICE_CREATE=false
|
||||
fi
|
||||
|
||||
if $SERVICE_CREATE; then
|
||||
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; }
|
||||
echo "Service $SERVICE_FILE enabled."
|
||||
else
|
||||
echo "Service $SERVICE_FILE not created."
|
||||
fi
|
||||
|
||||
# Export display variables
|
||||
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 "Start touchkio setup? (Y/n) " answer
|
||||
if [[ ${answer:-y} == [Yy]* ]]; then
|
||||
read -p $'\nStart touchkio setup? (Y/n) ' setup
|
||||
|
||||
if [[ ${setup:-y} == [Yy]* ]]; then
|
||||
echo "/usr/bin/touchkio --setup"
|
||||
/usr/bin/touchkio --setup
|
||||
else
|
||||
echo "/usr/bin/touchkio"
|
||||
/usr/bin/touchkio
|
||||
fi
|
||||
|
||||
exit 0
|
||||
|
||||
+608
-165
File diff suppressed because it is too large
Load Diff
+526
-150
File diff suppressed because it is too large
Load Diff
+1021
-227
File diff suppressed because it is too large
Load Diff
+12
-8
@@ -1,27 +1,31 @@
|
||||
{
|
||||
"name": "touchkio",
|
||||
"title": "TouchKio",
|
||||
"description": "Home Assistant Touch Kiosk",
|
||||
"homepage": "https://github.com/leukipp/touchkio",
|
||||
"author": "leukipp",
|
||||
"version": "1.2.0",
|
||||
"version": "1.4.2",
|
||||
"license": "MIT",
|
||||
"main": "index.js",
|
||||
"scripts": {
|
||||
"start": "electron . --web-url=https://demo.home-assistant.io --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.1",
|
||||
"@electron-forge/maker-deb": "^7.8.1",
|
||||
"@electron-forge/maker-zip": "^7.8.1",
|
||||
"@electron-forge/publisher-github": "^7.8.1",
|
||||
"electron": "^37.2.0",
|
||||
"@electron-forge/cli": "^7.10.2",
|
||||
"@electron-forge/maker-deb": "^7.10.2",
|
||||
"@electron-forge/maker-zip": "^7.10.2",
|
||||
"@electron-forge/publisher-github": "^7.10.2",
|
||||
"electron": "^39.2.4",
|
||||
"jszip": "^3.10.1",
|
||||
"prettier": "^3.6.2"
|
||||
},
|
||||
"dependencies": {
|
||||
"mqtt": "^5.13.2"
|
||||
"axios": "^1.13.2",
|
||||
"electron-log": "^5.4.3",
|
||||
"mqtt": "^5.14.1"
|
||||
}
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user