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
Copy file name to clipboardExpand all lines: docs/web-interface.md
+41-12Lines changed: 41 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -66,8 +66,8 @@ Available options for each individual NSPanel are:
66
66
All actions meant for relay 1 will be applied to relay 2 and vice versa.
67
67
-**Left/Right Button mode** - Change the mode of a button. Available options are:
68
68
-**Direct mode** - The buttons controls the relay directly. No WiFi is needed.
69
-
-**Detached mode** - Detached mode controls a button via you selected home automation platform.
70
-
This also exposes the option "Left/Right button controls light" where you select which entity it controls.
69
+
-**Detached mode** - Detached mode controls a light via your selected home automation platform.
70
+
This also exposes the option "Left/Right button controls light in room" as well as "Left/Right button controls light" where you select which entity it controls.
71
71
-**Custom MQTT** - This mode can be used to send a custom message on a custom MQTT topic.
72
72
-**Follow mode** - When the button is pressed the relay is engaged, when the button is release the relay is disconnected.
73
73
-**Relay 1/2 default mode** - Select the default mode of the relay when the NSPanel starts.
@@ -101,9 +101,9 @@ When that's done you need to update the GUI on the panel and it should be up and
101
101
102
102
**Available Backgrounds** (US files have the same background as the EU.)
@@ -114,11 +114,11 @@ rooms, please read this chapter for a full understanding on how to work with roo
114
114
115
115
### <Labelvalue="beta"/>Pages
116
116
117
-
Both scenes and entities are handled within "Pages". These pages as simply to use and will hold all your scenes and entities. Because the Nextion display used on the
118
-
Sonoff NSPanel is somewhat limiting there are only predefined pages available. Pages are available in variants to displya 4, 8 or 12 entities as displayed below.
117
+
Both scenes and entities are handled within "Pages". These pages are simple to use and will hold all your scenes and entities. Because the Nextion display used on the
118
+
Sonoff NSPanel is somewhat limiting there are only predefined pages available. Pages are available in variants to display 4, 8 or 12 entities as displayed below.
119
119
It's possible to change the type of an existing page by pressing the pen-icon in the bottom right of the page. To reorder pages simply drag and drop them by the hand-icon in the bottom center of the page you wish to move. If you have more than one page avaiable it's also possible to delete a page with all the entities by pressing the cross in the bottom right of the page.
120
120
121
-
The entities/scenes that are assigned to each slot in the page can also be moved by draging and dropping them into available slots. If an entity/scene is dropped on a slot with an already assigned entity/slot the will swap places.
121
+
The entities/scenes that are assigned to each slot in the page can also be moved by draging and dropping them into available slots. If an entity/scene is dropped on a slot with an already assigned entity/slot they will swap places.
@@ -178,15 +178,15 @@ Each entity may only be assigned to one slot. If the list of entities is empty t
178
178
179
179
### Entities <Labelvalue="beta"/>
180
180
181
-
To add a new entity, simply press the "+"-icon in a free slot on a page and select type.
182
-
If you have both Home Assistant and OpenHAB configured you will be given the option to select from what manager the entity is controlled by.
181
+
To add a new entity, simply press the "+"-icon in a free slot on a page and select type. Once that's done you will need to select from which manager the entity is controlled by (Home Assistant, OpenHAB or NSPanel Manager internal entity).
183
182
In the last step you can configure settings such as display name and any settings specific for that entity type.
184
183
185
184
#### Configure lights
186
185
187
186
When adding/editing a light entity you get multiple options of charecteristics of the light.
188
187
189
188
-**Name** - The displayed name on the NSPanel and web interface.
189
+
-**Home Assistant Entity <Labelvalue="home_assistant"/>** - The displayed name on the NSPanel and web interface.
190
190
-**Type** - is this light a ceiling or table light (as to how it should be grouped/displayed on main page on NSPanel).
191
191
-**Control mode** - Is this light dimmable or it it simply an on/off light.
192
192
-**Controlled by main page** - If this is marked the light will be included in the displayed data and controlled from the main page of the NSPanel.
@@ -199,6 +199,35 @@ When adding/editing a light entity you get multiple options of charecteristics o
199
199
<CenteredImagesrc="/images/doc/configure_home_assistant_light.png"alt="Add/Edit light Home Assistant"figureNumber="12a" />
When adding/editing a Home Assistant button entity you simply get the choice of what name to display and also what entity to use.
215
+
216
+
-**Name** - The displayed name on the NSPanel and web interface.
217
+
-**Home Assistant item** - This is the button entity in Home Assistant. This can be either an "button." or "input_button." entity.
218
+
219
+
<CenteredImagesrc="/images/doc/configure_home_assistant_button.png"alt="Add/Edit button Home Assistant"figureNumber="14" />
220
+
221
+
#### Configure NSPM buttons
222
+
223
+
An NSPM button entity is controlled by the NSPanel Manager itself. This button entity is simply used to send an MQTT payload to a specified topic. What you do with it is up to you.
224
+
225
+
-**Name** - The displayed name on the NSPanel and web interface.
226
+
-**MQTT Topic** - The MQTT topic to send the payload to.
It's possible to add relays/switches as controlled entities from the NSPanel. These are simply on/off and can be toggled from the "Entities page" on the NSPanel.
@@ -210,7 +239,7 @@ all the relays in the group transissions to the new state.
210
239
211
240
## Weather and Time
212
241
213
-
<CenteredImagesrc="/images/doc/weather_and_time.png"alt="Weather and Time settings"figureNumber="13" />
242
+
<CenteredImagesrc="/images/doc/weather_and_time.png"alt="Weather and Time settings"figureNumber="16" />
214
243
215
244
On the Weather & Time page settings related to time, date and weather can be changed. Date format is configured
216
245
according to the `strftime` function and a link to available formatting options is available in the information box or [here](https://cplusplus.com/reference/ctime/strftime/).
0 commit comments