Mach Modules Documentation
Lua Module API Documentation
Loading...
Searching...
No Matches
JetScreenV02.lua File Reference

Go to the source code of this file.

Functions

JetScreenV02 MachineScreenPLCScript ()
 Execute the PLC cycle script for the Jet machine screen.
JetScreenV02 MachineScreenLoadScript ()
 Execute screen load initialization for the Jet machine screen.
JetScreenV02 MachineScreenStartupScript ()
 Execute startup initialization for the Jet machine screen.
JetScreenV02 MachineScreenLowPriorityLoop ()
 Execute low-priority periodic updates for the Jet machine screen.
JetScreenV02 MachineScreenDisable ()
 Handle machine disable event for the Jet machine screen.
JetScreenV02 MachineScreenCycleStop ()
 Handle cycle stop event for the Jet machine screen.
JetScreenV02 HideSpindleWarmUpGroup ()
 Placeholder function that disables spindle warm-up group visibility for the Jet screen.
JetScreenV02 UpdateSpindleWarmUp ()
 Placeholder function that disables spindle warm-up update behavior for the Jet screen.
JetScreenV02 HideAbrasiveAxes ()
 Hide axis position display elements for all configured abrasive axes.
JetScreenV02 UpdatePlateAligmentBtn ()
 Update the Plate Alignment button color based on G68 rotation or GC rotate state.
JetScreenV02 IsJetsHighPressureOn ()
 Check whether jets high pressure mode is currently enabled.
JetScreenV02 JetsHighPressure (onoff)
 Set the jets high pressure enabled state and update the hardware output.
JetScreenV02 JetsHighPressureToggle ()
 Toggle the jets high pressure mode on or off.
JetScreenV02 UpdateJetPressureDRO (pressure,...)
 Update and clamp the jet pressure DRO value to the configured min/max range.
JetScreenV02 InitializeZAxisOverride ()
 Initialize the Z axis override to link a secondary axis to the main Z axis.
JetScreenV02 InitializeJetPump ()
 Initialize the jet pump configuration, output ignore lists, and alarm monitoring.
JetScreenV02 JetPumpToggle ()
 Toggle the jet pump on or off based on its current starting state.
JetScreenV02 JetPumpOn ()
 Turn on the jet pump and stop the spindle.
JetScreenV02 JetPumpOff ()
 Turn off the jet pump and stop the spindle.
JetScreenV02 IsJetPumpOn ()
 Check whether the jet pump is currently on.
JetScreenV02 IsJetPumpOnBtn ()
 Get the jet pump button state for UI display, including blinking during startup.
JetScreenV02 JetPumpOffOnEndOfProgram ()
 Toggle the jet pump auto-off on end of program setting.
JetScreenV02 IsJetPumpOffOnEndOfProgram ()
 Check whether the jet pump is configured to turn off automatically at end of program.
JetScreenV02 InitializeAbrasive ()
 Initialize the abrasive UI label based on the configured abrasive axis units.
JetScreenV02 InitializeJetStations ()
 Initialize jet station visibility and register state based on the number of enabled jets.
JetScreenV02 JetPressureToggleStation (StationNumber)
 Toggle the pressure enabled state for a specific jet station.
JetScreenV02 JetAbrasiveToggleStation (StationNumber)
 Toggle the abrasive enabled state for a specific jet station.
JetScreenV02 JetsPressureSelectAll ()
 Select or deselect all jet pressure stations and update outputs accordingly.
JetScreenV02 JetAbrasiveSelectAll ()
 Select or deselect all jet abrasive stations and update outputs accordingly.
JetScreenV02 UpdateJetAbrasiveAxisRate (rate,...)
 Update the abrasive axis feed rate, clamping it to the configured min/max range.
JetScreenV02 UpdateJetControls ()
 Update all jet station pressure and abrasive button states and UI elements.
JetScreenV02 GetStationPressureEnabled (StationNumber)
 Get whether a jet station's pressure button is enabled (interactive).
JetScreenV02 GetStationPressureState (StationNumber)
 Get the raw button state value for a jet station's pressure control.
