User can create new state tabs.

State tabs are displayed on main user interface and can include any parameter used by software whether its tool offset value, number of g-code line or absolute position of machine. By default, software will display only state tabs “GCode” and “IO”.

User can create up to 30 state tabs.

To create new state tab, access your PlanetCNC  install folder and locate Profiles folder. Open your profile folder and create new .txt file and name it State1.txt.

Even when state file is empty, it will be displayed as new state tab, under state panel. Default name of the tab will be its file name, in this case State1:

 

If state panel uses multiple state tabs, it would make sense to use more descriptive tab names. You can do this by simply adding desired <_name text > next to file name.

So, if we would like to change our State1 tab name into e.g.  Tool Offset, change name of the State1 file into: State1_Tool Offset.txt:

 

State tabs can be display any given parameter value or text. To display desired text, you can use label command:

label "Milk" 
label "Bread" 
label "Butter"

 

You can also change color of labels using colorname command:

label "Milk" colorname=#f8ff00
label "Bread" colorname=#21d841
label "Butter" colorname=#2c6bed

 

Since we will use tabs to display something more meaningful than shopping list, here is an example of Selected tool and Current tool parameter value display under label Tool:

label "Tool" 
param _selected_tool 0 "Selected Tool"
param _current_tool 0 "Current Tool"

 

Lets change colors and size of label and parameters:

label "Tool" colorname=#ffa500 size=35
param _selected_tool 0 "Selected Tool" colorname=#2c6bed color=#21d841 
param _current_tool 0 "Current Tool" colorname=#2c6bed color=#21d841 

 

Example of Work Position parameter values displayed under label Work Position, note that position values will be displayed  at three decimals :

label "Work Position" colorname=#ffa500 size=35
param _x 3 "Work X" size=32 colorname=#2c6bed color=#21d841 
param _y 3 "Work Y" size=32 colorname=#2c6bed color=#21d841 
param _z 3 "Work Z" size=32 colorname=#2c6bed color=#21d841

 

Parameter values can be displayed in decimal, boolean od HEX format. Here is an example of all three types of parameter value format display:

label "Value format" colorname=#ffa500 size=35
param _x 3 "Work X" size=32 colorname=#2c6bed color=#21d841 
param _hw_motors_en B "Motors Enable" colorname=#2c6bed color=#21d841
param _hw_limit X "Limit Hex" colorname=#2c6bed color=#21d841

 

With new state tabs you can also use values of default GCode and IO panels. You can also display controller input/output state values.

label "Panel and IO values" colorname=#ffa500 size=35

panel gcodes colorname=#2c6bed color=#21d841 
panel mcodes colorname=#2c6bed color=#21d841 
panel othercodes colorname=#2c6bed color=#21d841

io input colorname=#2c6bed size=32 name="Input LED's" color=#21d841 
io custom colorname=#2c6bed size=32 name="LED's" led="ES,LM,MT,ER,On,In,Ln,Jn,Cn" color=#21d841

 

As state tab values you can also use expressions. Here is an example of using DateTime function do display current time:

label "Date and Time" colorname=#ffa500 size=35
expr "DateTime()" DT "Current Time" colorname=#00a5ff color=#4bb725

 

This tutorial will explain how to correctly use Tool Offset / Measure  feature with fixed tool sensor using PlanetCNC TNG software and PlanetCNC motion controllers.

 

Fixed tool sensor

For fixed tool sensor we can use a dedicated tool measuring switch or, most basic solution, a standard micro switch fixed to machine table.

When tool activates tool sensor, controllers corresponding input is activated and software sets new tool offset value.

Example of fixed tool sensor used with Mk3 controller:

 

Connecting fixed sensor with PlanetCNC motion controller

MK3 controller:

 

Mk3/4 controller:

 

MK3DRV controller:

 

MK3ECO controller:

 

Configuring fixed tool sensor in  PlanetCNC TNG software

In PlanetCNC TNG under File/Settings/Program Options/Probe & Measure configure input pin that you intend to use for fixed tool sensor.

You can select between either Probe 1 or Probe 2 option. It doesn’t matter which one you choose.

 

Sensor input pin is selected from drop down menu:

Now that your sensor is connected and configured, it is best to activate sensor by hand to check if everything is functioning OK. Jog your machine (it can be in any direction) and see if machine stops when you activate sensor.

Under IO tab of main display check if input is activated correctly:

 

Now move  machine to position where fixed sensor is mounted. Make sure that tool is right above the center of fixed tool sensor or in case that you use micro switch, above the lever.

 

Write down Machine coordinates of  X and Y axis. These values will be used for configuration of sensors X and Y axis position:

 

Jog Z axis towards the sensor. When sensor is activated, write down Machine coordinate of  Z axis. This value will be used for configuration of sensor Z axis position:

We would like to emphasize that it is very important what kind of tool is used when obtaining Z axis position value, because all future tool measurements will be dependent on this value. That is why we call this tool also a default tool. Default tool should not be too long or too short. It should be some normal length.

Signs that your default tool was not suitable are usually Z axis plunging into machine table or Z axis activating limit switch after tool offset measurement.

 

Under File/Settings/Program Options/Offsets/Tool Offset/Measure Length, insert values that you previously wrote down for Sensor Position X,Y and Z:

 

Speed & Low:

Speed and Low are speed values of first and second tool offset measurement moves (only Z axis).

First reference move will be performed at Speed value. After fixed tool sensor is activated, machine retracts for switch click distance and starts with the second measurement move, but this time at Low speed value. Make sure that Speed value is not set too high to the point where fixed tool sensor, tool or machine could get damaged. Low value should be significantly lower that Speed value.

Safe Height: After both tool offset measurement moves are finished, machine will ascend to Safe Height value and return to previous position.

Switch Click Distance: This is the distance from the point where fixed tool sensor is activated and to the point when it is deactivated.

 

 

Measuring tool offset with  PlanetCNC TNG software

Tool offset measure procedure can be executed via menu item Machine/Tool Offset/Measure Length or  with left toolbar button:

Default sequence of Tool Offset Measure procedure:

-Machine will ascend to safe height at current machine position and move to fixed sensors XY position.

-Machine will descend towards fixed tool sensor with Speed value and when sensor gets activated, Z axis will retract for Switch Click Distance and measure tool offset again at Low speed value. Machine will stop and ascend to safe height.

-Software will set new tool offset value

-Machine will return back to XYZ position

 

Measure tool offset script file

If you would like to edit script code or have more in-depth look at the procedure itself, you can do that by opening script file.

You can access and edit script file in settings under File/Settings/Program Options/Scripts/Tool Offset/Measure Length and click button Edit Script.

Script file will open in TNG gcode editor. In order that Measure Length script file is generated and saved in your profiles Script folder, you need to click Save button.

 

This tutorial will explain how to correctly use Machine/Home  feature.

Homing procedure will reference machine axes and set machine work area.

 

First you would need to configure your machines step per unit values, motor & soft limits and limit switch inputs of controller:

How to set step per unit values in PlanetCNC TNG software

How to configure limit switch inputs of controller in PlanetCNC TNG software

How to set motor & soft limits in PlanetCNC TNG software

 

Homing procedure configuration

Homing procedure is configured in settings: File/Settings/Program Options/Home

 

 

Speed & Low:

Speed and Low are speed values of first and second axis reference moves.

First reference move will be performed at Speed value. After limit switch is activated, machine retracts for switch click distance and starts with the second reference move, but this time at Low speed value.

Make sure that Speed value is not set too high to the point where limit switch or machine could get damaged. Low value should be significantly lower that Speed value.

 

Order:

To set homing order of specified axis, select order number from drop down menu:

Direction:

To set homing direction of specified axis, click radio button of axis direction option, – or +. So, if your Y axis limit switch is mounted at the positive end of Y axis, you enable “+” for Y:

Switch Position:

Switch Position value is axis machine position at which corresponding axis limit switch gets activated. These values, to some degree, have already been obtained in How to set motor & soft limits in PlanetCNC TNG software tutorial.

For example, during Homing procedure when e.g. X axis is being referenced and its limit switch is activated, X axis will get assigned machine position value of Switch Position value.

To automatically populate all axis Switch Position values, click Copy Motor Limits button. However these values are not values of limit switch activation but previously obtained motor limit values…

 

Obtaining axis switch position values:

