Kiosk Satellite Documentation

Guides for every part of Kiosk Satellite, from the first install to the remote and JavaScript APIs. New here? Start with the three steps on the home page, then come back for the details.

• Home Assistant

  ---

  The built-in ESPHome connection that makes the kiosk a device in Home Assistant, and Voice Satellite for voice.

  ESPHome · Voice Satellite

• Display & Audio

  ---

  Brightness, screen timing and the microphone.

  Screen · Microphone

• Screensavers

  ---

  Everything the kiosk shows when nobody is touching it.

  Screensavers · Immich · At a Glance

• Media Player & Cameras

  ---

  The music player, DLNA, camera views and the device camera.

  Media player · DLNA · Camera streams · Device camera

• Kiosk features

  ---

  Locking the device down, the launcher, gestures, optimizations, permissions and Shizuku.

  Kiosk and lockdown · Home launcher · Gestures · Optimizations · Permissions · Shizuku

• Management

  ---

  Many kiosks at once, updates, the remote and JavaScript APIs and analytics.

  Fleet management · Updates · Remote API · JavaScript API · Analytics

• Devices

  ---

  Notes for the hardware that needs a little extra care.

  Amazon Fire tablets · Meta Portal

• Plugins

  ---

  Installing community plugins and building your own.

  Plugin Manager

Getting help

Questions and ideas go to GitHub Discussions. For something broken, open an issue and attach the app log from Settings > System > Logs or the remote admin.