Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/matth-x/MicroOcpp

OCPP 1.6 client for microcontrollers
https://github.com/matth-x/MicroOcpp

arduino arduino-ocpp embedded esp32 esp32-arduino esp8266 evse ocpp ocpp-controller platformio

Last synced: 3 months ago
JSON representation

OCPP 1.6 client for microcontrollers

Host: GitHub
URL: https://github.com/matth-x/MicroOcpp
Owner: matth-x
License: mit
Created: 2020-04-16T13:04:28.000Z (over 4 years ago)
Default Branch: main
Last Pushed: 2024-07-31T17:27:33.000Z (3 months ago)
Last Synced: 2024-08-01T19:52:59.086Z (3 months ago)
Topics: arduino, arduino-ocpp, embedded, esp32, esp32-arduino, esp8266, evse, ocpp, ocpp-controller, platformio
Language: C++
Homepage:
Size: 3.21 MB
Stars: 311
Watchers: 20
Forks: 134
Open Issues: 63
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Security: docs/security.md

Awesome Lists containing this project

awesome-ev-charging - OCPP 1.6 client for ESP32 / ESP8266

README

        #    MicroOcpp

[![Build Status]( https://github.com/matth-x/MicroOcpp/workflows/PlatformIO%20CI/badge.svg)](https://github.com/matth-x/MicroOcpp/actions)

[![Unit tests]( https://github.com/matth-x/MicroOcpp/workflows/Unit%20tests/badge.svg)](https://github.com/matth-x/MicroOcpp/actions)

[![codecov](https://codecov.io/github/matth-x/ArduinoOcpp/branch/develop/graph/badge.svg?token=UN6LO96HM7)](https://codecov.io/github/matth-x/ArduinoOcpp)

OCPP 1.6 client for microcontrollers. Portable C/C++. Compatible with Espressif, Arduino, NXP, STM, Linux and more.

:heavy_check_mark: Works with [15+ commercial Central Systems](https://www.micro-ocpp.com/#h.314525e8447cc93c_81)

:heavy_check_mark: Eligible for public chargers (Eichrecht-compliant)

:heavy_check_mark: Supports all OCPP 1.6 feature profiles and OCPP 2.0.1 preview

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)

## Tester / Demo App

*Main repository: [MicroOcppSimulator](https://github.com/matth-x/MicroOcppSimulator)*

The Simulator is a demo & development tool for MicroOcpp which allows to quickly assess the compatibility with different OCPP backends. It simulates a full charging station, adds a GUI and a mocked hardware binding to MicroOcpp and runs in the browser (using WebAssembly): [Try it](https://demo.micro-ocpp.com/)



#### Usage

**OCPP server setup**: Navigate to "Control Center". In the WebSocket options, add the OCPP backend URL, charge box ID and authorization key if existent. Press "Update WebSocket" to save. The Simulator should connect to the OCPP server. To check the connection status, it could be helpful to open the developer tools of the browser.

If you don't have an OCPP server at hand, leave the charge box ID blank and enter the following backend address: `wss://echo.websocket.events/` (this server is sponsored by Lob.com)

**RFID authentication**: Go to "Control Center" > "Connectors" > "Transaction" and update the idTag with the desired value.

## Benchmarks

*Full report: [MicroOcpp benchmark (esp-idf)](https://github.com/matth-x/MicroOcpp-benchmark)*

The following measurements were taken on the ESP32 @ 160MHz and represent the optimistic best case scenario for a charger with two physical connectors (i.e. compiled with `-Os`, disabled debug output and logs).

| Description | Value |

| :--- | ---: |

| Flash size (minimal) | 121,170 B |

| Heap occupation (idle) | 12,308 B |

| Heap occupation (peak) | 21,916 B |

| Initailization | 21 ms |

| `loop()` call (idle) | 0.05 ms |

| Large message sent | 5 ms |

In practical setups, the execution time is largely determined by IO delays and the heap occupation is significantly influenced by the configuration with reservation, local authorization and charging profile lists.

## Developers guide

PlatformIO package: [MicroOcpp](https://registry.platformio.org/libraries/matth-x/MicroOcpp)

MicroOcpp is an implementation of the OCPP communication behavior. It automatically initiates the corresponding OCPP operations once the hardware status changes or the RFID input is updated with a new value. Conversely it processes new data from the server, stores it locally and updates the hardware controls when applicable.

Please take `examples/ESP/main.cpp` as the starting point for the first project. It is a minimal example which shows how to establish an OCPP connection and how to start and stop charging sessions. The API documentation can be found in [`MicroOcpp.h`](https://github.com/matth-x/MicroOcpp/blob/main/src/MicroOcpp.h). Also check out the [Docs](https://matth-x.github.io/MicroOcpp).

### Dependencies

Mandatory:

- [bblanchon/ArduinoJSON](https://github.com/bblanchon/ArduinoJson) (version `6.21`)

If compiled with the Arduino integration:

- [Links2004/arduinoWebSockets](https://github.com/Links2004/arduinoWebSockets) (version `2.4.1`)

If using the built-in certificate store (to enable, set build flag `MO_ENABLE_MBEDTLS=1`):

- [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/[email protected]` in the PIO library manager.

## OCPP 2.0.1 and ISO 15118

The following OCPP 2.0.1 use cases are implemented:

| UC | Description | Note |

| :--- | :--- | :--- |

| M03 - M05 | Certificate management | Enable Mbed-TLS to use the built-in certificate store |

| B05 - B07 | Variables | |

| B01 - B04
B11 - B12 | Provisioning | Ported from OCPP 1.6 |

| E01 - E12 | Transactions | |

| F01 - F02 | Remote Start/Stop Tx | |

| - | Protocol negotiation | The charger can select the OCPP version at runtime |

The OCPP 2.0.1 features are in an alpha development stage (no persistency yet). By default, they are disabled and excluded from the build, so they have no impact on the firmware size. To enable, set the build flag `MO_ENABLE_V201=1` and initialize the library with the ProtocolVersion parameter `2.0.1`  (see [this example](https://github.com/matth-x/MicroOcppSimulator/blob/657e606c3b178d3add242935d413c72624130ff3/src/main.cpp#L43-L47) in the Simulator).

An integration of the library for OCPP 1.6 will also be functional with the 2.0.1 upgrade. It works with the same API in MicroOcpp.h.

ISO 15118 defines some use cases which include a message exchange between the charger and server. This library facilitates the integration of ISO 15118 by handling its OCPP-side communication.

## Contact

If you have further questions, feel free to reach out!

:envelope: : matthias [A⊤] micro-ocpp [DО⊤] com