anycubic-cloud-api 0.4.35__tar.gz → 0.4.36__tar.gz

{anycubic_cloud_api-0.4.35/src/anycubic_cloud_api.egg-info → anycubic_cloud_api-0.4.36}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: anycubic-cloud-api
-Version: 0.4.35
+Version: 0.4.36
 Summary: Async client for the Anycubic Cloud API and its MQTT stream
 Author: WaresWichall, Nino Bondonno
 Maintainer: Nino Bondonno

{anycubic_cloud_api-0.4.35 → anycubic_cloud_api-0.4.36}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "anycubic-cloud-api"
-version = "0.4.35"
+version = "0.4.36"
 description = "Async client for the Anycubic Cloud API and its MQTT stream"
 readme = "README.md"
 requires-python = ">=3.12"

{anycubic_cloud_api-0.4.35 → anycubic_cloud_api-0.4.36}/src/anycubic_cloud_api/api/mqtt.py

@@ -42,6 +42,7 @@ from ..helpers.helpers import (
     get_mqtt_ssl_path_key,
     get_part_from_mqtt_topic,
     get_ssl_cert_directory,
+    redact_for_log,
     redact_part_from_mqtt_topic,
 )
 from .functions import AnycubicAPIFunctions
@@ -151,7 +152,7 @@ class AnycubicMQTTAPI(AnycubicAPIFunctions):
         if self._mqtt_topic_is_user_topic(topic):
             self._log_to_debug(
                 f"Anycubic MQTT USER Msg Received on `{topic}`:\n"
-                f"    {payload}"
+                f"    {redact_for_log(payload)}"
             )
 
         else:
@@ -182,7 +183,7 @@ class AnycubicMQTTAPI(AnycubicAPIFunctions):
                     f"  with type: {e.unhandled_mqtt_type}, "
                     f"action: {e.unhandled_mqtt_action}, "
                     f"state: {e.unhandled_mqtt_state}\n"
-                    f"    unhandled data: {e.unhandled_mqtt_data}"
+                    f"    unhandled data: {redact_for_log(e.unhandled_mqtt_data)}"
                 )
 
             except AnycubicMQTTUnknownUpdate as e:
@@ -193,7 +194,7 @@ class AnycubicMQTTAPI(AnycubicAPIFunctions):
                 self._log_to_debug(
                     f"Anycubic MQTT Message not understood: {e}\n"
                     f"  on MQTT topic: {redacted_topic}\n"
-                    f"    {payload}"
+                    f"    {redact_for_log(payload)}"
                 )
 
             except Exception as e:
@@ -203,7 +204,7 @@ class AnycubicMQTTAPI(AnycubicAPIFunctions):
                 self._log_to_error(
                     f"Anycubic MQTT Message error: {error_type}: {e}\n"
                     f"  on MQTT topic: {redacted_topic}\n"
-                    f"    {payload}\n"
+                    f"    {redact_for_log(payload)}\n"
                     f"{tb}"
                 )
 
@@ -230,7 +231,7 @@ class AnycubicMQTTAPI(AnycubicAPIFunctions):
                 self._log_to_debug(
                     f"Anycubic MQTT Message processed on topic: "
                     f"{redact_part_from_mqtt_topic(topic, 6)}\n"
-                    f"    {payload}"
+                    f"    {redact_for_log(payload)}"
                 )
 
     def _mqtt_publish_on_topic(

{anycubic_cloud_api-0.4.35 → anycubic_cloud_api-0.4.36}/src/anycubic_cloud_api/data_models/printer.py

@@ -452,6 +452,12 @@ class AnycubicPrinter:
                         updated.get(box.box_id, box) for box in known_boxes
                     ])
 
+                if known_boxes:
+                    previous = {box.box_id: box for box in known_boxes}
+                    for box in self._multi_color_box:
+                        if (known := previous.get(box.box_id)) is not None and known is not box:
+                            box.keep_printer_slot_from(known)
+
         except Exception as e:
             self._initialisation_error = True
             # Swallowing this leaves the ACE list empty, which presents as
