Rule to slowly fade in or out any given item based on variables

simcla · October 23, 2020, 10:51am

Thanks for the code - works very well!

One minor suggestion for improvement:
Instead of having “type” as a parameter you can retrieve it from the item itself

// item Type: HSBType->Color or PercentType->Dimmer

val item_type = item.getAcceptedDataTypes().get(0).toString.split(" ").get(1).toString.split("\\.").get(6).toString

var int startingBrightness = 0

if (item_type == "HSBType") {     // type == "Color"
        startingBrightness = (item.state as HSBType).getBrightness().intValue
} else if (item_type == "PercentType") { // type == "Dimmer" 
        startingBrightness = (item.state as DecimalType).intValue
}

Example:
item.AccecptedDataTypes: [class org.eclipse.smarthome.core.library.types.PercentType, class org.eclipse.smarthome.core.library.types.OnOffType, class org.eclipse.smarthome.core.types.UnDefType]
thereof get(0): “class org.eclipse.smarthome.core.library.types.PercentType”
thereof split(" “).get(1): “org.eclipse.smarthome.core.library.types.PercentType”
thereof split(”\.").get(6): “PercentType”

This is e.g. useful for dimming a group of lights of different types (Color or Dimmer)

gLight.members.forEach[ i | universaldimmer.sendCommand("100,10000," + i.name) ]

Kind regards, Joachim

simcla · October 23, 2020, 2:20pm

One minor correction:

if (item.state == null) 
    { ...

should read

if (item.state == NULL) 

    { ...

(see also [SOLVED] NULL | UNDEF | null | uninitialized)

habau · October 25, 2020, 2:07am

Thank’s Joachim - have incorporated both tips and updated the gist.

item_name is now the first argument - not last.

renegade2k · January 16, 2021, 12:12pm

Hi.
I like the idea behind the script and this matches pretty much, what i need for my automation.
So i created the item using “add item (textual)”-function in OH3.
Then i created an “universaldimmer.rules” file in the “rules” folder of OH andjust copy/paste the whole code block from the second post ino the file.
Now i can see the rule “Universaldimmer” in my rules-list.

To make it work now, i set up a new rule:

triggers:
  - id: "1"
configuration:
  itemName: Bewegungsmelder
  state: ON
type: core.ItemStateUpdateTrigger
conditions: []
actions:
  - inputs: {}
id: "3"
configuration:
  itemName: universaldimmer
  command: Dimmer,20,2000,10,Lampe_Helligkeit
type: core.ItemCommandAction

“Bewegungsmelder” is a presence sensor and this seems to work, but my light “Lampe_Helligkeit” keeps off. The log file tells me:

*[ERROR] [.internal.handler.ScriptActionHandler] - Script execution of rule with UID 'universaldimmer-1' failed: The name 'ScriptServiceUtil' cannot be resolved to an item or type; line 48, column 17, length 17 in universaldimmer*

So i don’t reallyknow, whats wrong there, but it seems, the scrips can’t find my light, or the
“ScriptActionHandler” does not work at all …
I’m stuck at this point, could you help me plz?

rossko57 · January 16, 2021, 1:07pm

renegade2k · January 16, 2021, 1:30pm

Well, i did it exactly, like the original creator of the script:

import org.eclipse.smarthome.model.script.ScriptServiceUtil

right at the first line in the rules-file
Is there a way to check whether the import is really successful?
Or is there a dependency which has to be met before? (Java is installed ofcourse)

Also i found another post ([Rules DSL] Get item from string name! which tells, you need to change the import to

import org.openhab.core.model.script.ScriptServiceUtil

And the last part did it!
but you need to restart openhab, even the rule is reloaded, as sonn as you save the changes (te log file also shows, that the module is realoaded)

rossko57 · January 16, 2021, 1:57pm

But you’ve shown us a UI entered rule, not a rule from a xxx.rules file as used in 2018? The UI entered rule shares nothing with your import, which is local to the xxx.rules file it is in only.

I don’t think you can do imports like this in UI rules.

renegade2k · January 16, 2021, 2:10pm

But you’ve shown us a UI entered rule, not a rule from a xxx.rules file as used in 2018?

Right.
As described, this is a new rule i created, which calls the text-coded rule, as soon as movement is recognized by the presence sensor
It’s a bit tricky, but the error was caused by changed import in version 3 in combination with OH not loading the import, when it is not restarted.

Args … the script seems to be not ok anymore (due to changed environment i guess?)
The script runs now, but it’s buggy.

[ERROR] [.internal.handler.ScriptActionHandler] - Script execution of rule with UID 'universaldimmer-1' failed: 'plusMillis' is not a member of 'java.time.ZonedDateTime'; line 69, column 27, length 22 in universaldimmer

The light is dimmed by one step (which is set as the 3rd parameter) and stops then. It’s not repeated until the set destination value (the 1st variable).
So to be precise: when i turn my light on by hand to 40% and start the script with as follows:

Dimmer,0,2000,10,Lampe_Helligkeit

The dimmer is set from 40% to 30%, then 30% to 38%, and again 38% to 30% and the script stops …

Also found a solution for this.
You need to change to lines to make it work nice and smooth

now.plusMillis(mytime)

must be changed to

now.toInstant().plusMillis(mytime).atZone(now.zone)

rlkoshak · January 16, 2021, 3:50pm

You should be able to. If it doesn’t work it’s a bug.

habau · January 22, 2021, 7:40pm

You didn’t mention whose version you were using. The code snippet you mention that needs fixing isn’t in my version. Your symptoms sound like problems I had with the one originally posted.

See my post from Sept 20 for a version that works much better. It has been working flawlessly for me.

ZacR · January 25, 2021, 12:39am

I’ve been using your version for months without issues, although upgrading to OpenHAB 3 has broken the universaldimmer script, as it doesn’t seem to work at all.

I receive the following error in my openhab.log file when I attempt to execute a dimming function:

2021-01-23 00:55:01.396 [ERROR] [internal.handler.ScriptActionHandler] - Script execution of rule with UID ‘universaldimmer-1’ failed: The name ‘ScriptServiceUtil’ cannot be resolved to an item or type; line 40, column 20, length 17 in universaldimmer

Thinking it may have been caused by the import line at the very top, I commented out

import org.eclipse.smarthome.model.script.ScriptServiceUtil

and replaced it with

import org.openhab.core.model.script.ScriptServiceUtil

after reading My experience migrating from OH2.5 to OH 3.0 although that made no difference and the same error shows up in my logs when I try to use the universaldimmer command on a light.

The only other thing I’ve noticed that has broken for me as well is googletts, everything appears to be set up the same, although I’m just trying to work out one issue at a time.

habau · January 25, 2021, 6:34am

I didn’t realise OH3 was out. Will look into upgrading and fixing the script.

ZacR · January 25, 2021, 6:47am

Oh that’ll be great, thank you so much! I wasn’t aware either until 3 or 4 days ago, when I randomly visited the OpenHab blog and saw it came out on Dec 21.

I’ve loved the universalfader script so much because it’s worked so well with my TP-Link Kasa Dimmer Switches to slowly fade certain lights with an offset of when it gets to be dusk, so as it gets dark outside, my office slowly gets brighter over the course of about 12.5 minutes so you don’t even really realize the lights are coming on.

habau · January 27, 2021, 10:20am

All done.

Revision 4 of the gist supports OH3. Requires Regex transformation to be installed
Revision 3 contains the OH2 version

ZacR · January 27, 2021, 10:14pm

Thanks for such a prompt update! It seems I’m running into a small hiccup where it begins the dimming, but then fails within a 100ms. I seem to already have the Regex transformation installed, but here is what my logs show when I attempt to trigger the dimming:

2021-01-27 15:08:54.793 [INFO ] [el.core.internal.ModelRepositoryImpl] - Loading model 'dimmer.rules'
2021-01-27 15:09:28.997 [INFO ] [ab.core.model.script.UniversalDimmer] - Dim Light_UL_OfficeCeilingBrightness PercentType from 0 => 50 over 5000 ms
2021-01-27 15:09:29.000 [INFO ] [ab.core.model.script.UniversalDimmer] - itemName=Light_UL_OfficeCeilingBrightness set to 0.13, iteration=1, elapsedMs=13
2021-01-27 15:09:29.002 [INFO ] [ab.core.model.script.UniversalDimmer] - itemName=Light_UL_OfficeCeilingBrightness set to 0.15, iteration=2, elapsedMs=15
2021-01-27 15:09:29.003 [INFO ] [ab.core.model.script.UniversalDimmer] - itemName=Light_UL_OfficeCeilingBrightness set to 0.16, iteration=3, elapsedMs=16
2021-01-27 15:09:29.008 [INFO ] [ab.core.model.script.UniversalDimmer] - itemName=Light_UL_OfficeCeilingBrightness set to 0.21, iteration=4, elapsedMs=21
2021-01-27 15:09:29.008 [WARN ] [el.script.internal.actions.TimerImpl] - Rescheduling failed as execution has already started!
2021-01-27 15:10:19.715 [WARN ] [ore.io.rest.auth.internal.AuthFilter] - Unauthorized API request: Invalid Basic authentication credentials
2021-01-27 15:11:36.296 [INFO ] [ab.core.model.script.UniversalDimmer] - Cancelling existing timer for Light_UL_OfficeCeilingBrightness
2021-01-27 15:11:36.296 [INFO ] [ab.core.model.script.UniversalDimmer] - Dim Light_UL_OfficeCeilingBrightness PercentType from 0 => 50 over 5000 ms
2021-01-27 15:11:36.298 [INFO ] [ab.core.model.script.UniversalDimmer] - itemName=Light_UL_OfficeCeilingBrightness set to 0.02, iteration=1, elapsedMs=2
2021-01-27 15:11:36.300 [INFO ] [ab.core.model.script.UniversalDimmer] - itemName=Light_UL_OfficeCeilingBrightness set to 0.04, iteration=2, elapsedMs=4
2021-01-27 15:11:36.304 [INFO ] [ab.core.model.script.UniversalDimmer] - itemName=Light_UL_OfficeCeilingBrightness set to 0.08, iteration=3, elapsedMs=8
2021-01-27 15:11:36.305 [INFO ] [ab.core.model.script.UniversalDimmer] - itemName=Light_UL_OfficeCeilingBrightness set to 0.10, iteration=4, elapsedMs=10
2021-01-27 15:11:36.306 [INFO ] [ab.core.model.script.UniversalDimmer] - itemName=Light_UL_OfficeCeilingBrightness set to 0.11, iteration=5, elapsedMs=11
2021-01-27 15:11:36.307 [INFO ] [ab.core.model.script.UniversalDimmer] - itemName=Light_UL_OfficeCeilingBrightness set to 0.12, iteration=6, elapsedMs=12
2021-01-27 15:11:36.314 [INFO ] [ab.core.model.script.UniversalDimmer] - itemName=Light_UL_OfficeCeilingBrightness set to 0.13, iteration=7, elapsedMs=13
2021-01-27 15:11:36.315 [WARN ] [el.script.internal.actions.TimerImpl] - Rescheduling failed as execution has already started!

rossko57 · January 28, 2021, 12:20am

That looks like an OH3.0 bug

ZacR · January 28, 2021, 12:50am

Oh interesting, I’ll follow that thread to keep an eye on that. With all new things there will be some bugs and kinks to work out, but at least I’ve primed my environment by upgrading and am ready at least.

Thanks again for updating your script!

habau · January 30, 2021, 10:23am

I fixed a bug - 1,000,000 ns in 1 ms, not 1000. That may/may not help your issue. See revision 5

rossko57 · January 30, 2021, 11:47am

That’s true! ZonedDateTime is weird not giving a plusMillis or even plusMicros method.

S13_Mills · January 30, 2021, 10:34pm

Thank you for this! It’s working well in OH3 for me, after making the changes mentioned further up in the thread, specifically:

import org.eclipse.smarthome.model.script.ScriptServiceUtil
changes to
import org.openhab.core.model.script.ScriptServiceUtil

fade_Timer = createTimer(now.plusMillis(mytime))
changes to
fade_Timer = createTimer(now.plusNanos(mytime*1000000))

fade_Timer.reschedule(now.plusMillis(mytime))
changes to
fade_Timer.reschedule(now.plusNanos(mytime*1000000))

I’m using it to fade up / down the volume for my Sonos when arriving / leaving the house, which is working great.

What changes would need to be made to be able to call several of these concurrently? I’m thinking about using it for a slow fade-in of my lights for sunrise / sunset, and it would be on for 15 mins. Am I better off making another string item and copy / pasting for the specific case?

Thanks again - a great rule!