Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add support for Deebot N8 Pro+ #617

Merged
merged 1 commit into from
Dec 5, 2024
Merged

Conversation

Kokahontas13
Copy link
Contributor

@Kokahontas13 Kokahontas13 commented Dec 5, 2024

  • Added support for the Deebot N8 Pro +
  • Updated tests to include new device with id "ifbw08"

Summary by CodeRabbit

  • New Features

    • Introduced a comprehensive configuration for the robotic vacuum device, enhancing operational capabilities including cleaning, charging, and advanced features like fan speed control.
  • Bug Fixes

    • Updated testing framework to include the new device identifier, ensuring robust validation of device capabilities and expected behaviors.

Copy link
Contributor

coderabbitai bot commented Dec 5, 2024

Walkthrough

The changes introduce a new file, ifbw08.py, within the deebot_client framework, defining the operational capabilities of a robotic vacuum. This file includes command and event handlers for various functions such as cleaning, charging, and battery management. Additionally, it enhances the test suite in tests/hardware/test_init.py by incorporating the new device identifier "ifbw08" and updating event-command mappings for existing devices, ensuring comprehensive testing coverage for the new functionalities.

Changes

File Path Change Summary
deebot_client/hardware/deebot/ifbw08.py New file added defining capabilities for a robotic vacuum, including command and event handlers.
tests/hardware/test_init.py Updated to include "ifbw08" in device tests and enhanced event-command mappings for existing devices.

Possibly related PRs

  • Add DEEBOT T10 TURBO #489: The changes in 9s1s80.py introduce capabilities and commands for a robotic vacuum, similar to the comprehensive configuration defined in ifbw08.py.
  • GOAT GX-600 support added #506: The addition of a new device identifier in test_init.py for the GOAT GX-600 relates to the testing framework that now includes the new device capabilities defined in ifbw08.py.
  • Add Deebot T30 Omni #548: The new module for the Deebot T30 Omni likely introduces similar functionalities as those defined in ifbw08.py, focusing on device capabilities and commands.
  • Add Deebot T30 Pro Omni #597: The new file for the Deebot T30 Pro Omni also encapsulates various capabilities and functionalities, paralleling the structure established in ifbw08.py.
  • Add Deebot N20 Pro Plus #608: The addition of capabilities for the Deebot N20 Pro Plus aligns with the comprehensive configuration approach seen in ifbw08.py.
  • Add support for Deebot N8 #613: The support for the Deebot N8 series introduces capabilities that are consistent with the operational features defined in ifbw08.py.

Suggested labels

pr: new-feature

Suggested reviewers

  • edenhaus

🐰 In the world of dust and cheer,
A new vacuum draws near.
With commands and events so bright,
Cleaning floors, day and night.
In tests we trust, the code will play,
For a tidy home, hip-hip-hooray! 🧹✨


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
🪧 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 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.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (1)
tests/hardware/test_init.py (1)

Line range hint 77-126: Add test case for the new device "ifbw08" in the parameterized tests

To ensure thorough testing of the new device's capabilities, please add a test case for "ifbw08" in the test_capabilities_event_extraction function.

Apply this diff to include the new test case:

     ids=["5xu9h3", "itk04l", "yna5xi", "p95mgv"],
 )
 async def test_capabilities_event_extraction(
     class_: str, expected: dict[type[Event], list[Command]]
 ) -> None:
     info = await get_static_device_info(class_)
     assert info is not None
     capabilities = info.capabilities
     assert capabilities._events.keys() == expected.keys()
     for event, expected_commands in expected.items():
         assert (
             capabilities.get_refresh_commands(event) == expected_commands
         ), f"Refresh commands doesn't match for {event}"
 
+@pytest.mark.parametrize(
+    ("class_", "expected"),
+    [
+        (
+            "ifbw08",
+            {
+                AdvancedModeEvent: [GetAdvancedMode()],
+                AvailabilityEvent: [GetBattery(is_available_check=True)],
+                BatteryEvent: [GetBattery()],
+                CachedMapInfoEvent: [GetCachedMapInfo()],
+                CarpetAutoFanBoostEvent: [GetCarpetAutoFanBoost()],
+                CleanCountEvent: [GetCleanCount()],
+                CleanPreferenceEvent: [GetCleanPreference()],
+                ContinuousCleaningEvent: [GetContinuousCleaning()],
+                CustomCommandEvent: [],
+                ErrorEvent: [GetError()],
+                FanSpeedEvent: [GetFanSpeed()],
+                LifeSpanEvent: [
+                    GetLifeSpan(
+                        [
+                            LifeSpan.BRUSH,
+                            LifeSpan.FILTER,
+                            LifeSpan.SIDE_BRUSH,
+                            LifeSpan.UNIT_CARE,
+                        ]
+                    )
+                ],
+                MajorMapEvent: [GetMajorMap()],
+                MapChangedEvent: [],
+                MapTraceEvent: [GetMapTrace()],
+                MultimapStateEvent: [GetMultimapState()],
+                NetworkInfoEvent: [GetNetInfo()],
+                PositionsEvent: [GetPos()],
+                ReportStatsEvent: [],
+                RoomsEvent: [GetCachedMapInfo()],
+                StateEvent: [GetChargeState(), GetCleanInfo()],
+                StatsEvent: [GetStats()],
+                TotalStatsEvent: [GetTotalStats()],
+                TrueDetectEvent: [GetTrueDetect()],
+                VolumeEvent: [GetVolume()],
+                WaterInfoEvent: [GetWaterInfo()],
+            },
+        ),
+    ],
+    ids=["ifbw08"],
+)
+async def test_capabilities_event_extraction_ifbw08(
+    class_: str, expected: dict[type[Event], list[Command]]
+) -> None:
+    info = await get_static_device_info(class_)
+    assert info is not None
+    capabilities = info.capabilities
+    assert capabilities._events.keys() == expected.keys()
+    for event, expected_commands in expected.items():
+        assert (
+            capabilities.get_refresh_commands(event) == expected_commands
+        ), f"Refresh commands doesn't match for {event}"
+
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between aa7b6e9 and 23e250e.

📒 Files selected for processing (2)
  • deebot_client/hardware/deebot/ifbw08.py (1 hunks)
  • tests/hardware/test_init.py (1 hunks)
🔇 Additional comments (2)
deebot_client/hardware/deebot/ifbw08.py (1)

1-1: ⚠️ Potential issue

Incorrect module name at the top of the file

The file is named ifbw08.py, but the first line contains x5d34r.py. This appears to be a copy-paste error. Please update the module name to reflect the correct filename.

Apply this diff to correct the module name:

-x5d34r.py
+ifbw08.py

Likely invalid or redundant comment.

tests/hardware/test_init.py (1)

266-266: LGTM!

The addition of "ifbw08" to the devices list in the test_all_models_loaded function ensures that the new device is included in the model loading tests.

@edenhaus edenhaus added enhancement New feature or request pr: new-feature PR, which adds a new feature and removed enhancement New feature or request labels Dec 5, 2024
Copy link

codecov bot commented Dec 5, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 86.42%. Comparing base (aa7b6e9) to head (23e250e).
Report is 1 commits behind head on dev.

Additional details and impacted files
@@           Coverage Diff           @@
##              dev     #617   +/-   ##
=======================================
  Coverage   86.42%   86.42%           
=======================================
  Files          88       88           
  Lines        3301     3301           
  Branches      298      298           
=======================================
  Hits         2853     2853           
  Misses        394      394           
  Partials       54       54           

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

Copy link
Contributor

@edenhaus edenhaus left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @Kokahontas13 👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
pr: new-feature PR, which adds a new feature
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants