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!
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 this repository for now, just for completeness.
This repository contains information about TrainLink as a whole, as well as information relevant to all platforms. Also, the readthedocs sources are hosted here.
If you are an end user looking for more information, please go here.
The different libraries and servers can be found in the following repositories, just click the link for the one you need (the sublist shows supported platforms, whilst ones in italic are planned for the future):
- The API Server
- Python (Cross-platform)
- Arduino (ESP32/ESP8266)
- The API Library
- Javascript (Cross-platform)
- Arduino
- Python
There is a demo for each library in it's repository.
One of the major features of TrainLink is the cross-platform nature of the API. The server runs on Python, meaning it can be run on most platforms. Also, the API library is written in Javascript, so again, it can be run on most platforms.
Also, TrainLink is very flexible to different development styles. For example, if you don't need the sync feature, you can just send direct commands.
Here is a list of compatable front ends that work with TrainLink:
| Name | Location | Maintainer |
|---|---|---|
| Demo page | This repository | Matt-hu |
Its looking a little bare at the moment! If you know of or maintain a compatible front end, please let me know and I wil add it here.
You can identify compatible front ends from this logo:
For the full list of supported features and commands, please see the wiki and full documentation. Here is a brief list of what is currently fully supported:
| Feature | Version |
|---|---|
| Cab control | 0.1 |
| Track power control | 0.1 |
| Direct command | 0.1 |
| Cab functions | 0.2 |
The reason I say fully supported is because the API has the direct command function. This allows DCC++ comands (such as <t 1 3 126 1>) to be sent directly to the base s tation, so all DCC++ commands are supported to some degree. Full support means they are handled by the server and are synced between instances.
To find out what is next for TrainLink, check out the Development Tasks project!
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."
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!
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.
For more information please see the following:
- The wiki - FAQ and other repository maintainance help
- Readthedocs - information on the API itself and the function calls
Many thanks,
Matt
- November 2020