isDate

Triggering periodically when the particular time, day or month has come. The Gregorian Calendar is used.
- Daily event arises each day at a time that is within the time array.
- Weekly event arises each weekday that is set within the weekdays array in time that is set within the time array. If the time array is empty, the event will be True during the whole weekday/day (available since advanced_scenes/1.53), otherwise it will arise at the specified points of time.
- Monthly event arises each day that is set within the days array in time that is set within the time array.
- Weeks and YearWeeks events arise each time when a week with a specified number begins in a month or year accordingly. Available since advanced_scenes/1.9, updated in advanced_scenes/1.52 (see below).

Edit

Field	Type	Required	Description
blockOptions.method.args.type	string	+	Argument declaration of schedule type. The value should be in field block with name type. The possible values are daily, weekly, monthly, weeks and yearWeeks. daily type requires presence of time array only. weekly type requires presence of both time array and weekday array. monthly type requires presence of both time array and day array. weeks and yearWeeks types require presence of weeks array only.
blockOptions.method.args.time	string	+	Argument declaration of time array. The value should be in field block with name time. The time array contains strings. The time format is “hh:mm” in 24-hour clock format. Type 24_hours_time_array. See Item Value Type.
blockOptions.method.args.weekdays	string	–	Argument declaration of weekday array. The value should be in field block with name weekday. The weekday array contains integer numbers. The possible values are 1..7 range. Type int_array. See Item Value Type.
blockOptions.method.args.days	string	–	Argument declaration of day array. The value should be in field block with name day. The day array contains integer numbers. The possible values are 1..31 range. If day is set to 31 then event works in each month where 31st day is present. Type int_array. See Item Value Type.
blockOptions.method.args.weeks	string	–	Argument declaration of weeks array. The value should be in field block with name weeks. The weeks array contains integer numbers. The possible values are in range [1..6, -1] for weeks of a month (for type = weeks), and [1..54, -1] for weeks of a year (for type = yearWeeks). Week -1 means the last week of a period. Type int_array. See Item Value Type.

Edit

See Item Value Types / int_array, 24_hours_time_array

In advanced_scenes/1.52, the behavior for types weeks and yearWeeks was changed. These types no longer use the time array. The state of the condition is True throughout the specified weeks. Other types remain unchanged – they arise only when the particular time point is reached and then immediately switch to False.

Also, since this version, actions in else blocks will be executed for isDate events of the weeks and yearWeeks types.

In advanced_scenes/1.53, possible configurations for types weekly and monthly were extended. In previous versions, the time array had to be non-empty. Now, if the array is empty, the event is durable and its state will be True during the whole weekday/day. Configuration with specific time points is still available and its behavior wasn’t changed. Also, since this version, actions in else blocks will be executed for durable date events of the weekly and monthly types.

Example 1: daily event

Edit

Will raise at 10:20, 12:40, 13:32 every day

				
					{
    "blockOptions":{
        "method":{
            "args":{
                "type":"type",
                "time":"time"
            },
            "name":"isDate"
        }
    },
    "blockType":"when",
    "fields":[
        {
            "name": "type",
            "type": "string",
            "value": "daily"
        },
        {
            "name": "time",
            "type": "24_hours_time_array",
            "value": [ "10:20", "12:40", "13:32" ]
        }
    ]
}

Example 2: days of a week event

Edit

Will raise at 10:20, 12:40, 13:32 every Monday, Tuesday and Sunday.

				
					"when" : [{
    "blockOptions":{
        "method":{
            "args":{
                "type":"type",
                "time":"time",
                "weekdays":"weekdays"
            },
            "name":"isDate"
        }
    },
    "blockType":"when",
    "fields":[
        {
            "name": "type",
            "type": "string",
            "value": "weekly"
        },
        {
            "name": "time",
            "type": "24_hours_time_array",
            "value": [ "10:20", "12:40", "13:32" ]
        },
        {
            "name": "weekdays",
            "type": "int_array",
            "value": [ 1, 2, 7 ]
        }
    ]
}]

Example 2.1: days of a week event, empty time array

Edit

