diff --git a/apps/nspanel-lovelace-ui/luibackend/config.py b/apps/nspanel-lovelace-ui/luibackend/config.py index 9ef9bfcd..62c1cb42 100644 --- a/apps/nspanel-lovelace-ui/luibackend/config.py +++ b/apps/nspanel-lovelace-ui/luibackend/config.py @@ -86,27 +86,24 @@ class LuiBackendConfig(object): 'cards': [{ 'type': 'cardEntities', 'entities': [{ - 'entity': 'switch.test_item', - 'name': 'Test Item' - }, { - 'entity': 'switch.test_item' - }], - 'title': 'Example Entities Page' - }, { - 'type': 'cardGrid', - 'entities': [{ - 'entity': 'switch.test_item' - }, { - 'entity': 'switch.test_item' - }, { - 'entity': 'switch.test_item' - } - ], - 'title': 'Example Grid Page' - }, { - 'type': 'climate', - 'entity': 'climate.test_item', - 'temperatureUnit': 'celsius' + 'entity': 'iText.', + 'name': 'MQTT Config successful', + 'icon': 'mdi:check', + 'color:': [0, 255, 0], + },{ + 'entity': 'iText.', + 'name': 'Continue adding', + 'icon': 'mdi:arrow-right-bold', + },{ + 'entity': 'iText.', + 'name': 'cards to your', + 'icon': 'mdi:card', + },{ + 'entity': 'iText.', + 'name': 'apps.yaml', + 'icon': 'mdi:cog', + }], + 'title': 'Setup successful' }], 'screensaver': { 'type': 'screensaver', diff --git a/docs/configure_mqtt.md b/docs/configure_mqtt.md new file mode 100644 index 00000000..1f649aab --- /dev/null +++ b/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. + +
+Note: You can add multiple panels to this configuration: +
+```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" +``` +
diff --git a/docs/setup_ha.md b/docs/prepare_ha.md similarity index 100% rename from docs/setup_ha.md rename to docs/prepare_ha.md diff --git a/mkdocs.yml b/mkdocs.yml index fb65ca8d..1cda7f8a 100644 --- a/mkdocs.yml +++ b/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 \ No newline at end of file