h3n3/NSPanel_HA_Blueprint
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
Files
9d9ab4c08d304a05f8cb21e8dc8c6fe0e7c4d07c
NSPanel_HA_Blueprint/ReleaseNotes.md
Edward Firmo 9d9ab4c08d Update release notes
2024-02-26 22:57:25 +01:00

12 KiB
Raw Blame History

v4.3 - Embracing the Future with ESP-IDF Framework

General

This milestone release is not just about adopting a new technical foundation; it's about enhancing the capabilities and experiences of our users through significant performance improvements, more comprehensive API documentation, and customizable user interfaces. As we move forward with the ESP-IDF framework, we're excited to offer a platform that's not only more robust but also more adaptable to the needs of our diverse user base.

Our dedication to refining the user experience and expanding customization options continues, with this release featuring:

  • Comprehensive API Documentation: Facilitating easier customization and integration, we introduce detailed documentation of our services. This enhancement aims to empower developers and users alike to tailor their NSPanel experience to their unique needs.

  • Enhanced Personalization Features: With customizable font sizes for the screensaver time display and the visibility of hardware button bars on all pages, personalizing your NSPanel is now more intuitive than ever. These features not only improve accessibility but also allow for a deeper level of interaction with your device.

  • Performance Improvements and New Functionalities: At the core of this release is our commitment to performance and functionality. The transition to ESP-IDF opens up new possibilities for future enhancements, ensuring that NSPanel remains at the cutting edge of smart control solutions.

As we embrace the ESP-IDF framework, we're excited to explore the new horizons it brings to the NSPanel firmware. Dive into v4.3 and discover the advancements that await.

ESP-IDF Framework Transition

With this release, we've officially transitioned to the ESP-IDF framework. This move is part of our ongoing efforts to enhance the memory capacity and expand the features available on the ESP, facilitating broader customization and new functionalities.

For users updating to this version:

  • Flashing Required: To adopt the ESP-IDF framework, flashing your device using a serial cable is necessary. This step mirrors the initial custom firmware setup process.
  • Arduino Framework Still Available: For those who prefer the arduino framework or require Over-The-Air (OTA) updates, it remains an option. Detailed guidance on how to choose your framework is provided in our customization documentation.

This transition is a significant milestone for us, promising a robust platform for our community. We're here to help with any questions or assistance needed during this change. For more details and support, visit our community discussion.

Updating

Please review your settings post-update to ensure compatibility. Refer to the update procedures here.

Breaking Changes and Guidance

With this release, we're implementing several important changes. While we strive to improve the panel, we understand that changes can affect your setups. Here's a detailed overview and guidance for a smooth transition:

  1. Transition to ESP-IDF Framework: This release marks the official switch to the ESP-IDF framework, enhancing performance and allowing for more complex features.

    • What to Do: You'll need to flash your device with the new firmware using a serial connection. Detailed instructions are available in our installation guide.
    • Support for Arduino Framework: If you're not ready to make the switch or prefer the Arduino framework, it's still supported for OTA updates. See our framework customization documentation for details on how to select your preferred framework.

  2. Several Services Changed: In our pursuit to enhance integration capabilities and future-proof our services, we've undertaken a comprehensive restructuring of our API. This change is aimed at improving functionality and compatibility but may require adjustments to your current automations.

    • What to Do: We strongly encourage you to review our updated API documentation. This resource has been meticulously updated to assist you in updating your automation scripts accordingly. Pay special attention to the examples section, which offers valuable insights and practical guidance for adapting your existing setups seamlessly.

  3. 15s Hardware Button Press No Longer Restarts the Device: This feature was removed to repurpose the hardware button for more versatile uses.

    • What to Do: If you relied on this feature, see our customization guide for alternatives. Additionally, the reset pin remains an option for manual resets.

  4. Relay Fallback Switches Removed: These switches were deprecated and have now been removed to streamline the firmware and reduce memory usage.

    • What to Do: For users who utilized customizations to expose these switches, refer to our updated customization guide. Alternatively, use the esphome.xxxxx_init_hardware service for a similar functionality without the memory overhead.

We appreciate your understanding and patience during this transition. Our goal is to ensure NSPanel continues to evolve in a way that enhances your experience and meets future needs. Our community and support channels are open for any questions or assistance you may require.

Overview of noteworthy changes

Details of noteworthy changes

Transition to ESP-IDF as Default Framework

We've transitioned to ESP-IDF, enhancing our platform's performance and capabilities. This change promises new possibilities for your projects. Those continuing with the Arduino framework can find instructions for setting framework preferences.

For more information, visit our discussion.

New API documentation

Now all the services available are listed in a comprehensive documentation, making easier for people who want to customize their systems, integrate to other automations and to encourage new collaborators to our repository.

For more details, please visit our API documentation.

Selectable font size for screensaver time display

Now you can chose the font size for your clock display in the screen saver. There are 3 sizes available:

Image

72px

image image image

112px

image image

192px

image

Important

For this time to be displayed you must select a brightness higher than 0 on the device's page (under Settings > Devices & Services > ESPHome).

[!ATTENTION] Some fonts may not support all the languages.

[!ATTENTION] Bigger fonts may not fit well on your display and the selected time format. Please select a differnt font in that case.

Hardware buttons bars visible on all pages

Bars indicating statuses of entities controlled by hardware buttons are now visible on all pages, including screensaver. Color customization for these bars is also available. Image

Support

For support or more information about this update, visit our GitHub repository or our online documentation.

What's Next?

Discover our upcoming projects in our Milestones.

Special Thanks

Details to be added.

Previous releases

Reference in New Issue View Git Blame Copy Permalink