# Otonomo driver setup guides

Customer-facing setup guides for the most-common drivers. Each covers:

- Hardware / network prerequisites
- Step-by-step config flow in the local UI's drivers wizard
- How to verify the data is flowing
- Common pitfalls (the scars we've learned)
- What Otonomo will do with that driver in observe + active mode

## Top five (covered)

| Driver | Device class | Status | Guide |
|--------|--------------|--------|-------|
| `vaillant_ebus` | Gas boiler | Stable | [vaillant_ebus.md](vaillant_ebus.md) |
| `solaredge_modbus` | PV inverter + battery + grid meter | Stable | [solaredge_modbus.md](solaredge_modbus.md) |
| `daikin_local` | Air-to-air heat pump | Stable | [daikin_local.md](daikin_local.md) |
| `shelly_rpc` | Temperature / humidity sensor | Stable | [shelly_rpc.md](shelly_rpc.md) |
| `easee_api` | EV charger (cloud API) | Stable | [easee_api.md](easee_api.md) |

## Coming guides (drivers ship today, docs are next)

- `panasonic_aquarea` — heat pump (cloud API + planned Heishamon variant)
- `aurora_rs485` — Power-One / ABB Aurora PV inverter
- `wlbox2_local` — BlueCorner / eNovates EV charger (USB-RS485)
- `huawei_sun2000` — Huawei SUN2000 + LUNA battery (Modbus TCP)
- `homewizard_p1` — Belgian / Dutch P1 smart meter dongle
- `goe_charger` — go-e Charger HOMEfix / Gemini
- `marstek_modbus` — Marstek Venus battery
- `enphase_iq` — Enphase IQ Gateway (micro-inverter PV)
- `lg_thermav` — LG Therma V monobloc heat pump

If you have one of these in your home, write us at
`support@otonomo.be` while you're setting it up — we'll walk you
through and turn the conversation into the guide.

## Driver-author guidance

If you're writing a NEW driver for the SDK, your guide should follow
the same structure as the five above:

1. **Prerequisites** — what hardware + what network setup
2. **Configuring the driver** — the exact form fields, what to fill in
3. **Verifying** — the local UI + command-line check
4. **Common pitfalls** — at least 3, in order of likelihood. These
   are the scars; comment them in the driver code too.
5. **What Otonomo will do** — separate observe vs active behaviour
6. **References** — vendor docs, community projects, driver source

The structure is repeated for a reason: customers learn the pattern
once and find new drivers' guides instantly. Don't deviate without
a good reason.