From d8128dae2e38310236669655ba31aa247700dad9 Mon Sep 17 00:00:00 2001 From: Scott Penrose Date: Thu, 18 Dec 2025 17:53:39 +1100 Subject: [PATCH] Initial version only --- README.md | 10 ++++++++++ VERSIONS | 29 +++++++++++++++++++++++++++++ library.json | 9 ++------- library.properties | 2 +- 4 files changed, 42 insertions(+), 8 deletions(-) create mode 100644 VERSIONS diff --git a/README.md b/README.md index a4ea1f7..0ef9601 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,12 @@ ESP32 library for reading Victron Energy device data via Bluetooth Low Energy (BLE) advertisements. +**⚠️ INITIAL RELEASE - NOT YET TESTED ON HARDWARE** + +This is an initial release (v0.1.1) and has not yet been tested with real Victron devices. Use with caution and please report any issues you encounter. Testing and feedback are greatly appreciated! + +--- + Why another library? Most of the Victron BLE examples are built into other frameworks (e.g. ESPHome) and I want a library that can be used in all ESP32 systems, including ESPHome or other frameworks. With long term plan to try and move others to this library and improve code with many eyes. ## Features @@ -441,6 +447,10 @@ Copyright (c) 2025 Scott Penrose This library is not officially supported by Victron Energy. Use at your own risk. +## Version History + +See [VERSIONS](VERSIONS) file for detailed changelog and release history. + ## Support - 📫 Report issues on GitHub diff --git a/VERSIONS b/VERSIONS new file mode 100644 index 0000000..8940100 --- /dev/null +++ b/VERSIONS @@ -0,0 +1,29 @@ +# Version History + +## 0.1.1 (2025-12-18) + +Initial release - not yet tested on hardware. + +### Features +- Support for multiple Victron device types: + - Solar Chargers (MPPT) + - Battery Monitors (SmartShunt, BMV) + - Inverters (MultiPlus, Quattro, Phoenix with VE.Bus BLE) + - DC-DC Converters (Orion Smart, Orion XS) +- BLE advertisement decryption using AES-128-CTR +- Callback interface for real-time data updates +- Manual data polling API +- Support for multiple simultaneous devices +- Debug logging +- Framework agnostic (Arduino and ESP-IDF) + +### Known Issues +- Not yet tested with real hardware +- No validation against actual Victron devices + +### TODO +- Hardware testing with real Victron devices +- Add more device types (Smart Battery Protect, Lynx Smart BMS, etc.) +- Add more examples +- Performance optimization +- Add unit tests diff --git a/library.json b/library.json index 8b424b7..54d84d5 100644 --- a/library.json +++ b/library.json @@ -1,6 +1,6 @@ { "name": "VictronBLE", - "version": "1.0.0", + "version": "0.1.1", "description": "ESP32 library for reading Victron Energy device data via Bluetooth Low Energy (BLE) advertisements", "keywords": "victron, ble, bluetooth, solar, mppt, battery, smartshunt, esp32", "repository": { @@ -19,11 +19,6 @@ "platforms": ["espressif32"], "dependencies": [], "export": { - "exclude": [ - "examples", - "test", - "tests", - ".git" - ] + "exclude": ["examples", "test", "tests", ".git"] } } diff --git a/library.properties b/library.properties index 12c8ff3..515d483 100644 --- a/library.properties +++ b/library.properties @@ -1,5 +1,5 @@ name=VictronBLE -version=1.0.0 +version=0.1.1 author=Scott Penrose maintainer=Scott Penrose sentence=ESP32 library for reading Victron Energy device data via BLE for any ESP32