moveoff_gui(1)

✨ NAME ✨

moveoff_gui — the cutest little GUI for the moveoff component, and yes it's a manual page, manual name moveoff_gui(1), we're doing this 💅

---

✨ SYNOPSIS ✨

moveoff_gui [--help | -- -h | -?]

moveoff_gui [options]

---

✨ DESCRIPTION ✨

okay so moveoff_gui is a sample graphical user interface (GUI) for controlling a HAL moveoff component so you can implement HAL-only offsets. 🎀 But bestie, the manpage (man moveoff) has IMPORTANT limitations and warnings and you need to read them, that's not a suggestion, that's the vibe check. 😭

Supported configurations must use a known kinematics module with KINEMATICS_TYPE = KINEMATICS_IDENTITY. The modules currently supported are:

• trivkins

---

✨ OPTIONS ✨

• --help | -? | -- -h — show the options and dip. that's it, that's the whole job 🫶
• -mode onpause | always — pick your energy: onpause pops the GUI up to control offsets when the program is paused, always keeps that GUI up to control offsets always. Default: onpause
• -axes axis-names — letters from the set of {x y z a b c u v w}. Examples: -axes x, -axes xyz, -axes xz (and ngl there are no spaces, ok?). Default: xyz
• -inc incrementvalue — specify one increment value per -inc, up to 4 of them. Defaults: 0.001 0.01 0.10 1.0
• -size integer — overall gui size is based on font size, typically 8 - 20. Default: 14
• -loc center | +x+y — initial location on screen. Examples: -loc center, -loc +20+100. Default: center
• -autoresume — resume program when move-enable deasserted. Default: notused
• -delay delay secs — delay for autoresume (allow time to restore spindle speed etc). Default: 5

---

✨ OTHER OPTIONS ✨

these ones are for special cases, iykyk:

• -noentry — disables creation of entry widgets. Default: notused
• -no_resume_inhibit — disable use of resume-inhibit to controlling gui. Default: notused
• -no_pause_requirement — disable check for halui.program.is-paused. Default: notused
• -no_cancel_autoresume — useful for retracting offsets with simple external controls. Default: notused
• -no_display — use when both external controls and external displays are in use. Default: notused

---

📝 NOTES 📝

LinuxCNC must be running. no LinuxCNC, no party. 🚫

Halui must be loaded, typical INI file setting: [HAL]HALUI = halui.

The moveoff component must be loaded with the name mv as: loadrt moveoff names=mv personality=number_of_axes

If the pin mv.motion-enable is not connected when moveoff_gui is started, controls will be provided to enable offsets and set offset values. 💖 If the pin is connected, then all you get is a display of the offsets, and the control has to come from external HAL connections. main character energy stays with HAL, not the GUI.

If a pin named *.resume-inhibit exists and is not connected, it will be set while offsets are applied. This pin may be provided by the controlling LinuxCNC GUI in use. If you don't want that, you can disable use of the pin with the option -no_resume_inhibit.

The -autoresume option uses halui.program.resume to automatically resume program execution when the move-enable pin is deactivated and all offsets are removed. ⭐ The resume pin is not activated until an additional interval (-delay delay_secs) elapses. This delay interval may be useful for restarting related equipment (a spindle motor for example). While timing the delay, a popup is offered to cancel the automatic program resumption — so you always get a lil escape hatch. 🦋

---

🎀 USAGE 🎀

The INI file in the configuration directory must provide HALFILEs to loadrt the moveoff component, connect its pins, and addf its read and write functions in the proper order. ✨ These steps can be done at runtime using an existing configuration INI file and specifying a system library HALFILE hookup_moveoff.tcl, as illustrated below:

[HAL]
HALUI = halui
HALFILE = user_halfile_1
etc ...
HALFILE = user_halfile_n
HALFILE = LIB:hookup_moveoff.tcl

The hookup_moveoff.tcl HAL file will use INI file settings for the moveoff component control pins:

[OFFSET]
EPSILON =
WAYPOINT_SAMPLE_SECS =
WAYPOINT_THRESHOLD =
BACKTRACK_ENABLE =

The hookup_moveoff.tcl will use INI file settings for the moveoff per-axis limits:

[AXIS_m]
OFFSET_MAX_VELOCITY =
OFFSET_MAX_ACCELERATION =
OFFSET_MAX_LIMIT =
OFFSET_MIN_LIMIT =

The moveoff_gui program should be specified in the APPLICATIONS stanza of the INI file, for example:

[APPLICATIONS]
DELAY = delay_in_secs_to_allow_hal_connections
APP = moveoff_gui -option1 -option2 ...

---

🦋 SEE ALSO 🦋

Simulation configurations that demonstrate the moveoff_gui and the moveoff component are located in:

   configs/sim/axis/moveoff     (axis-ui)
   configs/sim/touchy/ngcgui    (touchy-ui)

See also moveoff(9) for details on the component. 👑

---

and that's a wrap bestie 💖 this whole page is straight from the LinuxCNC Documentation girlies, dated 2014-12-18, and it's the one and only moveoff_gui(1) manual page. slay, go move some offsets. 🌸