Skip to content

Commit c7b2cf1

Browse files
tpanajottcablesandcoffee
tpanajott
and
cablesandcoffee
authored
79 update docs to reflect new stable v2 release (#80)
* Cleanup of "beta"-tags in web interface and removed old V1 stable specific chapters * Renamed 1.0 to "stable" in the online flashing tool * Update flash-nspanel.md fixed broken link to merged_flash.bin --------- Co-authored-by: cablesandcoffee <63468500+cablesandcoffee@users.noreply.github.com>
1 parent 0a2fcd9 commit c7b2cf1

File tree

11 files changed

+97
-166
lines changed

11 files changed

+97
-166
lines changed

‎docs/advanced/architecture.md‎

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -70,13 +70,6 @@ Home Assistant and OpenHAB can leverage the MQTT integration through "Home Assis
7070
OpenHAB can also use) to auto-discover NSPanels and automatically register entities for panel temperature reading, panel
7171
relays, screen state and so on.
7272

73-
### NSPanel Manager container to/from NSPanels <Label value="stable"/>
74-
75-
The configuration of lights, scenes and so on does not reside on each panel. The panel only has locally the bare minimum
76-
configuration for setup. When the panel starts and has connected to WiFi it will do a HTTP GET request to the NSPanel
77-
Manager container in order to receive all configuration of entities, screen brightness and really, all settings
78-
available in the NSPanel Manager web interface.
79-
8073
### NSPanel Manager container to/from NSPanels <Label value="beta"/>
8174

8275
The configuration of lights, scenes and so on does not reside on each panel. The panel only has locally the bare minimum

‎docs/advanced/mqtt-topics.md‎

Lines changed: 0 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -6,37 +6,6 @@ sidebar_position: 10
66
import Centered from '@site/src/components/Centered';
77
import Label from '@site/src/components/Label';
88

9-
# MQTT Topics <Label value="stable"/>
10-
11-
Below table is a description of all MQTT topics that might be of use by a user. Replace `<panel_name>` with the friendly
12-
name of your NSPanel:
13-
14-
| Topic | Payload | Description |
15-
| --------------------------------------------- | ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
16-
| nspanel/\<panel_name\>/screen_cmd | 1 or 0 | Send a 1 or 0 to turn on/off the display. |
17-
| nspanel/\<panel_name\>/screen_state | 1 or 0 | Current state of the screen. |
18-
| nspanel/\<panel_name\>/brightness | 1 to 100 | Control the brightness of the screen. |
19-
| nspanel/\<panel_name\>/brightness_screensaver | 0 to 100 | Control the brightness of the screensaver. |
20-
| nspanel/\<panel_name\>/r1_cmd | 1 or 0 | Send a 1 or 0 to turn on/off relay 1. |
21-
| nspanel/\<panel_name\>/r1_state | 1 or 0 | The current state of relay 1. |
22-
| nspanel/\<panel_name\>/r2_cmd | 1 or 0 | Send a 1 or 0 to turn on/off relay 2. |
23-
| nspanel/\<panel_name\>/r2_state | 1 or 0 | The current state of relay 2. |
24-
| nspanel/\<panel_name\>/temperature_state | Current temperature | The current temperature reading. |
25-
| 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 |
26-
| nspanel/\<panel_name\>/log | Log message | The panel will send live logs on this topic. |
27-
28-
There are more topics that are used internally, these are:
29-
30-
| Topic | Payload | Description |
31-
| ----------------------------------------------------- | -------------------------- | ------------------------------------------------------------------------------------------------------- |
32-
| 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 |
33-
| nspanel/status/time | Time as a string | Current time sent by MQTTManager. |
34-
| nspanel/status/weather | JSON | A JSON representation of the current weather and weather forecast. |
35-
| nspanel/\<panel_name\>/status_report | JSON | JSON payload with current state of the panel. |
36-
| nspanel/\<panel_name\>/status | JSON | JSON payload with current online/offline state of the panel. |
37-
| nspanel/\<panel_name\>/command | JSON | JSON payload with a command for the panel to execute. |
38-
| nspanel/mqttmanager/command | JSON | JSON payload from panel with a command for MQTTManager to perform. |
39-
409
# MQTT Topics <Label value="beta"/>
4110

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

‎docs/advanced/stomp-topics.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,15 @@ sidebar_position: 15
66
import Centered from '@site/src/components/Centered';
77
import Label from '@site/src/components/Label';
88

9-
# STOMP Topics <Label value="beta"/>
9+
# STOMP Topics
1010

11-
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.
11+
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.
1212

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

