Skip to main content

Convert strings to gcode commands.

Project description

TextToGcode

PyPI version License: GPL v3

A python library you can utilize to create custom gcode commands from a string. Intended to be used to engrave or draw text with cnc machines.

numbers

Installation

install with pip install TextToGcode or download the file from the github if you want to use via the command line

Command Line Usage

navigate to the location of TextToGcode.py and run it with

python3 TextToGcode.py "TEXT" SIZE ROTATION MODE FEEDRATE "ON COMMAND" "OFF COMMAND" "FAST COMMAND" "SLOW COMMAND"

the important part is that all multi word arguments are surrounded with quotation marks as seen above

Library Usage

import into your project with from ttgLib.TextToGcode import ttg

Then you can call the ToGcode function with your arguments to output or return your gcode as a file or list:

ttg(TEXT, SIZE, ROTATION, MODE, FEEDRATE).toGcode("ON COMMAND", "OFF COMMAND", "FAST COMMAND", "SLOW COMMAND")

Explanation of arguments:

Text: a string for the text you want to be transformed to gcode, accepted characters are a-z, 0-9

Size: integer that represents the scale of the text in mm

Rotation: integer in degrees of the rotation of the text

Mode: a string specifying the mode of return.

  • Return: returns a string of gcode commands
  • File: generates an output.gcode file in the same directory
  • visualize: returns a raw list of tuples (if you want to plot them using matplotlib to visualize your path)

Feedrate: integer used to specify the feed rate for the gcode operations

On Off Fast Slow Commands: string commands for certain gcode operations. ex:

  • ON: "M03 S500"
  • OFF: "M05 S0"
  • FAST: "G0"
  • SLOW: "G1"

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

TextToGcode-1.3.0.tar.gz (19.6 kB view hashes)

Uploaded Source

Built Distribution

TextToGcode-1.3.0-py3-none-any.whl (20.3 kB 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