pymammotion 0.5.11__tar.gz → 0.5.12__tar.gz

{pymammotion-0.5.11 → pymammotion-0.5.12}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: pymammotion
-Version: 0.5.11
+Version: 0.5.12
 Summary: 
 License: GPL-3.0
 Author: Michael Arthur

{pymammotion-0.5.11 → pymammotion-0.5.12}/pymammotion/data/state_manager.py

@@ -87,6 +87,7 @@ class StateManager:
         await self.on_status_callback(thing_status)
 
     async def device_event(self, device_event: ThingEventMessage) -> None:
+        """Sets MQTT event and calls callback."""
         self._device.mqtt_device_event = device_event
         await self.on_device_event_callback(device_event)
 
@@ -121,7 +122,7 @@ class StateManager:
             await self.status_callback.data_event(thing_status)
 
     async def on_device_event_callback(self, device_event: ThingEventMessage) -> None:
-        """Execute the status callback if it is set."""
+        """Executes the status callback if it is set."""
         if self.device_event_callback:
             await self.device_event_callback.data_event(device_event)
 

{pymammotion-0.5.11 → pymammotion-0.5.12}/pymammotion/http/http.py

@@ -29,6 +29,7 @@ class MammotionHTTP:
         return await self.login(email, password)
 
     async def get_all_error_codes(self) -> dict[str, ErrorInfo]:
+        """Retrieves and parses all error codes from the MAMMOTION API."""
         async with ClientSession(MAMMOTION_API_DOMAIN) as session:
             async with session.post(
                 "/user-server/v1/code/record/export-data",

{pymammotion-0.5.11 → pymammotion-0.5.12}/pymammotion/mammotion/commands/abstract_message.py

@@ -7,12 +7,13 @@ from pymammotion.utility.device_type import DeviceType
 
 class AbstractMessage:
     seqs = AtomicInteger(0)
-    user_account: int = 1
+    user_account: int
 
     @abstractmethod
     def get_device_name(self) -> str:
         """Get device name."""
 
+    @abstractmethod
     def get_device_product_key(self) -> str:
         """Get device name."""
 

{pymammotion-0.5.11 → pymammotion-0.5.12}/pymammotion/mammotion/commands/mammotion_command.py

@@ -5,6 +5,7 @@ from pymammotion.mammotion.commands.messages.network import MessageNetwork
 from pymammotion.mammotion.commands.messages.ota import MessageOta
 from pymammotion.mammotion.commands.messages.system import MessageSystem
 from pymammotion.mammotion.commands.messages.video import MessageVideo
+from pymammotion.utility.device_type import DeviceType
 from pymammotion.utility.movement import get_percent, transform_both_speeds
 
 
@@ -22,6 +23,13 @@ class MammotionCommand(
         """Get device name."""
         return self._device_name
 
+    def read_write_device(self, rw_id: int, context: int, rw: int):
+        if (
+            rw_id == 6 or rw_id == 3 or rw_id == 7 or rw_id == 8 or rw_id == 10 or rw_id == 11
+        ) and DeviceType.is_luba_pro(self.get_device_name()):
+            return self.allpowerfull_rw_adapter_x3(rw_id, context, rw)
+        return self.allpowerfull_rw(rw_id, context, rw)
+
     def get_device_product_key(self) -> str:
         return self._product_key
 

{pymammotion-0.5.11 → pymammotion-0.5.12}/pymammotion/mammotion/commands/messages/navigation.py

@@ -50,7 +50,7 @@ class MessageNavigation(AbstractMessage, ABC):
 
     def allpowerfull_rw_adapter_x3(self, rw_id: int, context: int, rw: int) -> bytes:
         build = MctlNav(nav_sys_param_cmd=NavSysParamMsg(id=rw_id, context=context, rw=rw))
-        logger.debug(f"Send command--9 general read and write command id={id}, context={context}, rw={rw}")
+        logger.debug(f"Send command--x3 general read and write command id={rw_id}, context={context}, rw={rw}")
         return self.send_order_msg_nav(build)
 
     def along_border(self) -> bytes:

{pymammotion-0.5.11 → pymammotion-0.5.12}/pymammotion/mammotion/commands/messages/ota.py

@@ -1,9 +1,12 @@
 # === sendOrderMsg_Ota ===
 from abc import ABC
+import logging
 
 from pymammotion.mammotion.commands.abstract_message import AbstractMessage
 from pymammotion.proto import GetInfoReq, InfoType, LubaMsg, MctlOta, MsgAttr, MsgCmdType, MsgDevice
 
+_LOGGER = logging.getLogger(__name__)
+
 
 class MessageOta(AbstractMessage, ABC):
     """Message OTA class."""
@@ -25,11 +28,11 @@ class MessageOta(AbstractMessage, ABC):
     def get_device_ota_info(self, log_type: int):
         todev_get_info_req = MctlOta(todev_get_info_req=GetInfoReq(type=InfoType.IT_OTA))
 
-        print("===Send command to get upgrade details===logType:" + str(log_type))
+        _LOGGER.debug("===Send command to get upgrade details===logType:" + str(log_type))
         return self.send_order_msg_ota(todev_get_info_req)
 
     def get_device_info_new(self) -> bytes:
         """New device call for OTA upgrade information."""
         todev_get_info_req = MctlOta(todev_get_info_req=GetInfoReq(type=InfoType.IT_BASE))
-        print("Send to get OTA upgrade information", "Get device information")
+        _LOGGER.debug("Send to get OTA upgrade information", "Get device information")
         return self.send_order_msg_ota(todev_get_info_req)

{pymammotion-0.5.11 → pymammotion-0.5.12}/pymammotion/mammotion/commands/messages/system.py

@@ -5,7 +5,6 @@ import time
 
 from pymammotion import logger
 from pymammotion.mammotion.commands.abstract_message import AbstractMessage
-from pymammotion.mammotion.commands.messages.navigation import MessageNavigation
 from pymammotion.proto import (
     DeviceProductTypeInfoT,
     LoraCfgReq,
@@ -23,12 +22,9 @@ from pymammotion.proto import (
     SysSetDateTime,
     TimeCtrlLight,
 )
-from pymammotion.utility.device_type import DeviceType
 
 
 class MessageSystem(AbstractMessage, ABC):
-    messageNavigation: MessageNavigation = MessageNavigation()
-
     def send_order_msg_sys(self, sys) -> bytes:
         luba_msg = LubaMsg(
             msgtype=MsgCmdType.EMBED_SYS,
@@ -119,10 +115,6 @@ class MessageSystem(AbstractMessage, ABC):
         return self.send_order_msg_sys(MctlSys(todev_lora_cfg_req=LoraCfgReq(op=op, cfg=cgf)))
 
     def allpowerfull_rw(self, rw_id: int, context: int, rw: int) -> bytes:
-        if (
-            rw_id == 6 or rw_id == 3 or rw_id == 7 or rw_id == 8 or rw_id == 10 or rw_id == 11
-        ) and DeviceType.is_luba_pro(self.get_device_name()):
-            return self.messageNavigation.allpowerfull_rw_adapter_x3(rw_id, context, rw)
         build = MctlSys(bidire_comm_cmd=SysCommCmd(id=rw_id, context=context, rw=rw))
         logger.debug(f"Send command - 9 general read and write command id={rw_id}, context={context}, rw={rw}")
         return self.send_order_msg_sys(build)

{pymammotion-0.5.11 → pymammotion-0.5.12}/pymammotion/mammotion/devices/mammotion.py

@@ -140,8 +140,10 @@ class MammotionDeviceManager:
             exists.replace_ble(mammotion_device.ble())
 
     def get_device(self, mammotion_device_name: str) -> MammotionMixedDeviceManager:
-        """Get a device."""
-        return self.devices.get(mammotion_device_name)
+        if device := self.devices[mammotion_device_name]:
+            return device
+        else:
+            raise KeyError
 
     async def remove_device(self, name: str) -> None:
         """Remove a device."""

{pymammotion-0.5.11 → pymammotion-0.5.12}/pymammotion/mammotion/devices/mammotion_cloud.py

@@ -52,6 +52,7 @@ class MammotionCloud:
         self._mqtt_client.on_ready = self.on_ready
 
     async def on_ready(self) -> None:
+        """Starts processing the queue and emits the ready event."""
         loop = asyncio.get_event_loop()
         loop.create_task(self.process_queue())
         await self.on_ready_event.data_event(None)
@@ -116,7 +117,16 @@ class MammotionCloud:
         await self._parse_mqtt_response(topic, payload)
 
     async def _parse_mqtt_response(self, topic: str, payload: dict) -> None:
-        """Parse the MQTT response."""
+        """Parse and handle MQTT responses based on the topic.
+        
+        This function processes different types of MQTT messages received from various
+        topics. It logs debug information and calls appropriate callback methods for
+        each event type.
+        
+        Args:
+            topic (str): The MQTT topic from which the message was received.
+            payload (dict): The payload data of the MQTT message.
+        """
         if topic.endswith("/app/down/thing/events"):
             _LOGGER.debug("Thing event received")
             event = ThingEventMessage.from_dicts(payload)
@@ -323,11 +333,23 @@ class MammotionBaseCloudDevice(MammotionBaseDevice):
         await self.state_manager.status(status)
 
     async def _parse_device_event_for_device(self, status: ThingStatusMessage) -> None:
+        """Process device event if it matches the device's IoT ID."""
         if status.params.iotId != self.iot_id:
             return
         await self.state_manager.device_event(status)
 
     async def _parse_message_for_device(self, event: ThingEventMessage) -> None:
+        """Parses a message received from a device and updates internal state.
+        
+        This function processes an incoming `ThingEventMessage`, checks if the message
+        is intended for this device, decodes the binary data, and updates raw data. It
+        then attempts to parse the binary data into a `LubaMsg`. If parsing fails, it
+        logs the exception. The function also handles setting the device product key if
+        not already set and processes specific sub-messages based on their types.
+        
+        Args:
+            event (ThingEventMessage): The event message received from the device.
+        """
         params = event.params
         new_msg = LubaMsg()
         if event.params.iotId != self.iot_id:

{pymammotion-0.5.11 → pymammotion-0.5.12}/pymammotion/mqtt/mammotion_mqtt.py

@@ -180,7 +180,7 @@ class MammotionMQTT:
             asyncio.wrap_future(future, loop=self.loop)
 
     def _thing_on_connect(self, session_flag, rc, user_data) -> None:
-        """Is called on thing connect."""
+        """Handle connection event and execute callback if set."""
         self.is_connected = True
         if self.on_connected is not None:
             future = asyncio.run_coroutine_threadsafe(self.on_connected(), self.loop)

{pymammotion-0.5.11 → pymammotion-0.5.12}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "poetry.core.masonry.api"
 
 [project]
 name        = "pymammotion"
-version     = "0.5.11"
+version     = "0.5.12"
 license     = "GPL-3.0"
 description = ""
 readme      = "README.md"
@@ -66,7 +66,7 @@ autotyping = "^24.3.0"
 ipython = "^9.0.2"
 
 [tool.bumpver]
-current_version = "0.5.11"
+current_version = "0.5.12"
 version_pattern = "MAJOR.MINOR.PATCH"
 commit_message  = "Bump version {old_version} -> {new_version}"
 commit          = true