RGB.NET/RGB.NET.Devices.WS281X/Generic/SerialPortConnection.cs

using System.IO.Ports;

namespace RGB.NET.Devices.WS281X;

/// <inheritdoc />
/// <summary>
/// Represents a serial-connection using the default microsoft serial-port implementation.
/// </summary>
public sealed class SerialPortConnection : ISerialConnection
{
    #region Properties & Fields

    /// <summary>
    /// The <see cref="System.IO.Ports.SerialPort"/> used for the connection.
    /// </summary>
    public SerialPort SerialPort { get; }

    /// <inheritdoc />
    public string Port => SerialPort.PortName;

    /// <inheritdoc />
    public int BaudRate => SerialPort.BaudRate;

    /// <inheritdoc />
    public bool IsOpen => SerialPort.IsOpen;

    #endregion

    #region Constructors

    /// <summary>
    /// Initializes a new instance of the <see cref="SerialPortConnection"/> class.
    /// </summary>
    /// <param name="port">The name of the serial-port to connect to.</param>
    /// <param name="baudRate">The baud-rate used by the serial-connection.</param>
    public SerialPortConnection(string port, int baudRate)
    {
        SerialPort = new SerialPort(port, baudRate);
    }

    #endregion

    #region Methods

    /// <inheritdoc />
    public void Open() => SerialPort.Open();

    /// <inheritdoc />
    public void DiscardInBuffer() => SerialPort.DiscardInBuffer();

    /// <inheritdoc />
    public byte ReadByte() => (byte)SerialPort.ReadByte();

    /// <inheritdoc />
    public void ReadTo(char target) => SerialPort.ReadTo(target.ToString());

    /// <inheritdoc />
    public void Write(byte[] buffer, int offset, int length) => SerialPort.Write(buffer, offset, length);

    /// <inheritdoc />
    public void WriteLine(string line) => SerialPort.WriteLine(line);

    /// <inheritdoc />
    public void Dispose()
    {
        SerialPort.Dispose();
    }

    #endregion
}