https://snapmaker.com/product/snapmaker-original/downloads

https://snapmaker.com/product/snapmaker-2/downloads

https://luban.xyz/

1. Overview

1.1 Foreword

Snapmaker Luban (Luban hereafter) is a free, open-source slicing software tailor-made for Snapmaker machines. This manual offers useful tips to help you find your way around. To use versions previous to 4.0, see the Quick Start Guide or User Manual of your machine.

1.2 System Requirements

1.3 Version Requirements

To use Luban with your machine, download the designated versions:

• Snapmaker Original: Snapmaker Luban 3.1.0 or later
• Snapmaker Original with Z-axis Extension Module: Snapmaker Luban 3.12.2 or later
• Snapmaker Original Enclosure: Snapmaker Luban 3.9.0 or later
• Snapmaker 2.0 A150 or A250 or A350: Snapmaker Luban 3.1.0 or later
• Snapmaker 2.0 Enclosure: Snapmaker Luban 3.5.0 or later
• Snapmaker 2.0 Rotary Module: Snapmaker Luban 3.14.0 or later
• Snapmaker 2.0 Emergency Stop Button: Snapmaker Luban 3.14.0 or later
• Snapmaker 2.0 Air Purifier: Snapmaker Luban 3.15.0 or later

1.4 Download

Download Luban from one of the following:

• luban.xyz
• Snapmaker Forum.

1.5 Installation

To install Luban, follow these steps:

1.5.1 Windows

1. Double-click to run the EXE file.

2. Browse to select the target file folder, and click Install.

Unless you are specifically instructed to right-click (as in the right mouse button), you always left-click (as in the left mouse button) when the word click appears.

3. After Luban is installed, click Finish.

1.5.2 macOS

1. Double-click to run the DMG file.

2. Drag and drop Snapmaker Luban.app into the Applications file folder.

3. After Luban is copied, the installation is completed, and Luban is ready for use.

1.6 Development

Luban and the firmware of Touchscreen are open-source, accessible to anyone who can see, distribute, and compile the code as they see fit.

1.6.1 Develop Luban

To develop Luban, go to Snapmaker/Luban and read README at GitHub.

1.6.2 Firmware Tool

There are two types of firmware in Touchscreen—Controller firmware and Module firmware that you can access. To find the Firmware Tool, click Help > Firmware Tool on the menu bar.

To develop the firmware, follow these steps:

1. Get the source code from Snapmaker2-Controller or Snapmaker2-Modules at GitHub.

2. After contributing the code, go to the Firmware Tool on Luban. Click Choose File to import the code file, click Compile and Export to convert it to the file format that can be saved and updated via USB flash drive.

1.7 Settings

On the menu bar, click Settings to set the language and machine preferences.

1.7.1 Language Settings

On the menu bar, click Settings > Language, and a pop-up window will be displayed. Go to the Language pane, click the drop-down list to select your preferred language, and click Save.

1.7.2 Machine Settings

On the menu bar, click Settings > Machine Settings, and a pop-up window will be displayed. Go to the Machine pane, click the drop-down list to select your machine model, and click Save.

2. User Interface

2.1 Interface Overview

2.1.1 Home

Contains five panes, including the hidden menu bar, jumping, Get Started, Case Library, and Help.

Menu bar

Includes File, Edit, Window, Settings, and Help. It provides access to functions, including opening files, interacting with Luban, or providing helpful documentation or tutorials.

Jumping

Click to switch between Home and other windows, including the 3D Printing G-code Generator, Laser G-code Generator, CNC G-code Generator, and Workspace.

Get Started

Get started by importing projects or entering the 3D Printing G-code Generator, Laser G-code Generator, CNC G-code Generator, or Workspace.

Case Library

Provides you free, delicate 3-axis and 4-axis cases.

Help

Provides useful resources, including the software manual, video tutorials, and relevant websites.

2.1.2 3D Printing G-code Generator

Contains five panes, including the hidden menu bar, main toolbar, toolbar, configuration bar, and printing area.

Main Toolbar

Contains frequently used tools, including Home, Workspace, Save, Undo, and Redo.

Toolbar

Import objects and edit the properties related to the objects.

• Import Objects
  Click  to import an object, or drag an object to Luban.
  
  
• Edit Objects
  Edit the position, size, or placement angle of the objects, or add supports to the objects.

Configuration Bar

Set the material and printing settings, generate G-code files, and preview the printing path.

Printing Area

Displays the 3D objects that you are editing, slicing, or previewing.

2.1.3 Laser G-code Generator

Contains five panes, including the hidden menu bar, main toolbar, toolbar, configuration bar, canvas, and preview area.

Main Toolbar

Contains frequently used tools, including Home, Workspace, Save, Undo, and Redo, Job Setup, Top, Bottom, and Camera Capture.

Toolbar

Import objects and edit the properties related to the objects.

• Import Objects
  Click  to import an object, or drag an object to Luban.
  
  
• Select Objects
  Click to select the object, which will be highlighted in blue when selected.
  
  
• Draw Objects
  Draw rectangles, ellipses, and circles, or add text.

Configuration Bar

Transform objects, create toolpaths, generate G-code files, and preview toolpaths.

• Edit Panel
  The Edit panel shows the property related to object. When an object is selected, Luban displays this panel where you can transform the object, switch the Processing Mode, or enter the Process panel.

• Process Panel
  The Process panel shows the Toolpath List and the relevant property of the toolpath. After the selected object is edited, you can create, edit, and sort the toolpaths of the object. Below the Toolpath List are the parameters you often use.

3-axis Canvas

Displays the 3-axis objects that you are editing or processing.

4-axis Canvas

Displays the 4-axis objects that you are editing or processing.

3-axis Preview Area

Displays the 3-axis objects that you are previewing.

4-axis Preview Area

Displays the 4-axis objects that you are previewing.

2.1.4 CNC G-code Generator

Contains five panes, including the hidden menu bar, main toolbar, toolbar, configuration bar, canvas, and preview area.

Main Toolbar

Contains frequently used tools, including Home, Workspace, Save, Undo, and Redo, Job Setup, Top, Bottom, and STL 3D View.

Toolbar

Import objects and edit the properties related to the objects.

• Import Objects
  Click  to import an object, or drag an object to Luban.
  
  
• Select Objects
  Click to select the object, which will be highlighted in blue when selected.
  
  
• Draw Objects
  Draw rectangles, ellipses, and circles, or add text.

Configuration Bar

Transform objects, create toolpaths, generate G-code files, preview toolpaths, and simulate operation results.

• Edit Panel
  The Edit panel shows the property related to object. When an object is selected, Luban displays this panel where you can transform the object, switch the Processing Mode, or enter the Process panel.

• Process Panel
  The Process panel shows the Toolpath List and the relevant property of the toolpath. After the selected object is edited, you can create, edit, and sort the toolpaths of the object. Below the Toolpath List are the parameters you often use.

3-axis Canvas

Displays the 3-axis objects that you are editing or processing.

4-axis Canvas

Displays the 4-axis objects that you are editing or processing.

3-axis Preview Area

Displays the 3-axis objects that you are previewing or simulating.

4-axis Preview Area

Displays the 4-axis objects that you are previewing or simulating.

2.1.5 Workspace

Contains five panes, including the hidden menu bar, jumping, left sidebar, right sidebar, and preview area. You can enter Workspace from Home, the 3D Printing G-code Generator, Laser G-code Generator, or CNC G-code Generator.

Left Sidebar

Contains the Connection panel and Console panel. The Connection panel helps you to connect Luban with the machine, and the Console panel can read and execute the entered commands. If Luban detects any toolheads or modules, their corresponding operation panels will be displayed on the left sidebar.

Right Sidebar

Operate G-code files, control the movement of Linear Modules, and set the work origin before laser engraving or CNC carving.

Preview Area

Preview the G-code files and monitor the printing, engraving, or carving job. When Luban is connected to the machine, you can Run the G-code file, Pause or Stop running, or Close the G-code file.

2.2 Regular Interactions

2.2.1 Select Objects

2.2.2 Select Toolpaths

2.2.3 View Transformation

To view the transformation of 2D objects

To view the transformation of 3D objects

2.3 Keyboard Shortcuts

3. 3D Printing G-code Generator

3.1 3D Printing Workflow

Create a project

⇩

Project settings

⇩

Import an object

⇩

Place the object

⇩

Configure the slicing parameters

⇩

Slice the object

⇩

Preview the G-code file

⇩

Export the G-code file

⇩

Start printing

3.2 Supported File Formats

Luban supports the following file formats:

• STL ASCII format (*.stl)
• STL Binary format (*.stl)
• OBJ format (*.obj)

3.3 Get Started

To create a 3D printing project, do one of the following:

3.3.1 Option 1

1. Open Luban, and enter the Home window.

2. Go to the Get Started pane, and click 3D Printing to enter the 3D Printing G-code Generator window.

3. Now you can import objects to generate G-code files.

3.3.2 Option 2

1. Open Luban, and enter the Home window.

2. Go to the menu bar, and click File > New Project > 3D Printing to enter the 3D Printing G-code Generator window.

3. Now you can import objects to generate G-code files.

3.4 Main Toolbar

3.4.1 Home

Click to enter the Home window.

3.4.2 Workspace

Click to enter the Workspace window.

3.4.3 Save

Click to save the current project.

3.4.4 Undo

Click to reverse the last action.

3.4.5 Redo

Click to reverse the last Undo.

3.5 Placement

3.5.1 Toolbar

Import

Click to import objects to Luban.

Move

Click to move objects within the printing area. To move the object, do one of the following:

• Enter a value into the input box.

• Click and drag the corresponding axis marked in red, green, or blue. When you hover the selection arrow over one axis, the color of the hovered axis will appear darker.

• Click and drag the blue square. When you hover the selection arrow over the blue square, the color of the hovered square will appear darker.

The objects, even moved along the Z axis, will jump back to touch the bottom of the printing area. If the object extends beyond the printing area, it becomes red to alert you.

Scale

Click to scale objects within the printing area. To scale the object, do one of the following:

• Enter a value into the input box.

• Click and drag the corresponding axis marked in red, green, or blue. When you hover the selection arrow over one axis, the color of the hovered axis will appear darker.

Uniform Scaling

You can resize the object in a uniform or non-uniform way. When Uniform Scaling is enabled, the object enlarges or shrinks by one scale factor in all directions. When Uniform Scaling is disabled, the scaling can be applied to a single axis, without affecting other axes.

If the object extends beyond the printing area, it becomes red to alert you.

Scale to Fit

Click Scale to Fit to resize the object to fit the maximum printable area.

Rotate

Click to rotate objects within the printing area. To rotate the object, do one of the following:

• Enter a value into the input box.

• Click and drag the corresponding circle marked in red, green, or blue. When you hover the selection arrow over one circle, the color of the hovered circle will appear darker.
  • Drag the red circle, and the object will rotate around the X axis.
  • Drag the green circle, and the object will rotate around the Y axis.
  • Drag the blue circle, and the object will rotate around the Z axis.

Mirror

Click to mirror the object along the X, Y, or Z axis.

Manual Support

1. Click > Add Support to add manual supports as a supplement or alternative to auto supports. The red surfaces represent the overhang area that needs manual supports.

2. Click wherever you want the supports added, and click Done.

Custom Support

To adjust the support size, do one of the following:

• Before adding supports, click , enter a value into the input box, and click Add Support.
• After adding supports, select the support, and click  to resize the support.

To adjust the support position, do this:

• After adding supports, select the support, and click  to change its position.

3.5.2 Middle Pane

Object List

Shows or hides all objects on the printing area. You can click the object file to display the object, or click  to hide the object. Hidden objects will not be sliced when you click Generate G-code.

View Tool

With the view tool on the bottom-left corner, you can view the object from five angles.

• 3D View

• Front View

• Top View

• Left View

• Right View

Object Information

On the bottom-right corner, you can see the width, depth, and height of the object in millimeters.

Line Type

After the object is sliced, you can preview its printing path and line types. Each type of line is represented in a designated color. To view a certain type of line, tick the checkbox under the Line Type.

Layer View

To inspect the sliced object layer by layer, scroll up or down the scroll bar to control which layer can be displayed.

Progress Bar

Displays the slicing progress or previewing progress in percentage.

3.6 Context Menu

With the Context Menu, you can access additional functions related to the object on the printing area without cluttering the pane. To reveal the Context Menu, select the object, and then right-click it with the mouse.

3.6.1 Cut

Cut the selected objects and save them to the clipboard ready to paste to the printing area.

3.6.2 Copy

Copy the selected objects to the clipboard ready to paste to the printing area.

3.6.3 Paste

Paste the cut or copied objects from the clipboard to the printing area.

3.6.4 Duplicate

Duplicate the selected objects to the printing area.

3.6.5 Hide

Hide the objects. Hidden objects will not be sliced when you click Generate G-code.

3.6.6 Reset Model Transformation

Reset the scaling and rotation of the selected objects to their original status. But this action will not reset the current position of the object.

3.6.7 Center Models

Center the selected objects on the printing area.

3.6.8 Auto Rotate

Automatically place the selected objects at their optimal angle to ensure the best printing result.

3.6.9 Auto Arrange

Automatically arrange multiple objects to fit the printing area.

3.7 Slice

3.7.1 Material Settings

Material settings vary with material types. This panel enables you to customize the material types and pertinent parameters. On the configuration bar, click  on the Material Settings panel, and a pop-up window will be displayed.

Flow

Set the amount of filament extruded out of the nozzle.

Printing Temperature

Set the temperature of the nozzle during printing. The printing temperature varies with filament types. Set the printing temperature at a recommended range to fully melt the filament and thus ensure the best extrusion result.

Initial Layer Printing Temperature

Set the temperature of the nozzle while the toolhead is printing the initial layer which adheres to the Heated Bed. Printing at a slightly higher temperature improves the first layer adhesion.

Fan Speed

Set the fan speed at which the fan cools down the print while preventing the hot end from overheating.

Has Heated Bed

Use the Heated Bed or not. When enabled, the Heated Bed will be heated up to the target temperature to improve the adhesion between the Heated Bed and extruded filament. When disabled, whether you assemble the Heated Bed or not, the Bed will not be heated.

Heated Bed Temperature

Set the temperature of the Heated Bed during printing. To avoid warping, you are advised to heat the Bed during printing to keep the print cooling evenly.

Initial Heated Bed Temperature

Set the temperature of the Heated Bed while the toolhead is printing the initial layer which adheres to the Heated Bed. Keeping the Heated Bed at a slightly higher temperature can slow down the curing of the first layer and thus improve the initial layer adhesion.

3.7.2 Create Material

To customize the Material Settings, click Create or Copy to create new materials.

3.7.3 Printing Settings

Printing settings vary with models, material types, printing conditions, and printing needs. This panel enables you to customize the printing profiles. On the configuration bar, click  on the Printing Settings panel, and a pop-up window will be displayed.

Quality

• Layer Height
  Set the thickness of each layer in millimeters. Printing at a thicker layer height can decrease your printing time, at the cost of a smooth surface and rich details. On the flip side, printing at a thinner layer height increases the printing quality while costing you much more time.

• Initial Layer Height
  Set the thickness of the initial layer in millimeters, without affecting the thickness of other layers. With a thicker initial layer, your print can better adhere to the Heated Bed.

• Initial Layer Line Width
  Set the line width of the initial layer in millimeters. With a wider initial layer, your print can better adhere to the Heated Bed.

Shell

• Wall Thickness
  Set the thickness of the wall. The wall thickness should be the multiple of the nozzle diameter. The thickness divided by the nozzle diameter determines how many times the nozzle needs to extrude to fill the wall.

• Top Thickness
  Set the thickness of the top layers. The thickness divided by the layer height determines the number of the top layers. The more layers the top part has, the stronger and smoother it will be.

• Bottom Thickness
  Set the thickness of the bottom layers. The thickness divided by the layer height determines the number of the bottom layers. The more layers the bottom part has, the stronger and smoother it will be.

• Outer Before Inner Walls
  Prints outer walls before inner walls. When enabled, this setting can improve the smoothness of the print surface.

Infill

• Infill Density
  Set the amount of filament infilled inside the print. The more infill the print has, the stronger it will be.

• Infill Pattern
  Set the pattern of the filament infilled inside the print. The supported patterns are listed below:

• • Grid
  • Line
  • Triangle
  • Tri-Hexagon
  • Cubic
  • Cubic Subdivision
  • Octet
  • Quarter Cubic
  • Concentric
  • Zig Zag
  • Cross
  • Cross 3D
  • Gyroid

Speed

• Initial Layer Printing Speed
  Set the speed at which the first layer is printed. Printing at a lower speed improves the adhesion between the initial layer and the Heated Bed. To print at a higher speed without failure, you may need other actions to help the first layer adhere to the Bed.

• Infill Speed
  Set the speed at which the filament is infilled inside the print. Printing at a lower speed improves the infill quality at the cost of time.

• Outer Wall Speed
  Set the speed at which the outer wall is printed. Printing at a lower speed makes the outer surface smoother.

• Inner Wall Speed
  Set the speed at which the inner wall is printed. Printing at a lower speed makes the inner surface smoother.

• Top/Bottom Speed
  Set the speed at which the top and bottom layers are printed. Printing at a lower speed makes the top and bottom layers smoother.

• Travel Speed
  Set the speed at which the toolhead moves without extruding filaments. A faster travel speed not only saves the printing time substantially, but keeps the filament from oozing too much out of the nozzle. Whereas the hot nozzle in a fast movement is likely to hit your print.

• Initial Layer Travel Speed
  Set the speed at which the toolhead moves on the first layer without extruding filaments. Printing at a lower travel speed is less likely to pull the initial layer off the Heated Bed.

Retraction & Z-hop

• Enable Retraction
  The toolhead pulls back a specified length of the filament when the toolhead travels over the non-printable area. Retraction is the key to reducing stringing and constructing a cleaner print.

• Retract at Layer Change
  The toolhead pulls back the filament before it moves along the Z axis.

• Retraction Distance
  Set the length to extract. A value between 5 mm and 6 mm is recommended.

• Retraction Speed
  Set the speed at which the toolhead pulls back the filament. A value between 25 mm/s and 60 mm/s is recommended. The faster the toolhead retracts, the less oozing you will see, and the more friction the filament will encounter.

• Z-hop When Extracted
  The toolhead lifts along the Z axis when the filament is extracted. This setting increases the gap between the nozzle and print so that the hot nozzle will not hit the print or scratch the print surface.

Surface

• Spiralize Outer Contour
  Only prints the model surface with a continuous spiral path. This setting creates a seamless, smooth print while using relatively fewer filaments.

• Surface Mode
  Only prints the model surface, with no infill, top layers, or bottom layers. This setting can be used for enclosed or unenclosed models.

• Normal Mode
  Prints the infill, top layers, and bottom layers, except the model surface. This setting is only for enclosed models.

Heated Bed Adhesion Type

• Skirt
  Prints lines around the model to ensure that the filament flows well, the Heated Bed is leveled, and the bed surface has no blobs.

• Skirt Line Count
  Set the number of printed lines around the model. Multiple skirt lines help to prime your extrusion better for small models. Setting this value to 0 will disable the skirt.

• Brim
  Prints a flat area touching the print base to increase the bed adhesion and prevent warping.

• Brim Line Count
  Set the number of lines around the model. More brim lines enhance adhesion between the bed and model, but also reduces the printable area.

• Raft
  Prints a thick grid with a roof below the model.

• Raft Extra Margin
  Set the extra margin of the raft in millimeters. Increasing this margin will create a stronger raft while using more material and leaving less printable area.

Support

• Generate Auto Support
  Automatically generate supports for overhangs to prevent collapse due to gravity.

• Support Placement
  Adjusts the placement of the support structures.

• • Touching Heated Bed
    Adds supports that only touch the Heated Bed.

• • Everywhere
    Adds supports that not only touch the Heated Bed but can be printed on the model itself.

• Support Pattern
  Set the pattern of supports, including line, zig zag, and grid. Line is easy to remove and slightly stronger than zig zag. Grid provides sturdy supports while also being the hardest to remove.

• Support Density
  Set the density of support structures.

• Support Z Distance
  Set the top distance and bottom distance of the supports to the print. The distance determines if the structure can lend strong support to the print and if it can be easily removed from the print.

• Support Overhang Angle
  Set the angle at which overhangs need the support structures. The smaller angle you set, the more supports your print will be added.

3.7.4 Custom Parameter Visibility

The General Parameters panel displays frequently used printing parameters, including Layer Height, Infill Density, Wall Thickness, Heated Bed Adhesion Type, and Generate Auto Support. To customize visible parameters, click , tick the parameters on the pop-up window, and click Close to save your selection.

3.8 Preview

After setting the material parameters and printing parameters, click Generate G-code on the bottom corner of the configuration bar. Subsequently, Luban slices the object, and the printing area displays the G-code file generated. Now you can preview the G-code file using the Line Type and Layer View.

3.9 Print

3.9.1 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, and start printing via Luban or Touchscreen.
• Click Export > Export G-code to File to save the file to the USB flash drive, and start printing via Touchscreen.

3.9.2 Start Printing via Luban

To start printing via Luban, follow these steps:

1. On the 3D Printing 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 Connection.

3. On Workspace, click    on the top-left corner to start printing.

If you connect Luban to the printer via USB cable, keep the cable connected until the printing job is completed. Otherwise, the job will be stopped.

3.9.3 Start Printing via Touchscreen

To start printing via Touchscreen, do one of the following:

Option 1

1. On the 3D Printing 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 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 and start printing.

Option 2

1. On the 3D Printing 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 and start printing.

4. Laser G-code Generator

4.1 Laser Engraving 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 laser engraving or cutting

4.2 Supported File Formats

Luban supports the following file formats:

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

4.3 Get Started

To create a laser engraving 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.

4.4 Main Toolbar

4.4.1 Home

Click to enter the Home window.

4.4.2 Workspace

Click to enter the Workspace window.

4.4.3 Save

Click to save the current project.

4.4.4 Undo

Click to reverse the last action.

4.4.5 Redo

Click to reverse the last Undo.

4.4.6 Job Setup

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

4.4.7 Top

Click to move the selected object to the top layer.

4.4.8 Bottom

Click to move the selected object to the bottom layer.

4.4.9 Camera Capture

Capture images of the work platform as a background where you can place the object for laser engraving or cutting.

4.5 Edit

4.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.

4.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.

4.5.3 Draw Shapes

To draw vector shapes, including rectangles, ellipses, and circles for laser engraving or cutting, 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.

4.5.4 Edit Graphics

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

• B&W
  Converts the graphics into black and white.

• Greyscale
  Converts the graphics into grey monochrome, composed exclusively of shades of grey. Each pixel in greyscale carries an amount of light, ranging from 0 as the weakest amount of light, or dark, to 255 as the strongest amount of light, or white.

• Vector
  Converts the graphics into vector graphics, composed of paths.

• Halftone
  Converts the graphics into a halftone effect, composed of dots varying either in size or spacing.

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

All built-in objects in Luban will be processed in the Vector mode.

B&W Parameters

• Show Original Image
  Shows the original image.

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

• Threshold
  Set the proportion of the black pixels. Colors above this value will be rendered in white.

Greyscale Parameters

• Show Original Image
  Shows the original image.

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

• Contrast
  Set the disparity between darkness and brightness. The bigger the value is, the more obvious the contrast will be.

• Brightness
  Set the brightness of the image. The bigger the value is, the brighter the image will be.

• White Clip
  Set the threshold to turn the color that is not pure white into pure white. Zero is taken to be black, and 255 is taken to be white. Colors above this value will be rendered into pure white.

• Algorithm
  Select an algorithm for image processing. The eight algorithms are listed as below:
  • Floyd-Steinburg
  • Jarvis-Judice-Ninke
  • Stucki
  • Atkinson
  • Burkes
  • Sierra-2
  • Sierra-3
  • Sierra Lite

Vector Parameters

• Show Original Image
  Shows the original image.

• Invert
  Inverts the color of vector graphics, white becomes black, and black becomes white.

• Threshold
  Colors above this value will be rendered in white.

• Impurity Size
  Set the minimum size of impurities allowed to be shown.

Halftone Parameters

• Show Original Image
  Shows the original image.

• Type
  • Line
    Dots are arranged into lines.

• • Round
    Dots are arranged into rounds.

• • Diamond
    Dots are arranged into diamonds.

• Size
  Set the size of dots.

• Angle
  Set the rotation angle of the halftone image through the arrange of dots.

• Threshold
  Set the proportion of the black pixels. Colors above this value will be rendered in white.

4.5.5 Add Text

To add text for laser engraving or cutting, 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 laser engrave or cut.

• Font
  Select the font of the text.

• Font Size
  Select the font size of the text.

4.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.

4.6 Process

4.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 type (vector or raster) can generate a single toolpath.

4.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
    Draws the outline that consists of smooth straight lines, instead of dots.

• • Fill
    Draws the outline and fills the inner area of the object with lines.

• • • Movement Mode
      Set whether the object is filled with lines or dots. In this case, the outline of vector objects can only be filled with lines.

• • • Fill Interval
      Set the degree to which an area is filled with laser lines or dots. The minimal interval is 0.05 mm.

• If the Processing Mode is B&W, Greyscale, or Halftone:
  • Fill
    Fills the raster object with lines or dots, without drawing its outline.

• • Movement Mode
    Set whether the object is filled with lines or dots. Filling with dots has the best engraving result, but it will take a longer time. Though filling with lines will be faster, the engraving effect will not be as good as dot filling.

• • Line Direction
    Appears only when the Movement Mode is set as Line. Engraves the path in the horizontal, vertical, or diagonal direction.

• • Fill Interval
    Set the degree to which an area is filled with laser lines or dots. The minimal interval is 0.05 mm.

Speed

• Jog Speed
  Set the speed at which the toolhead moves when it is not engraving or cutting.

• Work Speed
  Set the speed at which the toolhead moves on the material when it is engraving or cutting.

• Dwell Time
  Appears only when the Movement Mode is Dot. Set how long the laser spot stays on when it is engraving a dot.

Pass

Appears only when the Processing Mode is Vector, or you add vector text.

• Number of Passes
  Set how many times the laser will trace the same path in a G-code file. A value between 1 and 5 is recommended.

• Z Step per Pass
  Set the amount at which the Laser Module is lowered with each pass. This setting is useful only when the machine engraves a multi-pass toolpath. The recommended value for the product of Number of Passes and Z Step per Pass is less than 5 mm.

Power

Set the laser power to engrave or cut the object.

4.6.3 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.

4.6.4 Delete Toolpaths

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

4.6.5 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 .

4.6.6 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.

4.6.7 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.

4.7 Engrave

4.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.

4.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 laser engraving via Luban or Touchscreen.
  If you use Camera Capture to add a background, you don’t need to set the work origin in Luban.
• Click Export > Export G-code to File to save the file to the USB flash drive. Set the work origin and start laser engraving via Touchscreen.

4.7.3 Start Engraving via Luban

To start laser engraving or cutting via Luban, follow these steps:

1. On the Laser 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 in the drop-down list, and click Connect.

For detailed instructions on connection, see Connection.

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

4. On Workspace, click  on the top-left corner to start laser engraving or cutting.

If you connect Luban to the laser engraver via USB cable, keep the cable connected until the engraving job is completed. Otherwise, the job will be stopped.

4.7.4 Start Engraving via Touchscreen

To start laser engraving or cutting via Touchscreen, do one of the following:

Option 1

1. On the Laser 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 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 laser engraving or cutting.

Option 2

1. On the Laser 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 laser engraving or cutting.

4.8 Camera Capture

Before using Camera Capture Snapmaker 2.0 machines, you should connect Luban to the machine, and calibrate the camera using the Touchscreen.

For how to calibrate the camera, tap Settings > Laser > Camera Calibration on Touchscreen.

4.8.1 Add Background

To add a background on the platform to place the object, follow these steps:

1. On the Laser G-code Generator, go to the main toolbar and click Camera Capture > Add Background.

