flashforge-python-api 1.3.1__py3-none-any.whl → 1.3.3__py3-none-any.whl

flashforge/api/controls/control.py

@@ -2,6 +2,7 @@
 FlashForge Python API - Control Module
 """
 
+import logging
 from typing import TYPE_CHECKING, Any
 
 from ...models.responses import FilamentArgs
@@ -14,6 +15,8 @@ if TYPE_CHECKING:
     from ...client import FlashForgeClient
     from ...tcp.ff_client import FlashForgeClient as TcpClient
 
+logger = logging.getLogger(__name__)
+
 
 class Control:
     """
@@ -75,7 +78,7 @@ class Control:
             return await self._send_filtration_command(
                 FilamentArgs(internal="close", external="open")
             )
-        print("SetExternalFiltrationOn() error, filtration not equipped.")
+        logger.warning("set_external_filtration_on: filtration is not equipped on this printer.")
         return False
 
     async def set_internal_filtration_on(self) -> bool:
@@ -90,7 +93,7 @@ class Control:
             return await self._send_filtration_command(
                 FilamentArgs(internal="open", external="close")
             )
-        print("SetInternalFiltrationOn() error, filtration not equipped.")
+        logger.warning("set_internal_filtration_on: filtration is not equipped on this printer.")
         return False
 
     async def set_filtration_off(self) -> bool:
@@ -105,7 +108,7 @@ class Control:
             return await self._send_filtration_command(
                 FilamentArgs(internal="close", external="close")
             )
-        print("SetFiltrationOff() error, filtration not equipped.")
+        logger.warning("set_filtration_off: filtration is not equipped on this printer.")
         return False
 
     async def turn_camera_on(self) -> bool:
@@ -188,7 +191,7 @@ class Control:
             True if the command is successful, False otherwise.
         """
         if not self.client.led_control:
-            print("SetLedOn() error, LED control not equipped.")
+            logger.warning("set_led_on: LED control is not equipped on this printer.")
             return False
         return await self.send_control_command(Commands.LIGHT_CONTROL_CMD, {"status": "open"})
 
@@ -200,7 +203,7 @@ class Control:
             True if the command is successful, False otherwise.
         """
         if not self.client.led_control:
-            print("SetLedOff() error, LED control not equipped.")
+            logger.warning("set_led_off: LED control is not equipped on this printer.")
             return False
         return await self.send_control_command(Commands.LIGHT_CONTROL_CMD, {"status": "close"})
 
@@ -259,7 +262,9 @@ class Control:
             True if the command is successful, False otherwise.
         """
         if not self.client.is_ad5x and not self.client.is_creator5:
-            print("configure_slot() error, material station only available on AD5X / Creator 5.")
+            logger.warning(
+                "configure_slot: the material station is only available on the AD5X / Creator 5."
+            )
             return False
         # The AD5X and Creator 5 use MUTUALLY EXCLUSIVE color wire formats (see
         # creator5_palette for the firmware match rules), so model-gate here:
@@ -293,7 +298,9 @@ class Control:
             "payload": {"cmd": command, "args": args},
         }
 
-        print(f"SendControlCommand:\n{payload}")
+        # Log the command, never `payload`: it carries the serial number and
+        # check code, and these lines end up pasted into bug reports.
+        logger.debug("Sending control command %s with args %s", command, args)
 
         try:
             await self.client.is_http_client_busy()
@@ -305,12 +312,12 @@ class Control:
                 headers={"Content-Type": "application/json"},
             ) as response:
                 data = await json_from_response(response)
-                print(f"Command reply: {data}")
+                logger.debug("Control command %s reply: %s", command, data)
 
                 return NetworkUtils.is_ok(data)
 
         except Exception as e:
-            print(f"Error in send_control_command: {e}")
+            logger.warning("Error in send_control_command (%s): %s", command, e)
             return False
         finally:
             self.client.release_http_client()

flashforge/api/controls/creator5_palette.py

@@ -16,6 +16,7 @@ for the model-gating that splits them.
 
 from __future__ import annotations
 
+import logging
 import math
 import re
 from dataclasses import dataclass
@@ -25,6 +26,8 @@ from dataclasses import dataclass
 # reference. PEP 8 lowercase locals are therefore relaxed here on purpose.
 # ruff: noqa: N806
 
+logger = logging.getLogger(__name__)
+
 
 @dataclass(frozen=True)
 class Creator5PaletteColor:
@@ -70,7 +73,7 @@ CREATOR5_PALETTE: tuple[Creator5PaletteColor, ...] = (
 )
 
 # 25^7, the CIEDE2000 chroma weighting constant.
-_25_POW_7 = 25.0 ** 7
+_25_POW_7 = 25.0**7
 
 # D65 reference white point used by the sRGB -> XYZ transform.
 _D65_XN = 0.95047
@@ -132,7 +135,7 @@ def _delta_e_2000(c1: tuple[float, float, float], c2: tuple[float, float, float]
     C1 = math.sqrt(a1 * a1 + b1 * b1)
     C2 = math.sqrt(a2 * a2 + b2 * b2)
     Cbar = (C1 + C2) / 2.0
-    Cbar7 = Cbar ** 7
+    Cbar7 = Cbar**7
     G = 0.5 * (1 - math.sqrt(Cbar7 / (Cbar7 + _25_POW_7)))
 
     a1p = (1 + G) * a1
@@ -178,7 +181,7 @@ def _delta_e_2000(c1: tuple[float, float, float], c2: tuple[float, float, float]
     )
 
     dTheta = 30 * math.exp(-(((hbarp - 275) / 25.0) ** 2))
-    Cbarp7 = Cbarp ** 7
+    Cbarp7 = Cbarp**7
     RC = 2 * math.sqrt(Cbarp7 / (Cbarp7 + _25_POW_7))
     SL = 1 + (0.015 * (Lbarp - 50) ** 2) / math.sqrt(20 + (Lbarp - 50) ** 2)
     SC = 1 + 0.045 * Cbarp
@@ -238,9 +241,9 @@ def snap_to_creator5_palette(hex_str: str) -> Creator5PaletteColor:
     """
     rgb = _hex_to_rgb(hex_str)
     if rgb is None:
