Maintenance commit:

- Added some documentation,
- Made modifications  to the build scripts to build the UX on Windows, Linux & MacOS.
- Updated OTD.EnhancedOutputMode so that touch & this plugin can be used at the same time

.vscode/settings.json

@@ -0,0 +1,3 @@
+{
+    "dotnet.defaultSolution": "Wheel-Addon.sln"
+}

Directory.Build.props

@@ -1,6 +1,6 @@
 <Project>
   <PropertyGroup>
     <Nullable>enable</Nullable>
-    <AvaloniaVersion>11.0.0</AvaloniaVersion>
+    <AvaloniaVersion>11.0.10</AvaloniaVersion>
   </PropertyGroup>
 </Project>

README.md

@@ -1,6 +1,6 @@
 # Wheel Addon
 
-A plugin for OTD that add support for the touch wheel present in some Wacom tablets
+A plugin for OTD that add support for the Absolute Touch Wheel present in some Wacom tablets
 
 ## Supported Versions
 

TODO.md

@@ -1,4 +1,12 @@
-# TODO
+## TODO
 
-- Installer
-- README.md
+- 2 Way communication between plugin & UX (server on both ends)
+    - Plugin pipe name : WheelDaemon,
+    - UX pipe name : WheelDaemonUX
+- Profiles
+- Notifications on :
+    - Profile changes,
+    - Successful Apply,
+    - Successful Save
+- LED blink on profile change (PTHs)
+- Display changes on profile changes (PTKs)

Wheel-Addon.UX/Controls/BindingDisplay.axaml.cs

@@ -1,15 +1,13 @@
 using System;
-using Avalonia;
 using Avalonia.Controls;
