-
-
Notifications
You must be signed in to change notification settings - Fork 149
Add Support for Deebot N8+ Black Variant #644
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
Merged
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,198 @@ | ||
| """DEEBOT N8+ Black Capabilities.""" | ||
|
|
||
| from __future__ import annotations | ||
|
|
||
| from deebot_client.capabilities import ( | ||
| Capabilities, | ||
| CapabilityClean, | ||
| CapabilityCleanAction, | ||
| CapabilityCustomCommand, | ||
| CapabilityEvent, | ||
| CapabilityExecute, | ||
| CapabilityLifeSpan, | ||
| CapabilityMap, | ||
| CapabilitySet, | ||
| CapabilitySetEnable, | ||
| CapabilitySettings, | ||
| CapabilitySetTypes, | ||
| CapabilityStats, | ||
| DeviceType, | ||
| ) | ||
| from deebot_client.commands.json.advanced_mode import GetAdvancedMode, SetAdvancedMode | ||
| from deebot_client.commands.json.battery import GetBattery | ||
| from deebot_client.commands.json.carpet import ( | ||
| GetCarpetAutoFanBoost, | ||
| SetCarpetAutoFanBoost, | ||
| ) | ||
| from deebot_client.commands.json.charge import Charge | ||
| from deebot_client.commands.json.charge_state import GetChargeState | ||
| from deebot_client.commands.json.clean import Clean, CleanArea, GetCleanInfo | ||
| from deebot_client.commands.json.clean_count import GetCleanCount, SetCleanCount | ||
| from deebot_client.commands.json.clean_logs import GetCleanLogs | ||
| from deebot_client.commands.json.clean_preference import ( | ||
| GetCleanPreference, | ||
| SetCleanPreference, | ||
| ) | ||
| from deebot_client.commands.json.continuous_cleaning import ( | ||
| GetContinuousCleaning, | ||
| SetContinuousCleaning, | ||
| ) | ||
| from deebot_client.commands.json.custom import CustomCommand | ||
| from deebot_client.commands.json.error import GetError | ||
| from deebot_client.commands.json.fan_speed import GetFanSpeed, SetFanSpeed | ||
| from deebot_client.commands.json.life_span import GetLifeSpan, ResetLifeSpan | ||
| from deebot_client.commands.json.map import GetCachedMapInfo, GetMajorMap, GetMapTrace | ||
| from deebot_client.commands.json.multimap_state import ( | ||
| GetMultimapState, | ||
| SetMultimapState, | ||
| ) | ||
| from deebot_client.commands.json.network import GetNetInfo | ||
| from deebot_client.commands.json.play_sound import PlaySound | ||
| from deebot_client.commands.json.pos import GetPos | ||
| from deebot_client.commands.json.relocation import SetRelocationState | ||
| from deebot_client.commands.json.stats import GetStats, GetTotalStats | ||
| from deebot_client.commands.json.true_detect import GetTrueDetect, SetTrueDetect | ||
| from deebot_client.commands.json.volume import GetVolume, SetVolume | ||
| from deebot_client.commands.json.water_info import GetWaterInfo, SetWaterInfo | ||
| from deebot_client.const import DataType | ||
| from deebot_client.events import ( | ||
| AdvancedModeEvent, | ||
| AvailabilityEvent, | ||
| BatteryEvent, | ||
| CachedMapInfoEvent, | ||
| CarpetAutoFanBoostEvent, | ||
| CleanCountEvent, | ||
| CleanLogEvent, | ||
| CleanPreferenceEvent, | ||
| ContinuousCleaningEvent, | ||
| CustomCommandEvent, | ||
| ErrorEvent, | ||
| FanSpeedEvent, | ||
| FanSpeedLevel, | ||
| LifeSpan, | ||
| LifeSpanEvent, | ||
| MajorMapEvent, | ||
| MapChangedEvent, | ||
| MapTraceEvent, | ||
| MultimapStateEvent, | ||
| NetworkInfoEvent, | ||
| PositionsEvent, | ||
| ReportStatsEvent, | ||
| RoomsEvent, | ||
| StateEvent, | ||
| StatsEvent, | ||
| TotalStatsEvent, | ||
| TrueDetectEvent, | ||
| VolumeEvent, | ||
| WaterAmount, | ||
| WaterInfoEvent, | ||
| ) | ||
| from deebot_client.models import StaticDeviceInfo | ||
| from deebot_client.util import short_name | ||
|
|
||
| from . import DEVICES | ||
|
|
||
| DEVICES[short_name(__name__)] = StaticDeviceInfo( | ||
| DataType.JSON, | ||
| Capabilities( | ||
| device_type=DeviceType.VACUUM, | ||
| availability=CapabilityEvent( | ||
| AvailabilityEvent, [GetBattery(is_available_check=True)] | ||
| ), | ||
| battery=CapabilityEvent(BatteryEvent, [GetBattery()]), | ||
| charge=CapabilityExecute(Charge), | ||
| clean=CapabilityClean( | ||
| action=CapabilityCleanAction(command=Clean, area=CleanArea), | ||
| continuous=CapabilitySetEnable( | ||
| ContinuousCleaningEvent, | ||
| [GetContinuousCleaning()], | ||
| SetContinuousCleaning, | ||
| ), | ||
| count=CapabilitySet(CleanCountEvent, [GetCleanCount()], SetCleanCount), | ||
| log=CapabilityEvent(CleanLogEvent, [GetCleanLogs()]), | ||
| preference=CapabilitySetEnable( | ||
| CleanPreferenceEvent, [GetCleanPreference()], SetCleanPreference | ||
| ), | ||
| ), | ||
| custom=CapabilityCustomCommand( | ||
| event=CustomCommandEvent, get=[], set=CustomCommand | ||
| ), | ||
| error=CapabilityEvent(ErrorEvent, [GetError()]), | ||
| fan_speed=CapabilitySetTypes( | ||
| event=FanSpeedEvent, | ||
| get=[GetFanSpeed()], | ||
| set=SetFanSpeed, | ||
| types=( | ||
| FanSpeedLevel.QUIET, | ||
| FanSpeedLevel.NORMAL, | ||
| FanSpeedLevel.MAX, | ||
| FanSpeedLevel.MAX_PLUS, | ||
| ), | ||
| ), | ||
| life_span=CapabilityLifeSpan( | ||
| types=( | ||
| LifeSpan.BRUSH, | ||
| LifeSpan.FILTER, | ||
| LifeSpan.SIDE_BRUSH, | ||
| LifeSpan.UNIT_CARE, | ||
| ), | ||
| event=LifeSpanEvent, | ||
| get=[ | ||
| GetLifeSpan( | ||
| [ | ||
| LifeSpan.BRUSH, | ||
| LifeSpan.FILTER, | ||
| LifeSpan.SIDE_BRUSH, | ||
| LifeSpan.UNIT_CARE, | ||
| ] | ||
| ) | ||
| ], | ||
| reset=ResetLifeSpan, | ||
| ), | ||
| map=CapabilityMap( | ||
| cached_info=CapabilityEvent(CachedMapInfoEvent, [GetCachedMapInfo()]), | ||
| changed=CapabilityEvent(MapChangedEvent, []), | ||
| major=CapabilityEvent(MajorMapEvent, [GetMajorMap()]), | ||
| multi_state=CapabilitySetEnable( | ||
| MultimapStateEvent, [GetMultimapState()], SetMultimapState | ||
| ), | ||
| position=CapabilityEvent(PositionsEvent, [GetPos()]), | ||
| relocation=CapabilityExecute(SetRelocationState), | ||
| rooms=CapabilityEvent(RoomsEvent, [GetCachedMapInfo()]), | ||
| trace=CapabilityEvent(MapTraceEvent, [GetMapTrace()]), | ||
| ), | ||
| network=CapabilityEvent(NetworkInfoEvent, [GetNetInfo()]), | ||
| play_sound=CapabilityExecute(PlaySound), | ||
| settings=CapabilitySettings( | ||
| advanced_mode=CapabilitySetEnable( | ||
| AdvancedModeEvent, [GetAdvancedMode()], SetAdvancedMode | ||
| ), | ||
| carpet_auto_fan_boost=CapabilitySetEnable( | ||
| CarpetAutoFanBoostEvent, | ||
| [GetCarpetAutoFanBoost()], | ||
| SetCarpetAutoFanBoost, | ||
| ), | ||
| true_detect=CapabilitySetEnable( | ||
| TrueDetectEvent, [GetTrueDetect()], SetTrueDetect | ||
| ), | ||
| volume=CapabilitySet(VolumeEvent, [GetVolume()], SetVolume), | ||
| ), | ||
| state=CapabilityEvent(StateEvent, [GetChargeState(), GetCleanInfo()]), | ||
| stats=CapabilityStats( | ||
| clean=CapabilityEvent(StatsEvent, [GetStats()]), | ||
| report=CapabilityEvent(ReportStatsEvent, []), | ||
| total=CapabilityEvent(TotalStatsEvent, [GetTotalStats()]), | ||
| ), | ||
| water=CapabilitySetTypes( | ||
| event=WaterInfoEvent, | ||
| get=[GetWaterInfo()], | ||
| set=SetWaterInfo, | ||
| types=( | ||
| WaterAmount.LOW, | ||
| WaterAmount.MEDIUM, | ||
| WaterAmount.HIGH, | ||
| WaterAmount.ULTRAHIGH, | ||
| ), | ||
| ), | ||
| ), | ||
| ) | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🛠️ Refactor suggestion
Consider reusing existing capabilities to avoid code duplication
Since the DEEBOT N8+ Black variant (
"b2jqs4") is functionally identical to the white variant, you can register the new class ID to point to the existingStaticDeviceInfoinstance of the white variant. This approach reduces code duplication and simplifies future maintenance.You can modify the device registration in the existing file for the white variant (e.g.,
b2jqs3.py) to include the new class ID:# In b2jqs3.py DEVICES[short_name(__name__)] = StaticDeviceInfo( # existing capabilities... ) +DEVICES["b2jqs4"] = DEVICES[short_name(__name__)]Alternatively, if the devices are identical except for the class ID, you can create a shared module for common capabilities and import it in both files.