h3n3/NSPanel_HA_Blueprint
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

update v.3.2

hollabee
2023-03-20 22:12:44 +01:00
parent fd7f9dabd1
commit 451a87f081
4 changed files with 122 additions and 57 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
(DE)-Blueprint---Einrichtung-und-Erklärung-vom-Blueprint.md

@@ -16,9 +16,11 @@ Es wird der Übersichtlichkeit halber in der folgenden Dokumentation nicht geson
   
# Parameter # Parameter
### ESPhome Node Name ### ESPhome Node Name
Bezieht sich auf den ESPhome-Gerätenamen. **Zulässig sind die Zeichen "__",a-z, 0-9, jedoch keine Sonder- und Leerzeichen**. Dies ist eine Einschränkung seitens HA, da aus dem Device-Name des Blueprints die jeweiligen Entity_IDs generiert werden. Bezieht sich auf den ESPhome-Gerätenamen. **Zulässig sind die Zeichen "__",a-z, 0-9, jedoch keine Sonder- und Leerzeichen**. Dies ist eine Einschränkung seitens HA, da aus dem Device-Name des Blueprints die jeweiligen Entity_IDs generiert werden.
### Language for NSPanel ### Language for NSPanel
Über das Dropdown Menü kann die Sprache ausgewählt werden. Unterstützt werden derzeit 26 Sprachen. Über das Dropdown Menü kann die Sprache ausgewählt werden. Unterstützt werden derzeit 26 Sprachen.
### Delay to avoid synchronization problems ### Delay to avoid synchronization problems
@@ -30,12 +32,15 @@ Es kann bei schlechtem WLAN Signal vorkommen, dass Menüs nicht komplett geladen
## Weather and Temperature ## Weather and Temperature
### Weather Integration ### Weather Integration
Auswahl zwischen der HA Weather Integration oder dem genaueren Accuweather. Auswahl zwischen der HA Weather Integration oder dem genaueren Accuweather.
### Weather entity from HA ### Weather entity from HA
Dropdown Menü zur Auswahl der zu verwendenden Weather Entität. Beispiel: Wenn in Punkt 7 "Accuweather" ausgewählt wird, so muss hier die Entität für Accuweather ausgewählt werden. Dropdown Menü zur Auswahl der zu verwendenden Weather Entität. Beispiel: Wenn in Punkt 7 "Accuweather" ausgewählt wird, so muss hier die Entität für Accuweather ausgewählt werden.
### Outdoor Temperature Sensor (Optional) ### Outdoor Temperature Sensor (Optional)
Optional kann hier der Wert eines Aussentemperatur Sensor verwendet werden. Falls kein separater Sensor verwendet wird, wird der Wert der Wetter-Integration verwendet. Optional kann hier der Wert eines Aussentemperatur Sensor verwendet werden. Falls kein separater Sensor verwendet wird, wird der Wert der Wetter-Integration verwendet.
### Outdoor Temperature Sensor - LABEL COLOR (Optional) ### Outdoor Temperature Sensor - LABEL COLOR (Optional)
@@ -50,7 +55,7 @@ Optional kann hier der Wert eines InnentemperaturSensor verwendet werden. Wird d
## Sensor Home Page ## Sensor Home Page
#### Sensor 01-03 - Entity (Optional) ### Sensor 01-03 - Entity (Optional)
Bis zu drei Sensoren können auf dem Home Screen dargestellt werden. Hierzu die HA Entität auswählen. Bis zu drei Sensoren können auf dem Home Screen dargestellt werden. Hierzu die HA Entität auswählen.
@@ -58,7 +63,7 @@ Bis zu drei Sensoren können auf dem Home Screen dargestellt werden. Hierzu die
## Chips ## Chips
#### Chip 01-07 - Entity (Optional) ### Chip 01-07 - Entity (Optional)
Zur Darstellung von HA Entities auf dem Home Screen. Kann verwendet werden um bspw. den Status eines bestimmten Schalters auf dem NSPanel darzustellen. Zur Darstellung von HA Entities auf dem Home Screen. Kann verwendet werden um bspw. den Status eines bestimmten Schalters auf dem NSPanel darzustellen.
@@ -82,11 +87,11 @@ Optionaler Schalter um bspw. einen Boiler an- bzw. aus zu schalten.
## QR Code ## QR Code
#### Activate QR Code - TRUE/FALSE (Optional) ### Activate QR Code - TRUE/FALSE (Optional)
Aktiviert die QR Code Page sowie den Button auf dem Home Screen. Aktiviert die QR Code Page sowie den Button auf dem Home Screen.
#### QR Code content - VALUE (optional) ### QR Code content - VALUE (optional)
String, der als QR Code dargestellt werden soll. Dies kann ein Text sein, eine URL oder beispielsweise auch für einen vereinfachten Login ins WiFi verwendet werden (hier einfach SSID und Password ersetzen sowie entweder "WPA" oder "WEP" verwenden): String, der als QR Code dargestellt werden soll. Dies kann ein Text sein, eine URL oder beispielsweise auch für einen vereinfachten Login ins WiFi verwendet werden (hier einfach SSID und Password ersetzen sowie entweder "WPA" oder "WEP" verwenden):
@@ -96,27 +101,27 @@ String, der als QR Code dargestellt werden soll. Dies kann ein Text sein, eine U
## Hardware Buttons ## Hardware Buttons
#### Delay for HW-Buttons hold in seconds - VALUE ### Delay for HW-Buttons hold in seconds - VALUE
Einstellung, wie lange ein Button gedrückt bleiben muss, um einen "hold" zu erkennen. Default: 1 Sekunde. Einstellung, wie lange ein Button gedrückt bleiben muss, um einen "hold" zu erkennen. Default: 1 Sekunde.
### Activate Relay x local Fallback (Optional) ### Activate Relay x local Fallback (Optional)
Normalerweise werden die internen Relays über HA getriggert. Ist dieser Menüpunkt aktiviert, so wird das Relay 1 bei betätigen des Linken Hardware Buttons geschaltet, sollte HA offline sein. Normalerweise werden die internen Relays über HA getriggert. Ist dieser Menüpunkt aktiviert, so wird das jeweilige Relays bei betätigen des Linken bzw. Rechten Hardware Buttons geschaltet, sollte HA offline sein.
### Left/Right Hardware Button - Entity (Optional) ### Left/Right Hardware Button - Entity (Optional)
Hier kann die Entitiy ausgewählt werden, welche mit dem linken Hardware Button geschaltet werden soll. Hier kann die Entitiy ausgewählt werden, welche mit dem linken/rechten Hardware Button geschaltet werden soll.
### Left/Right Hardware Button Name - Label (Optional) ### Left/Right Hardware Button Name - Label (Optional)
Text auf dem Screen über dem linken Hardware Button (Home Screen) Text auf dem Screen über dem jeweiligen Hardware Button (Home Screen)
#### Left/Right Hardware Button hold assignment - VALUE (optional) ### Left/Right Hardware Button hold assignment - VALUE (optional)
Auswahl, welche Action passieren soll, wenn der Button länger gedrückt bleibt. Auswahl, welche Action passieren soll, wenn der Button länger gedrückt bleibt.
#### Left/Right Hardware Button custom hold action - VALUE (Optional) ### Left/Right Hardware Button custom hold action - VALUE (Optional)
Auswahl der zu startenden Action beim Halten des Buttons. Auswahl der zu startenden Action beim Halten des Buttons.
@@ -125,6 +130,7 @@ Auswahl der zu startenden Action beim Halten des Buttons.
## Button Page 01-04 ## Button Page 01-04
### Button Page 01-04 name - LABEL (Optional) ### Button Page 01-04 name - LABEL (Optional)
Text auf den jeweiligen Button Screens. Text auf den jeweiligen Button Screens.
### Buttons 01 - 32 (Optional) ### Buttons 01 - 32 (Optional)
@@ -165,7 +171,7 @@ Alle Buttons bieten die Möglichkeit, die Ausführung der Aktion optional bestä
Hiermit können die Entity Pages auf dem Home Screen aktiviert werden. Diese können verwendet werden, um bspw. Werte oder Status von Entitäten auf den einzelnen Pages darzustellen. Hiermit können die Entity Pages auf dem Home Screen aktiviert werden. Diese können verwendet werden, um bspw. Werte oder Status von Entitäten auf den einzelnen Pages darzustellen.
#### Entity Page 01-04 name - LABEL (Optional) ### Entity Page 01-04 name - LABEL (Optional)
Text auf den jeweiligen Entity Screens. Text auf den jeweiligen Entity Screens.

6
(DE)-HowTo---Alle-wichtigen-Dinge-die-man-wissen-sollte.md

@@ -96,6 +96,8 @@ use_blueprint:
>Derzeit bietet HA nicht die Möglichkeit, Blueprints direkt über das UI upzudaten. Dies muss manuell bspw. über den File Editor geschehen. >Derzeit bietet HA nicht die Möglichkeit, Blueprints direkt über das UI upzudaten. Dies muss manuell bspw. über den File Editor geschehen.
>WICHTIG! Um eine neue Version des NSPanels zu installieren, muss zwingend der Blueprint, ESPHome sowie das TFT upgedatet werden!
1. Letztes Release des Blueprints von Github aus dem Repository laden. 1. Letztes Release des Blueprints von Github aus dem Repository laden.
2. Das existierende YAML File "nspanel_blueprint.yaml" im Folder ***./config/blueprints/automation/Blackymas*** mit der neuen Version ersetzen. 2. Das existierende YAML File "nspanel_blueprint.yaml" im Folder ***./config/blueprints/automation/Blackymas*** mit der neuen Version ersetzen.
3. Automationen neu laden oder Home Assistant neu starten. 3. Automationen neu laden oder Home Assistant neu starten.
@@ -106,6 +108,8 @@ use_blueprint:
## 3. Update ESPHome ## 3. Update ESPHome
>WICHTIG! Um eine neue Version des NSPanels zu installieren, muss zwingend der Blueprint, ESPHome sowie das TFT upgedatet werden!
Zum ESPHome Update auf die ESPHome Integration gehen. Zum ESPHome Update auf die ESPHome Integration gehen.
Dann die Konfiguration validieren: Dann die Konfiguration validieren:
@@ -128,6 +132,8 @@ Danach startet der Installationsvorgang. Dies kann ein paar Minuten in Anspruch
## 4. Update TFT ## 4. Update TFT
>WICHTIG! Um eine neue Version des NSPanels zu installieren, muss zwingend der Blueprint, ESPHome sowie das TFT upgedatet werden!
Das Update des Displays kann über das UI erfolgen: Das Update des Displays kann über das UI erfolgen:
1. Im Menü ***Einstellungen --> Geräte & Services --> Integrationen*** unter der ESPHome Integration das Display auswählen. 1. Im Menü ***Einstellungen --> Geräte & Services --> Integrationen*** unter der ESPHome Integration das Display auswählen.

