From 39980f40c16898267d390a16e1a56c6dc654f2a6 Mon Sep 17 00:00:00 2001 From: Matthias Prinke <83612361+matthias-bs@users.noreply.github.com> Date: Thu, 20 Jun 2024 15:42:55 +0200 Subject: [PATCH] Update README.md --- README.md | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index a356cb7..4d49648 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# BresserWeatherSensorReceiver +Jo# BresserWeatherSensorReceiver [![CI](https://github.com/matthias-bs/BresserWeatherSensorReceiver/actions/workflows/CI.yml/badge.svg)](https://github.com/matthias-bs/BresserWeatherSensorReceiver/actions/workflows/CI.yml) [![CppUTest](https://github.com/matthias-bs/BresserWeatherSensorReceiver/actions/workflows/CppUTest.yml/badge.svg)](https://github.com/matthias-bs/BresserWeatherSensorReceiver/actions/workflows/CppUTest.yml) [![GitHub release](https://img.shields.io/github/release/matthias-bs/BresserWeatherSensorReceiver?maxAge=3600)](https://github.com/matthias-bs/BresserWeatherSensorReceiver/releases) @@ -160,7 +160,16 @@ See `WeatherSensorCfg.h` for configuration options. ## Rain Statistics -[RainGauge.h](https://github.com/matthias-bs/BresserWeatherSensorReceiver/blob/main/src/RainGauge.h) +The weather sensors transmit the accumulated rainfall since the last battery change or reset. This raw value is provided as `rain_mm`. To provide the same functionality as the original weather stations, the class `RainGauge` (see [RainGauge.h](https://github.com/matthias-bs/BresserWeatherSensorReceiver/blob/main/src/RainGauge.h)) +is used to calculate +* hourly (past 60 minutes) rainfall, +* daily rainfall, +* weekly rainfall, +* and monthly rainfall. + +These values are named `rain_h`, `rain_d`, `rain_w` and `rain_m` in the MQTT software examples. + +See [Implementing Rain Gauge Statistics] (https://github.com/matthias-bs/BresserWeatherSensorReceiver/wiki/04.-Implementing-Rain-Gauge-Statistics) for more details. ## SW Examples