Will raise at 00:00 every Monday, Tuesday and Sunday. The event will stay true during all the day.

				
					{
    "blockOptions":{
        "method":{
            "args":{
                "type":"type",
                "time":"time",
                "weekdays":"weekdays"
            },
            "name":"isDate"
        }
    },
    "blockType":"when",
    "fields":[
        {
            "name": "type",
            "type": "string",
            "value": "weekly"
        },
        {
            "name": "time",
            "type": "24_hours_time_array",
            "value": []
        },
        {
            "name": "weekdays",
            "type": "int_array",
            "value": [ 1, 2, 7 ]
        }
    ]
}

Example 3: monthly event

Edit

Will raise at 10:20, 12:40, 13:32 every 1st, 5th and 12th day of a month.

				
					{
    "blockOptions":{
        "method":{
            "args":{
                "type": "type",
                "time":"time",
                "days":"days"
            },
            "name":"isDate"
        }
    },
    "blockType":"when",
    "fields":[
        {
            "name": "type",
            "type": "string",
            "value": "monthly"
        },
        {
            "name": "time",
            "type": "24_hours_time_array",
            "value": [ "10:20", "12:40", "13:32" ]
        },
        {
            "name": "days",
            "type": "int_array",
            "value": [ 1, 5, 12 ]
        }
    ]
}

Example 3: monthly event, empty time array

Edit

Will raise at 00:00 every 1st, 5th and 12th day of a month. The event will stay true during all the day.

				
					{
    "blockOptions":{
        "method":{
            "args":{
                "type": "type",
                "time":"time",
                "days":"days"
            },
            "name":"isDate"
        }
    },
    "blockType":"when",
    "fields":[
        {
            "name": "type",
            "type": "string",
            "value": "monthly"
        },
        {
            "name": "time",
            "type": "24_hours_time_array",
            "value": []
        },
        {
            "name": "days",
            "type": "int_array",
            "value": [ 1, 5, 12 ]
        }
    ]
}

Example 4: isDate weeks of a month event (This feature is available since advanced_scenes/1.9 version).

Edit

The event will become true at 00:00 of 1st, 3rd and last week of a month and will remain true during all the week.

				
					{
    "blockOptions": {
        "method": {
        "args": {
            "type": "type",
            "weeks": "weeks"
        },
        "name": "isDate"
        }
    },
    "blockType": "when",
    "fields": [
        {
            "name": "type",
            "type": "string",
            "value": "weeks"
        },
        {
            "name": "weeks",
            "type": "int_array",
            "value": [1, 3, -1]
        }
    ]
}

Example 5: isDate weeks of a year (This feature is available since advanced_scenes/1.9 version):

Edit

The event will become true at 00:00 of 35th, 36th and last week of a year and will remain true during all the week.

				
					{
    "blockOptions": {
        "method": {
            "args": {
                "type": "type",
                "weeks": "weeks"
            },
            "name": "isDate"
        }
    },
    "blockType": "when",
    "fields": [
        {
            "name": "type",
            "type": "string",
            "value": "yearWeeks"
        },
        {
            "name": "weeks",
            "type": "int_array",
            "value": [35, 36, -1]
        }
    ]
}

Edit

Reference of required fields by event type:

Type: daily

Edit

Field	Type	Required	Description
blockOptions.method.args.time	24_hours_time_array	+	Target time array. Should not be empty. Should contain at least one value in 24 hour time format.

Type: weekly

Edit

Field	Type	Required	Description
blockOptions.method.args.time	24_hours_time_array	+	Target time array. Required. May be empty. If empty, the event is a range event that is true during all the period defined by the weekdays field. May have multiple different values.
blockOptions.method.args.weekdays	int_array	+	The weekday array contains integer numbers. The possible values are 1..7 range.

Type: monthly

Edit

Field	Type	Required	Description
blockOptions.method.args.time	24_hours_time_array	+	Target time array. Required. May be empty.
blockOptions.method.args.days	int_array	+	An array of days of month. The possible values are 1..31 range. If day is set to 31 then event works in each month where 31st day is present.

Type: weeks

Edit

Field	Type	Required	Description
blockOptions.method.args.weeks	int_array	+	An array of week numbers. The possible values are in range [1..6, -1] for weeks of a month. Week -1 means the last week of a period. First day of a week is Monday.

Type: yearWeeks

Edit

Field	Type	Required	Description
blockOptions.method.args.weeks	int_array	+	An array of week numbers. The possible values are in range [1..54, -1] for weeks of a year. Week -1 means the last week of a period. First day of a week is Monday.