139
(EN)-Blueprint---Setup-and-Description-of-the-Blueprint.md

@@ -3,36 +3,37 @@ This article covers the settings in the Blueprint Automation.
The Blueprint Automation is the central configuration element of this solution for the NSPanel.  The Blueprint Automation is the central configuration element of this solution for the NSPanel. 
In principle, the setup of the automation is self-explanatory. The individual elements of the Blueprint are described below. In principle, the setup of the automation is self-explanatory. The individual elements of the Blueprint are described below.
  It is possible to change both the color of the labels and the icons for most of the elements on each screen.
Default color is "65535". The desired Nextion color code can be found at
``https://nodtem66.github.io/nextion-hmi-color-convert/index.html``
The icons under the following link can be used:
``https://htmlpreview.github.io/?https://github.com/jobr99/Generate-HASP-Fonts/blob/master/cheatsheet.html``
For an easier overview, the menu items "Icon Color" and "Label Color" will not be described separately in the following documentation.
 
# Parameters # Parameters
### ESPhome Node Name ### ESPhome Node Name
Refers to the ESPhome device name. **Allowed characters are "__",a-z, 0-9, but no special characters or spaces**. This is a restriction on the side of HA, since the respective entity_IDs are generated from the device name of the blueprint. Refers to the ESPhome device name. **Allowed characters are "__",a-z, 0-9, but no special characters or spaces**. This is a restriction on the side of HA, since the respective entity_IDs are generated from the device name of the blueprint.
### Language of NSPanel ### Language for NSPanel
The language can be selected via the drop-down menu. Currently 26 languages are supported. The language can be selected via the drop-down menu. Currently 26 languages are supported.
### Nextion TFT File Folder ### Delay to avoid synchronization problems
Can be left blank. However, it is required if a custom TFT configuration is to be used.
### Delay
If the WiFi signal is poor, menus may not be loaded completely. If this happens, a delay in 5ms increments can be set here to compensate for this. If the WiFi signal is poor, menus may not be loaded completely. If this happens, a delay in 5ms increments can be set here to compensate for this.
### Synchronization of all values (Optional)
Light and cover pages (values) are updated continuously (may cause flickering).
### Synchronization of all all sliders (Optional) ## Weather and Temperature
Light and cover pages (cover position) are updated continuously (may cause flickering).
### Weather integration ### Weather integration
Choose between HA own weather integration or the more accurate Accuweather. Choose between HA own weather integration or the more accurate Accuweather.
### Weather entity from HA ### Weather entity from HA
@@ -47,21 +48,24 @@ Optionally, the value of an outdoor temperature sensor can be used here. If no s
An indoor temperature sensor is not necessary. Leave the field empty if you want to use the temperature sensor of the NSPanel. If the value of the sensor needs to be corrected, this can be done via the temperature correction for the NSPanel under HA Devices. An indoor temperature sensor is not necessary. Leave the field empty if you want to use the temperature sensor of the NSPanel. If the value of the sensor needs to be corrected, this can be done via the temperature correction for the NSPanel under HA Devices.
### Humidity Sensor (Optional)
Optional indoor humidity sensor.
### Hot Water Temperature Sensor (Optional) ## Sensor Home Page
Optional Hot Water Sensor. #### Sensor 01-03 - Entity (Optional)
### Hot Water Charge (Optional) Up to three sensors can be displayed on the home screen. Select the corresponding HA entity.
Optional hot water switch, e.g. for a boiler.
### Top 04 Flame
Displays a flame symbol on the home screen, e.g. when a boiler is switched on. ## Chips
#### Chip 01-07 - Entity (Optional)
Used to display HA entities on the home screen. For example to display the status of a specific switch on the NSPanel.
## Climate
### Climate to Control (Optional) ### Climate to Control (Optional)
@@ -71,13 +75,17 @@ If a Climate Integration is to be controlled, it must be entered here. This can
Depending on the climate control, the optimistic mode can be used for better response. The changes made are only transferred to the device when the screen is exited. Depending on the climate control, the optimistic mode can be used for better response. The changes made are only transferred to the device when the screen is exited.
### Activate QR Code (Optional) ### Hot Water Charge Button (Optional)
Optional hot water switch, e.g. for a boiler.
## QR Code
### Activate QR Code - TRUE/FALSE (Optional)
Activates the QR Code Page and the QR Code Button on the home page Activates the QR Code Page and the QR Code Button on the home page
### Name "QR Code Page" (Optional)
Naming of the QR Code Page, displayed on the top left of the page.
### QR Code content (Optional) ### QR Code content (Optional)
@@ -85,31 +93,39 @@ String, which is shown as a QR Code on the NSPanel. This can be a simple text, a
```WIFI:S:SSID;T:WPA/WEP;P:PASSWORD;;``` ```WIFI:S:SSID;T:WPA/WEP;P:PASSWORD;;```
### Left Button (Optional)
Left hardware button of the NSPanel.
### Name Left Button (Optional) ## Hardware Buttons
Text on the screen above the left hardware button (home screen). ### Delay for HW-Buttons hold in seconds - VALUE
### Activate Relay 1 local Fallback (Optional) Setting for how long a button must remain pressed in order to be recognized as a "hold". Default: 1 second.
Normally, the internal relays of the NSPanels are triggered via HA. If the NSPanel loses WiFi connection or HA is down, the left hardware button can then switch relay 1 directly. ### Activate Relay x local Fallback (Optional)
### Right Button (Optional) Normally, the internal relays of the NSPanels are triggered via HA. If the NSPanel loses WiFi connection or HA is down, the hardware button can then switch the corresponding relay directly.
Right Hardware Button of the NSPanel. ### Left/Right Hardware Button - Entity (Optional)
### Name "Right Button" (Optional) The entity that should be switched with the left/right hardware button.
Text on the screen above the right hardware button (home screen). ### Left/Right Hardware Button Name - Label (Optional)
### Activate Relay 2 local Fallback (Optional) Text on the screen above the corresponding hardware button (home screen).
Normally, the internal relays of the NSPanels are triggered via HA. If the NSPanel loses WiFi connection or HA is down, the right hardware button can then switch relay 2 directly. ### Left/Right Hardware Button hold assignment - VALUE (optional)
### Name Button Page 1- 4 Selection of what action should happen when the button is pressed for a longer time.
### Left/Right Hardware Button custom hold action - VALUE (Optional)
Selection of the action to start when holding the button.
## Button Page 01-04
### Button Page 01-04 name - LABEL (Optional)
Text on the respective button screens. Text on the respective button screens.
@@ -139,15 +155,24 @@ The following entities can be stored:
- Script - Script
- Binary Sensor - Binary Sensor
- Fan - Fan
- Climate
When the respective button is pressed, the corresponding page is automatically opened, e.g. the cover control for covers, etc. When the respective button is pressed, the corresponding page is automatically opened, e.g. the cover control for covers, etc.
For each button an own name can be specified optionally. For each button an own name can be specified optionally.
All buttons offer the possibility to optionally confirm the execution of the action. This can be activated or deactivated separately for each button via *"Confirm execution of the button press"*. All buttons offer the possibility to optionally confirm the execution of the action. This can be activated or deactivated separately for each button via *"Confirm execution of the button press"*.
### Activate Entity Pages (Optional)
## Entity Page 01-04
### Activate Entity Page - TRUE/FALSE (Optional)
This option activates the entity pages on the Home Screen. The entity pages can be used for example to display values or statuses of entities on the individual pages. This option activates the entity pages on the Home Screen. The entity pages can be used for example to display values or statuses of entities on the individual pages.
### Entity Page 01-04 name - LABEL (Optional)
Naming of the corresponding Entity Screens.
### Entity 01 - 32 (Optional) ### Entity 01 - 32 (Optional)
The entity pages can be accessed by pressing the symbol on the Home Screen and their functions are completely identical. The entity pages can be accessed by pressing the symbol on the Home Screen and their functions are completely identical.
@@ -167,19 +192,41 @@ The currently implemented symbols can be found here: https://htmlpreview.github.
**To use the icons in the Blueprint you would have to click on the "U" on the website to copy the icon and then paste it in the Blueprint** *(Attention: Only a "strange" character is displayed, but that is correct).* **To use the icons in the Blueprint you would have to click on the "U" on the website to copy the icon and then paste it in the Blueprint** *(Attention: Only a "strange" character is displayed, but that is correct).*
## Custom Configuration
### Hot Water Temperature Sensor (Optional)
Optional Hot Water Sensor.
### Top 04 Flame
Displays a flame symbol on the home screen, e.g. when a boiler is switched on.
### Nextion TFT File Folder
Can be left blank. However, it is required if a custom TFT configuration is to be used.
### Synchronization of all values (Optional)
Light and cover pages (values) are updated continuously (may cause flickering).
### Synchronization of all all sliders (Optional)
Light and cover pages (cover position) are updated continuously (may cause flickering).
*** ***
![image-20230210082420725](./assets/image-20230210082420725.png) Example Screenshots
![image-20230210082450296](./assets/image-20230210082450296.png) ![image-20230317162851693](./assets/image-20230317162851693.png)
![image-20230210082520575](./assets/image-20230210082520575.png) ![image-20230317162944247](./assets/image-20230317162944247.png)
![image-20230210082614749](./assets/image-20230210082614749.png) ![image-20230317163012105](./assets/image-20230317163012105.png)
... ![image-20230317163035519](./assets/image-20230317163035519.png)
![image-20230210082638657](./assets/image-20230210082638657.png)

6
(EN)-HowTo---All-important-thing-you-should-know.md

@@ -101,6 +101,8 @@ use_blueprint:
>Currently HA does not offer the possibility to update Blueprints directly via the UI. This has to be done manually e.g. via the file editor. >Currently HA does not offer the possibility to update Blueprints directly via the UI. This has to be done manually e.g. via the file editor.
>IMPORTANT: To install a new version of the NSPanel, the Blueprint, ESPHome and the TFT must be updated!
1. Download the latest release of the Blueprint from the Github repository. 1. Download the latest release of the Blueprint from the Github repository.
2. Replace the existing YAML file "nspanel_blueprint.yaml" in the folder ***./config/blueprints/automation/Blackymas*** with the new version. 2. Replace the existing YAML file "nspanel_blueprint.yaml" in the folder ***./config/blueprints/automation/Blackymas*** with the new version.
3. Reload automations or restart Home Assistant. 3. Reload automations or restart Home Assistant.
@@ -112,6 +114,8 @@ use_blueprint:
## 3. Update ESPHome ## 3. Update ESPHome
>IMPORTANT: To install a new version of the NSPanel, the Blueprint, ESPHome and the TFT must be updated!
To update ESPHome go to the ESPHome integration. There click on "Update All":![ESPHome Update0](./(DE)-HowTo---Alle-wichtigen-Dinge-die-man-wissen-sollte.assets/ESPHome Update0.PNG) To update ESPHome go to the ESPHome integration. There click on "Update All":![ESPHome Update0](./(DE)-HowTo---Alle-wichtigen-Dinge-die-man-wissen-sollte.assets/ESPHome Update0.PNG)
The update process may take a few minutes.![ESPHome Update](./(DE)-HowTo---Alle-wichtigen-Dinge-die-man-wissen-sollte.assets/ESPHome Update.PNG) The update process may take a few minutes.![ESPHome Update](./(DE)-HowTo---Alle-wichtigen-Dinge-die-man-wissen-sollte.assets/ESPHome Update.PNG)
@@ -120,6 +124,8 @@ The update process may take a few minutes.![ESPHome Update](./(DE)-HowTo---Alle-
## 4. Update TFT ## 4. Update TFT
>IMPORTANT: To install a new version of the NSPanel, the Blueprint, ESPHome and the TFT must be updated!
The display can be updated via the UI: The display can be updated via the UI:
1. Go to ***Settings --> Devices & Services --> Integrations*** , select the display under the ESPHome integration. 1. Go to ***Settings --> Devices & Services --> Integrations*** , select the display under the ESPHome integration.