Import LinuxCNC source tree

configs/sim/axis/vismach/3axis-tutorial/3axis-tutorial

@@ -0,0 +1,284 @@
+#!/usr/bin/env python3
+
+# Rolf Redford, Nov 2018
+
+#import libraries
+from vismach import *
+import hal
+import math
+import sys
+
+#----------------------------------------------------------------------------------------------------------------------------------
+# Starting and defining
+
+# used for diameter for versions less than 2.8.
+# it gives us way to access variable values from vismach script.
+import linuxcnc
+s = linuxcnc.stat()
+s.poll()
+
+# Here is where we define pins that linuxcnc will send
+# data to, in order to make movements.
+# We will need 5 pins, 3 for motion and 2 for tool stats.
+# tooldiameter isn't really used but if you are using 2.8 you can make couple changes
+# in this file, and uncomment last line in HAL file.
+# add joints. Mill has 3.
+c = hal.component("3axis-tutorial")
+c.newpin("jointX", hal.HAL_FLOAT, hal.HAL_IN)
+c.newpin("jointY", hal.HAL_FLOAT, hal.HAL_IN)
+c.newpin("jointZ", hal.HAL_FLOAT, hal.HAL_IN)
+
+# tool length and diameter pins?
+c.newpin("toollength", hal.HAL_FLOAT, hal.HAL_IN)
+c.newpin("tooldiameter", hal.HAL_FLOAT, hal.HAL_IN)
+
+# tells loadusr pins is ready
+c.ready()
+
+# Used for tool cylinder
+# it will be updated in shape and length by function below.
+toolshape = CylinderZ(0)
+toolshape = Color([1, .5, .5, .5],[toolshape])
+
+# updates tool cylinder shape.
+class HalToolCylinder(CylinderZ):
+    def __init__(self, comp, *args): 
+        # get machine access so it can
+        # change itself as it runs
+        # specifically tool cylinder in this case.
+        CylinderZ.__init__(self, *args)
+        self.comp = c
+    def coords(self):
+        # update data -  not needed if using 2.8 and self.comp["tooldiameter"]
+        # 2.7 does not have direct pin for diameter so this is workaround. commented out code is direct way to do it.
+        # s.poll() # 2.8 don't need this, comment out if using 2.8.
+        # get diameter and divide by 2 to get radius.
+        # rad = ( s.tool_table[s.tool_in_spindle].diameter ) # 2.7 workaround
+        rad = ( self.comp["tooldiameter"] )  # 2.8 only
+        rad = rad / 2 # change to rad
+        # this instantly updates tool model but tooltip doesn't move till -
+        # tooltip, the drawing point will NOT move till g43h(tool number) is called, however.
+        # Tool will "crash" if h and tool length does not match.
+        leng = s.tool_table[s.tool_in_spindle].zoffset 
+        # Update tool length when g43h(toolnumber) is called, otherwise stays at 0 or previous size.
+        # commented out as I prefer machine to show actual tool size right away.
+        #leng = self.comp["toollength"]
+        return (-leng, rad, 0, rad)
+
+
+#----------------------------------------------------------------------------------------------------------------------------------
+# Concept of machine design
+
+# The model follows logical tree design - picture the tree, with branch and smaller branches off it
+# if you move the larger branch, smaller branches will move with it, but if you move smaller branch larger will not.
+#
+# Machine design follows that conceptal design, so for example if you move X, it can move on its own, but if you move Y,
+# it will also move X assembly, as it is attached to Y assembly.
+# so for this machine, tree looks like this:
+
+# model
+#   |
+#   |---frame
+#   |     |
+#   |     |---base
+#   |     |
+#   |     |---column
+#   |     |
+#   |     |---top
+#   |
+#   |
+#   |---yassembly
+#   |      |
+#   |      |
+#   |      |---xassembly
+#   |      |      |
+#   |      |      |
+#   |      |      |---xbase
+#   |      |      |
+#   |      |      |---work
+#   |      |
+#   |      |
+#   |      |---ybase
+#   |
+#   |
+#   |---zassembly
+#           |
+#           |
+#           |---zframe
+#           |     |
+#           |     |---zbody
+#           |     |
+#           |     |---spindle
+#           |
+#           |
+#           |---toolassembly
+#                     |
+#                     |---cat30
+#                     |
+#                     |---tool
+#                          |
+#                          |---tooltip
+#                          |
+#                          |---(tool cylinder function)
+
+# As you can see, lowest parts must exist first before it can be grouped with others into assembly.
+# So you build upwards from lowest point in tree and assembly them together.
+# Same is applicable for any design of machine. Look at machine arm example and you will see that it starts
+# with tip and adds to larger part of arm then it finally groups with base.
+
+
+#----------------------------------------------------------------------------------------------------------------------------------
+# Starting with fixed frame
+
+# start creating base itself, floor and column for z. box is centered on 0,0,0
+base = BoxCentered(200, 560, 20)
+# translate it so top of base is at zero
+base = Translate([base], 0,0,-10)
+
+# column, attached to base on side. 
+# Box() accepts extents
+# ie -100 to 100 is 200 wide, and rightmost is at -100 on coord.
+#        Box(x rightmost, y futherest, z lowest, x leftmost, y nearest, z highest)
+column = Box(        -60,        -260,        0,         60,      -200,       400)
+
+# add block on top
+# not really needed, but I like how it looks with it.
+# bare column looks little bit strange for some reason.
+top = Box(-80,-280,400, 80,-160,440)
+
+# now fuse it into "frame"
+frame = Collection([base, column, top])
+# color it grayish
+frame = Color([.8,.8,.8,1],[frame])
+
+
+#----------------------------------------------------------------------------------------------------------------------------------
+# Moving parts section
+
+# Start with X, Y then finally Z with tool and spindle.
+
+# X table addition
+xbase = BoxCentered(1000,200,30)
+# let's color it blue
+xbase = Color([0,0,1,1], [xbase])
+# Move table so top is at zero for now,
+# so work (default 0,0,0) is on top of table.
+xbase = Translate([xbase], 0,0, -15)
+
+# now create work which would be defined by Linuxcnc.
+# I suspect we would need to define shape but not enough is known.
+# for now just create an point that would be bottom center of stock.
+work = Capture()
+
+# group work and xbase together so they move together.
+xassembly = Collection([xbase, work])
+# work is now defined and grouped, and default at 0,0,0, or
+# currently on top of x part table.
+# so we move table group upwards, taking work with it.
+xassembly = Translate([xassembly], 0,0, 35)
+
+# Must define part motion before it becomes part of collection.
+# Must have arguments, object itself, c (defined above), then finally scale from the pin to x y z.
+# since this moves solely on X axis, only x is 1, rest is zero.
+# you could use fractions for say axis that moves in compound like arm for example
+# but this machine is very simple, so all axis will be purely full on axis and zero on other axis.
+xassembly = HalTranslate([xassembly], c, "jointX", 1, 0, 0)
+
+# Y assembly creation
+ybase = BoxCentered(200, 200, 10)
+# colorize it green so we can see it separate from frame.
+ybase = Color([0,1,0,1], [ybase])
+# don't define translation for this one, as y also moves X table.
+# translating this would move itself alone. You want it to move X parts also.
+
+# X table is moved by Y base, so we have to make X child of Y.
+# now define collection of ybase and xassembly.
+yassembly = Collection([ybase, xassembly])
+# define its motion first before translate.
+yassembly = HalTranslate([yassembly], c, "jointY", 0, 1, 0)
+# Now that translate is locked with part, 
+# move it upwards so its on frame base.
+yassembly = Translate([yassembly], 0,0,5)
+
+# spindle head
+# define small cylinder where tool will be attached to.
+# It is shallow, basically exposed end of "cat30" toolholder.
+# let's pretend machine uses cat30.
+cat30 = CylinderZ(0, 30, 20, 40) # cone wider top smaller bottom
+# color it red, as in danger, tool!
+cat30 = Color([1,0,0,1], [cat30])
+
+# Define tool and grab such model information from linuxcnc
+# tooltip is initially in vismach "world" 0,0,0. 
+# what it does is place where line drawing is in world, so
+# you can see where machine think tip of tool is.
+# first capture it, so we can use it and move it to where
+# defined end of tool is.
+tooltip = Capture()
+
+# Now that we have tooltip, let's attach it to cylinder function (see above)
+# it creates cylinder then translates tooltip to end of it.
+tool = Collection([
+	Translate([HalTranslate([tooltip], c, "toollength", 0, 0, -1)], 0, 0, 0),
+	HalToolCylinder(toolshape)
+	])
+
+# Since tool is defined, lets attach it to cat30
+# Group cat30 and tooltip
+toolassembly = Collection([cat30, tool])
+# now that tool is properly attached, we can move it
+# and tool will "move" with it now.
+# BUT we need to build rest of head in such way that TOP of head is defined as Z zero.
+# Move it so it attaches to bottom of spindle body.
+toolassembly = Translate([toolassembly],0,0,-120)
+
+# Start building Z assembly head, including spindle and support
+# top is at zero as I want top to be defined as Z home top.
+spindle = CylinderZ(-100, 60, 0, 60) # top is at zero
+# define rest of head using Box
+zbody = Box(-30, -200, 0, 30, 0, -100)
+
+# fuse into z assembly
+zframe = Collection([zbody, spindle])
+# color it yellow
+zframe = Color([1,1,0,1], [zframe])
+
+# Now that all parts are created, let's group it and finally make Z motion
+zassembly = Collection([zframe, toolassembly])
+# define Z motion
+zassembly = HalTranslate([zassembly], c, "jointZ", 0, 0, 1)
+# Now that motion is defined,
+# we can now move it to Z home position.
+zassembly = Translate([zassembly], 0,0, 400)
+
+#----------------------------------------------------------------------------------------------------------------------------------
+# Getting it all together and finishing model
+
+# Assembly everything into single model.
+# xassembly is already included into yassembly so don't need to include it.
+model = Collection([frame, yassembly, zassembly])
+
+# Finally, call main() with parameter to let linuxcnc know.
+# parameter list:
+# final model name must include all parts you want to use
+# tooltip (special for tool tip inclusuion)
+# work (special for work part inclusion)
+# size of screen (bigger means more zoomed out to show more of machine)
+# last 2 is where view point source is.
+main(model, tooltip, work, 600, lat=-75, lon=215)
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+

configs/sim/axis/vismach/3axis-tutorial/3axis-tutorial.hal

@@ -0,0 +1,71 @@
+# core HAL config file for simulation
+
+# first load all the RT modules that will be needed
+# kinematics
+loadrt [KINS]KINEMATICS
+#autoconverted  trivkins
+# motion controller, get name and thread periods from ini file
+loadrt [EMCMOT]EMCMOT base_period_nsec=[EMCMOT]BASE_PERIOD servo_period_nsec=[EMCMOT]SERVO_PERIOD num_joints=[KINS]JOINTS 
+# load 6 differentiators (for velocity and accel signals
+loadrt ddt names=ddt_x,ddt_xv,ddt_y,ddt_yv,ddt_z,ddt_zv
+# load additional blocks
+loadrt hypot names=vel_xy,vel_xyz
+
+# add motion controller functions to servo thread
+addf motion-command-handler servo-thread
+addf motion-controller servo-thread
+# link the differentiator functions into the code
+addf ddt_x servo-thread
+addf ddt_xv servo-thread
+addf ddt_y servo-thread
+addf ddt_yv servo-thread
+addf ddt_z servo-thread
+addf ddt_zv servo-thread
+addf vel_xy servo-thread
+addf vel_xyz servo-thread
+
+# create HAL signals for position commands from motion module
+# loop position commands back to motion module feedback
+net Xpos joint.0.motor-pos-cmd => joint.0.motor-pos-fb ddt_x.in
+net Ypos joint.1.motor-pos-cmd => joint.1.motor-pos-fb ddt_y.in
+net Zpos joint.2.motor-pos-cmd => joint.2.motor-pos-fb ddt_z.in
+
+# send the position commands thru differentiators to
+# generate velocity and accel signals
+net Xvel ddt_x.out => ddt_xv.in vel_xy.in0
+net Xacc <= ddt_xv.out
+net Yvel ddt_y.out => ddt_yv.in vel_xy.in1
+net Yacc <= ddt_yv.out
+net Zvel ddt_z.out => ddt_zv.in vel_xyz.in0
+net Zacc <= ddt_zv.out
+
+# Cartesian 2- and 3-axis velocities
+net XYvel vel_xy.out => vel_xyz.in1
+net XYZvel <= vel_xyz.out
+
+# estop loopback
+net estop-loop iocontrol.0.user-enable-out iocontrol.0.emc-enable-in
+
+loadusr -W hal_manualtoolchange
+net tool-change  iocontrol.0.tool-change => hal_manualtoolchange.change
+net tool-changed iocontrol.0.tool-changed <= hal_manualtoolchange.changed
+net tool-number  iocontrol.0.tool-prep-number => hal_manualtoolchange.number
+net tool-prepare-loopback iocontrol.0.tool-prepare => iocontrol.0.tool-prepared
+
+# start 3axis-tutorial vismach addition
+loadusr -W  ./3axis-tutorial
+
+# "wire" linuxcnc pins to joints defined in vismach file
+net j0 joint.0.pos-fb => 3axis-tutorial.jointX
+net j1 joint.1.pos-fb => 3axis-tutorial.jointY
+net j2 joint.2.pos-fb => 3axis-tutorial.jointZ
+
+#tool sinput
+net tool_len 3axis-tutorial.toollength <= motion.tooloffset.z
+net tool_rad halui.tool.diameter 3axis-tutorial.tooldiameter # Only in 2.8 or later
+
+
+
+
+
+

