Skip to main content

Notice: This Wiki is now read only and edits are no longer possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.

Jump to: navigation, search

Difference between revisions of "BaSyx / Documentation / API / ControlComponentProfiles"

m (Rearranged common profile values.)
(→‎Profile Values: Changed to bitmasks. Changed ES to select subsets of packML instead of selecting the whole state machine.)
Line 44: Line 44:
 
All profiles shall be determined with an positiv integer or zero, respectively enums may be implemented.
 
All profiles shall be determined with an positiv integer or zero, respectively enums may be implemented.
 
In order to combine profile values and to use them as statements some common values are equal for all profiles, which is presented in the following table.
 
In order to combine profile values and to use them as statements some common values are equal for all profiles, which is presented in the following table.
 +
As different profile values in one profile may be combined they are defined by bitmasks.
 +
Hence their values are multiples of two and combinations may be represented by bit order operations and integer values.
 +
If the value is higher than one any profile values are given.
 
{| class="wikitable"
 
{| class="wikitable"
−
! Value !! Name !! Description
+
!Bit !! Value !! Name !! Description
 +
|-
 +
| 1    || 0  || UNKNOWN || No statement about profile or not determined
 
|-
 
|-
−
| 0 || UNKNOWN || No statement about profile or not determined
+
| 1    || 1 || NONE    || Profile is not realised, used, compliant or implemented
 
|-
 
|-
−
| 1 || NONE     || Profile is not realised, used, compliant or implemented
+
| 2..n || >1 || ANY     || One ore more profile values, but not specified which ones
 
|-
 
|-
−
| 2 || ANY      || One ore more profile values, but not specified which ones
+
| 2   || 2  || ...    || First specific variant or property of the profile.
 
|-
 
|-
−
| 3 - n || Profile specific || Specific variants of the profile.
+
| n   || 2^n|| ...    || Nth specific variant or property of the profile.
 
|-
 
|-
 
|}
 
|}
−
<!-- TODO define a way how profile values can be concenated, as bitmask for example. -->
+
<!-- TODO define a way how profile values can be concenated. -->
  
 
=== SI Profile ===
 
=== SI Profile ===
Line 75: Line 80:
 
! style="text-align:left;"| SI value
 
! style="text-align:left;"| SI value
 
! Name
 
! Name
−
! Usage in Basys
 
 
! Activation mechanism
 
! Activation mechanism
 
! Aggregated state represenation
 
! Aggregated state represenation
 
! Utiliziation recommendation
 
! Utiliziation recommendation
 
|-
 