JetScreenV02 GetStationAbrasiveEnabled (StationNumber)
 Get whether a jet station's abrasive button is enabled (interactive).
JetScreenV02 GetStationAbrasiveState (StationNumber)
 Get the raw button state value for a jet station's abrasive control.
JetScreenV02 GetStationPressureButtonState (StationNumber)
 Get the combined button state for a jet station's pressure control.
JetScreenV02 GetStationAbrasiveButtonState (StationNumber)
 Get the combined button state for a jet station's abrasive control.
JetScreenV02 GetAxisPositionGroupTable ()
 Get the axis position group layout table for the Jet machine screen.
JetScreenV02 JetSlide new ()
 Construct and initialize a new JetSlide instance.
JetScreenV02 JetSlide GetSelectedSlideMotorUpInput ()
 Get the state of the jogging-up input for the currently selected slide motor.
JetScreenV02 JetSlide GetSelectedSlideMotorDownInput ()
 Get the state of the jogging-down input for the currently selected slide motor.
JetScreenV02 JetSlide GetSelectedSlideMotor ()
 Get the selection state of all configured jet slide motors.
JetScreenV02 JetSlide JogSlideMotorUp ()
 Jog a jet slide motor in the upward direction.
JetScreenV02 JetSlide JogSlideMotorDown ()
 Jog a jet slide motor in the downward direction.
JetScreenV02 JetSlide StopJoggingSlideMotor ()
 Stop jogging a specific jet slide motor by clearing all motor outputs.
JetScreenV02 JetSlide UpdateJogging ()
 Update jogging state for all jet slide motors based on input signals.
JetScreenV02 MachineCreatePreCannedCommands ()
 Register all pre-canned commands for the Jet machine screen.

Function Documentation

◆ GetAxisPositionGroupTable()

JetScreenV02 GetAxisPositionGroupTable ( )

Get the axis position group layout table for the Jet machine screen.

Returns a distribution parameter table used to position axis DROs on the screen. If user.GetAxisPositionGroupTable is defined, it delegates to that function to allow machine-specific overrides. Otherwise, it builds a default table from all enabled and visible axes, with a fixed pixel range (19 to 216) and layout constraints.

Returns
(table) Distribution parameter table with keys:
  • count (number): Number of enabled axes
  • order (table): Array of axis IDs to display
  • start (number): Starting pixel position
  • length (number): Total pixel length available
  • constraints (table): Table with 'maximum_size' and 'maximum_padding' keys
Note
Documentation generated by AI on 2026-03-03

◆ GetSelectedSlideMotor()

JetScreenV02 JetSlide GetSelectedSlideMotor ( )

Get the selection state of all configured jet slide motors.

Iterates over all enabled jets (up to self.JetsEnabled) and retrieves the selected state of each slide motor input via GetSelectedSlideInput. Returns a table indexed by slide number where each value is truthy if that slide is currently selected.

Returns
(table) Array indexed by slide number (1-based); each entry is the selected input state for that slide
Note
Documentation generated by AI on 2026-03-03

◆ GetSelectedSlideMotorDownInput()

JetScreenV02 JetSlide GetSelectedSlideMotorDownInput ( )

Get the state of the jogging-down input for the currently selected slide motor.

Reads the OEM parameter signal mapped to "JetJogSelectedSlideMotorDownInput". This is the pendant or global down-jog input shared across all slides when one is selected. Returns false if the parameter signal is not mapped.

Returns
(boolean) True if the selected slide motor down jog input is active, false otherwise
Note
Documentation generated by AI on 2026-03-03

◆ GetSelectedSlideMotorUpInput()

JetScreenV02 JetSlide GetSelectedSlideMotorUpInput ( )

Get the state of the jogging-up input for the currently selected slide motor.

Reads the OEM parameter signal mapped to "JetJogSelectedSlideMotorUpInput". This is the pendant or global up-jog input shared across all slides when one is selected. Returns false if the parameter signal is not mapped.

Returns
(boolean) True if the selected slide motor up jog input is active, false otherwise
Note
Documentation generated by AI on 2026-03-03

◆ GetStationAbrasiveButtonState()

JetScreenV02 GetStationAbrasiveButtonState ( StationNumber )

Get the combined button state for a jet station's abrasive control.

Returns true only when the station's abrasive is both enabled and in an active state (btn_state != 0). This is the value used to drive abrasive button highlight/color on the screen.

Parameters
StationNumber(number) The 1-based jet station index (defaults to 1 if nil)
Returns
(boolean) True if the abrasive button should appear active, false otherwise
Note
Documentation generated by AI on 2026-03-03

◆ GetStationAbrasiveEnabled()

JetScreenV02 GetStationAbrasiveEnabled ( StationNumber )

Get whether a jet station's abrasive button is enabled (interactive).

Returns the enabled flag from JetStations.Abrasive for the specified station. A station's abrasive button is only enabled when its pressure is active.

Parameters
StationNumber(number) The 1-based jet station index (defaults to 1 if nil)
Returns
(boolean) True if the abrasive button is enabled for interaction, false otherwise
Note
Documentation generated by AI on 2026-03-03

◆ GetStationAbrasiveState()

JetScreenV02 GetStationAbrasiveState ( StationNumber )

Get the raw button state value for a jet station's abrasive control.

Returns the numeric btn_state from JetStations.Abrasive for the specified station. States: 0 = off, 1 = on (abrasive active and master enable on), 2 = pending (abrasive enabled but master enable off).

Parameters
StationNumber(number) The 1-based jet station index (defaults to 1 if nil)
Returns
(number) The abrasive button state (0, 1, or 2)
Note
Documentation generated by AI on 2026-03-03

◆ GetStationPressureButtonState()

JetScreenV02 GetStationPressureButtonState ( StationNumber )

Get the combined button state for a jet station's pressure control.

Returns true only when the station's pressure is both enabled and in an active state (btn_state != 0). This is the value used to drive pressure button highlight/color on the screen.

Parameters
StationNumber(number) The 1-based jet station index (defaults to 1 if nil)
Returns
(boolean) True if the pressure button should appear active, false otherwise
Note
Documentation generated by AI on 2026-03-03

◆ GetStationPressureEnabled()

JetScreenV02 GetStationPressureEnabled ( StationNumber )

Get whether a jet station's pressure button is enabled (interactive).

Returns the enabled flag from JetStations.Pressure for the specified station. Pressure buttons are always enabled for configured stations.

Parameters
StationNumber(number) The 1-based jet station index (defaults to 1 if nil)
Returns
(boolean) True if the pressure button is enabled for interaction, false otherwise
Note
Documentation generated by AI on 2026-03-03

◆ GetStationPressureState()

JetScreenV02 GetStationPressureState ( StationNumber )

Get the raw button state value for a jet station's pressure control.

Returns the numeric btn_state from JetStations.Pressure for the specified station. States: 0 = pressure off, 1 = pressure on.

Parameters
StationNumber(number) The 1-based jet station index (defaults to 1 if nil)
Returns
(number) The pressure button state (0 or 1)
Note
Documentation generated by AI on 2026-03-03

◆ HideAbrasiveAxes()

JetScreenV02 HideAbrasiveAxes ( )

Hide axis position display elements for all configured abrasive axes.

Iterates over up to 4 abrasive axis slots. For each slot, reads the JetAbrasiveAxisEnabled_N OEM parameter. If the axis is enabled ("Yes"), reads the corresponding JetAbrasiveAxisID_N parameter and hides that axis via m.screen.HideAxis(). Axes that are not enabled are left unchanged.

Note
Documentation generated by AI on 2026-03-03

◆ HideSpindleWarmUpGroup()

JetScreenV02 HideSpindleWarmUpGroup ( )

Placeholder function that disables spindle warm-up group visibility for the Jet screen.

This function intentionally performs no operations. It overrides the base screen spindle warm-up group hiding behavior to disable that feature for the Jet machine type.

Note
Documentation generated by AI on 2026-03-03

◆ InitializeAbrasive()

JetScreenV02 InitializeAbrasive ( )

Initialize the abrasive UI label based on the configured abrasive axis units.