-        print(
-            f'snap_to_creator5_palette: could not parse "{hex_str}" as hex; '
-            "falling back to White."
+        logger.warning(
+            'snap_to_creator5_palette: could not parse "%s" as hex; falling back to White.',
+            hex_str,
         )
         return CREATOR5_PALETTE[0]
 

flashforge/api/controls/files.py

@@ -3,6 +3,7 @@ FlashForge Python API - Files Module
 """
 
 import base64
+import logging
 from typing import TYPE_CHECKING
 
 from pydantic import ValidationError
@@ -15,6 +16,8 @@ from ..network.utils import NetworkUtils, json_from_response
 if TYPE_CHECKING:
     from ...client import FlashForgeClient
 
+logger = logging.getLogger(__name__)
+
 
 class Files:
     """
@@ -87,13 +90,27 @@ class Files:
                 data = await json_from_response(response)
 
                 if not NetworkUtils.is_ok(data):
-                    print(f"Error retrieving file list: {NetworkUtils.get_error_message(data)}")
+                    logger.warning(
+                        "Error retrieving the file list: %s",
+                        NetworkUtils.get_error_message(data),
+                    )
                     return []
 
                 # Parse the response using GCodeListResponse
                 try:
                     result = GCodeListResponse(**data)
-                except ValidationError:
+                except ValidationError as err:
+                    # The names-only fallback below silently costs the caller
+                    # every per-file field, which is indistinguishable from a
+                    # printer that only reports names. Say so, loudly enough to
+                    # reach an integration's log, or the next model that changes
+                    # this payload looks like it reports no metadata at all.
+                    logger.warning(
+                        "Could not parse the /gcodeList response; falling back to file "
+                        "names only, so print time, filament weight, and per-tool "
+                        "material data are unavailable for every file. %s",
+                        err,
+                    )
                     raw_list = data.get("gcodeList", [])
                     if isinstance(raw_list, list):
                         entries: list[FFGcodeFileEntry] = []
@@ -127,15 +144,13 @@ class Files:
                     elif isinstance(first_item, FFGcodeFileEntry):
                         # Already FFGcodeFileEntry objects - need explicit type narrowing
                         return [
-                            item
-                            for item in result.gcode_list
-                            if isinstance(item, FFGcodeFileEntry)
+                            item for item in result.gcode_list if isinstance(item, FFGcodeFileEntry)
                         ]
 
                 return []
 
         except Exception as err:
-            print(f"GetRecentFileList error: {err}")
+            logger.warning("get_recent_file_list error: %s", err)
             return []
 
     async def get_gcode_thumbnail(self, file_name: str) -> bytes | None:
@@ -173,9 +188,12 @@ class Files:
                     result = ThumbnailResponse(**data)
                     return base64.b64decode(result.image_data)
                 else:
-                    print(f"Error retrieving thumbnail: {NetworkUtils.get_error_message(data)}")
+                    logger.warning(
+                        "Error retrieving the thumbnail: %s",
+                        NetworkUtils.get_error_message(data),
+                    )
                     return None
 
         except Exception as err:
-            print(f"GetGcodeThumbnail error: {err}")
+            logger.warning("get_gcode_thumbnail error: %s", err)
             return None

flashforge/api/controls/info.py

@@ -2,6 +2,7 @@
 FlashForge Python API - Info Module
 """
 
+import logging
 import re
 from datetime import datetime, timedelta
 from typing import TYPE_CHECKING
@@ -9,11 +10,14 @@ from typing import TYPE_CHECKING
 from ...models.machine_info import FFMachineInfo, MachineState, Temperature
 from ...models.responses import DetailResponse, FFPrinterDetail
 from ..constants.endpoints import Endpoints
+from ..misc.redaction import redact_model
 from ..network.utils import json_from_response
 
 if TYPE_CHECKING:
     from ...client import FlashForgeClient
 
+logger = logging.getLogger(__name__)
+
 
 # Firmware-reported PIDs from FlashForge's /detail endpoint. These are stable
 # identifiers set by firmware, unlike the user-mutable `name` field.
@@ -89,10 +93,17 @@ class MachineInfoParser:
             print_progress = getattr(detail, "print_progress", 0) or 0
             est_length = total_job_filament_meters * print_progress
             est_weight = (getattr(detail, "estimated_right_weight", 0) or 0) * print_progress
+            # Material Station presence, derived rather than read off a single
+            # field. `hasMatlStation` is AD5X-only: the Creator 5 series omits it
+            # from /detail entirely (verified on a Creator 5 Pro, pid 41, firmware
+            # 1.9.4) while reporting a fully populated matlStationInfo with four
+            # loaded slots, so an absent flag means "not reported", never "absent
+            # hardware". Populated slot data is the reliable signal.
             has_material_station = (
                 getattr(detail, "has_matl_station", None) is True
                 or (getattr(getattr(detail, "matl_station_info", None), "slot_cnt", 0) or 0) > 0
-                or len(getattr(getattr(detail, "matl_station_info", None), "slot_infos", []) or []) > 0
+                or len(getattr(getattr(detail, "matl_station_info", None), "slot_infos", []) or [])
+                > 0
             )
             printer_name = getattr(detail, "name", "") or ""
             pid = getattr(detail, "pid", None)
@@ -236,7 +247,9 @@ class MachineInfoParser:
                 print_speed_adjust=getattr(detail, "print_speed_adjust", 0) or 0,
                 filament_type=getattr(detail, "right_filament_type", "") or "",
                 # Machine state
-                machine_state=MachineInfoParser._get_machine_state(getattr(detail, "status", "") or ""),
+                machine_state=MachineInfoParser._get_machine_state(
+                    getattr(detail, "status", "") or ""
+                ),
                 status=getattr(detail, "status", "") or "",
                 total_print_layers=getattr(detail, "target_print_layer", 0) or 0,
                 tvoc=getattr(detail, "tvoc", 0) or 0,
@@ -249,8 +262,8 @@ class MachineInfoParser:
                 completion_time=completion_time,
                 formatted_run_time=formatted_run_time,
                 formatted_total_run_time=formatted_total_run_time,
-                # AD5X Material Station
-                has_matl_station=getattr(detail, "has_matl_station", None),
+                # Material Station (AD5X / Creator 5 series)
+                has_matl_station=has_material_station,
                 matl_station_info=getattr(detail, "matl_station_info", None),
                 indep_matl_info=getattr(detail, "indep_matl_info", None),
             )
@@ -258,8 +271,14 @@ class MachineInfoParser:
             return machine_info
 
         except Exception as error:
-            print(f"Error in MachineInfoParser.from_detail: {error}")
-            print(f"Detail object causing error: {detail}")
+            logger.warning(
+                "Could not parse the /detail payload into FFMachineInfo; the caller sees "
+                "this as an unreachable printer. %s",
+                error,
+            )
+            # Redacted: this dump carries the MAC, IP and cloud registration
+            # codes, and it exists to be pasted into a bug report.
+            logger.debug("Detail object that failed to parse: %s", redact_model(detail))
             return None
 
     @staticmethod
@@ -294,7 +313,7 @@ class MachineInfoParser:
             return state_mapping[valid_status]
 
         if valid_status:
-            print(f"Unknown machine status received: '{status}'")
+            logger.warning("Unknown machine status received: %r", status)
         return MachineState.UNKNOWN
 
 
@@ -375,12 +394,17 @@ class Info:
                 headers={"Content-Type": "application/json"},
             ) as response:
                 if response.status != 200:
-                    print(f"Non-200 status from detail endpoint: {response.status}")
+                    logger.warning("Non-200 status from the /detail endpoint: %s", response.status)
                     return None
 
                 data = await json_from_response(response)
                 return DetailResponse(**data)
 
         except Exception as error:
-            print(f"GetDetailResponse Request error: {error}")
+            logger.warning(
+                "Could not read /detail; callers cannot tell this from an unreachable "
+                "printer or a rejected check code, so this line is the only record of "
+                "the real cause. %s",
+                error,
+            )
             return None