refactor protocol

ProtocolInterface.cs

@@ -0,0 +1,17 @@
+/*
+ * Created by SharpDevelop.
+ * User: uzix
+ * Date: 04.01.2017
+ * Time: 16:02
+ */
+using System;
+
+namespace SDRSharp.SerialController
+{
+	public interface ProtocolInterface
+	{
+		string EndMarker { get; }
+		string PktTransmitter(string ChangedProperty);
+		string PktReceiver(string ReveivedData);
+	}
+}

Protocol_TS50.cs

@@ -0,0 +1,86 @@
+/*
+ * Created by SharpDevelop.
+ * User: uzix
+ * Date: 02.05.2016
+ * Time: 17:00
+ */
+using System;
+using System.Collections.Generic;
+
+using SDRSharp.Radio;
+
+
+namespace SDRSharp.SerialController
+{
+	public class Protocol_TS50 : ProtocolInterface
+	{
+		static readonly Dictionary<DetectorType, uint> mode2int = new Dictionary<DetectorType, uint> {
+			{DetectorType.NFM, 4},
+			{DetectorType.WFM, 4},
+			{DetectorType.AM,  5},
+			{DetectorType.DSB, 5},
+			{DetectorType.LSB, 1},
+			{DetectorType.USB, 2},
+			{DetectorType.CW,  3},
+			{DetectorType.RAW, 4}
+		};
+		static readonly Dictionary<uint, DetectorType> int2mode = new Dictionary<uint, DetectorType> {
+			{1, DetectorType.LSB},
+			{2, DetectorType.USB},
+			{3, DetectorType.CW},
+			{4, DetectorType.NFM},
+			{5, DetectorType.AM}
+		};
+		
+		public string EndMarker { get { return ";"; } }
+
+		SerialRadioInterface _radio;
+		
+		public Protocol_TS50(SerialRadioInterface radio)
+		{
+			_radio = radio;
+		}
+		
+    	public string PktTransmitter(string ChangedProperty)
+    	{
+    		string response = "";
+            switch (ChangedProperty)
+            {
+                case "Frequency":
+            		response = "FA" + String.Format("{0:00000000000}", _radio.RadioFrequency) + ";";
+                    break;
+                case "DetectorType":
+                    response = "MD" + mode2int[_radio.RadioMode] + ";";
+                    break;
+            }
+            return response;
+    	}
+    	
+		public string PktReceiver(string ReveivedData)
+		{
+			string response = "";
+			if (ReveivedData.StartsWith("IF", StringComparison.Ordinal)) {
+				response += "IF";
+				response += String.Format("{0:00000000000}", _radio.RadioFrequency);
+				response += "0000000000000000";
+				response += mode2int[_radio.RadioMode];
+				response += "0000000";
+				response += EndMarker;
+			}
+			if (ReveivedData.StartsWith("FA", StringComparison.Ordinal)) {
+				long freq;
+				if (long.TryParse(ReveivedData.Substring(2), out freq)) {
+					_radio.RadioFrequency = freq;
+				}
+			}
+			if (ReveivedData.StartsWith("MD", StringComparison.Ordinal)) {
+				uint mode;
+				if (uint.TryParse(ReveivedData.Substring(2), out mode)) {
+					_radio.RadioMode = int2mode[mode];
+				}
+			}
+			return response;
+		}
+		
+	}
+}

README.md

@@ -1,8 +1,17 @@
 # sdrsharp-catcontroller
 
-This plugin allow SDR# to be controlled via serial (COM) interface with subset of TS-50 receiver commands.
+This plugin allow SDR# to be controlled via serial (COM) interface with set of TS-50 receiver commands.
+E.g. it can be coupled with com0com virtual serial port and Fldigi for better convenience.
+
 Supported commands:
-* IF - get frequency
+* IF - get frequency and mode
 * FA - set frequency
