update of the documentation inside readme file

This commit is contained in:
adricen
2021-04-29 11:40:18 +02:00
parent 49f24f6d7f
commit 2f11017bbf
2 changed files with 26 additions and 8 deletions

View File

@@ -4,7 +4,10 @@ This is the official repository for the XY Plotter Tool Inkscape extension.
## Purpose
This extension work for the [DIY XY Plotter High Precision Drawbot](https://www.aliexpress.com/item/32917861259.html?spm=a2g0s.9042311.0.0.3d9f6c37xpT5iS) on Ali Express
This extension work for the [DIY XY Plotter High Precision Drawbot](https://www.aliexpress.com/item/32917861259.html?spm=a2g0s.9042311.0.0.3d9f6c37xpT5iS)
* This is made for Inkscape 1.0 and above.
* This machin is using GRBL Control with GRBL Arduino Shield
## Installation
@@ -14,21 +17,34 @@ Unzip the files directly into the Inkscape user extensions folder. Inkscape list
Restart Inkscape and you're done.
## Documentation
## Gcode Panel
## Basic command
> Inside `Inkscape > Extension > Generate GCode for XY Plotter > XY Plotter tool from Love Open Design`
* Pen Up: `M5 S0`
* Pen Down: `M3 S1000`
* Pen Delay: `P4 P<your delay ms>`
* Pen Speed Movement: `G1 F<your speed>`
![XY Plotter tool panel](img/GcodePanelByLOD.jpeg)
| Name | Definition | Default | Gcode Result |
|---|---| --- | --- |
| **Drawing On Command** | Gcode commande to lower down the Z-axis | `M3` | `M3 S1000` |
| **Drawing Off Command** | Gcode commande to upper down the Z-axis | `M5` | `M5 S0` |
| **Pen Up Travel speed** | Travel speed with Pen Up | `3000` | `G1 F3000` |
| **Pen Down Travel speed** | Travel speed when drawing | `1500` | `G1 F1500` |
| **Pen Active Power** | command value to lower the pen | `1000` | `M3 S1000` |
| **Pen On Delay** | Delay after pen down and before drawing | `0,1` | `G4 P0.1` |
| **Pen Off Delay** | Delay after pen up and before moving | `0,2` | `G4 P0.2` |
| **Passes** | Number of Passes | | |
| **Pass Depth** | *relative to cnc milling* | `1,0` | |
| **Directory** | path directory to save your file in absolute | | |
| **Filename + numeric value** | the numeric value increment your file with the same name | `output.gcode` | |
| **All Units** | **Important** Be sure to setting everything up to the same unit inside Inkscape - Document Units, Inkscape Units and </br>this output units otherwise it mae some stranges things | `mm` | |
### Custom G-code Header and Footer
Add "header" and "footer" text files without extensions in your destination directory to add custom commands. Don't forget to add a new line at the end of these two files.
If no files are detected the default values are :
- Header : G90 ; Absolute positioning
- Header : G90 ; Absolute positioningon the
- Header : G0 Z0 ; Display path inside GRBL Control
- Footer : G1 X0 Y0 ; Move to X0 Y0
## For developers
@@ -38,3 +54,5 @@ Pull requests are welcome. Just make sure to test your code on both Python >=2.6
## Credits
This inkscape extension is adapted from [J-Tech-Photonics-Laser-Tool](https://github.com/JTechPhotonics/J-Tech-Photonics-Laser-Tool) inkscape extension.
Thanks to [StuartB44](https://www.instructables.com/member/StuartB44/) for his work and infos on [Instructables](https://www.instructables.com/Fix-for-Image-Not-Showing-in-GRBLControl/) to display GCode inside GRBL Control

BIN
img/GcodePanelByLOD.jpeg Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 149 KiB