doc/sim: Add Documentation about SIM Input

This commit adds basic information about SIM Input support.

Signed-off-by: Alan C. Assis <acassis@gmail.com>
This commit is contained in:
Alan Carvalho de Assis
2026-08-12 14:08:34 -03:00
committed by Alan C. Assis
parent e2ab02d368
commit 42ac826a4c
2 changed files with 39 additions and 0 deletions
+1
View File
@@ -15,3 +15,4 @@ The following Simulator/Emulators are supported:
network_linux
network_vpnkit
sim_gpiochip
sim_input
+38
View File
@@ -0,0 +1,38 @@
====================
Sim Input Interfaces
====================
Overview
========
The Sim can emulate buttons, keyboard, touchscreen-mouse based, mouse with 3 buttons and analog-mouse based joystick.
These drivers are particularly useful for graphical applications emulared over X11.
Buttons
=======
This driver emulates a button using the user Mouse button. You can enable it using
``CONFIG_SIM_BUTTONS``.
Joystick
========
This driver simulates an Analog Joystick using the user mouse.
Keyboard
========
There are two types of keyboards: is native one used by default on NuttX SIM, since it is used to access the NuttShell interface and the ``CONFIG_SIM_KEYBOARD`` used with graphical applications.
Mouse
=====
The driver emulates a Mouse with 3 buttons support. It can be enabled using the
symbol: ``CONFIG_SIM_MOUSE``. This driver is useful with used with more advanced interfaces like Microwindow/Nano-X that require at least left and right click buttons events.
Touchscreen
===========
The difference between this driver and the Mouse is because this only generates a pen-down event when the user click in the interface. It is useful to use with LVGL graphic interface.