Skip to content
This repository has been archived by the owner on Apr 14, 2023. It is now read-only.

Latest commit

 

History

History
62 lines (46 loc) · 4.43 KB

README.md

File metadata and controls

62 lines (46 loc) · 4.43 KB
Raw

TrainLink API

Python CI Coverage Status CodeQL

This is an API to intergrate with a DCC++ (or DCC++ EX) BaseStation. It provides a simple way to control it over your local network, with multiple instances supported. This means if you open a website using TrainLink on two devices connected to the same server, they will be kept in sync! If you don't know anything about TrainLink, I suggest you check out the main repo, this gives a better overview of the TrainLink system.

Note: Before version 0.2.0, the whole codebase was kept in one repository. It has now been split into separate repositories to help with maintainance, but the old releases are kept in the main repository for now, just for completeness.

What is in this Repository?

This repository contains the Python version of the server for TrainLink. Due to being written in Python, this version of the server can be run on most OSes, on most architectures (Raspberry Pi included!)

Dependancies

Firstly, you will need Python 3.6 or newer installed (I am currently using Python 3.8). You can check what version is installed (if any) using the command python3 --version. If you are using linux, it is probably pre-installed. Otherwise, you will need to visit the Python website to download and install it.

The server application has these Python depencancies:

  • pyserial - Provides serial communication with the basestation
  • websockets - Allows the client to communicate with the server
  • xmltodict - Parses the config.xml file

These can all be easily installed using Pip by running the following command:

$ pip3 install -r requirements.txt

Installation

It's as easy as 1,2,3!

  1. Download the source code file (tar.gz or zip) from the latest release (or click here)
  2. Check all the dependancies are installed (see above) and copy config/config.default.xml to config/config.xml
  3. Run server.py

Now the TrainLink server will be running on your PC! Just point a client at the server and you are ready to go! For more detailed instructions please see the readthedocs page

Branches and releases

Releases are numbered according to the Semantic Numbering scheme. Therefore, releases will be numbered as following:

Given a version number MAJOR.MINOR.PATCH, increment the:

MAJOR version when you make incompatible API changes,
MINOR version when you add functionality in a backwards compatible manner, and
PATCH version when you make backwards compatible bug fixes."

Branches

Master branch - Where code for the next release accumulates.
Preview branch - Code that is finished, but not fully tested yet.
Development-x.x branch - Where I write my code, almost guaranteed to be unstable!
Any other branches - Same as above.

Contributing

Want to suggest a feature, found a bug, or even better, fixed a bug? Please, go ahead and submit a pull request or issue! Every little helps, and even the smallest contribution will go a long way to help me with this project. You don't need to know how to code, as correcting typos or updating the documentation would help a lot! For more information on contributing, please see the wiki on the main repository.

More Information

For more information please see the following:

  • The main repo - Gives an overview of the TrainLink system.
  • The wiki - FAQ and other repository maintainance help
  • Readthedocs - information on the API itself and the function calls

Many thanks,
Matt
- January 2021