Initial version only

This commit is contained in:
2025-12-18 17:53:39 +11:00
parent 3daf61d78a
commit d8128dae2e
4 changed files with 42 additions and 8 deletions

View File

@@ -2,6 +2,12 @@
ESP32 library for reading Victron Energy device data via Bluetooth Low Energy (BLE) advertisements. 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. 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 ## Features
@@ -441,6 +447,10 @@ Copyright (c) 2025 Scott Penrose <scottp@dd.com.au>
This library is not officially supported by Victron Energy. Use at your own risk. 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 ## Support
- 📫 Report issues on GitHub - 📫 Report issues on GitHub

29
VERSIONS Normal file
View File

@@ -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

View File

@@ -1,6 +1,6 @@
{ {
"name": "VictronBLE", "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", "description": "ESP32 library for reading Victron Energy device data via Bluetooth Low Energy (BLE) advertisements",
"keywords": "victron, ble, bluetooth, solar, mppt, battery, smartshunt, esp32", "keywords": "victron, ble, bluetooth, solar, mppt, battery, smartshunt, esp32",
"repository": { "repository": {
@@ -19,11 +19,6 @@
"platforms": ["espressif32"], "platforms": ["espressif32"],
"dependencies": [], "dependencies": [],
"export": { "export": {
"exclude": [ "exclude": ["examples", "test", "tests", ".git"]
"examples",
"test",
"tests",
".git"
]
} }
} }

View File

@@ -1,5 +1,5 @@
name=VictronBLE name=VictronBLE
version=1.0.0 version=0.1.1
author=Scott Penrose author=Scott Penrose
maintainer=Scott Penrose <scottp@dd.com.au> maintainer=Scott Penrose <scottp@dd.com.au>
sentence=ESP32 library for reading Victron Energy device data via BLE for any ESP32 sentence=ESP32 library for reading Victron Energy device data via BLE for any ESP32