Rules / Variables based on Date or Calendar

SharpTools.io (web)
27

I wanted to a share a workaround that might be sufficient until we get a chance to build this as a first-class feature in the Rule Engine.

:stop_sign: Update: Math / Date Expressions are now available as a native feature. You can use the syntax noted below directly in an expression without having to use the Lab environment.

:link: Feature Announcement: Math / Date Expressions

We have a Lab environment which has some endpoints that can be called using the HTTP Action in the Rule Engine and you can get the results using context variables. The /date endpoint can be used with an optional timezone (IANA format) and optional locale parameter to customize the output.

https://lab.sharptools.dev/date?timezone=Poland&locale=pl

As you’ll see from the link above, this provides a wide variety of date related details available as properties that you can then use in your rules.

image
image1024×492 9.49 KB

Formatted Output

Furthermore, you can pass a format property using any combination of those values to receive a fully formatted string in return. Examples:

Note that if you are using more complex formats with spaces and such, you will either want to URL encode them or you can even use a POST request to send the parameters across.

image
image1024×767 11.2 KB

Localized Formats

Also supported for the format field are some default localized formats:

  • L - localized date (short)
  • LL - localized date (long)
  • LT - localized time
  • LTS - localized time with seconds

Formatted Input

You can also provide an input to the /date endpoint as well.

  • input - expects an ISO 8601 timestamp by default, but can be modified with inputFormat
  • inputFormat - the format of the input value (eg. a format string like YYYY-MM-DD or MMMM DD, YYYY)
  • inputTimezone - the IANA timezone (if your input value is not UTC)
  • inputLocale - can only be used if you’re using the default UTC timezone (eg. no inputTimezone)

Date Between

The /date/between endpoint accepts a start, end, and timezone (IANA) property for checking if the current date is between two dates.

For example, you could check if the date is between August 1st and September 1st
https://lab.sharptools.dev/date/between?start=2022-08-01&end=2022-09-01&timezone=America/Chicago

The formats are YYYY-MM-DD or MM-DD. By default, the endpoint will ignore the year – this enables the same condition to continue to work year after year without needing to update the rule. You can include the flag &includeYear=true if you want to restrict to a specific year.

The main property you would look for in the response is result which is a true/false indicating if it’s currently between the specified date range.

You could use this with a rule that has a Time trigger to run every day and checks this endpoint to determine if it matches your range to decide if you want to run the rest of the rule or not.

1 Like
28

wow nice, will take a look!

29

We added the ability to provide an input to the /date endpoint as well.

:arrow_up: Content moved into the main post

Also supported for the format field are some default localized formats:

:arrow_up: Content moved into the main post

2 Likes
30

I have the same request as the OP. I have many webCoRe pistons I want to convert that handle holiday lighting. My Christmas rules are the most complex and they require more than just date ranges but as a start being able to specify a range will get me some way there. I have simpler requirements for Valentines, July 4th and Halloween. Being able to set these dates in variables and then use those as ‘in between’ date IFs would be a winner.

31

Can you share more details about what the more complex automations would require?

32

Absolutely Josh.

Actually, what I’m looking for here for my Christmas rule I could also use elsewhere. It’s just this Christmas one is what is bothering me the most right now as it’s my most complex.

The date range as a condition is the biggest item. Then I want to be able to code that at certain times on certain days but only when the date range is true do something. Similarly, I want to trigger x mins before sunset, again only within a date range, do something else. Being able to set multiple devices in a variable is another plus.

Some of my issues are having to create multiple rules for what is currently a single piston. Not a huge deal but very tedious and often requires extensive testing.

It’s quite possible that much of this, sans the ‘date range’ is possible now. I’m only a few days in to working with the Rules Engine and I’m still learning.

Take a look at my Christmas piston to get some idea of what I’m trying to manage. Please ignore the ‘Set Piston State’ statements as those were only for the webCoRe dashboard.

Christmas Piston
Christmas Piston1178×3134 602 KB