+* MD - set mode (AM,FM,USB,LSB,CW)
+
+Serial port parameters:
+* Speed: 9600
+* Data bits: 8
+* Stop bits: 1
+* Parity: none
 
 This plugin based on code by pewusoft (http://users.vline.pl/~pewusoft/)

SDRSharp.SerialController.csproj

@@ -101,7 +101,9 @@
     <Reference Include="System.Xml" />
   </ItemGroup>
   <ItemGroup>
-    <Compile Include="SerialPort.cs" />
+    <Compile Include="ProtocolInterface.cs" />
+    <Compile Include="Protocol_TS50.cs" />
+    <Compile Include="SerialPortCtrl.cs" />
     <!--<Reference Include="SDRSharp.PanView, Version=0.0.0.0, Culture=neutral, processorArchitecture=x86">
       <SpecificVersion>False</SpecificVersion>
       <HintPath>../Common/SDRSharp.PanView.dll</HintPath>
@@ -114,6 +116,7 @@
     </Compile>
     <Compile Include="SerialControllerPlugin.cs" />
     <Compile Include="Properties\AssemblyInfo.cs" />
+    <Compile Include="SerialRadioInterface.cs" />
   </ItemGroup>
   <ItemGroup>
     <EmbeddedResource Include="SerialControllerPanel.resx">

SerialControllerPanel.Designer.cs

@@ -32,9 +32,7 @@
         	this.cbEnable = new System.Windows.Forms.CheckBox();
         	this.comboPorts = new System.Windows.Forms.ComboBox();
         	this.btnRefreshPorts = new System.Windows.Forms.Button();
-        	this.cbLogToFile = new System.Windows.Forms.CheckBox();
         	this.lbLog = new System.Windows.Forms.ListBox();
-        	this.label1 = new System.Windows.Forms.Label();
         	this.SuspendLayout();
         	// 
         	// cbEnable
@@ -61,47 +59,27 @@
         	this.btnRefreshPorts.Image = ((System.Drawing.Image)(resources.GetObject("btnRefreshPorts.Image")));
         	this.btnRefreshPorts.Location = new System.Drawing.Point(188, 2);
         	this.btnRefreshPorts.Name = "btnRefreshPorts";
-        	this.btnRefreshPorts.Size = new System.Drawing.Size(30, 30);
+        	this.btnRefreshPorts.Size = new System.Drawing.Size(24, 24);
         	this.btnRefreshPorts.TabIndex = 3;
         	this.btnRefreshPorts.UseVisualStyleBackColor = true;
         	this.btnRefreshPorts.Click += new System.EventHandler(this.BtnRefreshPortsClick);
         	// 
-        	// cbLogToFile
-        	// 
-        	this.cbLogToFile.Location = new System.Drawing.Point(3, 30);
-        	this.cbLogToFile.Name = "cbLogToFile";
-        	this.cbLogToFile.Size = new System.Drawing.Size(104, 24);
-        	this.cbLogToFile.TabIndex = 4;
-        	this.cbLogToFile.Text = "Log to file";
-        	this.cbLogToFile.UseVisualStyleBackColor = true;
-        	// 
         	// lbLog
         	// 
         	this.lbLog.FormattingEnabled = true;
-        	this.lbLog.Location = new System.Drawing.Point(3, 60);
+        	this.lbLog.Location = new System.Drawing.Point(3, 30);
         	this.lbLog.Name = "lbLog";
         	this.lbLog.Size = new System.Drawing.Size(215, 69);
-        	this.lbLog.TabIndex = 5;
-        	// 
-        	// label1
-        	// 
-        	this.label1.Location = new System.Drawing.Point(3, 132);
-        	this.label1.Name = "label1";
-        	this.label1.Size = new System.Drawing.Size(215, 46);
-        	this.label1.TabIndex = 6;
-        	this.label1.Text = "Accept some TS-50 CAT commands via serial interface. " +
-							    "Made by Uzix, 2016. Based on plugin by pewusoft, 2015";
+        	this.lbLog.TabIndex = 4;
         	// 
         	// SerialControllerPanel
         	// 
-        	this.Controls.Add(this.label1);
         	this.Controls.Add(this.lbLog);
-        	this.Controls.Add(this.cbLogToFile);
         	this.Controls.Add(this.btnRefreshPorts);
         	this.Controls.Add(this.comboPorts);
         	this.Controls.Add(this.cbEnable);
         	this.Name = "SerialControllerPanel";
-        	this.Size = new System.Drawing.Size(222, 201);
+        	this.Size = new System.Drawing.Size(222, 131);
         	this.ResumeLayout(false);
 
         }
@@ -111,9 +89,7 @@
         private System.Windows.Forms.CheckBox cbEnable;
         private System.Windows.Forms.ComboBox comboPorts;
         private System.Windows.Forms.Button btnRefreshPorts;
