OZMO 905 Support by nanomad · Pull Request #883 · DeebotUniverse/client.py

nanomad · 2025-04-06T10:12:31Z

This PR adds support for the OZMO 900 bot, a legacy XML robot.

The work is rebased on top of #817 and #560

flubshi · 2025-04-06T19:23:20Z

Nice 😻👍

flubshi · 2025-04-07T19:46:51Z

Did you runtime test the SetCleanSpeed command? Not sure if my setup is broken, but for my XML robot an error is thrown:

await bot.execute_command(SetCleanSpeed(FanSpeedLevel.MAX))

DEBUG:deebot_client.authentication:Calling api(1/3): url=https://portal-eu.ecouser.net/api/iot/devmanager.do, params={'mid': 'ls1ok3', 'did': '56[...]-[...]a8a', 'td': 'q', 'u': 'ia[...]10', 'cv': '1.67.3', 't': 'a', 'av': '1.3.1'}, json={'cmdName': 'SetCleanSpeed', 'payload': '<ctl speed="strong" />', 'payloadType': 'x', 'td': 'q', 'toId': '56[...]-[...]a8a', 'toRes': 'Y1OW', 'toType': 'ls1ok3'}
DEBUG:deebot_client.mqtt_client.client:Received PUBLISH (d0, q0, r0, m0), 'iot/p2p/SetCleanSpeed/HelperMQClientId-sts-ngiot-mqserver-eco0-54/ecosys/1234/56[...]-[...]a8a/ls1ok3/Y1OW/q/K3bN/x', ...  (22 bytes)
DEBUG:deebot_client.mqtt_client:Got message: topic=iot/p2p/SetCleanSpeed/HelperMQClientId-sts-ngiot-mqserver-eco0-54/ecosys/1234/56[...]-[...]a8a/ls1ok3/Y1OW/q/K3bN/x, payload=b'<ctl speed="strong" />'
DEBUG:deebot_client.mqtt_client.client:Received PUBLISH (d0, q0, r0, m0), 'iot/p2p/SetCleanSpeed/56[...]-[...]a8a/ls1ok3/Y1OW/HelperMQClientId-sts-ngiot-mqserver-eco0-54/ecosys/1234/p/K3bN/x', ...  (15 bytes)
DEBUG:deebot_client.mqtt_client:Got message: topic=iot/p2p/SetCleanSpeed/56[...]-[...]a8a/ls1ok3/Y1OW/HelperMQClientId-sts-ngiot-mqserver-eco0-54/ecosys/1234/p/K3bN/x, payload=b"<ctl ret='ok'/>"
WARNING:deebot_client.message:Could not parse SetCleanSpeed: b"<ctl ret='ok'/>"
Traceback (most recent call last):
  File "/usr/lib/python3.13/xml/etree/ElementTree.py", line 1713, in feed
    self.parser.Parse(data, False)
    ~~~~~~~~~~~~~~~~~^^^^^^^^^^^^^
xml.parsers.expat.ExpatError: not well-formed (invalid token): line 1, column 1

During handling of the above exception, another exception occurred:

Traceback (most recent call last):
  File "client.py/deebot_client/message.py", line 65, in wrapper
    response = func(cls, event_bus, data)
  File "client.py/deebot_client/message.py", line 108, in handle
    return cls._handle(event_bus, message)
           ~~~~~~~~~~~^^^^^^^^^^^^^^^^^^^^
  File "client.py/deebot_client/message.py", line 138, in _handle
    return cls.__handle_str(event_bus, message)
           ~~~~~~~~~~~~~~~~^^^^^^^^^^^^^^^^^^^^
  File "client.py/deebot_client/message.py", line 126, in __handle_str
    return cls._handle_str(event_bus, message)
           ~~~~~~~~~~~~~~~^^^^^^^^^^^^^^^^^^^^
  File "client.py/deebot_client/commands/xml/common.py", line 67, in _handle_str
    xml = ElementTree.fromstring(message)
  File "client.py/.venv/lib/python3.13/site-packages/defusedxml/common.py", line 126, in fromstring
    parser.feed(text)
    ~~~~~~~~~~~^^^^^^
  File "/usr/lib/python3.13/xml/etree/ElementTree.py", line 1715, in feed
    self._raiseerror(v)
    ~~~~~~~~~~~~~~~~^^^
  File "/usr/lib/python3.13/xml/etree/ElementTree.py", line 1622, in _raiseerror
    raise err
xml.etree.ElementTree.ParseError: not well-formed (invalid token): line 1, column 1

⬆️ fixed by 17d49a0

Edit: And mypy seems unhappy too:

