Add console command

Author: minisbett

minitool/Commands/Console.cs

@@ -0,0 +1,95 @@
+using CommandLine.Text;
+using CommandLine;
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
+using minitool.Enums;
+using minitool.Models;
+using System.IO.Ports;
+
+namespace minitool.Commands;
+
+public static class Console_
+{
+  [Verb("console", HelpText = "Opens a raw command console for the specified minipad.")]
+  public class Options
+  {
+    [Value(0, Required = true, HelpText = "The port number of the minipad.")]
+    public int Port { get; private set; }
+    
+    public Options() { }
+  }
+
+  public static int Handle(Options options)
+  {
+    MinipadDevice device;
+    try
+    {
+      // Get the minipad device from the port.
+      device = MinipadHelper.GetDeviceAsync(options.Port).Result;
+    }
+    catch (Exception ex)
+    {
+      // If any error occured, output it to the user.
+      Console.ForegroundColor = ConsoleColor.Red;
+      Console.WriteLine($"Error: {ex.InnerException!.Message}");
+      Console.WriteLine(ex.InnerException!.StackTrace);
+      Console.ForegroundColor = ConsoleColor.Gray;
+      return 3;
+    }
+
+    // Just output the state of the device if it's not connected.
+    if (device.State == DeviceState.DISCONNECTED)
+    {
+      Console.Write($"The minipad on COM{options.Port} is currently ");
+      Console.ForegroundColor = ConsoleColor.Red;
+      Console.WriteLine("disconneted");
+      Console.ForegroundColor = ConsoleColor.Gray;
+      return 2;
+    }
+    else if (device.State == DeviceState.BUSY)
+    {
+      Console.Write($"The minipad on COM{options.Port} is currently ");
+      Console.ForegroundColor = ConsoleColor.Yellow;
+      Console.WriteLine("busy");
+      Console.ForegroundColor = ConsoleColor.Gray;
+      return 1;
+    }
+
+    // Keep a serial port opened through-out the console session to block other applications from using it.
+    SerialPort port = MinipadHelper.Open(device.PortName);
+
+    // Ask for user input in a loop and only exit if the user types an exit keyword.
+    string input = "";
+    while(true)
+    {
+      // Ask for user input.
+      Console.Write($"{device.Configuration.Name} ({device.PortName})> ");
+      input = Console.ReadLine()!;
+
+      // If the user typed an exit keyword, exit the loop.
+      if (input is "exit" or "q" or "quit")
+        break;
+
+      // Try to send the command to the minipad.
+      try
+      {
+        port.WriteLine(input);
+      }
+      catch (Exception ex)
+      {
+        // If any error occured, output it to the user.
+        Console.ForegroundColor = ConsoleColor.Red;
+        Console.Write("Error: ");
+        Console.WriteLine($"{ex.InnerException!.Message}");
+        Console.ForegroundColor = ConsoleColor.Gray;
+      }
+    }
+
+    // Close the serial port and return 0 exit code for success.
+    port.Close();
+    return 0;
+  }
+}

minitool/Program.cs

@@ -31,14 +31,15 @@ public static void Main(string[] args)
       {
         x.EnableDashDash = true;
         x.HelpWriter = Console.Out;
-      }).ParseArguments<Devices.Options, Info.Options, Boot.Options, Send.Options, Calibrate.Options, Visualize.Options, Flash.Options>(args).MapResult(
+      }).ParseArguments<Devices.Options, Info.Options, Boot.Options, Send.Options, Calibrate.Options, Visualize.Options, Flash.Options, Console_.Options>(args).MapResult(
         (Devices.Options o) => Devices.Handle(o),
         (Info.Options o) => Info.Handle(o),
         (Boot.Options o) => Boot.Handle(o),
         (Send.Options o) => Send.Handle(o),
         (Calibrate.Options o) => Calibrate.Handle(o),
         (Visualize.Options o) => Visualize.Handle(o),
         (Flash.Options o) => Flash.Handle(o),
+        (Console_.Options o) => Console_.Handle(o),
         Error);
     }
 

minitool/Properties/launchSettings.json

@@ -2,7 +2,7 @@
   "profiles": {
     "minitool": {
       "commandName": "Project",
-      "commandLineArgs": "visualize 37"
+      "commandLineArgs": "console 4"
     }
   }
 }

minitool/Utils/MinipadHelper.cs

@@ -1,6 +1,7 @@
 using System.Diagnostics;
 using System.IO.Ports;
 using System.Reflection;
+using System.Reflection.Metadata.Ecma335;
 using minitool.Enums;
 using minitool.Models;
 
