v4.1.1 patch
v4.1.1 patch
This commit is contained in:
Edward Firmo
GitHub
161
README.md
161
README.md
@@ -1,81 +1,42 @@
|
||||
# NSPanel Custom with HA Blueprint
|
||||
|
||||
*You use our NSPanel version and are satisfied with it? Then we would be very happy about a donation to support our project.*
|
||||
|
||||
[](https://www.paypal.com/donate/?hosted_button_id=S974SWQMB8PB2)
|
||||
*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)
|
||||
|
||||
This project allows you to configure your complete NSPanel via a Blueprint with UI.
|
||||
### *That means you don't have to customize any code or change any lines in the code.*
|
||||
[](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)
|
||||
|
||||
So you have a nice graphical interface where you can build your NSPanel.
|
||||
And the best thing is, the installation takes only a few minutes.
|
||||
# NSPanel Custom with HA Blueprint
|
||||
|
||||
The goal was to create a version that allows everyone to use the NSpanel fully local without having to deal with programming or reading hours of documentation - *AND YES WE DID IT!!!!* ;)
|
||||
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!
|
||||
|
||||
📕 Full documentation and installation is available here: [NSPanel Configuration, Setup and HowTo](https://github.com/Blackymas/NSPanel_HA_Blueprint/wiki).
|
||||
## Table of Contents
|
||||
1. [Project Highlights](#-project-highlights)
|
||||
2. [Documentation & Resources](#-documentation--resources)
|
||||
3. [Features](#-features)
|
||||
4. [Pages Overview](#-pages-overview)
|
||||
5. [Contributing](#-contributing)
|
||||
6. [Community & Support](#-community--support)
|
||||
7. [Acknowledgements](#-acknowledgements)
|
||||
8. [Donations](#-donations)
|
||||
|
||||
📌 Step by Step - [Setup Video](https://github.com/Blackymas/NSPanel_HA_Blueprint/wiki)
|
||||
## 🌟 Project Highlights
|
||||
|
||||
🚀 How to create "Issues" when I have a problem: [WIKI HowTo](https://github.com/Blackymas/NSPanel_HA_Blueprint/wiki)
|
||||
- **No Coding Required:** Customize your NSPanel without touching a single line of code. It's all about intuitive, user-friendly experiences!
|
||||
- **Quick Setup:** Get your NSPanel up and running in minutes with our easy-to-follow graphical interface.
|
||||
- **Local Control:** Embrace full local control of your NSPanel, steering clear of cloud dependencies.
|
||||
- **Community-Driven:** A project for the users, by the users. Your contributions shape the future of this project!
|
||||
|
||||
⭐ All Feature Requests can be found here: [All Feature Request](https://github.com/Blackymas/NSPanel_HA_Blueprint/labels/new%20feature%20request)
|
||||
## 📚 Documentation & Resources
|
||||
|
||||
🎉 Roadmap can be found here: [Roadmap](https://github.com/Blackymas/NSPanel_HA_Blueprint/labels/roadmap)
|
||||
- **Getting Started:** Dive into our comprehensive [Documentation and Setup Guide](https://github.com/Blackymas/NSPanel_HA_Blueprint/wiki) for detailed instructions.
|
||||
- **Video Tutorial:** Prefer visual learning? Check out our [Step-by-Step Setup Video](https://github.com/Blackymas/NSPanel_HA_Blueprint/wiki).
|
||||
- **Troubleshooting:** Encounter an issue? Here's how to report it: [WIKI HowTo](https://github.com/Blackymas/NSPanel_HA_Blueprint/wiki).
|
||||
- **Feature Requests:** Got ideas? Share them [here](https://github.com/Blackymas/NSPanel_HA_Blueprint/labels/new%20feature%20request).
|
||||
- **Project Roadmap:** Curious about what's next? Explore our [Roadmap](https://github.com/Blackymas/NSPanel_HA_Blueprint/labels/roadmap).
|
||||
|
||||
💥 Please move pull request to DEV branch and not to main branch - thanks!
|
||||
## 🚀 Features
|
||||
|
||||
🙋 WE ARE LOOKING FOR YOU! _**We are always looking for people who would like to support this project. We are looking for help with "programming new features, writing documentation or translating documentation to EN. If you are interested then please contact us :)**_
|
||||
|
||||
|
||||
## NSPanel:
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
(Home and Button page)
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
(Light settings - Brightness and TEMP Color)
|
||||
|
||||
|
||||
|
||||
|
||||
(Light color wheel)
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
(Cover settings and Weather forecast)
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
(NSPanel settings and Boot screen)
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
(HA device settings - Temperature correction)
|
||||
|
||||
|
||||
## Blueprint:
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## Features:
|
||||
- Easy to use and simple configuration via Blueprint - no change in the code is necessary
|
||||
- 32 buttons on 4 button pages with long press function for settings (more buttons are also possible)
|
||||
- Button design is automatically generated based on the selected entity
|
||||
@@ -93,10 +54,13 @@ The goal was to create a version that allows everyone to use the NSpanel fully l
|
||||
- 2 physical switches with optional fallback mode
|
||||
- and much more ;)
|
||||
|
||||
|
||||
## Pages
|
||||
|
||||
## 📖 Pages Overview
|
||||
|
||||
|
||||
### Home
|
||||
|
||||
|
||||
- Current weather with button to Weather Forcast page
|
||||
- Hardware buttons can be freely assigned
|
||||
- Hardware button label (optional)
|
||||
@@ -109,6 +73,9 @@ The goal was to create a version that allows everyone to use the NSpanel fully l
|
||||
|
||||
|
||||
### Button Page
|
||||
|
||||
|
||||
|
||||
- Up to 32 buttons
|
||||
- 4 Button pages
|
||||
- Button design is automatically generated based on the selected entity
|
||||
@@ -121,6 +88,10 @@ The goal was to create a version that allows everyone to use the NSpanel fully l
|
||||
|
||||
|
||||
### Light Settings
|
||||
|
||||
|
||||
|
||||
|
||||
- Light current state
|
||||
- Brightness slider
|
||||
- RGB color wheel
|
||||
@@ -129,6 +100,8 @@ The goal was to create a version that allows everyone to use the NSpanel fully l
|
||||
|
||||
|
||||
### Cover Settings
|
||||
|
||||
|
||||
- Open and close cover
|
||||
- Cover position via slider
|
||||
- Cover battery value (when available)
|
||||
@@ -157,6 +130,8 @@ The goal was to create a version that allows everyone to use the NSpanel fully l
|
||||
|
||||
|
||||
### Weather Forecast
|
||||
|
||||
|
||||
- 5 days weather forecast via swipe (supports most used weather integrations)
|
||||
- Min and max outside temperatures
|
||||
- Date
|
||||
@@ -169,22 +144,56 @@ The goal was to create a version that allows everyone to use the NSpanel fully l
|
||||
|
||||
|
||||
### Display Settings
|
||||
|
||||
|
||||
- Restart NSPanel
|
||||
- Display brightness slider
|
||||
- Display dim brightness slider
|
||||
|
||||
### Boot
|
||||
|
||||
|
||||
|
||||
## Thanks to:
|
||||
SmartHome Yourself: https://www.youtube.com/c/SmarthomeyourselfDe_DIY
|
||||
## Home Assistant interface
|
||||
|
||||
Masto: https://github.com/masto/NSPanel-Demo-Files
|
||||
## Device's page
|
||||
|
||||
|
||||
|
||||
Marcfager: https://github.com/marcfager/nspanel-mf
|
||||
## Automation (Blueprint)
|
||||
|
||||
|
||||
|
||||
lovejoy77: https://github.com/lovejoy777/NSpanel
|
||||
|
||||
Hellis81: https://github.com/Hellis81/NS-panel
|
||||
## 🚀 Contributing
|
||||
|
||||
sairon: https://github.com/sairon/esphome-nspanel-lovelace-ui
|
||||
- **Pull Requests:** Please direct all pull requests to the `DEV` branch, not the `main` branch.
|
||||
- **Join Our Team:** We're on the lookout for enthusiasts in programming, documentation, and translation. Interested? Please let us know.
|
||||
|
||||
## 🌍 Community & Support
|
||||
|
||||
Join our vibrant community! Whether you're seeking support, wanting to contribute, or just looking to share your NSPanel journey, we're here for you.
|
||||
|
||||
- **[Issues & Feature requests](https://github.com/Blackymas/NSPanel_HA_Blueprint/issues)**
|
||||
- **[Discussion Forum](https://github.com/Blackymas/NSPanel_HA_Blueprint/discussions)**
|
||||
- **[Home Assistant Community](https://community.home-assistant.io/t/sonoff-nspanel-blueprint-configure-your-own-custom-nspanel-easy-via-a-blueprint/500577)**
|
||||
|
||||
## 🎉 Acknowledgements
|
||||
|
||||
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
|
||||
|
||||
|
||||
## 💖 Donations
|
||||
|
||||
Are you happy with our version for NSPanel? Please consider supporting us with a donation.
|
||||
|
||||
[](https://www.paypal.com/donate/?hosted_button_id=S974SWQMB8PB2)
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
# v4.1 - Easier TFT transfer
|
||||
# v4.1.1 - Easier TFT transfer
|
||||
|
||||
## Support this project
|
||||
|
||||
@@ -40,8 +40,8 @@ Since in this update lots of input to the blueprint changed, we highly recommend
|
||||
2. The following components are now deprecated:
|
||||
- Buttons:
|
||||
- Exit reparse (`button.xxxxx_exit_reparse`) - It shouldn't be necessary with the new TFT upload engine
|
||||
- Services:
|
||||
- Play rtttl (`esphome.xxxxx_play_rtttl`)
|
||||
- ~~Services:~~
|
||||
- ~~Play rtttl (`esphome.xxxxx_play_rtttl`)~~
|
||||
- Sensors:
|
||||
- API uptime
|
||||
- Device uptime
|
||||
@@ -85,6 +85,11 @@ packages:
|
||||
5. Font size for chips
|
||||
6. Short click to open Climate and Media Player
|
||||
|
||||
- 4.1.1 patch:
|
||||
- Service `esphome.xxxxx_play_rtttl` is back to core package
|
||||
- Stop the fallback to Home page when Notification or Confirm pages are shown
|
||||
|
||||
|
||||
|
||||
## Details of noteworthy changes
|
||||
|
||||
@@ -150,6 +155,7 @@ See here: https://github.com/Blackymas/NSPanel_HA_Blueprint/labels/roadmap
|
||||
@Floppe
|
||||
|
||||
## Previous releases
|
||||
- [v4.1 - Easier TFT transfer](https://github.com/Blackymas/NSPanel_HA_Blueprint/releases/tag/v4.1)
|
||||
- [v4.0.2 - Bug fixes](https://github.com/Blackymas/NSPanel_HA_Blueprint/releases/tag/v4.0.2)
|
||||
- [v4.0.1 - Bug fixes](https://github.com/Blackymas/NSPanel_HA_Blueprint/releases/tag/v4.0.1)
|
||||
- [v4.0 - Alarm and Media player pages, Climate add-ons and a more robust panel](https://github.com/Blackymas/NSPanel_HA_Blueprint/releases/tag/v4.0)
|
||||
|
||||
@@ -7,17 +7,6 @@
|
||||
##### ATTENTION: This will add advanced elements to the core system and requires the core part. #####
|
||||
#####################################################################################################
|
||||
|
||||
api:
|
||||
services:
|
||||
##### Service to play a rtttl tones #####
|
||||
# Example tones : https://codebender.cc/sketch:109888#RTTTL%20Songs.ino
|
||||
- service: play_rtttl
|
||||
variables:
|
||||
song_str: string
|
||||
then:
|
||||
- rtttl.play:
|
||||
rtttl: !lambda 'return song_str;'
|
||||
|
||||
button:
|
||||
##### EXIT REPARSE TFT DISPLAY #####
|
||||
- name: ${device_name} Exit reparse
|
||||
|
||||
@@ -7,7 +7,7 @@
|
||||
|
||||
substitutions:
|
||||
##### DON'T CHANGE THIS #####
|
||||
version: "4.1"
|
||||
version: "4.1.1"
|
||||
#############################
|
||||
|
||||
##### ESPHOME CONFIGURATION #####
|
||||
@@ -172,6 +172,15 @@ api:
|
||||
then:
|
||||
- lambda: set_component_color->execute(component, foreground, background);
|
||||
|
||||
##### Service to play a rtttl tones #####
|
||||
# Example tones : https://codebender.cc/sketch:109888#RTTTL%20Songs.ino
|
||||
- service: play_rtttl
|
||||
variables:
|
||||
song_str: string
|
||||
then:
|
||||
- rtttl.play:
|
||||
rtttl: !lambda 'return song_str;'
|
||||
|
||||
#### Service to populate the alarm settings page #####
|
||||
- service: alarm_settings
|
||||
variables:
|
||||
@@ -1539,12 +1548,22 @@ script:
|
||||
- if:
|
||||
condition:
|
||||
- lambda: |-
|
||||
return (page != "screensaver" and page != "boot" and page != "home" and timeout >= 1);
|
||||
return (timeout >= 1 and
|
||||
page != "boot" and
|
||||
page != "confirm" and
|
||||
page != "home" and
|
||||
page != "notification" and
|
||||
page != "screensaver");
|
||||
then:
|
||||
- delay: !lambda return (timeout *1000);
|
||||
- lambda: |-
|
||||
ESP_LOGV("script.timer_page", "Timed out on page: %s", current_page->state.c_str());
|
||||
if (current_page->state != "screensaver" and current_page->state != "boot" and current_page->state != "home" and timeout >= 1)
|
||||
if (timeout >= 1 and
|
||||
current_page->state != "boot" and
|
||||
current_page->state != "confirm" and
|
||||
current_page->state != "home" and
|
||||
current_page->state != "notification" and
|
||||
current_page->state != "screensaver")
|
||||
{
|
||||
ESP_LOGD("script.timer_page", "Fallback to page Home");
|
||||
disp1->goto_page("home");
|
||||
|
||||
Reference in New Issue
Block a user