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

Getting ready for release

Browse Source
This commit is contained in:
Edward Firmo
2024-01-09 23:54:50 +01:00
parent 7c46f5d1f0
commit 9dc93d8969
1 changed files with 0 additions and 31 deletions
Download Patch File Download Diff File Expand all files Collapse all files

31
ReleaseNotes.md
View File

@@ -1,14 +1,12 @@
# v4.2 - Multi-Alarm Control, Dual Thermostat Functionality, and More # v4.2 - Multi-Alarm Control, Dual Thermostat Functionality, and More
## Support this project ## 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 **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 ;)** So if you haven't made a donation yet, now would be a good time ;)**
[![Paypal](https://user-images.githubusercontent.com/41958506/212499642-b2fd097a-0938-4bfc-b37b-74df64592c58.png)](https://www.paypal.com/donate/?hosted_button_id=S974SWQMB8PB2) [![Paypal](https://user-images.githubusercontent.com/41958506/212499642-b2fd097a-0938-4bfc-b37b-74df64592c58.png)](https://www.paypal.com/donate/?hosted_button_id=S974SWQMB8PB2)
## General ## General
Hello everyone! In our latest update, we've made some great strides to enhance your experience. 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. We've fine-tuned the TFT upload process, making it smoother and more user-friendly for both newbies and veterans.
@@ -20,7 +18,6 @@ Oh, and don't miss the new clock feature on the sleep page – it's a small but
Dive into the details below and see how these improvements can upgrade your day-to-day. Looking forward to your feedback! 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 ### 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. 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. This upgrade is designed to significantly increase the available memory on the ESP, making more room for new features and your customizations.
@@ -37,24 +34,20 @@ For all the details on customizing the framework, our [customization docs](docs/
We're committed to making this transition as smooth as possible, so reach out if you have any concerns or need assistance. We're committed to making this transition as smooth as possible, so reach out if you have any concerns or need assistance.
## Updating ## 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. 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. 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 ### Files that need to be reloaded
1. nspanel_eu.tft, nspanel_us.tft or nspanel_us_land.tft - v4.2 1. nspanel_eu.tft, nspanel_us.tft or nspanel_us_land.tft - v4.2
2. nspanel_esphome.yaml - v4.2 2. nspanel_esphome.yaml - v4.2
3. nspanel_blueprint.yaml - v4.2 3. nspanel_blueprint.yaml - v4.2
### Instructions ### 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) - [How To - All important thing you should know - Update](docs/howto.md#update-blueprint)
## Breaking changes ## Breaking changes
1. **The `background` parameter in the `esphome.xxxxx_set_component_color` service is now deprecated.** 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.** 2. **On the home and climate pages, the button layout has changed.**
@@ -136,7 +129,6 @@ We did our best to support your legacy settings and avoid breaking your system,
Thanks for your cooperation in making these settings more reliable for everyday use. Thanks for your cooperation in making these settings more reliable for everyday use.
## Overview of noteworthy changes ## Overview of noteworthy changes
1. Standardized entity icons 1. Standardized entity icons
2. Additional custom buttons on Home page 2. Additional custom buttons on Home page
3. Outdoor temperature selectable font size 3. Outdoor temperature selectable font size
@@ -157,19 +149,16 @@ We did our best to support your legacy settings and avoid breaking your system,
## Details of noteworthy changes ## Details of noteworthy changes
### 1. Standardized entity icons ### 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. 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. 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. 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. 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 ### 2. Additional custom buttons on Home page
It's that simple, now you have 7 buttons where used to be 3. 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. 😉 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 ### 3. Outdoor temperature selectable font size
Now you can select the font size of your outdoor temperature display: Now you can select the font size of your outdoor temperature display:
![image](https://github.com/Blackymas/NSPanel_HA_Blueprint/assets/94725493/263f14d6-39f7-41d2-ae12-72f403d811fd) ![image](https://github.com/Blackymas/NSPanel_HA_Blueprint/assets/94725493/263f14d6-39f7-41d2-ae12-72f403d811fd)
@@ -177,7 +166,6 @@ 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. > 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 ### 4. Select icon size for button's pages
You can also select the size of the icons on the buttos pages: You can also select the size of the icons on the buttos pages:
![HA Blueprint - Buttons pages icon's size](docs/pics/ha_blueprint_buttons_pages_icon_size.png) ![HA Blueprint - Buttons pages icon's size](docs/pics/ha_blueprint_buttons_pages_icon_size.png)
@@ -187,7 +175,6 @@ You can also select the size of the icons on the buttos pages:
![EU Buttons pages - Large icons](docs/pics/eu_buttonpages_icon_large.png) ![EU Buttons pages - Large icons](docs/pics/eu_buttonpages_icon_large.png)
### 5. Support to CJK languages (experimental) ### 5. Support to CJK languages (experimental)
You will find 3 new TFT files on the repository for the CJK languages. 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. These files are considerably bigger, as the fonts requires more memory, but it should work fine in your panel.
@@ -197,7 +184,6 @@ Please report if you find anything.
### 6. Improved TFT transfer ### 6. Improved TFT transfer
#### TFT file selectors #### TFT file selectors
We still working on the Upload TFT engine to make it easier for new and for experienced users. 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) 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, 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,
@@ -210,7 +196,6 @@ 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. 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 #### Alternative baud rate for TFT uploads
You can select an alternative baud rate for your 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). 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).
@@ -231,44 +216,36 @@ The default value for this substitution (in case it is not set by users) will be
During a TFT transfer, the system will always fall back to the standard baud rate (115200 bps) if other tentatives fails. 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 ### 7. Multiple Alarm Control Panels
Now alarm control panel entities can be assigned to chips and custom buttons in the Home page, 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. but also to hardware buttons, any of the buttons pages or entities pages, similarly to other domains.
### 8. Support to `remote` ### 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). 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. The service `remote.toggle` will be called when the button is pressed.
### 9. Home page chips now supports covers ### 9. Home page chips now supports covers
That's it! That's it!
Chips now include cover visualization, allowing for easy monitoring of covers directly from the Home page. Chips now include cover visualization, allowing for easy monitoring of covers directly from the Home page.
### 10. Chips can be inverted ### 10. Chips can be inverted
Chips now have an 'invert' option on the blueprint settings, providing additional customization flexibility. Chips now have an 'invert' option on the blueprint settings, providing additional customization flexibility.
### 11. Add swipe control to Screensaver page ### 11. Add swipe control to Screensaver page
You can now navigate to button pages from the screensaver while your panel is in sleep mode. 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. The swipe controls will function as they do on the Home page.
### 12. Enhanced control for automation entities on buttons ### 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. 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. 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. This update allows for a more personalized and efficient control experience, tailored to your unique preferences.
#### Key features #### Key features
- **Toggle:** This action will enable or disable the automation. - **Toggle:** This action will enable or disable the automation.
It is set as the default option. It is set as the default option.
- **Trigger:** This action will execute the automation regardless of its current state, providing more flexibility. - **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**. 1. Access your configuration for automation under **Services** > **Automations & Scenes**.
Select the automation associated with your panel setup. Select the automation associated with your panel setup.
1. Scroll to the **ADVANCED SETTINGS** section at the end. 1. Scroll to the **ADVANCED SETTINGS** section at the end.
@@ -279,17 +256,14 @@ This will then be effective across all relevant entities.
This update is specially designed to cater to diverse user needs, ensuring a more intuitive and responsive smart home experience. 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) ### 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. 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. - **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. - **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. - **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 #### Implementation Details
- The dual thermostat controller functionality allows the NSPanel to utilize both of its relays for separate heating and cooling control. - 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. Users can configure their heating and cooling settings independently, providing a tailored climate control experience.
@@ -297,13 +271,11 @@ This new add-on enables the NSPanel to manage both heating and cooling systems s
- Additional Documentation: For detailed instructions and configurations, refer to the updated [add-on climate documentation](docs/addon_climate.md). - Additional Documentation: For detailed instructions and configurations, refer to the updated [add-on climate documentation](docs/addon_climate.md).
#### Note to Users #### Note to Users
This feature enhances the capabilities of the NSPanel without compromising its existing functionalities. 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 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. now explore dual-mode options for a more comprehensive climate control solution.
### 14. Enhanced Climate Page for Dual Thermostat Control ### 14. Enhanced Climate Page for Dual Thermostat Control
Leveraging the capabilities introduced with the Dual Thermostat Controller add-on, 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. 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. This enhancement allows users to effectively manage thermostats that require both heating and cooling target temperatures, directly from the NSPanel's interface.
@@ -312,14 +284,12 @@ this refined climate page also seamlessly extends its functionality to existing
offering a more versatile and comprehensive climate control experience. offering a more versatile and comprehensive climate control experience.
### 15. Enhanced timeout flexibility for Sleep, Page fallback, and Dimming settings ### 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. 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. 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, 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. while still maintaining the option for shorter durations.
### 16. Display time on the `screensaver` page ### 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. 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, 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. reflecting our commitment to creating practical, user-friendly solutions.
@@ -328,7 +298,6 @@ You can enable this feature on the bueprint settings, at the **CUSTOM CONFIGURAT
You also have to set **Display Brightness Sleep** at the device's page (**Settings** > **Devices & Services** > **ESPHome**). You also have to set **Display Brightness Sleep** at the device's page (**Settings** > **Devices & Services** > **ESPHome**).
## What's Next? ## 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) 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