From 231d90ece524a33a5a977eb5e4e856dafade2f3a Mon Sep 17 00:00:00 2001 From: BlueFox Date: Fri, 13 Jun 2025 16:11:23 +0200 Subject: [PATCH] Added more detailed description --- LICENSE => COPYING | 0 README.md | 19 ++++++++++++++++++- 2 files changed, 18 insertions(+), 1 deletion(-) rename LICENSE => COPYING (100%) diff --git a/LICENSE b/COPYING similarity index 100% rename from LICENSE rename to COPYING diff --git a/README.md b/README.md index 29e372b..3262c5f 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,20 @@ # lge320-reader -Read data from the Landis+Gyr E320 electricity meter (or any DIN EN 62056‐21-compatible meter on 9600 Baud) \ No newline at end of file +Read data from the Landis+Gyr E320 electricity meter (or any DIN EN 62056‐21-compatible meter on 9600 Baud) +In the `if __name__ == "__main__"` statement, an example data processing is written (as it is in use by me) - sending data to MQTT every second (on each data receive of the Landis+Gyr) and writing data to an influx database every 10s is currently implemented and can be configured using the `.env` file. + + +## Usage + +First, you need to configure all the necessary values in the .env file. After configuring, run + +```bash +python3 lge320reader.py +``` + +...to run the script. + + +## License + +This project is licensed under the terms of the GNU General Public License v3.0 or later, see [COPYING](COPYING).