Merge pull request #298 from Blackymas/beta

v.3.1.0 - New features and US Version

.github/FUNDING.yml

@@ -0,0 +1,13 @@
+# These are supported funding model platforms
+
+github: # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
+patreon: # Replace with a single Patreon username
+open_collective: # Replace with a single Open Collective username
+ko_fi: # Replace with a single Ko-fi username
+tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
+community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
+liberapay: # Replace with a single Liberapay username
+issuehunt: # Replace with a single IssueHunt username
+otechie: # Replace with a single Otechie username
+lfx_crowdfunding: # Replace with a single LFX Crowdfunding project-name e.g., cloud-foundry
+custom: https://www.paypal.com/donate/?hosted_button_id=S974SWQMB8PB2

README.md

@@ -1,5 +1,8 @@
 # NSPanel Custom with HA Blueprint
 
+*You use our NSPanel version and are satisfied with it? Then we would be very happy about a donation to support our project.*
+
+[![Paypal](https://user-images.githubusercontent.com/41958506/212499642-b2fd097a-0938-4bfc-b37b-74df64592c58.png)](https://www.paypal.com/donate/?hosted_button_id=S974SWQMB8PB2)
 
 [![Open your Home Assistant instance and show the blueprint import dialog with a specific blueprint pre-filled.](https://my.home-assistant.io/badges/blueprint_import.svg)](https://my.home-assistant.io/redirect/blueprint_import/?blueprint_url=https%3A%2F%2Fgithub.com%2FBlackymas%2FNSPanel_HA_Blueprint%2Fblob%2Fmain%2Fnspanel_blueprint.yaml)
 
@@ -13,6 +16,8 @@ The goal was to create a version that allows everyone to use the NSpanel fully l
 
 📕 Full documentation and installation is available here [NSPanel Configuration, Setup and HowTo](https://github.com/Blackymas/NSPanel_HA_Blueprint/wiki).
 
+📌 Step by Step - [Setup and Overview Video´s](https://github.com/Blackymas/NSPanel_HA_Blueprint/wiki)
+
 🚀 How to create "Issues" when I have a problem [WIKI HowTo](https://github.com/Blackymas/NSPanel_HA_Blueprint/wiki)
 
 ⭐ All Feature Requests can be found here [All Feature Request](https://github.com/Blackymas/NSPanel_HA_Blueprint/labels/new%20feature%20request)
@@ -24,8 +29,11 @@ The goal was to create a version that allows everyone to use the NSpanel fully l
 🙋 WE ARE LOOKING FOR YOU! _**We are always looking for people who would like to support this project. We are looking for help with "programming new features, writing documentation or translating documentation to EN. If you are interested then please contact us :)**_
 
 ## NSPanel:
-![2 Home](https://user-images.githubusercontent.com/41958506/203653897-cf96a7af-2b92-4ad9-a375-987decad5aa7.png)
+![2 Home](https://user-images.githubusercontent.com/41958506/212768891-9610d800-43c5-454f-a8b6-6b7c43677b5d.png)
+
+
 ![3 Buttonpage](https://user-images.githubusercontent.com/41958506/203654022-c6d81263-ce56-4a84-917a-9d4911f19f55.png)
+![NEW Domains](https://user-images.githubusercontent.com/41958506/206879659-3aea30c1-b126-4d52-a869-abf6adfc8fa1.png)
 
 (Home and Buttonpage)
 

nspanel_esphome.yaml

@@ -124,6 +124,14 @@ api:
     - service: upload_tft
       then:
         - lambda: 'id(disp1)->upload_tft();'
+
+    ##### SERVICE TO UPDATE THE TFT FILE from URL #####
+    - service: upload_tft_url
+      variables:
+        url: string
+      then:
+        - lambda: 'id(disp1)->set_tft_url(url.c_str());'
+        - lambda: 'id(disp1)->upload_tft();'
             
     ##### Service to send a command "printf" directly to the display #####
     - service: send_command_printf
@@ -179,6 +187,7 @@ api:
         - wait_until:
               switch.is_on: nextion_init
         - lambda: 'id(disp1).set_component_font_color(component.c_str(), message);'
+    
     ##### Service to send a command "background color" directly to the display #####
     - service: send_command_background_color
       variables:
@@ -189,6 +198,57 @@ api:
               switch.is_on: nextion_init
         - lambda: 'id(disp1).set_component_background_color(component.c_str(), message);'
 
+    ##### Service to show a notification-message on the screen #####
+    - service: notification_show
+      variables:
+        label: string
+        text: string
+      then:
+        - wait_until:
+              switch.is_on: nextion_init
+        - lambda: |-
+            id(disp1).send_command_printf("page notification");
+            id(disp1).set_component_text_printf("notification.notifi_label", "%s", label.c_str());
+            id(disp1).set_component_text_printf("notification.notifi_text01", "%s", text.c_str());
+            id(notification_label).publish_state(label.c_str());
+            id(notification_text).publish_state(text.c_str());
+        - switch.turn_on: notification_unread
+        - if:
+            condition:
+              switch.is_on: notification_sound
+            then:
+              - rtttl.play: "two short:d=4,o=5,b=100:16e6,16e6"
+
+    ##### Service to clear the notification #####
+    - service: notification_clear
+      then:
+        - wait_until:
+              switch.is_on: nextion_init
+        - lambda: |-
+            id(notification_label).publish_state("");
+            id(notification_text).publish_state("");
+        - switch.turn_off: notification_unread
+
+    ##### Service to play a rtttl tones #####
+    # Example tones : https://codebender.cc/sketch:109888#RTTTL%20Songs.ino
+    - service: play_rtttl
+      variables:
+        song_str: string
+      then:
+        - rtttl.play:
+            rtttl: !lambda 'return song_str;'    
+
+    # Service to show a QR code on the display (ex. for WiFi password)
+    - service: qr_code
+      variables:
+        qrdata: string
+      then:
+        - wait_until:
+              switch.is_on: nextion_init
+        - lambda: |-
+            id(disp1).send_command_printf("page qrcode");
+            id(disp1).set_component_text_printf("qrcode.qrcode_value", "%s", qrdata.c_str());
+
     #### Service to send thermostat cycle state ####
     - service: send_thermostat_cycle_state
       variables:
@@ -198,126 +258,12 @@ api:
               switch.is_on: nextion_init
         - lambda: |-
             //ESP_LOGD("nextion", "thermostat sendig value %f", value);
-            int left=16; // 16 is empty left.
-            int mid=17; // 17 is empty mid.
-            int right=18; // 18 is empty right.
-            if (value < 13.5) {
-              left=16;
-              mid=17;
-              right=18;
-            } else if (value >= 13.5 and value < 14) {
-              left=19;
-              mid=17;
-              right=18;
-            } else if (value >= 14 and value < 14.5) {
-              left=20;
-              mid=17;
-              right=18;
-            } else if (value >= 14.5 and value < 15) {
-              left=21;
-              mid=17;
-              right=18;
-            } else if (value >= 15 and value < 15.5) {
-              left=22;
-              mid=17;
-              right=18;
-            } else if (value >= 15.5 and value < 16) {
-              left=23;
-              mid=17;
-              right=18;
-            } else if (value >= 16 and value < 16.5) {
-              left=24;
-              mid=17;
-              right=18;
-            } else if (value >= 16.5 and value < 17) {
-              left=25;
-              mid=17;
-              right=18;
-            } else if (value >= 17 and value < 17.5) {
-              left=26;
-              mid=17;
-              right=18;
-            } else if (value >= 17.5 and value < 18) {
-              left=27;
-              mid=17;
-              right=18;
-            } else if (value >= 18 and value < 18.5) {
-              left=28;
-              mid=17;
-              right=18;
-            } else if (value >= 18.5 and value < 19) {
-              left=29;
-              mid=30;
-              right=18;
-            } else if (value >= 19 and value < 19.5) {
-              left=29; 
-              mid=31;
-              right=18;
-            } else if (value >= 19.5 and value < 20) {
-              left=29;
-              mid=32;
-              right=18;
-            } else if (value >= 20 and value < 20.5) {
-              left=29;
-              mid=33;
-              right=18;
-            } else if (value >= 20.5 and value < 21) {
-              left=29;
-              mid=34;
-              right=18;
-            } else if (value >= 21 and value < 21.5) {
-              left=29;
-              mid=35;
-              right=18;
-            } else if (value >= 21.5 and value < 22) {
-              left=29;
-              mid=36;
-              right=18;
-            } else if (value >= 22 and value < 22.5) {
-              left=29;
-              mid=37;
-              right=38;
-            } else if (value >= 22.5 and value < 23) {
-              left=29;
-              mid=37;
-              right=39;
-            } else if (value >= 23 and value < 23.5) {
-              left=29;
-              mid=37;
-              right=40;
-            } else if (value >= 23.5 and value < 24) {
-              left=29;
-              mid=37;
-              right=41;
-            } else if (value >= 24 and value < 24.5) {
-              left=29;
-              mid=37;
-              right=42;
-            } else if (value >= 24.5 and value < 25) {
-              left=29;
-              mid=37;
-              right=43;
-            } else if (value >= 25 and value < 25.5) {
-              left=29;
-              mid=37;
-              right=44;
-            } else if (value >= 25.5 and value < 26) {
-              left=29;
-              mid=37;
-              right=45;
-            } else if (value >= 26 and value < 26.5) {
-              left=29;
-              mid=37;
-              right=46;
-            } else if (value >= 26.5 and value < 27) {
-              left=29;
-              mid=37;
-              right=47;
-            } else if (value >= 27) {
-              left=29;
-              mid=37;
-              right=48;
-            }
+            int v = int(2 * std::min(std::max(value - 13.5, 0.0), 5.0));
+            int left = v + (v ? 19 : 16); // 16 is empty left.
+            v = int(2 * std::min(std::max(value - 18.0, 0.0), 4.0));
+            int mid = v + (v ? 29 : 17); // 17 is empty mid.
+            v = int(2 * std::min(std::max(value - 21.5, 0.0), 5.5));
+            int right = v + (v ? 37 : 18); // 18 is empty right.
             // sends the 3 images to the display
             //ESP_LOGD("nextion", "thermostat left %i", left);
             //ESP_LOGD("nextion", "thermostat mid %i", mid);
@@ -381,7 +327,7 @@ globals:
     restore_value: no
     initial_value: ''
 
-  ##### lastclick_ccurrentpage State #####
+  ##### lastclick_currentpage State #####
   - id: currentpage_global
     type: std::string
     restore_value: no
@@ -392,23 +338,135 @@ binary_sensor:
 
   ###### LEFT BUTTON BELOW DISPLAY TO TOGGLE RELAY#####
   - platform: gpio
-    name: ${device_name} Left Button
+    # name: ${device_name} Left Button
+    id: left_button
     pin:
       number: 14
       inverted: true
+    on_click:
+    - min_length: 50ms
+      max_length: 1000ms
+      then:
+        - binary_sensor.template.publish:
+            id: left_button_short
+            state: ON
+        - if:
+            condition:
+              and:
+                  - switch.is_on: relay1_fallback
+                  - not:
+                      api.connected:
+            then:
+              - switch.toggle: relay_1
+              - lambda: id(disp1).send_command_printf("home.icon_top_01.pic=51");
+              - lambda: id(disp1).send_command_printf("home.left_bt_pic.pic=98");
+              - if: 
+                  condition:
+                    switch.is_on: relay_1
+                  then:
+                    - lambda: id(disp1).send_command_printf("home.icon_top_01.pic=105");
+        - delay: 500ms
+        - binary_sensor.template.publish:
+            id: left_button_short
+            state: OFF
+    on_press:
+      then:
+        - lambda: |-
+            if (id(disp1_currentpage).state == "lightsettings" or id(disp1_currentpage).state == "coversettings") {
+              ESP_LOGD("nspanel", "settingspage -> no press");
+            } else {
+              // ESP_LOGD("nspanel", "release button");
+              id(disp1_lastclick_general).set_state("pressbuttonleft",true,true);
+            }
+    on_release:
+      then:
+        - lambda: |-
+            if (id(disp1_currentpage).state == "lightsettings" or id(disp1_currentpage).state == "coversettings") {
+              ESP_LOGD("nspanel", "settingspage -> no release");
+            } else {
+              // ESP_LOGD("nspanel", "release button");
+              id(disp1_lastclick_general).set_state("releasebuttonleft",true,true);
+            }
+
+  - platform: template
+    name: ${device_name} Left Button
+    id: left_button_short
+    lambda: |-
+      return {};
+
 
   ##### RIGHT BUTTON BELOW DISPLAY TO TOGGLE RELAY #####
   - platform: gpio
-    name: ${device_name} Right Button
+    # name: ${device_name} Right Button
+    id: right_button
     pin:
       number: 27
       inverted: true
+    on_click:
+    - min_length: 50ms
+      max_length: 1000ms
+      then:
+        - binary_sensor.template.publish:
+            id: right_button_short
+            state: ON
+        - if:
+            condition:
+              and:
+                  - switch.is_on: relay2_fallback
+                  - not:
+                      api.connected:
+            then:
+              - switch.toggle: relay_2
+              - lambda: id(disp1).send_command_printf("home.icon_top_02.pic=51");
+              - lambda: id(disp1).send_command_printf("home.right_bt_pic.pic=98");
+              - if: 
+                  condition:
+                    switch.is_on: relay_2
+                  then:
+                    - lambda: id(disp1).send_command_printf("home.icon_top_02.pic=106");
+        - delay: 500ms
+        - binary_sensor.template.publish:
+            id: right_button_short
+            state: OFF
+    on_press:
+      then:
+        - lambda: |-
+            if (id(disp1_currentpage).state == "lightsettings" or id(disp1_currentpage).state == "coversettings") {
+              ESP_LOGD("nspanel", "settingspage -> no press");
+            } else {
+              // ESP_LOGD("nspanel", "release button");
+              id(disp1_lastclick_general).set_state("pressbuttonright",true,true);
+            }
+    on_release:
+      then:
+        - lambda: |-
+            if (id(disp1_currentpage).state == "lightsettings" or id(disp1_currentpage).state == "coversettings") {
+              ESP_LOGD("nspanel", "settingspage -> no release");
+            } else {
+              // ESP_LOGD("nspanel", "release button");
+              id(disp1_lastclick_general).set_state("releasebuttonright",true,true);
+            }
 
-  ##### Restart NSPanel Button #####
+  - platform: template
+    name: ${device_name} Right Button
+    id: right_button_short
+    lambda: |-
+      return {};
+
+  ##### Restart NSPanel Button - Setting Page #####
   - platform: nextion
     name: ${device_name} Restart
     page_id: 7
-    component_id: 9
+    component_id: 8
+    internal: true
+    on_click:
+      - button.press: restart_nspanel
+
+  ##### Restart NSPanel Button - Boot Page #####
+  - platform: nextion
+    name: ${device_name} Restart
+    page_id: 8
+    component_id: 5
     internal: true
     on_click:
       - button.press: restart_nspanel
@@ -417,7 +475,7 @@ binary_sensor:
   - platform: nextion
     name: ${device_name} Sleep Modus
     page_id: 7
-    component_id: 4
+    component_id: 3
     internal: true
     on_click:
       - switch.toggle: sleep_modus
@@ -447,21 +505,21 @@ sensor:
     name: ${device_name} RSSI
     update_interval: 60s
 
-  ##### INTERNAL TEMPERATUE SENSOR, ADC VALUE #####
+  ##### INTERNAL TEMPERATURE SENSOR, ADC VALUE #####
   - platform: adc
     id: ntc_source
     pin: 38
-    update_interval: 10s
+    update_interval: 60s
     attenuation: 11db
 
-  ##### INTERNAL TEMPERATUE SENSOR, adc reading converted to resistance (calculation)#####
+  ##### INTERNAL TEMPERATURE SENSOR, adc reading converted to resistance (calculation)#####
   - platform: resistance
     id: resistance_sensor
     sensor: ntc_source
     configuration: DOWNSTREAM
     resistor: 11.2kOhm
 
-  ##### INTERNAL TEMPERATUE SENSOR, resistance to temperature (calculation) #####
+  ##### INTERNAL TEMPERATURE SENSOR, resistance to temperature (calculation) #####
   - platform: ntc
     name: ${device_name} Temperature
     id: temp_nspanel
@@ -472,12 +530,12 @@ sensor:
       reference_resistance: 10kOhm
     filters:
       - lambda: return x + id(temperature_correction_global);
-    on_value:
-      then:
-        - wait_until:
-            switch.is_on: nextion_init
-        - lambda: id(disp1).set_component_text_printf("home.current_temp", "%.1f°", id(temp_nspanel).state); # onboard temp (thermostat temp) to home page.
-        # - lambda: id(disp1).set_component_text_printf("climate.current_temp", "%.1f", id(temp_nspanel).state);
+#    on_value:
+#      then:
+#        - wait_until:
+#            switch.is_on: nextion_init
+#         - lambda: id(disp1).set_component_text_printf("home.current_temp", "%.1f°", id(temp_nspanel).state); # onboard temp (thermostat temp) to home page.
+#         - lambda: id(disp1).set_component_text_printf("climate.current_temp", "%.1f", id(temp_nspanel).state);
 
   ##### current value of page-climate target_temp #####
   - platform: template
@@ -542,6 +600,7 @@ text_sensor:
     ip_address:
       name: ${device_name} IP
       disabled_by_default: true
+      id: ip_address
     ssid:
       name: ${device_name} SSID
       disabled_by_default: true
@@ -549,6 +608,14 @@ text_sensor:
       name: ${device_name} BSSID
       disabled_by_default: true
 
+  - platform: template
+    name: ${device_name} Notification Label
+    id: notification_label
+
+  - platform: template
+    name: ${device_name} Notification Text
+    id: notification_text
+
   ##### last click sensor, the main action variable - push to HA #####
   - platform: nextion
     nextion_id: disp1
@@ -569,6 +636,8 @@ text_sensor:
         - globals.set:
             id: lastclick_general_global
             value: !lambda return x;
+        - lambda: |-
+            id(page_timer)->execute(int(id(page_timeout).state));
   
   ##### last click lightsettings page, the main action variable - push to HA #####
   - platform: nextion
@@ -590,6 +659,8 @@ text_sensor:
         - globals.set:
             id: lastclick_lightsettings_global
             value: !lambda return x;
+        - lambda: |-
+            id(page_timer)->execute(int(id(page_timeout).state));
 
   ##### last click coversettings page, the main action variable - push to HA #####
   - platform: nextion
@@ -611,6 +682,8 @@ text_sensor:
         - globals.set:
             id: lastclick_coversettings_global
             value: !lambda return x;
+        - lambda: |-
+            id(page_timer)->execute(int(id(page_timeout).state));
 
   ##### last click climate page, the main action variable - push to HA #####
   - platform: nextion
@@ -632,6 +705,8 @@ text_sensor:
         - globals.set:
             id: lastclick_climatesettings_global
             value: !lambda return x;
+        - lambda: |-
+            id(page_timer)->execute(int(id(page_timeout).state));
 
   ##### currentpage sensor, the main action variable - push to HA #####
   - platform: nextion
@@ -653,6 +728,32 @@ text_sensor:
         - globals.set:
             id: currentpage_global
             value: !lambda return x;
+        - lambda: |-
+            id(page_timer)->execute(int(id(page_timeout).state));
+
+
+  ##### touchevent sensor, Reset the page timeout #####
+  - platform: nextion
+    nextion_id: disp1
+    #name: ${device_name} touchevent
+    id: disp1_touchevent
+    update_interval: 50ms
+    component_name: touchevent
+    internal: true
+    filters:
+      - lambda: |-
+          static std::string touchevent_history = "";
+          if (strcmp(x.c_str(), touchevent_history.c_str()) != 0) {
+            touchevent_history = x;
+            return x;
+            // touchevent_history = "";
+          } else {
+            return {};
+          }
+    on_value:
+      then:
+        - lambda: |-
+            id(page_timer)->execute(int(id(page_timeout).state));
 
 
 ##### START - SWITCH CONFIGURATION #####  
@@ -675,9 +776,33 @@ switch:
     assumed_state: off
     optimistic: true
 
+  ##### Notification unread #####
+  - platform: template
+    name: ${device_name} Notification unread
+    id: notification_unread
+    entity_category: config
+    restore_state: true
+    optimistic: true
+
+  ##### Notification sound #####
+  - platform: template
+    name: ${device_name} Notification sound
+    id: notification_sound
+    entity_category: config
+    restore_state: true
+    optimistic: true
+
+  ##### Confirmation Message #####
+  - platform: template
+    name: ${device_name} Confirmation Message
+    id: confirmation_message
+    entity_category: config
+    restore_state: false
+    optimistic: true
+
   ##### UPDATE TFT DISPLAY #####
   - platform: template
-    name: Update TFT display
+    name: ${device_name} Update TFT display
     id: tft_update
     entity_category: config
     turn_on_action:
@@ -732,6 +857,20 @@ switch:
             value: '1'
       - lambda:  id(disp1).set_component_value("settings.a02",1);
 
+  ##### Relay Local control Fallback #####  
+  - platform: template
+    name: ${device_name} Relay 1 Local Fallback
+    id: relay1_fallback
+    entity_category: config
+    restore_state: true
+    optimistic: true
+
+  - platform: template
+    name: ${device_name} Relay 2 Local Fallback
+    id: relay2_fallback
+    entity_category: config
+    restore_state: true
+    optimistic: true
 
 ##### START - NUMBER CONFIGURATION #####
 number:
@@ -790,6 +929,17 @@ number:
             id: temperature_correction_global
             value: !lambda 'return x;'
 
+##### page-timeout #####
+  - platform: template
+    name: ${device_name} Page Timeout
+    id: page_timeout
+    entity_category: config
+    min_value: 0
+    max_value: 60
+    initial_value: 10
+    step: 1
+    restore_value: true
+    optimistic: true
 
 ##### START - DISPLAY START CONFIGURATION #####
 display:
@@ -799,17 +949,12 @@ display:
     tft_url: ${nextion_update_url}
     on_setup:
       then:
-        - lambda: id(disp1).send_command_printf("page 9"); ##### CHANGE! -  Loading page #####
+        - lambda: id(disp1).send_command_printf("page 8");
+        - lambda: id(disp1).set_component_text_printf("boot.esph_version", "%s", "3.1.0"); ### esphome-version ###
         - wait_until:
             api.connected
+        - lambda: id(disp1).set_component_text_printf("boot.ip_addr", "%s", id(ip_address).state.c_str());
         - delay: 0.5s
-        - rtttl.play: "two short:d=4,o=5,b=100:16e6,16e6"
-        - delay: 0.5s
-        - switch.template.publish:
-            id: nextion_init
-            state: on
-        - lambda: id(disp1).send_command_printf("page 0"); #### home page #####
-        - delay: 2s ##### gives the display time to update other components & set the home page #####
         - number.set:
             id: display_brightness
             value: !lambda 'return id(display_brightness_global);'
@@ -821,9 +966,26 @@ display:
         - lambda: id(disp1).send_command_printf("settings.brightslider.val=%i", id(display_brightness_global));
         - lambda: id(disp1).send_command_printf("settings.dimslider.val=%i", id(display_dim_brightness_global));
         - lambda: id(disp1).send_command_printf("home.sleepmodus.val=%i", id(sleep_modus_global));
-        - lambda: |-
-            id(disp1).set_component_value("settings.a02",0);
-            if (id(sleep_modus_global) == 1) 
-            {
-              id(disp1).set_component_value("settings.a02",1);
-            }
+        - lambda: id(disp1).set_component_value("settings.a02", id(sleep_modus_global) == 1);
+        - delay: 0.5s
+        - switch.template.publish:
+            id: nextion_init
+            state: on
+
+### Script for page_timer
+script:
+  - id: page_timer
+    mode: restart
+    parameters:
+      delay: int
+    then:
+      - lambda: ESP_LOGD("nspanel", "start page-timer delay %i", int(id(page_timeout).state));
+      - delay: !lambda return delay *1000;
+      - lambda: |-
+          if (id(disp1_currentpage).state == "home" or id(disp1_currentpage).state == "screensaver" or id(disp1_currentpage).state == "boot" or int(id(page_timeout).state) == 0) {
+            ESP_LOGD("nspanel", "no page-jump");
+          } else {
+            ESP_LOGD("nspanel", "timer->home");
+            id(disp1).send_command_printf("page 0");
+          }
+