kiosk-satellite README

项目的 README,来自 github.com/jxlarrea/kiosk-satellite。合并为一个 markdown 文件: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: Make voice or video calls between kiosks 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 (2nd gen), Echo Dot (3rd gen), Echo Show 5 (1st gen), Echo Show 5 (2nd gen), Echo Show 8 (1st gen), Echo Show 8 (2nd gen), 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)

正在搜索数据库…

这是什么?Kiosk Satellite 可以把一台 Android 设备变成专用的 Home Assistant 仪表盘信息屏,内置语音控制、同步音乐、屏保,并支持基于摄像头的人员检测。
这是应用还是 Home Assistant 插件?它是一个独立的 Android 应用,以 APK 形式安装,并连接到你现有的 Home Assistant 实例;无需在 Home Assistant 本身中安装任何内容。
怎样才能让它运行起来?下载 APK 并安装,然后按照设置向导连接到你的 Home Assistant 实例,并选择一个仪表盘。
安装前我需要准备什么?Android 7.0 或更高版本、一个设备可以访问的 Home Assistant 实例,以及在你的 Home Assistant 个人资料中生成的长期访问令牌。
我可以免费使用吗?可以用于商业用途吗?仅限个人非商业用途免费使用;不允许将本应用用于商业用途,也不允许重新分发修改后的版本。
我的数据会保留在本地吗?应用完全在本地运行,运动、人脸和人员检测等功能都在设备上处理,不会上传到云端。
什么是 Voice Satellite?它是应用内置的 Home Assistant Assist 语音卫星,提供唤醒词检测、定时器和播报功能,即使屏幕关闭也能工作,且无需在 Home Assistant 本身中安装任何内容。
音乐播放是如何工作的?它通过 Sendspin 播放与 Music Assistant 同步的音频,支持来自 Apple 设备的 AirPlay,并可跟随 Home Assistant 或 Sonos 播放器,还提供全屏的正在播放界面和歌词。
它在哪些设备上测试过?文档中提供了 Amazon Fire 平板、Echo Dot、Echo Show 5、Echo Show 8、Meta Portal 和 Raspberry Pi 4 的专门设置指南。
它能感知有人走近信息屏吗?可以,设备摄像头会在本地进行运动、人脸和人员检测,从而唤醒屏幕或打开摄像头画面,这些检测结果还会以传感器的形式显示在 Home Assistant 中。
作者
jxlarrea
大小
205.7 MB
星标
2.8K
时长
4个月
提交 · 90 天