pymammotion 0.4.0a2__py3-none-any.whl → 0.5.51__py3-none-any.whl

pymammotion/mammotion/devices/rtk_manager.py

@@ -0,0 +1,122 @@
+"""RTK Device Manager - manages RTK devices with cloud and BLE connectivity."""
+
+from typing import override
+
+from bleak import BLEDevice
+
+from pymammotion.aliyun.cloud_gateway import CloudIOTGateway
+from pymammotion.aliyun.model.dev_by_account_response import Device
+from pymammotion.data.model.device import RTKDevice
+from pymammotion.data.model.enums import ConnectionPreference
+from pymammotion.mammotion.devices.mammotion_cloud import MammotionCloud
+from pymammotion.mammotion.devices.managers.managers import AbstractDeviceManager
+from pymammotion.mammotion.devices.rtk_ble import MammotionRTKBLEDevice
+from pymammotion.mammotion.devices.rtk_cloud import MammotionRTKCloudDevice
+
+
+class MammotionRTKDeviceManager(AbstractDeviceManager):
+    """Manages an RTK device with both cloud and BLE connectivity options."""
+
+    def __init__(
+        self,
+        name: str,
+        iot_id: str,
+        cloud_client: CloudIOTGateway,
+        cloud_device: Device,
+        ble_device: BLEDevice | None = None,
+        mqtt: MammotionCloud | None = None,
+        preference: ConnectionPreference = ConnectionPreference.WIFI,
+    ) -> None:
+        """Initialize RTK device manager."""
+        super().__init__(name, iot_id, cloud_client, cloud_device, preference)
+        self._ble_device: MammotionRTKBLEDevice | None = None
+        self._cloud_device: MammotionRTKCloudDevice | None = None
+        self.name = name
+        self.iot_id = iot_id
+        self.cloud_client = cloud_client
+        self._device: Device = cloud_device
+        self.mammotion_http = cloud_client.mammotion_http
+        self.preference = preference
+
+        # Initialize RTK state
+        self._rtk_state = RTKDevice(
+            name=name,
+            iot_id=iot_id,
+            product_key=cloud_device.product_key,
+        )
+
+        # Add connection types if provided
+        if ble_device:
+            self.add_ble(ble_device)
+        if mqtt:
+            self.add_cloud(mqtt)
+
+    @property
+    def state(self) -> RTKDevice:
+        """Return the RTK device state."""
+        return self._rtk_state
+
+    @state.setter
+    def state(self, value: RTKDevice) -> None:
+        """Set the RTK device state."""
+        self._rtk_state = value
+
+    @property
+    def ble(self) -> MammotionRTKBLEDevice | None:
+        """Return BLE device interface."""
+        return self._ble_device
+
+    @property
+    def cloud(self) -> MammotionRTKCloudDevice | None:
+        """Return cloud device interface."""
+        return self._cloud_device
+
+    def has_queued_commands(self) -> bool:
+        """Check if there are queued commands."""
+        if self.cloud and self.preference == ConnectionPreference.WIFI:
+            return not self.cloud.mqtt.command_queue.empty()
+        elif self.ble:
+            return not self.ble.command_queue.empty()
+        return False
+
+    def add_ble(self, ble_device: BLEDevice) -> MammotionRTKBLEDevice:
+        """Add BLE device."""
+        self._ble_device = MammotionRTKBLEDevice(
+            cloud_device=self._device, rtk_state=self._rtk_state, device=ble_device
+        )
+        return self._ble_device
+
+    @override
+    def add_cloud(self, mqtt: MammotionCloud) -> MammotionRTKCloudDevice:
+        """Add cloud device."""
+        self._cloud_device = MammotionRTKCloudDevice(mqtt, cloud_device=self._device, rtk_state=self._rtk_state)
+        return self._cloud_device
+
+    def replace_cloud(self, cloud_device: MammotionRTKCloudDevice) -> None:
+        """Replace cloud device."""
+        self._cloud_device = cloud_device
+
+    def remove_cloud(self) -> None:
+        """Remove cloud device."""
+        self._cloud_device = None
+
+    def replace_ble(self, ble_device: MammotionRTKBLEDevice) -> None:
+        """Replace BLE device."""
+        self._ble_device = ble_device
+
+    def remove_ble(self) -> None:
+        """Remove BLE device."""
+        self._ble_device = None
+
+    def replace_mqtt(self, mqtt: MammotionCloud) -> None:
+        """Replace MQTT connection."""
+        device = self._cloud_device.device
+        self._cloud_device = MammotionRTKCloudDevice(mqtt, cloud_device=device, rtk_state=self._rtk_state)
+
+    def has_cloud(self) -> bool:
+        """Check if cloud connection is available."""
+        return self._cloud_device is not None
+
+    def has_ble(self) -> bool:
+        """Check if BLE connection is available."""
+        return self._ble_device is not None

