Update Wiki

hollabee
2023-01-19 23:23:05 +01:00
parent 2b481bb523
commit 72e58660c3
9 changed files with 445 additions and 50 deletions

@@ -6,97 +6,95 @@ Im Prinzip ist die Einrichtung der Automatisierung selbsterklärend. Nachfolgend
 
# Parameter
### 1. 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.
### 2. 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.
### 3. Nextion TFT File Folder
> _Kann freigelassen werden. Wird aber benötigt, wenn eine eigene TFT Konfiguration verwendet werden soll._
Kann freigelassen werden. Wird aber benötigt, wenn eine eigene TFT Konfiguration verwendet werden soll.
### 4. Delay
> _Es kann bei schlechtem WLAN Signal vorkommen, dass Menüs nicht komplett geladen werden. Sollte dies vorkommen, kann hier ein Delay in 5ms Schritten eingestellt werden, um dies zu kompensieren._
Es kann bei schlechtem WLAN Signal vorkommen, dass Menüs nicht komplett geladen werden. Sollte dies vorkommen, kann hier ein Delay in 5ms Schritten eingestellt werden, um dies zu kompensieren.
### 5 . Synchronisation of all all values
> _Light und Cover Seiten (Werte) werden kontinuierlich upgedatet (kann zu Flackern führen)._
Light und Cover Seiten (Werte) werden kontinuierlich upgedatet (kann zu Flackern führen).
### 6. Synchronisation of all all Sliders
> _Light und Cover Seiten (Position der Cover) werden kontinuierlich upgedatet (kann zu Flackern führen)._
Light und Cover Seiten (Position der Cover) werden kontinuierlich upgedatet (kann zu Flackern führen).
### 7. Weather Integration
> _Auswahl zwischen der HA Weather Integration oder dem genaueren Accuweather._
Auswahl zwischen der HA Weather Integration oder dem genaueren Accuweather.
### 8. Name Weather
> _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.
### 9. Outdoor Temperature
> _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.
### 10. Humidity Sensor
> _Optionaler Innen-Feuchte Sensor._
Optionaler Innen-Feuchte Sensor.
### 11. Hot Water Temperatur Sensor
> _Optionaler Heiß Wasser Sensor._
Optionaler Heiß Wasser Sensor.
### 12. Hot Water Switch
> _Optionaler Warm Wasser Schalter, bspw. für einen Boiler._
Optionaler Warm Wasser Schalter, bspw. für einen Boiler.
### 13. Top 04 Flame
> _Zeigt ein Flammen-Symbol auf dem Home Screen an, bspw. wenn eine Therme angeschaltet (On) ist._
Zeigt ein Flammen-Symbol auf dem Home Screen an, bspw. wenn eine Therme angeschaltet (On) ist.
### 14. Climate to Control
> _Wenn eine Climate Integration gesteuert werden soll, muss diese hier eingegeben werden. Erreichbar ist diese dann über die Temperatur auf dem Home Screen des NSPanels._
Wenn eine Climate Integration gesteuert werden soll, muss diese hier eingegeben werden. Erreichbar ist diese dann über die Temperatur auf dem Home Screen des NSPanels.
### 15. Climate Control optimistic Mode
> _Abhängig von der Klima Steuerung, kann für ein besseres Ansprechverhalten der Optimistic Mode verwendet werden. Die vorgenommenen Änderungen werden erst bei verlassen des Screens auf das Device übertragen._
Abhängig von der Klima Steuerung, kann für ein besseres Ansprechverhalten der Optimistic Mode verwendet werden. Die vorgenommenen Änderungen werden erst bei verlassen des Screens auf das Device übertragen.
### 16. Left Button Switch
> _Linker Hardware Button des NSPanel._
Linker Hardware Button des NSPanel.
### 17. Name Left Button Switch
> _Text auf dem Screen über dem linken Hardware Button (Home Screen)_
Text auf dem Screen über dem linken Hardware Button (Home Screen)
### 18. Right Button Switch
> _Rechter Hardware Button des NSPanel_.
Rechter Hardware Button des NSPanel.
### 19. Name Right Button Switch
> _Text auf dem Screen über dem rechten Hardware Button (Home Screen)_
Text auf dem Screen über dem rechten Hardware Button (Home Screen)
### 20. Name Button Page 1- 4
> _Text auf den jeweiligen Button Screens._
Text auf den jeweiligen Button Screens.
### Buttons 01 - 32
> _Die Buttons sind durch Wischen auf dem Home Screen zu erreichen und in ihrer Funktion völlig identisch.
> Entweder können nacheinander die einzelnen Button Pages durch Wischen nach links erreicht werden, oder direkt auf die Button Pages durch Wischen nach oben, unten oder rechts angesprungen werden._
>
>
>
> _Die Buttons sind wie folgt nummeriert:_
>
> | | Button Page 1 | Button Page 2 | Button Page 3 | Button Page 4 |
> | ------- | ------------- | ------------- | ------------- | ------------- |
> | Zeile 1 | 01 02 03 04 | 09 10 11 12 | 17 18 19 20 | 25 26 27 28 |
> | Zeile 2 | 05 06 07 08 | 13 14 15 16 | 21 22 23 24 | 29 30 31 32 |
>
> _Es können folgende Entitäten hinterlegt werden:_
> - _Light_
> - _Switch_
> - _Cover_
> - _Input Boolean_
> - _Automation_
> - _Button_
> - _Input Button_
> - _Scene_
> - _Person_
> - _Script_
> - _Binary Sensor_
> - _Fan
>
> _Wenn der jeweilige Button gedrückt wird, wird automatisch die korrespondierende Seite aufgerufen, bspw. bei Cover die Coversteuerung etc.
> Für jeden Button kann optional ein eigener Name angegeben werden.
> Alle Buttons bieten die Möglichkeit, die Ausführung der Aktion optional bestätigen zu lassen. Dies kann separat für jeden Button über "Confirm execution of the button press" aktiviert bzw. deaktiviert werden._
Die Buttons sind durch Wischen auf dem Home Screen zu erreichen und in ihrer Funktion völlig identisch.
Entweder können nacheinander die einzelnen Button Pages durch Wischen nach links erreicht werden, oder direkt auf die Button Pages durch Wischen nach oben, unten oder rechts angesprungen werden.
Die Buttons sind wie folgt nummeriert:
| | Button Page 1 | Button Page 2 | Button Page 3 | Button Page 4 |
| ------- | ------------- | ------------- | ------------- | ------------- |
| Zeile 1 | 01 02 03 04 | 09 10 11 12 | 17 18 19 20 | 25 26 27 28 |
| Zeile 2 | 05 06 07 08 | 13 14 15 16 | 21 22 23 24 | 29 30 31 32 |
Es können folgende Entitäten hinterlegt werden:
- Light
- Switch
- Cover
- Input Boolean
- Automation
- Button
- Input Button
- Scene
- Person
- Script
- Binary Sensor
- Fan
Wenn der jeweilige Button gedrückt wird, wird automatisch die korrespondierende Seite aufgerufen, bspw. bei Cover die Coversteuerung etc.
Für jeden Button kann optional ein eigener Name angegeben werden.
Alle Buttons bieten die Möglichkeit, die Ausführung der Aktion optional bestätigen zu lassen. Dies kann separat für jeden Button über *"Confirm execution of the button press"* aktiviert bzw. deaktiviert werden.
***

