dsf-python 3.4.6.post4__tar.gz → 3.5.0.1rc2__tar.gz

{dsf-python-3.4.6.post4/src/dsf_python.egg-info → dsf-python-3.5.0.1rc2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: dsf-python
-Version: 3.4.6.post4
+Version: 3.5.0.1rc2
 Summary: Python interface to access DuetSoftwareFramework
 Home-page: https://github.com/Duet3D/dsf-python
 Author: Duet3D Ltd.
@@ -17,6 +17,10 @@ Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.7
 Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
 Classifier: Programming Language :: Python :: 3 :: Only
 Requires-Python: >=3.7, <4
 Description-Content-Type: text/markdown

{dsf-python-3.4.6.post4 → dsf-python-3.5.0.1rc2}/setup.py

@@ -6,7 +6,7 @@ long_description = open("README.md", encoding="utf-8").read()
 
 setuptools.setup(
     name="dsf-python",
-    version="3.4.6-4",
+    version="3.5.0.1rc2",
     description="Python interface to access DuetSoftwareFramework",
     long_description=long_description,
     long_description_content_type="text/markdown",
@@ -22,6 +22,10 @@ setuptools.setup(
         "Programming Language :: Python :: 3.7",
         "Programming Language :: Python :: 3.8",
         "Programming Language :: Python :: 3.9",
+        "Programming Language :: Python :: 3.10",
+        "Programming Language :: Python :: 3.11",
+        "Programming Language :: Python :: 3.12",
+        "Programming Language :: Python :: 3.13",
         "Programming Language :: Python :: 3 :: Only",
     ],
     install_requires=[

{dsf-python-3.4.6.post4 → dsf-python-3.5.0.1rc2}/src/dsf/commands/code.py

@@ -1,4 +1,3 @@
-from __future__ import annotations
 from typing import List, Optional
 
 from .base_command import BaseCommand
@@ -79,7 +78,7 @@ class Code(BaseCommand):
     @property
     def is_from_file_channel(self) -> bool:
         """Check if this code is from a file channel"""
-        return self.channel is CodeChannel.File
+        return self.channel is CodeChannel.File or self.channel is CodeChannel.File2
 
     def parameter(self, letter: str, default=None):
         """Retrieve the parameter whose letter equals c or generate a default parameter"""

{dsf-python-3.4.6.post4 → dsf-python-3.5.0.1rc2}/src/dsf/commands/code_channel.py

@@ -40,6 +40,12 @@ class CodeChannel(str, Enum):
     # Code channel that executes macros on power fail, heater faults and filament out
     Autopause = "Autopause"
 
+    # Code channel for secondary file prints
+    File2 = "File2"
+
+    # Code channel for the code queue that executes a couple of codes in-sync with moves of the primary print file
+    Queue2 = "Queue2"
+
     # Unknown code channel
     Unknown = "Unknown"
 

{dsf-python-3.4.6.post4 → dsf-python-3.5.0.1rc2}/src/dsf/commands/generic.py

@@ -10,7 +10,9 @@ def check_password(password: str):
     """
     Check if the given password is correct and matches the previously set value from M551.
     If no password was configured before or if it was set to "reprap", this will always return true
+
     :param password: Password to check
+
     :returns: true if the password matches or is not set
     """
     if not isinstance(password, str) or not password:
@@ -23,6 +25,7 @@ def evaluate_expression(channel: CodeChannel, expression: str):
     Evaluate an arbitrary expression on the given channel in RepRapFirmware.
     Do not use this call to evaluate file-based and network-related fields because the
     DSF and RRF models diverge in this regard.
+
     :param channel: Code channel where the expression is evaluated
     :param expression: Expression to evaluate
     """
@@ -33,22 +36,36 @@ def evaluate_expression(channel: CodeChannel, expression: str):
     return BaseCommand("EvaluateExpression", **{"Channel": channel, "Expression": expression})
 
 
-def flush(channel: CodeChannel):
+def flush(channel: CodeChannel, sync_file_streams: bool = False, if_executing: bool = True):
     """
     Wait for all pending (macro) codes on the given channel to finish.
     This effectively guarantees that all buffered codes are processed by RRF before this command finishes.
+
     :param channel: Code channel to flush
+    :param sync_file_streams: Whether the File and File2 streams are supposed to synchronize if a code is being
+    intercepted. This option should be used with care, under certain circumstances this can lead to a deadlock!
+    :param if_executing: Check if the corresponding channel is actually executing codes (i.e. if it is active).
+    If the input channel is not active, this command returns false.
+    This option is ignored if SyncFileStreams is true.
+
     :returns: true if the flush request is successful
     """
     if not isinstance(channel, CodeChannel):
         raise TypeError("channel must be a CodeChannel")
-    return BaseCommand("Flush", **{"Channel": channel})
+    if not isinstance(sync_file_streams, bool):
+        raise TypeError("sync_file_streams must be a boolean")
+    if not isinstance(if_executing, bool):
+        raise TypeError("if_executing must be a boolean")
+    return BaseCommand("Flush",
+                       **{"Channel": channel, "SyncFileStreams": sync_file_streams, "IfExecuting": if_executing})
 
 
 def invalidate_channel(channel: CodeChannel):
     """
     Invalidate all pending codes and files on a given channel (including buffered codes from DSF in RepRapFirmware)
+
     :param channel: Code channel to invalidate
+
     :returns: true if the invalidate request is successful
     """
     if not isinstance(channel, CodeChannel):
@@ -59,6 +76,7 @@ def invalidate_channel(channel: CodeChannel):
 def set_update_status(updating: bool):
     """
     Override the current status as reported by the object model when performing a software update.
+
     :param updating: Whether an update is now in progress
     """
     if not isinstance(updating, bool):
@@ -73,6 +91,7 @@ def simple_code(code: str, channel: CodeChannel = CodeChannel.DEFAULT_CHANNEL, a
     its Code.Result is transformed back into a basic string. This is useful for minimal
     extensions that do not require granular control of the code details. Except for certain cases, it
     is NOT recommended for usage in InterceptionMode because it renders the internal code buffer useless.
+
     :param code: Code to parse and execute
     :param channel: Destination channel
     :param async_exec: Whether this code may be executed asynchronously.
@@ -93,6 +112,7 @@ def write_message(
 ):
     """
     Write an arbitrary generic message
+
     :param message_type: Type of the message to write
     :param content: Content of the message to write
     :param output_message: Output the message on the console and via the object model

{dsf-python-3.4.6.post4 → dsf-python-3.5.0.1rc2}/src/dsf/commands/http_endpoints.py

@@ -1,5 +1,5 @@
 from .base_command import BaseCommand
-from ..object_model.http_endpoints import HttpEndpointType
+from ..object_model import HttpEndpointType
 
 
 def add_http_endpoint(endpoint_type: HttpEndpointType, namespace: str, path: str, is_upload_request: bool):

{dsf-python-3.4.6.post4 → dsf-python-3.5.0.1rc2}/src/dsf/commands/user_sessions.py

@@ -1,21 +1,5 @@
-from enum import Enum
-
 from .base_command import BaseCommand
-
-
-class AccessLevel(str, Enum):
-    """Defines what a user is allowed to do"""
-
-    ReadOnly = "ReadOnly"
-    ReadWrite = "ReadWrite"
-
-
-class SessionType(str, Enum):
-    """Types of user sessions"""
-
-    Local = "Local"
-    HTTP = "HTTP"
-    Telnet = "Telnet"
+from ..object_model import AccessLevel, SessionType
 
 
 def add_user_session(access_level: AccessLevel, session_type: SessionType, origin: str):

{dsf-python-3.4.6.post4 → dsf-python-3.5.0.1rc2}/src/dsf/connections/__init__.py

@@ -24,8 +24,8 @@ class InterceptionMode(str, Enum):
     # Intercept codes before they are internally processed by the control server
     PRE = "Pre"
 
-    # Intercept codes after the initial processing of the control server but before they are forwarded to
-    # the RepRapFirmware controller
+    # Intercept codes after the initial processing of the control server, but before they are forwarded
+    # to the RepRapFirmware controller
     POST = "Post"
 
     # Receive a notification for executed codes. In this state the final result can be still changed

{dsf-python-3.4.6.post4 → dsf-python-3.5.0.1rc2}/src/dsf/connections/base_command_connection.py

@@ -5,8 +5,7 @@ from .. import commands, DEFAULT_BACKLOG
 from ..commands import code
 from ..commands.code_channel import CodeChannel
 from ..http import HttpEndpointUnixSocket
-from ..object_model import ObjectModel
-from ..object_model.http_endpoints import HttpEndpointType
+from ..object_model import HttpEndpointType, ObjectModel
 from ..object_model.job import GCodeFileInfo
 from ..object_model.messages import Message, MessageType
 from ..object_model.state import LogLevel

{dsf-python-3.4.6.post4 → dsf-python-3.5.0.1rc2}/src/dsf/connections/base_connection.py

@@ -117,9 +117,7 @@ class BaseConnection:
                     except Exception as e:
                         raise e
                     # either 0 or end of data
-                    if part == b"":
-                        raise IPCSocketBrokenException()
-                    elif len(part) < BUFF_SIZE:
+                    if len(part) < BUFF_SIZE:
                         break
 
                 json_string += data.decode("utf8")

{dsf-python-3.4.6.post4 → dsf-python-3.5.0.1rc2}/src/dsf/connections/init_messages/client_init_messages.py

@@ -17,7 +17,7 @@ clientinitmessages holds all messages a client can send to the server to initiat
     You should have received a copy of the GNU Lesser General Public License
     along with this program.  If not, see <https://www.gnu.org/licenses/>.
 """
-from __future__ import annotations
+from typing import List
 from .server_init_message import ServerInitMessage
 from .. import ConnectionMode, InterceptionMode, SubscriptionMode
 from ...commands.code_channel import CodeChannel
@@ -38,8 +38,8 @@ class ClientInitMessage:
 
 def intercept_init_message(
         intercept_mode: InterceptionMode,
-        channels: list[CodeChannel],
-        filters: list[str],
+        channels: List[CodeChannel],
+        filters: List[str],
         priority_codes: bool,
         auto_flush: bool = True):
     """
@@ -70,7 +70,7 @@ def intercept_init_message(
             "Channels": channels,
             "AutoFlush": auto_flush,
             "Filters": filters,
-            "PriortyCodes": priority_codes,
+            "PriorityCodes": priority_codes,
         },
     )
 

{dsf-python-3.4.6.post4 → dsf-python-3.5.0.1rc2}/src/dsf/connections/intercept_connection.py

@@ -1,4 +1,4 @@
-from __future__ import annotations
+from typing import List, Optional
 
 from .base_command_connection import BaseCommandConnection
 from .init_messages import client_init_messages
@@ -28,8 +28,8 @@ class InterceptConnection(BaseCommandConnection):
     def __init__(
         self,
         interception_mode: client_init_messages.InterceptionMode,
-        channels: list[CodeChannel] = None,
-        filters: list[str] = None,
+        channels: List[CodeChannel] = None,
+        filters: List[str] = None,
         auto_flush: bool = True,
         priority_codes: bool = False,
         debug: bool = False,

{dsf-python-3.4.6.post4 → dsf-python-3.5.0.1rc2}/src/dsf/http.py

@@ -5,7 +5,7 @@ from concurrent.futures import ThreadPoolExecutor
 from enum import Enum
 
 from . import DEFAULT_BACKLOG
-from .object_model.http_endpoints import HttpEndpointType
+from .object_model import HttpEndpointType
 
 
 class HttpResponseType(str, Enum):

{dsf-python-3.4.6.post4 → dsf-python-3.5.0.1rc2}/src/dsf/object_model/__init__.py

@@ -2,19 +2,19 @@ from .boards import Board, BoardState
 from .directories import Directories
 from .fans import Fan
 from .heat import Heat, Heater, HeaterState
-from .http_endpoints import HttpEndpoint, HttpEndpointType
 from .inputs import InputChannel
 from .job import Job
+from .led_strips import LedStrip, LedStripType
 from .limits import Limits
 from .messages import Message, MessageType
 from .move import DriverId, Move
 from .network import Network, NetworkInterface, NetworkInterfaceType, NetworkProtocol, NetworkState
 from .object_model import ObjectModel
 from .plugins import Plugin, PluginManifest, SbcPermissions
-from .scanner import Scanner, ScannerStatus
+from .sbc import CPU, Memory, SBC
+from .sbc.dsf import AccessLevel, HttpEndpoint, HttpEndpointType, SessionType, UserSession
 from .sensors import AnalogSensor, AnalogSensorType, Endstop, EndstopType, GpInputPort, Probe, ProbeType, Sensors
 from .spindles import Spindle, SpindleState
 from .state import LogLevel, MachineStatus, MessageBox, MessageBoxMode, State
 from .tools import Tool, ToolState
-from .user_sessions import AccessLevel, SessionType, UserSession
 from .volumes import Volume

dsf-python-3.5.0.1rc2/src/dsf/object_model/boards/__init__.py

@@ -0,0 +1,10 @@
+from .accelerometer import Accelerometer
+from .boards import Board, BoardState
+from .board_closed_loop import BoardClosedLoop
+from .direct_display import DirectDisplay
+from .driver import Driver
+from .driver_closed_loop import DriverClosedLoop, ClosedLoopCurrentFraction, ClosedLoopPositionError
+from .min_max_current import MinMaxCurrent
+
+__all__ = ['Accelerometer', 'Board', 'BoardState', 'BoardClosedLoop', 'DirectDisplay', 'Driver', 'DriverClosedLoop',
+           'ClosedLoopCurrentFraction', 'ClosedLoopPositionError', 'MinMaxCurrent']

dsf-python-3.4.6.post4/src/dsf/object_model/boards/closed_loop.py → dsf-python-3.5.0.1rc2/src/dsf/object_model/boards/board_closed_loop.py

@@ -1,10 +1,10 @@
 from ..model_object import ModelObject
 
 
-class ClosedLoop(ModelObject):
+class BoardClosedLoop(ModelObject):
     """This represents information about closed-loop tuning"""
     def __init__(self):
-        super(ClosedLoop, self).__init__()
+        super(BoardClosedLoop, self).__init__()
         # Number of collected data points in the last run or 0 if it failed
         self._points = 0
         # Number of completed sampling runs

{dsf-python-3.4.6.post4 → dsf-python-3.5.0.1rc2}/src/dsf/object_model/boards/boards.py

@@ -1,12 +1,16 @@
 from __future__ import annotations
 from enum import Enum
+from typing import List, Union
 
 from .accelerometer import Accelerometer
-from .closed_loop import ClosedLoop
+from .board_closed_loop import BoardClosedLoop
 from .direct_display import DirectDisplay
+from .driver import Driver
 from .min_max_current import MinMaxCurrent
+from ..model_collection import ModelCollection
 from ..model_object import ModelObject
 from ..utils import wrap_model_property
+from ...utils import deprecated
 
 
 class BoardState(str, Enum):
@@ -36,7 +40,7 @@ class Board(ModelObject):
     # Accelerometer of this board or None if unknown
     accelerometer = wrap_model_property('accelerometer', Accelerometer)
     # Closed loop data of this board or None if unknown
-    closed_loop = wrap_model_property('closed_loop', ClosedLoop)
+    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)
     # Minimum, maximum, and current temperatures of the MCU or None if unknown
@@ -59,6 +63,8 @@ class Board(ModelObject):
         self._closed_loop = None
         # Details about a connected display or None if none is connected
         self._direct_display = None
+        # Drivers of this board
+        self._drivers = None
         # Date of the firmware build
         self._firmware_date = ""
         # Filename of the firmware binary
@@ -95,9 +101,11 @@ class Board(ModelObject):
         self._v_12 = None
         # Minimum, maximum, and current voltages on the input rail or None if unknown
         self._v_in = None
+        # Filename of the on-board WiFi chip or None if not present
+        self._wifi_firmware_file_name = None
 
     @property
-    def bootloader_file_name(self) -> str | None:
+    def bootloader_file_name(self) -> Union[str, None]:
         """Filename of the bootloader binary or None if unknown"""
         return self._bootloader_file_name
 
@@ -106,7 +114,7 @@ class Board(ModelObject):
         self._bootloader_file_name = str(value) if value is not None else None
 
     @property
-    def can_address(self) -> int | None:
+    def can_address(self) -> Union[int, None]:
         """CAN address of this board or None if not applicable"""
         return self._can_address
 
@@ -114,13 +122,22 @@ class Board(ModelObject):
     def can_address(self, value: int | None = None):
         self._can_address = int(value) if value is not None else None
 
+    @property
+    def drivers(self) -> Union[List[Driver], None]:
+        """Drivers of this board"""
+        return self._drivers
+
+    @drivers.setter
+    def drivers(self, value):
+        self._drivers = None if value is None else ModelCollection(Driver, value)
+
     @property
     def firmware_date(self) -> str:
         """Date of the firmware build"""
         return self._firmware_date
 
     @firmware_date.setter
-    def firmware_date(self, value: str):
+    def firmware_date(self, value):
         self._firmware_date = str(value)
 
     @property
@@ -129,7 +146,7 @@ class Board(ModelObject):
         return self._firmware_file_name
 
     @firmware_file_name.setter
-    def firmware_file_name(self, value: str):
+    def firmware_file_name(self, value):
         self._firmware_file_name = str(value)
 
     @property
@@ -138,7 +155,7 @@ class Board(ModelObject):
         return self._firmware_name
 
     @firmware_name.setter
-    def firmware_name(self, value: str):
+    def firmware_name(self, value):
         self._firmware_name = str(value)
 
     @property
@@ -147,11 +164,11 @@ class Board(ModelObject):
         return self._firmware_version
 
     @firmware_version.setter
-    def firmware_version(self, value: str):
+    def firmware_version(self, value):
         self._firmware_version = str(value)
 
     @property
-    def iap_file_name_SBC(self) -> str | None:
+    def iap_file_name_SBC(self) -> Union[str, None]:
         """Filename of the IAP binary that is used for updates from the SBC or None if unsupported"""
         return self._iap_file_name_SBC
 
@@ -160,7 +177,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) -> str | None:
+    def iap_file_name_SD(self) -> Union[str, 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)"""
         return self._iap_file_name_SD
@@ -175,7 +192,7 @@ class Board(ModelObject):
         return self._max_heaters
 
     @max_heaters.setter
-    def max_heaters(self, value: int):
+    def max_heaters(self, value):
         self._max_heaters = int(value)
 
     @property
@@ -184,7 +201,7 @@ class Board(ModelObject):
         return self._max_motors
 
     @max_motors.setter
-    def max_motors(self, value: int):
+    def max_motors(self, value):
         self._max_motors = int(value)
 
     @property
@@ -193,7 +210,7 @@ class Board(ModelObject):
         return self._name
 
     @name.setter
-    def name(self, value: str):
+    def name(self, value):
         self._name = str(value)
 
     @property
@@ -202,7 +219,7 @@ class Board(ModelObject):
         return self._short_name
 
     @short_name.setter
-    def short_name(self, value: str):
+    def short_name(self, value):
         self._short_name = str(value)
 
     @property
@@ -221,9 +238,10 @@ class Board(ModelObject):
                             f" Got {type(value)}: {value}")
 
     @property
+    @deprecated(f"Use {__name__}.supports_direct_display instead")
     def supports_12864(self) -> bool:
         """Indicates if this board supports external 12864 displays
-        Obsolete: Replaced with SupportsDirectDisplay"""
+        Deprecated: Use supports_direct_display instead"""
         return self._supports_12864
 
     @supports_12864.setter
@@ -240,10 +258,19 @@ class Board(ModelObject):
         self._supports_direct_display = bool(value)
 
     @property
-    def unique_id(self) -> str | None:
+    def unique_id(self) -> Union[str, None]:
         """Unique identifier of the board or None if unknown"""
         return self._unique_id
 
     @unique_id.setter
     def unique_id(self, value: str | None = None):
         self._unique_id = str(value) if value is not None else None
+
+    @property
+    def wifi_firmware_file_name(self):
+        """Filename of the on-board WiFi chip or None if not present"""
+        return self._wifi_firmware_file_name
+
+    @wifi_firmware_file_name.setter
+    def wifi_firmware_file_name(self, value):
+        self._wifi_firmware_file_name = str(value) if value is not None else None

dsf-python-3.5.0.1rc2/src/dsf/object_model/boards/direct_display/__init__.py

@@ -0,0 +1,8 @@
+from .direct_display import DirectDisplay
+from .direct_display_controller import DirectDisplayController
+from .direct_display_encoder import DirectDisplayEncoder
+from .direct_display_screen import DirectDisplayScreen
+from .direct_display_screen_st7567 import DirectDisplayScreenST7567
+
+__all__ = ['DirectDisplay', 'DirectDisplayController', 'DirectDisplayEncoder',
+           'DirectDisplayScreen', 'DirectDisplayScreenST7567']

dsf-python-3.5.0.1rc2/src/dsf/object_model/boards/direct_display/direct_display.py

@@ -0,0 +1,23 @@
+from .direct_display_encoder import DirectDisplayEncoder
+from .direct_display_screen import DirectDisplayScreen
+
+from ...model_object import ModelObject
+from ...utils import wrap_model_property
+
+
+class DirectDisplay(ModelObject):
+    """Class providing information about a connected direct-connect display"""
+
+    encoder = wrap_model_property('encoder', DirectDisplayEncoder)
+
+    def __init__(self):
+        super(DirectDisplay, self).__init__()
+        # Encoder of this screen or null if none
+        self._encoder = None
+        # Screen information
+        self._screen = DirectDisplayScreen()
+
+    @property
+    def screen(self) -> DirectDisplayScreen:
+        """Screen information"""
+        return self._screen

dsf-python-3.5.0.1rc2/src/dsf/object_model/boards/direct_display/direct_display_controller.py

@@ -0,0 +1,14 @@
+from enum import Enum
+
+
+class DirectDisplayController(str, Enum):
+    """Enumeration of possible direct-connect display controllers"""
+
+    # ST7920 controller
+    ST7920 = "ST7920"
+
+    # ST7567 controller
+    ST7567 = "ST7567"
+
+    # ILI9488 controller
+    ILI9488 = "ILI9488"

dsf-python-3.5.0.1rc2/src/dsf/object_model/boards/direct_display/direct_display_encoder.py

@@ -0,0 +1,19 @@
+from ...model_object import ModelObject
+
+
+class DirectDisplayEncoder(ModelObject):
+    """Class providing information about a connected display encoder"""
+
+    def __init__(self):
+        super().__init__()
+        # Number of pulses per click of the rotary encoder
+        self._pulses_per_click = 1
+
+    @property
+    def pulses_per_click(self) -> int:
+        """Number of pulses per click of the rotary encoder"""
+        return self._pulses_per_click
+
+    @pulses_per_click.setter
+    def pulses_per_click(self, value: int):
+        self._pulses_per_click = int(value)