OPC-UA Interface Guide (Smart Quality)

Overview

The Smart Media Manager allows the user to create and modify Smart Media Definitions (SMDs).

When the Open Platform Communications (OPC) server in Smart Media Manager is enabled an OPC node tree is published. The nodes in this tree represent grouped areas of state and functionality.

Default address: opc.tcp://localhost:26755/smm

Certificates

Communication between OPC UA clients and servers require both parties to possess their own application certificate. To enable further communication each party must trust the opposing certificate. This trust can be established automatically, programmatically or manually depending on the application's configuration or implementation. The application certificate can be found in %programdata%\Global Graphics Software Ltd\Smart Media Manager\App Certificates\certs should you need to copy it to the Trusted Peer Certificate folder. In this release it will be a Self Signed Certificate.

OPC Methods

Any methods listed in this documentation will include details about their required parameters (if any), and return value.

In the event of an error please see the application log file for more information.

OPC Methods

Many published OPC method nodes return a String value indicating their success or error state. In all such cases a check for Success will indicate success, and any other value is an error.

Return Value	Description
`FailedToExecute`	The request failed to execute.
`FailedToExportSmd`	The SMD failed to export.
`FailedToUpdateSmd`	The SMD in SPC failed to update.
`ItemNotFound`	The specified item was not found.
`NoActiveProject`	There is no active project.
`RequiresEndUserMode`	The request requires SMM to be in end user mode.
`Success`	The request completed successfully.

Any methods returning data (E.g. JSON, comma-separated values, ...) will be explicitly documented. Callers should check the format of the returned data to see if the call succeeded (otherwise one of the above errors may be returned).

Any methods listed in this documentation include details about their required parameters (if any), and return value.

In the event of an error, please see the Smart Media Manager log file for more information.

OPC Client Library

The following documentation provides guidance on using the Traeger Industry Components GmbH OPC client library for software developers working with Smart Media Manager.

Configuring Custom Message Sizes

The default maximum message sizes used by OPC clients to communicate to the server are sufficient for most use cases. However, to ensure transfer of larger data packets (such as retrieving some job thumbnail images) it may be necessary to configure the OPC client with custom values.

For example:

CODE

	Client = new OpcClient();
	Client.Transport.MaxArrayLength = 1024 * 1024 * 50;
	Client.Transport.MaxBufferSize = 1024 * 1024 * 50;
	Client.Transport.MaxMessageSize = 1024 * 1024 * 50;
	Client.Transport.MaxStringLength = 1024 * 1024 * 50;

See here for more information.

Adjusting Communication Timeouts

OPC clients regularly verify the responsiveness of the connection to the OPC server. However, in certain circumstances where the system is under heavy load, maintaining a responsive connection might not always be possible. To mitigate potential issues under such conditions, it is recommended to increase the default communication timeouts.

The example below demonstrates how to adjust the default values:

CODE

	var defaultTimeOut = (int)TimeSpan.FromMinutes(10).TotalMilliseconds;
	Client = new OpcClient
	{
	    // Don't auto-disconnect - Dispose the client to explicitly disconnect.
	    DisconnectTimeout = int.MaxValue,
	    KeepAlive = { Interval = defaultTimeOut },
	    SessionTimeout = defaultTimeOut,
	    OperationTimeout = defaultTimeOut,
	    ReconnectTimeout = defaultTimeOut
	};

Please note that the provided examples serve as illustrations, and it's important to tailor the configuration to your specific requirements.

SmartMediaManagerSet

The top-level set containing all available OPC nodes.

Immediately underneath this root-level node are a categorized collection of sub-nodes, each encapsulating a different area of behavior.

Section Name	Description
App	General Information about the app (E.g. Version number, Product name, etc.).
ColorOverride	Controls to change the values in the color override pane in SMM

App

General Information about the app (E.g. Version number, Product name, etc.).

Properties

Name	Type	Writable	Description
`CompanyName`	`String`	No	Gets the company name.
`IsEndUser`	`Boolean`	No	This setting is based on the application license. This setting determines the application's available feature set.
`ProductName`	`String`	No	Gets the product name.
`SelectedSmartMediaName`	`String`	Yes	The name of the application's selected media.
`ServerModeLocked`	`Boolean`	Yes	Whether to lock the minimized status of the application UI when running in server mode. OPC clients can use this to prevent the application UI from being visible.
`SmartMediaNames`	`Null`	No	Gets the names of the media that are avaliable to load into the application.
`VersionNumber`	`String`	No	Gets the application version number.

Methods

