Automatic Calibration desktop SW
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
doc
form
icon
lib
src
.clang-format
.clang-tidy
.gitignore
.gitmodules
LICENSE
NOTICE
README.md
activate.sh
auto-calib.pro
auto-calib.qrc

README.md

Automatic Calibration SW

Automatic Calibration SW is a desktop application which allows you to automatically calibrate your model train vehicle. It requires a Wireless Speedometer and XpressNET command station connected to PC via LI and (virtual) serial port.

Calibrating = assigning power to each of 28 speed steps so specific speed steps fit specific real speed. E. g. step 15 = 40 km/h, step 17 = 50 km/h etc. This assignment is defined by user and this application loads it from file 'speed.csv'. The main aim of this application is to do this 'assignment' automatically.

How does it work? Application assigns power to each speed step of the DCC decoder in the train and then measures real speed of the train. It repeats this process until the correct speed is assigned to the speed step. And the again for different speed step and different real speed...

This application is developed in QT v5.

Resources

Building & toolkit

This SW was developed in vim using qmake & make. Downloads are available in Releases section.

Prerequisities

  • Qt 5
  • Qt's serialport
  • Qt's charts

Build

Clone this repository (including submodules!):

$ git clone --recurse-submodules https://github.com/kmzbrnoI/automatic-calibration

And then build:

$ mkdir build
$ cd build
$ qmake ..
$ make

To make debug binary, run:

$ qmake CONFIG+=debug ..
$ make

You may use this script to debug segfaults.

Connecting to WSM

  • Windows: pair it with HC-05 module, serial port should be added automatically

  • Linux: pair it with HC-05 module and map it to new serial device:

    $ rfcomm connect /dev/rfcomm0 hc-05-hw-address 2
    

Project description

This project consists of several C++ classes defined in header files and its implementations defined in .cpp files. All classes are described in diagram below:

Class diagram

Squares are classes (in this project singletons), the arrow represents relationship owns. Red classes are Window classes, MainWindow basically owns everything, yellow classes are libraries, blue classes are managers and green classes are helpers.

Basically all the managers use all the libraries and helpers. Helpers are connected to GUI to visualize its states. Libs and helpers are passed to managers as references.

CalibMan manages whole process of calibration divided into two phases (CalibOverview, CalibStep), see calib-man.h for more information.

All visualized classes inherit from QObject and usually communicate with outer world by receiving function calls and calling Qt's signals.

Each header file contains a docstring, so see it for more information.

Configuration

The binary loads general configuration from config.ini file located in the directory where the binary is executed from. This file is created once the application is run for the first time. Inspect it and configure the app according to your requirements. Configuration cannot be done from GUI, it is done just through the config file. Config could be reloaded at runtime.

Loco-specific configuration could be loaded from & saved to xml file according to the format of loco of JMRI.

Speed table is loaded from speed.csv file, where each line is of format step;speed:

6;10
15;40
17;50
...

Style checking

$ clang-tidy -extra-arg-before=-x -extra-arg-before=c++ -extra-arg=-std=c++14

Authors

License

This application is released under the Apache License v2.0 .