Status Items¶
Status Items can be used in Widget Rules to control and display status data for LinuxCNC.
Tuples¶
If a status item returns a tuple you can get a single value from the tuple by
slicing. For example if the tuple is channel 0 ch[0]
you can convert it to a
string and get the first entry like this str(ch[0][0])
. To get the third
item in the tuple you slice at 2 because counting starts at 0 not 1 so
str(ch[0][2])
returns the third item in the tuple. For axis items they are
in this order X, Y, Z, A, B, C, U, V, W.
Status Items List¶
- acceleration
- active queue
- actual position
- adaptive feed enabled
- analog inputs
- all axes homed
- angular units
- analog outputs
- axes configured
- axis mask
- block delete
- o word call level
- currently executing line
- current velocity
- cycle time
- G4 delay left
- digital inputs
- distance to go
- digital outputs
- distance to go by axis
- serial number
- enabled
- estop
- task execution state
- feed hold
- feed override enabled
- feedrate override
- filename
- flood
- G5x index
- G5x offset
- G92 offset
- gcodes
- homed
- id
- in position
- input timer
- interpreter state
- interpreter return code
- joint n backlash
- joint n enabled
- joint n fault
- joint n following error
- joint n maximum following error
- joint n homed
- joint n homing
- joint n in position
- joint n input position
- joint n type of axis
- joint n maximum following error rapid
- joint n maximum hard limit
- joint n maximum soft limit setting
- joint n maximum soft limit
- joint n maximum following error feed
- joint n minimum hard limit
- joint n minimum soft limit
- joint n minimum soft limit exceeded
- joint n commanded output position
- joint n override limits
- joint n units
- joint n velocity
- joint actual positions
- commanded joint positions
- joints
- kinematics type
- limit masks
- linear units
- lube status
- lube level
- maximum acceleration
- maximum velocity
- m codes
- mist status
- motion line
- motion mode
- motion type
- machine power
- optional stop
- motion paused
- pocket prepped
- trajectory position
- probe tripped
- probe input value
- probed position
- probing status
- program units
- trajectory planner queue
- trajectory planner queue full
- queued mdi commands
- rapid override scale
- interperter read line
- recent files
- rotation XY
- interpreter settings
- spindle brake
- spindle direction
- spindle enabled
- spindle homed
- spindle orient fault
- spindle n orient state
- spindle speed override
- spindle speed override enabled
- spindle speed
- spindles
- command execution status
- task mode
- task paused
- task state
- tool in spindle
- tool offset
- tool table
- velocity
- acceleration
default acceleration, ini parameter [TRAJ]DEFAULT_ACCELERATION
syntaxstatus:acceleration
returns floatsyntaxstatus:acceleration?string
returns str
return to the status items list
- active_queue
number of motions blending
syntaxstatus:active_queue
returns intsyntaxstatus:active_queue?string
returns str
return to the status items list
- actual_position
current trajectory position, (x y z a b c u v w) in machine units
syntaxstatus:actual_position
returns tuple of floatssyntaxstatus:actual_position?string
returns tuple of str
return to the status items list
- adaptive_feed_enabled
status of adaptive feedrate override
syntaxstatus:adaptive_feed_enabled
returns boolsyntaxstatus:adaptive_feed_enabled?string
returns str
return to the status items list
- ain
current value of the analog input pins
syntaxstatus:ain
returns tuple of floatssyntaxstatus:ain?string
returns str
return to the status items list
- all_axes_homed
current status of all axes homed, if any axis is not homed it is false
syntaxstatus:all_axes_homed
returns boolsyntaxstatus:all_axes_homed?string
returns str
return to the status items list
- angular_units
machine angular units per deg, ini parameter [TRAJ]ANGULAR_UNITS
syntaxstatus:angular_units
returns floatsyntaxstatus:angular_units?string
returns str
return to the status items list
- aout
current value of the analog output pins
syntaxstatus:aout
returns tuple of floatssyntaxstatus:aout?string
returns str
return to the status items list
- axes
number of axes. derived from [TRAJ]COORDINATES ini parameter
syntaxstatus:axes
returns intsyntaxstatus:axes?string
returns str
return to the status items list
- axis_mask
axes as configured in the [TRAJ]COORDINATES INI parameter
the sum of the axes X=1, Y=2, Z=4, A=8, B=16, C=32, U=64, V=128, W=256syntaxstatus:axis_mask
returns int bit masksyntaxstatus:axis_mask?list
returns list of axis numbers[0, 1, 2]
syntaxstatus:axis_mask?string
returns string of axis lettersXYZ
return to the status items list
- block_delete
block delete curren status
syntaxstatus:block_delete
returns boolsyntaxstatus:block_delete?string
returns str
return to the status items list
- call_level
current nesting level of O-word procedures
syntaxstatus:call_level
returns intsyntaxstatus:call_level?string
returns str
return to the status items list
- current_line
currently executing line
syntaxstatus:current_line
returns intsyntaxstatus:current_line?string
returns str
return to the status items list
- current_vel
current velocity in user units per second
syntaxstatus:current_vel
returns floatsyntaxstatus:current_vel?string
returns str
return to the status items list
- cycle_time
thread period
syntaxstatus:cycle_time
returns floatsyntaxstatus:cycle_time?string
returns str
return to the status items list
- delay_left
remaining time on the G4 dwell command, seconds
syntaxstatus:delay_left
returns floatsyntaxstatus:delay_left?string
returns str
return to the status items list
- din
current value of the digital input pins
syntaxstatus:din
returns tuple of integerssyntaxstatus:din?string
returns str
return to the status items list
- distance_to_go
remaining distance of current move, as reported by trajectory planner
syntaxstatus:distance_to_go
returns floatsyntaxstatus:distance_to_go?string
returns str
return to the status items list
- dout
current value of the digital output pins
syntaxstatus:dout
returns tuple of integerssyntaxstatus:dout?string
returns str
return to the status items list
- dtg
remaining distance of current move for each axis, as reported by trajectory planner
syntaxstatus:dtg
returns tuple of floatssyntaxstatus:dtg?string
returns str
return to the status items list
- echo_serial_number
The serial number of the last completed command sent by a UI to task
syntaxstatus:echo_serial_number
returns intsyntaxstatus:echo_serial_number?string
returns str
return to the status items list
- enabled
trajectory planner enabled flag
syntaxstatus:enabled
returns boolsyntaxstatus:enabled?string
returns str
return to the status items list
- estop
status of E Stop, 1 for enabled and 0 for not enabled
syntaxstatus:estop
returns intsyntaxstatus:estop?string
returns str
return to the status items list
- exec_state
task execution state
int str 1 Error 2 Done 3 Waiting for Motion 4 Waiting for Motion Queue 5 Waiting for Pause 6 Not used by LinuxCNC 7 Waiting for Motion and IO 8 Waiting for Delay 9 Waiting for system CMD 10 Waiting for spindle orient syntaxstatus:exec_state
returns intsyntaxstatus:exec_state?string
returns str
return to the status items list
- feed_hold_enabled
status of feed hold
syntaxstatus:feed_hold_enabled
returns boolsyntaxstatus:feed_hold_enabled?string
returns str
return to the status items list
- feed_override_enabled
status of feed override
syntaxstatus:feed_override_enabled
returns boolsyntaxstatus:feed_override_enabled?string
returns str
return to the status items list
- feedrate
current feedrate override, 1.0 = 100%
syntaxstatus:feedrate
returns floatsyntaxstatus:feedrate?string
returns str
return to the status items list
- file
currently loaded gcode filename with path
syntaxstatus:file
returns strfor just the file name use this expressionch[0].split('/')[-1]
return to the status items list
- flood
current flood status 0 for off, 1 for on
syntaxstatus:flood
returns intsyntaxstatus:flood?string
returns str
return to the status items list
- g5x_index
currently active coordinate system
int string 0 G53 1 G54 2 G55 3 G56 4 G57 5 G58 6 G59 7 G59.1 8 G59.2 9 G59.3 syntaxstatus:g5x_index
returns intsyntaxstatus:g5x_index?string
returns str
return to the status items list
- g5x_offset
offsets of the currently active coordinate system
syntaxstatus:g5x_offset
returns tuple of floatssyntaxstatus:g5x_offset?string
returns str
return to the status items list
- g92_offset
current g92 offsets
syntaxstatus:g92_offset
returns tuple of floatssyntaxstatus:g92_offset?string
returns str
return to the status items list
- gcodes
active G-codes for each modal group
syntaxstatus:gcodes
returns tuple of integerssyntaxstatus:gcodes?string
returns str
return to the status items list
- homed
currently homed joints, 0 = not homed, 1 = homed
syntaxstatus:homed
returns tuple of integerssyntaxstatus:homed?string
returns str
return to the status items list
- id
currently executing motion id
syntaxstatus:id
returns intsyntaxstatus:id?string
returns str
return to the status items list
- inpos
status machine in position
syntaxstatus:inpos
returns boolsyntaxstatus:inpos?string
returns str
return to the status items list
- input_timeout
flag for M66 timer in progress
syntaxstatus:input_timeout
returns boolsyntaxstatus:input_timeout?string
returns str
return to the status items list
- interp_state
current state of RS274NGC interpreter
int str 1 Idle 2 Reading 3 Paused 4 Waiting syntaxstatus:interp_state
returns intsyntaxstatus:interp_state?string
returns str
return to the status items list
- interpreter_errcode
current RS274NGC interpreter return code
int str 0 Ok 1 Exit 2 Finished 3 Endfile 4 File not open 5 Error syntaxstatus:interpreter_errcode
returns intsyntaxstatus:interpreter_errcode?string
returns str
return to the status items list
- joint.n.backlash
backlash in machine units, ini parameter [JOINT_n]BACKLASH (n is joint number)
syntaxstatus:joint.n.backlash
returns floatsyntaxstatus:joint.n.backlash?string
returns str
return to the status items list
- joint.n.enabled
status of joint n enabled, 0 not enabled 1 enabled
syntaxstatus:joint.n.enabled
returns intsyntaxstatus:joint.n.enabled?string
returns str
return to the status items list
- joint.n.fault
status of joint n fault, 0 not faulted 1 faulted
syntaxstatus:joint.n.fault
returns intsyntaxstatus:joint.n.fault?string
returns str
return to the status items list
- joint.n.ferror_current
current joint n following error
syntaxstatus:joint.n.ferror_current
returns floatsyntaxstatus:joint.n.ferror_current?string
returns str
return to the status items list
- joint.n.ferror_highmark
joint n magnitude of maximum following error
syntaxstatus:joint.n.ferror_highmark
returns floatsyntaxstatus:joint.n.ferror_highmark?string
returns str
return to the status items list
- joint.n.homed
status of joint n homed, 0 not homed 1 homed
syntaxstatus:joint.n.homed
returns intsyntaxstatus:joint.n.homed?string
returns str
return to the status items list
- joint.n.homing
status of joint n homing in progress, 0 not homing 1 homing
syntaxstatus:joint.n.homing
returns intsyntaxstatus:joint.n.homing?string
returns str
return to the status items list
- joint.n.inpos
status of joint n in position, 0 not in position 1 in position
syntaxstatus:joint.n.inpos
returns intsyntaxstatus:joint.n.inpos?string
returns str
return to the status items list
- joint.n.input
joint n current input position
syntaxstatus:joint.n.input
returns floatsyntaxstatus:joint.n.input?string
returns str
return to the status items list
- joint.n.jointType
joint n type of axis, ini parameter [JOINT_n]TYPE
syntaxstatus:joint.n.jointType
returns intsyntaxstatus:joint.n.jointType?string
returns str
return to the status items list
- joint.n.max_ferror
joint n maximum following error rapid, ini parameter [JOINT_n]FERROR
syntaxstatus:joint.n.max_ferror
returns floatsyntaxstatus:joint.n.max_ferror?string
returns str
return to the status items list
- joint.n.max_hard_limit
status of joint n maximum hard limit, 0 not exceeded 1 exceeded
syntaxstatus:joint.n.max_hard_limit
returns intsyntaxstatus:joint.n.max_hard_limit?string
returns str
return to the status items list
- joint.n.max_position_limit
joint n maximum soft limit, ini parameter [JOINT_n]MAX_LIMIT
syntaxstatus:joint.n.max_position_limit
returns floatsyntaxstatus:joint.n.max_position_limit?string
returns str
return to the status items list
- joint.n.max_soft_limit
status of joint n maximum soft limit, 0 not exceeded 1 exceeded
syntaxstatus:joint.n.max_soft_limit
returns intsyntaxstatus:joint.n.max_soft_limit?string
returns str
return to the status items list
- joint.n.min_ferror
maximum following error feed, ini parameter [JOINT_n]MIN_FERROR
syntaxstatus:joint.n.min_ferror
returns floatsyntaxstatus:joint.n.min_ferror?string
returns str
return to the status items list
- joint.n.min_hard_limit
non-zero means min hard limit exceeded
syntaxstatus:joint.n.min_hard_limit
returns intsyntaxstatus:joint.n.min_hard_limit?string
returns str
return to the status items list
- joint.n.min_position_limit
minimum soft limit ini parameter [JOINT_n]MIN_LIMIT
syntaxstatus:joint.n.min_position_limit
returns floatsyntaxstatus:joint.n.min_position_limit?string
returns str
return to the status items list
- joint.n.min_soft_limit
non-zero means min_position_limit was exceeded
syntaxstatus:joint.n.min_soft_limit
returns intsyntaxstatus:joint.n.min_soft_limit?string
returns str
return to the status items list
- joint.n.output
commanded output position
syntaxstatus:joint.n.output
returns floatsyntaxstatus:joint.n.output?string
returns str
return to the status items list
- joint.n.override_limits
non-zero means limits are overridden
syntaxstatus:joint.n.override_limits
returns intsyntaxstatus:joint.n.override_limits?string
returns str
return to the status items list
- joint.n.units
joint units
syntaxstatus:joint.n.units
returns floatsyntaxstatus:joint.n.units?string
returns str
return to the status items list
- joint.n.velocity
current velocity
syntaxstatus:joint.n.velocity
returns floatsyntaxstatus:joint.n.velocity?string
returns str
return to the status items list
- joint_actual_position
joint actual positions
syntaxstatus:joint_actual_position
returns tuple of floatssyntaxstatus:joint_actual_position?string
returns str
return to the status items list
- joint_position
commanded joint positions
syntaxstatus:joint_position
returns tuple of floatssyntaxstatus:joint_position?string
returns str
return to the status items list
- joints
number of joints, ini parameter [KINS]JOINTS
syntaxstatus:joints
returns intsyntaxstatus:joints?string
returns str
return to the status items list
- kinematics_type
kinematics type
syntaxstatus:kinematics_type
returns intsyntaxstatus:kinematics_type?string
returns str
return to the status items list
- limit
axis limit masks
syntaxstatus:limit
returns tuple of integerssyntaxstatus:limit?string
returns str
return to the status items list
- linear_units
machine linear units, ini parameter [TRAJ]LINEAR_UNITS
syntaxstatus:linear_units
returns floatsyntaxstatus:linear_units?string
returns str
return to the status items list
- lube
lube status
syntaxstatus:lube
returns intsyntaxstatus:lube?string
returns str
return to the status items list
- lube_level
status of iocontrol.0.lube_level
syntaxstatus:lube_level
returns intsyntaxstatus:lube_level?string
returns str
return to the status items list
- max_acceleration
maximum acceleration, ini parameter [TRAJ]MAX_ACCELERATION
syntaxstatus:max_acceleration
returns floatsyntaxstatus:max_acceleration?string
returns str
return to the status items list
- max_velocity
maximum velocity, ini parameter [TRAJ]MAX_VELOCITY
syntaxstatus:max_velocity
returns floatsyntaxstatus:max_velocity?string
returns str
return to the status items list
- mcodes
currently active M codes
syntaxstatus:mcodes
returns tuple of integerssyntaxstatus:mcodes?string
returns str
return to the status items list
- mist
mist status
syntaxstatus:mist
returns intsyntaxstatus:mist?string
returns str
return to the status items list
- motion_line
source line number motion is currently executing
syntaxstatus:motion_line
returns intsyntaxstatus:motion_line?string
returns str
return to the status items list
- motion_mode
mode of the motion controller
int string 0 N/A 1 Free 2 Coord 3 Teleop syntaxstatus:motion_mode
returns intsyntaxstatus:motion_mode?string
returns str
return to the status items list
- motion_type
motion type of move currently executing
int string 0 None 1 Traverse 2 Linear Feed 3 Arc Feed 4 Tool Change 5 Probing 6 Rotary Index syntaxstatus:motion_type
returns intsyntaxstatus:motion_type?string
returns str
return to the status items list
- on
status of machine power
syntaxstatus:on
returns boolsyntaxstatus:on?string
returns str
return to the status items list
- optional_stop
status of optional stop
syntaxstatus:optional_stop
returns intsyntaxstatus:optional_stop?string
returns str
return to the status items list
- paused
motion paused
syntaxpstatus:aused
returns boolsyntaxstatus:paused?string
returns str
return to the status items list
- pocket_prepped
pocket prepped from last Tn commaned
syntaxstatus:pocket_prepped
returns intsyntaxstatus:pocket_prepped?string
returns str
return to the status items list
- position
trajectory position
syntaxstatus:position
returns tuple of floatssyntaxstatus:position?string
returns str
return to the status items list
- probe_tripped
probe tripped
syntaxstatus:probe_tripped
returns boolsyntaxstatus:probe_tripped?string
returns str
return to the status items list
- probe_val
value of the motion.probe-input pin
syntaxstatus:probe_val
returns intsyntaxstatus:probe_val?string
returns str
return to the status items list
- probed_position
position where probe tripped
syntaxstatus:probed_position
returns tuple of floatssyntaxstatus:probed_position?string
returns str
return to the status items list
- probing
probe operation is in progress
syntaxstatus:probing
returns boolsyntaxstatus:probing?string
returns str
return to the status items list
- program_units
program units
int short long 0 N/A N/A 1 in Inches 2 mm Millimeters 3 cm Centimeters syntaxstatus:program_units
returns intsyntaxstatus:rogram_units?string
returns short strsyntaxstatus:rogram_units?string&format=long
returns long str
return to the status items list
- queue
current size of the trajectory planner queue
syntaxstatus:queue
returns intsyntaxstatus:queue?string
returns str
return to the status items list
- queue_full
status of the trajectory planner queue
syntaxstatus:queue_full
returns boolsyntaxstatus:queue_full?string
returns str
return to the status items list
- queued_mdi_commands
queued mdi commands
syntaxstatus:queued_mdi_commands
returns intsyntaxstatus:queued_mdi_commands?string
returns str
return to the status items list
- rapidrate
rapid override scale
syntaxstatus:rapidrate
returns floatsyntaxstatus:rapidrate?string
returns str
return to the status items list
- read_line
current line the interperter is reading
syntaxstatus:read_line
returns intsyntaxstatus:read_line?string
returns str
return to the status items list
- recent_files
recent files opened including file path
syntaxstatus:recent_files
returns listsyntaxstatus:recent_files?string
returns str
return to the status items list
- rotation_xy
current XY rotation angle around Z axis
syntaxstatus:rotation_xy
returns floatsyntaxstatus:rotation_xy?string
returns str
return to the status items list
- settings
current interpreter settings
returns a tuple of floats
index value 0 sequence number 1 F word value (feed) 2 S word value (speed) 3 G64 P value (blend tolerance) 4 G64 Q value (naive CAM tolerance) syntaxstatus:settings
returns tuple of floatssyntaxstatus:settings?string
returns str
return to the status items list
- spindle.n.brake
status of spindle n brake
syntaxstatus:spindle.n.brake
returns intsyntaxstatus:spindle.n.brake?string
returns str
return to the status items list
- spindle.n.direction
rotational direction of the spindle. forward=1, reverse=-1
syntaxstatus:spindle.n.direction
returns intsyntaxstatus:spindle.n.direction?string
returns str
return to the status items list
- spindle.n.enabled
spindle enabled status
syntaxstatus:spindle.n.enabled
returns intsyntaxstatus:spindle.n.enabled?string
returns str
return to the status items list
- spindle.n.homed
spindle n homed
syntaxstatus:spindle.n.homed
returns boolsyntaxstatus:spindle.n.homed?string
returns str
return to the status items list
- spindle.n.orient_fault
spindle n orient fault status
syntaxstatus:spindle.n.orient_fault
returns intsyntaxstatus:spindle.n.orient_fault?string
returns str
return to the status items list
- spindle.n.orient_state
unknown
syntaxstatus:spindle.n.orient_state
returns intsyntaxstatus:spindle.n.orient_state?string
returns str
return to the status items list
- spindle.n.override
spindle n speed override scale
syntaxstatus:spindle.n.override
returns floatsyntaxstatus:spindle.n.override?string
returns str
return to the status items list
- spindle.n.override_enabled
spindle n override enabled
syntaxstatus:spindle.n.override_enabled
returns boolsyntaxstatus:spindle.n.override_enabled?string
returns str
return to the status items list
- spindle.n.speed
spindle n speed rpm, > 0 clockwise, < 0 counterclockwise
syntaxstatus:spindle.n.speed
returns floatsyntaxstatus:spindle.n.speed?string
returns str
return to the status items list
- spindles
number of spindles, ini parameter [TRAJ]SPINDLES
syntaxstatus:spindles
returns intsyntaxstatus:spindles?string
returns str
return to the status items list
- state
current command execution status
syntaxstatus:state
returns intsyntaxstatus:state?string
returns str
return to the status items list
- task_mode
current task mode
int string 0 N/A 1 Manual 2 Auto 3 MDI syntaxstatus:task_mode
returns intsyntaxstatus:task_mode?string
returns str
return to the status items list
- task_paused
task paused status
syntaxstatus:task_paused
returns intsyntaxstatus:task_paused?string
returns str
return to the status items list
- task_state
current task state
int string 0 N/A 1 E-Stop 2 Reset 3 Off 4 On syntaxstatus:task_state
returns intsyntaxstatus:task_state?string
returns str
return to the status items list
- tool_in_spindle
current tool number
syntaxstatus:tool_in_spindle
returns intsyntaxstatus:tool_in_spindle?string
returns str
return to the status items list
- tool_offset
offset values of the current tool
syntaxstatus:tool_offset
returns tuple of floatssyntaxstatus:tool_offset?string
returns str
return to the status items list
return to the status items list
- tool_table
list of tool entries
syntaxstatus:tool_table
returns tuple of tool_resultssyntaxstatus:tool_table?string
returns str
return to the status items list
- velocity
This property is defined, but it does not have a useful interpretation
syntaxstatus:velocity
returns floatsyntaxstatus:velocity?string
returns str