feat(UI): add mouse and keyboard support to T113

AndyEveritt · AndyEveritt · commit 888c56724be9 · 2026-02-09T15:43:51.000Z
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -278,11 +278,20 @@ endif()
 target_compile_definitions(DuetScreen.lib PUBLIC MULTITHREADED)
 
 if(PROCESSOR STREQUAL "T113")
+  pkg_check_modules(XKBCOMMON xkbcommon)
   target_compile_definitions(lvgl PUBLIC 
                                   LV_USE_LINUX_FBDEV=1
                                   LV_USE_EVDEV=1
                                   LV_LINUX_FBDEV_RENDER_MODE=LV_DISPLAY_RENDER_MODE_DIRECT
                                   LV_LINUX_FBDEV_BUFFER_COUNT=2)
+  if(XKBCOMMON_FOUND)
+    message(STATUS "xkbcommon found: enabling XKB support for evdev")
+    target_compile_definitions(lvgl PUBLIC LV_EVDEV_XKB=1)
+    target_link_libraries(lvgl PUBLIC ${XKBCOMMON_LIBRARIES})
+    target_include_directories(lvgl PUBLIC ${XKBCOMMON_INCLUDE_DIRS})
+  else()
+    message(STATUS "xkbcommon not found: evdev keyboard support will be disabled")
+  endif()
                                   # add_compile_definitions(T113=1)
   
   target_compile_definitions(DuetScreen.lib PUBLIC T113=1)
diff --git a/assets/i18n/en-GB.json b/assets/i18n/en-GB.json
@@ -260,6 +260,7 @@
       "firmware_version": "Firmware Version:",
       "font": "Font",
       "icons": "Icons",
+      "keyboard_layout": "USB Keyboard Layout:",
       "language": "Language:",
       "language_en": "English",
       "notification_auto_close_error": "Do not close error messages automatically:",
diff --git a/libraries/lvgl b/libraries/lvgl
@@ -1 +1 @@
-Subproject commit fdff247adb3254b0ce37405d6bc4f812e6d8e7fa
+Subproject commit 2aee9698bf34af2206025fa9b78574214badc1e3
diff --git a/libraries/lvgl.cmake b/libraries/lvgl.cmake
@@ -32,6 +32,7 @@ if(CMAKE_BUILD_TYPE STREQUAL "Debug")
   target_compile_definitions(lvgl PUBLIC
                               # LV_USE_ASSERT_OBJ=1 # significantly increases unit test time and decreases frame rate
                               LV_USE_LOG=1
+                              LV_LOG_LEVEL=LV_LOG_LEVEL_WARN
                               LV_LOG_PRINTF=1
                               LV_USE_SYSMON=1
                               LV_USE_PERF_MONITOR=1
diff --git a/src/CMakeLists.txt b/src/CMakeLists.txt
@@ -7,12 +7,8 @@ target_sources(
           ${CMAKE_CURRENT_SOURCE_DIR}/Debug.cpp
           ${CMAKE_CURRENT_SOURCE_DIR}/LockWrapper.cpp
           ${CMAKE_CURRENT_SOURCE_DIR}/Storage.cpp
-          ${CMAKE_CURRENT_SOURCE_DIR}/DebugCommands.cpp)
-
-if(PROCESSOR STREQUAL "Simulation")
-  target_sources(DuetScreen.lib
-                 PRIVATE ${CMAKE_CURRENT_SOURCE_DIR}/mouse_cursor_icon.c)
-endif()
+          ${CMAKE_CURRENT_SOURCE_DIR}/DebugCommands.cpp
+          ${CMAKE_CURRENT_SOURCE_DIR}/mouse_cursor_icon.c)
 
 add_subdirectory(Comm)
 add_subdirectory(Hardware)
diff --git a/src/Comm/Usb.cpp b/src/Comm/Usb.cpp
@@ -596,7 +596,8 @@ namespace Comm
 		case UsbMode::InternalWiFi:
 			setUsbHost(true);
 			setUsbMux(false);
-			setUsbState(false);
+			setUsbState(false); /* probably `false` because smart USB chargers reset the screen in wifi mode if the
+								   state pin doesn't signal device mode */
 			NetworkHelper::enable(true);
 			break;
 		default:
