h3n3/NSPanel_HA_Blueprint
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Lint

Browse Source
This commit is contained in:
Edward Firmo
2024-01-11 01:13:57 +01:00
parent c642da6c3c
commit ff42959751
1 changed files with 24 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

39
docs/nspanel_blank.md
View File

@@ -1,27 +1,30 @@
# `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.
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.
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.
You can find this file under the folder [`custom_configuration`](/custom_configuration).
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"](/wiki/(EN)-Common-Issues-TFT-Upload).
please refeer to the [Troubleshooting TFT transfer](tft_upload.md) guide.
## How to install a different `tft` file?
### v4.2 or later and `esp-idf` framework
Just go to your devices's page (under **Settings** > **Devices and Services** > **ESPHome**), select your **Upload TFT display - Model** and then press **Upload TFT display**.
**v4.2 or later and `esp-idf` framework:**
Just go to your devices's page (under **Settings** > **Devices and Services** > **ESPHome**),
select your **Upload TFT display - Model** and then press **Upload TFT display**.
**Older versions or `arduino` framework:**
### Older versions or `arduino` framework
On your ESPHome settings, you have entered a url for `nextion_update_url`, in the substitutions, like this:
```yaml
@@ -56,10 +59,12 @@ esp32:
type: esp-idf
```
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`.
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.
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`?
@@ -69,10 +74,13 @@ It's up to you, as both ways will give the same result.
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.
### v4.2 or later and `esp-idf` framework
Just go to your devices's page (under **Settings** > **Devices and Services** > **ESPHome**), select your **Upload TFT display - Model** and then press **Upload TFT display**.
**v4.2 or later and `esp-idf` framework:**
Just go to your devices's page (under **Settings** > **Devices and Services** > **ESPHome**),
select your **Upload TFT display - Model** and then press **Upload TFT display**.
**Older versions or `arduino` framework:**
### Older versions or `arduino` framework
Make sure you have one of the following final TFT files in your local http server (typically Home Assistant on ***www*** folder):
- [`nspanel_eu.tft`](../nspanel_eu.tft)
- [`nspanel_us.tft`](../nspanel_us.tft)
@@ -85,7 +93,8 @@ press **Upload TFT** in the device's page (**Settings** > **Devices & Services**
We have an useful guide for [troubleshooting TFT transfer issues](tft_upload.md).
Please take a look there first.
After troubleshooting, if issues persist, consult the [Issues](/Blackymas/NSPanel_HA_Blueprint/issues) and feel free to create a new one asking for more personalized assistance.
After troubleshooting, if issues persist, consult the [Issues](https://github.com/Blackymas/NSPanel_HA_Blueprint/issues)
and feel free to create a new one asking for more personalized assistance.
Please share as much info as possible, like:
1. Describing (or a picture of) what is in your screen