ICON INTERFACE

Software System Guide

 ICON INTERFACE SOFTWARE SYSTEM GUIDE

Table of Contents Page

Introduction 3
Software Installation 3
Main Application Window 5
Loading Templates 6
Laser Marking 8
Programmable Z Axis Movement Commands 8
Editing Template Data 9
Add Text Boundary 10
Load Template with Scanner 11
Editing Template Data with Scanner 11
Scanner Simple Mark Mode 12
Scanner Commands 13
Setting Mark Quantity 13
Adding Items to Queue 14
Global IDs 15
Tree Browse Templates 18
Access Control 19
Settings 20
General 20
Theme 21
Imports 22
Axis 23
Card I/O 23
Message Log 24
Log File 25
Icon Interface Version 26
SQL Server 27
TCP/IP Interface 28
Python Code Example 31
Configuration File 32
Contact Information 35

Copyright © 2018 Tykma™ Electrox Inc. All rights reserved.

This document contains information covered by copyright. Any information contained in this manual may be subject to
change without prior notice. All product or program names mentioned in this document are registered trademarks owned
by the respective companies.

All information and contents in this document are property of Tykma™ Electrox Inc. and cannot be shown, distributed,
modified and/or reproduced through electronic, mechanical or any other way, without written consent from Tykma™
Electrox Inc.

Originally Published October 2017.

TE-EN-C-1151-C1 Page 2 of 35 Rev 3/14/18

 ICON INTERFACE SOFTWARE SYSTEM GUIDE

Introduction

ICON Interface Introduction

ICON Interface is integrated with Minilase Pro SE software to perform basic functions in controlling laser marking.
Minilase Pro SE software is used to develop project files with in depth configuration settings and functions. ICON
Interface provides a user-friendly GUI for operators to load and mark projects that were created in Minilase Pro SE.

ICON Interface templates import Minilase Pro SE project file (*.pse) information for preview and marking. ICON
Interface templates do not modify the original Minilase Pro SE project files. However, data such as text and numeric
values can be edited within a loaded template session.

ICON Interface is ideal for automated processes that includes the use of scanning devices. This manual provides
instructions in the use of scanner data input. This manual also includes technical information for administrators in the
configuration of various settings, the use of a TCP/IP interface, log files and other tools within ICON Interface.
Contact TykmaTM Electrox (1-740-474-9981) technical support for further instructions if needed.

Software Installation
System requirements for the ICON Interface software is a Windows PC with minimum 1 GHZ CPU and 2 GB RAM.
ICON Interface is supported by Windows 7, 8 and 10. USB port for laser connection, Ethernet port required for
TCP/IP interface and pre-loaded Minilase Pro SE project file(s).

Note: Microsoft .Net framework may need to be downloaded during installation.

Step 1: Locate the ICON Interface installer file and double click.

Step 2: The installation Wizard will open. Click Next.

TE-EN-C-1151-C1 Page 3 of 35 Rev 3/14/18

 ICON INTERFACE SOFTWARE SYSTEM GUIDE

Software Installation

Step 3: Confirm installation by clicking Install.

Step 4: Once installation is complete click Finish.

TE-EN-C-1151-C1 Page 4 of 35 Rev 3/14/18

 ICON INTERFACE SOFTWARE SYSTEM GUIDE

Main Application Window

Software Main Application Window

After starting the ICON Interface software, the main application window opens. This window provides control of
templates, marking sequences, data input and access to configuration settings.

1 Template List lists the templates available to load and mark.

2 Preview Screen shows a preview of the loaded template
3 Start begins laser marking. Limits displays a trace outline marking
4 Edit allows for editing of loaded template. Clear clears the loaded template
5 Scanner Input text box allows for scanned or manually typed input.
6 Status bar shows messages on performed actions.
7 Menu located in the lower right-hand corner of the screen allows editing of different Settings, I/O port status,
Global IDs and type of Access. Click the arrow button to open menu options.

TE-EN-C-1151-C1 Page 5 of 35 Rev 3/14/18

 ICON INTERFACE SOFTWARE SYSTEM GUIDE

Loading Templates
ICON Interface searches for project files created with Minilase Pro SE by default inside the “My Documents” folder. To
change the folder location, Engineer Access is required (password protected). Contact TykmaTM Electrox for
password. To change folder location, go to Settings and modify the Project Folder path.

TE-EN-C-1151-C1 Page 6 of 35 Rev 3/14/18

 ICON INTERFACE SOFTWARE SYSTEM GUIDE

Loading Templates
Template buttons will appear listed when the project files are located according to Project Folder settings.

Scroll buttons located in the lower left-

hand screen appear if the list of
templates can not fit on one screen.

Note: “Projects” as denoted in this

