Merge pull request #189 from Blackymas/beta

Release - v.3.0.0

README.md

@@ -1,4 +1,9 @@
 # NSPanel Custom with HA Blueprint
+
+[![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)
+
 This project allows you to configure your complete NSPanel via a Blueprint with UI.
 ### *That means you don't have to customize any code or change any lines in the code.*
 
@@ -7,15 +12,25 @@ And the best thing is, the installation takes only a few minutes.
 
 The goal was to create a version that allows everyone to use the NSpanel fully local without having to deal with programming or reading hours of documentation - *AND YES WE DID IT!!!!* ;)
 
-📕 Full documentation and installation is available here [NSPanel Configuration, Setup and HowTo ](https://github.com/Blackymas/NSPanel_HA_Blueprint/wiki). (coming soon)
+📕 Full documentation and installation is available here [NSPanel Configuration, Setup and HowTo](https://github.com/Blackymas/NSPanel_HA_Blueprint/wiki).
 
+📌 Step by Step - [Setup Video](https://www.youtube.com/watch?v=3afPFg6kUdc)
 
-ℹ️ Version 2.0.0
-    
+🚀 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)
+
+🎉 Roadmap Roadmap can be found here [Roadmap](https://github.com/Blackymas/NSPanel_HA_Blueprint/labels/roadmap)
+
+💥 Please move pull request to DEV branch and not to main branch - thanks!
+
+🙋 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)
+
 ![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)
 
@@ -35,12 +50,20 @@ The goal was to create a version that allows everyone to use the NSpanel fully l
 ![8 Cover](https://user-images.githubusercontent.com/41958506/203654290-c6ec2f2f-7924-492c-914c-0d96dc3907e0.png)
 ![9 Weather](https://user-images.githubusercontent.com/41958506/203654307-24000d00-b7e1-47eb-bd64-9e97b508db52.png)
 
-(Coversetting and Weather Forcast)
+(Coversetting and Weather Forecast)
 
 
 ![10 Settings](https://user-images.githubusercontent.com/41958506/203654386-e4e574ad-8674-4268-84dd-1c4e40f98eb9.png)
+![1 Boot](https://user-images.githubusercontent.com/41958506/203667473-d33523a4-3197-4838-9099-cccebfc727db.png)
 
-(NSPanel Settings)
+(NSPanel Settings and Boot Screen)
+
+
+![Device Setting 1](https://user-images.githubusercontent.com/41958506/203723223-8afc0e44-51cf-49ed-8a49-8ba713716639.png)
+![Device Setting 2](https://user-images.githubusercontent.com/41958506/203724491-53ecd93d-bc7c-4c2d-850b-f106691e2639.png)
+
+
+(HA Device Setting for Example temperature correction)
 
 
 ## Blueprint:
@@ -50,28 +73,28 @@ The goal was to create a version that allows everyone to use the NSpanel fully l
 
 
 ## Features:
-- easy to use and simple configuration via Blueprint - no change in the code is necessary
+- Easy to use and simple configuration via Blueprint - no change in the code is necessary
 - 32 buttons on 4 button pages with long press function for settings (more buttons are also possible)
 - Button design is automatically generated based on the selected entity
 - Buttons show current brightness and cover position in the button itself
 - Buttons label can be assigned via blueprint
-- Weather + 5 days weather forcast
+- Weather + 5 days weather forecast
 - Thermostat + Touch + Relay control for floor heating
-- Light control (brightness-slider, colorwheel, TempColor-slider) - via Long Press
+- Light control (brightness-slider, colorwheel, TempColor-slider) - via long Press
 - Cover control (open, close, position-slider) - via long press
 - Settings page (display brightness, display dim brightness, auto-dim, sleep mode, reboot NSPanel)
 - Swipe between pages
 - Top menu with 10 icons for specific states
 - Heating control (hot water)
-- modern design - design easy to change via Adobe Express (free + design template)
-- 2 pysical switches
+- Modern design - design easy to change via Adobe Express (free + design template)
+- 2 physical switches
 - and much more ;)
 
 
 # Pages
 
 ## Home
-- current weather with button to Weather Forcast page
+- Current weather with button to Weather Forcast page
 - Hardware buttons can be freely assigned
 - Hardware button label or without label
 - Blue line indicates on or off of the entity
@@ -118,8 +141,8 @@ The goal was to create a version that allows everyone to use the NSpanel fully l
 - Hot water button
 
 
-## Weather Forcast
-- 5 days Weather Forcast via swipe (Integration Accuweather - but should also go with another integration)
+## Weather Forecast
+- 5 days Weather Forecast via swipe (Integration Accuweather - but should also go with another integration)
 - Lowest and highest temperature outside
 - Date
 - Rain probability
@@ -150,3 +173,4 @@ Marcfager:  https://github.com/marcfager/nspanel-mf
 lovejoy77: https://github.com/lovejoy777/NSpanel
 
 Hellis81: https://github.com/Hellis81/NS-panel
+

nspanel_esphome.yaml

@@ -11,8 +11,10 @@
   # ## usage of secrets-file ## -> comment in ###### Change ME ######
   # device_name: "nspanel-name" # Wird im Blueprint benötigt!
   # wifi_ssid: !secret nspanel_wifi_ssid # add in your esphome secrets file.
-  # wifi_password: !secret nspanel_wifi_password # add in your esphome secrets file.
-  # ota_password: !secret nspanel_ota_password # add in your esphome secrets file.
+  # wifi_password: !secret nspanel_wifi_password # add in your esphome secrets file. -> per default this is also used for ota_password and web_password
+  # ota_password: !secret nspanel_ota_password # add in your esphome secrets file. - manual change in code required to activate
+  # web_password: !secret nspanel_web_password # add in your esphome secrets file. - manual change in code required to activate
+  # api_password: !secret nspanel_api_password # add in your esphome secrets file. - manual change in code required to activate
   # nextion_update_url: !secret nspanel_update_url # add in your esphome secrets file. Example: "http://"HOME ASSISTANT IP":8123/local/nspanel/nspanel.tft"
 
   # ## static ip config ##
@@ -22,6 +24,11 @@
   # dns: "10.0.0.138"
   # domain: ".local"
 
+##### if you rename this file to .nspanel_esphome.yaml then you can activate nested config
+##### use the ADVANCED CONFIG-Section as device configuration
+##### https://esphome.io/guides/configuration-types.html#yaml-insertion-operator
+# <<: !include .nspanel_esphome.yaml
+
 ##### END OF ADVANCED CONFIGURATION ##############################################################
 
 ##### WIFI SETUP #####
@@ -36,7 +43,7 @@ wifi:
   #   subnet: ${subnet}
   #   dns1: ${dns}
   # domain: ${domain}
-  # Enable fallback hotspot (captive portal) in case wifi connection fails
+  ##### Enable fallback hotspot (captive portal) in case wifi connection fails
   ap:
     ssid: "${device_name}"
     password: ${wifi_password}
@@ -62,11 +69,15 @@ web_server:
   port: 80
   auth:
     username: admin
-    password: ${ota_password}
+    password: ${wifi_password}
+    ##### advanced config - change to use web_password ##### 
+    # password: ${web_password}
 
 ##### OTA PASSWORD #####
 ota:
-  password: ${ota_password}
+  password: ${wifi_password}
+  ##### advanced config - change to use ota_password ##### 
+  # password: ${ota_password}
   safe_mode: true
   reboot_timeout: 3min
   num_attempts: 3
@@ -105,12 +116,22 @@ button:
 
 ##### START - API CONFIGURATION #####
 api:
+  ##### advanced config - activate to use api_password ##### 
+  # password: ${api_password}
   services:
 
     ##### SERVICE TO UPDATE THE HMI FILE #####
     - 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
@@ -166,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:
@@ -176,6 +198,46 @@ 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 send thermostat cycle state ####
     - service: send_thermostat_cycle_state
       variables:
@@ -391,7 +453,7 @@ binary_sensor:
       number: 27
       inverted: true
 
-  ##### Restart NSPanel Button #####
+  ##### Restart NSPanel Button - Setting Page #####
   - platform: nextion
     name: ${device_name} Restart
     page_id: 7
@@ -400,6 +462,15 @@ binary_sensor:
     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
+
   ##### Sleep Modus NSPanel Button #####
   - platform: nextion
     name: ${device_name} Sleep Modus
@@ -459,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
@@ -536,6 +607,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
@@ -662,9 +741,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:
@@ -786,17 +889,10 @@ 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");
         - wait_until:
             api.connected
         - 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);'
@@ -814,3 +910,7 @@ display:
             {
               id(disp1).set_component_value("settings.a02",1);
             }
+        - delay: 0.5s
+        - switch.template.publish:
+            id: nextion_init
+            state: on