uv run --frozen mypy deebot_client/

⬆️ fixed

This comment is resolved

nanomad · 2025-04-07T20:06:51Z

Did you runtime test the SetCleanSpeed command? Not sure if my setup is broken, but for my XML robot an error is thrown:

await bot.execute_command(SetCleanSpeed(FanSpeedLevel.MAX))

DEBUG:deebot_client.authentication:Calling api(1/3): url=https://portal-eu.ecouser.net/api/iot/devmanager.do, params={'mid': 'ls1ok3', 'did': '56[...]-[...]a8a', 'td': 'q', 'u': 'ia[...]10', 'cv': '1.67.3', 't': 'a', 'av': '1.3.1'}, json={'cmdName': 'SetCleanSpeed', 'payload': '<ctl speed="strong" />', 'payloadType': 'x', 'td': 'q', 'toId': '56[...]-[...]a8a', 'toRes': 'Y1OW', 'toType': 'ls1ok3'}
DEBUG:deebot_client.mqtt_client.client:Received PUBLISH (d0, q0, r0, m0), 'iot/p2p/SetCleanSpeed/HelperMQClientId-sts-ngiot-mqserver-eco0-54/ecosys/1234/56[...]-[...]a8a/ls1ok3/Y1OW/q/K3bN/x', ...  (22 bytes)
DEBUG:deebot_client.mqtt_client:Got message: topic=iot/p2p/SetCleanSpeed/HelperMQClientId-sts-ngiot-mqserver-eco0-54/ecosys/1234/56[...]-[...]a8a/ls1ok3/Y1OW/q/K3bN/x, payload=b'<ctl speed="strong" />'
DEBUG:deebot_client.mqtt_client.client:Received PUBLISH (d0, q0, r0, m0), 'iot/p2p/SetCleanSpeed/56[...]-[...]a8a/ls1ok3/Y1OW/HelperMQClientId-sts-ngiot-mqserver-eco0-54/ecosys/1234/p/K3bN/x', ...  (15 bytes)
DEBUG:deebot_client.mqtt_client:Got message: topic=iot/p2p/SetCleanSpeed/56[...]-[...]a8a/ls1ok3/Y1OW/HelperMQClientId-sts-ngiot-mqserver-eco0-54/ecosys/1234/p/K3bN/x, payload=b"<ctl ret='ok'/>"
WARNING:deebot_client.message:Could not parse SetCleanSpeed: b"<ctl ret='ok'/>"
Traceback (most recent call last):
  File "/usr/lib/python3.13/xml/etree/ElementTree.py", line 1713, in feed
    self.parser.Parse(data, False)
    ~~~~~~~~~~~~~~~~~^^^^^^^^^^^^^
xml.parsers.expat.ExpatError: not well-formed (invalid token): line 1, column 1

During handling of the above exception, another exception occurred:

Traceback (most recent call last):
  File "client.py/deebot_client/message.py", line 65, in wrapper
    response = func(cls, event_bus, data)
  File "client.py/deebot_client/message.py", line 108, in handle
    return cls._handle(event_bus, message)
           ~~~~~~~~~~~^^^^^^^^^^^^^^^^^^^^
  File "client.py/deebot_client/message.py", line 138, in _handle
    return cls.__handle_str(event_bus, message)
           ~~~~~~~~~~~~~~~~^^^^^^^^^^^^^^^^^^^^
  File "client.py/deebot_client/message.py", line 126, in __handle_str
    return cls._handle_str(event_bus, message)
           ~~~~~~~~~~~~~~~^^^^^^^^^^^^^^^^^^^^
  File "client.py/deebot_client/commands/xml/common.py", line 67, in _handle_str
    xml = ElementTree.fromstring(message)
  File "client.py/.venv/lib/python3.13/site-packages/defusedxml/common.py", line 126, in fromstring
    parser.feed(text)
    ~~~~~~~~~~~^^^^^^
  File "/usr/lib/python3.13/xml/etree/ElementTree.py", line 1715, in feed
    self._raiseerror(v)
    ~~~~~~~~~~~~~~~~^^^
  File "/usr/lib/python3.13/xml/etree/ElementTree.py", line 1622, in _raiseerror
    raise err
xml.etree.ElementTree.ParseError: not well-formed (invalid token): line 1, column 1

I did but turns out sometimes it replies with bytes or bytearray (paho can do that). I've added the decoding to the XML message as well as I did for events altough I'm not sure wheter that decoding should be pushed further up the chain

flubshi · 2025-04-07T20:13:05Z

I'm not sure wheter that decoding should be pushed further up the chain

