Skip to content

Commit cd65105

Browse files
committed
Improve screenshots in docs
1 parent 2939f8b commit cd65105

11 files changed

Lines changed: 36 additions & 2 deletions

README.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -152,6 +152,10 @@ edit). Press **s** to save and **q** to quit. Comments, ordering, formatting and
152152
existing quote style in `config.py` are preserved; complex settings (lists and the output
153153
function) are shown read-only with a note to edit them directly in the file.
154154

155+
<p align="center">
156+
<img src="./images/configurator.png" alt="Interactive TUI configurator" />
157+
</p>
158+
155159
## Configuration
156160

157161
All options live in `src/config.py`. Key settings:
@@ -213,6 +217,12 @@ If none of the above fits your setup, set `display_on_command` / `display_off_co
213217

214218
When `discovery_messages = True` (the default), a new MQTT device is created in Home Assistant automatically — no `configuration.yaml` edits required. Just add it to a dashboard.
215219

220+
The auto-created device groups all readings, controls (restart, shutdown, update), and sensors under a single Home Assistant entry:
221+
222+
<p align="center">
223+
<img src="./images/hass-view.png" alt="Auto-created Home Assistant device" />
224+
</p>
225+
216226
### Home Assistant API
217227

218228
To bypass MQTT and push directly to the HA REST API, use the `--hass_api` flag and configure `hass_host` and `hass_token` in `config.py`.
@@ -224,7 +234,7 @@ Run `rpi-mqtt-monitor --hass_wake` to print the YAML snippet for a Home Assistan
224234
### Home Assistant Dashboard
225235

226236
<p align="center">
227-
<img src="./images/rpi-cpu2mqtt-hass.jpg" alt="Home Assistant dashboard" />
237+
<img src="./images/hass-dashboard.png" alt="Home Assistant dashboard" />
228238
</p>
229239

230240
## External Sensors

docs/cli.html

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,15 @@ <h2>Options at a glance</h2>
6565
<tr><td><code>--uninstall</code></td><td>Uninstall rpi-mqtt-monitor and remove all related files</td></tr>
6666
</tbody>
6767
</table>
68+
69+
<h2>Interactive configurator</h2>
70+
<p>Run <code>rpi-mqtt-monitor --config</code> to open a terminal UI for editing <code>config.py</code>.
71+
Move through the settings with the <strong>↑/↓</strong> arrows; each setting shows its description and
72+
default value. Press <strong>Enter</strong> to edit the selected value, <strong>s</strong> to save,
73+
and <strong>q</strong> to quit. Comments, ordering, and formatting in <code>config.py</code> are preserved.</p>
74+
<figure>
75+
<img src="images/configurator.png" alt="Interactive TUI configurator" />
76+
</figure>
6877
</main>
6978
</div>
7079

docs/configuration.html

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,16 @@ <h1>Configuration</h1>
6868
<p>Full configuration reference:
6969
<a href="https://github.com/hjelev/rpi-mqtt-monitor/wiki/Configuration" target="_blank" rel="noopener">Configuration wiki</a>.</p>
7070

71+
<h2>Interactive configurator</h2>
72+
<p>Run <code>rpi-mqtt-monitor --config</code> to edit these settings from a terminal UI instead of
73+
editing <code>config.py</code> by hand. Move through the settings with the <strong>↑/↓</strong>
74+
arrows; each shows its description and default value. Press <strong>Enter</strong> to edit the
75+
selected value, <strong>s</strong> to save, and <strong>q</strong> to quit. Comments, ordering,
76+
and formatting in <code>config.py</code> are preserved.</p>
77+
<figure>
78+
<img src="images/configurator.png" alt="Interactive TUI configurator" />
79+
</figure>
80+
7181
<h2>Display control backends</h2>
7282
<p>With <code>display_control = True</code>, the monitor on/off buttons auto-detect a working
7383
backend for the current environment:</p>

docs/home-assistant.html

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,11 @@ <h1>Home Assistant Integration</h1>
3737
<p>When <code>discovery_messages = True</code> (the default), a new MQTT device is created in
3838
Home Assistant automatically — no <code>configuration.yaml</code> edits required. Just add it
3939
to a dashboard.</p>
40+
<p>The auto-created device groups all readings, controls (restart, shutdown, update), and sensors
41+
under a single Home Assistant entry:</p>
42+
<figure>
43+
<img src="images/hass-view.png" alt="Auto-created Home Assistant device" />
44+
</figure>
4045

4146
<h2>Home Assistant API</h2>
4247
<p>To bypass MQTT and push directly to the HA REST API, use the <code>--hass_api</code> flag and
@@ -48,7 +53,7 @@ <h2>Wake on LAN</h2>
4853

4954
<h2>Home Assistant Dashboard</h2>
5055
<figure>
51-
<img src="images/rpi-cpu2mqtt-hass.jpg" alt="Home Assistant dashboard" />
56+
<img src="images/hass-dashboard.png" alt="Home Assistant dashboard" />
5257
</figure>
5358
</main>
5459
</div>

docs/images/configurator.png

15 KB
Loading

docs/images/hass-dashboard.png

27.2 KB
Loading

docs/images/hass-view.png

73.3 KB
Loading

images/configurator.png

15 KB
Loading

images/hass-dashboard.png

27.2 KB
Loading

images/hass-view.png

33.8 KB
Loading

0 commit comments

Comments
 (0)