diff --git a/src/Storage.cpp b/src/Storage.cpp
@@ -51,6 +51,7 @@ constexpr StorageKey<speed_t> ID_DUET_BAUD_RATE = {"duet:baud_rate", DEFAULT_BAU
 constexpr StorageKey<size_t> ID_THEME = {"ui:theme", std::numeric_limits<size_t>::max()};
 constexpr StorageKey<std::string_view> ID_FONT = {"ui:font", "OpenSans"};
 constexpr StorageKey<std::string_view> ID_ICON_FOLDER = {"ui:icon_folder", DEFAULT_ICON_SET};
+constexpr StorageKey<std::string_view> ID_KEYBOARD_LAYOUT = {"ui:keyboard_layout", "us"};
 
 constexpr StorageKey<bool> ID_SCREENSAVER_ENABLE = {"ui:screensaver_enable", true};
 constexpr StorageKey<std::chrono::seconds> ID_SCREENSAVER_TIMEOUT = {"ui:screensaver_timeout", DEFAULT_SCREEN_TIMEOUT};
diff --git a/src/Storage.h b/src/Storage.h
@@ -134,6 +134,7 @@ extern const StorageKey<speed_t> ID_DUET_BAUD_RATE;
 extern const StorageKey<size_t> ID_THEME;
 extern const StorageKey<std::string_view> ID_FONT;
 extern const StorageKey<std::string_view> ID_ICON_FOLDER;
+extern const StorageKey<std::string_view> ID_KEYBOARD_LAYOUT;
 
 extern const StorageKey<bool> ID_SCREENSAVER_ENABLE;
 extern const StorageKey<std::chrono::seconds> ID_SCREENSAVER_TIMEOUT;
diff --git a/src/UI/Components/Input/DropdownMenu.cpp b/src/UI/Components/Input/DropdownMenu.cpp
@@ -83,12 +83,6 @@ namespace UI
 		m_dropdown.clearText();
 	}
 
