mirror/SimplySerial
1
0
Fork 0
mirror of https://github.com/fasteddy516/SimplySerial.git synced 2024-11-24 10:04:35 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Change console windows title based on connected port and status

Browse Source
This commit is contained in:
Edward Wright 2023-02-16 11:46:21 -05:00
parent 17250a57b5
commit 185e541b12
1 changed files with 38 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

64
SimplySerial/SimplySerial.cs
View File

@ -1,14 +1,14 @@
using System; using Newtonsoft.Json;
using System;
using System.Collections.Generic; using System.Collections.Generic;
using System.Linq;
using System.IO; using System.IO;
using System.IO.Ports; using System.IO.Ports;
using System.Text; using System.Linq;
using System.Threading;
using System.Management; using System.Management;
using System.Text.RegularExpressions;
using System.Runtime.InteropServices; using System.Runtime.InteropServices;
using Newtonsoft.Json; using System.Text;
using System.Text.RegularExpressions;
using System.Threading;
namespace SimplySerial namespace SimplySerial
{ {
@ -114,7 +114,7 @@ namespace SimplySerial
if (logging) if (logging)
{ {
try try
{ {
FileStream stream = new FileStream(logFile, logMode, FileAccess.Write); FileStream stream = new FileStream(logFile, logMode, FileAccess.Write);
using (StreamWriter writer = new StreamWriter(stream, encoding)) using (StreamWriter writer = new StreamWriter(stream, encoding))
{ {
@ -127,7 +127,7 @@ namespace SimplySerial
ExitProgram($"* Error accessing log file '{logFile}'\n > {e.GetType()}: {e.Message}", exitCode: -1); ExitProgram($"* Error accessing log file '{logFile}'\n > {e.GetType()}: {e.Message}", exitCode: -1);
} }
} }
// set up keyboard input for program control / relay to serial port // set up keyboard input for program control / relay to serial port
ConsoleKeyInfo keyInfo = new ConsoleKeyInfo(); ConsoleKeyInfo keyInfo = new ConsoleKeyInfo();
Console.TreatControlCAsInput = true; // we need to use CTRL-C to activate the REPL in CircuitPython, so it can't be used to exit the application Console.TreatControlCAsInput = true; // we need to use CTRL-C to activate the REPL in CircuitPython, so it can't be used to exit the application
@ -222,7 +222,7 @@ namespace SimplySerial
else else
baud = 9600; baud = 9600;
} }
serialPort.BaudRate = baud; serialPort.BaudRate = baud;
} }
catch (ArgumentOutOfRangeException) catch (ArgumentOutOfRangeException)
@ -257,6 +257,8 @@ namespace SimplySerial
continue; continue;
} }
Console.Title = $"{port.name}: {port.board.make} {port.board.model}";
// if we get this far, clear the screen and send the connection message if not in 'quiet' mode // if we get this far, clear the screen and send the connection message if not in 'quiet' mode
if (clearScreen) if (clearScreen)
{ {
@ -362,6 +364,7 @@ namespace SimplySerial
ExitProgram((e.GetType() + " occurred while attempting to read/write to/from " + port.name + "."), exitCode: -1); ExitProgram((e.GetType() + " occurred while attempting to read/write to/from " + port.name + "."), exitCode: -1);
else else
{ {
Console.Title = $"{port.name}: (disconnected)";
Output("\n<<< Communications Interrupted >>>\n"); Output("\n<<< Communications Interrupted >>>\n");
} }
try try
@ -375,11 +378,13 @@ namespace SimplySerial
Thread.Sleep(2000); // sort-of arbitrary delay - should be long enough to read the "interrupted" message Thread.Sleep(2000); // sort-of arbitrary delay - should be long enough to read the "interrupted" message
if (autoConnect == AutoConnect.ANY) if (autoConnect == AutoConnect.ANY)
{ {
Console.Title = "SimplySerial: Searching...";
port.name = String.Empty; port.name = String.Empty;
Output("<<< Attemping to connect to any available COM port. Use CTRL-X to cancel >>>"); Output("<<< Attemping to connect to any available COM port. Use CTRL-X to cancel >>>");
} }
else if (autoConnect == AutoConnect.ONE) else if (autoConnect == AutoConnect.ONE)
{ {
Console.Title = $"{port.name}: Searching...";
Output("<<< Attempting to re-connect to " + port.name + ". Use CTRL-X to cancel >>>"); Output("<<< Attempting to re-connect to " + port.name + ". Use CTRL-X to cancel >>>");
} }
break; break;
@ -410,7 +415,7 @@ namespace SimplySerial
foreach (string arg in args) foreach (string arg in args)
{ {
// split argument into components based on 'key:value' formatting // split argument into components based on 'key:value' formatting
string[] argument = arg.Split(new [] { ':' }, 2); string[] argument = arg.Split(new[] { ':' }, 2);
argument[0] = argument[0].ToLower(); argument[0] = argument[0].ToLower();
// help // help
@ -590,7 +595,7 @@ namespace SimplySerial
argument[1] = argument[1].ToLower(); argument[1] = argument[1].ToLower();
if (argument[1].StartsWith("a")) if (argument[1].StartsWith("a"))
{ {
encoding = Encoding.ASCII; encoding = Encoding.ASCII;
convertToPrintable = false; convertToPrintable = false;
} }
@ -600,7 +605,7 @@ namespace SimplySerial
convertToPrintable = true; convertToPrintable = true;
} }
else if (argument[1].StartsWith("u")) else if (argument[1].StartsWith("u"))
{ {
encoding = Encoding.UTF8; encoding = Encoding.UTF8;
convertToPrintable = false; convertToPrintable = false;
} }
@ -622,6 +627,7 @@ namespace SimplySerial
if (autoConnect == AutoConnect.ANY) if (autoConnect == AutoConnect.ANY)
{ {
Console.Title = "SimplySerial: Searching...";
Output("<<< Attemping to connect to any available COM port. Use CTRL-X to cancel >>>"); Output("<<< Attemping to connect to any available COM port. Use CTRL-X to cancel >>>");
} }
else if (autoConnect == AutoConnect.ONE) else if (autoConnect == AutoConnect.ONE)
@ -631,11 +637,17 @@ namespace SimplySerial
Console.Clear(); Console.Clear();
} }
if (port.name == String.Empty) if (port.name == String.Empty)
{
Console.Title = "SimplySerial: Searching...";
Output("<<< Attempting to connect to first available COM port. Use CTRL-X to cancel >>>"); Output("<<< Attempting to connect to first available COM port. Use CTRL-X to cancel >>>");
}
else else
{
Console.Title = $"{port.name}: Searching...";
Output("<<< Attempting to connect to " + port.name + ". Use CTRL-X to cancel >>>"); Output("<<< Attempting to connect to " + port.name + ". Use CTRL-X to cancel >>>");
}
} }
// if we made it this far, everything has been processed and we're ready to proceed! // if we made it this far, everything has been processed and we're ready to proceed!
} }
@ -644,7 +656,7 @@ namespace SimplySerial
/// Writes messages using Console.WriteLine() as long as the 'Quiet' option hasn't been enabled /// Writes messages using Console.WriteLine() as long as the 'Quiet' option hasn't been enabled
/// </summary> /// </summary>
/// <param name="message">Message to output (assuming 'Quiet' is false)</param> /// <param name="message">Message to output (assuming 'Quiet' is false)</param>
static void Output(string message, bool force=false, bool newline=true, bool flush=false) static void Output(string message, bool force = false, bool newline = true, bool flush = false)
{ {
if (!SimplySerial.Quiet || force) if (!SimplySerial.Quiet || force)
{ {
@ -665,7 +677,7 @@ namespace SimplySerial
foreach (byte c in message) foreach (byte c in message)
{ {
if ((c > 31 && c < 128) || (c == 8) || (c == 9) || (c == 10) || (c == 13)) if ((c > 31 && c < 128) || (c == 8) || (c == 9) || (c == 10) || (c == 13))
newMessage += (char) c; newMessage += (char)c;
else else
newMessage += $"[{c:X2}]"; newMessage += $"[{c:X2}]";
} }
@ -761,7 +773,7 @@ namespace SimplySerial
/// <param name="message">Message to display - should indicate the reason why the program is terminating.</param> /// <param name="message">Message to display - should indicate the reason why the program is terminating.</param>
/// <param name="exitCode">Code to return to parent process. Should be &lt;0 if an error occurred, &gt;=0 if program is terminating normally.</param> /// <param name="exitCode">Code to return to parent process. Should be &lt;0 if an error occurred, &gt;=0 if program is terminating normally.</param>
/// <param name="silent">Exits without displaying a message or asking for a key press when set to 'true'</param> /// <param name="silent">Exits without displaying a message or asking for a key press when set to 'true'</param>
static void ExitProgram(string message="", int exitCode=0, bool silent=false) static void ExitProgram(string message = "", int exitCode = 0, bool silent = false)
{ {
// the serial port should be closed before exiting // the serial port should be closed before exiting
if (serialPort != null && serialPort.IsOpen) if (serialPort != null && serialPort.IsOpen)
@ -801,7 +813,7 @@ namespace SimplySerial
string[] cpb_descriptions = new string[] { "CircuitPython CDC ", "Sol CDC ", "StringCarM0Ex CDC " }; string[] cpb_descriptions = new string[] { "CircuitPython CDC ", "Sol CDC ", "StringCarM0Ex CDC " };
List<ComPort> detectedPorts = new List<ComPort>(); List<ComPort> detectedPorts = new List<ComPort>();
foreach (var p in new ManagementObjectSearcher("root\\CIMV2", query).Get().OfType<ManagementObject>()) foreach (var p in new ManagementObjectSearcher("root\\CIMV2", query).Get().OfType<ManagementObject>())
{ {
ComPort c = new ComPort(); ComPort c = new ComPort();
@ -814,7 +826,7 @@ namespace SimplySerial
c.name = mName.Value; c.name = mName.Value;
c.num = int.Parse(c.name.Substring(3)); c.num = int.Parse(c.name.Substring(3));
} }
// if the port name or number cannot be determined, skip this port and move on // if the port name or number cannot be determined, skip this port and move on
if (c.num < 1) if (c.num < 1)
continue; continue;
@ -834,7 +846,7 @@ namespace SimplySerial
// extract the device's friendly description (caption) // extract the device's friendly description (caption)
c.description = p.GetPropertyValue("Caption").ToString(); c.description = p.GetPropertyValue("Caption").ToString();
// attempt to match this device with a known board // attempt to match this device with a known board
c.board = MatchBoard(c.vid, c.pid); c.board = MatchBoard(c.vid, c.pid);
@ -860,7 +872,7 @@ namespace SimplySerial
} }
// add this port to our list of detected ports // add this port to our list of detected ports
detectedPorts.Add(c); detectedPorts.Add(c);
} }
return detectedPorts; return detectedPorts;
@ -881,7 +893,7 @@ namespace SimplySerial
if (mBoard == null) if (mBoard == null)
{ {
mBoard = new Board(vid:vid, pid:pid); mBoard = new Board(vid: vid, pid: pid);
Vendor mVendor = null; Vendor mVendor = null;
if (boardData.vendors != null) if (boardData.vendors != null)
@ -892,7 +904,7 @@ namespace SimplySerial
return mBoard; return mBoard;
} }
static void LoadBoards() static void LoadBoards()
{ {
try try
@ -911,7 +923,7 @@ namespace SimplySerial
} }
} }
/// <summary> /// <summary>
/// Custom string array sorting logic for SimplySerial command-line arguments /// Custom string array sorting logic for SimplySerial command-line arguments
/// </summary> /// </summary>
@ -930,15 +942,15 @@ namespace SimplySerial
// 'l' triggers the 'list available ports' output and supersedes all other command-line arguments aside from 'help' and 'version' // 'l' triggers the 'list available ports' output and supersedes all other command-line arguments aside from 'help' and 'version'
// 'q' enables the 'quiet' option, which needs to be enabled before something that would normally generate console output // 'q' enables the 'quiet' option, which needs to be enabled before something that would normally generate console output
// 'c' is the 'comport' setting, which needs to be processed before 'autoconnect' // 'c' is the 'comport' setting, which needs to be processed before 'autoconnect'
x = x.ToLower(); x = x.ToLower();
if (x.StartsWith("lo")) if (x.StartsWith("lo"))
x = "z"; // mask out logging options so that they are not interpreted as the list option x = "z"; // mask out logging options so that they are not interpreted as the list option
y = y.ToLower(); y = y.ToLower();
if (y.StartsWith("lo")) if (y.StartsWith("lo"))
y = "z"; // mask out logging options so that they are not interpreted as the list option y = "z"; // mask out logging options so that they are not interpreted as the list option
foreach (char c in "?hvlqc") foreach (char c in "?hvlqc")
{ {
if (x.ToLower()[0] == c) if (x.ToLower()[0] == c)