Slowly jog Z axis up until Z+ limit switch is hit and machine stops. Write down Z+ axis machine position.

If your X limit switch is mounted at positive end of  X axis: Slowly jog X axis in positive direction until X+ limit switch is hit and machine stops. Write down X+ axis machine position.

If your X limit switch is mounted at negative end of  X axis: Slowly jog X axis in negative direction until X- limit switch is hit and machine stops. Write down X- axis machine position.

If your Y limit switch is mounted at positive end of  Y axis: Slowly jog Y axis in positive direction until Y+ limit switch is hit and machine stops. Write down Y+ axis machine position.

If your Y limit switch is mounted at negative end of  Y axis: Slowly jog Y axis in negative direction until Y- limit switch is hit and machine stops. Write down Y- axis machine position.

 

Now insert all values that you obtained for switch positions into their corresponding field values…

 

 

Move To:

Each axis will travel to its dedicated Move To position immediately after being referenced.  These are machine position values.

 

Switch Click Distance:

This is the distance from the point where limit switch is activated and to the point when it is released.

 

 

Homing sequence:

You can execute homing procedure via Machine menu Machine/Home or left toolbar button: 

When Homing is executed, homing sequence(as set above – see screenshots) will be:

Z axis will be referenced first. Axis will move in positive direction until Z axis limit switch is activated. When switch is activated machine stops and moves to position set with Z “Move To”(Z=10mm) .

X axis will be referenced second. Axis will move in positive direction until X axis limit switch is activated. When switch is activated machine stops and moves to position set with X “Move To”(X=0mm).

Y axis will be referenced third. Axis will move in positive direction until Y axis limit switch is activated. When switch is activated machine stops and moves to position set with Y “Move To”(Y=0mm).

 

Home script file

Homing procedure uses script file. If you would like to edit script code or to have more in-depth look at the procedure itself, you can do that by opening script file.

You can access and edit script file:

In settings under File/Settings/Program Options/Scripts/Home & Measure -> Home, click button Edit Script.  Script file will open in TNG gcode editor. In order that Home script file is generated and saved in your profiles Script folder, you need to click Save button.

 

 

This tutorial will explain how to set motor and soft limits of your machine.

Soft limits (sometimes also program limits term is used) will stop machine motion when motor limit values of specific machine axis are achieved (without any limit switch activation). Soft limits will stop machine in soft stop fashion, meaning axis motors will use deceleration  – hence the name, soft limits.

 

First you need to configure step per unit values and limit switch inputs of controller:

How to set Steps Per Unit values in PlanetCNC TNG software

How to configure limit switch inputs of controller in PlanetCNC TNG software

 

Configuring motor and soft limits

You can configure motor limit values for each axis.

Limit- value sets limitation of axis movement in negative direction

Limit+ value sets limitation of axis movement in positive direction

Step 1:

First we need to set all machine and tool offsets values to zero.

Work offset should be set to zero with command “Machine/Work Position/Offset->To Zero”.

Tool offset should be set to zero with with command “Machine/Tool Offset -> To Zero”.

 

Step 2:

Now we need to choose where machine zero position is. Usually machine works in work position coordinates and it is not really important where machine zero is. What is important is that it is always at same position. I will put some tape to mark it so that you will see it better on image:

 

Tool is put in spindle and machine is jogged to this position. Use tool with normal length, not too short, not too long. Be careful not to crush tool into machine table when you descent Z axis. You can just loosely tighten tool in spindle and if accident happens nothing will be damaged.

This position should be machine zero. Command for zeroing machine position is in menu: “Machine/Machine Position ->To Zero”.

After using “To Zero” feature you will notice that values under Machine and Motors tab in coordinate position display will be zero for all axes:

 

Step 3:

Slowly jog Z axis up until Z+ limit switch is hit and machine stops. Step jog in opposite direction so that limit switch is released and write down Z+ axis machine position.

Slowly jog X axis in positive direction until X+ limit switch is hit and machine stops.  Step jog in opposite direction so that limit switch is released and write down X+ axis machine position.

Slowly jog X axis in negative direction until X- limit switch is hit and machine stops. Step jog in opposite direction so that limit switch is released and write down X- axis machine position.

Slowly jog Y axis in positive direction until Y+ limit switch is hit and machine stops.  Step jog in opposite direction so that limit switch is released and write down Y+ axis machine position.

Slowly jog Y axis in negative direction until Y- limit switch is hit and machine stops.  Step jog in opposite direction so that limit switch is released and write down Y- axis machine position.

PLEASE NOTE: Motor limit values obtained above are just an example on how you can obtain and define them. Motor limit values can be any values that suits your machine and application.

 

 

Step 4:

Now insert values that you previously written down(X+, X- ; Y+,Y-; Z+)  into Limit windows. If we want motors to stop when limits are reached, we must enable the radio button for desired axis. By doing this, we now set soft limits:

Step 5: Enable/Disable of soft limits

To enable soft limit settings, you need to make sure that they are enabled under: Machine/Motors,Limits,Probe/Soft Limits Enable

To observe Soft Limits enable/disable state, you can do that by observing:

-Machine/Motors,Limits,Probe/Soft Limits Enable menu. Checked for enabled, unchecked for disabled

-SL light under IO tab which will toggle according to above settings. Green when soft limits are enabled, and red when they are disabled

PlanetCNC TNG software recognizes all PlanetCNC controllers that are connected to your PC trough USB or Network ports. However, only Mk3 series of controllers (Mk3, MK3/4,MK3DRV,Mk3ECO)  can be used with TNG sw.

It is essential that user sets “Primary controller” in settings. Without this, you will not be able to control your machine!

 

Basic connection settings

Lets start by going trough connection parameters in settings: File/Settings/Connection

Select the type of connection that you wish to use with your controller: USB or Network.

When you select type of connection, you will notice that window with connected devices will add new controller(s) to the list(beside Simulation). If you have multiple controllers connected via USB to your computer, software will display them. In case of enabling Ethernet option, software will display also controllers connected to computer via network:

 

To select your primary controller, you need to double click on controller displayed in device list.
“Primary controller” window will now display type of connection, type of controller and its serial number.

Connection light colour description:

Now that your “Primary controller” is selected you can observe its status via connection light.

If you look closely at the bottom right corner of PlanetCNC TNG software, you will notice that there is a round light.
This light can be lit in various colours and each colour indicates different connection, firmware and license status.

Green light with S indicates that PlanetCNC TNG software is in Simulation mode. You can use software options and features, execute gcode programs etc..however, you are not able to control your machine. In order that software communicates with PlanetCNC motion controller, you need to set “Primary controller”. 

Green light indicates that controller is updated with correct firmware version, it is set as primary controller and is activated, meaning license for corresponding controller is found by software.

Green light with X indicates that controller is updated with correct firmware, it is set as primary controller but software does not find proper license for connected controller.

Orange light indicates that controllers firmware version is not correct. Update firmware of controller.

Gray light with S indicates no communication between controller and software. Click “Machine/Controller/Reconnect” and make sure that correct controller is set as Primary controller in settings. 

Red light indicates that software is processing commands and is sending them to controller.

Communication status can also be indicated by observing on-board Link LED. If this LED is blinking in pattern of approximately 500ms, controller is communicating with software. When software is processing commands and is sending them to controller, this LED will be blinking even faster.

If Link LED is not blinking, this indicates communication has dropped.

We used freshly installed Linux – Ubuntu MATE distribution for this guide. Please note that distributions differ one from another so these steps may not be suitable for all distributions and installation methods may vary.

1.) Start your Ubuntu MATE system.

2.) Using your web browser, download PlanetCNC TNG version from PlanetCNC download page: PlanetCNC TNG download page

Under download options choose “PlanetCNC TNG preview-Linux” and click
“Download” button:

3.When download dialogue appears, select “Save File” and hit “OK” button:

4.)When download is complete, click “Open folder” button:

5.) In “Downloads” folder, right click on downloaded file and click: “Extract To…”:

6.)Extract dialogue will appear, click: “Create Folder” button:

7.) Type in the name of new folder: PlanetCNC

8.) Open PlanetCNC folder and click “Extract” button:

9.) Extracted files will now populate PlanetCNC folder:

10.) Right mouse click on blank space and click: “Open in Terminal”

11.) Terminal window will appear:

12.) Write: sh install.sh

13.) Type in your root password and hit enter.

14.) PlanetCNC TNG software will automatically launch