mirror of
https://github.com/Legolas-2025/esp32-energy-meter.git
synced 2026-08-17 12:35:01 +02:00
117 lines
4.0 KiB
Markdown
117 lines
4.0 KiB
Markdown
# Changelog
|
|
|
|
All notable changes to this project will be documented in this file.
|
|
|
|
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
|
|
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
|
|
|
## [2.0.0] - 2025-12-20
|
|
|
|
### Added
|
|
- Enhanced WiFi connectivity monitoring using signal strength
|
|
- OLED burn-in protection with automatic screen clearing
|
|
- Professional Google Fonts integration for display
|
|
- Comprehensive hardware setup documentation
|
|
- Complete ESPHome configuration guide
|
|
- Extensive troubleshooting documentation
|
|
- Home Assistant integration tutorial
|
|
- Advanced features and customization guide
|
|
- Complete API reference documentation
|
|
- System health monitoring sensors
|
|
- Memory usage and uptime tracking
|
|
- Template sensors for power quality analysis
|
|
|
|
### Changed
|
|
- WiFi status from generic `platform: status` to signal strength-based monitoring
|
|
- Display update intervals optimized for performance (3 seconds)
|
|
- Modbus communication throttling improved (50ms)
|
|
- Font loading efficiency enhanced
|
|
- Documentation structure reorganized and expanded
|
|
- Security through anonymization of personal credentials
|
|
|
|
### Fixed
|
|
- False WiFi "disconnected" alerts after device boot
|
|
- OLED screen burn-in from static content display
|
|
- Missing Home Assistant entity state classes for energy dashboard
|
|
- Inadequate troubleshooting guidance for common issues
|
|
- Lack of professional documentation for community sharing
|
|
|
|
### Enhanced
|
|
- User experience through accurate connectivity status
|
|
- Display readability with professional typography
|
|
- System reliability through optimized communication intervals
|
|
- Documentation quality for educational value
|
|
- Community readiness through comprehensive guides
|
|
|
|
### Security
|
|
- Personal API keys and passwords anonymized
|
|
- Proper secret management system implementation
|
|
- Mandatory encryption for Home Assistant API
|
|
- Network security requirements documented
|
|
|
|
### Documentation
|
|
- Hardware assembly guide with safety warnings
|
|
- Step-by-step configuration tutorial
|
|
- 400+ lines of troubleshooting solutions
|
|
- Complete entity and service reference
|
|
- Home Assistant energy dashboard setup
|
|
- Advanced customization options
|
|
|
|
### Performance
|
|
- Optimized sensor update intervals (3s)
|
|
- Efficient Modbus command throttling
|
|
- Memory usage optimization
|
|
- Network communication improvements
|
|
|
|
---
|
|
|
|
## [1.0.0] - Original Project
|
|
|
|
### Original Features
|
|
- Basic ESP32 energy monitoring with JSY meter
|
|
- Simple OLED display for power readings
|
|
- Home Assistant API integration
|
|
- Modbus RTU communication
|
|
- Basic WiFi connectivity
|
|
|
|
### Original Author
|
|
- Giovanni Aggiustatutto
|
|
- Project: "DIY Smart Energy Meter With ESP32 + Home Assistant"
|
|
- License: Creative Commons BY-NC-SA 4.0
|
|
- Source: https://www.instructables.com/DIY-Smart-Energy-Meter-With-ESP32-Home-Assistant/
|
|
|
|
### Original Capabilities
|
|
- Dual channel power monitoring
|
|
- Voltage, current, and frequency measurement
|
|
- Energy consumption tracking
|
|
- Power factor calculation
|
|
- Basic Home Assistant integration
|
|
|
|
---
|
|
|
|
## Version Numbering
|
|
|
|
This project uses semantic versioning (SemVer):
|
|
- **MAJOR** version when you make incompatible API changes
|
|
- **MINOR** version when you add functionality in a backwards compatible manner
|
|
- **PATCH** version when you make backwards compatible bug fixes
|
|
|
|
### Version 2.0.0 Rationale
|
|
- **MAJOR**: Significant architectural improvements and new features
|
|
- **Enhanced WiFi monitoring**: Major reliability improvement
|
|
- **OLED burn-in protection**: New functionality
|
|
- **Comprehensive documentation**: Major value addition
|
|
- **Professional presentation**: Significant user experience improvement
|
|
|
|
### Migration from 1.0.0 to 2.0.0
|
|
1. Hardware remains compatible (no changes required)
|
|
2. Configuration file needs updating (new YAML)
|
|
3. Personal credentials need configuring (secrets.yaml)
|
|
4. Documentation benefits from new guides
|
|
5. Enhanced features become immediately available
|
|
|
|
### Future Versioning
|
|
- **2.1.0**: MQTT integration addition
|
|
- **2.2.0**: Solar panel monitoring support
|
|
- **3.0.0**: Mobile application integration
|
|
- **1.x.x**: Will refer to original project versions |