add on-screen keyboard for X11 and wayland

Author: sailoog

.gitignore

@@ -4,4 +4,5 @@ debian/*debhelper*
 debian/files
 debian/*.substvars
 .pybuild/
-*/__pycache__/
+*/__pycache__/
+build/

bin/toggle-wvkbd

@@ -0,0 +1,18 @@
+#!/bin/bash
+#This script toggle the virtual keyboard
+
+PID="$(pidof wvkbd-mobintl)"
+if [  "$PID" != ""  ]; then
+  killall wvkbd-mobintl
+else
+ wvkbd-mobintl
+# use wvkbd-mobintl --help for options
+#
+# -L 300 = landscape, 300 pixels tall
+# -fg ffffff = foreground color white
+# -fg-sp ffffff = special keys foreground white
+# -text 000000 = text color black
+# -text-sp 000000 = special keys text color black
+# -fn 40 = font size 40
+
+fi

debian/control

@@ -10,6 +10,6 @@ X-Python3-Version: >= 3.2
 Package: openplotter-settings
 Architecture: all
 Multi-Arch: foreign
-Depends: ${misc:Depends}, ${python3:Depends}, python3-wxgtk4.0, python3-ujson, python3-pyudev, vlc, matchbox-keyboard
+Depends: ${misc:Depends}, ${python3:Depends}, python3-wxgtk4.0, python3-ujson, python3-pyudev, vlc, matchbox-keyboard, wvkbd
 Description: Main OpenPlotter app
  Main OpenPlotter app

openplotterSettings/openplotterSettings.py

@@ -218,6 +218,9 @@ def pageGeneral(self):
 			self.toolbar3.ToggleTool(303,True)
 			self.Maximize()
 
+		out = subprocess.check_output('echo $XDG_SESSION_TYPE', shell=True).decode(sys.stdin.encoding)
+		if 'wayland' in out: self.toolbar10.EnableTool(1001,False)
+
 		delay = self.conf.get('GENERAL', 'delay')
 		if delay:
 			self.delay.SetValue(delay)
@@ -242,7 +245,9 @@ def OnToolFile(self,e):
 
 	def OnToolMatchbox(self,e=0):
 		subprocess.call(['pkill', '-f', 'matchbox-keyboard'])
-		subprocess.Popen('matchbox-keyboard')
+		out = subprocess.check_output('echo $XDG_SESSION_TYPE', shell=True).decode(sys.stdin.encoding)
+		if 'wayland' in out: subprocess.Popen('toggle-wvkbd')
+		else: subprocess.Popen('matchbox-keyboard')
 
 	def OnToolKeyboards(self,e=0):
 		if self.keyboardsList.GetSelection() == -1: return
@@ -797,7 +802,7 @@ def OnToolWayland(self,e):
 			msg += _('OpenPlotter will reboot. Are you sure?')
 			dlg = wx.MessageDialog(None, msg, _('Question'), wx.YES_NO | wx.NO_DEFAULT | wx.ICON_EXCLAMATION)
 			if dlg.ShowModal() == wx.ID_YES: 
-				subprocess.call([self.platform.admin, 'raspi-config', 'nonint', 'do_wayland', 'W2'])
+				subprocess.call([self.platform.admin, 'python3', self.currentdir+'/wayland.py', 'W2'])
 				out = subprocess.check_output('raspi-config nonint get_vnc', shell=True).decode(sys.stdin.encoding)
 				if '0' in out: self.conf.set('GENERAL', 'forceVNC', '1')
 				os.system('shutdown -r now')
@@ -810,7 +815,7 @@ def OnToolWayland(self,e):
 			msg += _('OpenPlotter will reboot. Are you sure?')
 			dlg = wx.MessageDialog(None, msg, _('Question'), wx.YES_NO | wx.NO_DEFAULT | wx.ICON_EXCLAMATION)
 			if dlg.ShowModal() == wx.ID_YES: 
-				subprocess.call([self.platform.admin, 'raspi-config', 'nonint', 'do_wayland', 'W1'])
+				subprocess.call([self.platform.admin, 'python3', self.currentdir+'/wayland.py', 'W1'])
 				out = subprocess.check_output('raspi-config nonint get_vnc', shell=True).decode(sys.stdin.encoding)
 				if '0' in out: self.conf.set('GENERAL', 'forceVNC', '1')
 				os.system('shutdown -r now')

openplotterSettings/startup.py

@@ -249,18 +249,20 @@ def starting(self):
 				self.add_logger_data({'green':'','black':_('disabled'),'red':''})
 		except Exception as e: self.add_logger_data({'green':'','black':'','red':str(e)})
 
-		self.add_logger_data(_('Checking virtual keyboard...'))
-		currentKeyboard = self.conf.get('GENERAL', 'keyboard')
-		if currentKeyboard: self.add_logger_data({'green':'','black':currentKeyboard,'red':''})
-		else:
-			try:
-				folder = self.conf.home+'/.matchbox'
-				if not os.path.exists(folder): os.mkdir(folder)
-				os.system('cp -f '+self.currentdir+'/data/keyboards/keyboard-EN.xml '+folder+'/keyboard.xml')
-				self.conf.set('GENERAL', 'keyboard', 'keyboard-EN.xml')
-				self.add_logger_data({'green':'','black':'keyboard-EN.xml','red':''})
-			except Exception as e: 
-				self.add_logger_data({'green':'','black':'','red':str(e)})
+		out = subprocess.check_output('echo $XDG_SESSION_TYPE', shell=True).decode(sys.stdin.encoding)
+		if not 'wayland' in out:
+			self.add_logger_data(_('Checking virtual keyboard...'))
+			currentKeyboard = self.conf.get('GENERAL', 'keyboard')
+			if currentKeyboard: self.add_logger_data({'green':'','black':currentKeyboard,'red':''})
+			else:
+				try:
+					folder = self.conf.home+'/.matchbox'
+					if not os.path.exists(folder): os.mkdir(folder)
+					os.system('cp -f '+self.currentdir+'/data/keyboards/keyboard-EN.xml '+folder+'/keyboard.xml')
+					self.conf.set('GENERAL', 'keyboard', 'keyboard-EN.xml')
+					self.add_logger_data({'green':'','black':'keyboard-EN.xml','red':''})
+				except Exception as e: 
+					self.add_logger_data({'green':'','black':'','red':str(e)})
 
 		if self.isRPI:
 			self.add_logger_data(_('Checking backlight...'))

openplotterSettings/wayland.py

@@ -0,0 +1,37 @@
+#!/usr/bin/env python3
+
+# This file is part of OpenPlotter.
+# Copyright (C) 2023 by Sailoog <https://github.com/openplotter/openplotter-settings>
+#
+# Openplotter is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 2 of the License, or
+# any later version.
+# Openplotter is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with Openplotter. If not, see <http://www.gnu.org/licenses/>.
+
+import subprocess, os, sys
+
+subprocess.call(['raspi-config', 'nonint', 'do_wayland', sys.argv[1]])
+
+if sys.argv[1] == 'W2': command = 'toggle-wvkbd'
+if sys.argv[1] == 'W1': command = 'matchbox-keyboard'
+
+shortcut = '/usr/share/applications/inputmethods/matchbox-keyboard.desktop'
+if os.path.exists(shortcut):
+	file = open(shortcut, 'r')
+	file2 = ''
+	while True:
+		line = file.readline()
+		if not line: break
+		if 'Exec=' in line: file2 += 'Exec='+command+'\n'
+		else: file2 += line
+	file.close()
+	file1 = open(shortcut, 'w')
+	file1.write(file2)
+	file1.close()

setup.py

@@ -33,6 +33,7 @@
 	'Programming Language :: Python :: 3'],
 	include_package_data=True,
 	entry_points={'console_scripts': ['openplotter-settings=openplotterSettings.openplotterSettings:main','openplotter-startup=openplotterSettings.startup:main','openplotterPostInstall=openplotterSettings.postInstall:main','settingsPreUninstall=openplotterSettings.settingsPreUninstall:main','settingsSourcesInstall=openplotterSettings.installSources:main']},
+	scripts=['bin/toggle-wvkbd'],
 	data_files=[('share/applications', ['openplotterSettings/data/openplotter-settings.desktop','openplotterSettings/data/openplotter-check.desktop']),('share/pixmaps', ['openplotterSettings/data/openplotter-settings.png', 'openplotterSettings/data/openplotter-48.png', 'openplotterSettings/data/openplotter-check.png', 'openplotterSettings/data/brightness-48.png']),
 	('share/sounds/openplotter', ['openplotterSettings/data/sounds/Bleep.mp3',
 									'openplotterSettings/data/sounds/House_Fire_Alarm.mp3',