anycubic-cloud-api 0.4.28__tar.gz → 0.4.32__tar.gz

{anycubic_cloud_api-0.4.28/src/anycubic_cloud_api.egg-info → anycubic_cloud_api-0.4.32}/PKG-INFO

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

{anycubic_cloud_api-0.4.28 → anycubic_cloud_api-0.4.32}/pyproject.toml

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

{anycubic_cloud_api-0.4.28 → anycubic_cloud_api-0.4.32}/src/anycubic_cloud_api/api/functions.py

@@ -1807,8 +1807,12 @@ class AnycubicAPIFunctions(AnycubicAPIBase):
             return None
 
         if box_id >= 0:
+            # The box has to be named: the sender numbers unnamed boxes by
+            # position, so a lone {'status': 0} always stopped box 0 and a
+            # second ACE could never be stopped from here (#39).
             order_params: list[dict[str, Any]] | dict[str, Any] = {
                 'status': 0,
+                'box_id': box_id,
             }
         else:
             order_params = [

{anycubic_cloud_api-0.4.28 → anycubic_cloud_api-0.4.32}/src/anycubic_cloud_api/data_models/printer.py

@@ -150,6 +150,7 @@ class AnycubicPrinter:
         "_axis_position",
         "_multi_color_box",
         "_latest_project",
+        "_lan_last_job",
         "_fan_speed",
         "_aux_fan_speed",
         "_box_fan_level",
@@ -260,6 +261,11 @@ class AnycubicPrinter:
         self._set_multi_color_box(multi_color_box)
 
         self._latest_project: AnycubicProject | None = None
+        # The printer's own record of the job that finished last, from the
+        # local info report. Kept because the running job is cleared the moment
+        # the printer goes idle, and without this a finished LAN print could
+        # never be charged to its spool (hass-anycubic G1).
+        self._lan_last_job: dict[str, Any] | None = None
         # None until the printer says so. It used to default to 0, which
         # is indistinguishable from a fan that is genuinely stopped.
         self._fan_speed: int | None = None
@@ -445,6 +451,36 @@ class AnycubicPrinter:
 
         self._parameter.update_current_temps(hotbed, nozzle)
 
+    def _set_lan_last_job(self, data: dict[str, Any]) -> None:
+        if not data:
+            return
+
+        def as_int(value: Any) -> int | None:
+            try:
+                return int(value)
+            except (TypeError, ValueError):
+                return None
+
+        def as_float(value: Any) -> float | None:
+            try:
+                return float(value)
+            except (TypeError, ValueError):
+                return None
+
+        self._lan_last_job = {
+            'task_id': as_int(data.get('task_id')),
+            # Millimetres of filament the printer says it extruded.
+            'supplies_usage_mm': as_float(data.get('supplies_usage')),
+            'print_status': as_int(data.get('print_status')),
+            'state': data.get('state') if isinstance(data.get('state'), str) else None,
+            'filename': data.get('filename') if isinstance(data.get('filename'), str) else None,
+        }
+
+    @property
+    def lan_last_job(self) -> dict[str, Any] | None:
+        """The last finished job as the printer reported it locally, if any."""
+        return self._lan_last_job
+
     def _apply_lan_project(self, project: Any) -> None:
         """Track the running job from the printer's own report of it.
 
@@ -480,8 +516,19 @@ class AnycubicPrinter:
         if self._latest_project is None:
             return
 
+        # A Kobra X sends print_status 0 mid-print, and 0 is not a status.
+        # Raising on it threw away the whole info report -- temperatures,
+        # progress, layers -- 20 times in two minutes (#38). An unrecognised
+        # status now leaves the job's status as it was and applies the rest.
+        try:
+            print_status: AnycubicPrintStatus | None = AnycubicPrintStatus(
+                int(data.get('print_status'))  # type: ignore[arg-type]
+            )
+        except (TypeError, ValueError):
+            print_status = None
+
         self._latest_project.update_with_mqtt_print_status_data(
-            AnycubicPrintStatus(int(data.get('print_status') or 0)),
+            print_status,
             data,
             paused=data.get('pause'),
         )
@@ -1027,13 +1074,16 @@ class AnycubicPrinter:
     ) -> None:
         if action == 'query' and state == 'done':
             data = payload['data']
-            coords = data['coordinates']
-
-            self._axis_position = AnycubicAxisPosition(
-                x=coords['x'],
-                y=coords['y'],
-                z=coords['z'],
-            )
+            # A Kobra X answers the query without coordinates at all during a
+            # print. No reading is better than a raise that loses the report.
+            coords = data.get('coordinates')
+
+            if coords:
+                self._axis_position = AnycubicAxisPosition(
+                    x=coords['x'],
+                    y=coords['y'],
+                    z=coords['z'],
+                )
 
             # Nested payloads are only released once emptied, and anything left
             # behind raises AnycubicMQTTUnhandledData at the end of dispatch.
@@ -1499,9 +1549,9 @@ class AnycubicPrinter:
         data.get('model')
         self._apply_lan_project(data.get('project'))
 
-        # Whatever ran before this one. Nothing reads it yet, and the printer
-        # sends null for it far more often than not.
-        _drain(data.get('last_project'))
+        # The job that finished last. Null until one has, and then it stays --
+        # so a null here never clears what is already known.
+        self._set_lan_last_job(_drain(data.get('last_project')))
         _drain(data)
 
     def _process_mqtt_update_ai_settings(
@@ -2365,6 +2415,29 @@ class AnycubicPrinter:
 
         return None
 
+    @property
+    def secondary_multi_color_box_loaded_slot(self) -> int | None:
+        """Which slot is feeding on the second ACE, or None.
+
+        Mirrors primary_multi_color_box_loaded_slot. A printer with two boxes
+        reported this all along -- it was parsed and then had no accessor, so
+        the only way to know which slot the second unit was feeding from was
+        to not know (hass-anycubic #33).
+        """
+        box = self.secondary_multi_color_box
+
+        if not box:
+            return None
+
+        slot = box.loaded_slot
+
+        # -1 means nothing is loaded; surface that as unknown rather than a
+        # slot number that doesn't exist.
+        if slot is not None and slot >= 0:
+            return slot
+
+        return None
+
     @property
     def secondary_multi_color_box_current_temperature(self) -> int:
         if self.secondary_multi_color_box:

{anycubic_cloud_api-0.4.28 → anycubic_cloud_api-0.4.32}/src/anycubic_cloud_api/data_models/project.py

@@ -683,14 +683,17 @@ class AnycubicProject:
 
     def update_with_mqtt_print_status_data(
         self,
-        print_status: AnycubicPrintStatus,
+        # None when the printer sent a status that is not one: the job keeps
+        # the status it had, and everything else in the report still applies.
+        print_status: AnycubicPrintStatus | None,
         # Only read from, by key -- so a plain report dict off the wire is as
         # good as the wrapped form, and both reach here.
         mqtt_data: Mapping[str, Any] | None = None,
         paused: int | None = None,
         reason: str | None = None,
     ) -> None:
-        self._print_status = int(print_status)
+        if print_status is not None:
+            self._print_status = int(print_status)
 
         if paused is not None:
             self._set_pause(paused)

{anycubic_cloud_api-0.4.28 → anycubic_cloud_api-0.4.32/src/anycubic_cloud_api.egg-info}/PKG-INFO

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

{anycubic_cloud_api-0.4.28 → anycubic_cloud_api-0.4.32}/src/anycubic_cloud_api.egg-info/SOURCES.txt

@@ -54,4 +54,5 @@ tests/test_null_tolerant_parsing.py
 tests/test_partial_reports.py
 tests/test_printer_error_codes.py
 tests/test_project_null_status.py
-tests/test_regions.py
+tests/test_regions.py
+tests/test_secondary_ace.py

{anycubic_cloud_api-0.4.28 → anycubic_cloud_api-0.4.32}/tests/test_axis_position.py

@@ -68,6 +68,15 @@ class TestMqttDispatch:
 
         assert payload.is_empty, f"left behind: {payload.remaining_data}"
 
+    def test_a_reply_without_coordinates_is_harmless(self):
+        """A Kobra X answers the query with no coordinates mid-print (#38)."""
+        printer = self._printer()
+        payload = self._msg(data={})
+
+        printer.process_mqtt_update("a/b/c/d/e/f/g/axis/report", payload)
+
+        assert printer.axis_position is None
+
     def test_an_unexpected_action_is_reported(self):
         from anycubic_cloud_api import AnycubicMQTTUnknownUpdate
 

{anycubic_cloud_api-0.4.28 → anycubic_cloud_api-0.4.32}/tests/test_lan_reports.py

@@ -678,6 +678,7 @@ class TestTheRunningJob:
         assert printer.latest_project_print_in_progress is True
         assert printer.latest_project_print_is_paused is False
 
+
     def test_a_paused_job_reads_as_paused(self):
         printer = make_printer()
 
@@ -775,3 +776,81 @@ class TestTheFinishedJobBlock:
         apply(printer, self._report())
 
         assert printer.latest_project is None
+
+
+class TestAStatusThatIsNotOne:
+    """A Kobra X reports print_status 0 mid-print, which is not a status.
+
+    Raising on it discarded the whole info report -- temperatures, progress,
+    layers -- 20 times in two minutes (#38).
+    """
+
+    @pytest.mark.parametrize("status", [0, None, 8])
+    def test_the_rest_of_the_report_still_applies(self, status):
+        printer = make_printer()
+        job = deepcopy(LAN_JOB)
+        job["print_status"] = status
+        job["progress"] = 75
+
+        apply(printer, info_with_job(job))
+
+        assert printer.latest_project_progress_percentage == 75
+
+    def test_the_status_already_known_is_kept(self):
+        printer = make_printer()
+        apply(printer, info_with_job(LAN_JOB))
+        job = deepcopy(LAN_JOB)
+        job["print_status"] = 0
+
+        apply(printer, info_with_job(job))
+
+        assert printer.latest_project_print_in_progress is True
+
+
+class TestTheLastFinishedJob:
+    """hass-anycubic G1: over LAN the running job is cleared as soon as the
+    printer goes idle, so the finished job is only ever in `last_project`."""
+
+    FINISHED = {
+        "task_id": 119231778,
+        "filename": ".3mf_temp/0622-1002-Spectacular Wolt (1)_plate(01)_PLA_0.2_45s.gcode",
+        "progress": 100, "curr_layer": 5, "total_layers": 5, "print_time": 2,
+        "remain_time": 0, "supplies_usage": 65, "pause": 0, "state": "finished",
+        "print_status": 2, "print_speed_mode": 2, "project_type": 2,
+        "localtask": "aff63521-084c-4dfc-9cf7-d112c7159551",
+    }
+
+    def _idle_with_last(self, last):
+        report = info_with_job(None)
+        report["data"]["last_project"] = deepcopy(last)
+        return report
+
+    def test_it_is_kept(self):
+        printer = make_printer()
+        apply(printer, self._idle_with_last(self.FINISHED))
+
+        job = printer.lan_last_job
+        assert job["task_id"] == 119231778
+        assert job["supplies_usage_mm"] == 65.0
+        assert job["print_status"] == 2
+        assert job["state"] == "finished"
+
+    def test_a_later_null_does_not_forget_it(self):
+        printer = make_printer()
+        apply(printer, self._idle_with_last(self.FINISHED))
+        apply(printer, self._idle_with_last(None))
+
+        assert printer.lan_last_job["task_id"] == 119231778
+
+    def test_nothing_before_the_first_finish(self):
+        printer = make_printer()
+        apply(printer, info_with_job(None))
+
+        assert printer.lan_last_job is None
+
+    def test_the_report_is_still_fully_consumed(self):
+        printer = make_printer()
+        report = AnycubicConsumableData(self._idle_with_last(self.FINISHED))
+        printer.process_mqtt_update("a/b/c/d/e/f/g/info/report", report)
+
+        assert report.is_empty, report.remaining_data

anycubic_cloud_api-0.4.32/tests/test_secondary_ace.py

@@ -0,0 +1,111 @@
+"""The second ACE unit, which the library parsed and then hid.
+
+hass-anycubic #33: a Kobra S1 can take two ACE Pro units and a Kobra X up to
+four. The boxes are parsed into a list of whatever the printer reports, and
+connected_ace_units counts them correctly -- but only the first two have
+accessors, and until now the second had no way to report which slot was
+feeding.
+"""
+
+from unittest.mock import MagicMock
+
+import pytest
+
+from anycubic_cloud_api.data_models.printer import AnycubicPrinter
+
+
+def _box(box_id: int, loaded_slot: int = -1) -> dict:
+    return {
+        "id": box_id, "status": 1, "model_id": 40002, "auto_feed": 0,
+        "loaded_slot": loaded_slot, "temp": 25, "slots": [],
+    }
+
+
+def _printer(*boxes: dict) -> AnycubicPrinter:
+    return AnycubicPrinter(
+        api_parent=MagicMock(), machine_type=20025, machine_name="x", id=1,
+        ignore_init_errors=True, multi_color_box=list(boxes) or None,
+    )
+
+
+class TestHowManyBoxesAreSeen:
+    @pytest.mark.parametrize("count", [1, 2, 3, 4])
+    def test_every_reported_box_is_counted(self, count):
+        """Three and four are parsed even though only two are reachable --
+        so the count is honest about hardware the accessors cannot reach."""
+        printer = _printer(*[_box(i) for i in range(count)])
+
+        assert printer.connected_ace_units == count
+
+    def test_no_boxes_is_zero_not_an_error(self):
+        assert _printer().connected_ace_units == 0
+
+    @pytest.mark.parametrize("count", [3, 4])
+    def test_more_than_two_boxes_does_not_break_the_accessors(self, count):
+        """A four-unit printer must not raise; the extra boxes are merely
+        invisible until the entity scheme is indexed rather than named."""
+        printer = _printer(*[_box(i) for i in range(count)])
+
+        assert printer.primary_multi_color_box is not None
+        assert printer.secondary_multi_color_box is not None
+
+
+class TestTheSecondBoxCanNameItsLoadedSlot:
+    def test_it_reports_the_feeding_slot(self):
+        printer = _printer(_box(0, loaded_slot=0), _box(1, loaded_slot=2))
+
+        assert printer.primary_multi_color_box_loaded_slot == 0
+        assert printer.secondary_multi_color_box_loaded_slot == 2
+
+    def test_nothing_feeding_is_unknown_not_minus_one(self):
+        """-1 is the printer's way of saying nothing is loaded. Reporting it
+        as a slot number would put slot -1 on someone's dashboard."""
+        printer = _printer(_box(0), _box(1, loaded_slot=-1))
+
+        assert printer.secondary_multi_color_box_loaded_slot is None
+
+    def test_a_single_box_printer_has_no_second_slot(self):
+        printer = _printer(_box(0, loaded_slot=1))
+
+        assert printer.secondary_multi_color_box_loaded_slot is None
+
+    def test_no_ace_at_all_is_not_an_error(self):
+        assert _printer().secondary_multi_color_box_loaded_slot is None
+
+
+class TestStoppingTheDryer:
+    """hass-anycubic #39: stopping the second ACE's dryer did nothing.
+
+    The stop order named no box, and the sender numbers unnamed boxes by
+    position, so every single-box stop went to box 0.
+    """
+
+    async def _sent_boxes(self, **kwargs):
+        from unittest.mock import AsyncMock
+
+        from anycubic_cloud_api.anycubic_api import AnycubicAPI
+
+        api = AnycubicAPI(session=MagicMock(), cookie_jar=MagicMock())
+        api._send_anycubic_order = AsyncMock(return_value="msgid")
+        printer = _printer(_box(0), _box(1))
+
+        await api.multi_color_box_drying_stop(printer, **kwargs)
+
+        order = api._send_anycubic_order.await_args.kwargs["order_request"]
+        return order.order_data["multi_color_box"]
+
+    async def test_the_second_box_is_the_one_stopped(self):
+        boxes = await self._sent_boxes(box_id=1)
+
+        assert [box["id"] for box in boxes] == [1]
+        assert boxes[0]["drying_status"]["status"] == 0
+
+    async def test_the_first_box_is_still_stopped_by_name(self):
+        boxes = await self._sent_boxes(box_id=0)
+
+        assert [box["id"] for box in boxes] == [0]
+
+    async def test_no_box_named_stops_every_box(self):
+        boxes = await self._sent_boxes()
+
+        assert [box["id"] for box in boxes] == [0, 1]