@@ -1542,9 +1548,32 @@ class AnycubicPrinter:
             if self.external_shelves:
                 self.external_shelves.update_with_mqtt_data(data)
             return
+        elif action == 'auto' and state == 'done':
+            # Sent as a filament change completes, naming the feeding slot as
+            # "<box>-<slot>", both counted from 0 ("0-3" while the screen shows
+            # slot 4 on a Kobra X, #34); empty while the filament is retracted.
+            data = payload.get('data') or {}
+            self._apply_current_filament(data.get('current_filament'))
+            return
         else:
             raise AnycubicMQTTUnknownUpdate(ErrorsMQTTUpdate.shelves)
 
+    def _apply_current_filament(self, current_filament: Any) -> None:
+        """Follow the printer's own "<box>-<slot>" reading, where the box is certain.
+
+        Only with a single box: which list entry the printer's box number
+        means beside an ACE is not confirmed (#33). An empty reading is a
+        retract for calibration or wiping, not a change of slot, so the last
+        slot is kept.
+        """
+        boxes = self._multi_color_box
+        if not isinstance(current_filament, str) or not boxes or len(boxes) != 1:
+            return
+        box_no, _, slot_no = current_filament.partition('-')
+        box_index, slot_index = as_int(box_no, -1), as_int(slot_no, -1)
+        if box_index == 0 and 0 <= slot_index < len(boxes[0].slots):
+            boxes[0].set_slot_loaded(slot_index)
+
     def _process_mqtt_update_file(
         self,
         action: str,

{anycubic_cloud_api-0.4.35 → anycubic_cloud_api-0.4.36}/src/anycubic_cloud_api/data_models/printer_properties.py

@@ -702,6 +702,7 @@ class AnycubicMultiColorBox:
         "_model_id",
         "_auto_feed",
         "_loaded_slot",
+        "_slot_from_printer",
         "_feed_status",
         "_temp",
         "_humidity",
@@ -734,6 +735,9 @@ class AnycubicMultiColorBox:
         self._model_id: int = as_int(model_id)
         self._auto_feed: int = as_int(auto_feed)
         self._loaded_slot: int = as_int(loaded_slot, -1)
+        # Whether the printer itself has reported the loaded slot, as opposed
+        # to a cloud record that only knew it at some earlier point.
+        self._slot_from_printer = False
         self.set_feed_status(feed_status)
         self.set_current_temperature(temp)
         self._humidity: float | None = (
@@ -759,7 +763,21 @@ class AnycubicMultiColorBox:
         self._feed_status = AnycubicFeedStatus.from_json(feed_status)
 
     def set_slot_loaded(self, slot_num: int) -> None:
+        """A loaded slot reported by the printer (MQTT or LAN)."""
         self._loaded_slot = as_int(slot_num, -1)
+        self._slot_from_printer = True
+
+    def keep_printer_slot_from(self, previous: AnycubicMultiColorBox) -> None:
+        """Carry over a slot the printer reported, past a cloud refresh.
+
+        The cloud's record of the loaded slot goes stale during a print: a
+        Kobra X kept reporting slot 4 while each cloud poll said slot 2, and
+        the sensor flipped to 2 mid-print (#34). What the printer said last
+        wins until it says something else.
+        """
+        if previous._slot_from_printer:
+            self._loaded_slot = previous._loaded_slot
+            self._slot_from_printer = True
 
     def set_current_temperature(self, temp: int) -> None:
         # Reached from the constructor as well as from MQTT, so a null

{anycubic_cloud_api-0.4.35 → anycubic_cloud_api-0.4.36}/src/anycubic_cloud_api/helpers/helpers.py

@@ -164,6 +164,34 @@ def get_part_from_mqtt_topic(topic: str, part: int) -> str | None:
     return split_topic[part]
 
 
+# Identifiers a printer puts in its own reports. A debug log gets pasted into
+# public issues, and only the topic's printer key was being redacted: a
+# Kobra X's PrintStart report carried its cn_code in the clear (#34).
+_LOG_REDACT_KEYS = frozenset({
+    'cn_code', 'cn', 'sn', 'serial', 'machine_sn', 'mac', 'machine_mac',
+    'ip', 'key', 'printer_key', 'device_id', 'deviceId', 'user_id', 'email',
+})
+_LOG_REDACT_PARTS = ('token', 'secret', 'password')
+
+
+def redact_for_log(data: Any) -> Any:
+    """A copy of an MQTT payload that is safe to put in a log."""
+    if isinstance(data, dict):
+        return {
+            key: (
+                "**REDACTED**"
+                if isinstance(key, str)
+                and data[key] not in (None, '')
+                and (key in _LOG_REDACT_KEYS or any(part in key.lower() for part in _LOG_REDACT_PARTS))
+                else redact_for_log(data[key])
+            )
+            for key in data
+        }
+    if isinstance(data, list):
+        return [redact_for_log(item) for item in data]
+    return data
+
+
 def redact_part_from_mqtt_topic(topic: str, part: int) -> str:
     split_topic = topic.split("/")
     new_chunk = list()

{anycubic_cloud_api-0.4.35 → anycubic_cloud_api-0.4.36/src/anycubic_cloud_api.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: anycubic-cloud-api
-Version: 0.4.35
+Version: 0.4.36
 Summary: Async client for the Anycubic Cloud API and its MQTT stream
 Author: WaresWichall, Nino Bondonno
 Maintainer: Nino Bondonno

{anycubic_cloud_api-0.4.35 → anycubic_cloud_api-0.4.36}/src/anycubic_cloud_api.egg-info/SOURCES.txt

@@ -56,6 +56,7 @@ tests/test_null_tolerant_parsing.py
 tests/test_partial_reports.py
 tests/test_print_reports_0434.py
 tests/test_printer_error_codes.py
+tests/test_printer_slot_0436.py
 tests/test_project_null_status.py
 tests/test_regions.py
 tests/test_secondary_ace.py

anycubic_cloud_api-0.4.36/tests/test_printer_slot_0436.py

@@ -0,0 +1,149 @@
+"""The printer's own loaded slot, and logs safe to paste (0.4.36).
+
+From a Kobra X printing from slot 4 (#34): the sensor flipped to 2 mid-print
+with no message from the printer. Each cloud poll rebuilt the box from the
+cloud's record, whose loaded slot was stale. The printer also names the
+feeding slot itself in its extfilbox report, and its PrintStart report put
+the printer's cn_code into the debug log.
+"""
+
+import pytest
+from test_filament_change_0435 import (
+    KOBRA_S1,
+    KOBRA_X,
+    box,
+    make_printer,
+    message,
+    topic,
+)
+
+from anycubic_cloud_api.helpers.helpers import redact_for_log
+
+
+def cloud_info(boxes, machine_type=KOBRA_X):
+    return {
+        "id": 1, "name": "Printer", "key": "k", "machine_type": machine_type, "model": "Printer",
+        "img": "", "device_status": 1, "is_printing": 2, "type_function_ids": [], "version": None,
+        "multi_color_box": boxes,
+    }
+
+
+def stale_box(box_id, loaded_slot):
+    b = box(box_id)
+    b["loaded_slot"] = loaded_slot
+    return b
+
+
+def loaded(printer):
+    return [b.loaded_slot for b in printer.multi_color_box]
+
+
+class TestCloudPollKeepsThePrintersSlot:
+    def test_a_slot_the_printer_reported_survives_a_cloud_poll(self):
+        printer = make_printer([box(0)])
+        printer.multi_color_box[0].set_slot_loaded(3)
+
+        printer.update_from_info_json(cloud_info([stale_box(0, 1)]))
+
+        assert loaded(printer) == [3]
+
+    def test_without_a_printer_report_the_cloud_value_is_used(self):
+        printer = make_printer([box(0)])
+
+        printer.update_from_info_json(cloud_info([stale_box(0, 1)]))
+
+        assert loaded(printer) == [1]
+
+    def test_the_next_printer_report_still_wins(self):
+        printer = make_printer([box(0)])
+        printer.multi_color_box[0].set_slot_loaded(3)
+        printer.update_from_info_json(cloud_info([stale_box(0, 1)]))
+
+        printer.multi_color_box[0].set_slot_loaded(0)
+
+        assert loaded(printer) == [0]
+
+    def test_each_box_keeps_its_own(self):
+        printer = make_printer([box(0), box(1)], machine_type=KOBRA_S1)
+        printer.multi_color_box[1].set_slot_loaded(2)
+
+        printer.update_from_info_json(cloud_info([stale_box(0, 1), stale_box(1, 0)], machine_type=KOBRA_S1))
+
+        assert loaded(printer) == [1, 2]
+
+    def test_other_cloud_fields_still_update(self):
+        printer = make_printer([box(0)])
+        printer.multi_color_box[0].set_slot_loaded(3)
+        refreshed = stale_box(0, 1)
+        refreshed["temp"] = 33
+
+        printer.update_from_info_json(cloud_info([refreshed]))
+
+        assert printer.multi_color_box[0].current_temperature == 33
+
+
+def extfilbox(printer, current_filament, machine_type=KOBRA_X):
+    printer.process_mqtt_update(
+        topic(machine_type, "extfilbox"),
+        message("extfilbox", "auto", "done", {"current_filament": current_filament}),
+    )
+
+
+class TestCurrentFilament:
+    @pytest.mark.parametrize(("reading", "slot"), [("0-3", 3), ("0-0", 0)])
+    def test_one_box_follows_the_printer(self, reading, slot):
+        printer = make_printer([box(0)])
+
+        extfilbox(printer, reading)
+
+        assert loaded(printer) == [slot]
+
+    @pytest.mark.parametrize("reading", ["", None, "0-9", "1-2", "x", "0-", "-1"])
+    def test_a_retract_or_unknown_reading_keeps_the_slot(self, reading):
+        printer = make_printer([box(0)])
+        printer.multi_color_box[0].set_slot_loaded(3)
+
+        extfilbox(printer, reading)
+
+        assert loaded(printer) == [3]
+
+    def test_with_two_boxes_nothing_is_guessed(self):
+        printer = make_printer([box(0), box(1)])
+
+        extfilbox(printer, "0-3")
+
+        assert loaded(printer) == [-1, -1]
+
+    def test_it_survives_the_next_cloud_poll(self):
+        printer = make_printer([box(0)])
+        extfilbox(printer, "0-3")
+
+        printer.update_from_info_json(cloud_info([stale_box(0, 1)]))
+
+        assert loaded(printer) == [3]
+
+
+class TestRedactForLog:
+    def test_printer_identifiers_are_redacted_wherever_they_are(self):
+        payload = {"type": "buried", "data": {"cn_code": "CN123", "nested": [{"machine_mac": "AA:BB"}], "ip": "10.0.0.2"}}
+
+        assert redact_for_log(payload) == {
+            "type": "buried",
+            "data": {"cn_code": "**REDACTED**", "nested": [{"machine_mac": "**REDACTED**"}], "ip": "**REDACTED**"},
+        }
+
+    @pytest.mark.parametrize("key", ["token", "casdoor_user_token", "rtc_token", "app_secret", "password"])
+    def test_credentials_are_redacted(self, key):
+        assert redact_for_log({key: "secret-value"}) == {key: "**REDACTED**"}
+
+    def test_ordinary_fields_and_empty_values_pass_through(self):
+        payload = {"progress": 42, "taskid": "131448158", "cn_code": "", "state": "printing", "slots": [1, 2]}
+
+        assert redact_for_log(payload) == payload
+
+    def test_the_input_is_not_changed(self):
+        payload = {"data": {"cn_code": "CN123"}}
+
+        redact_for_log(payload)
+
+        assert payload == {"data": {"cn_code": "CN123"}}