Add serial protocol and update demo project

Author: leandrovip

src/Vip.Printer.Demo/Vip.Printer.Demo.csproj

@@ -43,6 +43,9 @@
       <HintPath>..\..\packages\System.Drawing.Common.6.0.0\lib\net461\System.Drawing.Common.dll</HintPath>
     </Reference>
     <Reference Include="System.Drawing" />
+    <Reference Include="System.IO.Ports, Version=6.0.0.0, Culture=neutral, PublicKeyToken=cc7b13ffcd2ddd51, processorArchitecture=MSIL">
+      <HintPath>..\..\packages\System.IO.Ports.6.0.0\lib\net461\System.IO.Ports.dll</HintPath>
+    </Reference>
     <Reference Include="System.Windows.Forms" />
   </ItemGroup>
   <ItemGroup>

src/Vip.Printer.Demo/frmPrincipal.Designer.cs

@@ -1,6 +1,7 @@
 using System;
 using System.Diagnostics;
 using System.IO;
+using System.IO.Ports;
 using System.Windows.Forms;
 using Vip.Printer.Enums;
 
@@ -23,6 +24,9 @@ private void frmPrincipal_Load(object sender, EventArgs e)
         {
             cboModelo.SelectedItem = cboModelo.Items[0];
             cboProtocolo.SelectedItem = cboProtocolo.Items[0];
+            cboParity.SelectedItem = cboParity.Items[0];
+            cboStopBits.SelectedItem = cboStopBits.Items[0];
+            cboHandShake.SelectedItem = cboHandShake.Items[0];
         }
 
         private void lblLinkGit_LinkClicked(object sender, LinkLabelLinkClickedEventArgs e)
@@ -157,10 +161,14 @@ private Printer ObterPrinter()
             int.TryParse(txtCondensado.Text, out var condensado);
             int.TryParse(txtExpandido.Text, out var expandido);
 
+            int.TryParse(txtBaudeRate.Text, out var baudeRate);
+            int.TryParse(txtDataBits.Text, out var dataBits);
+
             var settings = PrinterSettings.Create()
                 .WithPrinterName(txtImpressora.Text)
                 .WithPrinterType(ObterTipo())
                 .WithProtocol(ObterProtocolo())
+                .WithSerialOptions(baudeRate, dataBits, ObterParity(), ObterStopBits(), ObterHandShake())
                 .WithColumns(normal, condensado, expandido)
                 .Build();
 
@@ -175,10 +183,51 @@ private ProtocolType ObterProtocolo()
             {
                 case "Raw":     return ProtocolType.Raw;
                 case "Network": return ProtocolType.Network;
+                case "Serial":  return ProtocolType.Serial;
                 default:        return ProtocolType.Raw;
             }
         }
 
+        private Parity ObterParity()
+        {
+            switch (cboParity.Text)
+            {
+                case "Odd":   return Parity.Odd;
+                case "Even":  return Parity.Even;
+                case "Mark":  return Parity.Mark;
+                case "Space": return Parity.Space;
+                case "None":
+                default:
+                    return Parity.None;
+            }
+        }
+
+        private StopBits ObterStopBits()
+        {
+            switch (cboStopBits.Text)
+            {
+                case "None":         return StopBits.None;
+                case "Two":          return StopBits.Two;
+                case "OnePointFive": return StopBits.OnePointFive;
+                case "One":
+                default:
+                    return StopBits.One;
+            }
+        }
+
+        private Handshake ObterHandShake()
+        {
+            switch (cboHandShake.Text)
+            {
+                case "XOnXOff":              return Handshake.XOnXOff;
+                case "RequestToSend":        return Handshake.RequestToSend;
+                case "RequestToSendXOnXOff": return Handshake.RequestToSendXOnXOff;
+                case "None":
+                default:
+                    return Handshake.None;
+            }
+        }
+
         #endregion
     }
 }

src/Vip.Printer.Demo/frmPrincipal.cs

@@ -1,4 +1,5 @@
 <?xml version="1.0" encoding="utf-8"?>
 <packages>
   <package id="System.Drawing.Common" version="6.0.0" targetFramework="net462" />
+  <package id="System.IO.Ports" version="6.0.0" targetFramework="net48" />
 </packages>

src/Vip.Printer.Demo/packages.config

