From ca7f8b609174b9b18c7b2f1d95249fff15f241eb Mon Sep 17 00:00:00 2001 From: matth-x <63792403+matth-x@users.noreply.github.com> Date: Sat, 21 Oct 2023 17:13:00 +0200 Subject: [PATCH] add changelog --- CHANGELOG.md | 52 +++++++++++++++++++++++++++++++++++++++++++++++ docs/migration.md | 10 ++++++++- 2 files changed, 61 insertions(+), 1 deletion(-) create mode 100644 CHANGELOG.md diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 00000000..8c3c8101 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,52 @@ +# Changelog + +## [1.0.0] - 2023-10-21 + +_First release._ + +### Changed + +- `mocpp_initialize` takes OCPP URL without explicit host, port ([#220](https://github.com/matth-x/MicroOcpp/pull/220)) +- `endTransaction` checks authorization of `idTag` +- Update configurations API ([#195](https://github.com/matth-x/MicroOcpp/pull/195)) +- Update Firmware- and DiagnosticsService API ([#207](https://github.com/matth-x/MicroOcpp/pull/207)) +- Update Connection interface +- Update Authorization module functions ([#213](https://github.com/matth-x/MicroOcpp/pull/213)) +- Reflect changes in C-API +- Change build flag prefix from `MOCPP_` to `MO_` +- Change `mo_set_console_out` to `mocpp_set_console_out` +- Revise README.md +- Revise misleading debug messages +- Update Arduino IDE manifest ([#206](https://github.com/matth-x/MicroOcpp/issues/206)) + +### Added + +- Auto-recovery switch in `mocpp_initialize` params +- WebAssembly port +- Configurable `MO_PARTITION_LABEL` for the esp-idf SPIFFS integration ([#218](https://github.com/matth-x/MicroOcpp/pull/218)) +- `MO_TX_CLEAN_ABORTED=0` keeps aborted txs in journal +- `MO_VERSION` specifier +- `MO_PLATFORM_NONE` for compilation on custom platforms +- `endTransaction_authorized` enforces the tx end +- Add valgrind, ASan, UBSan CI/CD steps ([#189](https://github.com/matth-x/MicroOcpp/pull/189)) + +### Fixed + +- Reservation ([#196](https://github.com/matth-x/MicroOcpp/pull/196)) +- Fix immediate FW-update Download phase abort ([#216](https://github.com/matth-x/MicroOcpp/pull/216)) +- `stat` usage on arduino-esp32 LittleFS +- SetChargingProfile JSON capacity calculation +- Set correct idTag when Reset triggers StopTx +- Execute operations only once despite multiple .conf send attempts ([#207](https://github.com/matth-x/MicroOcpp/pull/207)) +- ConnectionTimeOut only applies when connector is still unplugged +- Fix valgrind warnings + +## [1eff6e5] - 23-08-23 + +_Previous point with breaking changes on master_ + +Renaming to MicroOcpp is completed since this commit. See the [migration guide](https://matth-x.github.io/MicroOcpp/migration/) for more details on what's changed. Changelogs and semantic versioning are adopted starting with v1.0.0 + +## [0.3.0] - 23-08-19 + +_Last version under the project name ArduinoOcpp_ diff --git a/docs/migration.md b/docs/migration.md index fed7bd10..88a1cf66 100644 --- a/docs/migration.md +++ b/docs/migration.md @@ -1,6 +1,10 @@ # 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. To migrate existing projects, find and replace the keywords in the following. +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 + +Find and replace the keywords in the following. If using the C-facade (skip if you don't use anything from *ArduinoOcpp_c.h*): @@ -26,4 +30,8 @@ If using the C-facade, change this as the final step: - `ao_` to `ocpp_` +## 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). + **If something is missing in this guide, please share the issue here:** [https://github.com/matth-x/MicroOcpp/issues/176](https://github.com/matth-x/MicroOcpp/issues/176)