SerialTransfer.NET

Overview

Installation

Requirements

Via NuGet (Coming Soon)

Install-Package SerialTransfer.NET

Manual Installation

Project Structure

SerialTransfer.NET/
├── src/ # Source code for the library
│ ├── PacketCRC.cs # CRC implementation
│ ├── Packet.cs # Packet handling
│ └── SerialTransfer.cs # Main SerialTransfer class
├── samples/ # Example applications
└── tests/ # Unit and integration tests

Usage

Basic Example

using System;
using System.IO.Ports;
using System.Text;
using SerialTransfer;
// Create and configure SerialPort
SerialPort port = new SerialPort
{
 PortName = "COM3",
 BaudRate = 115200,
 DataBits = 8,
 Parity = Parity.None,
 StopBits = StopBits.One
};
// Create SerialTransfer instance
SerialTransfer transfer = new SerialTransfer();
transfer.Begin(port);
// Send text message
string message = "Hello Arduino!";
byte[] messageBytes = Encoding.ASCII.GetBytes(message);
for (int i = 0; i < messageBytes.Length; i++)
{
 transfer.Packet.TxBuff[i] = messageBytes[i];
}
transfer.SendData((ushort)messageBytes.Length, 1);
// Receive response
if (transfer.Available() > 0)
{
 byte packetId = transfer.CurrentPacketId();
 byte bytesRead = transfer.BytesRead;
 
 string response = Encoding.ASCII.GetString(
 transfer.Packet.RxBuff, 0, bytesRead);
 
 Console.WriteLine($"Response: {response}");
}
// Clean up
transfer.Close();

Sending and Receiving Structs

// Define a struct for binary transmission
[StructLayout(LayoutKind.Sequential, Pack = 1)]
struct SensorData
{
 public int Id;
 public float Temperature;
 public float Humidity;
 public byte Status;
}
// Create data to send
SensorData data = new SensorData
{
 Id = 42,
 Temperature = 23.5f,
 Humidity = 65.0f,
 Status = 1
};
// Manually serialize and send the struct
int structSize = Marshal.SizeOf(data);
byte[] structBytes = new byte[structSize];
GCHandle handle = GCHandle.Alloc(structBytes, GCHandleType.Pinned);
try
{
 Marshal.StructureToPtr(data, handle.AddrOfPinnedObject(), false);
}
finally
{
 handle.Free();
}
// Copy to transmit buffer
for (int i = 0; i < structBytes.Length; i++)
{
 transfer.Packet.TxBuff[i] = structBytes[i];
}
// Send with packet ID 2
transfer.SendData((ushort)structSize, 2);
// Receive and deserialize struct
if (transfer.Available() > 0)
{
 SensorData receivedData = new SensorData();
 transfer.RxObj(ref receivedData);
 
 Console.WriteLine($"Received: ID={receivedData.Id}, " +
 $"Temp={receivedData.Temperature}°C");
}

Arduino Compatibility

#include "SerialTransfer.h"
SerialTransfer myTransfer;
void setup() {
 Serial.begin(115200);
 myTransfer.begin(Serial);
}
void loop() {
 if(myTransfer.available()) {
 // Process received data
 // ...
 
 // Send response
 // ...
 }
}

Contributing

License

Acknowledgments