Reads the JetAbrasiveAxisUnits OEM parameter to determine the unit type. If set to "Mass Per Minute", sets the AbrasiveRateText label to "Abrasive (m)". Otherwise, sets the label to "Abrasive (%)". This configures the abrasive rate DRO label to reflect the correct unit system for the machine.

Returns
(nil) Primary return value (always nil on error)
(boolean) Success flag - true if operation completed successfully
(string) Status message from w.FunctionError() on error
Note
Documentation generated by AI on 2026-03-03

◆ InitializeJetPump()

JetScreenV02 InitializeJetPump ( )

Initialize the jet pump configuration, output ignore lists, and alarm monitoring.

Performs the following setup steps:

  • If JetLeavePumpOnDuringStop is "Yes", adds the pump output signals (JetPumpOutput, JetPumpMomentaryOnOutput, JetPumpMomentaryOffOutput) to the IgnoreOutputsOnStop list so they remain active when the machine stops
  • If the JetPumpAlarmInput signal is mapped and no existing GMS alarm with the title "Jet Pump Intensifier Alarm" is found, creates a new system global message that triggers an alarm and disables the machine when the pump alarm input activates while the machine is enabled
    Note
    Documentation generated by AI on 2026-03-03

◆ InitializeJetStations()

JetScreenV02 InitializeJetStations ( )

Initialize jet station visibility and register state based on the number of enabled jets.

Reads the JetsEnabled OEM parameter to determine how many jet stations are active. For each station up to aux.MaxNumberOfJets:

  • If the station index is within the enabled count, makes the station group visible
  • Otherwise, hides the station group and clears both the abrasive and pressure enabled bits in JetsAbrasiveEnabledBits and JetsPressureEnabledBits registers for that station
    Returns
    (nil) Primary return value (always nil on error)
    (boolean) Success flag - true if operation completed successfully
    (string) Status message from w.FunctionCompleted() or w.FunctionError()
    Note
    Documentation generated by AI on 2026-03-03

◆ InitializeZAxisOverride()

JetScreenV02 InitializeZAxisOverride ( )

Initialize the Z axis override to link a secondary axis to the main Z axis.

Reads the JetZAxisOverrideAxisID OEM parameter to determine which axis acts as the secondary Z axis override. For each configured operator panel that is not a lathe or plasma type (not part numbers X15-12-02 or X15-14-22), maps the secondary axis to whichever jogging axis slot corresponds to the main Z axis. Also updates the SystemJogger profile section. If the Motion Filter Plugin is not enabled, posts a warning message and returns early. If both the Z axis and the override axis are enabled, activates the axis override via mf.OverrideAxis() if not already overridden.

Returns
(nil) Primary return value (always nil on error)
(boolean) Success flag - true if operation completed successfully
(string) Status message from w.FunctionCompleted() or w.FunctionError()
Note
Documentation generated by AI on 2026-03-03

◆ IsJetPumpOffOnEndOfProgram()

JetScreenV02 IsJetPumpOffOnEndOfProgram ( )

Check whether the jet pump is configured to turn off automatically at end of program.

Parameters
(nil)No parameters
Returns
(boolean) True if the JetPumpOffOnEndOfProgram OEM parameter is set to "Yes", false otherwise
Note
Documentation generated by AI on 2026-03-03

◆ IsJetPumpOn()

JetScreenV02 IsJetPumpOn ( )

Check whether the jet pump is currently on.

Returns
(boolean) True if the jet pump is on, false otherwise
Note
Documentation generated by AI on 2026-03-03

◆ IsJetPumpOnBtn()

JetScreenV02 IsJetPumpOnBtn ( )

Get the jet pump button state for UI display, including blinking during startup.

Returns a tri-state value suitable for driving a UI button:

  • true if the pump is fully on
  • BLINK_OBJECT_ACTIVE if the pump is starting (causes button to blink)
  • false if the pump is off
    Returns
    (boolean|number) True if pump is on, BLINK_OBJECT_ACTIVE if starting, false if off
    Note
    Documentation generated by AI on 2026-03-03

◆ IsJetsHighPressureOn()

