README.md

ThrottleLibrary.Client

A client library for working with model railroad protocols, such as DCC++EX, SRCP, LocoNet, and WiThrottle.

References

Protocols

• WiThrottle
  • WiThrottleProtocol C++ Library (more advanced fork)
    • WiThrottleProtocol C++ Library (original repository)
    • Heart of the protocol command processing (local fork)
  • PiThrottle
  • LocoNetControlStation
  • PyWiThrottle Python Library
• SRCP
  • Android SRCP Client
  • Android SRCP Client
  • iThrottle for iOS
  • model-rail-control
  • SRCP.NET
  • Java SRCP Client
  • microSRCP
  • RailuinoSrcp (for Maerklin)
• SRCP REST
  • srcp-rs
  • Gember
• DCC++ EX
  • Documentation
    • Command Summary
    • Command Reference
    • Technical Reference for Throttle Developers
  • Examples
    • DCC++ EX Protocol Library
    • DCC++ EX Protocol Parsing
    • WiThrottle Protocol Parsing
• LocoNet
  • Licensing and Documentation
    • Digitrax LocoNet Architecture
    • Digitrax LocoNet Protocol Documentation
    • Licensing and Licensees
  • Projects
    • LocoNetSharp (targets .NET Standard 2.0)
      • NuGet Package
      • Based on LocoNetToolbox (.NET Framework app) by ChrisSharp
    • LocoNet Library
      • Arduino Reference
    • Loconet2 Library (Development Branch)
    • LNetSerialMaster (based in part on RocRail)
    • LNetDCCpp (DCC++ command station with added Loconet support)
  • DCCSpider (uses Loconet to communicate with throttles and boosters)
  • JMRI LocoNet
    • LocoNet Constants/OpCodes
    • LocoNet Message Interpreter
  • RocRail LocoNet
• XpressNet
  • Documentation (German)
  • XpressnetLib (.NET binary)
• Z21 (from Manuals Page)
  • z21-Drive Java API
  • z21 Typescript Client Library

 

Open Source Software and Command Stations

• JMRI
  • JMRI Network Connections
• DCC++ EX
• IoTT
  • Many designes largely built around the M5Stack M5StickC…
  • …which is itself basd on the Espressif ESP32
  • Grove connector on one end; for interfacing with Arduino or similar, jumper cables might be useful
    • 4-pin male
    • 4-pin female
• LocoNet Control Station
• DCC Lite: Includes LocoNet to WiThrottle Bridge
• LocoDuino (Google Translate)
• Atanisoft ESP32 Command Station: Supports LCC
• Railroad Automation (RRA) (GitHub Repository)
  • Currnetly only supports LocoNet via serial (or serial over USB) connections (no LbServer support)
  • Does provide .NET libraries that can be used to create your own implementations and customizations

Free (but Closed Source) Software

• Rocrail
  • Formerly Open Source, then went closed source
  • Repo moritzmhmk/Rocrail appears to be the most advanced fork before Rocrail went closed source
  • Some functionality now only available via an annual subscription fee

Commercial Multi-Protocol Command Stations

• Digikeijs DR5000
  • Product Information
  • Wiki: Capabilities and Limitations
  • No plans to support LCC
• Z21
• TCS DCC
  • Reported that Digitrax denied them a LocoNet license

Throttles (mostly closed source)

Windows

• Train Throttle - includes support for Windows 10 Mobile

Android

• Engine Driver
  • Source Code
• DCC Throttle

iOS

• SRCP Client by IO-Expert (also supports z21 and DCC++ EX protocols)
• Train Driver by IO-Expert (also supports z21 and DCC++ EX protocols)

 

Alternative Decoders and Electronics

Arduino-Based DCC Decoders

• Arduino DCC Decoder: Use an Arduino Mini as a DCC decoder

WiFi Decoders

• WifiTrax: Control a locomotive directly over WiFi via WiThrottle

Bluetooth Decoders

• BlueRail Trains: Control a locomotive directly over Bluetooth via a custom app (currently iOS only)

RF Decoders

• Ring Engineering RailPro: Control a locomotive using special RF throttles and decoders

Electronics

• Azatrax: Exhibit controllers and sensors
• Iowa Scaled Engineering: ProtoThrottle, sensors, and exhibit controller
  • Reported that Digitrax denied them a LocoNet license
• Model Train Technology: Lighting and sensors
  • Passenger Car Lighting

 

Development References and Resources

Arduino

• evive: A prototyping platform for Arduino MEGA
• VSCodium: A true open source release of Visual Studio Code
• Visual Studio Code Extension for Android: Facilitates use of VS Code / VSCodium for Arduino development
  • Guide to Configuring for Debugging

Haxe

• Try
• Setup
  • Haxe C# Backend
  • Target .NET Core 2.1 for .NET Standard 2.0 Compatibility
  • .NET Standard Versions Overview
    • .NET Standard Versions Detail
    • Target Frameworks and Target Framework Monikers (TFMs)
  • Selecting the .NET version to use
• Components
  • Task Library: hxbolts

.NET

• .NET Standard (support tables)
  • v2.0 for best cross-compatibility between .NET (formerly .NET Core) and .NET Framework
  • v1.4 to support Windows 10 Mobile and earlier versions of Windows 10 (pre-10.0.16299 [1709 Fall Creators Update for Desktop; Mobile version of 1709 is 10.0.15254.603])
• Avalonia UI: Cross-platform UI framework similar to WPF (GitHub)
• Uno Platform: Make C# and XAML or WinUI apps cross-platform