Change how speed units are handled. #30

Author: karliss

inkcut/core/utils.py

@@ -97,6 +97,22 @@ def to_unit(val, unit="px"):
     return QtSvgDoc.convertToUnit(val, unit)
 
 
+def from_speed_unit(val, unit):
+    dist_unit, time_unit = unit.split('/')
+    speed = from_unit(val, dist_unit)
+    if time_unit == 'min':
+        speed /= 60
+    return speed
+
+
+def to_speed_unit(val, unit):
+    dist_unit, time_unit = unit.split('/')
+    speed = to_unit(val, dist_unit)
+    if time_unit == 'min':
+        speed *= 60
+    return speed
+
+
 def parse_unit(val):
     """Parse a string into pixels"""
     return QtSvgDoc.parseUnit(val)

inkcut/device/plugin.py

@@ -167,7 +167,7 @@ def set_velocity(self, v):
         Parameters
         ----------
         v: int
-            The force setting value to send to the device
+            velocity in inkcut units/s
 
         """
 
@@ -280,12 +280,12 @@ class DeviceConfig(Model):
     #: Time between each path command
     #: Time to wait between each step so we don't get
     #: way ahead of the cutter and fill up it's buffer
-    step_time = Float(strict=False).tag(config=True)
+    step_time = Float(strict=False).tag(config=True) # ms
     custom_rate = Float(-1, strict=False).tag(config=True)
 
     #: Distance between each command in user units
     #: this is effectively the resolution the software supplies
-    step_size = Float(parse_unit('1mm'), strict=False).tag(config=True)
+    step_size = Float(from_unit(1, 'mm'), strict=False).tag(config=True)
 
     #: Interpolate paths breaking them into small sections that
     #: can be sent. This allows pausing mid plot as many devices do not have
@@ -347,9 +347,8 @@ class DeviceConfig(Model):
     #: Defines prescaling before conversion to a polygon
     quality_factor = Float(1, strict=False).tag(config=True)
 
-    #: In cm/s
-    speed = Float(4, strict=False).tag(config=True)
-    speed_units = Enum('in/s', 'cm/s').tag(config=True)
+    speed = Float(4, strict=False).tag(config=True) # in inkcut units/s
+    speed_display_units = Enum('in/s', 'cm/s', 'mm/s', 'mm/min').tag(config=True)
     speed_enabled = Bool().tag(config=True)
 
     #: Force in g
@@ -381,10 +380,7 @@ def _default_step_time(self):
 
 
         """
-        #: Convert speed to px/s then to mm/s
-        units = self.speed_units.split("/")[0]
-        speed = parse_unit('%s%s' % (self.speed, units))
-        speed = to_unit(speed, 'mm')
+        speed = self.speed
         if speed == 0:
             return 0
 
@@ -394,7 +390,7 @@ def _default_step_time(self):
     def _default_area(self):
         return AreaBase()
 
-    @observe('speed', 'speed_units', 'step_size')
+    @observe('speed', 'step_size')
     def _update_step_time(self, change):
         if change['type'] == 'update':
             self.step_time = self._default_step_time()
@@ -703,9 +699,7 @@ def init(self, job):
         log.debug("device | init {}".format(job))
         config = self.config
 
-        # Set the speed of this device for tracking purposes
-        units = config.speed_units.split("/")[0]
-        job.info.speed = from_unit(config.speed, units)
+        job.info.speed = config.speed
 
         direction = self.config.expansion_direction
 
@@ -865,9 +859,7 @@ def submit(self, job, test=False):
                     else:
                         rate = 0 # Undefined
                 else:
-                    rate = from_unit(
-                        config.speed,  # in/s or cm/s
-                        config.speed_units.split("/")[0])/1000.0
+                    rate = config.speed/1000.0
 
                 # Device model is updated in real time
                 model = yield defer.maybeDeferred(self.init, job)

inkcut/device/protocols/gcode.py

@@ -7,7 +7,7 @@
 import atom.api
 import twisted.internet.task
 
-from inkcut.core.utils import async_sleep, log
+from inkcut.core.utils import async_sleep, log, from_speed_unit, to_speed_unit
 from inkcut.device.plugin import DeviceProtocol, Model
 from inkcut.core.api import from_unit, to_unit
 from twisted.internet import defer
@@ -195,8 +195,17 @@ def move(self, x, y, z, absolute=True):
     def set_force(self, f):
         raise NotImplementedError
 