-using OpenTabletDriver.Desktop.Reflection;
 using WheelAddon.UX.ViewModels;
 using WheelAddon.UX.Views;
 
 namespace WheelAddon.UX.Controls
 {
     public partial class BindingDisplay : UserControl
     {
-        private string? _description;
+        /*private string? _description;
         private PluginSettingStore? _store;
 
         // --------------------------------- Description --------------------------------- //
@@ -38,7 +36,7 @@ public PluginSettingStore? Store
         {
             get => _store;
             set => this.SetAndRaise(StoreProperty, ref _store, value);
-        }
+        }*/
 
         // --------------------------------- Constructor --------------------------------- //
 
@@ -60,7 +58,7 @@ protected override void OnDataContextChanged(EventArgs e)
 
         private void ShowBindingEditorDialog(object? sender, BindingDisplayViewModel e)
         {
-            if (this.DataContext is BindingDisplayViewModel vm)
+            if (DataContext is BindingDisplayViewModel vm)
             {
                 if (TopLevel.GetTopLevel(this) is MainWindow window)
                 {
@@ -71,7 +69,7 @@ private void ShowBindingEditorDialog(object? sender, BindingDisplayViewModel e)
 
         private void ShowAdvancedBindingEditorDialog(object? sender, BindingDisplayViewModel e)
         {
-            if (this.DataContext is BindingDisplayViewModel vm)
+            if (DataContext is BindingDisplayViewModel vm)
             {
                 if (TopLevel.GetTopLevel(this) is MainWindow window)
                 {

Wheel-Addon.UX/ViewLocator.cs

@@ -7,13 +7,12 @@ namespace WheelAddon.UX;
 
 public class ViewLocator : IDataTemplate
 {
-    public Control Build(object? data)
+    public Control? Build(object? data)
     {
         if (data is null)
             return null!;
 
         var name = data.GetType().FullName!.Replace("ViewModel", "View");
-
         var type = Type.GetType(name);
 
         if (type != null)

Wheel-Addon.UX/Views/MainWindow.axaml.cs

@@ -1,5 +1,6 @@
 using System.Collections.ObjectModel;
 using System.Linq;
+using System.Threading.Tasks;
 using Avalonia.Controls;
 using Avalonia.Threading;
 using WheelAddon.Lib.Serializables;
@@ -18,80 +19,84 @@ public MainWindow()
     public void ShowBindingEditorDialog(object? sender, BindingDisplayViewModel e)
     {
         // instantiate and show dialog on UI thread
-        Dispatcher.UIThread.Post(async () =>
+        _ = Dispatcher.UIThread.InvokeAsync(() => ShowBindingEditorDialogCore(e));
+    }
+
+    private async Task ShowBindingEditorDialogCore(BindingDisplayViewModel e)
+    {
+        if (DataContext is MainViewModel vm)
         {
-            if (DataContext is MainViewModel vm)
+            var dialog = new BindingEditorDialog()
+            {
+                DataContext = new BindingEditorDialogViewModel(),
+                Plugins = vm.Plugins
+            };
+
+            var res = await dialog.ShowDialog<SerializablePluginSettings>(this);
+
+            if (res == null)
+                return;
+
+            if (res.Identifier == -1 || res.Value == "None")
+            {
+                e.PluginProperty = null;
+                e.Content = "";
+            }
+            else
             {
-                var dialog = new BindingEditorDialog()
-                {
-                    DataContext = new BindingEditorDialogViewModel(),
-                    Plugins = vm.Plugins
-                };
-
-                var res = await dialog.ShowDialog<SerializablePluginSettings>(this);
-
-                if (res == null)
-                    return;
-
-                if (res.Identifier == -1 || res.Value == "None")
-                {
-                    e.PluginProperty = null;
-                    e.Content = "";
-                }
-                else
-                {
-                    e.PluginProperty = res;
-                    e.Content = vm.GetFriendlyContentFromProperty(res);
-                }
+                e.PluginProperty = res;
+                e.Content = vm.GetFriendlyContentFromProperty(res);
             }
-        });
+        }
     }
 
     public void ShowAdvancedBindingEditorDialog(object? sender, BindingDisplayViewModel e)
     {
         // instantiate and show dialog on UI thread
-        Dispatcher.UIThread.Post(async () =>
+        _ = Dispatcher.UIThread.InvokeAsync(() => ShowAdvancedBindingEditorDialogCore(e));
+    }
+
+    private async Task ShowAdvancedBindingEditorDialogCore(BindingDisplayViewModel e)
+    {
+        if (DataContext is MainViewModel vm)
         {
-            if (DataContext is MainViewModel vm)
+            var types = vm.Plugins.Select(p => p.PluginName ?? p.FullName ?? "Unknown").ToList();
+
+            var currentPlugin = vm.Plugins.FirstOrDefault(p => p.Identifier == e.PluginProperty?.Identifier);
+            var selectedType = currentPlugin?.PluginName ?? currentPlugin?.FullName ?? "Unknown";
+
+            var validProperties = currentPlugin?.ValidProperties ?? new string[0];
+            var selectedProperty = e.PluginProperty?.Value ?? "";
+
+            var dialogVM = new AdvancedBindingEditorDialogViewModel()
+            {
+                Types = new ObservableCollection<string>(types),
+                SelectedType = selectedType,
+                ValidProperties = new ObservableCollection<string>(validProperties),
+                SelectedProperty = selectedProperty
+            };
+
+            var dialog = new AdvancedBindingEditorDialog()
+            {
+                DataContext = dialogVM,
+                Plugins = vm.Plugins
+            };
+
+            var res = await dialog.ShowDialog<SerializablePluginSettings>(this);
+
+            if (res == null)
+                return;
+
+            if (res.Identifier == -1 || res.Value == "None")
+            {
+                e.PluginProperty = null;
+                e.Content = "";
+            }
+            else
             {
-                var types = vm.Plugins.Select(p => p.PluginName ?? p.FullName ?? "Unknown").ToList();
-                
-                var currentPlugin = vm.Plugins.FirstOrDefault(p => p.Identifier == e.PluginProperty?.Identifier);
-                var selectedType = currentPlugin?.PluginName ?? currentPlugin?.FullName ?? "Unknown";
-
-                var validProperties = currentPlugin?.ValidProperties ?? new string[0];
-                var selectedProperty = e.PluginProperty?.Value ?? "";
-
-                var dialogVM = new AdvancedBindingEditorDialogViewModel()
-                {
-                    Types = new ObservableCollection<string>(types),
-                    SelectedType = selectedType,
-                    ValidProperties = new ObservableCollection<string>(validProperties),
-                    SelectedProperty = selectedProperty
-                };
-
-                var dialog = new AdvancedBindingEditorDialog()
-                {
-                    DataContext = dialogVM,
-                    Plugins = vm.Plugins
-                };
-
-                var res = await dialog.ShowDialog<SerializablePluginSettings>(this);
-
-                if (res == null)
-                    return;
-
-                if (res.Identifier == -1 || res.Value == "None")
-                {
-                    e.PluginProperty = null;
-                    e.Content = "";
-                }
-                else
-                {
-                    e.PluginProperty = res;
-                    e.Content = vm.GetFriendlyContentFromProperty(res);
-                }
+                e.PluginProperty = res;
+                e.Content = vm.GetFriendlyContentFromProperty(res);
             }
-        });
+        }
     }
 }

Wheel-Addon.UX/Wheel-Addon.UX.csproj

@@ -1,7 +1,7 @@
 <Project Sdk="Microsoft.NET.Sdk">
   <PropertyGroup>
     <TargetFramework>net7.0</TargetFramework>
-    <NoWarn>NETSDK1138</NoWarn>
+    <NoWarn>NETSDK1138; VSTHRD200; VSTHRD100</NoWarn>
     <Nullable>enable</Nullable>
     <LangVersion>latest</LangVersion>
     <AvaloniaUseCompiledBindingsByDefault>true</AvaloniaUseCompiledBindingsByDefault>

Wheel-Addon/WheelDaemon.cs

@@ -110,6 +110,7 @@ public Task<bool> ApplyWheelBindings(SerializableSettings bindings)
 
             var serializableSimpleModeBindings = bindings.SimpleMode;
 
+            // Grab the plugin identifiers and values
             var clockwisePluginIdentifier = serializableSimpleModeBindings.Clockwise.PluginProperty?.Identifier;
             var counterClockwisePluginIdentifier = serializableSimpleModeBindings.CounterClockwise.PluginProperty?.Identifier;
 
@@ -146,13 +147,15 @@ public Task<bool> ApplyWheelBindings(SerializableSettings bindings)
 
             Settings.AdvancedMode.Clear();
 
+            // Grab the plugin identifiers and values for each advanced mode binding
             var serializableAdvancedModeBindings = bindings.AdvancedMode;
 
             foreach (var serializableAdvancedModeBinding in serializableAdvancedModeBindings)
             {
                 var pluginIdentifier = serializableAdvancedModeBinding.PluginProperty?.Identifier;
                 var pluginValue = serializableAdvancedModeBinding.PluginProperty?.Value;
 
+                // convert the advanced mode bindings
                 var advancedModeBinding = new RangedWheelBinding()
                 {
                     Store = pluginIdentifier != null ? 
@@ -161,6 +164,7 @@ public Task<bool> ApplyWheelBindings(SerializableSettings bindings)
                     End = serializableAdvancedModeBinding.End
                 };
 
+                // set the properties values of each stores settings
                 if (pluginIdentifier != null)
                     advancedModeBinding.Store?.Settings.SingleOrDefault(x => x.Property == "Property")!.SetValue(pluginValue!);
 
@@ -179,14 +183,17 @@ public Task<List<SerializablePlugin>> GetPlugins()
 
             List<SerializablePlugin> plugins = new();
 
+            // iterate through each plugin and add it to the list
             foreach (var IdentifierPluginPair in identifierToPlugin)
             {
                 var plugin = IdentifierPluginPair.Value;
 
                 var store = new PluginSettingStore(plugin);
 
+                // Construct the binding plugin so we can get the valid properties
                 var validateBinding = store.Construct<IValidateBinding>();
 
+                // Convert the plugin to a serializable plugin, so it can be transferred over RPC
                 var serializablePlugin = new SerializablePlugin(plugin.GetCustomAttribute<PluginNameAttribute>()?.Name, 
                                                                 plugin.FullName, 
                                                                 IdentifierPluginPair.Key, 
@@ -268,7 +275,9 @@ private void OnWheelReport(object? sender, IWheelReport report)
             if (report.Wheel > Settings.MaxWheelValue)
             {
                 Settings.MaxWheelValue = report.Wheel;
-                //WheelHandler.HandlerLog(this, NAME, $"New max wheel value: {Settings.MaxWheelValue}");
+#if DEBUG
+                WheelHandler.HandlerLog(this, NAME, $"New max wheel value: {Settings.MaxWheelValue}", LogLevel.Debug);
+#endif
             }
         }
 

Wheel-Addon/WheelHandler.cs

@@ -71,8 +71,10 @@ public void OnWheelUsed(object? sender, IWheelReport report)
             if (rpcServer.Instance.IsCalibrating || rpcServer.Instance.HasErrored)
                 return;
 
+            // Wheel isn't in use (anymore?)
             if (report.Wheel == -1)
             {
+                // We need a debounce mechanism to detect when the wheel is no longer in use
                 if (RemainingTouchesDebounce-- > 0)
                 {
                     LastValue = -1;
@@ -206,6 +208,7 @@ public void HandleSimpleModeAction(object? sender, bool isClockwise)
 
         public void HandleAdvancedMode(object? sender, IWheelReport report)
         {
+            // if the mode is not Advanced (true), return
             if (ModeToggle != true)
                 return;
 

build.ps1

@@ -30,7 +30,15 @@ Write-Output ""
 Write-Output "Building UX"
 Write-Output ""
 
-dotnet publish Wheel-Addon.UX.Desktop -c Release -r win-x64 --self-contained='false' -o ./build/win-x64
+dotnet publish Wheel-Addon.UX.Desktop -c Release -r win-x64 --self-contained='false' -o ./build/UX/win-x64
+dotnet publish Wheel-Addon.UX.Desktop -c Release -r win-x86 --self-contained='false' -o ./build/UX/win-x86
+dotnet publish Wheel-Addon.UX.Desktop -c Release -r win-arm64 --self-contained='false' -o ./build/UX/win-arm64
+
+dotnet publish Wheel-Addon.UX.Desktop -c Release -r linux-x64 --self-contained='false' -o ./build/UX/linux-x64
+dotnet publish Wheel-Addon.UX.Desktop -c Release -r linux-arm64 --self-contained='false' -o ./build/UX/linux-arm64
+
+dotnet publish Wheel-Addon.UX.Desktop -c Release -r osx-x64 --self-contained='false' -o ./build/UX/osx-x64
+dotnet publish Wheel-Addon.UX.Desktop -c Release -r osx-arm64 --self-contained='false' -o ./build/UX/osx-arm64
 
 if ($LASTEXITCODE -ne 0) {
     exit $LASTEXITCODE
@@ -52,6 +60,10 @@ Remove-Item ./build/installer/* -Recurse -Force
 
 Move-Item ./temp/installer/Wheel-Addon.Installer.dll ./build/installer/Wheel-Addon.Installer.dll
 
+# zip the installer
+
+Compress-Archive -Path ./build/installer/* -DestinationPath ./build/installer/Wheel-Addon.Installer.zip
+
 Remove-Item ./temp -Recurse -Force
 
 Write-Output ""