The structure of the Companion Specification Profile and its Facets is interdependent, as depicted in Figure 20. Implementations of the Companion Specification are required to fulfil the LADS BaseServer Server Profile. Additionally, up to three optional Facets - Maintenance, ProgramManager, and ExtendedFunctionalUnit (blue) - can be implemented.
The Maintenance Facet encompasses all necessary nodes for maintenance use cases. The ProgramManager Facet includes all nodes for read-only Program Management, which can be expanded with management methods in the ExtendedProgramManager.
The ExtendedFunctionalUnit Profile mandates the optional methods of the FunctionalUnit, enabling control of a functional unit and a program. This structure provides a comprehensive and flexible framework for implementing the LADS Companion Specification.
In addition, at least one Facet function (grey) needs to be implemented. For the CoverFunction and the ControllerFunction, there is a base Profile (read-only) and an extended Profile with method and write implementation.
Figure 20 – Overview of the Profiles
Table 134 lists all Profiles defined in this document and defines their URIs.
Table 134 – Profile URIs for LADS
Profile |
URI |
LADS BaseServer Server Profile |
http://opcfoundation.org/UA-Profile/LADS/Server/BaseServer |
LADS Maintenance Server Facet |
http://opcfoundation.org/UA-Profile/LADS/Server/Maintenance |
LADS ProgramManager Server Facet |
http://opcfoundation.org/UA-Profile/LADS/Server/ProgramManager |
LADS ExtendedProgramManager |
http://opcfoundation.org/UA-Profile/LADS/Server/ExtendedProgramManager |
LADS ExtendedFunctionalUnit Server Facet |
http://opcfoundation.org/UA-Profile/LADS/Server/ExtendedFunctionalUnit |
LADS CoverFunction Server Facet |
http://opcfoundation.org/UA-Profile/LADS/Server/CoverFunction |
LADS SensorFunction Server Facet |
http://opcfoundation.org/UA-Profile/LADS/Server/SensorFunction |
LADS ControllerFunction Server Facet |
http://opcfoundation.org/UA-Profile/LADS/Server/ControllerFunction |
LADS ExtendedControllerFunction Server Facet |
http://opcfoundation.org/UA-Profile/LADS/Server/ExtendedControllerFunction |
The following sections specify the Facets available for Servers that implement the LADS companion specification. Each section defines and describes a Facet or Profile.
Table 135 defines a Profile that describes a basic LADS OPC UA Server.
Table 135 – LADS BaseServer Server Profile
Group |
Conformance Unit/Profile Title |
Mandatory/Optional |
Profile |
0:Core 2022 Server Facethttp://opcfoundation.org/UA-Profile/Server/Core2022Facet |
|
Profile |
0:Nano Embedded Device 2022 Server Profilehttp://opcfoundation.org/UA-Profile/Server/NanoEmbeddedDevice2022 |
|
Profile |
0:UA-TCP UA-SC UA Binaryhttp://opcfoundation.org/UA-Profile/Transport/uatcp-uasc-uabinary |
|
Profile |
0:Data Access Server Facethttp://opcfoundation.org/UA-Profile/Server/DataAccess |
|
Base Information |
0:Base Info Custom Type System |
M |
Base Information |
0:Base Info Engineering Units |
M |
Base Information |
0:Base Info Placeholder Modelling Rules |
M |
AMB |
3:AMB Configurable Asset Identification |
M |
AMB |
3:AMB Hierarchical Location Property |
O |
AMB |
3:AMB Operational Location Property |
O |
DI |
2:DI DeviceSet |
M |
DI |
2:DI DeviceType |
M |
DI |
2:DI DeviceHealth |
O |
DI |
2:DI Locking |
O |
Machinery |
4:Machinery Component Identification |
O |
Machinery |
4:Machinery Building Block Organization |
O |
Machinery |
4:Machinery MachineryItem State |
O |
Machinery |
4:Machinery Operation Mode |
O |
Machinery |
4:Machinery Operation Counter |
O |
Machinery |
4:Machinery Lifetime Counter |
O |
LADS |
LADS ComponentSetType |
M |
LADS |
LADS FunctionalStateMachineType |
M |
LADS |
LADS FunctionalUnitSetType |
M |
LADS |
LADS FunctionalUnitStateMachineType |
M |
LADS |
LADS FunctionalUnitType |
M |
LADS |
LADS FunctionSetType |
M |
LADS |
LADS FunctionType |
M |
LADS |
LADS LADSComponentType |
M |
LADS |
LADS LADSDeviceStateMachineType |
M |
LADS |
LADS LADSDeviceStateMachineType GotoMaintenance Method |
O |
LADS |
LADS LADSDeviceStateMachineType GotoOperating Method |
O |
LADS |
LADS LADSDeviceStateMachineType GotoShuttingDown method |
O |
LADS |
LADS LADSDeviceStateMachineType GotoSleep Method |
O |
LADS |
LADS LADSDeviceType |
M |
LADS |
LADS LADSMaintenanceSetType |
O |
LADS |
LADS LADSOperationCountersType |
M |
LADS |
LADS RunningStateMachineType |
M |
LADS |
LADS SensorValueSetType |
M |
LADS |
LADS SetType |
M |
LADS |
LADS SupportedPropertiesSetType |
M |
LADS |
LADS SupportedPropertyType |
M |
LADS |
LADS VariableSetType |
M |
LADS |
LADS FunctionalStateMachineType |
M |
LADS |
LADS FunctionalUnitSetType |
M |
LADS |
LADS FunctionalUnitStateMachineType |
M |
LADS |
LADS FunctionalUnitType |
M |
LADS |
LADS FunctionSetType |
M |
Table 136 defines a Profile that contains all necessary conformance units for maintenance tasks.
Table 136 – LADS Maintenance Server Facet
Group |
Conformance Unit/Profile Title |
Mandatory/Optional |
AMB |
AMB Asset Health Status Base |
M |
AMB |
AMB Asset Health Status Alarms |
O |
AMB |
AMB Asset Health Tracking Overall Asset Status |
O |
AMB |
AMB Asset Health Tracking Events |
O |
AMB |
AMB Client Asset Health Status |
O |
LADS |
LADS MaintenanceTaskType |
M |
LADS |
LADS MaintenanceTaskType ResetTask Method |
O |
LADS |
LADS MaintenanceTaskType Start Method |
O |
Table 137 defines a Profile that contains all necessary conformance units for program monitoring.
Table 137 – LADS ProgramManager Server Facet
Group |
Conformance Unit/Profile Title |
Mandatory/Optional |
LADS |
LADS ActiveProgramType |
M |
LADS |
LADS ProgramManagerType |
M |
LADS |
LADS ProgramTemplateSetType |
M |
LADS |
LADS ProgramTemplateType |
M |
LADS |
LADS ResultFileSetType |
O |
LADS |
LADS ResultFileType |
O |
LADS |
LADS ResultSetType |
O |
LADS |
LADS ResultType |
O |
Table 138 defines a Profile that contains all necessary conformance units for complete program management, including up- and download of program templates.
Table 138 – LADS ExtendedProgramManager Server Facet
Group |
Conformance Unit/Profile Title |
Mandatory/Optional |
LADS |
LADS ProgramManager Server Facet |
M |
LADS |
LADS ProgramManagerType Download method |
M |
LADS |
LADS ProgramManagerType Remove method |
M |
LADS |
LADS ProgramManagerType Upload method |
M |
Table 139 defines a Profile that contains all conformance units which extend a Functional Unit with Methods.
Table 139 – LADS ExtendedFunctionalUnit Server Facet
Group |
Conformance Unit/Profile Title |
Mandatory/Optional |
LADS |
LADS FunctionalStateMachineType Abort Method |
M |
LADS |
LADS FunctionalStateMachineType Clear Method |
M |
LADS |
LADS FunctionalStateMachineType Stop Method |
M |
LADS |
LADS FunctionalUnitStateMachineType Start Method |
M |
LADS |
LADS FunctionalUnitStateMachineType StartProgram Method |
O |
LADS |
LADS RunningStateMachineType Hold Method |
O |
LADS |
LADS RunningStateMachineType Reset Method |
O |
LADS |
LADS RunningStateMachineType Suspend Method |
O |
LADS |
LADS RunningStateMachineType ToComplete Method |
O |
LADS |
LADS RunningStateMachineType Unhold Method |
O |
LADS |
LADS RunningStateMachineType Unsuspend Method |
O |
Table 140 defines a Profile which contains all conformance units for implementing a cover function.
Table 140 – LADS CoverFunction Server Facet
Group |
Conformance Unit/Profile Title |
Mandatory/Optional |
LADS |
LADS CoverFunctionType |
M |
LADS |
LADS CoverStateMachineType |
M |
Table 141 defines a Profile which contains all conformance units for implementing a cover function and extending the CoverFunction with Methods.
Table 141 – LADS ExtendedCoverFunction Server Facet
Group |
Conformance Unit/Profile Title |
Mandatory/Optional |
LADS |
LADS CoverFunction Server Facet |
|
LADS |
LADS CoverStateMachineType Close Method |
M |
LADS |
LADS CoverStateMachineType Lock Method |
M |
LADS |
LADS CoverStateMachineType Open Method |
M |
LADS |
LADS CoverStateMachineType Reset Method |
O |
LADS |
LADS CoverStateMachineType Unlock Method |
M |
LADS |
LADS CoverStateMachineType Close Method |
M |
Table 142 defines a Profile that a Server can provide if a Sensor is used in the model. At least one of the optional conformance units must also be implemented.
Table 142 – LADS SensorFunction Server Facet
Group |
Conformance Unit/Profile Title |
Mandatory/Optional |
LADS |
LADS AnalogArraySensorFunctionType |
O |
LADS |
LADS AnalogSensorFunctionType |
O |
LADS |
LADS AnalogScalarSensorFunctionType |
O |
LADS |
LADS AnalogScalarSensorFunctionWithCompensationType |
O |
LADS |
LADS BaseSensorFunctionType |
M |
LADS |
LADS DiscreteSensorFunctionType |
O |
LADS |
LADS MultiSensorFunctionType |
O |
LADS |
LADS MultiStateDiscreteSensorFunctionType |
O |
LADS |
LADS TwoStateDiscreteSensorFunctionType |
O |
Table 143 defines a Profile that a Server can provide if a Controller system is used in the model. At least one of the optional conformance units must also be implemented.
Table 143 – LADS ControllerFunction Server Facet
Group |
Conformance Unit/Profile Title |
Mandatory/Optional |
LADS |
LADS AnalogControlFunctionType |
O |
LADS |
LADS AnalogControlFunctionWithComposedTargetValueType |
O |
LADS |
LADS AnalogControlFunctionWithTotalizerType |
O |
LADS |
LADS BaseControlFunctionType |
M |
LADS |
LADS ControlFunctionStateMachineType |
O |
LADS |
LADS ControllerParameterSetType |
O |
LADS |
LADS ControllerParameterType |
O |
LADS |
LADS ControllerTuningParameterType |
M |
LADS |
LADS DiscreteControlFunctionType |
O |
LADS |
LADS MultiModeAnalogControlFunctionType |
O |
LADS |
LADS MultiStateDiscreteControlFunctionType |
O |
LADS |
LADS PidControllerParameterType |
O |
LADS |
LADS RatebasedAccumulatingControlFunctionType |
O |
LADS |
LADS TimerFunctionType |
O |
LADS |
LADS TwoStateDiscreteControlFunctionType |
O |
Table 144 defines a Profile which extends the ControllerFunction Server Facet with method calls.
Table 144 – LADS ExtendedControllerFunction Server Facet
Group |
Conformance Unit/Profile Title |
Mandatory/Optional |
LADS |
LADS ControllerFunction Server Facet |
|
LADS |
LADS ControlFunctionStateMachineType Start Method |
M |
LADS |
LADS RunningStateMachineType Hold Method |
O |
LADS |
LADS RunningStateMachineType Reset Method |
O |
LADS |
LADS RunningStateMachineType Suspend Method |
O |
LADS |
LADS RunningStateMachineType ToComplete Method |
O |
LADS |
LADS RunningStateMachineType Unhold Method |
O |
LADS |
LADS RunningStateMachineType Unsuspend Method |
O |
LADS |
LADS FunctionalStateMachineType Abort Method |
M |
LADS |
LADS FunctionalStateMachineType Clear Method |
M |
LADS |
LADS FunctionalStateMachineType Stop Method |
M |