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
Added thermostat explanation and updated NSPanel physical buttons options (#100)
* Added documentation for thermostat/climate control. Also updated the option names to reflect that the NSPanel physical buttons can now control entities and not just lights.
* Added beta tag to thermostat option
* Added a simple explanation of how to use the thermostat page on the panel itself.
* Fixed spelling and added more information about from where the current temp reading is from.
Copy file name to clipboardExpand all lines: docs/panel-functions.md
+6Lines changed: 6 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -115,3 +115,9 @@ To control a device individually press the device name.
115
115
116
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
117
117
in the top right corner to toggle between Color Temperature mode and Color mode.
118
+
119
+
### Thermostat control page
120
+
121
+
All the capabilities of the chosen thermostat/climate entity will be shown on this page. Simple press the setting you want to change and use the arrows to change it.
122
+
Wait for the timeout or press the next option to apply the changes. The current temperature for the room will be shown using the temperature sensor attached to the room if one exists.
123
+
If no such sensor is attached to the room the thermostat is placed in the current temperature reading will be read from the internal thermistor.
Copy file name to clipboardExpand all lines: docs/web-interface.md
+30-4Lines changed: 30 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -66,8 +66,7 @@ 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 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.
69
+
-**Detached mode** - Detached mode controls an entity via your selected home automation platform. Do not however that not all entity types support the toggle mechanism.
71
70
-**Custom MQTT** - This mode can be used to send a custom message on a custom MQTT topic.
72
71
-**Follow mode** - When the button is pressed the relay is engaged, when the button is release the relay is disconnected.
73
72
-**Relay 1/2 default mode** - Select the default mode of the relay when the NSPanel starts.
@@ -154,7 +153,7 @@ In the last step you can configure settings such as display name and any setting
154
153
When adding/editing a light entity you get multiple options of charecteristics of the light.
155
154
156
155
-**Name** - The displayed name on the NSPanel and web interface.
157
-
-**Home Assistant Entity <Labelvalue="home_assistant"/>** - The displayed name on the NSPanel and web interface.
156
+
-**Home Assistant Entity <Labelvalue="home_assistant"/>** - The home assistant entity to control.
158
157
-**Type** - is this light a ceiling or table light (as to how it should be grouped/displayed on main page on NSPanel).
159
158
-**Control mode** - Is this light dimmable or it it simply an on/off light.
160
159
-**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.
@@ -186,7 +185,34 @@ When adding/editing a Home Assistant button entity you simply get the choice of
186
185
187
186
<CenteredImagesrc="/images/doc/configure_home_assistant_button.png"alt="Add/Edit button Home Assistant"figureNumber="14" />
188
187
189
-
#### Configure NSPM buttons
188
+
#### Configure thermostat/climate control <Labelvalue="beta"/>
189
+
190
+
When adding/editing a thermostat/climate entity you get multiple options of characteristics of the entity.
191
+
192
+
-**Name** - The displayed name on the NSPanel and web interface.
193
+
-**Home Assistant Entity <Labelvalue="home_assistant"/>** - The home assistant entity to control.
194
+
-**Load options from selected Home Assistant entity <Labelvalue="home_assistant"/>** - This button will load all available options from the selected Home Assistant entity and populate the fields below.
195
+
-**Temperature item <Labelvalue="openhab"/>** - The item in OpenHAB that controls the target temperature.
196
+
-**Step size <Labelvalue="openhab"/>** - When adjusting the temperature, step the temperature by this value.
197
+
198
+
Following those settings there will be groups of items/settings to adjust. These are the following:
199
+
200
+
- Fan mode
201
+
- Mode
202
+
- Presets
203
+
- Swing
204
+
- Horizontal swing
205
+
206
+
Each of these groups have, in case of running <Labelvalue="openhab"/>, a field for selecting the OpenHAB item that controls it.
207
+
There is also a table of settings for each group. This table is built so that the user may choose a different display name and
208
+
icon for each value. The left most field is the value that will be sent to Home Assistant or OpenHAB, the next field is the
209
+
display name that will be shown on the NSPanel, and the rightmost field is the icon that will be shown on the NSPanel. To change the icon
210
+
press the button and select the icon from the list.
211
+
212
+
<CenteredImagesrc="/images/doc/configure_home_assistant_thermostat.png"alt="Add/Edit thermostat Home Assistant"figureNumber="12a" />
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.
0 commit comments