DateTime adapter

DateTime adapter for Mozilla IoT Gateway.

Purpose: Create rules where date, time, sunrise and sunset is needed

Upgrade

After an upgrade of the addon the pages must be reloaded before the new attributes are visible.
After upgrade to version 1.0.0 check existing rules because some properties are changed.

Release notes

1.0.1
No new functionallity

• New package format WebThings Gateway version 0.12

1.0.0

• Check Known Bugs below
• Added event 'Sunset'/'Sunrise'
• Added property enum 'Weekday'
• Removed property 'Sunrise'/'Sunset'
• Removed 'Hour_n' and 'Minute n'. Not needed whe gateway 0.7 support Integer
• Use Enum instead of Strings (require gateway version >= 0.7)
• Use Integer instead of Strings (require gateway version >= 0.7)
• Property 'Hour', 'Minute' is now integers
• Property '5 minutes' is an enum

0.9.5

• Added property Hour_N. Used in rules to create interval. See below for example.
• Added property Minute_N

DateTime have the following properties and events

• Sunrise (event)
• Sunset (event)
• Weekend. Boolean on for Saturday and Sunday
• Weekday. Enum. Monday...Sunday
• Dark. Boolean on when it is dark outside
• Hour. Integer, values 0-23
• Minute. Integer, values 0-59. Support < and > in rule-engine
• Even Hour. Boolean on for even hours
• Even minute. Bollean on for even minute
• 5 minutes. Enum. Values 0,5,10,15,20,...,55.

Setup

1. Add the DateTime Adapter from the Settings -> Addons
   • Go ahead and configure it
   • Valid time zone strings are TZ values from https://en.wikipedia.org/wiki/List_of_tz_database_time_zones. Example Europe/Stockholm
   • For the value horizon. Use https://www.timeanddate.com/sun/ , lookup your place and select "Sunrise & Sunset" to see the difference between -0:34 or -6=civil twilight, -12=nautical and -18=astronomical
2. Add the DateTime Thing from the Things -> + menu

Now it will be available for use in the Rules palette. (Thanks to @hwine and @mrinx)

Configuration

Configure the position latitude and longitude where you live and horizon. Normally the horizon is set to some values where the sun is below horizon.

Example

Turn the lamp in bedroom only on weekdays `if the time of day is 06:13 and DateTime is not weekend, turn BedroomLamp on

To start the fan evey hour and switch it of after 5 minutes
if DateTime 'Minutes' is 20, turn Fan on
if DateTime 'Minutes' is 25, turn Fan off

To start the fan evey second hour when it is dark and switch it of after 5 minutes
if DateTime is dark and DateTime 'Minutes' is 20 and DateTime is 'Even hour', turn Fan on
if DateTime 'Minutes' is 25, turn Fan off

If it only for 5 minutes while DateTime 'Minutes' is 5, turn Fan on

A motion sensor is only active between 10:00--10:59 if DateTime 'Hour' is greater than 9 and DateTime 'Hour'is less than 11 and Motion sensor is motion, turn Light on

Debug

Find calculated sunset and sunrise time

Go to Things. View all properties and press menu in lower right corner and select 'Event Log'. After a sunset/sunrise you will find the time for the event

Known Bugs

Bug 1.

Because of a bug in gateways rule enginge it will not handle rules with more than one properties correctly. If a rule is if DateTime minute is 5 and DateTime is dark, turn Fan on it will not work directly if the rule is created when it is dark. To work it must first be not dark.
To solve this after the rule is created go to the things page and click on the dark property in DateTime device. The same is valie for e.g. 'weekend'.
See bug WebThingsIO/gateway#1452

Code

The code can be found by selecting the release branch on Github.