Documentation
Kiosky documentation
Everything you need to set up, lock down and automate an Android tablet with Kiosky, for people and for AI assistants.
Kiosky turns an Android tablet or phone into a kiosk: a wall panel, an info screen, a signage display or a single-purpose device. It shows a dashboard, a website or one app, keeps it running, and can lock the device so nobody wanders off into Android. It works with any web page and has first-class support for Home Assistant.
These pages are the complete user guide. If you are new, read Getting started and then Choosing a mode. If you would like an AI assistant such as Claude to configure the tablet for you, go straight to Set up Kiosky with an AI assistant.
How the docs are organised#
- Start here covers install, the setup wizard and the choice between a normal app and a locked kiosk.
- Use Kiosky covers dashboards, screen and power behaviour, and the camera and sensors.
- Connect covers Home Assistant, the REST API and MQTT.
- Reference covers Kiosky Pro and security.
- Help covers troubleshooting and the AI assistant guide.
For agents and scripts#
Every page is also available as plain Markdown at the same address with a .md ending, for example /docs/rest-api.md. The index for agents is /llms.txt and the whole documentation in one file is /llms-full.txt.
Note. Kiosky is under active development. Where a feature is planned but not built yet, these pages say "Coming soon" instead of describing it as if it worked.
- Start hereGetting startedWhat Kiosky is, what you need, how to install it and how the five-step setup wizard works.
- Start hereChoosing a modeNormal app, soft lock or full lock (Device Owner), single-app mode, pausing the lock and leaving the kiosk.
- Use KioskyDashboards & browserMultiple dashboards, rotation and planner, allowed hosts, zoom, reload, Home Assistant sign-in and theme, hiding the HA header, and the JavaScript bridge.
- Use KioskyScreen, power & screensaverBrightness, idle dimming, screen off, the clock and photo-frame screensaver, night mode, daily maintenance and battery care.
- ConnectHome Assistant integrationConnect Kiosky to Home Assistant over MQTT, every entity it creates, example automations in YAML, and the Assist voice satellite.
- Use KioskyCamera & sensorsMotion wake, face presence, tamper detection, snapshots, the MJPEG stream, camera popups and QR config import.
- ConnectREST API referenceThe local REST API and web admin page: authentication, every endpoint, the command list, reading and writing config, rate limits and mDNS discovery.
- ConnectMQTT referenceTopic layout, the state and event payloads, the command list and delivery details for talking to Kiosky over MQTT.
- ReferenceKiosky ProPlans and prices, which features Pro covers, how to activate a tablet with a QR code, how to manage devices and how the 30-day offline grace works.
- ReferenceSecurityThe admin PIN, the remote-control policy, protected settings, API token handling and guidance for keeping Kiosky on your local network.
- HelpTroubleshootingFixes for tablets that stop starting, battery and vendor auto-start screens, overlay permission, USB debugging, a busy camera, voice that will not wake and dashboards that will not load.
- HelpSet up Kiosky with an AI assistantA ready-to-copy prompt and the exact steps an AI agent should follow to find a tablet, read and change its config safely, send commands and build Home Assistant automations.