pymammotion 0.5.34__tar.gz → 0.5.40__tar.gz

pymammotion-0.5.40/.gitignore

@@ -0,0 +1,237 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64
+lib64/
+bin/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+pyvenv.cfg
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio, WebStorm and Rider
+# Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839
+
+# User-specific stuff
+.idea/**/workspace.xml
+.idea/**/tasks.xml
+.idea/**/usage.statistics.xml
+.idea/**/dictionaries
+.idea/**/shelf
+
+# AWS User-specific
+.idea/**/aws.xml
+
+# Generated files
+.idea/**/contentModel.xml
+
+# Sensitive or high-churn files
+.idea/**/dataSources/
+.idea/**/dataSources.ids
+.idea/**/dataSources.local.xml
+.idea/**/sqlDataSources.xml
+.idea/**/dynamic.xml
+.idea/**/uiDesigner.xml
+.idea/**/dbnavigator.xml
+
+# Gradle
+.idea/**/gradle.xml
+.idea/**/libraries
+
+# Gradle and Maven with auto-import
+# When using Gradle or Maven with auto-import, you should exclude module files,
+# since they will be recreated, and may cause churn.  Uncomment if using
+# auto-import.
+# .idea/artifacts
+# .idea/compiler.xml
+# .idea/jarRepositories.xml
+# .idea/modules.xml
+# .idea/*.iml
+# .idea/modules
+# *.iml
+# *.ipr
+
+# CMake
+cmake-build-*/
+
+# Mongo Explorer plugin
+.idea/**/mongoSettings.xml
+
+# File-based project format
+*.iws
+
+# IntelliJ
+out/
+
+# mpeltonen/sbt-idea plugin
+.idea_modules/
+
+# JIRA plugin
+atlassian-ide-plugin.xml
+
+# Cursive Clojure plugin
+.idea/replstate.xml
+
+# SonarLint plugin
+.idea/sonarlint/
+
+# Crashlytics plugin (for Android Studio and IntelliJ)
+com_crashlytics_export_strings.xml
+crashlytics.properties
+crashlytics-build.properties
+fabric.properties
+
+# Editor-based Rest Client
+.idea/httpRequests
+
+# Android studio 3.1+ serialized cache file
+.idea/caches/build_file_checksums.ser
+scripts.txt
+.idea

{pymammotion-0.5.34 → pymammotion-0.5.40}/PKG-INFO

@@ -1,34 +1,29 @@
-Metadata-Version: 2.3
+Metadata-Version: 2.4
 Name: pymammotion
-Version: 0.5.34
-Summary: 
-License: GPL-3.0
-Author: Michael Arthur
-Author-email: michael@jumblesoft.co.nz
-Requires-Python: >=3.10
-Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
-Classifier: Programming Language :: Python :: 3.13
-Requires-Dist: aiohttp (>=3.9.1)
-Requires-Dist: alibabacloud-apigateway-util (>=0.0.2,<0.0.3)
-Requires-Dist: alibabacloud-iot-api-gateway (>=0.0.4,<0.0.5)
-Requires-Dist: alicloud-gateway-iot (>=1.0.0,<2.0.0)
-Requires-Dist: async-timeout (>=4.0.3,<5.0.0)
-Requires-Dist: betterproto2 (>=0.8.0,<0.9.0)
-Requires-Dist: bleak (>=0.21.0)
-Requires-Dist: bleak-retry-connector (>=3.5.0)
-Requires-Dist: crcmod (>=1.7,<2.0)
-Requires-Dist: cryptography (>=43.0.1)
-Requires-Dist: grpclib (>=0.4.8,<0.5.0)
-Requires-Dist: jsonic (>=1.0.0,<2.0.0)
-Requires-Dist: mashumaro (>=3.13,<4.0)
-Requires-Dist: numpy (>=1.26.0)
-Requires-Dist: orjson (>=3.9.15,<4.0.0)
-Requires-Dist: paho-mqtt (>=2.1.0,<3.0.0)
-Requires-Dist: protobuf (>=4.23.1)
-Requires-Dist: py-jsonic (>=0.0.2,<0.0.3)
+Version: 0.5.40
+Author: jLynx
+Author-email: Michael Arthur <michael@jumblesoft.co.nz>
+License-Expression: GPL-3.0
+License-File: LICENSE
+Requires-Python: <4.0,>=3.12
+Requires-Dist: aiohttp>=3.9.1
+Requires-Dist: alibabacloud-apigateway-util<0.0.3,>=0.0.2
+Requires-Dist: alibabacloud-iot-api-gateway<0.0.5,>=0.0.4
+Requires-Dist: alicloud-gateway-iot<2,>=1.0.0
+Requires-Dist: async-timeout<5,>=4.0.3
+Requires-Dist: betterproto2<0.9,>=0.8.0
+Requires-Dist: bleak-retry-connector>=3.5.0
+Requires-Dist: bleak>=0.21.0
+Requires-Dist: crcmod~=1.7
+Requires-Dist: cryptography>=43.0.1
+Requires-Dist: jsonic<2,>=1.0.0
+Requires-Dist: mashumaro~=3.13
+Requires-Dist: numpy>=1.26.0
+Requires-Dist: orjson<4,>=3.9.15
+Requires-Dist: paho-mqtt<3,>=2.1.0
+Requires-Dist: protobuf>=4.23.1
+Requires-Dist: py-jsonic<0.0.3,>=0.0.2
+Requires-Dist: pyjwt>=2.10.1
 Description-Content-Type: text/markdown
 
 # PyMammotion - Python API for Mammotion Mowers [![Discord](https://img.shields.io/discord/1247286396297678879)](https://discord.gg/vpZdWhJX8x)
@@ -97,4 +92,3 @@ This project is licensed under the MIT License - see the [LICENSE](LICENSE) file
 
 The trademarks "Mammotion," "Luba," and "Yuka" referenced herein are registered trademarks of their respective owners. The author of this software repository is not affiliated with, endorsed by, or connected to these trademark owners in any way.
 
-

{pymammotion-0.5.34 → pymammotion-0.5.40}/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-0.5.34 → pymammotion-0.5.40}/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,
@@ -608,7 +611,8 @@ class CloudIOTGateway:
         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
@@ -619,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,
@@ -658,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):
@@ -698,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:
@@ -867,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
@@ -883,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