Important
This is an outdated component, originally developed when it wasn’t possible to use LVGL natively. It will most likely stop working after the ESPHome 2025.10 update (Arduino as an IDF component).
Recommended alternatives: native LVGL or Remote WebView.
Config-driven Home Assistant dashboard (built on top of ESPHome using LVGL).
The HA Deck comprises of two components: hd_device_[name] and ha_deck itself. The first one has such responsibilities:
- Integrates with the hardware (configures display, touch screen, LVGL)
- Exposes display brightness so it can be changed by other components.
- Incapsulates a background image and fonts.
The ha_deck component renders all widgets, switches screens, and controls inactivity behavior.
- WT32-SC01 PLUS (ESP32-S3, 3.5", 480x320)
- WT32S3-86S/ZX3D95CE01S-AR-4848 (ESP32-S3, 4", 480x480) - not fully tested As of today, only the hardware component has been added. HA Deck doesn't auto-scale widget size based on screen resolution, so sliders will look odd when the default parameters are used with a larger (480x480) display.
As I'm currently focusing on developing the new version of HA Deck that comes with additional widgets, styles, and other features, I won't be able to provide support for new boards. Once the initial release is ready, I need to figure out the best way to do it, as there are numerous screens to consider, and it won't be feasible for me to test and maintain them all.
For now, creating a new hardware component in a separate repository is the recommended way for easy integration with HA Deck.
First, import components using the external components feature.
external_components:
- source:
type: git
url: https://github.com/strange-v/ha_deck
ref: main
components: [ hd_device_sc01_plus, ha_deck ]Then, declare the hardware component.
hd_device_sc01_plus:
id: device
brightness: 75After this, the main component with screens and widgets can be declared (see complete example here).
ha_deck:
id: deck
main_screen: scr_main
screens:
- name: scr_main
widgets:
- type: button
position: 8, 8
text: Rooms
icon:
enabled: return true;
on_click:
lambda: id(deck).switch_screen("scr_rooms");
- name: scr_rooms
widgets:
... ... ...Make sure you have enough space on the app partitions, as pre-compiled fonts require a lot of space. The icon font contains common home-based icons. You can search icons here, but make sure they belong to a common home-based icons subset.
If a device has PSRAM, it is better to enable it. In the case of a big screen, the display won't work without PSRAM. The configuration below is for WT32S3-86S.
esphome:
name: device_name
friendly_name: device_friendly_name
platformio_options:
board_build.arduino.memory_type: qio_opi