Skip to content

Commit b14bfde

Browse files
authored
Minor fixes and updates for v2.1.0 beta (#63)
1 parent 3111cb7 commit b14bfde

6 files changed

Lines changed: 41 additions & 12 deletions

docs/web-interface.md

Lines changed: 41 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -66,8 +66,8 @@ Available options for each individual NSPanel are:
6666
All actions meant for relay 1 will be applied to relay 2 and vice versa.
6767
- **Left/Right Button mode** - Change the mode of a button. Available options are:
6868
- **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.
7171
- **Custom MQTT** - This mode can be used to send a custom message on a custom MQTT topic.
7272
- **Follow mode** - When the button is pressed the relay is engaged, when the button is release the relay is disconnected.
7373
- **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
101101

102102
**Available Backgrounds** (US files have the same background as the EU.)
103103
<CenteredImage src="https://raw.githubusercontent.com/NSPManager/NSPanelManager/refs/heads/beta/docker/HMI_files/tft_automation/eu/output_tft1/example.png" alt="GUI1" figureNumber={4} />
104-
<CenteredImage src="https://raw.githubusercontent.com/NSPManager/NSPanelManager/refs/heads/beta/docker/HMI_files/tft_automation/eu/output_tft1/example.png" alt="GUI2" figureNumber={5} />
105-
<CenteredImage src="https://raw.githubusercontent.com/NSPManager/NSPanelManager/refs/heads/beta/docker/HMI_files/tft_automation/eu/output_tft1/example.png" alt="GUI3" figureNumber={6} />
106-
<CenteredImage src="https://raw.githubusercontent.com/NSPManager/NSPanelManager/refs/heads/beta/docker/HMI_files/tft_automation/eu/output_tft1/example.png" alt="GUI4" figureNumber={7} />
104+
<CenteredImage src="https://raw.githubusercontent.com/NSPManager/NSPanelManager/refs/heads/beta/docker/HMI_files/tft_automation/eu/output_tft2/example.png" alt="GUI2" figureNumber={5} />
105+
<CenteredImage src="https://raw.githubusercontent.com/NSPManager/NSPanelManager/refs/heads/beta/docker/HMI_files/tft_automation/eu/output_tft3/example.png" alt="GUI3" figureNumber={6} />
106+
<CenteredImage src="https://raw.githubusercontent.com/NSPManager/NSPanelManager/refs/heads/beta/docker/HMI_files/tft_automation/eu/output_tft4/example.png" alt="GUI4" figureNumber={7} />
107107

108108
## Room page
109109

@@ -114,11 +114,11 @@ rooms, please read this chapter for a full understanding on how to work with roo
114114

115115
### <Label value="beta"/>Pages
116116

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.
119119
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.
120120

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.
122122

123123
<CenteredImage src="/images/doc/entities_page_variants.png" alt="Page variants" figureNumber={9} />
124124

@@ -178,15 +178,15 @@ Each entity may only be assigned to one slot. If the list of entities is empty t
178178

179179
### Entities <Label value="beta"/>
180180

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).
183182
In the last step you can configure settings such as display name and any settings specific for that entity type.
184183

185184
#### Configure lights
186185

187186
When adding/editing a light entity you get multiple options of charecteristics of the light.
188187

189188
- **Name** - The displayed name on the NSPanel and web interface.
189+
- **Home Assistant Entity <Label value="home_assistant"/>** - The displayed name on the NSPanel and web interface.
190190
- **Type** - is this light a ceiling or table light (as to how it should be grouped/displayed on main page on NSPanel).
191191
- **Control mode** - Is this light dimmable or it it simply an on/off light.
192192
- **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
199199
<CenteredImage src="/images/doc/configure_home_assistant_light.png" alt="Add/Edit light Home Assistant" figureNumber="12a" />
200200
<CenteredImage src="/images/doc/configure_openhab_light.png" alt="Add/Edit light OpenHAB" figureNumber="12b" />
201201

202+
#### Configure switches
203+
204+
When adding/editing a switch entity you simply get to choose the entity/item and the name to use.
205+
206+
- **Name** - The displayed name on the NSPanel and web interface.
207+
- **Home Assistant item <Label value="home_assistant"/>** - The home assistant entity to control.
208+
- **OpenHAB item <Label value="openhab"/>** - The OpenHAB item to control.
209+
210+
<CenteredImage src="/images/doc/configure_home_assistant_switch.png" alt="Add/Edit switch Home Assistant" figureNumber="13a" />
211+
<CenteredImage src="/images/doc/configure_openhab_switch.png" alt="Add/Edit switch OpenHAB" figureNumber="13b" />
212+
#### Configure Home Assistant buttons
213+
214+
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+
<CenteredImage src="/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.
227+
- **MQTT Payload** - The MQTT payload to send.
228+
229+
<CenteredImage src="/images/doc/configure_nspm_button.png" alt="Add/Edit button NSPM" figureNumber="15" />
230+
202231
### Switch
203232

204233
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.
210239

211240
## Weather and Time
212241

213-
<CenteredImage src="/images/doc/weather_and_time.png" alt="Weather and Time settings" figureNumber="13" />
242+
<CenteredImage src="/images/doc/weather_and_time.png" alt="Weather and Time settings" figureNumber="16" />
214243

215244
On the Weather & Time page settings related to time, date and weather can be changed. Date format is configured
216245
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/).
@@ -253,7 +282,7 @@ and so on.
253282

254283
Go ahead and explore by yourself.
255284

256-
<CenteredImage src="/images/doc/settings_page.png" alt="Global settings" figureNumber="14" />
285+
<CenteredImage src="/images/doc/settings_page.png" alt="Global settings" figureNumber="17" />
257286

258287
The "Global settings" section of the web interface is where you can settings that apply to all NSPanels or settings
259288
that simply are not directly related the panels themselves.
11.6 KB
Loading
11.9 KB
Loading
16.7 KB
Loading
11.5 KB
Loading

static/images/doc/nspanel_page.png

2.17 KB
Loading

0 commit comments

Comments
 (0)