Add comprehensive documentation and testing tools
- Update README with complete setup guide and all blueprint URLs - Add PACKAGE_SETUP_GUIDE with step-by-step setup instructions - Add ROOM_CONFIGURATION_GUIDE with bedroom, living room, and bathroom examples - Add HARDWARE_TESTING_CHECKLIST for validating with real Inovelli switches - Add CHANGELOG documenting v1.0.0 release - Add validation script for automated YAML testing - Add test configuration example for testing without hardware
This commit is contained in:
53
CHANGELOG.md
Normal file
53
CHANGELOG.md
Normal file
@@ -0,0 +1,53 @@
|
||||
# Changelog
|
||||
|
||||
All notable changes to the Adaptive Lighting Mode System will be documented in
|
||||
this file.
|
||||
|
||||
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
|
||||
|
||||
## [1.0.0] - 2025-12-20
|
||||
|
||||
### Added
|
||||
|
||||
**Blueprints**:
|
||||
- `inovelli_mode_cycling.yaml` - Config button cycles through lighting modes
|
||||
with LED feedback
|
||||
- `inovelli_button_actions.yaml` - Multi-tap brightness controls with
|
||||
auto-reset
|
||||
- `presence_mode_reset.yaml` - Auto-reset modes and manual control when room
|
||||
empty
|
||||
|
||||
**Package Templates**:
|
||||
- `adaptive_lighting_global.yaml` - Shared mode definitions and color mappings
|
||||
- `adaptive_lighting_bedroom_template.yaml` - Complete bedroom example with 5
|
||||
modes
|
||||
- `adaptive_lighting_living_room_template.yaml` - Living room example with
|
||||
entertainment modes
|
||||
- `adaptive_lighting_simple_template.yaml` - Minimal template for simple rooms
|
||||
|
||||
**Documentation**:
|
||||
- `PACKAGE_SETUP_GUIDE.md` - Setup instructions and version control guide
|
||||
- `ROOM_CONFIGURATION_GUIDE.md` - Room-by-room configuration examples
|
||||
- `HARDWARE_TESTING_CHECKLIST.md` - Comprehensive testing checklist
|
||||
- Updated `README.md` with system overview and quick start
|
||||
|
||||
**Features**:
|
||||
- Room-specific mode definitions (Adaptive, Reading, Theater, Sleep, etc.)
|
||||
- Visual LED feedback using ROYGBIV color scheme
|
||||
- Weekend mode with automatic sunrise/sunset adjustments
|
||||
- Multi-tap button actions (boost, max, night light)
|
||||
- Presence-based auto-reset
|
||||
- Version-controlled package-based configuration
|
||||
|
||||
### Technical Details
|
||||
|
||||
- Zigbee2MQTT integration for Inovelli Blue VZM31-SN switches
|
||||
- Home Assistant Adaptive Lighting integration required
|
||||
- Package-based architecture for easy version control
|
||||
- Template-driven room setup for scalability
|
||||
|
||||
### Known Limitations
|
||||
|
||||
- Zigbee2MQTT only (Z-Wave JS requires different MQTT topics)
|
||||
- Settings from `adaptive_lighting.change_switch_settings` reset on HA restart
|
||||
- Requires manual Inovelli switch configuration (Smart Bulb Mode, buttonDelay)
|
||||
Reference in New Issue
Block a user