JetScreenV02 IsJetsHighPressureOn ( )

Check whether jets high pressure mode is currently enabled.

Reads the JetsHighPressureEnabled OEM parameter and returns true if its value is 1.

Returns
(boolean|nil) True if high pressure is enabled, false if disabled, nil on error
(boolean) Success flag - true if the parameter was read successfully
(string) Status message from w.FunctionError() on error
Note
Documentation generated by AI on 2026-03-03

◆ JetAbrasiveSelectAll()

JetScreenV02 JetAbrasiveSelectAll ( )

Select or deselect all jet abrasive stations and update outputs accordingly.

Reads the current label of the "JetAbrasiveSelectAll" button to determine action:

  • If "Select": enables abrasive for all stations that currently have pressure enabled, iterating through all jets up to aux.MaxNumberOfJets
  • If anything else (e.g., "Deselect"): clears all abrasive enabled bits to 0 After updating registers, refreshes the jet controls UI via UpdateJetControls().
    Returns
    (nil) Primary return value (always nil)
    (boolean) Success flag - true if operation completed successfully
    (string) Status message from w.FunctionCompleted() or w.FunctionError()
    Note
    Documentation generated by AI on 2026-03-03

◆ JetAbrasiveToggleStation()

JetScreenV02 JetAbrasiveToggleStation ( StationNumber )

Toggle the abrasive enabled state for a specific jet station.

If the station number is within the enabled jets range, reads the current abrasive and pressure enabled states for the station. If pressure is not enabled, returns immediately without changing abrasive state. Otherwise, toggles the abrasive enabled bit in the JetsAbrasiveEnabledBits register. If the spindle is on, activates abrasive output. If the station is outside the enabled range, clears the abrasive bit and deactivates output. After updating registers, refreshes the jet controls UI via UpdateJetControls().

Parameters
StationNumber(number) The 1-based index of the jet station to toggle abrasive for
Returns
(nil) Primary return value (always nil)
(boolean) Success flag - true if operation completed successfully
(string) Status message from w.FunctionCompleted() or w.FunctionError()
Note
Documentation generated by AI on 2026-03-03

◆ JetPressureToggleStation()

JetScreenV02 JetPressureToggleStation ( StationNumber )

Toggle the pressure enabled state for a specific jet station.

If the station number is within the enabled jets range, reads the current pressure enabled state and toggles the corresponding bit in JetsPressureEnabledBits. When the spindle is on, also manages abrasive outputs based on the new pressure state and current abrasive enabled state - activating pressure and abrasive in the correct sequence (with delays) or deactivating them as appropriate. If the station is outside the enabled range, clears the pressure bit and deactivates pressure output, also turning off abrasive if it was active. After updating registers, refreshes the jet controls UI via UpdateJetControls().

Parameters
StationNumber(number) The 1-based index of the jet station to toggle pressure for
Returns
(nil) Primary return value (always nil)
(boolean) Success flag - true if operation completed successfully
(string) Status message from w.FunctionCompleted() or w.FunctionError()
Note
Documentation generated by AI on 2026-03-03

◆ JetPumpOff()

JetScreenV02 JetPumpOff ( )

Turn off the jet pump and stop the spindle.

Stops the spindle via m.SpindleStop() before turning off the jet pump via aux.JetPumpOff(). Both operations are performed in sequence to ensure the jets are properly shut down.

Note
Documentation generated by AI on 2026-03-03

◆ JetPumpOffOnEndOfProgram()

JetScreenV02 JetPumpOffOnEndOfProgram ( )

Toggle the jet pump auto-off on end of program setting.

Reads the current state via IsJetPumpOffOnEndOfProgram() and toggles the JetPumpOffOnEndOfProgram OEM parameter string between "Yes" and "No".

Note
Documentation generated by AI on 2026-03-03

◆ JetPumpOn()

JetScreenV02 JetPumpOn ( )

Turn on the jet pump and stop the spindle.

Stops the spindle via m.SpindleStop() before activating the jet pump via aux.JetPumpOn(). The spindle is stopped first to ensure safe pump startup.

Note
Documentation generated by AI on 2026-03-03