This piston handles colour cycling of some lights in a random manner. I don’t think SharpTools currently has that capability.

download
download1178×913 90.1 KB

33

Thanks for sharing the details and the example!

:stop_sign: Update: Math / Date Expressions are now available as a native feature. You can use the syntax noted below directly in an expression without having to use the Lab environment.

:link: Feature Announcement: Math / Date Expressions

Not formally, but I believe you could accomplish this with the /math endpoint on our Lab server that I mentioned in another thread by using the pickRandom() function:

The formula would be:

pickRandom(["Green","Red","Gold","Blue","whiteTemperature"])

You can test it by refreshing the following link:
https://lab.sharptools.dev/math?formula=pickRandom(["Green","Red","Gold","Blue","whiteTemperature"])

From what I can see, that seems to be the biggest missing piece. Basically a True/False indicating if you are between a start and and end date.

Sunset/Sunrise offsets are supported in triggers.

image
image956×300 14 KB

I believe you already cast a vote on the following feature request, but posting it here in case other people see it and want to cast a vote. :slight_smile:

:link: Select multiple devices in rule triggers and actions

2 Likes
34

Thank you Josh. That gives me some things to look in to and work with.

As always, I appreciate your support.

1 Like
35

We pushed an update the /date endpoint to support checking if the current date is between two dates (within a range).

:arrow_up: Content moved into the main post

1 Like
36

Oh, very nice. I’ve been using a routine in Tasker called DateSpan (or something like that) that someone posted on Reddit I believe and it works great (and similarly). I used to have it check for school break and then not run morning routines because kids would sleep in, but we just shipped the last one off to college, so it’s not quite as useful any longer. Oh well. At least I know how to use it in case it’s ever pertinent again (and can mimic it in SharpTools). :wink:

1 Like
37

I’ve successfully implemented this, thank you.

What I’ve actually done is created one rule that contains multiple actions that set variables to true/false, each representing different spans of time (Thanksgiving, Valentines, etc). The trigger for this rule is an HTTP trigger.

In my holiday lighting rules I then trigger the date setting rule as the first action then I can use the variable true/false settings it sets as conditions in the rest of the lighting rule. If I make any changes to the dates in the date setting rule they will always be picked up by triggering the rule each time a check is needed.

1 Like
38

One thing to keep in mind is that triggering a rule via HTTP enqueues it to run and returns a response if it was successfully queued up to run. It doesn’t wait for the rule to finish before it returns.

You can still use this concept, but would either want to have the primary rule that does all the variable calculations just run first thing in the morning every day (eg. 12:05 AM) or have the other rules introduce some delay after they execute the HTTP Action to the other rule.

39

Ah, thanks for that info. I’ll make some adjustments.

1 Like
40

Josh, can you help me with the syntax for the payload on this please (JSON is relatively new to me).

I currently have:

{
"formula": "pickRandom(["Green","Red","Gold","Blue","whiteTemperature"])"
}

But it’s obviously not right as the editor is not letting me save.

41

The first quote before Green is causing the formula to become unquoted. You would either need to escape the quotes with a backslash or just switch to single quotes.

{
"formula": "pickRandom(['Green','Red','Gold','Blue','whiteTemperature'])"
}
1 Like
42

Doh! Thanks Josh, that did it.

1 Like
43

I’m trying to check if a single date is true or false but can’t get it right. The variable remains blank.

https://lab.sharptools.dev/date=09-02&timezone=America/Phoenix

I also tried using the date range with one date. This results in true when set to today but the variable is empty when set like this.

https://lab.sharptools.dev/date/between?start=09-02&end=09-02&timezone=America/Phoenix

What am I doing wrong?

44

Which variable is empty? The second approach would be the right approach for checking if it’s currently a specific day.

You would access the variable as $context.response.data.result

In other words: Variable > Context Tab: Response → HTTP → Data, then enter result as the property you want.

45

Apparently it only works when you spell result correctly :woman_facepalming:t4:

1 Like
46

Could this be used to pick a random light and/or random time by replacing color with device names or list of numbers?