Add support for Zigbee Smart Water Valve (SWV-BSP) #646

etienne678 · 2025-02-12T04:20:06Z

Add support for Zigbee Smart Water Valve (SWV-BSP)
This PR adds support for the Zigbee Smart Water Valve (SWV-BSP) device, as requested in issue #645.

Implementation Details
Added UIID 7027 support in constants.js
Implemented basic switch functionality in zigbee-water-valve.js
Device works through Sonoff Zigbee Pro Bridge
Device Information
Device logs showing the data structure:

{
"bindInfos": {},
"subDevId": "b95a33feff1227847027",
"parentid": "10023e03d6",
"fwVersion": "1.0.2",
"battery": 100,
"trigTime": "1739203803000",
"supportPowConfig": 1,
"subDevRssi": -3,
"exceptionReport": [],
"hasException": false,
"switch": false,
"realIrrigationVolume": 0,
"realIrrigationVolumeGal": 0,
"todayWaterUsage": 0,
"todayWaterUsageGal": 0,
"controlMode": "manual",
"runningMode": 2
}
Functionality
✅ Basic on/off control from HomeKit
✅ State updates from eWeLink app reflected in HomeKit
✅ Multiple devices tested and working
Future Improvements
While this PR implements basic on/off functionality, the device has additional features that could be added in the future:

Water usage tracking
Irrigation volume monitoring
Battery level reporting
Testing
Tested with multiple SWV-BSP devices connected through a Sonoff Zigbee Pro Bridge. All devices are properly recognized and can be controlled through both HomeKit and the eWeLink app.

improved

bwp91 · 2025-02-12T08:11:18Z

Hi @etienne678

Thanks for taking the time to make this PR.

Question: any reason why you chose a switch accessory rather than a homekit water valve accessory?

etienne678 · 2025-02-12T08:42:00Z

Hi @etienne678

Thanks for taking the time to make this PR.

Question: any reason why you chose a switch accessory rather than a homekit water valve accessory?

Hi @bwp91 ,
no reason, just thought of the simplest way an went with a switch.
I wasn’t aware that homekit water valve accessory is available.
But I think I yes, it would be much better as water valve accessory.

bwp91 · 2025-02-12T08:48:06Z

Here is an example:

homebridge-ewelink/lib/device/simulation/valve-one.js

Lines 52 to 60 in ed18368

    
           this.service = this.accessory.getService(this.hapServ.Valve) 
        
           if (!this.service) { 
        
             this.service = this.accessory.addService(this.hapServ.Valve) 
        
             this.service.updateCharacteristic(this.hapChar.Active, 0) 
        
             this.service.updateCharacteristic(this.hapChar.InUse, 0) 
        
             this.service.updateCharacteristic(this.hapChar.ValveType, 1) 
        
             this.service.updateCharacteristic(this.hapChar.SetDuration, 120) 
        
             this.service.addCharacteristic(this.hapChar.RemainingDuration) 
        
           }

You can use Valve instead of Switch
Instead of hapChar.On use hapChar.Active (with 1 and 0 instead of true and false)
Also use hapChar.InUse with 1 and 0 and keep this value the same as hapChar.Active at all times
Set hapChar.ValveType to 1 when initially creating the service (it never needs updating again)

This commit refactors the Zigbee Smart Water Valve (SWV-BSP) implementation to use the HomeKit Valve service instead of the Switch service. This change provides a more semantically accurate and feature-rich representation of the water valve in HomeKit, including: - **Valve Service**: Switched from Switch to the more appropriate Valve service. - **Valve Characteristics**: Implemented support for key Valve characteristics: - `Active`: For on/off control. - `InUse`: To indicate active watering. - `ValveType`: Set to Irrigation (1). - `SetDuration`: To configure watering duration. - `RemainingDuration`: To display remaining watering time. - **Timer Functionality**: Added automatic valve shut-off after the set duration, enhancing irrigation control. - **State Management**: Maintained robust state caching and error handling from previous Switch implementation. This update provides an improved user experience for controlling Zigbee Smart Water Valves within HomeKit, aligning with the intended functionality of a valve accessory.

etienne678 · 2025-02-12T14:39:37Z

@bwp91 the Valve device does not appear in the automation section in the home app.
can you see why? when i use the switch solution it does show up.

bwp91 · 2025-02-15T07:37:24Z

@bwp91 the Valve device does not appear in the automation section in the home app. can you see why? when i use the switch solution it does show up.

did you manage to sort this at all?

etienne678 · 2025-02-15T11:31:46Z

Tried around for two days now, didn’t work unfortunately.

…