15-
| Topic | Payload | Description |
16-
| ----------------------------------- |-------------------------------------------------------------------------| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
15+
| Topic | Payload | Description |
16+
| ----------------------------------- | ------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
1717
| nspanel/\<mac_address\>/command | `reboot`, `firmware_update` or `gui_update` | Reboot, update firmware or update the GUI of the NSPanel. |
18-
| 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. |
19-
| 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. |
18+
| 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. |
19+
| 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. |
2020
| 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. |

‎docs/contribute/documentation/improve-documentation.md‎

Lines changed: 45 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Here’s a quick overview to get you started.
1414

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

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

1919
1. Simply click over this link, it will allow you to edit via GitHub UI directly, the content of the page.
2020
2. Update the content using Markdown in the editor.
@@ -34,68 +34,69 @@ Each pages of the Guide including this one provides a link at its whole bottom:
3434
title: <page title>
3535
sidebar_position: <order in sidebar menu>
3636
---
37-
37+
3838
# <page title>
39-
39+
4040
<your content>
4141
```
42-
42+
4343
4. You can, make use of MDX components (rich UI components) by importing them within the pages.
4444
Have a look at this to learn more: https://docusaurus.io/docs/markdown-features.
4545

46-
5. Optionally, you might also want to use specific widgets created for this project.
46+
5. Optionally, you might also want to use specific widgets created for this project.
4747
They are documented here: [custom widgets](./custom-widgets.md)
48+
4849
## Customize sidebar menu
4950

5051
Edit `docs/src/sidebars.ts`
5152

5253
```ts
5354
const sidebars: SidebarsConfig = {
54-
mainSidebar: [
55+
mainSidebar: [
56+
{
57+
type: "category",
58+
label: "Getting started",
59+
items: [
60+
"getting-started/pre-requisites",
61+
"getting-started/supported-devices",
62+
"getting-started/flash-nspanel",
5563
{
56-
type: 'category',
57-
label: 'Getting started',
58-
items: [
59-
'getting-started/pre-requisites',
60-
'getting-started/supported-devices',
61-
'getting-started/flash-nspanel',
62-
{
63-
type: 'category',
64-
label: 'Install NSPanel Manager',
65-
items: [
66-
{
67-
type: 'autogenerated',
68-
dirName: 'getting-started/install',
69-
},
70-
],
71-
},
72-
'getting-started/configuration',
73-
]
64+
type: "category",
65+
label: "Install NSPanel Manager",
66+
items: [
67+
{
68+
type: "autogenerated",
69+
dirName: "getting-started/install",
70+
},
71+
],
7472
},
75-
'web-interface',
76-
'panel-functions',
73+
"getting-started/configuration",
74+
],
75+
},
76+
"web-interface",
77+
"panel-functions",
78+
{
79+
type: "category",
80+
label: "Advanced topics",
81+
items: [
7782
{
78-
type: 'category',
79-
label: 'Advanced topics',
80-
items: [
81-
{
82-
type: 'autogenerated',
83-
dirName: 'advanced',
84-
},
85-
]
83+
type: "autogenerated",
84+
dirName: "advanced",
8685
},
86+
],
87+
},
88+
{
89+
type: "category",
90+
label: "Contribute",
91+
items: [
8792
{
88-
type: 'category',
89-
label: 'Contribute',
90-
items: [
91-
{
92-
type: 'autogenerated',
93-
dirName: 'contribute',
94-
},
95-
]
93+
type: "autogenerated",
94+
dirName: "contribute",
9695
},
97-
],
96+
],
97+
},
98+
],
9899
};
99100
```
100101

101-
More help is available on docusaurus: https://docusaurus.io/docs/sidebar
102+
More help is available on docusaurus: https://docusaurus.io/docs/sidebar

‎docs/getting-started/configure-flashed-nspanel.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -42,10 +42,10 @@ Let's setup the minimal configuration, the rest can be configured from NSPanel M
4242
After that the device will reboot and connect to your Wifi
4343
(it will no longer host a WiFi named `NSPMPanel` nor be reachable to the previous url).
4444

45-
<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.
45+
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.
4646

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

5050
At this stage, if your device could connect to your WiFi and to MQTT you can jump into
5151
the [installation of NSPanel Manager](./install/installation-guide-docker.md)

‎docs/getting-started/flash-nspanel.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@ Notice that RX and TX pins have to be inverted between the devices: it is not TX
102102

103103
### Flash NSPanel with NSPanelManager custom firmware
104104

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

107107
Then, flash the firmware with your tool of choice:
108108

0 commit comments

Comments
 (0)