Operator Guide - SlideMate AS - Gateway Manual
Operator Guide - SlideMate AS - Gateway Manual
SlideMate AS Gateway
Operator Guide
Operator Guide
A839xxxxx Issue 1
2
Company Information
Copyright 2017. Pyramid Innovation Ltd. All rights reserved.
Pyramid Innovation Ltd is an ISO 9001:2008 Accredited Company. These instruments conform to the essential
Pyramid Innovation Ltd is the trading name of Pyramid Innovation requirements of:
Ltd. Low Voltage Directive 2006/95/EC
All other trademarks are the property of Pyramid Innovation Ltd and
its subsidiaries . EMC Directive 2004/108/EC
Pyramid Innovation Ltd makes every endeavour to ensure that the RoHS Directive 2011/65/EU
information contained in its support documentation is correct and
clearly stated but does not accept responsibility for any errors or Symbols
omissions. The development of Pyramid Innovation Ltd products and
services is continuous. Make sure that any published information that The following symbols and conventions may be
you use for reference is up to date and relates to the status of the used throughout this document and on the
product. If necessary, check with Pyramid Innovation Ltd or your local instrument:
Pyramid Innovation Ltd representative.
Contact address
3
Table of Contents
COMPANY INFORMATION .................................................................................................................... 3
SYMBOLS ........................................................................................................................................................ 3
CONTACT ADDRESS ........................................................................................................................................... 3
TABLE OF CONTENTS ............................................................................................................................ 4
SAFETY INFORMATION ......................................................................................................................... 5
INTRODUCTION ................................................................................................................................................ 5
GENERAL SAFETY .............................................................................................................................................. 5
INTENDED USE ................................................................................................................................................. 5
Requirements: .......................................................................................................................................... 5
SOFTWARE LICENCE AGREEMENT ........................................................................................................................ 6
HOW TO USE THIS GUIDE ..................................................................................................................... 8
INTRODUCTION ................................................................................................................................................ 8
INSTALLING THE SOFTWARE................................................................................................................................ 8
Getting started ......................................................................................................................................... 8
Configuration............................................................................................................................................ 8
Pyramid Single Gateway .......................................................................................................................... 8
Pyramid Multi Gateway ........................................................................................................................... 9
CHAPTER 1 – INSTALLING THE SOFTWARE ........................................................................................... 10
CHAPTER 2 – GETTING STARTED ......................................................................................................... 12
RUNNING THE GATEWAY FOR THE FIRST TIME ...................................................................................................... 12
CHAPTER 3 – GATEWAY OPERATION ................................................................................................... 14
SETTINGS MENU ............................................................................................................................................ 15
GENERAL TAB ................................................................................................................................................ 16
DEVICE TAB ................................................................................................................................................... 18
ADDING DEVICES ............................................................................................................................................ 19
Make Connection using Ethernet or Wi-Fi.............................................................................................. 20
Connection using Ethernet or Wi-Fi........................................................................................................ 21
Setting the Parameters .......................................................................................................................... 22
Connection using USB............................................................................................................................. 23
Setting the Parameters .......................................................................................................................... 24
Sending Text Files to the Printer ............................................................................................................. 25
Device Data Translator ........................................................................................................................... 25
Start Cache Monitoring .......................................................................................................................... 25
Cache Sub Folders................................................................................................................................... 26
Device Image Display ............................................................................................................................. 26
General Tab ............................................................................................................................................ 27
Laser Mode ............................................................................................................................................. 28
INDEX ................................................................................................................................................ 30
4
Safety Information
Introduction
Pyramid Innovation Ltd products are designed for convenient and reliable service; however, incorrect actions by a
user may damage the equipment, or cause a hazard to health.
The following sections contain important information for the safe setup and use of the instrument.
The following sections contain important information for the safe setup and use of the instrument,
and should be read and understood by the user before using the instrument.
General Safety
It is the users responsibility to ensure the integrity and validity of the data used, loaded or entered to the software.
All users must have read and understood the Operator Guide and these safety
instructions; and only operate the unit in accordance with the instructions.
It is important that normal standards of safety and good laboratory practices are
employed. Always use common sense when operating the software.
Any problems and queries should be referred to your Pyramid Innovation Ltd supplier
Intended Use
The software is intended for use in laboratories by operator’s familiar with labelling techniques and laboratory
equipment. The software should be operated with the environmental limits stated in the specification within this
document.
Requirements:
PC with one of the following operating systems
5
Software Licence Agreement
1. This is an agreement between Pyramid Innovation Ltd (Licensor) and Licensee, who is being licensed to use
the named Software.
2. Licensee acknowledges that this is only a limited non-exclusive license. Licensor is and remains the owner
of all titles, rights, and interests in the Soft-ware.
3. This License permits the Licensee to install the Software on more than one computer system, as long as
the Software will not be used on more than one computer system simultaneously. Licensee will not make
copies of the Software or allow copies of the Software to be made by others, unless authorized by this
License Agreement. Licensee may make copies of the Software for backup purposes only.
4. This Software is subject to a limited warranty. Licensor warrants to Licensee that the physical medium on
which this Software is distributed is free from defects in materials and workmanship under normal use, the
Software will perform according to its printed documentation, and to the best of Licensor's knowledge
Licensee's use of this Software according to the printed documentation is not an infringement of any third
party's intellectual property rights. This limited warranty lasts for a period of 365 days after delivery. To
the extent permitted by law, THE ABOVE-STATED LIMITED WARRANTY REPLACES ALL OTHER
WARRANTIES, EXPRESS OR IMPLIED, AND LICENSOR DISCLAIMS ALL IMPLIED WARRANTIES
INCLUDING ANY IMPLIED WARRANTY OF TITLE, MER-CHANTABILITY, NON-INFRINGEMENT, OR OF
FITNESS FOR A PARTICULAR PURPOSE. No agent of Licensor is authorized to make any other warranties
or to modify this limited warranty. Any action for breach of this limited warranty must be commenced
within one year of the expiration of the warranty. Because some jurisdictions do not allow any limit on the
length of an implied warranty, the above limitation may not apply to this Licensee. If the law does not
allow disclaimer of implied warranties, then any implied warranty is limited to 365 days after delivery of
the Software to Licensee. Licensee has specific legal rights pursuant to this warranty and, depending on
Licensee's jurisdiction, may have additional rights.
5. In case of a breach of the Limited Warranty, Licensee's exclusive remedy is as follows: Licensee will return
all copies of the Software to Licensor, at Licensee's cost, along with proof of purchase. (Licensee can obtain
a step-by-step explanation of this procedure, including a return authorization code, by contacting Licensor
at [address and toll free telephone number].) At Licensor's option, Licensor will either send Licensee a
replacement copy of the Software, at Licensor's expense, or issue a full refund.
6. Notwithstanding the foregoing, LICENSOR IS NOT LIABLE TO LICENSEE FOR ANY DAMAGES,
INCLUDING COMPENSATORY, SPECIAL, INCIDENTAL, EXEM-PLARY, PUNITIVE, OR CONSEQUENTIAL
DAMAGES, CONNECTED WITH OR RESULTING FROM THIS LICENSE AGREEMENT OR LICENSEE'S USE
OF THIS SOFT-WARE. Licensee's jurisdiction may not allow such a limitation of damages, so this limitation
may not apply.
7. Licensee agrees to defend and indemnify Licensor and hold Licensor harmless from all claims, losses,
damages, complaints, or expenses connected with or resulting from Licensee's business operations.
8. Licensor has the right to terminate this License Agreement and Licensee's right to use this Software upon
any material breach by Licensee.
9. Licensee agrees to return to Licensor or to destroy all copies of the Software upon termination of the
License.
10. This License Agreement is the entire and exclusive agreement between Licensor and Licensee regarding this
Software. This License Agreement replaces and supersedes all prior negotiations, dealings, and agreements
between Licensor and Licensee regarding this Software.
6
11. This License Agreement is governed by the law of [State] applicable to [State] contracts.
12. This License Agreement is valid without Licensor's signature. It becomes effective upon the earlier of
Licensee's signature or Licensee's use of the Soft-ware.
7
How to Use This Guide
Introduction
The Gateway is designed to interface Pi devices with third party computer systems.
It is the users responsibility to ensure the validity and accuracy of data used, entered, passed or
loaded into the software.
Getting started
This takes you through the operation of the software.
Configuration
This takes you through the various settings and configuration options.
The Gateway software is used to move data from external software programs, including LIS systems which use text
file format to the printer(s) that will be used by the printer to create label images. The software also manages other
aspects of the printer settings, but is primarily used to transfer these files. To use the Gateway software will require
a PC and a connection to the printer. The connection can be USB, Ethernet or Wi-Fi. Wi-Fi requires the use of a
Wi-Fi router in or-der to make the connection possible.
There are two versions of Gateway, a single version and a multi version. The single version allows connection of a
single printer at any one time. The multi version allows connection to a maximum of ten (10) printers.
Two Gateway software products are available to use with SlideMate AS. Depending on local requirements one may
be more useful than the second. The Gateway software is not provided with the slide printer and may be an
additional purchase from your slide printer supplier. The software package includes a memory stick with the
installation files, a PDF of the operator guide and a license key used to install and configure the Gateway software.
8
Pyramid Multi Gateway
The Pyramid Multi Gateway is used to control the slide printer and transfer special text files from LIS and other
systems to the printer. These files may be used for printing individual or multiple slide labels. The Pyramid Multi
Gateway can control up to ten SlideMate AS On-Demand printers simultaneously.
9
Chapter 1 – Installing the Software
1. To install the Gateway you need to run Setup for the appropriate program. The installation process may
vary depending on the specific operating system employed on the PC.
The Multi Gateway installation is shown in this example, the Single Gateway process is identical.
2. Select Next
3. Select Install
4. Select Yes
10
5. Select Finish
11
Chapter 2 – Getting Started
Running the Gateway for the first time
Double click on the Gateway icon on your desktop
3. Press OK
12
6. To activate this program, please contact your
software supplier for a code or go to
http://primary.copyminder.com/activate.php or
http://secondary.copyminder.com/activate.php.
You will need the following details to do this:
13
Chapter 3 – Gateway Operation
The Title Bar at the top of the Gateway displays the name of the Gateway, the software Version and may contain
the Date code associated with this version.
Depending on the version installed, some of the following icons could be displayed:
This button opens the Settings menu—this is used to customize Gateway and configure or modify
devices
This button signifies that the Gateway is unlocked and is only displayed on the Single Gateway, it
allows the lock function limiting discovery and connection to a single slide printer. Once connection
to a single slide printer is established, this button can be pressed to lock Gateway.
This button signifies that the Gateway is locked, to unlock the Gateway, press this button.
14
Settings Menu
Pressing the Settings button will display the settings menu. This menu has two screens, the first is the General Tab
which is the configuration section for The Gateway software. The second is the Devices Tab which is used to
configure new devices or modify existing devices. The settings menu will open to the General Tab.
15
General Tab
The General Tab is divided into sections which have settings that can be adjusted. These settings should only be
adjusted by a trained user who understands how the change might affect the software. For some of the
adjustments, guidance is given in the section description.
Cache Directories
This sets the frequency to which the Gateway software checks the Cache
Check Frequency (ms) folder for new label records. Setting this too low, may cause the Gateway to
run slow, a setting lower than 100 is not recommended.
Communications
This sets the frequency to which the Gateway software pings the printer
connections to see that they remain active and on-line. Setting this too low,
Ping Frequency (ms)
may cause the Gateway to run slow, a setting of no lower than 1000 is
recommended.
16
Device Screen
Setting this to True displays the printer screen within the Gateway software
on the Home screen only. This is not intended to be left on continuously, but
Show
used when necessary as the use of this display will affect the computer and
Gateway software operation speed.
Setting this to False turns off the display of the printer screen within the
Gateway software.
Size
This sets the resolution size from small to medium to large display. Smallest
is recommended as the larger sizes may cause the PC and Gateway to run
slow.
This sets the refresh frequency. This is how often the display is refreshed
Update Frequency
within Gateway.
Is used to set up slide printers to replace the Laser MicroWriter. Files sent to a
Laser Mode cache director for the laser can be separated and sent to individual slide
printers.
The colours can be changed to suit the user, these are the background colours
Status background colours
that identify when the printer is connected, in Error or Not Connected
The colours can be changed to suit the user, these are the foreground colours
Status foreground colours
that identify when the printer is connected, in Error or Not Connected
17
Device Tab
To display the list if devices, press the device tab button. The devices menu will be displayed. The devices that are
connected will be shown within the left panel and the information about each device can be displayed within the
right panel by selecting one of the three tabs.
Parameters tab
The Parameters Tab will display setup and configuration information assigned to selected devices. To show
the parameters, you must select the device, then press the Parameters Tab.
The Local View Tab displays folders that are located within the PC but are associated with the Gateway
software, such as Cache folder, Software updates, data folders and image captures.
The Remote View Tab displays information held within the printer, these are Versions, Database, Fonts,
Images, Sounds and XML, these can be viewed and edited remotely. To make changes to these items, they
must be selected, modified, then saved to the device. In many cases, the save to the device is automatic.
Button Functions
Used to close the settings menu and display the Home Screen
18
Adding Devices
Before adding devices to the Gateway software, you must first determine which connection method will be used.
The Gate-way can communicate with printers using USB, Ethernet or Wi-Fi.
USB—to connect using USB, you will need to connect the printer to the computer using a standard
printer USB cable. Attach the square end of the USB cable to the top port on rear of the printer. Connect
the other end of the cable to the PC using any available USB port. You will need to check the Device
Manager menu on the PC to determine which Com Port the printer has been assigned.
Ethernet—to connect using Ethernet cable, you will need a standard Ethernet cable and an available
network. This may be a router or server but must be connected and have an IP Address assigned by the
network.
Wi-Fi—to connect using Wi-Fi, you will need a Wireless router. The PC and Printer will need to be
connected to the router and each have an IP Address assigned by the network.
Once the Gateway window is open it will start looking for a Printer to connect to. If the printer is connected via
Ethernet or Wi-Fi, the connection will automatically happen. If the printer is connected via USB, the connection will
need to be made through a manual setup.
19
Make Connection using Ethernet or Wi-Fi
Connect the Printer to your network using the appropriate cable. Check your router uses DHCP to allocate IP
addresses. You may need to set your firewall to enable the application to link to the IP address.
Turn on the printer and wait for the main user screen to display.
20
Connection using Ethernet or Wi-Fi
The status bar at the bottom of the screen shows the connection status. On start-up the gateway will search for a
Printer.
The Gateway will automatically connect to a Printer that has been connected using a network connection. The
status bar will show Connected once connection is established.
Connection problems
If the Gateway does not connect and display the printer check:
If no IP address is displayed and there is a Tick in the Connect to Gateway tick box turn the device off and
then back on. If there is still no IP address shown check the cable is properly installed and check your
router uses DHCP to allocate IP addresses. You may need to contact your network administrator for
assistance.
Check the PC firewall settings to ensure the Gateway application has the correct permissions. You may
need to contact your network administrator for assistance.
21
Setting the Parameters
1. Press the Gateway settings button.
22
Connection using USB
The status bar at the bottom of the screen shows the connection status. On start-up the gateway will search for
a Printer.
The Gateway will not automatically connect to a Printer that has been connected using a USB connection. The
status bar will show Connected once connection is established.
23
Setting the Parameters
1. Press the Gateway settings button.
24
Sending Text Files to the Printer
The Gateway is designed to monitor a cache folder for incoming text files.
The text files can contain one or more records. The format of the text file record must be consistent.
The text file record can be delimited or un-delimited. If un-delimited the character length of the data elements
should be fixed length.
Each line is treated as an individual record that will be sent to the printer.
Example:
A text file with twelve slide records with delimiters -
the Gate-way creates 12 individual records which are
then sent to the connected device.
25
Cache Sub Folders
The Gateway will add two sub folders to the cache folder.
Error Folder
Any records that are rejected by the printer will be put into the Error folder.
Sync Folder
The Gateway processes all files as they are found in the cache folder dividing them up into individual records. The
individual records are moved into the Sync folder ready to be sent to the printer.
If you have more than one printer connected, the printer displayed can be changed by pressing the appropriate
printer in the bottom panel.
The display is touch sensitive; by pressing the buttons on the display, the same button will be activated on the
printer.
26
General Tab
General Tab Settings can be modified but care must be taken to avoid slowing down or causing problems with
some of the features. The Cache directory setting can be reduced to speed the import of records into the slide
printer, however the setting should not be reduced below 100.
The slide printer display screen is able to be shown within the Gateway window. This tool is intended to be used
for short periods of time as a troubleshooting aide and is not recommended to be active continually.
To view the device screen, connect a printer as usual, then select Show = True under the device screen header on
the General tab.
27
Laser Mode
The Gateway can receive and use files originally set up for the Thermo Laser MicroWriter. These files have special
configuration to select up to six dispense hoppers all within a single Cache folder. The Gateway Laser mode imports
these files and separates individual records and sends the print job to individual slide printers based on the hopper
command.
In this example the H? commands are sent to the cache folder along with the data to be printed. The H? code
defines the hopper to be used. In Laser Mode, the H? code will be used to direct the files to individual printers. If
six hoppers were used on the Laser MicroWriter, six printers would be required to replicate the six hoppers.
c) Delimited or Fixed
d) For Delimited, you will need to set the delimiters and Item Index. The item index is the item position once
delimited. This starts with 0 being the position before the first delimiting character, 1 the position after the
first delimiting character …...
e) For Fixed, you will need to set the Item Length and the Start Character Index
28
On the Device Tab
a) Set the path, this should point to the Cache folder for the device. The device folders are located in the
Gateway folder using the following Path:
C:\ProgramData\Pyramid Innovation\Gateway\Devices
e) Set the Hopper token, in this case it will be the Hopper Command. For the first printer it will be H1,
second printer H2…
Set up each of the six printers using this same method, when all six have been completed, Laser Mode is ready to
use.
29
Index
Installing the Software ..................................................... 8
Introduction ..................................................................... 8
A
Adding Devices I
Make Connection using Ethernet................................... 20
Make Connection using Wi-Fi ........................................ 20 Installing the Software
Configuration ................................................................... 8
Getting started ................................................................ 8
C Pyramid Multi Gateway ................................................... 9
Pyramid Single Gateway .................................................. 8
Cache Sub Folders .............................................................. 26 Installing the Software ....................................................... 10
Company Information .......................................................... 3
Connection using Ethernet or Wi-Fi ................................... 21
Connection using USB ........................................................ 23 L
Contact address.................................................................... 3
Laser Mode ........................................................................ 28
D
R
Device Data Translator ....................................................... 25
Device Image Display.......................................................... 26 Requirements....................................................................... 5
G S
30
31
32