|-
−
| 0 - 2
+
| 0 - 1
−
| UNKNOWN, NONE, ANY
+
| UNKNOWN, NONE
−
| See [[#Profile Values|common profile values]]
+
 
| Not defined
 
| Not defined
 
| Not defined
 
| Not defined
−
| Probably not a compliant basys control component
+
| See [[#Profile Values|common profile values]]
 
|-
 
|-
−
| 3
+
| 2
−
| VARIABLES
+
−
| Not used in basys
+
−
| Multiple (spread) variables are used to activate service operations
+
−
| Multiple (spread) variables are used to represent the component states
+
−
| Very generic but needs mapping description. Not standardized browseable. May be mapped to NAMUR MTP
+
−
|-
+
−
| 4
+
 
| CMD
 
| CMD
−
| Used in SMS Demonstrator (RWTH)
 
 
| A string variable called CMD (command input) with a specific syntax is used to activate service operations
 
| A string variable called CMD (command input) with a specific syntax is used to activate service operations
 
| A flat list of variables of all aggregated component states under a containing element (folder)
 
| A flat list of variables of all aggregated component states under a containing element (folder)
 
| Process control applications with IEC 61131
 
| Process control applications with IEC 61131
 
|-
 
|-
−
| 5
+
| 4
 
| OPERATIONS
 
| OPERATIONS
−
| Used in SMS and common Demonstrator (~All partners)
 
 
| A flat list of operations of all offered services under a containing element (folder)
 
| A flat list of operations of all offered services under a containing element (folder)
 
| A flat list of variables of all aggregated component states under a containing element (folder)
 
| A flat list of variables of all aggregated component states under a containing element (folder)
 
| Advanced components or as additional interface
 
| Advanced components or as additional interface
 
|-
 
|-
−
| 6
+
| 8
 
| SERVICES
 
| SERVICES
−
| Not used, upcomming in BaSys 4.2
 
 
| Operations are grouped under service elements
 
| Operations are grouped under service elements
 
| State variables are grouped under service elements
 
| State variables are grouped under service elements
 
| Advanced and modular components
 
| Advanced and modular components
 +
|-
 +
| 16
 +
| VARIABLES
 +
| Multiple (spread) variables are used to activate service operations
 +
| Multiple (spread) variables are used to represent the component states
 +
| Very generic but needs mapping description. Not standardized browseable. May be mapped to NAMUR MTP
 
|}
 
|}
 
Note on ''NAMUR Module Type Package (MTP)'': in the future, basys will map the description for the orchestration of modules that are described via a NAMUR MTP to profiles.
 
Note on ''NAMUR Module Type Package (MTP)'': in the future, basys will map the description for the orchestration of modules that are described via a NAMUR MTP to profiles.
Line 131: Line 130:
 
This is important for an orchestrator, as it has to be checked, whether the component is free and it has to be occupied before operation.  
 
This is important for an orchestrator, as it has to be checked, whether the component is free and it has to be occupied before operation.  
 
Further more, the occupation profile determins, whether it is possible to occupy the component with a higher priority, for example by an operator or maintenance person.
 
Further more, the occupation profile determins, whether it is possible to occupy the component with a higher priority, for example by an operator or maintenance person.
−
An OC profile value of two (ANY) or higher requries the component to have an OCCUPIER variable to determine who occupies the component.
+
An OC profile value of two or higher (ANY) requries the component to have an OCCUPIER variable to determine who occupies the component.
−
If the OC profile value is four (PRIO) or higher, the OCCST variable is needed to differentiate occupation states.
+
Moreover, the OCCST variable is needed to differentiate occupation states.
  
 
{| class="wikitable"
 
{| class="wikitable"
−
! Value !! Name !! Description !! Possible OCCST values
+
! Value !! Name !! Description !! Possible OCCST values !! Possible ORDERs
 
|-
 
|-
−
| 0 - 2 || UNKNOWN, NONE, ANY || See [[#Profile Values|common profile values]] || Undefined
+
| 0 - 1 || UNKNOWN, NONE || See [[#Profile Values|common profile values]] || Undefined ||
 
|-
 
|-
−
| 3 || OCCUPIED || Only one occupier || OCCUPIED
+
| 2 || OCCUPIED || Normal occupation possible || FREE, OCCUPIED || FREE, OCCUPY
 
|-
 
|-
−
| 4 || PRIO    || Priority possible || OCCUPIED, PRIO
+
| 4 || PRIO    || Priority occupation possible || FREE, PRIO || FREE, PRIO
 
|-
 
|-
−
| 5 || LOCAL    || Local overwrite  || OCCUPIED, PRIO, LOCAL
+
| 8 || LOCAL    || Local overwrite  || FREE, LOCAL ||
 
|-
 
|-
 
|}
 
|}
Line 151: Line 150:
 
The execution mode profile describes which execution modes are available.
 
The execution mode profile describes which execution modes are available.
 
A component is assumed to be in AUTO like mode at all time, if the ES value is NONE.
 
A component is assumed to be in AUTO like mode at all time, if the ES value is NONE.
−
An ES value of three (MANUAL) or higher demands a EXMODE variable to determine the mode.
+
An ES value of two or higher (ANY) requires a EXMODE variable to determine the current mode.
  
 
{| class="wikitable"
 
{| class="wikitable"
−
! Value !! Name !! Description !! Possible EXMODE values
+
! Value !! Name !! Description !! Possible EXMODE values = Possible ORDERs
 
|-
 
|-
−
| 0 - 2 || UNKNOWN, NONE, ANY || See [[#Profile Values|common profile values]] || Undefined
+
| 0 - 1 || UNKNOWN, NONE || See [[#Profile Values|common profile values]] || Undefined
 
|-
 
|-
−
| 3 || MANUAL  || Additional manual mode available || AUTO, MANUAL
+
| 2 || MANUAL  || Additional manual mode available || AUTO, MANUAL
 
|-
 
|-
−
| 4 || SEMIAUTO || Additional semiautomatic mode available || AUTO, SEMIAUTO, MANUAL
+
| 4 || SEMIAUTO || Additional semiautomatic mode available || AUTO, SEMIAUTO
 
|-
 
|-
−
| 5 || SIMULATE || Additional simulation mode available  || AUTO, SEMIAUTO, MANUAL, SIMULATE
+
| 8 || SIMULATE || Additional simulation mode available  || AUTO, SIMULATE
 
|-
 
|-
 
|}
 
|}
 
<!-- DISCUSS  
 
<!-- DISCUSS  
−
     add more combinations with SIMULATE mode: SIMAUTO (AUTO + SIM), SIMMANU (AUTO + MANUAL + SIM) and SIMSEMI ... ?
+
     AUTO mode always available, like FREE in OC profile.
 
-->
 
-->
  
 
=== ES Profile ===
 
=== ES Profile ===
  
−
The execution state profile defines which execution state machine is used by a reference to common standards.
+
In general different execution state machines or subsets are used in different domains or companies.
−
BaSys recommends the use of the PACKML profile as it is possible to map the other state machines to it.
+
For example
 +
ANSI/ISA-88.00.01-2010<ref name="ISA88">ISA-S88 Part 1 – Batch Control Models and Terminology (IEC 61512-1)</ref>,
 +
MTP Part 4<ref name="MTP">VDI/VDE/NAMUR 2658 Part 4 - Modelling of module services</ref> or
 +
OPC UA Part 10<ref name="OPCUA-Part10">IEC 62541 Part 10 – Programs</ref>
 +
may be used.
 +
 
 +
BaSys recommends the use of the PackML <ref name="PackML">ISA-TR88.00.02-2008 Machine and Unit States:  An Implementation Example of ISA-88.</ref> state machine, as it is possible to map the other state machines to it.
 
<ref name="D-PC2.3">Wagner, C., Grothoff, J., Epple, U., Grüner, S., Wenger, M., & Zoitl, A. (2018). Ein Beitrag zu einem einheitlichen Engineering für Laufzeitumgebungen, 19. Leitkongress der Mess- und Automatisierungs-technik, Baden-Baden.</ref>
 
<ref name="D-PC2.3">Wagner, C., Grothoff, J., Epple, U., Grüner, S., Wenger, M., & Zoitl, A. (2018). Ein Beitrag zu einem einheitlichen Engineering für Laufzeitumgebungen, 19. Leitkongress der Mess- und Automatisierungs-technik, Baden-Baden.</ref>
 +
The execution state profile defines which subset of the PackML execution state machine are used.
 
The EXST variable has to be present, if an ES value of two (ANY) or higher is given.
 
The EXST variable has to be present, if an ES value of two (ANY) or higher is given.
 
A control component with ES profile value one (NONE) is assumed to be in the EXECUTE state at all time and hence it can not be halted, suspended, stopped or aborted.
 
A control component with ES profile value one (NONE) is assumed to be in the EXECUTE state at all time and hence it can not be halted, suspended, stopped or aborted.
  
 +
<!-- TODO add description of every value in table -->
 
{| class="wikitable"
 
{| class="wikitable"
−
! Value !! Name !! Description !! Reference
+
! Value !! Name !! Possible EXST States !! Possible ORDERs
 
|-
 
|-
−
| 0 - 2 || UNKNOWN, NONE, ANY || See [[#Profile Values|common profile values]] || Undefined
+
| 0 - 1 || UNKNOWN, NONE || See [[#Profile Values|common profile values]] || ||
 
|-
 
|-
−
| 3 || PACKML  || PackML state machine        || ISA TR88.00.02-2008<ref name="PackML">ISA-TR88.00.02-2008 Machine and Unit States:  An Implementation Example of ISA-88.</ref>
+
| 2 || COMPLETE || EXECUTE, (COMPLETING), COMPLETE, (RESETTING), IDLE, (STARTING) || START, RESET
 
|-
 
|-
−
| 4 || ISA88    || ISA88 state machine          || ANSI/ISA-88.00.01-2010<ref name="ISA88">ISA-S88 Part 1 – Batch Control Models and Terminology (IEC 61512-1)</ref>
+
| 4 || SUSPEND  || EXECUTE, (SUSPENDING), SUSPENDED, (UNSUSPENDING) || SUSPEND, UNSUSPEND
 
|-
 
|-
−
| 5 || MTP      || MTP state machine            || MTP Part 4<ref name="MTP">VDI/VDE/NAMUR 2658 Part 4 - Modelling of module services</ref>
+
| 8 || HOLD    || EXECUTE, (HOLDING), HELD, (UNHOLDING) || HOLD, UNHOLD
 
|-
 
|-
−
| 6 || OPCUA   || OPC UA program state machine || OPC UA Part 10<ref name="OPCUA-Part10">IEC 62541 Part 10 – Programs</ref>
+
| 16 || STOP   || EXECUTE, (STOPPING), STOPPED, (RESETTING), IDLE, (STARTING) || START, STOP, RESET
 
|-
 
|-
−
| 7 || BASYS    || Subset of PackML (Start, Stop, Reset) || PackML without held, suspended, aborted and corresponding active states.<!-- BaSys IPSMS specification -->
+
| 32 || ABORT  || EXECUTE, (ABORTING), ABORTED, (CLEARING), STOPPED, (RESETTING), IDLE, (STARTING) || ABORT, CLEAR, RESET, START
 
|-
 
|-
 
|}
 
|}
Line 203: Line 210:
 
! Value !! Name !! Description
 
! Value !! Name !! Description
 
|-
 
|-
−
| 0 - 2 || UNKNOWN, NONE, ANY || See [[#Profile Values|common profile values]]
+
| 0 - 1 || UNKNOWN, NONE || See [[#Profile Values|common profile values]]
 
|-
 
|-
−
| 3 || CONTI   || Conti process operation mode with startup and shutdown: BSTATE, STARTUP, SHUTDOWN
+
| 2 || MULTI   || Multiple, application specific modes available.
 
|-
 
|-
−
| 4 || MULTI    || Multiple, application specific modes available.
+
| 4 || PARALLEL || Parallel executable operation modes with own execution states. See [[BaSyx_/_Documentation_/_API_/_ControlComponent#Components with concurrent behavior|components with concurrent behavior]].
 +
| 8 || CONTI    || Conti process operation mode with startup and shutdown: BSTATE, STARTUP, SHUTDOWN
 
|-
 
|-
−
| 5 || PARALLEL || Parallel executable operation modes with own execution states. See [[BaSyx_/_Documentation_/_API_/_ControlComponent#Components with concurrent behavior|components with concurrent behavior]].
 
 
|}
 
|}
  

Revision as of 10:01, 20 January 2020

Warning2.png
This information is work in progress as part of the BaSys 4.2 project. This section is preliminary and subject to change during the project.


Overview | Interface | Implementation

Profiles

An example control component in OPC UA with the following profile: SI=5, OC=4, EM=3, ES=3, OM=4

BaSys control components may be described by the following profiles:

SI - Service Interface Profile
Describes how the offered services are structured and how states are represented.
This profile is special, because it is orthogonal to the other profiles. Hence, every other profile looks a bit different, if a different SI profile is realised in component.
OC - Occupation Profile
Describes whether a occuption is necessary.
Variants may describe whether a occupation with priority or local is possible.
EM - Execution Modes Profile
Describes whether different execution modes are possible.
Variants may describe which modes are possible and how they are called.
ES - Execution States Profile
References the used execution states and their transitions.
May describe variants or subsets of a full execution state state machines.
OM - Operation Modes Profile
Describes whether multiple operation modes are available and need to be selcted.
Variants may describe whether there are specific operation modes, like fallback or startup and shutdown modes.

For example a control component could have the following profile values.

  • SI = 5 (OPERATIONS)
  • OC = 4 (PRIO)
  • EM = 3 (MANUAL)
  • ES = 3 (PACKML)
  • OM = 4 (MULTI)

The address space of a control component interface in OPC UA is shown in the figure.

Profile Values

All profiles shall be determined with an positiv integer or zero, respectively enums may be implemented. In order to combine profile values and to use them as statements some common values are equal for all profiles, which is presented in the following table. As different profile values in one profile may be combined they are defined by bitmasks. Hence their values are multiples of two and combinations may be represented by bit order operations and integer values. If the value is higher than one any profile values are given.

Bit Value Name Description
1 0 UNKNOWN No statement about profile or not determined
1 1 NONE Profile is not realised, used, compliant or implemented
2..n >1 ANY One ore more profile values, but not specified which ones
2 2 ... First specific variant or property of the profile.
n 2^n ... Nth specific variant or property of the profile.

SI Profile

The control component service interface E1 may be realised in various ways. Basys classifies different realisations via profiles. The service interface profile (SI) describes how a control component can be affected by the means of orchestration and how the resulting state changes may be observed. Therefore each profile value defines how the activation interaction likewise the writing of variables or invocation of operations is handled. Moreover, a component has aggregated state values for its state machines, which may be represented by one or more variables at different adresses. State change events may be raised if state variable values change. Consequently, the SI profile also defines how to find the addresses or endpoints of its activation and reaction represenations.

The following table presents an overview and small comparision of possible SI profile values. The major profile of the service interface used in basys is OPERATIONS.

SI value Name Activation mechanism Aggregated state represenation Utiliziation recommendation
0 - 1 UNKNOWN, NONE Not defined Not defined See common profile values
2 CMD A string variable called CMD (command input) with a specific syntax is used to activate service operations A flat list of variables of all aggregated component states under a containing element (folder) Process control applications with IEC 61131
4 OPERATIONS A flat list of operations of all offered services under a containing element (folder) A flat list of variables of all aggregated component states under a containing element (folder) Advanced components or as additional interface
8 SERVICES Operations are grouped under service elements State variables are grouped under service elements Advanced and modular components
16 VARIABLES Multiple (spread) variables are used to activate service operations Multiple (spread) variables are used to represent the component states Very generic but needs mapping description. Not standardized browseable. May be mapped to NAMUR MTP

Note on NAMUR Module Type Package (MTP): in the future, basys will map the description for the orchestration of modules that are described via a NAMUR MTP to profiles. Therefore an existing profile value like VARIABLES may be used or a new profile value may be necessary.

OC Profile

The occupation profile describes, whether a control component can be occupied. This is important for an orchestrator, as it has to be checked, whether the component is free and it has to be occupied before operation. Further more, the occupation profile determins, whether it is possible to occupy the component with a higher priority, for example by an operator or maintenance person. An OC profile value of two or higher (ANY) requries the component to have an OCCUPIER variable to determine who occupies the component. Moreover, the OCCST variable is needed to differentiate occupation states.

Value Name Description Possible OCCST values Possible ORDERs
0 - 1 UNKNOWN, NONE See common profile values Undefined
2 OCCUPIED Normal occupation possible FREE, OCCUPIED FREE, OCCUPY
4 PRIO Priority occupation possible FREE, PRIO FREE, PRIO
8 LOCAL Local overwrite FREE, LOCAL

EM Profile

The execution mode profile describes which execution modes are available. A component is assumed to be in AUTO like mode at all time, if the ES value is NONE. An ES value of two or higher (ANY) requires a EXMODE variable to determine the current mode.

Value Name Description Possible EXMODE values = Possible ORDERs
0 - 1 UNKNOWN, NONE See common profile values Undefined
2 MANUAL Additional manual mode available AUTO, MANUAL
4 SEMIAUTO Additional semiautomatic mode available AUTO, SEMIAUTO
8 SIMULATE Additional simulation mode available AUTO, SIMULATE

ES Profile

In general different execution state machines or subsets are used in different domains or companies. For example ANSI/ISA-88.00.01-2010[1], MTP Part 4[2] or OPC UA Part 10[3] may be used.

BaSys recommends the use of the PackML [4] state machine, as it is possible to map the other state machines to it. [5] The execution state profile defines which subset of the PackML execution state machine are used. The EXST variable has to be present, if an ES value of two (ANY) or higher is given. A control component with ES profile value one (NONE) is assumed to be in the EXECUTE state at all time and hence it can not be halted, suspended, stopped or aborted.

Value Name Possible EXST States Possible ORDERs
0 - 1 UNKNOWN, NONE See common profile values
2 COMPLETE EXECUTE, (COMPLETING), COMPLETE, (RESETTING), IDLE, (STARTING) START, RESET
4 SUSPEND EXECUTE, (SUSPENDING), SUSPENDED, (UNSUSPENDING) SUSPEND, UNSUSPEND
8 HOLD EXECUTE, (HOLDING), HELD, (UNHOLDING) HOLD, UNHOLD
16 STOP EXECUTE, (STOPPING), STOPPED, (RESETTING), IDLE, (STARTING) START, STOP, RESET
32 ABORT EXECUTE, (ABORTING), ABORTED, (CLEARING), STOPPED, (RESETTING), IDLE, (STARTING) ABORT, CLEAR, RESET, START

OM Profile

The operation mode profile defines whether different operation modes are selectable. A control component with an OM value of two or higher has to represent the current operation mode via OPMODE state variable. The OM value NONE yields to a control component, that has no operation modes to select and is therefore assumed to be in BSTATE (basic state) at all time.

Value Name Description
0 - 1 UNKNOWN, NONE See common profile values
2 MULTI Multiple, application specific modes available.
4 PARALLEL Parallel executable operation modes with own execution states. See components with concurrent behavior. 8 CONTI Conti process operation mode with startup and shutdown: BSTATE, STARTUP, SHUTDOWN


References

  1. ↑ ISA-S88 Part 1 – Batch Control Models and Terminology (IEC 61512-1)
  2. ↑ VDI/VDE/NAMUR 2658 Part 4 - Modelling of module services
  3. ↑ IEC 62541 Part 10 – Programs
  4. ↑ ISA-TR88.00.02-2008 Machine and Unit States: An Implementation Example of ISA-88.
  5. ↑ Wagner, C., Grothoff, J., Epple, U., Grüner, S., Wenger, M., & Zoitl, A. (2018). Ein Beitrag zu einem einheitlichen Engineering für Laufzeitumgebungen, 19. Leitkongress der Mess- und Automatisierungs-technik, Baden-Baden.
BaSyx project links: Project BaSyx main wiki page | What is BaSyx? | BaSyx Developer Documentation
Retrieved from "https://wiki.eclipse.org/index.php?title=BaSyx_/_Documentation_/_API_/_ControlComponentProfiles&oldid=437674"

Back to the top