https://github.com/blackymas/nspanel_ha_blueprint

This allows you to configure your complete NSPanel via Blueprint with UI and without changing anything in the code
https://github.com/blackymas/nspanel_ha_blueprint

blueprint esphome home-assistant homeassistant nextion nextion-display nspanel nspanel-pro nspanelpro sonoff

Last synced: 3 months ago
JSON representation

This allows you to configure your complete NSPanel via Blueprint with UI and without changing anything in the code

• Host: GitHub
• URL: https://github.com/blackymas/nspanel_ha_blueprint
• Owner: Blackymas
• Created: 2022-09-27T21:37:59.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2025-05-04T21:16:24.000Z (about 1 year ago)
• Last Synced: 2025-05-14T08:07:21.237Z (about 1 year ago)
• Topics: blueprint, esphome, home-assistant, homeassistant, nextion, nextion-display, nspanel, nspanel-pro, nspanelpro, sonoff
• Language: C++
• Homepage:
• Size: 1.41 GB
• Stars: 1,655
• Watchers: 56
• Forks: 290
• Open Issues: 195
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml

Awesome Lists containing this project

README

          
# NSPanel Custom with HA Blueprint

[![GitHub Release][releases-shield]][releases]

[![GitHub Activity][commits-shield]][commits]

[![Last Commit][last-commit-shield]][commits]

[![Platform][platform-shield]](https://github.com/esphome)

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.*

[![Open your Home Assistant instance and show the blueprint import dialog with a specific blueprint pre-filled.](https://my.home-assistant.io/badges/blueprint_import.svg)](https://my.home-assistant.io/redirect/blueprint_import/?blueprint_url=https%3A%2F%2Fgithub.com%2FBlackymas%2FNSPanel_HA_Blueprint%2Fblob%2Fmain%2Fnspanel_blueprint.yaml)

## Framework Support Notice

> **ℹ️ As of v4.3.22, this project uses ESP-IDF framework only.**

> 

> **New users:** No action needed - the project defaults to ESP-IDF automatically.  

> **Existing users:** If you have Arduino framework configured, see our [migration guide](docs/customization.md#frameworks).

## 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)

## 🌟 Project Highlights

- **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!

## 📚 Documentation & Resources

- **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](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

- 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

- Buttons show current brightness and cover position in the button itself

- Buttons label can be assigned via blueprint

- Weather + 5 days weather forecast

- Thermostat + Touch + [Relay control for floor heating](docs/addon_climate.md)

- Light control (brightness, color and temperature) - via long Press

- Cover control (open, close and position) - via long press

- Settings page (display brightness, display dim brightness, sleep mode, reboot NSPanel)

- Swipe between pages

- Top menu with 10 icons for specific states

- Heating control (hot water)

- Modern design - design easy to change via Adobe Express (free + design template)

- 2 physical switches with optional fallback mode

- and much more ;)

## 📖 Pages Overview

### Home

![Home EU](docs/pics/eu_home.png)

![Home US](docs/pics/us_home.png)

- Current weather with button to Weather Forcast page

- Hardware buttons can be freely assigned

- Hardware button label (optional)

- Blue line indicates the entity's states (`on` or `off`)

- Outside temperature

- Status icons at the top

- Room temperature with button to thermostat page

- Room humidity

- Up to 3 user's selectable entities

### Buttons Pages

![3 Buttonpage](https://user-images.githubusercontent.com/41958506/203654022-c6d81263-ce56-4a84-917a-9d4911f19f55.png)

![NEW Domains](https://user-images.githubusercontent.com/41958506/206879659-3aea30c1-b126-4d52-a869-abf6adfc8fa1.png)

- Up to 8 buttons per page, across 4 different pages, totaling 32 buttons

- Button design is automatically generated based on the selected entity

- Buttons display current brightness and cover position directly on the button

- 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 up and down for quick access to specific pages

### Entities Pages

![Entities EU](docs/pics/eu_entities.png)

![Entities US](docs/pics/us_entities.png)

- 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

![4 lightsetting 1](https://user-images.githubusercontent.com/41958506/203654055-943d1910-7673-4d9f-ad81-7ef00d155e5a.png)

![5 Lightsetting 2](https://user-images.githubusercontent.com/41958506/203654076-93e110df-f314-4cf1-8500-ed667f2202fd.png)

![6 Lightsetting 3](https://user-images.githubusercontent.com/41958506/203654179-f7303b02-c886-4890-b976-cb498940a627.png)

- Light current state

- Brightness slider

- RGB color wheel

- Color temperature slider

- Jump back to the right button page

### Cover Settings

![8 Cover](https://user-images.githubusercontent.com/41958506/203654290-c6ec2f2f-7924-492c-914c-0d96dc3907e0.png)

- Open and close cover

- Cover position via slider

- Cover battery value (when available)

- jump back to the right button page

### Thermostat / Climate

- 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

![9 Weather](https://user-images.githubusercontent.com/41958506/203654307-24000d00-b7e1-47eb-bd64-9e97b508db52.png)

- 5 days weather forecast via swipe (supports most used weather integrations)

- Min and max outside temperatures

- Date

- Other weather parameters (when provided by your integration):

  - Rain probability

  - Sunshine hours

  - UV index

  - Thunderstorm probability

  - Wind speed

### Display Settings

This page is accessible with a long press in the time area on the Home page.

![Settings EU](docs/pics/eu_settings.png)

![Settings US](docs/pics/us_settings.png)

- Restart NSPanel

- Display brightness slider

- Display dim brightness slider

### Boot

![Boot EU](docs/pics/eu_boot.png)

![Boot US](docs/pics/us_boot.png)

## 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:

![Device Setting - Controls](docs/pics/ha_device_controls.png)

![Device Setting - Sensors](docs/pics/ha_device_sensors.png)

![Device Setting - Configuration](docs/pics/ha_device_configuration.png)

![Device Setting - Diagnostic](docs/pics/ha_device_diagnostic.png)

## 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:

![Blueprint 01](docs/pics/ha_blueprint_01.png)

![Blueprint 02](docs/pics/ha_blueprint_02.png)

![Blueprint 03](docs/pics/ha_blueprint_03.png)

![Blueprint 04](docs/pics/ha_blueprint_04.png)

![Blueprint 05](docs/pics/ha_blueprint_05.png)

## 🚀 Contributing

- **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.

[![Paypal](https://user-images.githubusercontent.com/41958506/212499642-b2fd097a-0938-4bfc-b37b-74df64592c58.png)](https://www.paypal.com/donate/?hosted_button_id=S974SWQMB8PB2)

[commits-shield]: https://img.shields.io/github/commit-activity/y/Blackymas/NSPanel_HA_Blueprint

[commits]: https://github.com/Blackymas/NSPanel_HA_Blueprint/commits/main

[releases-shield]: https://img.shields.io/github/v/release/Blackymas/NSPanel_HA_Blueprint

[releases]: https://github.com/Blackymas/NSPanel_HA_Blueprint/releases

[last-commit-shield]: https://img.shields.io/github/last-commit/Blackymas/NSPanel_HA_Blueprint

[platform-shield]: https://img.shields.io/badge/platform-Home%20Assistant%20&%20ESPHome-blue