pymammotion 0.5.27__py3-none-any.whl → 0.5.44__py3-none-any.whl

pymammotion/__init__.py

@@ -15,12 +15,12 @@ from pymammotion.bluetooth.ble import MammotionBLE
 from pymammotion.http.http import MammotionHTTP
 
 # TODO make a working device that will work outside HA too.
-from pymammotion.mqtt import MammotionMQTT
+from pymammotion.mqtt import AliyunMQTT, MammotionMQTT
 
 logger = logging.getLogger(__name__)
 
 
-__all__ = ["MammotionBLE", "MammotionHTTP", "MammotionMQTT", "logger"]
+__all__ = ["MammotionBLE", "MammotionHTTP", "AliyunMQTT", "MammotionMQTT", "logger"]
 
 
 # TODO provide interface to pick between mqtt/cloud/bluetooth
@@ -37,7 +37,7 @@ if __name__ == "__main__":
     REGION = os.environ.get("REGION")
     mammotion_http = MammotionHTTP()
     cloud_client = CloudIOTGateway(mammotion_http)
-    luba = MammotionMQTT(
+    luba = AliyunMQTT(
         iot_token=IOT_TOKEN or "",
         region_id=REGION or "",
         product_key=PRODUCT_KEY or "",

pymammotion/aliyun/client.py

@@ -124,6 +124,9 @@ class Client:
                 _request.headers["x-ca-signature"] = APIGatewayUtilClient.get_signature(_request, self._app_secret)
                 _last_request = _request
                 _response = TeaCore.do_action(_request, _runtime)
+                if _response.body.get("code") == 20056:
+                    raise Exception("Gateway timeout.")
+
                 return _response
             except Exception as e:
                 if TeaCore.is_retryable(e):

pymammotion/aliyun/cloud_gateway.py

@@ -22,7 +22,7 @@ from Tea.exceptions import UnretryableException
 from pymammotion.aliyun.client import Client
 from pymammotion.aliyun.model.aep_response import AepResponse
 from pymammotion.aliyun.model.connect_response import ConnectResponse
-from pymammotion.aliyun.model.dev_by_account_response import ListingDevByAccountResponse
+from pymammotion.aliyun.model.dev_by_account_response import ListingDevAccountResponse
 from pymammotion.aliyun.model.login_by_oauth_response import LoginByOAuthResponse
 from pymammotion.aliyun.model.regions_response import RegionResponse
 from pymammotion.aliyun.model.session_by_authcode_response import SessionByAuthCodeResponse
@@ -103,6 +103,9 @@ class CheckSessionException(Exception):
     """Raise exception when checking session results in a failure."""
 
 
+EXPIRED_CREDENTIAL_EXCEPTIONS = (CheckSessionException, SetupException)
+
+
 class CloudIOTGateway:
     """Class for interacting with Aliyun Cloud IoT Gateway."""
 
@@ -120,7 +123,7 @@ class CloudIOTGateway:
         aep_response: AepResponse | None = None,
         session_by_authcode_response: SessionByAuthCodeResponse | None = None,
         region_response: RegionResponse | None = None,
-        dev_by_account: ListingDevByAccountResponse | None = None,
+        dev_by_account: ListingDevAccountResponse | None = None,
     ) -> None:
         """Initialize the CloudIOTGateway."""
         self.mammotion_http: MammotionHTTP = mammotion_http
@@ -146,7 +149,7 @@ class CloudIOTGateway:
             )
 
     @staticmethod
-    def generate_random_string(length: int):
+    def generate_random_string(length: int) -> str:
         """Generate a random string of specified length."""
         characters = string.ascii_letters + string.digits
         return "".join(random.choice(characters) for _ in range(length))
@@ -165,7 +168,7 @@ class CloudIOTGateway:
             logger.error("Couldn't decode message %s", response_body_str)
             return {"code": 22000}
 
-    def sign(self, data):
+    def sign(self, data: dict) -> str:
         """Generate signature for the given data."""
         keys = ["appKey", "clientId", "deviceSn", "timestamp"]
         concatenated_str = ""
@@ -180,7 +183,7 @@ class CloudIOTGateway:
             hashlib.sha1,
         ).hexdigest()
 
-    async def get_region(self, country_code: str):
+    async def get_region(self, country_code: str) -> RegionResponse:
         """Get the region based on country code and auth code."""
         auth_code = self.mammotion_http.login_info.authorization_code
 
@@ -244,7 +247,7 @@ class CloudIOTGateway:
 
         return response.body
 
-    async def aep_handle(self):
+    async def aep_handle(self) -> AepResponse:
         """Handle AEP authentication."""
         aep_domain = self.domain
 
