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

{dsf-python-3.5.0.1rc2/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.1rc2
+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.1rc2 → 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.1rc2",
+    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.1rc2 → dsf_python-3.5.1rc1}/src/dsf/commands/code_interception.py

@@ -1,4 +1,4 @@
-from __future__ import annotations
+from typing import Optional
 
 from .base_command import BaseCommand
 from ..object_model.messages import MessageType
@@ -17,7 +17,7 @@ def ignore():
     return BaseCommand("Ignore")
 
 
-def resolve_code(rtype: MessageType, content: str | None = None):
+def resolve_code(rtype: MessageType, content: Optional[str]):
     """
     Resolve the code to intercept and return the given message details for its completion.
     This command is only permitted in ConnectionMode.Intercept mode.

{dsf-python-3.5.0.1rc2 → dsf_python-3.5.1rc1}/src/dsf/commands/code_parameter.py

@@ -1,7 +1,6 @@
 """
 codeparameter contains all classes and methods dealing with deserialized code parameters.
 """
-from __future__ import annotations
 import json
 
 from ..exceptions import CodeParserException

{dsf-python-3.5.0.1rc2 → dsf_python-3.5.1rc1}/src/dsf/commands/generic.py

@@ -1,4 +1,4 @@
-from __future__ import annotations
+from typing import Optional
 
 from .base_command import BaseCommand
 from .code_channel import CodeChannel
@@ -108,7 +108,7 @@ def write_message(
     message_type: MessageType,
     content: str,
     output_message: bool = True,
-    log_level: LogLevel | None = None,
+    log_level: Optional[LogLevel] = None,
 ):
     """
     Write an arbitrary generic message

{dsf-python-3.5.0.1rc2 → dsf_python-3.5.1rc1}/src/dsf/connections/base_connection.py

@@ -1,9 +1,8 @@
-from __future__ import annotations
 import json
 import socket
+from typing import Optional
 
-from .exceptions import (IncompatibleVersionException, InternalServerException, IPCSocketBrokenException,
-                         TaskCanceledException)
+from .exceptions import IncompatibleVersionException, InternalServerException, TaskCanceledException
 from .init_messages import client_init_messages, server_init_message
 from ..commands import responses
 
@@ -12,16 +11,12 @@ class BaseConnection:
     """
     Base class for connections that access the control server via the Duet API
     using a UNIX socket
-
-    Constructor arguments:
-    :param debug: Whether to print debug information or not
-    :param timeout: Set a timeout value on blocking socket operations or None to set the socket in non-blocking mode
     """
 
-    def __init__(self, debug: bool = False, timeout: int = None):
+    def __init__(self, debug: bool = False, timeout: int = 3):
         self.debug = debug
         self.timeout = timeout
-        self.socket: socket.socket | None = None
+        self.socket: Optional[socket.socket] = None
         self.id = None
         self.input = ""
 
@@ -30,7 +25,7 @@ class BaseConnection:
 
         self.socket = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM)
         self.socket.connect(socket_file)
-        self.socket.settimeout(self.timeout)
+        self.socket.setblocking(True)
         server_init_msg = server_init_message.ServerInitMessage.from_json(
             json.loads(self.socket.recv(50).decode("utf8"))
         )

{dsf-python-3.5.0.1rc2 → dsf_python-3.5.1rc1}/src/dsf/connections/exceptions.py

@@ -14,10 +14,3 @@ class InternalServerException(Exception):
 
 class TaskCanceledException(Exception):
     """Exception returned by the server if the task has been cancelled remotely"""
-
-
-class IPCSocketBrokenException(Exception):
-    """Exception raised if the IPC connection has been closed on the remote server"""
-
-    def __init__(self):
-        super().__init__("IPC socket connection broken")

{dsf-python-3.5.0.1rc2 → 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.1rc2 → 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)
 
@@ -60,7 +70,7 @@ class InterceptConnection(BaseCommandConnection):
         """Instruct the control server to ignore the last received code (in intercepting mode)"""
         self.send(commands.code_interception.ignore())
 