Binary file not shown.

After

Width:  |  Height:  |  Size: 164 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 125 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 158 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 150 KiB

@@ -1,3 +1,138 @@
This article covers the settings in the Blueprint Automation.
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.
 
# Parameters
### 1. 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.
### 2. Language of NSPanel
The language can be selected via the drop-down menu. Currently 26 languages are supported.
### 3. Nextion TFT File Folder
Can be left blank. However, it is required if a custom TFT configuration is to be used.
### 4. 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.
### 5. Synchronization of all values
Light and cover pages (values) are updated continuously (may cause flickering).
### 6. Synchronization of all all sliders
Light and cover pages (cover position) are updated continuously (may cause flickering).
### 7. Weather integration
Choose between HA own weather integration or the more accurate Accuweather.
### 8. Name Weather
Dropdown menu to select the Weather entity to use. Example: If "Accuweather" is selected in item 7, then the entity for Accuweather must be selected here.
### 9. Outdoor temperature
Optionally, the value of an outdoor temperature sensor can be used here. If no separate sensor is used, the value of the weather integration will be used._
### 10. Humidity Sensor
Optional indoor humidity sensor.
### 11. Hot Water Temperature Sensor
Optional Hot Water Sensor.
### 12. Hot Water Switch
Optional hot water switch, e.g. for a boiler.
### 13. Top 04 Flame
Displays a flame symbol on the home screen, e.g. when a boiler is switched on.
### 14. Climate to Control
If a Climate Integration is to be controlled, it must be entered here. This can then be accessed via the temperature on the home screen of the NSPanel.
### 15. Climate control optimistic mode
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.
### 16. Left button switch
Left hardware button of the NSPanel.
### 17. Name left button switch
Text on the screen above the left hardware button (home screen).
### 18. Right Button Switch
Right Hardware Button of the NSPanel.
### 19. Name Right Button Switch
Text on the screen above the right hardware button (home screen).
### 20. Name Button Page 1- 4
Text on the respective button screens.
### Buttons 01 - 32
The buttons can be accessed by swiping on the Home Screen and their functions are completely identical.
Either the individual button pages can be accessed one after the other by swiping to the left, or the button pages can be accessed directly by swiping up, down or to the right.
The buttons are numbered as follows:
| | Button Page 1 | Button Page 2 | Button Page 3 | Button Page 4 |
| ------ | ------------- | ------------- | ------------- | ------------- |
| Line 1 | 01 02 03 04 | 09 10 11 12 | 17 18 19 20 | 25 26 27 28 |
| line 2 | 05 06 07 08 | 13 14 15 16 | 21 22 23 24 | 29 30 31 32 |
The following entities can be stored:
- Light
- Switch
- Cover
- Input Boolean
- Automation
- Button
- Input Button
- Scene
- Person
- Script
- Binary Sensor
- Fan
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.
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"*.
***
![configuration_1](./(EN)-Blueprint---Setup-and-Description-of-the-Blueprint.assets/configuration_1.png)
![configuration_2](./(EN)-Blueprint---Setup-and-Description-of-the-Blueprint.assets/configuration_2.png)
![configuration_3](./(EN)-Blueprint---Setup-and-Description-of-the-Blueprint.assets/configuration_3.png)
![configuration_4](./(EN)-Blueprint---Setup-and-Description-of-the-Blueprint.assets/configuration_4.png)
This section is covering the settings in the Blueprint Automation.
The Blueprint Automation is the central configuration piece of this solution for the NSPanel.
 

