This OPC UA ControlsHWType ObjectType describes the hardware component that is used in the control architecture of the machine modules or workcentre and exposes the supported capabilities to clients.
Figure 21 shows an overview for the ControlsHWType with related Objects. It is formally defined in Table 38.
Figure 21 – ControlsHWType overview
The ControlsHWType is formally defined in Table 38.
Table 38 – ControlsHWType Definition
Attribute |
Value |
|||||
BrowseName |
ControlsHWType |
|||||
IsAbstract |
False |
|||||
References |
Node Class |
BrowseName |
DataType |
TypeDefinition |
Modelling Rule |
|
Subtype of DeviceType defined in OPC 10000-100 |
||||||
HasComponent |
Variable |
IOImageIsSupported |
Boolean |
BaseDataVariableType |
Mandatory |
|
HasComponent |
Variable |
LiveStreamIsSupported |
Boolean |
BaseDataVariableType |
Mandatory |
|
HasComponent |
Variable |
RemoteConnectionIsSupported |
Boolean |
BaseDataVariableType |
Mandatory |
|
HasComponent |
Variable |
ScreenshotIsSupported |
Boolean |
BaseDataVariableType |
Mandatory |
|
HasComponent |
Variable |
IOImage |
IOPointType[] |
BaseDataVariableType |
Mandatory |
|
HasComponent |
Variable |
SystemDumpIsSupported |
Boolean |
BaseDataVariableType |
Mandatory |
|
HasComponent |
Method |
GetIOImage |
|
|
Mandatory |
|
HasComponent |
Method |
GetLiveStream |
|
|
Mandatory |
|
HasComponent |
Method |
GetRemoteConnection |
|
|
Mandatory |
|
HasComponent |
Method |
GetScreenshot |
|
|
Mandatory |
|
HasComponent |
Method |
GetSupportedFeatures |
|
|
Mandatory |
|
HasComponent |
Method |
GetSystemDump |
|
|
Mandatory |
|
GeneratesEvent |
ObjectType |
NewSystemDumpIsGenerated |
|
|
|
The ControlsHWType ObjectType is a concrete type and can be used directly.
The following properties are already included in the DeviceType.
The Manufacturer property provides the name of the manufacturer that supplied the part (e.g. "Siemens”).
The Model property provides the name of the part as identified by the manufacturer (e.g. "S7- CPU 1515-2 PN").
The RevisionCounter property provides the revision level of the part as identified by the manufacturer (e.g. "").
The Serial property provides the serial number of the part as identified uniquely by the manufacturer.
The following Objects are defined to extend the DeviceType.
When the IOImageIsSupported Variable is true, the controls' hardware component supports requests of the IO Image, i.e. a synchronous snapshot of all the inputs and outputs of the controls element at the time the method is invoked.
When the LiveStreamIsSupported Variable is true, the controls' hardware component supports live stream, i.e. remotely connecting to the local HMI and streaming the live view of the HMI application back to the client.
When the RemoteConnectionIsSupported Variable is true, the controls' hardware component supports remote connection, i.e. remotely connecting to the local HMI, including streaming and remote control.
When the ScreenshotIsSupported Variable is true, the controls' hardware component supports taking a screenshot of the HMI screen at the time of the method invocation.
When the SystemDumpIsSupported Variable is true, the controls' hardware component supports saving complete system dumps.
The Variable IOImage contains the current snapshot of the inputs and outputs of the ControlsHW Object.
The Variable IOImage is a list of items of type IOPointType. The Type IOPointType is defined in Table 39.
Table 39 – IOPointType Definition
Name |
Type |
Description |
Structure |
Single IO Point |
|
IOMetaType |
The meta-data describing the IO point. |
|
IOValueType |
The value of the IO point. |
The Variable IOValueType is defined in Table 40.
Table 40 – IOValueType Definition
Name |
Type |
Description |
Structure |
The value of a single IO point. |
|
UtcTime |
The time the value of the IO point was read in the underlying system. |
|
BaseDataType |
The raw value of the IO point read at time TimeStamp. |
|
BaseDataType |
The engineering value of the IO point read at time TimeStamp. |
The Variable IOMetaType is defined in Table 41.
Table 41 – IOMetaType Definition
Name |
Type |
Description |
Structure |
Meta-data describing a single IO point. |
|
String |
The description of the IO point. |
|
String |
The address of the IO point, e.g. PEW1. |
|
IOTypeEnumeration |
The data type of the IO point in the underlying system. |
The Data Type IOTypeEnumeration is defined in accordance with IEC 6-1131 Part 3 in Table 42.
Table 42 – IOTypeEnumeration Definition
Enumstring |
Value |
Description |
BYTE |
0 |
Byte |
WORD |
1 |
Word |
DWORD |
2 |
Double Word |
LWORD |
3 |
Long Word |
SINT |
4 |
Signed Integer |
INT |
5 |
Integer |
DINT |
6 |
Double Integer |
LINT |
7 |
Long Integer |
USINT |
8 |
Unsigned Short Integer |
UINT |
9 |
Unsigned Integer |
UDINT |
10 |
Unsigned Double Integer |
ULINT |
11 |
Unsigned Long Integer |
REAL |
12 |
Real |
LREAL |
13 |
Long Real |
TIME |
14 |
Time |
LTIME |
15 |
Long Time |
DATE |
16 |
Date |
LDATE |
17 |
Long Date |
TIME_OF_DAY |
18 |
Clock Time |
LTIME_OF_DAY |
19 |
Long Clock Time |
DATE_AND_TIME |
20 |
Date and Time |
LDATE_AND_TIME |
21 |
Long Date and Time |
CHAR |
22 |
Character |
WCHAR |
23 |
|
STRING |
24 |
|
WSTRING |
25 |
|
The Method GetIOImage returns a file that represents the IO image of the controls’ hardware component. The format of the file may vary according to the proprietary nature of the controls’ hardware component.
Signature
GetIOImage (
[out]IOPointType[] IOImage
[out]MethodExecutionFeedbackType ExecutionFeedback
);
Argument |
Description |
IOImage |
IO image as a file. |
ExecutionFeedback |
The extended feedback returning a detailed message in case of execution failure. |
Method Result Codes
ResultCode |
Description |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
BadNodeIdUnknown |
See table 173 in OPC 10000-4 for the description of these result codes. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
BadTypeMismatch |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
BadOutOfRange |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
BadNotWritable |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
BadNotFound |
Argument |
Description |
ScreenStreamURL |
The url of the video stream. |
ExecutionFeedback |
The extended feedback returning a detailed message in case of execution failure. |
Method Result Codes
ResultCode |
Description |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
BadNodeIdUnknown |
See table 173 in OPC 10000-4 for the description of these result codes. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
BadTypeMismatch |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
BadOutOfRange |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
BadNotWritable |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
BadNotFound |
Argument |
Description |
ExecutionFeedback |
The extended feedback returning a detailed message in case of execution failure. |
Method Result Codes
ResultCode |
Description |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
BadNodeIdUnknown |
See table 173 in OPC 10000-4 for the description of these result codes. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
BadTypeMismatch |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
BadOutOfRange |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
BadNotWritable |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
BadNotFound |
Argument |
Description |
CurrentScreenshot |
The screenshot in jpg, gif, bmp or png format. |
ExecutionFeedback |
The extended feedback returning a detailed message in case of execution failure. |
Method Result Codes
ResultCode |
Description |
||||||||||||||||||||||||||||||||||||||||||||||||
BadNodeIdUnknown |
See table 173 in OPC 10000-4 for the description of these result codes. |
||||||||||||||||||||||||||||||||||||||||||||||||
BadTypeMismatch |
|||||||||||||||||||||||||||||||||||||||||||||||||
BadOutOfRange |
|||||||||||||||||||||||||||||||||||||||||||||||||
BadNotWritable |
|||||||||||||||||||||||||||||||||||||||||||||||||
BadNotFound |
Argument |
Description |
SupportedFeatures |
The list of supported features. |
ExecutionFeedback |
The extended feedback returning a detailed message in case of execution failure. |
The Enumeration ControlsHWFeaturesEnumeration is defined in Table 43.
Table 43 – ControlsHWFeaturesEnumeration Definition
Enumstring |
Value |
Description |
Other |
0 |
None of the below. |
IOImage |
1 |
The controls’ hardware components supports IO image retrieval. |
LiveStream |
2 |
The controls’ hardware components supports live stream. |
RemoteConnection |
3 |
The controls’ hardware components supports remote connection. |
ScreenshotCurrentPage |
4 |
The controls’ hardware components supports screenshot retrieval. |
SystemDump |
5 |
The controls’ hardware components supports system dump. |
Method Result Codes
ResultCode |
Description |
|||||||||||||
BadNodeIdUnknown |
See table 173 in OPC 10000-4 for the description of these result codes. |
|||||||||||||
BadTypeMismatch |
||||||||||||||
BadOutOfRange |
||||||||||||||
BadNotWritable |
||||||||||||||
BadNotFound |
Argument |
Description |
SystemDump |
The system dump file. |
ExecutionFeedback |
The extended feedback returning a detailed message in case of execution failure. |
Method Result Codes
ResultCode |
Description |
BadNodeIdUnknown |
See table 173 in OPC 10000-4 for the description of these result codes. |
BadTypeMismatch |
|
BadOutOfRange |
|
BadNotWritable |
|
BadNotFound |