You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* Fixed typo and updated docs for the new functionality of selecting panel type, orientation and background.
* Updated documentation with regards to swipes and STOMP-topics.
* Escaped < and > tags
* Fixed comments from review and moved backgrounds to the "NSPanel page" section
* Updated sidebar and also added a 'Known issues' page.
* minor formating improvement (use ` vs ')
add a blank line for readability
* fix known issues label in sidemenu
---------
Co-authored-by: sebastienvermeille <sebastien.vermeille@gmail.com>
import Centered from '@site/src/components/Centered';
7
+
import Label from '@site/src/components/Label';
8
+
9
+
# STOMP Topics <Labelvalue="beta"/>
10
+
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.
12
+
13
+
When a stomp connection has been established the following topics can be used:
| 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. |
20
+
| 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. |
import CenteredImage from '@site/src/components/CenteredImage';
7
+
import Label from '@site/src/components/Label';
8
+
9
+
# Known issues
10
+
11
+
This chapter describes all known issues with NSPanel Manager. For up to date list of bugs, enhancements and other issues, please visit the [GitHub repository](https://github.com/NSPManager/NSPanelManager/issues). This list simply describes bugs that we cannot fix.
12
+
13
+
- If using OpenHAB and something else triggers a light to turn off, OpenHAB will not send out a new state for the light that the brightness has changed to 0 (turned off). This makes it so that if you have a light added to OpenHAB, then add it to NSPanel Manager but control the light from something else other than OpenHAB or NSPanel Manager the NSPanel will not always have the correct state of a light. Please see [issue #125](https://github.com/NSPManager/NSPanelManager/issues/125)
Copy file name to clipboardExpand all lines: docs/panel-functions.md
+32-21Lines changed: 32 additions & 21 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,6 +2,7 @@
2
2
title: Panel functions
3
3
sidebar_position: 4
4
4
---
5
+
5
6
import CenteredImage from '@site/src/components/CenteredImage';
6
7
7
8
# Panel functions
@@ -27,26 +28,26 @@ import CenteredImage from '@site/src/components/CenteredImage';
27
28
7. Lights mode button
28
29
**Short press** - Toggle between Room Lights mode and All Lights mode
29
30
8. Scenes button.
30
-
**Short press** - Enter Scenes page. If 7 is in Room Lights mode user will enter Room Scenes. If 7 is in All Lights
31
+
**Short press** - Enter Scenes page. If 7 is in Room Lights mode user will enter Room Scenes. If 7 is in All Lights
31
32
mode user will enter Global Scenes page.
32
33
33
34
### Lights control logic
34
35
35
36
The NSPanel main page might have some behavior that seems odd at first but the logic of it will be described here.
36
-
The first page will affect entities in the selected room (if in room-mode) or all the configured lights
37
+
The first page will affect entities in the selected room (if in room-mode) or all the configured lights
37
38
(if in "All lights"-mode).
38
39
39
-
The two left buttons for ceiling and table lights will always behave the same.
40
-
Pressing a button that is "off" will turn on all the lights of that type.
40
+
The two left buttons for ceiling and table lights will always behave the same.
41
+
Pressing a button that is "off" will turn on all the lights of that type.
41
42
Pressing a button that is "on" will turn off all lights of that type.
42
43
The sliders will always display an average value of all entities that will be affected of changes.
43
44
44
45
There are few different scenarios:
45
46
46
47
#### One or more lights on
47
48
48
-
When changing the sliders, the changes will only be sent out to the lights currently on.
49
-
If turning on a group of lights or individual lights they will be turned on to the current brightness of the slider.
49
+
When changing the sliders, the changes will only be sent out to the lights currently on.
50
+
If turning on a group of lights or individual lights they will be turned on to the current brightness of the slider.
50
51
I.e. average dimming level in the room.
51
52
52
53
:::info
@@ -60,47 +61,57 @@ When changing the sliders, the changes will be sent out to all lights selected (
60
61
61
62
#### Lock mode
62
63
63
-
You can lock which light to affect by pressing and holding either the ceiling or table-lights button.
64
-
This will enter a special mode where changes to the sliders will only affect the selected type of lights.
65
-
By pressing the same button again you can exit the "special mode".
64
+
You can lock which light to affect by pressing and holding either the ceiling or table-lights button.
65
+
This will enter a special mode where changes to the sliders will only affect the selected type of lights.
66
+
By pressing the same button again you can exit the "special mode".
66
67
The "special mode" will also time out after a few seconds.
67
68
68
69
### Scenes button (top left corner)
69
70
70
71
The settings icon in the top left corner is for entering the Scenes page. In NSPanel Manager there are both Room Scenes
71
-
and Global Scenes. If you’re in Room Lights mode (button in lower right corner) you will enter the Room Scenes page.
72
-
If you’re in All Lights mode you will enter the Global Scenes page. You’ll also see that the settings icon changes when
73
-
toggling between Room Lights and All Lights mode. Standard settings icon leads to Room Scenes page when pressing it.
72
+
and Global Scenes. If you’re in Room Lights mode (button in lower right corner) you will enter the Room Scenes page.
73
+
If you’re in All Lights mode you will enter the Global Scenes page. You’ll also see that the settings icon changes when
74
+
toggling between Room Lights and All Lights mode. Standard settings icon leads to Room Scenes page when pressing it.
74
75
Settings icon with a roof on top leads to Global Scenes page.
75
76
76
-
### Swipe down
77
+
### Swipes
78
+
79
+
#### Swipe down
77
80
78
-
You can swipe downwards when on the first page to enter the Smart Home Control page. This page is a work in progress.
81
+
On most pages, a swipe down will go back to the previous page. When swiping down on the home page you will enter the Smart Home Control page. This page is a work in progress.
79
82
Design and functionality is not finished or decided yet.
80
83
84
+
#### Swipe in from left
85
+
86
+
On the page that shows entities and scenes, a swipe in from the left will go the to previous room. Note that when swiping you have to do it on the top of the page where no entities exists. This will be resolved in a future update.
87
+
88
+
#### Swipe in from right
89
+
90
+
On the page that shows entities and scenes, a swipe in from the right will go the to next room. Note that when swiping you have to do it on the top of the page where no entities exists. This will be resolved in a future update.
91
+
81
92
### Smart Home Control page
82
93
83
94
Accessed by swiping down on Main page. Work in progress. Design and functionality is not finished or decided yet.
84
95
85
-
### Scenes page
96
+
### Scenes page
86
97
87
-
To enter Scenes page, press the settings icon in top left corner on Main page.
98
+
To enter Scenes page, press the settings icon in top left corner on Main page.
88
99
Depending on if you’re in Room Lights mode or All Lights mode you will enter Room Scenes page or Global Scenes page.
89
100
90
-
Scene names that show up here are the ones you have configured in the NSPanel Manager web interface.
101
+
Scene names that show up here are the ones you have configured in the NSPanel Manager web interface.
91
102
92
-
To store a scene simply hold the save button for three seconds and the current values of the lights in the room you are
93
-
in or all lights if in All Lights mode will be saved.
103
+
To store a scene simply hold the save button for three seconds and the current values of the lights in the room you are
104
+
in or all lights if in All Lights mode will be saved.
94
105
95
106
To activate a scene and send out those saved values you just press the scene name.
96
107
97
108
### Room page
98
109
99
-
Enter Room page by pressing the room name on Main page.
110
+
Enter Room page by pressing the room name on Main page.
100
111
All devices configured for that room will show up here.
101
112
To control a device individually press the device name.
102
113
103
114
### Individual Lights page
104
115
105
-
All the capabilities of the chosen light will be shown on this page. If the light is RGB capable there will be an icon
116
+
All the capabilities of the chosen light will be shown on this page. If the light is RGB capable there will be an icon
106
117
in the top right corner to toggle between Color Temperature mode and Color mode.
0 commit comments