Merge pull request #15 from rene-d/develop

Develop

Author: rene-d

.github/workflows/release.yml

@@ -31,8 +31,11 @@ jobs:
           platformio run -e esp01s_prod -e esp12e_prod -t buildfs
 
           cd .pio/build
-          zip --junk-paths ../../wifinfo-esp01_1m.zip esp01s_prod/*.bin
-          zip --junk-paths ../../wifinfo-esp12e.zip esp12e_prod/*.bin
+          zip --junk-paths ../../esp01_1m.zip esp01s_prod/*.bin
+          zip --junk-paths ../../esp12e.zip esp12e_prod/*.bin
+
+          cd ../..
+          tools/mkarduinosrc.py arduino.zip
 
       - name: Create Release
         id: create_release
@@ -45,24 +48,35 @@ jobs:
           draft: false
           prerelease: false
 
-      - name: Upload Release Asset 1
+      - name: Upload Release Asset ESP01S
         id: upload-release-asset-1
         uses: actions/upload-release-asset@v1
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         with:
           upload_url: ${{ steps.create_release.outputs.upload_url }} # This pulls from the CREATE RELEASE step above, referencing it's ID to get its outputs object, which include a `upload_url`. See this blog post for more info: https://jasonet.co/posts/new-features-of-github-actions/#passing-data-to-future-steps
-          asset_path: ./wifinfo-esp01_1m.zip
+          asset_path: ./esp01_1m.zip
           asset_name: wifinfo-esp01_1m.zip
           asset_content_type: application/zip
 
-      - name: Upload Release Asset 2
+      - name: Upload Release Asset ESP12E
         id: upload-release-asset-2
         uses: actions/upload-release-asset@v1
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         with:
           upload_url: ${{ steps.create_release.outputs.upload_url }} # This pulls from the CREATE RELEASE step above, referencing it's ID to get its outputs object, which include a `upload_url`. See this blog post for more info: https://jasonet.co/posts/new-features-of-github-actions/#passing-data-to-future-steps
-          asset_path: ./wifinfo-esp12e.zip
+          asset_path: ./esp12e.zip
           asset_name: wifinfo-esp12e.zip
           asset_content_type: application/zip
+
+      - name: Upload Release Asset Sources
+        id: upload-release-asset-3
+        uses: actions/upload-release-asset@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          upload_url: ${{ steps.create_release.outputs.upload_url }} # This pulls from the CREATE RELEASE step above, referencing it's ID to get its outputs object, which include a `upload_url`. See this blog post for more info: https://jasonet.co/posts/new-features-of-github-actions/#passing-data-to-future-steps
+          asset_path: ./arduino.zip
+          asset_name: wifinfo-arduino-sources.zip
+          asset_content_type: application/zip

.github/workflows/tests.yml

@@ -34,6 +34,10 @@ jobs:
         xsltproc gtest2html.xslt build/test_detail.xml > artifacts/test_detail.html
         gcovr -r . --html -o artifacts/coverage.html
 
+    - name: Amalgamation for Arduino IDE
+      run: |
+        tools/mkarduinosrc.py -1 artifacts/wifinfo-amalgamation.zip
+
     - name: Archive tests and code coverage results
       uses: actions/upload-artifact@v1
       with:

.gitignore

@@ -1,7 +1,4 @@
-.vscode/c_cpp_properties.json
-.vscode/launch.json
-.vscode/settings.json
-.vscode/.ropeproject/
+.vscode/
 data/
 .pio/
 build/

.vscode/extensions.json

@@ -45,12 +45,14 @@ endif()
 #
 #
 add_executable(tic
-    test/test_support.cpp
-    test/test_teleinfo.cpp
     test/test_config.cpp
-    test/test_tic.cpp
-    test/test_sys.cpp
     test/test_filesystem.cpp
+    test/test_led_enabled.cpp
+    test/test_led_disabled.cpp
+    test/test_sys.cpp
+    test/test_teleinfo.cpp
+    test/test_tic.cpp
+    test/test_support.cpp
     test/mock_time.cpp
     test/mock.cpp
     test/mock_support.cpp)
@@ -72,7 +74,7 @@ target_link_libraries(tic
 
 target_link_libraries(tic PUBLIC coverage_config)
 
-target_compile_definitions(tic PRIVATE ENABLE_CLI DEBUG)
+target_compile_definitions(tic PRIVATE ENABLE_CLI ENABLE_DEBUG PLATFORMIO=1 WIFINFO_VERSION=\"test\")
 
 #
 #
@@ -81,7 +83,7 @@ add_executable(gen_eeprom
 target_include_directories(gen_eeprom
     PRIVATE src
     PRIVATE test/support)
-
+target_compile_definitions(gen_eeprom PRIVATE PLATFORMIO=1 WIFINFO_VERSION=\"test\")
 
 #
 #

CMakeLists.txt

@@ -124,12 +124,13 @@ La page HTML est compressée avec [html-minifier](https://github.com/kangax/html
 
 ### Options de compilation
 
--   `DEBUG` : active la sortie sur le port série TX et vitesse 115200. Non utilisable avec un compteur, il faut utiliser le client de test pour injecter des trames.
+-   `ENABLE_DEBUG` : active la sortie sur le port série TX et vitesse 115200. Non utilisable avec un compteur, il faut utiliser le client de test pour injecter des trames.
 -   `ENABLE_CLI` : active les commandes par port série (`TAB` ou `ESC`)
--   `DISABLE_LED` : désactive l'utilisation de LED pour les cartes qui n'en ont pas
+-   `ENABLE_LED` : active l'utilisation de LED pour les cartes qui en ont une (esp01s, esp12e)
 -   `ENABLE_OTA` : rajoute le code pour les mises à jour OTA **(non testé)**
+-   `ENABLE_CPULOAD` : mesure de manière empirique la charge CPU
 
-Nota: Sans l'option `DEBUG`, le port série est réglé à 1200 7E1 en RX uniquement. Il y a suffisamment d'outils de mise au point pour ne pas à devoir tester avec un compteur ou un autre microcontrôleur qui simule la téléinformation.
+Nota: Sans l'option `ENABLE_DEBUG`, le port série est réglé à 1200 7E1 en RX uniquement. Il y a suffisamment d'outils de mise au point pour ne pas à devoir tester avec un compteur ou un autre microcontrôleur qui simule la téléinformation.
 
 ### PlatformtIO
 
@@ -220,7 +221,7 @@ L'interface alors sera disponible à cette adresse: <http://localhost:5001/>, av
 
 La mise en place d'une stack sonde/InfluxDB/Grafana est grandement simplifiée grâce à Docker.
 
-Le fichier [docker-compose.yaml](dashboard/docker-compose.yaml) rassemble les trois services:
+Le fichier [docker-compose.yaml](tools/dashboard/docker-compose.yaml) rassemble les trois services:
 
 -   la sonde, écrite en Python, qui récupère les données en JSON via une connexion SSE avec le module
 -   la base de données InfluxDB de type TSBD

README.md

@@ -18,7 +18,7 @@ board = esp12e
 framework = arduino
 monitor_speed = 115200
 ;build_flags = -DDEBUG_ESP_UPDATER -DDEBUG_ESP_PORT=Serial
-src_build_flags = -DDEBUG -DENABLE_CLI # -DENABLE_CPULOAD -DENABLE_OTA
+src_build_flags = -DENABLE_DEBUG -DENABLE_CLI -DENABLE_LED -DENABLE_OTA # -DENABLE_CPULOAD
 lib_deps = SimpleCLI
 extra_scripts = post:prep_data_folder.py
 check_tool = cppcheck, clangtidy
@@ -32,7 +32,7 @@ platform = espressif8266
 board = esp01_1m
 framework = arduino
 monitor_speed = 115200
-src_build_flags = -DDEBUG -DENABLE_CLI -DLED_BUILTIN=2
+src_build_flags = -DENABLE_DEBUG -DENABLE_CLI -DLED_BUILTIN=2 -DENABLE_LED
 lib_deps = SimpleCLI
 extra_scripts = post:prep_data_folder.py
 
@@ -42,7 +42,7 @@ platform = espressif8266
 board = esp01_1m
 framework = arduino
 monitor_speed = 115200
-src_build_flags = -DDEBUG -DENABLE_CLI -DDISABLE_LED
+src_build_flags = -DENABLE_DEBUG -DENABLE_CLI
 lib_deps = SimpleCLI
 extra_scripts = post:prep_data_folder.py
 
@@ -52,15 +52,16 @@ platform = espressif8266
 board = esp01_1m
 framework = arduino
 monitor_speed = 1200
-src_build_flags = -DLED_BUILTIN=2
+src_build_flags = -DLED_BUILTIN=2 -DENABLE_LED -DENABLE_OTA
 lib_deps = SimpleCLI
 extra_scripts = post:prep_data_folder.py
 
-; nodeMCU ou similaire
+; NodeMCU 1.0 ou similaire, pas de sortie série
 [env:esp12e_prod]
 platform = espressif8266
 board = esp12e
 framework = arduino
 monitor_speed = 1200
+src_build_flags = -DLED_BUILTIN=2 -DENABLE_LED -DENABLE_OTA
 lib_deps = SimpleCLI
 extra_scripts = post:prep_data_folder.py

platformio.ini

@@ -1,6 +1,7 @@
 // module téléinformation client
 // rene-d 2020
 
+#include "settings.h"
 #include "cli.h"
 #include "config.h"
 #include "filesystem.h"
@@ -17,6 +18,8 @@
 #include <SimpleCLI.h>
 
 extern "C" uint32_t _EEPROM_start;
+extern "C" uint32_t _FS_start;
+extern "C" uint32_t _FS_end;
 
 static void cli_eeprom_dump(uint8_t bytesPerRow, size_t size);
 
@@ -186,6 +189,9 @@ void cli_setup()
         Serial.printf_P(PSTR("checkFlashConfig  : %d\n"), ESP.checkFlashConfig());
         Serial.printf_P(PSTR("FlashChipVendorId : 0x%x\n"), ESP.getFlashChipVendorId());
         Serial.printf_P(PSTR("EEPROM_start      : 0x%08x\n"), (uint32_t)&_EEPROM_start - 0x40200000);
+        Serial.printf_P(PSTR("EEPROM_end        : 0x%08x\n"), (uint32_t)&_EEPROM_start - 0x40200000 + SPI_FLASH_SEC_SIZE);
+        Serial.printf_P(PSTR("FS_start          : 0x%08x\n"), (uint32_t)&_FS_start - 0x40200000);
+        Serial.printf_P(PSTR("FS_end            : 0x%08x\n"), (uint32_t)&_FS_end - 0x40200000);
 
         Serial.printf_P(PSTR("FreeHeap          : %u\n"), ESP.getFreeHeap());
         Serial.printf_P(PSTR("MaxFreeBlockSize  : %u\n"), ESP.getMaxFreeBlockSize());
@@ -239,8 +245,8 @@ int cli_loop_read()
     if (Serial.available())
     {
         int c = Serial.read();
-        if ((c == 0x09) || (c == 0x1B)) // ESC non présent dans une trame de téléinfo
-        {                               // TAB possible en séparateur, mais pas rencontré
+        if ((c == 0x09) || (c == 0x1B) || (c == '`')) // ESC non présent dans une trame de téléinfo
+        {                                             // TAB possible en séparateur, mais pas rencontré
             cli_mode = true;
             Serial.print("$ ");
         }

src/cli.cpp

@@ -23,6 +23,7 @@
 //
 // **********************************************************************************
 
+#include "settings.h"
 #include "config.h"
 #include "jsonbuilder.h"
 #include "strncpy_s.h"
@@ -364,7 +365,7 @@ void config_handle_form(ESP8266WebServer &server)
     // We validated config ?
     if (server.hasArg("save"))
     {
-#ifdef DEBUG
+#ifdef ENABLE_DEBUG
         Serial.println(F("===== Posted configuration"));
         for (int i = 0; i < server.args(); ++i)
             Serial.printf("  %3d  %-20s = %s\n", i, server.argName(i).c_str(), server.arg(i).c_str());
@@ -373,10 +374,10 @@ void config_handle_form(ESP8266WebServer &server)
 
         // Wi-Fi et avancé
         strncpy_s(config.ssid, server.arg(CFG_FORM_SSID), CFG_SSID_LENGTH);
-        strncpy_s(config.psk, server.arg(CFG_FORM_PSK), CFG_SSID_LENGTH);
+        strncpy_s(config.psk, server.arg(CFG_FORM_PSK), CFG_PSK_LENGTH);
         strncpy_s(config.host, server.arg(CFG_FORM_HOST), CFG_HOSTNAME_LENGTH);
-        strncpy_s(config.ap_psk, server.arg(CFG_FORM_AP_PSK), CFG_SSID_LENGTH);
-        strncpy_s(config.ota_auth, server.arg(CFG_FORM_OTA_AUTH), CFG_SSID_LENGTH);
+        strncpy_s(config.ap_psk, server.arg(CFG_FORM_AP_PSK), CFG_PSK_LENGTH);
+        strncpy_s(config.ota_auth, server.arg(CFG_FORM_OTA_AUTH), CFG_PSK_LENGTH);
         config.ota_port = validate_int(server.arg(CFG_FORM_OTA_PORT), 0, 65535, DEFAULT_OTA_PORT);
 
         config.sse_freq = validate_int(server.arg(CFG_FORM_SSE_FREQ), 0, 360, 0);

src/config.cpp

@@ -1,6 +1,8 @@
 // module téléinformation client
 // rene-d 2020
 
+#include "settings.h"
+
 #ifdef ENABLE_CPULOAD
 
 #include "cpuload.h"
@@ -25,7 +27,7 @@ void cpuload_loop()
 
         perf_counter = 0;
 
-#ifdef DEBUG
+#ifdef ENABLE_DEBUG
         if (perf_index == 0)
         {
             cpuload_print(Serial);
@@ -34,6 +36,17 @@ void cpuload_loop()
     }
 }
 
+int cpuload_cpu()
+{
+    uint32_t sum = 0;
+    for (int i = 0; i < 10; ++i)
+    {
+        sum += perfs[i];
+    }
+    sum /= 10;
+    return (100 * (MAX_COUNTER_80MHZ - sum)) / MAX_COUNTER_80MHZ;
+}
+
 void cpuload_print(Print &prt)
 {
     uint32_t sum = 0;

src/cpuload.cpp

@@ -7,6 +7,7 @@
 
 void cpuload_loop();
 void cpuload_print(Print &prt);
+int cpuload_cpu();
 
 class StringPrint : public Print
 {

src/cpuload.h

@@ -7,8 +7,8 @@
 
 struct EmptySerialClass
 {
-    void printf(const char *format, ...) {}
-    void printf_P(PGM_P format, ...) {}
+    void printf(const char *, ...) {}
+    void printf_P(PGM_P, ...) {}
     void print(const __FlashStringHelper *) {}
     void print(const String &) {}
     void print(const char[]) {}
@@ -22,7 +22,7 @@ struct EmptySerialClass
     void print(const Printable &) {}
 
     void println(const __FlashStringHelper *) {}
-    void println(const String &s) {}
+    void println(const String &) {}
     void println(const char[]) {}
     void println(char) {}
     void println(unsigned char, int = DEC) {}
@@ -37,7 +37,7 @@ struct EmptySerialClass
     void flush() {}
 };
 
-#ifndef DEBUG
+#ifndef ENABLE_DEBUG
 extern EmptySerialClass EmptySerial;
 #define Serial EmptySerial
 #endif

src/emptyserial.h

@@ -1,6 +1,7 @@
 // module téléinformation client
 // rene-d 2020
 
+#include "settings.h"
 #include "filesystem.h"
 #include "jsonbuilder.h"
 

src/filesystem.cpp

@@ -1,6 +1,7 @@
 // module téléinformation client
 // rene-d 2020
 
+#include "settings.h"
 #include "httpreq.h"
 
 #include <ESP8266HTTPClient.h>

src/httpreq.cpp

@@ -5,16 +5,7 @@
 
 #include <Arduino.h>
 
-#ifdef DISABLE_LED
-
-// pas de buildin led sur certains ESP-01
-
-#define led_setup()
-#define led_on()
-#define led_off()
-#define led_toggle()
-
-#else
+#ifdef ENABLE_LED
 
 inline void led_setup()
 {
@@ -36,4 +27,11 @@ inline void led_toggle()
     digitalWrite(LED_BUILTIN, 1 - digitalRead(LED_BUILTIN));
 }
 
+#else
+
+#define led_setup()
+#define led_on()
+#define led_off()
+#define led_toggle()
+
 #endif