Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/barrenszeppelin/humanize-gcode
Annotates GCode files with human readable descriptions of commands
https://github.com/barrenszeppelin/humanize-gcode
gcode gcode-viewer human-readable python3 utility
Last synced: 8 days ago
JSON representation
Annotates GCode files with human readable descriptions of commands
- Host: GitHub
- URL: https://github.com/barrenszeppelin/humanize-gcode
- Owner: BarrensZeppelin
- License: mit
- Created: 2018-06-09T19:43:16.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-12-09T14:20:28.000Z (17 days ago)
- Last Synced: 2024-12-09T15:27:36.641Z (17 days ago)
- Topics: gcode, gcode-viewer, human-readable, python3, utility
- Language: Python
- Homepage:
- Size: 62.5 KB
- Stars: 11
- Watchers: 2
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# humanize-gcode
A tool for explaining the commands in machine readable GCode files.
Based on the specified GCode flavour, the tool parses a list of GCode commands and their description from the flavour's documentation. With this library it parses the input file and explains the effect of each command.
#### Installation
The utility is available on PyPi, so it can be installed with `pip`:
`pip3 install humanize-gcode`
#### Usage
The package comes with the executable script `hucode` that accepts two arguments. The GCode flavour (currently only `marlin/smoothie` are supported) and the name of the file to annotate (or `-` for stdin).
##### Example usage
`~ hucode smoothie testfile.gcode`
![Example output](https://i.imgur.com/u87tTqs.png)
#### TODO
- More output formats (and possibly customization?)
- More supported GCode flavours
- Use command arguments to influence annotation