diff --git a/HMI/nspanel.HMI b/HMI/nspanel.HMI index 9a9611e0..d7b04f00 100644 Binary files a/HMI/nspanel.HMI and b/HMI/nspanel.HMI differ diff --git a/README.md b/README.md index 7b115f99..4dd0b80e 100644 --- a/README.md +++ b/README.md @@ -6,9 +6,15 @@ NsPanel Lovelace UI is a Firmware for the nextion screen inside of NSPanel in the Design of [HomeAssistant](https://www.home-assistant.io/)'s Lovelace UI Design. +See the following picture to get an idea of the look of this firmware for NSPanel. + +![screens](doc-pics/screens.png) + It works with [Tasmota](https://tasmota.github.io/docs/) over MQTT. To control the panel and update it with content from HomeAssistant there is an [AppDeamon](https://github.com/AppDaemon/appdaemon) App. + + - [How It Works](#how-it-works) - [Requirements](#requirements) @@ -181,41 +187,32 @@ Upload the [tft file from HMI folder](HMI/nspanel.tft) to a Webserver (for examp ### Configuring the MQTT integration in AppDaemon +For the app to work you need a working MQTT Configuration in AppDaemon. Please configure mqtt server, user and password in `appdaemon.yaml` + +```yaml +. +. +. + plugins: + HASS: + type: hass + MQTT: + type: mqtt + namespace: mqtt + client_id: "appdaemon" + client_host: 192.168.75.30 + client_port: 1883 + client_user: "mqttuser" + client_password: "mqttpassword" + client_topics: NONE +. +. +. +``` + ### Configure your NSPanel in AppDaemon - - - - - - - - - - - - - - - - - - -# Old Docs - - - -## 3. Setup your Backend - -The Backend answers to commands from NsPanel and send's content to display on the screen. - -## 3a. AppDeamon Backend (Recommended) - -### Installation - - - -### App Configuration +Confiure your NSPanel as you like, you need to edit the `apps.yaml` inside of your appdeamon config folder. ```yaml nspanel-1: @@ -264,6 +261,20 @@ key | optional | type | default | description `config` | False | complex | | Config/Mapping between Homeassistant and your NsPanel + + + + + + + + + + + + + + ## 3b. Node Red Flow (Deprecated, but functional with limited Feature Set) Import the example node-red flow from "node-red-example-flow.json" file and adjust to your needs. diff --git a/doc-pics/screen_cardEntities1.png b/doc-pics/screen_cardEntities1.png new file mode 100644 index 00000000..3995ae6d Binary files /dev/null and b/doc-pics/screen_cardEntities1.png differ diff --git a/doc-pics/screen_cardEntities2.png b/doc-pics/screen_cardEntities2.png new file mode 100644 index 00000000..9f9d99c7 Binary files /dev/null and b/doc-pics/screen_cardEntities2.png differ diff --git a/doc-pics/screen_cardMedia.png b/doc-pics/screen_cardMedia.png new file mode 100644 index 00000000..7ca94c29 Binary files /dev/null and b/doc-pics/screen_cardMedia.png differ diff --git a/doc-pics/screen_cardThermo.png b/doc-pics/screen_cardThermo.png index 66223198..88868369 100644 Binary files a/doc-pics/screen_cardThermo.png and b/doc-pics/screen_cardThermo.png differ diff --git a/doc-pics/screen_popupLight.png b/doc-pics/screen_popupLight.png index 8c338af7..e5166e41 100644 Binary files a/doc-pics/screen_popupLight.png and b/doc-pics/screen_popupLight.png differ diff --git a/doc-pics/screen_popupShutter.png b/doc-pics/screen_popupShutter.png index 776121de..faf21c92 100644 Binary files a/doc-pics/screen_popupShutter.png and b/doc-pics/screen_popupShutter.png differ diff --git a/doc-pics/screens.png b/doc-pics/screens.png new file mode 100644 index 00000000..5b1d62ac Binary files /dev/null and b/doc-pics/screens.png differ