From 733def2dace94d339464dc450ec1287fb17e4979 Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Sun, 21 Jun 2026 05:47:55 +0000 Subject: [PATCH] Update and create README files across the repository --- README.md | 15 +++++++++++++-- bluetooth/README.md | 6 +++--- board/README.md | 4 +++- board/extension/README.md | 6 ++++-- board/module/README.md | 8 +++++--- board/pins/README.md | 5 +++-- common/README.md | 3 ++- features/README.md | 4 ++++ gui/README.md | 3 +++ gui/fonts/README.md | 4 ++++ gui/functions/README.md | 4 ++++ gui/img/README.md | 4 ++++ gui/pages/README.md | 3 ++- gui/styles/README.md | 4 ++++ gui/themes/README.md | 4 ++++ gui/weather/README.md | 4 ++++ gui/widgets/README.md | 4 ++++ 17 files changed, 70 insertions(+), 15 deletions(-) create mode 100644 features/README.md create mode 100644 gui/fonts/README.md create mode 100644 gui/functions/README.md create mode 100644 gui/img/README.md create mode 100644 gui/styles/README.md create mode 100644 gui/themes/README.md create mode 100644 gui/weather/README.md create mode 100644 gui/widgets/README.md diff --git a/README.md b/README.md index 0911765..1ceab58 100644 --- a/README.md +++ b/README.md @@ -20,9 +20,20 @@ M5Stack: ATOM Mate HAT, ATOM Port ABC, Unit pA Hub and more Sensors and peripherals M5Stack: HAT ENV.III, Unit ENV.IV, Unit PIR ePaper basic functions and scripts - + +### [bluetooth](bluetooth) +Bluetooth proxy and BLE scanner/tracker packages + +### [common](common) +Shared base configuration included in all ESPHome projects +WiFi, API, OTA, logging, time and restart defaults + +### [features](features) +Reusable feature packages for cross-device functionality +Combined sensors, IR codes, NordPool alerts, status LEDs + ### [gui](gui) -Modular LVGL layout +Modular LVGL layout with resolution-specific configs, themes, pages and widgets --- diff --git a/bluetooth/README.md b/bluetooth/README.md index 49337b8..96eef0a 100644 --- a/bluetooth/README.md +++ b/bluetooth/README.md @@ -1,5 +1,5 @@ # Bluetooth - -Bluetooth proxy and BLE scanner -Only included in some devices +Bluetooth proxy and BLE scanner/tracker packages +Provides BLE tracking and Bluetooth proxy functionality for Home Assistant +Only included in devices with BLE-capable ESP32 chips diff --git a/board/README.md b/board/README.md index e83ddee..06d355f 100644 --- a/board/README.md +++ b/board/README.md @@ -1,3 +1,5 @@ # Board variants - Basic functions for ESP32 board variants +Basic functions for ESP32 board variants +Each file defines the core platform, framework and board-specific settings +Covers M5Stack, WaveShare, Sunton, GeekMagic and generic ESP32 boards diff --git a/board/extension/README.md b/board/extension/README.md index c2b062a..7c8a387 100644 --- a/board/extension/README.md +++ b/board/extension/README.md @@ -1,3 +1,5 @@ # Extensions - -BUS and extension functions + +BUS and extension functions +Configurations for I2C, SPI, UART and GPIO expansion +Supports HAT, Grove, M-BUS and Port ABC connectivity on various boards diff --git a/board/module/README.md b/board/module/README.md index e47a2a0..e36c079 100644 --- a/board/module/README.md +++ b/board/module/README.md @@ -1,3 +1,5 @@ -# Sensor and peripherals - -Functions for sensors, displays and peripherals +# Sensors and peripherals + +Functions for sensors, displays and peripherals +Includes environmental sensors, IMUs, RTCs, microphones, IR remotes, ePaper displays and more +Organized by unit/HAT/chip type for easy inclusion diff --git a/board/pins/README.md b/board/pins/README.md index e8222ea..a8f79f9 100644 --- a/board/pins/README.md +++ b/board/pins/README.md @@ -1,3 +1,4 @@ # Pins - -Pin definitions for board variants + +Pin definitions for board variants +GPIO assignments for buttons, LEDs, I2C, SPI, UART and display interfaces diff --git a/common/README.md b/common/README.md index d6b2c31..bc717ff 100644 --- a/common/README.md +++ b/common/README.md @@ -1,3 +1,4 @@ # Common -Inclusions for all ESPHome projects +Shared base configuration included in all ESPHome projects +Covers WiFi, API, OTA, logging, time synchronization, restart buttons and status sensors diff --git a/features/README.md b/features/README.md new file mode 100644 index 0000000..327f099 --- /dev/null +++ b/features/README.md @@ -0,0 +1,4 @@ +# Features + +Reusable feature packages for cross-device functionality +Includes combined sensor templates, IR code definitions, NordPool energy alerts and status LED controls diff --git a/gui/README.md b/gui/README.md index f2f16d1..3d673ee 100644 --- a/gui/README.md +++ b/gui/README.md @@ -1,8 +1,11 @@ # GUI Display related files Modular LVGL configs for different screen sizes +Top-level files are resolution-specific entry points (e.g. 240x135, 480x320) Images might be out of date +Subdirectories: [pages](pages) · [widgets](widgets) · [themes](themes) · [styles](styles) · [fonts](fonts) · [functions](functions) · [weather](weather) · [img](img) +
128x128 (Click to expand) diff --git a/gui/fonts/README.md b/gui/fonts/README.md new file mode 100644 index 0000000..47882e0 --- /dev/null +++ b/gui/fonts/README.md @@ -0,0 +1,4 @@ +# Fonts + +Font files and glyph definitions for LVGL displays +Includes TrueType, BDF fonts and glyph/icon mappings for Material Design Icons diff --git a/gui/functions/README.md b/gui/functions/README.md new file mode 100644 index 0000000..8648d37 --- /dev/null +++ b/gui/functions/README.md @@ -0,0 +1,4 @@ +# Functions + +LVGL interaction and navigation functions +Display control, page navigation, swipe gestures and anti-burn-in logic diff --git a/gui/img/README.md b/gui/img/README.md new file mode 100644 index 0000000..5cbaf8e --- /dev/null +++ b/gui/img/README.md @@ -0,0 +1,4 @@ +# Images + +Image assets used in LVGL displays +Icons, logos and graphics for GUI pages and widgets diff --git a/gui/pages/README.md b/gui/pages/README.md index f919399..184f531 100644 --- a/gui/pages/README.md +++ b/gui/pages/README.md @@ -1,3 +1,4 @@ # Pages -Pre-made commonly used pages for LVGL +Pre-made commonly used pages for LVGL +Each page type has resolution-specific layouts for supported screen sizes diff --git a/gui/styles/README.md b/gui/styles/README.md new file mode 100644 index 0000000..dd4bffb --- /dev/null +++ b/gui/styles/README.md @@ -0,0 +1,4 @@ +# Styles + +LVGL style definitions for pages, containers and button layouts +Shared visual styling applied across different screen sizes diff --git a/gui/themes/README.md b/gui/themes/README.md new file mode 100644 index 0000000..567a07b --- /dev/null +++ b/gui/themes/README.md @@ -0,0 +1,4 @@ +# Themes + +LVGL theme and color scheme definitions +Color palettes, debug overlays and main theme configurations diff --git a/gui/weather/README.md b/gui/weather/README.md new file mode 100644 index 0000000..499573c --- /dev/null +++ b/gui/weather/README.md @@ -0,0 +1,4 @@ +# Weather + +Weather-related LVGL components +Forecast data, weather icons and today's weather display configurations diff --git a/gui/widgets/README.md b/gui/widgets/README.md new file mode 100644 index 0000000..d1445e4 --- /dev/null +++ b/gui/widgets/README.md @@ -0,0 +1,4 @@ +# Widgets + +Reusable LVGL widget components +Boot screens, buttons, headers, footers, labels and OTA update screens