OATControl V0.9.9.01 - Updates

- Added lots of logging around the communication between the app and the OAT
- Moved logfiles to AppData/Roaming/OpenAstroTracker
- Only keep the last 6 lo files around

Author: ClutchplateDude

Software/OATMobile/OATCommunications/CommunicationHandlers/TcpCommunicationHandler.cs

@@ -16,6 +16,8 @@ public class TcpCommunicationHandler : ICommunicationHandler
 
 		public TcpCommunicationHandler(string spec)
 		{
+			Log.WriteLine($"COMMFACTORY: Creating Wifi handler at {spec} ...");
+
 			string ip = string.Empty;
 			string port = string.Empty;
 
@@ -26,13 +28,16 @@ public TcpCommunicationHandler(string spec)
 				{
 					ip = spec.Substring(0, colon);
 					port = spec.Substring(colon + 1);
+
+					Log.WriteLine($"COMMFACTORY: Wifi handler will monitor at {ip}:{port} ...");
+
 					_ip = IPAddress.Parse(ip);
 					_port = int.Parse(port);
 					_client = new TcpClient();
 				}
-				catch
+				catch (Exception ex)
 				{
-
+					Log.WriteLine($"COMMFACTORY: Failed to create TCP client. {ex.Message}");
 				}
 			}
 		}