configs/sim/axis/vismach/3axis-tutorial/3axis-tutorial.ini

@@ -0,0 +1,216 @@
+# This config file was created 2018-11-21 06:26:44.941844 by the update_ini script
+# The original config files may be found in the /home/john/linuxcnc/configs/rolfmill/rolfmill.old directory
+
+# EMC controller parameters for a simulated machine.
+
+# General note: Comments can either be preceded with a # or ; - either is
+# acceptable, although # is in keeping with most linux config files.
+
+# General section -------------------------------------------------------------
+[EMC]
+
+
+# Version of this INI file
+VERSION = 1.0
+
+# Name of machine, for use with display, etc.
+MACHINE =               3axis-tutorial
+
+# Debug level, 0 means no messages. See src/emc/nml_int/emcglb.h for others
+# DEBUG =               0x7FFFFFFF
+DEBUG = 0
+
+# Sections for display options ------------------------------------------------
+[DISPLAY]
+
+# Name of display program, e.g., xemc
+DISPLAY =             axis
+
+# Cycle time, in seconds, that display will sleep between polls
+CYCLE_TIME =            0.100
+
+# Path to help file
+HELP_FILE =             doc/help.txt
+
+# Initial display setting for position, RELATIVE or MACHINE
+POSITION_OFFSET =       RELATIVE
+
+# Initial display setting for position, COMMANDED or ACTUAL
+POSITION_FEEDBACK =     ACTUAL
+
+# Highest value that will be allowed for feed override, 1.0 = 100%
+MAX_FEED_OVERRIDE =     1.2
+MAX_SPINDLE_OVERRIDE =  1.0
+# Prefix to be used
+PROGRAM_PREFIX =/home/rolf/linuxcnc/nc_files #need to change
+
+# Introductory graphic
+INTRO_GRAPHIC = linuxcnc.gif
+INTRO_TIME = 5
+
+#EDITOR = geany
+
+INCREMENTS = 1 mm, .01 in, .1mm, 1 mil, .1 mil, 1/8000 in
+
+[FILTER]
+PROGRAM_EXTENSION = .png,.gif,.jpg Grayscale Depth Image
+PROGRAM_EXTENSION = .py Python Script
+
+png = image-to-gcode
+gif = image-to-gcode
+jpg = image-to-gcode
+py = python3
+
+# Task controller section -----------------------------------------------------
+
+[RS274NGC]
+
+# File containing interpreter variables
+PARAMETER_FILE = 3axis-tutorial_mm.var
+
+# Motion control section ------------------------------------------------------
+[EMCMOT]
+
+
+EMCMOT =              motmod
+
+# Timeout for comm to emcmot, in seconds
+COMM_TIMEOUT =          1.0
+
+
+# BASE_PERIOD is unused in this configuration but specified in core_sim.hal
+BASE_PERIOD  =               0
+# Servo task period, in nano-seconds
+SERVO_PERIOD =               1000000
+
+# Hardware Abstraction Layer section --------------------------------------------------
+[TASK]
+
+# Name of task controller program, e.g., milltask
+TASK =                  milltask
+
+# Cycle time, in seconds, that task controller will sleep between polls
+CYCLE_TIME =            0.001
+
+# Part program interpreter section --------------------------------------------
+
+[HAL]
+
+# The run script first uses halcmd to execute any HALFILE
+# files, and then to execute any individual HALCMD commands.
+#
+
+# list of hal config files to run through halcmd
+# files are executed in the order in which they appear
+HALFILE = 3axis-tutorial.hal
+
+# list of halcmd commands to execute
+# commands are executed in the order in which they appear
+#HALCMD =                    save neta
+
+# Single file that is executed after the GUI has started.  Only supported by
+# AXIS at this time (only AXIS creates a HAL component of its own)
+#POSTGUI_HALFILE = test_postgui.hal
+
+HALUI = halui
+
+# Trajectory planner section --------------------------------------------------
+
+[HALUI]
+#No Content
+
+[TRAJ]
+
+
+AXES =                  3
+COORDINATES =           X Y Z
+HOME =                  0 0 0
+LINEAR_UNITS =          mm
+ANGULAR_UNITS =         degree
+DEFAULT_LINEAR_VELOCITY =      30.48
+MAX_LINEAR_VELOCITY =          53.34
+DEFAULT_ACCELERATION =  508
+MAX_LINEAR_ACCELERATION =      508
+POSITION_FILE = position_mm.txt
+ARC_BLEND_ENABLE =      1
+ARC_BLEND_FALLBACK_ENABLE = 1
+ARC_BLEND_OPTIMIZATION_DEPTH = 50
+#Use this setting for no smoothing (for debugging and stress-testing)
+ARC_BLEND_SMOOTHING_THRESHOLD = .75
+#Use this setting for "normal" smoothing, i.e. if we blend over more than 40% of a segment
+#ARC_BLEND_SMOOTHING_THRESHOLD = 0.40
+
+# Axes sections ---------------------------------------------------------------
+
+[EMCIO]
+# tool table file
+TOOL_TABLE = tool.tbl
+TOOL_CHANGE_POSITION = 0 0 0
+
+
+[KINS]
+KINEMATICS = trivkins
+#This is a best-guess at the number of joints, it should be checked
+JOINTS = 3
+
+[AXIS_X]
+MIN_LIMIT = -500.0
+MAX_LIMIT = 500.0
+MAX_VELOCITY = 25.0
+MAX_ACCELERATION = 750.0
+
+[JOINT_0]
+
+TYPE = LINEAR
+HOME = 0.0
+MAX_VELOCITY = 25.0
+MAX_ACCELERATION = 750.0
+STEPGEN_MAXACCEL = 937.5
+SCALE = 80.0
+FERROR = 1
+MIN_FERROR = .25
+MIN_LIMIT = -500.0
+MAX_LIMIT = 500.0
+HOME_OFFSET = 0.0
+
+[AXIS_Y]
+MIN_LIMIT = -100.0
+MAX_LIMIT = 100.0
+MAX_VELOCITY = 25.0
+MAX_ACCELERATION = 750.0
+
+[JOINT_1]
+
+TYPE = LINEAR
+HOME = 0.0
+MAX_VELOCITY = 25.0
+MAX_ACCELERATION = 750.0
+STEPGEN_MAXACCEL = 937.5
+SCALE = 80.0
+FERROR = 1
+MIN_FERROR = .25
+MIN_LIMIT = -100.0
+MAX_LIMIT = 100.0
+HOME_OFFSET = 0.0
+
+[AXIS_Z]
+MIN_LIMIT = -240.0
+MAX_LIMIT = 0.001
+MAX_VELOCITY = 25.0
+MAX_ACCELERATION = 750.0
+
+[JOINT_2]
+
+TYPE = LINEAR
+HOME = 0.0
+MAX_VELOCITY = 25.0
+MAX_ACCELERATION = 750.0
+STEPGEN_MAXACCEL = 937.5
+SCALE = 80.0
+FERROR = 1
+MIN_FERROR = .25
+MIN_LIMIT = -240.0
+MAX_LIMIT = 0.001
+HOME_OFFSET = 0.0
+
+# section for main IO controller parameters -----------------------------------

configs/sim/axis/vismach/3axis-tutorial/README

@@ -0,0 +1,2 @@
+A simple vismach 3 axis mill example built using primitives.
+Comments is in 3axis-tutorial vismach file, and some in 3axis-tutorial.hal explains step by step the process to build.

configs/sim/axis/vismach/3axis-tutorial/tool.tbl

@@ -0,0 +1,4 @@
+T1 P1 Z12 D30 ;big 
+T2 P2 Z50 D10 ;1/16 end mill 
+T3 P3 Z50 D5 ;#7 tap drill 
+T99999 P99999 Z0.1 ;big tool number