-
Notifications
You must be signed in to change notification settings - Fork 555
SONOFF/SWV1C #3157
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
Open
yanggx24
wants to merge
2
commits into
SmartThingsCommunity:main
Choose a base branch
from
yanggx24:main
base: main
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
SONOFF/SWV1C #3157
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
14 changes: 14 additions & 0 deletions
14
drivers/SmartThings/zigbee-valve/profiles/valve-battery.yml
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,14 @@ | ||
| name: valve-battery | ||
| components: | ||
| - id: main | ||
| capabilities: | ||
| - id: valve | ||
| version: 1 | ||
| - id: battery | ||
| version: 1 | ||
| - id: firmwareUpdate | ||
| version: 1 | ||
| - id: refresh | ||
| version: 1 | ||
| categories : | ||
| - name: WaterValve |
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
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,118 @@ | ||
| -- Copyright 2026 SmartThings, Inc. | ||
| -- Licensed under the Apache License, Version 2.0 | ||
|
|
||
| local capabilities = require "st.capabilities" | ||
| local zcl_clusters = require "st.zigbee.zcl.clusters" | ||
| local OnOff = zcl_clusters.OnOff | ||
| local PowerConfiguration = zcl_clusters.PowerConfiguration | ||
| local utils = require "st.utils" | ||
|
|
||
| -- Battery Polling Interval (seconds): SWV1C is a battery sleep device, polling every 2 hours | ||
| local BATTERY_POLL_INTERVAL = 7200 | ||
|
|
||
| -- SWV1C Fingerprint list | ||
| local FINGERPRINTS = { | ||
| { mfr = "SONOFF", model = "SWV-ZFU" }, | ||
| { mfr = "SONOFF", model = "SWV-ZFE" }, | ||
| { mfr = "SONOFF", model = "SWV-ZNU" }, | ||
| { mfr = "SONOFF", model = "SWV-ZNE" } | ||
| } | ||
|
|
||
| --- OnOff Property Reporting Handler → Valve Capability Point Event | ||
| --- It must be handled explicitly because the child driver defines capability_handlers. | ||
| --- The default OnOff→valve mapping from the parent driver will be skipped (only OnOff→switch remains) | ||
| --- @param driver table Driver instance | ||
| --- @param device table Device instance | ||
| --- @param value table Zigbee attribute value | ||
| local function onoff_attr_handler(driver, device, value) | ||
| local is_on = value.value ~= false and value.value ~= 0 | ||
| if is_on then | ||
| device:emit_event(capabilities.valve.valve.open()) | ||
| else | ||
| device:emit_event(capabilities.valve.valve.closed()) | ||
| end | ||
| end | ||
|
|
||
| --- Battery Percentage Attribute Handler | ||
| --- Zigbee BatteryPercentageRemaining range 0-200 (0%-100%), needs to be divided by 2 | ||
| --- @param driver table Driver instance | ||
| --- @param device table Device instance | ||
| --- @param value table Zigbee attribute value | ||
| local function battery_percentage_handler(driver, device, value) | ||
| local raw = value.value | ||
| local percent = utils.round(raw / 2) | ||
| device:emit_event(capabilities.battery.battery(percent)) | ||
| end | ||
|
|
||
| --- Lifecycle initialization handler | ||
| --- Ensures battery data is available by periodically actively reading BatteryPercentageRemaining | ||
| --- @param driver table Driver instance | ||
| --- @param device table Device instance | ||
| local function device_init(driver, device) | ||
| device.thread:call_on_schedule( | ||
| BATTERY_POLL_INTERVAL, | ||
| function() | ||
| device:send(PowerConfiguration.attributes.BatteryPercentageRemaining:read(device)) | ||
| end | ||
| ) | ||
| end | ||
|
|
||
| --- valve.open ability handler | ||
| --- @param driver table driver instance | ||
| --- @param device table device instance | ||
| --- @param command table ability command | ||
| local function valve_open_handler(driver, device, command) | ||
| device:send(OnOff.server.commands.On(device)) | ||
| device:send(OnOff.attributes.OnOff:read(device)) | ||
| end | ||
|
|
||
| --- valve.close capability handler | ||
| --- @param driver table driver instance | ||
| --- @param device table device instance | ||
| --- @param command table capability command | ||
| local function valve_close_handler(driver, device, command) | ||
| device:send(OnOff.server.commands.Off(device)) | ||
| device:send(OnOff.attributes.OnOff:read(device)) | ||
| end | ||
|
|
||
| --- Device Matching Check | ||
| --- @param opts table Options | ||
| --- @param driver table Driver instance | ||
| --- @param device table Device instance | ||
| --- @return boolean Whether this sub-driver takes over | ||
| local function is_sonoff_valve(opts, driver, device) | ||
| for _, fingerprint in ipairs(FINGERPRINTS) do | ||
| if device:get_manufacturer() == fingerprint.mfr and device:get_model() == fingerprint.model then | ||
| return true | ||
| end | ||
| end | ||
| return false | ||
| end | ||
|
|
||
| local sonoff_valve_handler = { | ||
| NAME = "SONOFF Water Valve Handler", | ||
| lifecycle_handlers = { | ||
| init = device_init | ||
| }, | ||
| capability_handlers = { | ||
| [capabilities.valve.ID] = { | ||
| [capabilities.valve.commands.open.NAME] = valve_open_handler, | ||
| [capabilities.valve.commands.close.NAME] = valve_close_handler, | ||
| } | ||
| }, | ||
| zigbee_handlers = { | ||
| attr = { | ||
| -- OnOff property reporting → valve event (to compensate for the defect of the parent driver's default mapping being skipped) | ||
| [OnOff.ID] = { | ||
| [OnOff.attributes.OnOff.ID] = onoff_attr_handler | ||
| }, | ||
|
Comment on lines
+106
to
+108
Contributor
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. Did You check if Your device works with the zigbe-valve driver default handling ? (without this custom handling) |
||
| -- Battery percentage attribute reporting → battery event | ||
| [PowerConfiguration.ID] = { | ||
| [PowerConfiguration.attributes.BatteryPercentageRemaining.ID] = battery_percentage_handler | ||
| } | ||
| } | ||
| }, | ||
| can_handle = is_sonoff_valve | ||
| } | ||
|
|
||
| return sonoff_valve_handler | ||
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.
Did You check if Your device works with the zigbe-valve driver default handling ? (without this custom handling)