Include all files

README.md

@@ -0,0 +1,40 @@
+# Home Assistant Voice Satellite (HAV-SAT)
+
+Experimental voice satellite for [Home Assistant][homeassistant] that uses the [ESPHome][esphome] protocol.
+
+Runs on Linux `aarch64` and `x86_64` platforms. Tested with Python 3.13 and Python 3.11.
+Supports announcments, start/continue conversation, and timers.
+
+## Installation
+
+Install system dependencies (`apt-get`):
+
+* `libportaudio2` (for `sounddevice`)
+* `build-essential` (for `pymicro-features`)
+* `libmpv-dev` (for `python-mpv`)
+
+Clone and install project:
+
+``` sh
+git clone https://github.com/OHF-Voice/hav-sat.git
+cd hav-sat
+script/setup
+```
+
+## Running
+
+Use `script/run` or `python3 -m hav_sat`
+
+See `--help` for more options.
+
+## Connecting to Home Assistant
+
+1. In Home Assistant, go to "Settings" -> "Device & services"
+2. Click the "Add integration" button
+3. Choose "ESPHome" and then "Set up another instance of ESPHome"
+4. Enter the IP address of your voice satellite with port 6053
+5. Click "Submit"
+
+<!-- Links -->
+[homeassistant]: https://www.home-assistant.io/
+[esphome]: https://esphome.io/