5. CNC G-code Generator – Snapmaker

5.1 CNC Carving Workflow

Create a project

⇩

Project settings

⇩

Import an object

⇩

Draw an object (alternative)

⇩

Edit the object

⇩

Create a toolpath

⇩

Generate the G-code file

⇩

Preview the G-code file

⇩

Export the G-code file

⇩

Start CNC carving

5.2 Supported File Formats

Luban supports the following file formats:

Custom Files (*.svg *.png *.jpg *.jpeg *.bmp *.dxf *.stl) – default
JPEG format (*.jpg*.jpeg)
PNG format (*.png)
BMP format (*.bmp)
SVG format (*.svg)
DXF format (*.dxf)
STL format (*.stl)

5.3 Get Started

To create a CNC carving project, follow these steps:

1. Create a project.

Option 1: Enter the Home window, and go to the Get Started pane.

Option 2: Enter the Home window, and go to the menu bar.

2. Select 3-axis or 4-axis.

3. Job Setup

Job Setup allows you to set the Work Size and where the Work Origin will be.

3-axis: Set the Work Size (Width and Height of the material) and the position of the Work Origin.
4-axis: Set the Work Size (Length and Diameter of the material) and the position of the Work Origin.

5.4 Main Toolbar

5.4.1 Home

Click to enter the Home window.

5.4.2 Workspace

Click to enter the Workspace window.

5.4.3 Save

Click to save the current project.

5.4.4 Undo

Click to reverse the last action.

5.4.5 Redo

Click to reverse the last Undo.

5.4.6 Job Setup

Set the work size and where the work origin will be.

5.4.7 Top

Click to move the selected object to the top of the stack.

5.4.8 Bottom

Click to move the selected object to the bottom of the stack.

5.4.9 STL 3D View

Click to enable or disable the 3D view of STL objects.

5.5 Edit

5.5.1 Import Projects

To import projects to Luban, do one of the following:

Enter the Home window, and click Open Project, and select a local project.
On the menu bar, click File > Open Project, and select a local project.
On the menu bar, click File > Case Library, and select a built-in project.
On your computer, double-click to run the local project.

5.5.2 Import Objects

To import objects to Luban, do one of the following:

On the toolbar, click and select an object.
On the menu bar, click File > Import, and select an object.
Drag and drop an object to Luban.

5.5.3 Draw Shapes

To draw vector shapes, including rectangles, ellipses, and circles for CNC carving, follow these steps:

1. On the toolbar, click or to select a shape.

2. On the canvas, click the first point wherever you want the shape placed, draw the shape as you like, and then release it.

5.5.4 Edit Graphics or Models

To select a processing mode for graphics or models, select the graphics or models, and click a mode on the configuration bar.

Vector

Converts the object to a vector graphic.

Relief

Converts the object to a greyscale graphic. To carve reliefs, you are recommended to use raster graphics for processing.

Model

Set the orientation and image density of the 3D model.

Here is a table showing the available processing choices of different file formats.

Vector Parameters

Show Original Image
Shows the original image.

Relief Parameters

Show Original Image
Shows the original image.

Invert
Inverts the color of images, white becomes black, and black becomes white.

Model Parameters

Orientation
Set the projection orientation of the 3D model. The face of the model you set will be clamped by the 3-jaw Chuck.

Image Density
Set the resolution of the greyscale image generated by the 3D model. The bigger the value is, the more details your model will have.

5.5.5 Add Text

To add text for CNC carving, follow these steps:

1. On the toolbar, click to add text.

2. Select the text box, and enter the content on the configuration bar where you can also adjust the font and font size.

Text
Enter the content you want to CNC carve.

Font
Select the font of the text.

Font Size
Select the font size of the text.

5.5.6 Transformation

To adjust the properties of the object, do one of the following:

Drag the object
- Move
  Click and hold the object, move it to the target position , and then release it.

- Scale
  Click the object, hold any of the eight circles to resize the object, and then release it.

- Rotate
  Click the object, hold the top circle to rotate the object, and then release it.

- Mirror
  Click the object, hold any of the eight circles to rotate the object until the circle crosses the diagonal point or opposite point, and then release it.

Use the configuration bar
- Move
  Enter the value to change the position of the object.

- Size
  Enter the value to change the size of the object.

- Rotate
  Enter the value to change the angle of the object.

- Flip
  Click to flip the object horizontally. Click to flip the object vertically.

5.6 Process

5.6.1 Create Toolpaths

To create and configure toolpaths, follow these steps:

1. Select one or more object(s).

2. Click Create Toolpath.

3. Set parameters of the toolpath on the pop-up Toolpath Settings window, and click Save.

If you select multiple objects, only objects of the same graphic types (vector or raster) can generate a single toolpath.

5.6.2 Toolpath Parameters

Name

Enter the toolpath name.

Method

Select the method to process the object. Different processing modes have certain restrictions on their processing method.

If the Processing Mode is Vector, or you add vector text:
- On the Path
  Carves along the shape of the object.
- Outline
  Carves along the outline of the object.
- Fill
  Carves away the inner area of the object.
- Target Depth
  Set the depth of the object to be carved. The depth should be smaller than the flute length.

If the Processing Mode is Relief or 3-axis Model:
- Carve
  Carves the object into the shape that you want.
- Target Depth
  Set the depth of the object to be carved. The depth should be smaller than the flute length.
- Allowance
  Set the amount of the material remaining on the object that needs to be carved in future operations.

If the Processing Mode is 4-axis Model:
- Rotation
  The X axis is fixed during carving. It can carve a smoother surface at a fast speed, but not suitable for complicated 3D models.
