6 OPC UA ObjectTypes ToC Previous Next

6.13 ControlsHWType ToC Previous Next

6.13.4 Additional Objects of the ControlsHWType ToC Previous Next

The following Objects are defined to extend the DeviceType.

6.13.4.1 Variable IOImageIsSupported ToC

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.

6.13.4.2 Variable LiveStreamIsSupported ToC

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.

6.13.4.3 Variable RemoteConnectionIsSupported ToC

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.

6.13.4.4 Variable ScreenshotIsSupported ToC

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.

6.13.4.5 Variable SystemDumpIsSupported ToC

When the SystemDumpIsSupported Variable is true, the controls’ hardware component supports saving complete system dumps.

6.13.4.6 Variable IOImage ToC Model

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
IOPointType Structure Single IO Point
IOPointMeta IOMetaType The meta-data describing the IO point.
IOPointValue IOValueType The value of the IO point.

The Variable IOValueType is defined in Table 40.

Table 40 – IOValueType Definition

Name Type Description
IOValueType Structure The value of a single IO point.
TimeStamp UtcTime The time the value of the IO point was read in the underlying system.
RawValue BaseDataType The raw value of the IO point read at time TimeStamp.
EngValue 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
IOMetaType Structure Meta-data describing a single IO point.
Description String The description of the IO point.
Address String The address of the IO point, e.g. PEW1.
IOType 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  

6.13.4.7 Method GetIOImage ToC

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  

6.13.4.8 Method GetLiveStream ToC

The Method GetLiveStream returns the URL that the client connects to to get the video stream.

Signature

GetLiveStream (
[out]	String					ScreenStreamURL
[out]	MethodExecutionFeedbackType		ExecutionFeedback
);

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  

6.13.4.9 Method GetRemoteConnection ToC

The Method GetRemoteConnection establishes a remote connection between an OPC UA Client and an object of type ControlHWType.

Signature

GetRemoteConnection (
[out]	MethodExecutionFeedbackType		ExecutionFeedback
);

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  

6.13.4.10 Method GetScreenshot ToC

The Method GetScreenshot returns a screenshot of the controls’ hardware HMI at the time the method is invoked.

Signature

GetScreenshot (
[out]	Image						CurrentScreenshot
[out]	MethodExecutionFeedbackType		ExecutionFeedback
);

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  

6.13.4.11 Method GetSupportedFeatures ToC

The Method GetSupportedFeatures returns the list of features that the controls’ hardware component supports.

Signature

GetSupportedFeatures (
[out]	ControlsHWFeatureEnumeration[]	SupportedFeatures
[out]	MethodExecutionFeedbackType		ExecutionFeedback
);

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  

6.13.4.12 Method GetSystemDump ToC

The Method GetSystemDump returns a file containing the system dump. The system dump file format may be proprietary.

Signature

GetSystemDump (
[out]	ByteString					SystemDump
[out]	MethodExecutionFeedbackType		ExecutionFeedback
);

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  

Previous Next