Direct TFT Transfer from GitHub for Arduino Users

This commit is contained in:
Edward Firmo
2024-02-07 23:57:55 +01:00
parent b02be58888
commit 0b8ac56521
6 changed files with 22 additions and 109 deletions

View File

@@ -18,56 +18,9 @@ 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**.
**Older versions or `arduino` framework:**
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"
friendly_name: "Your panel's friendly name"
wifi_ssid: !secret wifi_ssid
wifi_password: !secret wifi_password
nextion_update_url: "http://homeassistant.local:8123/local/nspanel_eu.tft"
nextion_blank_url: "http://homeassistant.local:8123/local/nspanel_blank.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
# - nspanel_esphome_addon_climate_dual.yaml # activate for local climate (dual) control
refresh: 300s
esp32:
framework:
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`.
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`?
![image](https://github.com/Blackymas/NSPanel_HA_Blueprint/assets/94725493/3b0bb950-4857-4c22-a53a-062d09f315dc)
@@ -75,21 +28,9 @@ 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**.
**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)
- [`nspanel_us_land.tft`](../nspanel_us_land.tft)
Now Flash your panel with `nextion_update_url` pointing to one of the final TFT files and
press **Upload TFT** in the device's page (**Settings** > **Devices & Services** > **ESPHome**).
## Additional Tips and Resources
We have an useful guide for [troubleshooting TFT transfer issues](tft_upload.md).
Please take a look there first.