/TMX

Primary LanguagePythonMIT LicenseMIT


Logo

Detect Raven

TMX is the serial control interface for the trackmaster treadmill protocol
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgments

About The Project

Product Name Screen Shot

Using the trackmaster protocol, This simple tkinter GUI can control the speed and elevation of the treadmil.

(back to top)

Built With

  • Python

(back to top)

Getting Started

To run program use the executable

output\main.exe

Modifications

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

  • Python 3.10 at https://python.org
    wget https://www.python.org/ftp/python/3.10.1/Python-3.10.1.tgz
    tar xzf Python-3.10.1.tgz
    cd Python-3.10.1 
    ./configure --enable-optimizations
    make altinstall

Dependencies

  1. We need to install a virtual environment and dependencies
  2. Clone the repo
    git clone https://github.com/jbirbal-skydom/TMX/.git
  3. Install virtual environment
    pip install virtualenv
  4. To make virtual environment
    python -m venv .venv
  5. Start VEnv
    .\.venv\Scripts\activate
  6. Install dependencies
    python -m pip install -r requirements.txt

(back to top)

Configure the settings JSON file

  • Initialize our annotations file

    nano setting\config.jsonc
  • edit the Config

    {
      /****
      * DATASET PATHS
      ****/
      "writePort": "COM1",
      "readPort": "COM2",
      "rate": 4800,
      "stopbits": 1,
      "Parity": "N",
      "bytes": 8,
      "timeout": 0,
      "Duplex": "full"
        ```
    
    

Usage

Clicking the button up sends comand to increase the speed/elevation in relation to the set values respectfully. The increment are hard coded abut can be changed easily.

The reference unit is the TMX 428:

---Any units that uses the treadmaster protocol should work.---

tmx

For more examples, please refer to the Documentation

(back to top)

Roadmap

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Jason Birbal - skydom@zoho.com

Project Link: https://github.com/jbirbal-skydom/TMX/

(back to top)

Acknowledgments and References

(back to top)