-
Notifications
You must be signed in to change notification settings - Fork 720
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 quirk for Sonoff SWV Smart Water Valve #3340
Open
benbancroft
wants to merge
2
commits into
zigpy:dev
Choose a base branch
from
benbancroft:sonoff-swv
base: dev
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
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 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,71 @@ | ||
"""Sonoff SWV - Zigbee smart water valve.""" | ||
|
||
import typing | ||
|
||
from zigpy.quirks import CustomCluster | ||
from zigpy.quirks.v2 import QuirkBuilder | ||
from zigpy.quirks.v2.homeassistant.binary_sensor import BinarySensorDeviceClass | ||
import zigpy.types as t | ||
from zigpy.zcl.foundation import BaseAttributeDefs, ZCLAttributeDef | ||
|
||
|
||
class ValveState(t.enum8): | ||
"""Water valve state.""" | ||
|
||
Water_Shortage = 1 | ||
Water_Leakage = 2 | ||
|
||
|
||
class EwelinkCluster(CustomCluster): | ||
"""Ewelink specific cluster.""" | ||
|
||
cluster_id = 0xFC11 | ||
|
||
class AttributeDefs(BaseAttributeDefs): | ||
"""Attribute definitions.""" | ||
|
||
water_supply_state = ZCLAttributeDef( | ||
id=0x500C, | ||
type=bool, | ||
) | ||
|
||
valve_leak_state = ZCLAttributeDef( | ||
id=0x500C, | ||
type=bool, | ||
) | ||
|
||
@property | ||
def _is_manuf_specific(self): | ||
return False | ||
|
||
def get(self, key: int | str, default: typing.Any | None = None) -> typing.Any: | ||
"""Map binary sensors onto bits of shared attribute.""" | ||
|
||
value = super().get(key, default) | ||
match key: | ||
case self.AttributeDefs.water_supply_state.name: | ||
return value & ValveState.Water_Shortage | ||
case self.AttributeDefs.valve_leak_state.name: | ||
return value & ValveState.Water_Leakage | ||
raise ValueError(f"Unknown attribute {key}") | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Q: I suppose key would only be one of the supported attributes but perhaps for unknown keys this should return the value? |
||
|
||
|
||
( | ||
QuirkBuilder("SONOFF", "SWV") | ||
.replaces(EwelinkCluster) | ||
.binary_sensor( | ||
EwelinkCluster.AttributeDefs.water_supply_state.name, | ||
EwelinkCluster.cluster_id, | ||
device_class=BinarySensorDeviceClass.PROBLEM, | ||
translation_key="water_supply", | ||
fallback_name="Water supply status", | ||
) | ||
.binary_sensor( | ||
EwelinkCluster.AttributeDefs.valve_leak_state.name, | ||
EwelinkCluster.cluster_id, | ||
device_class=BinarySensorDeviceClass.PROBLEM, | ||
translation_key="valve_leak", | ||
fallback_name="Valve leak status", | ||
) | ||
.add_to_registry() | ||
) |
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.
To show all the possible values if querying the cluster directly, can you also add the Normal (0) and Water leakage and shortage (3) values?