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

52 lines
2.1 KiB
Markdown

# Cantabile Modbus bridge
The bridge reads inverters, meters and batteries over Modbus TCP by
Cantabile's device profiles and shows them in Home Assistant (MQTT
discovery, the device under its own name), in Cantabile's units, so the
Cantabile agent maps them exactly.
## Devices
Add each device in the options: its profile (for example `hm8042-hybrid`),
a name, the address and port of its Modbus TCP gateway, and its Modbus id.
The add-on makes everything else from the profile at every start; nothing
is kept by hand.
One Modbus master per gateway: if Home Assistant's own modbus integration
already reads a device, keep that, or stop it before the bridge reads it.
Some RS485 gateways send every answer to every connected client, so a
second master's answers reach the first one too.
Per device, optionally: `poll_s` (seconds between reads, at least 10),
`read_only` (commands are checked and logged but never written: a dry run)
and `simulate` (this device only).
## Circuits from Home Assistant
A SONOFF SPM-4Relay (profile `sonoff-spm`) is read from the SonoffLAN
integration's entities (LAN mode is enough): give its eWeLink id as
`device` (the `ab40...` in `switch.sonoff_ab40..._1`). Each of its four
circuits shows its switch, power, current and voltage under Cantabile's
names; the energy is added up from the power (SonoffLAN reads energy only
from the cloud). A circuit is switched only through this add-on's switch,
after its protection check.
## Protection
Each control has a protection: **none**, **protected** (commands that would
switch it off are refused; for a control without an off, every command) or
**sealed** (set by Cantabile, locked). Every relay and circuit, and the
inverter's settings, start protected. Only
you lift a protection, on the add-on's page (Cantabile devices in the
sidebar); every change is written to the add-on's log with who and when.
## Simulate
With **Simulate** on, the add-on answers for the devices itself, from a
recorded trace in `/share/cantabile/trace-<profile>.json`, and never
touches the real devices.
---
© 2026 Setti Solutions S.R.L, [www.setti.md](https://www.setti.md). All rights reserved.