Tellurian.Trains.Adapters.LocoNet 1.8.0

Tellurian.Trains.Adapters.LocoNet

A .NET adapter for LocoNet-based command stations via serial port, TCP (LoconetOverTcp), or UDP multicast, providing a high-level API for locomotive control, accessory switching, and decoder programming.

Features

• Locomotive Control (ILoco): Speed, direction, function control (F0-F12), and state query
• Accessory Control (IAccessory): Set and query accessory states
• Turnout Control (ITurnout): Convenient throw/close/off operations for turnouts
• Decoder Programming (IDecoder): CV read/write operations on the programming track

Usage

// Create serial port adapter
var serialPort = new SerialPortAdapter("COM3", 57600);

// Create LocoNet framer
var framer = new LocoNetFramer();

// Create communication channel
var channel = new SerialDataChannel(serialPort, framer, logger);

// Create adapter
await using var adapter = new Adapter(channel, logger);

// Start receiving
await adapter.StartReceiveAsync();

// Control a locomotive
var address = Address.From(999);
var drive = new Drive
{
    Direction = Direction.Forward,
    Speed = Speed.Set126(50)
};
await adapter.DriveAsync(address, drive);

// Query current locomotive state from the command station
var info = await adapter.GetLocoInfoAsync(address);
if (info is not null)
{
    // Returns speed, direction, and function states F0-F8
    // (F9-F28 are not available via LocoNet slot data)
    Console.WriteLine($"Speed: {info.Speed.CurrentStep}, Direction: {info.Direction}");
}

// Control a switch
var switchAddress = Accessories.Address.From(1);
await adapter.SetThrownAsync(switchAddress);

Slot Management

LocoNet uses a slot-based architecture where each locomotive is assigned to a slot (0-119). This adapter handles slot management automatically:

1. When you control a locomotive, the adapter requests a slot for the address
2. The slot assignment is cached for subsequent operations
3. Slots are automatically managed for the lifetime of the adapter

Notifications

Subscribe to receive state change notifications:

adapter.Subscribe(new NotificationObserver());

class NotificationObserver : IObserver<Notification>
{
    public void OnNext(Notification notification)
    {
        // Handle notification
    }

    public void OnError(Exception error) { }
    public void OnCompleted() { }
}

Transport Options

The adapter works with any ICommunicationsChannel. Choose the transport that matches your hardware:

// Serial — direct connection via LocoBuffer-USB
var channel = new SerialDataChannel(new SerialPortAdapter("COM3"), new LocoNetFramer(), logger);

// TCP — LoconetOverTcp (LbServer, JMRI, Rocrail on port 1234)
var channel = new TcpLocoNetChannel(new TcpStreamAdapter("192.168.1.100", 1234), logger);

// UDP — loconetd (multicast 225.0.0.2, listen 4501, send to gateway on 4500)
var udpAdapter = new UdpLocoNetAdapter(
    IPAddress.Parse("225.0.0.2"), 4501,
    new IPEndPoint(IPAddress.Parse("192.168.1.50"), 4500));
var channel = new UdpLocoNetChannel(udpAdapter, logger);

// UDP — GCA101 LocoBuffer-UDP (multicast 224.0.0.1, port 1235)
var gca101 = new UdpLocoNetAdapter(
    IPAddress.Parse("224.0.0.1"), 1235,
    new IPEndPoint(IPAddress.Parse("192.168.0.200"), 1235));
var channel = new UdpLocoNetChannel(gca101, logger);

Requirements

• LocoNet interface connected via serial port, TCP server, or UDP multicast gateway
• .NET 10.0 or later