◆ JetPumpToggle()

JetScreenV02 JetPumpToggle ( )

Toggle the jet pump on or off based on its current starting state.

If the pump is currently starting (aux.IsJetPumpStarting() is true), turns the pump off via m.screen.JetPumpOff(). Otherwise, turns it on via m.screen.JetPumpOn().

Note
Documentation generated by AI on 2026-03-03

◆ JetsHighPressure()

JetScreenV02 JetsHighPressure ( onoff )

Set the jets high pressure enabled state and update the hardware output.

Updates the JetsHighPressureEnabled OEM parameter register to 1 (on) or 0 (off). When turning off, immediately deactivates the high pressure output via aux.SetJetsHighPressure(false) regardless of whether the jets pressure is on. When turning on, only activates the high pressure output if the jets pressure is currently active (aux.IsJetsPressureOn() returns true).

Parameters
onoff(boolean) True to enable high pressure, false to disable. Defaults to false if nil.
Returns
(nil) Primary return value (always nil on error)
(boolean) Success flag - true if operation completed successfully
(string) Status message from w.FunctionError() on error
Note
Documentation generated by AI on 2026-03-03

◆ JetsHighPressureToggle()

JetScreenV02 JetsHighPressureToggle ( )

Toggle the jets high pressure mode on or off.

Reads the current high pressure state via IsJetsHighPressureOn() and passes the inverted value to JetsHighPressure() to toggle the state.

Note
Documentation generated by AI on 2026-03-03.

◆ JetsPressureSelectAll()

JetScreenV02 JetsPressureSelectAll ( )

Select or deselect all jet pressure stations and update outputs accordingly.

Reads the current label of the "JetPressureSelectAll" button to determine action:

  • If "Select": sets all pressure enabled bits using a bitmask derived from JetsEnabled, and activates pressure output if the spindle is currently on
  • If anything else (e.g., "Deselect"): clears all pressure enabled bits to 0 and deactivates pressure output immediately After updating registers, refreshes the jet controls UI via UpdateJetControls().
    Returns
    (nil) Primary return value (always nil)
    (boolean) Success flag - true if operation completed successfully
    (string) Status message from w.FunctionCompleted() or w.FunctionError()
    Note
    Documentation generated by AI on 2026-03-03

◆ JogSlideMotorDown()

JetScreenV02 JetSlide JogSlideMotorDown ( )

Jog a jet slide motor in the downward direction.

If the slide motor's lower limit input is active, jogging is stopped instead of started to prevent overtravel. Otherwise, sets the motor up output low, motor down output high, and enables the motor enable output.

Parameters
slide_number(number) The 1-based index of the jet slide motor to jog downward
Note
Documentation generated by AI on 2026-03-03

◆ JogSlideMotorUp()

JetScreenV02 JetSlide JogSlideMotorUp ( )

Jog a jet slide motor in the upward direction.

If the slide motor's upper limit input is active, jogging is stopped instead of started to prevent overtravel. Otherwise, sets the motor down output low, motor up output high, and enables the motor enable output.

Parameters
slide_number(number) The 1-based index of the jet slide motor to jog upward
Note
Documentation generated by AI on 2026-03-03

◆ MachineCreatePreCannedCommands()

JetScreenV02 MachineCreatePreCannedCommands ( )

Register all pre-canned commands for the Jet machine screen.

Creates and registers all operator-accessible commands for the Jet machine, including: station pressure and abrasive toggles (one per enabled jet), abrasive master enable toggle, high pressure toggle, move-to-tool-path position, wiggle piercing toggle, jets on/off, jet pump controls (toggle, on, off), and jet pump auto-off on end of program. Each command is registered with action options, feedback options, button labels, and optionally button colors. Station commands are dynamically created based on the number of enabled jets.

Note
This function is registered with m.CommandRegistrar and called during screen load
Documentation generated by AI on 2026-03-03

◆ MachineScreenCycleStop()

JetScreenV02 MachineScreenCycleStop ( )

Handle cycle stop event for the Jet machine screen.

