diff --git a/(EN)-First-Steps---Installation-and-Setup.md b/(EN)-First-Steps---Installation-and-Setup.md index 9b34fcf..32a48b3 100644 --- a/(EN)-First-Steps---Installation-and-Setup.md +++ b/(EN)-First-Steps---Installation-and-Setup.md @@ -57,72 +57,64 @@ This section covers the initial configuration. All important steps for installat > ❗ _**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_blackymas**_ -   ### CODE: ```yaml substitutions: + ###### CHANGE ME START ###### + device_name: "YOUR_NSPANEL_NAME" + wifi_ssid: !secret wifi_ssid + wifi_password: !secret wifi_password -###### CHANGE ME START ###### + nextion_update_url: "http://homeassistant.local:8123/local/nspanel_eu.tft" - device_name: "YOUR NSPANEL_NAME" - wifi_ssid: "YOUR WIFI SSID" - wifi_password: "YOUR WIFI PASSWORD" + ##### addon-configuration ##### + ## addon_climate ## + # addon_climate_heater_relay: "1" # possible values: 1/2 - nextion_update_url: "http://HOME-ASSISTANT-IP:8123/local/nspanel_us.tft" # URL to local tft File -# nextion_update_url: "https://raw.githubusercontent.com/Blackymas/NSPanel_HA_Blueprint/main/nspanel_us.tft" # URL to Github - -##### CHANGE ME END ##### - - - -##### DO NOT CHANGE ANYTHING! ##### + ##### CHANGE ME END ##### packages: - ##### download esphome code from Github remote_package: url: https://github.com/Blackymas/NSPanel_HA_Blueprint ref: main - files: [nspanel_esphome.yaml] + files: + - nspanel_esphome.yaml # Core package + # - nspanel_esphome_advanced.yaml # activate advanced (legacy) elements - can be useful for troubleshooting + # - nspanel_esphome_addon_climate_cool.yaml # activate for local climate (cooling) control + # - nspanel_esphome_addon_climate_heat.yaml # activate for local climate (heater) control refresh: 300s -##### DO NOT CHANGE ANYTHING! ##### +##### My customization - Start ##### +##### My customization - End ##### ``` - -> 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_us.tft_** - -> ⚠️ _**ATTENTION!**_ You can also comment out the path nextion_update_url: "https://raw.githubusercontent.com/Blackymas/NSPanel_HA_Blueprint/main/nspanel_us.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 +> ⚠️ _**ATTENTION!**_ You can also comment out the path `nextion_update_url: "https://raw.githubusercontent.com/Blackymas/NSPanel_HA_Blueprint/main/nspanel_us.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 Wi-Fi. For more information on this issue, see the issue page on GitHub. It should then look like this: ```yaml -# nextion_update_url: "http://HOME-ASSISTANT-IP:8123/local/nspanel_us.tft" # URL to local tft File - nextion_update_url: "https://raw.githubusercontent.com/Blackymas/NSPanel_HA_Blueprint/main/nspanel_us.tft" +# nextion_update_url: "http://homeassistant.local:8123/local/nspanel_eu.tft" # URL to local tft File + nextion_update_url: "https://raw.githubusercontent.com/Blackymas/NSPanel_HA_Blueprint/main/nspanel_eu.tft" ``` -> _⚠️ **Attention**_if you want to use the European Layout of the NSPanel, you must use "nspanel_eu.tft" instead of "nspanel_us.tft"! +> _⚠️ **Attention**_The following TFT files are available and can be replaced in your url accordingly: +- `nspanel_eu.tft` (European layout) +- `nspanel_us.tft` (US layout) +- `nspanel_us_land.tft` (US layout - landscape orientation) +   #### 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) +> How to flash the NSPanel you can see here: [HowTo - Flash NSPanel with ESPhome](https://www.youtube.com/watch?v=jpSTA_ILB8g) #### 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. -#### 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. +#### 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 will take up to 30 minutes. -#### 9. now the setup of ESPHome and NSPanel is completed. +#### 9. Now the setup of ESPHome and NSPanel is completed. #### 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"**_. - -> **Example:** _**nspanel_blackymas**_ - +> _**NOTE!**_ In the blueprint, the field _**"NSPanel device"**_ is required. Although you can still save the automation without a device selected, it would be unusable without that information.     @@ -141,13 +133,34 @@ See [(EN) Common Issues | TFT Upload When nspanel lovelace ui has been installed     ## 3. Advanced configuration for all ESPHome and Home Assistant professionals +> _**ATTENTION!**_ Customizations and advanced mode are not supported by this project's team. Use this with caution and only when you know what you are doing. -* Blueprint file _**"nspnael_blueprint.yaml "**_ can also be installed manually. -* ESPHome file_**"nspanel_esphome.yaml "**_ can also be installed manually. This allows to activate or add more _**"Advanced "**_ configurations. +Before you start customizing your system, we would like to invite you to share anything nice you achieve. You can always create a new [Pull Request](https://github.com/Blackymas/NSPanel_HA_Blueprint/pulls) to `dev` branch and this will give a chance for other users with similar challenges to take advantage of your discoveries. + +The simpler way to go "advanced" with ESPHome is to use "Customizations". We have a page specifically for that where, again, your contribution is very welcome: https://github.com/Blackymas/NSPanel_HA_Blueprint/blob/main/docs/en/customization.md + +If you want for some reason use a local copy of `nspanel_esphome.yaml`, you can copy the file from GitHub to you local file system and reference in your ESPHome settings like this: + +```yaml +substitutions: + ###### CHANGE ME START ###### + device_name: office-workstation-panel + wifi_ssid: !secret wifi_ssid + wifi_password: !secret wifi_password + + nextion_update_url: "http://homeassistant.local:8123/local/nspanel_us_land.tft" + + ##### CHANGE ME END ##### + +packages: + local_package: !include packages/nspanel_esphome.yaml +``` +> Note that a sub-folder was used in the example above in order to avoid that file to be added as an additional device in your ESPHome dashboard. You can also have the file in the same folder, but with it's name starting with `.`, so ESPHome dashboard understands that file should be ignored when listing devices. + + +* Blueprint file _**"nspanel_blueprint.yaml "**_ can also be installed manually. * There is also the possibility to upload the TFT file _**"nspanel_us.tft "**_ manually. The whole thing can also be combined with a _**"Folder Watcher "**_. -* additionally we provide the HMI file _**"nspanel_us.HMI "**_ for the Nextion Editor to customize graphics and programming if needed - -> _**ATTENTION!**_ If you use this mode, you should know what you are doing. We do not give support here! +* additionally we provide the HMI files _**"nspanel_xx.HMI "**_ for the Nextion Editor to customize graphics and programming if needed.