add: renamed files

deejaybeam
2023-01-15 22:42:46 +01:00
parent 55d2da2a62
commit 0790bcf24b
4 changed files with 382 additions and 0 deletions

@@ -0,0 +1,67 @@
# (DE) Blueprint | Einrichtung und Erklärung vom Blueprint
## Dieser Artikel befasst sich mit den Einstellungen in der Blueprint Automatisierung.
 
Die Blueprint Automation ist das zentrale Konfigurationselement dieser Lösung für das NSPanel.
 
Im Prinzip ist die Einrichtung der Automatisierung selbsterklärend. Nachfolgend werden die einzelnen Elemente des Blueprints erklärt.
 
# Parameter:
1. ESPhome Node Name: Dies bezieht sich auf den ESPhome-Gerätenamen. Wichtiger Hinweis: Zur Trennung im Namen muss ein Unterstrich verwendent werden.
2. Language for NSPanel: Sprachauswahl. Derzeit wird EN und DE unterstützt.
3. Nextion TFT File Folder: 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.
5. Synchronisation of all all values: Light und Cover Seiten werden kontinuierlich upgedatet (kann zu Flackern führen).
6. Synchronisation of all all Sliders: Light und Cover Seiten werden kontinuierlich upgedatet (kann zu Flackern führen).
7. Weather Integration: Auswahl zwischen der HA Weather Integration oder dem genaueren Accuweather.
8. Name Weather: Wenn Accuweather verwendet wird, muss hier der Name, der bei der Accuweather installation festgelegt wurde, eingegeben 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.
10. Humidity Sensor: Optionaler Aussen-Feuchte Sensor.
11. Hot Water Temperatur Sensor: Optionaler Heiss Wasser Sensor.
12. Hot Water Switch: 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.
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.
15. Climate Control optimistic Mode: Abhängig von der Klima Steuerung, kann für ein besseres Ansprechverhalten der Optimistic Mode verwendet werden.
16. Left Button Switch: Linker Hardware Button des NSPanel
17. Name Left Button Switch: Text auf dem Screen über dem linken Hardware Button (Home Screen)
18. Right Button Switch: Rechter Hardware Button des NSPanel
19. Name Right Button Switch: Text auf dem Screen über dem rechten Hardware Button (Home Screen)
 
