Add new API endpoint via DeviceAuthenticator #987

JNickson · 2025-05-23T11:51:00Z

No description provided.

Copilot

Pull Request Overview

This PR introduces an initial API endpoint for IoT control and updates the existing command infrastructure to support the new changes.

Added a new constant PATH_API_IOT_CONTROL to define the new endpoint.
Introduced CleanV3 and GetCleanInfoV3 command classes to use the new API endpoint.
Updated the API request execution logic in command.py to include a new branch for the IoT control endpoint.

Reviewed Changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.

File	Description
deebot_client/const.py	Added new constant for the IoT control API endpoint.
deebot_client/commands/json/clean.py	Added new command classes (CleanV3, GetCleanInfoV3) and updated CleanAreaV3 accordingly.
deebot_client/commands/json/init.py	Updated exports to include the new CleanV3 and GetCleanInfoV3 commands.
deebot_client/command.py	Updated API request logic to branch based on the new PATH_API_IOT_CONTROL endpoint.

Copilot · 2025-05-23T11:51:24Z

deebot_client/command.py

+                headers=REQUEST_HEADERS,
+            )
+
+        elif self._api_path == PATH_API_IOT_CONTROL:


The branch for handling PATH_API_IOT_CONTROL contains placeholder values ('body = ...' and 'query_params = ...'). Please implement the actual payload and query parameters to ensure correct functionality.

This reverts commit eb3e1ea.

deebot_client/commands/json/set_error.py

edenhaus · 2025-05-25T18:19:29Z

deebot_client/commands/json/error.py