On 15. Feb 2025, at 09:37, Ben ***@***.***> wrote: bwp91 left a comment (homebridge-plugins/homebridge-ewelink#646) @bwp91 the Valve device does not appear in the automation section in the home app. can you see why? when i use the switch solution it does show up. did you manage to sort this at all? — Reply to this email directly, view it on GitHub, or unsubscribe. You are receiving this because you were mentioned. <https://github.com/bwp91> <#646 (comment)> <https://github.com/notifications/unsubscribe-auth/AAICNCBDQW5WJS52QFU57432P3VEVAVCNFSM6AAAAABW6UHRUSVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDMNRQG44TGNJWG4> bwp91 left a comment (homebridge-plugins/homebridge-ewelink#646) <#646 (comment)> @bwp91 <https://github.com/bwp91> the Valve device does not appear in the automation section in the home app. can you see why? when i use the switch solution it does show up. did you manage to sort this at all? — Reply to this email directly, view it on GitHub <#646 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAICNCBDQW5WJS52QFU57432P3VEVAVCNFSM6AAAAABW6UHRUSVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDMNRQG44TGNJWG4>. You are receiving this because you were mentioned.

bwp91 · 2025-02-15T13:42:18Z

You can use the Eve for HomeKit app to create scenes for valves

etienne678 · 2025-02-16T09:28:09Z

ooh, ok, then Valve isn't even supposed to be available for automations within the apple home app? that would explain a lot. i tried everything to make it appear there and finally gave up when it just would not work.
but yes, i can see it in the eve app. well ok, then i think it works as good as it can as Valve type.

on antother note, I tried to display other values for the default run time for the irrigation in the apple home app, because i think for irrigation valves it would be good if the user could set the duration in smaller increments as well.

i tried with something like this:
´´´
this.service.getCharacteristic(this.hapChar.SetDuration)
.setProps({
validValues: [10, 20, 30, 60, 120, 300, 600, 900, 1800, 3600] // Explicit durations
})
.updateValue(60); // Default duration

´´´
did not work.

bwp91 · 2025-02-16T17:18:34Z

I think these are a set list for all valve types, whether the accessory is native to homekit as a valve, or via homebridge.

If using a valid values array did not work, then I would not know what else to suggest.

Are you happy with this PR as it is?

etienne678 · 2025-02-16T17:32:55Z

ok, thanks.

Are you happy with this PR as it is?

I have my garden irrigation with 4 of these Valves now working for 2 days with the changes in this PR. i currently run commit e4363e5. i tested a lot and so far it all works fine.
It's a pity that Valves cannot be automated through the Home app directly, but apparently we cannot change this. So I'd say it is good to go from my side.

But: I never coded a device for homebridge before and running water is involved, so i would be very happy if you could check to make sure it is done correctly before this sets someones house under water :D

bwp91 · 2025-02-24T07:49:02Z

thank you for taking the time to do this!

etienne678 · 2025-02-24T07:52:35Z

thank you for taking the time to do this!

no problem. thank you for the plugin, it is great.

etienne678 mentioned this pull request Feb 12, 2025

SWV-BSP Zigbee Smart Water Valve Support? #645

Open

etienne678 force-pushed the feature/zigbee-water-valve branch 4 times, most recently from a0a46cd to f222d32 Compare February 12, 2025 05:56

Add support for Zigbee Smart Water Valve (SWV-BSP)

3dc9331

improved

etienne678 force-pushed the feature/zigbee-water-valve branch from f222d32 to 3dc9331 Compare February 12, 2025 06:23

MrTomAsh approved these changes Feb 12, 2025

View reviewed changes

Etienne Doussin added 2 commits February 12, 2025 10:58

fix(zigbee): persist valve timer state across HomeKit restarts

d332626

Improved handling of timers and state

e4363e5

bwp91 approved these changes Feb 24, 2025

View reviewed changes

bwp91 merged commit 3dec172 into homebridge-plugins:latest Feb 24, 2025
4 checks passed

etienne678 deleted the feature/zigbee-water-valve branch February 24, 2025 07:52

Uh oh!

Add support for Zigbee Smart Water Valve (SWV-BSP) #646

Add support for Zigbee Smart Water Valve (SWV-BSP) #646

Uh oh!

Conversation

etienne678 commented Feb 12, 2025

Uh oh!

bwp91 commented Feb 12, 2025

Uh oh!

etienne678 commented Feb 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

bwp91 commented Feb 12, 2025

Uh oh!

etienne678 commented Feb 12, 2025

Uh oh!

bwp91 commented Feb 15, 2025

Uh oh!

etienne678 commented Feb 15, 2025 via email

Uh oh!

bwp91 commented Feb 15, 2025

Uh oh!

etienne678 commented Feb 16, 2025

Uh oh!

bwp91 commented Feb 16, 2025

Uh oh!

etienne678 commented Feb 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

bwp91 commented Feb 24, 2025

Uh oh!

etienne678 commented Feb 24, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

etienne678 commented Feb 12, 2025 •

edited

Loading

etienne678 commented Feb 16, 2025 •

edited

Loading