A sequence is a collection of commands. The commands can be executed in a time sequence. A time of execution is specified in seconds for this purpose. This refers to the start time of the sequence.
The list is edited using the operating buttons directly to the right of the list: Add, Delete, Modify/Edit
Sequences can be imported and exported with the Global Library.
The list is edited using the operating buttons directly to the right of the list: Add, Delete, Modify/Edit
Sequences can be imported and exported with the Global Library.
1.Tabs
1.1.Data
Designation
Designation of the sequence in the project.
Sequences can be searched via the end point interface, where a word from the designation begins with the search word used there.
Sequences can be searched via the end point interface, where a word from the designation begins with the search word used there.
Restart
Yes: if called again, the sequence is cancelled while running and then run again from the beginning.
No: The ongoing sequence continues to be executed without interruption.
The sequence is not executed again at the end of the ongoing sequence.
No: The ongoing sequence continues to be executed without interruption.
The sequence is not executed again at the end of the ongoing sequence.
Commands
All assigned commands with their time of execution are shown in this list. The list is automatically sorted by the time of execution.
An editing mask is opened with the buttons Create and Change. A command is deleted with the Delete button.
An editing mask is opened with the buttons Create and Change. A command is deleted with the Delete button.
1.2.End point
Sequences 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 sequence can of course be used instead of the sequence used in all the call-up 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 from the sequence.https://HS_IP/endpoints/call?key=SQ@my_sequence&method=meta&user=USER&pw=PWD |
| get_state | Retrieval of the status of the sequence (running: True/False).https://HS_IP/endpoints/call?key=SQ@my_sequence&method=get_state&user=USER&pw=PWD |
| start | Starts the sequence.https://HS_IP/endpoints/call?key=SQ@my_sequence&method=start&user=USER&pw=PWD |
| stop | Stops the sequence.https://HS_IP/endpoints/call?key=SQ@my_sequence&method=stop&user=USER&pw=PWD |
1.2.2.Fields
ID
The value entered here forms the unique object keyof the end point, together with the fixed prefix "SQ", 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 sequence.
Sequences can be searched via the end point interface, where a word from the description begins with the search word used there.
Sequences can be searched via the end point interface, where a word from the description begins with the search word used there.
Tags
A list of terms, separated by commas (",").
Sequences 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 ("_")!
Sequences 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 sequence for reading (left column) and/or writing (right column) via the end point interface.