dsf-python 3.6.0b2.post3__tar.gz → 3.6.0rc1.post1__tar.gz

{dsf_python-3.6.0b2.post3 → dsf_python-3.6.0rc1.post1}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: dsf-python
-Version: 3.6.0b2.post3
+Version: 3.6.0rc1.post1
 Summary: Python interface to access DuetSoftwareFramework
 Home-page: https://github.com/Duet3D/dsf-python
 Author: Duet3D Ltd.
@@ -29,6 +29,19 @@ Requires-Dist: python-dateutil
 Provides-Extra: dev
 Requires-Dist: sphinx; extra == "dev"
 Requires-Dist: tox; extra == "dev"
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: license-file
+Dynamic: project-url
+Dynamic: provides-extra
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
 
 # Duet Software Framework Python Bindings
 

{dsf_python-3.6.0b2.post3 → dsf_python-3.6.0rc1.post1}/setup.cfg

@@ -5,7 +5,7 @@ license_files = LICENSE
 max-line-length = 120
 
 [sdist_dsc]
-forced-upstream-version = 3.6.0-b2.post3
+forced-upstream-version = 3.6.0-rc1.post1
 
 [egg_info]
 tag_build = 

{dsf_python-3.6.0b2.post3 → dsf_python-3.6.0rc1.post1}/setup.py

@@ -6,7 +6,7 @@ long_description = open("README.md", encoding="utf-8").read()
 
 setuptools.setup(
     name="dsf-python",
-    version="3.6.0-b2.post3",
+    version="3.6.0-rc1.post1",
     description="Python interface to access DuetSoftwareFramework",
     long_description=long_description,
     long_description_content_type="text/markdown",

{dsf_python-3.6.0b2.post3 → dsf_python-3.6.0rc1.post1}/src/dsf/__init__.py

@@ -1,4 +1,4 @@
-__version__ = "3.6.0-b2.post3"
+__version__ = "3.6.0-rc1.post1"
 
 # path to unix socket file
 SOCKET_FILE = "/run/dsf/dcs.sock"

{dsf_python-3.6.0b2.post3 → dsf_python-3.6.0rc1.post1}/src/dsf/connections/base_connection.py

@@ -1,5 +1,6 @@
 import json
 import socket
+import time
 from typing import Optional
 
 from .exceptions import IncompatibleVersionException, InternalServerException, TaskCanceledException
@@ -25,7 +26,8 @@ class BaseConnection:
 
         self.socket = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM)
         self.socket.connect(socket_file)
-        self.socket.setblocking(True)
+        self.socket.settimeout(self.timeout if self.timeout > 0 else None)
+        # self.socket.setblocking(True)
         server_init_msg = server_init_message.ServerInitMessage.from_json(
             json.loads(self.socket.recv(50).decode("utf8"))
         )
@@ -98,7 +100,11 @@ class BaseConnection:
             json_string = json_string[:end_index]
         else:
             found = False
+            start_time = time.time()
             while not found:
+                if (self.timeout > 0) and (time.time() - start_time > self.timeout):
+                    raise TimeoutError("Timeout while waiting for JSON response")
+
                 # Refill the buffer and check again
                 BUFF_SIZE = 4096  # 4 KiB
                 data = b""

{dsf_python-3.6.0b2.post3 → dsf_python-3.6.0rc1.post1}/src/dsf/connections/intercept_connection.py

@@ -37,8 +37,9 @@ class InterceptConnection(BaseCommandConnection):
         auto_evaluate_expression: bool = True,
         priority_codes: bool = False,
         debug: bool = False,
+        timeout: int = 0
     ):
-        super().__init__(debug)
+        super().__init__(debug, timeout)
         self.interception_mode = interception_mode
         self.channels = channels if channels is not None else CodeChannel.list()
         self.filters = filters

{dsf_python-3.6.0b2.post3 → dsf_python-3.6.0rc1.post1}/src/dsf/http.py

