Files
cantabile-ha-addons/cantabile_edge/DOCS.md
T

52 lines
2.1 KiB
Markdown

# Cantabile Edge Agent
The agent connects this Home Assistant to Cantabile. It reads the devices an
installer chose with you, plans your home's energy every 15 minutes (48 hours
ahead, from prices, weather and your devices) and, only where you agreed,
runs those devices through Home Assistant: heating, charging, the battery.
## Before you start
- **Mosquitto broker** add-on, installed and started (Settings → Add-ons →
Add-on store). The agent shows itself in Home Assistant through it: the
device "Cantabile" in the area "Cantabile", prices, what Cantabile asked
for and why. Without the broker the agent still works, but you don't see it
in Home Assistant.
- Your **claim code**, from the Cantabile card.
## Options
- **Mode:** `shadow` (default) reads and plans, controls nothing. `off` only
keeps the connection. Advising and running devices are turned on from
Cantabile, never here, and only with your consent.
- **Claim code:** ties this home to your Cantabile account.
- **Dashboards:** Cantabile's dashboards (Cantabile, Electricity, Solar &
battery, Heating & cooling, Total energy), and Home Assistant's Energy
dashboard while you have none of your own. Your own dashboards are never
changed.
## What it reads, and what leaves your home
- Nothing leaves until an installer has confirmed, with you, which devices
Cantabile may read (the mapping) and you agreed to share data.
- At start the add-on reads Home Assistant's instance id once (in
`/homeassistant/.storage`), as the identity of your home in Cantabile. Then
it runs as its own user without any special rights; it never reads your
`secrets.yaml`, passwords or tokens.
- Everything goes to Cantabile over one encrypted connection that the agent
opens; nothing in your network is opened for it.
## Backups
Home Assistant's backups include the add-on's data: its identity with
Cantabile, the mapping, your consent. Restored on a new machine, the home
keeps its history with Cantabile.
## Help
Cantabile's support, from your Cantabile account.
---
© 2026 Setti Solutions S.R.L, [www.setti.md](https://www.setti.md). All rights reserved.