-        private System.Windows.Forms.CheckBox cbLogToFile;
         private System.Windows.Forms.ListBox lbLog;
-        private System.Windows.Forms.Label label1;
 
 
     }

SerialControllerPanel.cs

@@ -3,6 +3,7 @@ using System.Windows.Forms;
 
 using SDRSharp.Radio;
 
+
 namespace SDRSharp.SerialController
 {
     public partial class SerialControllerPanel : UserControl
@@ -25,7 +26,7 @@ namespace SDRSharp.SerialController
 		}
 		
 		public void addToLogList(String log) {
-			lbLog.Items.Add(log);
+			lbLog.Items.Add(DateTime.Now.ToString("[HH:mm:ss] ") + log);
 			// scroll to bottom
 			lbLog.SelectedIndex = lbLog.Items.Count - 1;
 			lbLog.SelectedIndex = -1;
@@ -33,14 +34,12 @@ namespace SDRSharp.SerialController
 		
 		public void readSettings() {
 			comboPorts.Text = Utils.GetStringSetting("serialControlComPort", "");
-			cbLogToFile.Checked = Utils.GetBooleanSetting("serialControlLogToFile");
 			cbEnable.Checked = Utils.GetBooleanSetting("serialControlEnable");
 			CbEnableClick(null,null);
 		}
 		
 		public void saveSettings() {
 			Utils.SaveSetting("serialControlComPort", comboPorts.Text);
-			Utils.SaveSetting("serialControlLogToFile", cbLogToFile.Checked);
 			Utils.SaveSetting("serialControlEnable", cbEnable.Checked);
 		}
 		void CbEnableClick(object sender, EventArgs e)
@@ -52,8 +51,6 @@ namespace SDRSharp.SerialController
 			cbEnable.Checked = _serialPort.IsOpen;
 			comboPorts.Enabled = !cbEnable.Checked;
 			btnRefreshPorts.Enabled = !cbEnable.Checked;
-			cbLogToFile.Enabled = !cbEnable.Checked;
-			_serialPort.EnableLogging = cbLogToFile.Checked;
 		}
 		void CbEnableKeyDown(object sender, EventArgs e)
 		{

SerialControllerPlugin.cs

@@ -1,17 +1,21 @@
 using System;
+using System.ComponentModel;
 using System.Windows.Forms;
 
 using SDRSharp.Common;
+using SDRSharp.Radio;
+
 
 namespace SDRSharp.SerialController
 {
-    public class SerialControllerPlugin: ISharpPlugin
+    public class SerialControllerPlugin: ISharpPlugin,SerialRadioInterface
     {
         private const string _displayName = "SerialController";
 
+        private ISharpControl _control;
         private SerialControllerPanel _controlPanel;
         private SerialPortCtrl _serialPort;
-        private ISharpControl _control;
+        private ProtocolInterface _Protocol;
 
         public string DisplayName
         {
@@ -31,27 +35,51 @@ namespace SDRSharp.SerialController
         public void Initialize(ISharpControl control)
         {
             _control = control;
-            _serialPort = new SerialPortCtrl();
-			_serialPort.OnFrequencyChange += UpdateFrequency;
-			_serialPort.OnGetFrequency += GetFrequency;
-            
+			_control.PropertyChanged += PropertyChangedHandler;
+            _Protocol = new Protocol_TS50(this);
+            _serialPort = new SerialPortCtrl(_Protocol);           
             _controlPanel = new SerialControllerPanel(_serialPort);
             _controlPanel.readSettings();
         }
         
-        void UpdateFrequency(object sender, long freq) {
-        	_control.Frequency = freq;
-        	_controlPanel.addToLogList(freq.ToString("N0")+" Hz");
-        }
-        
-        long GetFrequency() {
-        	return _control.Frequency;
-        }
-        
         public void Close()
         {
         	_serialPort.closePort();
         	_controlPanel.saveSettings();
         }        
+
+        
+        void PropertyChangedHandler(object sender, PropertyChangedEventArgs e)
+		{
+        	if (_serialPort.IsOpen)
+		    {
+        		string response = _Protocol.PktTransmitter(e.PropertyName);
+				if (! string.IsNullOrEmpty(response))
+					_serialPort.DataTransmit(response);
+		    }
+		}
+        
+        public long RadioFrequency
+        {
+        	get {
+        		return _control.Frequency;
+        	}
+        	set {
+        		_controlPanel.addToLogList(value.ToString("N0")+" Hz");
+        		_control.Frequency = value;
+        	}
+        }
+            
+        public DetectorType RadioMode
+        {
+        	get {
+        		return _control.DetectorType;
+        	}
+        	set {
+	        	_controlPanel.addToLogList(value.ToString());
+	        	_control.DetectorType = value;        		
+        	}
+        }
+        
     }
 }

SerialPort.cs

@@ -1,162 +0,0 @@
-/*
- * Author: Pawel Walczak (pewusoft)
- * Date: 2015-01-12 20:50
- *
- */
-using System;
-using System.IO.Ports;
-using System.IO;
-using System.Windows.Forms;
-
-namespace SDRSharp.SerialController
-{
-	/// <summary>
-	/// Description of SerialPort.
-	/// </summary>
-	public class SerialPortCtrl
-	{
-		bool _enableLogging = true;
-		public bool EnableLogging {
-			set { this._enableLogging = value; }
-			get { return this._enableLogging; }
-		}
-		public bool IsOpen {
-			get { return _port != null && _port.IsOpen; }
-		}
-		
-		StreamWriter logger;
-		SerialPort _port;
-		
-		public delegate void FrequencyChangeHandler(object sender, long freq);
-    	public event FrequencyChangeHandler OnFrequencyChange;
-    	
-    	public delegate long GetFrequencyHandler();
-    	public event GetFrequencyHandler OnGetFrequency;
-    	
-				
-    	public static string[] GetAllPorts()
-		{
-			try {
-				return SerialPort.GetPortNames();
-    		} catch (Exception e) {
-    			MessageBox.Show("Cannot read port list:\n"+e.ToString(), "SerialController", MessageBoxButtons.OK, MessageBoxIcon.Error);
-				return new string[0];
-			}
-		}
-		
-		public bool openPort(string portName) {
-			try {
-	    		if (_port != null && _port.IsOpen)
-					return false;
-    			
-    			if (portName == null || (portName.Trim().Equals("")))
-    				return false;
-
-				_port = new SerialPort(portName, 9600, Parity.None, 8, StopBits.One);
-				_port.DataReceived += new SerialDataReceivedEventHandler( Port_DataReceived );
-						
-				if (_port != null) {
-					_port.Open();
-					if (_enableLogging) {
-						prepareLogger();
-						log("Port " + _port.PortName + " opened");
-					}
-					return true;
-				}
-				return false;
-			} catch (Exception e) {
-    			MessageBox.Show("Couldn't open port "+portName+":\n"+e.ToString(), "SerialController",
-    			                MessageBoxButtons.OK, MessageBoxIcon.Error);
-				return false;
-			}
-		}
-		
-		public bool closePort() {
-			if (_port != null) {
-				if (_port.IsOpen) {
-					try {
-						_port.Close();
-						if (_enableLogging) {
-							log("Port " + _port.PortName + " closed");
-							closeLogger();
-						}
-						return true;
-					} catch (IOException) {
-						return false;
-					}
-				} else {
-					return false;
-				}
-			}
-			return false;
-		}
-		
-		void Port_DataReceived(object sender, SerialDataReceivedEventArgs e)
-        {
-			string data = "";
-			while( data.IndexOf(';') < 0 ) {
-				byte[] bytes = new byte[_port.BytesToRead+32];
-				try {
-					_port.Read(bytes, 0, _port.BytesToRead);
-				}
-				catch (Exception) {
-					log("Error reading COM port");
-					return;
-				}
-				data += System.Text.Encoding.UTF8.GetString(bytes);
-			}
-			data = data.Substring(0, data.IndexOf(';'));
-			
-			// TS-50 command parse
-			if (data.StartsWith("IF", StringComparison.Ordinal)) {
-				long freq = OnGetFrequency();
-				string response = "IF";
-				response += String.Format("{0:00000000000}", freq);
-				response += "000000000000000000000000;";
-				_port.Write(response);
-			}
-			if (data.StartsWith("FA", StringComparison.Ordinal)) {
-				long freq;
-				if (long.TryParse(data.Substring(2), out freq)) {
-					log("Received on COM port: "+data);
-					if (OnFrequencyChange == null) return;
-					OnFrequencyChange(this, freq);
-					log("Changing frequency to: "+freq.ToString("N0"));
-				}
-			}
-        }
-		
-		void log(String str) {
-			if (logger!=null) {
-				logger.WriteLine("[" + DateTime.Now + "]: " + str.Trim());
-			}
-		}
-		
-		void prepareLogger() {
-			try {
-				if (logger != null) {
-					logger.Close();
-				}
-				logger = new StreamWriter(new FileStream("serial.log",
-				                                         FileMode.Append,
-				                                         FileAccess.Write,
-				                                         FileShare.ReadWrite,
-				                                       	 1024,
-				                                         FileOptions.WriteThrough));
-				logger.AutoFlush = true;
-			} catch (Exception) {
-				logger = null;
-			}
-		}
-		void closeLogger() {
-			try {
-				if (logger != null) {
-					logger.Close();
-				}
-				logger = null;
-			} catch (Exception) {
-				logger = null;
-			}
-		}
-	}
-}

SerialPortCtrl.cs

@@ -0,0 +1,108 @@
+/*
+ * Author: Pawel Walczak (pewusoft)
+ * Date: 2015-01-12 20:50
+ *
+ */
+using System;
+using System.IO.Ports;
+using System.IO;
+using System.Windows.Forms;
+
+
+namespace SDRSharp.SerialController
+{
+	public class SerialPortCtrl
+	{
+		public bool IsOpen {
+			get { return _port != null && _port.IsOpen; }
+		}
+		
+		SerialPort _port;
+		ProtocolInterface _protocol;
+		
+		public SerialPortCtrl(ProtocolInterface protocol)
+		{
+			_protocol = protocol;
+		}
+		
+    	public static string[] GetAllPorts()
+		{
+			try {
+				return SerialPort.GetPortNames();
+    		}
+    		catch (Exception e) {
+    			MessageBox.Show("Couldn't read port list:\n"+e.ToString(), "SerialController", MessageBoxButtons.OK, MessageBoxIcon.Error);
+				return new string[0];
+			}
+		}
+		
+		public bool openPort(string portName)
+		{
+			try {
+	    		if (_port != null && _port.IsOpen)
+					return false;
+    			
+    			if (portName == null || (portName.Trim().Equals("")))
+    				return false;
+
+				_port = new SerialPort(portName, 9600, Parity.None, 8, StopBits.One);
+				_port.DataReceived += new SerialDataReceivedEventHandler( DataReceivedHandler );
+						
+				if (_port != null) {
+					_port.Open();
+					return true;
+				}
+				return false;
+			}
+			catch (Exception e) {
+    			MessageBox.Show("Couldn't open port "+portName+":\n"+e.ToString(), "SerialController",
+    			                MessageBoxButtons.OK, MessageBoxIcon.Error);
+				return false;
+			}
+		}
+		
+		public bool closePort()
+		{
+			if (_port != null)	{
+				if (_port.IsOpen) {
+					try {
+						_port.Close();
+						return true;
+					}
+					catch (IOException)	 {
+						return false;
+					}
+				}
+				else {
+					return false;
+				}
+			}
+			return false;
+		}
+		
+		void DataReceivedHandler(object sender, SerialDataReceivedEventArgs e)
+        {
+			string data = "";
+			while (data.IndexOf(_protocol.EndMarker) < 0) {
+				byte[] bytes = new byte[_port.BytesToRead+32];
+				try {
+					_port.Read(bytes, 0, _port.BytesToRead);
+				}
+				catch (Exception) {
+					return;
+				}
+				data += System.Text.Encoding.UTF8.GetString(bytes);
+			}
+			data = data.Substring(0, data.IndexOf(_protocol.EndMarker));
+			
+			string response = _protocol.PktReceiver(data);
+			if (! string.IsNullOrEmpty(response))
+				DataTransmit(response);
+        }
+		
+		public void DataTransmit(string data)
+		{
+			_port.Write(data);
+		}
+	}
+}

SerialRadioInterface.cs

@@ -0,0 +1,19 @@
+/*
+ * Created by SharpDevelop.
+ * User: uzix
+ * Date: 04.01.2017
+ * Time: 16:46
+ */
+using System;
+
+using SDRSharp.Radio;
+
+
+namespace SDRSharp.SerialController
+{
+	public interface SerialRadioInterface
+	{
+		long RadioFrequency { get; set; }
+		DetectorType RadioMode { get; set; }
+	}
+}