first public release

Author: ludwig-austermann

.gitignore

@@ -0,0 +1,5 @@
+/target
+Cargo.lock
+simple.gcode
+test_transformed.gcode
+test.gcode

Cargo.toml

@@ -0,0 +1,13 @@
+[package]
+name = "gcodeplot"
+version = "0.1.0"
+authors = ["ludwig-austermann <ludwig.austermann@outlook.com>"]
+edition = "2018"
+
+# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+
+[dependencies]
+nannou = "0.16.0"
+clap = "3.0.0-beta.2"
+pest = "2.1.3"
+pest_derive = "2.1"

img/v0.2_screenshot.png

@@ -0,0 +1,43 @@
+# gcodeplot
+
+*Note that this app purposely supports only a very minimal subset of g-code features, since it is primarily supposed for educational purposes.*
+
+![Screenshot of version 0.2](v0.2_screenshot.png)
+![Screenshot of debugging features 0.2](v0.2_screenshot_debugging.png)
+*The pictures show a screenshot without debugging features and a zoomed screenshot of debugging features.*
+
+## Description
+
+`gcodeplot` is a simulated plotter of [G-code](http://en.wikipedia.org/wiki/G-code) files. It supports only
+- `G28`: **return to home** position
+- `G1 X{} Y{}`: **linear move**, move directly to `(X,Y)` (from current position)
+- `G2 X{} Y{} I{} J{}`: (part-)**circular move in clockwise direction**, move to `(X,Y)` (from current position) along a circle with center in `CURRENTPOS + (I,J)`
+- `G3 X{} Y{} I{} J{}`: (part-)**circular move in anticlockwise direction**, move to `(X,Y)` (from current position) along a circle with center in `CURRENTPOS + (I,J)`
+- `M280 P0 S{}`: **Set the pen** as follows, if `S>=40` down (which means it can draw) and else up
+- `;{}`: **comment**, which can be put on seperate line or after a regular command
+
+## Arguments and features
+
+The application is programmed in rust with the [nannou library](https://nannou.cc/) for displaying and the [pest library](https://pest.rs/) for parsing. It supports the following command line arguments:
+- `INPUT` (required): sets the gcode file to plot
+- `-d {}`, `--debug {}`: This enables debugging and can take values up to 3. While running, this can be changed with the key <kbd>D</kbd>
+- `-s {}`, `--scale {}`: This scales the whole view. While running you can access it with the <kbd>+</kbd>(might be <kbd>=</kbd> on your PC) and <kbd>-</kbd> keys
+- `-g {}`, `--gridsize`: This describes the gridsize used. While running you can access it with the key <kbd>G</kbd>
+- the flag `--hot`, for hot reloading of the gcode file. Alternatively you can update in the app with <kbd>R</kbd>
+- and other arguments as `--treshold`, `--wwidth` and `-wheight`.
+
+It furthermore supports a subcommand `transform`, which
+allows you to transform a file by translation and dilation.
+
+In the graphical app, a few keyboard commands are enabled. To increase a value corresponding to a <kbd>key</kbd>, just press <kbd>key</kbd> and to decrease press <kbd>shift</kbd> + <kbd>key</kbd>. For bigger steps combine these combination with a further <kbd>ctrl</kbd>.
+
+## Room to improve
+
+While the app can be used for many purposes, it is in a early development phase. Tests are missing and not everything is programmed the clever way. If you want to improve it feel welcome to contribute.
+
+TODO:
+- [ ] better loop management for hot reloading
+- [ ] more file maniplulation features
+- [ ] move in grid support
+- [ ] draw mode?
+- [ ] more debug options, e.g. show coordinates

img/v0.2_screenshot_debugging.png

@@ -0,0 +1,39 @@
+num = @{ int ~ ("." ~ ASCII_DIGIT*)? ~ (^"e" ~ int)? }
+int = { ("+" | "-")? ~ ASCII_DIGIT+ }
+
+expr = { cmd? ~ COMMENT? }
+cmd = _{ HOME | MOVE | PEN | ARC }
+HOME = { "G28" }
+MOVE = { "G1" ~ ((X ~ Y) | (Y ~ X)) }
+ARC = { (CLKW | ANTICLKW) ~ (
+	(X ~ (
+    	(Y ~ ((I ~ J) | (J ~ I))) |
+        (I ~ ((Y ~ J) | (J ~ Y))) |
+        (J ~ ((Y ~ I) | (I ~ Y)))
+    )) | (Y ~ (
+    	(X ~ ((I ~ J) | (J ~ I))) |
+        (I ~ ((X ~ J) | (J ~ X))) |
+        (J ~ ((X ~ I) | (I ~ X)))
+    )) | ( I ~ (
+    	(J ~ ((X ~ Y) | (Y ~ X))) |
+        (X ~ ((J ~ Y) | (Y ~ J))) |
+        (Y ~ ((J ~ X) | (X ~ J)))
+    )) | ( J ~ (
+    	(I ~ ((X ~ Y) | (Y ~ X))) |
+        (X ~ ((I ~ Y) | (Y ~ I))) |
+        (Y ~ ((I ~ X) | (X ~ I)))
+    ))
+) }
+CLKW = { "G2" }
+ANTICLKW = { "G3" }
+PEN = { "M280 P0 S" ~ num }
+
+X = { "X" ~ num }
+Y = { "Y" ~ num }
+I = { "I" ~ num }
+J = { "J" ~ num }
+
+file = _{ SOI ~ (expr ~ NEWLINE)* ~ expr? ~ EOI }
+
+WHITESPACE = _{ " " | "\t" }
+COMMENT = { ";" ~ (!NEWLINE ~ ANY)* }