From 1cc0d40885b3594e17326b7299e9cc05f93db7f0 Mon Sep 17 00:00:00 2001
From: joBr99 <29555657+joBr99@users.noreply.github.com>
Date: Tue, 24 May 2022 20:21:11 +0200
Subject: [PATCH] Add Docs about notifications
---
README.md | 84 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
1 file changed, 84 insertions(+)
diff --git a/README.md b/README.md
index 6d47e2af..1f3ed3d4 100644
--- a/README.md
+++ b/README.md
@@ -590,6 +590,90 @@ You may reverse this change by entering the following in the Tasmota console of
Please note: Doing this will mean that if HomeAssistant is not working for any reason your buttons will not function correctly.
+#### Sending Notifications to the Panel
+
+There are two notification types, that can be triggered by sending a command over mqtt to the panel here are examples for homeassistant scripts:
+
+
+Seperate Page
+
+
+ This is the notification used by the backend for updates, opening it requires to the following commands to the CustomSend Topic:
+
+ `pageType popupNotify`
+
+ `entityUpdateDetail~internalName~heading~headingColor~button1text~button1color~button2text~tB2Color~notificationText~textColor~sleepTimeout`
+
+ It is possible to exit from the page by sending `exitPopup`
+
+Send Message to the Panel combined with a buzzer sound:
+
+ ```yaml
+nspanel_popup_notification:
+ alias: Popup Notification
+ sequence:
+ - service: mqtt.publish
+ data:
+ topic: cmnd/tasmota_NsPanelTerrasse/Backlog
+ payload: CustomSend pageType~popupNotify; CustomSend entityUpdateDetail~id~{{
+ title }}~65535~~~~~{{ message }}~65535~{{ timeout }}; Buzzer 2,2,2
+ mode: single
+ icon: mdi:message-badge
+ ```
+
+Send Message to the Panel:
+
+ ```yaml
+nspanel_popup_notification:
+ alias: Popup Notification
+ sequence:
+ - service: mqtt.publish
+ data:
+ topic: cmnd/tasmota_NsPanelTerrasse/Backlog
+ payload: CustomSend pageType~popupNotify; CustomSend entityUpdateDetail~id~{{
+ title }}~65535~~~~~{{ message }}~65535~{{ timeout }}
+ mode: single
+ icon: mdi:message-badge
+ ```
+
+
+
+
+Notification on screensaver
+
+
+ The screensaver can display Notifications by sending this command to the CustomSend topic: `notify~heading~text`
+
+
+Send Message to the Screensaver combined with a buzzer sound:
+
+ ```yaml
+nspanel_screensaver_notification:
+ alias: Screensaver Notification
+ sequence:
+ - service: mqtt.publish
+ data:
+ topic: cmnd/tasmota_NsPanelTerrasse/Backlog
+ payload: CustomSend notify~{{ heading }}~{{ message }}; Buzzer 2,2,2
+ mode: single
+ icon: mdi:message-badge
+ ```
+
+Send Message to the Panel:
+
+ ```yaml
+nspanel_screensaver_notification:
+ alias: Screensaver Notification
+ sequence:
+ - service: mqtt.publish
+ data:
+ topic: cmnd/tasmota_NsPanelTerrasse/Backlog
+ payload: CustomSend notify~{{ heading }}~{{ message }}
+ mode: single
+ icon: mdi:message-badge
+ ```
+
+
## How to update