-    def resolve_code(self, rtype: MessageType = MessageType.Success, content: str | None = None):
+    def resolve_code(self, rtype: MessageType = MessageType.Success, content: Optional[str] = None):
         """
         Instruct the control server to resolve the last received code with the given
         message details (in intercepting mode)

{dsf-python-3.5.0.1rc2 → 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.1rc2 → dsf_python-3.5.1rc1}/src/dsf/object_model/boards/boards.py

@@ -1,11 +1,11 @@
-from __future__ import annotations
 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
@@ -43,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
@@ -73,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
@@ -105,25 +111,25 @@ 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
 
     @bootloader_file_name.setter
-    def bootloader_file_name(self, value: str | None = None):
+    def bootloader_file_name(self, value):
         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
 
     @can_address.setter
-    def can_address(self, value: int | None = None):
+    def can_address(self, value):
         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
 
@@ -168,22 +174,31 @@ 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
 
     @iap_file_name_SBC.setter
-    def iap_file_name_SBC(self, value: str | None = None):
+    def iap_file_name_SBC(self, value):
         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
 
     @iap_file_name_SD.setter
-    def iap_file_name_SD(self, value: str | None = None):
+    def iap_file_name_SD(self, value):
         self._iap_file_name_SD = str(value) if value is not None else None
 
     @property
@@ -228,14 +243,13 @@ class Board(ModelObject):
         return self._state
 
     @state.setter
-    def state(self, value: BoardState):
-        if isinstance(value, BoardState):
+    def state(self, value):
+        if value is None or isinstance(value, BoardState):
             self._state = value
         elif isinstance(value, str):
             self._state = BoardState(value)
         else:
-            raise TypeError(f"{__name__}.state must be of type BoardState."
-                            f" Got {type(value)}: {value}")
+            raise TypeError(f"{__name__}.state must be of type BoardState or None. Got {type(value)}: {value}")
 
     @property
     @deprecated(f"Use {__name__}.supports_direct_display instead")
@@ -245,7 +259,7 @@ class Board(ModelObject):
         return self._supports_12864
 
     @supports_12864.setter
-    def supports_12864(self, value: bool):
+    def supports_12864(self, value):
         self._supports_12864 = bool(value)
 
     @property
@@ -254,16 +268,16 @@ class Board(ModelObject):
         return self._supports_direct_display
 
     @supports_direct_display.setter
-    def supports_direct_display(self, value: bool):
+    def supports_direct_display(self, value):
         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
 
     @unique_id.setter
-    def unique_id(self, value: str | None = None):
+    def unique_id(self, value):
         self._unique_id = str(value) if value is not None else None
 
     @property

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.1rc2 → dsf_python-3.5.1rc1}/src/dsf/object_model/directories/directories.py

@@ -27,7 +27,7 @@ class Directories(ModelObject):
         return self._filaments
 
     @filaments.setter
-    def filaments(self, value: str):
+    def filaments(self, value):
         self._filaments = str(value)
 
     @property
@@ -36,7 +36,7 @@ class Directories(ModelObject):
         return self._firmware
 
     @firmware.setter
-    def firmware(self, value: str):
+    def firmware(self, value):
         self._firmware = str(value)
 
     @property
@@ -45,7 +45,7 @@ class Directories(ModelObject):
         return self._g_codes
 
     @g_codes.setter
-    def g_codes(self, value: str):
+    def g_codes(self, value):
         self._g_codes = str(value)
 
     @property
@@ -54,7 +54,7 @@ class Directories(ModelObject):
         return self._macros
 
     @macros.setter
-    def macros(self, value: str):
+    def macros(self, value):
         self._macros = str(value)
 
     @property
@@ -64,7 +64,7 @@ class Directories(ModelObject):
         return self._menu
 
     @menu.setter
-    def menu(self, value: str):
+    def menu(self, value):
         self._menu = str(value)
 
     @property
@@ -73,7 +73,7 @@ class Directories(ModelObject):
         return self._system
 
     @system.setter
-    def system(self, value: str):
+    def system(self, value):
         self._system = str(value)
 
     @property
@@ -82,5 +82,5 @@ class Directories(ModelObject):
         return self._web
 
     @web.setter
-    def web(self, value: str):
+    def web(self, value):
         self._web = str(value)

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

@@ -1,4 +1,4 @@
-from __future__ import annotations
+from typing import List, Union
 from ..model_object import ModelObject
 from ...utils import deprecated
 
@@ -24,21 +24,21 @@ class FanThermostaticControl(ModelObject):
         return self._heaters
 
     @property
-    def high_temperature(self) -> float | None:
+    def high_temperature(self) -> Union[float, None]:
         """Upper temperature range required to turn on the fan (in C)"""
         return self._high_temperature
 
     @high_temperature.setter
-    def high_temperature(self, value: float | None = None):
+    def high_temperature(self, value):
         self._high_temperature = float(value) if value is not None else None
 
     @property
-    def low_temperature(self) -> float | None:
+    def low_temperature(self) -> Union[float, None]:
         """Lower temperature range required to turn on the fan (in C)"""
         return self._low_temperature
 
     @low_temperature.setter
-    def low_temperature(self, value: float | None = None):
+    def low_temperature(self, value):
         self._low_temperature = float(value) if value is not None else None
 
     @property

{dsf-python-3.5.0.1rc2 → 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()
 
@@ -78,7 +80,7 @@ class Fan(ModelObject):
         return self._name
 
     @name.setter
-    def name(self, value: str):
+    def name(self, value):
         self._name = str(value)
 
     @property
@@ -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.1rc2 → dsf_python-3.5.1rc1}/src/dsf/object_model/heat/heat.py

@@ -1,4 +1,4 @@
-from __future__ import annotations
+from typing import List
 
 from .heater import Heater
 from ..model_collection import ModelCollection
@@ -22,13 +22,13 @@ class Heat(ModelObject):
         self._heaters = ModelCollection(Heater)
 
     @property
-    def bed_heaters(self) -> list[int]:
+    def bed_heaters(self) -> List[int]:
         """List of configured bed heaters (indices)
         Items may be -1 if unconfigured"""
         return self._bed_heaters
 
     @property
-    def chamber_heaters(self) -> list[int]:
+    def chamber_heaters(self) -> List[int]:
         """List of configured chamber heaters (indices)
         Items may be -1 if unconfigured"""
         return self._chamber_heaters
@@ -52,6 +52,6 @@ class Heat(ModelObject):
         self._cold_retract_temperature = float(value)
 
     @property
-    def heaters(self) -> list[Heater]:
+    def heaters(self) -> List[Heater]:
         """List of configured heaters"""
         return self._heaters

{dsf-python-3.5.0.1rc2 → dsf_python-3.5.1rc1}/src/dsf/object_model/heat/heater.py

@@ -1,5 +1,5 @@
-from __future__ import annotations
 from enum import Enum
+from typing import List
 
 from .heater_model import HeaterModel
 from .heater_monitor import HeaterMonitor
@@ -142,7 +142,7 @@ class Heater(ModelObject):
         return self._model
 
     @property
-    def monitors(self) -> list[HeaterMonitor]:
+    def monitors(self) -> List[HeaterMonitor]:
         """Monitors of this heater"""
         return self._monitors
 

{dsf-python-3.5.0.1rc2 → dsf_python-3.5.1rc1}/src/dsf/object_model/heat/heater_model.py

@@ -1,5 +1,3 @@
-from __future__ import annotations
-
 from ..model_object import ModelObject
 from .heater_model_pid import HeaterModelPID
 
@@ -108,7 +106,7 @@ class HeaterModel(ModelObject):
         return self._pid
 
     @property
-    def standard_voltage(self) -> float | None:
+    def standard_voltage(self) -> float:
         """Standard voltage or null if unknown"""
         return self._standard_voltage
 

{dsf-python-3.5.0.1rc2 → dsf_python-3.5.1rc1}/src/dsf/object_model/heat/heater_model_pid.py

@@ -41,7 +41,7 @@ class HeaterModelPID(ModelObject):
         return self._overridden
 
     @overridden.setter
-    def overridden(self, value: bool):
+    def overridden(self, value):
         self._overridden = bool(value)
 
     @property
@@ -59,5 +59,5 @@ class HeaterModelPID(ModelObject):
         return self._used
 
     @used.setter
-    def used(self, value: bool):
+    def used(self, value):
         self._used = bool(value)

{dsf-python-3.5.0.1rc2 → dsf_python-3.5.1rc1}/src/dsf/object_model/heat/heater_monitor.py

@@ -1,4 +1,3 @@
-from __future__ import annotations
 from enum import Enum, IntEnum
 from typing import Union
 
@@ -61,7 +60,7 @@ class HeaterMonitor(ModelObject):
             self._action = HeaterMonitorAction(value)
         else:
             raise TypeError(f"{__name__}.action must be of type HeaterMonitorAction or None."
-                            f" Got {type(value)}: {value}")
+                            f"Got {type(value)}: {value}")
 
     @property
     def condition(self):
@@ -70,16 +69,16 @@ class HeaterMonitor(ModelObject):
 
     @condition.setter
     def condition(self, value: HeaterMonitorCondition = HeaterMonitorCondition.disabled):
-        if isinstance(value, HeaterMonitorCondition):
+        if value is None or isinstance(value, HeaterMonitorCondition):
             self._condition = value
         elif isinstance(value, str):
             self._condition = HeaterMonitorCondition(value)
         else:
             raise TypeError(f"{__name__}.condition must be of type HeaterMonitorCondition or None."
-                            f" Got {type(value)}: {value}")
+                            f"Got {type(value)}: {value}")
 
     @property
-    def limit(self) -> float | None:
+    def limit(self) -> float:
         """Limit threshold for this heater monitor"""
         return self._limit