Skip to content

Commit 9f3e64a

Browse files
committed
✏️ Add some explainers to make usage easier
See #20
1 parent 8a6d8bf commit 9f3e64a

File tree

4 files changed

+30
-10
lines changed

4 files changed

+30
-10
lines changed

octoprint_wled/static/src/wled.scss

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -112,6 +112,10 @@ $animation-duration: 0.3s;
112112
d-block {
113113
display: block;
114114
}
115+
.visibility-collapse {
116+
visibility: collapse;
117+
}
118+
115119

116120
.effect-overview {
117121
margin-left: 1.5rem;

octoprint_wled/templates/wled-settings/features.jinja2

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,12 @@
2424
</tr>
2525
{% endmacro %}
2626

27+
<p>
28+
Enable some optional features for the plugin here.
29+
</p>
30+
2731
<table class="table">
28-
<thead>
32+
<thead class="visibility-collapse">
2933
<tr>
3034
<th class="colwidth-10"></th> {# These widths have been carefully fine tuned... Try not to break them :) #}
3135
<th class="colwidth-80"></th>
Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,12 @@
11
{% import "wled-settings/sub/template.jinja2" as template %}
2-
2+
<p>
3+
Enable the events you want the plugin to react to below, then add effect configurations for each event.
4+
</p>
5+
<p>
6+
Segments need to be configured in WLED for the plugin to be able to use them.
7+
</p>
38
<table class="table">
4-
<thead>
9+
<thead class="visibility-collapse">
510
<tr>
611
<th class="colwidth-10"></th> {# These widths have been carefully fine tuned... Try not to break them :) #}
712
<th class="colwidth-35"></th>
@@ -12,11 +17,11 @@
1217
</tr>
1318
</thead>
1419
<tbody>
15-
{{ template.effectOverview("idle", "Idle", "Fires when the printer is connected.") }}
20+
{{ template.effectOverview("idle", "Idle (Connected)", "Fires when the printer is connected.") }}
1621
{{ template.effectOverview("disconnected", "Disconnected") }}
1722
{{ template.effectOverview("started", "Print Started") }}
18-
{{ template.effectOverview("failed", "Failed") }}
19-
{{ template.effectOverview("success", "Success") }}
20-
{{ template.effectOverview("paused", "Paused") }}
23+
{{ template.effectOverview("failed", "Print Failed") }}
24+
{{ template.effectOverview("success", "Print Success") }}
25+
{{ template.effectOverview("paused", "Print Paused") }}
2126
</tbody>
2227
</table>

octoprint_wled/templates/wled-settings/progress.jinja2

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -49,15 +49,22 @@
4949
<input id="ws_temp_threshold" class="input-small" type="number" data-bind="value: settingsViewModel.settings.plugins.wled.progress.cooling.threshold">
5050
<span class="add-on">C</span>
5151
</div>
52-
{# TODO add some explanation or docs #}
52+
<p class="d-block">
53+
Cooling progress will stop once the temperature gets to this value.
54+
</p>
5355
</td>
5456
<td></td>
5557
</tr>
5658
{% endmacro %}
57-
59+
<p>
60+
Progress effects simulate a progress bar, with two colours. Progress is shown per-segment.
61+
</p>
62+
<p>
63+
You can customize the colours and some additional configuration for each event type.
64+
</p>
5865

5966
<table class="table">
60-
<thead>
67+
<thead class="visibility-collapse">
6168
<tr>
6269
<th class="colwidth-10"></th> {# These widths have been carefully fine tuned... Try not to break them :) #}
6370
<th class="colwidth-35"></th>

0 commit comments

Comments
 (0)