Skip to content

Quentin18/Line-Track-Designer

Repository files navigation

Line Track Designer

Documentation Status Build Status PyPI PyPI - Python Version License: MIT

Line Track Designer is a library to design line following tracks for robots. With this tool, you can easily edit, save, share and print your tracks with a printer.

Tracks can be created in two different ways:

  • with the command line interface (CLI)
  • with the application programming interface in Python (API)

It uses a PDF file containing tiles to build tracks: PDF

Installation

Line Track Designer can be installed using pip:

pip3 install line-track-designer

Quickstart

For example, we consider a file named track.txt:

3;1 2;1 3;0
2;0 11;0 2;0
3;2 2;1 3;3

This file represents the following track: Track Image

This picture can be obtained with the following command:

linetrack show track.txt

You can also generate documentation for your track using this command:

linetrack savemd track.txt

It generates a markdown file with informations about the track. You can see an example here.

You can also use the API to create tracks:

import numpy as np
from line_track_designer.track import Track


# Arrays for the track
tiles = np.array([
    [3, 2, 3],
    [2, 11, 2],
    [3, 2, 3]
])
orient = np.array([
    [1, 1, 0],
    [0, 0, 0],
    [2, 1, 3]
])

# Creation of the track
track = Track(tiles, orient, 'Test track')

# Save the track
track.save_txt('track.txt')
# Make png file
track.save_img('track.png')
# Make markdown file
track.save_md('track.md', 'Easy track')

For more details, see the documentation here.

Links

Author

Quentin Deschamps: [email protected]

License

MIT