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

Standardize suggested yaml between docs

Browse Source 
Supports #1256
This commit is contained in:
Edward Firmo
2023-12-16 20:36:55 +01:00
parent a070626ee1
commit 884bef9774
4 changed files with 27 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
docs/en/addon_climate.md
View File

@@ -24,6 +24,7 @@ substitutions:
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 ##
@@ -39,9 +40,13 @@ packages:
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
- nspanel_esphome_addon_climate_heat.yaml # activate for local climate (heater) control
refresh: 300s
esp32:
framework:
type: esp-idf
```
 
## Configuration

13
docs/en/customization.md
View File

@@ -56,7 +56,8 @@ substitutions:
wifi_ssid: !secret wifi_ssid
wifi_password: !secret wifi_password
nextion_update_url: "http://homeassistant.local:8123/local/nspanel_us.tft"
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 ##
@@ -70,9 +71,9 @@ packages:
ref: main
files:
- nspanel_esphome.yaml # Core package
# - advanced/esphome/nspanel_esphome_addon_climate_cool.yaml # activate for local climate (cooling) control
# - advanced/esphome/nspanel_esphome_addon_climate_heat.yaml # activate for local climate (heater) control
refresh: 1s
# - 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
esp32:
framework:
@@ -248,12 +249,12 @@ button:
state: false
- delay: 16ms
- lambda: |-
id(disp1)->set_tft_url("${nextion_update_blank_url}");
id(disp1)->set_tft_url("${nextion_blank_url}");
id(disp1).upload_tft();
```
You also must add the url for the alternative tft in your substitutions, like this:
```yaml
nextion_update_blank_url: "http://homeassistant.local:8123/local/nspanel/dev/nspanel_blank.tft"
nextion_blank_url: "http://homeassistant.local:8123/local/nspanel_blank.tft"
```
 

10
docs/en/install.md
View File

@@ -146,12 +146,17 @@ substitutions:
wifi_ssid: !secret wifi_ssid
wifi_password: !secret wifi_password
nextion_update_url: "http://homeassistant.local:8123/local/nspanel_us_land.tft"
nextion_update_url: "http://homeassistant.local:8123/local/nspanel_eu.tft"
nextion_blank_url: "http://homeassistant.local:8123/local/nspanel_blank.tft"
##### CHANGE ME END #####
packages:
local_package: !include packages/nspanel_esphome.yaml
esp32:
framework:
type: esp-idf
```
> 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.
@@ -161,6 +166,3 @@ packages:
* additionally we provide the HMI files _**"nspanel_xx.HMI "**_ for the Nextion Editor to customize graphics and programming if needed.
 
 
***

7
docs/en/nspanel_blank.md
View File

@@ -22,7 +22,8 @@ substitutions:
wifi_ssid: !secret wifi_ssid
wifi_password: !secret wifi_password
nextion_update_url: "http://homeassistant.local:8123/local/nspanel_us.tft"
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 ##
@@ -39,6 +40,10 @@ packages:
# - 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
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`.