Home Assistant Windows Kiosk - An open-source Windows webpage kiosk designed for integration with Home Assistant. Prevents access to the typical Windows UI without pin access and publishes MQTT commands and sensors to Home Assistant. Configurable gestures for reload, clear cache, send MQTT message, and more.
- Download the .exe file from the latest release and once downloaded double click/open to install. It will automatically install .NET 8 if needed.
- On first run, Settings will open. Enter your kiosk webpage URL, MQTT host, port, username, password, and other details as needed.
- Click Save & Back to Kiosk - the fullscreen kiosk will load your HA dashboard or chosen URL.
- Click the gear button to open Settings (If you've disabled show settings button use a configured gesture with action set to
settings, or MQTTopensettings). Use Exit to Windows in Settings to quit the app.
I recommend checking out my setup if you want to sleep/wake your kiosk, use autologin, have troubles with the app not starting, or have a Surface Pro 3. Please check this out before making an issue!
- Windows 10/11 (I would be interested to know if this works on previous versions)
- .NET 8 Runtime (Desktop) (the installer will install this automatically if not already present)
- WebView2 Runtime (usually pre-installed on Windows 11)
- WebView zoom is blocked (pinch zoom and Ctrl+wheel zoom).
- WebView back/forward swipe navigation is blocked.
- Kiosk window keeps itself topmost and fullscreen, hides the Windows taskbar while running, and restores the taskbar when the app exits.
- Windows key, context-menu key, Alt+F4, Alt+Tab, F11, F12, Ctrl+Esc, and Ctrl+Shift+Esc are intercepted while the kiosk is running. A limitation of running inside Windows Explorer is that the start menu will still come up on windows key/swipe up from bottom.
While I previously attempted to add native openwakeword and wyoming services support with releases v3.9.3-beta to v3.10.9-beta I have discovered a wonderful intergration that does this just as well, if not better, with a lot less work.
Instead of continuing, I've optimised this kiosk app to work with voice-satellite-card-integration by jxlarrea. Mic access, input device, output device, and volume can be changed from the config section of HA WinKiosk's settings. If you want to customise the Voice Assist appearance to match this app better, you can follow the intergration instructions for skins and extra css.
With MQTT configured, the app publishes MQTT payloads that show up in Integrations > MQTT in Home Assistant. In the app Settings, under MQTT, you can choose which sensors and commands are exposed.
| Name in HA | Type | Description |
|---|---|---|
| Shutdown | Button | Shut down Windows |
| Restart | Button | Restart Windows |
| System sleep | Button | Suspend the PC (S3 sleep) |
| Monitor sleep | Button | Turn the display off |
| Monitor wake | Button | Turn the display on |
| Refresh kiosk | Button | Reload the page in the kiosk |
| Clear kiosk cache | Button | Clear kiosk cache (passwords & settings kept), then reload kiosk |
| Open settings | Button | Open this app’s Settings screen (no PIN) |
| Close settings | Button | Close Settings and return to the kiosk |
| Run Windows updates | Button | Starts a Windows Update scan/download/install run. If Respect active hours is on, it will wait till inactive hours before restarting. If it's off, it will restart within 30 seconds. |
| PowerShell command | Button | Executes configured PowerShell command text from settings |
| Update sensors | Button | Immediately publish all enabled sensor values (entity is auto-created when any sensor is enabled) |
| Battery level | Sensor | Remaining battery % (not available on PCs without a battery) |
| Last Active | Sensor | Seconds since last input (updates every 1 second, ignoring the update interval) |
| Windows updates pending | Number | Count of available Windows updates |
| Monitor brightness | Number | Brightness % (1-100 by default; 0-100 when Allow 0% brightness is on) |
When the command Navigate is enabled in Settings, the kiosk listens to {discoveryPrefix}/command/{device}/navigate/set. Call it from Home Assistant with the mqtt.publish service to navigate between HA pages.
service: mqtt.publish
data:
topic: "homeassistant/command/kiosk/navigate/set"
payload: "/lovelace/default_view"Settings are stored at %APPDATA%\HA-WinKiosk\settings.yaml. Settings can be edited either in YAML or in the UI.
Below is a key of what all the options are, and below that is an example settings.yaml.
| UI Name | Values | Notes |
|---|---|---|
| Kiosk URL | URL | Kiosk page URL |
| Ignore HTTPS cert warnings | true/false |
Auto-allow invalid/self-signed TLS certs for the kiosk URL |
| Do Not Disturb | true/false |
Suppress toast notifications while the kiosk is running |
| Beta updates | true/false |
When true, automatic updates may install GitHub prereleases; when false, only stable releases |
| Show settings button | true/false |
Show/hide gear button |
| Theme | auto/light/dark |
UI theme mode |
| Brightness (%) | 0..100 |
Screen brightness |
| Allow 0% brightness | true/false |
When false (default), local slider and HA brightness entity minimum is 1% |
| Start when Windows starts | true/false |
Launch app at sign-in |
| Respect active hours | true/false |
When on, a required reboot after Windows Update is deferred to outside active hours; when off, reboot is scheduled in 30 seconds |
| Playback device | string (MMDevice ID) | Empty keeps Windows default playback device |
| Input device | string (MMDevice ID) | Empty uses Windows default capture device |
| Volume (%) | 0..100 |
Master volume for the playback device |
| Settings PIN | string | PIN required when PIN protection is enabled. Doesn't have to be numbers |
| PIN hint | string | Hint shown on PIN prompt |
| Verification question | string | Forgot-PIN verification question |
| PIN reset answer | string | Forgot-PIN verification answer |
| PIN protection | true/false |
false disables PIN gate |
Each enabled gesture has an action dropdown with the following possible values:
Disabled, Reload, Clear cache and reload, Settings, MQTT message
When action is MQTT message, make sure to set an MQTT topic suffix for that gesture.
| Gesture | Options |
|---|---|
| Single tap | Location: Top left/Top right/Bottom right/Bottom left/Anywhere |
| Double tap | Location: same |
| Triple tap | Location: same |
| Quadruple tap | Location: same |
| Quintuple tap | Location: same |
| Swipe | Direction: Down/Left/Right |
| Swipe and hold | Direction: Down/Left/RightHold threshold (ms): integer |
| Two-finger swipe (touch devices only) | Direction: Down/Left/Right |
| Two-finger swipe and hold (touch devices only) | Direction: Down/Left/RightHold threshold (ms): integer |
| Pinch | - |
| Zoom | Direction: Any/In/Out |
Enable or disable each sensor or command in this section of settings. They are listed under MQTT entities & services.
| UI Name | Values | Notes |
|---|---|---|
| MQTT IP | hostname/IP | Broker host |
| MQTT port | integer | Broker port |
| MQTT username | string | Broker username |
| MQTT password | string | Broker password |
| Device name | string | Base ID in MQTT entities/topics |
| Discovery prefix | string | MQTT discovery prefix for Home Assistant (default homeassistant) |
| PowerShell command text | string | Command text for the PowerShell command button |
config:
url: "http://homeassistant.local:8123"
ignoreCertificateErrors: false
doNotDisturb: true
pin: ""
pinHint: ""
pinResetQuestion: ""
pinResetAnswer: ""
pinProtectionDisabled: false
showSettingsButton: true
uiTheme: auto
betaUpdates: false
playbackDeviceId: ""
inputDeviceId: ""
volumePercent: 100
brightnessPercent: 100
allowZeroBrightness: false
autoStartEnabled: true
windowsUpdateRespectActiveHours: true
gestures:
singleTapAction: disabled
singleTapLocation: top-left
singleTapMqttTopic: "single_tap"
doubleTapAction: disabled
doubleTapLocation: top-left
doubleTapMqttTopic: "double_tap"
tripleTapAction: disabled
tripleTapLocation: top-left
tripleTapMqttTopic: "triple_tap"
quadrupleTapAction: settings
quadrupleTapLocation: top-left
quadrupleTapMqttTopic: "quadruple_tap"
quintupleTapAction: disabled
quintupleTapLocation: top-left
quintupleTapMqttTopic: "quintuple_tap"
swipeAction: reload
swipeDirection: down
swipeMqttTopic: "swipe"
twoFingerSwipeAction: disabled
twoFingerSwipeDirection: down
twoFingerSwipeMqttTopic: "two_finger_swipe"
swipeHoldAction: clearcache_reload
swipeHoldDirection: down
swipeHoldMs: 1000
swipeHoldMqttTopic: "swipe_hold"
twoFingerSwipeHoldAction: disabled
twoFingerSwipeHoldDirection: down
twoFingerSwipeHoldMs: 1000
twoFingerSwipeHoldMqttTopic: "two_finger_swipe_hold"
pinchAction: disabled
pinchMqttTopic: "pinch"
zoomAction: disabled
zoomDirection: any
zoomMqttTopic: "zoom"
mqtt:
host: "192.168.1.?"
port: 1883
username: ""
password: ""
deviceName: "kiosk"
discoveryPrefix: "homeassistant"
sensors:
enabled:
- battery
- last_active
- updates_pending
commands:
enabled:
- shutdown
- restart
- sleep
- monitorsleep
- monitorwake
- refresh
- clearcache
- opensettings
- closesettings
- windowsupdate
- navigate
powerShellCommand: ""The app checks daily at 3:00 AM local device time for any updates. If a newer version is found, it downloads the installer, silently replaces the old app, and relaunches the new version.
If beta updates are enabled, it will download the latest update, even if it is a pre-release. If disabled, it will download the latest stable release.
When Start on boot is enabled in Settings, the app adds itself to the current-user Run key and opens immediately. The exception for this is if Windows Smart App Control decides that it's not safe to open (even if it has opened before). To solve this, read my setup docs.
This project uses the GNU General Public License v3.0. See LICENSE for the full legal text. In short: you can use, change, and share it freely. If you distribute a modified version, you must offer it under the same license and share the source too, so the work (and its derivatives) stay open. You cannot take this code, tweak it, and ship it as a closed product.
HASS.Agent 2.0 (hass-agent, forked from LAB02-Research) was heavily leaned on for implementation of sensors and commands, and in the case of monitor wake/sleep, directly mirrored. Check out this program if you're just looking for sensors and commands without a kiosk!
Browser Mod 2 was referenced and inspiration for the navigation function.
This is my first Windows app (super excited that I finally made one). I use it for my own setup and it's been really helpful. Please report an issue if something doesn't work, I'll try my best to fix it.
Contributions/PRs welcome.
If this app helps you out, consider supporting me here :)