@@ -0,0 +1,99 @@
+using System;
+using System.IO.Ports;
+using System.Threading;
+using Vip.Printer.Interfaces.Engine;
+
+namespace Vip.Printer.Engine
+{
+    public sealed class SerialEngine : IEngine, IDisposable
+    {
+        #region Fields
+
+        private readonly PrinterSettings _settings;
+        private SerialPort _port;
+
+        #endregion
+
+        #region Constructors
+
+        public SerialEngine(PrinterSettings settings)
+        {
+            _settings = settings ?? throw new ArgumentNullException(nameof(settings));
+            if (_settings.SerialOptions == null) throw new ArgumentNullException(nameof(settings.SerialOptions));
+            if (!settings.SerialOptions.AutoOpenClose) _port = CreateAndOpenPort();
+        }
+
+        #endregion
+
+        #region Methods
+
+        public bool Send(string printer, byte[] content)
+        {
+            try
+            {
+                if (_settings.SerialOptions.AutoOpenClose)
+                {
+                    using (var port = CreateAndOpenPort())
+                        WriteInChunks(port, content);
+                }
+                else
+                {
+                    if (_port == null || !_port.IsOpen)
+                    {
+                        _port?.Dispose();
+                        _port = CreateAndOpenPort();
+                    }
+
+                    WriteInChunks(_port, content);
+                }
+
+                return true;
+            }
+            catch
+            {
+                return false;
+            }
+        }
+
+        public void Dispose()
+        {
+            try { _port?.Dispose(); }
+            catch { }
+        }
+
+        private SerialPort CreateAndOpenPort()
+        {
+            var sp = new SerialPort(_settings.PrinterName, _settings.SerialOptions.BaudRate, _settings.SerialOptions.Parity, _settings.SerialOptions.DataBits, _settings.SerialOptions.StopBits)
+            {
+                Handshake = _settings.SerialOptions.Handshake,
+                DtrEnable = false,
+                RtsEnable = false,
+                WriteTimeout = _settings.SerialOptions.WriteTimeoutMs
+            };
+            sp.Open();
+            Thread.Sleep(10);
+            return sp;
+        }
+
+        private void WriteInChunks(SerialPort port, byte[] data)
+        {
+            if (data == null || data.Length == 0) return;
+
+            var offset = 0;
+            while (offset < data.Length)
+            {
+                var count = Math.Min(_settings.SerialOptions.ChunkSize, data.Length - offset);
+                port.Write(data, offset, count);
+                offset += count;
+
+                if (_settings.SerialOptions.InterChunkDelayMs > 0)
+                    Thread.Sleep(_settings.SerialOptions.InterChunkDelayMs);
+            }
+
+            if (_settings.SerialOptions.InterChunkDelayMs > 0)
+                Thread.Sleep(_settings.SerialOptions.InterChunkDelayMs);
+        }
+
+        #endregion
+    }
+}

src/Vip.Printer/Engine/SerialEngine.cs

@@ -4,6 +4,6 @@ public enum ProtocolType
     {
         Raw = 0,
         Network = 1,
-        //Serial = 2 - Future
+        Serial = 2
     }
 }

src/Vip.Printer/Enums/ProtocolType.cs

@@ -67,7 +67,7 @@ public class Printer : IPrinter
         #region Constructors
 
         /// <summary>
-        /// Initializes a new instance of the <see cref="Printer" /> class.
+        ///     Initializes a new instance of the <see cref="Printer" /> class.
         /// </summary>
         /// <param name="settings"></param>
         /// <exception cref="ArgumentNullException"></exception>
@@ -151,6 +151,7 @@ private IEngine EngineFactory(ProtocolType protocol)
             {
                 case ProtocolType.Raw:     return new RawEngine();
                 case ProtocolType.Network: return new NetworkEngine();
+                case ProtocolType.Serial:  return new SerialEngine(_settings);
                 default:                   return new RawEngine();
             }
         }

src/Vip.Printer/Printer.cs

@@ -1,4 +1,5 @@
-using System.Text;
+using System.IO.Ports;
+using System.Text;
 using Vip.Printer.Enums;
 using Vip.Printer.Interfaces.Engine;
 
@@ -12,6 +13,7 @@ public sealed class PrinterSettings
         public PrinterType PrinterType { get; }
         public ProtocolType Protocol { get; }
         public Encoding Encoding { get; }
