Skip to content

Commit 549f400

Browse files
committed
docs/controllers/dinmeter: Add usage documentation for startup ui.
Signed-off-by: lbuque <[email protected]>
1 parent bcf687b commit 549f400

File tree

13 files changed

+204
-0
lines changed

13 files changed

+204
-0
lines changed
94.5 KB
Loading
115 KB
Loading
140 KB
Loading
70.8 KB
Loading
83 KB
Loading
89.7 KB
Loading
119 KB
Loading

docs/en/controllers/dinmeter.rst

Lines changed: 88 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,88 @@
1+
########
2+
DinMeter
3+
########
4+
5+
.. include:: ../refs/controllers.dinmeter.ref
6+
7+
**********
8+
Startup UI
9+
**********
10+
11+
.. NOTE::
12+
1. ``ENCODER`` is used for menu selection.
13+
2. ``BtnA`` is used to execute menu items.
14+
3. Long press ``BtnA`` to exit the application.
15+
4. ``CardKB Unit`` is used for input.
16+
17+
Launcher
18+
********
19+
20+
|launcher.png|
21+
22+
``ENCODER`` cycles through available applications.
23+
24+
``BtnA`` click to launch the selected application.
25+
26+
Setting
27+
*******
28+
29+
|setting.png|
30+
31+
``ENCODER`` cycles through available applications.
32+
33+
``BtnA`` click to launch the selected application.
34+
35+
Long press ``BtnA`` to exit the application.
36+
37+
WLAN
38+
====
39+
40+
|wlan.png|
41+
42+
``ENCODER`` selects the corresponding input box or button.
43+
44+
``BtnA`` click to perform the corresponding action.
45+
46+
Long press ``BtnA`` to exit the application.
47+
48+
General
49+
========
50+
51+
|general.png|
52+
53+
``ENCODER`` selects menu.
54+
55+
``BtnA`` click to set.
56+
57+
Long press ``BtnA`` to exit the application.
58+
59+
Develop
60+
*******
61+
62+
|develop.png|
63+
64+
Long press ``BtnA`` to exit the application.
65+
66+
APP.RUN
67+
*******
68+
69+
|apprun.png|
70+
71+
``ENCODER`` selects the corresponding action.
72+
73+
``BtnA`` click to run main.py according to the corresponding action.
74+
75+
Long press ``BtnA`` to exit the application.
76+
77+
APP.LIST
78+
********
79+
80+
|applist.png|
81+
82+
``ENCODER`` cycles through available applications.
83+
84+
``BtnA`` click to run the application once.
85+
86+
Double click ``BtnA`` to always run the application.
87+
88+
Long press ``BtnA`` to exit the application.

docs/en/controllers/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,3 +12,4 @@ Controllers
1212
coreink.rst
1313
airq.rst
1414
paper.rst
15+
dinmeter.rst

docs/en/refs/controllers.dinmeter.ref

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
.. |applist.png| image:: ../../_static/controllers/dinmeter/applist.png
2+
3+
.. |apprun.png| image:: ../../_static/controllers/dinmeter/apprun.png
4+
5+
.. |develop.png| image:: ../../_static/controllers/dinmeter/develop.png
6+
7+
.. |launcher.png| image:: ../../_static/controllers/dinmeter/launcher.png
8+
9+
.. |setting.png| image:: ../../_static/controllers/dinmeter/setting.png
10+
11+
.. |wlan.png| image:: ../../_static/controllers/dinmeter/wlan.png
12+
13+
.. |general.png| image:: ../../_static/controllers/dinmeter/general.png

0 commit comments

Comments
 (0)