+    @defer.inlineCallbacks
     def set_velocity(self, v):
-        raise NotImplementedError
+        # Marlin docs -> unit/min
+        # FluidNC -> unit/min (unless inverse time mode is active)
+        # reprap wiki unit/min
+        # LinuxCNC -> unit/min (unless inverse time mode active)
+        if self.config.unit_mode == GCodeConfig.UNIT_METRIC:
+            v = to_speed_unit(v, "mm/min")
+        else:
+            v = to_speed_unit(v, "in/min")
+        yield self.write("G1 F{:.3f}".format(v))
 
     def set_pen(self, p):
         raise NotImplementedError

inkcut/device/protocols/gpgl.py

@@ -11,6 +11,7 @@
 from inkcut.device.plugin import DeviceProtocol
 from atom.api import Instance, Float, Bool, Int, Enum
 from inkcut.device.plugin import DeviceProtocol, Model
+from inkcut.core.utils import to_unit
 
 
 class GPGLConfig(Model):
@@ -39,7 +40,11 @@ def move(self, x, y, z, absolute=True):
             self.write("%s%i,%i" % ('E' if z else 'O', x, y))
 
     def set_velocity(self, v):
-        self.write('!%i' % v)
+        # MP4000 series command set reference manual -> 10mm/s = cm/s
+        # note that speed can be set in two different modes 1-10  uses an abstract scale from min to max speed
+        # 100...(max_speed+100) specifies spped offset by 100 in cm/s
+        speed = max(1, round(to_unit(v, "cm")))
+        self.write('!{:i}'.format(speed + 100))
 
     def set_force(self, f):
         self.write("FX%i,1" % f)

inkcut/device/protocols/hpgl.py

@@ -6,7 +6,7 @@
 """
 from atom.api import Instance, Float, Bool, Int
 from inkcut.device.plugin import DeviceProtocol, Model
-from inkcut.core.utils import log
+from inkcut.core.utils import log, to_speed_unit
 
 
 class HPGLConfig(Model):
@@ -47,7 +47,11 @@ def set_force(self, f):
         self.write("FS%i; " % f)
 
     def set_velocity(self, v):
-        self.write("VS%i;" % v)
+        # HP DraftPro programmers reference says that speed units are cm/s
+        # HP 7585B service manual -> "1 to 6cm/s (0.4 to 24in/s) in 1cm increments"
+        # Siemens C1613 PROGRAMMIERHANDBUCH cm/sek
+        # Roland DPX-3300 operation manual cm/s
+        self.write("VS{}".format(round(to_speed_unit(v, 'cm/s'))))
 
     def set_pen(self, p):
         self.write("SP%i;" % p)

inkcut/device/view.enaml

@@ -23,7 +23,7 @@ from enaml.widgets.api import (
 from enamlx.widgets.api import DoubleSpinBox
 from inkcut.core.api import Model, DockItem
 from inkcut.core.models import AreaBase
-from inkcut.core.utils import to_unit, from_unit, load_icon
+from inkcut.core.utils import to_unit, from_unit, to_speed_unit, from_speed_unit, load_icon
 from inkcut.preview.plot_view import PlotView
 from inkcut.ui.widgets import AlignmentChoice9
 from .plugin import DeviceConfig
@@ -80,12 +80,22 @@ enamldef DeviceConfigView(Container):
             Form:
                 Label:
                     text = QApplication.translate("device", "Speed")
-                DoubleSpinBox:
-                    minimum = 0
-                    maximum = 999999999
-                    value := model.speed
-                    single_step = 4
-                    suffix << " {}".format(model.speed_units)
+                Container:
+                    padding = 0
+                    constraints = [
+                        hbox(speed, speed_unit)
+                    ]
+                    DoubleSpinBox: speed:
+                        minimum = 0
+                        maximum = 999999999
+                        value << to_speed_unit(model.speed, model.speed_display_units)
+                        value :: model.speed = from_speed_unit(change['value'], model.speed_display_units)
+                        single_step = 4
+                        suffix << " {}".format(model.speed_display_units)
+                    ObjectCombo: speed_unit:
+                        items = list(model.get_member('speed_display_units').items)
+                        selected := model.speed_display_units
+                        tool_tip = QApplication.translate("device", "Display units for speed, does not affect units used by protocol.")
                 Label:
                     text = ""
                 CheckBox: