prepare v1.1.0 release (#306)

* increase dbg msg buf size, clean up

* more concise build flag MO_ENABLE_RESERVATION

* update docs

* advance version to v1.1.0

* fix compiler warnings

* clean CMakeLists.txt

* update release date

* update example, fix compilation error

* update dependencies

Author: matth-x

.github/workflows/esp-idf.yml

@@ -37,7 +37,7 @@ jobs:
       uses: actions/checkout@v3
       with:
         repository: matth-x/MicroOcppMongoose
-        ref: 92ebea9fe8554999b4d34c6a03fa12c0d9faec48
+        ref: v1.1.0
         path: examples/ESP-IDF/components/MicroOcppMongoose
     - name: Checkout ArduinoJson
       uses: actions/checkout@v3

CHANGELOG.md

@@ -1,6 +1,6 @@
 # Changelog
 
-## [Unreleased]
+## [1.1.0] - 2024-05-21
 
 ### Changed
 
@@ -14,7 +14,7 @@
 
 - File index ([#270](https://github.com/matth-x/MicroOcpp/pull/270))
 - Config `Cst_TxStartOnPowerPathClosed` to put back TxStartPoint ([#271](https://github.com/matth-x/MicroOcpp/pull/271))
-- Build flag `MO_ENABLE_V16_RESERVATION=0` disables Reservation module ([#302](https://github.com/matth-x/MicroOcpp/pull/302))
+- Build flag `MO_ENABLE_RESERVATION=0` disables Reservation module ([#302](https://github.com/matth-x/MicroOcpp/pull/302))
 - Build flag `MO_ENABLE_LOCAL_AUTH=0` disables LocalAuthList module ([#303](https://github.com/matth-x/MicroOcpp/pull/303))
 - Function `bool isConnected()` in `Connection` interface ([#282](https://github.com/matth-x/MicroOcpp/pull/282))
 - Build flags for customizing memory limits of SmartCharging ([#260](https://github.com/matth-x/MicroOcpp/pull/260))

CMakeLists.txt

@@ -106,19 +106,18 @@ set(MO_SRC
 if(ESP_PLATFORM)
 
     idf_component_register(SRCS ${MO_SRC}
-                        INCLUDE_DIRS "./src" "../ArduinoJson/src"
-                        PRIV_REQUIRES spiffs)
+        INCLUDE_DIRS "./src" "../ArduinoJson/src"
+        PRIV_REQUIRES spiffs
+    )
 
     target_compile_options(${COMPONENT_TARGET} PUBLIC
         -DMO_PLATFORM=MO_PLATFORM_ESPIDF
-        -DMO_CUSTOM_RESET
-        )
+    )
 
     return()
 endif()
 
-project(MicroOcpp
-        VERSION 0.2.0)
+project(MicroOcpp VERSION 1.1.0)
 
 add_library(MicroOcpp ${MO_SRC})
 
@@ -129,7 +128,6 @@ target_include_directories(MicroOcpp PUBLIC
 
 target_compile_definitions(MicroOcpp PUBLIC
     MO_PLATFORM=MO_PLATFORM_UNIX
-    MO_CUSTOM_RESET
 )
 
 # Unit tests
@@ -181,7 +179,6 @@ target_compile_definitions(mo_unit_tests PUBLIC
     MO_PLATFORM=MO_PLATFORM_UNIX
     MO_NUMCONNECTORS=3
     MO_CUSTOM_TIMER
-    MO_CUSTOM_RESET
     MO_DBG_LEVEL=MO_DL_DEBUG
     MO_TRAFFIC_OUT
     MO_FILENAME_PREFIX="./mo_store/"

README.md

@@ -14,8 +14,6 @@ OCPP 1.6 client for microcontrollers. Portable C/C++. Compatible with Espressif,
 
 Reference usage: [OpenEVSE](https://github.com/OpenEVSE/ESP32_WiFi_V4.x/blob/master/src/ocpp.cpp) | Technical introduction: [Docs](https://matth-x.github.io/MicroOcpp/intro-tech) | Website: [www.micro-ocpp.com](https://www.micro-ocpp.com)
 
-**Updated branches (2024-03-24):** the default branch was renamed from master into main. The develop branch hasn't been used anymore, so it is deleted. This better represents how branches are used in MicroOcpp: active development takes place on main (plus the feature and fixing branches) and the releases are stable versions of this library. To get a release version, checkout a tag, e.g. *v1.0.3*, or download it from GitHub / PlatformIO.
-
 ## Tester / Demo App
 
 *Main repository: [MicroOcppSimulator](https://github.com/matth-x/MicroOcppSimulator)*
@@ -71,7 +69,7 @@ If using the built-in certificate store (to enable, set build flag `MO_ENABLE_MB
 
 - [Mbed-TLS/mbedtls](https://github.com/Mbed-TLS/mbedtls) (version `2.28.1`)
 
-In case you use PlatformIO, you can copy all dependencies from `platformio.ini` into your own configuration file. Alternatively, you can install the full library with dependencies by adding `matth-x/MicroOcpp@1.0.3` in the PIO library manager.
+In case you use PlatformIO, you can copy all dependencies from `platformio.ini` into your own configuration file. Alternatively, you can install the full library with dependencies by adding `matth-x/MicroOcpp@1.1.0` in the PIO library manager.
 
 ## OCPP 2.0.1 and ISO 15118
 

docs/migration.md

@@ -1,8 +1,25 @@
-# Migrating to v1.0
+# Migrating to v1.1
+
+As a new minor version, all features should work the same as in v1.0 and existing integrations are mostly backwards compatible. However, some fixes / cleanup steps in MicroOcpp require syntactic changes or special consideration when upgrading from v1.0 to v1.1. The known pitfalls are as follows:
+
+- The default branch has been renamed from `master` into `main`
+- Need to include extra headers: the transitive includes have been cleaned a bit. Probably it's necessary to add more includes next to `#include <MicroOcpp.h>`. E.g.<br/>`#include <MicroOcpp/Model/Diagnostics/DiagnosticsService.h>`<br/>`#include <MicroOcpp/Model/FirmwareManagement/FirmwareService.h>`
+- `ocppPermitsCharge()` does not consider failures reported by the charger anymore. Before v1.1 it was possible to report failures to MicroOcpp using ErrorCodeInputs and then to rely on `ocppPermitsCharge()` becoming false when a failure occurs. For backwards compatibility, complement any occurence to `ocppPermitsCharge() && !isFaulted()`
+- `setEnergyMeterInput` changed the expected return type of the callback function from `float` to `int` (see [#301](https://github.com/matth-x/MicroOcpp/pull/301))
+- The return type of the UnlockConnector handler also changed from `PollResult<bool>` to enum `UnlockConnectorResult` (see [#271](https://github.com/matth-x/MicroOcpp/pull/271))
+
+If upgrading MicroOcppMongoose at the same time, then the following changes are very important to consider:
+
+- Certificates are no longer copied into heap memory, but the MO-Mongoose class takes the passed certificate pointer as a zero-copy parameter. The string behind the passed pointer must outlive the MO-Mongoose class (see [#10](https://github.com/matth-x/MicroOcppMongoose/pull/10))
+- WebSocket authorization keys are no longer stored as c-strings, but as `unsigned char` buffers. For backwards compatibility, a null-byte is still appended and the buffer can be accessed as c-string, but this should be tested in existing deployments. Furtermore, MicroOcpp only accepts hex-encoded keys coming via ChangeConfiguration which is mandated by the standard. This also may break existing deployments (see [#4](https://github.com/matth-x/MicroOcppMongoose/pull/4)).
+
+If accessing the MicroOcpp modules directly (i.e. not over `MicroOcpp.h` or `MicroOcpp_c.h`) then there are likely some more modifications to be done. See the history of pull requests where each change to the code is documented. However, if the existing integration compiles under the new MO version, then there shouldn't be too many unexpected incompatibilities.
+
+## Migrating to v1.0
 
 The API has been continously improved to best suit the common use cases for MicroOcpp. Moreover, the project has been given a new name to prevent confusion with the relation to the Arduino platform and to reflect the project goals properly. With the new project name, the API has been frozen for the v1.0 release.
 
-## Adopting the new project name in existing projects
+### Adopting the new project name in existing projects
 
 Find and replace the keywords in the following.
 
@@ -30,7 +47,7 @@ If using the C-facade, change this as the final step:
 
 - `ao_` to `ocpp_`
 
-## Further API changes to consider
+### Further API changes to consider
 
 In addition to the new project name, the API has also been reworked for more consistency. After renaming the existing project as described above, also take a look at the [changelogs](https://github.com/matth-x/MicroOcpp/blob/1.0.x/CHANGELOG.md) (see Section Changed for v1.0.0).
 

examples/ESP-TLS/main.cpp

@@ -14,25 +14,18 @@ ESP8266WiFiMulti WiFiMulti;
 #endif
 
 #include <MicroOcpp.h>
-#include <MicroOcpp/Core/Connection.h> //need for setting TLS credentials
 
-#define STASSID  "YOUR_WIFI_SSID"
-#define STAPSK   "YOUR_WIFI_PW"
+#define STASSID "YOUR_WIFI_SSID"
+#define STAPSK  "YOUR_WIFI_PW"
 
-#define OCPP_HOST  "echo.websocket.events"
-#define OCPP_PORT  443
-#define OCPP_URL   "wss://echo.websocket.events/"
+#define OCPP_BACKEND_URL   "wss://echo.websocket.events"
+#define OCPP_CHARGE_BOX_ID ""
+#define OCPP_AUTH_KEY      "SecureAuthKey" // OCPP Security Profile 2: TLS with Basic Authentication
 
 /*
- * OCPP Security Profile 2: TLS with Basic Authentication
- *
- * Example credentials from the OCPP-JSON document (p. 16)
+ * ISRG ROOT X1
  */
-#define OCPP_AUTH_ID  "AL1000"
-#define OCPP_AUTH_KEY "0001020304050607FFFFFFFFFFFFFFFFFFFFFFFF"
-
-const char ENDPOINT_CA_CERT[] PROGMEM = R"EOF(
------BEGIN CERTIFICATE-----
+const char ca_cert[] PROGMEM = R"EOF(-----BEGIN CERTIFICATE-----
 MIIFazCCA1OgAwIBAgIRAIIQz7DSQONZRGPgu2OCiwAwDQYJKoZIhvcNAQELBQAw
 TzELMAkGA1UEBhMCVVMxKTAnBgNVBAoTIEludGVybmV0IFNlY3VyaXR5IFJlc2Vh
 cmNoIEdyb3VwMRUwEwYDVQQDEwxJU1JHIFJvb3QgWDEwHhcNMTUwNjA0MTEwNDM4
@@ -65,9 +58,6 @@ emyPxgcYxn/eR44/KJ4EBs+lVDR3veyJm+kXQ99b21/+jh5Xos1AnX5iItreGCc=
 -----END CERTIFICATE-----
 )EOF";
 
-WebSocketsClient wsockSecure {};
-MicroOcpp::EspWiFi::WSClient osockSecure {&wsockSecure};
-
 void setup() {
 
     /*
@@ -76,7 +66,7 @@ void setup() {
 
     Serial.begin(115200);
 
-    Serial.print(F("[main] Wait for WiFi "));
+    Serial.print(F("[main] Wait for WiFi: "));
 
 #if defined(ESP8266)
     WiFiMulti.addAP(STASSID, STAPSK);
@@ -87,12 +77,14 @@ void setup() {
 #elif defined(ESP32)
     WiFi.begin(STASSID, STAPSK);
     while (!WiFi.isConnected()) {
-        delay(1000);
         Serial.print('.');
+        delay(1000);
     }
+#else
+#error only ESP32 or ESP8266 supported at the moment
 #endif
 
-    Serial.print(F(" connected\n"));
+    Serial.println(F(" connected!"));
 
     /*
      * Set system time (required for Certificate validation)
@@ -108,23 +100,22 @@ void setup() {
     Serial.printf(" finished. Unix timestamp is %lu\n", now);
 
     /*
-     * Connect to OCPP Central System (using OCPP Security Profile 2: TLS with Basic Authentication )
+     * Initialize the OCPP library (using OCPP Security Profile 2: TLS with Basic Authentication)
      */
-    wsockSecure.beginSslWithCA(OCPP_HOST,
-                    OCPP_PORT,
-                    OCPP_URL,
-                    ENDPOINT_CA_CERT, "ocpp1.6");
-    wsockSecure.setReconnectInterval(5000);
-    wsockSecure.enableHeartbeat(15000, 3000, 2);
-    wsockSecure.setAuthorization(OCPP_AUTH_ID, OCPP_AUTH_KEY); // => Authorization: Basic QUwxMDAwOgABAgMEBQYH////////////////
-    
-    mocpp_initialize(osockSecure, ChargerCredentials("My Charging Station", "My company name"));
+    mocpp_initialize(
+            OCPP_BACKEND_URL,
+            OCPP_CHARGE_BOX_ID,
+            "My Charging Station",
+            "My company name",
+            MicroOcpp::FilesystemOpt::Use_Mount_FormatOnFail,
+            OCPP_AUTH_KEY,
+            ca_cert);
 
     /*
      * ... see MicroOcpp.h for how to integrate the EVSE hardware.
      *
      * This example only showcases the TLS connection. For examples about the HW integration,
-     * please see the other examples
+     * see the other examples
      */
 }
 

library.json

@@ -1,6 +1,6 @@
 {
     "name": "MicroOcpp",
-    "version": "1.0.0",
+    "version": "1.1.0",
     "description": "OCPP 1.6 Client for microcontrollers",
     "keywords": "OCPP, 1.6, OCPP 1.6, Smart Energy, Smart Charging, client, ESP8266, ESP32, Arduino, esp-idf, EVSE, Charge Point",
     "repository":
@@ -36,17 +36,18 @@
     "export": {
         "include":
         [
-            "src/*",
+            "docs/*",
             "examples/*",
-            "platformio.ini",
+            "src/*",
+            "CHANGELOG.md",
+            "CMakeLists.txt",
             "library.json",
             "library.properties",
-            "README.md",
-            "CMakeLists.txt",
-            "docs/*",
             "LICENSE",
             "mkdocs.yml",
-            "CHANGELOG.md"
+            "platformio.ini",
+            "README.md",
+            "SConscript.py"
         ]
     },
 

library.properties

@@ -1,5 +1,5 @@
 name=MicroOcpp
-version=1.0.0
+version=1.1.0
 author=Matthias Akstaller
 maintainer=Matthias Akstaller
 sentence=OCPP 1.6 Client for microcontrollers

src/MicroOcpp.cpp

@@ -293,7 +293,7 @@ void mocpp_initialize(Connection& connection, const char *bootNotificationCreden
         new AuthorizationService(*context, filesystem)));
 #endif //MO_ENABLE_LOCAL_AUTH
 
-#if MO_ENABLE_V16_RESERVATION
+#if MO_ENABLE_RESERVATION
     model.setReservationService(std::unique_ptr<ReservationService>(
         new ReservationService(*context, MO_NUMCONNECTORS)));
 #endif
@@ -583,8 +583,8 @@ void setEnergyMeterInput(std::function<int()> energyInput, unsigned int connecto
     SampledValueProperties meterProperties;
     meterProperties.setMeasurand("Energy.Active.Import.Register");
     meterProperties.setUnit("Wh");
-    auto mvs = std::unique_ptr<SampledValueSamplerConcrete<int, SampledValueDeSerializer<int>>>(
-                           new SampledValueSamplerConcrete<int, SampledValueDeSerializer<int>>(
+    auto mvs = std::unique_ptr<SampledValueSamplerConcrete<int32_t, SampledValueDeSerializer<int32_t>>>(
+                           new SampledValueSamplerConcrete<int32_t, SampledValueDeSerializer<int32_t>>(
             meterProperties,
             [energyInput] (ReadingContext) {return energyInput();}
     ));

src/MicroOcpp/Core/ConfigurationKeyValue.cpp

@@ -243,7 +243,7 @@ std::unique_ptr<Configuration> makeConfiguration(TConfig type, const char *key)
     }
     res->setKey(key);
     return res;
-};
+}
 
 bool deserializeTConfig(const char *serialized, TConfig& out) {
     if (!strcmp(serialized, "int")) {

src/MicroOcpp/Core/FtpMbedTLS.cpp

@@ -162,7 +162,7 @@ void mo_mbedtls_log(void *user, int level, const char *file, int line, const cha
  */
 
 FtpTransferMbedTLS::FtpTransferMbedTLS(bool tls_only, const char *client_cert, const char *client_key) 
-        : isSecure(tls_only), client_cert(client_cert), client_key(client_key) {
+        : client_cert(client_cert), client_key(client_key), isSecure(tls_only) {
     mbedtls_net_init(&ctrl_fd);
     mbedtls_ssl_init(&ctrl_ssl);
     mbedtls_net_init(&data_fd);
@@ -369,7 +369,8 @@ void FtpTransferMbedTLS::close_data() {
 
 int FtpTransferMbedTLS::handshake_tls() {
 
-    while (auto ret = mbedtls_ssl_handshake(&ctrl_ssl) != 0) {
+    int ret;
+    while ((ret = mbedtls_ssl_handshake(&ctrl_ssl)) != 0) {
         if (ret != MBEDTLS_ERR_SSL_WANT_READ && ret != MBEDTLS_ERR_SSL_WANT_WRITE && ret != 1) {
             char buf [1024];
             mbedtls_strerror(ret, (char *) buf, 1024);
@@ -381,7 +382,7 @@ int FtpTransferMbedTLS::handshake_tls() {
     if (ca_cert) {
         //certificate validation enabled
 
-        if (auto ret = mbedtls_ssl_get_verify_result(&ctrl_ssl) != 0) {
+        if ((ret = mbedtls_ssl_get_verify_result(&ctrl_ssl)) != 0) {
             char vrfy_buf[512];
             mbedtls_x509_crt_verify_info(vrfy_buf, sizeof(vrfy_buf), "   > ", ret);
             MO_DBG_ERR("mbedtls_ssl_get_verify_result: %i, %s", ret, vrfy_buf);
@@ -403,7 +404,7 @@ void FtpTransferMbedTLS::send_cmd(const char *cmd, const char *arg, bool disable
             cmd,               //cmd mandatory (e.g. "USER")
             arg ? " " : "",    //line spacing if arg is provided
             arg ? arg : "");   //arg optional (e.g. "anonymous")
-    if (len < 0 || len >= MSG_SIZE) {
+    if (len < 0 || (size_t)len >= MSG_SIZE) {
         MO_DBG_ERR("could not write cmd, send QUIT instead");
         len = sprintf((char*) msg, "QUIT\r\n");
     } else {
@@ -883,7 +884,7 @@ bool FtpTransferMbedTLS::read_url_data(const char *data_url_raw) {
 }
 
 FtpClientMbedTLS::FtpClientMbedTLS(bool tls_only, const char *client_cert, const char *client_key)
-        : tls_only(tls_only), client_cert(client_cert), client_key(client_key) {
+        : client_cert(client_cert), client_key(client_key), tls_only(tls_only) {
 
 }
 

src/MicroOcpp/Core/Time.cpp

@@ -190,7 +190,7 @@ Timestamp &Timestamp::operator+=(int secs) {
     }
 
     return *this;
-};
+}
 
 Timestamp &Timestamp::addMilliseconds(int val) {
 

src/MicroOcpp/Model/Authorization/IdToken.cpp

@@ -70,6 +70,9 @@ const char *IdToken::get() const {
 const char *IdToken::getTypeCstr() const {
     const char *res = nullptr;
     switch (type) {
+        case Type::UNDEFINED:
+            MO_DBG_ERR("internal error");
+            break;
         case Type::Central:
             res = "Central";
             break;
@@ -96,9 +99,6 @@ const char *IdToken::getTypeCstr() const {
             break;
     }
 
-    if (!res) {
-        MO_DBG_ERR("internal error");
-    }
     return res ? res : "";
 }
 

src/MicroOcpp/Model/Certificates/CertificateMbedTLS.cpp

@@ -178,7 +178,6 @@ class CertificateStoreMbedTLS : public CertificateStore {
 
         if (!success) {
             MO_DBG_ERR("could not read cert: %s", fn);
-            (void)0;
         }
 
         delete[] buf;