Merge branch 'joBr99:main' into main

README.md

@@ -16,7 +16,7 @@ Or an TypeScript on your ioBroker Instance in case you are an ioBroker User.
 
 NsPanel needs to be flashed with Tasmota (or upcoming with ESPHome)
 
-![nspanel-rl](doc-pics/nspanel-rl.png)
+![nspanel-rl](docs/img/nspanel-rl.png)
 
 ## Features
 

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

@@ -80,8 +80,8 @@ class LuiBackendConfig(object):
             'locale': "en_US",
             'timeFormat': "%H:%M",
             'dateFormatBabel': "full",
-            'dateAdditonalTemplate': "",
+            'dateAdditionalTemplate': "",
-            'timeAdditonalTemplate': "",
+            'timeAdditionalTemplate': "",
             'dateFormat': "%A, %d. %B %Y",
             'cards': [{
                 'type': 'cardEntities',

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

@@ -42,7 +42,7 @@ class LuiPagesGen(object):
 
     def update_time(self, kwargs):
         time = datetime.datetime.now().strftime(self._config.get("timeFormat"))
-        addTemplate = self._config.get("timeAdditonalTemplate")
+        addTemplate = self._config.get("timeAdditionalTemplate")
         addTimeText = self._ha_api.render_template(addTemplate)
         self._send_mqtt_msg(f"time~{time}~{addTimeText}")
 
@@ -55,7 +55,7 @@ class LuiPagesGen(object):
             dateformat = self._config.get("dateFormat")
             date = datetime.datetime.now().strftime(dateformat)
             
-        addTemplate = self._config.get("dateAdditonalTemplate")
+        addTemplate = self._config.get("dateAdditionalTemplate")
         addDateText = self._ha_api.render_template(addTemplate)
         self._send_mqtt_msg(f"date~{date}{addDateText}")
 
@@ -234,7 +234,7 @@ class LuiPagesGen(object):
             unit_of_measurement = entity.attributes.get("unit_of_measurement", "")
             value = entity.state + " " + unit_of_measurement
             if cardType == "cardGrid" and entityType == "sensor":
-                icon_id = entity.state[:4]
+                icon_id = entity.state[:3]
                 if icon_id[-1] == ".":
                     icon_id = icon_id[:-1]
             else:
@@ -251,8 +251,9 @@ class LuiPagesGen(object):
             return f"~button~{entityId}~{icon_id}~17299~{name}~{text}"
         if entityType == "script":
             icon_id = get_icon_id_ha("script", overwrite=icon)
+            icon_color = self.get_entity_color(entity, overwrite=colorOverride)
             text = get_translation(self._locale, "frontend.ui.card.script.run")
-            return f"~button~{entityId}~{icon_id}~17299~{name}~{text}"
+            return f"~button~{entityId}~{icon_id}~{icon_color}~{name}~{text}"
         if entityType == "lock":
             icon_id = get_icon_id_ha("lock", state=entity.state, overwrite=icon)
             icon_color = self.get_entity_color(entity, overwrite=colorOverride)

docs/card-media.md

@@ -1,4 +1,4 @@
-# Alarm Card
+# Media Card
 
 ![card-media](img/card-media.png)
 
@@ -16,4 +16,4 @@ key | optional | type | default | description
 `title` | True | string | `None` | Title of the Page 
 `entity` | False | string | `None` | contains the entity of the current card
 `key` | True | string | `None` | Used by navigate items
-`alarmControl` | True | complex | `None` | overwrites the action executed on pressing the left bottom icon, by default this button is used to show a list of open sensors on a failed attempt to arm.
+`mediaControl` | True | complex | `None` | overwrites the action executed on pressing the left upper icon (red circle), icon is showing the current type of media and cannot be changed

docs/config-overview.md

@@ -62,8 +62,8 @@ key | optional | type | default | description
 `locale` | True | string | `en_US` | Used by babel to determinante Date format on screensaver, also used for localization.
 `dateFormatBabel` | True | string | `full` | formatting options on https://babel.pocoo.org/en/latest/dates.html?highlight=name%20of%20day#date-fields
 `timeFormat` | True | string | `%H:%M` | Time Format on screensaver. Substring after `?` is displayed in a seperate smaller textbox. Useful for 12h time format with AM/PM  <pre>`"%I:%M   ?%p"`</pre>
-`dateAdditonalTemplate` | True | string | `""` | Addional Text dispayed after Date, can contain a Homeassistant Template Example `" - {{ states('sun.sun') }}"`
+`dateAdditionalTemplate` | True | string | `""` | Addional Text dispayed after Date, can contain a Homeassistant Template Example `" - {{ states('sun.sun') }}"`
-`timeAdditonalTemplate` | True | string | `""` | Addional Text dispayed below Time, can contain a Homeassistant Template
+`timeAdditionalTemplate` | True | string | `""` | Addional Text dispayed below Time, can contain a Homeassistant Template
 `dateFormat` | True | string | `%A, %d. %B %Y` | date format used if babel is not installed
 `cards` | False | complex | | configuration for cards that are displayed on panel; see docs for cards
 `screensaver` | True | complex | | configuration for screensaver; see docs for screensaver

docs/entities.md

@@ -36,7 +36,7 @@ It is also possible to configure different icon overwrites per state:
                 "off": mdi:lightbulb
 ```
 
-# Hide item based on state
+## Hide item based on state
 
 This sensor will only be shown on the card if it's state is equal to `off`
 

ioBroker/NsPanelTs.ts

@@ -13,11 +13,8 @@ ReleaseNotes:
         - 08.05.2022 - Menüpfeile bei HardwareButtons (button1Page; button2Page) mit Navigation auf Page 0
         - 08.05.2022 - Standard-Brightness über neuen Parameter active einstellbar (Test mit 2.9.3)
         - 08.05.2022 - Schalter (Licht, Dimmer, Hue, etc) in cardGrid lassen sich wieder schalten
-        - 13.06.2022 - GitHub Issue #277 - HandleMessage -> pageOpenDetail does not work for Sub-Page
+        - 14.06.2022 - Aktion auf Submenüs schaltet unmittelbar auf vorheriges Mainmenu (Many thanks to Grrzzz)
- 
+        - 14.06.2022 - Menü-Pfeile in Subpages (z.B. card QR, cardMedia, etc) (Many thanks to Grrzzz)
-    Known-Bugs --> Bugfix folgt:
-        - Aktion auf Submenüs schaltet unmittelbar auf vorheriges Mainmenu
-        - Menü-Pfeile in Subpages (z.B. card QR, cardMedia, etc)
     
 Wenn Rule definiert, dann können die Hardware-Tasten ebenfalls für Seitensteuerung (dann nicht mehr als Releais) genutzt werden
 Tasmota Konsole: 
@@ -180,6 +177,7 @@ var Test_Licht: PageEntities =
     "heading": "Color Aliase",
     "useColor": true,
     "subPage": false,
+    "parent": Test_Licht,
     "items": [
         <PageItem>{ id: "alias.0.NSPanel_1.TestRGBLichteinzeln", name: "RGB-Licht Hex-Color", interpolateColor: true},
         //<PageItem>{ id: "alias.0.NSPanel_1.TestFarbtemperatur", name: "Farbtemperatur", interpolateColor: true},
@@ -195,6 +193,7 @@ var Test_Funktionen: PageEntities =
     "heading": "Sonstige Aliase",
     "useColor": true,
     "subPage": false,
+    "parent": Test_Funktionen,
     "items": [
         <PageItem>{ id: "alias.0.NSPanel_1.TestLautstärke", offColor: MSRed /*if mute=true*/, onColor: MSGreen ,name: "Echo Spot Büro", minValue: 0, maxValue: 100},
         <PageItem>{ id: "alias.0.NSPanel_1.TestTemperatur",name: "Temperatur außen", icon: "thermometer", onColor: White},
@@ -209,6 +208,7 @@ var Buero_Seite_1: PageEntities =
     "heading": "Büro",
     "useColor": true,
     "subPage": false,
+    "parent": Buero_Seite_1,
     "items": [
         <PageItem>{ id: "alias.0.NSPanel_1.Schreibtischlampe", interpolateColor: true},
         <PageItem>{ id: "alias.0.NSPanel_1.Deckenbeleuchtung", interpolateColor: true},
@@ -223,6 +223,7 @@ var Fenster_1: PageEntities =
     "heading": "Fenster und Türen",
     "useColor": true,
     "subPage": false,
+    "parent": Fenster_1,
     "items": [
         <PageItem>{ id: "alias.0.NSPanel_1.TestFenster", offColor: MSRed, onColor: MSGreen, name: "Büro Fenster"},
         <PageItem>{ id: "alias.0.NSPanel_1.Haustuer", offColor: MSRed, onColor: MSGreen, name: "Haustür"},
@@ -237,6 +238,7 @@ var Button_1: PageEntities =
     "heading": "Button Aliase",
     "useColor": true,
     "subPage": false,
+    "parent": Button_1,
     "items": [
         <PageItem>{ id: "alias.0.NSPanel_1.TestTastensensor", name: "Tastensensor (FFN)"},
         <PageItem>{ id: "alias.0.NSPanel_1.Radio.NDR2", icon: "radio", name: "Taste (NDR2)", onColor: colorRadio},
@@ -249,6 +251,7 @@ var Subpages_1: PageEntities =
     "heading": "Test Subpages",
     "useColor": true,
     "subPage": false,
+    "parent": Subpages_1,
     "items": [
         <PageItem>{ navigate: true, id: "Abfall", onColor: White, name: "Abfallkalender"},
         <PageItem>{ navigate: true, id: "WLAN", onColor: White, name: "Gäste WLAN"},
@@ -262,6 +265,7 @@ var Abfall: PageEntities =
     "heading": "Abfallkalender",
     "useColor": true,
     "subPage": true,
+    "parent": Subpages_1,
     "items": [
         <PageItem>{ id: "alias.0.NSPanel_1.Abfall.event1",icon: "trash-can"},
         <PageItem>{ id: "alias.0.NSPanel_1.Abfall.event2",icon: "trash-can"},
@@ -276,6 +280,7 @@ var Buero_Seite_2: PageGrid =
     "heading": "Büro 2",
     "useColor": true,
     "subPage": false,
+    "parent": Buero_Seite_2,
     "items": [
         <PageItem>{ id: "alias.0.NSPanel_1.Schreibtischlampe", name: "Schreibtisch"},
         <PageItem>{ id: "alias.0.NSPanel_1.Deckenbeleuchtung", name: "Deckenlampe"},
@@ -292,6 +297,7 @@ var Alexa: PageMedia =
     "heading": "Alexa",
     "useColor": true,
     "subPage": false,
+    "parent": Alexa,
     "items": [<PageItem>{ id: "alias.0.NSPanel_1.Alexa.PlayerBuero" }]
 };
 
@@ -301,6 +307,7 @@ var Buero_Themostat: PageThermo =
     "heading": "Test Thermostat",
     "useColor": true,
     "subPage": false,
+    "parent": Buero_Themostat,
     "items": [<PageItem>{ id: "alias.0.NSPanel_1.Thermostat_Büro", minValue: 50, maxValue: 300 }]
 };
 
@@ -310,6 +317,7 @@ var Buero_Klimaanlage: PageThermo =
     "heading": "Test Klimaanlage",
     "useColor": true,
     "subPage": false,
+    "parent": Buero_Klimaanlage,
     "items": [<PageItem>{ id: "alias.0.NSPanel_1.TestKlimaanlage", minValue: 170, maxValue: 250}]
 };
 
@@ -320,6 +328,7 @@ var WLAN: PageQR =
     "heading": "Gäste WLAN",
     "useColor": true,
     "subPage": true,
+    "parent": WLAN,
     "items": [<PageItem>{ id: "alias.0.NSPanel_1.Guest_Wifi" }]
 };
 
@@ -329,6 +338,7 @@ var Buero_Alarm: PageAlarm =
     "heading": "Alarm",
     "useColor": true,
     "subPage": false,
+    "parent": Buero_Alarm,
     "items": [<PageItem>{ id: "alias.0.NSPanel_1.Alarm" }]
 };
 
@@ -338,6 +348,7 @@ var button1Page: PageGrid =
     "heading": "Radio",
     "useColor": true,
     "subPage": false,
+    "parent": button1Page,
     "items": [
         <PageItem>{ id: "alias.0.NSPanel_1.Radio.FFN", icon: "radio", name: "FFN", onColor: colorRadio},
         <PageItem>{ id: "alias.0.NSPanel_1.Radio.Antenne" , icon: "radio", name: "Antenne Nds.", onColor: colorRadio},
@@ -354,6 +365,7 @@ var button2Page: PageEntities =
     "heading": "Büro",
     "useColor": true,
     "subPage": false,
+    "parent": button2Page,
     "items": [
         <PageItem>{ id: "alias.0.NSPanel_1.Schreibtischlampe"},
         <PageItem>{ id: "alias.0.NSPanel_1.Deckenbeleuchtung"}
@@ -367,6 +379,7 @@ var Service: PageEntities =
     "heading": "NSPanel Service",
     "useColor": true,
     "subPage": false,
+    "parent": Service,
     "items": [
         <PageItem>{ id: "alias.0.NSPanel_1.NSPanel_AutoUpdate", name: "Auto-Updates" ,icon: "update", offColor: MSRed, onColor: MSGreen},
         <PageItem>{ navigate: true, id: "NSPanel_Infos", icon: "information-outline", onColor: White, name: "NSPanel Infos"},
@@ -382,6 +395,7 @@ var NSPanel_Infos: PageEntities =
     "heading": "NSPanel Infos",
     "useColor": true,
     "subPage": true,
+    "parent": Service,
     "items": [
         <PageItem>{ id: "alias.0.NSPanel_1.NSPanel_Hardware", name: "Hardware", icon: "memory", offColor: MSYellow, onColor: MSYellow, useColor: true},
         <PageItem>{ id: "alias.0.NSPanel_1.NSPanel_ESP_Temp", name: "ESP Temperatur", icon: "thermometer", unit: "°C", offColor: MSYellow, onColor: MSYellow, useColor: true},
@@ -397,6 +411,7 @@ var NSPanel_Einstellungen: PageEntities =
     "heading": "Screensaver",
     "useColor": true,
     "subPage": true,
+    "parent": Service,
     "items": [
         <PageItem>{ id: "alias.0.NSPanel_1.Dimmode_BrightnessDay", name: "Brightness Tag", icon: "brightness-5", offColor: MSYellow, onColor: MSYellow, useColor: true, minValue: 5, maxValue: 10},
         <PageItem>{ id: "alias.0.NSPanel_1.Dimmode_BrightnessNight", name: "Brightness Nacht", icon: "brightness-4", offColor: MSYellow, onColor: MSYellow, useColor: true, minValue: 0, maxValue: 4},
@@ -412,6 +427,7 @@ var NSPanel_Firmware_Updates: PageEntities =
     "heading": "Firmware-Updates",
     "useColor": true,
     "subPage": true,
+    "parent": Service,
     "items": [
         <PageItem>{ id: "alias.0.NSPanel_1.Tasmota_Version", name: "Tasmota Firmware", useColor: true},
         <PageItem>{ id: "alias.0.NSPanel_1.TFT_Firmware", name: "TFT-Firmware", useColor: true},
@@ -494,7 +510,7 @@ var screensaverEnabled : boolean = false;
 var pageId = 0;
 
 //Neu für Subpages
-var subPage_open = false;
+var activePage = undefined;
 
 schedule("* * * * *", function () {
     SendTime();
@@ -849,21 +865,9 @@ function HandleMessage(typ: string, method: string, page: number, words: Array<s
             case "pageOpenDetail":
                 screensaverEnabled = false;
                 UnsubscribeWatcher();
-                let pageItem = config.pages[pageId].items.find(e => e.id === words[3]);
+                let pageItem = findPageItem(words[3]);  
                 if (pageItem !== undefined)
                     SendToPanel(GenerateDetailPage(words[2], pageItem));                                         
-                else {
-                    config.subPages.every (sp => {
-                        let pageItem =  sp.items.find(e => e.id === words[3]);
-                        if (pageItem !== undefined) {
-                            SendToPanel(GenerateDetailPage(words[2], pageItem));
-                            console.log(words[2] + " - " + pageItem);
-                            return false;
-                        }
-                        return true;
-                        }
-                    )
-                }  
             case "buttonPress2":
                 screensaverEnabled = false;
                 HandleButtonEvent(words);
@@ -879,6 +883,23 @@ function HandleMessage(typ: string, method: string, page: number, words: Array<s
     }
 }
 
+function findPageItem(searching: String) : PageItem {
+    let pageItem = config.pages[pageId].items.find(e => e.id === searching);
+    
+    if (pageItem !== undefined) {
+        return pageItem;
+    }
+    config.subPages.every (sp => {
+        pageItem =  sp.items.find(e => e.id === searching);
+        if (pageItem !== undefined) {           
+            return false;
+        }
+        return true;
+    });   
+    
+    return pageItem;
+}
+
 function GeneratePage(page: Page): void {
     switch (page.type) {
         case "cardEntities":
@@ -976,6 +997,7 @@ function GenerateGridPage(page: PageGrid): Payload[] {
 }
 
 function GeneratePageElements(page: Page): string {
+    activePage = page;
     let maxItems = 0;
     switch (page.type) {
         case "cardThermo":
@@ -1000,22 +1022,10 @@ function GeneratePageElements(page: Page): string {
 
     let pageData = "entityUpd~" + page.heading + "~" + GetNavigationString(pageId);
 
-//--------------------------------------Subpage----------------
-    if (page.subPage) {
-        subPage_open = true;
-        pageData = "entityUpd~" + page.heading + "~" + "1|0";
-    } 
-//---------------------------------------------------------    
     for (let index = 0; index < maxItems; index++) {
         if (page.items[index] !== undefined) {
             pageData += CreateEntity(page.items[index], index + 1, page.useColor);
         }
-/*
-        else {
-            pageData += CreateEntity(<PageItem>{ id: "delete" }, index + 1); 
-            //muss das wirklich? Wo erforderlich wird es mitgegeben!
-        }
-*/
     }
     return pageData;
 }
@@ -1278,6 +1288,7 @@ function CreateEntity(pageItem: PageItem, placeId: number, useColors: boolean =
                         iconColor = GetIconColor(pageItem, false, useColors);
                         var lockState = "LOCK"
                     }
+                    lockState = pageItem.buttonText !== undefined ? pageItem.buttonText : lockState;
                     RegisterEntityWatcher(pageItem.id + ".ACTUAL");
                 }
 
@@ -1369,7 +1380,7 @@ function GetIconColor(pageItem: PageItem, value: (boolean | number), useColors:
 }
 
 function RegisterEntityWatcher(id: string): void {
-    if (subscriptions.hasOwnProperty(id)) {
+    if (subscriptions.hasOwnProperty(id) || activePage.subPage ) {
         return;
     }
     subscriptions[id] = (on({ id: id, change: 'any' }, function (data) {
@@ -1788,6 +1799,8 @@ function GenerateAlarmPage(page: PageAlarm): Payload[] {
 }
 
 function GenerateQRPage(page: PageQR): Payload[] {
+    activePage = page;
+    
     var id = page.items[0].id
     var out_msgs: Array<Payload> = [];
     out_msgs.push({ payload: "pageType~cardQR" });
@@ -1897,14 +1910,19 @@ function HandleButtonEvent(words): void {
             var pageNum = ((pageId - 1) % config.pages.length);
             pageId = Math.abs(pageNum);          
             UnsubscribeWatcher();            
-            GeneratePage(config.pages[pageId]);
+            if(activePage!=undefined && activePage.parent!=undefined) {                                    
-
+                //update pageID
-//-------------Subpage
+                for (let i=0; i<config.pages.length; i++) {
-            if (subPage_open) {
+                    if(config.pages[i] == activePage.parent) {
-                subPage_open = false;
+                        pageId = i;
-                HandleButtonEvent(['event','buttonPress2','cardEntities','bNext'])
+                        break;
+                    }
+                }                
+                GeneratePage(activePage.parent);                                
+            }
+            else {
+                GeneratePage(config.pages[pageId]);                               
             }                      
-//--------------------------------
             break;
         case "bExit":
             if (config.screenSaverDoubleClick) {
@@ -2001,18 +2019,8 @@ function HandleButtonEvent(words): void {
             timeoutSlider = setTimeout(async function () {
                 if (existsObject(id)) { 
                     let o = getObject(id);
-                    let pageItem = config.pages[pageId].items.find(e => e.id === id);
+                    let pageItem = findPageItem(id);
-                    if (pageItem == undefined) {
-                        config.subPages.every (sp => {
-                            pageItem =  sp.items.find(e => e.id === id);
-                            if (pageItem !== undefined) {
                                                                      
-                                return false;
-                            }
-                            return true;
-                            }
-                        )
-                    } 
                     switch (o.common.role) {
                         case "dimmer":                            
                             if (pageItem.minValueBrightness != undefined && pageItem.maxValueBrightness != undefined) {  
@@ -2040,17 +2048,7 @@ function HandleButtonEvent(words): void {
         case "colorTempSlider": // Armilar - Slider tickt verkehrt - Hell = 0 / Dunkel = 100 -> Korrektur
             (function () {if (timeoutSlider) {clearTimeout(timeoutSlider); timeoutSlider = null;}})();
             timeoutSlider = setTimeout(async function () {
-                let pageItem = config.pages[pageId].items.find(e => e.id === id);
+                let pageItem = findPageItem(id);                
-                if (pageItem == undefined) {
-                    config.subPages.every (sp => {
-                        pageItem =  sp.items.find(e => e.id === id);
-                        if (pageItem !== undefined) {                        
-                            return false;
-                        }
-                        return true;
-                        }
-                    )
-                }
                 if (pageItem.minValueColorTemp !== undefined && pageItem.minValueColorTemp !== undefined) {
                     let colorTempK = Math.trunc(scale(parseInt(words[4]), 0, 100, pageItem.minValueColorTemp, pageItem.maxValueColorTemp));
                     setIfExists(id + ".TEMPERATURE", (colorTempK));
@@ -2221,7 +2219,9 @@ function HandleButtonEvent(words): void {
 
 function GetNavigationString(pageId: number): string {
     if (Debug) console.log(pageId);
-    if (Debug) console.log(subPage_open);
+   
+    if(activePage.subPage)
+        return "1|0";
 
     switch (pageId) {
         case 0:
@@ -2864,6 +2864,7 @@ type Page = {
     items: PageItem[],
     useColor: boolean,
     subPage: boolean,
+    parent: Page,
 };
 
 interface PageEntities extends Page {