Add capability "ChangeLevel" to Generic Z-Wave Shades

ljfh001 · January 9, 2021, 8:26pm

Hi Hubitat devs,

I was trying to add button controller to control shades. Without the ChangeLevel capability from Generic Z-Wave Shades driver, I'm unable to program a button hold for raising/lowering shades and button release for stop(). Well, I guess I could make the up button hold to issue a set level command to 100 or down button hold to issue a set level command to 0. That just seems hacky. It's better to have the driver support ChangeLevel capability natively and use the z-wave switchMultilevelStartLevelChange and switchMultilevelStopLevelChange API respectively.

The driver for Generic Z-Wave Shades is close sourced. Could the Hubitat dev add ChangeLevel capability to the driver? It should be very trivial amount of work.
borrowing from https://github.com/hubitat/HubitatPublic/blob/master/examples/drivers/genericZWaveCentralSceneDimmer.groovy:

String startLevelChange(direction){
    Integer upDown = direction == "down" ? 1 : 0
    return secure(zwave.switchMultilevelV1.switchMultilevelStartLevelChange(upDown: upDown, ignoreStartLevel: 1, startLevel: 0))
}

List<String> stopLevelChange(){
    return [
            secure(zwave.switchMultilevelV1.switchMultilevelStopLevelChange())
            ,"delay 200"
            ,secure(zwave.basicV1.basicGet())
    ]
}

ljfh001 · January 28, 2021, 9:16pm

Can this be addressed in the next release? It's a super small change. If you open source the driver code for Generic Z-Wave Shades, I'll send you a pull request. Thank you!

bertabcd1234 · January 28, 2021, 9:27pm

Do you know that your shades work with this? Mine don't, but they're really blinds and not shades, where the usefulness is probably not as apparent.

If you want a starting place for something that vaguely resembles a generic shade driver, you can start with mine that I wrote for mine, which are iBlinds v3 units (I also have a driver for their v2, but I wouldn't recommend starting with that one since it has a couple workarounds for v2 device oddities). You can probably remove everything related to configuring Z-Wave parameters (lines 31-44, 60-62, and 93-100; possibly more), which are specific to the units I wrote this for. Otherwise, this would probably give you a good starting point.

github.com

RMoRobert/Hubitat/blob/master/drivers/iBlinds-v3.groovy

/**
 *  iBlinds v3 (manufactured by HAB Home Intel) community driver for Hubitat
 * 
 *  Copyright 2020 Robert Morris
 *
 *  Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
 *  in compliance with the License. You may obtain a copy of the License at:
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing, software distributed under the License is distributed
 *  on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License
 *  for the specific language governing permissions and limitations under the License.
 * 
 *  Version History
 *  2020-11-22: Initial release for iBlinds v3 (portions based on v2 driver)
 *  2020-11-24: Added missing "position" events, Z-Wave parameter 1 option and paramter 3 auto-setting (for reporting to hub);
 *              Added option for default digital "on"/"open" position; battery reports now always generate event (state change)
 *  2020-11-25: Minor fixes (parameter 3 auto-set failed with secure pairing) and tweaks to request and parse MSR, DSR, and other Z-Wave reports
 *  2020-11-27: Fixed issues with Z-Wave parameters not getting set correctly in some cases

This file has been truncated. show original

ljfh001 · January 28, 2021, 11:18pm

I forked this, and this is my modification to add start/stopLevelChange.

github.com

ljfh001/hubitat-springs-windows-fashions/blob/main/hubitat-springs-window-fashions.groovy

/**
 *  Springs Window Fashions - Roller Shade Driver
 *  Author: DevTodd / Hubitat: DevOpsTodd
 *  Date: 2020-12-23
 *
 *  Copyright 2020 DevTodd
 *
 *  Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
 *  in compliance with the License. You may obtain a copy of the License at:
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing, software distributed under the License is distributed
 *  on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License
 *  for the specific language governing permissions and limitations under the License.
 *
 *  2020-12-23: Initial commit, port.  Added:
 *      -   Debug and Info Logging
 *      -   Fingerprinting
 *      -   Added capability for SetPosition and SetLevel to be used for controlling position of the blinds

This file has been truncated. show original

Everything works, but there's still a bug for reporting the shade status in the dashboard which I have yet had the time to fix.

The built-in Generic Z-Wave Shades driver doesn't have that issue. All it's missing is the start/stopLevelChange methods. I'm just hoping the devs can add those 2 methods and the driver will be complete.