Skip to main content

A library to design line following tracks for robots

Project description

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: quentindeschamps18@gmail.com

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

line-track-designer-0.0.2.tar.gz (1.2 MB view hashes)

Uploaded Source

Built Distribution

line_track_designer-0.0.2-py3-none-any.whl (1.2 MB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page