##Button 1-32
Die Tasten sind durch Wischen nach rechts zu erreichen und in ihrer Funktion völlig identisch.
Button 1 befindet sich ganz links und Button 32 ganz rechts.
Es können Entitäten mit den Eigenschaften Licht, Schalter, Abdeckung, Input Boolean, Automation, Button, Input Button, Scene und Person verwendet werden.
Wenn die Schaltfläche gedrückt wird, wird automatisch die richtige Einstellungsseite aufgerufen.
Für jede Schaltfläche kann ein eigener Name angegeben werden.
 
 
***
![](https://user-images.githubusercontent.com/41958506/203655004-a11f5a1c-d098-4e1a-958a-0293e50000b2.png)
![](https://user-images.githubusercontent.com/41958506/203655014-e6cae9df-aaf8-4537-8165-b8f44a177d3b.png)

@@ -0,0 +1,165 @@
# (DE) Erste Schritte - Installation und Einrichtung
## In diesem Beitrag geht es um die erst Konfiguration. Hier werden alle wichtigen Schritte zur Installation und Einrichtung von ESPHome und dem Blueprint beschrieben.
 
**_Step by Step [Einrichtungs Video](https://www.youtube.com/watch?v=3afPFg6kUdc)_**
 
> ### _**ACHTUNG! solltest du vorher bereits auf deinem NSPanel die Version "nspanel-lovelace-ui" von joBr99 eingerichtet haben, ist ein zwischen Schritt nötig - sonst ist es nicht möglich diese oder irgendeine andere Version zu installieren**_
 
 
***
 
# Inhalt:
1. [Kurz Version der Einrichtung von Esphome und Blueprint](https://github.com/Blackymas/NSPanel_HA_Blueprint/wiki/(DE)-Erste-Schritte-%7C-Installation-und-Einrichtung#1-kurz-version-der-einrichtung-von-esphome-und-blueprint)
2. [Version "nspanel-lovelace-ui" von joBr99 wurde vorher installiert](https://github.com/Blackymas/NSPanel_HA_Blueprint/wiki/(DE)-Erste-Schritte-%7C-Installation-und-Einrichtung#2-version-nspanel-lovelace-ui-von-jobr99-wurde-vorher-installiert)
3. [Advance Modus für ESPHome und HA Profis](https://github.com/Blackymas/NSPanel_HA_Blueprint/wiki/(DE)-Erste-Schritte-%7C-Installation-und-Einrichtung#3-advanced-configuration-für-alle-esphome-und-home-assistant-profis)
4. [Step by Step Einrichtung und Konfiguration](https://github.com/Blackymas/NSPanel_HA_Blueprint/wiki/(DE)-Erste-Schritte-%7C-Installation-und-Einrichtung#4-step-by-step-konfiguration-und-einrichtung-von-esphome-und-blueprint)
 
***
 
 
## 1. Kurz Version der Einrichtung von Esphome und Blueprint
> _**(für alle die bereits mit ESPhome und Home Assistant Erfahrung haben)**_
1. Als erstes muss das Blueprint installiert werden. Dazu nutze bitte folgenden Link
[![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)
> Es ist auch möglich den Code aus der Datei _**"nspnael_blueprint.yaml"**_ zu kopieren und in HA einzufügen.
> Hinweise dazu findest du unter [Using Automation Blueprints](https://www.home-assistant.io/docs/automation/using_blueprints/) und [Automation blueprint tutorial](https://www.home-assistant.io/docs/blueprint/tutorial/#create-the-blueprint-file)
2. im nächsten Schritt muss eine neues ESP32 Device in ESPHome erstellt werden
3. wenn das neue ESP32 Device erstellt wurde, klicke als nächstes bei dem soeben angelegten Device auf _**"Edit"**_ um den Web-Editor zu öffnen. Nun muss folgender Code kopiert und eingesetzt werden.
> ❗ _**WICHTIG!**_ Der bereits vorhanden Code in der ESPHome Datei muss _**"KOMPLETT"**_ gelöscht werden und durch den unten stehenden Code _**"ERSETZT"**_ werden.
> ❗ _**WICHTIG!**_ im Block _**"CHANGE ME"**_ müssen alle Werte _**(device_name, wifi_ssid, wifi_password)**_ in den _**" "**_ durch deine eigenen Werte ersetzt werden. Es ist hier auch möglich mit _**"!secret"**_ zu arbeiten
> ⚠️ _**ACHTUNG!**_ es dürfen bei _**"device_name"**_ max. 15 Zeichen _**[a-z] und [0-9]**_ verwendet werden und alles müssen _**"Kleinbuchstaben"**_ sein. Weiterhin sind Zeichen wie _**[-], [SONDERZEICHEN] und [LEERZEICHEN]**_ verboten und führen zu Problemen mit dem Blueprint.
> **Beispiel:** _**nspanel_blackymas**_
 
### CODE:
```
substitutions:
###### CHANGE ME ######
device_name: "YOUR NSPANEL_NAME"
wifi_ssid: "YOUR WIFI SSID"
wifi_password: "YOUR WIFI PASSWORD"
##### CHANGE ME #####
##### DO NOT CHANGE ANYTHING! #####
nextion_update_url: "https://raw.githubusercontent.com/Blackymas/NSPanel_HA_Blueprint/main/nspanel.tft"
packages:
##### download esphome code from Github
remote_package:
url: https://github.com/Blackymas/NSPanel_HA_Blueprint
ref: main
files: [nspanel_esphome.yaml]
refresh: 300s
##### DO NOT CHANGE ANYTHING! #####
```
 
4. Jetzt kann das NSPanel mit dem neuen ESPHome Code geflasht werden
> wie das NSPanel geflasht wird kannst du dir hier ansehen [HOW TO - Flash Sonoff NSPanel with ESPHome](https://www.youtube.com/watch?v=p-AK4o5jOSI)
5. Nachdem das NSPanel fertig geflasht wurde, kannst du unter _**"Einstellungen --> Geräte & Dienste --> Integration hinzufügen"**_ dein neues Gerät hinzufügen und fertig einrichten
6. im letzten Schritt muss nun nur noch das TFT hochgeladen werden. Dazu öffne in der Integration ESPHome dein neues Device und aktiviere unter _**"Konfiguration"**_ den Punkt _**"Update TFT display"**_. Jetzt wird aus Github das aktuelle TFT File geladen und auf dein NSPanel hochgeladen. _**ACHTUNG!**_ dieser Vorgang kann einen Moment dauern
7. jetzt ist die Einrichtung vom ESPHome und dem NSPanel abgeschlossen.
8. Nun kannst du über das Blueprint dein NSPanel konfigurieren. Dazu gehe auf _**"Einstellungen --> Automatisierungen & Szenen --> Vorlagen --> NSPanel Configuration --> AUTOMATISIERUNG ERSTELLEN"**_ und starte mit der Einrichtung vom NSPanel.
> **HINWEIS!** Trage im Blueprint im Feld _**"ESPHOME Node Name"**_ exakt den selben Namen ein, den du in der _**"ESPHome Datei"**_ vergeben hast.
> **Beispiel:** _**nspanel_blackymas**_
 
 
***
 
 
## 2. Version "nspanel-lovelace-ui" von joBr99 wurde vorher installiert
> _**in der Version "nspanel-lovelace-ui" von joBr99 sind ein paar Besonderheiten eingebaut, die es nicht so einfach ermöglichen eine neue Version und TFT auf das NSPanel zu flashen. Da wir dieses Problem aber schon hatten, haben wir natürlich auch schon eine Lösung für euch ;)**_
### _**Es ist notwendig eine "Leeres TFT" Datei hochzuladen, solange "Lovelace ui" noch auf dem NSPanel installiert ist.**_
> WICHTIG! Wenn du bereits das NSPanel mit meiner Version installiert hast, musst du zuerst wieder "Lovelace ui" vollständig installieren.
### Folgende Schritte sind notwendig:
1. lade dir aus dem Ordner _**custom_configuration**_ die Datei _**"nspanel_blank.tft"**_ herunter.
2. lade nun die TFT Datei _**"nspanel_blank.tft"**_ in den Ordner _**"www"**_ in Home Assistant hoch
3. gehe jetzt zu dem Punkt _**"Entwicklerwerzeuge --> Dienste"**_ und suche dort nach dem Dienst
 
_**"ESPHome: DEVICE_NAME_upload_tft"**_ --> (esphome.device_name_upload_tft)
4. unter URL musst du jetzt den Pfad zu deiner Datei _**nspanel_blank.tft**_ eingeben. Das könnte zum Beispiel so aussehen _**"http://IP_HOME_ASSISTANT:8123/local/nspanel_blank.tft"**_
5. nun sollte die TFT Datei auf das NSPanel gespielt werden. Es kann einen Moment dauern, bis es fertig ist
6. sollte alles funktioniert haben, sollte auf dem NSPanel nur eine weiße Seite zu sehen sein
7. jetzt kann mit der Einrichtung und Konfiguration meiner Version fortgesetzt werden. Dazu siehe [Kurz Version der Einrichtung von Esphome und Blueprint](https://github.com/Blackymas/NSPanel_HA_Blueprint/wiki/(DE)-Erste-Schritte-%7C-Installation-und-Einrichtung#1-kurz-version-der-einrichtung-von-esphome-und-blueprint)
 
 
***
 
 
## 3. Advanced configuration für alle ESPHome und Home Assistant Profis
* Blueprint Datei _**"nspnael_blueprint.yaml"**_ kann auch manuell installiert werden
* ESPHome Datei_**"nspanel_esphome.yaml"**_ kann auch manuell installiert werden. Dadurch können weitere _**"Advanced"**_ Konfigurationen aktiviert oder hinzugefügt werden.
* Außerdem besteht die Möglichkeit das TFT File _**"nspanel.tft"**_ manuell hochzuladen. Das Ganze kann auch mit einem _**"Folder Watcher"**_ kombiniert werden
* zusätzlich stellen wir die HMI Datei _**"nspanel.HMI"**_ für den Nextion Editor zur Verfügung, um Grafiken und Programmierung bei bedarf anpassen zu können
> _**ACHTUNG!**_ Wer diesen Modus benutzt, sollte wissen was er tut. Wir geben hier keinen Support!
 
 
***
 
 
## 4. Step by Step Konfiguration und Einrichtung von ESPHome und Blueprint
> _**(für alle die neu im Thema ESPhome sind oder noch keine Erfahrungen gesammelt haben)**_

@@ -0,0 +1,83 @@
# (DE) HowTo | Alle wichtigen Dinge die man wissen sollte
## In diesem Beitrag werden wir alle wichtigen Dinge zu verschiedenen Themen zusammen tragen, die im Laufe der Zeit uns auffallen.
 
> ### _**HINWEIS! sollte dir bei der Konfiguration etwas auffallen oder du irgendein Problem hattest und es lösen konntest, wäre es für uns und alle anderen in der Community super, wenn du dein Wissen mit uns teilst. Dazu kannst du mir ein kurze Nachricht schreiben und ich nehme es in diesem Beitrag dann mit auf.**_
 
> ### WICHTIG! Wenn du ein Problem bei der Einrichtung oder einer Funktion hast und ein _**"Issue auf Github"**_ eröffnest, beschreibe dein Problem bitte so genau wie möglich. Auch Bilder können hier helfen.
 
> ### WICHTIG! Wenn du ein _**"Issue"**_ eröffnest, folge bitter der Anleitung sieh hier [Wie erstelle ich "Issues"](https://github.com/Blackymas/NSPanel_HA_Blueprint/wiki/(DE)-HowTo-%7C-Alle-wichtigen-Dinge-die-man-wissen-sollte#1-wie-erstelle-ich-issues-wenn-ich-ein-problem-habe)
 
 
***
 
# Inhalt:
1. [Wie erstelle ich "Issues" wenn ich ein Problem habe ](https://github.com/Blackymas/NSPanel_HA_Blueprint/wiki/(DE)-HowTo-%7C-Alle-wichtigen-Dinge-die-man-wissen-sollte#1-wie-erstelle-ich-issues-wenn-ich-ein-problem-habe)
 
***
 
 
## 1. Wie erstelle ich "Issues" wenn ich ein Problem habe
> _**Um dein Problem lösen zu können, ist es für uns wichtig so viele Informationen wie möglich zu haben**_
* Probleme können auf DE oder EN erstellt werden.
* beschreibe dein Problem so genau wie möglich.
* schreibe bitte deine ESPHome und Home Assistant Version
* gehe bitte auf deine Automation und dann auf die "3 Punkte" und danach auf _**Als YAML bearbeiten**_. Kopiere den kompletten Code und füge es dem Ticket bei
* Ein wichtiger "Helfer" beim lösen der Probleme ist der Trace einer Automation. Den Trace findest du unter _**Einstellungen --> Automatisierungen & Szenen --> deine NSPanel Automatisierung --> Traces (rechts oben)**_
> TRACES! Bitte führe erneut aus, was nicht funktioniert und öffne danach sofort den Trace. Oft muss auch nach dem Reboot der trace geöffnet werden. Im Boot werden die meisten Dinge geladen.
> WICHTIG! im Trace kannst du anhand der _**"Orangen"**_ Linien sehen welchen Weg die Automation gegangen ist. Bitte teile uns diesen Weg mit. Außerdem erstelle bitte davon ein oder mehrer Screenshots die du deinem Ticket hinzufügst. Besonders wichtig ist für uns wo die _**"Orangen"**_ Linie aufhört, denn meist ist dort auch das Problem
> WICHTIG! Wenn du den Trace geöffnet hast, gibt es ganz oben die _**"Zeitstempel"**_. Es ist wichtig das du den richtigen Zeitstempel auswählst.
### Beispiel Trace nach Reboot:
![Bildschirmfoto 2022-11-27 um 14 54 58](https://user-images.githubusercontent.com/41958506/204139082-70d3a8d1-1c82-43cb-88f2-573f2e276a48.png)
### Beispiel Automatisierungen 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
```

@@ -0,0 +1,67 @@
# (EN) Blueprint | Setup and Description of the Blueprint
## This article is covering the settings in the Blueprint Automation.
 
The Blueprint Automation is the central configuration piece of this solution for the NSPanel.
 
In principal, setting up the automation is self explaining. Below you will find an explanation of each configuration point of the Blueprint.
 
# Parameter:
1. ESPhome Node Name: This refers to the ESPhome device_name. Important note: please use an underscore for the name.
2. Language for NSPanel: Language selection. Currently we support EN and DE.
3. Nextion TFT File Folder: Can be left blank and is only required if you would like to use an individual configarion, e.g. when using a custom build TFT file.
4. Delay: If the WiFi signal is weak, it can happen that menus are not loaded completely. If this happens, please increase the delay in 5ms incremeents and verify that the pages are loading correctly.
5. Synchronisation of all all values: Light and Cover pages are being refreshed continuously (can lead the flickering)
6. Synchronisation of all all Sliders: Light and Cover pages are being refreshed continuously (can lead the flickering)
7. Weather Integration: You can select between HA own weather instance or if you want to select the more accurate AccuWeather.
8. Name Weather: If using Accuweather, the name of the Accuweather integration needs to be put here.
9. Outdoor Temperature: You can use your own outside temperature sensor. If you choose not to, the value of the weather app will be used.
10. Humidity Sensor: Optional outside humidity sensor.
11. Hot Water Temperatur Sensor: Optional hot water sensor.
12. Hot Water Switch: Optional warm water switch for boiler.
13. Top 04 Flame: This indicates a flame symbol on the first page, e.g. if a climate is being switched on.
14. Climate to Control: This leads to a climate which needs to be set up in HA first. This can be accessed on the NSPanel via the temperature on the home screen.
15. Climate Control optimistic Mode: Depending on the climate control being used, you might want to switch to optimistic mode.
16. Left Button Switch: Left Hardware Button of NSPanel
17. Name Left Button Switch: Name above the left hardware switch (Home Screen)
18. Right Button Switch: Right Hardware Button NSPanel
19. Name Right Button Switch: Name above the right hardware switch (Home Screen)
 
##Button 1-32
The buttons can be reached by swiping to the right and are completely identical in function
Button 1 is located on the far left and Button 32 on the far right.
Entities with the property Light, Switch, Cover, Input Boolean, Automation, Button, Input Button, Scene and Person can be used.
When the button is pressed, the correct setting page is automatically called.
A name for each button can be specified.
 
 
***
![](https://user-images.githubusercontent.com/41958506/203655004-a11f5a1c-d098-4e1a-958a-0293e50000b2.png)
![](https://user-images.githubusercontent.com/41958506/203655014-e6cae9df-aaf8-4537-8165-b8f44a177d3b.png)