Refactor component structure (#12)

* Refactor matrix switch component into nested component * Refactor matrix number component into nested component * Move library loading to display component * Rename main component to hub75_matrix_display
TillFleisch · Jan 31, 2024 · dd1bade · dd1bade
1 parent b088bbd
commit dd1bade
Show file tree

Hide file tree

Showing 18 changed files with 45 additions and 41 deletions.
diff --git a/README.md b/README.md
@@ -51,7 +51,7 @@ A minimum working example for setting up the display. A more complex configurati
 
 ```yaml
 display:
-  - platform: matrix_display
+  - platform: hub75_matrix_display
     id: matrix
     width: 64
     height: 32
@@ -87,20 +87,21 @@ The additional settings are used to set the configuration variables for the wrap
 - **i2sspeed**(**Optional**): I2SSpeed used for configuring the display. Select one of `HZ_8M`, `HZ_10M`, `HZ_15M`, `HZ_20M`.
 - **latch_blanking**(**Optional**, int): Latch blanking value used for configuring the display.
 - **clock_phase**(**Optional**, boolean): Clock phase value used for configuring the display.
+- **use_custom_library**(**Optional**, boolean): If set to `true` a custom library must be defined using `platformio_options:lib_deps`. Defaults to `false`. See [this example](custom_library.yaml) for more details.
 
 - All other options from [Display](https://esphome.io/components/display/index.html)
 
 Note that the default pin configurations are the ones mentioned in the [ESP32-HUB75-MatrixPanel-DMA](https://github.com/mrfaptastic/ESP32-HUB75-MatrixPanel-DMA) library. Some of these pins are used as strapping pins on ESPs. It is recommended to not use these.
 My panel and the ESP do not work unless I change the R2, G2 and B2 pins.
 
-## Matrix Display Switch
+## Switch
 
 This switch can be used to turn the display on or off. In it's off state the display is showing a blank screen.
 
 - **matrix_id**(**Required**, string): The matrix display entity to which this power switch belongs.
 - All other options from [Switch](https://esphome.io/components/switch/index.html#config-switch)
 
-## Matrix Display Brightness
+## Brightness
 
 This number entity can be used to set the display brightness. In combination with a brightness sensor this can used to adaptively change matrix displays brightness.
 

diff --git a/complex_matrix_config.yaml b/complex_matrix_config.yaml
@@ -1,5 +1,5 @@
 display:
-  - platform: matrix_display
+  - platform: hub75_matrix_display
     id: matrix
     width: 64
     height: 32

diff --git a/components/matrix_display/__init__.py → components/hub75_matrix_display/__init__.py b/components/matrix_display/__init__.py → components/hub75_matrix_display/__init__.py
diff --git a/components/matrix_display/display.py → components/hub75_matrix_display/display.py b/components/matrix_display/display.py → components/hub75_matrix_display/display.py
@@ -10,7 +10,6 @@
     CONF_WIDTH,
 )
 
-AUTO_LOAD = ["switch", "matrix_display_switch", "number", "matrix_display_brightness"]
 MATRIX_ID = "matrix_id"
 CHAIN_LENGTH = "chain_length"
 BRIGHTNESS = "brightness"
@@ -37,6 +36,8 @@
 LATCH_BLANKING = "latch_blanking"
 CLOCK_PHASE = "clock_phase"
 
+USE_CUSTOM_LIBRARY = "use_custom_library"
+
 matrix_display_ns = cg.esphome_ns.namespace("matrix_display")
 MatrixDisplay = matrix_display_ns.class_(
     "MatrixDisplay", cg.PollingComponent, display.DisplayBuffer
@@ -65,6 +66,7 @@
         cv.GenerateID(): cv.declare_id(MatrixDisplay),
         cv.Required(CONF_WIDTH): cv.positive_int,
         cv.Required(CONF_HEIGHT): cv.positive_int,
+        cv.Optional(USE_CUSTOM_LIBRARY, default=False): cv.boolean,
         cv.Optional(CHAIN_LENGTH, default=1): cv.positive_int,
         cv.Optional(BRIGHTNESS, default=128): cv.int_range(min=0, max=255),
         cv.Optional(
@@ -93,6 +95,16 @@
 
 
 async def to_code(config):
+    if not config[USE_CUSTOM_LIBRARY]:
+        cg.add_library("SPI", None)
+        cg.add_library("Wire", None)
+        cg.add_library("Adafruit BusIO", None)
+        cg.add_library("adafruit/Adafruit GFX Library", None)
+        cg.add_library(
+            "https://github.com/TillFleisch/ESP32-HUB75-MatrixPanel-DMA#optional_logging",
+            None,
+        )
+
     var = cg.new_Pvariable(config[CONF_ID])
     cg.add(var.set_panel_width(config[CONF_WIDTH]))
     cg.add(var.set_panel_height(config[CONF_HEIGHT]))

diff --git a/components/matrix_display/matrix_display.cpp → ...s/hub75_matrix_display/matrix_display.cpp b/components/matrix_display/matrix_display.cpp → ...s/hub75_matrix_display/matrix_display.cpp
diff --git a/components/matrix_display/matrix_display.h → ...nts/hub75_matrix_display/matrix_display.h b/components/matrix_display/matrix_display.h → ...nts/hub75_matrix_display/matrix_display.h
diff --git a/...nents/matrix_display_brightness/number.py → ...s/hub75_matrix_display/number/__init__.py b/...nents/matrix_display_brightness/number.py → ...s/hub75_matrix_display/number/__init__.py
@@ -3,9 +3,7 @@
 from esphome.components import number
 from esphome.const import CONF_MODE
 
-from ..matrix_display.display import MATRIX_ID, MatrixDisplay
-
-AUTO_LOAD = ["number"]
+from ..display import MATRIX_ID, MatrixDisplay
 
 matrix_display_brightness_ns = cg.esphome_ns.namespace(
     "matrix_display::matrix_display_brightness"

diff --git a/..._brightness/matrix_display_brightness.cpp → ...play/number/matrix_display_brightness.cpp b/..._brightness/matrix_display_brightness.cpp → ...play/number/matrix_display_brightness.cpp
diff --git a/...ay_brightness/matrix_display_brightness.h → ...isplay/number/matrix_display_brightness.h b/...ay_brightness/matrix_display_brightness.h → ...isplay/number/matrix_display_brightness.h
@@ -2,7 +2,7 @@
 
 #include "esphome/core/component.h"
 #include "esphome/components/number/number.h"
-#include "../matrix_display/matrix_display.h"
+#include "../matrix_display.h"
 
 namespace esphome::matrix_display::matrix_display_brightness
 {

diff --git a/components/matrix_display_switch/switch.py → ...s/hub75_matrix_display/switch/__init__.py b/components/matrix_display_switch/switch.py → ...s/hub75_matrix_display/switch/__init__.py
@@ -3,9 +3,7 @@
 from esphome.components import switch
 from esphome.const import CONF_ID
 
-from ..matrix_display.display import MATRIX_ID, MatrixDisplay
-
-AUTO_LOAD = ["switch"]
+from ..display import MATRIX_ID, MatrixDisplay
 
 matrix_display_switch_ns = cg.esphome_ns.namespace(
     "matrix_display::matrix_display_switch"

diff --git a/..._display_switch/matrix_display_switch.cpp → ..._display/switch/matrix_display_switch.cpp b/..._display_switch/matrix_display_switch.cpp → ..._display/switch/matrix_display_switch.cpp
diff --git a/...ix_display_switch/matrix_display_switch.h → ...ix_display/switch/matrix_display_switch.h b/...ix_display_switch/matrix_display_switch.h → ...ix_display/switch/matrix_display_switch.h
@@ -2,7 +2,7 @@
 
 #include "esphome/core/component.h"
 #include "esphome/components/switch/switch.h"
-#include "../matrix_display/matrix_display.h"
+#include "../matrix_display.h"
 
 namespace esphome::matrix_display::matrix_display_switch
 {

diff --git a/components/matrix_display_brightness/__init__.py b/components/matrix_display_brightness/__init__.py
diff --git a/components/matrix_display_switch/__init__.py b/components/matrix_display_switch/__init__.py
diff --git a/custom_library.yaml b/custom_library.yaml
@@ -0,0 +1,16 @@
+esphome:
+  name: matrix-display
+  platformio_options:
+    lib_deps:
+      - SPI
+      - Wire
+      - Adafruit BusIO
+      - adafruit/Adafruit GFX Library
+      - https://github.com/TillFleisch/ESP32-HUB75-MatrixPanel-DMA#optional_logging
+
+display:
+  - platform: hub75_matrix_display
+    id: matrix
+    width: 64
+    height: 32
+    use_custom_library: true
diff --git a/example.yaml b/example.yaml
@@ -1,13 +1,6 @@
 esphome:
   name: matrix-display
   friendly_name: Matrix Display
-  platformio_options:
-    lib_deps:
-      - SPI
-      - Wire
-      - Adafruit BusIO
-      - adafruit/Adafruit GFX Library
-      - https://github.com/TillFleisch/ESP32-HUB75-MatrixPanel-DMA#optional_logging
 
 external_components:
   - source: github://TillFleisch/ESPHome-HUB75-MatrixDisplayWrapper@main
@@ -24,7 +17,7 @@ font:
     size: 10
 
 display:
-  - platform: matrix_display
+  - platform: hub75_matrix_display
     id: matrix
     width: 64
     height: 32
@@ -33,12 +26,12 @@ display:
       it.print(0, 0, id(roboto), "Hello World!");
 
 switch:
-  - platform: matrix_display_switch
+  - platform: hub75_matrix_display
     matrix_id: matrix
     name: "Power"
     id: power
 
 number:
-  - platform: matrix_display_brightness
+  - platform: hub75_matrix_display
     matrix_id: matrix
     name: "Brightness"
diff --git a/tests/base.yaml b/tests/base.yaml
@@ -1,12 +1,5 @@
 esphome:
   name: matrix-display
-  platformio_options:
-    lib_deps:
-      - SPI
-      - Wire
-      - Adafruit BusIO
-      - adafruit/Adafruit GFX Library
-      - https://github.com/TillFleisch/ESP32-HUB75-MatrixPanel-DMA#optional_logging
 
 esp32:
   board: esp32dev
@@ -27,7 +20,7 @@ uart:
   stop_bits: 2
 
 display:
-  - platform: matrix_display
+  - platform: hub75_matrix_display
     id: matrix
     width: 64
     height: 32
diff --git a/tests/full.yaml b/tests/full.yaml
@@ -1,12 +1,5 @@
 esphome:
   name: matrix-display
-  platformio_options:
-    lib_deps:
-      - SPI
-      - Wire
-      - Adafruit BusIO
-      - adafruit/Adafruit GFX Library
-      - https://github.com/TillFleisch/ESP32-HUB75-MatrixPanel-DMA#optional_logging
 
 esp32:
   board: esp32dev
@@ -27,7 +20,7 @@ uart:
   stop_bits: 2
 
 display:
-  - platform: matrix_display
+  - platform: hub75_matrix_display
     id: matrix
     width: 64
     height: 32
@@ -41,14 +34,14 @@ display:
     update_interval: 8 ms
 
 switch:
-  - platform: matrix_display_switch
+  - platform: hub75_matrix_display
     matrix_id: matrix
     name: "Power"
     id: power
     restore_mode: RESTORE_DEFAULT_OFF
 
 number:
-  - platform: matrix_display_brightness
+  - platform: hub75_matrix_display
     id: brightness
     matrix_id: matrix
     name: "Brightness"