diff --git a/(DE)-Erste-Schritte---Installation-und-Einrichtung.md b/(DE)-Erste-Schritte---Installation-und-Einrichtung.md index 53d18c6..f21599b 100644 --- a/(DE)-Erste-Schritte---Installation-und-Einrichtung.md +++ b/(DE)-Erste-Schritte---Installation-und-Einrichtung.md @@ -31,16 +31,25 @@ In diesem Beitrag geht es um die erst Konfiguration. Hier werden alle wichtigen ## 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 +#### 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 +#### 2. Nun muss von Github das File **_"nspanel.tft"_** herunter geladen 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. +![Bildschirmfoto 2023-01-23 um 21 31 05](https://user-images.githubusercontent.com/41958506/214161397-ec927f77-be77-433d-84a5-79fbfed33932.png) + + +#### 3. Das File **_"nspanel.tft"_** muss nun auf deinen Home Assistant Server in den Ordner **_"www"_** hochgeladen werden. Siehe dazu auch hier [Home Assistant HTTP](https://www.home-assistant.io/integrations/http/#hosting-files) 'Hosting Files' Bereich für weiter Informationen. + +![Bildschirmfoto 2023-01-23 um 21 33 20](https://user-images.githubusercontent.com/41958506/214162088-3bd67e46-c389-496f-a937-757ad63e1fe2.png) + +#### 4. im nächsten Schritt muss eine neues ESP32 Device in ESPHome erstellt werden + +#### 5. 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. @@ -56,19 +65,21 @@ In diesem Beitrag geht es um die erst Konfiguration. Hier werden alle wichtigen ``` substitutions: -###### CHANGE ME ###### +###### CHANGE ME START ###### device_name: "YOUR NSPANEL_NAME" wifi_ssid: "YOUR WIFI SSID" wifi_password: "YOUR WIFI PASSWORD" -##### CHANGE ME ##### + nextion_update_url: "http://HOME-ASSISTANT-IP:8123/local/nspanel.tft" # URL to local tft File +# nextion_update_url: "https://raw.githubusercontent.com/Blackymas/NSPanel_HA_Blueprint/main/nspanel.tft" # URL to Github + +##### CHANGE ME END ##### ##### 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: @@ -80,18 +91,30 @@ packages: ##### DO NOT CHANGE ANYTHING! ##### ``` + +> Im Pfad **_http://HOME-ASSISTANT-IP:8123/local/nspanel.tft_** muss nun die IP Adresse von deinem _**Home Assistant Server**_ eingetragen werden. (_**/local/**_ ist das selbe Verzeichnis wie **_"www"_** + +> Das kann dann wie folgt aussehen **_http://192.168.1.1:8123/local/nspanel.tft_** + +> ⚠️ **_ACHTUNG_** Du kannst auch den Pfad zu Github verwenden **_https://raw.githubusercontent.com/Blackymas/NSPanel_HA_Blueprint/main/nspanel.tft_** und das TFT direkt von Github herunter laden. Aber dabei kann es zu Problemen mit dem Upload zum NSPanel kommen. Das hängt von deinem Internet und WLAN ab. Für mehr Informationen zu diesem Thema schauen auf der **_Issue_** Seite im Github. Das ganze sollte dann so aussehen + +``` +# nextion_update_url: "http://HOME-ASSISTANT-IP:8123/local/nspanel.tft" # URL to local tft File + nextion_update_url: "https://raw.githubusercontent.com/Blackymas/NSPanel_HA_Blueprint/main/nspanel.tft" # URL to Github +``` +   -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) +#### 6. Jetzt kann das NSPanel mit dem neuen ESPHome Code geflasht werden +> wie das NSPanel geflasht wird kannst du dir hier ansehen [Anleitung - Flash Sonoff NSPanel mit ESPHome](https://www.youtube.com/watch?v=3afPFg6kUdc) -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 +#### 7. 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 +#### 8. 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 von deinem lokalen Home Assistant Server oder 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. +#### 9. 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. +#### 10. 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. diff --git a/(EN)-First-Steps---Installation-and-Setup.md b/(EN)-First-Steps---Installation-and-Setup.md index f857326..ab686a2 100644 --- a/(EN)-First-Steps---Installation-and-Setup.md +++ b/(EN)-First-Steps---Installation-and-Setup.md @@ -1,6 +1,6 @@ This section covers the initial configuration. All important steps for installation and setup of ESPHome and the Blueprint are described here.  -⭐ **_Step by Step [Setup Video](https://www.youtube.com/watch?v=3afPFg6kUdc)_** +⭐ **_Step by Step [Setup Video](https://www.youtube.com/watch?v=jpSTA_ILB8g)_**   @@ -32,44 +32,56 @@ This section covers the initial configuration. All important steps for installat ## 1. Short version of the setup of Esphome and Blueprint > _**(for those who already have experience with ESPhome and Home Assistant)**_ -1. First you have to install the Blueprint. For this please use the following link +#### 1. First you have to install the Blueprint. For this please use the following 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) > It is also possible to copy the code from the file _**"nspnael_blueprint.yaml "**_ and paste it into HA. -> You can find instructions for this under [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) +> You can find instructions for this under [Using Automation Blueprints](https://www.home-assistant.io/docs/automation/using_blueprints/) and [Automation blueprint tutorial](https://www.home-assistant.io/docs/blueprint/tutorial/#create-the-blueprint-file) -2. in the next step you have to create a new ESP32 device in ESPHome +#### 2. You have to download the file **_nspanel.tft_** from Github -3. when the new ESP32 device has been created, next click _**"Edit "**_ on the device you have just created to open the web editor. Now the following code must be copied and pasted. - -> _**IMPORTANT!**_ The already existing code in the ESPHome file must be _**"COMPLETELY "**_ deleted and _**"REPLACED "**_ by the code below. - -> _**IMPORTANT!**_ in the block _**"CHANGE ME "**_ all values _**(device_name, wifi_ssid, wifi_password)**_ in the _**" "**_ must be replaced by your own values. It is also possible to work here with _**"!secret "**_. +![Bildschirmfoto 2023-01-23 um 21 31 05](https://user-images.githubusercontent.com/41958506/214144182-e2a5f28e-e96d-4263-8c4b-b7fbcc6658e7.png) -> _**ATTENTION!**_ for _**"device_name"**_ max. 15 characters _**[a-z] and [0-9]**_ may be used and all must be _**"lowercase"**_. Furthermore, characters like _**[-], [SPECIAL CHARACTARS] and [SPACES]**_ are forbidden and will cause problems with the blueprint. +#### 3. Upload the **_nspnael.tft_** file to your **_Home Assistant Server_** in the **_www_** folder, see [Home Assistant HTTP](https://www.home-assistant.io/integrations/http/#hosting-files) 'Hosting Files' section for details. -**Example:** _**nspanel_blackymas**_ +![Bildschirmfoto 2023-01-23 um 21 33 20](https://user-images.githubusercontent.com/41958506/214144729-08fb5d3f-9255-4f57-9c6e-a5e33665e4df.png) + + +#### 4. In the next step you have to create a new ESP32 device in ESPHome + +#### 5. When the new ESP32 device has been created, next click _**"Edit "**_ on the device you have just created to open the web editor. Now the following code must be copied and pasted. + +> ❗ _**IMPORTANT!**_ The already existing code in the ESPHome file must be _**"COMPLETELY "**_ deleted and _**"REPLACED "**_ by the code below. + +> ❗ _**IMPORTANT!**_ in the block _**"CHANGE ME "**_ all values _**(device_name, wifi_ssid, wifi_password, nextion_update_url )**_ in the _**" "**_ must be replaced by your own values. It is also possible to work here with _**"!secret "**_. + + +> ⚠️ _**ATTENTION!**_ for _**"device_name"**_ max. 15 characters _**[a-z], [0-9] and [\_]**_ may be used and all must be _**"lowercase"**_. Furthermore, characters like _**[-], [SPECIAL CHARACTARS] and [SPACES]**_ are forbidden and will cause problems with the blueprint. + +**Example:** _**nspanel_kitchen**_   ### CODE: ``` substitutions: -###### CHANGE ME ###### +###### CHANGE ME START ###### device_name: "YOUR NSPANEL_NAME" wifi_ssid: "YOUR WIFI SSID" wifi_password: "YOUR WIFI PASSWORD" -##### CHANGE ME ##### + nextion_update_url: "http://HOME-ASSISTANT-IP:8123/local/nspanel.tft" # URL to local tft File +# nextion_update_url: "https://raw.githubusercontent.com/Blackymas/NSPanel_HA_Blueprint/main/nspanel.tft" # URL to Github + +##### CHANGE ME END ##### ##### 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: @@ -81,22 +93,33 @@ packages: ##### DO NOT CHANGE ANYTHING! ##### ``` +> At **_http://HOME-ASSISTANT-IP:8123/local/nspanel.tft_** you have to enter your _**IP from Home Assistant**_. + +> This could look like this **_http://192.168.1.1:8123/local/nspanel.tft_** + +> ⚠️ _**ATTENTION!**_ You can also comment out the path nextion_update_url: "https://raw.githubusercontent.com/Blackymas/NSPanel_HA_Blueprint/main/nspanel.tft" and load the TFT directly from Github. But it can happen that there are problems with the upload to the NSPanel. This depends on your internet and wifi. For more information on this issue, see the issue page on Github. It should then look like this + +``` +# nextion_update_url: "http://HOME-ASSISTANT-IP:8123/local/nspanel.tft" # URL to local tft File + nextion_update_url: "https://raw.githubusercontent.com/Blackymas/NSPanel_HA_Blueprint/main/nspanel.tft" +``` +   -4. Now the NSPanel can be flashed with the new ESPHome code. -> how to flash the NSPanel you can see here [HOW TO - Flash Sonoff NSPanel with ESPHome](https://www.youtube.com/watch?v=p-AK4o5jOSI) +#### 6. Now the NSPanel can be flashed with the new ESPHome code. +> how to flash the NSPanel you can see here [HowTo - Flash NSPanel with ESPhome](https://www.youtube.com/watch?v=jpSTA_ILB8g) -5. After the NSPanel is flashed, you can go to _**"Settings --> Devices & Services --> Add Integration"**_ to add your new device and finish setting it up. +#### 7. After the NSPanel is flashed, you can go to _**"Settings --> Devices & Services --> Add Integration"**_ to add your new device and finish setting it up. -6. In the last step, only the TFT must be uploaded. To do this, open your new device in the ESPHome integration and activate the item _**"Update TFT display "**_ under _**"Configuration"**_. Now the current TFT file is loaded from Github and uploaded to your NSPanel. _**ATTENTION!**_ this process may take a moment. +#### 8. In the last step, only the TFT must be uploaded. To do this, open your new device in the ESPHome integration and activate the item _**"Update TFT display "**_ under _**"Configuration"**_. Now the current TFT file is loaded from local Home Assistant Server or Github and uploaded to your NSPanel. _**ATTENTION!**_ this process may take a moment. -7. now the setup of ESPHome and NSPanel is completed. +#### 9. now the setup of ESPHome and NSPanel is completed. -8. Now you can configure your NSPanel via the Blueprint. To do this, go to _**"Settings --> Automations & Scenes --> Templates --> NSPanel Configuration --> CREATE AUTOMATION"**_ and start with the setup of the NSPanel. +#### 10. Now you can configure your NSPanel via the Blueprint. To do this, go to _**"Settings --> Automations & Scenes --> Templates --> NSPanel Configuration --> CREATE AUTOMATION"**_ and start with the setup of the NSPanel. > _**NOTE!**_ In the blueprint, in the _**"ESPHOME Node Name"**_ field, enter exactly the same name that you assigned in the _**"ESPHome File"**_. -> **Beispiel:** _**nspanel_blackymas**_ +> **Example:** _**nspanel_kitchen**_     diff --git a/Home.md b/Home.md index 330191e..7ceea5e 100644 --- a/Home.md +++ b/Home.md @@ -14,6 +14,8 @@ DE - **_[Einrichtungs und Konfigurations Video](https://www.youtube.com/watch?v= EN - **_[Overview and features](https://www.youtube.com/watch?v=b7vW4YtUaTs) - Mark Watt Tech_** +EN - **_[HOW TO Setup](https://www.youtube.com/watch?v=jpSTA_ILB8g) - Mark Watt Tech_** +     # Navigation: