diff --git a/custom_configuration/nspanel_blank.HMI b/custom_configuration/nspanel_blank.HMI index ed78da1..da48719 100644 Binary files a/custom_configuration/nspanel_blank.HMI and b/custom_configuration/nspanel_blank.HMI differ diff --git a/docs/en/customization.md b/docs/en/customization.md index 3f79f83..1b46bfb 100644 --- a/docs/en/customization.md +++ b/docs/en/customization.md @@ -37,8 +37,9 @@ packages: url: https://github.com/Blackymas/NSPanel_HA_Blueprint ref: main files: - - nspanel_esphome.yaml - #- nspanel_esphome_addon_climate.yaml # activate local climate-control + - nspanel_esphome.yaml # Core package + # - 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 ##### My customization - Start ##### diff --git a/docs/en/nspanel_blank.md b/docs/en/nspanel_blank.md new file mode 100644 index 0000000..3b8c246 --- /dev/null +++ b/docs/en/nspanel_blank.md @@ -0,0 +1,52 @@ +# `nspanel_blank.tft` + +The NSPanel consist in a ESP32 board (the panel itself, controlling the relays, buttons, communications, etc.) with a Nextion display connected to. + +This Nextion display have an independent controller which also requires a firmware and its settings (the basic layout), and this is done by an `.tft` file. + +When you get your panel from Sonoff, their `tft` file is installed in the Nextion display and using a called "Reparse mode", which makes a bit challenging to replace the `tft` file when using ESPHome and then, we highly recoment you using `nspanel_blank.tft`, which is just a fraction of the size of a regular `tft` and will make the first `tft` replacement much easier. + +Once NSPanel's original `tft` is replaced, is much easier to install a new `tft` with ESPHome, so you can go directly to the final file (either `nspanel_eu.tft`, `nspanel_us.tft` or `nspanel_us_land.tft`). + +For more datails on how to install the first `tft` file, specially if your panel still displaying the original Sonoff screen, please refeer to the Wiki where you will find the doc ["Common Issues TFT Upload"](https://github.com/Blackymas/NSPanel_HA_Blueprint/wiki/(EN)-Common-Issues-TFT-Upload). + + +## How to install a different `tft` file? + +On your ESPHome settings, you have entered a url for `nextion_update_url`, in the substitutions, like this: + +```yaml +substitutions: + ###### CHANGE ME START ###### + device_name: "YOUR_NSPANEL_NAME" + wifi_ssid: !secret wifi_ssid + wifi_password: !secret wifi_password + + nextion_update_url: "http://homeassistant.local:8123/local/nspanel_us.tft" + + ##### addon-configuration ##### + ## addon_climate ## + # addon_climate_heater_relay: "1" # possible values: 1/2 + + ##### CHANGE ME END ##### + +packages: + remote_package: + url: https://github.com/Blackymas/NSPanel_HA_Blueprint + ref: main + files: + - nspanel_esphome.yaml # Core package + # - 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 +``` + +This url will indicate where your panel will look for the `tft` file when you click the "Upload TFT" button (under device's page) or call the service `esphome.xxxxx_upload_tft`. + +The most popular way to switch between the `nspanel_blank.tft` and `nspanel_xx.tft` is replacing the URL on the ESPHome settings and flashing the device again, however, you can also do this calling the service `esphome.xxxxx_upload_tft_url` adding the URL of the alternative file as a parameter. It's up to you, as both ways will give the same result. + +## What to do after installing `nspanel_blank.tft`? + +Once you have sucessfully installed any of the `tft` files from this project, the `nspanel_blank.tft` file shouldn't be necessary anymore and you should be able to always install the final `tft` file. + +Just make sure you flashed your panel with `nextion_update_url` pointing to one of the final files (`nspanel_eu.tft`, `nspanel_us.tft` or `nspanel_us_land.tft`) and click "Upload TFT" in the device's page (Settings > Devices & Services > ESPHome). \ No newline at end of file