Binary file not shown.

After

Width:  |  Height:  |  Size: 56 KiB

@@ -0,0 +1,262 @@
In this post we will collect all the important things about different topics that we notice over time. 
> ### _**NOTE! If you notice something during the configuration or you had some problem and could solve it, it would be great for us and everyone else in the community if you share your knowledge with us. You can write me a short message and I will include it in this post.
 
> ### IMPORTANT! If you have a problem with the setup or a feature and open an _**"Issue on Github "**_, please describe your problem as detailed as possible. Pictures can also help here.
 
> ### IMPORTANT! When you open an _**"Issue "**_, follow the instructions bitterly see here [How to create "Issues"](https://github.com/Blackymas/NSPanel_HA_Blueprint/wiki/(EN)-HowTo---All-important-things-you-should-know#1-how-to-create-issues-when-I-have-a-problem).
 
 
------
 
# Contents:
1. [How do I create "Issues" when I have a problem ](https://github.com/Blackymas/NSPanel_HA_Blueprint/wiki/(EN)-HowTo---All-important-things-you-should-know#1-how-do-I-create-issues-when-I-have-a-problem).
2. [Update Blueprint](https://github.com/Blackymas/NSPanel_HA_Blueprint/wiki/(EN)-HowTo--all-important-things-you-should-know#2-update-blueprint)
3. [Update ESPHome](https://github.com/Blackymas/NSPanel_HA_Blueprint/wiki/(EN)-HowTo---All-important-things-you-should-know#3-update-esphome)
4. [Update TFT](https://github.com/Blackymas/NSPanel_HA_Blueprint/wiki/(EN)-HowTo---All-important-things-you-should-know#4-update-tft)
5. Manual TFT upload via local HA (coming soon)
6. Upload TFT error and solution (coming soon
7. Notification via HA (coming soon)
8. [Climate for relays](https://github.com/Blackymas/NSPanel_HA_Blueprint/wiki/(DE)-HowTo--all-important-things-you-should-know#8-climate-for-relays)
9. [Display internal switches as lamp in HA](https://github.com/Blackymas/NSPanel_HA_Blueprint/wiki/(EN)-HowTo--all-important-things-you-should-know#9-display-internal-switches-as-lamp-in-ha)
10. Quick navigation (coming soon)
11. [Call certain pages directly](https://github.com/Blackymas/NSPanel_HA_Blueprint/wiki/(EN)-HowTo---All-important-things-you-should-know#11-call-certain-pages-directly)
12. [Play RTTTL Sound](https://github.com/Blackymas/NSPanel_HA_Blueprint/wiki/(EN)-HowTo---All-important-things-you-should-know#12-play-rtttl-sound)
13. Advanced functions and automations (coming soon)
14. [Start automations via Input_Boolean](https://github.com/Blackymas/NSPanel_HA_Blueprint/wiki/(EN)-HowTo---All-important-things-you-should-know#14-start-automations-via-input_boolean)
 
***
 
## 1. How to create "issues" when I have a problem
> _**To be able to solve your problem, it is important for us to have as much information as possible**_.
* Issues can be created in DE or EN.
* Describe your problem as detailed as possible.
* Please write your ESPHome and Home Assistant version.
* please go to your automation and then to the "3 dots" and then to _**Edit as YAML**_. Copy the complete code and attach it to the ticket
* An important "helper" for solving problems is the trace of an automation. You can find the trace under _**Settings --> Automations & Scenes --> your NSPanel automation --> Traces (top right)**_
> TRACES! Please execute again what does not work and open the trace immediately afterwards. Often you have to open the trace after the reboot too. In the boot most things are loaded.
> IMPORTANT! in the trace you can see by the _**"orange "**_ lines which way the automation has gone. Please tell us this path. Also, please take one or more screenshots and add them to your ticket. Especially important for us is where the _**"Orange "**_ line ends, because most of the time this is also where the problem is.
> IMPORTANT! When you have opened the trace, there is a _**"timestamp "**_ at the top. It is important that you select the correct timestamp.
### Example trace after reboot:
![Bildschirmfoto 2022-11-27 um 14 54 58](https://user-images.githubusercontent.com/41958506/204139082-70d3a8d1-1c82-43cb-88f2-573f2e276a48.png)
### Example automations Blueprint:
```
alias: YYXYYXYYX - NSPanel Configuration
description: ""
use_blueprint:
path: nspanel_configuration.yaml
input:
nspanel_name: nspanel_dev
language: DE
sync_value_ha: select_no
sync_slider_ha: select_no
weather: AccuWeather
accuweather: home_wetter
outdoortemp: sensor.terrasse_garage_motion_sensor_temperature
humidity: sensor.kinderzimmer_lea_temperatur_sensor_humidity
hotwatertemp: sensor.hotwater_temp
hotwatercharge: switch.charge
heatingsystemflame: binary_sensor.flamestatus
climate: climate.nspanel_buro
left_button_entity: light.haustur_spot_2
right_button_entity: light.haustur_spot_1
entity01: light.buro_sideboard
entity01_name: Sideboard
entity02: cover.kuche_rollo
entity02_name: Küche Rollo
entity03: switch.buro_dart_beleuchtung
entity03_name: Dart Licht
delay: 2
right_button_name: Test 1
left_button_name: Test 2
```
------
## 2. Update 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.
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.
3. Reload automations or restart Home Assistant.
4. The new Blueprint is now available. Settings that have already been made are adopted.
![BlueprintUpdate](./(DE)-HowTo---Alle-wichtigen-Dinge-die-man-wissen-sollte.assets/BlueprintUpdate.PNG)
------
## 3. Update ESPHome
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)
------
## 4. Update TFT
The display can be updated via the UI:
1. Go to ***Settings --> Devices & Services --> Integrations*** , select the display under the ESPHome integration.
2. Press the switch "Update TFT Display" under Configuration.
3. The display starts the update process and then restarts.
![DisplayUpdate](./(DE)-HowTo---Alle-wichtigen-Dinge-die-man-wissen-sollte.assets/DisplayUpdate.PNG)
------
## 5. Manual TFT upload via local HA
coming soon
------
## 6. Upload TFT error and solution
coming soon
------
## 7. Notification via HA
coming soon
------
## 8. Climate control with Relays
In order to use the NSPanel to control a radiator or underfloor heating, at least one Generic Thermostat must be created in the HA. More information can be found here: https://www.home-assistant.io/integrations/generic_thermostat/
Example configuration Generic Thermostat:
```
climate:
- platform: generic_thermostat
name: Study
heater: switch.study_heater ## Wenn das NSPanel Relays den Heizkreis Regler schaltet, kann dieses hier definiert werden
target_sensor: sensor.study_temperature ## Hier kann der NSPanel Sensor verwendet werden
min_temp: 15
max_temp: 21
ac_mode: false
target_temp: 17
cold_tolerance: 0.3
hot_tolerance: 0
min_cycle_duration:
seconds: 5
keep_alive:
minutes: 3
initial_hvac_mode: "off"
away_temp: 16
precision: 0.1
```
Afterwards, the climate.entity must be assigned accordingly in the panel configuration:![climate](./(DE)-HowTo---Alle-wichtigen-Dinge-die-man-wissen-sollte.assets/climate.PNG)
------
## 9. Display internal switches as lamp in HA
In the world of Home Assistant, the relay in the NSPanel is a switch. And although this is generally correct, these relays are often used for a lamp or a fan, for example. If now e.g. a lamp is switched directly with the relay, it is desirable that also in the HA the switch is displayed as a lamp or that this "lamp" should be added to a light group.
With the Switch as X integration, these switches can be converted into the entity types that best suit the use case: https://www.home-assistant.io/integrations/switch_as_x/
![Swichasx](./(DE)-HowTo---Alle-wichtigen-Dinge-die-man-wissen-sollte.assets/Swichasx.png)
------
## 10. Quick Navigation
coming soon
------
## 11. Call certain pages directly
Sometimes it can make sense to automatically show a certain side of the display. To do this, the following service can be used:
```
service: esphome.nspanel_dev_send_command_printf
data:
cmd: page home
```
For example, to directly display button page 2, "home" must be replaced with "buttonpage02".
The following pages are currently available:
![automation_1](./(DE)-HowTo---Alle-wichtigen-Dinge-die-man-wissen-sollte.assets/automation_1.png)
------
## 12. Play RTTTL Sound
HA can send a RTTTL to the NSPanel, custom melodies are possible.
The use this function, the following service is called: ***nspanel_dev_play_rtttl***
You can find many RTTTL strings on the web, the important thing is that they must start with the name and then a colon.
Here is an example:
```
The Simpsons:d=4,o=5,b=160:c.6,e6,f#6,8a6,g.6,e6,c6,8a,8f#,8f#,8f#,2g,8p,8p,8f#,8f#,8f#,8g,a#.,8c6,8c6,8c6,c6
```
![212177541-206ed70d-b4e0-436c-9ef5-25e03a816898](./(DE)-HowTo---Alle-wichtigen-Dinge-die-man-wissen-sollte.assets/212177541-206ed70d-b4e0-436c-9ef5-25e03a816898.png)
More information: https://esphome.io/components/rtttl.html#common-beeps
More songs: https://codebender.cc/sketch:109888#RTTTL%20Songs.ino
------
## 13. Advanced functions and automations
coming soon
------
## 14. Start Automation via Input_Boolean
Although the NSPanel can execute scripts directly over the buttons, there is also the possibility of starting automations directly by the means of Input_Boolean.
For this, a helper must first be created under ***Settings --> Devices&Services --> Helpers***, see here:
https://www.home-assistant.io/integrations/input_boolean/![Toggle1](./(EN)-HowTo---All-important-thing-you-should-know.assets/Toggle1.PNG)
Now add the created Input_Boolean as a trigger in the desired automation under State:![Toggle2](./(DE)-HowTo---Alle-wichtigen-Dinge-die-man-wissen-sollte.assets/Toggle2.PNG)
In the last step, assign the trigger to a button in the Panel Config:![Toggle3](./(DE)-HowTo---Alle-wichtigen-Dinge-die-man-wissen-sollte.assets/Toggle3.PNG)
------

@@ -35,5 +35,5 @@ This Wiki will grow over time and we are trying to keep up with the rapid develo
[(EN) Blueprint | Setup and explanation of the Blueprint](https://github.com/Blackymas/NSPanel_HA_Blueprint/wiki/(EN)-Blueprint---Setup-and-Description-of-the-Blueprint)
[(EN) HowTo | All important things you should know (coming soon)](https://github.com/Blackymas/NSPanel_HA_Blueprint/wiki/(DE)-HowTo---Alle-wichtigen-Dinge-die-man-wissen-sollte)
[(EN) HowTo | All important things you should know](https://github.com/Blackymas/NSPanel_HA_Blueprint/wiki/(EN)-HowTo---all-important-things-you-should-know)