- Linkage
  The X, Y, Z, and B axes will move during carving. It is designed for carving complicated 3D models, at the cost of working speed and surface smoothness.
- Allowance
  Set the amount of the material remaining on the object that needs to be carved in future operations.

Tool

Tool
Select a tool for the carving job. Luban provides you with default tool profiles for carving common materials or the epoxy tooling board. By clicking , you can customize the tool profiles and material profiles based on your needs.

Work Speed
Set the speed at which the tool moves on the material when it is carving.

Plunge Speed
Set the speed at which the tool is driven down into the material.

Stepdown
Set the distance along the Z axis per step that the tool is plunged into the material.

Stepover
Set the space between parallel toolpaths.

Jog

Jog Speed
Set the speed at which the tool moves on the material when it is not carving.

Jog Height
Set the distance between the tool and the material when the tool is not carving.

Stop Height
Set the distance between the tool and the material when the tool stops.

Tab

Tabs are the small segments of uncut areas that hold the pieces in place. After the carving job is done, you can manually remove these tabs and extract your pieces from the material. This setting appears only when the Processing Mode is Vector, or you add vector text.

Use Tab
Use tabs to hold the pieces in place.

Tab Height
Set the height of tabs.

Tab Space
Set the distance between each tab.

Tab Width
Set the width of tabs.

5.6.3 Tool Settings

To customize tool profiles, follow these steps:

1. On the Toolpath List, click Create Toolpath or double-click a toolpath.

2. On the Toolpath Settings window, go to the Tool Settings panel and click .

3. On the Tool Settings window, you can customize and manage tool profiles.

Create Profiles

1. Click Create.

2. Select Create Material or Create Carving Tool.

3. Enter the material or tool name. While creating a carving tool, you also need to select the material type to which the created tool belongs.

4. Click Save.

Copy Profiles

Select a material or tool, and click Copy to copy its profile.

Import & Export Profiles

To import profiles, click and select a tool profile. The profiles imported will appear at the bottom of the list.
To export profiles, select the tool profile and click to save it to the local device.

Currently, Luban only supports importing files that were exported from Luban.

Rename Profiles

To rename profiles, click the profile and enter a new name.

Delete Profiles

To delete profiles, select the profile and click .

5.6.4 Configure Toolpaths

To configure a toolpath, do one of the following:

On the Toolpath List, double-click a toolpath. On the pop-up Toolpath Settings window, modify the values, and click Save.

On the Toolpath List, select a toolpath. On the General Parameters panel, modify the values.

On the Toolpath List, select a toolpath. On the General Parameters panel, click More, modify the values on the pop-up Toolpath Settings window, and click Save.

After a toolpath is created, you cannot delete the object. Otherwise, its toolpath created will be deleted together.

5.6.5 Delete Toolpaths

To delete a toolpath, select the toolpath on the Toolpath List and click .

5.6.6 Sort Toolpaths

When a project has multiple toolpaths, you can set the processing sequence of all toolpaths if needed. The machine will process the toolpaths in the sequence that they are displayed from top to bottom on the Toolpath List. To adjust the processing sequence, select a toolpath, and click or .

5.6.7 Show or Hide Toolpaths

To show or hide a toolpath, click or on the Toolpath List.

Visible toolpaths will appear in the Preview view and be generated to a G-code.
Hidden toolpaths will not appear in the Preview view nor be generated to a G-code.

5.6.8 Preview

Click Generate G-code and Preview to generate the G-code file and preview the toolpath.

Zoom in or out to inspect the details or panorama of the toolpath.
The selected toolpath will be rendered in blue in the Preview view.
On the Toolpath List, click or to preview the toolpath selectively.
Tick Toolpath or Simulation to select the preview type.

5.7 Carve

5.7.1 Generate G-code Files

To generate G-code files, click Generate G-code and Preview. Hidden toolpaths will not be generated to a G-code file.

5.7.2 Export G-code Files

To export G-code files, do one of the following:

Click Export > Load G-code to Workspace to load the file to Workspace. Set the work origin and start CNC carving via Luban or Touchscreen.
Click Export > Export G-code to File to save the file to your USB flash drive. Set the work origin and start CNC carving via Touchscreen.

5.7.3 Start Carving via Luban

To start CNC carving via Luban, follow these steps:

1. On the CNC G-code Generator, click Export > Load G-code to Workspace on the configuration bar.

2. On Workspace, go to the Connection panel. Click Serial Port or Wi-Fi, select the serial port or machine model on the drop-down list, and click Connect.

For detailed instructions on connection, see 6.1 Connection.

3. On Workspace, set the work origin on the configuration bar.

4. On Workspace, click on the top-left corner to start carving.
If you connect Luban to the CNC carver via USB cable, keep the cable connected until the carving job is completed. Otherwise, the job will be stopped.

5.7.4 Start Carving via Touchscreen

To start CNC carving via Touchscreen, do one of the following:

Option 1

1. On the CNC G-code Generator, click Export > Load G-code to Workspace on the configuration bar.

2. On Workspace, go to the Connection panel. Click Wi-Fi, select your machine model on the drop-down list, and click Connect.

For detailed instructions on connection, see 6.1 Connection.

3. On Workspace , click Send to Device via Wi-Fi to transfer the G-code file to Touchscreen.

4. On Touchscreen, tap Disconnect > Start > Local to find the G-code file. Set the work origin and start carving.

Option 2

1. On the CNC G-code Generator, click Export > Export G-code to File on the configuration bar.

2. Save the G-code file to the USB flash drive.

3. Insert the USB flash drive into the Controller of the machine.

4. On Touchscreen, tap Disconnect > Start > USB to find the G-code file. Set the work origin and start carving.