homebridge-netro/README.md

Homebridge plugin for Netro devices (Spark, Sprite, Pixie, Stream, Whisperer, Lapland S1). English-only UI; manual watering by minutes; zone filtering; multi-device; auto-detection; stable UUIDs.

# homebridge-netro

> Integrate **Netro** smart garden devices with Homebridge / Apple Home. Control watering zones, start **manual watering by minutes**, and read sensor data — all from the Home app or Siri.

[☕ Buy me a coffee](https://paypal.me/mashgundash)

## Supported products
- **Spark / Sprite / Pixie / Stream** — irrigation controllers (multi‑zone)
- **Whisperer** — soil sensor (humidity / temperature / ambient light)
- **Lapland S1** — lamp / light control

## Features
- Manual watering — **duration in minutes** (not seconds)
- **Per‑device zone filtering** (`EXPOSE ONLY THESE ZONES`), leave empty to expose **all zones**
- **Multi‑device** (add as many Netro devices as you want)
- **Auto‑detection** of device type (controller / sensor / lamp) via Netro API
- **Stable UUIDs** so accessories aren’t duplicated
- **Auto‑prune**: hidden zones are unregistered automatically when config changes
- Polling every *N* seconds for live status (default: 60s)
- English‑only UI (cleaner settings)

## Install
```bash
npm i -g homebridge-netro
```

## Configure (Homebridge UI)
Open **Plugins → Netro → Configure**.  
The form has two areas:

### 1) NETRO DEVICES
Press **ADD NETRO DEVICES** to add one or more devices. For each device:
- **DEVICE SERIAL (API KEY)** — the serial (as shown in the Netro app)
- **CUSTOM NAME (optional)** — for logs (the Home app uses the *zone* name)
- **DEVICE TYPE** — leave **Auto (detect)** unless you need to force
- **EXPOSE ONLY THESE ZONES** — list indices, e.g. `[1,3]` (empty = **all**)
- **DEFAULT MANUAL WATERING DURATION (MINUTES)** — override for this device

### 2) COMMON SETTINGS
- **GLOBAL DEFAULT WATERING DURATION (MINUTES)**
- **STATUS POLLING INTERVAL (SECONDS)** (default **60**)
- **AUTO‑PRUNE REMOVED ZONES/ACCESSORIES** (on by default)

## Use in Apple Home
- Each **zone** appears as a **Valve** accessory. The **name is the zone name** (e.g. “Drip”).  
- Start watering by toggling the valve. The plugin automatically stops it after the selected duration and updates **In Use / Active / Remaining Duration**.

## Notes by product
- **Spark / Sprite / Pixie / Stream**: zones are created as **Valve** services. Manual watering is available from the tile.  
- **Whisperer**: exposes **Humidity**, **Temperature**, and **Ambient Light** sensors.  
- **Lapland S1**: appears as a **Lightbulb** (On/Off).

## Troubleshooting
- **No valves appear** → leave `EXPOSE ONLY THESE ZONES` **empty** (all zones), verify your serial/API key, and check the log for “Discovered device … with N zone(s)”.  
- **Old accessories remain** → enable **AUTO‑PRUNE** or use “Reset Cached Accessories” for the Netro child bridge.  
- **Homebridge release notes not visible** → publish a GitHub release matching your npm version (Homebridge reads GitHub for the *Release Notes* tab). The **Full Changelog** tab reads `CHANGELOG.md` through unpkg (already configured).

## Acknowledgements
Made by **Régis Jehl (mashgundash)**. Feedback / PRs welcome.