@@ -11,20 +12,29 @@ namespace minitool;
 /// </summary>
 public static class MinipadHelper
 {
+  public static SerialPort Open(string portName)
+  {
+    // Create the SerialPort instance with the correct settings.
+    SerialPort port = new SerialPort(portName, 115200, Parity.Even, 8, StopBits.One);
+    port.RtsEnable = true;
+    port.DtrEnable = true;
+
+    // Open the port and return it.
+    port.Open();
+    return port;
+  }
+
   public static void Send(MinipadDevice device, params string[] commands)
   {
     // Open the serial port.
-    SerialPort serialPort = new SerialPort(device.PortName, 115200, Parity.Even, 8, StopBits.One);
-    serialPort.RtsEnable = true;
-    serialPort.DtrEnable = true;
-    serialPort.Open();
+    SerialPort port = Open(device.PortName);
 
     // Write all specified commands to the serial interface.
     foreach (string command in commands)
-      serialPort.WriteLine(command);
+      port.WriteLine(command);
 
     // Safely close the serial port for usage by other processes.
-    serialPort.Close();
+    port.Close();
   }
 
   public static (int[] raw, int[] mapped) GetSensorValues(MinipadDevice device)
@@ -38,9 +48,7 @@ public static (int[] raw, int[] mapped) GetSensorValues(MinipadDevice device)
       mappedValues[i] = -1;
     }
 
-    SerialPort port = new SerialPort(device.PortName, 115200, Parity.None, 8, StopBits.One);
-    port.RtsEnable = true;
-    port.DtrEnable = true;
+    SerialPort port = Open(device.PortName);
     port.DataReceived += (sender, e) =>
     {
       lock (port)
@@ -63,8 +71,7 @@ public static (int[] raw, int[] mapped) GetSensorValues(MinipadDevice device)
       }
     };
 
-    // Open the port, send the out command, wait until no value in the array is -1 anymore and safely close it.
-    port.Open();
+    // Send the out command, wait until no value in the array is -1 anymore and safely close it.
     port.WriteLine("out");
     while (rawValues.Any(x => x == -1))
       ;
@@ -75,15 +82,12 @@ public static (int[] raw, int[] mapped) GetSensorValues(MinipadDevice device)
     return (rawValues, mappedValues);
   }
 
-  public static async Task<MinipadDevice> GetDeviceAsync(int port)
+  public static async Task<MinipadDevice> GetDeviceAsync(int portNumber)
   {
     try
     {
       // Open the serial port.
-      SerialPort serialPort = new SerialPort($"COM{port}", 115200, Parity.Even, 8, StopBits.One);
-      serialPort.RtsEnable = true;
-      serialPort.DtrEnable = true;
-      serialPort.Open();
+      SerialPort port = Open($"COM{portNumber}");
 
       // Create a semaphore for timeouting the serial data reading.
       SemaphoreSlim semaphoreSlim = new SemaphoreSlim(0);
@@ -93,13 +97,13 @@ public static async Task<MinipadDevice> GetDeviceAsync(int port)
       void DataReceivedCallback(object sender, SerialDataReceivedEventArgs e)
       {
         // Lock the serial port to make sure it's not being closed when the 200ms timeout runs out.
-        lock (serialPort)
+        lock (port)
         {
           // Read the data all the way to the end, line by line.
-          while (serialPort.BytesToRead > 0)
+          while (port.BytesToRead > 0)
           {
             // Read the next line.
-            string line = serialPort.ReadLine().TrimEnd('\r');
+            string line = port.ReadLine().TrimEnd('\r');
 
             // If the end of the 'get' command was reached (indicated by "GET END"), release the semaphore thus returning.
             if (line == "GET END")
@@ -116,15 +120,15 @@ void DataReceivedCallback(object sender, SerialDataReceivedEventArgs e)
       }
 
       // Subscribe to the callback method, write the 'get' command that returns the keypad specifications.
-      serialPort.DataReceived += DataReceivedCallback;
-      serialPort.WriteLine("get");
+      port.DataReceived += DataReceivedCallback;
+      port.WriteLine("get");
 
       // Give the response 200ms until this reading process times out.
       await semaphoreSlim.WaitAsync(10);
 
       // Safely close the serial port for usage by other processes.
-      lock (serialPort)
-        serialPort.Close();
+      lock (port)
+        port.Close();
 
       // Create a Configuration object from the retrieved values, starting with the global settings.
       Configuration configuration = new Configuration()
@@ -165,17 +169,17 @@ void DataReceivedCallback(object sender, SerialDataReceivedEventArgs e)
         };
 
       // Create a MinipadDevice object with the parsed info and return it.
-      return new MinipadDevice(port, DeviceState.CONNECTED, values.ContainsKey("version") ? values["version"] : null, configuration);
+      return new MinipadDevice(portNumber, DeviceState.CONNECTED, values.ContainsKey("version") ? values["version"] : null, configuration);
     }
     catch (UnauthorizedAccessException)
     {
       // If an UnauthorizedAccessException was thrown, the device is connected but the serial interface occupied by another process.
-      return new MinipadDevice(port, DeviceState.BUSY, null, new Configuration());
+      return new MinipadDevice(portNumber, DeviceState.BUSY, null, new Configuration());
     }
     catch (FileNotFoundException)
     {
       // If a FileNotFoundException was thrown, the device is disconnected.
-      return new MinipadDevice(port, DeviceState.DISCONNECTED, null, new Configuration());
+      return new MinipadDevice(portNumber, DeviceState.DISCONNECTED, null, new Configuration());
     }
   }