manual refers to the Minilase Pro SE
project files. “Templates” refer to the
structure ICON Interface creates by
using the Project files located in the
Project Folder path.

To load a template, click button in the Template List. A preview of the mark will appear in the preview screen.

A template can also be loaded by entering the name of the template in the Scanner Input field.

TE-EN-C-1151-C1 Page 7 of 35 Rev 3/14/18

 ICON INTERFACE SOFTWARE SYSTEM GUIDE

Laser Marking

***CAUTION***
Follow all prescribed safety requirements in operating any laser marking system

Step 1: Select a template to mark.

Step 2: Place object to be marked in laser machine

Step 3: Press the Limits button to view a traced outlined of the

marking area

Note: Limits does not work until the Z Axis has been moved to the
Proper Position for Trace/Mark

Step 4: Press the Start button to begin laser marking.

Programmable Z Axis Movement Commands

If using a machine that includes a programmable Z

axis, the project files created in Minilase Pro SE
used by ICON Interface must include Move Axis
objects to control positioning. With Minilase Pro
SE, the Z position property is normally set to adjust
for part height. ICON Interface does not process Z
axis position settings. To move the Z axis in
position to accommodate part height, ICON
Interface reads Move Axis object property settings.

TE-EN-C-1151-C1 Page 8 of 35 Rev 3/14/18

 ICON INTERFACE SOFTWARE SYSTEM GUIDE

Editing Template Data

Value of an object can be edited while the template is loaded. Editing only applies to the loaded template, not the
original Minilase Pro SE project file. New values remain as long as the template session is open. Once template is
closed, the template reverts to original values stored in the Minilase Pro SE project file.

Before template data values can be edited, the object must have a name ID assigned to that object within Minilase Pro
SE. The Edit button will not appear In ICON Interface if the object does not have a name ID assigned.

Step 1: Open project file in Minilase Pro SE

Step 2: Double click inside the Object List Name field
Step 3: Enter name and click OK
Step 4: Save project file

To temporarily edit the value of a loaded template’s object, click the Edit button.
Click on the Value field of the object and modify.

Note: Edits made to the template within ICON

Interface do not update the Minilase Pro SE project
file.

Press the Shift & Enter key to create a CR line break

in the value field.

TE-EN-C-1151-C1 Page 9 of 35 Rev 3/14/18

 ICON INTERFACE SOFTWARE SYSTEM GUIDE

Add Text Boundary

Icon Interface version 1.0.12.2 and above contains a feature can be used to keep a text object from exceeding a set
size. This feature can be added to Custom ICON Interface as needed.

1. In Minilase Pro SE, create a Text Object and name it (ex: TEXT1)
2. Create a rectangle around that Text Object which defines the bounds beyond which the text object should not grow.
3. Name the boundary you created "BOUNDARY:TEXT1"
4. This tells the software that TEXT1 should grow to that boundary
5. When running Icon Interface, the object is automatically scaled to fit within the boundary while maintaining aspect
ratio.

Note: To avoid marking the boundary, turn off Pen marking parameters assigned to the boundary.

TE-EN-C-1151-C1 Page 10 of 35 Rev 3/14/18

 ICON INTERFACE SOFTWARE SYSTEM GUIDE

Load Template with Scanner

Templates can be loaded without Template List buttons. A connected scanner can be used to enter the name of the
template to load. Manually typing the template name and pressing the Enter key in the Scanner Input field can also be
used to load templates.

Editing Template Data with Scanner

To edit the value of an object, an ID name must be assigned within Minilase Pro SE. Format for setting value using
the scanner field: @[ID]:[DATA]. Example: “@Serial:1234” changes SerialNum template’s text object ID “Serial”
value to “1234”.

TE-EN-C-1151-C1 Page 11 of 35 Rev 3/14/18

 ICON INTERFACE SOFTWARE SYSTEM GUIDE

Scanner Simple Mark Mode

If "Simple Mark Mode" is enabled (see Config file), scanner input field can set new values to two different Ids.

Example
Enable Simple Mark Mode in Config file :

<add key="SIMPLE_MARK_MODE" value="True" />

<add key="SIMPLE_MARK_FIRSTIDPREFSUFF" value="*" />
<add key="SIMPLE_MARK_STRIP_SUFFIX" value="True" />
<add key="SIMPLE_MARK_FIRSTID" value="Serial" />
<add key="SIMPLE_MARK_SECONDID" value="Serial2" />
First ID: Serial
Second ID: Serial2

Entering “*1234* in the scanner field will change Serial ID value to “1234”

Entering “5678” (without “*” prefix or suffix) in the scanner field will change Serial2 ID value to “5678”

TE-EN-C-1151-C1 Page 12 of 35 Rev 3/14/18

 ICON INTERFACE SOFTWARE SYSTEM GUIDE

Scanner Commands
Various scanner commands can be entered to perform other marking operations. The following list of commands can
be entered in the Scanner Field. These include many of the same commands set to available buttons and settings.

Command Operation
!start Start the marking cycle
!clear Clear the loaded template
!limits Start/Stop the limits.
!qty_up Increase quantity (when counter enabled).
!qty_down Decrease quantity (when counter disabled).
!edit Bring up the "Edit data" screen
!joblist Bring up the "job list" screen.
!homez Home the "Z" axis.
!homer Home the "R" axis.

Setting Mark Quantity

Dynamic fields, such as counters, require laser marks to repeat to increment numeric values. ICON Interface can set
the number of repeated incremental markings. Scan or enter the symbol "#" followed by a numeric value to set the
quantity to mark. Counter functionality must be enabled in the Config file (<add key="USE_COUNTER" value="True"
/>). Click the “#” button to enter quantity using the Input Quantity keypad.

TE-EN-C-1151-C1 Page 13 of 35 Rev 3/14/18

 ICON INTERFACE SOFTWARE SYSTEM GUIDE

Adding Items to Queue

If the queue functionality is enabled in the Config file a queue window will open along with the main interface (<add
key="USE_QUEUE" value="True" />). Scanning or typing a template name in the scanning field will add it to the
queue. Repeat for each template to place in queue.

Highlight and press Skip to skip template in Queue. Highlight and press Run to place template back in queue.

To repeat a template in the queue, append the template name with the “|” symbol, followed by a numeric value.
Example: Entering “SerialNum|10” in the scanning field places ten instances of this job in queue.

TE-EN-C-1151-C1 Page 14 of 35 Rev 3/14/18

 ICON INTERFACE SOFTWARE SYSTEM GUIDE

Global IDs
Global IDs are global in scope. When a project is loaded that contains an ID with the same name as a Global ID, its
value will be replaced with the Global ID's value. Both counters and strings can serve as Global Ids.

Add Counter Global ID

Step 1: Click on the Menu icon in the

bottom right corner of the screen.

Step 2: Click “Global IDs”. Global IDs screen appears.

Step 3: Click "Add" button for a Counter variable.

Step 4: Enter ID and Value.

Step 5: Click “Add”

TE-EN-C-1151-C1 Page 15 of 35 Rev 3/14/18

 ICON INTERFACE SOFTWARE SYSTEM GUIDE

Global IDs
Add Counter Global ID (continued)

The counter “MyCounter” is now a Global ID with a value of “100”.

Any loaded templates that contains an ID named “MyCounter” will
use the value of this Global ID.

The Global value will incrementally increase as each marking

sequence is complete.

Counter Global IDs can be reset by clicking the “Reset” button

TE-EN-C-1151-C1 Page 16 of 35 Rev 3/14/18

 ICON INTERFACE SOFTWARE SYSTEM GUIDE

Global IDs
Add String Global ID

Step 1: Click "Add" button for a String variable.

Step 2: Enter ID and Value.

Step 3: Click “Add”

The ID “ICON” is now a Global ID with a value of

“MyGlobalString”. Any loaded templates containing an
ID named “ICON” will use the value of this Global ID.

TE-EN-C-1151-C1 Page 17 of 35 Rev 3/14/18

 ICON INTERFACE SOFTWARE SYSTEM GUIDE

Tree Browse
Tree browse lists templates in an alphabetical folder tree format. When there are large numbers of templates to list, it
may be easier to view and select templates when they are listed in a tree folder layout. To enable the Tree Browse
layout option the value of the TREE_JOB_LIST key in the Config.xml file must be set to “True”.

Config.xml Setting: <add key="TREE_JOB_LIST" value="True" />

Click on the folder icon that appears in the lower left-hand corner of the ICON Interface screen.

Templates are arranged in a folder tree format alphabetically.

TE-EN-C-1151-C1 Page 18 of 35 Rev 3/14/18

 ICON INTERFACE SOFTWARE SYSTEM GUIDE

Access Control
Enabling Access

There are two access modes in the icon interface: "Operator" and
"Engineer. Access Control may be enabled in either mode. However,
once disabled in Operator mode, ICON Interface must run in Engineer
mode to re-enable Access Control.

Engineer mode allows for expanded access to ICON Interface Settings.

To login in Engineer mode, select “Access” from the Menu and click on
“Engineer”. Engineer mode is password protected. Enter “89562”

In Engineer mode, Card-I/O and Settings options will become active.

1) Select “Settings” from Menu.

2) Select General.

3) Enable Access Control.

4) Click Save.

Password Entry Keypad

TE-EN-C-1151-C1 Page 19 of 35 Rev 3/14/18

 ICON INTERFACE SOFTWARE SYSTEM GUIDE

Settings

Settings include four options:

1) General
2) Theme
3) Imports
4) Axis

General Settings

General settings allows for editing of folder locations for several different system files and includes options to
enable/disable functions such as tracing, instructions window display, opening of last loaded job on startup, and
access control to settings.

Instructions Window

Install Folder Minilase Pro SE install location: C:\Program Files (x86)\Minilase Pro SE\
Project Folder Location ICON Interface searches for projects to load
Images Folder Location ICON Interface searches for default image to display error and instructional messages
RTF Folder Location ICON Interface searches for default text to display in Instruction window
Pervasive Limits Enabled, tracing is turned on any time a project is loaded
Instructions Enable Instructions window to display when project is loaded
Load Last Job Last project loaded will load on ICON Interface opening
Access Control Enable Operator/Engineer control modes
New Password Set new password log in Engineer mode

Instructions Window Image and Text File Naming

When Instructions is enabled a window will appear that includes an image (PNG, JPG or BMP) and text (RTF). The
image displayed is the image located in the Images Folder with the same name as the Template. If the Template name
is “ICON”, then name the JPG image “ICON.JPG”. Name the RTF file located in the RTF Folder same as Template
(“ICON.RTF”).

TE-EN-C-1151-C1 Page 20 of 35 Rev 3/14/18

 ICON INTERFACE SOFTWARE SYSTEM GUIDE

Settings
Theme
Theme settings provides options to change the look and layout of the ICON Interface GUI. You can change the
background, font and status bar color. There is also an option to use an image for your background. Language
settings can be changed, use of full screen mode and ability to hide the list of templates/jobs.

Background Set background color of ICON Interface window

Font Set font color
Status Bar Set background color of status bar
Language Set language (Russian, English, Korean, German)
Use Full Screen Mode Set ICON Interface in full screen mode
Hide Job List Hide project buttons. Requires re-opening of ICON Interface
Background Image Set ICON Interface window background to an image

TE-EN-C-1151-C1 Page 21 of 35 Rev 3/14/18

 ICON INTERFACE SOFTWARE SYSTEM GUIDE

Settings
Imports
Icon Interface can be configured to retrieve data from a Comma Separated Value (CSV) or Text (TXT) file. With File
Import Enabled, ICON Interface searches the file location path for a CSV or Txt file.

Import Paths
File Location Location of CSV or TXT import file
Completed File Location of completed marked files
Error Path Location of files when error occurs. NoMark log is created on error
Configuration
File Poll Rate Set how often File Location is searched for changes
Wait to Read Delay between finding a file and reading it
Job Load Mode Read first line. “*” denotes job to load.
File Import Enabled Enable File Import

File Structure: Example: Set Mark Quantity

*$JOBNAME *SerialNum *SerialNum
$ID:$VALUE Serial:12345 Serial:12345
$ID2:$VALUE2 Serial2: 56789 Serial2: 56789
$ID3:$VALUE4 #100

MyImport.txt

TE-EN-C-1151-C1 Page 22 of 35 Rev 3/14/18

 ICON INTERFACE SOFTWARE SYSTEM GUIDE

Settings
Imports (continued)
Example:

MyImport.txt file located C:\Tykma.

C:\Tykma is checked for any CSV or TXT

files.

MyImport.txt file is found

SerialNum job is selected

First line “*SerialNum” identifies job

Second line sets value of Serial ID to

“1234”

Third line sets value of Serial2 ID to

“56789”

Axis

Enable Z and R axis along with the X axis.

Home Axis Frequency Home axis after number of marking sequences are completed.
Homing the axis ensures proper positioning to maintain focal length accuracy.
Home Axis On Startup Axis is homed automatically on ICON Interface startup

Card I/O
Card I/O displays input and output states of each port. Used for diagnostic purposes.

TE-EN-C-1151-C1 Page 23 of 35 Rev 3/14/18

 ICON INTERFACE SOFTWARE SYSTEM GUIDE

Message Log
ICON Interface software displays messages and records actions with a timestamped event log. Displayed messages
and the log file can be useful in troubleshooting by tracking errors, entered commands and general history of use. The
location of the log file can be modified, as well as the level of detail being recorded.

Software Message Log

Double click the status bar on the bottom left side of the ICON Interface window to view log.

Message log appears. Error level messages will be logged in red.

TE-EN-C-1151-C1 Page 24 of 35 Rev 3/14/18

 ICON INTERFACE SOFTWARE SYSTEM GUIDE

Log File
A log file is saved according to date and is located: C:\TYKMA\Custom\Tykma_Icon\Logs\[DATE].Log

Example log file:

Changing Location of Log File

Advanced user only

Modify the NLog.config file located: C:\Program Files (x86)\Icon Interface

<variable name="LogsLocation" value="c:\tykma\custom\${LogProjName}\Logs" />

TE-EN-C-1151-C1 Page 25 of 35 Rev 3/14/18

 ICON INTERFACE SOFTWARE SYSTEM GUIDE

Log File

Changing Detail Level of Log File

Advanced user only

The level of detail being recorded in the message log can be adjusted by editing the “logger name” tag in the
NLog.config file located: C:\Program Files (x86)\Icon Interface. Modify the “minilevel” value to the desired level.

Available levels are: TRACE, DEBUG, INFO, WARN, ERROR, FATAL

Example: <logger name="*" minlevel="Info" writeTo="file" />

“Trace” provides the most detailed log. “Fatal” records only major errors and creates the least detailed log.

ICON Interface Version

To check the software version of ICON
Interface, click the main menu button in
the lower right-hand corner of the screen
and select “About”. The window screen
displays the software version and
Operating System information.

TE-EN-C-1151-C1 Page 26 of 35 Rev 3/14/18

 ICON INTERFACE SOFTWARE SYSTEM GUIDE

SQL Server
ICON Interface can be configured to enable the use of Microsoft SQL Server. Once configured, ICON Interface will
query and return data from a SQL database to populate a template. The field names in the SQL table is created to include
field names that correspond with the ID names in the project (template) file. The data record is used to identify the template
to load, number of laser marking sequences to make and populates the individual ID values within the template. To enable
the integration of ICON Interface and SQL Server the SQL.xml file settings are required to be edited. SQL.xml file is
located C:\Tykma\Custom\Tykma_Icon.

SQL.xml Settings Example:

<add key="USE_SQL_SERVER" value="False" />
<add key="SQL_TABLE" value="Table1" />
<add key="SQL_PRIMARY_FIELD" value="PrimaryKey" />
<add key="SQL_JOB_COLUMN" value="Job Number" />
<add key="SQL_QTY_COLUMN" value="Quantity" />
<add key="SQL_CONN_STRING" value="Server=sqlserver01;Database=master;User
Id=laseruser;Password=youri123;" />

SQL_TABLE = Name of the view or table to look up.

SQL_PRIMARY_FIELD = Name of the database’s table primary key field.
SQL_JOB_COLUMN = Name of the field storing names of templates to load.
SQL_QTY_COLUMN = Name of field to set number of marking sequences
Note: Config.xml file Use_Counter key must also be enabled (<add key="USE_COUNTER" value="True" />) to use
multiple marking sequences.
SQL_CONN_STRING = Database Connection string.

SQL Server and ICON Interface process:

1. ICON Interface software is opened and uses the SQL Conn String value in the SQL.xml file to make connection to
SQL database (master). Table (Table1), Primary_Field (PrimaryKey), Qty_Column (Quantity) and Job_Column (Job
Number) are initialized.
2. Search criteria "123" is entered in to the ICON input field.
3. Software connects to Table1 and finds the PrimaryKey column with the value “123”
4. Data record containing primary key “123” is returned with values from each column.
5. ICON Interface uses the returned Job Number value to determine the name of the template to load.
6. Template loads and IDs (Customer Name, Style Number, Serial….) in the template corresponding with Table1 field
names are populated with the SQL database data.
7. Qty (number of marking sequences) set to “55”.

TE-EN-C-1151-C1 Page 27 of 35 Rev 3/14/18

 ICON INTERFACE SOFTWARE SYSTEM GUIDE

TCP/IP Interface
The TCP/IP Interface allows for the use of a network device to send commands to ICON Interface that is running on a
networked computer. Commands are sent remotely by using the IP address. These commands provide the ability to
load templates, home axis, start and stop marking sequences and others. To use a TCP/IP Interface the Configuration
(Config.xml) file settings must be enabled.

***CAUTION***
Safety precautions must be taken anytime remote commands can be sent to your laser system

Enabling TCP/IP Interface

Step 1: Edit "Config.XML" in C:\TYKMA\Custom\Tykma_Icon and set NET_ENABLE to "True".
<add key="NET_ENABLE" value="True" />

Step 2: Open ICON Interface, double click on the status bar and verify that the TCP/IP port is open.

Step 3: Open a web browser on the system running ICON Interface and navigate to http://localhost:5287/loaded_job.
This will request the name of loaded template. To send commands remotely from another device, replace “localhost”
with the IP address (ex: 192.168.168.148) of the networked computer running ICON Interface. The IP address must
be appended using port “:5287”.

Available TCP/IP Commands

Clear job
Purpose: Clears any loaded job.
Command: clear_job
Return: "clear:ok"
Example: http://192.168.168.148:5287/clear_job

Get Job Status

Purpose: Gets the status of a job.
Command: job_status
Return: status:marked status:loaded status:not_loaded status:data_set status:stopped status:enabled
Example: http://192.168.168.148:5287/job_status

Enable job
Purpose: Enables a job – allow it to be ran by machine.
Command: enable_job
Return: "enable_job:ok" or "enable_job:fault"
Example: http://192.168.168.148:5287/enable_job

Load job
Purpose: Loads a specified job.
Command: load_job?JOB_NAME
Return: "job_load:ok" or "job_load:fault"
Example: http://192.168.168.148:5287/load_job?proj2
TE-EN-C-1151-C1 Page 28 of 35 Rev 3/14/18
 ICON INTERFACE SOFTWARE SYSTEM GUIDE

TCP/IP Interface
Available TCP/IP Commands (continued)

Get Axis Coordinate

Purpose: Gets the coordinate of an axis.
Command: axis_coor?axis=AXIS_NUM
Return: axis_coor:AXIS_NUM,COOR (axis_coor:1,32.2) or axis_coor:AXIS_NUM,fault
Example: http://192.168.168.148:5287/axis_coor?axis=1

Get Axis Min/Max

Purpose: Gets the minimum and maximum of an axis.
Command: get_axis?axis=[AXIS_NUM]?value=[MAX/MIN]
Return: get_axis:[AXIS_NUM],[MIN/MAX],[VALUE]
Example: http://192.168.168.148:5287/get_axis?axis=1&value=min

Axis Home
Purpose: Perform homing routine on a specified axis.
Command: axis_home?axis=[AXIS_NUM]
Return: "axis_home:ok", "axis_home:fault"
Example: http://192.168.168.148:5287/get_axis?axis=1&value=min

Stop Axis Movement

Purpose: Stops the movement of an axis.
Command: stop_axis?axis=[AXIS_NUM]
Return: stop_axis:ok
Example: http://192.168.168.148:5287/get_axis?axis=1&value=min

Set an ID
Purpose: Change value of an ID within a loaded template.
Command: set_id?id=[IDNAME]&data=[DATATOSET]
Return: set_id:ok or set_id:fault
Example: http://192.168.168.148:5287/set_id?id=SERIAL&data=0144184A

Name of Loaded Job

Purpose: Get the name of a loaded template(job).
Command: loaded_job
Return: loaded_job:[JOB_NAME]
Example: http://192.168.168.148:5287/loaded_job

Get Preview
Purpose: Get a preview of the currently loaded template.
Command: get_preview
Return: Bytes of a a image/xs-ms-bmp image
Example: http://192.168.168.148:5287/get_preview

TE-EN-C-1151-C1 Page 29 of 35 Rev 3/14/18

 ICON INTERFACE SOFTWARE SYSTEM GUIDE

TCP/IP Interface
Available TCP/IP Commands (continued)

Get Laser Cycle State

Purpose: Get the current state of the machine (whether it is idle or marking).
Command: state
Return: "state:busy" – Marking in progress "state:idle" – Marking not in progress
Example: http://192.168.168.148:5287/state

Turn on Limits
Purpose: Turns on the tracing beam.
Command: limits_on
Return: limits_on:ok
Example: http://192.168.168.148:5287/limits_on

Turn off Limits

Purpose: Turns off the tracing beam.
Command: limits_off
Return: limits_off:ok
Example: http://192.168.168.148:5287/limits_off

Stop Marking Sequence

Purpose: Stop marking or tracing.
Command: stop
Return: stop:ok
Example: http://192.168.168.148:5287/stop

Start Marking Sequence

Purpose: Start laser marking.
Command: start
Return: start:AXIS NOT HOME start:OK start:NO JOB LOADED start:MARK IN PROGRESS start:NOT AUTHORIZED
Example: http://192.168.168.148:5287/start

Get All IDs

Purpose: Retrieves all the Ids available in a loaded template.
Command: all_ids
Return: all_ids:[IDNAME]:[IDVALUE],[IDNAME2]:[IDVALUE2]
Example: http://192.168.168.148:5287/all_ids

TE-EN-C-1151-C1 Page 30 of 35 Rev 3/14/18

 ICON INTERFACE SOFTWARE SYSTEM GUIDE

Python Code Examples

#!/usr/bin/env python
# coding=utf8

import requests
import urllib
from distutils.log import INFO

HOST = http://wv-00003:5287

def get_version():
""" Get the version from the icon interface.
"""

versionUrl = urllib.parse.urljoin(HOST, "version")

r = requests.get(versionUrl)
return r.text

def load_job(whichJob):
""" Load a specified job
"""

jobUrl = urllib.parse.urljoin(HOST, ("load_job?%s" % whichJob))

r = requests.get(jobUrl)

return (r.text == "job_load:ok")

def clear_job():

"""Clears a loaded job

"""

jobClear = urllib.parse.urljoin(HOST, "clear_job")

r = requests.get(jobClear)

return (r.text == "clear:ok")

def isJobLoaded():
"""Checks job status for "loaded"
"""
return requests.get(urllib.parse.urljoin(HOST, "job_status")).text == "job_status:loaded"

def isJobNotLoaded():
"""Checks job status for "not loaded"
"""
return requests.get(urllib.parse.urljoin(HOST, "job_status")).text == "job_status:not_loaded"

def stopAxis(axis):
"""Sends a stop axis command
"""

return requests.get(urllib.parse.urljoin(HOST, "stop_axis?axis=" + axis)).text

if __name__ == "__main__":

print(get_version())

print("> Job Cleared" if clear_job() else "! Job Not Cleared")

print("> Clear Status OK" if not isJobLoaded() else "! Clear status FAULT")
print("> Loaded job" if load_job("proj2") else "! Could not load job")

TE-EN-C-1151-C1 Page 31 of 35 Rev 3/14/18

 ICON INTERFACE SOFTWARE SYSTEM GUIDE

Configuration File
Various expanded functions can be enabled or disabled by editing the XML configuration file (Config.xml).
Configuration file editing should only be carried out by advanced users. Contact Tykma Service before making
edits if you have any questions or uncertain about making changes to this file.

File location: C:\tykma\custom\tykma_icon\config.xml

Several sections in this manual refer to the Config.xml file as well as other configuration files in describing how to
expand the functionality of ICON Interface. Before making changes to any configuration file Tykma TM Electrox
suggests that you backup the original files.

Configuration File Settings

Setting Available Values Effect

PLC_ENABLED True/False Enables PLC functionality. (Allen Bradley)
PLC_IP Valid IP Address The IP Address of the PLC
PLC_MAIN_SCANTIME Integer (ms) How often the PLC high-priority tags will be scanned
PLC_SECOND_SCANTIM E Integer (ms) How often the PLC low-priority tags will be scanned
PLC_CONNECTION_TIM EOUT Integer (ms) How long to attempt a PLC connection before timing
out
PLC_TAG_START Valid Allen Bradley "Start Marking" tag
PLCTAG
(Compact/Control)
PLC_TYPE 0 = ControlLogix, The type of PLC
1 = CompactLogix
DATA_IMPORT_ENABLE D True/False Whether or not flat-file imported is enabled
DATA_IMPORT_SEARCH Valid Path The location of the flat-file "command" file
_FOLDER
DATA_IMPORT_DONE_F OLDER Valid Path Where the completed files will be moved to after
processing
DATA_IMPORT_ERROR_ FOLDER Valid Path Where problematic files will be moved to after
processing
DATA_IMPORT_SEARCH _SPEED Valid Path How often the path will be polled for changes
DATA_IMPORT_SEARCH _WAIT Integer (ms) Delay between finding a file and reading it
DATA_IMPORT_JOB_LO True/False Whether the loaded template will be controlled by a
AD_MODE command file
DATA_IMPORT_CLEAR_ True/False Whether or not the loaded file and template will be
ON_FINISH cleared after one cycle
DATA_IMPORT_CLEAR_ True/False Whether or not all template data will be cleared after
DATA_FINISH one marking cycle
DATA_IMPORT_START_O N_LOAD True/False Start a mark immediately after loading a command
file
DATA_IMPORT_SEARCH True/False Begin searching for a file immediately after loading a
_AFTER_COMPLETE file
IO_EXT_START Integer External Start input
IO_SOFT_READY Integer Software Ready output
IO_EXT_STOP Integer External stop input
IO_SHUTTER_STATE Integer Shutter state input
IO_INVERT Integer Whether or not the I/O is inverted
IO_SCANRATE Integer (ms) Rate at which to poll I/O
IO_ZAXISHOME Integer Z-axis is home input
IO_RAXISHOME Integer R-axis is home input
INSTRUCTIONS_ENABLE True/False Whether or not instructions are enabled
TREE_JOB_LIST True/False Whether or not a tree browser is enabled for the
template list
USE_COUNTER True/False Whether or not the quantity feature is enabled
ALWAYS_ON_LIMITS True/False Limits on immediately after loading a template.

TE-EN-C-1151-C1 Page 32 of 35 Rev 3/14/18

 ICON INTERFACE SOFTWARE SYSTEM GUIDE

Configuration File
Configuration File Settings (continued)

Setting Available Values Effect

HIDE_START_BUTTON True/False Hide start button from operator
HIDE_EDIT_BUTTON True/False Hide edit button from operator
USE_QUEUE True/False Enable/Disable queue functionality
OPERATOR_CAN_LOAD_ JOB True/False Toggle ability of operator to manually
load templates
JOB_TO_LOAD Valid job Internal
ENABLE_LAST_JOB_LOA D True/False Whether to load the last loaded template
on start up
SETTINGS_FOLDER Valid Path Where the icon interface will look for its
settings
SE_INSTALL_DIR Valid Path Where the icon interface will look for
minilase pro installation
PROJECTS_FOLDER Valid Path Where the icon interface will look for
available templates
INSTRUCTIONS_IMAGE_ FOLDER Valid Path If instructions are enabled – path to
images
INSTRUCTIONS_RTF_FO LDER Valid Path If instructions are enabled – path to RTFs
INITIAL_DIMENSIONS_I NSTRUCTIONS Size Internal
HORIZONTAL_SPLITTER _INSTRUCTIONS Size Internal
HIDE_JOB_LIST True/False Show or Hide the template list
SAVE_PROJECT_AFTER_ RUN True/False Save the project after each cycle
NET_ENABLE True/False Enable/Disable the TCP/IP interface
NET_TCP_PORT True/False TCP/IP Interface port
NET_ENABLES_JOB True/False Whether job can only be made valid via
TCP/IP
HOME_ON_OPEN True/False If enabled axis are homed on software
open
Z_AXIS_PRESENT True/False If the Z-Axis is enabled
Z_HOME_FREQUENCY Integer Amount of cycles before axis is re-
homed
Z_OVERTIME Integer (ms) Time before axis homing times out
Z_AXIS_HOME_ON_NEW _JOB True/False If the axis will be homed each time a job
is loaded
Z_AXIS_NUMBER Integer Internal
Z_AXIS_MIN Integer Internal
Z_AXIS_MAX Integer Internal
R_AXIS_PRESENT True/False If the R-Axis is enabled
R_AXIS_NUMBER Integer Internal
R_HOME_FREQUENCY Integer Amount of cycles before axis is re-
homed
R_OVERTIME Integer (ms) Time before axis homing times out
R_AXIS_MIN Integer Internal
R_AXIS_MAX Integer Internal
R_AXIS_PULSE_DIVIDER Integer Internal
USE_SQL_SERVER True/False Whether or not SQL server is enabled

TE-EN-C-1151-C1 Page 33 of 35 Rev 3/14/18

 ICON INTERFACE SOFTWARE SYSTEM GUIDE

Configuration File
Configuration File Settings (continued)

Setting Available Values Effect

SQL_TABLE String Name of Table/View to query
SQL_PRIMARY_FIELD String Primary field within the SQL Table
SQL_JOB_COLUMN String "Template/Job" column within Table
SQL_CONN_STRING Conn string Connection string
USE_NUDGE_FORM True/False Whether or not the nudge form is enabled
NUDGE_DISTANCE Integer Nudge distance
SIMPLE_MARK_MODE True/False Whether or not simple mark mode is enabled
SIMPLE_MARK_FIRSTID PREFSUFF Character Suffix and prefix identifying the first ID
SIMPLE_MARK_STRIP_S UFFIX True/False Whether or not the first ID prefix/suffix will be
stripped
SIMPLE_MARK_FIRSTID String Name of the FIRST ID
SIMPLE_MARK_SECOND ID String Name of the SECOND ID
ENGINE_TYPE Integer Internal
NET_ENGINE_IP IP Internal
NET_ENGINE_PORT IP Internal
NET_ENGINE_POLL_RAT E IP Internal
USE_DYNAMIC_FILE True/False Whether a dynamic graphics file will be polled
DYNAMIC_POLL_RATE Integer (ms) How often to poll for a dynamic graphics file
DYNAMIC_SOURCE_FOL DER Valid path Location of the source file
DYNAMIC_DESTINATION _FILE Valid path Location of the destination file
DYNAMIC_FILE_EXTENS IONS List of extensions Extensions to include in graphics search

TE-EN-C-1151-C1 Page 34 of 35 Rev 3/14/18

 ICON INTERFACE SOFTWARE SYSTEM GUIDE

US Headquarters
370 Gateway Drive
Chillicothe, OH 45601
Phone: +1 (740) 779-9918
Fax: +1 (740) 779-9910
[email protected]

UK Facility
Avenue One, The Business Park
Letchworth Garden City, Hertfordshire SG6 3TA
United Kingdom
Tel: +44 (0)1462 472400

TE-EN-C-1151-C1 Page 35 of 35 Rev 3/14/18