mhu/reflow-oven-control-sw
2
0
Fork 0
Code Issues 4 Pull Requests Releases 4 Wiki Activity

Issue #17: Write documentation for emulation function

Browse Source
This commit is contained in:
Mario Hüttel 2020-08-30 19:03:17 +02:00
parent f32d1afde5
commit 9024402a3b
1 changed files with 28 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
doc/source/usage/command-line.rst
View File

@ -58,3 +58,31 @@ Calibration is most likely not necessary! See the :ref:`usage_calibration` page.
The command will guide you through the calibration process and will ask for two reference resistors with ``1000 Ohm`` and ``2000 Ohm`` values. The command will guide you through the calibration process and will ask for two reference resistors with ``1000 Ohm`` and ``2000 Ohm`` values.
Calibration can be aborted using ``CTRL + C``. Calibration can be aborted using ``CTRL + C``.
.. _shell_command_hang:
hang
~~~~
The ``hang`` command hangs the main-loop in an infinite loop. This function tests, whether the controller is correctly rescued by the watchdog.
.. _shell_command_ui_emulate:
ui-emulate
~~~~~~~~~~
The ``ui-emulate`` command emulates the rotary encoder and button from the shell. The following keys are available:
========== ================================
Key Emulation
========== ================================
``CTRL+C`` Exit the command
``ENTER`` Button press: short released
``s`` Rotary Encoder: anti-clockwise
``w`` Rotary Encoder: clockwise
``l`` Button press: long
``k`` Button press: short
``r`` Button press: long released
========== ================================