Spindle Actions¶
-
qtpyvcp.actions.spindle_actions.
forward
(speed=None, spindle=0)[source]¶ Turn a spindle ON in the FORWARD direction.
ActionButton syntax to start spindle 0 CW (spindle 0 is default)
spindle.forward
ActionButton syntax to start spindle 1 CW
spindle.1.forward
ActionButton syntax to start spindle 0 CW at 1800 RPM
spindle.forward:1800
- Parameters
speed (int, optional) – The requested speed to spin the spindle at. If
speed
is not specified the current interpreter speed setting (as set by the last S word) is used, taking into account the value of the spindle override if it is enabled.spindle (int, optional) – The number of the spindle to turn ON. If
spindle
is not specified spindle 0 is assumed.
-
qtpyvcp.actions.spindle_actions.
reverse
(speed=None, spindle=0)[source]¶ Turn a spindle ON in the REVERSE direction.
ActionButton syntax to start spindle 0 CCW (spindle 0 is default)
spindle.reverse
ActionButton syntax to start spindle 1 CCW
spindle.1.reverse
ActionButton syntax to start spindle 0 CCW at 1800 RPM
spindle.reverse:1800
- Parameters
speed (float, optional) – The requested speed to spin the spindle at. If
speed
is not specified the current interpreter speed setting (as set by the last S word) is used, taking into account the value of the spindle override if it is enabled.spindle (int, optional) – The number of the spindle to turn ON. If
spindle
is not specified spindle 0 is assumed.
-
qtpyvcp.actions.spindle_actions.
off
(spindle=0)[source]¶ Turn a spindle OFF.
ActionButton syntax to stop spindle 0 (spindle 0 is default)
spindle.off
ActionButton syntax to stop spindle 1
spindle.1.off
- Parameters
spindle (int, optional) – The number of the spindle to turn OFF. If
spindle
is not specified spindle 0 is assumed.
-
qtpyvcp.actions.spindle_actions.
faster
(spindle=0)[source]¶ Increase spindle speed by 100rpm.
ActionButton syntax to increase spindle 0 speed (spindle 0 is default)
spindle.faster
ActionButton syntax to increase spindle 1
spindle.1.faster
- Parameters
spindle (int, optional) – The number of the spindle to increase the speed of. If
spindle
is not specified spindle 0 is assumed.
-
qtpyvcp.actions.spindle_actions.
slower
(spindle=0)[source]¶ Decrease spindle speed by 100rpm.
ActionButton syntax to decrease spindle 0 speed (spindle 0 is default)
spindle.slower
ActionButton syntax to decrease spindle 1 speed
spindle.1.slower
- Parameters
spindle (int, optional) – The number of the spindle to decrease the speed of. If
spindle
is not specified spindle 0 is assumed.
-
qtpyvcp.actions.spindle_actions.
getSpeed
(spindle=0)[source]¶ Gets the interpreter’s speed setting for the specified spindle.
- Parameters
spindle (int, optional) – The number of the spindle to get the speed of. If
spindle
is not specified spindle 0 is assumed.- Returns
The interpreter speed setting, with any override applied if override enabled.
- Return type
float
-
qtpyvcp.actions.spindle_actions.
override
(override, spindle=0)[source]¶ Set spindle override percentage.
- Parameters
override (float) – The desired spindle override in percent.
spindle (float, optional) – The number of the spindle to apply the override to. If
spindle
is not specified spindle 0 is assumed.
-
class
qtpyvcp.actions.spindle_actions.
brake
[source]¶ Spindle brake Group
-
static
on
(spindle=0)[source]¶ Set spindle brake ON.
ActionButton syntax to engage spindle 0 brake (spindle 0 is default)
spindle.brake.on
ActionButton syntax to engage spindle 1 brake
spindle.1.brake.on
- Parameters
spindle (int, optional) – The number of the spindle to apply the override to. If
spindle
is not specified spindle 0 is assumed.
-
static
off
(spindle=0)[source]¶ Set spindle brake OFF.
ActionButton syntax to disengage spindle 0 brake (spindle 0 is default)
spindle.brake.off
ActionButton syntax to disengage spindle 1 brake
spindle.1.brake.off
- Parameters
spindle (int, optional) – The number of the spindle to apply the override to. If
spindle
is not specified spindle 0 is assumed.
-
static
toggle
(spindle=0)[source]¶ Toggle spindle brake ON/OFF.
ActionButton syntax to toggle spindle 0 brake (spindle 0 is default)
spindle.brake.toggle
ActionButton syntax to toggle spindle 1 brake
spindle.1.brake.toggle
- Parameters
spindle (int, optional) – The number of the spindle to apply the override to. If
spindle
is not specified spindle 0 is assumed.
-
static