@@ -63,6 +68,7 @@ private async Task<CommandResponse> SendCommand(string command, ResponseType nee
 		{
 			if (_client == null)
 			{
+				Log.WriteLine($"TCP: Configuration error, IP [{_ip}] or port [{_port}] is invalid.");
 				return new CommandResponse(string.Empty, false, $"Configuration error, IP [{_ip}] or port [{_port}] is invalid.");
 			}
 
@@ -116,6 +122,7 @@ private async Task<CommandResponse> SendCommand(string command, ResponseType nee
 						case ResponseType.DigitResponse:
 						case ResponseType.FullResponse:
 							{
+								Log.WriteLine("TCP: [{0}] Expecting a reply needed to command, waiting...", command);
 								var response = new byte[256];
 								var respCount = await stream.ReadAsync(response, 0, response.Length);
 								respString = Encoding.ASCII.GetString(response, 0, respCount).TrimEnd("#".ToCharArray());
@@ -153,6 +160,7 @@ public void Disconnect()
 		{
 			if (_client != null && _client.Connected)
 			{
+				Log.WriteLine("TCP: Closing port.");
 				_client.Close();
 				_client = null;
 			}

Software/OATMobile/OATCommunications/Log.cs

@@ -13,7 +13,8 @@ public class Log
 	{
 		private static DateTime appStartTime = DateTime.UtcNow;
 		private static object oLock = new object();
-		private static string sPath = string.Format("{0}\\oat_{1}-{2}.log", Environment.GetFolderPath(Environment.SpecialFolder.Personal), DateTime.Now.ToString("yyyy-MM-dd_HH-mm-ss"), Environment.UserName);
+		private static string sFolder;
+		private static string sPath;
 
 		private static List<string> lstBuffer = new List<string>();
 		private static DateTime dtLastUpdate = DateTime.Now.AddSeconds(5.0);
@@ -29,6 +30,31 @@ public static string Filename
 
 		public static void Init(string sTitle)
 		{
+			// Create our logfile folder in AppData/Roaming
+			sFolder = string.Format("{0}\\OpenAstroTracker", Environment.GetFolderPath(Environment.SpecialFolder.ApplicationData));
+			Directory.CreateDirectory(sFolder);
+
+			// Create this session logfile
+			sPath = string.Format("{0}\\OATControl_{1}-{2}.log", sFolder, DateTime.Now.ToString("yyyy-MM-dd_HH-mm-ss"), Environment.UserName);
+			
+			// Find old logfiles and keep the latest 5 around.
+			var oldLogFiles = Directory.GetFiles(sFolder, "OATControl*.log").OrderByDescending(s => s).Skip(5).ToList();
+			
+			// Probably should run this by the user.... for now they can jhust manually delete them
+			// oldLogFiles.AddRange(Directory.GetFiles(Environment.GetFolderPath(Environment.SpecialFolder.Personal), "oat_*.log"));
+
+			foreach (var logFile in oldLogFiles)
+			{
+				try
+				{
+					File.Delete(logFile);
+				}
+				catch
+				{
+					// Oh well....
+				}
+			}
+
 			Log.WriteLine("*********************************");
 			Log.WriteLine(string.Format("*  {0} *", sTitle.PadRight(28)));
 			Log.WriteLine("*********************************");
@@ -42,7 +68,7 @@ private static string FormatMessage(string message, object[] args)
 			var sb = new StringBuilder(message.Length + 64);
 
 			TimeSpan elapsed = DateTime.UtcNow - Log.appStartTime;
-			sb.AppendFormat("[{0}] [{1}]: ", elapsed.ToString("hh\\:mm\\:ss\\.ffff"), Thread.CurrentThread.ManagedThreadId);
+			sb.AppendFormat("[{0}] [{1:00}]: ", elapsed.ToString("hh\\:mm\\:ss\\.fff"), Thread.CurrentThread.ManagedThreadId);
 
 			if (args != null && args.Length > 0)
 			{
@@ -67,7 +93,6 @@ public static void WriteLine(string message, params object[] args)
 					Log.lstBuffer.Clear();
 				}
 				Log.dtLastUpdate = DateTime.UtcNow;
-				return;
 			}
 
 			string sLine = FormatMessage(message, args);

Software/OpenAstroTracker ASCOM/OATCommuncations.WPF/CommunicationHandlers/CommunicationHandlerFactory.cs

@@ -8,6 +8,7 @@
 using OATCommunications.CommunicationHandlers;
 using System.Collections.ObjectModel;
 using OATCommuncations.WPF;
+using OATCommunications.Utilities;
 
 namespace OATCommunications.WPF.CommunicationHandlers
 {
@@ -16,12 +17,17 @@ public static class CommunicationHandlerFactory
 		static ObservableCollection<string> _available = new ObservableCollection<string>();
 		public static void DiscoverDevices()
 		{
+			Log.WriteLine("COMMFACTORY: Device Discovery initiated.");
+			Log.WriteLine("COMMFACTORY: Checking Serial ports....");
+
 			_available.Clear();
 			foreach (var port in SerialPort.GetPortNames())
 			{
+				Log.WriteLine("COMMFACTORY: Found Serial port [{0}]", port);
 				_available.Add("Serial : " + port);
 			}
 
+			Log.WriteLine("COMMFACTORY: Starting Wifi search by Broadcastign OAT on port 4031");
 			var searcher = new UdpClientAdapter("OAT", 4031);
 			searcher.ClientFound += OnWifiClientFound;
 			searcher.StartClientSearch();
@@ -30,15 +36,16 @@ public static void DiscoverDevices()
 		private static void OnWifiClientFound(object sender, ClientFoundEventArgs e) => WpfUtilities.RunOnUiThread(
 						   () =>
 						   {
+							   Log.WriteLine($"COMMFACTORY: Wifi device {e.Name} replied from {e.Address}:4030!");
 							   _available.Insert(0, $"WiFi : {e.Name} ({e.Address}:4030)");
-
 						   },
 						   System.Windows.Application.Current.Dispatcher);
 
 		public static ObservableCollection<String> AvailableDevices { get { return _available; } }
 
 		public static ICommunicationHandler ConnectToDevice(string device)
 		{
+			Log.WriteLine($"COMMFACTORY: Attempting to connect to device {device}...");
 			if (device.StartsWith("Serial : "))
 			{
 				string comPort = device.Substring("Serial : ".Length);

Software/OpenAstroTracker ASCOM/OATCommuncations.WPF/CommunicationHandlers/SerialCommunicationHandler.cs

@@ -1,4 +1,5 @@
 using OATCommunications.CommunicationHandlers;
+using OATCommunications.Utilities;
 using System;
 using System.Collections.Generic;
 using System.IO.Ports;
@@ -15,6 +16,8 @@ public class SerialCommunicationHandler : ICommunicationHandler
 
 		public SerialCommunicationHandler(string comPort)
 		{
+			Log.WriteLine($"COMMFACTORY: Creating Serial handler on {comPort} at 57600 baud...");
+
 			_portName = comPort;
 			_port = new SerialPort(comPort);
 			_port.BaudRate = 57600;
@@ -46,11 +49,13 @@ private async Task<CommandResponse> SendCommand(string command, ResponseType nee
 			{
 				try
 				{
+					Log.WriteLine("SERIAL: [{0}] Sending command", command);
 					_port.Write(command);
 				}
-				catch
+				catch (Exception ex)
 				{
-					return new CommandResponse(string.Empty, false, $"Unable to write to {_portName}");
+					Log.WriteLine("SERIAL: [{0}] Failed to send command. {1}", command, ex.Message);
+					return new CommandResponse(string.Empty, false, $"Unable to write to {_portName}. " + ex.Message);
 				}
 
 				try
@@ -59,31 +64,38 @@ private async Task<CommandResponse> SendCommand(string command, ResponseType nee
 					{
 						case ResponseType.NoResponse:
 							{
+								Log.WriteLine("SERIAL: [{0}] No response needed for command", command);
 								return new CommandResponse(string.Empty, true);
 							}
 
 						case ResponseType.DigitResponse:
 							{
+								Log.WriteLine("SERIAL: [{0}] Expecting single digit response for command, waiting...", command);
 								string response = new string((char)_port.ReadChar(), 1);
+								Log.WriteLine("SERIAL: [{0}] Received single digit response '{1}' for command", command, response);
 								return new CommandResponse(response, true);
 							}
 
 						case ResponseType.FullResponse:
 							{
+								Log.WriteLine("SERIAL: [{0}] Expecting #-delimited response for Command, waiting...", command);
 								string response = _port.ReadTo("#");
+								Log.WriteLine("SERIAL: [{0}] Received response '{1}' for command", command, response);
 								return new CommandResponse(response, true);
 							}
 					}
 				}
 				catch (Exception ex)
 				{
+					Log.WriteLine("SERIAL: [{0}] Failed to receive response to command. {1}", command, ex.Message);
 					return new CommandResponse(string.Empty, false, $"Unable to read response to {command} from {_portName}. {ex.Message}");
 				}
 
 				return new CommandResponse(string.Empty, false, "Something weird going on...");
 			}
 			else
 			{
+				Log.WriteLine("SERIAL: Failed to open port {0}", _portName);
 				return new CommandResponse(string.Empty, false, $"Unable to open {_portName}");
 			}
 		}
@@ -94,13 +106,16 @@ private async Task<bool> EnsurePortIsOpen()
 			{
 				try
 				{
+					Log.WriteLine("SERIAL: Port {0} is not open, attempting to open...", _portName);
 					_port.Open();
 					await Task.Delay(750); // Arduino resets on connection. Give it time to start up.
+					Log.WriteLine("SERIAL: Port is open, sending initial [:I#] command..");
 					_port.Write(":I#");
 					return true;
 				}
-				catch
+				catch (Exception ex)
 				{
+					Log.WriteLine("SERIAL: Failed to open the port. {0}", ex.Message);
 					return false;
 				}
 			}
@@ -111,11 +126,13 @@ public void Disconnect()
 		{
 			if (_port.IsOpen)
 			{
+				Log.WriteLine("SERIAL: Port is open, sending shutdown command [:Qq#]");
 				_port.Write(":Qq#");
+				Log.WriteLine("SERIAL: Closing port...");
 				_port.Close();
 				_port = null;
+				Log.WriteLine("SERIAL: Disconnected...");
 			}
 		}
-
 	}
 }