C# serial port driver wrapper class code and concept quality
- by Ruben Trancoso
Hi folks,
Would like to know from all you guys what you think about my Serial Wrapper class. Had be a while I've beem working with serial port but never shared the code what somekind make closed to my very own vision.
Would like to know if it's a good/bad approach, if the interface is enough and what more you see on it.
I know that Stackoverflow is for question but at the same time there's a lot of very good skilled people here and share code and opinion can also bennefit everybody, it's why I decided to post it anyway.
thanks!
using System.Text;
using System.IO;
using System.IO.Ports;
using System;
namespace Driver
{
class SerialSingleton
{
// The singleton instance reference
private static SerialSingleton instance = null;
// System's serial port interface
private SerialPort serial;
// Current com port identifier
private string comPort = null;
// Configuration parameters
private int confBaudRate;
private int confDataBits;
private StopBits confStopBits;
private Parity confParityControl;
ASCIIEncoding encoding = new ASCIIEncoding();
// ==================================================================================
// Constructors
public static SerialSingleton getInstance()
{
if (instance == null)
{
instance = new SerialSingleton();
}
return instance;
}
private SerialSingleton()
{
serial = new SerialPort();
}
// ===================================================================================
// Setup Methods
public string ComPort
{
get { return comPort; }
set {
if (value == null)
{
throw new SerialException("Serial port name canot be null.");
}
if (nameIsComm(value))
{
close();
comPort = value;
}
else
{
throw new SerialException("Serial Port '" + value + "' is not a valid com port.");
}
}
}
public void setSerial(string baudRate, int dataBits, StopBits stopBits, Parity parityControl)
{
if (baudRate == null)
{
throw new SerialException("Baud rate cannot be null");
}
string[] baudRateRef = { "300", "600", "1200", "1800", "2400", "3600", "4800", "7200", "9600", "14400", "19200", "28800", "38400", "57600", "115200" };
int confBaudRate;
if (findString(baudRateRef, baudRate) != -1)
{
confBaudRate = System.Convert.ToInt32(baudRate);
}
else
{
throw new SerialException("Baurate parameter invalid.");
}
int confDataBits;
switch (dataBits)
{
case 5:
confDataBits = 5;
break;
case 6:
confDataBits = 6;
break;
case 7:
confDataBits = 7;
break;
case 8:
confDataBits = 8;
break;
default:
throw new SerialException("Databits parameter invalid");
}
if (stopBits == StopBits.None)
{
throw new SerialException("StopBits parameter cannot be NONE");
}
this.confBaudRate = confBaudRate;
this.confDataBits = confDataBits;
this.confStopBits = stopBits;
this.confParityControl = parityControl;
}
// ==================================================================================
public string[] PortList
{
get {
return SerialPort.GetPortNames();
}
}
public int PortCount
{
get { return SerialPort.GetPortNames().Length; }
}
// ==================================================================================
// Open/Close Methods
public void open()
{
open(comPort);
}
private void open(string comPort)
{
if (isOpen())
{
throw new SerialException("Serial Port is Already open");
}
else
{
if (comPort == null)
{
throw new SerialException("Serial Port not defined. Cannot open");
}
bool found = false;
if (nameIsComm(comPort))
{
string portId;
string[] portList = SerialPort.GetPortNames();
for (int i = 0; i < portList.Length; i++)
{
portId = (portList[i]);
if (portId.Equals(comPort))
{
found = true;
break;
}
}
}
else
{
throw new SerialException("The com port identifier '" + comPort + "' is not a valid serial port identifier");
}
if (!found)
{
throw new SerialException("Serial port '" + comPort + "' not found");
}
serial.PortName = comPort;
try
{
serial.Open();
}
catch (UnauthorizedAccessException uaex)
{
throw new SerialException("Cannot open a serial port in use by another application", uaex);
}
try
{
serial.BaudRate = confBaudRate;
serial.DataBits = confDataBits;
serial.Parity = confParityControl;
serial.StopBits = confStopBits;
}
catch (Exception e)
{
throw new SerialException("Serial port parameter invalid for '" + comPort + "'.\n" + e.Message, e);
}
}
}
public void close()
{
if (serial.IsOpen)
{
serial.Close();
}
}
// ===================================================================================
// Auxiliary private Methods
private int findString(string[] set, string search)
{
if (set != null)
{
for (int i = 0; i < set.Length; i++)
{
if (set[i].Equals(search))
{
return i;
}
}
}
return -1;
}
private bool nameIsComm(string name)
{
int comNumber;
int.TryParse(name.Substring(3), out comNumber);
if (name.Substring(0, 3).Equals("COM"))
{
if (comNumber > -1 && comNumber < 256)
{
return true;
}
}
return false;
}
// =================================================================================
// Device state Methods
public bool isOpen()
{
return serial.IsOpen;
}
public bool hasData()
{
int amount = serial.BytesToRead;
if (amount > 0)
{
return true;
}
else
{
return false;
}
}
// ==================================================================================
// Input Methods
public char getChar()
{
int data = serial.ReadByte();
return (char)data;
}
public int getBytes(ref byte[] b)
{
int size = b.Length;
char c;
int counter = 0;
for (counter = 0; counter < size; counter++)
{
if (tryGetChar(out c))
{
b[counter] = (byte)c;
}
else
{
break;
}
}
return counter;
}
public string getStringUntil(char x)
{
char c;
string response = "";
while (tryGetChar(out c))
{
response = response + c;
if (c == x)
{
break;
}
}
return response;
}
public bool tryGetChar(out char c)
{
c = (char)0x00;
byte[] b = new byte[1];
long to = 10;
long ft = System.Environment.TickCount + to;
while (System.Environment.TickCount < ft)
{
if (hasData())
{
int data = serial.ReadByte();
c = (char)data;
return true;
}
}
return false;
}
// ================================================================================
// Output Methods
public void sendString(string data)
{
byte[] bytes = encoding.GetBytes(data);
serial.Write(bytes, 0, bytes.Length);
}
public void sendChar(char c)
{
char[] data = new char[1];
data[0] = c;
serial.Write(data, 0, 1);
}
public void sendBytes(byte[] data)
{
serial.Write(data, 0, data.Length);
}
public void clearBuffer()
{
if (serial.IsOpen)
{
serial.DiscardInBuffer();
serial.DiscardOutBuffer();
}
}
}
}
