Status

To see a quick overview of all available datachannels from the status plugin, please check Status Items

class qtpyvcp.plugins.status.Status(cycle_time=100)[source]
recent_files

List of recently loaded files

loadMdiHistory(fname)[source]

Load MDI history from file.

saveMdiHistory(fname)[source]

Write MDI history to file.

axis_mask

Axes as configured in the [TRAJ]COORDINATES INI option.

To return the string in a status label:

status:axis_mask
status:axis_mask?string
status:axis_mask?list
Returns:

the configured axes

Return type:

int, list, str

mdi_history

List of recently issued MDI commands. Commands are stored in reverse chronological order, with the newest command at the front of the list, and oldest at the end. When the list exceeds the length given by MAX_MDI_COMMANDS the oldest entries will be dropped.

Duplicate commands will not be removed, so that MDI History can be replayed via the queue meachanisim from a point in the history forward. The most recently issued command will always be at the front of the list.

mdi_remove_entry(mdi_index)[source]

Remove the indicated cmd by index reference

mdi_swap_entries(index1, index2)[source]

Switch two entries about.

mdi_remove_all()[source]

Remove all entries in mdi history

on

True if machine power is ON.

file

Currently loaded file including path

state

Current command execution status

  1. Done

  2. Exec

  3. Error

To return the string in a status label:

status:state?string
Returns:

current command execution state

Return type:

int, str

exec_state

Current task execution state

  1. Error

  2. Done

  3. Waiting for Motion

  4. Waiting for Motion Queue

  5. Waiting for Pause

  6. –

  7. Waiting for Motion and IO

  8. Waiting for Delay

  9. Waiting for system CMD

  10. Waiting for spindle orient

To return the string in a status label:

status:exec_state?string
Returns:

current task execution error

Return type:

int, str

interp_state

Current state of RS274NGC interpreter

  1. Idle

  2. Reading

  3. Paused

  4. Waiting

To return the string in a status label:

status:interp_state?string
Returns:

RS274 interpreter state

Return type:

int, str

interpreter_errcode

Current RS274NGC interpreter return code

  1. Ok

  2. Exit

  3. Finished

  4. Endfile

  5. File not open

  6. Error

To return the string in a status label:

status:interpreter_errcode?string
Returns:

interp error code

Return type:

int, str

task_state

Current status of task

  1. E-Stop

  2. Reset

  3. Off

  4. On

To return the string in a status label:

status:task_state?string
Returns:

current task state

Return type:

int, str

task_mode

Current task mode

  1. Manual

  2. Auto

  3. MDI

To return the string in a status label:

status:task_mode?string
Returns:

current task mode

Return type:

int, str

motion_mode

Current motion controller mode

  1. Free

  2. Coord

  3. Teleop

To return the string in a status label:

status:motion_mode?string
Returns:

current motion mode

Return type:

int, str

motion_type

Motion type

  1. None

  2. Traverse

  3. Linear Feed

  4. Arc Feed

  5. Tool Change

  6. Probing

  7. Rotary Index

To return the string in a status label:

status:motion_type?string
Returns:

current motion type

Return type:

int, str

program_units

Program units

Available as an integer, or in short or long string formats.

  1. in, Inches

  2. mm, Millimeters

  3. cm, Centimeters

To return the string in a status label:

status:program_units
status:program_units?string
status:program_units?string&format=long
Returns:

current program units

Return type:

int, str

linear_units

Machine linear units

Available as float (units/mm), or in short or long string formats.

To return the string in a status label:

status:linear_units
status:linear_units?string
status:linear_units?string&format=long
Returns:

machine linear units

Return type:

float, str

gcodes

G-codes

active G-codes for each modal group

syntax status:gcodes returns tuple of strings
syntax status:gcodes?raw returns tuple of integers
syntax status:gcodes?string returns str
mcodes

M-codes

active M-codes for each modal group

syntax status:mcodes returns tuple of strings
syntax status:mcodes?raw returns tuple of integers
syntax status:mcodes?string returns str
rotation_xy

Current G5x Rotation

syntax status:rotation_xy returns float
g5x_index

Current G5x work coord system

syntax status:g5x_index returns int
syntax status:g5x_index?string returns str
settings

Interpreter Settings

Available Items:

  1. sequence_number

  2. feed

  3. speed

Returns:

interpreter settings

Return type:

tuple, int, float

homed

Axis homed status

If no axis number is specified returns a tuple of integers. If anum is specified returns True if the axis is homed, else False.

Rules syntax:

status:homed
status:homed?anum=0
Parameters:

anum (int, optional) – the axis number to return the homed state of.

Returns:

axis homed states

Return type:

tuple, bool

all_axes_homed

All axes homed status

True if all axes are homed or if [TRAJ]NO_FORCE_HOMING set in INI.

If [TRAJ]NO_FORCE_HOMING is set in the INI the value will be come true as soon as the machine is turned on and the signal will be emitted, otherwise the signal will be emitted once all the axes defined in the INI have been homed.

Returns:

all homed

Return type:

bool

forceUpdateStaticChannelMembers()[source]

Static items need a force update to operate properly with the gui rules. This needs to be done with consideration to the data structure so as to not “break” things.

initialise()[source]

Start the periodic update timer.

terminate()[source]

Save persistent data on terminate.

class qtpyvcp.plugins.status.JointStatus(jnum)[source]
class qtpyvcp.plugins.status.SpindleStatus(snum)[source]