@@ -300,9 +303,9 @@ class CloudIOTGateway:
 
         logger.debug(response_body_dict)
 
-        return response.body
+        return self._aep_response
 
-    async def connect(self):
+    async def connect(self) -> ConnectResponse:
         """Connect to the Aliyun Cloud IoT Gateway."""
         region_url = "sdk.openaccount.aliyun.com"
         time_now = time.time()
@@ -449,7 +452,7 @@ class CloudIOTGateway:
                     return self._login_by_oauth_response
                 raise LoginException(data)
 
-    async def session_by_auth_code(self):
+    async def session_by_auth_code(self) -> SessionByAuthCodeResponse:
         """Create a session by auth code."""
         config = Config(
             app_key=self._app_key,
@@ -600,11 +603,16 @@ class CloudIOTGateway:
             await self.sign_out()
             raise CheckSessionException("Error check or refresh token: " + response_body_dict.__str__())
 
+        if response_body_dict.get("code") == 2401:
+            await self.sign_out()
+            raise CheckSessionException("Error check or refresh token: " + response_body_dict.__str__())
+
         session = SessionByAuthCodeResponse.from_dict(response_body_dict)
         session_data = session.data
 
         if (
-            session_data.identityId is None
+            session_data is None
+            or session_data.identityId is None
             or session_data.refreshTokenExpire is None
             or session_data.iotToken is None
             or session_data.iotTokenExpire is None
@@ -615,7 +623,7 @@ class CloudIOTGateway:
         self._session_by_authcode_response = session
         self._iot_token_issued_at = int(time.time())
 
-    async def list_binding_by_account(self) -> ListingDevByAccountResponse:
+    async def list_binding_by_account(self) -> ListingDevAccountResponse:
         """List bindings by account."""
         config = Config(
             app_key=self._app_key,
@@ -654,9 +662,9 @@ class CloudIOTGateway:
         response_body_dict = self.parse_json_response(response_body_str)
 
         if int(response_body_dict.get("code")) != 200:
-            raise Exception("Error in creating session: " + response_body_dict["msg"])
+            raise Exception("Error in creating session: " + response_body_dict["message"])
 
-        self._devices_by_account_response = ListingDevByAccountResponse.from_dict(response_body_dict)
+        self._devices_by_account_response = ListingDevAccountResponse.from_dict(response_body_dict)
         return self._devices_by_account_response
 
     async def list_binding_by_dev(self, iot_id: str):
@@ -694,10 +702,94 @@ class CloudIOTGateway:
         # Load the JSON string into a dictionary
         response_body_dict = self.parse_json_response(response_body_str)
 
+        if int(response_body_dict.get("code")) != 200:
+            raise Exception("Error in getting shared device list: " + response_body_dict["msg"])
+
+        self._devices_by_account_response = ListingDevAccountResponse.from_dict(response_body_dict)
+        return self._devices_by_account_response
+
+    async def confirm_share(self, record_list: list[str]) -> bool:
+        config = Config(
+            app_key=self._app_key,
+            app_secret=self._app_secret,
+            domain=self._region_response.data.apiGatewayEndpoint,
+        )
+
+        client = Client(config)
+
+        # build request
+        request = CommonParams(
+            api_ver="1.0.7",
+            language="en-US",
+            iot_token=self._session_by_authcode_response.data.iotToken,
+        )
+        body = IoTApiRequest(
+            id=str(uuid.uuid4()),
+            params={"agree": 1, "recordIdList": record_list},
+            request=request,
+            version="1.0",
+        )
+
+        # send request
+        response = await client.async_do_request("/uc/confirmShare", "https", "POST", None, body, RuntimeOptions())
+        logger.debug(response.status_message)
+        logger.debug(response.headers)
+        logger.debug(response.status_code)
+        logger.debug(response.body)
+
+        # Decode the response body
+        response_body_str = response.body.decode("utf-8")
+
+        # Load the JSON string into a dictionary
+        response_body_dict = self.parse_json_response(response_body_str)
+
+        if int(response_body_dict.get("code")) != 200:
+            raise Exception("Error in accepting share: " + response_body_dict["msg"])
+
+        return True
+
+    async def get_shared_notice_list(self):
+        ### status 0 accepted status -1 ready to be accepted 3 expired
+        config = Config(
+            app_key=self._app_key,
+            app_secret=self._app_secret,
+            domain=self._region_response.data.apiGatewayEndpoint,
+        )
+
+        client = Client(config)
+
+        # build request
+        request = CommonParams(
+            api_ver="1.0.9",
+            language="en-US",
+            iot_token=self._session_by_authcode_response.data.iotToken,
+        )
+        body = IoTApiRequest(
+            id=str(uuid.uuid4()),
+            params={"pageSize": 100, "pageNo": 1},
+            request=request,
+            version="1.0",
+        )
+
+        # send request
+        response = await client.async_do_request(
+            "/uc/getShareNoticeList", "https", "POST", None, body, RuntimeOptions()
+        )
+        logger.debug(response.status_message)
+        logger.debug(response.headers)
+        logger.debug(response.status_code)
+        logger.debug(response.body)
+
+        # Decode the response body
+        response_body_str = response.body.decode("utf-8")
+
+        # Load the JSON string into a dictionary
+        response_body_dict = self.parse_json_response(response_body_str)
+
         if int(response_body_dict.get("code")) != 200:
             raise Exception("Error in creating session: " + response_body_dict["msg"])
 
-        self._devices_by_account_response = ListingDevByAccountResponse.from_dict(response_body_dict)
+        self._devices_by_account_response = ListingDevAccountResponse.from_dict(response_body_dict)
         return self._devices_by_account_response
 
     async def send_cloud_command(self, iot_id: str, command: bytes) -> str:
@@ -774,7 +866,9 @@ class CloudIOTGateway:
             logger.debug("too many requests.")
             if self.message_delay > 8:
                 raise TooManyRequestsException(response.status_message, iot_id)
-            asyncio.get_event_loop().call_later(self.message_delay, self.send_cloud_command, iot_id, command)
+            asyncio.get_event_loop().call_later(
+                self.message_delay, lambda: asyncio.ensure_future(self.send_cloud_command(iot_id, command))
+            )
             self.message_delay = self.message_delay * 2
             return message_id
 
@@ -801,6 +895,10 @@ class CloudIOTGateway:
             if response_body_dict.get("code") == 6205:
                 raise DeviceOfflineException(response_body_dict.get("code"), iot_id)
 
+            if response_body_dict.get("code") == 460:
+                logger.debug("iotToken expired, must re-login.")
+                raise CheckSessionException(response_body_dict.get("message"))
+
         if self.message_delay != 1:
             self.message_delay = 1
 
@@ -857,11 +955,11 @@ class CloudIOTGateway:
         self.mammotion_http = mammotion_http
 
     @property
-    def region_response(self) -> RegionResponse:
+    def region_response(self) -> RegionResponse | None:
         return self._region_response
 
     @property
-    def aep_response(self) -> AepResponse:
+    def aep_response(self) -> AepResponse | None:
         return self._aep_response
 
     @property
@@ -873,9 +971,9 @@ class CloudIOTGateway:
         return self._client_id
 
     @property
-    def login_by_oauth_response(self) -> LoginByOAuthResponse:
+    def login_by_oauth_response(self) -> LoginByOAuthResponse | None:
         return self._login_by_oauth_response
 
     @property
-    def connect_response(self) -> ConnectResponse:
+    def connect_response(self) -> ConnectResponse | None:
         return self._connect_response

pymammotion/aliyun/model/dev_by_account_response.py

@@ -6,30 +6,208 @@ from mashumaro.mixins.orjson import DataClassORJSONMixin
 
 @dataclass
 class Device(DataClassORJSONMixin):
-    gmtModified: int
-    netType: str
-    categoryKey: str
-    productKey: str
-    nodeType: str
-    isEdgeGateway: bool
-    deviceName: str
-    categoryName: str
-    identityAlias: str
-    productName: str
-    iotId: str
-    bindTime: int
-    owned: int
-    identityId: str
-    thingType: str
+    """Unified device model supporting both Device and ShareNotification data"""
+
+    # Core device fields (from Device model)
+    gmt_modified: int
+    node_type: str
+    device_name: str
+    product_name: str
     status: int
-    nickName: str | None = None
+    identity_id: str
+
+    # Required fields from original Device model
+    net_type: str
+    category_key: str
+    product_key: str
+    is_edge_gateway: bool
+    category_name: str
+    identity_alias: str
+    iot_id: str
+    bind_time: int
+    owned: int
+    thing_type: str
+
+    # Optional fields (common to both or nullable)
+    nick_name: str | None = None
     description: str | None = None
-    productImage: str | None = None
-    categoryImage: str | None = None
-    productModel: str | None = None
+    product_image: str | None = None
+    category_image: str | None = None
+    product_model: str | None = None
+
+    # Optional fields from ShareNotification only
+    target_id: str | None = None
+    receiver_identity_id: str | None = None
+    target_type: str | None = None
+    gmt_create: int | None = None
+    batch_id: str | None = None
+    record_id: str | None = None
+    initiator_identity_id: str | None = None
+    is_receiver: int | None = None
+    initiator_alias: str | None = None
+    receiver_alias: str | None = None
 
     class Config(BaseConfig):
         omit_default = True
+        serialize_by_alias = True
+        aliases = {
+            # Original Device model aliases
+            "gmt_modified": "gmtModified",
+            "net_type": "netType",
+            "category_key": "categoryKey",
+            "product_key": "productKey",
+            "node_type": "nodeType",
+            "is_edge_gateway": "isEdgeGateway",
+            "device_name": "deviceName",
+            "category_name": "categoryName",
+            "identity_alias": "identityAlias",
+            "product_name": "productName",
+            "iot_id": "iotId",
+            "bind_time": "bindTime",
+            "identity_id": "identityId",
+            "thing_type": "thingType",
+            "nick_name": "nickName",
+            "product_image": "productImage",
+            "category_image": "categoryImage",
+            "product_model": "productModel",
+            # ShareNotification specific aliases
+            "target_id": "targetId",
+            "receiver_identity_id": "receiverIdentityId",
+            "target_type": "targetType",
+            "gmt_create": "gmtCreate",
+            "batch_id": "batchId",
+            "record_id": "recordId",
+            "initiator_identity_id": "initiatorIdentityId",
+            "is_receiver": "isReceiver",
+            "initiator_alias": "initiatorAlias",
+            "receiver_alias": "receiverAlias",
+        }
+
+
+# # Alternative: Keep them separate but with a common base class
+# @dataclass
+# class BaseDevice(DataClassORJSONMixin):
+#     """Base device model with common fields"""
+#
+#     gmt_modified: int
+#     node_type: str
+#     device_name: str
+#     product_name: str
+#     status: int
+#     product_image: Optional[str] = None
+#     category_image: Optional[str] = None
+#     description: Optional[str] = None
+#
+#     class Config(BaseConfig):
+#         omit_default = True
+#         serialize_by_alias = True
+#         aliases = {
+#             "gmt_modified": "gmtModified",
+#             "node_type": "nodeType",
+#             "device_name": "deviceName",
+#             "product_name": "productName",
+#             "product_image": "productImage",
+#             "category_image": "categoryImage",
+#         }
+#
+#
+# @dataclass
+# class Device(BaseDevice):
+#     """Full device model"""
+#
+#     net_type: str
+#     category_key: str
+#     product_key: str
+#     is_edge_gateway: bool
+#     category_name: str
+#     identity_alias: str
+#     iot_id: str
+#     bind_time: int
+#     owned: int
+#     identity_id: str
+#     thing_type: str
+#     nick_name: Optional[str] = None
+#     product_model: Optional[str] = None
+#
+#     class Config(BaseConfig):
+#         omit_default = True
+#         serialize_by_alias = True
+#         aliases = {
+#             **BaseDevice.Config.aliases,
+#             "net_type": "netType",
+#             "category_key": "categoryKey",
+#             "product_key": "productKey",
+#             "is_edge_gateway": "isEdgeGateway",
+#             "category_name": "categoryName",
+#             "identity_alias": "identityAlias",
+#             "iot_id": "iotId",
+#             "bind_time": "bindTime",
+#             "identity_id": "identityId",
+#             "thing_type": "thingType",
+#             "nick_name": "nickName",
+#             "product_model": "productModel",
+#         }
+#
+#
+# @dataclass
+# class ShareNotification(BaseDevice):
+#     """Share notification model extending base device"""
+#
+#     target_id: str
+#     receiver_identity_id: str
+#     target_type: str
+#     gmt_create: int
+#     batch_id: str
+#     record_id: str
+#     initiator_identity_id: str
+#     is_receiver: int
+#     initiator_alias: str
+#     receiver_alias: str
+#
+#     # Optional fields that Device has but ShareNotification might not
+#     net_type: Optional[str] = None
+#     category_key: Optional[str] = None
+#     product_key: Optional[str] = None
+#     is_edge_gateway: Optional[bool] = None
+#     category_name: Optional[str] = None
+#     identity_alias: Optional[str] = None
+#     iot_id: Optional[str] = None
+#     bind_time: Optional[int] = None
+#     owned: Optional[int] = None
+#     identity_id: Optional[str] = None
+#     thing_type: Optional[str] = None
+#     nick_name: Optional[str] = None
+#     product_model: Optional[str] = None
+#
+#     class Config(BaseConfig):
+#         omit_default = True
+#         serialize_by_alias = True
+#         aliases = {
+#             **BaseDevice.Config.aliases,
+#             "target_id": "targetId",
+#             "receiver_identity_id": "receiverIdentityId",
+#             "target_type": "targetType",
+#             "gmt_create": "gmtCreate",
+#             "batch_id": "batchId",
+#             "record_id": "recordId",
+#             "initiator_identity_id": "initiatorIdentityId",
+#             "is_receiver": "isReceiver",
+#             "initiator_alias": "initiatorAlias",
+#             "receiver_alias": "receiverAlias",
+#             # Device fields that might be present
+#             "net_type": "netType",
+#             "category_key": "categoryKey",
+#             "product_key": "productKey",
+#             "is_edge_gateway": "isEdgeGateway",
+#             "category_name": "categoryName",
+#             "identity_alias": "identityAlias",
+#             "iot_id": "iotId",
+#             "bind_time": "bindTime",
+#             "identity_id": "identityId",
+#             "thing_type": "thingType",
+#             "nick_name": "nickName",
+#             "product_model": "productModel",
+#         }
 
 
 @dataclass
@@ -41,7 +219,7 @@ class Data(DataClassORJSONMixin):
 
 
 @dataclass
-class ListingDevByAccountResponse(DataClassORJSONMixin):
+class ListingDevAccountResponse(DataClassORJSONMixin):
     code: int
     data: Data | None
     id: str | None = None

pymammotion/const.py

@@ -8,3 +8,6 @@ MAMMOTION_DOMAIN = "https://id.mammotion.com"
 MAMMOTION_API_DOMAIN = "https://domestic.mammotion.com"
 MAMMOTION_CLIENT_ID = "MADKALUBAS"
 MAMMOTION_CLIENT_SECRET = "GshzGRZJjuMUgd2sYHM7"
+
+MAMMOTION_OUATH2_CLIENT_ID = "GxebgSt8si6pKqR"
+MAMMOTION_OUATH2_CLIENT_SECRET = "JP0508SRJFa0A90ADpzLINDBxMa4Vj"

pymammotion/data/model/device.py

@@ -96,6 +96,7 @@ class MowingDevice(DataClassORJSONMixin):
                 self.location.device = coordinate_converter.enu_to_lla(
                     parse_double(location.real_pos_y, 4.0), parse_double(location.real_pos_x, 4.0)
                 )
+                self.map.invalidate_maps(location.bol_hash)
                 if location.zone_hash:
                     self.location.work_zone = (
                         location.zone_hash if self.report_data.dev.sys_status == WorkMode.MODE_WORKING else 0

pymammotion/data/model/device_config.py

@@ -30,7 +30,7 @@ class OperationSettings(DataClassORJSONMixin):
     obstacle_laps: int = 1
     mowing_laps: int = 1  # border laps
     start_progress: int = 0
-    areas: list[int] = field(default_factory=list)
+    areas: set[int] = field(default_factory=set)
 
 
 def create_path_order(operation_mode: OperationSettings, device_name: str) -> str:

pymammotion/data/model/enums.py

@@ -4,9 +4,11 @@ from enum import Enum
 class ConnectionPreference(Enum):
     """Enum for connection preference."""
 
-    EITHER = 0
+    ANY = 0
     WIFI = 1
     BLUETOOTH = 2
+    PREFER_WIFI = 3
+    PREFER_BLUETOOTH = 4
 
 
 class PositionMode(Enum):
@@ -17,7 +19,7 @@ class PositionMode(Enum):
     UNKNOWN = 4
 
     @staticmethod
-    def from_value(value: int):
+    def from_value(value: int) -> "PositionMode":
         if value == 0:
             return PositionMode.FIX
         elif value == 1:
@@ -50,7 +52,7 @@ class RTKStatus(Enum):
     UNKNOWN = 6
 
     @staticmethod
-    def from_value(value: int):
+    def from_value(value: int) -> "RTKStatus":
         if value == 0:
             return RTKStatus.NONE
         elif value == 1 or value == 2:

pymammotion/data/model/generate_route_information.py

@@ -1,4 +1,4 @@
-from dataclasses import dataclass
+from dataclasses import dataclass, field
 import logging
 
 logger = logging.getLogger(__name__)
@@ -8,7 +8,7 @@ logger = logging.getLogger(__name__)
 class GenerateRouteInformation:
     """Creates a model for generating route information and mowing plan before starting a job."""
 
-    one_hashs: list[int] = list
+    one_hashs: list[int] = field(default_factory=list)
     job_mode: int = 4  # taskMode
     job_version: int = 0
     job_id: int = 0