Ubisys D1 - Exposing the on and off fade property

[wb441]

I would like to make a property from the device Ubisys D1 accessible to set.
It is about the time the dimmer takes to fade in and fade out when turning the device on or off.

It is documented by the manufacturer https://www.ubisys.de/wp-content/uploads/ubisys-d1-technical-reference.pdf on page 18, see screenshot below:

The highlighted one is the one I would like to set.

@guydriesen Can you point me in the right direction how to 'unlock' this?

[sjorge]

This seems to be part of the normal spec, so it can probably be added to the generic converters

Usually doing something like this involves a few steps:

• ensure attribute is present in the cluster definition
• create a toZigbee converter
• create a fromZigbee converter
• updates devices.js

I have recently done this for StartupColorTemperature. But for this one less work needs to be done.

It's not super hard, but I don't have any devices to test.

1. add this to toZigbee.js

    level_control_config: {
        key: ['level_control_config'],
        convertSet: async (entity, key, value, meta) => {
            // XXX: check value is object, don't assume
            value = JSON.parse(value);

            if (value.hasOwnProperty('onOffTransitionTime') {
                // XXX: limit value range to 1-255
                await entity.write('genLevelCtrl', {onOffTransitionTime: Number(value.onOffTransitionTime)}, utils.getOptions(meta.mapped, entity));
                // XXX: fix return
                return {state: {color_temp_startup: value}};
            } else if (value.hasOwnProperty('startuplevel') {
                // XXX: check if attribute is rpesetn
            }
        },
        convertGet: async (entity, key, meta) => {
            await entity.read('genLevelCtrl', ['onOffTransitionTime']);
            // XXX: read startupLevel
        },
    }

2. add this to fromZigbee.js

# TBD

3. update D1 config in devices.js

    {
        zigbeeModel: ['D1 (5503)', 'D1-R (5603)'],
        model: 'D1',
        vendor: 'Ubisys',
        description: 'Universal dimmer D1',
        fromZigbee: [fz.on_off, fz.brightness, fz.metering, fz.command_toggle, fz.command_on, fz.command_off, fz.command_recall,
            fz.command_move, fz.command_stop, fz.lighting_ballast_configuration, fz.ubisys_dimmer_setup],
        toZigbee: [tz.light_onoff_brightness, tz.ballast_config, tz.level_control_config, tz.ubisys_dimmer_setup, tz.ubisys_device_setup],
        exposes: [e.light_brightness(), e.power(),
            exposes.numeric('ballast_physical_minimum_level', exposes.access.STATE_GET).withValueMin(1).withValueMax(254)
                .withDescription('Specifies the minimum light output the ballast can achieve.'),
            exposes.numeric('ballast_physical_maximum_level', exposes.access.STATE_GET).withValueMin(1).withValueMax(254)
                .withDescription('Specifies the maximum light output the ballast can achieve.'),
            exposes.numeric('ballast_minimum_level', exposes.access.ALL).withValueMin(1).withValueMax(254)
                .withDescription('Specifies the minimum light output of the ballast'),
            exposes.numeric('ballast_maximum_level', exposes.access.ALL).withValueMin(1).withValueMax(254)
                .withDescription('Specifies the maximum light output of the ballast'),
            exposes.binary('capabilities_forward_phase_control', exposes.access.STATE_GET, true, false)
                .withDescription('The dimmer supports AC forward phase control.'),
            exposes.binary('capabilities_reverse_phase_control', exposes.access.STATE_GET, true, false)
                .withDescription('The dimmer supports AC reverse phase control.'),
            exposes.binary('capabilities_reactance_discriminator', exposes.access.STATE_GET, true, false)
                .withDescription('The dimmer is capable of measuring the reactanceto distinguish inductive and capacitive loads.'),
            exposes.binary('capabilities_configurable_curve', exposes.access.STATE_GET, true, false)
                .withDescription('The dimmer is capable of replacing the built-in, default dimming curve.'),
            exposes.binary('capabilities_overload_detection', exposes.access.STATE_GET, true, false)
                .withDescription('The dimmer is capable of detecting an output overload and shutting the output off.'),
            exposes.binary('status_forward_phase_control', exposes.access.STATE_GET, true, false)
                .withDescription('The dimmer is currently operating in AC forward phase control mode.'),
            exposes.binary('status_reverse_phase_control', exposes.access.STATE_GET, true, false)
                .withDescription('The dimmer is currently operating in AC reverse phase control mode.'),
            exposes.binary('status_overload', exposes.access.STATE_GET, true, false)
                .withDescription('The output is currently turned off, because the dimmer has detected an overload.'),
            exposes.binary('status_capacitive_load', exposes.access.STATE_GET, true, false)
                .withDescription('The dimmer\'s reactance discriminator had detected a capacitive load.'),
            exposes.binary('status_inductive_load', exposes.access.STATE_GET, true, false)
                .withDescription('The dimmer\'s reactance discriminator had detected an inductive load.'),
            exposes.enum('mode_phase_control', exposes.access.ALL, ['automatic', 'forward', 'reverse'])
                .withDescription('Configures the dimming technique.')],
        meta: {configureKey: 3},
        configure: async (device, coordinatorEndpoint, logger) => {
            const endpoint = device.getEndpoint(4);
            await reporting.bind(endpoint, coordinatorEndpoint, ['seMetering']);
            await reporting.readMeteringMultiplierDivisor(endpoint);
            await reporting.instantaneousDemand(endpoint);
        },

I wrote this on the go without testing, so it might have a syntax error. But let me know how it goes.
If it works, I can probably clean this up and do a PR. Just need someone to test.

[sjorge]

I've added a PR to expose the StartupLevel too, Koenkk/zigbee-herdsman#283

If you can wait, wait for that to get merged and I can do a proper PR for the converter (and make sure the code is good), still need someone to test it on hardware though.

[sjorge]

OK here is an update...

Koenkk/zigbee-herdsman#283 to be merge
Koenkk/zigbee-herdsman-converters#2049 to be tested

The converters one depends on the herdsman one, so once the former is merged, you should be able to apply the changes from the converters one locally to test. I think it should just work.

[sjorge]

Good news, the herdsman PR is merged. And I manged to test most of the other PR, once it is merged it should just work 🤞
The frontend will even expose it for you:

[sjorge]

PR got merged, should show up in the next dev release

[wb441]

@sjorge Spun up a container with the latest dev. Simply fantastic!
Thank you so much!

[sjorge]

Good to get additional confirmation it works.