Repository navigation
🚀 What's New in v1.1.0
This release elevates the SmartDisplay project to a senior open-source engineering standard, introducing formal architectural decision records (ADRs), complete continuous integration (CI) automation with YAML linting, community developer experience templates, and real hardware showcases.
🧠 Architecture Decision Records (ADRs)
Documented formal engineering rationale and physics calculations in docs/ARCHITECTURE_DECISIONS.md:
-
ADR-01: Display SPI Bus at 80 MHz vs 40 MHz (
$921.6\text{ kb/frame}$ ,$11.52\text{ ms}$ DMA transfer time, securing >65% time budget for 30 FPS LVGL rendering). - ADR-02: Passive BLE Proxy vs Active Tracking mode (2.4 GHz RF coexistence eliminating Wi-Fi drops and I2S audio jitter).
- ADR-03: Dynamic GPIO46 Power Gating for NS4168 Class-D amplifier (~20mA idle power savings and zero background hiss).
- ADR-04: LIFO 10-item notification queue ring-buffer for immediate glanceability of critical home alarms.
- ADR-05: Event-driven SNTP clock synchronization eliminating cyclic 10s CPU wake-locks.
⚙️ CI/CD & Automated Quality Gates
- Automated ESPHome Validation: GitHub Actions workflow (
.github/workflows/ci.yml) validating both modular packages (smartdisplay.yaml) and single-file standalone (smartdisplay_standalone.yaml). - YAML Linting: Integrated
yamllintstep with custom.yamllint.ymlconfiguration ensuring clean formatting across the codebase.
🤝 Open Source Standards & DX
- Contributor Guide:
CONTRIBUTING.mdwith Gitflow branching model, Conventional Commits specification, and architectural parity guarantees. - Code of Conduct:
CODE_OF_CONDUCT.mdadhering to Contributor Covenant v2.1. - GitHub Issue & PR Templates: Structured YAML forms for Bug Reports, Feature Requests, and PR verification checklists.
📸 Real Hardware Showcase & Social Banner
- Added real high-resolution photographs of the device in its circular desk enclosure:
- Standby clock face with live weather and unread notification bell badge.
- Full-screen notification cards.
- Destructive action confirmation modal.
- Live system diagnostics screen.
- High-resolution OpenGraph social preview banner (
.github/assets/banner.png1280x640).
🌐 Community Outreach
devices.esphome.io: Ready-to-submit device catalog template indocs/community/devices_esphome_io_submission.md.- Home Assistant Community: Comprehensive showcase post draft in
docs/community/home_assistant_community_post.md.
Full Changelog: v1.0.0...v1.1.0