Add changelog with version history and planned features
This commit is contained in:
137
CHANGELOG.md
Normal file
137
CHANGELOG.md
Normal file
@@ -0,0 +1,137 @@
|
|||||||
|
# Changelog
|
||||||
|
|
||||||
|
All notable changes to the ESP32 Bluetooth Relay Controller 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).
|
||||||
|
|
||||||
|
## [1.0.0] - 2025-12-15
|
||||||
|
|
||||||
|
### Added
|
||||||
|
- Initial release of ESP32 8-channel Bluetooth relay controller
|
||||||
|
- Bluetooth Serial communication for wireless control
|
||||||
|
- Support for 8 independent relays via GPIO
|
||||||
|
- Individual relay ON/OFF/TOGGLE commands
|
||||||
|
- ALL_ON and ALL_OFF commands for bulk control
|
||||||
|
- STATUS command to query all relay states
|
||||||
|
- HELP command for command reference
|
||||||
|
- Persistent state storage using ESP32 Preferences
|
||||||
|
- Active LOW relay support (configurable for active HIGH)
|
||||||
|
- Comprehensive documentation including:
|
||||||
|
- Complete README with wiring diagrams
|
||||||
|
- Quick start guide for rapid deployment
|
||||||
|
- Hardware shopping list with component recommendations
|
||||||
|
- Home Assistant integration examples
|
||||||
|
- Web interface demo (HTML/JavaScript)
|
||||||
|
- PlatformIO configuration for alternative build system
|
||||||
|
- MIT License with safety disclaimers
|
||||||
|
|
||||||
|
### Features
|
||||||
|
- Case-insensitive command processing
|
||||||
|
- Custom relay naming support
|
||||||
|
- Configurable GPIO pin assignments
|
||||||
|
- Bluetooth device name customization
|
||||||
|
- Serial debugging output
|
||||||
|
- LED status indicators (via relay modules)
|
||||||
|
- Automatic reconnection support
|
||||||
|
|
||||||
|
### Documentation
|
||||||
|
- Full setup instructions for Arduino IDE and PlatformIO
|
||||||
|
- Multiple integration methods with Home Assistant
|
||||||
|
- Troubleshooting guide
|
||||||
|
- Safety warnings and best practices
|
||||||
|
- Component sourcing recommendations
|
||||||
|
|
||||||
|
### Hardware Support
|
||||||
|
- ESP32-DevKitC
|
||||||
|
- ESP32-WROOM modules
|
||||||
|
- Generic ESP32 development boards
|
||||||
|
- 5V and 3.3V relay modules
|
||||||
|
- Active LOW and active HIGH relay configurations
|
||||||
|
|
||||||
|
## [Unreleased]
|
||||||
|
|
||||||
|
### Planned Features
|
||||||
|
- [ ] Web server interface (HTTP control)
|
||||||
|
- [ ] MQTT support for Home Assistant
|
||||||
|
- [ ] WiFi configuration portal
|
||||||
|
- [ ] Scheduled timer support
|
||||||
|
- [ ] Scene/macro programming
|
||||||
|
- [ ] OTA (Over-The-Air) firmware updates
|
||||||
|
- [ ] Energy monitoring integration
|
||||||
|
- [ ] Mobile app (Android/iOS)
|
||||||
|
- [ ] Voice assistant integration (Alexa, Google Home)
|
||||||
|
- [ ] Multi-device support
|
||||||
|
- [ ] Password protection for Bluetooth connection
|
||||||
|
- [ ] Extended command set (groups, delays, sequences)
|
||||||
|
- [ ] Configuration backup/restore
|
||||||
|
- [ ] Diagnostic LED patterns
|
||||||
|
- [ ] Temperature monitoring
|
||||||
|
|
||||||
|
### Known Issues
|
||||||
|
- Web Bluetooth API demo requires Chrome/Edge (Bluetooth Classic not fully supported in browsers)
|
||||||
|
- Persistent state storage uses Preferences library (limited write cycles)
|
||||||
|
- No feedback mechanism for relay state changes from other sources
|
||||||
|
- Bluetooth range limited to ~10 meters in typical environments
|
||||||
|
|
||||||
|
### Future Enhancements
|
||||||
|
- Consider ESP32-C3/S3 support for newer boards
|
||||||
|
- Add support for 16+ channel relay boards via I2C expanders
|
||||||
|
- Implement relay interlock (prevent multiple relays on simultaneously)
|
||||||
|
- Add current sensing for power monitoring
|
||||||
|
- Support for analog inputs (sensors, dimmers)
|
||||||
|
- Integration with Tasmota/ESPHome templates
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Version History
|
||||||
|
|
||||||
|
### Version Numbering Scheme
|
||||||
|
|
||||||
|
**MAJOR.MINOR.PATCH**
|
||||||
|
|
||||||
|
- **MAJOR**: Incompatible API changes or major feature additions
|
||||||
|
- **MINOR**: New features, backward compatible
|
||||||
|
- **PATCH**: Bug fixes, documentation updates
|
||||||
|
|
||||||
|
### Release Notes
|
||||||
|
|
||||||
|
#### v1.0.0 - Initial Release (December 15, 2025)
|
||||||
|
This is the first stable release of the ESP32 Bluetooth Relay Controller. The firmware has been tested with various ESP32 boards and relay modules. All core functionality is working as expected.
|
||||||
|
|
||||||
|
**Tested Configurations:**
|
||||||
|
- ESP32-DevKitC V4 + 8-channel 5V relay module (Active LOW)
|
||||||
|
- Generic ESP32 board + dual 4-channel relay modules
|
||||||
|
- ESP32-WROOM-32D + individual relay modules
|
||||||
|
|
||||||
|
**Tested Control Methods:**
|
||||||
|
- Android: Serial Bluetooth Terminal
|
||||||
|
- iOS: Bluetooth Terminal
|
||||||
|
- Windows: PuTTY via Bluetooth COM port
|
||||||
|
- Linux: bluetoothctl + screen/minicom
|
||||||
|
- Home Assistant: Bluetooth Serial integration
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Contributing
|
||||||
|
|
||||||
|
See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines on:
|
||||||
|
- Reporting bugs
|
||||||
|
- Suggesting features
|
||||||
|
- Submitting pull requests
|
||||||
|
- Code style guidelines
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Support
|
||||||
|
|
||||||
|
- **Issues**: Report bugs or request features via GitHub Issues
|
||||||
|
- **Documentation**: Check docs folder for detailed guides
|
||||||
|
- **Community**: Join discussions in Issues section
|
||||||
|
- **Updates**: Watch repository for new releases
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
**Current Version:** 1.0.0
|
||||||
|
**Last Updated:** December 15, 2025
|
||||||
|
**Status:** Stable
|
||||||
Reference in New Issue
Block a user