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:
2025-12-21 14:30:53 -08:00
parent 5eec41a43c
commit a5a6b9d4b6
7 changed files with 722 additions and 18 deletions

36
scripts/validate_yaml.sh Executable file
View File

@@ -0,0 +1,36 @@
#!/bin/bash
# scripts/validate_yaml.sh
#
# Validates YAML syntax for all Adaptive Lighting system files
set -e
echo "Validating Adaptive Lighting Mode System YAML files..."
echo "========================================================"
# Check if yamllint is installed
if ! command -v yamllint &> /dev/null; then
echo "ERROR: yamllint not found."
echo "Install with: pip install yamllint"
echo "Or run with: nix run nixpkgs#yamllint -- <files>"
exit 1
fi
# Validate packages
echo ""
echo "Validating packages..."
for file in packages/*.yaml; do
echo " - $file"
yamllint -d '{extends: default, rules: {line-length: {max: 120}}}' "$file"
done
# Validate blueprints
echo ""
echo "Validating blueprints..."
for file in blueprints/automation/*.yaml; do
echo " - $file"
yamllint -d '{extends: default, rules: {line-length: {max: 120}}}' "$file"
done
echo ""
echo "✓ All YAML files are valid!"