ThreeByte.LinkLib.SerialLink 1.2.4

🔌 ThreeByte.LinkLib.SerialLink

Serial port (RS-232) communication with optional frame-based protocol support, auto-reconnection, and message queuing.

✨ Features

📦 Installation

dotnet add package ThreeByte.LinkLib.SerialLink

or via the NuGet Package Manager:

Install-Package ThreeByte.LinkLib.SerialLink

🚀 Quick Start

Raw Serial Communication

using ThreeByte.LinkLib.SerialLink;

// Open a serial port at 9600 baud
var serial = new SerialLink("COM3", baudRate: 9600);

// Subscribe to events
serial.IsConnectedChanged += (s, connected) =>
    Console.WriteLine(connected ? "✅ Port open" : "❌ Port closed");

serial.DataReceived += (s, e) =>
{
    byte[]? data = serial.GetMessage();
    if (data != null)
        Console.WriteLine($"Received {data.Length} bytes");
};

// Send raw bytes
byte[] command = new byte[] { 0x01, 0x02, 0x03 };
serial.SendData(command);

// Check for queued data
while (serial.HasData)
{
    byte[]? response = serial.GetMessage();
}

serial.Dispose();

Framed Serial Communication

Use FramedSerialLink when your device protocol uses header/footer delimiters:

using ThreeByte.LinkLib.SerialLink;

var framed = new FramedSerialLink("COM4", baudRate: 115200);

// Configure frame delimiters
framed.SendFrame = new SerialFrame
{
    Header = new byte[] { 0x02 },  // STX
    Footer = new byte[] { 0x03 }   // ETX
};

framed.ReceiveFrame = new SerialFrame
{
    Header = new byte[] { 0x02 },
    Footer = new byte[] { 0x03 }
};

// Send a framed message — header/footer added automatically
framed.SendMessage("STATUS?");
// Wire: [0x02] S T A T U S ? [0x03]

// Receive complete framed messages
framed.DataReceived += (s, e) =>
{
    string? response = framed.GetMessage();
    Console.WriteLine($"Device says: {response}");
};

framed.Dispose();

📖 API Reference

SerialLink — Raw Serial Port

Constructors

SerialLink(string comPort, int baudRate = 9600, int dataBits = 8,
           Parity parity = Parity.None, bool enabled = true)
SerialLink(SerialLinkSettings settings, bool enabled = true)

Properties

Methods

FramedSerialLink — Framed Protocol

Constructors

FramedSerialLink(string comPort, int baudRate = 9600, int dataBits = 8,
                 Parity parity = Parity.None, bool enabled = true)
FramedSerialLink(SerialLinkSettings settings, bool enabled = true)

Properties

Methods

SerialFrame — Frame Configuration

var frame = new SerialFrame
{
    Header = new byte[] { 0x02 },  // Start-of-text
    Footer = new byte[] { 0x0D, 0x0A }  // CR+LF
};

🏗️ Architecture

┌──────────────────────────────────────────────────┐
│                  FramedSerialLink                 │
│  ┌────────────┐           ┌────────────────────┐ │
│  │ SendFrame  │           │   ReceiveFrame     │ │
│  │ [HDR][MSG] │           │ Detect [HDR]..     │ │
│  │     [FTR]  │           │         ..[FTR]    │ │
│  └─────┬──────┘           └────────┬───────────┘ │
│        │                           │             │
│        ▼                           ▼             │
│  ┌──────────────────────────────────────────────┐│
│  │               SerialLink (Raw)               ││
│  │                                              ││
│  │  COM Port ←→ Read/Write ←→ Message Queue     ││
│  │                   ↕                          ││
│  │           Auto-Reconnect Timer               ││
│  └──────────────────────────────────────────────┘│
└──────────────────────────────────────────────────┘

🔧 Configuration

Use SerialLinkSettings for structured configuration:

var settings = new SerialLinkSettings("COM3", 9600, 8, Parity.None);
var serial = new SerialLink(settings);

🎯 Platform Support

📄 License

Part of the ThreeByte.LinkLib family of communication libraries.