-	void DropdownMenu::setOptions(std::span<std::string> options)
-	{
-		ZoneScoped;
-		m_dropdown.setOptions(options);
-	}
-
 	void DropdownMenu::addOption(const std::string& option, uint32_t pos)
 	{
 		ZoneScoped;
diff --git a/src/UI/Components/Input/DropdownMenu.h b/src/UI/Components/Input/DropdownMenu.h
@@ -28,7 +28,13 @@ namespace UI
 		LvLabel& getLabel() { return m_label; }
 		LvDropdown& getDropdownMenu() { return m_dropdown; }
 
-		void setOptions(std::span<std::string> options);
+		template <typename T>
+			requires std::convertible_to<T, std::string_view>
+		void setOptions(std::span<T> options)
+		{
+			ZoneScoped;
+			m_dropdown.setOptions(options);
+		}
 		void addOption(const std::string& option, uint32_t pos = LV_DROPDOWN_POS_LAST);
 		void clearOptions();
 		void setSelected(uint32_t selected);
diff --git a/src/UI/Components/LVGL/LvDropdown.cpp b/src/UI/Components/LVGL/LvDropdown.cpp
@@ -12,31 +12,19 @@ namespace UI
 {
 	void LvDropdown::setText(const std::string& text)
 	{
+		ZoneScoped;
 		LvDropdownGen::setText(text.c_str());
 	}
 
 	void LvDropdown::clearText()
 	{
+		ZoneScoped;
 		LvDropdownGen::setText(nullptr);
 	}
 
-	void LvDropdown::setOptions(std::span<std::string> options)
-	{
-		UI_LOCK();
-		std::string opt;
-		for (const auto& option : options)
-		{
-			opt += option;
-			if (&option != &options.back())
-			{
-				opt += "\n";
-			}
-		}
-		LvDropdownGen::setOptions(opt.c_str());
-	}
-
 	bool LvDropdown::setSelected(const std::string& option)
 	{
+		ZoneScoped;
 		UI_LOCK();
 		int32_t index = getOptionIndex(option);
 		if (index < 0)
@@ -55,6 +43,7 @@ namespace UI
 
 	std::string LvDropdown::getSelectedString() const
 	{
+		ZoneScoped;
 		UI_LOCK();
 		char buf[64];
 		LvDropdownGen::getSelectedStr(buf, sizeof(buf));
diff --git a/src/UI/Components/LVGL/LvDropdown.h b/src/UI/Components/LVGL/LvDropdown.h
@@ -23,7 +23,24 @@ namespace UI
 		void setText(const std::string& text);
 		void clearText();
 
-		void setOptions(std::span<std::string> options);
+		template <typename T>
+			requires std::convertible_to<T, std::string_view>
+		void setOptions(std::span<T> options)
+		{
+			ZoneScoped;
+			UI_LOCK();
+			std::string opt;
+			for (const auto& option : options)
+			{
+				opt += option;
+				if (&option != &options.back())
+				{
+					opt += "\n";
+				}
+			}
+			LvDropdownGen::setOptions(opt.c_str());
+		}
+
 		void addOption(const std::string& option, uint32_t pos) { LvDropdownGen::addOption(option.c_str(), pos); }
 		using LvDropdownGen::setSelected;
 		bool setSelected(const std::string& option);
diff --git a/src/UI/Screens/Settings/SettingsView.cpp b/src/UI/Screens/Settings/SettingsView.cpp
@@ -13,11 +13,43 @@
 #include "utils/StorageHelper.h"
 #include "utils/SystemHelper.h"
 #include "version.h"
+#include <ranges>
 
 #define USE_MODAL_NUMBERPAD_FOR_IP_ADDRESS 1
 
 namespace UI
 {
+	struct KeyboardLayout
+	{
+		std::string_view name;
+		std::string_view code;
+		const char* variant = nullptr;
+	};
+
+	/**
+	 * @brief List of common keyboard layouts with their XKB layout codes and variants where applicable
+	 *
+	 * @note It doesn't make sense to translate the layout names since they are only relevant when the user is familar
+	 * with that language. Each layout name should be easily readable by a user familiar with the language it is
+	 * relevant to
+	 */
+	static constexpr std::array s_keyboardLayouts = {
+		KeyboardLayout{.name = "US (QWERTY)", .code = "us"},
+		KeyboardLayout{.name = "UK (QWERTY)", .code = "gb"},
+		KeyboardLayout{.name = "Deutsch (QWERTZ)", .code = "de"},
+		KeyboardLayout{.name = "Français (AZERTY)", .code = "fr"},
+		KeyboardLayout{.name = "Español", .code = "es"},
+		KeyboardLayout{.name = "Italiano", .code = "it"},
+		KeyboardLayout{.name = "Svenska", .code = "se"},
+		KeyboardLayout{.name = "Norsk", .code = "no"},
+		KeyboardLayout{.name = "Dansk", .code = "dk"},
+		KeyboardLayout{.name = "Nederlands", .code = "nl"},
+		KeyboardLayout{.name = "Português", .code = "pt"},
+		KeyboardLayout{.name = "Polski", .code = "pl"},
+		KeyboardLayout{.name = "Čeština", .code = "cz"},
+		KeyboardLayout{.name = "US Dvorak", .code = "us", .variant = "dvorak"},
+	};
+
 	static void onTextareaEvent(lv_event_t* e, TextBox& text_box, lv_keyboard_mode_t mode);
 
 	static void setSliderNumberpadLabel(Slider& slider, std::string_view label)
@@ -175,9 +207,55 @@ namespace UI
 		m_language.setHeight(LV_SIZE_CONTENT);
 		{
 			std::array languages = {_("settings.language_en")};
-			m_language.setOptions(languages);
+			m_language.setOptions<std::string>(languages);
 		}
 
+		/* Keyboard Layout */
+		createRow(_("settings.keyboard_layout"), m_keyboardLayout);
+		m_keyboardLayout.setHeight(LV_SIZE_CONTENT);
+		{
+			// Common keyboard layouts with their XKB layout codes
+			std::array<std::string_view, s_keyboardLayouts.size()> layoutNames;
+			std::ranges::transform(
+				s_keyboardLayouts, layoutNames.begin(), [](const KeyboardLayout& kl) { return kl.name; });
+			m_keyboardLayout.setOptions<std::string_view>(layoutNames);
+		}
+		m_keyboardLayout.setSelectedCallback(
+			[](uint32_t index, std::string_view /* option */)
+			{
+				if (index >= s_keyboardLayouts.size())
+					return;
+
+				std::string_view layoutCode = s_keyboardLayouts.at(index).code;
+				const char* variant = s_keyboardLayouts.at(index).variant;
+
+				LOG_INFO("Selected keyboard layout: {} (code: {}, variant: {})",
+						 s_keyboardLayouts.at(index).name,
+						 layoutCode,
+						 variant ? variant : "none");
+
+				// Save to storage
+				StorageHelper::setData(ID_KEYBOARD_LAYOUT, layoutCode);
+
+#if LV_USE_EVDEV && LV_EVDEV_XKB
+				// Apply to all keyboard input devices
+				struct xkb_rule_names names = {.rules = nullptr,
+											   .model = "pc105",
+											   .layout = layoutCode.data(),
+											   .variant = variant,
+											   .options = nullptr};
+
+				lv_indev_t* indev = nullptr;
+				while ((indev = lv_indev_get_next(indev)) != nullptr)
+				{
+					if (lv_indev_get_type(indev) == LV_INDEV_TYPE_KEYPAD)
+					{
+						lv_evdev_set_keymap(indev, names);
+					}
+				}
+#endif
+			});
+
 		/* Brightness */
 		createRow(_("settings.brightness"), m_brightness);
 		setSliderNumberpadLabel(m_brightness, _("settings.brightness"));
@@ -260,6 +338,21 @@ namespace UI
 		m_notificationLevel.setSelected(static_cast<uint32_t>(StorageHelper::getData(ID_NOTIFICATION_LEVEL)));
 		m_notificationTimeout.setValue(static_cast<float>(StorageHelper::getData(ID_NOTIFICATION_TIMEOUT).count()));
 		m_notificationAutoCloseError.setChecked(!StorageHelper::getData(ID_NOTIFICATION_AUTO_CLOSE_ERROR));
+
+		// Update keyboard layout selection
+		{
+			auto currentLayout = StorageHelper::getData(ID_KEYBOARD_LAYOUT);
+			uint32_t selectedIndex = 0;
+			for (size_t i = 0; i < s_keyboardLayouts.size(); ++i)
+			{
+				if (s_keyboardLayouts.at(i).code == currentLayout)
+				{
+					selectedIndex = static_cast<uint32_t>(i);
+					break;
+				}
+			}
+			m_keyboardLayout.setSelected(selectedIndex);
+		}
 	}
 
 	ConnectionSettings::ConnectionSettings(const std::string& name, LvObj& parent)
@@ -274,7 +367,7 @@ namespace UI
 			options.push_back(_(method.data()));
 		}
 		m_connectionMethod.setHeight(LV_SIZE_CONTENT);
-		m_connectionMethod.setOptions(options);
+		m_connectionMethod.setOptions<std::string>(options);
 		m_connectionMethod.addEventCallback(
 			[this](lv_event_t*)
 			{
@@ -306,7 +399,7 @@ namespace UI
 				_("settings.usb_mode_device"),
 				_("settings.usb_mode_internal_wifi"),
 			};
-			m_usbMode.setOptions(usbModeOptions);
+			m_usbMode.setOptions<std::string>(usbModeOptions);
 		}
 		m_usbMode.setSelectedCallback([this](uint32_t index, std::string_view /* option */)
 									  { setUsbMode(Comm::UsbMode(index)); });
diff --git a/src/UI/Screens/Settings/SettingsView.h b/src/UI/Screens/Settings/SettingsView.h
@@ -52,6 +52,7 @@ namespace UI
 		/* General */
 		LvLabel m_buildTime{"build_time", getRoot()};
 		DropdownMenu m_language{"language", getRoot()};
+		DropdownMenu m_keyboardLayout{"keyboard_layout", getRoot()};
 		Slider m_brightness{"brightness", getRoot()};
 		Slider m_screensaverTimeout{"screensaver_timeout", getRoot()};
 		LvSettingsToggle m_showConfirmationDialogs{"show_confirmation_dialogs", getRoot()};
diff --git a/src/UI/Widgets/Filament/Dropdown/FilamentSelectDropdown.cpp b/src/UI/Widgets/Filament/Dropdown/FilamentSelectDropdown.cpp
@@ -66,7 +66,7 @@ namespace UI
 		}
 		else
 		{
-			m_selection.setOptions(m_filamentOptions);
+			m_selection.setOptions<std::string>(m_filamentOptions);
 		}
 		// m_selection.setText(disabled ? "" : m_loadedFilament);
 	}
@@ -77,7 +77,7 @@ namespace UI
 		UI_LOCK();
 		LOG_DBG("Setting filament options for {}", getName());
 		m_filamentOptions = options;
-		m_selection.setOptions(m_filamentOptions);
+		m_selection.setOptions<std::string>(m_filamentOptions);
 	}
 
 	void FilamentSelectDropdown::setFilamentSelected(const std::string& filament, bool forceUpdate)
diff --git a/src/main.cpp b/src/main.cpp
diff --git a/tests/ref_imgs/home_view/settings_view/general.png b/tests/ref_imgs/home_view/settings_view/general.png
diff --git a/tests/ref_imgs/home_view/settings_view/initial.png b/tests/ref_imgs/home_view/settings_view/initial.png

Original file line number	Diff line number	Diff line change
`@@ -83,12 +83,6 @@ namespace UI`
`83`	`83`	`m_dropdown.clearText();`
`84`	`84`	`}`
`85`	`85`
`86`		`- void DropdownMenu::setOptions(std::span<std::string> options)`
`87`		`- {`
`88`		`- ZoneScoped;`
`89`		`- m_dropdown.setOptions(options);`
`90`		`- }`
`91`		`-`
`92`	`86`	`void DropdownMenu::addOption(const std::string& option, uint32_t pos)`
`93`	`87`	`{`
`94`	`88`	`ZoneScoped;`