Skip to content

79 update docs to reflect new stable v2 release #80

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tpanajott merged 3 commits into from
Nov 18, 2025
Merged

79 update docs to reflect new stable v2 release #80

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a80024d
Cleanup of "beta"-tags in web interface and removed old V1 stable spe…
tpanajott Nov 9, 2025
291dd7e
Renamed 1.0 to "stable" in the online flashing tool
tpanajott Nov 9, 2025
df97576
Update flash-nspanel.md
cablesandcoffee Nov 12, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 0 additions & 7 deletions docs/advanced/architecture.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,13 +70,6 @@ Home Assistant and OpenHAB can leverage the MQTT integration through "Home Assis
OpenHAB can also use) to auto-discover NSPanels and automatically register entities for panel temperature reading, panel
relays, screen state and so on.

### NSPanel Manager container to/from NSPanels <Label value="stable"/>

The configuration of lights, scenes and so on does not reside on each panel. The panel only has locally the bare minimum
configuration for setup. When the panel starts and has connected to WiFi it will do a HTTP GET request to the NSPanel
Manager container in order to receive all configuration of entities, screen brightness and really, all settings
available in the NSPanel Manager web interface.

### NSPanel Manager container to/from NSPanels <Label value="beta"/>

The configuration of lights, scenes and so on does not reside on each panel. The panel only has locally the bare minimum
Expand Down
31 changes: 0 additions & 31 deletions docs/advanced/mqtt-topics.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,37 +6,6 @@ sidebar_position: 10
import Centered from '@site/src/components/Centered';
import Label from '@site/src/components/Label';

# MQTT Topics <Label value="stable"/>

Below table is a description of all MQTT topics that might be of use by a user. Replace `<panel_name>` with the friendly
name of your NSPanel:

| Topic | Payload | Description |
| --------------------------------------------- | ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| nspanel/\<panel_name\>/screen_cmd | 1 or 0 | Send a 1 or 0 to turn on/off the display. |
| nspanel/\<panel_name\>/screen_state | 1 or 0 | Current state of the screen. |
| nspanel/\<panel_name\>/brightness | 1 to 100 | Control the brightness of the screen. |
| nspanel/\<panel_name\>/brightness_screensaver | 0 to 100 | Control the brightness of the screensaver. |
| nspanel/\<panel_name\>/r1_cmd | 1 or 0 | Send a 1 or 0 to turn on/off relay 1. |
| nspanel/\<panel_name\>/r1_state | 1 or 0 | The current state of relay 1. |
| nspanel/\<panel_name\>/r2_cmd | 1 or 0 | Send a 1 or 0 to turn on/off relay 2. |
| nspanel/\<panel_name\>/r2_state | 1 or 0 | The current state of relay 2. |
| nspanel/\<panel_name\>/temperature_state | Current temperature | The current temperature reading. |
| nspanel/\<panel_name\>/screensaver_mode | screensaver mode | Select what screensaver to display <br/> Choose from the following: <br/>- with_background<br/>-without_background<br/>-datetime_with_background<br/>-datetime_without_background<br/>or no_screensaver |
| nspanel/\<panel_name\>/log | Log message | The panel will send live logs on this topic. |

There are more topics that are used internally, these are:

| Topic | Payload | Description |
| ----------------------------------------------------- | -------------------------- | ------------------------------------------------------------------------------------------------------- |
| nspanel/entities/\<type\>/\<id\>/state\_\<attribute\> | The value of the attribute | An update of entity state value sent out by MQTTManager. Example:nspanel/entities/light/42/state_kelvin |
| nspanel/status/time | Time as a string | Current time sent by MQTTManager. |
| nspanel/status/weather | JSON | A JSON representation of the current weather and weather forecast. |
| nspanel/\<panel_name\>/status_report | JSON | JSON payload with current state of the panel. |
| nspanel/\<panel_name\>/status | JSON | JSON payload with current online/offline state of the panel. |
| nspanel/\<panel_name\>/command | JSON | JSON payload with a command for the panel to execute. |
| nspanel/mqttmanager/command | JSON | JSON payload from panel with a command for MQTTManager to perform. |

# MQTT Topics <Label value="beta"/>

Below table is a description of all MQTT topics that might be of use by a user. Replace `<mac>` with the MAC-address of your NSPanel:
Expand Down
12 changes: 6 additions & 6 deletions docs/advanced/stomp-topics.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,15 @@ sidebar_position: 15
import Centered from '@site/src/components/Centered';
import Label from '@site/src/components/Label';

# STOMP Topics <Label value="beta"/>
# STOMP Topics

The web interface makes use of the STOMP protocol to communicate with the MQTTManager in the background. STOMP is being used over **websocket** and can be connected to via http://\<manager_address\>:\<manager_port\>/websocket/stomp.
The web interface makes use of the STOMP protocol to communicate with the MQTTManager in the background. STOMP is being used over **websocket** and can be connected to via http://\<manager_address\>:\<manager_port\>/websocket/stomp.

When a stomp connection has been established the following topics can be used:

