jepler/linuxcnc
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Docs: fix incorrect return values and add constants

Browse source 
Signed-off-by: John Thornton <bjt128@gmail.com>
This commit is contained in:
John Thornton 2016-09-05 07:24:36 -05:00
parent e2c70c4ec3
commit e88c0068e6
1 changed files with 52 additions and 41 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

93
docs/src/config/python-interface.txt
View file

@ -81,25 +81,25 @@ ini file values>> for an example.
*acceleration* :: '(returns float)' - *acceleration* :: '(returns float)' -
default acceleration, reflects the ini entry [TRAJ] DEFAULT_ACCELERATION. default acceleration, reflects the ini entry [TRAJ] DEFAULT_ACCELERATION.
*active_queue*:: '(returns int)' - *active_queue*:: '(returns integer)' -
number of motions blending. number of motions blending.
*actual_position*:: '(returns tuple of floats)' - *actual_position*:: '(returns tuple of floats)' -
current trajectory position, (x y z a b c u v w) in machine units. current trajectory position, (x y z a b c u v w) in machine units.
*adaptive_feed_enabled*:: '(returns True/False)' - *adaptive_feed_enabled*:: '(returns boolean)' -
status of adaptive feedrate override (0/1). status of adaptive feedrate override (0/1).
*ain*:: '(returns tuple of floats)' - *ain*:: '(returns tuple of floats)' -
current value of the analog input pins. current value of the analog input pins.
*angular_units*:: '(returns string)' - *angular_units*:: '(returns float)' -
reflects [TRAJ] ANGULAR_UNITS ini value. reflects [TRAJ] ANGULAR_UNITS ini value.
*aout*:: '(returns tuple of floats)' - *aout*:: '(returns tuple of floats)' -
current value of the analog output pins. current value of the analog output pins.
*axes*:: '(returns string)' - *axes*:: '(returns integer)' -
reflects [TRAJ] AXES ini value. reflects [TRAJ] AXES ini value.
*axis*:: '(returns tuple of dicts)' - *axis*:: '(returns tuple of dicts)' -
@ -111,8 +111,8 @@ mask of axis available as defined by [TRAJ] COORDINATES in the ini
file. Returns the sum of the axes X=1, Y=2, Z=4, A=8, B=16, C=32, U=64, file. Returns the sum of the axes X=1, Y=2, Z=4, A=8, B=16, C=32, U=64,
V=128, W=256. V=128, W=256.
*block_delete*:: '(returns integer)' - *block_delete*:: '(returns boolean)' -
block delete currently on/off. block delete curren status.
*command*:: '(returns string)' - *command*:: '(returns string)' -
currently executing command. currently executing command.
@ -121,13 +121,13 @@ currently executing command.
currently executing line, int. currently executing line, int.
*current_vel*:: '(returns float)' - *current_vel*:: '(returns float)' -
current velocity in Cartesian space. current velocity in user units per second.
*cycle_time*:: '(returns string)' - *cycle_time*:: '(returns float)' -
reflects [TRAJ] CYCLE_TIME ini value (FIXME is this right?). thread period
*debug*:: '(returns integer)' - *debug*:: '(returns integer)' -
debug flag. debug flag from the ini file.
*delay_left*:: '(returns float)' - *delay_left*:: '(returns float)' -
remaining time on dwell (G4) command, seconds. remaining time on dwell (G4) command, seconds.
@ -136,13 +136,13 @@ remaining time on dwell (G4) command, seconds.
current value of the digital input pins. current value of the digital input pins.
*distance_to_go*:: '(returns float)' - *distance_to_go*:: '(returns float)' -
remaining distance of current move, as reported by trajectory planner, in Cartesian space. remaining distance of current move, as reported by trajectory planner.
*dout*:: '(returns tuple of integers)' - *dout*:: '(returns tuple of integers)' -
current value of the digital output pins. current value of the digital output pins.
*dtg*:: '(returns tuple of 9 floats)' - *dtg*:: '(returns tuple of floats)' -
remaining distance of current move, as reported by trajectory planner. remaining distance of current move for each axis, as reported by trajectory planner.
*echo_serial_number*:: '(returns integer)' - *echo_serial_number*:: '(returns integer)' -
The serial number of the last completed command sent by a UI The serial number of the last completed command sent by a UI
@ -150,11 +150,11 @@ to task. All commands carry a serial number. Once the command
has been executed, its serial number is reflected in has been executed, its serial number is reflected in
`echo_serial_number`. `echo_serial_number`.
*enabled*:: '(returns integer)' - *enabled*:: '(returns boolean)' -
trajectory planner enabled flag. trajectory planner enabled flag.
*estop*:: '(returns integer)' - *estop*:: '(returns integer)' -
estop flag. Returns either STATE_ESTOP or not.
*exec_state*:: '(returns integer)' - *exec_state*:: '(returns integer)' -
task execution state. One of EXEC_ERROR, EXEC_DONE, task execution state. One of EXEC_ERROR, EXEC_DONE,
@ -162,23 +162,24 @@ EXEC_WAITING_FOR_MOTION, EXEC_WAITING_FOR_MOTION_QUEUE,
EXEC_WAITING_FOR_PAUSE,EXEC_WAITING_FOR_MOTION_AND_IO, EXEC_WAITING_FOR_PAUSE,EXEC_WAITING_FOR_MOTION_AND_IO,
EXEC_WAITING_FOR_DELAY, EXEC_WAITING_FOR_SYSTEM_CMD. EXEC_WAITING_FOR_DELAY, EXEC_WAITING_FOR_SYSTEM_CMD.
*feed_hold_enabled*:: '(returns integer)' - *feed_hold_enabled*:: '(returns boolean)' -
enable flag for feed hold. enable flag for feed hold.
*feed_override_enabled*:: '(returns integer)' - *feed_override_enabled*:: '(returns boolean)' -
enable flag for feed override. enable flag for feed override.
*feedrate*:: '(returns float)' - *feedrate*:: '(returns float)' -
current feedrate override. current feedrate override, 1.0 = 100%.
*file*:: '(returns string)' - *file*:: '(returns string)' -
currently executing gcode file. currently loaded gcode filename with path.
*flood*:: '(returns integer)' - *flood*:: '(returns integer)' -
flood enabled. One of 'FLOOD_OFF' or 'FLOOD_ON'.
*g5x_index*:: '(returns string)' - *g5x_index*:: '(returns integer)' -
currently active coordinate system, G54=0, G55=1 etc. **** replace with constants list
currently active coordinate system, G54=1, G55=2 etc.
*g5x_offset*:: '(returns tuple of floats)' - *g5x_offset*:: '(returns tuple of floats)' -
offset of the currently active coordinate system. offset of the currently active coordinate system.
@ -186,19 +187,27 @@ offset of the currently active coordinate system.
*g92_offset*:: '(returns tuple of floats)' - *g92_offset*:: '(returns tuple of floats)' -
pose of the current g92 offset. pose of the current g92 offset.
*gcodes*:: '(returns tuple of 16 integers)' - *gcodes*:: '(returns tuple of integers)' -
currently active G-codes. Active G-codes for each modal group.
G code constants
G_0, G_1, G_2, G_3, G_4, G_5, G_5_1, G_5_2, G_5_3, G_7, G_8, G_100, G_17,
G_17_1, G_18, G_18_1, G_19, G_19_1, G_20, G_21, G_28, G_28_1, G_30, G_30_1,
G_33, G_33_1, G_38_2, G_38_3, G_38_4, G_38_5, G_40, G_41, G_41_1, G_42, G_42_1,
G_43, G_43_1, G_43_2, G_49, G_50, G_51, G_53, G_54, G_55, G_56, G_57, G_58,
G_59, G_59_1, G_59_2, G_59_3, G_61, G_61_1, G_64, G_73, G_76, G_80, G_81, G_82,
G_83, G_84, G_85, G_86, G_87, G_88, G_89, G_90, G_90_1, G_91, G_91_1, G_92,
G_92_1, G_92_2, G_92_3, G_93, G_94, G_95, G_96, G_97, G_98, G_99
*homed*:: '(returns integer)' - *homed*:: '(returns tuple of integers)' -
flag. 1 if homed. 0 = not homed, 1 = homed.
*id*:: '(returns integer)' - *id*:: '(returns integer)' -
currently executing motion id. currently executing motion id.
*inpos*:: '(returns integer)' - *inpos*:: '(returns boolean)' -
machine-in-position flag. machine-in-position flag.
*input_timeout*:: '(returns integer)' - *input_timeout*:: '(returns boolean)' -
flag for M66 timer in progress. flag for M66 timer in progress.
*interp_state*:: '(returns integer)' - *interp_state*:: '(returns integer)' -
@ -224,7 +233,8 @@ identity=1, serial=2, parallel=3, custom=4 .
axis limit masks. minHardLimit=1, axis limit masks. minHardLimit=1,
maxHardLimit=2, minSoftLimit=4, maxSoftLimit=8. maxHardLimit=2, minSoftLimit=4, maxSoftLimit=8.
*linear_units*:: '(returns string)' - *linear_units*:: '(returns float)' -
******
reflects [TRAJ]LINEAR_UNITS ini value. reflects [TRAJ]LINEAR_UNITS ini value.
*lube*:: '(returns integer)' - *lube*:: '(returns integer)' -
@ -259,21 +269,21 @@ TRAJ_MODE_FREE, TRAJ_MODE_TELEOP.
*optional_stop*:: '(returns integer)' - *optional_stop*:: '(returns integer)' -
option stop flag. option stop flag.
*paused*:: '(returns integer)' - *paused*:: '(returns boolean)' -
`motion paused` flag. `motion paused` flag.
*pocket_prepped*:: '(returns integer)' - *pocket_prepped*:: '(returns integer)' -
A Tx command completed, and this pocket is prepared. -1 if no A Tx command completed, and this pocket is prepared. -1 if no
prepared pocket. prepared pocket.
*poll()*:: - *poll()*:: -'(built-in function)'
method to update current status attributes. method to update current status attributes.
*position*:: '(returns tuple of floats)' - *position*:: '(returns tuple of floats)' -
trajectory position. trajectory position.
*probe_tripped*:: '(returns integer)' - *probe_tripped*:: '(returns boolean)' -
flag, true if probe has tripped (latch) flag, True if probe has tripped (latch)
*probe_val*:: '(returns integer)' - *probe_val*:: '(returns integer)' -
reflects value of the `motion.probe-input` pin. reflects value of the `motion.probe-input` pin.
@ -281,8 +291,8 @@ reflects value of the `motion.probe-input` pin.
*probed_position*:: '(returns tuple of floats)' - *probed_position*:: '(returns tuple of floats)' -
position where probe tripped. position where probe tripped.
*probing*:: '(returns integer)' - *probing*:: '(returns boolean)' -
flag, 1 if a probe operation is in progress. flag, True if a probe operation is in progress.
*program_units*:: '(returns integer)' - *program_units*:: '(returns integer)' -
one of CANON_UNITS_INCHES=1, CANON_UNITS_MM=2, CANON_UNITS_CM=3 one of CANON_UNITS_INCHES=1, CANON_UNITS_MM=2, CANON_UNITS_CM=3
@ -290,16 +300,19 @@ one of CANON_UNITS_INCHES=1, CANON_UNITS_MM=2, CANON_UNITS_CM=3
*queue*:: '(returns integer)' - *queue*:: '(returns integer)' -
current size of the trajectory planner queue. current size of the trajectory planner queue.
*queue_full*:: '(returns integer)' - *queue_full*:: '(returns boolean)' -
the trajectory planner queue is full. the trajectory planner queue is full.
*rapidrate*:: '(returns float)' -
rapid override scale.
*read_line*:: '(returns integer)' - *read_line*:: '(returns integer)' -
line the RS274NGC interpreter is currently reading. line the RS274NGC interpreter is currently reading.
*rotation_xy*:: '(returns float)' - *rotation_xy*:: '(returns float)' -
current XY rotation angle around Z axis. current XY rotation angle around Z axis.
*settings*:: '(returns tuple of 3 floats)' - *settings*:: '(returns tuple of floats)' -
current interpreter settings. settings[0] = current interpreter settings. settings[0] =
sequence number, settings[1] = feed rate, settings[2] = speed. sequence number, settings[1] = feed rate, settings[2] = speed.
@ -315,7 +328,7 @@ value of the spindle enabled flag.
*spindle_increasing*:: '(returns integer)' - *spindle_increasing*:: '(returns integer)' -
unclear. unclear.
*spindle_override_enabled*:: '(returns integer)' - *spindle_override_enabled*:: '(returns boolean)' -
value of the spindle override enabled flag. value of the spindle override enabled flag.
*spindle_speed*:: '(returns float)' - *spindle_speed*:: '(returns float)' -
@ -325,9 +338,6 @@ counterclockwise.
*spindlerate*:: '(returns float)' - *spindlerate*:: '(returns float)' -
spindle speed override scale. spindle speed override scale.
*rapidrate*:: '(returns float)' -
rapid override scale.
*state*:: '(returns integer)' - *state*:: '(returns integer)' -
current command execution status. One of RCS_DONE, current command execution status. One of RCS_DONE,
RCS_EXEC, RCS_ERROR. RCS_EXEC, RCS_ERROR.
@ -356,6 +366,7 @@ woffset, diameter, frontangle, backangle, orientation. The id and orientation
are integers and the rest are floats. are integers and the rest are floats.
*velocity*:: '(returns float)' - *velocity*:: '(returns float)' -
********
default velocity. reflects [TRAJ] DEFAULT_VELOCITY. default velocity. reflects [TRAJ] DEFAULT_VELOCITY.
=== The `axis` dictionary [[sec:the-axis-dictionary]] === The `axis` dictionary [[sec:the-axis-dictionary]]