Machine Actions

class qtpyvcp.actions.machine_actions.estop[source]

E-Stop action group

static activate()[source]

Set E-Stop active

ActionButton syntax:

machine.estop.activate

static reset()[source]

Resets E-Stop

ActionButton syntax:

machine.estop.reset

static toggle()[source]

Toggles E-Stop state

ActionButton syntax:

machine.estop.toggle

static is_activated()[source]

Checks if E_Stop is activated.

Returns:: True if E-Stop is active, else False.
Return type:: bool

class qtpyvcp.actions.machine_actions.power[source]

Power action group

static on()[source]

Turns machine power On

ActionButton syntax:

machine.power.on

static off()[source]

Turns machine power Off

ActionButton syntax:

machine.power.off

static toggle()[source]

Toggles machine power On/Off

ActionButton syntax:

machine.power.toggle

static is_on()[source]

Checks if power is on.

Returns:: True if power is on, else False.
Return type:: bool

qtpyvcp.actions.machine_actions.issue_mdi(command, reset=True)[source]

Issue an MDI command.

An MDI command can be issued any time the machine is homed (if not NO_FORCE_HOMING in the INI) and the interpreter is IDLE. The task mode will automatically be switched to MDI prior to issuing the command and will be returned to the previous mode when the interpreter becomes IDLE.

ActionButton syntax to issue G0 X5:
machine.issue_mdi:G0X5
It is simpler to use the MDIButton, examples in the Widgets section.

Parameters:

command (str) – A valid RS274 gcode command string. Multiple MDI commands can be separated with a ; and will be issued sequentially.
reset (bool, optional) – Whether to reset the Task Mode to the state the machine was in prior to issuing the MDI command.

class qtpyvcp.actions.machine_actions.feedhold[source]

Feed Hold action Group

static enable()[source]: Enables Feed Hold

static disable()[source]: Disables Feed Hold

static toggle()[source]: Toggles Feed Hold state

class qtpyvcp.actions.machine_actions.feed_override[source]

Feed Override Group

static enable()[source]: Feed Override Enable

static disable()[source]: Feed Override Disable

static toggle_enable()[source]: Feed Override Enable Toggle

static set(value)[source]: Feed Override Set Value

static reset()[source]: Feed Override Reset

class qtpyvcp.actions.machine_actions.rapid_override[source]: Rapid Override Group

class qtpyvcp.actions.machine_actions.max_velocity[source]

Max Velocity Group

static set(value)[source]: Max Velocity Override Set Value

static reset()[source]: Max Velocity Override Reset Value

class qtpyvcp.actions.machine_actions.mode[source]

Mode action group

static manual()[source]

Change mode to Manual

ActionButton syntax:

machine.mode.manual

static auto()[source]

Change mode to Auto

ActionButton syntax:

machine.mode.auto

static mdi()[source]

Change mode to MDI

ActionButton syntax:

machine.mode.mdi

class qtpyvcp.actions.machine_actions.home[source]

Homing actions group

static all()[source]

Homes all axes

ActionButton syntax:

machine.home.all

static axis(axis)[source]

Home a specific axis

Parameters:: axis (int | str) – one of (xyzabcuvw or 012345678)

ActionButton syntax to home the X axis:

machine.home.axis:x

static joint(jnum)[source]

Home a specific joint

Parameters:: jnum (int) – one of (012345678)

ActionButton syntax to home joint 0:

machine.home.joint:0

class qtpyvcp.actions.machine_actions.unhome[source]

Unhoming actions group

static all()[source]

Unhome all the axes

ActionButton syntax:

machine.unhome.all

static axis(axis)[source]

Unhome a specific axis

Parameters:: axis (int | str) – one of (xyzabcuvw or 012345678)

ActionButton syntax to unhome the X axis:

machine.unhome.axis:x

static joint(jnum)[source]

Unhome a specific joint

Parameters:: jnum (int) – The number of the joint to home.

ActionButton syntax to unhome the joint 0:

machine.unhome.joint:0

qtpyvcp.actions.machine_actions.getAxisLetter(axis)[source]

Takes an axis letter or number and returns the axis letter.

Parameters:: axis (int | str) – Either a axis letter or an axis number.
Returns:: The axis letter, all for an input of -1.
Return type:: str

qtpyvcp.actions.machine_actions.getAxisNumber(axis)[source]

Takes an axis letter or number and returns the axis number.

Parameters:: axis (int | str) – Either a axis letter or an axis number.
Returns:: The axis number, -1 for an input of all.
Return type:: int

class qtpyvcp.actions.machine_actions.jog[source]

Jog Actions Group

static axis(axis, direction=0, speed=None, distance=None)[source]

Jog an axis.

Action Button Syntax to jog the X axis in the positive direction:

machine.jog.axis:x,pos

Parameters:

axis (str | int) – Either the letter or number of the axis to jog.
direction (str | int) – pos or +1 for positive, neg or -1 for negative.
speed (float, optional) – Desired jog vel in machine_units/s.
distance (float, optional) – Desired jog distance, continuous if 0.00.

static set_jog_continuous(continuous)[source]: Set Jog Continuous

static set_increment(raw_increment)[source]: Set Jog Increment

static set_linear_speed(speed)[source]

Set Jog Linear Speed

ActionSlider syntax:

machine.jog.set-linear-speed

static set_angular_speed(speed)[source]: Set Jog Angular Speed

static set_linear_speed_percentage(percentage)[source]: Set Jog Linear Speed Percentage

static set_angular_speed_percentage(percentage)[source]: Set Jog Angular Speed Percentage

class qtpyvcp.actions.machine_actions.jog_mode[source]

Jog Mode Group

static continuous()[source]

Set Jog Continuous

ActionButton syntax:

machine.jog-mode.continuous

static incremental()[source]

Set Jog Incremental

ActionButton syntax:

machine.jog-mode.incremental

static toggle()[source]

Jog Mode Toggle

ActionButton syntax:

machine.jog-mode.toggle