The universal timers are managed in this mask.
To start commands or sequences of commands at specific times or to stop them again after expiry of a specific time period, you can use universal timers in the HS/FS. Up to 100 functions can be assigned to a universal timer, and several commands can be assigned to each function.
The user assigns the times of execution to the functions in the HS/FS during operation. It forms a so-called action from the function and time of execution.
Further information on the application is available here.
In addition, the clock in the HS/FS can be synchronised via the Internet with a time standard - the so-called time server - or via the EIB. The settings are made under Master data\Project\Time calibration.
The universal timer can only be set when the HS/FS is in operation using one of the user interfaces. The universal timers are saved retentively in the HS/FS.
Universal timers can be imported and exported via the Global Library.
To start commands or sequences of commands at specific times or to stop them again after expiry of a specific time period, you can use universal timers in the HS/FS. Up to 100 functions can be assigned to a universal timer, and several commands can be assigned to each function.
The user assigns the times of execution to the functions in the HS/FS during operation. It forms a so-called action from the function and time of execution.
Further information on the application is available here.
In addition, the clock in the HS/FS can be synchronised via the Internet with a time standard - the so-called time server - or via the EIB. The settings are made under Master data\Project\Time calibration.
The universal timer can only be set when the HS/FS is in operation using one of the user interfaces. The universal timers are saved retentively in the HS/FS.
Universal timers can be imported and exported via the Global Library.
1.Tabs
1.1.Data
Designation
The universal timer is maintained under this term in the HS/FS Expert.
Universal timers can be searched via the end point interface, where a word from the designation begins with the search word used there.
Universal timers can be searched via the end point interface, where a word from the designation begins with the search word used there.
Control: Switch on/off via communication object
The clock can be activated or deactivated via the following communication object. At the same time, this status is displayed to the user in the user interface. The user can switch the status here. Switching within the user interface also changes the value of the communication object. If the communication object has the value 1, the universal timer is activated. If the communication object has the value 0, the universal timer is deactivated.
The communication object is not mandatory for the operation of the universal timer. If a communication object is assigned, the clock can only be activated/deactivated via the user interface.
The communication object is not mandatory for the operation of the universal timer. If a communication object is assigned, the clock can only be activated/deactivated via the user interface.
1.1.1.Functions
These functions are displayed to the user in the operating menu of the HS/FS with this universal timer. The commands are created for each function in the following mask.
Note
Only available when a function is created/edited.
1.2.End point
Universal timers can be accessed via the end point interface of the HS/FS.
There is a description of the call parameters here.
There is a description of the call parameters here.
Note
Any universal timer can of course be used instead of the universal timer used in all the call examples in the following table.
Placeholders are specified in UPPER CASE.
Placeholders are specified in UPPER CASE.
1.2.1.Methods
| Method | Description/Call |
|---|---|
| meta | Retrieval of metadata of the universal timer.https://HS_IP/endpoints/call?key=TI@my_uzsu&method=meta&user=USER&pw=PWD |
| get_state | Retrieval of the current state (active or inactive).https://HS_IP/endpoints/call?key=TI@my_uzsu&method=get_state&user=USER&pw=PWD |
| set_active | Activates the universal timer.https://HS_IP/endpoints/call?key=TI@my_uzsu&method=set_active&user=USER&pw=PWD |
| set_inactive | Deactivates the universal timer.https://HS_IP/endpoints/call?key=TI@my_uzsu&method=set_inactive&user=USER&pw=PWD |
| get_events | Retrieval of a list with all defined events.https://HS_IP/endpoints/call?key=TI@my_uzsu&method=get_events&user=USER&pw=PWD |
| add_event | Adds an event to the universal timer. Depending on the type of event, different parameters must also be transferred. Days of the week and time: (Tuesdays and Thursdays, 5.30 p.m., every day, action ID from call 'method=meta') https://HS_IP/endpoints/call?key=TI@my_uzsu&method=add_event&date_type=1&weekdays=1,3&time_type=1&time=1730&filter=0&action=123&user=USER&pw=PWD |
| set_event | Modifies an existing event. Depending on the type of event, different parameters must also be transferred. Modify the example from 'add_event': Add 'Wednesday'. (event_id from call 'method=meta') https://HS_IP/endpoints/call?key=TI@my_uzsu&method=set_event&event_id=789&weekdays=1,2,3&user=USER&pw=PWD |
| del_event | Deletes an existing event. (event_id from call 'method=meta')https://HS_IP/endpoints/call?key=TI@my_uzsu&method=del_event&event_id=789&user=USER&pw=PWD |
| simulate | Returns the times within the specified time period (specified in days, max. 28) at which events are triggered.https://HS_IP/endpoints/call?key=TI@my_uzsu&method=simulate&days=5&user=USER&pw=PWD |
1.2.2.Event
Description of the structure of an event.
- event_id - ID of the event.
- date_type - Indicates the type of date
- 1 => Days of the week
- 2 => Time period
- 3 => Individual date
- Only if date_type = 1:
- weekdays - List of activated weekdays (0=Monday, 6=Sunday).
- Only if date_type = 2:
- date1 - First day on which the event is to be triggered (date to be specified in the format "yymmdd").
- date2 - Last day on which the event is to be triggered (date to be specified in the format "yymmdd").
- Only if date_type = 3:
- day - Day (1-31) on which the event is to be triggered. If the field is not set, the event is triggered on every day on which the month and year match.
- month - Month (1-12) on which the event is to be triggered. If the field is not set, the event is triggered in every month in which the day and year match.
- year - Year (0-99 for 2000 to 2099) in which the event is to be triggered. If the field is not set, the event is triggered in every year in which the day and month match.
- time_type - Indicates the type of time specification
- 1 => Time
- 2 => Sunrise
- 3 => Sunset
- Only if time_type = 1:
- time - Time in the format "hhmm".
- Only if time_type = 2 or 3:
- offset - Number in minutes in which the event is to be triggered before (negative value) or after (positive value) sunrise or sunset.
- random - (Optional) Max. number in minutes which are to be added to or subtracted from the trigger time.
- filter - Defines whether an action is carried out
- 0 => Always
- 1 => Normal days (not a public holiday or holiday)
- 2 => Public holiday
- 3 => Holiday
- 4 => Never
- action - ID of the action to be triggered. All the actions defined in the universal timer are transferred when the metadata is retrieved.
1.2.3.Fields
ID
The value entered here forms the unique object keyof the end point, together with the fixed prefix "TI", with which the ID is connected by an '@' character.
Permitted characters are: A-Z, a-z, 0-9, hyphen ("-") and underscore ("_")!
Permitted characters are: A-Z, a-z, 0-9, hyphen ("-") and underscore ("_")!
Description
A meaningful description of the universal timer.
Universal timers can be searched via the end point interface, where a word from the designation begins with the search word used there.
Universal timers can be searched via the end point interface, where a word from the designation begins with the search word used there.
Tags
A list of terms, separated by commas (",").
Universal timers can be searched via the end point interface, where an individual tag completely matches the search word used there.
Permitted characters are: A-Z, a-z, 0-9, hyphen ("-") and underscore ("_")!
Universal timers can be searched via the end point interface, where an individual tag completely matches the search word used there.
Permitted characters are: A-Z, a-z, 0-9, hyphen ("-") and underscore ("_")!
User groups
Important
This item is only available when user groups have been activated!
User groups can be authorised to access this universal timer for reading (left column) and/or writing (right column) via the end point interface.