dsf-python 3.5.0.2rc2__tar.gz → 3.5.1rc1__tar.gz

{dsf-python-3.5.0.2rc2/src/dsf_python.egg-info → dsf_python-3.5.1rc1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: dsf-python
-Version: 3.5.0.2rc2
+Version: 3.5.1rc1
 Summary: Python interface to access DuetSoftwareFramework
 Home-page: https://github.com/Duet3D/dsf-python
 Author: Duet3D Ltd.

{dsf-python-3.5.0.2rc2 → dsf_python-3.5.1rc1}/setup.py

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

{dsf-python-3.5.0.2rc2 → dsf_python-3.5.1rc1}/src/dsf/connections/init_messages/client_init_messages.py

@@ -41,7 +41,8 @@ def intercept_init_message(
         channels: List[CodeChannel],
         filters: List[str],
         priority_codes: bool,
-        auto_flush: bool = True):
+        auto_flush: bool = True,
+        auto_evaluate_expression: bool = True):
     """
     Enter interception mode
     Whenever a code is received, the connection must respond with one of
@@ -62,6 +63,9 @@ def intercept_init_message(
     is specified.
     This option makes extra Flush calls in the interceptor implementation obsolete.
     It is highly recommended to enable this in order to avoid potential deadlocks when dealing with macros!
+    :param auto_evaluate_expression: Automatically evaluate expression parameters to their final values
+    before sending it over to the client.
+    This requires auto_flush to be True and happens when the remaining codes have been processed.
     """
     return ClientInitMessage(
         ConnectionMode.INTERCEPT,
@@ -69,6 +73,7 @@ def intercept_init_message(
             "InterceptionMode": intercept_mode,
             "Channels": channels,
             "AutoFlush": auto_flush,
+            "AutoEvaluateExpressions": auto_evaluate_expression,
             "Filters": filters,
             "PriorityCodes": priority_codes,
         },

{dsf-python-3.5.0.2rc2 → dsf_python-3.5.1rc1}/src/dsf/connections/intercept_connection.py

@@ -21,6 +21,9 @@ class InterceptConnection(BaseCommandConnection):
     in case a code filter is specified.
     This option makes extra Flush calls in the interceptor implementation obsolete.
     It is highly recommended to enable this in order to avoid potential deadlocks when dealing with macros!
+    :param auto_evaluate_expression: Automatically evaluate expression parameters to their final values
+    before sending it over to the client.
+    This requires auto_flush to be True and happens when the remaining codes have been processed.
     :param priority_codes: Defines if priority codes may be intercepted (e.g. M122 or M999)
     :param debug: Whether debugging output is turned on for this connection
     """
@@ -31,6 +34,7 @@ class InterceptConnection(BaseCommandConnection):
         channels: List[CodeChannel] = None,
         filters: List[str] = None,
         auto_flush: bool = True,
+        auto_evaluate_expression: bool = True,
         priority_codes: bool = False,
         debug: bool = False,
     ):
@@ -39,12 +43,18 @@ class InterceptConnection(BaseCommandConnection):
         self.channels = channels if channels is not None else CodeChannel.list()
         self.filters = filters
         self.auto_flush = auto_flush
+        self.auto_evaluate_expression = auto_evaluate_expression
         self.priority_codes = priority_codes
 
     def connect(self, socket_file: str = SOCKET_FILE):  # noqa
         """Establishes a connection to the given UNIX socket file"""
         iim = client_init_messages.intercept_init_message(
-            self.interception_mode, self.channels, self.filters, self.priority_codes, self.auto_flush
+            self.interception_mode,
+            self.channels,
+            self.filters,
+            self.priority_codes,
+            self.auto_flush,
+            self.auto_evaluate_expression
         )
         return super().connect(iim, socket_file)
 

{dsf-python-3.5.0.2rc2 → dsf_python-3.5.1rc1}/src/dsf/object_model/boards/accelerometer.py

@@ -5,11 +5,24 @@ class Accelerometer(ModelObject):
     """This represents an accelerometer"""
     def __init__(self):
         super(Accelerometer, self).__init__()
+        # Orientation of the accelerometer
+        # See https://docs.duet3d.com/en/Duet3D_hardware/Accessories/Duet3D_Accelerometer#orientation for a list of orientations
+        self._orientation = 20
         # Number of collected data points in the last run or 0 if it failed
         self._points = 0
         # Number of completed sampling runs
         self._runs = 0
 
+    @property
+    def orientation(self) -> int:
+        """Orientation of the accelerometer
+        See https://docs.duet3d.com/en/Duet3D_hardware/Accessories/Duet3D_Accelerometer#orientation for a list of orientations"""
+        return self._orientation
+
+    @orientation.setter
+    def orientation(self, value):
+        self._orientation = int(value)
+
     @property
     def points(self) -> int:
         """Number of collected data points in the last run or 0 if it failed"""

{dsf-python-3.5.0.2rc2 → dsf_python-3.5.1rc1}/src/dsf/object_model/boards/boards.py

@@ -1,10 +1,11 @@
 from enum import Enum
-from typing import List, Union
+from typing import List, Optional
 
 from .accelerometer import Accelerometer
 from .board_closed_loop import BoardClosedLoop
 from .direct_display import DirectDisplay
 from .driver import Driver
+from .inductive_sensor import InductiveSensor
 from .min_max_current import MinMaxCurrent
 from ..model_collection import ModelCollection
 from ..model_object import ModelObject
@@ -42,6 +43,8 @@ class Board(ModelObject):
     closed_loop = wrap_model_property('closed_loop', BoardClosedLoop)
     # Details about a connected display or None if none is connected
     direct_display = wrap_model_property('direct_display', DirectDisplay)
+    # Information about an inductive sensor or None if not present
+    inductive_sensor = wrap_model_property('inductive_sensor', InductiveSensor)
     # Minimum, maximum, and current temperatures of the MCU or None if unknown
     mcu_temp = wrap_model_property('mcu_temp', MinMaxCurrent)
     # Minimum, maximum, and current voltages on the 12V rail or None if unknown
@@ -72,11 +75,15 @@ class Board(ModelObject):
         self._firmware_name = ""
         # Version of the firmware build
         self._firmware_version = ""
+        # Amount of free RAM on this board (in bytes or null if unknown)
+        self._free_ram = None
         # Filename of the IAP binary that is used for updates from the SBC or None if unsupported
         self._iap_file_name_SBC = None
         # Filename of the IAP binary that is used for updates from the SD card or None if unsupported
         # This is only available for the mainboard (first board item)
         self._iap_file_name_SD = None
+        # Information about an inductive sensor or None if not present
+        self._inductive_sensor = None
         # Maximum number of heaters this board can control
         self._max_heaters = 0
         # Maximum number of motors this board can drive
@@ -104,7 +111,7 @@ class Board(ModelObject):
         self._wifi_firmware_file_name = None
 
     @property
-    def bootloader_file_name(self) -> Union[str, None]:
+    def bootloader_file_name(self) -> Optional[str]:
         """Filename of the bootloader binary or None if unknown"""
         return self._bootloader_file_name
 
@@ -113,7 +120,7 @@ class Board(ModelObject):
         self._bootloader_file_name = str(value) if value is not None else None
 
     @property
-    def can_address(self) -> Union[int, None]:
+    def can_address(self) -> Optional[int]:
         """CAN address of this board or None if not applicable"""
         return self._can_address
 
@@ -122,7 +129,7 @@ class Board(ModelObject):
         self._can_address = int(value) if value is not None else None
 
     @property
-    def drivers(self) -> Union[List[Driver], None]:
+    def drivers(self) -> Optional[List[Driver]]:
         """Drivers of this board"""
         return self._drivers
 
@@ -167,7 +174,16 @@ class Board(ModelObject):
         self._firmware_version = str(value)
 
     @property
-    def iap_file_name_SBC(self) -> Union[str, None]:
+    def free_ram(self) -> Optional[int]:
+        """Amount of free RAM on this board (in bytes or null if unknown)"""
+        return self._free_ram
+
+    @free_ram.setter
+    def free_ram(self, value):
+        self._free_ram = None if value is None else int(value)
+
+    @property
+    def iap_file_name_SBC(self) -> Optional[str]:
         """Filename of the IAP binary that is used for updates from the SBC or None if unsupported"""
         return self._iap_file_name_SBC
 
@@ -176,7 +192,7 @@ class Board(ModelObject):
         self._iap_file_name_SBC = str(value) if value is not None else None
 
     @property
-    def iap_file_name_SD(self) -> Union[str, None]:
+    def iap_file_name_SD(self) -> Optional[str]:
         """Filename of the IAP binary that is used for updates from the SD card or None if unsupported
         This is only available for the mainboard (first board item)"""
         return self._iap_file_name_SD
@@ -256,7 +272,7 @@ class Board(ModelObject):
         self._supports_direct_display = bool(value)
 
     @property
-    def unique_id(self) -> Union[str, None]:
+    def unique_id(self) -> Optional[str]:
         """Unique identifier of the board or None if unknown"""
         return self._unique_id
 

dsf_python-3.5.1rc1/src/dsf/object_model/boards/inductive_sensor.py

@@ -0,0 +1,9 @@
+from ..model_object import ModelObject
+
+
+class InductiveSensor(ModelObject):
+    """"""
+
+    def __init__(self):
+        super(InductiveSensor, self).__init__()
+        # still empty

{dsf-python-3.5.0.2rc2 → dsf_python-3.5.1rc1}/src/dsf/object_model/fans/fans.py

@@ -23,6 +23,8 @@ class Fan(ModelObject):
         self._requested_value = 0
         # Current RPM of this fan or -1 if unknown/unset
         self._rpm = -1
+        # Pulses per tacho revolution
+        self._tacho_ppr = 2.0
         # Thermostatic control parameters
         self._thermostatic = FanThermostaticControl()
 
@@ -99,6 +101,15 @@ class Fan(ModelObject):
     def rpm(self, value):
         self._rpm = int(value)
 
+    @property
+    def tacho_ppr(self) -> float:
+        """Pulses per tacho revolution"""
+        return self._tacho_ppr
+
+    @tacho_ppr.setter
+    def tacho_ppr(self, value):
+        self._tacho_ppr = float(value)
+
     @property
     def thermostatic(self) -> FanThermostaticControl:
         """Thermostatic control parameters"""

{dsf-python-3.5.0.2rc2 → dsf_python-3.5.1rc1}/src/dsf/object_model/move/axis.py

@@ -26,6 +26,26 @@ class AxisLetter(str, Enum):
     d = 'd'
     e = 'e'
     f = 'f'
+    g = 'g'
+    h = 'h'
+    i = 'i'
+    j = 'j'
+    k = 'k'
+    l = 'l'
+    m = 'm'
+    n = 'n'
+    o = 'o'
+    p = 'p'
+    q = 'q'
+    r = 'r'
+    s = 's'
+    t = 't'
+    u = 'u'
+    v = 'v'
+    w = 'w'
+    x = 'x'
+    y = 'y'
+    z = 'z'
     none = ''
 
 

{dsf-python-3.5.0.2rc2 → dsf_python-3.5.1rc1}/src/dsf/object_model/move/move_segmentation.py

@@ -5,17 +5,17 @@ class MoveSegmentation(ModelObject):
     """Move segmentation parameters"""
     def __init__(self):
         super().__init__()
-        self._segments_per_sec = 0
-        self._min_segment_length = 0
+        self._segments_per_sec = 0.0
+        self._min_segment_length = 0.0
         
     @property
-    def segments_per_sec(self) -> int:
+    def segments_per_sec(self) -> float:
         """Number of segments per second"""
         return self._segments_per_sec
     
     @segments_per_sec.setter
     def segments_per_sec(self, value):
-        self._segments_per_sec = int(value)
+        self._segments_per_sec = float(value)
         
     @property
     def min_segment_length(self) -> float:

{dsf-python-3.5.0.2rc2 → dsf_python-3.5.1rc1}/src/dsf/object_model/plugins/plugin_manifest.py

@@ -20,6 +20,7 @@ class PluginManifest(ModelObject):
         self._name = None
         self._rrf_version = None
         self._sbc_auto_restart = False
+        self._sbc_config_files = []
         self._sbc_dsf_version = None
         self._sbc_executable = None
         self._sbc_executable_arguments = []
@@ -137,6 +138,13 @@ class PluginManifest(ModelObject):
     @sbc_auto_restart.setter
     def sbc_auto_restart(self, value):
         self._sbc_auto_restart = bool(value)
+        
+    @property
+    def sbc_config_files(self) -> List[str]:
+        """List of files in the sys or virtual SD directory that should not be overwritten on upgrade
+        The file may be specified either relative to 0:/sys directory (e.g. motion.conf) or relative to the
+        virtual SD directory (e.g. sys/motion.conf). Drive indices as in 0:/sys/motion.conf are not allowed!"""
+        return self._sbc_config_files
 
     @property
     def sbc_dsf_version(self) -> str:

{dsf-python-3.5.0.2rc2 → dsf_python-3.5.1rc1}/src/dsf/object_model/sbc/dsf/dsf.py

@@ -13,6 +13,7 @@ class DSF(ModelObject):
         super().__init__()
         self._build_date_time = ""
         self._http_endpoints = ModelCollection(HttpEndpoint)
+        self._is64bit = False
         self._plugin_support = False
         self._root_plugin_support = False
         self._user_sessions = ModelCollection(UserSession)
@@ -27,6 +28,15 @@ class DSF(ModelObject):
     def build_date_time(self, value):
         self._build_date_time = str(value)
 
+    @property
+    def is64bit(self) -> bool:
+        """Indicates if the process is 64-bit"""
+        return self._is64bit
+
+    @is64bit.setter
+    def is64bit(self, value):
+        self._is64bit = bool(value)
+
     @property
     def http_endpoints(self) -> List[HttpEndpoint]:
         """List of registered third-party HTTP endpoints"""

{dsf-python-3.5.0.2rc2 → dsf_python-3.5.1rc1}/src/dsf/object_model/sensors/analog_sensor.py

@@ -14,9 +14,11 @@ class AnalogSensor(ModelObject):
         self._c = None
         self._last_reading = None
         self._name = None
+        self._offset_adj = 0.0
         self._port = None
         self._r_25 = None
         self._r_ref = None
+        self._slope_adj = 0.0
         self._state = TemperatureError.ok
         self._type = AnalogSensorType.Unknown
 
@@ -55,6 +57,16 @@ class AnalogSensor(ModelObject):
     @name.setter
     def name(self, value):
         self._name = str(value) if value is not None else None
+        
+    @property
+    def offset_adj(self) -> float:
+        """Offset adjustment (in K)
+        See also M308 U"""
+        return self._offset_adj
+    
+    @offset_adj.setter
+    def offset_adj(self, value):
+        self._offset_adj = float(value)
 
     @property
     def port(self) -> Union[str, None]:
@@ -83,6 +95,16 @@ class AnalogSensor(ModelObject):
     def r_ref(self, value):
         self._r_ref = float(value) if value is not None else None
 
+    @property
+    def slope_adj(self) -> float:
+        """Slope adjustment factor
+        See also M308 V"""
+        return self._slope_adj
+
+    @slope_adj.setter
+    def slope_adj(self, value):
+        self._slope_adj = float(value)
+
     @property
     def state(self) -> TemperatureError:
         """State of this sensor"""

{dsf-python-3.5.0.2rc2 → dsf_python-3.5.1rc1}/src/dsf/object_model/sensors/probe.py

@@ -1,4 +1,4 @@
-from typing import List, Union
+from typing import List, Optional
 
 from .probe_type import ProbeType
 from ..model_object import ModelObject
@@ -20,6 +20,7 @@ class Probe(ModelObject):
         self._is_calibrated = None
         self._last_stop_height = 0
         self._max_probe_count = 1
+        self._measured_height = None
         self._offsets = [0, 0]
         self._recovery_time = 0
         self._scan_coefficients = None
@@ -33,7 +34,7 @@ class Probe(ModelObject):
         self._value = []
 
     @property
-    def calib_a(self) -> Union[float, None]:
+    def calib_a(self) -> Optional[float]:
         """Linear coefficient for scanning probes"""
         return self._calib_a
 
@@ -42,7 +43,7 @@ class Probe(ModelObject):
         self._calib_a = float(value) if value is not None else None
 
     @property
-    def calib_b(self) -> Union[float, None]:
+    def calib_b(self) -> Optional[float]:
         """Quadratic coefficient for scanning probes"""
         return self._calib_b
 
@@ -97,7 +98,7 @@ class Probe(ModelObject):
         return self._dive_heights
 
     @property
-    def is_calibrated(self) -> Union[bool, None]:
+    def is_calibrated(self) -> Optional[bool]:
         """Indicates if the scanning probe is calibrated"""
         return self._is_calibrated
 
@@ -123,6 +124,15 @@ class Probe(ModelObject):
     def max_probe_count(self, value):
         self._max_probe_count = int(value)
         
+    @property
+    def measured_height(self) -> Optional[float]:
+        """Measured height (only applicable for scanning probes, in mm or null)"""
+        return self._measured_height
+    
+    @measured_height.setter
+    def measured_height(self, value):
+        self._measured_height = None if value is None else float(value)
+        
     @property
     def offsets(self) -> List[float]:
         """X+Y offsets (in mm)"""
@@ -144,7 +154,7 @@ class Probe(ModelObject):
         return self._speeds[0]
 
     @property
-    def scan_coefficients(self) -> Union[List[float], None]:
+    def scan_coefficients(self) -> Optional[List[float]]:
         """Coefficients for the scanning Z-probe (4 elements, if applicable)"""
         return self._scan_coefficients
 
@@ -154,7 +164,8 @@ class Probe(ModelObject):
         
     @property
     def speeds(self) -> List[float]:
-        """Fast and slow probing speeds (in mm/s)"""
+        """Fast and slow probing speeds (in mm/s)
+        Scanning probes may have three speeds where the last one is the movement speed while probing heightmaps"""
         return self._speeds
     
     @speeds.setter

{dsf-python-3.5.0.2rc2 → dsf_python-3.5.1rc1/src/dsf_python.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: dsf-python
-Version: 3.5.0.2rc2
+Version: 3.5.1rc1
 Summary: Python interface to access DuetSoftwareFramework
 Home-page: https://github.com/Duet3D/dsf-python
 Author: Duet3D Ltd.

{dsf-python-3.5.0.2rc2 → dsf_python-3.5.1rc1}/src/dsf_python.egg-info/SOURCES.txt

@@ -48,6 +48,7 @@ src/dsf/object_model/boards/board_closed_loop.py
 src/dsf/object_model/boards/boards.py
 src/dsf/object_model/boards/driver.py
 src/dsf/object_model/boards/driver_closed_loop.py
+src/dsf/object_model/boards/inductive_sensor.py
 src/dsf/object_model/boards/min_max_current.py
 src/dsf/object_model/boards/direct_display/__init__.py
 src/dsf/object_model/boards/direct_display/direct_display.py