@@ -140,7 +140,8 @@ class HttpEndpointUnixSocket:
         if self._loop is not None:
             # TODO: this enables correctly ending the loop. Why?
             self._loop.set_debug(True)
-            self._server.close()
+            if self._server is not None:
+                self._server.close()
             self._loop.stop()
         self.event_loop.cancel()
         self.executor.shutdown(wait=False)

{dsf_python-3.6.0b2.post3 → dsf_python-3.6.0rc1.post1}/src/dsf/object_model/heat/heater.py

@@ -1,5 +1,5 @@
 from enum import Enum
-from typing import List
+from typing import List, Union
 
 from .heater_model import HeaterModel
 from .heater_monitor import HeaterMonitor
@@ -39,6 +39,10 @@ class Heater(ModelObject):
         self._avg_pwm = 0
         # Current temperature of the heater (in C)
         self._current = -273.15
+        # Current feedforward PWM boost applied to the heater
+        self._extr_pwm_boost = 0.0
+        # Current temperature boost applied to the heater
+        self._extr_temp_boost = 0.0
         # Maximum temperature allowed for this heater (in C)
         # This is only temporary and should be replaced by a representation of the heater protection as in RRF
         self._max = 285
@@ -89,6 +93,24 @@ class Heater(ModelObject):
     def current(self, value: float):
         self._current = float(value)
 
+    @property
+    def extr_pwm_boost(self) -> float:
+        """Current feedforward PWM boost applied to the heater"""
+        return self._extr_pwm_boost
+
+    @extr_pwm_boost.setter
+    def extr_pwm_boost(self, value: float):
+        self._extr_pwm_boost = float(value)
+
+    @property
+    def extr_temp_boost(self) -> float:
+        """Current temperature boost applied to the heater"""
+        return self._extr_temp_boost
+
+    @extr_temp_boost.setter
+    def extr_temp_boost(self, value: float):
+        self._extr_temp_boost = float(value)
+
     @property
     def max(self) -> float:
         """Maximum temperature allowed for this heater (in C)

{dsf_python-3.6.0b2.post3 → dsf_python-3.6.0rc1.post1}/src/dsf/object_model/job/gcode_fileinfo.py

@@ -11,6 +11,7 @@ class GCodeFileInfo(ModelObject):
 
     def __init__(self):
         super().__init__()
+        self._custom_info = {}
         self._filament = []
         self._file_name = ""
         self._generated_by = ""
@@ -23,6 +24,11 @@ class GCodeFileInfo(ModelObject):
         self._size = 0
         self._thumbnails = ModelCollection(ThumbnailInfo)
 
+    @property
+    def custom_info(self) -> dict:
+        """Custom information extracted from the G-code file"""
+        return self._custom_info
+
     @property
     def filament(self) -> List[float]:
         """Filament consumption per extruder drive (in mm)"""

{dsf_python-3.6.0b2.post3 → dsf_python-3.6.0rc1.post1}/src/dsf/object_model/model_collection.py

@@ -1,25 +1,34 @@
+from typing import Generic, TypeVar, Type, List, Dict, Any, Union, Optional
 from .utils import is_model_object
 
+T = TypeVar('T')
 
-class ModelCollection(list):
+
+class ModelCollection(Generic[T], list):
     """
     Class for storing model object items in a list
     Useful for updating model object items from JSON data (patches)
     """
     
-    def __init__(self, item_constructor, value=None):
+    def __init__(self, item_constructor: Type[T], value: Optional[List[T]] = None) -> None:
         """
-
         :param item_constructor: Item constructor type that items must derive from
         :param value: Value used to initialize the list from
         """
         super().__init__()
-        self._item_constructor = item_constructor
+        self._item_constructor: Type[T] = item_constructor
 
         if value is not None:
-            self[:] = value
+            self[:] = []
+            for (i, item) in enumerate(value):
+                if isinstance(item, self._item_constructor):
+                    self.append(item)
+                else:
+                    ref_item = self._item_constructor()
+                    ref_item.update_from_json(item)
+                    self.append(ref_item)
 
-    def update_from_json(self, json_element):
+    def update_from_json(self, json_element: List[Any]) -> 'ModelCollection[T]':
         """
         Update this instance from the given data
         :param json_element: JSON data to upgrade this instance from

{dsf_python-3.6.0b2.post3 → dsf_python-3.6.0rc1.post1}/src/dsf/object_model/move/axis.py

@@ -86,6 +86,8 @@ class Axis(ModelObject):
         self._percent_current = 100
         # Percentage applied to the motor current during standstill (0..100 or None if not supported)
         self._percent_stst_current = None
+        # Motor jerk during the current print only (in mm/s)
+        self._printing_jerk = None
         # Reduced accelerations used by Z probing and stall homing moves (in mm/s^2)
         self._reduced_acceleration = 0
         # Maximum speed (in mm/min)
@@ -242,6 +244,15 @@ class Axis(ModelObject):
     def percent_stst_current(self, value):
         self._percent_stst_current = int(value) if value is not None else None
 
+    @property
+    def printing_jerk(self) -> Union[float, None]:
+        """Motor jerk during the current print only (in mm/s)"""
+        return self._printing_jerk
+
+    @printing_jerk.setter
+    def printing_jerk(self, value):
+        self._printing_jerk = float(value) if value is not None else None
+
     @property
     def reduced_acceleration(self) -> float:
         """Reduced accelerations used by Z probing and stall homing moves (in mm/s^2)"""

{dsf_python-3.6.0b2.post3 → dsf_python-3.6.0rc1.post1}/src/dsf/object_model/move/extruder.py

@@ -41,6 +41,8 @@ class Extruder(ModelObject):
         self._position = 0
         # Pressure advance
         self._pressure_advance = 0
+        # Motor jerk during the current print only (in mm/s)
+        self._printing_jerk = None
         # Raw extruder position as commanded by the slicer without extrusion factor applied (in mm)
         self._raw_position = 0
         # Maximum speed (in mm/s)
@@ -148,6 +150,15 @@ class Extruder(ModelObject):
     def pressure_advance(self, value):
         self._pressure_advance = float(value)
 
+    @property
+    def printing_jerk(self) -> Union[float, None]:
+        """Motor jerk during the current print only (in mm/s)"""
+        return self._printing_jerk
+
+    @printing_jerk.setter
+    def printing_jerk(self, value):
+        self._printing_jerk = float(value) if value is not None else None
+
     @property
     def raw_position(self) -> float:
         """Raw extruder position as commanded by the slicer without extrusion factor applied (in mm)"""

{dsf_python-3.6.0b2.post3 → dsf_python-3.6.0rc1.post1}/src/dsf/object_model/move/input_shaping.py

@@ -40,13 +40,10 @@ class InputShaping(ModelObject):
         self._amplitudes = []
         # Damping factor
         self._damping = 0.1
-        # Input shaper durations (in s)
-        self._durations = []
+        # Input shaper delays (in s)
+        self._delays = []
         # Frequency (in Hz)
         self._frequency = 40
-        # Minimum fraction of the original acceleration or feed rate to which the acceleration or
-        # feed rate may be reduced in order to apply input shaping
-        self._reduction_limit = 0.25
         # Configured input shaping type
         self._type = InputShapingType.none
 
@@ -65,9 +62,9 @@ class InputShaping(ModelObject):
         self._damping = float(value)
 
     @property
-    def durations(self) -> List[float]:
-        """Input shaper durations (in s)"""
-        return self._durations
+    def delays(self) -> List[float]:
+        """Input shaper delays (in s)"""
+        return self._delays
 
     @property
     def frequency(self) -> float:
@@ -78,16 +75,6 @@ class InputShaping(ModelObject):
     def frequency(self, value):
         self._frequency = float(value)
 
-    @property
-    def reduction_limit(self) -> float:
-        """Minimum fraction of the original acceleration or feed rate to which the acceleration or
-        feed rate may be reduced in order to apply input shaping"""
-        return self._reduction_limit
-
-    @reduction_limit.setter
-    def reduction_limit(self, value):
-        self._reduction_limit = float(value)
-
     @property
     def type(self) -> InputShapingType:
         """Configured input shaping type"""

{dsf_python-3.6.0b2.post3 → dsf_python-3.6.0rc1.post1}/src/dsf/object_model/network/network_interface.py

@@ -4,6 +4,7 @@ from .network_interface_type import NetworkInterfaceType
 from .network_protocol import NetworkProtocol
 from .network_state import NetworkState
 from ..model_object import ModelObject
+from ...utils import deprecated
 
 
 class NetworkInterface(ModelObject):
@@ -27,6 +28,8 @@ class NetworkInterface(ModelObject):
         self._mac = ""
         # Number of reconnect attempts or null if unknown
         self._num_reconnects = None
+        # Received signal strength indicator of the WiFi adapter (only WiFi, in dBm, or null if unknown)
+        self._rssi = None
         # Signal of the Wi-Fi adapter (only Wi-Fi, in dBm, or null if unknown)
         self._signal = None
         # Speed of the network interface (in MBit, null if unknown, 0 if not connected)
@@ -112,10 +115,20 @@ class NetworkInterface(ModelObject):
         self._num_reconnects = int(value) if value is not None else None
         
     @property
+    def rssi(self) -> Union[int, None]:
+        """Received signal strength indicator of the WiFi adapter (only WiFi, in dBm, or None if unknown)"""
+        return self._rssi
+
+    @rssi.setter
+    def rssi(self, value):
+        self._rssi = int(value) if value is not None else None
+
+    @property
+    @deprecated(f"Use '{__name__}.rssi' instead.")
     def signal(self) -> Union[int, None]:
         """Signal of the Wi-Fi adapter (only Wi-Fi, in dBm, or null if unknown)"""
         return self._signal
-    
+
     @signal.setter
     def signal(self, value):
         self._signal = int(value) if value is not None else None

{dsf_python-3.6.0b2.post3 → dsf_python-3.6.0rc1.post1}/src/dsf/object_model/sensors/analog_sensor.py

@@ -12,7 +12,9 @@ class AnalogSensor(ModelObject):
         super(AnalogSensor, self).__init__()
         self._beta = None
         self._c = None
+        self._high_reading = None
         self._last_reading = None
+        self._low_reading = None
         self._name = None
         self._offset_adj = 0.0
         self._port = None
@@ -40,6 +42,15 @@ class AnalogSensor(ModelObject):
     def c(self, value):
         self._c = float(value) if value is not None else None
 
+    @property
+    def high_reading(self) -> Union[float, None]:
+        """High sensor reading (only linear analog sensors, otherwise null)"""
+        return self._high_reading
+
+    @high_reading.setter
+    def high_reading(self, value):
+        self._high_reading = float(value) if value is not None else None
+
     @property
     def last_reading(self) -> Union[float, None]:
         """Last sensor reading (in C) or null if invalid"""
@@ -48,6 +59,15 @@ class AnalogSensor(ModelObject):
     @last_reading.setter
     def last_reading(self, value):
         self._last_reading = float(value) if value is not None else None
+
+    @property
+    def low_reading(self) -> Union[float, None]:
+        """Low sensor reading (only linear analog sensors, otherwise null)"""
+        return self._low_reading
+
+    @low_reading.setter
+    def low_reading(self, value):
+        self._low_reading = float(value) if value is not None else None
         
     @property
     def name(self) -> Union[str, None]:

{dsf_python-3.6.0b2.post3 → dsf_python-3.6.0rc1.post1}/src/dsf/object_model/sensors/filament_monitors/Duet3DFilamentMonitor.py

@@ -17,6 +17,8 @@ class Duet3DFilamentMonitor(FilamentMonitor):
         self._max_percentage = None
         # Minimum ratio of measured vs. commanded movement
         self._min_percentage = None
+        # Position of the sensor (in mm)
+        self._position = 0
         # Total extrusion commanded (in mm)
         self._total_extrusion = 0
         
@@ -55,6 +57,15 @@ class Duet3DFilamentMonitor(FilamentMonitor):
     @min_percentage.setter
     def min_percentage(self, value):
         self._min_percentage = None if value is None else int(value)
+
+    @property
+    def position(self) -> float:
+        """Position of the sensor (in mm)"""
+        return self._position
+
+    @position.setter
+    def position(self, value):
+        self._position = float(value)
     
     @property
     def total_extrusion(self) -> float:

{dsf_python-3.6.0b2.post3 → dsf_python-3.6.0rc1.post1}/src/dsf/object_model/sensors/filament_monitors/pulsed_filament_monitor.py

@@ -108,9 +108,19 @@ class PulsedFilamentMonitor(FilamentMonitor):
         super(PulsedFilamentMonitor, self).__init__()
         self._calibrated = None
         self._configured = PulsedFilamentMonitorConfigured()
+        self._position = None
         self._type = FilamentMonitorType.Pulsed
         
     @property
     def configured(self) -> PulsedFilamentMonitorConfigured:
         """Configured properties of this filament monitor"""
         return self._configured
+
+    @property
+    def position(self) -> float:
+        """Position of the sensor (in mm)"""
+        return self._position
+
+    @position.setter
+    def position(self, value):
+        self._position = float(value)

dsf_python-3.6.0rc1.post1/src/dsf/object_model/spindles/spindle_type.py

@@ -0,0 +1,14 @@
+from enum import Enum
+
+
+class SpindleType(str, Enum):
+    """Possible types of spindles"""
+
+    # Spindle not configured
+    null = "null"
+
+    # Enable and direction
+    enaDir = "enaDir"
+
+    # Forward and reverse
+    fwdRev = "fwdRev"

{dsf_python-3.6.0b2.post3 → dsf_python-3.6.0rc1.post1}/src/dsf/object_model/spindles/spindles.py

@@ -1,4 +1,5 @@
 from .spindle_state import SpindleState
+from .spindle_type import SpindleType
 from ..model_object import ModelObject
 
 from typing import Union
@@ -29,6 +30,8 @@ class Spindle(ModelObject):
         self._min_pwm = 0
         # Current state
         self._state = SpindleState.unconfigured
+        # Spindle type
+        self._type = SpindleType.null
         
     @property
     def active(self) -> Union[int, None]:
@@ -126,3 +129,19 @@ class Spindle(ModelObject):
             self._state = value
         else:
             raise TypeError(f"{__name__}.state must be of type SpindleState. Got {type(value)}: {value}")
+
+    @property
+    def type(self) -> SpindleType:
+        """Spindle type"""
+        return self._type
+
+    @type.setter
+    def type(self, value):
+        if value is None or value == "":
+            self._type = SpindleType.null
+        elif isinstance(value, str):
+            self._type = SpindleType(value)
+        elif isinstance(value, SpindleType):
+            self._type = value
+        else:
+            raise TypeError(f"{__name__}.type must be of type SpindleType. Got {type(value)}: {value}")

{dsf_python-3.6.0b2.post3 → dsf_python-3.6.0rc1.post1}/src/dsf/object_model/tools/tools.py

@@ -3,6 +3,7 @@ from typing import List
 from .tool_state import ToolState
 from .tool_retraction import ToolRetraction
 from ..model_object import ModelObject
+from ...utils import deprecated
 
 
 class Tool(ModelObject):
@@ -20,6 +21,9 @@ class Tool(ModelObject):
         self._fans = []
         # Feedforward coefficients to apply to the mapped heaters during extrusions
         self._feed_forward = []
+        self._feed_forward_pwm = []
+        self._feed_forward_advance = None
+        self._feed_forward_temp = []
         # Extruder drive index for resolving the tool filament (index or -1)
         self._filament_extruder = -1
         # List of associated heaters (indices)
