add mqtt config

apps/nspanel-lovelace-ui/luibackend/config.py

@@ -86,27 +86,24 @@ class LuiBackendConfig(object):
             'cards': [{
                 'type': 'cardEntities',
                 'entities': [{
-                    'entity': 'switch.test_item',
+                    'entity': 'iText.',
-                    'name': 'Test Item'
+                    'name': 'MQTT Config successful',
-                    }, {
+                    'icon': 'mdi:check',
-                    'entity': 'switch.test_item'
+                    'color:': [0, 255, 0],
-                }],
+                    },{
-                'title': 'Example Entities Page'
+                    'entity': 'iText.',
-            }, {
+                    'name': 'Continue adding',
-                'type': 'cardGrid',
+                    'icon': 'mdi:arrow-right-bold',
-                'entities': [{
+                    },{
-                    'entity': 'switch.test_item'
+                    'entity': 'iText.',
-                    }, {
+                    'name': 'cards to your',
-                    'entity': 'switch.test_item'
+                    'icon': 'mdi:card',
-                    }, {
+                    },{
-                    'entity': 'switch.test_item'
+                    'entity': 'iText.',
-                    }
+                    'name': 'apps.yaml',
-                ],
+                    'icon': 'mdi:cog',
-                'title': 'Example Grid Page'
+                    }],
-            }, {
+                'title': 'Setup successful'
-                'type': 'climate',
-                'entity': 'climate.test_item',
-                'temperatureUnit': 'celsius'
             }],
             'screensaver': {
                 'type': 'screensaver',

docs/configure_mqtt.md

@@ -0,0 +1,80 @@
+# Configure MQTT on Tasmota
+
+Configure your MQTT Server in Tasmota.
+See Tasmota [MQTT Documentation](https://tasmota.github.io/docs/MQTT/) for more details.
+
+![tasmota-mqtt-config](img/tasmota-mqtt-config.png)
+
+Please leave the Full Topic as it is in default configuration (and on the screenshot).
+
+Change the topic to something unique for your panel, you will need this topic later in the configuration of your panel in appdaemon / apps.yaml
+
+# Configure MQTT Connection on AppDaemon
+
+For the app to work you need a working MQTT Configuration in AppDaemon. Please add the configuration of your mqtt server, user and password to your existing `appdaemon.yaml`
+
+NOTE: This are not the options of the AppDaemon Addon in Home Assistant. 
+You will find this file in the following location: `config/appdaemon/appdeamon.yaml`
+
+```yaml
+---
+secrets: /config/secrets.yaml
+appdaemon:
+  latitude: 52.0
+  longitude: 4.0
+  elevation: 2
+  time_zone: Europe/Berlin
+  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
+http:
+  url: http://127.0.0.1:5050
+admin:
+api:
+hadashboard:
+```
+
+# Configure NsPanel on AppDaemon
+
+Please add the following minimal configuration to your apps.yaml, which is located in `config/appdaemon/apps/apps.yaml`
+
+```yaml
+---
+nspanel-1:
+  module: nspanel-lovelace-ui
+  class: NsPanelLovelaceUIManager
+  config:
+    panelRecvTopic: "tele/tasmota_your_mqtt_topic/RESULT"
+    panelSendTopic: "cmnd/tasmota_your_mqtt_topic/CustomSend"
+```
+
+Please adjust `tasmota_your_mqtt_topic` to the topic used in Tasmota MQTT Configuration.
+
+<details>
+<summary>Note: You can add multiple panels to this configuration:</summary>
+<br>
+```yaml
+---
+nspanel-1:
+  module: nspanel-lovelace-ui
+  class: NsPanelLovelaceUIManager
+  config:
+    panelRecvTopic: "tele/first-nspanel-topic/RESULT"
+    panelSendTopic: "cmnd/first-nspanel-topic/CustomSend"
+nspanel-2:
+  module: nspanel-lovelace-ui
+  class: NsPanelLovelaceUIManager
+  config:
+    panelRecvTopic: "tele/second-nspanel-topic/RESULT"
+    panelSendTopic: "cmnd/second-nspanel-topic/CustomSend"
+```
+</details>

mkdocs.yml

@@ -62,7 +62,8 @@ nav:
     - "Getting started":
         - "First steps":
             - "Prepare NsPanel": prepare_nspanel.md
-            - "Setup Home Assistant": setup_ha.md
+            - "Prepare Home Assistant": prepare_ha.md
+            - "Configure MQTT": configure_mqtt.md
         - "FAQ": faq.md
     - "Configuration - apps.yaml":
         - "Cards": cards.md