Installation

Please have a read through this page and also the instruction pages to see what this config does and what is involved to set it up.

Also check out the Discord server or Discussions section in the repo, for latest updates, new features, and to ask questions or make suggestions 👍

This firmware will enable your S3 Box 3 to use the touch screen and home button, and configure the box to act like a dashboard for Home Assistant. Giving you the power to control your entitities and display sensor information. The box will also be configured as a media player, giving you volume control (also improves the overall volume of the internal speaker compared to the ESPHome stock config) and easily broadcast messages to the device or stream media. Oh, and don't forget! it is also a Voice Assistant!!

There are also some settings that can be changed within the config and these can be found at the very top under the substitutions: section more details of these can be found in the 'how to customise' Guide - Click here

Requirements

ESPHome installation, either Home Assistant add-on, Local Cli install or docker. Please note that the compile of the config is fairly resource hungry and may fail on older devices with low ram and low processing power. However running ESPHome from a local machine with more power, will make this much faster and less likelihood of encountering errors. Details of how to run ESPHome in different ways, can be found here for OS installs or Docker here.

A Working installation of HomeAssistant preferably on the same network/vlan as the device, to avoid connection issues.

Samba Share Home Assistant add-on (available in the add-on store)or some other means of accessing your Home Assistant files and folders. you will need to access the config/esphome folder from your local computer in order to copy the required sound files.

For Voice Asssistant to function you will either need a Nabu Casa (HomeAssistant Cloud) subscription or the Whisper & Piper add-ons. If you don't intend to use the on device Micro Wake Word, you will require a wake word engine such as openwakeword. The following add-ons are all available in the Home Assistant add-on store Whisper, Piper & openwakeword.

Click here if you have everything ready and are ready to start the installation.

I really hope you enjoy this project and I thank you for your support. If you have found this project useful and would like to buy me a coffee then the link is below: