Class LaserModule

Namespace: Loehnert.Lisrt.Laser.Keyence

Assembly: Loehnert.Lisrt.Laser.Keyence.dll

Represents a Keyence marking laser.

public class LaserModule : InitializableCompositeModule, ICompositeModule, ILisrtModule, IInitializable, INotifyPropertyChangedEx, INotifyPropertyChanged, IHasServiceView, IHasDeviceLabel

Inheritance: object

PropertyChangedBase

LisrtModule

CompositeModule

InitializableCompositeModule

LaserModule

Implements: ICompositeModule

ILisrtModule

IInitializable

INotifyPropertyChangedEx

INotifyPropertyChanged

IHasServiceView

IHasDeviceLabel

Inherited Members: InitializableCompositeModule.InitializeSubModules()

InitializableCompositeModule.InitializationState

CompositeModule.SubModules

LisrtModule.ToString()

LisrtModule.Name

LisrtModule.Enabled

LisrtModule.TreeItem

LisrtModule.Icon

LisrtModule.Parent

PropertyChangedBase.Refresh()

PropertyChangedBase.NotifyOfPropertyChange(string)

PropertyChangedBase.NotifyOfPropertyChange<TProperty>(Expression<Func<TProperty>>)

PropertyChangedBase.OnUIThread(Action)

PropertyChangedBase.Set<T>(ref T, T, string)

PropertyChangedBase.IsNotifying

PropertyChangedBase.PropertyChanged

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Remarks

Performance Improvement

To speed up modifying a job, open a job using the CreateJob(int, int) method and close it after modification using the EndJob(int) method. This means that the job only has to be verified once, and not with every change.

Constructors

LaserModule(string, ICommunication)

Initializes a new instance of the LaserModule class.

public LaserModule(string name, ICommunication communication)

Parameters

name string: Module Name.
communication ICommunication: Instance of communication module.

Remarks

The communication argument is normally a TCP client, the default port is 50002. The encoding should be UTF8 to use UTF-8 encoded content. The encoding must also be configured on the laser (Settings→Controller→Communication Settings→CharCode).
The start delimiter is empty and the end delimiter is CR ("\r") by default.

Properties

DefaultTimeout

Gets or sets default timeout in milliseconds.

[Configuration(1000)]
public int DefaultTimeout { get; set; }

Property Value

int: The default value is 1000 ms.

DeviceLabel

Gets or sets the label for the device.

[Configuration("Keyence")]
public string DeviceLabel { get; set; }

Property Value

string

DeviceState

Gets the device state.

public DeviceState DeviceState { get; }

Property Value

DeviceState

DisableErrorMessage

Gets or sets a value indicating whether the state message, which is shown when the marking laser has an error, should be hidden.

public bool DisableErrorMessage { get; set; }

Property Value

bool

DisableWarmUpMessage

Gets or sets a value indicating whether the warm up message should be hidden.

public bool DisableWarmUpMessage { get; set; }

Property Value

bool

Errors

Gets the current errors.

public IEnumerable<string> Errors { get; }

Property Value

IEnumerable<string>

InstanceID

Gets or sets the ID for this instance.

[Configuration(0)]
public int InstanceID { get; set; }

Property Value

int

IsMarking

Gets a value indicating whether the laser is actually marking.

public bool IsMarking { get; }

Property Value

bool

JobFiles

Gets the job files.

public JobFileService JobFiles { get; }

Property Value

JobFileService

Remarks

The job files service uses a OPC connection. See UseOpc and OpcEndpoint.

LastReceivedResponse

Gets last received response from laser.

public string LastReceivedResponse { get; }

Property Value

string

LastSentCommand

Gets last sent command.

public string LastSentCommand { get; }

Property Value

string

LogoFiles

Gets the logo and photo files.

public LogoFileService LogoFiles { get; }

Property Value

LogoFileService

Remarks

The logo files service uses a OPC connection. See UseOpc and OpcEndpoint.

MarkingBuilderVersion

Gets or sets current Marking Builder Version.

[Configuration(MarkingBuilderVersion.MB3)]
public MarkingBuilderVersion MarkingBuilderVersion { get; set; }

Property Value

MarkingBuilderVersion

OpcEndpoint

Gets or sets the OPC endpoint URL.

[Configuration("opc.tcp://192.168.101.39:4840", Description = "Endpoint Url for the OPC connection.")]
public string OpcEndpoint { get; set; }

Property Value

string

See Also: UseOpc

UseOpc

Gets or sets a value indicating whether a OPC UA communication is established with the device.

[Configuration(false)]
public bool UseOpc { get; set; }

Property Value

bool

See Also: OpcEndpoint

Methods

CanGetCommunicationPriority()

Gets a value indicating whether the communication priority can be obtained.

public bool CanGetCommunicationPriority()

Returns

bool: A value indicating whether the communication priority can be obtained.

Remarks

This function requires a OPC connection. See UseOpc and OpcEndpoint.

Exceptions

NotInitializedException: Throw when the module is not initialized.
InvalidOperationException: Thrown when the OPC connection is disabled.

ClearError()

Clears error memory on laser and updates error state collection afterwards.

public void ClearError()

Exceptions

NotInitializedException: Throw when the module is not initialized.
LaserException: Thrown when the marking laser returns an error.

CreateJob(int, int)

Opens the specified job for creation or modification.

public void CreateJob(int job, int timeoutInMs = -1)

Parameters

job int: The job index.
timeoutInMs int: Timespan in milliseconds after which an exception is thrown when device does not return an answer.
-1 uses the DefaultTimeout.

Exceptions

NotInitializedException: Throw when the module is not initialized.
LaserException: Thrown when the marking laser returns an error.

DeleteJob(int, int)

Deletes a job.

public void DeleteJob(int job, int timeoutInMs = -1)

Parameters

job int: The index of the job to delete. 9999 deletes all job.
timeoutInMs int: Timeout in milliseconds after which an exception is thrown if the device does not respond.
Specify -1 to use DefaultTimeout.

Exceptions

NotInitializedException: Throw when the module is not initialized.
LaserException: Thrown when the marking laser returns an error.

DisableGuideLaser()

Disables the guide laser.

public void DisableGuideLaser()

Exceptions

NotInitializedException: Throw when the module is not initialized.
LaserException: Thrown when the marking laser returns an error.

DisableMarking(int, int, int)

Disables marking for a specific block.

public void DisableMarking(int job, int block, int timeoutInMs = -1)

Parameters

job int: The job index.
block int: The block index.
timeoutInMs int: Timeout in milliseconds after which an exception is thrown if the device does not respond.
Specify -1 to use DefaultTimeout.

Exceptions

NotInitializedException: Thrown when the module is not initialized.
LaserException: Thrown when the marking laser returns an error.

DisableMarkingForAllBlocks(int, int)

Disables marking for all blocks in a job.

public void DisableMarkingForAllBlocks(int job, int timeoutInMs = -1)

Parameters

job int: The job index.
timeoutInMs int: Timeout in milliseconds after which an exception is thrown if the device does not respond.
Specify -1 to use DefaultTimeout.

Exceptions

NotInitializedException: Thrown when the module is not initialized.
LaserException: Thrown when the marking laser returns an error.

DisableMarkingForAllMatrixCells(int, int)

Disables marking for all matrix cells.

public void DisableMarkingForAllMatrixCells(int job, int timeoutInMs = -1)

Parameters

job int: The job index.
timeoutInMs int: Timeout in milliseconds after which an exception is thrown if the device does not respond.
Specify -1 to use DefaultTimeout.

Exceptions

NotInitializedException: Throw when the module is not initialized.
LaserException: Thrown when the marking laser returns an error.

EditJob(int, Action<LaserModule, int>, int)

Creates or modifies a job within a CreateJob(int, int) and EndJob(int) block.

public void EditJob(int job, Action<LaserModule, int> jobEdit, int timeoutInMs = -1)

Parameters

job int: The job index.
jobEdit Action<LaserModule, int>: The action for job creation. First argument is the laser, the second the job index.
timeoutInMs int: Timeout in milliseconds after which an exception is thrown if the device does not respond.
Specify -1 to use DefaultTimeout.

Examples

This example sets the content of block 1 and 2 in a CreateJob-EndJob block.

Laser.EditJob(
    job: 10
    jobEdit: (laser, jobNo) =>
    {
        laser.WriteCharacterString(jobNo, 1, "Test");
        laser.WriteCharacterString(jobNo, 2, "Test");
    });

def edit_job(laser, job_no):
    laser.WriteCharacterString(job_no, 1, "Test");
    laser.WriteCharacterString(job_no, 2, "Test");

Laser.EditJob(job=10, jobEdit=edit_job)

Remarks

If an error occurs while EndJob, the jobEdit method will be executed outside the CreateJob, EndJob block again. This has the advantage that an exception is thrown with a meaningful message.

Exceptions

ArgumentNullException: Throw when jobEdit is null.
NotInitializedException: Throw when the module is not initialized.
LaserException: Thrown when the marking laser returns an error.

EnableGuideLaser(GuideLaserType)

Enables the guide laser.

public void EnableGuideLaser(GuideLaserType type = GuideLaserType.Continuous)

Parameters

type GuideLaserType: Type of the guide laser.

Exceptions

NotInitializedException: Throw when the module is not initialized.
LaserException: Thrown when the marking laser returns an error.

EnableMarking(int, int, int)

Enables marking for a specific block.

public void EnableMarking(int job, int block, int timeoutInMs = -1)

Parameters

job int: The job index.
block int: The block index.
timeoutInMs int: Timeout in milliseconds after which an exception is thrown if the device does not respond.
Specify -1 to use DefaultTimeout.

Exceptions

NotInitializedException: Thrown when the module is not initialized.
LaserException: Thrown when the marking laser returns an error.

EnableMarkingForAllBlocks(int, int)

Enables marking for all blocks in a job.

public void EnableMarkingForAllBlocks(int job, int timeoutInMs = -1)

Parameters

job int: The job index.
timeoutInMs int: Timeout in milliseconds after which an exception is thrown if the device does not respond.
Specify -1 to use DefaultTimeout.

Exceptions

NotInitializedException: Thrown when the module is not initialized.
LaserException: Thrown when the marking laser returns an error.

EnableMarkingForAllMatrixCells(int, int)

Enables marking for all matrix cells.

public void EnableMarkingForAllMatrixCells(int job, int timeoutInMs = -1)

Parameters

job int: The job index.
timeoutInMs int: Timeout in milliseconds after which an exception is thrown if the device does not respond.
Specify -1 to use DefaultTimeout.

Exceptions

NotInitializedException: Throw when the module is not initialized.
LaserException: Thrown when the marking laser returns an error.

EnableMarkingForSpecifiedMatrixCells(int, int, IEnumerable<bool>, int)

Enables marking for all matrix cells.

public void EnableMarkingForSpecifiedMatrixCells(int job, int startCell, IEnumerable<bool> markingEnabled, int timeoutInMs = -1)

Parameters

job int: The job index.
startCell int: The start cell, of the markingEnabled cells.
markingEnabled IEnumerable<bool>: The marking enabled values of the matrix cells.
Example: new bool[] { false, true, false}; Cell 1 and cell 3 are disabled, cell2 is enabled.
timeoutInMs int: Timeout in milliseconds after which an exception is thrown if the device does not respond.
Specify -1 to use DefaultTimeout.

Exceptions

NotInitializedException: Throw when the module is not initialized.
LaserException: Thrown when the marking laser returns an error.

EndJob(int)

Ends the creation or modification of a job.

public void EndJob(int timeoutInMs = -1)

Parameters

timeoutInMs int: Timeout in milliseconds after which an exception is thrown if the device does not respond.
Specify -1 to use DefaultTimeout.

Exceptions

NotInitializedException: Throw when the module is not initialized.
LaserException: Thrown when the marking laser returns an error.

ExecuteJob(int)

Starts the loaded job and waits until the job is completely finished.

public void ExecuteJob(int timeoutInMs)

Parameters

timeoutInMs int: Timespan in milliseconds after which an exception is thrown when the device did not finish marking.
-1 uses the DefaultTimeout.

Exceptions

NotInitializedException: Throw when the module is not initialized.
LaserException: Thrown when the marking laser returns an error.

ExecuteJob(int, CancellationToken)

Starts the loaded job and waits until the job is completely finished.

public void ExecuteJob(int timeoutInMs, CancellationToken cancellationToken = default)

Parameters

timeoutInMs int: Timespan in milliseconds after which an exception is thrown when the device did not finish marking.
-1 uses the DefaultTimeout.
cancellationToken CancellationToken: Cancellation token to cancel marking.

Remarks

This function requires a OPC connection. See UseOpc and OpcEndpoint. If you don't use the OPC connection, use the ExecuteJob(int) method.

Exceptions

NotInitializedException: Throw when the module is not initialized.
InvalidOperationException: Thrown when the OPC connection is disabled.
LaserException: Thrown when the marking laser returns an error.
OperationCanceledException: Thrown when the operation is canceled.

Exit()

De-initializes the module and all of its sub modules.

public override void Exit()

Initialize()

Initializes laser module.

public override void Initialize()

LoadJob(int, int)

Loads the selected jobNumber and waits until the operation is finished.

public void LoadJob(int jobNumber, int timeout = -1)

Parameters

jobNumber int: New job number.
timeout int: Timeout in milliseconds.
-1 uses the DefaultTimeout.

Exceptions

NotInitializedException: Thrown when the module is not initialized.
TimeoutException: Thrown when the job loading didn't finish in the expected timeout.
LaserException: Thrown when the marking laser returns an error.

Mark(int)

Starts the loaded job and waits until marking is finished.

public void Mark(int timeoutInMs)

Parameters

timeoutInMs int: Timespan in milliseconds after which an exception is thrown when device does not return an answer.

Remarks

This function returns when the marking process is finished. If a value is also read back (e.g. the code quality) in the loaded job, use the WaitUntilOperationIsFinished(int, CancellationToken) function to wait until the job is completely finished.

Exceptions

NotInitializedException: Throw when the module is not initialized.
LaserException: Thrown when the marking laser returns an error.

Mark(int, CancellationToken)

Starts the loaded job and waits until marking is finished.

public void Mark(int timeoutInMs, CancellationToken cancellationToken)

Parameters

timeoutInMs int: Timespan in milliseconds after which an exception is thrown when device does not return an answer.
cancellationToken CancellationToken: Cancellation token to cancel marking.

Remarks

This function requires an OPC connection. See UseOpc and OpcEndpoint. If you don't use the OPC connection, use the Mark(int) method.
This function returns when the marking process is finished. If a value is also read back (e.g. the code quality) in the loaded job, use the ExecuteJob(int, CancellationToken) function to wait until the job is completely finished.

Exceptions

NotInitializedException: Throw when the module is not initialized.
InvalidOperationException: Thrown when the OPC connection is disabled.
LaserException: Thrown when the marking laser returns an error.
OperationCanceledException: Thrown when marking is canceled.

Read2DCode(Read2DCodeParameters, int)

Reads a 2D code.

public Read2DCodeResult Read2DCode(Read2DCodeParameters writeValues, int timeoutInMs = -1)

Parameters

writeValues Read2DCodeParameters: Code read settings.
timeoutInMs int: Timespan in milliseconds after which an exception is thrown when device does not return an answer.
-1 uses the DefaultTimeout.

Returns

Read2DCodeResult: return values of scan operation depending on marking builder version.

Exceptions

NotInitializedException: Throw when the module is not initialized.
LaserException: Thrown when the marking laser returns an error.

ReadApproach(int, int, int)

Reads the approach setting for a specific block.

public double ReadApproach(int job, int block, int timeoutInMs = -1)

Parameters

job int: The job index.
block int: The block index.
timeoutInMs int: Timeout in milliseconds after which an exception is thrown if the device does not respond.
Specify -1 to use DefaultTimeout.

Returns

double: The approach value in millimeters read from the laser.

Exceptions

NotSupportedException: Thrown when MarkingBuilderVersion is MB3.
NotInitializedException: Thrown when the module is not initialized.
LaserException: Thrown when the marking laser returns an error.

ReadArcCharacter(int, int, int)

Reads the settings of characters written on an arc of a specific block.

public ArcCharacter ReadArcCharacter(int job, int block, int timeoutInMs = -1)

Parameters

job int: The job index.
block int: The block index.
timeoutInMs int: Timeout in milliseconds after which an exception is thrown if the device does not respond.
Specify -1 to use DefaultTimeout.

Returns

ArcCharacter: Parameter for arc character.

Exceptions

NotInitializedException: Thrown when the module is not initialized.
LaserException: Thrown when the marking laser returns an error.

ReadBarcodeSize(int, int, int)

Reads the barcode size of a specific block.

public BarcodeSize ReadBarcodeSize(int job, int block, int timeoutInMs = -1)

Parameters

job int: The job index.
block int: The block index.
timeoutInMs int: Timeout in milliseconds after which an exception is thrown if the device does not respond.
Specify -1 to use DefaultTimeout.

Returns

BarcodeSize: Barcode size of the block.

Exceptions

NotInitializedException: Thrown when the module is not initialized.
LaserException: Thrown when the marking laser returns an error.

ReadBlockLayout(int, int, int)

Reads the layout of a specific block.

public BlockLayout ReadBlockLayout(int job, int block, int timeoutInMs = -1)

Parameters

job int: The job index.
block int: The block index.
timeoutInMs int: Timeout in milliseconds after which an exception is thrown if the device does not respond.
Specify -1 to use DefaultTimeout.

Returns

BlockLayout: The layout of the block.

Exceptions

NotInitializedException: Thrown when the module is not initialized.
LaserException: Thrown when the marking laser returns an error.

ReadBlockMarkingParameters(int, int, int)

Reads the marking parameters for a specific block.

public BlockMarkingParameters ReadBlockMarkingParameters(int job, int block, int timeoutInMs = -1)

Parameters

job int: The job index.
block int: The block index.
timeoutInMs int: Timeout in milliseconds after which an exception is thrown if the device does not respond.
Specify -1 to use DefaultTimeout.

Returns

BlockMarkingParameters: Marking parameters for target block read from laser.

Exceptions

ArgumentNullException: Thrown when any argument is null.
NotInitializedException: Throw when the module is not initialized.
LaserException: Thrown when the marking laser returns an error.

ReadBlockPosition(int, int, int)

Reads the position of a specific block.

public BlockPosition ReadBlockPosition(int job, int block, int timeoutInMs = -1)

Parameters

job int: The job index.
block int: The block index.
timeoutInMs int: Timeout in milliseconds after which an exception is thrown if the device does not respond.
Specify -1 to use DefaultTimeout.

Returns

BlockPosition: The position of the block.

Exceptions

NotInitializedException: Thrown when the module is not initialized.
LaserException: Thrown when the marking laser returns an error.

ReadBlockType(int, int, int)

Reads the type of the specified block.

public BlockType ReadBlockType(int job, int block, int timeoutInMs = -1)

Parameters

job int: The job index.
block int: The block index.
timeoutInMs int: Timeout in milliseconds after which an exception is thrown if the device does not respond.
Specify -1 to use DefaultTimeout.

Returns

BlockType: The type of the block.

Exceptions

NotInitializedException: Thrown when the module is not initialized.
LaserException: Thrown when the marking laser returns an error.

ReadCameraImageFilePath(RequestImageType, int)

Reads the file path to last stored image from the laser.

public CameraImageFilePathResponse ReadCameraImageFilePath(RequestImageType imageType, int tracking)

Parameters

imageType RequestImageType: Image type.
tracking int: Tracking index.

Returns

CameraImageFilePathResponse: Results read from laser.

Exceptions

ArgumentNullException: Thrown when any argument is null.
NotInitializedException: Throw when the module is not initialized.
LaserException: Thrown when the marking laser returns an error.

ReadCameraImageSetting(int, TargetFunction)

Reads the camera image settings from the laser.

public CameraImageSettings ReadCameraImageSetting(int job, TargetFunction function)

Parameters

job int: The job index.
function TargetFunction: The camera function.

Returns

CameraImageSettings: Settings read from laser.

Exceptions

ArgumentNullException: Thrown when any argument is null.
NotSupportedException: Thrown when the MarkingBuilderVersion property is MB3.
NotInitializedException: Throw when the module is not initialized.
LaserException: Thrown when the marking laser returns an error.

ReadCameraTargetSetting(int, TargetFunction)

Reads the camera target settings from the laser.

public CameraTargetSettings ReadCameraTargetSetting(int job, TargetFunction function)

Parameters

job int: Job index.
function TargetFunction: Camera function.

Returns

CameraTargetSettings: Settings read from laser.

Exceptions

NotSupportedException: Thrown when the MarkingBuilderVersion property is MB3.
NotInitializedException: Throw when the module is not initialized.
LaserException: Thrown when the marking laser returns an error.

ReadCellReferencePoint(int, int)

Reads the matrix cell reference point of a job.

public ReferencePoint ReadCellReferencePoint(int job, int timeoutInMs = -1)

Parameters

job int: The job index.
timeoutInMs int: Timespan in milliseconds after which an exception is thrown when device does not return an answer.
-1 uses the DefaultTimeout.

Returns

ReferencePoint: Matrix cell reference point.

Exceptions

ArgumentNullException: Thrown when any argument is null.
NotInitializedException: Throw when the module is not initialized.
LaserException: Thrown when the marking laser returns an error.

ReadCharacterFont(int, int, int)

Reads the character font of the specified block.

public CharacterFont ReadCharacterFont(int job, int block, int timeoutInMs = -1)

Parameters

job int: The job index.
block int: The block index.
timeoutInMs int: Timeout in milliseconds after which an exception is thrown if the device does not respond.
Specify -1 to use DefaultTimeout.

Returns

CharacterFont: The character font of the block.

Exceptions

NotInitializedException: Thrown when the module is not initialized.
LaserException: Thrown when the marking laser returns an error.

ReadCharacterProportional(int, int, int)

Reads character proportional settings of a specific block.

public CharacterProportional ReadCharacterProportional(int job, int block, int timeoutInMs = -1)

Parameters

job int: The job index.
block int: The block index.
timeoutInMs int: Timeout in milliseconds after which an exception is thrown if the device does not respond.
Specify -1 to use DefaultTimeout.

Returns

CharacterProportional: The character proportional settings of the block.

Exceptions

NotInitializedException: Thrown when the module is not initialized.
LaserException: Thrown when the marking laser returns an error.

ReadCharacterRatio(int, int, int)

Reads the character ratio of a specific block.

public CharacterRatio ReadCharacterRatio(int job, int block, int timeoutInMs = -1)

Parameters

job int: The job index.
block int: The block index.
timeoutInMs int: Timeout in milliseconds after which an exception is thrown if the device does not respond.
Specify -1 to use DefaultTimeout.

Returns

CharacterRatio: Parameter for character ratio.

Exceptions

NotInitializedException: Thrown when the module is not initialized.
LaserException: Thrown when the marking laser returns an error.

ReadCharacterSize(int, int, int)

Reads the character size of the specified block.

public CharacterSize ReadCharacterSize(int job, int block, int timeoutInMs = -1)

Parameters

job int: The job index.
block int: The block index.
timeoutInMs int: Timeout in milliseconds after which an exception is thrown if the device does not respond.
Specify -1 to use DefaultTimeout.

Returns

CharacterSize: The character size of the block.

Exceptions

NotInitializedException: Thrown when the module is not initialized.
LaserException: Thrown when the marking laser returns an error.

ReadCharacterString(int, int, int)

Reads the character string of the specified block.

public string ReadCharacterString(int job, int block, int timeoutInMs = -1)

Parameters

job int: The job index.
block int: The block index.
timeoutInMs int: Timeout in milliseconds after which an exception is thrown if the device does not respond.
Specify -1 to use DefaultTimeout.

Returns

string: The character string of the block.

Exceptions

NotInitializedException: Thrown when the module is not initialized.
LaserException: Thrown when the marking laser returns an error.

ReadCodeFillParameter(int, int, int)

Reads code fill parameters for a specific block.

public CodeFillParameter ReadCodeFillParameter(int job, int block, int timeoutInMs = -1)

Parameters

job int: The job index.
block int: The block index.
timeoutInMs int: Timeout in milliseconds after which an exception is thrown if the device does not respond.
Specify -1 to use DefaultTimeout.

Returns

CodeFillParameter: The code fill parameters read from the laser.

Exceptions

NotSupportedException: Thrown when MarkingBuilderVersion is MB3.
NotInitializedException: Thrown when the module is not initialized.
LaserException: Thrown when the marking laser returns an error.

ReadCodePattern(int, int, int)

Reads the code pattern settings for a specific block.

public CodePattern ReadCodePattern(int job, int block, int timeoutInMs = -1)

Parameters

job int: The job index.
block int: The block index.
timeoutInMs int: Timeout in milliseconds after which an exception is thrown if the device does not respond.
Specify -1 to use DefaultTimeout.

Returns

CodePattern: Code pattern settings read from laser.

Exceptions

ArgumentNullException: Thrown when any argument is null.
NotSupportedException: Thrown when the MarkingBuilderVersion property is MB3.
NotInitializedException: Throw when the module is not initialized.
LaserException: Thrown when the marking laser returns an error.

ReadCodeReaderLightSetting(int)

Reads the code reader lighting settings.

public CodeReaderLightSettings ReadCodeReaderLightSetting(int job)

Parameters

job int: The job index.

Returns

CodeReaderLightSettings: Parameters read from laser.

Exceptions

NotSupportedException: Thrown when the MarkingBuilderVersion property is MB3.
NotInitializedException: Throw when the module is not initialized.
LaserException: Thrown when the marking laser returns an error.

ReadCodeReaderSetting(int)

Reads code reader settings from the laser.

public CodeReaderSettings ReadCodeReaderSetting(int job)

Parameters

job int: Job index.

Returns

CodeReaderSettings: parameters read from laser.

Exceptions

ArgumentNullException: Thrown when any argument is null.
NotSupportedException: Thrown when the MarkingBuilderVersion property is MB3.
NotInitializedException: Throw when the module is not initialized.
LaserException: Thrown when the marking laser returns an error.

ReadCodeSetting(int, int, int)

Reads the code settings of a specific block.

public CodeSettings ReadCodeSetting(int job, int block, int timeoutInMs = -1)

Parameters

job int: The job index.
block int: The block index.
timeoutInMs int: Timeout in milliseconds after which an exception is thrown if the device does not respond.
Specify -1 to use DefaultTimeout.

Returns

CodeSettings: The code settings of the block.

Exceptions

NotInitializedException: Thrown when the module is not initialized.
LaserException: Thrown when the marking laser returns an error.

ReadCodeType(int, int, int)

Reads the code type of the specified block.

public CodeType ReadCodeType(int job, int block, int timeoutInMs = -1)

Parameters

job int: The job index.
block int: The block index.
timeoutInMs int: Timeout in milliseconds after which an exception is thrown if the device does not respond.
Specify -1 to use DefaultTimeout.

Returns

CodeType: The code type of the block.

Exceptions

NotInitializedException: Thrown when the module is not initialized.
LaserException: Thrown when the marking laser returns an error.

ReadCommonMarkingParameters(int, int)

Reads common marking parameters of the specified job.

public CommonMarkingParameters ReadCommonMarkingParameters(int job, int timeoutInMs = -1)

Parameters

job int: The job index.
timeoutInMs int: Timeout in milliseconds after which an exception is thrown if the device does not respond.
Specify -1 to use DefaultTimeout.

Returns

CommonMarkingParameters: Common marking parameters read from laser.

Exceptions

NotInitializedException: Throw when the module is not initialized.
LaserException: Thrown when the marking laser returns an error.

ReadCounter(int, string)

Read laser counter parameters from Laser.

public CounterValues ReadCounter(int job, string counter)

Parameters

job int: Job index.
counter string: Counter name.

Returns

CounterValues: parameters read from laser.

Exceptions

NotInitializedException: Throw when the module is not initialized.
LaserException: Thrown when the marking laser returns an error.

ReadCurveCorrection(int, int, int)

Reads the curve correction setting for a specific block.

public bool ReadCurveCorrection(int job, int block, int timeoutInMs = -1)

Parameters

job int: The job index.
block int: The block index.
timeoutInMs int: Timeout in milliseconds after which an exception is thrown if the device does not respond.
Specify -1 to use DefaultTimeout.

Returns

bool: True if curve correction is active; otherwise, false.

Exceptions

NotSupportedException: Thrown when MarkingBuilderVersion is MB3.
NotInitializedException: Thrown when the module is not initialized.
LaserException: Thrown when the marking laser returns an error.

ReadDataMatrixSize(int, int, int)

Reads data matrix size of a specific block.

public DataMatrixSize ReadDataMatrixSize(int job, int block, int timeoutInMs = -1)

Parameters

job int: Job index.
block int: Block index.
timeoutInMs int: Timeout in milliseconds after which an exception is thrown if the device does not respond.
Specify -1 to use DefaultTimeout.

Returns

DataMatrixSize: The data matrix size of the block.

Exceptions

NotInitializedException: Thrown when the module is not initialized.
LaserException: Thrown when the marking laser returns an error.

ReadFillMarkingParameters(int, int, int)

Reads the fill marking parameters for a specific block.

public FillMarkingParameters ReadFillMarkingParameters(int job, int block, int timeoutInMs = -1)

Parameters

job int: The job index.
block int: The block index.
timeoutInMs int: Timeout in milliseconds after which an exception is thrown if the device does not respond.
Specify -1 to use DefaultTimeout.

Returns

FillMarkingParameters: The fill marking parameters read from the laser.

Exceptions

NotSupportedException: Thrown when MarkingBuilderVersion is MB3.
NotInitializedException: Thrown when the module is not initialized.
LaserException: Thrown when the marking laser returns an error.

ReadGS1DataBarSize(int, int, int)

Reads the GS1 data bar size of a specific block.

public GS1DataBarSize ReadGS1DataBarSize(int job, int block, int timeoutInMs = -1)

Parameters

job int: The job index.
block int: The block index.
timeoutInMs int: Timeout in milliseconds after which an exception is thrown if the device does not respond.
Specify -1 to use DefaultTimeout.

Returns

GS1DataBarSize: The GS1 data bar size of the block.

Exceptions

NotInitializedException: Thrown when the module is not initialized.
LaserException: Thrown when the marking laser returns an error.

ReadGroupOffset(int, int)

Reads the offset of a specific group.

public GroupOffset ReadGroupOffset(int job, int group)

Parameters

job int: The job index.
group int: The group index.

Returns

GroupOffset: The offset of a group.

Exceptions

NotInitializedException: Thrown when the module is not initialized.
LaserException: Thrown when the marking laser returns an error.

ReadHatchParameters(int, int, int)

Reads hatch parameters for a specific block.

public HatchParameters ReadHatchParameters(int job, int block, int timeoutInMs = -1)

Parameters

job int: The job index.
block int: The block index.
timeoutInMs int: Timeout in milliseconds after which an exception is thrown if the device does not respond.
Specify -1 to use DefaultTimeout.

Returns

HatchParameters: The hatch parameters read from the laser.

Exceptions

NotSupportedException: Thrown when MarkingBuilderVersion is MB3.
NotInitializedException: Thrown when the module is not initialized.
LaserException: Thrown when the marking laser returns an error.

ReadHatchPattern(int, int, int)

Reads hatch pattern settings for a specific block.

public HatchPattern ReadHatchPattern(int job, int block, int timeoutInMs = -1)

Parameters

job int: The job index.
block int: The block index.
timeoutInMs int: Timeout in milliseconds after which an exception is thrown if the device does not respond.
Specify -1 to use DefaultTimeout.

Returns

HatchPattern: The hatch pattern settings read from the laser.

Exceptions

NotSupportedException: Thrown when MarkingBuilderVersion is MB3.
NotInitializedException: Thrown when the module is not initialized.
LaserException: Thrown when the marking laser returns an error.

ReadHeightCorrection(int, int)

Reads the height correction of the specified job.

public HeightCorrection ReadHeightCorrection(int job, int timeoutInMs = -1)

Parameters

job int: The job index.
timeoutInMs int: Timeout in milliseconds after which an exception is thrown if the device does not respond.
Specify -1 to use DefaultTimeout.

Returns

HeightCorrection: The height correction.

Exceptions

NotInitializedException: Throw when the module is not initialized.
LaserException: Thrown when the marking laser returns an error.

ReadJobNumber()

Reads the loaded job number from the laser.

public int ReadJobNumber()

Returns

int: parameters read from laser.

Exceptions

NotInitializedException: Throw when the module is not initialized.
LaserException: Thrown when the marking laser returns an error.

ReadJobPosition(int, int)

Reads the position of the specified job.

public JobPosition ReadJobPosition(int job, int timeoutInMs = -1)

Parameters

job int: The job index.
timeoutInMs int: Timeout in milliseconds after which an exception is thrown if the device does not respond.
Specify -1 to use DefaultTimeout.

Returns

JobPosition: The position of the specified job.

Exceptions

NotInitializedException: Throw when the module is not initialized.
LaserException: Thrown when the marking laser returns an error.

ReadJobTitle(int, int)

Reads the title of the specified job.

public string ReadJobTitle(int job, int timeoutInMs = -1)

Parameters

job int: The job index.
timeoutInMs int: Timeout in milliseconds after which an exception is thrown if the device does not respond.
Specify -1 to use DefaultTimeout.

Returns

string: Title of the specified job.

Exceptions

NotInitializedException: Throw when the module is not initialized.
LaserException: Thrown when the marking laser returns an error.

ReadJumpSpeed(int, int, int)

Reads the jump speed for a specific block.

public JumpSpeed ReadJumpSpeed(int job, int block, int timeoutInMs = -1)

Parameters

job int: The job index.
block int: The block index.
timeoutInMs int: Timeout in milliseconds after which an exception is thrown if the device does not respond.
Specify -1 to use DefaultTimeout.

Returns

JumpSpeed: The jump speed setting read from the laser.

Exceptions

NotSupportedException: Thrown when MarkingBuilderVersion is MB3.
NotInitializedException: Thrown when the module is not initialized.
LaserException: Thrown when the marking laser returns an error.

ReadLastCodeResult(int)

Reads 2D-Code from Laser with marking builder version MBPLUS.

public Read2DCodeResult ReadLastCodeResult(int timeoutInMs = -1)

Parameters

timeoutInMs int: Timespan in milliseconds after which an exception is thrown when device does not return an answer.
-1 uses the DefaultTimeout.

Returns

Read2DCodeResult: results of last scan operation.

Exceptions

NotInitializedException: Throw when the module is not initialized.
LaserException: Thrown when the marking laser returns an error.

ReadLastWindowCheckAfterMarkingResult(int)

Reads the last window check after marking result.

public WindowCheckResult ReadLastWindowCheckAfterMarkingResult(int timeoutInMs = -1)

Parameters

timeoutInMs int: Timespan in milliseconds after which an exception is thrown when device does not return an answer.
-1 uses the DefaultTimeout.

Returns

WindowCheckResult: results of last window check.

Exceptions

NotSupportedException: Thrown when the MarkingBuilderVersion is MB3.
NotInitializedException: Throw when the module is not initialized.
LaserException: Thrown when the marking laser returns an error.

ReadLastWindowCheckBeforeMarkingResult(int)

Reads the last window check before marking result.

public WindowCheckResult ReadLastWindowCheckBeforeMarkingResult(int timeoutInMs = -1)

Parameters

timeoutInMs int: Timespan in milliseconds after which an exception is thrown when device does not return an answer.
-1 uses the DefaultTimeout.

Returns

WindowCheckResult: results of last window check.

Exceptions

NotSupportedException: Thrown when the MarkingBuilderVersion is MB3.
NotInitializedException: Throw when the module is not initialized.
LaserException: Thrown when the marking laser returns an error.

ReadLogoSize(int, int, int)

Reads the logo size of a specific block.

public LogoSize ReadLogoSize(int job, int block, int timeoutInMs = -1)

Parameters

job int: The job index.
block int: The block index.
timeoutInMs int: Timeout in milliseconds after which an exception is thrown if the device does not respond.
Specify -1 to use DefaultTimeout.

Returns

LogoSize: Logo size of the block.

Exceptions

NotInitializedException: Thrown when the module is not initialized.
LaserException: Thrown when the marking laser returns an error.

ReadMarkingConfirmationResult()

Reads the last marking confirmation result.

public MarkingConfirmationResult ReadMarkingConfirmationResult()

Returns

MarkingConfirmationResult: The result of the last marking confirmation.

ReadMarkingConfirmationSetting(int)

Reads marking confirmation settings from the laser.

public MarkingConfirmationSettings ReadMarkingConfirmationSetting(int job)

Parameters

job int: Job index.

Returns

MarkingConfirmationSettings: marking confirmation settings read from laser.

Exceptions

ArgumentNullException: Thrown when any argument is null.
NotSupportedException: Thrown when the MarkingBuilderVersion property is MB3.
NotInitializedException: Throw when the module is not initialized.
LaserException: Thrown when the marking laser returns an error.

ReadMarkingEnergyCheck(int, int)

Reads the marking energy check parameters of the specified job.

public MarkingEnergyCheckParameters ReadMarkingEnergyCheck(int job, int timeoutInMs = -1)

Parameters

job int: The job index.
timeoutInMs int: Timeout in milliseconds after which an exception is thrown if the device does not respond.
Specify -1 to use DefaultTimeout.

Returns

MarkingEnergyCheckParameters: parameters for marking energy supervision.

Exceptions

NotInitializedException: Throw when the module is not initialized.
LaserException: Thrown when the marking laser returns an error.

ReadMarkingEnergyResult()

Reads the last marking energy result.

public MarkingEnergyResult ReadMarkingEnergyResult()

Returns

MarkingEnergyResult: The result of the last marking energy.

ReadMarkingQuality(int, int, int)

Reads the marking quality for a specific block.

public MarkingQuality ReadMarkingQuality(int job, int block, int timeoutInMs = -1)

Parameters

job int: The job index.
block int: The block index.
timeoutInMs int: Timeout in milliseconds after which an exception is thrown if the device does not respond.
Specify -1 to use DefaultTimeout.

Returns

MarkingQuality: The marking quality read from the laser.

Exceptions

NotSupportedException: Thrown when MarkingBuilderVersion is MB3.
NotInitializedException: Thrown when the module is not initialized.
LaserException: Thrown when the marking laser returns an error.

ReadMarkingResult()

Reads the marking result from the laser.

public MarkingResult ReadMarkingResult()

Returns

MarkingResult: Results read from laser.

Exceptions

ArgumentNullException: Thrown when any argument is null.
NotInitializedException: Throw when the module is not initialized.
LaserException: Thrown when the marking laser returns an error.

ReadMatrixCell(int, int, int)

Reads a matrix cell settings of a specific matrix cell.

public MatrixCell ReadMatrixCell(int job, int cell, int timeoutInMs = -1)

Parameters

job int: The job index.
cell int: The cell of the matrix.
timeoutInMs int: Timeout in milliseconds after which an exception is thrown if the device does not respond.
Specify -1 to use DefaultTimeout.

Returns

MatrixCell: Matrix cell.

Exceptions

ArgumentNullException: Thrown when any argument is null.
NotInitializedException: Throw when the module is not initialized.
LaserException: Thrown when the marking laser returns an error.

ReadMatrixCellsMarkingCount()

Reads the numbers of marked matrix cells.

public MatrixCellMarkingCount ReadMatrixCellsMarkingCount()

Returns

MatrixCellMarkingCount: The number of matrix marked cells.

ReadMatrixInactiveCellCount(int, int)

Reads a value indicating whether inactive cells are counted.

public bool ReadMatrixInactiveCellCount(int job, int timeoutInMs = -1)

Parameters

job int: The job index.
timeoutInMs int: Timeout in milliseconds after which an exception is thrown if the device does not respond.
Specify -1 to use DefaultTimeout.

Returns

bool: inactive cell count read from laser.

Exceptions

ArgumentNullException: Thrown when any argument is null.
NotInitializedException: Throw when the module is not initialized.
LaserException: Thrown when the marking laser returns an error.

ReadMatrixPosition(int, int)

Reads the matrix position of a job.

public MatrixPosition ReadMatrixPosition(int job, int timeoutInMs = -1)

Parameters

job int: The job index.
timeoutInMs int: Timeout in milliseconds after which an exception is thrown if the device does not respond.
Specify -1 to use DefaultTimeout.

Returns

MatrixPosition: Matrix position.

Exceptions

ArgumentNullException: Thrown when any argument is null.
NotInitializedException: Throw when the module is not initialized.
LaserException: Thrown when the marking laser returns an error.

ReadMatrixSettings(int, int)

Reads the matrix settings of a job.

public MatrixSettings ReadMatrixSettings(int job, int timeoutInMs = -1)

Parameters

job int: The job index.
timeoutInMs int: Timespan in milliseconds after which an exception is thrown when device does not return an answer.
-1 uses the DefaultTimeout.

Returns

MatrixSettings: matrix settings read from laser.

Exceptions

ArgumentNullException: Thrown when any argument is null.
NotInitializedException: Throw when the module is not initialized.
LaserException: Thrown when the marking laser returns an error.

ReadMatrixSize(int, int)

Reads the matrix size of a job.

public MatrixSize ReadMatrixSize(int job, int timeoutInMs = -1)

Parameters

job int: The job index.
timeoutInMs int: Timespan in milliseconds after which an exception is thrown when device does not return an answer.
-1 uses the DefaultTimeout.

Returns

MatrixSize: Size of the matrix.

Exceptions

ArgumentNullException: Thrown when any argument is null.
NotInitializedException: Throw when the module is not initialized.
LaserException: Thrown when the marking laser returns an error.

ReadMultiPassMarkingParameters(int, int, int, int)

Reads marking parameters for target block.

public MultiPassMarkingParameters ReadMultiPassMarkingParameters(int job, int block, int overprinting, int timeoutInMs = -1)

Parameters

job int: The job index.
block int: The block index.
overprinting int: The overprinting index.
timeoutInMs int: Timespan in milliseconds after which an exception is thrown when device does not return an answer.
-1 uses the DefaultTimeout.

Returns

MultiPassMarkingParameters: Marking parameters for target block read from laser.

Exceptions

ArgumentNullException: Thrown when any argument is null.
NotSupportedException: Thrown when the MarkingBuilderVersion property is MB3.
NotInitializedException: Throw when the module is not initialized.
LaserException: Thrown when the marking laser returns an error.

ReadOnTheFlyParameters(int)

Reads the OnTheFly settings of a specific job.

public OnTheFlySettings ReadOnTheFlyParameters(int job)

Parameters

job int: The job index.

Returns

OnTheFlySettings: Parameters read from laser.

Exceptions

ArgumentNullException: Thrown when any argument is null.
NotInitializedException: Throw when the module is not initialized.
LaserException: Thrown when the marking laser returns an error.

ReadPhotoSettings(int, int, int)

Reads photo settings for a specific block.

public PhotoSettings ReadPhotoSettings(int job, int block, int timeoutInMs = -1)

Parameters

job int: The job index.
block int: The block index.
timeoutInMs int: Timeout in milliseconds after which an exception is thrown if the device does not respond.
Specify -1 to use DefaultTimeout.

Returns

PhotoSettings: The photo settings read from the laser.

Exceptions

NotSupportedException: Thrown when MarkingBuilderVersion is MB3.
NotInitializedException: Thrown when the module is not initialized.
LaserException: Thrown when the marking laser returns an error.

ReadQRCodeSize(int, int, int)

Reads the QR code size of a specific block.

public QRCodeSize ReadQRCodeSize(int job, int block, int timeoutInMs = -1)

Parameters

job int: The job index.
block int: The block index.
timeoutInMs int: Timeout in milliseconds after which an exception is thrown if the device does not respond.
Specify -1 to use DefaultTimeout.

Returns

QRCodeSize: The QR code size of the block.

Exceptions

NotInitializedException: Thrown when the module is not initialized.
LaserException: Thrown when the marking laser returns an error.

ReadSpaceApproach(int, int, int)

Reads the space approach setting for a specific block.

public double ReadSpaceApproach(int job, int block, int timeoutInMs = -1)

Parameters

job int: The job index.
block int: The block index.
timeoutInMs int: Timeout in milliseconds after which an exception is thrown if the device does not respond.
Specify -1 to use DefaultTimeout.

Returns

double: The space approach value in millimeters read from the laser.

Exceptions

NotSupportedException: Thrown when MarkingBuilderVersion is MB3.
NotInitializedException: Thrown when the module is not initialized.
LaserException: Thrown when the marking laser returns an error.

ReadTrueTypeFontParameters(int, int, int)

Reads TrueType font parameters for a specific block.

public TrueTypeFontParameters ReadTrueTypeFontParameters(int job, int block, int timeoutInMs = -1)

Parameters

job int: The job index.
block int: The block index.
timeoutInMs int: Timeout in milliseconds after which an exception is thrown if the device does not respond.
Specify -1 to use DefaultTimeout.

Returns

TrueTypeFontParameters: The TrueType font parameters read from the laser.

Exceptions

NotSupportedException: Thrown when MarkingBuilderVersion is MB3.
NotInitializedException: Thrown when the module is not initialized.
LaserException: Thrown when the marking laser returns an error.

ReadTrueTypeFontPattern(int, int, int)

Reads TrueType font pattern settings for a specific block.

public TrueTypeFontPattern ReadTrueTypeFontPattern(int job, int block, int timeoutInMs = -1)

Parameters

job int: The job index.
block int: The block index.
timeoutInMs int: Timeout in milliseconds after which an exception is thrown if the device does not respond.
Specify -1 to use DefaultTimeout.

Returns

TrueTypeFontPattern: The TrueType font pattern settings read from the laser.

Exceptions

NotSupportedException: Thrown when MarkingBuilderVersion is MB3.
NotInitializedException: Thrown when the module is not initialized.
LaserException: Thrown when the marking laser returns an error.

ReadWindowCheckAfterMarkingAlarmThreshold(int)

Reads the alarm threshold value for window check.

public int ReadWindowCheckAfterMarkingAlarmThreshold(int job)

Parameters

job int: Job index.

Returns

int: Alarm threshold in percent.

Exceptions

NotSupportedException: Thrown when the MarkingBuilderVersion is MB3.
NotInitializedException: Throw when the module is not initialized.
LaserException: Thrown when the marking laser returns an error.

ReadWindowCheckAfterMarkingEnable(int)

Reads the enabled state for window check after marking.

public bool ReadWindowCheckAfterMarkingEnable(int job)

Parameters

job int: Job index.

Returns

bool: window check is enabled.

Exceptions

NotSupportedException: Thrown when the MarkingBuilderVersion is MB3.
NotInitializedException: Throw when the module is not initialized.
LaserException: Thrown when the marking laser returns an error.

ReadWindowCheckAfterMarkingSensitivity(int)

Reads the sensitivity for window check after marking.

public WindowCheckSensitivity ReadWindowCheckAfterMarkingSensitivity(int job)

Parameters

job int: Job index.

Returns

WindowCheckSensitivity: sensitivity of window check.

Exceptions

NotSupportedException: Thrown when the MarkingBuilderVersion is MB3.
NotInitializedException: Throw when the module is not initialized.
LaserException: Thrown when the marking laser returns an error.

ReadWindowCheckBeforeMarkingAlarmThreshold(int)

Reads the alarm threshold value for window check.

public int ReadWindowCheckBeforeMarkingAlarmThreshold(int job)

Parameters

job int: Job index.

Returns

int: Alarm threshold in percent.

Exceptions

NotSupportedException: Thrown when the MarkingBuilderVersion is MB3.
NotInitializedException: Throw when the module is not initialized.
LaserException: Thrown when the marking laser returns an error.

ReadWindowCheckBeforeMarkingEnable(int)

Reads the enabled state for window check before marking.

public bool ReadWindowCheckBeforeMarkingEnable(int job)

Parameters

job int: Job index.

Returns

bool: window check is enabled.

Exceptions

NotSupportedException: Thrown when the MarkingBuilderVersion is MB3.
NotInitializedException: Throw when the module is not initialized.
LaserException: Thrown when the marking laser returns an error.

ReadWindowCheckBeforeMarkingSensitivity(int)

Reads the sensitivity for window check before marking.

public WindowCheckSensitivity ReadWindowCheckBeforeMarkingSensitivity(int job)

Parameters

job int: Job index.

Returns

WindowCheckSensitivity: sensitivity of window check.

Exceptions

NotSupportedException: Thrown when the MarkingBuilderVersion is MB3.
NotInitializedException: Throw when the module is not initialized.
LaserException: Thrown when the marking laser returns an error.

ReadWorkFlowResultDetail()

Reads the detailed work flow results from the laser.

public WorkFlowResultDetail ReadWorkFlowResultDetail()

Returns

WorkFlowResultDetail: Results read from laser.

Exceptions

ArgumentNullException: Thrown when any argument is null.
NotInitializedException: Throw when the module is not initialized.
LaserException: Thrown when the marking laser returns an error.

ReadXYTrackingCorrectionThreshold(int, int)

Reads XY-tracking correction threshold from the laser.

public int ReadXYTrackingCorrectionThreshold(int job, int tracking)

Parameters

job int: Job index.
tracking int: Tracking index.

Returns

int: XY-tracking correction threshold.

Exceptions

ArgumentNullException: Thrown when any argument is null.
NotSupportedException: Thrown when the MarkingBuilderVersion property is MB3.
NotInitializedException: Throw when the module is not initialized.
LaserException: Thrown when the marking laser returns an error.

ReadXYTrackingEnable(int, int)

Reads enabled of XY-tracking from the laser.

public bool ReadXYTrackingEnable(int job, int tracking)

Parameters

job int: Job index.
tracking int: Tracking index.

Returns

bool: XY-Tracking is enabled.

Exceptions

ArgumentNullException: Thrown when any argument is null.
NotSupportedException: Thrown when the MarkingBuilderVersion property is MB3.
NotInitializedException: Throw when the module is not initialized.
LaserException: Thrown when the marking laser returns an error.

ReadZTrackingCalibration(int)

Reads calibration of Z-tracking from the laser.

public ZTrackingCalibration ReadZTrackingCalibration(int job)

Parameters

job int: Job index.

Returns

ZTrackingCalibration: calibration of Z-tracking.

Exceptions

ArgumentNullException: Thrown when any argument is null.
NotSupportedException: Thrown when the MarkingBuilderVersion property is MB3.
NotInitializedException: Throw when the module is not initialized.
LaserException: Thrown when the marking laser returns an error.

ReadZTrackingEnable(int, int)

Reads enabled of Z-tracking from the laser.

public bool ReadZTrackingEnable(int job, int tracking)

Parameters

job int: Job index.
tracking int: Tracking index.

Returns

bool: Z-tracking is enabled.

Exceptions

ArgumentNullException: Thrown when any argument is null.
NotSupportedException: Thrown when the MarkingBuilderVersion property is MB3.
NotInitializedException: Throw when the module is not initialized.
LaserException: Thrown when the marking laser returns an error.

ShowServiceView()

Shows the service window.

public void ShowServiceView()

UpdateDeviceState()

Updates device state Properties and error state collection afterwards.

public void UpdateDeviceState()

Exceptions

NotInitializedException: Throw when the module is not initialized.
LaserException: Thrown when the marking laser returns an error.

UpdateErrorState()

Updates the Errors.

public void UpdateErrorState()

Exceptions

NotInitializedException: Throw when the module is not initialized.
LaserException: Thrown when the marking laser returns an error.

UploadJob(Job, int, bool, int)

Uploads a Job to the laser.

public void UploadJob(Job job, int jobIndex, bool clearExistingJob = true, int timeoutInMs = -1)

Parameters

job Job: The job to upload.
jobIndex int: The job index.
clearExistingJob bool: A a value indicating whether a existing job should be cleared. Must be true if text blocks with TrueType font are used.
timeoutInMs int: Timeout in in milliseconds for a single communication operation.

Exceptions

ArgumentNullException: Thrown when job is null.
ArgumentException: Thrown when the job contains a TextBlock using a TrueType font and clearExistingJob is false.
NotInitializedException: Throw when the module is not initialized.
LaserException: Thrown when the marking laser returns an error.

WaitUntilOperationIsFinished(int, CancellationToken)

Waits until the laser is busy.

public void WaitUntilOperationIsFinished(int timeout, CancellationToken cancellationToken = default)

Parameters

timeout int: Timeout in milliseconds.
cancellationToken CancellationToken: Cancellation token to cancel the operation.

Exceptions

NotInitializedException: Throw when the module is not initialized.
OperationCanceledException: Throw when the operation is canceled.

WriteApproach(int, int, double, int)

Writes the approach setting for a specific block.

public void WriteApproach(int job, int block, double approach, int timeoutInMs = -1)

Parameters

job int: The job index.
block int: The block index.
approach double: The approach value in millimeters.
timeoutInMs int: Timeout in milliseconds after which an exception is thrown if the device does not respond.
Specify -1 to use DefaultTimeout.

Exceptions

NotInitializedException: Thrown when the module is not initialized.
LaserException: Thrown when the marking laser returns an error.

WriteApproachScanSpeed(int, int, int)

Writes the approach scan speed for the specified job.

public void WriteApproachScanSpeed(int job, int approachScanSpeed, int timeoutInMs = -1)

Parameters

job int: The job index.
approachScanSpeed int: The approach scan speed in mm/s.
timeoutInMs int: Timeout in milliseconds after which an exception is thrown if the device does not respond.
Specify -1 to use DefaultTimeout.

Remarks

Only applied to blocks where quality level is set to custom.

Exceptions

NotInitializedException: Throw when the module is not initialized.
LaserException: Thrown when the marking laser returns an error.

WriteArcCharacter(int, int, ArcCharacter, int)

Sets the settings of characters written on an arc for a specific block.

public void WriteArcCharacter(int job, int block, ArcCharacter arcCharacter, int timeoutInMs = -1)

Parameters

job int: The job index.
block int: The block index.
arcCharacter ArcCharacter: Arc character settings.
timeoutInMs int: Timeout in milliseconds after which an exception is thrown if the device does not respond.
Specify -1 to use DefaultTimeout.

Exceptions

ArgumentNullException: Thrown when arcCharacter is null.
NotInitializedException: Thrown when the module is not initialized.
LaserException: Thrown when the marking laser returns an error.

WriteBarcodeSize(int, int, BarcodeSize, int)

Sets the barcode size for a specific block.

public void WriteBarcodeSize(int job, int block, BarcodeSize barcodeSize, int timeoutInMs = -1)

Parameters

job int: The job index.
block int: The block index.
barcodeSize BarcodeSize: Barcode size.
timeoutInMs int: Timeout in milliseconds after which an exception is thrown if the device does not respond.
Specify -1 to use DefaultTimeout.

Exceptions

ArgumentNullException: Thrown when barcodeSize is null.
NotInitializedException: Thrown when the module is not initialized.
LaserException: Thrown when the marking laser returns an error.

WriteBlockLayout(int, int, BlockLayout, int)

Sets the layout for a specific block.

public void WriteBlockLayout(int job, int block, BlockLayout blockLayout, int timeoutInMs = -1)

Parameters

job int: The job index.
block int: The block index.
blockLayout BlockLayout: The block layout.
timeoutInMs int: Timeout in milliseconds after which an exception is thrown if the device does not respond.
Specify -1 to use DefaultTimeout.

Exceptions

ArgumentNullException: Thrown when blockLayout is null.
NotInitializedException: Thrown when the module is not initialized.
LaserException: Thrown when the marking laser returns an error.

WriteBlockMarkingParameter(int, int, BlockMarkingParameters, int)

Sets the marking parameters for a specific block.

public void WriteBlockMarkingParameter(int job, int block, BlockMarkingParameters blockMarkingParameters, int timeoutInMs = -1)

Parameters

job int: The job index.
block int: The block index.
blockMarkingParameters BlockMarkingParameters: The marking parameters.
timeoutInMs int: Timeout in milliseconds after which an exception is thrown if the device does not respond.
Specify -1 to use DefaultTimeout.

Exceptions

NotInitializedException: Throw when the module is not initialized.
LaserException: Thrown when the marking laser returns an error.

WriteBlockPosition(int, int, BlockPosition, int)

Sets the position for a specific block.

public void WriteBlockPosition(int job, int block, BlockPosition blockPosition, int timeoutInMs = -1)

Parameters

job int: Job index.
block int: Block index.
blockPosition BlockPosition: Block position.
timeoutInMs int: Timeout in milliseconds after which an exception is thrown if the device does not respond.
Specify -1 to use DefaultTimeout.

Exceptions

ArgumentNullException: Thrown when blockPosition is null.
NotInitializedException: Thrown when the module is not initialized.
LaserException: Thrown when the marking laser returns an error.

WriteBlockType(int, int, BlockType, int)

Sets the type of the specified block.

public void WriteBlockType(int job, int block, BlockType blockType, int timeoutInMs = -1)

Parameters

job int: The job index.
block int: The block index.
blockType BlockType: The type to set for the block.
timeoutInMs int: Timeout in milliseconds after which an exception is thrown if the device does not respond.
Specify -1 to use DefaultTimeout.

Exceptions

NotInitializedException: Thrown when the module is not initialized.
LaserException: Thrown when the marking laser returns an error.

WriteCameraImageSetting(int, TargetFunction, CameraImageSettings)

Writes camera image settings to the laser.

public void WriteCameraImageSetting(int job, TargetFunction function, CameraImageSettings cameraImageSettings)

Parameters

job int: Job index.
function TargetFunction: The camera function.
cameraImageSettings CameraImageSettings: settings to be written to laser.

Exceptions

ArgumentNullException: Thrown when cameraImageSettings is null.
NotSupportedException: Thrown when the MarkingBuilderVersion property is MB3.
NotInitializedException: Throw when the module is not initialized.
LaserException: Thrown when the marking laser returns an error.

WriteCameraTargetSetting(int, TargetFunction, CameraTargetSettings)

Writes camera target settings to the laser.

public void WriteCameraTargetSetting(int job, TargetFunction function, CameraTargetSettings cameraTargetSettings)

Parameters

job int: Job index.
function TargetFunction: Camera function.
cameraTargetSettings CameraTargetSettings: settings to be written to laser.

Exceptions

ArgumentNullException: Thrown when any argument is null.
NotSupportedException: Thrown when the MarkingBuilderVersion property is MB3.
NotInitializedException: Throw when the module is not initialized.
LaserException: Thrown when the marking laser returns an error.

WriteCellReferencePoint(int, ReferencePoint, int)

Sets the reference point of the matrix cells of a job.

public void WriteCellReferencePoint(int job, ReferencePoint referencePoint, int timeoutInMs = -1)

Parameters

job int: The job index.
referencePoint ReferencePoint: Reference point of the matrix cells.
timeoutInMs int: Timespan in milliseconds after which an exception is thrown when device does not return an answer.
-1 uses the DefaultTimeout.

Exceptions

NotInitializedException: Throw when the module is not initialized.
LaserException: Thrown when the marking laser returns an error.

WriteCharacterFont(int, int, CharacterFont, int)

Sets the character font for the specified block.

public void WriteCharacterFont(int job, int block, CharacterFont characterFont, int timeoutInMs = -1)

Parameters

job int: The job index.
block int: The block index.
characterFont CharacterFont: The character font to set.
timeoutInMs int: Timeout in milliseconds after which an exception is thrown if the device does not respond.
Specify -1 to use DefaultTimeout.

Exceptions

ArgumentNullException: Thrown when characterFont is null.
NotInitializedException: Thrown when the module is not initialized.
LaserException: Thrown when the marking laser returns an error.

WriteCharacterProportional(int, int, CharacterProportional, int)

Sets the character proportional settings for a specific block.

public void WriteCharacterProportional(int job, int block, CharacterProportional characterProportional, int timeoutInMs = -1)

Parameters

job int: Job index.
block int: Block index.
characterProportional CharacterProportional: Character proportional settings.
timeoutInMs int: Timeout in milliseconds after which an exception is thrown if the device does not respond.
Specify -1 to use DefaultTimeout.

Exceptions

ArgumentNullException: Thrown when characterProportional is null.
NotInitializedException: Thrown when the module is not initialized.
LaserException: Thrown when the marking laser returns an error.

WriteCharacterRatio(int, int, CharacterRatio, int)

Sets the character ratio for a specific block.

public void WriteCharacterRatio(int job, int block, CharacterRatio characterRatio, int timeoutInMs = -1)

Parameters

job int: The job index.
block int: The block index.
characterRatio CharacterRatio: Character ratio settings.
timeoutInMs int: Timeout in milliseconds after which an exception is thrown if the device does not respond.
Specify -1 to use DefaultTimeout.

Exceptions

ArgumentNullException: Thrown when characterRatio is null.
NotInitializedException: Thrown when the module is not initialized.
LaserException: Thrown when the marking laser returns an error.

WriteCharacterSize(int, int, CharacterSize, int)

Sets the character size for the specified block.

public void WriteCharacterSize(int job, int block, CharacterSize characterSize, int timeoutInMs = -1)

Parameters

job int: The job index.
block int: The block index.
characterSize CharacterSize: The character size to set.
timeoutInMs int: Timeout in milliseconds after which an exception is thrown if the device does not respond.
Specify -1 to use DefaultTimeout.

Exceptions

ArgumentNullException: Thrown when characterSize is null.
NotInitializedException: Thrown when the module is not initialized.
LaserException: Thrown when the marking laser returns an error.

WriteCharacterString(int, int, string, int)

Sets the marking character string for the specified block.

public void WriteCharacterString(int job, int block, string content, int timeoutInMs = -1)

Parameters

job int: The job index.
block int: The block index.
content string: The marking characters to set.
timeoutInMs int: Timeout in milliseconds after which an exception is thrown if the device does not respond.
Specify -1 to use DefaultTimeout.

Remarks

This command can be sent to blocks of type: HatchLogo, Photo, WorkpieceImageLogo, Logo, HorizontalText, VerticalText, ArcTextClockwise, ArcTextCounterClockwise, and Code1D2D.

Exceptions

ArgumentNullException: Thrown when content is null.
NotInitializedException: Thrown when the module is not initialized.
LaserException: Thrown when the marking laser returns an error.

WriteCodeFillParameter(int, int, CodeFillParameter, int)

Writes code fill parameters for a specific block.

public void WriteCodeFillParameter(int job, int block, CodeFillParameter codeFillParameter, int timeoutInMs = -1)

Parameters

job int: The job index.
block int: The block index.
codeFillParameter CodeFillParameter: The code fill parameters to write.
timeoutInMs int: Timeout in milliseconds after which an exception is thrown if the device does not respond.
Specify -1 to use DefaultTimeout.

Exceptions

ArgumentNullException: Thrown when codeFillParameter is null.
NotInitializedException: Thrown when the module is not initialized.
LaserException: Thrown when the marking laser returns an error.

WriteCodePattern(int, int, CodePattern, int)

Writes the code pattern settings for a specific block.

public void WriteCodePattern(int job, int block, CodePattern codePattern, int timeoutInMs = -1)

Parameters

job int: The job index.
block int: The block index.
codePattern CodePattern: The code.
timeoutInMs int: Timeout in milliseconds after which an exception is thrown if the device does not respond.
Specify -1 to use DefaultTimeout.

Exceptions

NotInitializedException: Throw when the module is not initialized.
LaserException: Thrown when the marking laser returns an error.

WriteCodeReaderSetting(int, CodeReaderSettings)

Writes code reader settings to the laser.

public void WriteCodeReaderSetting(int job, CodeReaderSettings settings)

Parameters

job int: Job index.
settings CodeReaderSettings: parameters to be written to laser.

Exceptions

ArgumentNullException: Thrown when any argument is null.
ArgumentException: Thrown when all properties of settings are null.
NotSupportedException: Thrown when the MarkingBuilderVersion property is MB3.
NotInitializedException: Throw when the module is not initialized.
LaserException: Thrown when the marking laser returns an error.

WriteCodeSetting(int, int, CodeSettings, int)

Sets the code settings for a specific block.

public void WriteCodeSetting(int job, int block, CodeSettings codeSettings, int timeoutInMs = -1)

Parameters

job int: The job index.
block int: The block index.
codeSettings CodeSettings: Code settings.
timeoutInMs int: Timeout in milliseconds after which an exception is thrown if the device does not respond.
Specify -1 to use DefaultTimeout.

Exceptions

ArgumentNullException: Thrown when codeSettings is null.
NotInitializedException: Thrown when the module is not initialized.
LaserException: Thrown when the marking laser returns an error.

WriteCodeType(int, int, CodeType, int)

Sets the code type for the specified block.

public void WriteCodeType(int job, int block, CodeType codeType, int timeoutInMs = -1)

Parameters

job int: The job index.
block int: The block index.
codeType CodeType: The code type to set.
timeoutInMs int: Timeout in milliseconds after which an exception is thrown if the device does not respond.
Specify -1 to use DefaultTimeout.

Exceptions

NotInitializedException: Thrown when the module is not initialized.
LaserException: Thrown when the marking laser returns an error.

WriteCommonMarkingParameter(int, CommonMarkingParameters, int)

Sets the common marking parameters for the specified job.

public void WriteCommonMarkingParameter(int job, CommonMarkingParameters commonMarkingParameters, int timeoutInMs = -1)

Parameters

job int: The job index.
commonMarkingParameters CommonMarkingParameters: The common marking parameters.
timeoutInMs int: Timeout in milliseconds after which an exception is thrown if the device does not respond.
Specify -1 to use DefaultTimeout.

Exceptions

ArgumentNullException: Throw if commonMarkingParameters is null.
NotInitializedException: Throw when the module is not initialized.
LaserException: Thrown when the marking laser returns an error.

WriteCounter(int, string, CounterValues)

Write counter settings to laser.

public void WriteCounter(int job, string counter, CounterValues writeValues)

Parameters

job int: Job index.
counter string: Counter name.
writeValues CounterValues: parameters to be written to laser.

Exceptions

ArgumentNullException: Thrown when any argument is null.
NotInitializedException: Throw when the module is not initialized.
LaserException: Thrown when the marking laser returns an error.

WriteCurveCorrection(int, int, bool, int)

Writes the curve correction setting for a specific block.

public void WriteCurveCorrection(int job, int block, bool curveCorrectionIsActive, int timeoutInMs = -1)

Parameters

job int: The job index.
block int: The block index.
curveCorrectionIsActive bool: True to enable curve correction; otherwise, false.
timeoutInMs int: Timeout in milliseconds after which an exception is thrown if the device does not respond.
Specify -1 to use DefaultTimeout.

Exceptions

NotInitializedException: Thrown when the module is not initialized.
LaserException: Thrown when the marking laser returns an error.

WriteDataMatrixSize(int, int, DataMatrixSize, int)

Sets data matrix size for a specific block.

public void WriteDataMatrixSize(int job, int block, DataMatrixSize dataMatrixSize, int timeoutInMs = -1)

Parameters

job int: The job index.
block int: The block index.
dataMatrixSize DataMatrixSize: The data matrix size.
timeoutInMs int: Timeout in milliseconds after which an exception is thrown if the device does not respond.
Specify -1 to use DefaultTimeout.

Exceptions

ArgumentNullException: Thrown when dataMatrixSize is null.
NotInitializedException: Thrown when the module is not initialized.
LaserException: Thrown when the marking laser returns an error.

WriteFillMarkingParameters(int, int, FillMarkingParameters, int)

Writes the fill marking parameters for a specific block.

public void WriteFillMarkingParameters(int job, int block, FillMarkingParameters fillMarkingParameters, int timeoutInMs = -1)

Parameters

job int: The job index.
block int: The block index.
fillMarkingParameters FillMarkingParameters: The fill marking parameters to write.
timeoutInMs int: Timeout in milliseconds after which an exception is thrown if the device does not respond.
Specify -1 to use DefaultTimeout.

Exceptions

ArgumentNullException: Thrown when fillMarkingParameters is null.
NotInitializedException: Thrown when the module is not initialized.
LaserException: Thrown when the marking laser returns an error.

WriteGS1DataBarSize(int, int, GS1DataBarSize, int)

Sets the GS1 data bar size for a specific block.

public void WriteGS1DataBarSize(int job, int block, GS1DataBarSize gs1DataBarSize, int timeoutInMs = -1)

Parameters

job int: The job index.
block int: The block index.
gs1DataBarSize GS1DataBarSize: GS1 data bar size.
timeoutInMs int: Timeout in milliseconds after which an exception is thrown if the device does not respond.
Specify -1 to use DefaultTimeout.

Exceptions

ArgumentNullException: Thrown when gs1DataBarSize is null.
NotInitializedException: Thrown when the module is not initialized.
LaserException: Thrown when the marking laser returns an error.

WriteGroupOffset(int, int, GroupOffset)

Sets the offset for a specific group.

public void WriteGroupOffset(int job, int group, GroupOffset groupOffset)

Parameters

job int: The job index.
group int: The group index.
groupOffset GroupOffset: Offset to set.

Exceptions

ArgumentNullException: Thrown when groupOffset is null.
ArgumentException: Thrown when all properties of groupOffset are null.
NotInitializedException: Thrown when the module is not initialized.
LaserException: Thrown when the marking laser returns an error.

WriteHatchParameters(int, int, HatchParameters, int)

Writes hatch parameters for a specific block.

public void WriteHatchParameters(int job, int block, HatchParameters hatchParameters, int timeoutInMs = -1)

Parameters

job int: The job index.
block int: The block index.
hatchParameters HatchParameters: The hatch parameters to write.
timeoutInMs int: Timeout in milliseconds after which an exception is thrown if the device does not respond.
Specify -1 to use DefaultTimeout.

Exceptions

ArgumentNullException: Thrown when hatchParameters is null.
NotInitializedException: Thrown when the module is not initialized.
LaserException: Thrown when the marking laser returns an error.

WriteHatchPattern(int, int, HatchPattern, int)

Writes hatch pattern settings for a specific block.

public void WriteHatchPattern(int job, int block, HatchPattern hatchPattern, int timeoutInMs = -1)

Parameters

job int: The job index.
block int: Th block index.
hatchPattern HatchPattern: The hatch pattern settings.
timeoutInMs int: Timeout in milliseconds after which an exception is thrown if the device does not respond.
Specify -1 to use DefaultTimeout.

Exceptions

NotInitializedException: Throw when the module is not initialized.
LaserException: Thrown when the marking laser returns an error.

WriteHeadOrientation(int, HeadOrientation, int)

Sets the head orientation for a specific job.

public void WriteHeadOrientation(int job, HeadOrientation headOrientation, int timeoutInMs = -1)

Parameters

job int: The job index.
headOrientation HeadOrientation: The head orientation.
timeoutInMs int: Timeout in milliseconds after which an exception is thrown if the device does not respond.
Specify -1 to use DefaultTimeout.

Exceptions

NotInitializedException: Throw when the module is not initialized.
LaserException: Thrown when the marking laser returns an error.

WriteHeightCorrection(int, HeightCorrection, int)

Writes the height correction of the specified job.

public void WriteHeightCorrection(int job, HeightCorrection heightCorrection, int timeoutInMs = -1)

Parameters

job int: The job index.
heightCorrection HeightCorrection: The height correction.
timeoutInMs int: Timeout in milliseconds after which an exception is thrown if the device does not respond.
Specify -1 to use DefaultTimeout.

Exceptions

ArgumentNullException: Thrown when heightCorrection is null.
NotInitializedException: Throw when the module is not initialized.
LaserException: Thrown when the marking laser returns an error.

WriteJobNumber(int)

Loads the selected job.

public void WriteJobNumber(int job)

Parameters

job int: New job number.

Remarks

After loading a new job, wait until operation is finished.

Exceptions

NotInitializedException: Thrown when the module is not initialized.
LaserException: Thrown when the marking laser returns an error.

WriteJobPosition(int, JobPosition, int)

Sets the position of the specified job.

public void WriteJobPosition(int job, JobPosition position, int timeoutInMs = -1)

Parameters

job int: The job index.
position JobPosition: The position.
timeoutInMs int: Timeout in milliseconds after which an exception is thrown if the device does not respond.
Specify -1 to use DefaultTimeout.

Exceptions

ArgumentNullException: Thrown when position is null.
NotInitializedException: Throw when the module is not initialized.
LaserException: Thrown when the marking laser returns an error.

WriteJobTitle(int, string, int)

Writes the job title.

public void WriteJobTitle(int job, string title, int timeoutInMs = -1)

Parameters

job int: The job index.
title string: The title.
timeoutInMs int: Timeout in milliseconds after which an exception is thrown if the device does not respond.
Specify -1 to use DefaultTimeout.

Exceptions

ArgumentNullException: Thrown when the title is null.
NotInitializedException: Throw when the module is not initialized.
LaserException: Thrown when the marking laser returns an error.

WriteJumpSpeed(int, int, JumpSpeed, int)

Writes the jump speed for a specific block.

public void WriteJumpSpeed(int job, int block, JumpSpeed jumpSpeedSetting, int timeoutInMs = -1)

Parameters

job int: The job index.
block int: The block index.
jumpSpeedSetting JumpSpeed: The jump speed setting to write.
timeoutInMs int: Timeout in milliseconds after which an exception is thrown if the device does not respond.
Specify -1 to use DefaultTimeout.

Exceptions

NotInitializedException: Thrown when the module is not initialized.
LaserException: Thrown when the marking laser returns an error.

WriteLogoSize(int, int, LogoSize, int)

Sets the logo size for a specific block.

public void WriteLogoSize(int job, int block, LogoSize logoSize, int timeoutInMs = -1)

Parameters

job int: The job index.
block int: The block index.
logoSize LogoSize: Logo size.
timeoutInMs int: Timeout in milliseconds after which an exception is thrown if the device does not respond.
Specify -1 to use DefaultTimeout.

Exceptions

ArgumentNullException: Thrown when logoSize is null.
NotInitializedException: Thrown when the module is not initialized.
LaserException: Thrown when the marking laser returns an error.

WriteMarkingConfirmationSetting(int, MarkingConfirmationSettings)

Writes marking confirmation settings to the laser.

public void WriteMarkingConfirmationSetting(int job, MarkingConfirmationSettings settings)

Parameters

job int: Job index.
settings MarkingConfirmationSettings: parameters to be written to laser.

Exceptions

ArgumentNullException: Thrown when any argument is null.
ArgumentException: Thrown when all properties of settings are null.
NotSupportedException: Thrown when the MarkingBuilderVersion property is MB3.
NotInitializedException: Throw when the module is not initialized.
LaserException: Thrown when the marking laser returns an error.

WriteMarkingEnergyCheck(int, MarkingEnergyCheckParameters, int)

Sets parameters the marking energy check parameters for the specified job.

public void WriteMarkingEnergyCheck(int job, MarkingEnergyCheckParameters markingEnergyParameters, int timeoutInMs = -1)

Parameters

job int: The job index.
markingEnergyParameters MarkingEnergyCheckParameters: The marking energy settings.
timeoutInMs int: Timeout in milliseconds after which an exception is thrown if the device does not respond.
Specify -1 to use DefaultTimeout.

Exceptions

ArgumentNullException: Thrown when markingEnergyParameters is null.
NotInitializedException: Throw when the module is not initialized.
LaserException: Thrown when the marking laser returns an error.

WriteMarkingQuality(int, int, MarkingQuality, int)

Writes the marking quality for a specific block.

public void WriteMarkingQuality(int job, int block, MarkingQuality markingQuality, int timeoutInMs = -1)

Parameters

job int: The job index.
block int: The block index.
markingQuality MarkingQuality: The marking quality to write.
timeoutInMs int: Timeout in milliseconds after which an exception is thrown if the device does not respond.
Specify -1 to use DefaultTimeout.

Exceptions

ArgumentNullException: Thrown when markingQuality is null.
NotInitializedException: Thrown when the module is not initialized.
LaserException: Thrown when the marking laser returns an error.

WriteMatrixCell(int, int, MatrixCell, int)

Sets a matrix cell settings of a specific matrix cell.

public void WriteMatrixCell(int job, int cell, MatrixCell matrixCell, int timeoutInMs = -1)

Parameters

job int: The job index.
cell int: The cell index of the matrix.
matrixCell MatrixCell: The cell settings.
timeoutInMs int: Timeout in milliseconds after which an exception is thrown if the device does not respond.
Specify -1 to use DefaultTimeout.

Exceptions

NotInitializedException: Throw when the module is not initialized.
LaserException: Thrown when the marking laser returns an error.

WriteMatrixInactiveCellCount(int, bool, int)

Writes value indicating whether inactive matrix cells are counted.

public void WriteMatrixInactiveCellCount(int job, bool countInactiveCells, int timeoutInMs = -1)

Parameters

job int: The job index.
countInactiveCells bool: A value indicating whether inactive cells should be counted.
timeoutInMs int: Timeout in milliseconds after which an exception is thrown if the device does not respond.
Specify -1 to use DefaultTimeout.

Exceptions

NotInitializedException: Throw when the module is not initialized.
LaserException: Thrown when the marking laser returns an error.

WriteMatrixPosition(int, MatrixPosition, int)

Sets the matrix position of a job.

public void WriteMatrixPosition(int job, MatrixPosition matrixPosition, int timeoutInMs = -1)

Parameters

job int: The job index.
matrixPosition MatrixPosition: Matrix position.
timeoutInMs int: Timeout in milliseconds after which an exception is thrown if the device does not respond.
Specify -1 to use DefaultTimeout.

Exceptions

NotInitializedException: Throw when the module is not initialized.
LaserException: Thrown when the marking laser returns an error.

WriteMatrixSettings(int, MatrixSettings, int)

Sets matrix settings of a job.

public void WriteMatrixSettings(int job, MatrixSettings matrixSettings, int timeoutInMs = -1)

Parameters

job int: The job index.
matrixSettings MatrixSettings: Matrix settings.
timeoutInMs int: Timespan in milliseconds after which an exception is thrown when device does not return an answer.
-1 uses the DefaultTimeout.

Exceptions

NotInitializedException: Throw when the module is not initialized.
LaserException: Thrown when the marking laser returns an error.

WriteMatrixSize(int, MatrixSize, int)

Sets the matrix size of a job.

public void WriteMatrixSize(int job, MatrixSize matrixSize, int timeoutInMs = -1)

Parameters

job int: The job index.
matrixSize MatrixSize: settings sent to laser.
timeoutInMs int: Timespan in milliseconds after which an exception is thrown when device does not return an answer.
-1 uses the DefaultTimeout.

Exceptions

NotInitializedException: Throw when the module is not initialized.
LaserException: Thrown when the marking laser returns an error.

WriteMultiPassMarkingParameter(int, int, int, MultiPassMarkingParameters, int)

Sets common marking parameters.

public void WriteMultiPassMarkingParameter(int job, int block, int overprinting, MultiPassMarkingParameters blockMarkingParameters, int timeoutInMs = -1)

Parameters

job int: The job index.
block int: The block index.
overprinting int: The overprinting index.
blockMarkingParameters MultiPassMarkingParameters: Multi pass marking parameters for target block.
timeoutInMs int: Timespan in milliseconds after which an exception is thrown when device does not return an answer.
-1 uses the DefaultTimeout.

Exceptions

NotInitializedException: Throw when the module is not initialized.
LaserException: Thrown when the marking laser returns an error.

WriteOnTheFlyParameters(int, OnTheFlySettings)

Writes the OnTheFly settings for a specific block.

public void WriteOnTheFlyParameters(int job, OnTheFlySettings writeValues)

Parameters

job int: The job index.
writeValues OnTheFlySettings: OnTheFly parameters to be written to laser.

Exceptions

ArgumentNullException: Thrown when any argument is null.
NotInitializedException: Throw when the module is not initialized.
LaserException: Thrown when the marking laser returns an error.

WritePhotoSettings(int, int, PhotoSettings, int)

Writes photo settings for a specific block.

public void WritePhotoSettings(int job, int block, PhotoSettings ttfParameters, int timeoutInMs = -1)

Parameters

job int: The job index.
block int: The block index.
ttfParameters PhotoSettings: The photo settings to write.
timeoutInMs int: Timeout in milliseconds after which an exception is thrown if the device does not respond.
Specify -1 to use DefaultTimeout.

Exceptions

ArgumentNullException: Thrown when ttfParameters is null.
NotInitializedException: Thrown when the module is not initialized.
LaserException: Thrown when the marking laser returns an error.

WriteQRCodeSize(int, int, QRCodeSize, int)

Sets QR code size for a specific block.

public void WriteQRCodeSize(int job, int block, QRCodeSize qrCodeSize, int timeoutInMs = -1)

Parameters

job int: The job index.
block int: The block index.
qrCodeSize QRCodeSize: QR code size.
timeoutInMs int: Timeout in milliseconds after which an exception is thrown if the device does not respond.
Specify -1 to use DefaultTimeout.

Exceptions

ArgumentNullException: Thrown when qrCodeSize is null.
NotInitializedException: Thrown when the module is not initialized.
LaserException: Thrown when the marking laser returns an error.

WriteSpaceApproach(int, int, double, int)

Writes the space approach setting for a specific block.

public void WriteSpaceApproach(int job, int block, double spaceApproach, int timeoutInMs = -1)

Parameters

job int: The job index.
block int: The block index.
spaceApproach double: The space approach value in millimeters.
timeoutInMs int: Timeout in milliseconds after which an exception is thrown if the device does not respond.
Specify -1 to use DefaultTimeout.

Exceptions

NotInitializedException: Thrown when the module is not initialized.
LaserException: Thrown when the marking laser returns an error.

WriteTrueTypeFontParameters(int, int, TrueTypeFontParameters, int)

Writes TrueType font parameters for a specific block.

public void WriteTrueTypeFontParameters(int job, int block, TrueTypeFontParameters trueTypeFontParameters, int timeoutInMs = -1)

Parameters

job int: The job index.
block int: The block index.
trueTypeFontParameters TrueTypeFontParameters: The TrueType font parameters to write.
timeoutInMs int: Timeout in milliseconds after which an exception is thrown if the device does not respond.
Specify -1 to use DefaultTimeout.

Exceptions

ArgumentNullException: Thrown when trueTypeFontParameters is null.
NotInitializedException: Thrown when the module is not initialized.
LaserException: Thrown when the marking laser returns an error.

WriteTrueTypeFontPattern(int, int, TrueTypeFontPattern, int)

Writes TrueType font pattern settings for a specific block.

public void WriteTrueTypeFontPattern(int job, int block, TrueTypeFontPattern trueTypeFontPattern, int timeoutInMs = -1)

Parameters

job int: The job index.
block int: The block index.
trueTypeFontPattern TrueTypeFontPattern: The TrueType font pattern settings to write.
timeoutInMs int: Timeout in milliseconds after which an exception is thrown if the device does not respond.
Specify -1 to use DefaultTimeout.

Exceptions

ArgumentNullException: Thrown when trueTypeFontPattern is null.
NotInitializedException: Thrown when the module is not initialized.
LaserException: Thrown when the marking laser returns an error.

WriteWindowCheckAfterMarkingAlarmThreshold(int, int)

Writes alarm threshold value for window check to the laser.

public void WriteWindowCheckAfterMarkingAlarmThreshold(int job, int alarmThreshold)

Parameters

job int: Job index.
alarmThreshold int: Alarm threshold in percent.

Exceptions

ArgumentOutOfRangeException: Throw when alarmThreshold is less than 0 or greater than 100.
NotSupportedException: Thrown when the MarkingBuilderVersion is MB3.
NotInitializedException: Throw when the module is not initialized.
LaserException: Thrown when the marking laser returns an error.

WriteWindowCheckAfterMarkingEnable(int, bool)

Writes whether window check after marking is enabled to the laser.

public void WriteWindowCheckAfterMarkingEnable(int job, bool writeValue)

Parameters

job int: Job index.
writeValue bool: window check is enabled.

Exceptions

NotSupportedException: Thrown when the MarkingBuilderVersion is MB3.
NotInitializedException: Throw when the module is not initialized.
LaserException: Thrown when the marking laser returns an error.

WriteWindowCheckAfterMarkingSensitivity(int, WindowCheckSensitivity)

Writes sensitivity for window check after marking to the laser.

public void WriteWindowCheckAfterMarkingSensitivity(int job, WindowCheckSensitivity writeValue)

Parameters

job int: Job index.
writeValue WindowCheckSensitivity: window check sensitivity.

Exceptions

NotSupportedException: Thrown when the MarkingBuilderVersion is MB3.
NotInitializedException: Throw when the module is not initialized.
LaserException: Thrown when the marking laser returns an error.

WriteWindowCheckBeforeMarkingAlarmThreshold(int, int)

Writes alarm threshold value for window check to the laser.

public void WriteWindowCheckBeforeMarkingAlarmThreshold(int job, int alarmThreshold)

Parameters

job int: Job index.
alarmThreshold int: Alarm threshold in percent.

Exceptions

ArgumentOutOfRangeException: Throw when alarmThreshold is less than 0 or greater than 100.
NotSupportedException: Thrown when the MarkingBuilderVersion is MB3.
NotInitializedException: Throw when the module is not initialized.
LaserException: Thrown when the marking laser returns an error.

WriteWindowCheckBeforeMarkingEnable(int, bool)

Writes whether window check before marking is enabled to the laser.

public void WriteWindowCheckBeforeMarkingEnable(int job, bool writeValue)

Parameters

job int: Job index.
writeValue bool: window check is enabled.

Exceptions

NotSupportedException: Thrown when the MarkingBuilderVersion is MB3.
NotInitializedException: Throw when the module is not initialized.
LaserException: Thrown when the marking laser returns an error.

WriteWindowCheckBeforeMarkingSensitivity(int, WindowCheckSensitivity)

Writes sensitivity for window check before marking to the laser.

public void WriteWindowCheckBeforeMarkingSensitivity(int job, WindowCheckSensitivity writeValue)

Parameters

job int: Job index.
writeValue WindowCheckSensitivity: window check sensitivity.

Exceptions

NotSupportedException: Thrown when the MarkingBuilderVersion is MB3.
NotInitializedException: Throw when the module is not initialized.
LaserException: Thrown when the marking laser returns an error.

WriteXYTrackingCorrectionThreshold(int, int, int)

Writes XY-tracking correction threshold to the laser.

public void WriteXYTrackingCorrectionThreshold(int job, int tracking, int writeValue)

Parameters

job int: Job index.
tracking int: Tracking index.
writeValue int: XY-tracking correction threshold.

Exceptions

ArgumentNullException: Thrown when any argument is null.
NotSupportedException: Thrown when the MarkingBuilderVersion property is MB3.
NotInitializedException: Throw when the module is not initialized.
LaserException: Thrown when the marking laser returns an error.

WriteXYTrackingEnable(int, int, bool)

Writes enable of XY-tracking to the laser.

public void WriteXYTrackingEnable(int job, int tracking, bool trackingIsEnabled)

Parameters

job int: Job index.
tracking int: Tracking index.
trackingIsEnabled bool: XY-tracking is enabled.

Exceptions

ArgumentNullException: Thrown when any argument is null.
NotSupportedException: Thrown when the MarkingBuilderVersion property is MB3.
NotInitializedException: Throw when the module is not initialized.
LaserException: Thrown when the marking laser returns an error.

WriteZTrackingCalibration(int, ZTrackingCalibration)

Writes Z-tracking calibration to the laser.

public void WriteZTrackingCalibration(int job, ZTrackingCalibration writeValues)

Parameters

job int: Job index.
writeValues ZTrackingCalibration: calibration of Z-tracking.

Exceptions

ArgumentNullException: Thrown when any argument is null.
NotSupportedException: Thrown when the MarkingBuilderVersion property is MB3.
NotInitializedException: Throw when the module is not initialized.
LaserException: Thrown when the marking laser returns an error.

WriteZTrackingEnable(int, int, bool)

Writes enable of Z-tracking to the laser.

public void WriteZTrackingEnable(int job, int tracking, bool trackingIsEnabled)

Parameters

job int: Job index.
tracking int: Tracking index.
trackingIsEnabled bool: Z-tracking is enabled.

Exceptions

ArgumentNullException: Thrown when any argument is null.
NotSupportedException: Thrown when the MarkingBuilderVersion property is MB3.
NotInitializedException: Throw when the module is not initialized.
LaserException: Thrown when the marking laser returns an error.

Table of Contents

Class LaserModule

Remarks

Performance Improvement

Constructors

LaserModule(string, ICommunication)

Parameters

Remarks

Properties

DefaultTimeout

Property Value

DeviceLabel

Property Value

DeviceState

Property Value

DisableErrorMessage

Property Value

DisableWarmUpMessage

Property Value

Errors

Property Value

InstanceID

Property Value

IsMarking

Property Value

JobFiles

Property Value

Remarks

LastReceivedResponse

Property Value

LastSentCommand

Property Value

LogoFiles

Property Value

Remarks

MarkingBuilderVersion

Property Value

OpcEndpoint

Property Value

UseOpc

Property Value

Methods

CanGetCommunicationPriority()

Returns

Remarks

Exceptions

ClearError()

Exceptions

CreateJob(int, int)

Parameters

Exceptions

DeleteJob(int, int)

Parameters

Exceptions

DisableGuideLaser()

Exceptions

DisableMarking(int, int, int)

Parameters

Exceptions

DisableMarkingForAllBlocks(int, int)

Parameters

Exceptions

DisableMarkingForAllMatrixCells(int, int)

Parameters

Exceptions

EditJob(int, Action<LaserModule, int>, int)

Parameters

Examples

Remarks

Exceptions

EnableGuideLaser(GuideLaserType)

Parameters

Exceptions

EnableMarking(int, int, int)

Parameters

Exceptions

EnableMarkingForAllBlocks(int, int)

Parameters

Exceptions

EnableMarkingForAllMatrixCells(int, int)