From b215f1779db04c495c248c1eb39d0a8253afd06e Mon Sep 17 00:00:00 2001 From: Edward Firmo <94725493+edwardtfn@users.noreply.github.com> Date: Tue, 19 Sep 2023 11:20:13 +0200 Subject: [PATCH] Refresh docs --- custom_configuration/nspanel_blank.HMI | Bin 7343834 -> 7346184 bytes docs/en/customization.md | 5 ++- docs/en/nspanel_blank.md | 52 +++++++++++++++++++++++++ 3 files changed, 55 insertions(+), 2 deletions(-) create mode 100644 docs/en/nspanel_blank.md diff --git a/custom_configuration/nspanel_blank.HMI b/custom_configuration/nspanel_blank.HMI index ed78da1fc28567892917f8c87fc068136d14dd96..da4871976cc02c000419dc5c2b4b046f459ebdf3 100644 GIT binary patch delta 2291 zcmeHIOHb5L6uxa|1~7>DNPHkVG(;CNLkCP`P*8jzs3?f|VnEAKnSp8NrZW%?Q6M>u zZcH>f>57F56BAv?f{n)Lh>0;Sx^Q743-=oF+|CRZjFE-9(VOP>o^!tQ_4J;v zw{OR%g&U8j1up+Kx7qdSy*qHbZ0*Qrfe`Xyh7dWb`I}mr(Xz*Yi;_`XaR_YH<9)iU z`V*ND`G~O;hsK*3BKfJDb=$X54<&PXxI|8M31_S*!%2{nY%do^32DnD;XH@ICM4x% zu$U#JJBulqMN$q)>+>GA*h$$b7h?|$j@~aCOB-pRHa0br8IXDlU5P~k~h6`{JWaxn~^nwDHpbsJt zg?<=-7^t8@{4S;S{iz)uChZzj2~(;)PLz>ESXUG+ArC3K?cy31qPAU#^OTT!LTk5{ z;4W|gP}kAGG?vEzLvm~|OToy(5m{RZ zDS9Fr*D{$^QdPBI3i<=Vka%@zRjYDUMZArTnaho?-l$q<1_fHSDzJhfkl$<9X?6-! zbon;6-!m%<=mw5YmD2Wt+<6c%uX*U5DKVcGaHXxrhkSM{uzs);#~#=ZnwTkdHMcRmrbtbpfWIaJ*MZ3{u~sz*Iz_&-t!JzMq1Tgs`5<$)qp18W+hc^t-&# zu4c|?FHVlZn-c@kfWQ-4xTo|)?hptRUIfo-p#XYMO)+~9Q&y3(h;xdzG}y7 zNjZT@#R#&c#(M2-@BsP-S(hwlk4f$h}8PXW-nuGz_yCEUP?LSdvcv( zvjH*)CEXCI?!F#BK%dPkq$WLQA;z>fG4_gTKc(8<*$lB!mcILZq5t(Qivrz`FhyF5|!^fXD)o1tJSX7KkhmSzysm zOaDT`9I!88Y{i|}hP!Y#W^fO-V+VHPUfhTKu?r92LF~pJJcPY?82j)D_TvB!;!!+? z$8iXU@dTd4Q+OKB;8{F}=kWrLppIG0VIDaau!y5*;6=QICYDg3bw|n#y`MM!@OP3n z#alaH`kOSV7kSzpjLXKFb#(UPSL_|>XMyQQvdxW0WnI`$tA32jWWa3*$tL&fTDis@ z4$1oJ?UnLj!1HUS>RD!bM8@64ki0c!2n9~XNoUeYQd^hRwoDp4X=&+HAZ_k&p^~6R zIplf45QZ`=0agKurj^xAxT4#Jo;5jG!mNN(meR771KYP`D~f|-6a~)%HR45XLo*qh zlAwz`SZZ{PPEsoT2WO}9A+i)LM}&hshgDL}<4!&S-#WkK1Y zUdlE^(XW{FgE?LJf!`zMETL@6q;Y&c3Gd0g+eS&6yhJ>!<*;1E=x4Zkovd|ZQCa_& fckKwUW_Mw=Y>W$j%^NmlD6Z#IxtzNclRJI_q8Up# 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