Difference between revisions of "Scheduler"
| (16 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
| − | {{UI Object Header}}[[ | + | {{UI Object Header}} |
| + | |||
| + | This object provides the user interface to the HSYCO's scheduler system. | ||
| + | The scheduler is a powerful function that allows you to define a set of calendar entries to schedule actions at the beginning and end of each time interval. | ||
| + | |||
| + | A normal scheduler rule is defined with a start date/time and an end date/time and is valid within the defined period, even across several days. A daily rule is instead defined to be valid between a start time and end time, on a single day or spanning several days. If the end time is less than the start time, it will be considered as the next day. | ||
| + | |||
| + | An alternative scheduler mode, called trigger mode, is used when you only need to define a punctual activation time, not an activation period. In this case the schedule will activate only on the minute of the preset time. | ||
| + | |||
| + | The "repeat every year" flag can be set to automatically repeat the date interval on every year following the initial date. | ||
| + | |||
| + | In addition to the validity dates, you can set a rule to be active only on specific week days. | ||
| + | When the current time matches the date/time and week days, the default behavior is that the scheduler generates a TIMER <schedule name> = ON event and the corresponding userTimerEvent() Java callback — just like the (timer) object — and a TIMER <schedule name> = OFF event at the end of the period. Only the TIMER <schedule name> = ON event is generated for trigger mode schedulers. | ||
| + | |||
| + | You can also define an interval rule, setting the on and off minutes. An interval rule will go on and off repeatedly during the date/time validity period. | ||
| + | Each rule has a group. This group is used to generate the events, and is not unique, as you can define several rules under the same group. In this case the scheduler will evaluate the rules having the same group in the order they appear in the scheduler display, from top to bottom. | ||
| + | |||
| + | When a rule matches the date/time validity period, the scheduler stops checking any following rules with the same group. So, rules on top have priority within the rules with the same group. | ||
| + | |||
| + | When working in trigger mode, if there are rules, with date from or to set, that match the current date, any following rule with no date from and to set will be masked (skipped). | ||
| + | |||
| + | Rules set to work in off mode are used as "blocking rules", because when they are valid they will not become active, and at the same time will prevent the scheduler from processing the following rules that could otherwise match. | ||
| + | |||
| + | A scheduler has two graphical modes: compact and wide, depending on the object's width. A width of 750 pixels or more will toggle the wide mode that will display both the list of rules and the rule's details. | ||
| + | |||
| + | Here's a scheduler in compact mode, showing the list and the details: | ||
| + | |||
| + | [[File:UI Object scheduler.1.png]] | ||
| + | [[File:UI Object scheduler.2.png]] | ||
| + | |||
| + | Here's a scheduler in wide mode: | ||
| + | |||
| + | [[File:UI Object scheduler.3.png]] | ||
| + | [[File:UI Object scheduler.4.png]] | ||
| + | |||
| + | == Parameters == | ||
| + | *'''id''': the object's ID, used by UISets | ||
| + | *'''position''': the object's position. Use the pixels or rows and columns coordinates format | ||
| + | *'''width''': panel's width, in pixels | ||
| + | *'''height''': panel's height, in pixels | ||
| + | *'''rule list mode''': set to “edit” to enable the creation or deletion of individual schedules. Set to “noedit” to only allow editing of already defined schedules | ||
| + | *'''groups''': optional, comma separated list of schedule group names that are shown in this object. If the list is not defined or set to "*", the object shows all groups. Note that group names are case sensitive | ||
| + | *'''trigger mode''': optional, set to true for trigger-only schedules; default is false | ||
| + | |||
| + | == Syntax == | ||
| + | (scheduler <position>; <width>; <height>; <rule list mode>; <groups>; <trigger mode>) | ||
| + | E.g. | ||
| + | (scheduler!myscheduler x3y256; 750; 350; edit;) | ||
| + | |||
| + | == UI Attributes == | ||
| + | {{UI Object Attributes (Common)}} | ||
| + | === Scheduler attributes === | ||
| + | {| class="wikitable" | ||
| + | !Name | ||
| + | !Value | ||
| + | !Description | ||
| + | |- | ||
| + | |groups | ||
| + | |<comma-separated list of values> | ||
| + | |Specify the list of schedule groups names | ||
| + | |- | ||
| + | |} | ||
Latest revision as of 19:15, 25 February 2019
For a description and a complete list of UI Objects, see This object provides the user interface to the HSYCO's scheduler system. The scheduler is a powerful function that allows you to define a set of calendar entries to schedule actions at the beginning and end of each time interval.
A normal scheduler rule is defined with a start date/time and an end date/time and is valid within the defined period, even across several days. A daily rule is instead defined to be valid between a start time and end time, on a single day or spanning several days. If the end time is less than the start time, it will be considered as the next day.
An alternative scheduler mode, called trigger mode, is used when you only need to define a punctual activation time, not an activation period. In this case the schedule will activate only on the minute of the preset time.
The "repeat every year" flag can be set to automatically repeat the date interval on every year following the initial date.
In addition to the validity dates, you can set a rule to be active only on specific week days. When the current time matches the date/time and week days, the default behavior is that the scheduler generates a TIMER <schedule name> = ON event and the corresponding userTimerEvent() Java callback — just like the (timer) object — and a TIMER <schedule name> = OFF event at the end of the period. Only the TIMER <schedule name> = ON event is generated for trigger mode schedulers.
You can also define an interval rule, setting the on and off minutes. An interval rule will go on and off repeatedly during the date/time validity period. Each rule has a group. This group is used to generate the events, and is not unique, as you can define several rules under the same group. In this case the scheduler will evaluate the rules having the same group in the order they appear in the scheduler display, from top to bottom.
When a rule matches the date/time validity period, the scheduler stops checking any following rules with the same group. So, rules on top have priority within the rules with the same group.
When working in trigger mode, if there are rules, with date from or to set, that match the current date, any following rule with no date from and to set will be masked (skipped).
Rules set to work in off mode are used as "blocking rules", because when they are valid they will not become active, and at the same time will prevent the scheduler from processing the following rules that could otherwise match.
A scheduler has two graphical modes: compact and wide, depending on the object's width. A width of 750 pixels or more will toggle the wide mode that will display both the list of rules and the rule's details.
Here's a scheduler in compact mode, showing the list and the details:
Here's a scheduler in wide mode:
Parameters
- id: the object's ID, used by UISets
- position: the object's position. Use the pixels or rows and columns coordinates format
- width: panel's width, in pixels
- height: panel's height, in pixels
- rule list mode: set to “edit” to enable the creation or deletion of individual schedules. Set to “noedit” to only allow editing of already defined schedules
- groups: optional, comma separated list of schedule group names that are shown in this object. If the list is not defined or set to "*", the object shows all groups. Note that group names are case sensitive
- trigger mode: optional, set to true for trigger-only schedules; default is false
Syntax
(scheduler <position>; <width>; <height>; <rule list mode>; <groups>; <trigger mode>)
E.g.
(scheduler!myscheduler x3y256; 750; 350; edit;)
UI Attributes
Common attributes
| Name | Value | Description |
|---|---|---|
| pos | x<x>y<y> | Position specified as x/y coordinates. E.g. x-5y10 |
| visible | true | Default. Show the object |
| false | Hide the object | |
| blink | true | slow | Blink the object at a slow speed |
| fast | Blink the object at a fast speed | |
| false | Stop the blinking | |
| opacity | 0.0 ... 1.0 | Object opacity from 0 (not visible) to 1 (fully visible) |
| rotation | 0 ... 360 | Object rotation in degrees. Images are rotated around the center point, all other objects are rotated around the top left corner |
Scheduler attributes
| Name | Value | Description |
|---|---|---|
| groups | <comma-separated list of values> | Specify the list of schedule groups names |
