Merge pull request #15 from plottertools/tatarize/G20-corrections

G20 units in defaults are imperial rather than mm

Author: tatarize

README.md

@@ -97,10 +97,10 @@ All of the options below default to an empty text which means no output is gener
 ### Segment formatting
 `gwrite` uses `.format()` encoding which means that data elements must be encapsulated in `{}` brackets. This provides a particular syntax token which differs from between elements.
 For example every element except `layer_join` and `segment_join` accepts the value of `index`. You would encode that in the text as `{index:d}` the d denotes an integer value. If you need to have a `{` value in your text you would encode that as `{{` likewise you would encode a `}` as `}}`.
-- `layer_start`: Accepts `index` the current layer number and `layer_id` as vpype layer ID.
-- `layer_end`: Accepts `index` the current layer number and `layer_id` as vpype layer ID.
-- `line_start`: Accepts `index` the current line number.
-- `line_end`: Accepts `index` the current line number.
+- `layer_start`: Accepts `index` the current layer index starting from 0, `index1` the current layer number starting from 1, and `layer_id` as vpype layer ID.
+- `layer_end`: Accepts `index` the current layer index starting from 0, `index1` the current layer number starting from 1,  and `layer_id` as vpype layer ID.
+- `line_start`: Accepts `index` the current line number starting from 0, `index1` the current line number starting from 1, and `layer_index`, `layer_index1`, and `layer_id` values for the current layer this line is within.
+- `line_end`: Accepts `index` the current line number starting from 0, `index1` the current line number starting from 1, and `layer_index`, `layer_index1`, and `layer_id` values for the current layer this line is within.
 
 The segments accept a lot of values that may be useful statistics for various formats:
 * `index`: index of the particular coordinate pair. eg `{index:d}`

setup.py

@@ -5,7 +5,7 @@
 
 setup(
     name="vpype-gcode",
-    version="0.8.2",
+    version="0.9.0",
     description="vpype gcode plugin",
     long_description=readme,
     long_description_content_type="text/markdown",

vpype_gcode/bundled_configs.toml

@@ -1,12 +1,13 @@
-[gwrite.ninja]
+
+[gwrite.gcode]
 document_start = "G20\nG17\nG90\n"
-segment_first =  "M380\nG00 X{x:.4f} Y{y:.4f}\nM381\n"
+segment_first = "G00 X{x:.4f} Y{y:.4f}\n"
 segment = "G01 X{x:.4f} Y{y:.4f}\n"
 document_end = "M2\n"
-unit = "mm"
+unit = "in"
 
-[gwrite.gcode]
-document_start = "G20\nG17\nG90\n"
+[gwrite.gcodemm]
+document_start = "G21\nG17\nG90\n"
 segment_first = "G00 X{x:.4f} Y{y:.4f}\n"
 segment = "G01 X{x:.4f} Y{y:.4f}\n"
 document_end = "M2\n"
@@ -17,7 +18,7 @@ document_start = "G20\nG17\nG91\n"
 segment_first = "G00 X{dx:.4f} Y{dy:.4f}\n"
 segment = "G01 X{dx:.4f} Y{dy:.4f}\n"
 document_end = "M2\n"
-unit = "mm"
+unit = "in"
 
 [gwrite.csv]
 document_start = "#Operation, X-value, Y-value\n"
@@ -48,3 +49,34 @@ segment_first = "{ix:d} {iy:d} l"
 segment = "{idx:d} {idy:d} "
 line_end = '"/>'
 layer_end = "</g>"
+
+[gwrite.BBC-GL]
+document_start = ""
+layer_start = "F{index1:d}\n"
+segment_first = "C{x:.0f},{y:.0f};HK\n"
+segment = "C{x:.0f},{y:.0f};IK\n"
+document_end = "F0\n"
+scale_x = 10
+scale_y = 10
+unit = "mm"
+
+[gwrite.ninja]
+document_start = "G21\nG17\nG90\nG28\n"
+segment_first =  "G1 Z3 F10000\nG0 X{x:.4f} Y{y:.4f} F15000\nG1 Z6 F6000\n"
+segment = "G1 X{x:.4f} Y{y:.4f} F10000\n"
+document_end = "\nG1 Z0 F1000\nG1 X0 Y0 F1000\nM2\n"
+unit = "mm"
+
+[gwrite.step_motor]
+document_start = "$H (unlock by homing)\nG21 (unit is mm)\nG17 (work in XY plane)\n"
+segment_first =  "G91 Z-10 (pen up)\nG90 X{x:.4f} Y{y:.4f} (travel)\nG91 Z+13 (pen down)\nG90 (absolute position)\n"
+segment = "G01 X{x:.4f} Y{y:.4f} (draw)\n"
+document_end = "G91 Z-10 (pen up)\nG90 X0 Y0 (travel)\nM2 (end)\n"
+unit = "mm"
+
+[gwrite.step_motor_relative]
+document_start = "$H (unlock by homing)\nG21 (unit is mm)\nG17 (work in XY plane)\nG91 (relative position)\n"
+segment_first =  "G01 Z-10 (pen up)\nG00 X{dx:.4f} Y{dy:.4f} (travel)\nG01 Z+13 (pen down)\n"
+segment = "G01 X{dx:.4f} Y{dy:.4f} Z+0.01 (draw with minimum pressure)\n"
+document_end = "G01 Z-10 (pen up)\nG90 X0 Y0 (travel to origin)\nM2 (end)\n"
+unit = "mm"

vpype_gcode/gwrite.py

@@ -85,11 +85,23 @@ def gwrite(document: vp.Document, output: typing.TextIO, profile: str):
     for layer_index, layer_id in enumerate(document.layers):
         layer = document.layers[layer_id]
         if layer_start is not None:
-            output.write(layer_start.format(index=layer_index, layer_id=layer_id))
+            output.write(
+                layer_start.format(
+                    index=layer_index, index1=layer_index + 1, layer_id=layer_id
+                )
+            )
         lastlines_index = len(layer) - 1
         for lines_index, line in enumerate(layer):
             if line_start is not None:
-                output.write(line_start.format(index=lines_index))
+                output.write(
+                    line_start.format(
+                        index=lines_index,
+                        index1=lines_index + 1,
+                        layer_index=layer_index,
+                        layer_index1=layer_index + 1,
+                        layer_id=layer_id,
+                    )
+                )
             segment_last_index = len(line) - 1
             for segment_index, seg in enumerate(line):
                 x = seg.real
@@ -127,11 +139,21 @@ def gwrite(document: vp.Document, output: typing.TextIO, profile: str):
                 last_x = x
                 last_y = y
             if line_end is not None:
-                output.write(line_end.format(index=lines_index))
+                output.write(
+                    line_end.format(
+                        index=lines_index,
+                        index1=lines_index + 1,
+                        layer_index=layer_index,
+                        layer_index1=layer_index + 1,
+                        layer_id=layer_id,
+                    )
+                )
             if line_join is not None and lines_index != lastlines_index:
                 output.write(line_join)
         if layer_end is not None:
-            output.write(layer_end.format(index=layer_index, layer_id=layer_id))
+            output.write(
+                layer_end.format(index=layer_index, index1=layer_index + 1, layer_id=layer_id)
+            )
         if layer_join is not None and layer_index != lastlayer_index:
             output.write(layer_join)
     if document_end is not None: