Skip to content

Latest commit

 

History

History
58 lines (33 loc) · 1.96 KB

README.md

File metadata and controls

58 lines (33 loc) · 1.96 KB

NSPanel HomeAssistant UI Docs

README | Documentation | Installation | Configuration | Panels | FAQ

End User

For details about installation and configuration see the following pages.

Development

The device handling responsibility is assigned to ESPHome. The communication with the nextion display is done using the ESPHome component nextion.

The backend and global logic of the system is under the management of AppDaemon, which handles all the behind-the-scenes operations.

The display operations with minimal logic are assigned to Nextion, which works in collaboration with ESPHome to show informations on the panel.

  • Design Guidelines

    A description about designing styling panels.

  • Communication Overview

    A description about the communication process of the components.

  • ESPHome Component

    The ESP processes the serial communication and creates events which are being sent via MQTT. Only the ESP communicates directly with the display.

  • AppDaemon Component

    Most logic is implemented in the AppDaemon App. This app controls the Nextion display running on the ESP32. It updates the display based on the latest data from Home Assistant entities.

  • Nextion Component

    The display is responsible for showing the panels, preparing components on pages before they being shown (setting an initial state).

Versioning

There are version informations for:

  • AppDaemon App
  • YAML-File for ESPHome
  • TFT-Display File (Matches Release Version)

Every release should contain the tft files as assets. The version for the tft files should match the release version.