HEY, we are moving to a new wiki, any modification you make here will be ignored, so I removed edit rights so you don't loose your content

The new wiki is at beta.smoothieware.org, will be activated next week hopefully.

Jogger Module

Not yet completed or released

Note this page is a work in progress and the jogger functionality is not yet released in smoothieware.

What is Jogger?

Jogger is a module for SmoothieBoard which adds the ability to move your machine around: a process referred to as "jogging". This module is different from most jogging tools in that it accepts input from a joystick. This means your machine will move smoothly in the direction of the joystick, rather than take a small step in a certain direction each time a button in pressed.

Some possible uses for the Jogger module:

  • Moving a cutting tool to the origin of a part
  • Moving your print head to clear a jam or inspect the nozzle

Getting Started

Not yet completed or released

Note this page is a work in progress and the jogger functionality is not yet released in smoothieware.


You will need some kind of joystick-like device that the Jogger module will use to tell your steppers where to go. See the joystick page for information on how to set up an analog joystick. Once you have the joystick modules set up, you will need to know the module names of the joystick axes you want to link to the jogger.

Configuration

All Configuration Options

Option Example Value Explanation
jogger.enable true If true, enable the Jogger module
jogger.data_source_alpha horizontal Specifies the module name of the Joystick module the alpha/first jog axis will use
jogger.data_source_beta vertical Specifies the module name of the Joystick module the beta/second jog axis will use
jogger.m_code_set 777 Sets which M-code number the set axes command will use (777 means use M777 to set the jog axes)
jogger.m_code_toggle 778 Sets which M-code number the toggle axes (778 means use M778 to toggle the jog axes)
jogger.max_speed 600 Sets the maximum speed the machine will jog. If not given, the Jogger uses the general configuration "default_seek_rate" (G0 speed)
jogger.dead_zone 0.05 Sets the threshold the joystick must cross before movement occurs (see description below)
jogger.nonlinearity 1.5 Sets the non-linearity of the joystick to speed conversion function (see description below)
jogger.refresh_rate 100 Specifies how many times per second to read the joystick
jogger.segment_frequency 100 Sets the number of tiny movement segments per second while jogging

Mapping Joystick Position to Jog Speed

Image and description of how the joystick position is mapped to a speed.
speedplot.png

Examples

M777 XYZ

M777 Z

Developer Documentation

Link to Jogger developer doc page which gives info on how to interface with a joystick module or change the # of jog axes.


This site is a WIki, which means you are very welcome to help us improve it. Help on how to do that can be found at the Editing the Wiki page . You can edit any page by clicking the "Edit" button bellow :