Name	Returns	Description
`ExportMedia(String smdFilename)`	`String`	Create a new SMD based on the settings provided in SMM.
`LoadActiveMedia()`	`String`	Load the active media from SPC into the application.
`LogError(String clientId, String message)`	`void`	Allows an OPC client to write an error message into the application log.
`LogInfo(String clientId, String message)`	`void`	Allows an OPC client to write an information message into the application log.
`LogWarning(String clientId, String message)`	`void`	Allows an OPC client to write a warning message into the application log.
`UpdateMedia()`	`String`	Update the SMD in SPC.

Files

Name	Description
`LogFile`	Allows read-only access to the application log file.

NOTE OPC File nodes contain functions which allow access to file content:

Open(int fileAccess) - Open the file with the specified fileAccess (1:read, 2:write), returning an integer file handle.
Read(int fileHandle, int length) - Read data from an open file handle, returning an array of bytes.
Write(int fileHandle, byte[] buffer) - Write/append data to an open file handle.
Close(int fileHandle) - Close the file handle after use.

For more information see the OPC documentation.

ColorOverride

Controls to change the values in the color override pane in SMM

Properties

Name	Type	Writable	Description
`CmykDeviceLinkOption`	`String`	Yes	The selected option for generating the CMYK device link profile.
`CmykImagesIntentOverride`	`String`	Yes	This intent overrides all CMYK images. This setting will also apply to gray images when 'Color manage gray as CMYK' is checked. Values: `RelativeColorimetric`, `Perceptual`, `Saturation`, `AbsoluteColorimetric`
`ColorManageGrayAsCmyk`	`Boolean`	Yes	Whether to process gray with CMYK color management.
`DeviceEmulationIccProfile`	`String`	No	Name of the media's device emulation ICC profile.
`EmulateAnotherPrinter`	`Boolean`	Yes	Whether the device emulation ICC profile will be used.
`GrayDeviceLinkOption`	`String`	Yes	The selected option for generating the Gray device link profile.
`InputCmykIccProfile`	`String`	No	Name of the media's input CMYK ICC profile.
`InputGrayIccProfile`	`String`	No	Name of the media's input Gray ICC profile.
`InputRgbIccProfile`	`String`	No	Name of the media's input RGB ICC profile.
`KeepTextBlack`	`Boolean`	Yes	Whether to keep text black.
`MainRenderingIntent`	`String`	Yes	This is the default rendering intent. The rendering intents in the document will override it. Values: `RelativeColorimetric`, `Perceptual`, `Saturation`, `AbsoluteColorimetric`
`OptimizeFinePaths`	`Boolean`	Yes	Whether to optimize the fine paths.
`OutputIccProfile`	`String`	No	Name of the media's output ICC profile.
`OverrideColorManagementInPdf`	`Boolean`	Yes	Whether to override the color management specified in the PDF.
`Preserve100Black`	`Boolean`	Yes	Whether to preserve 100% black.
`RgbDeviceLinkOption`	`String`	Yes	The selected option for generating the RGB device link profile.
`RgbImagesIntentOverride`	`String`	Yes	This intent overrides all RGB images. Values: `RelativeColorimetric`, `Perceptual`, `Saturation`, `AbsoluteColorimetric`

Methods

Name	Returns	Description
`CreateCmykDeviceLinkProfile()`	`String`	Create CMYK device link profile. NOTE This will use the CMYK input profile and the output profile to create a new device link profile.
`CreateGrayDeviceLinkProfile()`	`String`	Create Gray device link profile. NOTE This will use the Gray input profile and the output profile to create a new device link profile.
`CreateRgbDeviceLinkProfile()`	`String`	Create RGB device link profile. NOTE This will use the RGB input profile and the output profile to create a new device link profile.
`SetDeviceEmulationIccProfile(String iccFileName)`	`String`	Install an ICC profile into the media. NOTE `iccFileName` must specify a file path accessible to the OPC server.
`SetInputCmykIccProfile(String iccFileName)`	`String`	Install an ICC profile into the media. NOTE `iccFileName` must specify a file path accessible to the OPC server.
`SetInputGrayIccProfile(String iccFileName)`	`String`	Install an ICC profile into the media. NOTE `iccFileName` must specify a file path accessible to the OPC server.
`SetInputRgbIccProfile(String iccFileName)`	`String`	Install an ICC profile into the media. NOTE `iccFileName` must specify a file path accessible to the OPC server.
`SetOutputIccProfile(String iccFileName)`	`String`	Install an ICC profile into the media. NOTE `iccFileName` must specify a file path accessible to the OPC server.