Add Deebot X5 Pro Omni (lr4qcs)

[XxInvictus]

• Initial clone of most compatible, requires extra features not supported yet in T30 Omni new features (full support) #555

Summary by CodeRabbit

• New Features

  • Introduced comprehensive configuration for a robotic vacuum, enhancing capabilities such as battery management, cleaning operations, error handling, fan speed control, lifespan management, mapping capabilities, network information, sound playback, and settings management.

• Tests

  • Expanded test coverage for the new device identifier and updated event and command mappings for improved validation of device capabilities.

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

The changes introduce a new file, lr4qcs.py, within the deebot_client framework, which defines a StaticDeviceInfo instance for a robotic vacuum. This file encapsulates various functionalities, including battery management, cleaning operations, error handling, fan speed control, lifespan management, mapping capabilities, network information, sound playback, and settings management. Additionally, modifications to the test suite in tests/hardware/test_init.py expand the coverage for device capabilities and enhance event extraction validation for multiple device identifiers.

Changes

File Path	Change Summary
deebot_client/hardware/deebot/lr4qcs.py	Introduced a new file defining StaticDeviceInfo with capabilities for battery management, cleaning operations, error handling, fan speed control, and more.
tests/hardware/test_init.py	Updated test suite to include new device identifier "lr4qcs" and enhanced event extraction tests for multiple device classes, ensuring comprehensive coverage.

Possibly related PRs

• Add DEEBOT T10 TURBO #489: Introduces capabilities for a robotic vacuum, similar to those in lr4qcs.py, including battery management and cleaning operations.
• Add support for Deebot T10 #618: Adds a StaticDeviceInfo instance and capabilities closely aligned with those in lr4qcs.py, such as battery management and cleaning actions.
• adding Deebot N30 Omni support (zwkcqc) #622: Defines a comprehensive configuration for a robotic vacuum, including capabilities like battery management and cleaning operations, similar to lr4qcs.py.
• Add support for Deebot T9 AIVI (8kwdb4) #630: Introduces capabilities for the DEEBOT OZMO T9 AIVI, including functionalities like battery management and cleaning operations, akin to those in lr4qcs.py.

Suggested labels

pr: new-feature

Suggested reviewers

• edenhaus

🐰 In the land of dust and cheer,
A vacuum's dance is drawing near.
With battery checks and cleaning might,
It sweeps away the dirt from sight.
New tests are here, to keep it bright,
A rabbit's joy in every byte! 🐇✨

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between e0fde3d and da52c67.

📒 Files selected for processing (2)

• deebot_client/hardware/deebot/lr4qcs.py (1 hunks)
• tests/hardware/test_init.py (1 hunks)

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR. (Experiment)
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 86.68%. Comparing base (e0fde3d) to head (da52c67).
Report is 2 commits behind head on dev.

Additional details and impacted files

@@           Coverage Diff           @@
##              dev     #659   +/-   ##
=======================================
  Coverage   86.68%   86.68%           
=======================================
  Files          90       90           
  Lines        3365     3365           
  Branches      298      298           
=======================================
  Hits         2917     2917           
  Misses        394      394           
  Partials       54       54           

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

[edenhaus]

Thanks @XxInvictus 👍

[n-andflash]

Hi @XxInvictus ,
My Deebot X5 Pro Omni has "rvflzn", not "lr4qcs". What is the difference? Should I PR this one?

[XxInvictus]

@n-andflash yeah you should be able to use this as a template and symlink to the same file for your model id. Probably just a regional thing :)