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

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

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

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

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

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

@@ -64,6 +64,20 @@ _PRINT_PROGRESS_KEYS = (
     'supplies_usage',
 )
 
+# The steps of a filament change, as a Kobra X with an ACE 2 Pro reports
+# them (#33). The ACE unfeed is the mirror of the feed, not yet seen.
+_FILAMENT_CHANGE_STATES = frozenset({
+    'extfilbox_filament_feeding',
+    'extfilbox_filament_unfeeding',
+    'ace_filament_feeding',
+    'ace_filament_unfeeding',
+    'nozzle_purging',
+})
+
+# Printers with a feeder of their own, which shares the box list with any
+# ACE fitted: the Kobra X.
+_PRINTERS_WITH_OWN_FEEDER = frozenset({20030})
+
 # How a printer words a refused order when it gives no code.
 _REFUSED_STATES = frozenset({'failed', 'fail', 'error', 'refused'})
 
@@ -1317,13 +1331,23 @@ class AnycubicPrinter:
             data.get('settings')
 
             if 'channel_no' in data:
-                self._apply_active_channel(data['channel_no'])
+                self._apply_active_channel(data['channel_no'], data.get('unit_no'))
 
             # A Kobra X reports progress this way between info reports, with
             # no task id. It was logged as unhandled and dropped (#34).
             if any(key in data for key in _PRINT_PROGRESS_KEYS):
                 self._apply_print_progress(project_id, data)
             return
+        elif action == 'start' and state in _FILAMENT_CHANGE_STATES:
+            # Each step of a filament change, naming the channel (and, for an
+            # ACE, the unit). Only a feed says what is now loaded (#33).
+            data = payload.get('data') or {}
+            # Read on every step, so the ones that change nothing are not
+            # reported as unhandled.
+            channel_no, unit_no = data.get('channel_no'), data.get('unit_no')
+            if state.endswith('_filament_feeding'):
+                self._apply_active_channel(channel_no, unit_no)
+            return
         elif action in ['start', 'stop'] and state in ['failed']:
             err_msg = payload.get('msg')
             self._is_printing = 1
@@ -1336,31 +1360,37 @@ class AnycubicPrinter:
         else:
             raise AnycubicMQTTUnknownUpdate(ErrorsMQTTUpdate.job_status)
 
-    def _apply_active_channel(self, channel_no: Any) -> None:
+    def _apply_active_channel(self, channel_no: Any, unit_no: Any = None) -> None:
         """Follow the filament channel the printer says it is printing from.
 
         A Kobra X reports each filament change as a print update carrying
-        only ``channel_no``, and stops sending the ACE's own ``loaded_slot``
-        after the first few changes of a print -- which is why the loaded
-        slot froze for the rest of the job (#34). The channel is numbered
-        from 1 across every box in order, so channel 5 on a printer whose
-        first box has four slots is the first slot of the second box.
+        ``channel_no``, and stops sending the box's own ``loaded_slot`` after
+        the first few changes of a print, which is why the loaded slot froze
+        (#34). Each box numbers its channels from 1; an ACE adds ``unit_no``
+        and the printer's own feeder sends none (#33, Kobra X + ACE 2 Pro).
+
+        With one box the channel can only mean that box. With several, an
+        ACE's ``unit_no`` picks it on a printer whose boxes are all ACEs.
+        On a Kobra X with an ACE, which list entry is the printer's own
+        feeder is not yet confirmed, so nothing is guessed there: a wrong
+        slot is worse than a stale one.
         """
         channel = as_int(channel_no, 0)
+        boxes = self._multi_color_box
 
-        if channel < 1 or not self._multi_color_box:
+        if channel < 1 or not boxes:
             return
 
-        index = channel - 1
-
-        for box in self._multi_color_box:
-            slot_count = len(box.slots)
-
-            if index < slot_count:
-                box.set_slot_loaded(index)
+        if len(boxes) == 1:
+            box = boxes[0]
+        else:
+            unit = as_int(unit_no, 0)
+            if unit < 1 or unit > len(boxes) or self._machine_type in _PRINTERS_WITH_OWN_FEEDER:
                 return
