kiosk-satellite README

The project's README from github.com/jxlarrea/kiosk-satellite. As one markdown file: README.md.

Kiosk Satellite for Home Assistant

Stars Downloads version Build

Buy Me A Coffee

Kiosk Satellite is an Android app designed for dedicated Home Assistant kiosks, with native Voice Satellite support, synchronized music playback and photo screensavers.
Kiosk Satellite is fully local and free for personal, non-commercial use.

Download · Get started · Documentation

Kiosk Satellite running on a Home Assistant display

Features

• Native voice control: Kiosk Satellite is a Home Assistant Assist satellite on its own, with Voice Satellite built in: ten skins, timers, announcements and wake word detection that works with the screen off or, with background listening enabled, while another app is open. Nothing to install in Home Assistant.

Hands-free voice control with Voice Satellite

• Dashboard performance: Optional optimizations reduce unnecessary dashboard updates and pause rendering during screensavers to lower CPU and GPU usage on older devices. Voice and the Home Assistant connection stay active.

• Music playback: Synchronized Music Assistant audio through Sendspin, AirPlay from an iPhone, iPad or Mac and the option to follow a Home Assistant or Sonos player. The full-screen Now Playing view shows album art, playback controls and supported lyrics, and the Music Library browses Music Assistant, Home Assistant or Sonos and plays on any speaker.

Now Playing with album artwork and music controls Music Library Discover in  Kiosk Satellite Music Library Discover in  Kiosk Satellite

• Screensavers: Immich albums, local photos, clocks, weather mood and a live night sky, with motion, face or presence detection to wake the kiosk.

• Motion, face and person detection: The device camera detects motion and faces on the device itself. Motion wakes the screen when someone walks up and holds off the screensaver while the room is in use. Face detection wakes it only when someone looks at the screen, so people walking past leave the screensaver up. Person detection uses the built-in sensor on supported devices. Motion and person also show up in Home Assistant as sensors for your automations.

Settings in Kiosk Satellite Digital Clock Screensaver in  Kiosk Satellite Weather Mood Screensaver in Kiosk Satellite

• Home Assistant integration: The built-in ESPHome connection exposes screen controls, volume and device sensors. An optional Bluetooth proxy relays nearby Bluetooth devices to Home Assistant.

• Remote administration: Configure the app, view live screenshots, read logs and back up settings from a browser. Fleet management shares configuration profiles and coordinates updates across multiple kiosks.

Remote Administration in Kiosk Satellite

• Intercom: Kiosks can call each other or broadcast to all kiosks at once using the Intercom feature. Kiosks are auto discovered in the local network.

• Alarms: Set alarms that ring on the kiosk itself, with no Home Assistant or network needed. A sunrise can brighten the screen before the alarm rings, and a Clock or Weather Mood screensaver can show the alarm with Snooze and Stop in its own style.

• Calendar: Show your Home Assistant calendars as a family calendar with Day, Week, Month and Schedule views. Each person gets a color, and an event shared by several people is split between their colors.

Calendar Days Calendar Schedule

• Kiosk conveniences: Use hand gestures to run Home Assistant actions or open a camera view by holding up fingers to the device camera. Set Kiosk Satellite as the home launcher on supported devices so the Home button returns to your dashboard. Arrange up to twelve live feeds in camera views, with camera imports from Home Assistant or Go2RTC.

Also built in: PIN-protected kiosk mode, touch and clap gestures, DLNA media playback, RTSP streaming, Shizuku support and more!

Now Playing with album artwork and music controls Live camera feeds in Kiosk Satellite

Get started

You need Android 7.0 or newer, a reachable Home Assistant instance and a long-lived access token from Home Assistant Profile → Security → Long-lived access tokens.

  1. Download the latest APK on your Android device.
  2. Open it to install. Allow installation from this source if Android asks.
  3. Launch Kiosk Satellite and follow the setup wizard to connect Home Assistant and choose your dashboard.

You can also enable Remote Administration in the first setup step and finish setup from your computer at http://<device-ip>:2324.

For voice control, leave Voice Satellite on in the setup wizard, then add the kiosk in Home Assistant under Settings > Devices & services, where it shows up as discovered. See Voice Satellite.

Documentation

Voice Satellite · Screensavers · Music · ESPHome & Bluetooth · Fleet management

All guides and API references

• Display: Screen settings, custom pages, screensavers, Immich and At a Glance widgets.

• Voice and media: Voice Satellite, microphone, media player, camera views, device camera, intercom and DLNA.

• Kiosk setup: Lockdown, home launcher, gestures, LED control, alarms, optimizations, permissions, Shizuku and updates.

• Automation and management: ESPHome, fleet management, Remote API, TLS encryption and JavaScript API.

• Device guides: Amazon Fire tablets, Echo Dot, Echo Show 5, Echo Show 8, Meta Portal and Raspberry Pi 4.

• Plugin Manager: Install and create community plugins for Kiosk Satellite.

Thank you for your support

Thank you to everyone who supports my work through Buy Me a Coffee. I test everything on real hardware, which means buying devices to reproduce issues and check changes across different manufacturers and Android flavors. Your contributions help cover those purchases and make that testing possible.

License and credits

Free for personal, non-commercial use under CC BY-NC-ND 4.0. Commercial use of the application and redistribution of modified application builds are not permitted. Independent plugins have additional permission.

Built with these projects

Thanks to Home Assistant, ESPHome, Music Assistant, Immich, Flutter, flutter_inappwebview and ONNX Runtime.

Wake-word support builds on vsWakeWord, openWakeWord and microWakeWord. Echo cancellation uses LocalVQE and ggml, with WebRTC audio processing and Abseil as the fallback. Icons come from Material Design Icons. Fonts include Rubik, Nunito, Inter and DSEG.

Thank you to the package authors whose work makes Kiosk Satellite possible.

kiosk-satellite (jxlarrea/kiosk-satellite)

bluetooth-low-energy
Searching Database…

What is this?Kiosk Satellite turns an Android device into a dedicated kiosk for Home Assistant dashboards, with built-in voice control, synchronized music, screensavers and camera-based presence detection.
Is this an app or a Home Assistant add-on?It is a standalone Android app installed as an APK that connects to your existing Home Assistant instance; nothing has to be installed inside Home Assistant itself.
How do I get it running?Download the APK, install it, and follow the setup wizard to connect to your Home Assistant instance and choose a dashboard.
What do I need before installing it?Android 7.0 or newer, a Home Assistant instance reachable from the device, and a long-lived access token generated from your Home Assistant profile.
Can I use this for free, even commercially?It is free only for personal, non-commercial use; commercial use of the app and redistributing modified builds are not permitted.
Does my data stay local?The app runs fully locally, and features like motion, face and person detection are processed on-device rather than sent to the cloud.
What is Voice Satellite?It is the built-in Home Assistant Assist satellite inside the app, offering wake word detection, timers and announcements that work even with the screen off, with nothing to install in Home Assistant itself.
How does music playback work?It plays synchronized Music Assistant audio via Sendspin, supports AirPlay from Apple devices, and can follow a Home Assistant or Sonos player, with a full-screen Now Playing view and lyrics.
Which devices has it been tested on?The docs include dedicated setup guides for Amazon Fire tablets, Echo Dot, Echo Show 5, Echo Show 8, Meta Portal and Raspberry Pi 4.
Can it tell when someone walks up to the kiosk?Yes, the device camera performs on-device motion, face and person detection to wake the screen or open a camera view, and these detections also show up as sensors in Home Assistant.
Creator
jxlarrea
Size
173 MB
Stars
2.4K
Age
3mo
Commits · 90 Days