From 9024402a3b4cda0e7032a3ee53aa5060d95fcf8f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mario=20H=C3=BCttel?= Date: Sun, 30 Aug 2020 19:03:17 +0200 Subject: [PATCH] Issue #17: Write documentation for emulation function --- doc/source/usage/command-line.rst | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) diff --git a/doc/source/usage/command-line.rst b/doc/source/usage/command-line.rst index e00c623..a7214f9 100644 --- a/doc/source/usage/command-line.rst +++ b/doc/source/usage/command-line.rst @@ -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. 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 +========== ================================