Skip to content

Commit 6f34701

Browse files
committed
docs: highlight API v2 requirement for recent Netro devices
1 parent f804931 commit 6f34701

2 files changed

Lines changed: 20 additions & 3 deletions

File tree

README.md

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,8 @@
22
# Netro Smart Garden Integration for Home Assistant
33

44

5-
[![hacs_badge](https://img.shields.io/badge/HACS-Default-orange.svg)](https://github.com/custom-components/hacs) [![CI](https://github.com/kcofoni/ha-netro-watering/workflows/CI/badge.svg)](https://github.com/kcofoni/ha-netro-watering/actions) [![codecov](https://codecov.io/gh/kcofoni/ha-netro-watering/branch/main/graph/badge.svg)](https://codecov.io/gh/kcofoni/ha-netro-watering) [![GitHub release](https://img.shields.io/github/v/release/kcofoni/ha-netro-watering)](https://github.com/kcofoni/ha-netro-watering/releases) ![GitHub repo size](https://img.shields.io/github/repo-size/kcofoni/ha-netro-watering) ![GitHub](https://img.shields.io/github/license/kcofoni/ha-netro-watering)
5+
[![hacs_badge](https://img.shields.io/badge/HACS-Default-orange.svg)](https://github.com/custom-components/hacs) [![CI](https://github.com/kcofoni/ha-netro-watering/workflows/CI/badge.svg)](https://github.com/kcofoni/ha-netro-watering/actions) [![codecov](https://codecov.io/gh/kcofoni/ha-netro-watering/branch/main/graph/badge.svg)](https://codecov.io/gh/kcofoni/ha-netro-watering) [![GitHub release](https://img.shields.io/github/v/release/kcofoni/ha-netro-watering)](https://github.com/kcofoni/ha-netro-watering/releases) [![GitHub beta](https://img.shields.io/github/v/tag/kcofoni/ha-netro-watering?label=beta&color=orange)](https://github.com/kcofoni/ha-netro-watering/releases)
6+
![GitHub repo size](https://img.shields.io/github/repo-size/kcofoni/ha-netro-watering) ![GitHub](https://img.shields.io/github/license/kcofoni/ha-netro-watering)
67

78

89
## 📑 Table of Contents
@@ -11,6 +12,7 @@
1112
- [📖 Description](#📖-description)
1213
- [🌱 Installation](#🌱-installation)
1314
- [⚙️ Configuration](#⚙️-configuration)
15+
- [🔐 Netro Public API v2](#🔐-netro-public-api-v2)
1416
- [🌦️ Netro Weather Sync Blueprint](#🌦️-netro-weather-sync-blueprint)
1517
- [🖼️ Lovelace cards](#🖼️-lovelace-cards)
1618
- [🛠️ Advanced configuration](#🛠️-advanced-configuration)
@@ -82,14 +84,29 @@ Polling intervals can be configured separately for sensors and controllers. A de
8284
![change controller options](https://kcofoni.github.io/ha-netro-watering/images/controller_options.png "Controller options")
8385
![change sensor options](https://kcofoni.github.io/ha-netro-watering/images/sensor_options.png "Sensor options")
8486

85-
8687
> **ℹ️ Note**
8788
> You no longer need to reload the device after changing options. Changes are applied automatically.
8889
> - Most updates take effect on the **next polling cycle**.
8990
> - `default_watering_delay` and `delay_before_refresh` apply to **subsequent commands**.
9091
> - `sensor_value_days_before_today` is used on the **next sensor update**.
9192
> - No manual reload or restart is required (except for internal fields like `netro_api_url`, if instructed).
9293
94+
### 🔐 Netro Public API v2
95+
96+
By default, the integration uses [version 1 of the Netro Public API](https://www.netrohome.com/en/shop/articles/10), which authenticates devices using their serial numbers. However, you can switch to version 2, which uses API keys generated on demand for each device.
97+
API keys provide a higher level of security: they can be regenerated if compromised, unlike fixed serial numbers.
98+
99+
To use [API v2](https://netrohome.com/en/shop/user_guides/7), simply specify the corresponding URL in your Home Assistant configuration file:
100+
101+
```yaml
102+
netro_watering:
103+
netro_api_url: https://api.netrohome.com/npa/v2/
104+
```
105+
> ⚠️ **Important:**
106+
> Some recent Netro devices only work with API version 2.
107+
> If your device is rejected when using a serial number with API v1 (the default), carefully check the error message.
108+
> It may indicate that you need to use API v2 and an API key for authentication.
109+
93110
## 🌦️ Netro Weather Sync Blueprint
94111
95112
This blueprint allows you to synchronize your **Netro smart watering** system with current weather conditions using Home Assistant data. It dynamically adjusts watering schedules to prevent watering during rain or when humidity is high, helping you save water efficiently.

custom_components/netro_watering/manifest.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,6 @@
1010
"issue_tracker": "https://github.com/kcofoni/ha-netro-watering/issues",
1111
"requirements": ["pynetro==0.1.5", "validators==0.20.0"],
1212
"ssdp": [],
13-
"version": "1.4.0-beta.2",
13+
"version": "1.4.0",
1414
"zeroconf": []
1515
}

0 commit comments

Comments
 (0)