@@ -74,10 +78,30 @@ class Tool(ModelObject):
         return self._fans
     
     @property
+    @deprecated("Use feed_forward_pwm instead.")
     def feed_forward(self) -> List[float]:
         """Feedforward coefficients to apply to the mapped heaters during extrusions"""
         return self._feed_forward
     
+    @property
+    def feed_forward_advance(self) -> float:
+        """Time advance for applying feedforward in milliseconds"""
+        return self._feed_forward_advance
+
+    @feed_forward_advance.setter
+    def feed_forward_advance(self, value):
+        self._feed_forward_advance = float(value)
+
+    @property
+    def feed_forward_pwm(self) -> List[float]:
+        """Feedforward coefficients to apply to the mapped heaters during extrusions"""
+        return self._feed_forward_pwm
+
+    @property
+    def feed_forward_temp(self) -> List[float]:
+        """Temperature increase per mm/dec extrusion speed"""
+        return self._feed_forward_temp
+
     @property
     def filament_extruder(self) -> int:
         """Extruder drive index for resolving the tool filament (index or -1)"""

{dsf_python-3.6.0b2.post3 → dsf_python-3.6.0rc1.post1}/src/dsf/object_model/utils.py

@@ -1,3 +1,5 @@
+from typing import Type, TypeVar, Any, Union, Dict
+
 
 def is_model_object(o):
     from .model_object import ModelObject
@@ -7,7 +9,10 @@ def is_model_object(o):
     return isinstance(o, ModelObject) or isinstance(o, ModelCollection) or isinstance(o, ModelDictionary)
 
 
-def wrap_model_property(name, model_type):
+T = TypeVar('T')  # Type variable for model objects
+
+
+def wrap_model_property(name: str, model_type: Type[T]) -> Union[Type[T], None]:
     """
     Wrap a nullable model object property so that type checks can be performed during update
     :param name: Property of the derived class
@@ -18,11 +23,11 @@ def wrap_model_property(name, model_type):
     STORAGE_NAME = '_' + name
 
     @property
-    def prop(self):
+    def prop(self) -> Union[Type[T], None]:
         return getattr(self, STORAGE_NAME)
 
     @prop.setter
-    def prop(self, value):
+    def prop(self, value: Union[Type[T], str, Dict[str, Any], None]):
         if value is None or isinstance(value, model_type):
             setattr(self, STORAGE_NAME, value)
         elif isinstance(value, dict):  # Update from JSON

{dsf_python-3.6.0b2.post3 → dsf_python-3.6.0rc1.post1}/src/dsf_python.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: dsf-python
-Version: 3.6.0b2.post3
+Version: 3.6.0rc1.post1
 Summary: Python interface to access DuetSoftwareFramework
 Home-page: https://github.com/Duet3D/dsf-python
 Author: Duet3D Ltd.
@@ -29,6 +29,19 @@ Requires-Dist: python-dateutil
 Provides-Extra: dev
 Requires-Dist: sphinx; extra == "dev"
 Requires-Dist: tox; extra == "dev"
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: license-file
+Dynamic: project-url
+Dynamic: provides-extra
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
 
 # Duet Software Framework Python Bindings
 

{dsf_python-3.6.0b2.post3 → dsf_python-3.6.0rc1.post1}/src/dsf_python.egg-info/SOURCES.txt

@@ -160,6 +160,7 @@ src/dsf/object_model/sensors/filament_monitors/pulsed_filament_monitor.py
 src/dsf/object_model/sensors/filament_monitors/rotating_magnet_filament_monitor.py
 src/dsf/object_model/spindles/__init__.py
 src/dsf/object_model/spindles/spindle_state.py
+src/dsf/object_model/spindles/spindle_type.py
 src/dsf/object_model/spindles/spindles.py
 src/dsf/object_model/state/__init__.py
 src/dsf/object_model/state/beep_request.py