DOCSEARCHbyAlgolia
Submit Docs

NSPanel Manager Documentation

website·Indexed 31 days ago

https://nspanelmanager.com

Documentation for NSPanel Manager, a custom firmware and management system for Sonoff NSPanel and NSPanel PRO. Includes guides for flashing firmware, installation via Docker, Home Assistant, and UNRAID, as well as details on MQTT and STOMP topics, web interface configuration, and supported devices.

Tokens
8.2K
Snippets
19
Records
62
Agent score
50%

What's inside NSPanel Manager

  1. Understand the NSPanel Manager software architecture

    The NSPanel Manager project consists of three primary software components:

    1. Web Interface: Built on the Django framework, this provides the user interface for configuration and manages the settings database.
    2. MQTT Manager: A background process within the container that acts as the 'glue' between the panels and home automation software. It loads configuration from the database, processes commands from panels, handles state updates from Home Assistant/OpenHAB, and pushes those updates back to the panels.
    3. NSPanel Firmware: Custom firmware for the NSPanel that manages the TFT (Nextion) display and communicates with the MQTT Manager via MQTT.

  2. Manage NSPanels from the main dashboard

    The main dashboard provides an overview of all registered NSPanels. By clicking the cog icon for a specific panel, you can perform the following actions:

    • Reboot: Restarts the NSPanel.
    • Settings: Opens the individual NSPanel configuration page.
    • Visit: Opens the panel's internal web page (used for initial WiFi/MQTT setup).
    • Firmware update: Triggers the panel to download and install firmware from the manager.
    • GUI update: Triggers the panel to download and install screen firmware from the manager.
    • Delete: Removes the panel from the manager.

    Additionally, the 'Actions' button in the top right allows these operations to be performed on all online panels simultaneously, or to Restart MQTTManager, which restarts the core communication component between the manager and Home Assistant/OpenHAB.

  3. Meet the prerequisites for NSPanel Manager

    To use NSPanel Manager, you must satisfy the following requirements:

    1. Compatible Hardware: Own a supported NSPanel device. Verify your specific model against the supported devices list.
    2. MQTT Server: A running MQTT server is required. You can use a standalone server or the embedded MQTT integrations provided by Home Assistant or OpenHab.
    3. 24/7 Hosting: A server capable of hosting the service continuously. Recommended hosting environments include:
      • Home Assistant server
      • NAS with Docker support
      • Intel NUC
      • Raspberry Pi
      • Any Linux machine with Docker installed

  4. Navigate the NSPanel interface using swipes

    The NSPanel supports specific swipe gestures for navigation:

    • Swipe Down (Main Page): Navigates to the Smart Home Control page.
    • Swipe Down (Other Pages): Returns to the previous page.
    • Swipe In from Left (Entities/Scenes Page): Navigates to the previous room. Note: This must be performed at the top of the page where no entities exist.
    • Swipe In from Right (Entities/Scenes Page): Navigates to the next room. Note: This must be performed at the top of the page where no entities exist.

  5. Fix typos or update existing documentation pages

    To fix a typo or complete an existing documentation page, use the 'Edit this page' link found at the bottom of every guide page. This allows you to edit the content directly via the GitHub UI using Markdown. After editing, use the Preview tab to verify rendering, commit the changes, and create a pull request for maintainer review.

  6. Access NSPanel logs via Serial connection

    Logs created before a WiFi connection is established are sent via Serial. To access these logs using a tool like Putty:

    1. Connect the NSPanel with the serial programmer, ensuring that IO0 is NOT connected to GND.
    2. In Putty, set the baud rate to 115200.
    3. Specify the correct serial port:
      • Windows: Use the COM port (e.g., COM4).
      • MacOS/Linux: Use the device path (e.g., /dev/ttyUSB0).
    4. Click the "Open" button to start the connection.

  7. Follow NSPanel Manager logo usage guidelines

    To maintain the identity of the NSPanel Manager project, adhere to the following branding rules:

    • Prioritize vectorized (SVG) versions for scalability and resolution independence.
    • Do not stretch, crop, or alter the colors of the logo.
    • Maintain a safe space margin equal to 25% of the logo's height.
    • Use rectangular logos as the primary choice; use square logos only when space is constrained (e.g., social media avatars).

  8. Install NSPanel Manager on UNRAID

    To install NSPanel Manager on UNRAID, you must first have the Community Apps plugin installed. Once the plugin is active, navigate to the 'APPS' link in the UNRAID user interface, search for 'NSPanelManager' within the Home Automation category, and select 'Install' from the Actions menu. During the installation process, you will be prompted to configure the application's port and data directory.

  9. Manage Room and Global Scenes

    Access the Scenes page by pressing the settings icon in the top left corner of the Main page. The destination depends on the active light mode:

    • Room Lights mode: Opens the Room Scenes page (indicated by a standard settings icon).
    • All Lights mode: Opens the Global Scenes page (indicated by a settings icon with a roof on top).

    Scene Operations:

    • Activate: Press the scene name to send the saved values to the lights.
    • Save: Hold the save button for three seconds to store the current light values for the active room or all lights.

  10. Connect Sonoff NSPanel to WiFi and configure initial settings

    After flashing the Sonoff NSPanel with custom firmware, follow these steps to connect it to your network:

    1. Power on the device. It will boot as a WiFi access point.
    2. Search for and connect to the WiFi network named NSPMPanel-XXXXXX (where XXXXXX is unique to your device). No password is required.
    3. The configuration page should open automatically. If it does not, navigate to http://192.168.4.1 in your browser.
    4. In the configuration interface, complete the WiFi section and the MQTT section with your network and broker details.
    5. Click Save. The device will reboot and connect to your local WiFi network.

  11. Create a new documentation page

    To add a new page to the documentation, fork the project and create a new .md file within the docs/docs/ directory. The file must include a frontmatter block for the title and sidebar position, followed by the page content in Markdown. You can use MDX components for rich UI elements or project-specific custom widgets.
    ---
title: <page title>
sidebar_position: <order in sidebar menu>
---
# <page title>
<your content>

  12. Manage scenes on the NSPanel

    Scenes allow you to save and restore the states of lights in a room.

    • Save a scene: Hold the save button for scenes on the NSPanel for 3 seconds to capture the current state of all lights added to the room.
    • Activate a scene: Press the name of the scene on the NSPanel to restore the saved light states.
    • Caveat: If a light is added to the room after a scene was saved, that light will not be affected by the scene until the scene is saved again.
    • Global Scenes: Scenes that apply to all rooms are managed via the "Entities" -> "Global scenes" menu.