Quick Start Guide¶
Get your NSPanel connected to Home Assistant and showing your first panel. This guide covers the bare minimum — for full details, see the Installation Guide.
What you need¶
- A Home Assistant instance with HACS installed
- The ESPHome add-on installed and running
- A USB-UART adapter (for first-time flashing)
- A Sonoff NSPanel device
1. Flash the device¶
Open the NSPanel and connect the USB-UART adapter (connect GND to IO0 for flashing mode). Flash the prebuilt nspanel_haui.bin from the latest release, then join the access point named after the device (e.g. nspanel-haui-a1b2c3) and enter your Wi-Fi. To build your own firmware instead, create a device in the ESPHome dashboard from esphome/install.yaml.
See Installation Guide for full flashing instructions.
2. Install the integration¶
Install NSPanel HAUI via HACS (add https://github.com/happydasch/nspanel_haui as a custom repository of type Integration, then download NSPanel HAUI) or copy custom_components/nspanel_haui/ into your Home Assistant custom_components/ directory. Restart Home Assistant.
3. Add the device¶
Go to Settings → Devices & Services → Add Integration → NSPanel HAUI. The integration is a single hub and picks up your ESPHome-flashed NSPanels automatically. If none appear, make sure the ESPHome integration has the device (see the FAQ).
4. Open the panel editor¶
Open NSPanel HAUI in the Home Assistant sidebar (admin only) and select your device. The editor shows your panel list. Click Add Panel to add your first panel.
5. Add your first panel¶
Choose a panel type (e.g., Clock for a screensaver or Grid for entity tiles). Fill in the required fields and click Save. The display updates automatically.
That's it!¶
Your NSPanel is now running. Next steps:
- Browse all panel types to see what's available
- Read example configurations for setup ideas
- Check the FAQ if something isn't working