From b522f90a6006435c23111afd89932cb56b5f9a93 Mon Sep 17 00:00:00 2001 From: "pixel::doc" Date: Sat, 4 Jun 2022 00:06:37 +0200 Subject: [PATCH] Update README.md Typo fixed, some Formatting, some Text and MQTT added. --- README.md | 38 ++++++++++++++++++++------------------ 1 file changed, 20 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index 11ccae3..7879397 100644 --- a/README.md +++ b/README.md @@ -1,34 +1,36 @@ # read APS inverters -This project is for reading APS Systems inverters. The program can pair and poll YC600 QS1 and DS3 inverters, up to 9 pieces. The read values are displayed on a web page and sent via mosquitto in a Json format. -The program has a lot of smart features. All settings can be done via the webinterface. It has a console that can be used for debugging and sending/receiving zigbee messages.
+This project is for reading APS Systems inverters. The program can pair and poll YC600 QS1 and DS3 inverters, up to 9 devices. The Data from the inverters is displayed on a web page and sent via MQTT (mosquitto) in JSON format. + +The program has a lot of smart features. All settings can be changed via the webinterface. It has a console that can be used for debugging and sending/receiving zigbee messages. + See the WIKI for information on building it, the working, etc. See it in action on youtube: https://youtu.be/7ZOAcrYXxbM -## downloads -may 17 2022: There is a new version v9_4 available, See changelog.
-Download ESP-ECU-v9_4 https://1drv.ms/u/s!AkMG5FvUwhedi0bA08s8itWhnSJA?e=risayF
+## Download +may 17 2022: There is a new version v9_4 available, See changelog. +Download ESP-ECU-v9_4 https://1drv.ms/u/s!AkMG5FvUwhedi0bA08s8itWhnSJA?e=risayF -

In case someone wants to print the housing, here is an stl: https://1drv.ms/u/s!AkMG5FvUwhedim8a_tVLywAivVDI?e=XIwhYg +In case someone wants to print the housing, here is an stl: https://1drv.ms/u/s!AkMG5FvUwhedim8a_tVLywAivVDI?e=XIwhYg This is for a nodemcu board 31x58mmr> -## features +## Features - Easy wifi config portal - Easy add, delete and pair inverters -- automatic polling or on demand via mqtt or http -- data can be requested via http and mosquitto -- There are 2 different json formats, a special one for domoticz -- Fast asyc webserver +- automatic polling or on demand via MQTT or HTTP +- data can be requested via HTTP and MQTT +- There are 2 different MQTT json formats, a special one for domoticz +- Fast async webserver - a very smart on-line console to send commands and debug - Smart timekeeping - A lot of system info on the webpage -## compile this sketch +## Compile this sketch Use arduino ide with the esp822 version 2.7.1 installed under boardmanager. The ota updates won't work with other versons. Or use the binary file ESP-ECU-v9_4 to flash directly on your ESP device. -## the hardware +## Hardware It is nothing more than an esp device like nodemcu, wemos or its relatives and a prepared cc2530, cc2531 zigbee module. And a powersupply. The zigbeemodule should be flashed with a firmware that can be found here https://github.com/Koenkk/zigbee2mqtt/issues/4221. Here you can find much more information on this project. The most recent link to a lua implementation (including firmware) by kadszol :https://github.com/Koenkk/zigbee2mqtt/files/6797510/discord-11-7-2021.zip @@ -49,7 +51,7 @@ the wiring: ( also see issues ) - gnd -> gnd gnd -> gnd ![minhw](https://user-images.githubusercontent.com/12282915/138685751-98112dfd-8ed8-4185-9de7-c2e2e8f005a9.jpg) -## how does it work +## How does it work The APS system works with a separate zigbee implementation. The ESP-ECU sends zigbee requests to the inverters and analyzes the answers, extracting the values. The ESP communicates with the zigbee module through the alternative serial port. The ESP-ECU starts a coordinator (an entity that can start a zigbee network). The coordinator binds the inverters and sends the poll requests to them. @@ -58,17 +60,17 @@ The interesting values are send via mqtt and displayed on the main page. ![frontpage](https://user-images.githubusercontent.com/12282915/138686152-3b065a7c-88f8-49d6-bf89-c512f82fd562.jpg) ![graph2](https://user-images.githubusercontent.com/12282915/139062602-71e92216-9703-4fc4-acc6-fabf544c4ffd.jpg) -## changelog ## -version ESP-ECU_V9_4: +## Changelog ## +### version ESP-ECU_V9_4 - fixed failed polling after power cycle - fine-tuned some dc values of the DS3 - default conversion factor now 1.66 -version ESP-ECU_V9_3: +### version ESP-ECU_V9_3 - fixed a bug with a negative poll offset - added the poll- begin and end time on the main page -version ESP-ECU_V9_2: +### version ESP-ECU_V9_2 - made it suitable for the DS3 inverter. - fixed polling intervall of 5 minutes. - bug repaired, sq1 dc data panels 2 and 3