Compare commits
48 Commits
f0661f0a6c
...
68d921c1ee
| Author | SHA1 | Date | |
|---|---|---|---|
|
68d921c1ee | ||
|
|
a259d354b3 | ||
|
|
02b7420798 | ||
|
|
5470794a17 | ||
|
|
f410a205e9 | ||
|
|
706c600c5c | ||
|
|
bed6d63c7a | ||
|
|
f77657fabb | ||
|
|
d4949d16d7 | ||
|
|
9686a62619 | ||
|
|
1896e4fc68 | ||
|
|
f12d4c1eea | ||
|
|
d235ddb4ac | ||
|
|
4d540a8b94 | ||
|
|
daa9142f7f | ||
|
|
a617a84dc7 | ||
|
|
c0ffb0896c | ||
|
|
03d04fcd6b | ||
|
|
75c2ff88b7 | ||
|
|
3b1a704b36 | ||
|
|
c35808b560 | ||
|
|
9c0958dc51 | ||
|
|
de3ec8e3d9 | ||
|
|
f69b48df52 | ||
|
|
371803dcf3 | ||
|
|
bcc8794b19 | ||
|
|
c3b11eb581 | ||
|
|
ddbe7d9723 | ||
|
|
216f6f3102 | ||
|
|
db8e204fa6 | ||
|
|
afea2518ce | ||
|
|
484fc4ba8c | ||
|
|
d158a801ad | ||
|
|
5268e214a3 | ||
|
|
71e33527a5 | ||
|
|
671145a56b | ||
|
|
65dc1cdf25 | ||
|
|
e766b8ccb9 | ||
|
|
bba6eb2aa6 | ||
|
|
ad2edfd905 | ||
|
|
716845bd0b | ||
|
|
8e70389fc4 | ||
|
|
c08c133a15 | ||
|
|
70e6a88638 | ||
|
|
469a84492c | ||
|
|
099f530947 | ||
|
|
f6b400aafa | ||
|
|
dae5d5b574 |
50
.github/workflows/validate_markdown.yml
vendored
50
.github/workflows/validate_markdown.yml
vendored
@@ -2,44 +2,40 @@ name: Validate Markdown
|
||||
|
||||
on:
|
||||
pull_request:
|
||||
paths:
|
||||
- '**/*.md'
|
||||
push:
|
||||
paths:
|
||||
- '**/*.md'
|
||||
workflow_dispatch:
|
||||
|
||||
|
||||
jobs:
|
||||
markdown-lint-quick:
|
||||
markdown-lint:
|
||||
name: Markdown Lint
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Check out code
|
||||
uses: actions/checkout@v4.1.0
|
||||
|
||||
# https://github.com/marketplace/actions/markdownlint-cli2-action
|
||||
#- name: Identify changed files
|
||||
# uses: tj-actions/changed-files@v41
|
||||
# id: changed-files
|
||||
# with:
|
||||
# files: '**/*.md'
|
||||
# separator: ","
|
||||
- name: Identify changed files
|
||||
uses: tj-actions/changed-files@v41
|
||||
id: changed-files
|
||||
with:
|
||||
files: '**/*.md'
|
||||
separator: ","
|
||||
# https://github.com/marketplace/actions/markdownlint-cli2-action
|
||||
- name: Markdown Lint
|
||||
uses: DavidAnson/markdownlint-cli2-action@v14
|
||||
# if: steps.changed-files.outputs.any_changed == 'true'
|
||||
if: steps.changed-files.outputs.any_changed == 'true'
|
||||
with:
|
||||
# globs: ${{ steps.changed-files.outputs.all_changed_files }}
|
||||
# separator: ","
|
||||
config: '.rules/custom.markdownlint.jsonc'
|
||||
|
||||
markdown-lint-detailed:
|
||||
runs-on: ubuntu-latest
|
||||
needs:
|
||||
- markdown-lint-quick
|
||||
steps:
|
||||
- name: Check out code
|
||||
uses: actions/checkout@v4.1.0
|
||||
|
||||
# https://github.com/actionshub/markdownlint
|
||||
- name: Markdown Lint
|
||||
uses: actionshub/markdownlint@main
|
||||
globs: ${{ steps.changed-files.outputs.all_changed_files }}
|
||||
separator: ","
|
||||
config: '.rules/.markdownlint.jsonc'
|
||||
fix: true
|
||||
|
||||
markdown-links:
|
||||
name: Check links
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Check out code
|
||||
@@ -49,6 +45,6 @@ jobs:
|
||||
- name: Markdown links
|
||||
uses: gaurav-nelson/github-action-markdown-link-check@v1
|
||||
with:
|
||||
CHECK_MODIFIED_FILES: yes
|
||||
|
||||
|
||||
check-modified-files-only: yes
|
||||
config-file: '.rules/mlc_config.json'
|
||||
base-branch: 'main'
|
||||
|
||||
4
.rules/.markdownlint.jsonc
Normal file
4
.rules/.markdownlint.jsonc
Normal file
@@ -0,0 +1,4 @@
|
||||
{
|
||||
"MD013": { "line_length": 200 }
|
||||
}
|
||||
|
||||
@@ -1,3 +0,0 @@
|
||||
{
|
||||
"line-length": 200
|
||||
}
|
||||
13
.rules/mlc_config.json
Normal file
13
.rules/mlc_config.json
Normal file
@@ -0,0 +1,13 @@
|
||||
{
|
||||
"ignorePatterns": [
|
||||
{
|
||||
"pattern": "^http://homeassistant\\.local.*$"
|
||||
},
|
||||
{
|
||||
"pattern": "^https://sonoff.tech/product/central-control-panel/nspanel/$"
|
||||
},
|
||||
{
|
||||
"pattern": "^https://sonoff.tech/wp-content/uploads/2021/11/%E4%BA%A7%E5%93%81%E5%8F%82%E6%95%B0%E8%A1%A8-NSPanel-20210831.pdf$"
|
||||
}
|
||||
]
|
||||
}
|
||||
84
README.md
84
README.md
@@ -1,16 +1,15 @@
|
||||
*Are you happy with our version for NSPanel? Please consider supporting us with a donation.*
|
||||
<br>[](https://www.paypal.com/donate/?hosted_button_id=S974SWQMB8PB2)
|
||||
|
||||
[](https://my.home-assistant.io/redirect/blueprint_import/?blueprint_url=https%3A%2F%2Fgithub.com%2FBlackymas%2FNSPanel_HA_Blueprint%2Fblob%2Fmain%2Fnspanel_blueprint.yaml)
|
||||
|
||||
[](https://github.com/Blackymas/NSPanel_HA_Blueprint/actions/workflows/validate_esphome.yml)
|
||||
[](https://github.com/Blackymas/NSPanel_HA_Blueprint/actions/workflows/validate_esphome_beta.yml)
|
||||
|
||||
# NSPanel Custom with HA Blueprint
|
||||
|
||||
This innovative solution is designed to revolutionize how you interact with your Sonoff NSPanel. Our goal? To make the customization of your NSPanel seamless, intuitive, and completely code-free!
|
||||
|
||||
*Are you happy with our version for NSPanel? Please consider supporting us with a donation.*
|
||||
|
||||
[](https://www.paypal.com/donate/?hosted_button_id=S974SWQMB8PB2)
|
||||
|
||||
[](https://my.home-assistant.io/redirect/blueprint_import/?blueprint_url=https%3A%2F%2Fgithub.com%2FBlackymas%2FNSPanel_HA_Blueprint%2Fblob%2Fmain%2Fnspanel_blueprint.yaml)
|
||||
|
||||
## Table of Contents
|
||||
|
||||
1. [Project Highlights](#-project-highlights)
|
||||
2. [Documentation & Resources](#-documentation--resources)
|
||||
3. [Features](#-features)
|
||||
@@ -32,7 +31,7 @@ This innovative solution is designed to revolutionize how you interact with your
|
||||
- **Getting Started:** Dive into our comprehensive [Documentation and Setup Guide](docs/README.md) for detailed instructions.
|
||||
- **Video Tutorial:** Prefer visual learning? Check out our [Step-by-Step Setup Video](docs/README.md).
|
||||
- **Troubleshooting:** Encounter an issue? Here's how to report it: [WIKI HowTo](docs/README.md).
|
||||
- **Feature Requests:** Got ideas? Share them [here](/Blackymas/NSPanel_HA_Blueprint/labels/new%20feature%20request).
|
||||
- **Feature Requests:** Got ideas? Share them [here](https://github.com/Blackymas/NSPanel_HA_Blueprint/labels/new%20feature%20request).
|
||||
- **What's Next?:** Discover what's next and what we are working on right now in our [Milestones](https://github.com/Blackymas/NSPanel_HA_Blueprint/milestones?direction=asc&sort=due_date)
|
||||
|
||||
## 🚀 Features
|
||||
@@ -54,13 +53,12 @@ This innovative solution is designed to revolutionize how you interact with your
|
||||
- 2 physical switches with optional fallback mode
|
||||
- and much more ;)
|
||||
|
||||
|
||||
## 📖 Pages Overview
|
||||
|
||||
|
||||
### Home
|
||||
|
||||
|
||||
<br>
|
||||
|
||||
|
||||
|
||||
- Current weather with button to Weather Forcast page
|
||||
@@ -73,8 +71,8 @@ This innovative solution is designed to revolutionize how you interact with your
|
||||
- Room humidity
|
||||
- Up to 3 user's selectable entities
|
||||
|
||||
|
||||
### Buttons Pages
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -84,21 +82,21 @@ This innovative solution is designed to revolutionize how you interact with your
|
||||
- Button labels can be assigned via blueprint
|
||||
- All buttons feature a long-press function
|
||||
- Automatic detection of light, cover, fan, media player, alarm or climate entities for submenus through long press
|
||||
- Swipe between all pages
|
||||
- Swipe between all pages
|
||||
- Swipe up and down for quick access to specific pages
|
||||
|
||||
|
||||
### Entities Pages
|
||||
|
||||
|
||||
<br>
|
||||
|
||||
|
||||
|
||||
- Up to 8 entities per page, across 4 different pages, totaling 32 entities
|
||||
- Icons and labels can be individually configured via blueprint or automatically detected for each entity
|
||||
- Flexible alignment options for values as per user preference
|
||||
|
||||
|
||||
### Light Settings
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -109,8 +107,8 @@ This innovative solution is designed to revolutionize how you interact with your
|
||||
- Color temperature slider
|
||||
- Jump back to the right button page
|
||||
|
||||
|
||||
### Cover Settings
|
||||
|
||||
|
||||
|
||||
- Open and close cover
|
||||
@@ -118,29 +116,28 @@ This innovative solution is designed to revolutionize how you interact with your
|
||||
- Cover battery value (when available)
|
||||
- jump back to the right button page
|
||||
|
||||
|
||||
### Thermostat / Climate
|
||||
- Target temperature control slider
|
||||
|
||||
- Target temperature control slider
|
||||
- Current temperature
|
||||
- 4 user's selectable values (for water and external temperatures, etc.)
|
||||
- All the standard climate controls from Home Assistant (`heat`, `fan`, `cool`, `auto`, `dry`)
|
||||
- 2 user's selectable buttons
|
||||
- [Can be used for local control (even when Wi-Fi is unavailable) when your panel's relays are used to control your cooler/heater](docs/addon_climate.md)
|
||||
|
||||
|
||||
### Fan speed
|
||||
|
||||
- Turn-on and turn-off fan
|
||||
- Set speed via slider or buttons
|
||||
- jump back to the right button page
|
||||
|
||||
|
||||
### Alarm
|
||||
|
||||
- Arm/disarm an alarm (standard modes supported by Home Assistant)
|
||||
- Support to numeric pin for arming or disarming
|
||||
|
||||
|
||||
|
||||
### Weather Forecast
|
||||
|
||||
|
||||
|
||||
- 5 days weather forecast via swipe (supports most used weather integrations)
|
||||
@@ -153,11 +150,10 @@ This innovative solution is designed to revolutionize how you interact with your
|
||||
- Thunderstorm probability
|
||||
- Wind speed
|
||||
|
||||
|
||||
### Display Settings
|
||||
|
||||
|
||||
<br>
|
||||
|
||||
|
||||
|
||||
- Restart NSPanel
|
||||
@@ -165,22 +161,27 @@ This innovative solution is designed to revolutionize how you interact with your
|
||||
- Display dim brightness slider
|
||||
|
||||
### Boot
|
||||
|
||||
<br>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## Home Assistant interface
|
||||
|
||||
## Device's page
|
||||
|
||||
On the device's page under "Devices & Services" you can set the global configuration of your device and see the value of it's sensors and relays:
|
||||
|
||||
<br>
|
||||
<br>
|
||||
<br>
|
||||
<br>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## Automation (Blueprint)
|
||||
|
||||
In your automations you use the blueprint's inputs to define what will be shown on your panel and how it should behave:
|
||||
|
||||
|
||||
@@ -188,7 +189,6 @@ In your automations you use the blueprint's inputs to define what will be shown
|
||||
|
||||
|
||||
|
||||
|
||||
## 🚀 Contributing
|
||||
|
||||
- **Pull Requests:** Please direct all pull requests to the `DEV` branch, not the `main` branch.
|
||||
@@ -207,15 +207,15 @@ Join our vibrant community! Whether you're seeking support, wanting to contribut
|
||||
A huge thank you to everyone who has contributed to making this project a reality. Your support, feedback, and contributions have been invaluable.
|
||||
|
||||
And special thanks for the other projects which inspired us:
|
||||
- Hellis81: https://github.com/Hellis81/NS-panel
|
||||
- Jimmyboy83: https://github.com/Jimmyboy83/nspanel
|
||||
- joBr99: https://github.com/joBr99/Generate-HASP-Fonts
|
||||
- lovejoy77: https://github.com/lovejoy777/NSpanel
|
||||
- Marcfager: https://github.com/marcfager/nspanel-mf
|
||||
- Masto: https://github.com/masto/NSPanel-Demo-Files
|
||||
- sairon: https://github.com/sairon/esphome-nspanel-lovelace-ui
|
||||
- SmartHome Yourself: https://www.youtube.com/c/SmarthomeyourselfDe_DIY
|
||||
|
||||
- [Hellis81](https://github.com/Hellis81/NS-panel)
|
||||
- [Jimmyboy83](https://github.com/Jimmyboy83/nspanel)
|
||||
- [joBr99](https://github.com/joBr99/Generate-HASP-Fonts)
|
||||
- [lovejoy77](https://github.com/lovejoy777/NSpanel)
|
||||
- [Marcfager](https://github.com/marcfager/nspanel-mf)
|
||||
- [Masto](https://github.com/masto/NSPanel-Demo-Files)
|
||||
- [sairon](https://github.com/sairon/esphome-nspanel-lovelace-ui)
|
||||
- [SmartHome Yourself](https://www.youtube.com/c/SmarthomeyourselfDe_DIY)
|
||||
|
||||
## 💖 Donations
|
||||
|
||||
|
||||
212
ReleaseNotes.md
212
ReleaseNotes.md
@@ -1,88 +1,117 @@
|
||||
# v4.2 - Multi-Alarm Control, Dual Thermostat Functionality, and More!
|
||||
# v4.2 - Multi-Alarm Control, Dual Thermostat Functionality, and More
|
||||
|
||||
## Support this project
|
||||
|
||||
### As always, we would like to thank everyone who donated to this project and remind you that every donation helps to support this project - so if you haven't made a donation yet, now would be a good time ;)
|
||||
**As always, we would like to thank everyone who donated to this project and remind you that every donation helps to support this project
|
||||
So if you haven't made a donation yet, now would be a good time ;)**
|
||||
|
||||
[](https://www.paypal.com/donate/?hosted_button_id=S974SWQMB8PB2)
|
||||
|
||||
|
||||
## General
|
||||
|
||||
Hello everyone! In our latest update, we've made some great strides to enhance your experience. We've fine-tuned the TFT upload process, making it smoother and more user-friendly for both newbies and veterans.
|
||||
Hello everyone! In our latest update, we've made some great strides to enhance your experience.
|
||||
We've fine-tuned the TFT upload process, making it smoother and more user-friendly for both newbies and veterans.
|
||||
|
||||
Exciting news – we've introduced multiple alarm control panels and added support for dual target temperature thermostats, complete with a handy new add-on.
|
||||
|
||||
On top of that, you've got more customization freedom now. Play around with additional custom buttons and icon size settings on your Home and button pages. Oh, and don't miss the new clock feature on the sleep page – it's a small but nifty addition!
|
||||
On top of that, you've got more customization freedom now. Play around with additional custom buttons and icon size settings on your Home and button pages.
|
||||
Oh, and don't miss the new clock feature on the sleep page – it's a small but nifty addition!
|
||||
|
||||
Dive into the details below and see how these improvements can upgrade your day-to-day. Looking forward to your feedback!
|
||||
|
||||
### Upcoming Change: Switching to ESP-IDF Framework by March 2024
|
||||
Exciting news for our community – in just a couple of months, by March 2024, we'll be transitioning to the **ESP-IDF** as our default framework. This upgrade is designed to significantly increase the available memory on the ESP, making more room for new features and your customizations.
|
||||
|
||||
While the change is around the corner, there's no need to rush. You have time to get ready for this transition. When it's time to switch, you’ll need to flash your device using a serial cable, similar to what you did for your first custom firmware installation.
|
||||
Exciting news for our community – in just a couple of months, by March 2024, we'll be transitioning to the **ESP-IDF** as our default framework.
|
||||
This upgrade is designed to significantly increase the available memory on the ESP, making more room for new features and your customizations.
|
||||
|
||||
While the change is around the corner, there's no need to rush. You have time to get ready for this transition.
|
||||
When it's time to switch, you’ll need to flash your device using a serial cable, similar to what you did for your first custom firmware installation.
|
||||
|
||||
If you happen to need a serial firmware installation before March, consider giving `esp-idf` a try earlier. It’s already supported and a good step towards future-proofing your setup.
|
||||
|
||||
And if you're not able to make the switch by March or can't flash via serial, don't worry. You’ll still have the option to use the `arduino` framework and update your device wirelessly (OTA).
|
||||
|
||||
For all the details on customizing the framework, our [customization docs](docs/customization.md#framework-esp-idf) are there to help. We're committed to making this transition as smooth as possible, so reach out if you have any concerns or need assistance.
|
||||
For all the details on customizing the framework, our [customization docs](docs/customization.md#framework-esp-idf) are there to help.
|
||||
We're committed to making this transition as smooth as possible, so reach out if you have any concerns or need assistance.
|
||||
|
||||
|
||||
## Updating
|
||||
Updates may come with changes on the blueprint inputs and we highly recommend you review your settings and make sure all fields have the correct selection. We did our best to support your legacy settings and avoid breaking your system, but please double check your settings if you see something not working as expected.
|
||||
|
||||
### Files that need to be reloaded:
|
||||
Updates may come with changes on the blueprint inputs and we highly recommend you review your settings and make sure all fields have the correct selection.
|
||||
We did our best to support your legacy settings and avoid breaking your system, but please double check your settings if you see something not working as expected.
|
||||
|
||||
### Files that need to be reloaded
|
||||
|
||||
1. nspanel_eu.tft, nspanel_us.tft or nspanel_us_land.tft - v4.2
|
||||
2. nspanel_esphome.yaml - v4.2
|
||||
3. nspanel_blueprint.yaml - v4.2
|
||||
|
||||
####
|
||||
|
||||
### Instructions
|
||||
_You can find the update procedures following here:_
|
||||
|
||||
*You can find the update procedures following here:*
|
||||
|
||||
- [How To - All important thing you should know - Update](docs/howto.md#update-blueprint)
|
||||
|
||||
|
||||
## Breaking changes
|
||||
|
||||
1. **The `background` parameter in the `esphome.xxxxx_set_component_color` service is now deprecated.**
|
||||
2. **On the home and climate pages, the button layout has changed.** This adjustment was made to incorporate additional custom buttons on the home page and new target temperature indicators on the climate page.
|
||||
3. **Wi-Fi power save mode has been reset to `NONE` as the default setting.**<br>This was the standard up to v4.0. We switched it in v4.1 to accommodate Bluetooth components. However, since this feature isn't widely used, we're reverting to the original setting. For Bluetooth usage, you should manually set a different mode, such as `LIGHT`, as shown in the customization example below:
|
||||
```yaml
|
||||
##### My customization - Start #####
|
||||
# Enable Bluetooth proxy
|
||||
bluetooth_proxy:
|
||||
# Set Wi-Fi power save mode to "LIGHT" as required for Bluetooth on ESP32
|
||||
wifi:
|
||||
power_save_mode: LIGHT
|
||||
##### My customization - End #####
|
||||
```
|
||||
2. **On the home and climate pages, the button layout has changed.**
|
||||
|
||||
This adjustment was made to incorporate additional custom buttons on the home page and new target temperature indicators on the climate page.
|
||||
3. **Wi-Fi power save mode has been reset to `NONE` as the default setting.**
|
||||
|
||||
This was the standard up to v4.0. We switched it in v4.1 to accommodate Bluetooth components.
|
||||
However, since this feature isn't widely used, we're reverting to the original setting.
|
||||
For Bluetooth usage, you should manually set a different mode, such as `LIGHT`, as shown in the customization example below:
|
||||
|
||||
```yaml
|
||||
##### My customization - Start #####
|
||||
# Enable Bluetooth proxy
|
||||
bluetooth_proxy:
|
||||
# Set Wi-Fi power save mode to "LIGHT" as required for Bluetooth on ESP32
|
||||
wifi:
|
||||
power_save_mode: LIGHT
|
||||
##### My customization - End #####
|
||||
```
|
||||
|
||||
4. **The default baud rate for advanced mode has been reverted to 115200 bps** to resolve issues that arise when rendering button pages.
|
||||
5. **ESPHome v2023.12.0 has been established as the minimum required version** to ensure optimal performance and compatibility, particularly with the recent developments in the Nextion component.
|
||||
6. **The Alarm section in the blueprint settings has been removed.** All configurations previously made in this section have been automatically transferred to custom button 07.
|
||||
7. **Documentation in German is no longer maintained.** This change allows us to more efficiently update and maintain the remaining documentation.
|
||||
8. **Reversion to "Toggle" as default action for automation entities on buttons.**
|
||||
|
||||
In this update, we have reverted the default action for button presses on automation. entities back to "Toggle." This change reverses the adjustment made in version 4.1, where "Trigger" was set as the default action.
|
||||
In this update, we have reverted the default action for button presses on automation. entities back to "Toggle".
|
||||
This change reverses the adjustment made in version 4.1, where "Trigger" was set as the default action.
|
||||
|
||||
**Impact:**
|
||||
|
||||
- **Default Behavior:** With this reversion, pressing a button linked to an automation entity will now enable or disable the automation, as it did prior to version 4.1.
|
||||
- **Consistency and Familiarity:** This change aims to align with user expectations and maintain consistency in the user experience.
|
||||
- **Customization Still Available:** Users still have the option to manually set "Trigger" as the action for their automation. entities, as per their preference.
|
||||
- **Customization Still Available:** Users still have the option to manually set "Trigger" as the action for their `automation.` entities, as per their preference.
|
||||
|
||||
We understand that changes in default settings can impact your workflows.
|
||||
We appreciate your understanding as we strive to balance new features with the familiarity and stability of the user experience.
|
||||
9. **Advanced mode no longer enforces a specific framework.**
|
||||
|
||||
In the past, the enforcement of framework changes by the advanced mode could inadvertently result in users switching frameworks during OTA updates.
|
||||
This practice was not recommended due to the potential for errors.
|
||||
10. **Alarm page cannot be used as wake-up page.**
|
||||
|
||||
We understand that changes in default settings can impact your workflows. We appreciate your understanding as we strive to balance new features with the familiarity and stability of the user experience.
|
||||
9. **Advanced mode no longer enforces a specific framework.**<br>
|
||||
In the past, the enforcement of framework changes by the advanced mode could inadvertently result in users switching frameworks during OTA updates. This practice was not recommended due to the potential for errors.
|
||||
10. **Alarm page cannot be used as wake-up page.**<br>
|
||||
As multiple alarms are supported now, the system don't know which one to show on the wake-up.
|
||||
11. **Changes in icon presentation.**<br>
|
||||
As part of our efforts to standardize icons across various pages, you might notice some differences in how they appear and behave. This includes new colors for lights and climate icons, as well as the introduction of new icon designs. While many aspects can still be customized through blueprint settings, the default presentation will now adhere to this new standardized format. These changes might be a departure from what you're accustomed to in previous versions, but they aim to enhance overall consistency and user experience.
|
||||
12. ***Action required:* Reset your wake-up page selection.**<br>
|
||||
We've enhanced the wake-up page functionality for improved consistency after power cycles. Previously, the system didn't remember your selection following a power outage. With our latest update, this issue has been resolved. However, this improvement requires you to reselect your wake-up page one more time. Thanks for your cooperation in making these settings more reliable for everyday use.
|
||||
11. **Changes in icon presentation.**
|
||||
|
||||
As part of our efforts to standardize icons across various pages, you might notice some differences in how they appear and behave.
|
||||
This includes new colors for lights and climate icons, as well as the introduction of new icon designs.
|
||||
While many aspects can still be customized through blueprint settings, the default presentation will now adhere to this new standardized format.
|
||||
These changes might be a departure from what you're accustomed to in previous versions, but they aim to enhance overall consistency and user experience.
|
||||
12. ***Action required:* Reset your wake-up page selection.**
|
||||
|
||||
We've enhanced the wake-up page functionality for improved consistency after power cycles.
|
||||
Previously, the system didn't remember your selection following a power outage. With our latest update, this issue has been resolved.
|
||||
However, this improvement requires you to reselect your wake-up page one more time.
|
||||
Thanks for your cooperation in making these settings more reliable for everyday use.
|
||||
|
||||
|
||||
## Overview of noteworthy changes
|
||||
|
||||
1. Standardized entity icons
|
||||
2. Additional custom buttons on Home page
|
||||
3. Outdoor temperature selectable font size
|
||||
@@ -100,42 +129,51 @@ wifi:
|
||||
15. Enhanced timeout flexibility for Sleep, Page fallback, and Dimming settings
|
||||
16. Display time on the `screensaver` page
|
||||
|
||||
|
||||
## Details of noteworthy changes
|
||||
|
||||
### 1. Standardized entity icons
|
||||
The engine for defining the icons to be shown and it's color was standardize between all the pages, so now you may see a more consistent User's Interface.
|
||||
We've upgraded the icon definition engine to standardize the appearance and color of icons across all pages. This enhancement leads to a more consistent and harmonious user interface. Expect a unified visual experience that aligns the look and feel of icons throughout the system, contributing to improved navigation and aesthetic appeal.
|
||||
|
||||
|
||||
The engine for defining the icons to be shown and it's color was standardize between all the pages, so now you may see a more consistent User's Interface.
|
||||
We've upgraded the icon definition engine to standardize the appearance and color of icons across all pages.
|
||||
This enhancement leads to a more consistent and harmonious user interface.
|
||||
Expect a unified visual experience that aligns the look and feel of icons throughout the system, contributing to improved navigation and aesthetic appeal.
|
||||
|
||||
### 2. Additional custom buttons on Home page
|
||||
|
||||
It's that simple, now you have 7 buttons where used to be 3. Well, where used to be 4, as the space previously used by the Alarm button is now a custom button. 😉
|
||||
|
||||
|
||||
### 3. Outdoor temperature selectable font size
|
||||
|
||||
Now you can select the font size of your outdoor temperature display:
|
||||
|
||||
|
||||
|
||||
> Important: Long text with bigger fonts may exceed the limit of space reserved for this with incomplete information shown.
|
||||
|
||||
|
||||
### 4. Select icon size for button's pages
|
||||
|
||||
You can also select the size of the icons on the buttos pages:
|
||||
|
||||
<br>
|
||||
<br>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### 5. Support to CJK languages (experimental)
|
||||
|
||||
You will find 3 new TFT files on the repository for the CJK languages. These files are considerably bigger, as the fonts requires more memory, but it should work fine in your panel.
|
||||
|
||||
**ATTENTION:** This is an experimental feature and may contain bugs or some areas missing translations. Please report if you find anything.
|
||||
|
||||
|
||||
### 6. Improved TFT transfer
|
||||
|
||||
#### TFT file selectors
|
||||
We still working on the Upload TFT engine to make it easier for new and for experienced users. Now, together with the **Update TFT Display** button, you will find also **Update TFT Display - Model** and **Update TFT Display - Branch** (disabled by default) where you can select the different model you are using and the upload URL will be automatically adjusted to donwload the file directly from the repository on GitHub, making this process much easier and removing the need of flashing your device every time you want to play with another TFT file or install the `nspanel_blank.tft`.
|
||||
|
||||
We still working on the Upload TFT engine to make it easier for new and for experienced users.
|
||||
Now, together with the **Update TFT Display** button, you will find also **Update TFT Display - Model** and **Update TFT Display - Branch** (disabled by default)
|
||||
where you can select the different model you are using and the upload URL will be automatically adjusted to donwload the file directly from the repository on GitHub,
|
||||
making this process much easier and removing the need of flashing your device every time you want to play with another TFT file or install the `nspanel_blank.tft`.
|
||||
|
||||
|
||||
|
||||
@@ -144,14 +182,17 @@ If you have issues with the remote file and want to transfer it from your local
|
||||
And you also can use the `esphome.xxxxx_upload_tft_url` service to upload using an alternative URL without the need of flash your panel again.
|
||||
|
||||
#### Alternative baud rate for TFT uploads
|
||||
You can select an alternative baud rate for your TFT uploads. This allows faster TFT uploads and also supports displays previously set with baud rates not supported by this project (currently 115200 bps and 921600 bps).
|
||||
|
||||
You can select an alternative baud rate for your TFT uploads.
|
||||
This allows faster TFT uploads and also supports displays previously set with baud rates not supported by this project (currently 115200 bps and 921600 bps).
|
||||
|
||||
In most cases, this would be set for a higher value to enable faster TFT transfer. The default is 921600 bps, the maximum supported by Nextion displays.
|
||||
In most cases, this would be set for a higher value to enable faster TFT transfer.
|
||||
The default is 921600 bps, the maximum supported by Nextion displays.
|
||||
|
||||
You can also use this if you have issues with TFT transfer and want to try a lower baud rate as in some rare cases Nextion will automatically set itself to 9600 bps.
|
||||
|
||||
To enable an alternative upload TFT baud rate, add the desired value in your substitutions like this:
|
||||
|
||||
```yaml
|
||||
upload_tft_baud_rate: "9600"
|
||||
```
|
||||
@@ -160,38 +201,42 @@ If an invalid value is entered, 115200 bps will be used. The default value for t
|
||||
|
||||
During a TFT transfer, the system will always fall back to the standard baud rate (115200 bps) if other tentatives fails.
|
||||
|
||||
|
||||
### 7. Multiple Alarm Control Panels
|
||||
|
||||
Now alarm control panel entities can be assigned to chips and custom buttons in the Home page, but also to hardware buttons, any of the buttons pages or entities pages, similarly to other domains.
|
||||
|
||||
|
||||
### 8. Support to `remote`
|
||||
|
||||
Entities from the `remote` domain can now be assigned to buttons (hardware and buttons pages) and custom buttons (home and climate pages).
|
||||
|
||||
The service `remote.toggle` will be called when the button is pressed.
|
||||
|
||||
|
||||
### 9. Home page chips now supports covers
|
||||
|
||||
That's it!
|
||||
Chips now include cover visualization, allowing for easy monitoring of covers directly from the Home page.
|
||||
|
||||
|
||||
### 10. Chips can be inverted
|
||||
|
||||
Chips now have an 'invert' option on the blueprint settings, providing additional customization flexibility.
|
||||
|
||||
|
||||
### 11. Add swipe control to Screensaver page
|
||||
|
||||
You can now navigate to button pages from the screensaver while your panel is in sleep mode. The swipe controls will function as they do on the Home page.
|
||||
|
||||
|
||||
### 12. Enhanced control for automation entities on buttons
|
||||
We're pleased to announce a new feature that offers users enhanced control over their smart home setups. Now, you can globally select between **Toggle** and **Trigger** actions for button presses on automation entities. This update allows for a more personalized and efficient control experience, tailored to your unique preferences.
|
||||
|
||||
#### Key features:
|
||||
We're pleased to announce a new feature that offers users enhanced control over their smart home setups.
|
||||
Now, you can globally select between **Toggle** and **Trigger** actions for button presses on automation entities.
|
||||
This update allows for a more personalized and efficient control experience, tailored to your unique preferences.
|
||||
|
||||
#### Key features
|
||||
|
||||
- **Toggle:** This action will enable or disable the automation. It is set as the default option.
|
||||
- **Trigger:** This action will execute the automation regardless of its current state, providing more flexibility.
|
||||
|
||||
#### How to use:
|
||||
#### How to use
|
||||
|
||||
1. Access your configuration for automation under **Services** > **Automations & Scenes**. Select the automation associated with your panel setup.
|
||||
1. Scroll to the **ADVANCED SETTINGS** section at the end.
|
||||
1. From the menu, select your desired action - either **Toggle** or **Trigger**.
|
||||
@@ -199,49 +244,64 @@ We're pleased to announce a new feature that offers users enhanced control over
|
||||
|
||||
This update is specially designed to cater to diverse user needs, ensuring a more intuitive and responsive smart home experience.
|
||||
|
||||
|
||||
### 13. Dual thermostat controller support (add-on)
|
||||
|
||||
This new add-on enables the NSPanel to manage both heating and cooling systems simultaneously, utilizing its dual relay functionality.
|
||||
|
||||
#### Key Benefits:
|
||||
#### Key Benefits
|
||||
|
||||
- **Versatility:** Users can now configure their NSPanel to control both a heater and a cooler, offering increased flexibility in home temperature management.
|
||||
- **Efficiency:** With the ability to control both heating and cooling systems, the NSPanel can more effectively maintain desired temperatures, potentially leading to energy savings.
|
||||
- **User Experience:** This update simplifies the user interface by integrating control of both systems into one panel, making it easier to manage home climate.
|
||||
|
||||
#### Implementation Details:
|
||||
- The dual thermostat controller functionality allows the NSPanel to utilize both of its relays for separate heating and cooling control.<br>
|
||||
Users can configure their heating and cooling settings independently, providing a tailored climate control experience.
|
||||
#### Implementation Details
|
||||
|
||||
- The dual thermostat controller functionality allows the NSPanel to utilize both of its relays for separate heating and cooling control.
|
||||
|
||||
Users can configure their heating and cooling settings independently, providing a tailored climate control experience.
|
||||
- The update is designed to be intuitive and user-friendly, ensuring a seamless transition for existing NSPanel users.
|
||||
- Additional Documentation: For detailed instructions and configurations, refer to the updated [add-on climate documentation](docs/addon_climate.md).
|
||||
|
||||
#### Note to Users:
|
||||
This feature enhances the capabilities of the NSPanel without compromising its existing functionalities. Users who previously used the NSPanel for single-mode (either heating or cooling) control can now explore dual-mode options for a more comprehensive climate control solution.
|
||||
#### Note to Users
|
||||
|
||||
This feature enhances the capabilities of the NSPanel without compromising its existing functionalities.
|
||||
Users who previously used the NSPanel for single-mode (either heating or cooling) control can now explore dual-mode options for a more comprehensive climate control solution.
|
||||
|
||||
|
||||
### 14. Enhanced Climate Page for Dual Thermostat Control
|
||||
Leveraging the capabilities introduced with the Dual Thermostat Controller add-on, the existing climate page has been upgraded to support systems with dual temperature settings. This enhancement allows users to effectively manage thermostats that require both heating and cooling target temperatures, directly from the NSPanel's interface. While originally developed to complement the new add-on, this refined climate page also seamlessly extends its functionality to existing thermostats with dual set capabilities, offering a more versatile and comprehensive climate control experience.
|
||||
|
||||
|
||||
Leveraging the capabilities introduced with the Dual Thermostat Controller add-on, the existing climate page has been upgraded to support systems with dual temperature settings.
|
||||
This enhancement allows users to effectively manage thermostats that require both heating and cooling target temperatures, directly from the NSPanel's interface.
|
||||
While originally developed to complement the new add-on,
|
||||
this refined climate page also seamlessly extends its functionality to existing thermostats with dual set capabilities,
|
||||
offering a more versatile and comprehensive climate control experience.
|
||||
|
||||
### 15. Enhanced timeout flexibility for Sleep, Page fallback, and Dimming settings
|
||||
We have improved the functionality of our system by enhancing the timeout flexibility for Sleep, Page Fallback, and Dimming settings. The previous timeout limit of 300 seconds has been significantly expanded, offering users more control and customization options for these specific features. This enhancement allows for a wider range of use cases, catering to the needs of those who require extended periods for these settings, while still maintaining the option for shorter durations.
|
||||
|
||||
|
||||
We have improved the functionality of our system by enhancing the timeout flexibility for Sleep, Page Fallback, and Dimming settings.
|
||||
The previous timeout limit of 300 seconds has been significantly expanded, offering users more control and customization options for these specific features.
|
||||
This enhancement allows for a wider range of use cases, catering to the needs of those who require extended periods for these settings, while still maintaining the option for shorter durations.
|
||||
|
||||
### 16. Display time on the `screensaver` page
|
||||
In this release, we're excited to introduce a new feature that adds a display time function to the Screensaver page. With this update, our screensaver not only serves its primary purpose of saving screen energy but also doubles as an informative display, reflecting our commitment to creating practical, user-friendly solutions.
|
||||
|
||||
You can enable this feature on the bueprint settings, at the **CUSTOM CONFIGURATION** section (almost at the end). You also have to set **Display Brightness Sleep** at the device's page (**Settings** > **Devices & Services** > **ESPHome**).
|
||||
In this release, we're excited to introduce a new feature that adds a display time function to the Screensaver page.
|
||||
With this update, our screensaver not only serves its primary purpose of saving screen energy but also doubles as an informative display,
|
||||
reflecting our commitment to creating practical, user-friendly solutions.
|
||||
|
||||
You can enable this feature on the bueprint settings, at the **CUSTOM CONFIGURATION** section (almost at the end).
|
||||
You also have to set **Display Brightness Sleep** at the device's page (**Settings** > **Devices & Services** > **ESPHome**).
|
||||
|
||||
|
||||
## What's Next?
|
||||
|
||||
Discover what's next and what we are working on right now in our [Milestones](https://github.com/Blackymas/NSPanel_HA_Blueprint/milestones?direction=asc&sort=due_date)
|
||||
|
||||
|
||||
## Special thanks to:
|
||||
## Special thanks to
|
||||
|
||||
- @bluefoxlee - For the CJK fonts and all the support with #1359.
|
||||
- @Floppe - Fix entity pages labels, #1455
|
||||
- @tikismoke - Customization guide: Exposing relay fallback switch to Home Assistant, #1537
|
||||
|
||||
## Previous releases
|
||||
|
||||
- [v4.1.4 - Support to Home Assistant 2023.12.0](https://github.com/Blackymas/NSPanel_HA_Blueprint/releases/tag/v4.1.4)
|
||||
- [v4.1.3 - Bug fixes](https://github.com/Blackymas/NSPanel_HA_Blueprint/releases/tag/v4.1.3)
|
||||
- [v4.1.2 - Bug fixes and minor enhancements](https://github.com/Blackymas/NSPanel_HA_Blueprint/releases/tag/v4.1.2)
|
||||
|
||||
@@ -2463,8 +2463,8 @@ script:
|
||||
then:
|
||||
- lambda: |-
|
||||
static const char *const TAG = "script.set_baud_rate";
|
||||
ESP_LOGW(TAG, "Baud rate changing from %i to %i bps", tf_uart->get_baud_rate(), baud_rate);
|
||||
ESP_LOGW(TAG, "Flush UART");
|
||||
ESP_LOGD(TAG, "Baud rate changing from %i to %i bps", tf_uart->get_baud_rate(), baud_rate);
|
||||
ESP_LOGD(TAG, "Flush UART");
|
||||
- wait_until:
|
||||
condition:
|
||||
- lambda: !lambda return (tf_uart->available() < 1);
|
||||
@@ -2472,9 +2472,9 @@ script:
|
||||
- lambda: |-
|
||||
tf_uart->flush();
|
||||
static const char *const TAG = "script.set_baud_rate";
|
||||
ESP_LOGW(TAG, "Sending instruction '%s=%i' to Nextion", definitive ? "bauds" : "baud", baud_rate);
|
||||
ESP_LOGD(TAG, "Sending instruction '%s=%i' to Nextion", definitive ? "bauds" : "baud", baud_rate);
|
||||
disp1->send_command_printf("%s=%i", definitive ? "bauds" : "baud", baud_rate);
|
||||
ESP_LOGW(TAG, "Flush UART");
|
||||
ESP_LOGD(TAG, "Flush UART");
|
||||
- wait_until:
|
||||
condition:
|
||||
- lambda: !lambda return (tf_uart->available() < 1);
|
||||
@@ -2482,10 +2482,10 @@ script:
|
||||
- lambda: |-
|
||||
tf_uart->flush();
|
||||
static const char *const TAG = "script.set_baud_rate";
|
||||
ESP_LOGW(TAG, "Set ESPHome new baud rate to %i bps", baud_rate);
|
||||
ESP_LOGD(TAG, "Set ESPHome new baud rate to %i bps", baud_rate);
|
||||
tf_uart->set_baud_rate(baud_rate);
|
||||
tf_uart->load_settings();
|
||||
ESP_LOGW(TAG, "Baud rate is changet to %i bps", baud_rate);
|
||||
ESP_LOGD(TAG, "Baud rate is changet to %i bps", baud_rate);
|
||||
|
||||
- id: set_brightness
|
||||
mode: restart
|
||||
|
||||
Binary file not shown.
Binary file not shown.
@@ -713,7 +713,7 @@ Timer click_timer
|
||||
|
||||
Events
|
||||
Timer Event
|
||||
lastclick.txt="{\"page\": \"buttonpage01\", \"event\": \"long_click\", \"component\": \""+click_comp.txt+"\"}"
|
||||
lastclick.txt="{\"page\": \""+page_name.txt+"\", \"event\": \"long_click\", \"component\": \""+click_comp.txt+"\"}"
|
||||
printh 92
|
||||
prints "localevent",0
|
||||
printh 00
|
||||
|
||||
@@ -713,7 +713,7 @@ Timer click_timer
|
||||
|
||||
Events
|
||||
Timer Event
|
||||
lastclick.txt="{\"page\": \"buttonpage01\", \"event\": \"long_click\", \"component\": \""+click_comp.txt+"\"}"
|
||||
lastclick.txt="{\"page\": \""+page_name.txt+"\", \"event\": \"long_click\", \"component\": \""+click_comp.txt+"\"}"
|
||||
printh 92
|
||||
prints "localevent",0
|
||||
printh 00
|
||||
|
||||
@@ -713,7 +713,7 @@ Timer click_timer
|
||||
|
||||
Events
|
||||
Timer Event
|
||||
lastclick.txt="{\"page\": \"buttonpage01\", \"event\": \"long_click\", \"component\": \""+click_comp.txt+"\"}"
|
||||
lastclick.txt="{\"page\": \""+page_name.txt+"\", \"event\": \"long_click\", \"component\": \""+click_comp.txt+"\"}"
|
||||
printh 92
|
||||
prints "localevent",0
|
||||
printh 00
|
||||
|
||||
@@ -713,7 +713,7 @@ Timer click_timer
|
||||
|
||||
Events
|
||||
Timer Event
|
||||
lastclick.txt="{\"page\": \"buttonpage01\", \"event\": \"long_click\", \"component\": \""+click_comp.txt+"\"}"
|
||||
lastclick.txt="{\"page\": \""+page_name.txt+"\", \"event\": \"long_click\", \"component\": \""+click_comp.txt+"\"}"
|
||||
printh 92
|
||||
prints "localevent",0
|
||||
printh 00
|
||||
|
||||
Binary file not shown.
Binary file not shown.
@@ -713,7 +713,7 @@ Timer click_timer
|
||||
|
||||
Events
|
||||
Timer Event
|
||||
lastclick.txt="{\"page\": \"buttonpage01\", \"event\": \"long_click\", \"component\": \""+click_comp.txt+"\"}"
|
||||
lastclick.txt="{\"page\": \""+page_name.txt+"\", \"event\": \"long_click\", \"component\": \""+click_comp.txt+"\"}"
|
||||
printh 92
|
||||
prints "localevent",0
|
||||
printh 00
|
||||
|
||||
@@ -713,7 +713,7 @@ Timer click_timer
|
||||
|
||||
Events
|
||||
Timer Event
|
||||
lastclick.txt="{\"page\": \"buttonpage01\", \"event\": \"long_click\", \"component\": \""+click_comp.txt+"\"}"
|
||||
lastclick.txt="{\"page\": \""+page_name.txt+"\", \"event\": \"long_click\", \"component\": \""+click_comp.txt+"\"}"
|
||||
printh 92
|
||||
prints "localevent",0
|
||||
printh 00
|
||||
|
||||
@@ -713,7 +713,7 @@ Timer click_timer
|
||||
|
||||
Events
|
||||
Timer Event
|
||||
lastclick.txt="{\"page\": \"buttonpage01\", \"event\": \"long_click\", \"component\": \""+click_comp.txt+"\"}"
|
||||
lastclick.txt="{\"page\": \""+page_name.txt+"\", \"event\": \"long_click\", \"component\": \""+click_comp.txt+"\"}"
|
||||
printh 92
|
||||
prints "localevent",0
|
||||
printh 00
|
||||
|
||||
@@ -713,7 +713,7 @@ Timer click_timer
|
||||
|
||||
Events
|
||||
Timer Event
|
||||
lastclick.txt="{\"page\": \"buttonpage01\", \"event\": \"long_click\", \"component\": \""+click_comp.txt+"\"}"
|
||||
lastclick.txt="{\"page\": \""+page_name.txt+"\", \"event\": \"long_click\", \"component\": \""+click_comp.txt+"\"}"
|
||||
printh 92
|
||||
prints "localevent",0
|
||||
printh 00
|
||||
|
||||
Binary file not shown.
Binary file not shown.
@@ -713,7 +713,7 @@ Timer click_timer
|
||||
|
||||
Events
|
||||
Timer Event
|
||||
lastclick.txt="{\"page\": \"buttonpage01\", \"event\": \"long_click\", \"component\": \""+click_comp.txt+"\"}"
|
||||
lastclick.txt="{\"page\": \""+page_name.txt+"\", \"event\": \"long_click\", \"component\": \""+click_comp.txt+"\"}"
|
||||
printh 92
|
||||
prints "localevent",0
|
||||
printh 00
|
||||
|
||||
@@ -713,7 +713,7 @@ Timer click_timer
|
||||
|
||||
Events
|
||||
Timer Event
|
||||
lastclick.txt="{\"page\": \"buttonpage01\", \"event\": \"long_click\", \"component\": \""+click_comp.txt+"\"}"
|
||||
lastclick.txt="{\"page\": \""+page_name.txt+"\", \"event\": \"long_click\", \"component\": \""+click_comp.txt+"\"}"
|
||||
printh 92
|
||||
prints "localevent",0
|
||||
printh 00
|
||||
|
||||
@@ -713,7 +713,7 @@ Timer click_timer
|
||||
|
||||
Events
|
||||
Timer Event
|
||||
lastclick.txt="{\"page\": \"buttonpage01\", \"event\": \"long_click\", \"component\": \""+click_comp.txt+"\"}"
|
||||
lastclick.txt="{\"page\": \""+page_name.txt+"\", \"event\": \"long_click\", \"component\": \""+click_comp.txt+"\"}"
|
||||
printh 92
|
||||
prints "localevent",0
|
||||
printh 00
|
||||
|
||||
@@ -713,7 +713,7 @@ Timer click_timer
|
||||
|
||||
Events
|
||||
Timer Event
|
||||
lastclick.txt="{\"page\": \"buttonpage01\", \"event\": \"long_click\", \"component\": \""+click_comp.txt+"\"}"
|
||||
lastclick.txt="{\"page\": \""+page_name.txt+"\", \"event\": \"long_click\", \"component\": \""+click_comp.txt+"\"}"
|
||||
printh 92
|
||||
prints "localevent",0
|
||||
printh 00
|
||||
|
||||
Binary file not shown.
@@ -713,7 +713,7 @@ Timer click_timer
|
||||
|
||||
Events
|
||||
Timer Event
|
||||
lastclick.txt="{\"page\": \"buttonpage01\", \"event\": \"long_click\", \"component\": \""+click_comp.txt+"\"}"
|
||||
lastclick.txt="{\"page\": \""+page_name.txt+"\", \"event\": \"long_click\", \"component\": \""+click_comp.txt+"\"}"
|
||||
printh 92
|
||||
prints "localevent",0
|
||||
printh 00
|
||||
|
||||
@@ -713,7 +713,7 @@ Timer click_timer
|
||||
|
||||
Events
|
||||
Timer Event
|
||||
lastclick.txt="{\"page\": \"buttonpage01\", \"event\": \"long_click\", \"component\": \""+click_comp.txt+"\"}"
|
||||
lastclick.txt="{\"page\": \""+page_name.txt+"\", \"event\": \"long_click\", \"component\": \""+click_comp.txt+"\"}"
|
||||
printh 92
|
||||
prints "localevent",0
|
||||
printh 00
|
||||
|
||||
@@ -713,7 +713,7 @@ Timer click_timer
|
||||
|
||||
Events
|
||||
Timer Event
|
||||
lastclick.txt="{\"page\": \"buttonpage01\", \"event\": \"long_click\", \"component\": \""+click_comp.txt+"\"}"
|
||||
lastclick.txt="{\"page\": \""+page_name.txt+"\", \"event\": \"long_click\", \"component\": \""+click_comp.txt+"\"}"
|
||||
printh 92
|
||||
prints "localevent",0
|
||||
printh 00
|
||||
|
||||
@@ -713,7 +713,7 @@ Timer click_timer
|
||||
|
||||
Events
|
||||
Timer Event
|
||||
lastclick.txt="{\"page\": \"buttonpage01\", \"event\": \"long_click\", \"component\": \""+click_comp.txt+"\"}"
|
||||
lastclick.txt="{\"page\": \""+page_name.txt+"\", \"event\": \"long_click\", \"component\": \""+click_comp.txt+"\"}"
|
||||
printh 92
|
||||
prints "localevent",0
|
||||
printh 00
|
||||
|
||||
Binary file not shown.
@@ -713,7 +713,7 @@ Timer click_timer
|
||||
|
||||
Events
|
||||
Timer Event
|
||||
lastclick.txt="{\"page\": \"buttonpage01\", \"event\": \"long_click\", \"component\": \""+click_comp.txt+"\"}"
|
||||
lastclick.txt="{\"page\": \""+page_name.txt+"\", \"event\": \"long_click\", \"component\": \""+click_comp.txt+"\"}"
|
||||
printh 92
|
||||
prints "localevent",0
|
||||
printh 00
|
||||
|
||||
@@ -713,7 +713,7 @@ Timer click_timer
|
||||
|
||||
Events
|
||||
Timer Event
|
||||
lastclick.txt="{\"page\": \"buttonpage01\", \"event\": \"long_click\", \"component\": \""+click_comp.txt+"\"}"
|
||||
lastclick.txt="{\"page\": \""+page_name.txt+"\", \"event\": \"long_click\", \"component\": \""+click_comp.txt+"\"}"
|
||||
printh 92
|
||||
prints "localevent",0
|
||||
printh 00
|
||||
|
||||
@@ -713,7 +713,7 @@ Timer click_timer
|
||||
|
||||
Events
|
||||
Timer Event
|
||||
lastclick.txt="{\"page\": \"buttonpage01\", \"event\": \"long_click\", \"component\": \""+click_comp.txt+"\"}"
|
||||
lastclick.txt="{\"page\": \""+page_name.txt+"\", \"event\": \"long_click\", \"component\": \""+click_comp.txt+"\"}"
|
||||
printh 92
|
||||
prints "localevent",0
|
||||
printh 00
|
||||
|
||||
@@ -713,7 +713,7 @@ Timer click_timer
|
||||
|
||||
Events
|
||||
Timer Event
|
||||
lastclick.txt="{\"page\": \"buttonpage01\", \"event\": \"long_click\", \"component\": \""+click_comp.txt+"\"}"
|
||||
lastclick.txt="{\"page\": \""+page_name.txt+"\", \"event\": \"long_click\", \"component\": \""+click_comp.txt+"\"}"
|
||||
printh 92
|
||||
prints "localevent",0
|
||||
printh 00
|
||||
|
||||
Binary file not shown.
@@ -713,7 +713,7 @@ Timer click_timer
|
||||
|
||||
Events
|
||||
Timer Event
|
||||
lastclick.txt="{\"page\": \"buttonpage01\", \"event\": \"long_click\", \"component\": \""+click_comp.txt+"\"}"
|
||||
lastclick.txt="{\"page\": \""+page_name.txt+"\", \"event\": \"long_click\", \"component\": \""+click_comp.txt+"\"}"
|
||||
printh 92
|
||||
prints "localevent",0
|
||||
printh 00
|
||||
|
||||
@@ -713,7 +713,7 @@ Timer click_timer
|
||||
|
||||
Events
|
||||
Timer Event
|
||||
lastclick.txt="{\"page\": \"buttonpage01\", \"event\": \"long_click\", \"component\": \""+click_comp.txt+"\"}"
|
||||
lastclick.txt="{\"page\": \""+page_name.txt+"\", \"event\": \"long_click\", \"component\": \""+click_comp.txt+"\"}"
|
||||
printh 92
|
||||
prints "localevent",0
|
||||
printh 00
|
||||
|
||||
@@ -713,7 +713,7 @@ Timer click_timer
|
||||
|
||||
Events
|
||||
Timer Event
|
||||
lastclick.txt="{\"page\": \"buttonpage01\", \"event\": \"long_click\", \"component\": \""+click_comp.txt+"\"}"
|
||||
lastclick.txt="{\"page\": \""+page_name.txt+"\", \"event\": \"long_click\", \"component\": \""+click_comp.txt+"\"}"
|
||||
printh 92
|
||||
prints "localevent",0
|
||||
printh 00
|
||||
|
||||
@@ -713,7 +713,7 @@ Timer click_timer
|
||||
|
||||
Events
|
||||
Timer Event
|
||||
lastclick.txt="{\"page\": \"buttonpage01\", \"event\": \"long_click\", \"component\": \""+click_comp.txt+"\"}"
|
||||
lastclick.txt="{\"page\": \""+page_name.txt+"\", \"event\": \"long_click\", \"component\": \""+click_comp.txt+"\"}"
|
||||
printh 92
|
||||
prints "localevent",0
|
||||
printh 00
|
||||
|
||||
@@ -2,8 +2,9 @@
|
||||
|
||||
Please select "Instruction codes: utf-8" in the Nextion simulator
|
||||
|
||||
### Boot page
|
||||
```
|
||||
## Boot page
|
||||
|
||||
```nextion
|
||||
page boot
|
||||
baud_rate.txt="115200 bps"
|
||||
esph_version.txt="4.2"
|
||||
@@ -14,13 +15,15 @@ framework.txt="esp-idf"
|
||||
ip_addr.txt="192.168.0.123"
|
||||
```
|
||||
|
||||
|
||||
<br>
|
||||
|
||||
|
||||
|
||||
### Home page
|
||||
#### EU version
|
||||
```
|
||||
|
||||
|
||||
## Home page
|
||||
|
||||
**EU version:**
|
||||
|
||||
```nextion
|
||||
page home
|
||||
date.txt="Sunday, 29/11"
|
||||
outdoor_temp.txt="8.9°"
|
||||
@@ -55,10 +58,12 @@ button03.txt=""
|
||||
value03_state.txt="715 W"
|
||||
value03_icon.txt=""
|
||||
```
|
||||
|
||||
|
||||
#### US version
|
||||
```
|
||||
|
||||
|
||||
**US version:**
|
||||
|
||||
```nextion
|
||||
page home
|
||||
meridiem.txt="PM"
|
||||
date.txt="Sunday, 11/29"
|
||||
@@ -94,19 +99,21 @@ button03.txt=""
|
||||
value03_state.txt="715 W"
|
||||
value03_icon.txt=""
|
||||
```
|
||||
|
||||
|
||||
### Settings page
|
||||
```
|
||||
|
||||
|
||||
## Settings page
|
||||
|
||||
```nextion
|
||||
page settings
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## Buttons pages (DRAFT)
|
||||
|
||||
### Buttons pages (DRAFT)
|
||||
```
|
||||
```nextion
|
||||
api=1
|
||||
page buttonpage01
|
||||
page_label.txt="Bedroom"
|
||||
@@ -143,9 +150,11 @@ button06icon.picc=46
|
||||
button06bri.picc=46
|
||||
```
|
||||
|
||||
### Entities pages
|
||||
#### EU version
|
||||
```
|
||||
## Entities pages
|
||||
|
||||
**EU version:**
|
||||
|
||||
```nextion
|
||||
api=1
|
||||
page entitypage01
|
||||
entity01_label.txt="Power monitoring"
|
||||
@@ -170,8 +179,10 @@ value07_label.txt="Electricity cost rate"
|
||||
value07.txt="1.84 €/h"
|
||||
value07.xcen=2
|
||||
```
|
||||
#### US version
|
||||
```
|
||||
|
||||
**US version:**
|
||||
|
||||
```nextion
|
||||
api=1
|
||||
page entitypage01
|
||||
entity01_label.txt="Power monitoring"
|
||||
@@ -197,8 +208,9 @@ value07.txt="1.84 $/h"
|
||||
value07.xcen=2
|
||||
```
|
||||
|
||||
### Sensor page (mockup)
|
||||
```
|
||||
## Sensor page (mockup)
|
||||
|
||||
```nextion
|
||||
api=1
|
||||
page notification
|
||||
vis bt_accept,0
|
||||
@@ -206,4 +218,4 @@ vis bt_clear,0
|
||||
notifi_label.txt="My sensor name"
|
||||
notifi_text01.txt="1115.4 kWh"
|
||||
notifi_text01.font=6
|
||||
```
|
||||
```
|
||||
|
||||
@@ -1,19 +1,19 @@
|
||||
This article covers the settings in the Blueprint Automation.
|
||||
# Blueprint Automation
|
||||
|
||||
The Blueprint Automation is the central configuration element of this solution for the NSPanel.<br>
|
||||
In principle, the setup of the automation is self-explanatory. The individual elements of the Blueprint are described below.
|
||||
This article covers the settings in the Blueprint Automation.
|
||||
|
||||
The Blueprint Automation is the central configuration element of this solution for the NSPanel.
|
||||
|
||||
In principle, the setup of the automation is self-explanatory.
|
||||
The individual elements of the Blueprint are described below.
|
||||
|
||||
It is possible to change both the color of the labels and the icons for most of the elements on each screen.
|
||||
|
||||
On the blueprint settings, you will be able to select any of the MDI icons supported by Home Assistant, however, your panel will only support the icons available on this library:
|
||||
``https://htmlpreview.github.io/?https://github.com/jobr99/Generate-HASP-Fonts/blob/master/cheatsheet.html``
|
||||
|
||||
|
||||
For an easier overview, the menu items "Icon Color" and "Label Color" will not be described separately in the following documentation.
|
||||
|
||||
|
||||
# Parameters
|
||||
|
||||
## Basic settings
|
||||
|
||||
### NSPanel device (REQUIRED)
|
||||
@@ -24,69 +24,106 @@ This is technically the only required field, as basic functionality will be avai
|
||||
> You cannot have more than one blueprint based automation per each panel
|
||||
|
||||
### Language for NSPanel
|
||||
|
||||
The language can be selected via the drop-down menu.
|
||||
|
||||
Currently around 30 languages are supported, but if you cannot find your language there, please create a [new feature request](/Blackymas/NSPanel_HA_Blueprint/issues/new) and we will be happy to help.
|
||||
Currently around 30 languages are supported, but if you cannot find your language there,
|
||||
please create a [new feature request](https://github.com/Blackymas/NSPanel_HA_Blueprint/issues/new) and we will be happy to help.
|
||||
|
||||
### Date format
|
||||
|
||||
Select how you want to see the date displayed on your panel (Home page and weather pages are affected).
|
||||
|
||||
### Time format
|
||||
|
||||
Select how you want to see the time displayed on your panel's Home page.
|
||||
|
||||
### Delay to avoid synchronization problems
|
||||
If the Wi-Fi signal is poor, you may have issues when loading some pages. If this happens, try to increase this delay as that may help.
|
||||
|
||||
If the Wi-Fi signal is poor, you may have issues when loading some pages.
|
||||
If this happens, try to increase this delay as that may help.
|
||||
|
||||
## Weather and Temperature
|
||||
|
||||
### Weather entity from HA
|
||||
|
||||
Select a Weather entity to use.
|
||||
|
||||
Most of the weather integrations are supported, however some may be able to provide more information than others.<br>
|
||||
Most of the weather integrations are supported, however some may be able to provide more information than others.
|
||||
|
||||
We run all of our tests with "Accuweather", so the parameters shown on the panel are targetting this integration and will be shown with your integration when available.
|
||||
|
||||
### Outdoor temperature Sensor (Optional)
|
||||
Optionally, the value of an outdoor temperature sensor can be used here. If no separate sensor is used, the value of the weather integration will be used.
|
||||
|
||||
Optionally, the value of an outdoor temperature sensor can be used here.
|
||||
If no separate sensor is used, the value of the weather integration will be used.
|
||||
|
||||
### Indoor Temperature Sensor (Optional)
|
||||
An indoor temperature sensor is not necessary. Leave the field empty if you want to use the temperature sensor of the NSPanel. If the value of the sensor needs to be corrected, this can be done via the temperature correction for the NSPanel under HA Devices.
|
||||
|
||||
An indoor temperature sensor is not necessary.
|
||||
Leave the field empty if you want to use the temperature sensor of the NSPanel.
|
||||
If the value of the sensor needs to be corrected, this can be done via the temperature correction for the NSPanel under HA Devices.
|
||||
|
||||
## Home page - Sensor
|
||||
#### Sensor 01-03 - Entity (Optional)
|
||||
Up to three sensors can be displayed on the home screen. Select the corresponding HA entity.
|
||||
|
||||
### Sensor 01-03 - Entity (Optional)
|
||||
|
||||
Up to three sensors can be displayed on the home screen.
|
||||
Select the corresponding HA entity.
|
||||
|
||||
## Home page - Chips
|
||||
#### Chip 01-07 - Entity (Optional)
|
||||
Used to display HA entities on the home screen. For example to display the status of a specific switch on the NSPanel.
|
||||
|
||||
### Chip 01-07 - Entity (Optional)
|
||||
|
||||
Used to display HA entities on the home screen.
|
||||
For example to display the status of a specific switch on the NSPanel.
|
||||
|
||||
## Home page - Custom buttons
|
||||
#### Custom button 01-06 - Entity (Optional)
|
||||
Your panel will show 10 buttons on the Home page. 4 of those are fixed for Notifications, QR Code, Entities pages and Alarm, but you have additional 6 custom buttons that can be assigned to different entities from your Home Assistant. The behavior of these buttons will depend on the entity's domain (light, media player, etc).
|
||||
|
||||
### Custom button 01-06 - Entity (Optional)
|
||||
|
||||
Your panel will show 10 buttons on the Home page.
|
||||
4 of those are fixed for Notifications, QR Code, Entities pages and Alarm, but you have additional 6 custom buttons that can be assigned to different entities from your Home Assistant.
|
||||
The behavior of these buttons will depend on the entity's domain (light, media player, etc).
|
||||
|
||||
## Alarm Control Panel
|
||||
An alarm control panel entity can be controlled by your panel. When you assign the entity here, it's icon will be shown as a button on the Home page.
|
||||
|
||||
An alarm control panel entity can be controlled by your panel.
|
||||
When you assign the entity here, it's icon will be shown as a button on the Home page.
|
||||
|
||||
## Climate
|
||||
### Climate to Control (Optional)
|
||||
Here you select the main climate entity controlled by your panel. It's temperature will be used on the Home page and by clicking on that value you will be able to control the climate settings.
|
||||
|
||||
You can optionally use your panel to control a climate system locally, using it's temperature sensor and relays. You will find more details about this on the Add-on Climate docummentation.<br>
|
||||
If you are using the Add-on Climate, it will create a climate entity in your panel's device page. You still have to select that entity on this field in the blueprint settings to have it used as your main climate.
|
||||
### Climate to Control (Optional)
|
||||
|
||||
Here you select the main climate entity controlled by your panel.
|
||||
It's temperature will be used on the Home page and by clicking on that value you will be able to control the climate settings.
|
||||
|
||||
You can optionally use your panel to control a climate system locally, using it's temperature sensor and relays.
|
||||
You will find more details about this on the Add-on Climate docummentation.
|
||||
|
||||
If you are using the Add-on Climate, it will create a climate entity in your panel's device page.
|
||||
You still have to select that entity on this field in the blueprint settings to have it used as your main climate.
|
||||
|
||||
Additional climate entities can be assigned to buttons and will be explained later in this documment.
|
||||
|
||||
On the blueprint settings, you will also find settings for sensors and custom buttons to be shown on all the climate pages.
|
||||
|
||||
## QR Code
|
||||
|
||||
### Activate QR Code (Optional)
|
||||
|
||||
Activates the QR Code page and shows the QR Code button on the Home page.
|
||||
|
||||
### QR Code content (Optional)
|
||||
String, which is shown as a QR Code on the NSPanel. This can be a simple text, a URL or could also be used for a simplified login to the Wi-Fi. Here is an example (simply change SSID and password to your credentials and either use "WPA" or "WEP"):
|
||||
|
||||
String, which is shown as a QR Code on the NSPanel.
|
||||
This can be a simple text, a URL or could also be used for a simplified login to the Wi-Fi.
|
||||
Here is an example (simply change SSID and password to your credentials and either use "WPA" or "WEP"):
|
||||
|
||||
`Wi-Fi:S:SSID;T:WPA/WEP;P:PASSWORD;;`
|
||||
|
||||
#### Example:
|
||||
|
||||
For a network with the following parameters:
|
||||
- **SSID:** my_ssid
|
||||
- **Pass:** MySecurePa$$w0rd
|
||||
@@ -99,36 +136,50 @@ Your QR code string will look like this:
|
||||
For more details about these specifications, please visit the [WPA3™ Specification v3.1, chapter 7](https://www.wi-fi.org/system/files/WPA3%20Specification%20v3.1.pdf#page=24).
|
||||
|
||||
## Hardware Buttons
|
||||
|
||||
### Activate Relay x local Fallback (Optional)
|
||||
Normally, the internal relays of the NSPanels are triggered via HA. If the NSPanel loses Wi-Fi connection or HA is down, the hardware button can then switch the corresponding relay directly.
|
||||
|
||||
Normally, the internal relays of the NSPanels are triggered via HA.
|
||||
If the NSPanel loses Wi-Fi connection or HA is down, the hardware button can then switch the corresponding relay directly.
|
||||
|
||||
### Left/Right Hardware Button - Entity (Optional)
|
||||
|
||||
The entity that should be switched with the left/right hardware button.
|
||||
|
||||
### Left/Right Hardware Button Name - Label (Optional)
|
||||
|
||||
Text on the screen above the corresponding hardware button (home screen).
|
||||
|
||||
### Left/Right Hardware Button hold assignment - VALUE (optional)
|
||||
|
||||
Selection of what action should happen when the button is pressed for a longer time.
|
||||
|
||||
### Left/Right Hardware Button custom hold action - VALUE (Optional)
|
||||
|
||||
Selection of the action to start when holding the button.
|
||||
|
||||
## Button Page 01-04
|
||||
|
||||
### Button Page 01-04 name - LABEL (Optional)
|
||||
|
||||
Text on the respective button screens.
|
||||
|
||||
### Buttons 01 - 32 (Optional)
|
||||
|
||||
The buttons can be accessed by swiping on the Home Screen and their functions are completely identical.
|
||||
Either the individual button pages can be accessed one after the other by swiping to the left, or the button pages can be accessed directly by swiping up, down or to the right.
|
||||
|
||||
The buttons are numbered as follows:
|
||||
|
||||
#### EU and US landscape models:
|
||||
|
||||
| | Button Page 1 | Button Page 2 | Button Page 3 | Button Page 4 |
|
||||
| :--: | :--: | :--: | :--: | :--: |
|
||||
| Row 1 | 01 02 03 04 | 09 10 11 12 | 17 18 19 20 | 25 26 27 28 |
|
||||
| Row 2 | 05 06 07 08 | 13 14 15 16 | 21 22 23 24 | 29 30 31 32 |
|
||||
|
||||
#### US model:
|
||||
|
||||
| | Button Page 1 | Button Page 2 | Button Page 3 | Button Page 4 |
|
||||
| :--: | :--: | :--: | :--: | :--: |
|
||||
| Row 1 | 01 02 | 09 10 | 17 18 | 25 26 |
|
||||
@@ -136,21 +187,28 @@ The buttons are numbered as follows:
|
||||
| Row 3 | 05 06 | 13 14 | 21 22 | 29 30 |
|
||||
| Row 4 | 07 08 | 15 16 | 23 24 | 31 32 |
|
||||
|
||||
When the respective button is pressed, a toggle action is executed or the corresponding page is automatically opened, e.g. the cover control for covers, etc.
|
||||
When the respective button is pressed, a toggle action is executed or the corresponding page is automatically opened, e.g.
|
||||
the cover control for covers, etc.
|
||||
For 2 state buttons (where toggle is the default action), a long press in the button will open it's corresponding page, when supported.
|
||||
|
||||
For each button an own name can be specified optionally.
|
||||
|
||||
All buttons offer the possibility to optionally confirm the execution of the action. This can be activated or deactivated separately for each button via *"Confirm execution of the button press"*.
|
||||
All buttons offer the possibility to optionally confirm the execution of the action.
|
||||
This can be activated or deactivated separately for each button via *"Confirm execution of the button press"*.
|
||||
|
||||
## Entity Page 01-04
|
||||
|
||||
### Activate Entity Page (Optional)
|
||||
This option activates the entity pages on the Home Screen. The entity pages can be used for example to display values or statuses of entities on the individual pages.
|
||||
|
||||
This option activates the entity pages on the Home Screen.
|
||||
The entity pages can be used for example to display values or statuses of entities on the individual pages.
|
||||
|
||||
### Entity Page 01-04 name - LABEL (Optional)
|
||||
|
||||
Naming of the corresponding Entity Screens.
|
||||
|
||||
### Entity 01 - 32 (Optional)
|
||||
|
||||
The entity pages can be accessed by pressing the symbol on the Home Screen and their functions are completely identical.
|
||||
|
||||
The entities are numbered as follows:
|
||||
@@ -166,7 +224,7 @@ Additionally there is the possibility to choose an icon of your choice for the E
|
||||
|
||||
Of course there is also the possibility to enter a label for each of the 4 pages and the aligment for the values on the entities pages.
|
||||
|
||||
# Example Screenshots
|
||||
## Example Screenshots
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -1,3 +0,0 @@
|
||||
## Attention
|
||||
|
||||
The manuals in Germany are not being updated. Please use the latest documents in English. Your browser translations can help if English is an issue for you.
|
||||
@@ -1,233 +0,0 @@
|
||||
Dieser Artikel befasst sich mit den Einstellungen in der Blueprint Automatisierung.
|
||||
|
||||
Die Blueprint Automation ist das zentrale Konfigurationselement dieser Lösung für das NSPanel.
|
||||
Im Prinzip ist die Einrichtung der Automatisierung selbsterklärend. Nachfolgend werden die einzelnen Elemente des Blueprints beschrieben.
|
||||
|
||||
|
||||
Es ist möglich, sowohl die Farbe der Labels als auch der Icons für die meisten Elemente auf den einzelnen Screens zu verändern.
|
||||
|
||||
Standard für die Farbe ist "65535". Der gewünschten Nextion Farbcode kann unter ```https://nodtem66.github.io/nextion-hmi-color-convert/index.html herausgesucht werden.```
|
||||
|
||||
Die Icons unter folgendem Link können verwendet werden:
|
||||
```https://htmlpreview.github.io/?https://github.com/jobr99/Generate-HASP-Fonts/blob/master/cheatsheet.html```
|
||||
|
||||
Es wird der Übersichtlichkeit halber in der folgenden Dokumentation nicht gesondert auf die Menüeinträge "Icon Color" und "Label Color" eingegangen.
|
||||
|
||||
|
||||
# Parameter
|
||||
### ESPhome Node Name
|
||||
|
||||
Bezieht sich auf den ESPhome-Gerätenamen. **Zulässig sind die Zeichen "__",a-z, 0-9, jedoch keine Sonder- und Leerzeichen**. Dies ist eine Einschränkung seitens HA, da aus dem Device-Name des Blueprints die jeweiligen Entity_IDs generiert werden.
|
||||
|
||||
### Language for NSPanel
|
||||
|
||||
Über das Dropdown Menü kann die Sprache ausgewählt werden. Unterstützt werden derzeit 26 Sprachen.
|
||||
|
||||
### Delay to avoid synchronization problems
|
||||
|
||||
Es kann bei schlechtem WLAN Signal vorkommen, dass Menüs nicht komplett geladen werden. Sollte dies vorkommen, kann hier ein Delay in ms Schritten eingestellt werden, um dies zu kompensieren.
|
||||
|
||||
|
||||
|
||||
## Weather and Temperature
|
||||
|
||||
### Weather Integration
|
||||
|
||||
Auswahl zwischen der HA Weather Integration oder dem genaueren Accuweather.
|
||||
|
||||
### Weather entity from HA
|
||||
|
||||
Dropdown Menü zur Auswahl der zu verwendenden Weather Entität. Beispiel: Wenn in Punkt 7 "Accuweather" ausgewählt wird, so muss hier die Entität für Accuweather ausgewählt werden.
|
||||
|
||||
### Outdoor Temperature Sensor (Optional)
|
||||
|
||||
Optional kann hier der Wert eines Aussentemperatur Sensor verwendet werden. Falls kein separater Sensor verwendet wird, wird der Wert der Wetter-Integration verwendet.
|
||||
|
||||
### Outdoor Temperature Sensor - LABEL COLOR (Optional)
|
||||
|
||||
Hier kann die Farbe der Beschriftung des Labels geändert werden. Siehe Link oben im Artikel.
|
||||
|
||||
### Indoor Temperature Sensor (Optional)
|
||||
|
||||
Optional kann hier der Wert eines InnentemperaturSensor verwendet werden. Wird das Feld leer gelassen, wird der Temperatursensor des NSPanels verwendet. Zusätzlich ist unter HA Devices eine Temperaturkorrektur für den NSPanel-Sensor möglich.
|
||||
|
||||
|
||||
|
||||
## Sensor Home Page
|
||||
|
||||
### Sensor 01-03 - Entity (Optional)
|
||||
|
||||
Bis zu drei Sensoren können auf dem Home Screen dargestellt werden. Hierzu die HA Entität auswählen.
|
||||
|
||||
|
||||
|
||||
## Chips
|
||||
|
||||
### Chip 01-07 - Entity (Optional)
|
||||
|
||||
Zur Darstellung von HA Entities auf dem Home Screen. Kann verwendet werden um bspw. den Status eines bestimmten Schalters auf dem NSPanel darzustellen.
|
||||
|
||||
|
||||
|
||||
## Climate
|
||||
|
||||
### Climate to Control (Optional)
|
||||
|
||||
Wenn eine Climate Integration gesteuert werden soll, muss diese hier eingegeben werden. Erreichbar ist diese dann über die Temperatur auf dem Home Screen des NSPanels.
|
||||
|
||||
### Climate Control optimistic Mode (Optional)
|
||||
|
||||
Abhängig von der Klima Steuerung, kann für ein besseres Ansprechverhalten der Optimistic Mode verwendet werden. Die vorgenommenen Änderungen werden erst bei verlassen des Screens auf das Device übertragen.
|
||||
|
||||
### Hot Water Charge Button (Optional)
|
||||
|
||||
Optionaler Schalter um bspw. einen Boiler an- bzw. aus zu schalten.
|
||||
|
||||
|
||||
|
||||
## QR Code
|
||||
|
||||
### Activate QR Code - TRUE/FALSE (Optional)
|
||||
|
||||
Aktiviert die QR Code Page sowie den Button auf dem Home Screen.
|
||||
|
||||
### QR Code content - VALUE (optional)
|
||||
|
||||
String, der als QR Code dargestellt werden soll. Dies kann ein Text sein, eine URL oder beispielsweise auch für einen vereinfachten Login ins WiFi verwendet werden (hier einfach SSID und Password ersetzen sowie entweder "WPA" oder "WEP" verwenden):
|
||||
|
||||
```WIFI:S:SSID;T:WPA/WEP;P:PASSWORD;;```
|
||||
|
||||
|
||||
|
||||
## Hardware Buttons
|
||||
|
||||
### Delay for HW-Buttons hold in seconds - VALUE
|
||||
|
||||
Einstellung, wie lange ein Button gedrückt bleiben muss, um einen "hold" zu erkennen. Default: 1 Sekunde.
|
||||
|
||||
### Activate Relay x local Fallback (Optional)
|
||||
|
||||
Normalerweise werden die internen Relays über HA getriggert. Ist dieser Menüpunkt aktiviert, so wird das jeweilige Relays bei betätigen des Linken bzw. Rechten Hardware Buttons geschaltet, sollte HA offline sein.
|
||||
|
||||
### Left/Right Hardware Button - Entity (Optional)
|
||||
|
||||
Hier kann die Entitiy ausgewählt werden, welche mit dem linken/rechten Hardware Button geschaltet werden soll.
|
||||
|
||||
### Left/Right Hardware Button Name - Label (Optional)
|
||||
|
||||
Text auf dem Screen über dem jeweiligen Hardware Button (Home Screen)
|
||||
|
||||
### Left/Right Hardware Button hold assignment - VALUE (optional)
|
||||
|
||||
Auswahl, welche Action passieren soll, wenn der Button länger gedrückt bleibt.
|
||||
|
||||
### Left/Right Hardware Button custom hold action - VALUE (Optional)
|
||||
|
||||
Auswahl der zu startenden Action beim Halten des Buttons.
|
||||
|
||||
|
||||
|
||||
## Button Page 01-04
|
||||
|
||||
### Button Page 01-04 name - LABEL (Optional)
|
||||
|
||||
Text auf den jeweiligen Button Screens.
|
||||
|
||||
### Buttons 01 - 32 (Optional)
|
||||
Die Buttons sind durch Wischen auf dem Home Screen zu erreichen und in ihrer Funktion völlig identisch.
|
||||
Entweder können nacheinander die einzelnen Button Pages durch Wischen nach links erreicht werden, oder direkt auf die Button Pages durch Wischen nach oben, unten oder rechts angesprungen werden.
|
||||
|
||||
Die Buttons sind wie folgt nummeriert:
|
||||
|
||||
| | Button Page 1 | Button Page 2 | Button Page 3 | Button Page 4 |
|
||||
| ------- | ------------- | ------------- | ------------- | ------------- |
|
||||
| Zeile 1 | 01 02 03 04 | 09 10 11 12 | 17 18 19 20 | 25 26 27 28 |
|
||||
| Zeile 2 | 05 06 07 08 | 13 14 15 16 | 21 22 23 24 | 29 30 31 32 |
|
||||
|
||||
Es können folgende Entitäten hinterlegt werden:
|
||||
- Light
|
||||
- Switch
|
||||
- Cover
|
||||
- Input Boolean
|
||||
- Automation
|
||||
- Button
|
||||
- Input Button
|
||||
- Scene
|
||||
- Person
|
||||
- Script
|
||||
- Binary Sensor
|
||||
- Fan
|
||||
- Climate
|
||||
|
||||
Wenn der jeweilige Button gedrückt wird, wird automatisch die korrespondierende Seite aufgerufen, bspw. bei Cover die Coversteuerung etc.
|
||||
Für jeden Button kann optional ein eigener Name angegeben werden.
|
||||
Alle Buttons bieten die Möglichkeit, die Ausführung der Aktion optional bestätigen zu lassen. Dies kann separat für jeden Button über *"Confirm execution of the button press"* aktiviert bzw. deaktiviert werden.
|
||||
|
||||
|
||||
|
||||
## Entity Page 01-04
|
||||
|
||||
### Activate Entity Page - TRUE/FALSE (Optional)
|
||||
|
||||
Hiermit können die Entity Pages auf dem Home Screen aktiviert werden. Diese können verwendet werden, um bspw. Werte oder Status von Entitäten auf den einzelnen Pages darzustellen.
|
||||
|
||||
### Entity Page 01-04 name - LABEL (Optional)
|
||||
|
||||
Text auf den jeweiligen Entity Screens.
|
||||
|
||||
### Entity 01 - 32 (Optional)
|
||||
|
||||
Die Entity Pages sind durch drücken auf das Entity Symbol auf dem Home Screen zu erreichen und in ihrer Funktion völlig identisch.
|
||||
|
||||
Die Entities sind wie folgt nummeriert:
|
||||
|
||||
| | Entity Page 1 | Entity Page 2 | Entity Page 3 | Entity Page 4 |
|
||||
| ------- | ------------- | ------------- | ------------- | ------------- |
|
||||
| Zeile 1 | 01 02 03 04 | 09 10 11 12 | 17 18 19 20 | 25 26 27 28 |
|
||||
| Zeile 2 | 05 06 07 08 | 13 14 15 16 | 21 22 23 24 | 29 30 31 32 |
|
||||
|
||||
Zusätzlich besteht die Möglichkeit, ein Icon für jede Entität aus derzeit 6896 Icons auszuwählen.
|
||||
Natürlich gibt es auch die Möglichkeit, eine eigene Entitätsbezeichnung einzugeben und eine Bezeichnung für die 4 Seiten zu vergeben. Wenn kein Entity-Label gesetzt ist, wird der Friendly Name von HA übernommen.
|
||||
|
||||
Die derzeit verfügbaren Icons finden sich hier: https://htmlpreview.github.io/?https://github.com/jobr99/Generate-HASP-Fonts/blob/master/cheatsheet.html
|
||||
|
||||
Zum Einfügen des ausgewählten Icons auf das "U" des Icons klicken und in das jeweilige Feld im Blueprint einfügen. Es wird danach ein "komisches" Symbol im Blueprint angezeigt, dies ist jedoch korrekt.
|
||||
|
||||
|
||||
|
||||
## Custom Configuration
|
||||
|
||||
### Hot Water Temperatur Sensor (Optional)
|
||||
|
||||
Optionaler Heiß Wasser Sensor.
|
||||
|
||||
### Top 04 Flame
|
||||
|
||||
Zeigt ein Flammen-Symbol auf dem Home Screen an, bspw. wenn eine Therme angeschaltet (On) ist.
|
||||
|
||||
### Nextion TFT File Folder
|
||||
|
||||
Kann freigelassen werden. Wird aber benötigt, wenn eine eigene TFT Konfiguration verwendet werden soll.
|
||||
|
||||
### Synchronization of all all values (Optional)
|
||||
|
||||
Light und Cover Seiten (Werte) werden kontinuierlich upgedatet (kann zu Flackern führen).
|
||||
|
||||
### Synchronization of all all Sliders (Optional)
|
||||
|
||||
Light und Cover Seiten (Position der Cover) werden kontinuierlich upgedatet (kann zu Flackern führen).
|
||||
|
||||
|
||||
|
||||
|
||||
***
|
||||
|
||||
Beispiel Screenshots:
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -1,29 +0,0 @@
|
||||
Es müssen verschiedene Dinge eingerichtet werden. Wenn diese nicht oder falsch eingerichtet sind, bleibt das NSPanel bei der Initialisierung stehen:<br>
|
||||
|
||||
<br><br>
|
||||
|
||||
#### 1. Wurde ESPHome korrekt geflashed
|
||||
Stellen Sie sicher, dass Sie die ESPHome-Konfiguration auf dem NSPanel installiert haben<br>
|
||||
<br>
|
||||
|
||||
#### 2. ESPHome Name
|
||||
Der Gerätename in ESPHome darf nur Kleinbuchstaben, Zahlen oder einen Unterstrich (\_) enthalten. Wenn Bindestriche (-) verwendet werden, kommt es zu Problemen.<br>
|
||||
<br>
|
||||
<br>
|
||||
|
||||
#### 3. NSPanel zu HA hinzugefügt
|
||||
Die ESPHome-Integration muss für jedes NSPanel im HA hinzugefügt werden:
|
||||
<br>
|
||||
<br>
|
||||
|
||||
#### 4. Blueprint installiert und Automation aktiviert
|
||||
Sicherstellen, dass der Blueprint installiert ist:<br>
|
||||
[](https://my.home-assistant.io/redirect/blueprint_import/?blueprint_url=https%3A%2F%2Fgithub.com%2FBlackymas%2FNSPanel_HA_Blueprint%2Fblob%2Fmain%2Fnspanel_blueprint.yaml)<br>
|
||||
|
||||
|
||||
Sicherstellen, dass eine Automatisierung für das NSPanel erstellt wurde und dass der **ESP Node Name** exakt dem Namen im ESPHome entspricht
|
||||
|
||||
|
||||
<br><br><br>
|
||||
|
||||
Sobald diese Schritte vorgenommen wurden, sollte sich das Display nach einem kurzen Delay verbinden.
|
||||
309
docs/de/howto.md
309
docs/de/howto.md
@@ -1,309 +0,0 @@
|
||||
|
||||
In diesem Beitrag werden wir alle wichtigen Dinge zu verschiedenen Themen zusammen tragen, die im Laufe der Zeit uns auffallen.
|
||||
> ### _**HINWEIS! sollte dir bei der Konfiguration etwas auffallen oder du irgendein Problem hattest und es lösen konntest, wäre es für uns und alle anderen in der Community super, wenn du dein Wissen mit uns teilst. Dazu kannst du mir ein kurze Nachricht schreiben und ich nehme es in diesem Beitrag dann mit auf.**_
|
||||
|
||||
|
||||
> ### WICHTIG! Wenn du ein Problem bei der Einrichtung oder einer Funktion hast und ein _**"Issue auf Github"**_ eröffnest, beschreibe dein Problem bitte so genau wie möglich. Auch Bilder können hier helfen.
|
||||
|
||||
|
||||
> ### WICHTIG! Wenn du ein _**"Issue"**_ eröffnest, folge bitter der Anleitung sieh hier [Wie erstelle ich "Issues"](https://github.com/Blackymas/NSPanel_HA_Blueprint/wiki/(DE)-HowTo---Alle-wichtigen-Dinge-die-man-wissen-sollte#1-wie-erstelle-ich-issues-wenn-ich-ein-problem-habe)
|
||||
|
||||
|
||||
|
||||
|
||||
***
|
||||
|
||||
|
||||
# Inhalt:
|
||||
|
||||
1. [Wie erstelle ich "Issues" wenn ich ein Problem habe ](https://github.com/Blackymas/NSPanel_HA_Blueprint/wiki/(DE)-HowTo---Alle-wichtigen-Dinge-die-man-wissen-sollte#1-wie-erstelle-ich-issues-wenn-ich-ein-problem-habe)
|
||||
1. [Update Blueprint](https://github.com/Blackymas/NSPanel_HA_Blueprint/wiki/(DE)-HowTo---Alle-wichtigen-Dinge-die-man-wissen-sollte#2-update-blueprint)
|
||||
1. [Update ESPHome](https://github.com/Blackymas/NSPanel_HA_Blueprint/wiki/(DE)-HowTo---Alle-wichtigen-Dinge-die-man-wissen-sollte#3-update-esphome)
|
||||
1. [Update TFT](https://github.com/Blackymas/NSPanel_HA_Blueprint/wiki/(DE)-HowTo---Alle-wichtigen-Dinge-die-man-wissen-sollte#4-update-tft)
|
||||
1. Manueller TFT Upload über lokalen HA (in Arbeit)
|
||||
1. Upload TFT Fehler und Lösung (in Arbeit)
|
||||
1. [Notification via HA](https://github.com/Blackymas/NSPanel_HA_Blueprint/wiki/(DE)-HowTo---Alle-wichtigen-Dinge-die-man-wissen-sollte#7-notification-via-ha)
|
||||
1. [Climate für Relays](https://github.com/Blackymas/NSPanel_HA_Blueprint/wiki/(DE)-HowTo---Alle-wichtigen-Dinge-die-man-wissen-sollte#8-climate-für-relays)
|
||||
1. [Interne Switches als Lampe darstellen in HA](https://github.com/Blackymas/NSPanel_HA_Blueprint/wiki/(DE)-HowTo---Alle-wichtigen-Dinge-die-man-wissen-sollte#9-interne-switches-als-lampe-darstellen-in-ha)
|
||||
1. Schnell Navigation (in Arbeit)
|
||||
1. [Bestimmte Seiten direkt aufrufen](https://github.com/Blackymas/NSPanel_HA_Blueprint/wiki/(DE)-HowTo---Alle-wichtigen-Dinge-die-man-wissen-sollte#11-bestimmte-seiten-direkt-aufrufen)
|
||||
1. [RTTTL Sound abspielen](https://github.com/Blackymas/NSPanel_HA_Blueprint/wiki/(DE)-HowTo---Alle-wichtigen-Dinge-die-man-wissen-sollte#12-rtttl-sound-abspielen)
|
||||
1. Erweiterte Funktionen und Automatisierungen (in Arbeit)
|
||||
1. [Automationen starten via Input_Boolean](https://github.com/Blackymas/NSPanel_HA_Blueprint/wiki/(DE)-HowTo---Alle-wichtigen-Dinge-die-man-wissen-sollte#14-automationen-starten-via-input_boolean)
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
***
|
||||
|
||||
|
||||
|
||||
## 1. Wie erstelle ich "Issues" wenn ich ein Problem habe
|
||||
> _**Um dein Problem lösen zu können, ist es für uns wichtig so viele Informationen wie möglich zu haben**_
|
||||
|
||||
* Probleme können auf DE oder EN erstellt werden.
|
||||
* Beschreibe dein Problem so genau wie möglich.
|
||||
* Schreibe bitte deine ESPHome und Home Assistant Version
|
||||
* gehe bitte auf deine Automation und dann auf die "3 Punkte" und danach auf _**Als YAML bearbeiten**_. Kopiere den kompletten Code und füge es dem Ticket bei
|
||||
* Ein wichtiger "Helfer" beim lösen der Probleme ist der Trace einer Automation. Den Trace findest du unter _**Einstellungen --> Automatisierungen & Szenen --> deine NSPanel Automatisierung --> Traces (rechts oben)**_
|
||||
|
||||
> TRACES! Bitte führe erneut aus, was nicht funktioniert und öffne danach sofort den Trace. Oft muss auch nach dem Reboot der trace geöffnet werden. Im Boot werden die meisten Dinge geladen.
|
||||
|
||||
> WICHTIG! im Trace kannst du anhand der _**"Orangen"**_ Linien sehen welchen Weg die Automation gegangen ist. Bitte teile uns diesen Weg mit. Außerdem erstelle bitte davon ein oder mehrer Screenshots die du deinem Ticket hinzufügst. Besonders wichtig ist für uns wo die _**"Orangen"**_ Linie aufhört, denn meist ist dort auch das Problem
|
||||
|
||||
> WICHTIG! Wenn du den Trace geöffnet hast, gibt es ganz oben die _**"Zeitstempel"**_. Es ist wichtig das du den richtigen Zeitstempel auswählst.
|
||||
|
||||
|
||||
### Beispiel Trace nach Reboot:
|
||||
|
||||
|
||||
### Beispiel Automatisierungen Blueprint:
|
||||
```
|
||||
alias: YYXYYXYYX - NSPanel Configuration
|
||||
description: ""
|
||||
use_blueprint:
|
||||
path: nspanel_configuration.yaml
|
||||
input:
|
||||
nspanel_name: nspanel_dev
|
||||
language: DE
|
||||
sync_value_ha: select_no
|
||||
sync_slider_ha: select_no
|
||||
weather: AccuWeather
|
||||
accuweather: home_wetter
|
||||
outdoortemp: sensor.terrasse_garage_motion_sensor_temperature
|
||||
humidity: sensor.kinderzimmer_lea_temperatur_sensor_humidity
|
||||
hotwatertemp: sensor.hotwater_temp
|
||||
hotwatercharge: switch.charge
|
||||
heatingsystemflame: binary_sensor.flamestatus
|
||||
climate: climate.nspanel_buro
|
||||
left_button_entity: light.haustur_spot_2
|
||||
right_button_entity: light.haustur_spot_1
|
||||
entity01: light.buro_sideboard
|
||||
entity01_name: Sideboard
|
||||
entity02: cover.kuche_rollo
|
||||
entity02_name: Küche Rollo
|
||||
entity03: switch.buro_dart_beleuchtung
|
||||
entity03_name: Dart Licht
|
||||
delay: 2
|
||||
right_button_name: Test 1
|
||||
left_button_name: Test 2
|
||||
```
|
||||
|
||||
------
|
||||
|
||||
## 2. Update Blueprint
|
||||
|
||||
>Derzeit bietet HA nicht die Möglichkeit, Blueprints direkt über das UI upzudaten. Dies muss manuell bspw. über den File Editor geschehen.
|
||||
|
||||
>WICHTIG! Um eine neue Version des NSPanels zu installieren, muss zwingend der Blueprint, ESPHome sowie das TFT upgedatet werden!
|
||||
|
||||
1. Letztes Release des Blueprints von Github aus dem Repository laden.
|
||||
2. Das existierende YAML File "nspanel_blueprint.yaml" im Folder ***./config/blueprints/automation/Blackymas*** mit der neuen Version ersetzen.
|
||||
3. Automationen neu laden oder Home Assistant neu starten.
|
||||
4. Der neue Blueprint steht zur Verfügung. Bereits vorgenommene Einstellungen werden übernommen.
|
||||
-HowTo---Alle-wichtigen-Dinge-die-man-wissen-sollte.assets/BlueprintUpdate.PNG)
|
||||
|
||||
------
|
||||
|
||||
## 3. Update ESPHome
|
||||
|
||||
>WICHTIG! Um eine neue Version des NSPanels zu installieren, muss zwingend der Blueprint, ESPHome sowie das TFT upgedatet werden!
|
||||
|
||||
Zum ESPHome Update auf die ESPHome Integration gehen.
|
||||
|
||||
Dann die Konfiguration validieren:
|
||||
|
||||
-HowTo---Alle-wichtigen-Dinge-die-man-wissen-sollte.assets/image-20230203111717731.png)
|
||||
|
||||
Wenn die Validierung durchgelaufen ist, erscheint ein grünes Checkmark im oberen Bereich des Fensters. Danach auf "Install" klicken:
|
||||
|
||||
-HowTo---Alle-wichtigen-Dinge-die-man-wissen-sollte.assets/image-20230203111838285.png)
|
||||
|
||||
Ein neues Fenster öffnet sich, hier die gewünschte Verbindung zum Panel auswählen:
|
||||
|
||||
-HowTo---Alle-wichtigen-Dinge-die-man-wissen-sollte.assets/image-20230203111919475.png)
|
||||
|
||||
Danach startet der Installationsvorgang. Dies kann ein paar Minuten in Anspruch nehmen:
|
||||
|
||||
-HowTo---Alle-wichtigen-Dinge-die-man-wissen-sollte.assets/image-20230203112632305.png)
|
||||
|
||||
------
|
||||
|
||||
## 4. Update TFT
|
||||
|
||||
>WICHTIG! Um eine neue Version des NSPanels zu installieren, muss zwingend der Blueprint, ESPHome sowie das TFT upgedatet werden!
|
||||
|
||||
Das Update des Displays kann über das UI erfolgen:
|
||||
|
||||
1. Im Menü ***Einstellungen --> Geräte & Services --> Integrationen*** unter der ESPHome Integration das Display auswählen.
|
||||
|
||||
2. Unter Configuration den Switch "Update TFT Display" drücken.
|
||||
|
||||
3. Das Display beginnt den Update Prozess und startet anschließend neu.
|
||||
|
||||
-HowTo---Alle-wichtigen-Dinge-die-man-wissen-sollte.assets/DisplayUpdate.PNG)
|
||||
|
||||
------
|
||||
|
||||
## 5. Manueller TFT Upload über lokalen HA
|
||||
|
||||
In Arbeit
|
||||
|
||||
------
|
||||
|
||||
## 6. Upload TFT Fehler und Lösung
|
||||
|
||||
In Arbeit
|
||||
|
||||
------
|
||||
|
||||
## 7. Notification via HA
|
||||
|
||||
Um eine Notification auf dem NSPanel anzeigen zu lassen, kann folgender Service Call verwendet werden:
|
||||
|
||||
```
|
||||
service: esphome.panelname_notification_show
|
||||
data:
|
||||
label: Example text
|
||||
text: Example text
|
||||
```
|
||||
|
||||
Um die Notifications auf dem Panel zu bestätigen, kann folgender Service Call verwendet werden:
|
||||
|
||||
```
|
||||
service: esphome.panelname_notification_clear
|
||||
data: {}
|
||||
```
|
||||
|
||||
|
||||
Die Notifications können einfach in eine Automation mit aufgenommen werden:
|
||||
|
||||
```
|
||||
description: ""
|
||||
mode: single
|
||||
trigger:
|
||||
- platform: state
|
||||
entity_id:
|
||||
- binary_sensor.motion_detector
|
||||
to: "on"
|
||||
condition: []
|
||||
action:
|
||||
- service: esphome.panelname_notification_show
|
||||
data:
|
||||
label: Motion Detected
|
||||
text: Example for a Notification on the Panel Screen
|
||||
```
|
||||
|
||||
|
||||
------
|
||||
|
||||
## 8. Climate für Relays
|
||||
|
||||
Um das NSPanel zur Steuerung eines Heizkörpers oder einer Fussbodenheizung zu nutzen, muss im HA mindestens ein Generic Thermostat angelegt sein. Siehe hierzu: https://www.home-assistant.io/integrations/generic_thermostat/
|
||||
|
||||
Beispielkonfiguration Generic Thermostat:
|
||||
|
||||
```
|
||||
climate:
|
||||
- platform: generic_thermostat
|
||||
name: Study
|
||||
heater: switch.study_heater ## Wenn das NSPanel Relays den Heizkreis Regler schaltet, kann dieser hier definiert werden
|
||||
target_sensor: sensor.study_temperature ## Hier kann der NSPanel Sensor verwendet werden
|
||||
min_temp: 15
|
||||
max_temp: 21
|
||||
ac_mode: false
|
||||
target_temp: 17
|
||||
cold_tolerance: 0.3
|
||||
hot_tolerance: 0
|
||||
min_cycle_duration:
|
||||
seconds: 5
|
||||
keep_alive:
|
||||
minutes: 3
|
||||
initial_hvac_mode: "off"
|
||||
away_temp: 16
|
||||
precision: 0.1
|
||||
```
|
||||
|
||||
Danach muss die climate.entity noch entsprechend in der Panel Configuration hinterlegt werden:-HowTo---Alle-wichtigen-Dinge-die-man-wissen-sollte.assets/climate.PNG)
|
||||
|
||||
------
|
||||
|
||||
## 9. Interne Switches als Lampe darstellen in HA
|
||||
|
||||
In der Welt von Home Assistant ist das Relays im NSPanel ein Schalter. Und obwohl das im Allgemeinen richtig ist, werden diese Relays oft z. B. für eine Leuchte oder einen Ventilator verwendet. Wenn nun bspw. eine Lampe direkt mit dem Relays geschaltet wird, so ist es wünschenswert, dass auch im HA der Switch als Lampe angezeigt wird oder diese "Lampe" einer Lichter-Gruppe hinzugefügt werden soll.
|
||||
|
||||
Mit der Switch as X-Integration können diese Schalter in die Entitätstypen umwandeln, die dem jeweiligen Anwendungsfall am besten entsprechen: https://www.home-assistant.io/integrations/switch_as_x/
|
||||
|
||||
-HowTo---Alle-wichtigen-Dinge-die-man-wissen-sollte.assets/Swichasx.png)
|
||||
|
||||
|
||||
|
||||
------
|
||||
|
||||
## 10. Schnell Navigation
|
||||
|
||||
In Arbeit
|
||||
|
||||
------
|
||||
|
||||
## 11. Bestimmte Seiten direkt aufrufen
|
||||
|
||||
Manchmal kann es Sinn machen, automatisch eine bestimmte Seite des Displays anzeigen zu lassen. Um dies zu tun, kann folgender Service genutzt werden:
|
||||
|
||||
```
|
||||
service: esphome.nspanel_send_command_printf
|
||||
data:
|
||||
cmd: page home
|
||||
```
|
||||
|
||||
Um bspw. direkt die Button Page 2 anzuzeigen, muss "home" durch "buttonpage02" ersetzt werden.
|
||||
|
||||
Folgende Seiten sind derzeit verfügbar:
|
||||
|
||||
|
||||
|
||||
------
|
||||
|
||||
## 12. RTTTL Sound abspielen
|
||||
|
||||
HA kann ein RTTTL an das NSPanel schicken, dabei sind eigene Melodien möglich.
|
||||
|
||||
Hierzu wird folgender Service verwendet: ***nspanel_play_rtttl***
|
||||
|
||||
Man findet viele RTTTL-Strings im Web, wichtig ist, dass diese mit dem Namen und dann einem Doppelpunkt beginnen müssen.
|
||||
|
||||
Hier ein Beispiel:
|
||||
|
||||
```
|
||||
The Simpsons:d=4,o=5,b=160:c.6,e6,f#6,8a6,g.6,e6,c6,8a,8f#,8f#,8f#,2g,8p,8p,8f#,8f#,8f#,8g,a#.,8c6,8c6,8c6,c6
|
||||
```
|
||||
|
||||
|
||||
|
||||
Mehr Informationen unter: https://esphome.io/components/rtttl.html#common-beeps
|
||||
|
||||
Mehr Songs hier: https://codebender.cc/sketch:109888#RTTTL%20Songs.ino
|
||||
|
||||
------
|
||||
|
||||
## 13. Erweiterte Funktionen und Automatisierungen
|
||||
|
||||
In Arbeit
|
||||
|
||||
------
|
||||
|
||||
## 14. Automationen starten via Input_Boolean
|
||||
|
||||
Obwohl mit dem NSPanel Scripts direkt über die Buttons gestartet werden können, gibt es auch die Möglichkeit, mittels Input_Boolean direkt Automationen zu starten.
|
||||
|
||||
Hierzu muss erst ein Helper angelegt werden unter ***Settings --> Devices&Services --> Helpers***, siehe hierzu: https://www.home-assistant.io/integrations/input_boolean/-HowTo---Alle-wichtigen-Dinge-die-man-wissen-sollte.assets/Toggle1.PNG)
|
||||
|
||||
Anschliessend wird der erstellte Input_Boolean als Trigger in eine beliebige Automation aufgenommen unter State:-HowTo---Alle-wichtigen-Dinge-die-man-wissen-sollte.assets/Toggle2.PNG)
|
||||
|
||||
Im letzten Schritt den Trigger noch einem Button in der Panel Config zuordnen:-HowTo---Alle-wichtigen-Dinge-die-man-wissen-sollte.assets/Toggle3.PNG)
|
||||
|
||||
|
||||
|
||||
------
|
||||
|
||||
@@ -1,190 +0,0 @@
|
||||
In diesem Beitrag geht es um die erst Konfiguration. Hier werden alle wichtigen Schritte zur Installation und Einrichtung von ESPHome und dem Blueprint beschrieben.
|
||||
|
||||
⭐ **_Step by Step [Einrichtungs Video](https://www.youtube.com/watch?v=3afPFg6kUdc)_**
|
||||
|
||||
|
||||
> ### _**ACHTUNG! solltest du vorher bereits auf deinem NSPanel die Version "nspanel-lovelace-ui" von joBr99 eingerichtet haben, ist ein zwischen Schritt nötig - sonst ist es nicht möglich diese oder irgendeine andere Version zu installieren**_
|
||||
|
||||
|
||||
|
||||
|
||||
***
|
||||
|
||||
|
||||
# Inhalt:
|
||||
|
||||
1. [Kurz Version der Einrichtung von Esphome und Blueprint](https://github.com/Blackymas/NSPanel_HA_Blueprint/wiki/(DE)-Erste-Schritte---Installation-und-Einrichtung#1-kurz-version-der-einrichtung-von-esphome-und-blueprint)
|
||||
|
||||
2. [Version "nspanel-lovelace-ui" von joBr99 wurde vorher installiert](https://github.com/Blackymas/NSPanel_HA_Blueprint/wiki/(DE)-Erste-Schritte---Installation-und-Einrichtung#2-version-nspanel-lovelace-ui-von-jobr99-wurde-vorher-installiert)
|
||||
|
||||
3. [Advance Modus für ESPHome und HA Profis](https://github.com/Blackymas/NSPanel_HA_Blueprint/wiki/(DE)-Erste-Schritte---Installation-und-Einrichtung#3-advanced-configuration-für-alle-esphome-und-home-assistant-profis)
|
||||
|
||||
4. [Step by Step Einrichtung und Konfiguration](https://github.com/Blackymas/NSPanel_HA_Blueprint/wiki/(DE)-Erste-Schritte---Installation-und-Einrichtung#4-step-by-step-konfiguration-und-einrichtung-von-esphome-und-blueprint)
|
||||
|
||||
|
||||
|
||||
***
|
||||
|
||||
|
||||
|
||||
|
||||
## 1. Kurz Version der Einrichtung von Esphome und Blueprint
|
||||
> _**(für alle die bereits mit ESPhome und Home Assistant Erfahrung haben)**_
|
||||
|
||||
#### 1. Als erstes muss das Blueprint installiert werden. Dazu nutze bitte folgenden Link
|
||||
|
||||
[](https://my.home-assistant.io/redirect/blueprint_import/?blueprint_url=https%3A%2F%2Fgithub.com%2FBlackymas%2FNSPanel_HA_Blueprint%2Fblob%2Fmain%2Fnspanel_blueprint.yaml)
|
||||
|
||||
> Es ist auch möglich den Code aus der Datei _**"nspnael_blueprint.yaml"**_ zu kopieren und in HA einzufügen.
|
||||
> Hinweise dazu findest du unter [Using Automation Blueprints](https://www.home-assistant.io/docs/automation/using_blueprints/) und [Automation blueprint tutorial](https://www.home-assistant.io/docs/blueprint/tutorial/#create-the-blueprint-file)
|
||||
|
||||
#### 2. Nun muss von Github das File **_"nspanel_eu.tft"_** oder **_"nspanel_us.tft"_**heruntergeladen werden
|
||||
|
||||
|
||||
|
||||
|
||||
#### 3. Das File muss nun auf deinen Home Assistant Server in den Ordner **_"www"_** hochgeladen werden. Siehe dazu auch hier [Home Assistant HTTP](https://www.home-assistant.io/integrations/http/#hosting-files) 'Hosting Files' Bereich für weiter Informationen.
|
||||
|
||||
|
||||
|
||||
#### 4. im nächsten Schritt muss eine neues ESP32 Device in ESPHome erstellt werden
|
||||
|
||||
#### 5. wenn das neue ESP32 Device erstellt wurde, klicke als nächstes bei dem soeben angelegten Device auf _**"Edit"**_ um den Web-Editor zu öffnen. Nun muss folgender Code kopiert und eingesetzt werden.
|
||||
|
||||
> ❗ _**WICHTIG!**_ Der bereits vorhanden Code in der ESPHome Datei muss _**"KOMPLETT"**_ gelöscht werden und durch den unten stehenden Code _**"ERSETZT"**_ werden.
|
||||
|
||||
> ❗ _**WICHTIG!**_ im Block _**"CHANGE ME"**_ müssen alle Werte _**(device_name, wifi_ssid, wifi_password)**_ in den _**" "**_ durch deine eigenen Werte ersetzt werden. Es ist hier auch möglich mit _**"!secret"**_ zu arbeiten
|
||||
|
||||
|
||||
> ⚠️ _**ACHTUNG!**_ es dürfen bei _**"device_name"**_ max. 15 Zeichen _**[a-z] und [0-9]**_ verwendet werden und alles müssen _**"Kleinbuchstaben"**_ sein. Weiterhin sind Zeichen wie _**[-], [SONDERZEICHEN] und [LEERZEICHEN]**_ verboten und führen zu Problemen mit dem Blueprint.
|
||||
|
||||
> **Beispiel:** _**nspanel_blackymas**_
|
||||
|
||||
|
||||
### CODE:
|
||||
```
|
||||
substitutions:
|
||||
|
||||
###### CHANGE ME START ######
|
||||
|
||||
device_name: "YOUR NSPANEL_NAME"
|
||||
wifi_ssid: "YOUR WIFI SSID"
|
||||
wifi_password: "YOUR WIFI PASSWORD"
|
||||
|
||||
nextion_update_url: "http://HOME-ASSISTANT-IP:8123/local/nspanel_eu.tft" # URL to local tft File
|
||||
# nextion_update_url: "https://raw.githubusercontent.com/Blackymas/NSPanel_HA_Blueprint/main/nspanel_eu.tft" # URL to Github
|
||||
|
||||
##### CHANGE ME END #####
|
||||
|
||||
|
||||
|
||||
##### DO NOT CHANGE ANYTHING! #####
|
||||
|
||||
packages:
|
||||
##### download esphome code from Github
|
||||
remote_package:
|
||||
url: https://github.com/Blackymas/NSPanel_HA_Blueprint
|
||||
ref: main
|
||||
files: [nspanel_esphome.yaml]
|
||||
refresh: 1s
|
||||
|
||||
esp32:
|
||||
framework:
|
||||
type: esp-idf
|
||||
|
||||
##### DO NOT CHANGE ANYTHING! #####
|
||||
```
|
||||
|
||||
|
||||
> Im Pfad **_http://HOME-ASSISTANT-IP:8123/local/nspanel_eu.tft_** muss nun die IP Adresse von deinem _**Home Assistant Server**_ eingetragen werden. (_**/local/**_ ist das selbe Verzeichnis wie **_"www"_**
|
||||
>
|
||||
>
|
||||
|
||||
> Das kann dann wie folgt aussehen **_http://192.168.1.1:8123/local/nspanel_eu.tft_**
|
||||
|
||||
> ⚠️ **_ACHTUNG_** Du kannst auch den Pfad zu Github verwenden **_https://raw.githubusercontent.com/Blackymas/NSPanel_HA_Blueprint/main/nspanel_eu.tft_** und das TFT direkt von Github herunter laden. Aber dabei kann es zu Problemen mit dem Upload zum NSPanel kommen. Das hängt von deinem Internet und WLAN ab. Für mehr Informationen zu diesem Thema schauen auf der **_Issue_** Seite im Github. Das ganze sollte dann so aussehen
|
||||
|
||||
```
|
||||
# nextion_update_url: "http://HOME-ASSISTANT-IP:8123/local/nspanel_eu.tft" # URL to local tft File
|
||||
nextion_update_url: "https://raw.githubusercontent.com/Blackymas/NSPanel_HA_Blueprint/main/nspanel_eu.tft" # URL to Github
|
||||
```
|
||||
|
||||
> ⚠️ **_ACHTUNG_** soll das US Layout des Panels verwendet werden, dann muss anstelle von "nspanel_eu.tft" in der nextion_update_url "nspanel_us.tft" verwendet werden!
|
||||
|
||||
#### 6. Jetzt kann das NSPanel mit dem neuen ESPHome Code geflasht werden
|
||||
> wie das NSPanel geflasht wird kannst du dir hier ansehen [Anleitung - Flash Sonoff NSPanel mit ESPHome](https://www.youtube.com/watch?v=3afPFg6kUdc)
|
||||
|
||||
#### 7. Nachdem das NSPanel fertig geflasht wurde, kannst du unter _**"Einstellungen --> Geräte & Dienste --> Integration hinzufügen"**_ dein neues Gerät hinzufügen und fertig einrichten
|
||||
|
||||
#### 8. im letzten Schritt muss nun nur noch das TFT hochgeladen werden. Dazu öffne in der Integration ESPHome dein neues Device und aktiviere unter _**"Konfiguration"**_ den Punkt _**"Update TFT display"**_. Jetzt wird von deinem lokalen Home Assistant Server oder Github das aktuelle TFT File geladen und auf dein NSPanel hochgeladen. _**ACHTUNG!**_ dieser Vorgang kann einen Moment dauern
|
||||
|
||||
#### 9. jetzt ist die Einrichtung vom ESPHome und dem NSPanel abgeschlossen.
|
||||
|
||||
#### 10. Nun kannst du über das Blueprint dein NSPanel konfigurieren. Dazu gehe auf _**"Einstellungen --> Automatisierungen & Szenen --> Vorlagen --> NSPanel Configuration --> AUTOMATISIERUNG ERSTELLEN"**_ und starte mit der Einrichtung vom NSPanel.
|
||||
|
||||
> **HINWEIS!** Trage im Blueprint im Feld _**"ESPHOME Node Name"**_ exakt den selben Namen ein, den du in der _**"ESPHome Datei"**_ vergeben hast.
|
||||
|
||||
> **Beispiel:** _**nspanel_blackymas**_
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
***
|
||||
|
||||
|
||||
|
||||
## 2. Version "nspanel-lovelace-ui" von joBr99 wurde vorher installiert
|
||||
> _**in der Version "nspanel-lovelace-ui" von joBr99 sind ein paar Besonderheiten eingebaut, die es nicht so einfach ermöglichen eine neue Version und TFT auf das NSPanel zu flashen. Da wir dieses Problem aber schon hatten, haben wir natürlich auch schon eine Lösung für euch ;)**_
|
||||
|
||||
### _**Es ist notwendig eine "Leeres TFT" Datei hochzuladen, solange "Lovelace ui" noch auf dem NSPanel installiert ist.**_
|
||||
|
||||
> WICHTIG! Wenn du bereits das NSPanel mit meiner Version installiert hast, musst du zuerst wieder "Lovelace ui" vollständig installieren.
|
||||
|
||||
### Folgende Schritte sind notwendig:
|
||||
|
||||
1. lade dir aus dem Ordner _**custom_configuration**_ die Datei _**"nspanel_blank.tft"**_ herunter.
|
||||
2. lade nun die TFT Datei _**"nspanel_blank.tft"**_ in den Ordner _**"www"**_ in Home Assistant hoch
|
||||
3. gehe jetzt zu dem Punkt _**"Entwicklerwerzeuge --> Dienste"**_ und suche dort nach dem Dienst
|
||||
|
||||
_**"ESPHome: DEVICE_NAME_upload_tft"**_ --> (esphome.device_name_upload_tft)
|
||||
4. unter URL musst du jetzt den Pfad zu deiner Datei _**nspanel_blank.tft**_ eingeben. Das könnte zum Beispiel so aussehen _**"http://IP_HOME_ASSISTANT:8123/local/nspanel_blank.tft"**_
|
||||
5. nun sollte die TFT Datei auf das NSPanel gespielt werden. Es kann einen Moment dauern, bis es fertig ist
|
||||
6. sollte alles funktioniert haben, sollte auf dem NSPanel nur eine weiße Seite zu sehen sein
|
||||
7. jetzt kann mit der Einrichtung und Konfiguration meiner Version fortgesetzt werden. Dazu siehe [Kurz Version der Einrichtung von Esphome und Blueprint](https://github.com/Blackymas/NSPanel_HA_Blueprint/wiki/(DE)-Erste-Schritte---Installation-und-Einrichtung#1-kurz-version-der-einrichtung-von-esphome-und-blueprint)
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
***
|
||||
|
||||
|
||||
|
||||
## 3. Advanced configuration für alle ESPHome und Home Assistant Profis
|
||||
|
||||
* Blueprint Datei _**"nspnael_blueprint.yaml"**_ kann auch manuell installiert werden
|
||||
* ESPHome Datei_**"nspanel_esphome.yaml"**_ kann auch manuell installiert werden. Dadurch können weitere _**"Advanced"**_ Konfigurationen aktiviert oder hinzugefügt werden.
|
||||
* Außerdem besteht die Möglichkeit das TFT File _**"nspanel_eu.tft"**_ manuell hochzuladen. Das Ganze kann auch mit einem _**"Folder Watcher"**_ kombiniert werden
|
||||
* zusätzlich stellen wir die HMI Datei _**"nspanel_eu.HMI"**_ für den Nextion Editor zur Verfügung, um Grafiken und Programmierung bei bedarf anpassen zu können
|
||||
|
||||
> _**ACHTUNG!**_ Wer diesen Modus benutzt, sollte wissen was er tut. Wir geben hier keinen Support!
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
***
|
||||
|
||||
|
||||
|
||||
## 4. Step by Step Konfiguration und Einrichtung von ESPHome und Blueprint
|
||||
> _**(für alle die neu im Thema ESPhome sind oder noch keine Erfahrungen gesammelt haben)**_
|
||||
@@ -1,29 +0,0 @@
|
||||
> ### _**ACHTUNG! Wenn bereits die Version "nspanel-lovelace-ui" von joBr99 auf dem NSPanel installiert ist, ist ein Zwischenschritt notwendig - ansonsten ist es nicht möglich, diese oder eine andere Version zu installieren.**_
|
||||
>Siehe hierzu [Installation und Einrichtung](https://github.com/Blackymas/NSPanel_HA_Blueprint/wiki/(DE)-Erste-Schritte---Installation-und-Einrichtung#2-version-nspanel-lovelace-ui-von-jobr99-wurde-vorher-installiert)
|
||||
<br>
|
||||
|
||||
> ### _**Die frühere Methode, bei der NSPanel das TFT direkt von GitHub heruntergeladen hat, wurde eingestellt, da eine große Anzahl von Benutzern langsame oder fehlgeschlagene Downloads verzeichnete. Daher muss der Upload nun mit einer lokal gehosteten tft-Datei vorgenommen werden**_
|
||||
|
||||
Es gibt eine Reihe von Problemen, die das Hochladen des TFT-Uploads beeinträchtigen können. Diese Probleme betreffen nicht das NSPanel HA Blueprint-Projekt, sondern scheinen bei Nextion-Displays und ESPhome aufzutreten. Nicht alle der unten genannten Ursachen betreffen alle Benutzer, jedoch haben die folgenden Massnahmen unter jedem Punkt zu einer Lösung geführt.
|
||||
|
||||
<br>In order of likelihood:
|
||||
|
||||
#### 1. Eine lokale Datenquelle verwenden (Home Assistant)
|
||||
Dies ist die häufigste Ursache für Probleme und der Grund, warum unsere Anleitung nicht mehr auf das Herunterladen des TFT von GitHub verweisen. Durch Ändern der nextion_update_url zum Hosten der TFT-Datei auf dem lokalen HA werden die meisten Probleme gelöst.
|
||||
|
||||
Siehe hierzu Punkt 2-4 in den [Installation und Einrichtung](https://github.com/Blackymas/NSPanel_HA_Blueprint/wiki/(DE)-Erste-Schritte---Installation-und-Einrichtung#2-version-nspanel-lovelace-ui-von-jobr99-wurde-vorher-installiert)
|
||||
<br><br>
|
||||
|
||||
#### 2. HTTP anstelle von HTTPS
|
||||
Während HTTPS für einige Benutzer funktionieren kann, mussten wir feststellen, dass es eine Reihe von Problemen verursachen kann. Eine Möglichkeit ist, das TFT-Dateihosting und nextion_update_url auf HTTPS umzustellen.
|
||||
<br><br>
|
||||
|
||||
#### 3. Netzwerkprobleme
|
||||
Eine instabile Netzwerkverbindung kann zu Verbindungsabbrüchen führen. Das NSPanel näher an den WiFi Zugangspunkt zu bringen, oder den Router neu zu starten sind zwei Möglichkeiten, dieses Problem zu lösen.
|
||||
Wenn die Fehlermeldung _Connection Refused_ oder _Connection Reset_ erscheint, ist dies das häufigste Problem.
|
||||
<br><br>
|
||||
|
||||
#### 4. DNS
|
||||
Ähnlich wie Punkt 2, sollte eine IP Adresse statt die DNS Auflösung verwendet werden:
|
||||
|
||||
also http://192.168.0.100:8123/local/nspanel.tft anstelle von http://homeassistant.local:8123/local/nspanel.tft
|
||||
@@ -1,36 +0,0 @@
|
||||
## Konfiguration
|
||||
|
||||
#### Im Home Assistant NSPanel Blueprint
|
||||
Im Blueprint muss als Integration "Accuweather" ausgewählt werden und die Weather Entitiy von AccuWeather (bspw. Home) ausgewählt werden:<br>
|
||||
<br>
|
||||
<br>
|
||||
|
||||
#### AccuWeather Vorhersage aktivieren
|
||||
|
||||
Unter Settings - Devices&Services - Accuweather - Configure muss der Haken bei "Weather forecast" gesetzt sein:
|
||||
|
||||
<br>
|
||||
<br>
|
||||
|
||||
#### Überprüfen in Developer Tools
|
||||
|
||||
#### In developer tools the weather entity should have the attribute 'attribution: Data provided by AccuWeather'<br>
|
||||
|
||||
Unter Developer Tools - States kann die AccuWeather integration überprüft werden. Die Weather Entity (hier im Beispiel weather.home) muss das Attribute "attribution: Data provided by Accuweather" haben:
|
||||
|
||||
#### <br>
|
||||
<br>
|
||||
|
||||
<br>
|
||||
|
||||
## Wenn das Problem immer noch besteht
|
||||
Es kann in Einzelfällen vorkommen, dass mehrere Wetter Integrationen nicht zusammen funktionieren. Um dies zu beheben, empfehlen wir ALLE Wetter Integrations zu löschen und AccuWeather neu hinzuzufügen. Achtung: Dabei werden alle assoziierten Daten sowie Entities gelöscht!!
|
||||
|
||||
Das Vorgehen ist wie folgt:
|
||||
|
||||
#### 1. Löschen der Standard und AccuWeather Integration
|
||||
|
||||
#### 2. Hinzufügen der AccuWeather Integration & Aktivieren der Vorhersage
|
||||
|
||||
#### 3. In der Blueprint Automation des NSPanels AccuWeather hinzufügen und die Entität auswählen
|
||||
|
||||
@@ -1,33 +1,48 @@
|
||||
# Panel stuck on Boot page
|
||||
|
||||
When your panel starts, a number of different things needs to be set and the ESPHome must establish connection to the Nextion display used by your panel and also to your Home Assistant, which will provide the propper settings required by your panel. If everything goes right, the boot page will be shown for just a few seconds, then the wake-up page will be shown.
|
||||
When your panel starts, a number of different things needs to be set and the ESPHome must establish connection to the Nextion display used by your panel
|
||||
and also to your Home Assistant, which will provide the propper settings required by your panel.
|
||||
If everything goes right, the boot page will be shown for just a few seconds, then the wake-up page will be shown.
|
||||
|
||||
If something happens during this process, your panel may get stuck on this page. In many cases, restarting your panel can resolve the issue, but if after a reboot it still showing the boot page, this guide may help you.
|
||||
If something happens during this process, your panel may get stuck on this page.
|
||||
In many cases, restarting your panel can resolve the issue, but if after a reboot it still showing the boot page, this guide may help you.
|
||||
|
||||
Understanding what is shown on the boot page can be useful to find the cause of the problem or when you are looking for help.
|
||||
|
||||
## Understanding the boot page
|
||||
|
||||
Your boot page probably looks like this:
|
||||
#### Before ESPHome is connected:
|
||||
|
||||
**Before ESPHome is connected:**
|
||||
|
||||
|
||||
#### When ESPHome is connected:
|
||||
|
||||
**When ESPHome is connected:**
|
||||
|
||||
|
||||
|
||||
### What is shown on the screen
|
||||
|
||||
#### Initializing or IP address
|
||||
|
||||
In the top, you will see the message "Initializing..." while the display is executing it's boot sequence or waiting for a connection from ESPHome.
|
||||
|
||||
Once ESPHome is connected to both the display and the Wi-Fi network, that text will be replace by the IP address, which can be useful for troubleshooting.
|
||||
|
||||
#### Baud rate (bps)
|
||||
On the top right corner, it's shown the baud rate used by the display to communicate to ESPHome. By default, all the communication should happens at 115200 bps, but as 921600 bps is also supported, the display will alternate between these 2 rates every 30 seconds until ESPHome gets connected.
|
||||
|
||||
On the top right corner, it's shown the baud rate used by the display to communicate to ESPHome.
|
||||
By default, all the communication should happens at 115200 bps, but as 921600 bps is also supported, the display will alternate between these 2 rates every 30 seconds until ESPHome gets connected.
|
||||
|
||||
#### Framework
|
||||
|
||||
Right bellow the baud rate information, you may see the framework used by ESPHome, which is either `esp-idf` (default for new installations) or `arduino` (default for installations prior v4.1.4).
|
||||
|
||||
That information will be available only when ESPHome establishes communication with the display. If you cannot see that information after a couple of seconds then you may have an issue on the communication between ESPHome and the display (explained later).
|
||||
That information will be available only when ESPHome establishes communication with the display.
|
||||
If you cannot see that information after a couple of seconds then you may have an issue on the communication between ESPHome and the display (explained later).
|
||||
|
||||
#### Versions
|
||||
|
||||
Here you may see the version of TFT, ESPHome and Blueprint used by this project.
|
||||
|
||||
If some of those versions are not shown, you can have an indication of where a possible communication issue is.
|
||||
@@ -39,10 +54,13 @@ If some of those versions are not shown, you can have an indication of where a p
|
||||
In normal situation, all the versions should be displayed and should be the same. Different patch versions are supported.
|
||||
|
||||
#### Reboot button
|
||||
|
||||
You can use this button to force a reboot of your panel. This button is available when ESPHome establishes communication with the display.
|
||||
|
||||
## Common issues
|
||||
|
||||
### ESPHome cannot establish communication to your panel's Nextion display
|
||||
|
||||
**Symptoms:** The ESPHome version (and other info) won't be shown in the boot page.
|
||||
|
||||
| Possible causes | Suggestions |
|
||||
@@ -52,18 +70,21 @@ You can use this button to force a reboot of your panel. This button is availabl
|
||||
| Baud rate mismatch. | Make sure your yaml settings don't have any specific baud rate set or, if a custom baud rate is set, make sure it is one of the supported rates (115200 bps or 921600 bps). |
|
||||
|
||||
### Blueprint is not detected
|
||||
|
||||
**Symptoms:** The ESPHome version is shown, but not the blueprint version.
|
||||
|
||||
<!-- markdownlint-disable MD013 MD033 -->
|
||||
| Possible causes | Suggestions |
|
||||
| :-- | :-- |
|
||||
| You may have an older version of the blueprint installed or the blueprint isn't installed into your Home Assistant. | [Install the blueprint](https://my.home-assistant.io/redirect/blueprint_import/?blueprint_url=https%3A%2F%2Fgithub.com%2FBlackymas%2FNSPanel_HA_Blueprint%2Fblob%2Fmain%2Fnspanel_blueprint.yaml).<br>[Update the blueprint](howto.md#update-blueprint).|
|
||||
| You don't have an automation created using the blueprint. | On Home Assistant, go to **Settings** --> **Automations & Scenes** --> **Blueprints** --> **NSPanel Configuration** --> **CREATE AUTOMATION** and follow the [instructions to setup your automation](blueprint.md).<br>**Attention!!** You need one automation per panel, if you have more than one panel set. |
|
||||
| Your panel is not selected in the automation. | Open the automation related to your panel and make sure the right device is set on the **NSPanel device** field. |
|
||||
| Reconnect the Panel's device to Home Assistant. | 1. Go to **Settings** --> **Devices & Services** --> **ESPHome**<br>2. Delete the device<br>3. Restart Home Assistant host<br>4. Go back to **Settings** --> **Devices & Services**<br>5. Click **Add integration**<br>6. Select **ESPHome**<br>7. Enter your panel's hostname or IP address.|
|
||||
|
||||
<!-- markdownlint-enable MD013 MD033 -->
|
||||
|
||||
## Additional Tips and Resources
|
||||
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
|
||||
@@ -72,4 +93,5 @@ Please share as much info as possible, like:
|
||||
4. Describe what you have already tried.
|
||||
|
||||
## Important note
|
||||
|
||||
Remember, these steps are a guideline and might vary slightly based on your specific setup and previously installed system.
|
||||
|
||||
148
docs/howto.md
148
docs/howto.md
@@ -1,22 +1,25 @@
|
||||
# How-to
|
||||
|
||||
# Introduction
|
||||
In this document, we collect important information, tips, and solutions related to various topics noticed over time. This is a community-driven resource, and we encourage everyone to contribute their knowledge.
|
||||
In this document, we collect important information, tips, and solutions related to various topics noticed over time.
|
||||
This is a community-driven resource, and we encourage everyone to contribute their knowledge.
|
||||
|
||||
## Community Contribution
|
||||
If you have a solution or tip to share, please contribute! Your knowledge can significantly help others in the community. You can write a short message with your findings, and we'll include it here.
|
||||
|
||||
# Topics and Solutions
|
||||
If you have a solution or tip to share, please contribute! Your knowledge can significantly help others in the community.
|
||||
You can write a short message with your findings, and we'll include it here.
|
||||
|
||||
## Topics and Solutions
|
||||
Below are the topics covered in this document, each with relevant tips and solutions.
|
||||
|
||||
1. [How do I create "Issues" when I have a problem ](#How-do-I-create-issues-when-I-have-a-problem)
|
||||
1. [Update Blueprint](#Update-blueprint)
|
||||
1. [Update ESPHome](#Update-esphome)
|
||||
1. [Update TFT](#Update-tft)
|
||||
1. [How do I create "Issues" when I have a problem ](#how-to-create-issues-when-i-have-a-problem)
|
||||
1. [Update Blueprint](#update-blueprint)
|
||||
1. [Update ESPHome](#update-esphome)
|
||||
1. [Update TFT](#update-tft)
|
||||
1. [Notification via HA](#notification-via-ha)
|
||||
1. [Climate control with relays](#climate-control-with-relays)
|
||||
1. [Call a page directly](#Call-a-page-directly)
|
||||
1. [Call a page directly](#call-a-page-directly)
|
||||
1. [Play RTTTL Sound](#play-rtttl-sound)
|
||||
1. [Start automations via Input_Boolean](#Start-automations-via-input_boolean)
|
||||
1. [Start automations via Input_Boolean](#start-automations-via-input_boolean)
|
||||
1. [Updating Wi-Fi and OTA passwords in ESPHome with this project](#updating-wi-fi-settings-and-ota-passwords-in-esphome-with-this-project)
|
||||
|
||||
## How to create "issues" when I have a problem
|
||||
@@ -25,22 +28,35 @@ Below are the topics covered in this document, each with relevant tips and solut
|
||||
|
||||
* Describe your problem as detailed as possible.
|
||||
* Please write your ESPHome and Home Assistant version, as the version of files of this project (TFT, ESPHome and Blueprint).
|
||||
* Please go to your automation and then to the "3 dots" and then to _**Edit as YAML**_. Copy the complete code and attach it to the ticket
|
||||
* An important "helper" for solving problems is the trace of an automation. You can find the trace under _**Settings --> Automations & Scenes --> your NSPanel automation --> Traces (top right)**_
|
||||
* Please go to your automation and then to the "3 dots" and then to _**Edit as YAML**_.
|
||||
Copy the complete code and attach it to the ticket
|
||||
* An important "helper" for solving problems is the trace of an automation.
|
||||
You can find the trace under _**Settings --> Automations & Scenes --> your NSPanel automation --> Traces (top right)**_
|
||||
|
||||
> TRACES! Please execute again what does not work and open the trace immediately afterwards. Often you have to open the trace after the reboot too. During the start up, most things are loaded.
|
||||
<!-- markdownlint-disable MD028 -->
|
||||
> [!NOTE]
|
||||
> TRACES! Please execute again what does not work and open the trace immediately afterwards.
|
||||
> Often you have to open the trace after the reboot too.
|
||||
> During the start up, most things are loaded.
|
||||
|
||||
> IMPORTANT! in the trace you can see by the _**"orange "**_ lines which way the automation has gone. Please tell us this path. Also, please take one or more screenshots and add them to your ticket. Especially important for us is where the _**"Orange "**_ line ends, because most of the time this is also where the problem is.
|
||||
> [!IMPORTANT]
|
||||
> In the trace you can see by the _**"orange "**_ lines which way the automation has gone.
|
||||
> Please tell us this path.
|
||||
> Also, please take one or more screenshots and add them to your ticket.
|
||||
> Especially important for us is where the _**"Orange "**_ line ends, because most of the time this is also where the problem is.
|
||||
|
||||
> IMPORTANT! When you have opened the trace, there is a _**"timestamp "**_ at the top. It is important that you select the correct timestamp.
|
||||
> [!IMPORTANT]
|
||||
> When you have opened the trace, there is a _**"timestamp "**_ at the top.
|
||||
> It is important that you select the correct timestamp.
|
||||
<!-- markdownlint-enable MD028 -->
|
||||
|
||||
|
||||
### Example trace after reboot:
|
||||
### Example trace after reboot
|
||||
|
||||
|
||||
|
||||
### Example automations Blueprint:
|
||||
```
|
||||
### Example automations Blueprint
|
||||
|
||||
```yaml
|
||||
alias: YYXYYXYYX - NSPanel Configuration
|
||||
description: ""
|
||||
use_blueprint:
|
||||
@@ -76,25 +92,32 @@ use_blueprint:
|
||||
>IMPORTANT: To install a new version of the NSPanel, the Blueprint, ESPHome and the TFT must be updated!
|
||||
|
||||
1. In Home Assistant, go to Settings > Automation & Scenes, select the tab Blueprints and find the blueprint named "NSPanel Configuration"
|
||||
2. Click the 3-dot menu and select "Re-import blueprint":<br>
|
||||
3. Click "Re-import" button:<br>
|
||||
2. Click the 3-dot menu and select "Re-import blueprint":
|
||||
|
||||
3. Click "Re-import" button:
|
||||
|
||||
4. Reload automations or restart Home Assistant.
|
||||
5. The new Blueprint is now available. Settings that have already been made are adopted.
|
||||
5. The new Blueprint is now available.
|
||||
Settings that have already been made are adopted.
|
||||
6. Please review the blueprint settings (under Automations tab) for new settings available with the new version.
|
||||
|
||||
## Update ESPHome
|
||||
|
||||
***IMPORTANT:***
|
||||
|
||||
- *To install a new version of the NSPanel, the Blueprint, ESPHome and the TFT must be updated!*
|
||||
- *These instructions are for updating a panel where an older version of these files are already installed.*
|
||||
|
||||
To flash your panel with an updated version from this project, go to the ESPHome dashboard (in your Home Assistant) and find the device you want to update. Then click the 3-dot menu and select the option "Validate":
|
||||
To flash your panel with an updated version from this project, go to the ESPHome dashboard (in your Home Assistant) and find the device you want to update.
|
||||
Then click the 3-dot menu and select the option "Validate":
|
||||
|
||||
|
||||
|
||||
The system will go thru all the settings, combining your entries in "substitutions" and the ESPHome file(s) from the GitHub repository and validate the final setup. It might take some time.
|
||||
The system will go thru all the settings, combining your entries in "substitutions" and the ESPHome file(s) from the GitHub repository and validate the final setup.
|
||||
It might take some time.
|
||||
|
||||
If everything goes well, you will see a green check mark in the top of the dialog window. When you get that, you can click "Install":
|
||||
If everything goes well, you will see a green check mark in the top of the dialog window.
|
||||
When you get that, you can click "Install":
|
||||
|
||||
|
||||
|
||||
@@ -114,18 +137,14 @@ The new firmware will be built and then flashed to your panel, which will restar
|
||||
The display can be updated via the UI:
|
||||
|
||||
1. Go to ***Settings --> Devices & Services --> Integrations*** , select the display under the ESPHome integration.
|
||||
|
||||
2. Press the switch "Update TFT Display" under Configuration.
|
||||
|
||||
3. The display starts the update process and then restarts.
|
||||
|
||||
-HowTo---Alle-wichtigen-Dinge-die-man-wissen-sollte.assets/DisplayUpdate.PNG)
|
||||
|
||||
## Notification via HA
|
||||
|
||||
To show a notification on the NSPAnel, the following service call can be used:
|
||||
|
||||
```
|
||||
```yaml
|
||||
service: esphome.panelname_notification_show
|
||||
data:
|
||||
label: Example text
|
||||
@@ -134,7 +153,7 @@ data:
|
||||
|
||||
To clear any notifications, the following service call can be used:
|
||||
|
||||
```
|
||||
```yaml
|
||||
service: esphome.panelname_notification_clear
|
||||
data: {}
|
||||
```
|
||||
@@ -142,7 +161,7 @@ data: {}
|
||||
|
||||
To use the notifications in an automation, again simply use the service call as shown in the example below:
|
||||
|
||||
```
|
||||
```yaml
|
||||
description: ""
|
||||
mode: single
|
||||
trigger:
|
||||
@@ -161,11 +180,12 @@ trigger:
|
||||
## Climate control with Relays
|
||||
> Attention!! Although these instructions are still valid, since v4.0 there is a better way to setup a climate control using the panel's relays: https://github.com/Blackymas/NSPanel_HA_Blueprint/wiki/(EN)-Add%E2%80%90on:-Climate
|
||||
|
||||
In order to use the NSPanel to control a radiator or underfloor heating, at least one Generic Thermostat must be created in the HA. More information can be found here: https://www.home-assistant.io/integrations/generic_thermostat/
|
||||
In order to use the NSPanel to control a radiator or underfloor heating, at least one Generic Thermostat must be created in the HA.
|
||||
More information can be found here: https://www.home-assistant.io/integrations/generic_thermostat/
|
||||
|
||||
Example configuration Generic Thermostat:
|
||||
|
||||
```
|
||||
```yaml
|
||||
climate:
|
||||
- platform: generic_thermostat
|
||||
name: Study
|
||||
@@ -186,13 +206,14 @@ climate:
|
||||
precision: 0.1
|
||||
```
|
||||
|
||||
Afterwards, the climate.entity must be assigned accordingly in the panel configuration:-HowTo---Alle-wichtigen-Dinge-die-man-wissen-sollte.assets/climate.PNG)
|
||||
Afterwards, the climate.entity must be assigned accordingly in the panel configuration.
|
||||
|
||||
## Call a page directly
|
||||
|
||||
Sometimes it can make sense to automatically show a certain side of the display. To do this, the following service can be used:
|
||||
Sometimes it can make sense to automatically show a certain side of the display.
|
||||
To do this, the following service can be used:
|
||||
|
||||
```
|
||||
```yaml
|
||||
service: esphome.nspanel_send_command_printf
|
||||
data:
|
||||
cmd: page home
|
||||
@@ -201,6 +222,7 @@ data:
|
||||
For example, to directly display button page 2, "home" must be replaced with "buttonpage02".
|
||||
|
||||
The following pages are currently available for a direct call:
|
||||
|
||||
- alarm
|
||||
- buttonpage01
|
||||
- buttonpage02
|
||||
@@ -216,19 +238,19 @@ The following pages are currently available for a direct call:
|
||||
|
||||
## Play RTTTL Sound
|
||||
|
||||
HA can send a RTTTL to the NSPanel, custom melodies are possible.
|
||||
HA can send a RTTTL to the NSPanel, custom melodies are possible.
|
||||
|
||||
The use this function, the following service is called: ***nspanel_play_rtttl***
|
||||
|
||||
You can find many RTTTL strings on the web, the important thing is that they must start with the name and then a colon.
|
||||
You can find many RTTTL strings on the web, the important thing is that they must start with the name and then a colon.
|
||||
|
||||
Here is an example:
|
||||
|
||||
```
|
||||
```txt
|
||||
The Simpsons:d=4,o=5,b=160:c.6,e6,f#6,8a6,g.6,e6,c6,8a,8f#,8f#,8f#,2g,8p,8p,8f#,8f#,8f#,8g,a#.,8c6,8c6,8c6,c6
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
More information: https://esphome.io/components/rtttl.html#common-beeps
|
||||
|
||||
@@ -238,19 +260,20 @@ More songs: https://codebender.cc/sketch:109888#RTTTL%20Songs.ino
|
||||
|
||||
Although the NSPanel can execute scripts directly over the buttons, there is also the possibility of starting automations directly by the means of Input_Boolean.
|
||||
|
||||
For this, a helper must first be created under ***Settings --> Devices&Services --> Helpers***, see here:
|
||||
https://www.home-assistant.io/integrations/input_boolean/-HowTo---All-important-thing-you-should-know.assets/Toggle1.PNG)
|
||||
For this, a helper must first be created under ***Settings --> Devices&Services --> Helpers***
|
||||
|
||||
Now add the created Input_Boolean as a trigger in the desired automation under State:-HowTo---Alle-wichtigen-Dinge-die-man-wissen-sollte.assets/Toggle2.PNG)
|
||||
Now add the created Input_Boolean as a trigger in the desired automation under State.
|
||||
|
||||
In the last step, assign the trigger to a button in the Panel Config:-HowTo---Alle-wichtigen-Dinge-die-man-wissen-sollte.assets/Toggle3.PNG)
|
||||
In the last step, assign the trigger to a button in the Panel Config.
|
||||
|
||||
## Updating Wi-Fi settings and OTA Passwords in ESPHome with This Project
|
||||
|
||||
#### Overview
|
||||
When you update your Wi-Fi password in a device with firmware from our project, it's important to remember that the `wifi_password` substitution is used for both Wi-Fi and OTA updates (and a few more places that are not relevant now). Failing to update both simultaneously can lead to connection issues.
|
||||
### Overview
|
||||
When you update your Wi-Fi password in a device with firmware from our project,
|
||||
it's important to remember that the `wifi_password` substitution is used for both Wi-Fi and OTA updates (and a few more places that are not relevant now).
|
||||
Failing to update both simultaneously can lead to connection issues.
|
||||
|
||||
#### Step-by-Step Guide
|
||||
### Step-by-Step Guide
|
||||
|
||||
1. **Prepare Your Device for Update**
|
||||
- Ensure your device is connected to your computer and is accessible via your current Wi-Fi network.
|
||||
@@ -258,6 +281,7 @@ When you update your Wi-Fi password in a device with firmware from our project,
|
||||
2. **Update OTA Password First**
|
||||
- Open your panel's YAML.
|
||||
- Add the following in the customization area:
|
||||
|
||||
```yaml
|
||||
esphome:
|
||||
on_boot:
|
||||
@@ -269,29 +293,39 @@ When you update your Wi-Fi password in a device with firmware from our project,
|
||||
password: "Your current Wi-Fi password"
|
||||
id: my_ota
|
||||
```
|
||||
- Flash your device. It will use the current password for this flash and will inform your device to start using the new password for the next OTA.
|
||||
|
||||
- Flash your device.
|
||||
It will use the current password for this flash and will inform your device to start using the new password for the next OTA.
|
||||
- When your device starts, **remove the lines above**.
|
||||
- Find the `wifi_ssid` and `wifi_password` key in the `substitutions` area (usually at the beginning of the file) and change it to your new Wi-Fi password. If that is point to `!secret`, you will have to edit it in your `secrets.yaml` file instead.
|
||||
- Flash your device again with the updated YAML. It will use the current Wi-Fi to connect to your device and the new Wi-Fi password as the OTA password, then will inform your device to connect to the Wi-Fi with the new settings.
|
||||
- Find the `wifi_ssid` and `wifi_password` key in the `substitutions` area (usually at the beginning of the file) and change it to your new Wi-Fi password.
|
||||
If that is point to `!secret`, you will have to edit it in your `secrets.yaml` file instead.
|
||||
- Flash your device again with the updated YAML.
|
||||
It will use the current Wi-Fi to connect to your device and the new Wi-Fi password as the OTA password, then will inform your device to connect to the Wi-Fi with the new settings.
|
||||
|
||||
3. **Update Wi-Fi Settings in Your Access Point**
|
||||
|
||||
#### Important Notes
|
||||
- The device will still be using the old Wi-Fi settings for this update. If you've already changed your Wi-Fi network settings, this step will fail.
|
||||
### Important Notes
|
||||
|
||||
- The device will still be using the old Wi-Fi settings for this update.
|
||||
If you've already changed your Wi-Fi network settings, this step will fail.
|
||||
- **Troubleshooting: Unable to Connect via Wi-Fi**
|
||||
- If your device cannot connect to Wi-Fi due to a password or SSID change, you will need to flash the device via a serial connection.
|
||||
- Connect your device to your computer using a USB-to-Serial adapter.
|
||||
- Use the ESPHome flasher tool to upload the new configuration.
|
||||
- In this case, don't worry about the OTA password, as it's not required when flashing via serial.
|
||||
|
||||
#### Verify the Update
|
||||
### Verify the Update
|
||||
|
||||
- Once the new configuration is uploaded, your device should automatically connect to your Wi-Fi network with the new settings.
|
||||
- Verify that OTA updates are working with the new password.
|
||||
|
||||
#### Additional Tips
|
||||
### Additional Tips
|
||||
|
||||
- **Backup Your Configuration:** Always keep a backup of your ESPHome configuration files.
|
||||
- **Network Accessibility:** Ensure your device remains within your Wi-Fi network's range during the update process.
|
||||
- **Serial Flashing:** Familiarize yourself with the process of flashing via serial, as it's a reliable fallback method.
|
||||
|
||||
#### Conclusion
|
||||
By carefully updating both your Wi-Fi settings and OTA passwords in your ESPHome configuration, you can avoid connection issues. Remember to always back up your configuration and be prepared to use a serial connection if Wi-Fi connectivity is lost.
|
||||
### Conclusion
|
||||
|
||||
By carefully updating both your Wi-Fi settings and OTA passwords in your ESPHome configuration, you can avoid connection issues.
|
||||
Remember to always back up your configuration and be prepared to use a serial connection if Wi-Fi connectivity is lost.
|
||||
|
||||
@@ -5,7 +5,7 @@ Whether you're a first-time smart device user or an enthusiast looking to person
|
||||
|
||||
> [!NOTE]
|
||||
> Some images or instructions on this guide might be slighly different due to different configurations depending on your ESPHome and Home Assistant implementation or versions.<br>
|
||||
> If you find something that is not understandable or needs to be updated, please let us know. You can create an issue reporting this, or fix it yourself and submit a [Pull Request](/Blackymas/NSPanel_HA_Blueprint/pulls) to this repository.
|
||||
> If you find something that is not understandable or needs to be updated, please let us know. You can create an issue reporting this, or fix it yourself and submit a [Pull Request](https://github.com/Blackymas/NSPanel_HA_Blueprint/pulls) to this repository.
|
||||
|
||||
## Summary
|
||||
- [Preparation](#preparation)
|
||||
@@ -162,7 +162,7 @@ The installation in a NSPanel with Sonoff's original firmware should be straighf
|
||||
If you have already installed on your NSPanel the "nspanel-lovelace-ui" firmware from @joBr99 or from Tasmota, an [intermediate step](lovelace_ui.md) is necessary. Please execute that first before returning here.
|
||||
|
||||
#### Other
|
||||
Please try the standard process and if you find any issue, please [create a new issue](/Blackymas/NSPanel_HA_Blueprint/issues) and inform which custom firmware you have installed before migrating to NSPanel HA Blueprint.
|
||||
Please try the standard process and if you find any issue, please [create a new issue](https://github.com/Blackymas/NSPanel_HA_Blueprint/issues) and inform which custom firmware you have installed before migrating to NSPanel HA Blueprint.
|
||||
|
||||
## Upload TFT
|
||||
##### Pending:
|
||||
@@ -229,7 +229,7 @@ For homes with multiple panels:
|
||||
> [!WARNING]
|
||||
> Customizations and advanced mode are not supported by this project's team. Use them with caution and only if you have the necessary expertise.
|
||||
|
||||
Before customizing your system, we encourage you to share any enhancements you make. Consider creating a [Pull Request](/Blackymas/NSPanel_HA_Blueprint/pulls) to the `dev` branch to share your discoveries with the community.
|
||||
Before customizing your system, we encourage you to share any enhancements you make. Consider creating a [Pull Request](https://github.com/Blackymas/NSPanel_HA_Blueprint/pulls) to the `dev` branch to share your discoveries with the community.
|
||||
|
||||
### ESPHome
|
||||
|
||||
@@ -275,7 +275,7 @@ For guidance on using Nextion, refer to:
|
||||
> [!TIP]
|
||||
> For troubleshooting TFT transfer issues, consult our [TFT Transfer Troubleshooting Guide](tft_upload.md) first.
|
||||
|
||||
If problems persist after troubleshooting, visit the [Issues](/Blackymas/NSPanel_HA_Blueprint/issues) page. Feel free to create a new issue for personalized assistance, providing details such as:
|
||||
If problems persist after troubleshooting, visit the [Issues](https://github.com/Blackymas/NSPanel_HA_Blueprint/issues) page. Feel free to create a new issue for personalized assistance, providing details such as:
|
||||
1. A description or picture of what is displayed on your screen.
|
||||
2. Information on whether you are updating from a previous version of this project, migrating from another NSPanel customization, or customizing a panel with the original Sonoff settings.
|
||||
3. ESPHome logs from the start of your panel to the point where the upload fails.
|
||||
|
||||
@@ -8,7 +8,10 @@ If you are coming from there, you have to chose one of the 3 options:
|
||||
- [Upload TFT using **NsPanel Lovelace UI** tools - Tasmota version](#upload-tft-using-nspanel-lovelace-ui-tools---tasmota-version)
|
||||
- [Upload TFT using this project's tools](#upload-tft-using-this-projects-tools)
|
||||
|
||||
## Updating TFT
|
||||
|
||||
### Common steps
|
||||
|
||||
1. Download the file [`nspanel_blank.tft`](../nspanel_blank.tft) from our GitHub repository.
|
||||
2. Upload the same file (`nspanel_blank.tft`) to the folder _**"www"**_ in your Home Assistant
|
||||
3. Double check if the file is available by trying to download it using your local url (typically [`http://homeassistant.local:8123/local/nspanel_blank.tft`](http://homeassistant.local:8123/local/nspanel_blank.tft)).
|
||||
@@ -17,15 +20,17 @@ If you are coming from there, you have to chose one of the 3 options:
|
||||
|
||||
After following the [**Common steps**](#common-steps), follow the additional steps:
|
||||
|
||||
4. On Home Assistant, go to _**"Developer tools --> Services"**_ and search there for the service named "**ESPHome: DEVICE_NAME_upload_tft**" or `esphome.<<device_name>>_upload_tft`.
|
||||
5. On the field `URL`, enter the url for your local `nspanel_blank.tft` file (typically `http://homeassistant.local:8123/local/nspanel_blank.tft`).
|
||||
6. Press the button **CALL SERVICE**
|
||||
1. On Home Assistant, go to _**"Developer tools --> Services"**_ and search there for the service named "**ESPHome: DEVICE_NAME_upload_tft**" or `esphome.<<device_name>>_upload_tft`.
|
||||
2. On the field `URL`, enter the url for your local `nspanel_blank.tft` file (typically `http://homeassistant.local:8123/local/nspanel_blank.tft`).
|
||||
3. Press the button **CALL SERVICE**
|
||||
|
||||
If everything goes right, you will see the progress bar indicating the file transfer an you will end up with a black screen showing a QR code. Then please follow the instructions from [here](nspanel_blank.md#what-to-do-after-installing-nspanel_blanktft).
|
||||
|
||||
### Upload TFT using **NsPanel Lovelace UI** tools - Tasmota version
|
||||
|
||||
After following the [**Common steps**](#common-steps), use the instructions from [**NsPanel Lovelace UI** - Flash Firmware to Nextion Screen](https://docs.nspanel.pky.eu/stable/prepare_nspanel/#flash-firmware-to-nextion-screen) website to upload TFT, just replacing the file url by the one you have locally (typically `http://homeassistant.local:8123/local/nspanel_blank.tft`).
|
||||
After following the [**Common steps**](#common-steps),
|
||||
use the instructions from [**NsPanel Lovelace UI** - Flash Firmware to Nextion Screen](https://docs.nspanel.pky.eu/stable/prepare_nspanel/#flash-firmware-to-nextion-screen) website to upload TFT,
|
||||
just replacing the file url by the one you have locally (typically `http://homeassistant.local:8123/local/nspanel_blank.tft`).
|
||||
|
||||
If everything goes right, you will see the progress bar indicating the file transfer an you will end up with a black screen showing a QR code. Then please follow the instructions from [here](nspanel_blank.md#what-to-do-after-installing-nspanel_blanktft).
|
||||
|
||||
@@ -35,21 +40,25 @@ If you have already installed the ESPHome firmware from this project, this is pr
|
||||
|
||||
After following the [**Common steps**](#common-steps), follow the additional steps:
|
||||
|
||||
4. On your panel's screen showing a ring and a message "Wait for content...", click 9 times in the center of the ring.<br>
|
||||
5. You should get to this page:<br>
|
||||
6. Click on the button "disable recmod"
|
||||
7. Click on the button "bauds=115200"
|
||||
4. On Home Assistant, go to _**"Developer tools --> Services"**_ and search there for the service named "**ESPHome: DEVICE_NAME_upload_tft**" or `esphome.<<device_name>>_upload_tft`.
|
||||
5. On the field `URL`, enter the url for your local `nspanel_blank.tft` file (typically `http://homeassistant.local:8123/local/nspanel_blank.tft`).
|
||||
6. Press the button **CALL SERVICE**
|
||||
1. On your panel's screen showing a ring and a message "Wait for content...", click 9 times in the center of the ring.
|
||||
|
||||
|
||||
2. You should get to this page:
|
||||
|
||||
|
||||
3. Click on the button "disable recmod"
|
||||
4. Click on the button "bauds=115200"
|
||||
5. On Home Assistant, go to _**"Developer tools --> Services"**_ and search there for the service named "**ESPHome: DEVICE_NAME_upload_tft**" or `esphome.<<device_name>>_upload_tft`.
|
||||
6. On the field `URL`, enter the url for your local `nspanel_blank.tft` file (typically `http://homeassistant.local:8123/local/nspanel_blank.tft`).
|
||||
7. Press the button **CALL SERVICE**
|
||||
|
||||
If everything goes right, you will see the progress bar indicating the file transfer an you will end up with a black screen showing a QR code. Then please follow the instructions from [here](nspanel_blank.md#what-to-do-after-installing-nspanel_blanktft).
|
||||
|
||||
|
||||
## Additional Tips and Resources
|
||||
|
||||
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
|
||||
@@ -58,4 +67,5 @@ Please share as much info as possible, like:
|
||||
4. Describe what you have already tried.
|
||||
|
||||
## Important note
|
||||
|
||||
Remember, these steps are a guideline and might vary slightly based on your specific setup and previously installed system.
|
||||
|
||||
BIN
docs/pics/204139082-70d3a8d1-1c82-43cb-88f2-573f2e276a48.png
Normal file
BIN
docs/pics/204139082-70d3a8d1-1c82-43cb-88f2-573f2e276a48.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 138 KiB |
BIN
docs/pics/269593660-e393ced5-78d4-475a-8630-893c05734f5d.png
Normal file
BIN
docs/pics/269593660-e393ced5-78d4-475a-8630-893c05734f5d.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 318 KiB |
BIN
docs/pics/269593729-bc67533b-4f2e-4034-8e7e-34063a26f1c3.png
Normal file
BIN
docs/pics/269593729-bc67533b-4f2e-4034-8e7e-34063a26f1c3.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 581 KiB |
BIN
docs/pics/269593754-c9b53549-c78a-4a02-bcde-31582905d0c4.png
Normal file
BIN
docs/pics/269593754-c9b53549-c78a-4a02-bcde-31582905d0c4.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 384 KiB |
BIN
docs/pics/269593965-e63dcb4a-ef74-4665-9897-455e02950964.png
Normal file
BIN
docs/pics/269593965-e63dcb4a-ef74-4665-9897-455e02950964.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 691 KiB |
BIN
docs/pics/287632422-afb433e8-f29c-4b3f-8d6b-16a12b181422.png
Normal file
BIN
docs/pics/287632422-afb433e8-f29c-4b3f-8d6b-16a12b181422.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 57 KiB |
BIN
docs/pics/287632717-1db36411-e5a4-4cef-bcef-575a08019a67.png
Normal file
BIN
docs/pics/287632717-1db36411-e5a4-4cef-bcef-575a08019a67.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 16 KiB |
BIN
docs/pics/Bildschirmfoto_2023-03-21_um_00.24.01.png
Normal file
BIN
docs/pics/Bildschirmfoto_2023-03-21_um_00.24.01.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 16 KiB |
BIN
docs/pics/DisplayUpdate.png
Normal file
BIN
docs/pics/DisplayUpdate.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 16 KiB |
BIN
docs/pics/Swichasx.png
Normal file
BIN
docs/pics/Swichasx.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 16 KiB |
BIN
docs/pics/Toggle2.png
Normal file
BIN
docs/pics/Toggle2.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 56 KiB |
BIN
docs/pics/Toggle3.png
Normal file
BIN
docs/pics/Toggle3.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 102 KiB |
BIN
docs/pics/climate.png
Normal file
BIN
docs/pics/climate.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 41 KiB |
BIN
docs/pics/image-20230320222454441.png
Normal file
BIN
docs/pics/image-20230320222454441.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 18 KiB |
@@ -1,20 +1,26 @@
|
||||
# Troubleshooting TFT transfer
|
||||
|
||||
> #### _**ATTENTION! If you have already installed the version "nspanel-lovelace-ui" from joBr99 on your NSPanel, an intermediate step is necessary - otherwise, it is not possible to install this or any other version.**_
|
||||
> [!IMPORTANT]
|
||||
> If you have already installed the version "nspanel-lovelace-ui" from joBr99 on your NSPanel, an intermediate step is necessary - otherwise, it is not possible to install this or any other version.
|
||||
>
|
||||
> See [Common Issues | TFT Upload when NSPanel Lovelace UI has been installed](howto.md)
|
||||
<br>
|
||||
|
||||
> #### _**The previous method of having the NSPanel download the TFT directly from GitHub has been discontinued due to a large number of users experiencing slow or failed downloads. Please make sure you change to a locally hosted TFT file for a more reliable installation process.**_
|
||||
|
||||
## Common Issues and Troubleshooting
|
||||
|
||||
The following is a list of common issues affecting the TFT upload, along with suggested solutions. These issues are not specific to the NSPanel HA Blueprint project but are common to Nextion displays and ESPHome.
|
||||
The following is a list of common issues affecting the TFT upload, along with suggested solutions.
|
||||
These issues are not specific to the NSPanel HA Blueprint project but are common to Nextion displays and ESPHome.
|
||||
|
||||
### Wait a Bit Before Starting the TFT Upload
|
||||
|
||||
- **Issue**: The Nextion display might not connect to ESPHome immediately after boot.
|
||||
- **Solution**: Wait up to 2 minutes for the boot script to complete. If you are already using a TFT from this project, the display of ESPHome version and the framework used (`arduino` vs `esp-idf`) is an indication that a communication was established. If you haven't installed any TFT yet, look for Nextion related messages on ESPHome logs.
|
||||
- **Additional Guidance**: Knowing when the device is fully booted and ready to accept the TFT upload can prevent many issues. Observe any changes in the display or logs indicators to ensure the device is ready.
|
||||
- **Solution**: Wait up to 2 minutes for the boot script to complete.
|
||||
If you are already using a TFT from this project, the display of ESPHome version and the framework used (`arduino` vs `esp-idf`) is an indication that a communication was established.
|
||||
If you haven't installed any TFT yet, look for Nextion related messages on ESPHome logs.
|
||||
- **Additional Guidance**: Knowing when the device is fully booted and ready to accept the TFT upload can prevent many issues.
|
||||
Observe any changes in the display or logs indicators to ensure the device is ready.
|
||||
|
||||
### Using a Local Source (Home Assistant)
|
||||
|
||||
- **Issue**: Problems with downloading the TFT from GitHub.
|
||||
- **Solution**: Host the TFT file on your Home Assistant and change the `nextion_update_url` accordingly.
|
||||
- **Step-by-Step Guide**: Here's how you can change your `nextion_update_url`:
|
||||
@@ -23,33 +29,43 @@ The following is a list of common issues affecting the TFT upload, along with su
|
||||
3. Replace the URL with the local address where your TFT file is hosted.
|
||||
|
||||
### HTTP Instead of HTTPS
|
||||
|
||||
- **Issue**: HTTPS connections may be problematic with ESP.
|
||||
- **Solution**: Use HTTP for hosting the TFT file and updating the `nextion_update_url`.
|
||||
- **Why HTTP?**: HTTP can be more stable for these connections. To switch, simply replace 'https' with 'http' in your URLs and make sure your http server supports non-secure connections.
|
||||
- **Why HTTP?**: HTTP can be more stable for these connections.
|
||||
To switch, simply replace 'https' with 'http' in your URLs and make sure your http server supports non-secure connections.
|
||||
|
||||
### Remove Customizations
|
||||
|
||||
- **Issue**: Customizations like `bluetooth_proxy` and `ble_tracker` may interfere with the upload.
|
||||
- **Solution**: Temporarily remove any customizations to free up memory.
|
||||
- **How to Remove Customizations**: Identify any additional features you've added and remove them from your configuration file. Pay special attention to memory-intensive customizations.
|
||||
- **How to Remove Customizations**: Identify any additional features you've added and remove them from your configuration file.
|
||||
Pay special attention to memory-intensive customizations.
|
||||
|
||||
### Use IP Address Instead of DNS
|
||||
|
||||
- **Issue**: DNS may cause connection problems.
|
||||
- **Solution**: Use the IP address of your Home Assistant directly.
|
||||
- **Example**: Replace `http://homeassistant.local:8123/local/nspanel_blank.tft` with `http://192.168.0.100:8123/local/nspanel_blank.tft`.
|
||||
|
||||
### Consider changing the framework
|
||||
|
||||
- **Issue**: You might be facing some situation where the transfer engine used by your framework cannot handle it properly.
|
||||
- **Solution**: Temporarily switch between the frameworks.
|
||||
- **Additional Guidance**: This project supports both `arduino` (ESPHome default) or `esp-idf` frameworks. Those have totally independently upload TFT engines, so changing the framework may cause a significant change.
|
||||
- **Additional Guidance**: This project supports both `arduino` (ESPHome default) or `esp-idf` frameworks.
|
||||
Those have totally independently upload TFT engines, so changing the framework may cause a significant change.
|
||||
In our experience, `esp-idf` have a better memory management and therefore is more efficient with uploading TFT, however the support to HTTPS is a bit better (although not indicated) with `arduino`.
|
||||
You can set the framework you want by adding this to your ESPHome yaml:
|
||||
|
||||
#### ESP-IDF
|
||||
|
||||
```yaml
|
||||
esp32:
|
||||
framework:
|
||||
type: esp-idf
|
||||
```
|
||||
#### Arduino
|
||||
|
||||
```yaml
|
||||
esp32:
|
||||
framework:
|
||||
@@ -57,16 +73,22 @@ esp32:
|
||||
```
|
||||
|
||||
### Check the File Size by Downloading to Your Computer
|
||||
|
||||
- **Issue**: Ensuring the file size matches the GitHub version.
|
||||
- **Solution**: Use the same URL you provided to ESPHome to download the file on your computer and compare sizes.
|
||||
- **Verification Steps**: Download the file, then right-click and select 'Properties' to check the size. Compare this with the size listed on GitHub or from the file you downlodaded directly from GitHub.
|
||||
- **Verification Steps**: Download the file, then right-click and select 'Properties' to check the size.
|
||||
Compare this with the size listed on GitHub or from the file you downlodaded directly from GitHub.
|
||||
|
||||
### Power Cycle Your Panel
|
||||
|
||||
- **Issue**: General troubleshooting.
|
||||
- **Solution**: Turn off the power supply, wait a moment, and power it back on. If your panel is already installed in the wall, you probably can still power cycle using your electricity relay's panel and switching the relay connected to your panel.
|
||||
- **How Long to Wait**: Wait at least 30 seconds before turning the power back on. This ensures the system resets to a clean state.
|
||||
- **Solution**: Turn off the power supply, wait a moment, and power it back on.
|
||||
If your panel is already installed in the wall, you probably can still power cycle using your electricity relay's panel and switching the relay connected to your panel.
|
||||
- **How Long to Wait**: Wait at least 30 seconds before turning the power back on.
|
||||
This ensures the system resets to a clean state.
|
||||
|
||||
### Flash your panel again
|
||||
|
||||
- **Issue**: Your firmware might be missing some important library, you may be using an outdated version or the ESP may be out of memory.
|
||||
- **Solution**: Remove all add-ons and non-essential customization and flash your panel again.
|
||||
- **Step-by-Step Guide**:
|
||||
@@ -76,19 +98,21 @@ esp32:
|
||||
4. Add the add-ons and removed customization back and then flash it again.
|
||||
|
||||
### Try an alternative http service
|
||||
- **Issue**: Your current http server may be overloaded.
|
||||
- **Solution**: Try another http server installed in your computer. There are many options available for free to run under you local Windows, MAC or Linux machine.
|
||||
- **Examples**: Just to name some:
|
||||
| Solution | Website | Supported OSs | Pros | Cons |
|
||||
|----------|---------|---------------|------|------|
|
||||
| NGINX | [nginx.org](https://nginx.org/en/) | Linux, Windows, macOS | High performance, efficient for static content, good for high concurrency | Configuration can be complex for beginners |
|
||||
| IIS | [Microsoft Web Platform](https://www.microsoft.com/web/downloads/platform.aspx) | Windows | Integrated with Windows, GUI for setup, good for Windows environments | Limited to Windows OS |
|
||||
| Apache | [httpd.apache.org](https://httpd.apache.org/) | Linux, Windows, macOS | Highly reliable and flexible, wide OS compatibility, extensive customization | Can be less efficient under high load than NGINX |
|
||||
| XAMPP | [apachefriends.org](https://www.apachefriends.org/index.html) | Linux, Windows, macOS | All-in-one package, easy to install, ideal for beginners | Not optimized for high-traffic sites, more suited for development than production |
|
||||
|
||||
- **Issue**: Your current http server may be overloaded.
|
||||
- **Solution**: Try another http server installed in your computer.
|
||||
There are many options available for free to run under you local Windows, MAC or Linux machine.
|
||||
- **Examples**: Just to name some:
|
||||
| Solution | Website | Supported OSs | Pros | Cons |
|
||||
|----------|---------|---------------|------|------|
|
||||
| NGINX | [nginx.org](https://nginx.org/en/) | Linux, Windows, macOS | High performance, efficient for static content, good for high concurrency | Configuration can be complex for beginners |
|
||||
| IIS | [Microsoft Web Platform](https://www.microsoft.com/web/downloads/platform.aspx) | Windows | Integrated with Windows, GUI for setup, good for Windows environments | Limited to Windows OS |
|
||||
| Apache | [httpd.apache.org](https://httpd.apache.org/) | Linux, Windows, macOS | Highly reliable and flexible, wide OS compatibility, extensive customization | Can be less efficient under high load than NGINX |
|
||||
| XAMPP | [apachefriends.org](https://www.apachefriends.org/index.html) | Linux, Windows, macOS | All-in-one package, easy to install, ideal for beginners | Not optimized for high-traffic sites, more suited for development than production |
|
||||
|
||||
## Additional Tips and Resources
|
||||
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
|
||||
@@ -97,4 +121,5 @@ Please share as much info as possible, like:
|
||||
4. Describe what you have already tried.
|
||||
|
||||
## Important note
|
||||
|
||||
Remember, these steps are a guideline and might vary slightly based on your specific setup and previously installed system.
|
||||
|
||||
Binary file not shown.
BIN
nspanel_eu.tft
BIN
nspanel_eu.tft
Binary file not shown.
BIN
nspanel_us.tft
BIN
nspanel_us.tft
Binary file not shown.
Binary file not shown.
Reference in New Issue
Block a user