🤷‍♂️
Maybe @edenhaus as the maintainer can answer this.

nanomad · 2025-04-07T20:40:10Z

TODO List:

Clean job end state decoding (success / stop / error)
Figure out how HA fetches the "clean duration" statistics
Network Diagnostics

flubshi · 2025-04-09T18:09:27Z

        ),
        network=CapabilityEvent(NetworkInfoEvent, []),
        play_sound=CapabilityExecute(PlaySound),
-        settings=CapabilitySettings(


I think the settings key is required:

File "client.py/deebot_client/hardware/deebot/2pv572.py", line 55, in <module> Capabilities( ~~~~~~~~~~~~^ availability=CapabilityEvent(AvailabilityEvent, []), ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ...<33 lines>... ), ^^ ), ^ TypeError: Capabilities.__init__() missing 1 required keyword-only argument: 'settings'

@flubshi That's correct but we do not support any of those settings yet. In particular the volume seems mandatory.
I'm going to push a "fake volume" command tomorrow so that both HA and the library are happy :)

(Actually, my bot doesn't support ANY volume configuration at all)

The XML robot Deebot 900 has also no volume configuration. Maybe we should make it optional in the library instead of a fake module.

nanomad · 2025-04-13T15:47:21Z

@flubshi I've added map support as well, feel free to check if it works for you as well

flubshi · 2025-04-13T17:46:59Z

@flubshi I've added map support as well, feel free to check if it works for you as well

Wow, yes - it works! Thanks a lot!
I modified my ls1ok3.py based on your 2pv572.py (it is the same, except for the waterinfo).

The map of the bot is now available in Home Assistant :)

Most sensors are working as well.
Not sure how/whether the room info is displayed in Home Assistant, but using the room IDs from API to clean a specific room works as expected. I was able to clean the kitchen via voice assistant.

nanomad · 2025-04-14T19:38:43Z

@flubshi two new features for you to test:

HA should now display the bot trace in overlay
HA should rebuild the map in realtime while the bot is cleaning (as the app does)

edenhaus

Thanks for your contribution :)
This PR is huge and needs to be splitted into multiple PRs.
Please create a PR for any new added command. Similar commands like all map commands can be in one PR.
The last PR should be the PR, where the capabilities files for the new bot is added.
As the capabilities file changes include breaking change, I want that PR as small as possible.
A lot of test are missing for the newly added commands. Please add them

edenhaus · 2025-04-16T08:54:48Z

    except ValueError as err:
-        msg = f'Could not convert "{value}" of {name} into {type_}'
-        raise DeebotError(msg) from err
+        if hasattr(type_, "from_xml"):


This is xml specific and should be in the XML specific files and not in the general one

edenhaus · 2025-04-16T08:57:23Z

                    status = State.DOCKED
                case "idle":
-                    status = State.IDLE
+                    pass


Why are you changing this line?

edenhaus · 2025-04-16T08:58:50Z

+            elif clean_action == CleanAction.PAUSE:
+                event_bus.notify(StateEvent(State.PAUSED))
+            else:
+                _LOGGER.debug("Ignored CleanState %s", clean_action)


Why are we ignoring this state? If we don't know what this state means, then we should return HandlingResult.analyse() instead

edenhaus · 2025-04-16T09:01:39Z



-class XmlSetCommand(ExecuteCommand, SetCommand, ABC):
+class XmlCommandMqttP2P(XmlCommand, CommandMqttP2P, ABC):


CommandMqttP2P should only be used for commands, where the bot will not inform us if the command was changed via the app. Newer models are always sending a message if the state has changed and therefore this class is somehow deprecated and only used if the bot really doesn't send any updates

Indeed I agree, I'll get rid of this as I see no value. We do get notification via messages for most of the changes anyway. The only thing I'm not so sure about is SetOnOff (which I have locally and has no message counterpart, but I'll leave that for another PR)

edenhaus · 2025-04-16T09:10:12Z


-    amount: WaterAmount
    # None means no data available
+    amount: WaterAmount | None = None


When is the amount None and another field not?

XML bots have two commands:
One to tell you if the waterbox is attached (GetWaterBoxInfo), the other to give you the water level (GetWaterPermeability) . So we cannot always publish the water amount

Co-authored-by: flubshi <4031504+flubshi@users.noreply.github.com>

nanomad · 2025-04-29T06:22:20Z

Sure, I'll have the draft in a few hours Il Lun 28 Apr 2025, 11:21 Robert Resch ***@***.***> ha scritto:

…

*edenhaus* left a comment (DeebotUniverse/client.py#883) <#883 (comment)> Would it be possible to update this PR, so we can merge it before Wednesday so that the functionality will be in the next HA version. It's fine if not all commands are supported yet. We can always improve it later :) — Reply to this email directly, view it on GitHub <#883 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAIT3RR7SPHOD6ARNO4TMWD23XXKFAVCNFSM6AAAAAB2RRCUN6VHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDQMZUGU3TINJUG4> . You are receiving this because you authored the thread.Message ID: ***@***.***>

nanomad marked this pull request as draft April 6, 2025 10:12

nanomad force-pushed the feature/2pv572-support branch from bcfeaf6 to ea5b144 Compare April 6, 2025 10:52

nanomad marked this pull request as ready for review April 6, 2025 11:11

nanomad changed the title ~~[WIP] OZMO 900 Support~~ OZMO 900 Support Apr 6, 2025

nanomad mentioned this pull request Apr 6, 2025

Deebot not work after 2025.3.0 update Ligio/hacc-ozmo#53

Open

nanomad changed the title ~~OZMO 900 Support~~ OZMO 905 Support Apr 6, 2025

flubshi reviewed Apr 7, 2025

View reviewed changes

Comment thread deebot_client/commands/xml/water_info.py Outdated

Comment thread deebot_client/hardware/deebot/2pv572.py Outdated

nanomad force-pushed the feature/2pv572-support branch from 4fd891e to 00948d6 Compare April 7, 2025 20:34

flubshi reviewed Apr 9, 2025

View reviewed changes

flubshi reviewed Apr 12, 2025

View reviewed changes

Comment thread deebot_client/hardware/deebot/2pv572.py

nanomad force-pushed the feature/2pv572-support branch from f6abb2c to 336346f Compare April 14, 2025 19:36

edenhaus requested changes Apr 16, 2025

View reviewed changes

nanomad marked this pull request as draft April 19, 2025 08:16

nanomad force-pushed the feature/2pv572-support branch 2 times, most recently from d022c86 to a6fc2d2 Compare April 19, 2025 11:11

nanomad and others added 7 commits April 22, 2025 15:21

Add legacy GetNetInfo JSON command

dd996da

Initial Ozmo 900 support

192b023

Implement XML message handling

fe04e13

Ignore ruff error

ae3309a

Do not go idle while cleaning

9c5e88d

Use correct Charge and PlaySound commands

28544b8

Always notify idle and paused states

db9af4f

nanomad and others added 20 commits April 22, 2025 15:30

Add clean logs capability

30642f9

Convert CleanAction to CleanState

f3a0b60

Apply suggestions from code review

677616e

Co-authored-by: flubshi <4031504+flubshi@users.noreply.github.com>

Fix bytes and bytearray decoding

12fd347

Ignore MapP word as it is a message type

7b6e737

Run ruff format

935b92a

2pv572: Disable volume configuration (unsupported in ecovacs app)

ee9a687

Fix cleaning tests

b520287

Fix charge state tests

47aa64d

Make volume capability optional

ea6060c

Add 2pv572 LifeSpan Capabilities

f448abe

Fix type linting error in device.py

cfb095f

Add legacy GetNetInfo JSON command

ca44b20

Add more XML commands and messages

75ad3a4

Add decoding for ReportStatsEvent

a204679

Add water capability

0d5fa49

Map workflow

e0ce03f

Handle MapTrace events

ffc41fc

Realtime map updates

895a635

Enable trace reporting from the bot.

b22f593

nanomad force-pushed the feature/2pv572-support branch from a6fc2d2 to b22f593 Compare April 22, 2025 13:38

Rollback deprecated change

e241f9e

nanomad closed this Apr 29, 2025



		class XmlSetCommand(ExecuteCommand, SetCommand, ABC):
		class XmlCommandMqttP2P(XmlCommand, CommandMqttP2P, ABC):

Uh oh!

Conversation

nanomad commented Apr 6, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

flubshi commented Apr 6, 2025

Uh oh!

Uh oh!

Uh oh!

flubshi commented Apr 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

nanomad commented Apr 7, 2025

Uh oh!

flubshi commented Apr 7, 2025

Uh oh!

nanomad commented Apr 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

nanomad commented Apr 13, 2025

Uh oh!

flubshi commented Apr 13, 2025

Uh oh!

nanomad commented Apr 14, 2025

Uh oh!

edenhaus left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

nanomad Apr 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

nanomad commented Apr 29, 2025 via email

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

nanomad commented Apr 6, 2025 •

edited

Loading

flubshi commented Apr 7, 2025 •

edited

Loading

nanomad commented Apr 7, 2025 •

edited

Loading

nanomad Apr 19, 2025 •

edited

Loading