Develop03 devil

.github/workflows/compile_development.yml

@@ -47,7 +47,7 @@ jobs:
       run: python convert.py
 
     - name: Run PlatformIO
-      run: pio run -d src --environment esp8266-release --environment esp8285-release --environment esp8266-nokia5110 --environment esp8266-ssd1306 --environment esp32-wroom32-release --environment esp32-wroom32-nokia5110 --environment esp32-wroom32-ssd1306
+      run: pio run -d src --environment esp8266-release --environment esp8285-release --environment esp32-wroom32-release
 
     - name: Rename Binary files
       id: rename-binary-files

.github/workflows/compile_release.yml

@@ -51,7 +51,7 @@ jobs:
       run: python convert.py
 
     - name: Run PlatformIO
-      run: pio run -d src --environment esp8266-release --environment esp8285-release --environment esp8266-nokia5110 --environment esp8266-ssd1306 --environment esp32-wroom32-release --environment esp32-wroom32-nokia5110 --environment esp32-wroom32-ssd1306
+      run: pio run -d src --environment esp8266-release --environment esp8285-release --environment esp32-wroom32-release
 
     - name: Rename Binary files
       id: rename-binary-files

Getting_Started.md

@@ -6,9 +6,12 @@
 - [Things needed](#things-needed)
     - [There are fake NRF24L01+ Modules out there](#there-are-fake-nrf24l01-modules-out-there)
 - [Wiring things up](#wiring-things-up)
-    - [ESP8266 wiring example](#esp8266-wiring-example)
+    - [ESP8266 wiring example on WEMOS D1](#esp8266-wiring-example)
       - [Schematic](#schematic)
       - [Symbolic view](#symbolic-view)
+    - [ESP8266 wiring example on 30pin Lolin NodeMCU v3](#esp8266-wiring-example-2)
+      - [Schematic](#schematic-2)
+      - [Symbolic view](#symbolic-view-2)
     - [ESP32 wiring example](#esp32-wiring-example)
       - [Schematic](#schematic-1)
       - [Symbolic view](#symbolic-view-1)
@@ -69,8 +72,9 @@ Make sure the NRF24L01+ module has the "+" in its name as we depend on the 250kb
 
 | **Parts** | **Price** |
 | --- | --- |
-| D1 ESP8266 Mini WLAN Board Mikrokontroller | 4,40 Euro |
+| D1 ESP8266 Mini WLAN Board Microcontroller | 4,40 Euro |
 | NRF24L01+ SMD Modul 2,4 GHz Wi-Fi Funkmodul | 3,45 Euro |
+| 100µF / 10V Capacitor Kondensator | 0,15 Euro |
 | Jumper Wire Steckbrücken Steckbrett weiblich-weiblich | 2,49 Euro |
 | **Total costs** | **10,34 Euro** |
 
@@ -80,6 +84,7 @@ To also run our sister project OpenDTU and be upwards compatible for the future
 | --- | --- |
 | ESP32 Dev Board NodeMCU WROOM32 WiFi | 7,90 Euro |
 | NRF24L01+ PA LNA SMA mit Antenne Long | 4,50 Euro |
+| 100µF / 10V Capacitor Kondensator | 0,15 Euro |
 | Jumper Wire Steckbrücken Steckbrett weiblich-weiblich | 2,49 Euro |
 | **Total costs** | **14,89 Euro** |
 
@@ -89,6 +94,18 @@ Watch out, there are some fake NRF24L01+ Modules out there that seem to use rebr
 An example can be found in [Issue #230](https://github.com/lumapu/ahoy/issues/230).<br/>
 You are welcome to add more examples of faked chips. We will add that information here.<br/>
 
+Some users reported better connection or longer range through more walls when using the
+"E01-ML01DP5" EBYTE 2,4 GHz Wireless Modul nRF24L01 + PA + LNA RF Modul, SMA-K Antenna connector,
+which has an eye-catching HF cover. But beware: It comes without the antenna!
+
+In any case you should stabilize the Vcc power by a capacitor and don't exceed the Amplifier Power Level "LOW".
+Users reporting good connection over 10m through walls / ceilings with Amplifier Power Level "MIN".
+It is not always the bigger the better...
+
+Power levels "HIGH" and "MAX" are meant to wirings where the nRF24 is supplied by an extra 3.3 Volt regulator.
+The bultin regulator on ESP boards has only low reserves in case WiFi and nRF are sending simultaneously.
+If you operate additional interfaces like a display, the reserve is again reduced.
+
 ## Wiring things up
 
 The NRF24L01+ radio module is connected to the standard SPI pins:
@@ -107,7 +124,7 @@ Additional, there are 3 pins, which can be set individual:
 
 *These pins can be changed from the /setup URL.*
 
-#### ESP8266 wiring example
+#### ESP8266 wiring example on WEMOS D1
 
 This is an example wiring using a Wemos D1 mini.<br>
 
@@ -119,6 +136,18 @@ This is an example wiring using a Wemos D1 mini.<br>
 
 ![Symbolic](doc/AhoyWemos_Steckplatine.jpg)
 
+#### ESP8266 wiring example on 30pin Lolin NodeMCU v3
+
+This is an example wiring using a NodeMCU V3.<br>
+
+##### Schematic
+
+![Schematic](doc/ESP8266_nRF24L01+_Schaltplan.jpg)
+
+##### Symbolic view
+
+![Symbolic](doc/ESP8266_nRF24L01+_bb.png)
+
 #### ESP32 wiring example
 
 Example wiring for a 38pin ESP32 module

User_Manual.md

@@ -29,6 +29,7 @@ The AhoyDTU will publish on the following topics
 | `uptime` | 73630 | uptime in seconds | false |
 | `version` | 0.5.61 | current installed verison of AhoyDTU | true |
 | `wifi_rssi` | -75 | WiFi signal strength | false |
+| `ip_addr` | 192.168.178.25 | WiFi Station IP Address | true |
 
 | status code | Remarks |
 |---|---|
@@ -43,6 +44,7 @@ The AhoyDTU will publish on the following topics
 |---|---|---|---|
 | `available` | 2 | see table below | true |
 | `last_success` | 1672155690 | UTC Timestamp | true |
+| `ack_pwr_limit` | true | fast information if inverter has accepted power limit | false |
 
 | status code | Remarks |
 |---|---|

doc/prometheus_ep_description.md

@@ -0,0 +1,47 @@
+# Prometheus Endpoint
+Metrics available for AhoyDTU device, inverters and channels.
+
+Prometheus metrics provided at `/metrics`. 
+
+## Labels
+| Label name | Description                           | 
+|:-----------|:--------------------------------------|
+| version    | current installed version of AhoyDTU  |
+| image      | currently not used                    |
+| devicename | Device name from setup                |
+| name       | Inverter name from setup              |
+| serial     | Serial number of inverter             |
+| enabled    | Communication enable for inverter     |
+| inverter   | Inverter name from setup              |
+| channel    | Channel name from setup               |
+
+
+## Exported Metrics
+| Metric name                            | Type    | Description                                            | Labels       | 
+|----------------------------------------|---------|--------------------------------------------------------|--------------|
+| `ahoy_solar_info`                      | Gauge   | Information about the AhoyDTU device                   | version, image, devicename |
+| `ahoy_solar_inverter_info`             | Gauge   | Information about the configured inverter(s)           | name, serial, enabled |
+| `ahoy_solar_U_AC_volt`                 | Gauge   | AC voltage of inverter [V]                             | inverter  | 
+| `ahoy_solar_I_AC_ampere`               | Gauge   | AC current of inverter [A]                             | inverter  | 
+| `ahoy_solar_P_AC_watt`                 | Gauge   | AC power of inverter [W]                               | inverter  | 
+| `ahoy_solar_Q_AC_var`                  | Gauge   | AC reactive power[var]                                 | inverter  | 
+| `ahoy_solar_F_AC_hertz`                | Gauge   | AC frequency [Hz]                                      | inverter  | 
+| `ahoy_solar_PF_AC`                     | Gauge   | AC Power factor                                        | inverter  | 
+| `ahoy_solar_Temp_celsius`              | Gauge   | Temperature of inverter                                | inverter  | 
+| `ahoy_solar_ALARM_MES_ID`              | Gauge   | Last alarm message id of inverter                      | inverter  | 
+| `ahoy_solar_YieldDay_wattHours`        | Counter | Energy converted to AC per day [Wh]                    | inverter  | 
+| `ahoy_solar_YieldTotal_kilowattHours`  | Counter | Energy converted to AC since reset [kWh]               | inverter  | 
+| `ahoy_solar_P_DC_watt`                 | Gauge   | DC power of inverter [W]                               | inverter  | 
+| `ahoy_solar_Efficiency_ratio`          | Gauge   | ration AC Power over DC Power [%]                      | inverter  | 
+| `ahoy_solar_U_DC_volt`                 | Gauge   | DC voltage of channel [V]                              | inverter, channel | 
+| `ahoy_solar_I_DC_ampere`               | Gauge   | DC current of channel [A]                              | inverter, channel | 
+| `ahoy_solar_P_DC_watt`                 | Gauge   | DC power of channel [P]                                | inverter, channel | 
+| `ahoy_solar_YieldDay_wattHours`        | Counter | Energy converted to AC per day [Wh]                    | inverter, channel | 
+| `ahoy_solar_YieldTotal_kilowattHours`  | Counter | Energy converted to AC since reset [kWh]               | inverter, channel | 
+| `ahoy_solar_Irradiation_ratio`         | Gauge   | ratio DC Power over set maximum power per channel [%]  | inverter, channel |
+| `ahoy_solar_radio_rx_success`          | Gauge   | NRF24 statistic                                        | |
+| `ahoy_solar_radio_rx_fail`             | Gauge   | NRF24 statistic                                        | |
+| `ahoy_solar_radio_rx_fail_answer`      | Gauge   | NRF24 statistic                                        | |
+| `ahoy_solar_radio_frame_cnt`           | Gauge   | NRF24 statistic                                        | |
+| `ahoy_solar_radio_tx_cnt`              | Gauge   | NRF24 statistic                                        | |
+

scripts/buildManifest.py

@@ -36,13 +36,13 @@ def buildManifest(path, infile, outfile):
     esp32["parts"].append({"path": "bootloader.bin", "offset": 4096})
     esp32["parts"].append({"path": "partitions.bin", "offset": 32768})
     esp32["parts"].append({"path": "ota.bin", "offset": 57344})
-    esp32["parts"].append({"path": version[1] + "_esp32_" + sha + ".bin", "offset": 65536})
+    esp32["parts"].append({"path": version[1] + "_" + sha + "_esp32.bin", "offset": 65536})
     data["builds"].append(esp32)
 
     esp8266 = {}
     esp8266["chipFamily"] = "ESP8266"
     esp8266["parts"] = []
-    esp8266["parts"].append({"path": version[1] + "_esp8266_" + sha + ".bin", "offset": 0})
+    esp8266["parts"].append({"path": version[1] + "_" + sha + "_esp8266.bin", "offset": 0})
     data["builds"].append(esp8266)
 
     jsonString = json.dumps(data, indent=2)

scripts/getVersion.py

@@ -52,42 +52,22 @@ def readVersion(path, infile):
     os.mkdir(path + "firmware/")
     sha = os.getenv("SHA",default="sha")
 
-    versionout = version[:-1] + "_esp8266_" + sha + ".bin"
+    versionout = version[:-1] + "_" + sha + "_esp8266.bin"
     src = path + ".pio/build/esp8266-release/firmware.bin"
     dst = path + "firmware/" + versionout
     os.rename(src, dst)
-
-    versionout = version[:-1] + "_esp8266_nokia5110_" + sha + ".bin"
-    src = path + ".pio/build/esp8266-nokia5110/firmware.bin"
-    dst = path + "firmware/" + versionout
-    os.rename(src, dst)
-
-    versionout = version[:-1] + "_esp8266_ssd1306_" + sha + ".bin"
-    src = path + ".pio/build/esp8266-ssd1306/firmware.bin"
-    dst = path + "firmware/" + versionout
-    os.rename(src, dst)
 
-    versionout = version[:-1] + "_esp8285_" + sha + ".bin"
+    versionout = version[:-1] + "_" + sha + "_esp8285.bin"
     src = path + ".pio/build/esp8285-release/firmware.bin"
     dst = path + "firmware/" + versionout
     os.rename(src, dst)
     gzip_bin(dst, dst + ".gz")
 
-    versionout = version[:-1] + "_esp32_" + sha + ".bin"
+    versionout = version[:-1] + "_" + sha + "_esp32.bin"
     src = path + ".pio/build/esp32-wroom32-release/firmware.bin"
     dst = path + "firmware/" + versionout
     os.rename(src, dst)
 
-    versionout = version[:-1] + "_esp32_nokia5110_" + sha + ".bin"
-    src = path + ".pio/build/esp32-wroom32-nokia5110/firmware.bin"
-    dst = path + "firmware/" + versionout
-    os.rename(src, dst)
-
-    versionout = version[:-1] + "_esp32_ssd1306_" + sha + ".bin"
-    src = path + ".pio/build/esp32-wroom32-ssd1306/firmware.bin"
-    dst = path + "firmware/" + versionout
-    os.rename(src, dst)
-
     # other ESP32 bin files
     src = path + ".pio/build/esp32-wroom32-release/"
     dst = path + "firmware/"

src/CHANGES.md

@@ -1,36 +1,84 @@
-# Changelog v0.5.66
-
-**Note:** Version `0.5.42` to `0.5.65` were development versions. Last release version was `0.5.41`
-Detailed change log (development changes): https://github.com/lumapu/ahoy/blob/945a671d27d10d0f7c175ebbf2fbb2806f9cd79a/src/CHANGES.md
-
-
-* updated REST API and MQTT (both of them use the same functionality)
-* improved stability
-* Regular expressions for input fields which are used for MQTT to be compliant to MQTT
-* WiFi optimization (AP Mode and STA in parallel, reconnect if local STA is unavailable)
-* improved display of `/system`
-* fix Update button protection (prevent double click #527)
-* optimized scheduler #515
-* fix of duplicates in API `/api/record/live` (#526)
-* added update information to `index.html` (check for update with github.com)
-* fix web logout (auto logout)
-* switched MQTT library
-* removed MQTT `available_text` (can be deducted from `available`)
-* enhanced MQTT documentation in `User_Manual.md`
-* changed MQTT topic `status` to nummeric value, check documentation in `User_Manual.md`
-* added immediate (each minute) report of inverter status MQTT #522
-* increased MQTT user, pwd and topic length to 64 characters + `\0`. (The string end `\0` reduces the available size by one) #516
-* added disable night communication flag to MQTT #505
-* added MQTT <TOPIC>/status to show status over all inverters
-* added MQTT RX counter to index.html
-* added protection mask to select which pages should be protected
-* added monochrome display that show values also if nothing changed and in offline mode #498
-* added icons to index.html, added WiFi-strength symbol on each page
-* refactored communication offset (adjustable in minutes now)
-* factory reset formats entire little fs
-* renamed sunrise / sunset on index.html to start / stop communication
-* fixed static IP save
-* fix NTP with static IP
-* all values are displayed on /live even if they are 0
-* added NRF24 info to Systeminfo
-* reordered enqueue commands after boot up to prevent same payload length for successive commands
+# Changelog
+
+(starting from release version `0.5.66`)
+
+## 0.5.78
+* further improvements regarding wifi #611, fix connection if only one AP with same SSID is there
+* fix endless loop in `zerovalues` #564
+* fix auto discover again #565
+* added total values to autodiscover #630
+* improved zero at midnight #625
+
+## 0.5.77
+* fix wrong filename for automatically created manifest (online installer) #620
+* added rotate display feature #619
+* improved Prometheus endpoint #615, thx to @fsck-block
+* improved wifi to connect always to strongest RSSI, thx to @beegee3 #611
+
+## 0.5.76
+* reduce MQTT retry interval from maximum speed to one second
+* fixed homeassistant autodiscovery #565
+* implemented `getNTPTime` improvements #609 partially #611
+* added alarm messages to MQTT #177, #600, #608
+
+## 0.5.75
+* fix wakeup issue, once wifi was lost during night the communication didn't start in the morning
+* reenabled FlashStringHelper because of lacking RAM
+* complete rewrite of monochrome display class, thx to @dAjaY85 -> displays are now configurable in setup
+* fix power limit not possible #607
+
+## 0.5.74
+* improved payload handling (retransmit all fragments on CRC error)
+* improved `isAvailable`, checkes all record structs, inverter becomes available more early because version is check first
+* fix tickers were not set if NTP is not available
+* disabled annoying `FlashStringHelper` it gives randomly Expeptions during development, feels more stable since then
+* moved erase button to the bottom in settings, not nice but more functional
+* split `tx_count` to `tx_cnt` and `retransmits` in `system.html`
+* fix mqtt retransmit IP address #602
+* added debug infos for `scheduler` (web -> `/debug` as trigger prints list of tickers to serial console)
+
+## 0.5.73
+* improved payload handling (request / retransmit) #464
+* included alarm ID parse to serial console (in development)
+
+## 0.5.72
+* repaired system, scheduler was not called any more #596
+
+## 0.5.71
+* improved wifi handling and tickers, many thanks to @beegee3 #571
+* fixed YieldTotal correction calculation #589
+* fixed serial output of power limit acknowledge #569
+* reviewed `sendDiscoveryConfig` #565
+* merged PR `Monodisplay`, many thanks to @dAjaY85 #566, Note: (settings are introduced but not able to be modified, will be included in next version)
+
+## 0.5.70
+* corrected MQTT `comm_disabled` #529
+* fix Prometheus and JSON endpoints (`config_override.h`) #561
+* publish MQTT with fixed interval even if inverter is not available #542
+* added JSON settings upload. NOTE: settings JSON download changed, so only settings should be uploaded starting from version `0.5.70` #551
+* MQTT topic and inverter name have more allowed characters: `[A-Za-z0-9./#$%&=+_-]+`, thx: @Mo Demman
+* improved potential issue with `checkTicker`, thx @cbscpe
+* MQTT option for reset values on midnight / not avail / communication stop #539
+* small fix in `tickIVCommunication` #534
+* add `YieldTotal` correction, eg. to have the option to zero at year start #512
+
+## 0.5.69
+* merged SH1106 1.3" Display, thx @dAjaY85
+* added SH1106 to automatic build
+* added IP address to MQTT (version, device and IP are retained and only transmitted once after boot) #556
+* added `set_power_limit` acknowledge MQTT publish #553
+* changed: version, device name are only published via MQTT once after boot
+* added `Login` to menu if admin password is set #554
+* added `development` to second changelog link in `index.html` #543
+* added interval for MQTT (as option). With this settings MQTT live data is published in a fixed timing (only if inverter is available) #542, #523
+* added MQTT `comm_disabled` #529
+* changed name of binaries, moved GIT-Sha to the front #538
+
+## 0.5.68
+* repaired receive payload
+* Powerlimit is transfered immediately to inverter
+
+## 0.5.67
+* changed calculation of start / stop communication to 1 min after last comm. stop #515
+* moved payload send to `payload.h`, function `ivSend` #515
+* payload: if last frame is missing, request all frames again