Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 13 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

---

Expand Down
6 changes: 3 additions & 3 deletions bluetooth/README.md
Original file line number Diff line number Diff line change
@@ -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
4 changes: 3 additions & 1 deletion board/README.md
Original file line number Diff line number Diff line change
@@ -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
6 changes: 4 additions & 2 deletions board/extension/README.md
Original file line number Diff line number Diff line change
@@ -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
8 changes: 5 additions & 3 deletions board/module/README.md
Original file line number Diff line number Diff line change
@@ -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
5 changes: 3 additions & 2 deletions board/pins/README.md
Original file line number Diff line number Diff line change
@@ -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
3 changes: 2 additions & 1 deletion common/README.md
Original file line number Diff line number Diff line change
@@ -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
4 changes: 4 additions & 0 deletions features/README.md
Original file line number Diff line number Diff line change
@@ -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
3 changes: 3 additions & 0 deletions gui/README.md
Original file line number Diff line number Diff line change
@@ -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)

<details>

<summary>128x128 (Click to expand)</summary>
Expand Down
4 changes: 4 additions & 0 deletions gui/fonts/README.md
Original file line number Diff line number Diff line change
@@ -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
4 changes: 4 additions & 0 deletions gui/functions/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Functions

LVGL interaction and navigation functions
Display control, page navigation, swipe gestures and anti-burn-in logic
4 changes: 4 additions & 0 deletions gui/img/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Images

Image assets used in LVGL displays
Icons, logos and graphics for GUI pages and widgets
3 changes: 2 additions & 1 deletion gui/pages/README.md
Original file line number Diff line number Diff line change
@@ -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
4 changes: 4 additions & 0 deletions gui/styles/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Styles

LVGL style definitions for pages, containers and button layouts
Shared visual styling applied across different screen sizes
4 changes: 4 additions & 0 deletions gui/themes/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Themes

LVGL theme and color scheme definitions
Color palettes, debug overlays and main theme configurations
4 changes: 4 additions & 0 deletions gui/weather/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Weather

Weather-related LVGL components
Forecast data, weather icons and today's weather display configurations
4 changes: 4 additions & 0 deletions gui/widgets/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Widgets

Reusable LVGL widget components
Boot screens, buttons, headers, footers, labels and OTA update screens