Reads the JetLeavePumpOnDuringStop OEM parameter. If the parameter is not set to "Yes", turns off the jet pump via JetScreenV02.JetPumpOff(). If the parameter is "Yes", the pump is left running through the stop event. Raises an error if the parameter cannot be read.

Note
Documentation generated by AI on 2026-03-03

◆ MachineScreenDisable()

JetScreenV02 MachineScreenDisable ( )

Handle machine disable event for the Jet machine screen.

Resets the jet pump status to PUMP_STATUS_OFF via aux.SetJetPumpStatus() and turns off the jet pump via JetScreenV02.JetPumpOff(). This ensures the pump is safely shut down whenever the machine is disabled.

Note
Documentation generated by AI on 2026-03-03

◆ MachineScreenLoadScript()

JetScreenV02 MachineScreenLoadScript ( )

Execute screen load initialization for the Jet machine screen.

Registers all pre-canned command creation callbacks with the command registrar, then performs structural screen setup:

  • Registers DualTable, Machine, and CommonShapeCutting pre-canned command creators
  • Initializes the dual table layout via m.screen.InitializeDualTable()
  • Hides abrasive axes via m.screen.HideAbrasiveAxes()
  • Hides all OB axes via m.screen.HideAllOBAxes()
  • Creates and stores a new JetSlide instance in the global JetSlids variable
    Note
    Documentation generated by AI on 2026-03-03

◆ MachineScreenLowPriorityLoop()

JetScreenV02 MachineScreenLowPriorityLoop ( )

Execute low-priority periodic updates for the Jet machine screen.

Called at a lower frequency than the PLC script to update UI elements that do not require real-time refresh. Currently updates the plate alignment button color via m.screen.UpdatePlateAligmentBtn() and the move-to-tool-path position button state via m.screen.UpdateMoveToTPPositionBtn().

Note
Documentation generated by AI on 2026-03-03

◆ MachineScreenPLCScript()

JetScreenV02 MachineScreenPLCScript ( )

Execute the PLC cycle script for the Jet machine screen.

Called every PLC cycle to perform real-time updates:

  • Updates jet controls UI via m.screen.UpdateJetControls()
  • Updates jogging state for all jet slide motors via JetSlids:UpdateJogging()
  • Updates the jet pump output pressure control via aux.UpdateJetPumpOutputPressureControl()
  • Updates the intensifier control via aux.UpdateIntensifierControl()
    Note
    Documentation generated by AI on 2026-03-03

◆ MachineScreenStartupScript()

JetScreenV02 MachineScreenStartupScript ( )

Execute startup initialization for the Jet machine screen.

Performs all one-time startup tasks required for the Jet machine type:

  • Sets the machine type name label to "Mach Jet"
  • Initializes jet station visibility and configuration via m.screen.InitializeJetStations()
  • If the JetEnableZAxisOverride OEM parameter is set to "Yes", initializes the Z axis override
  • Initializes the axis position group and fixture offsets group UI elements
  • Initializes jet pump configuration and alarm monitoring via m.screen.InitializeJetPump()
  • Initializes abrasive UI label via m.screen.InitializeAbrasive()
  • Initializes the intensifier via aux.InitializeIntensifier()
    Note
    Documentation generated by AI on 2026-03-03

◆ new()

JetScreenV02 JetSlide new ( )

Construct and initialize a new JetSlide instance.

Creates a JetSlide object that manages up to aux.MaxNumberOfJets slide motors. During construction the function:

  • Reads OEM parameters for slide motor enable and pendant mapping configuration
  • Dynamically generates getter and setter methods for each signal in the param_list (SelectedSlideInput, JogSlideMotorUpInput, JogSlideMotorDownInput, SlideMotorLimitUpInput, SlideMotorLimitDownInput, MotorEnableOutput, MotorUpOutput, MotorDownOutput)
  • Optionally maps slide selection and jog inputs to an X15-41-01 pendant if configured
    Returns
    (table) A new JetSlide object with dynamically generated signal accessors, or (nil, false, string) on error if any required OEM parameter cannot be read
    Note
    Pendant mapping only applies to the first 4 jets due to limited operator panel buttons
    Documentation generated by AI on 2026-03-03