+            box = boxes[unit - 1]
 
-            index -= slot_count
+        if channel <= len(box.slots):
+            box.set_slot_loaded(channel - 1)
 
     def _apply_print_progress(
         self,
@@ -1466,8 +1496,12 @@ class AnycubicPrinter:
                     continue
 
                 assert self._multi_color_box
-                self._multi_color_box[box_id].set_current_temperature(box['temp'])
-                self._multi_color_box[box_id].set_drying_status(box['drying_status'])
+                # An ACE 2 Pro's periodic drying report carries no `temp`, and
+                # reading it raised every six minutes, so drying never updated
+                # (#33). Keep the last reading rather than inventing one.
+                if 'temp' in box:
+                    self._multi_color_box[box_id].set_current_temperature(box['temp'])
+                self._multi_color_box[box_id].set_drying_status(box.get('drying_status'))
             return
         elif action == 'setDry' and self._report_refused_drying(state, payload):
             return

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

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

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

@@ -47,6 +47,7 @@ tests/test_auth_mode_fallback.py
 tests/test_axis_position.py
 tests/test_endpoint_urls.py
 tests/test_exchange_rate_limit.py
+tests/test_filament_change_0435.py
 tests/test_lan_client.py
 tests/test_lan_commands.py
 tests/test_lan_handshake.py

anycubic_cloud_api-0.4.35/tests/test_filament_change_0435.py

@@ -0,0 +1,133 @@
+"""Filament-change reports and the ACE 2 Pro's drying report (0.4.35).
+
+From a Kobra X with an ACE 2 Pro (#33). Each step of a filament change
+arrives as a print ``start`` naming ``channel_no``, counted from 1 within
+its box, plus ``unit_no`` when the feed comes from an ACE. These were
+dropped as unhandled. The ACE 2 Pro's periodic drying report has no
+``temp``, and reading it raised every six minutes.
+"""
+
+from unittest.mock import MagicMock
+
+import pytest
+
+from anycubic_cloud_api.data_models.consumable import AnycubicConsumableData
+from anycubic_cloud_api.data_models.printer import AnycubicPrinter
+
+KOBRA_X = 20030
+KOBRA_S1 = 20025
+
+
+def slot(index):
+    return {"index": index, "sku": "", "type": "PLA", "color": [1, 2, 3], "status": 5, "edit_status": 1}
+
+
+def box(box_id, slots=4):
+    return {"id": box_id, "loaded_slot": -1, "temp": 21, "slots": [slot(i) for i in range(slots)]}
+
+
+def make_printer(boxes, machine_type=KOBRA_X):
+    return AnycubicPrinter(
+        api_parent=MagicMock(),
+        machine_type=machine_type,
+        machine_name="Printer",
+        id=1,
+        multi_color_box=boxes,
+        ignore_init_errors=True,
+    )
+
+
+def message(msg_type, action, state, data):
+    return AnycubicConsumableData({
+        "type": msg_type, "action": action, "state": state,
+        "code": 200, "msg": "done", "msgid": "m", "timestamp": 1, "data": data,
+    })
+
+
+def topic(machine_type, kind):
+    return f"anycubic/anycubicCloud/v1/printer/public/{machine_type}/key/{kind}/report"
+
+
+def feed(printer, state, channel_no, unit_no=None, machine_type=KOBRA_X):
+    data = {"channel_no": channel_no, "taskid": "t"}
+    if unit_no is not None:
+        data["unit_no"] = unit_no
+    printer.process_mqtt_update(topic(machine_type, "print"), message("print", "start", state, data))
+
+
+def loaded(printer):
+    return [b.loaded_slot for b in printer.multi_color_box]
+
+
+class TestFilamentChange:
+    @pytest.mark.parametrize(("state", "unit_no"), [
+        ("extfilbox_filament_feeding", None),
+        ("ace_filament_feeding", 1),
+    ])
+    def test_one_box_follows_the_feed(self, state, unit_no):
+        printer = make_printer([box(0)])
+
+        feed(printer, state, 3, unit_no)
+
+        assert loaded(printer) == [2]
+
+    @pytest.mark.parametrize("state", [
+        "extfilbox_filament_unfeeding", "ace_filament_unfeeding", "nozzle_purging",
+    ])
+    def test_other_steps_are_read_but_change_nothing(self, state):
+        """Consumed, so not logged as unhandled; only a feed says what is loaded."""
+        printer = make_printer([box(0)])
+        printer.multi_color_box[0].set_slot_loaded(1)
+
+        feed(printer, state, 3, 1)
+
+        assert loaded(printer) == [1]
+
+    @pytest.mark.parametrize(("unit_no", "expected"), [(1, [1, -1]), (2, [-1, 1])])
+    def test_an_ace_unit_picks_its_box_on_a_printer_of_aces(self, unit_no, expected):
+        """A Kobra S1 has no feeder of its own: unit 1 is the first ACE."""
+        printer = make_printer([box(0), box(1)], machine_type=KOBRA_S1)
+
+        feed(printer, "ace_filament_feeding", 2, unit_no, machine_type=KOBRA_S1)
+
+        assert loaded(printer) == expected
+
+    @pytest.mark.parametrize(("state", "unit_no"), [
+        ("extfilbox_filament_feeding", None),
+        ("ace_filament_feeding", 1),
+    ])
+    def test_a_kobra_x_with_an_ace_guesses_nothing(self, state, unit_no):
+        """Which list entry is the Kobra X's own feeder is unconfirmed (#33)."""
+        printer = make_printer([box(0), box(1)])
+
+        feed(printer, state, 1, unit_no)
+
+        assert loaded(printer) == [-1, -1]
+
+    @pytest.mark.parametrize(("channel_no", "unit_no"), [(5, 1), (0, 1), (2, 3), ("x", 1), (2, None)])
+    def test_a_channel_or_unit_that_fits_no_box_changes_nothing(self, channel_no, unit_no):
+        printer = make_printer([box(0), box(1)], machine_type=KOBRA_S1)
+
+        feed(printer, "ace_filament_feeding", channel_no, unit_no, machine_type=KOBRA_S1)
+
+        assert loaded(printer) == [-1, -1]
+
+
+class TestAce2ProDryingReport:
+    REPORT = {"multi_color_box": [{
+        "drying_status": {"duration": 14400, "humidity": 28, "remain_time": 162, "status": 1, "target_temp": 50},
+        "id": 0,
+    }]}
+
+    def test_a_report_without_temp_still_updates_drying(self):
+        printer = make_printer([box(0)])
+
+        printer.process_mqtt_update(
+            topic(KOBRA_X, "multiColorBox"),
+            message("multiColorBox", "autoUpdateDryStatus", "success", self.REPORT),
+        )
+
+        ace = printer.multi_color_box[0]
+        assert ace.drying_status.is_drying
+        assert ace.drying_status.target_temperature == 50
+        assert ace.current_temperature == 21  # the last reading is kept

{anycubic_cloud_api-0.4.34 → anycubic_cloud_api-0.4.35}/tests/test_print_reports_0434.py

@@ -90,13 +90,18 @@ class TestActiveChannel:
 
         assert printer.primary_multi_color_box_loaded_slot == slot_index
 
-    def test_channels_beyond_the_first_box_land_in_the_next(self):
-        """Channel 5 with four slots in the first box is the second box's first."""
+    @pytest.mark.parametrize("channel_no", [1, 5])
+    def test_with_two_boxes_and_no_unit_nothing_is_guessed(self, channel_no):
+        """Channels are numbered per box (#33), so without a unit the box is unknown.
+
+        0.4.34 counted across boxes and put channel 5 in the second box.
+        """
         printer = make_printer([box(0), box(1)])
+        before = [b.loaded_slot for b in printer.multi_color_box]
 
-        self._channel(printer, 5)
+        self._channel(printer, channel_no)
 
-        assert printer.secondary_multi_color_box_loaded_slot == 0
+        assert [b.loaded_slot for b in printer.multi_color_box] == before
 
     @pytest.mark.parametrize("channel_no", [0, -1, 9, None, "x"])
     def test_a_channel_with_no_slot_changes_nothing(self, channel_no):