+        public SerialOptions SerialOptions { get; }
         public IEngine Engine { get; }
         public int ColsNormal { get; }
         public int ColsCondensed { get; }
@@ -21,12 +23,13 @@ public sealed class PrinterSettings
 
         #region Constructors
 
-        private PrinterSettings(string printerName, PrinterType printerType, ProtocolType protocol, Encoding encoding, IEngine engine, int colsNormal, int colsCondensed, int colsExpanded)
+        private PrinterSettings(string printerName, PrinterType printerType, ProtocolType protocol, Encoding encoding, SerialOptions serialOptions, IEngine engine, int colsNormal, int colsCondensed, int colsExpanded)
         {
             PrinterName = string.IsNullOrWhiteSpace(printerName) ? "temp.prn" : printerName.Trim();
             PrinterType = printerType;
             Protocol = protocol;
             Encoding = encoding;
+            SerialOptions = serialOptions;
             Engine = engine;
             ColsNormal = colsNormal;
             ColsCondensed = colsCondensed;
@@ -62,6 +65,7 @@ public sealed class PrinterSettingsBuilder
             private PrinterType _printerType = PrinterType.Epson;
             private ProtocolType _protocol = ProtocolType.Raw;
             private Encoding _encoding;
+            private SerialOptions _serialOptions;
             private IEngine _engine;
             private int _colsNormal;
             private int _colsCondensed;
@@ -73,7 +77,7 @@ public sealed class PrinterSettingsBuilder
 
             public PrinterSettings Build()
             {
-                return new PrinterSettings(_printerName, _printerType, _protocol, _encoding, _engine, _colsNormal, _colsCondensed, _colsExpanded);
+                return new PrinterSettings(_printerName, _printerType, _protocol, _encoding, _serialOptions, _engine, _colsNormal, _colsCondensed, _colsExpanded);
             }
 
             #endregion
@@ -104,6 +108,12 @@ public PrinterSettingsBuilder WithEncoding(Encoding encoding)
                 return this;
             }
 
+            public PrinterSettingsBuilder WithSerialOptions(int baudeRate, int dataBits = 8, Parity parity = Parity.None, StopBits stopBits = StopBits.One, Handshake handshake = Handshake.None)
+            {
+                _serialOptions = new SerialOptions(baudeRate, dataBits, parity, stopBits, handshake);
+                return this;
+            }
+
             public PrinterSettingsBuilder WithEngine(IEngine engine)
             {
                 _engine = engine;

src/Vip.Printer/PrinterSettings.cs

@@ -0,0 +1,42 @@
+using System;
+using System.IO.Ports;
+
+namespace Vip.Printer
+{
+    public class SerialOptions
+    {
+        #region Constructors
+
+        public SerialOptions(int baudRate = 9600, int dataBits = 8, Parity parity = Parity.None, StopBits stopBits = StopBits.One, Handshake handshake = Handshake.None, int writeTimeoutMs = 5000, int chunkSize = 512, int interChunkDelayMs = 3, bool autoOpenClose = true)
+        {
+            if (baudRate <= 0) throw new ArgumentOutOfRangeException(nameof(baudRate));
+
+            BaudRate = baudRate;
+            DataBits = dataBits;
+            Parity = parity;
+            StopBits = stopBits;
+            Handshake = handshake;
+            WriteTimeoutMs = writeTimeoutMs;
+            ChunkSize = chunkSize;
+            InterChunkDelayMs = interChunkDelayMs;
+            AutoOpenClose = autoOpenClose;
+        }
+
+        #endregion
+
+        #region Properties
+
+        public int BaudRate { get; }
+        public int DataBits { get; }
+        public Parity Parity { get; }
+        public StopBits StopBits { get; }
+        public Handshake Handshake { get; }
+
+        public int WriteTimeoutMs { get; }
+        public int ChunkSize { get; }
+        public int InterChunkDelayMs { get; }
+        public bool AutoOpenClose { get; }
+
+        #endregion
+    }
+}

src/Vip.Printer/SerialOptions.cs

@@ -13,6 +13,9 @@
 		<PackageReference Include="System.Drawing.Common">
 			<Version>6.0.0</Version>
 		</PackageReference>
+		<PackageReference Include="System.IO.Ports">
+			<Version>6.0.0</Version>
+		</PackageReference>
 	</ItemGroup>
 	<ItemGroup>
 	  <Folder Include="Interfaces\Engine\" />