Getting Started

Prerequisites

• Python 3.13+
• uv -- fast Python package manager
• A running Home Assistant instance
• Ollama running locally (or a cloud LLM API key)
• (Optional) Spotify Developer credentials for music control
• (Optional) Docker for containerized deployment
• (Optional) M5Stack Atom Echo for the voice satellite

Quick Start

# Clone the repository
git clone https://github.com/ragnarok22/schakel.git
cd schakel

# Install dependencies
uv sync

# Copy the example config and edit it
cp config.yaml.example config.yaml

# Start the dev server
make dev

The service will be available at http://localhost:8000 with:

• GET / -- health check
• WS /ws/audio -- audio WebSocket pipeline

Next Steps

• Installation -- detailed setup instructions for all components
• Configuration -- full config.yaml walkthrough with all options
• M5Stack Atom Echo -- flash the voice satellite firmware