| Topic | Payload | Description |
| ----------------------------------- |-------------------------------------------------------------------------| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Topic | Payload | Description |
| ----------------------------------- | ------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| nspanel/\<mac_address\>/command | `reboot`, `firmware_update` or `gui_update` | Reboot, update firmware or update the GUI of the NSPanel. |
| nspanel/\<mac_address\>/status | JSON-encoded status object. | The MQTTManager will send out a JSON-encoded status object when it changes for the specified NSPanel. NSPanel. |
| nspanel/\<mac_address\>/log | Stream of JSON-encoded log messages from the NSPanel. | When a log message is received from the NSPanel it will be decoded and sent out to this topic as a JSON-encoded object. |
| nspanel/\<mac_address\>/status | JSON-encoded status object. | The MQTTManager will send out a JSON-encoded status object when it changes for the specified NSPanel. NSPanel. |
| nspanel/\<mac_address\>/log | Stream of JSON-encoded log messages from the NSPanel. | When a log message is received from the NSPanel it will be decoded and sent out to this topic as a JSON-encoded object. |
| nspanel/\<mac_address\>/log_backlog | Stream of JSON-encoded log messages from the NSPanel log buffer backlog. | The MQTTManager will buffer a given amount of logs in memory. When connecting to this topic the MQTTManager will send out all buffered logs as a JSON-encoded object. This topic is only ment to be subscribed to, get the log backlog, then unsubscribe and get new logs from the 'nspanel/\<mac_address\>/log' topic. |
89 changes: 45 additions & 44 deletions docs/contribute/documentation/improve-documentation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Here’s a quick overview to get you started.

Each pages of the Guide including this one provides a link at its whole bottom:

[Edit this page](hhttps://github.com/NSPManager/NSPanelManager/edit/beta/docs/docs/contribute/documentation/improve-documentation.md)
[Edit this page](https://github.com/NSPManager/NSPanelManager/edit/beta/docs/docs/contribute/documentation/improve-documentation.md)

1. Simply click over this link, it will allow you to edit via GitHub UI directly, the content of the page.
2. Update the content using Markdown in the editor.
Expand All @@ -34,68 +34,69 @@ Each pages of the Guide including this one provides a link at its whole bottom:
title: <page title>
sidebar_position: <order in sidebar menu>
---

# <page title>

<your content>
```

4. You can, make use of MDX components (rich UI components) by importing them within the pages.
Have a look at this to learn more: https://docusaurus.io/docs/markdown-features.

5. Optionally, you might also want to use specific widgets created for this project.
5. Optionally, you might also want to use specific widgets created for this project.
They are documented here: [custom widgets](./custom-widgets.md)

## Customize sidebar menu

Edit `docs/src/sidebars.ts`

```ts
const sidebars: SidebarsConfig = {
mainSidebar: [
mainSidebar: [
{
type: "category",
label: "Getting started",
items: [
"getting-started/pre-requisites",
"getting-started/supported-devices",
"getting-started/flash-nspanel",
{
type: 'category',
label: 'Getting started',
items: [
'getting-started/pre-requisites',
'getting-started/supported-devices',
'getting-started/flash-nspanel',
{
type: 'category',
label: 'Install NSPanel Manager',
items: [
{
type: 'autogenerated',
dirName: 'getting-started/install',
},
],
},
'getting-started/configuration',
]
type: "category",
label: "Install NSPanel Manager",
items: [
{
type: "autogenerated",
dirName: "getting-started/install",
},
],
},
'web-interface',
'panel-functions',
"getting-started/configuration",
],
},
"web-interface",
"panel-functions",
{
type: "category",
label: "Advanced topics",
items: [
{
type: 'category',
label: 'Advanced topics',
items: [
{
type: 'autogenerated',
dirName: 'advanced',
},
]
type: "autogenerated",
dirName: "advanced",
},
],
},
{
type: "category",
label: "Contribute",
items: [
{
type: 'category',
label: 'Contribute',
items: [
{
type: 'autogenerated',
dirName: 'contribute',
},
]
type: "autogenerated",
dirName: "contribute",
},
],
],
},
],
};
```

More help is available on docusaurus: https://docusaurus.io/docs/sidebar
More help is available on docusaurus: https://docusaurus.io/docs/sidebar
6 changes: 3 additions & 3 deletions docs/getting-started/configure-flashed-nspanel.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,10 +42,10 @@ Let's setup the minimal configuration, the rest can be configured from NSPanel M
After that the device will reboot and connect to your Wifi
(it will no longer host a WiFi named `NSPMPanel` nor be reachable to the previous url).

<Label value="beta" />In case you need to access the setup page again it is possible to reset the device by pressing the reset/reboot button via the bottom hole quickly 5 times in a row. This will start the WiFi access point again and let you configure it.
In case you need to access the setup page again it is possible to reset the device by pressing the reset/reboot button via the bottom hole quickly 5 times in a row. This will start the WiFi access point again and let you configure it.

If needed, you will still be able to connect to it via it's new IP from your own Wifi network.
(Check in your Router to retrieve its IP)
If needed, you will still be able to connect to it via it's new IP from your own Wifi network
(check in your router to retrieve its new IP).

At this stage, if your device could connect to your WiFi and to MQTT you can jump into
the [installation of NSPanel Manager](./install/installation-guide-docker.md)
2 changes: 1 addition & 1 deletion docs/getting-started/flash-nspanel.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ Notice that RX and TX pins have to be inverted between the devices: it is not TX

### Flash NSPanel with NSPanelManager custom firmware

First, download the latest firmware `merged-flash.bin` from [here](https://github.com/NSPManager/NSPanelManager/raw/refs/heads/main/firmware/NSPanelManagerFirmware/merged-flash.bin).
First, download the latest firmware `merged-flash.bin` from [here](https://github.com/NSPManager/NSPanelManager/blob/main/docker/web/nspanelmanager/merged_flash.bin).

Then, flash the firmware with your tool of choice:

Expand Down
Loading
Loading