pyechorobotics 1.2.0__tar.gz → 2.0.0__tar.gz

{pyechorobotics-1.2.0/src/pyechorobotics.egg-info → pyechorobotics-2.0.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pyechorobotics
-Version: 1.2.0
+Version: 2.0.0
 Summary: Access API for echorobotics robot lawn mowers
 Author-email: functionpointer <suspendfunction@gmail.com>
 License: GNU General Public License v3 or later (GPLv3+)
@@ -39,8 +39,8 @@ import logging
 
 
 async def main():
-    async with aiohttp.ClientSession(cookies=echoroboticsapi.create_cookies(user_id="your-user-id", user_token="user-user-token")) as session:
-        api = echoroboticsapi.Api(session, robot_ids=["your-robot-id"])
+    async with aiohttp.ClientSession() as session:
+        api = echoroboticsapi.Api(session, robot_ids=["your-robot-id"], email="your-email", password="your-password")
         print(await api.last_statuses())
         print(await api.set_mode("chargeAndWork"))
 
@@ -66,8 +66,8 @@ import logging
 
 
 async def main():
-    async with aiohttp.ClientSession(cookies=echoroboticsapi.create_cookies(user_id="your-user-id", user_token="user-user-token")) as session:
-        api = echoroboticsapi.Api(session, robot_ids=["your-robot-id"])
+    async with aiohttp.ClientSession() as session:
+        api = echoroboticsapi.Api(session, robot_ids=["your-robot-id"], email="your-email", password="your-password")
         smartmode = echoroboticsapi.SmartMode("your-robot-id")
         api.register_smart_mode(smartmode)
         
@@ -102,8 +102,8 @@ import logging
 
 
 async def main():
-    async with aiohttp.ClientSession(cookies=echoroboticsapi.create_cookies(user_id="your-user-id", user_token="user-user-token")) as session:
-        api = echoroboticsapi.Api(session, robot_ids=["your-robot-id"])
+    async with aiohttp.ClientSession() as session:
+        api = echoroboticsapi.Api(session, robot_ids=["your-robot-id"], email="your-email", password="your-password")
         smartmode = echoroboticsapi.SmartMode("your-robot-id")
         api.register_smart_mode(smartmode)
         smartfetch = echoroboticsapi.SmartFetch(api)

{pyechorobotics-1.2.0 → pyechorobotics-2.0.0}/README.md

@@ -21,8 +21,8 @@ import logging
 
 
 async def main():
-    async with aiohttp.ClientSession(cookies=echoroboticsapi.create_cookies(user_id="your-user-id", user_token="user-user-token")) as session:
-        api = echoroboticsapi.Api(session, robot_ids=["your-robot-id"])
+    async with aiohttp.ClientSession() as session:
+        api = echoroboticsapi.Api(session, robot_ids=["your-robot-id"], email="your-email", password="your-password")
         print(await api.last_statuses())
         print(await api.set_mode("chargeAndWork"))
 
@@ -48,8 +48,8 @@ import logging
 
 
 async def main():
-    async with aiohttp.ClientSession(cookies=echoroboticsapi.create_cookies(user_id="your-user-id", user_token="user-user-token")) as session:
-        api = echoroboticsapi.Api(session, robot_ids=["your-robot-id"])
+    async with aiohttp.ClientSession() as session:
+        api = echoroboticsapi.Api(session, robot_ids=["your-robot-id"], email="your-email", password="your-password")
         smartmode = echoroboticsapi.SmartMode("your-robot-id")
         api.register_smart_mode(smartmode)
         
@@ -84,8 +84,8 @@ import logging
 
 
 async def main():
-    async with aiohttp.ClientSession(cookies=echoroboticsapi.create_cookies(user_id="your-user-id", user_token="user-user-token")) as session:
-        api = echoroboticsapi.Api(session, robot_ids=["your-robot-id"])
+    async with aiohttp.ClientSession() as session:
+        api = echoroboticsapi.Api(session, robot_ids=["your-robot-id"], email="your-email", password="your-password")
         smartmode = echoroboticsapi.SmartMode("your-robot-id")
         api.register_smart_mode(smartmode)
         smartfetch = echoroboticsapi.SmartFetch(api)

{pyechorobotics-1.2.0 → pyechorobotics-2.0.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "pyechorobotics"
-version = "1.2.0"
+version = "2.0.0"
 dependencies = [
     "aiohttp",
     "yarl",

{pyechorobotics-1.2.0 → pyechorobotics-2.0.0}/src/echoroboticsapi/__init__.py

@@ -1,5 +1,4 @@
 from .api import Api
 from .models import *
-from .api import create_cookies
 from .smart_mode import SmartMode
 from .smart_fetch import SmartFetch

{pyechorobotics-1.2.0 → pyechorobotics-2.0.0}/src/echoroboticsapi/api.py

@@ -1,16 +1,20 @@
 import datetime
 
 import asyncio
+from typing import Any, TYPE_CHECKING, TypedDict
+from warnings import deprecated
+
 import pydantic
 from aiohttp import ClientSession, ClientResponse
 from yarl import URL
+
 from .models import *
 import logging
 import time
+from abc import ABC, abstractmethod
 
-
-def create_cookies(user_id: str, user_token: str) -> dict[str, str]:
-    return {"UserId": user_id, "UserToken": user_token}
+if TYPE_CHECKING:
+    from . import SmartMode
 
 
 class LastKnownMode:
@@ -22,12 +26,27 @@ class LastKnownMode:
         self.pending_since = pending_since or time.time()
 
 
+class AuthInfo(TypedDict):
+    access_token: str
+    refresh_token: str
+    obtained_timestamp: float
+
+
 class Api:
     """Class to make authenticated requests."""
 
-    def __init__(self, websession: ClientSession, robot_ids: RobotId | list[RobotId]):
+    def __init__(
+        self,
+        websession: ClientSession,
+        robot_ids: RobotId | list[RobotId],
+        email: str,
+        password: str,
+    ):
         """Initialize the auth."""
         self.websession = websession
+        self.email = email
+        self.password = password
+        self.auth_info: AuthInfo | None = None
         if not isinstance(robot_ids, list):
             robot_ids = [robot_ids]
         self.robot_ids = robot_ids
@@ -36,6 +55,80 @@ class Api:
         self.logger = logging.getLogger("echoroboticsapi")
         self.smart_modes: dict[RobotId, "SmartMode"] = {}
 
+    async def loginv2(self) -> AuthInfo:
+        data = {"Email": self.email, "Password": self.password}
+        url = URL(f"https://myrobot.echorobotics.com/api/authentication/loginv2")
+        result = await self.request(
+            method="POST",
+            add_auth=False,
+            url=url,
+            json=data,
+        )
+        result.raise_for_status()
+        json_result = await result.json()
+        ret: AuthInfo = {
+            "access_token": json_result["Token"],
+            "refresh_token": json_result["RefreshToken"],
+            "obtained_timestamp": time.time(),
+        }
+        self.logger.info(
+            "loginv2 %s. Token len=%s; RefreshToken len=%s",
+            result.status,
+            len(ret["access_token"]),
+            len(ret["refresh_token"]),
+        )
+        return ret
+
+    @property
+    def token_refresh_duration(self):
+        return 5 * 60  # 5 minutes
+
+    async def get_access_token(self) -> str:
+        """Returns a valid access token
+        Performs API call to the refresh endpoint if needed.
+        """
+        if self.auth_info is None:
+            self.auth_info = await self.loginv2()
+        if self.auth_info is None:
+            return ""
+        if (
+            remaining := (
+                self.auth_info["obtained_timestamp"] + self.token_refresh_duration
+            )
+            - time.time()
+        ) <= 0:
+            # have to refresh
+            url = URL(f"https://myrobot.echorobotics.com/api/authentication/refresh")
+            # url = URL(f"http://httpbin.org/cookies")
+            result = await self.request(
+                method="POST",
+                add_auth=False,
+                url=url,
+                headers={"Authorization": f"Bearer {self.auth_info['access_token']}"},
+                cookies={
+                    "br_rt": self.auth_info["refresh_token"],
+                    # "br_at": self.auth_info["access_token"],
+                },
+                json={},
+            )
+            result.raise_for_status()
+            json = await result.json()
+            new_auth_info: AuthInfo = {
+                "access_token": json["Token"],
+                "refresh_token": json["RefreshToken"],
+                "obtained_timestamp": time.time(),
+            }
+            self.auth_info = new_auth_info
+            self.logger.info(
+                "auth refresh %s. access_token len=%s, refresh_token len=%s",
+                result.status,
+                len(new_auth_info["access_token"]),
+                len(new_auth_info["refresh_token"]),
+            )
+        else:
+            self.logger.debug("auth refresh not needed, %.2f s remaining", remaining)
+        return self.auth_info["access_token"]
+
     def _set_mode_use_current_sleep_times(self):
         yield from [3, 2, 2, 2]
         while True:
@@ -278,10 +371,17 @@ class Api:
                 await self.smart_modes[robot_id].notify_history_list_received(resp)
             return resp
 
-    async def request(self, method: str, url: URL, **kwargs) -> ClientResponse:
+    async def request(
+        self, method: str, url: URL, add_auth: bool = True, **kwargs
+    ) -> ClientResponse:
         """Make a request."""
+        if headers := kwargs.pop("headers", {}):
+            headers = dict(headers)
+        if add_auth:
+            headers["authorization"] = f"Bearer {await self.get_access_token()}"
         return await self.websession.request(
             method,
             url,
+            headers=headers,
             **kwargs,
         )

{pyechorobotics-1.2.0 → pyechorobotics-2.0.0}/src/echoroboticsapi/models.py

@@ -11,12 +11,16 @@ from pydantic import (
     validator,
     RootModel,
     ConfigDict,
+    StringConstraints,
 )
-from typing import Literal, Self
+from typing import Literal, Self, Annotated
 from dateutil.parser import isoparse as dateutil_isoparse
 from enum import Enum
 
-RobotId = constr()
+RobotId = Annotated[
+    str,
+    StringConstraints(strip_whitespace=True, to_upper=True),
+]
 Mode = Literal["chargeAndWork", "chargeAndStay", "work"]
 Status = Literal[
     "Offline",

{pyechorobotics-1.2.0 → pyechorobotics-2.0.0/src/pyechorobotics.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pyechorobotics
-Version: 1.2.0
+Version: 2.0.0
 Summary: Access API for echorobotics robot lawn mowers
 Author-email: functionpointer <suspendfunction@gmail.com>
 License: GNU General Public License v3 or later (GPLv3+)
@@ -39,8 +39,8 @@ import logging
 
 
 async def main():
-    async with aiohttp.ClientSession(cookies=echoroboticsapi.create_cookies(user_id="your-user-id", user_token="user-user-token")) as session:
-        api = echoroboticsapi.Api(session, robot_ids=["your-robot-id"])
+    async with aiohttp.ClientSession() as session:
+        api = echoroboticsapi.Api(session, robot_ids=["your-robot-id"], email="your-email", password="your-password")
         print(await api.last_statuses())
         print(await api.set_mode("chargeAndWork"))
 
@@ -66,8 +66,8 @@ import logging
 
 
 async def main():
-    async with aiohttp.ClientSession(cookies=echoroboticsapi.create_cookies(user_id="your-user-id", user_token="user-user-token")) as session:
-        api = echoroboticsapi.Api(session, robot_ids=["your-robot-id"])
+    async with aiohttp.ClientSession() as session:
+        api = echoroboticsapi.Api(session, robot_ids=["your-robot-id"], email="your-email", password="your-password")
         smartmode = echoroboticsapi.SmartMode("your-robot-id")
         api.register_smart_mode(smartmode)
         
@@ -102,8 +102,8 @@ import logging
 
 
 async def main():
-    async with aiohttp.ClientSession(cookies=echoroboticsapi.create_cookies(user_id="your-user-id", user_token="user-user-token")) as session:
-        api = echoroboticsapi.Api(session, robot_ids=["your-robot-id"])
+    async with aiohttp.ClientSession() as session:
+        api = echoroboticsapi.Api(session, robot_ids=["your-robot-id"], email="your-email", password="your-password")
         smartmode = echoroboticsapi.SmartMode("your-robot-id")
         api.register_smart_mode(smartmode)
         smartfetch = echoroboticsapi.SmartFetch(api)

{pyechorobotics-1.2.0 → pyechorobotics-2.0.0}/test/test_api.py

@@ -1,3 +1,5 @@
+import time
+
 import datetime
 import json
 import urllib.parse
@@ -26,20 +28,64 @@ async def client_session():
 
 
 @pytest.fixture
-def api(client_session: aiohttp.ClientSession, robot_id: echoroboticsapi.RobotId):
-    ret = echoroboticsapi.Api(client_session, robot_id)
+def api_not_logged_in(
+    client_session: aiohttp.ClientSession,
+    robot_id: echoroboticsapi.RobotId,
+    user_email: str,
+    user_password: str,
+):
+    ret = echoroboticsapi.Api(
+        client_session, robot_id, email=user_email, password=user_password
+    )
 
     def fast():
         while True:
             yield 0.01
 
     ret._set_mode_use_current_sleep_times = fast
-    yield ret
+    return ret
+
+
+@pytest.fixture
+def api(api_not_logged_in: echoroboticsapi.Api):
+    api_not_logged_in.auth_info = {
+        "access_token": "abc",
+        "refresh_token": "abc",
+        "obtained_timestamp": time.time(),
+    }
+    yield api_not_logged_in
+
+
+@pytest.fixture
+def expected_headers():
+    return {"authorization": "Bearer abc"}
+
+
+@pytest.mark.asyncio
+async def test_loginv2(
+    robot_id: echoroboticsapi.RobotId,
+    api_not_logged_in: echoroboticsapi.Api,
+    mock_aioresponse,
+    user_email: str,
+    user_password: str,
+):
+    mock_payload = {"Token": "abc", "RefreshToken": "abc"}
+    expected_url = f"https://myrobot.echorobotics.com/api/authentication/loginv2"
+    mock_aioresponse.post(expected_url, payload=mock_payload)
+
+    api_not_logged_in.auth_info = await api_not_logged_in.loginv2()
+    assert api_not_logged_in.auth_info["access_token"] == "abc"
+    mock_aioresponse.assert_called_once_with(
+        expected_url,
+        method="POST",
+        headers={},
+        json={"Email": user_email, "Password": user_password},
+    )
 
 
 @pytest.mark.asyncio
 async def test_get_config(
-    robot_id: RobotId, api: echoroboticsapi.Api, mock_aioresponse
+    robot_id: RobotId, api: echoroboticsapi.Api, mock_aioresponse, expected_headers
 ):
     mock_json = '{"IsError": true, "IsInProgress": false, "Message": "configurator.messages.robotOffline", "Data": null, "Descriptors": null, "ConfigId": 0, "ConfigVersionId": 0, "ConfigDateTime": "0001-01-01T00:00:00", "ConfigValidated": false}'
     expected_url = f"https://myrobot.echorobotics.com/api/RobotConfig/GetConfig/{robot_id}?reload=False"
@@ -48,12 +94,14 @@ async def test_get_config(
     resp = await api.get_config(reload=False, robot_id=robot_id)
 
     assert resp
-    mock_aioresponse.assert_called_once_with(expected_url, method="GET")
+    mock_aioresponse.assert_called_once_with(
+        expected_url, method="GET", headers=expected_headers
+    )
 
 
 @pytest.mark.asyncio
 async def test_get_config_in_progress_without_config_version_id(
-    robot_id: RobotId, api: echoroboticsapi.Api, mock_aioresponse
+    robot_id: RobotId, api: echoroboticsapi.Api, mock_aioresponse, expected_headers
 ):
     mock_json = '{"IsError": false, "IsInProgress": true, "Message": "configurator.apiresponse.get.willNowContactRobot", "ConfigId": 0, "ConfigDateTime": "0001-01-01T00:00:00", "ConfigValidated": false}'
     expected_url = f"https://myrobot.echorobotics.com/api/RobotConfig/GetConfig/{robot_id}?reload=True"
@@ -63,12 +111,17 @@ async def test_get_config_in_progress_without_config_version_id(
 
     assert resp.is_in_progress
     assert resp.config_version_id is None
-    mock_aioresponse.assert_called_once_with(expected_url, method="GET")
+    mock_aioresponse.assert_called_once_with(
+        expected_url, method="GET", headers=expected_headers
+    )
 
 
 @pytest.mark.asyncio
 async def test_laststatuses(
-    api: echoroboticsapi.Api, mock_aioresponse, robot_id: echoroboticsapi.RobotId
+    api: echoroboticsapi.Api,
+    mock_aioresponse,
+    robot_id: echoroboticsapi.RobotId,
+    expected_headers,
 ):
     mock_json = r'{"QueryDate":"2025-01-24T18:50:19.3556944Z","Robots":["robot_id"],"StatusesInfo":[{"Robot":"robot_id","Status":"Off","MacAddress":"ac1f0fb92010","Date":"2024-12-20T15:17:14.861Z","Delta":"5 Wochen","EstimatedBatteryLevel":99.99,"Position":{"Longitude":6.1,"Latitude":5.5,"DateTime":"2024-11-04T13:17:48.461Z"},"QueryTime":"2025-01-24T18:50:19.3556944Z","HasValues":true,"IsOnline":false}],"RobotOfflineDelayInSeconds":1500}'
     mock_json = mock_json.replace("robot_id", robot_id)
@@ -76,10 +129,11 @@ async def test_laststatuses(
     mock_aioresponse.post(expected_url, body=mock_json)
     last_statuses = await api.last_statuses()
 
-    mock_aioresponse.assert_called_once_with(
+    mock_aioresponse.assert_called_with(
         expected_url,
         method="POST",
         json=[robot_id],
+        headers=expected_headers,
     )
     assert last_statuses
     assert last_statuses.statuses_info[0].robot == robot_id
@@ -89,7 +143,10 @@ async def test_laststatuses(
 
 @pytest.mark.asyncio
 async def test_history_list(
-    api: echoroboticsapi.Api, mock_aioresponse, robot_id: echoroboticsapi.RobotId
+    api: echoroboticsapi.Api,
+    mock_aioresponse,
+    robot_id: echoroboticsapi.RobotId,
+    expected_headers,
 ):
     mock_json = [
         {
@@ -403,13 +460,17 @@ async def test_history_list(
     mock_aioresponse.assert_called_once_with(
         expected_url,
         method="GET",
+        headers=expected_headers,
     )
     assert len(history_list) > 3
 
 
 @pytest.mark.asyncio
 async def test_current(
-    api: echoroboticsapi.Api, mock_aioresponse, robot_id: echoroboticsapi.RobotId
+    api: echoroboticsapi.Api,
+    mock_aioresponse,
+    robot_id: echoroboticsapi.RobotId,
+    expected_headers,
 ):
     mock_json = r'{"SerialNumber":"robot_id","ActionId":null,"Status":0,"Message":null}'
     mock_json = mock_json.replace("robot_id", robot_id)
@@ -424,12 +485,16 @@ async def test_current(
     mock_aioresponse.assert_called_once_with(
         expected_url,
         method="GET",
+        headers=expected_headers,
     )
 
 
 @pytest.mark.asyncio
 async def test_set_mode_bad_contact(
-    api: echoroboticsapi.Api, mock_aioresponse, robot_id: echoroboticsapi.RobotId
+    api: echoroboticsapi.Api,
+    mock_aioresponse,
+    robot_id: echoroboticsapi.RobotId,
+    expected_headers,
 ):
     mock_json_old = (
         rf'{{"SerialNumber":"{robot_id}","ActionId":null,"Status":0,"Message":null}}'
@@ -448,12 +513,17 @@ async def test_set_mode_bad_contact(
     status_code = await api.set_mode("work", robot_id, use_current=True)
 
     assert status_code == -1
-    mock_aioresponse.assert_called_with(expected_url, method="GET")
+    mock_aioresponse.assert_called_with(
+        expected_url, method="GET", headers=expected_headers
+    )
 
 
 @pytest.mark.asyncio
 async def test_set_mode_bad_contact_timeout(
-    api: echoroboticsapi.Api, mock_aioresponse, robot_id: echoroboticsapi.RobotId
+    api: echoroboticsapi.Api,
+    mock_aioresponse,
+    robot_id: echoroboticsapi.RobotId,
+    expected_headers,
 ):
     mock_json_old = (
         rf'{{"SerialNumber":"{robot_id}","ActionId":null,"Status":0,"Message":null}}'
@@ -472,12 +542,17 @@ async def test_set_mode_bad_contact_timeout(
     )
 
     assert status_code == -1
-    mock_aioresponse.assert_called_with(expected_url, method="GET")
+    mock_aioresponse.assert_called_with(
+        expected_url, method="GET", headers=expected_headers
+    )
 
 
 @pytest.mark.asyncio
 async def test_set_mode_working(
-    api: echoroboticsapi.Api, mock_aioresponse, robot_id: echoroboticsapi.RobotId
+    api: echoroboticsapi.Api,
+    mock_aioresponse,
+    robot_id: echoroboticsapi.RobotId,
+    expected_headers,
 ):
     mock_json_old = (
         rf'{{"SerialNumber":"{robot_id}","ActionId":null,"Status":0,"Message":null}}'
@@ -500,4 +575,6 @@ async def test_set_mode_working(
     status_code = await api.set_mode("work", robot_id, use_current=True)
 
     assert status_code == 200
-    mock_aioresponse.assert_called_with(expected_url, method="GET")
+    mock_aioresponse.assert_called_with(
+        expected_url, method="GET", headers=expected_headers
+    )

{pyechorobotics-1.2.0 → pyechorobotics-2.0.0}/test/test_smart_fetch.py

@@ -13,8 +13,10 @@ ALL_STATUSES = list(typing.get_args(echoroboticsapi.Status))
 
 
 @pytest.fixture
-def api(robot_id: RobotId):
-    api = echoroboticsapi.Api(websession=None, robot_ids=[robot_id])
+def api(robot_id: RobotId, user_email: str, user_password: str):
+    api = echoroboticsapi.Api(
+        websession=None, robot_ids=[robot_id], email=user_email, password=user_password
+    )
     yield api