pymammotion/mqtt/__init__.py

@@ -1,5 +1,6 @@
 """Package for MammotionMQTT."""
 
+from .aliyun_mqtt import AliyunMQTT
 from .mammotion_mqtt import MammotionMQTT
 
-__all__ = ["MammotionMQTT"]
+__all__ = ["AliyunMQTT", "MammotionMQTT"]

pymammotion/mqtt/aliyun_mqtt.py

@@ -0,0 +1,232 @@
+"""MammotionMQTT."""
+
+import asyncio
+import base64
+from collections.abc import Awaitable, Callable
+import hashlib
+import hmac
+import json
+import logging
+from logging import getLogger
+
+import betterproto2
+from paho.mqtt.client import MQTTMessage
+
+from pymammotion.aliyun.cloud_gateway import CloudIOTGateway
+from pymammotion.data.mqtt.event import ThingEventMessage
+from pymammotion.data.mqtt.properties import ThingPropertiesMessage
+from pymammotion.data.mqtt.status import ThingStatusMessage
+from pymammotion.mqtt.linkkit.linkkit import LinkKit
+from pymammotion.proto import LubaMsg
+
+logger = getLogger(__name__)
+
+
+class AliyunMQTT:
+    """MQTT client for pymammotion."""
+
+    def __init__(
+        self,
+        region_id: str,
+        product_key: str,
+        device_name: str,
+        device_secret: str,
+        iot_token: str,
+        cloud_client: CloudIOTGateway,
+        client_id: str | None = None,
+    ) -> None:
+        """Create instance of MammotionMQTT."""
+        super().__init__()
+        self._cloud_client = cloud_client
+        self.is_connected = False
+        self.is_ready = False
+        self.on_connected: Callable[[], Awaitable[None]] | None = None
+        self.on_ready: Callable[[], Awaitable[None]] | None = None
+        self.on_error: Callable[[str], Awaitable[None]] | None = None
+        self.on_disconnected: Callable[[], Awaitable[None]] | None = None
+        self.on_message: Callable[[str, str, str], Awaitable[None]] | None = None
+
+        self._product_key = product_key
+        self._device_name = device_name
+        self._device_secret = device_secret
+        self._iot_token = iot_token
+        self._mqtt_username = f"{device_name}&{product_key}"
+        # linkkit provides the correct MQTT service for all of this and uses paho under the hood
+        if client_id is None:
+            client_id = f"python-{device_name}"
+        self._mqtt_client_id = f"{client_id}|securemode=2,signmethod=hmacsha1|"
+        sign_content = f"clientId{client_id}deviceName{device_name}productKey{product_key}"
+        self._mqtt_password = hmac.new(
+            device_secret.encode("utf-8"), sign_content.encode("utf-8"), hashlib.sha1
+        ).hexdigest()
+
+        self._client_id = client_id
+        self.loop = asyncio.get_running_loop()
+
+        self._linkkit_client = LinkKit(
+            region_id,
+            product_key,
+            device_name,
+            device_secret,
+            auth_type="",
+            client_id=client_id,
+            password=self._mqtt_password,
+            username=self._mqtt_username,
+        )
+
+        self._linkkit_client.enable_logger(level=logging.ERROR)
+        self._linkkit_client.on_connect = self._thing_on_connect
+        self._linkkit_client.on_disconnect = self._on_disconnect
+        self._linkkit_client.on_thing_enable = self._thing_on_thing_enable
+        self._linkkit_client.on_topic_message = self._thing_on_topic_message
+        self._mqtt_host = f"{self._product_key}.iot-as-mqtt.{region_id}.aliyuncs.com"
+
+    def connect_async(self) -> None:
+        """Connect async to MQTT Server."""
+        logger.info("Connecting...")
+        if self._linkkit_client.check_state() is LinkKit.LinkKitState.INITIALIZED:
+            self._linkkit_client.thing_setup()
+        self._linkkit_client.connect_async()
+
+    def disconnect(self) -> None:
+        """Disconnect from MQTT Server."""
+        logger.info("Disconnecting...")
+
+        self._linkkit_client.disconnect()
+
+    def _thing_on_thing_enable(self, user_data) -> None:
+        """Is called when Thing is enabled."""
+        logger.debug("on_thing_enable")
+        self.is_connected = True
+        # logger.debug('subscribe_topic, topic:%s' % echo_topic)
+        # self._linkkit_client.subscribe_topic(echo_topic, 0)
+        self._linkkit_client.subscribe_topic(
+            f"/sys/{self._product_key}/{self._device_name}/app/down/account/bind_reply"
+        )
+        self._linkkit_client.subscribe_topic(
+            f"/sys/{self._product_key}/{self._device_name}/app/down/thing/event/property/post_reply"
+        )
+        self._linkkit_client.subscribe_topic(
+            f"/sys/{self._product_key}/{self._device_name}/app/down/thing/wifi/status/notify"
+        )
+        self._linkkit_client.subscribe_topic(
+            f"/sys/{self._product_key}/{self._device_name}/app/down/thing/wifi/connect/event/notify"
+        )
+        self._linkkit_client.subscribe_topic(
+            f"/sys/{self._product_key}/{self._device_name}/app/down/_thing/event/notify"
+        )
+        self._linkkit_client.subscribe_topic(f"/sys/{self._product_key}/{self._device_name}/app/down/thing/events")
+        self._linkkit_client.subscribe_topic(f"/sys/{self._product_key}/{self._device_name}/app/down/thing/status")
+        self._linkkit_client.subscribe_topic(f"/sys/{self._product_key}/{self._device_name}/app/down/thing/properties")
+        self._linkkit_client.subscribe_topic(
+            f"/sys/{self._product_key}/{self._device_name}/app/down/thing/model/down_raw"
+        )
+
+        self._linkkit_client.publish_topic(
+            f"/sys/{self._product_key}/{self._device_name}/app/up/account/bind",
+            json.dumps(
+                {
+                    "id": "msgid1",
+                    "version": "1.0",
+                    "request": {"clientId": self._mqtt_username},
+                    "params": {"iotToken": self._iot_token},
+                }
+            ),
+        )
+
+        if self.on_ready:
+            self.is_ready = True
+            future = asyncio.run_coroutine_threadsafe(self.on_ready(), self.loop)
+            asyncio.wrap_future(future, loop=self.loop)
+
+    def unsubscribe(self) -> None:
+        self._linkkit_client.unsubscribe_topic(
+            f"/sys/{self._product_key}/{self._device_name}/app/down/account/bind_reply"
+        )
+        self._linkkit_client.unsubscribe_topic(
+            f"/sys/{self._product_key}/{self._device_name}/app/down/thing/event/property/post_reply"
+        )
+        self._linkkit_client.unsubscribe_topic(
+            f"/sys/{self._product_key}/{self._device_name}/app/down/thing/wifi/status/notify"
+        )
+        self._linkkit_client.unsubscribe_topic(
+            f"/sys/{self._product_key}/{self._device_name}/app/down/thing/wifi/connect/event/notify"
+        )
+        self._linkkit_client.unsubscribe_topic(
+            f"/sys/{self._product_key}/{self._device_name}/app/down/_thing/event/notify"
+        )
+        self._linkkit_client.unsubscribe_topic(f"/sys/{self._product_key}/{self._device_name}/app/down/thing/events")
+        self._linkkit_client.unsubscribe_topic(f"/sys/{self._product_key}/{self._device_name}/app/down/thing/status")
+        self._linkkit_client.unsubscribe_topic(
+            f"/sys/{self._product_key}/{self._device_name}/app/down/thing/properties"
+        )
+        self._linkkit_client.unsubscribe_topic(
+            f"/sys/{self._product_key}/{self._device_name}/app/down/thing/model/down_raw"
+        )
+
+    def _thing_on_topic_message(self, topic: str, payload: str, qos, user_data) -> None:
+        """Is called when thing topic comes in."""
+        logger.debug(
+            "on_topic_message, receive message, topic:%s, payload:%s, qos:%d",
+            topic,
+            payload,
+            qos,
+        )
+        json_payload = json.loads(payload)
+        iot_id = json_payload.get("params", {}).get("iotId", "")
+        if iot_id != "" and self.on_message is not None:
+            future = asyncio.run_coroutine_threadsafe(self.on_message(topic, payload, iot_id), self.loop)
+            asyncio.wrap_future(future, loop=self.loop)
+
+    def _thing_on_connect(self, session_flag, rc, user_data) -> None:
+        """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)
+            asyncio.wrap_future(future, loop=self.loop)
+
+        logger.debug("on_connect, session_flag:%d, rc:%d", session_flag, rc)
+
+    def _on_disconnect(self, _client, _userdata) -> None:
+        """Is called on disconnect."""
+        if self._linkkit_client.check_state() is LinkKit.LinkKitState.DISCONNECTED:
+            logger.info("Disconnected")
+            self.is_connected = False
+            self.is_ready = False
+            if self.on_disconnected:
+                future = asyncio.run_coroutine_threadsafe(self.on_disconnected(), self.loop)
+                asyncio.wrap_future(future, loop=self.loop)
+
+    def _on_message(self, _client, _userdata, message: MQTTMessage) -> None:
+        """Is called when message is received."""
+        logger.debug("Message on topic %s", message.topic)
+
+        payload = json.loads(message.payload)
+        if message.topic.endswith("/app/down/thing/events"):
+            event = ThingEventMessage(**payload)
+            params = event.params
+            if params.identifier == "device_protobuf_msg_event":
+                content = LubaMsg().parse(base64.b64decode(params.value.content))
+
+                logger.info("Unhandled protobuf event: %s", betterproto2.which_one_of(content, "LubaSubMsg"))
+            elif params.identifier == "device_warning_event":
+                logger.debug("identifier event: %s", params.identifier)
+            else:
+                logger.info("Unhandled event: %s", params.identifier)
+        elif message.topic.endswith("/app/down/thing/status"):
+            # the tell if a device has come back online
+            # lastStatus
+            # 1 online?
+            # 3 offline?
+            status = ThingStatusMessage(**payload)
+            logger.debug(status.params.status.value)
+        elif message.topic.endswith("/app/down/thing/properties"):
+            properties = ThingPropertiesMessage(**payload)
+            logger.debug("properties: %s", properties)
+        else:
+            logger.debug("Unhandled topic: %s", message.topic)
+            logger.debug(payload)
+
+    async def send_cloud_command(self, iot_id: str, command: bytes) -> str:
+        """Return internal cloud client."""
+        return await self._cloud_client.send_cloud_command(iot_id, command)

pymammotion/mqtt/linkkit/__init__.py

@@ -0,0 +1,5 @@
+"""Package for linkkit."""
+
+from .linkkit import LinkKit
+
+__all__ = ["LinkKit"]