◆ StopJoggingSlideMotor()

JetScreenV02 JetSlide StopJoggingSlideMotor ( )

Stop jogging a specific jet slide motor by clearing all motor outputs.

Parameters
slide_number(number) The 1-based index of the jet slide motor to stop
Note
Documentation generated by AI on 2026-03-03

◆ UpdateJetAbrasiveAxisRate()

JetScreenV02 UpdateJetAbrasiveAxisRate ( rate ,
... )

Update the abrasive axis feed rate, clamping it to the configured min/max range.

Retrieves the abrasive axis ID from the JetAbrasiveAxisID_1 OEM parameter, then queries the min and max allowable rates. The provided rate is clamped to this range before being passed to aux.UpdateJetAbrasiveAxisRate(). The clamped rate is returned to the caller.

Parameters
rate(number) The desired abrasive axis rate to apply
...(any) Additional arguments (passed through but not used by this function)
Returns
(number) The clamped rate that was actually applied
Note
Documentation generated by AI on 2026-03-03

◆ UpdateJetControls()

JetScreenV02 UpdateJetControls ( )

Update all jet station pressure and abrasive button states and UI elements.

Reads the current JetsEnabled count, JetsPressureEnabledBits, JetsAbrasiveEnabledBits, and abrasive master enable state, then updates the JetStations table and corresponding screen button colors for all stations. Pressure button colors reflect on/off state. Abrasive button colors indicate: off (BTN_COLOR_OFF), active with master enable (BTN_COLOR_ON), or active without master enable (yellow). Also updates the Select/Deselect label on the pressure and abrasive select-all buttons based on whether any bits are set.

Returns
(nil) Returns nil on error
(boolean) Success flag - true if operation completed successfully
(string) Status message from w.FunctionError() on error
Note
Documentation generated by AI on 2026-03-03

◆ UpdateJetPressureDRO()

JetScreenV02 UpdateJetPressureDRO ( pressure ,
... )

Update and clamp the jet pressure DRO value to the configured min/max range.

Retrieves the configured minimum and maximum jet pump pressures via aux.GetJetPumpPressureMin() and aux.GetJetPumpPressureMax(). The provided pressure value is clamped to this range before being returned to the caller.

Parameters
pressure(number) The desired jet pressure value to display and apply
...(any) Additional arguments (accepted but not used by this function)
Returns
(number) The clamped pressure value that was actually applied
Note
Documentation generated by AI on 2026-03-03

◆ UpdateJogging()

JetScreenV02 JetSlide UpdateJogging ( )

Update jogging state for all jet slide motors based on input signals.

Called each PLC cycle to poll jog inputs and drive slide motor outputs accordingly. If slide motors are disabled (JetsSlideMotorsEnabled == false), the function returns immediately. For each enabled jet, it determines the jog direction by checking the selected slide motor's up/down inputs (pendant-mapped inputs take priority when the slide is selected), falling back to the individual slide motor jog inputs. It then calls JogSlideMotorUp, JogSlideMotorDown, or StopJoggingSlideMotor as appropriate.

Note
This method is intended to be called from the PLC script (MachineScreenPLCScript) every cycle
Documentation generated by AI on 2026-03-03

◆ UpdatePlateAligmentBtn()

JetScreenV02 UpdatePlateAligmentBtn ( )

Update the Plate Alignment button color based on G68 rotation or GC rotate state.

Checks whether G68 rotation is active for the currently selected instance (via G68_ROTATION_ACTIVE_INST table) or whether GC rotate is active (via m.screen:IsGCRotateActive()). Sets the PlateAlignmentBtn button color to BTN_COLOR_ON if either condition is true, or BTN_COLOR_OFF otherwise.

Note
Documentation generated by AI on 2026-03-03

◆ UpdateSpindleWarmUp()

JetScreenV02 UpdateSpindleWarmUp ( )

Placeholder function that disables spindle warm-up update behavior for the Jet screen.

This function intentionally performs no operations. It overrides the base screen spindle warm-up update to disable that feature for the Jet machine type.

Note
Documentation generated by AI on 2026-03-03