@@ -34,6 +38,12 @@ def _handle_body_data_dict(

        error: int | None = 0

+        if 505 in codes:


Why are you doing this??

Please add the error to the ERROR_CODES

Added.
I'm not quite sure what the error means but the android app did this when pressing start:-

send start mowing

get error 505

send remove error 505

send resume

I've added an error to the codes list

edenhaus · 2025-05-25T18:27:45Z

deebot_client/commands/json/clean.py

+            if (
+                state.state == State.DOCKED
+                and self._args["act"] == CleanAction.RESUME.value
+            ):
+                # if docked and resume, send resume...
+                self._args = self._get_args(CleanAction.RESUME)
+            elif (
+                state.state == State.DOCKED
+                and self._args["act"] == CleanAction.START.value
+            ):
+                self._args = self._get_args(CleanAction.START)


You are not changing the clean action in these two chases, so why have you added it here?

I've removed this - it was to try fix an issue which you can replicate by:-

click start

click return to dock

bot returns to dock

click start, nothing happens

Reason: bot is docked but paused, so need to send resume or end the current job.

If bot finishes the job and returns to dock, it automatically ends current job and you can press start again.

I think we should get this PR merged for now as a base and other bugs can be fixed later.

edenhaus · 2025-08-07T12:02:10Z

I maybe found better solution, I need to test it next week

deebot_client/authentication.py

+            "Calling api(%d/%d): %s",
+            i + 1,
+            MAX_RETRIES,
+            logger_request_params,


deebot_client/authentication.py

                    _LOGGER.debug(
-                        "Error calling api %s, response=%s", logger_request_params, res
+                        "Success calling api %s, response=%s",
+                        logger_request_params,


deebot_client/authentication.py

+                    return response_data
+
+                _LOGGER.debug(
+                    "Error calling api %s, response=%s", logger_request_params, res


deebot_client/authentication.py

+            _LOGGER.debug("Timeout (%d) reached on path: %s", _TIMEOUT, url)
+            raise ApiTimeoutError(path=url, timeout=_TIMEOUT) from ex
+        except ClientResponseError as ex:
+            _LOGGER.debug("Error: %s", logger_request_params, exc_info=True)


codecov · 2025-08-11T19:57:49Z

Codecov Report

❌ Patch coverage is 39.28571% with 51 lines in your changes missing coverage. Please review.
✅ Project coverage is 93.10%. Comparing base (5bff22b) to head (da7a42c).
⚠️ Report is 1 commits behind head on dev.
✅ All tests successful. No failed tests found.

Files with missing lines	Patch %	Lines
deebot_client/authentication.py	33.76%	51 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##              dev     #987      +/-   ##
==========================================
- Coverage   93.72%   93.10%   -0.63%     
==========================================
  Files         131      131              
  Lines        5020     5060      +40     
  Branches      327      326       -1     
==========================================
+ Hits         4705     4711       +6     
- Misses        252      287      +35     
+ Partials       63       62       -1

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

codspeed-hq · 2025-08-11T20:02:24Z

CodSpeed Performance Report

Merging #987 will not alter performance

_{Comparing JNickson:CleanV3-new-api-endpoint (da7a42c) with dev (5bff22b)}

Summary

✅ 6 untouched benchmarks

added inital api endpoint execute request change

d8af4f4

Copilot AI review requested due to automatic review settings May 23, 2025 11:51

JNickson closed this May 23, 2025

JNickson reopened this May 23, 2025

Copilot AI reviewed May 23, 2025

View reviewed changes

JNickson marked this pull request as draft May 23, 2025 11:52

JNickson closed this May 23, 2025

alec-pinson added 2 commits May 23, 2025 13:27

rm symlink + use new body / header

069fa9b

use 'cleanv3'

585dfac

JNickson reopened this May 23, 2025

alec-pinson and others added 10 commits May 23, 2025 13:32

missed some

b4e3226

correct path + command

53c485c

added other headers

41329b8

debug auth json

19360c0

another api required to get new auth token for control api

52cc9cd

begin adding new perms api

ebb08ed

move credentials if statement

05c625f

sst token

9eeefe3

added base url

ce5c9fc

added logging + corrected userid

df9f446

JNickson changed the title ~~added initial api endpoint execute request change~~ Ecovacs GOAT - RTK O800 updated api endpoint request changes May 23, 2025

alec-pinson and others added 9 commits May 23, 2025 18:46

some fixes

a3d7d82

updating error checking

eb3e1ea

Revert "updating error checking"

79ec978

This reverts commit eb3e1ea.

setError comment

3b73ef5

add set_error

b5a916d

added set errors for cleanv3 cannot inherit from clean

f628a7b

added clean logic in cleanv3

e033e06

after start clear 505 + extra resume step

1a67bf9

added debug for action executed

0c00cac

JNickson and others added 11 commits May 23, 2025 20:28

added resume to args

698afeb

set errors no data

a089f3c

added state check before error and resume to make sure in paused

3d4004c

slight cleanup

64de88a

try clear error 505 on get error

07158de

updated set error and clean

409dc4b

added resume if still paused after start

f2df532

added _execute

8f36c1a

removed clean execute resume part

cdd445f

send resume and start if docked

de433ba

remove GetCleanInfoV3

b618b3d

edenhaus requested changes May 25, 2025

View reviewed changes

alec-pinson added 6 commits May 27, 2025 09:25

cleanup

8853022

Merge branch 'dev' into CleanV3-new-api-endpoint

21255cf

configured precommit

7aa7491

fix precommit

5820e17

remove extra logging

073b0d7

doc string

b06ba3c

edenhaus added 3 commits August 11, 2025 15:44

Fix pre-commit findings

6f30c3d

Merge branch 'dev' into pr/JNickson/987

6337711

Create DeviceAuthenticator

eaa7c07

edenhaus changed the title ~~Ecovacs GOAT - RTK O800 updated api endpoint request changes~~ Add new API endpoint via DeviceAuthenticator Aug 11, 2025

edenhaus added the pr: enhancement PR with Improve something label Aug 11, 2025

github-advanced-security bot found potential problems Aug 11, 2025

View reviewed changes

formatting

da7a42c

edenhaus force-pushed the CleanV3-new-api-endpoint branch from 23f1880 to da7a42c Compare August 11, 2025 20:02

Fix wrong content type

1eedbbc

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

Add new API endpoint via DeviceAuthenticator #987

Add new API endpoint via DeviceAuthenticator #987

Uh oh!

JNickson commented May 23, 2025

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI May 23, 2025

Uh oh!

Uh oh!

edenhaus May 25, 2025

Uh oh!

alec-pinson May 27, 2025

Uh oh!

edenhaus May 25, 2025

Uh oh!

alec-pinson May 27, 2025

Uh oh!

edenhaus commented Aug 7, 2025

Uh oh!

Check failure

Check failure

Check failure

Check failure

codecov bot commented Aug 11, 2025 •

edited

Loading

Uh oh!

codspeed-hq bot commented Aug 11, 2025 •

edited

Loading

Uh oh!

Uh oh!

		@@ -34,6 +38,12 @@ def _handle_body_data_dict(

		error: int \| None = 0

		if 505 in codes:

Uh oh!

Add new API endpoint via DeviceAuthenticator #987

Are you sure you want to change the base?

Add new API endpoint via DeviceAuthenticator #987

Uh oh!

Conversation

JNickson commented May 23, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI May 23, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

edenhaus May 25, 2025

Choose a reason for hiding this comment

Uh oh!

alec-pinson May 27, 2025

Choose a reason for hiding this comment

Uh oh!

edenhaus May 25, 2025

Choose a reason for hiding this comment

Uh oh!

alec-pinson May 27, 2025

Choose a reason for hiding this comment

Uh oh!

edenhaus commented Aug 7, 2025

Uh oh!

Check failure

Uh oh!

Check failure

Uh oh!

Check failure

Uh oh!

Check failure

Uh oh!

codecov bot commented Aug 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

codspeed-hq bot commented Aug 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

CodSpeed Performance Report

Merging #987 will not alter performance

Summary

Uh oh!

Uh oh!

codecov bot commented Aug 11, 2025 •

edited

Loading

codspeed-hq bot commented Aug 11, 2025 •

edited

Loading