2. On the pop-up Camera Capture window, click Start to capture nine images of the Laser Engraving and Cutting Platform.

3. If the captured images are perfectly stitched, click Confirm and go to step 5.
If not, click Calibrate and go to step 4.

4. Zoom in the image, and align the four corners of the blue quadrilateral with the engraved square until they are perfectly aligned. Click Confirm > Apply.

5. The stitched image will be loaded to the canvas as a background. Now you can place objects on the background for laser engraving.

4.8.2 Remove Background

To remove the added background, click Remove Background on the main toolbar.

5. CNC G-code Generator

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 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 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.

6. Workspace

6.1 Connection

On the Connection panel, you can connect Luban to the machine via Serial Port or Wi-Fi to execute online operations.

6.1.1 Via Serial Port

1. Insert the USB cable into your computer and the machine.

2. On the Connection panel, click Serial Port > .

3. Select the serial port on the drop-down list, and click Connect.

If you cannot find the port, unplug the USB cable and try again. For initial use, you should download and install the driver.

6.1.2 Via Wi-Fi

1. On the Connection panel, click Wi-Fi > .

2. Select your machine on the drop-down list, and click Connect.

3. On Touchscreen, tap Yes to confirm the Wi-Fi connection.

If you cannot find your machine on the drop-down list, click , enter your IP address, and click Confirm.

6.2 Console

On the Console panel, you can enter commands and press the Enter key to control the machine. For the list of common commands, see Use commands to troubleshoot.

6.3 G-code Files

On the G-code  Files panel, you can open, export, load, and send G-code files. After the G-code file is loaded to Workspace, you can click , , , or to operate the G-code file.

6.4 Control

On the Control panel, you can control the movement of the Linear Modules and Toolheads.

6.4.1 Linear Modules

After connection, you can use the buttons below to control the movement of the X, Y, Z, and B axes. If Luban detects the Laser Module or CNC Module, these buttons can also be used to set the work origin and run boundary.

6.4.2 Toolheads

If Luban detects the 3D Printing Module, Laser Module, or CNC Module, a corresponding control panel of the toolhead will appear.

3D Printing Module

Appears only when Luban detects the 3D Printing Module. On this panel, you can control the work speed, nozzle temperature, Heated Bed temperature, and filament loading or unloading.

Laser Module

Appears only when Luban detects the Laser Module. On this panel, you can enable or disable the Auto Mode, set the material thickness, and control the laser height, Z offset, work speed, as well as laser power.

The Fine-tune Work Origin feature, exclusive to the Laser Module of Snapmaker Original, can be used to fine-tune the work origin.

CNC Module

Appears only when Luban detects the CNC Module. On this panel, you can control the work speed and CNC spindle.

6.5 Macro

On the Macro panel, you can automate frequently used operations by creating and running macros. A macro is a series of commands and instructions that you group as a single command to accomplish an operation automatically.

6.6 Machine Setting

Exclusive to Snapmaker Original. After Luban is connected to the machine, you can enable or disable Door Detection and select the Z-axis Extension Module on the Machine Setting panel of the left sidebar.

7. Feedback

Your feedback is very much appreciated. If you have encountered any problem or would like to propose suggestions, contact us via one of the following:

• Email to support@snapmaker.com.
• Create issues from Snapmaker/Luban.

7.1 Report Problems

To solve the problem and reply to you as soon as possible, we need a clear and concise description of the problem. Here is a template:

1. Affected Versions
This issue is caused by version…

2. Is this a regression? (Optional)
Yes, the previous version in which this bug was not present was…

3. To Reproduce
Steps to reproduce this problem:
① Go to…
② Click…
③ Scroll down to…
④ See error…

4. Exception or Error (Optional)

7.2 Propose Suggestions

1. Is your feature request related to a problem? Please describe.
A clear and concise description of what the problem is. Ex. I'm always frustrated when...

2. Describe the solution you'd like
A clear and concise description of what you want to happen.

3. Describe alternatives you've considered
A clear and concise description of any alternative solutions or features you've considered.

4. Additional context
Add any other context or screenshots about the feature request here.