API Mode Reference-Guide

Evolis SDK
API MODE REFERENCE GUIDE

(Evolis Services Provider and Evolis Services provider 2)
Contents
Evolis Services Provider Framework Concept ................................................................................... 4
Overview of the services.................................................................................................................................. 4
Quick Description of the services .............................................................................................................. 5
Request model....................................................................................................................................................... 5
Services – Technical description................................................................................................................. 8
CMD SERVICE.................................................................................................................................................... 8
CMD.SendCommand ............................................................................................................................... 8
CMD.GetStatus ........................................................................................................................................... 10
CMD.ResetCom ...........................................................................................................................................11
PRINT SERVICE ................................................................................................................................................12
PRINT.Begin ..................................................................................................................................................13
PRINT.Set ....................................................................................................................................................... 14
PRINT.SetBitmap ...................................................................................................................................... 16
PRINT.Print ................................................................................................................................................... 17
PRINT.GetJobID ......................................................................................................................................... 18
PRINT.End ..................................................................................................................................................... 19
SETTING SERVICE ........................................................................................................................................ 20
SETTING.Begin ............................................................................................................................................21
SETTINGS.Import ......................................................................................................................................22
SETTING.Get .................................................................................................................................................23
SETTING.Set................................................................................................................................................. 24
Evolis Premium Suite 2 :Evosettings to manage printer's settings......................... 24
SETTING.Export ......................................................................................................................................... 26
SETTING.End ................................................................................................................................................27
SUPERVISION SERVICE............................................................................................................................ 28
SUPERVISION.List ................................................................................................................................... 28
Supervision.AddDevice ........................................................................................................................ 30
SUPERVISION.RemoveDevice ......................................................................................................... 30
SUPERVISION.GetState .........................................................................................................................31
SUPERVISION.GetEvent .......................................................................................................................32
SUPERVISION.SetEvent ........................................................................................................................ 33
ECHO SERVICE .............................................................................................................................................. 34
ECHO.Echo .................................................................................................................................................. 34
ADD-ON SERVICE .........................................................................................................................................35
2
ADDON.Launch .........................................................................................................................................35
ESPF SERVICE ................................................................................................................................................ 36
ESPF.GetParam ........................................................................................................................................ 36
ESPF.SetParam ..........................................................................................................................................37
SCANNER SERVICE ..................................................................................................................................... 38
SCAN.Version.............................................................................................................................................. 38
SCAN.Acquire ............................................................................................................................................. 39
SCAN.GetSession ...................................................................................................................................... 41
SCAN.Begin ................................................................................................................................................. 42
SCAN.End ..................................................................................................................................................... 43
SCAN.GetImages ..................................................................................................................................... 44
SCAN.SendCommand .......................................................................................................................... 45
APPENDIX ............................................................................................................................................................. 47
ESPF SERVER CONFIGURATION ........................................................................................................ 47
Configuration file available settings: ............................................................................................ 48
RETURNED ERRORS .................................................................................................................................. 50
Major state.....................................................................................................................................................55
Minor state ....................................................................................................................................................55
Disclaimer.............................................................................................................................................................. 60
3
Evolis Services Provider Framework Concept
The Evolis Services Provider Framework and Evolis Services Provider Framework 2
(based on Evolis Premium Suite 2) is a server and the gateway to the Evolis Suite
(Evolis, Edikio, Badgy Premium Suite) features (supervision or standard mode)
using requests.
All communications leverage IPC standard protocols (Socket or Named Pipe).
The request process is based on the JSON-RPC protocol, which eases the
enablement of clients as described in the next sections.
Overview of the services

The Evolis Services Provider (API mode) is currently composed of 7 services,
described in the schematic below:
• For each service, features could be accessed by calling a set of methods.

• Selected services require implementation of a specific call sequence.
4
Quick Description of the services
SERVICE NAME PURPOSE
CMD Bi-directional communication with the printer
Print Direct Printing of a card
Setting Printer configuration
Supervision Printer’s status management
Echo Test service
ESPF Server configuration
ADD-ON Management of ADD-ON execution

Ex : a third-party software for smart encoding
Request model
The request model used between the clients and the ESPF service leverages JSON-
RPC v2.0, a light-weight and stateless RPC (Remote Procedure Call) protocol using
the JSON format.
Notification and Batch concepts of JSON-RPC v2.0 are not supported for the ESPF.
The protocol is used in compliance with the following specifications:
• The params member is an object which member names matching the

parameters expected by the server. Any value is a String.
• The id member is a String. For a response to a processed request, but
with an unknown id, the id value is considered as Null.
• The result member is a String
• The data member is not considered
For Primacy 2 available settings, please refer to this section
5
Pay attention than the application software development made with Premium
SDK are fully compliant with Primacy 2 model but could require modifications in
case of new Primacy2 features (scan, rewrite…).
To send a request, client (software) sends a Requests object and receives a reply
from the server in the form of a Response object
REQUEST OBJECT
{
"id": "1",
"jsonrpc": "2.0",
"method": "CMD.SendCommand",
"params": {
"command": "Rfv",
"timeout": "5000",
"device": "Evolis Primacy"
}
}
RESPONSE OBJECT
{
"id": "1",
"jsonrpc": "2.0",
"result": "1943"
}
The general syntax to call a method in a JSON request is "SERVICE" Method"

(method uses CamelCase), for example CMD.SendCommand (Use the Send
Command method of the CMD service).
6
This implementation, at the communication protocol level, must be carried out as
shown below:
(1)
(2)
(3)
(1) During the connection, the IP address, server port, or Named pipe are
identified according to the IPC communication protocol used.
(2) Request is sent through a call on a full buffer(no data sent while buffer is
sliced)
(3) Response to the request is expected to b a single reply
If an unexpected error happens on the server while communicating with a

connected client, server will shut down communication channel with this client. If
a client disconnects from the server, it will stop any in progress process.
When sending a request, if the reception of the request takes longer that a
configurable timeout (3,000 ms by default), the server will shut the communication
channel with the client (support for « half-open connections » issues).
7
Services – Technical description
CMD SERVICE
• Sends commands in text or binary format
• Receives statuses in binary format
• Reset communication
CMD.SendCommand Send commands in text or binary format

Command Text or binary command
timeout Timeout in milliseconds
device Device name
result Answer to the sent command
error Not acknowleged
REQUEST OBJECT
{
"id": "1",
"jsonrpc": "2.0",
"params": {
"command": "Rfv",
"timeout": "5000",
}
}
RESPONSE OBJECT
{
"id": "1",
"jsonrpc": "2.0",
"result": "1943"
}
8
To send a binary command, data must be base64-encoded. The command
parameter is made up of the encoded data complemented by the "base64:" prefix
e.g., a base64-encoded Rfv command:
REQUEST OBJECT
{
{
"id": "1",
"jsonrpc": "2.0",
"params": {
"device": "Evolis Primacy",
"command": "base64:G1Jmdg0=",
"timeout": "3000"
}
}
}
RESPONSE OBJECT
{
"id": "1",
"jsonrpc": "2.0",
"result": "1943"
}
If the response timeout is exceeded, the returned response will be an error with
related error code.
If the timeout setting is not indicated, default value will be affected. This value is
3000 ms for the service. This parameter is not effective for a networked printer
(Ethernet or WIFI).
9
CMD.GetStatus Retrieve
Retrievethe
the binary statusofofa adevice
binary status device
device Device name
Result Binary status of the device
error Error code
REQUEST OBJECT
{
"id": "1",
"jsonrpc": "2.0",
"method": "CMD.GetStatus",
"params": {
}
}
RESPONSE OBJECT
{
"id": "1",
"jsonrpc": "2.0",
"result": "88D02420204000000000000000000000800C2000000000000000000000000000:32005 "
}
This method can be called even if the printer is printing a job or processing a
command.
10
CMD.ResetCom Reset communication with a device
Timeout Timeout in milliseconds
Device Device name
Result Ok if successful
Error Error code
REQUEST OBJECT
{
"id": "1",
"jsonrpc": "2.0", "method":
"CMD.ResetCom", "params":
{
"timeout": "30000",
}
}
RESPONSE OBJECT
{
"id": "1",
"jsonrpc": "2.0",
"result": "OK"
}
When response timeout is exceeded, returned response will be an error with related
error code.
If the time out setting is not indicated, a default value will be provided. This value is
of 3000 ms for the service. This parameter is not considered when the device is
networked.
11
PRINT SERVICE
Prints a card, whatever the printing system

Configure the printings jobs
12
PRINT.Begin Initiates the printing session
Device device name
Session optional : to set in case the automatic job
ID is not adapted to your use-case
Result Job ID is successful
Error Error code in case of fail
REQUEST OBJECT
{
"id": "1",
"jsonrpc": "2.0",
"method": "PRINT.Begin",
"params": {
}
}
RESPONSE OBJECT
{
"id": "1",
"jsonrpc": "2.0", "result":
"JOB000002"
}
REQUEST OBJECT
{
"id": "1",
"jsonrpc": "2.0",
"method": "PRINT.Begin",
"params": {
"device": "Evolis Primacy",
"session": "CUSTOMJOBID"
}
}
RESPONSE OBJECT
{
"id": "1",
"CUSTOMJOBID"
}
13
Printing session: a timeframe during which a printer is assigned to one or several
printing jobs specified in the following format if generated automatically:
JOBXXXXXX.
The job ID is not unique and is referenced in the printing logs.
The service can manage only one printing session (job) at a time per printer
instance.
PRINT.Set Set the printing parameters

session JOB ID
data printing parameters in the following format :
key1=value1; …; keyN=valueN
result OK is successful
error error code and related message
REQUEST OBJECT
{
"id": "1",
"jsonrpc": "2.0",
"method": "PRINT.Set",
"params": {
"session": "JOB000002",
"data": "FColorBrightness=VAL12;GRibbonType=RC_YMCKO"
}
}
RESPONSE OBJECT
{
"id": "1",
"jsonrpc": "2.0",
"result": "OK"
}
The settings.xml file describes all printing parameters and their possible values for
eachprinter model. This file is available from:
%EPS_DIR%\Evolis Premium Suite\Model\{printer model}
%EPS_DIR% is either the installation directory for the suite or an environment

variable.To read the XML file, open it with an appropriate Web browser.
For Evolis Premium Suite 2, please refer to next page.
14
PRIMACY 2 : Available settings for Evolis Premium Suite release
above to version 7.0.0.0
To get the available settings and their possible values with newest Evolis Premium
Suite, use the following command line :
evosettings.exe -p "Evolis Primacy 2" -lk
or
evosettings.exe -p "Evolis Primacy 2" --list-key
Replace "Evolis Primacy 2" by the correct name as in printer and devices.
The evosettings utility is in "...\"Installation Directory selected during

setup"\Evolis Card Printer 2\Evolis Premium Suite 2\tools"
Below a sample screenshot :
Evosettings utility has different options that are described when you run the
command.
15
PRINT.SetBitmap Defines the graphics data to be printed
Session JOB ID
Face front or back
Panel color, resin or varnish
Data Image data (bitmap) encoded in base64
Result OK
Error error code and related message
REQUEST OBJECT
{
"id": "1",
"jsonrpc": "2.0",
"method": "PRINT.SetBitmap",
"params": {
"session": "JOB000002",
"face": "front",
"panel": "color",
"data": "base64:Qk12Ix4AAAAAADYAAAAo...
}
}
RESPONSE OBJECT
{
"id": "1",
"jsonrpc": "2.0",
"result": "OK"
}
Method will be called only once per card side and panel type. Color panel type
includes graphical data required for the three YMC panels.
If the method is called twice or three times for a side, color panel will be the primary
source, while the black, and/or overlay panel will be set as optional.
For the YMCKOO ribbon (available only for Evolis Primacy 2 printer), set the panel
property to varnish to use the second overlay.
Options are then :

- FOverlaySecondManagement (for the Front of the card)
- BOverlaySecondManagement (for the Back of the card)
With the following possibilities :

- NOVARNISH
- FULLVARNISH
- BMPVARNISH
In case BMPVARNISH is set, then a PRINT.SetBitmap is required to configure the

used bitmap (2 level monochrome bitmap).
16
PRINT.Print Run a print job
Session JOB ID
Result OK if successful
REQUEST OBJECT
{
"id": "1",
"jsonrpc": "2.0",
"method": "PRINT.Print",
"params": {
"session": "JOB000002"
}
}
RESPONSE OBJECT
{
"id": "1",
"jsonrpc": "2.0",
"result": "OK"
}
The printing traffic is monitored during the printing job. Feature is always enabled
and not configurable.
When calling the PRINT method, the GetEvent method from the SUPERVISION
service must be polled on a regular basis. If an event is identified, an action must be
taken so that the print job can be finalized.
17
PRINT.GetJobID Get current printing session JOB ID
device device name
Result current JOB ID if successful
REQUEST OBJECT
{
"id": "1",
"jsonrpc": "2.0",
"method": "PRINT.GetJobID",
"params": {
}
}
RESPONSE OBJECT
{
"id": "1",
"JOB000002"
}
18
PRINT.End Close a print session Additional information
Session JOB ID to set only if you want to close

the printing session by Job ID
Device device name to set only if you want to close the
printing session by device name
Result OK if successful N/A
Error error code and related message N/A
REQUEST OBJECT
{
"id": "1",
"jsonrpc": "2.0",
"method": "PRINT.End",
"params": {
"session": "JOB000002"
}
}
RESPONSE OBJECT
{
"id": "1",
"jsonrpc": "2.0",
"result": "OK"
}
REQUEST OBJECT
{
"id": "1",
"jsonrpc": "2.0",
"method": "PRINT.End",
"params": {
}
}
RESPONSE OBJECT
{
"id": "1",
"jsonrpc": "2.0",
"result": "OK"
}
19
SETTING SERVICE
Loads printing parameters

Reads the loaded parameters
Edits the loaded parameters
Exports the printing parameters
20
SETTING.Begin Start a configuration session
device device name
REQUEST OBJECT
{
"id": "1",
"jsonrpc": "2.0",
"method": "SETTING.Begin",
"params": {
}
}
RESPONSE OBJECT
{
"id": "1",
"SET000001"
}
21
SETTINGS.Import Import parameters
Session Session ID
Format printer
Data Base64 encoded data (for XML format)
REQUEST OBJECT
{
"id": "1",
"jsonrpc": "2.0",
"method": "SETTING.Import",
"params": {
"session": "SET000001",
"format": "printer"
}
}
RESPONSE OBJECT
{
"id": "1",
"jsonrpc": "2.0",
"result": "OK"
}
With this method, parameters can be imported via the active session, and in a
non-persistent way (until the end of the configuration session). For further use,
use the demo program in the API mode folder.
22
SETTING.Get Gets the value of a parameter
Session Session ID
Data key parameter ID
Result Parameter value
REQUEST OBJECT
{
"id": "1",
"jsonrpc": "2.0",
"method": "SETTING.Get",
"parameters": {
"data": "FColorContrast"
}
}
RESPONSE OBJECT
{
"id": "1",
"jsonrpc": "2.0",
"result": "15"
}
23
SETTING.Set Sets the value of a parameter
Session Session ID
Data Key=value ID of parameter with new value
REQUEST OBJECT
{
"id": "1",
"jsonrpc": "2.0",
"method": "SETTING.Set",
"parameters": {
"data": "FColorContrast=18"
}
}
RESPONSE OBJECT
{
"id": "1",
"jsonrpc": "2.0",
"result": "OK"
}
The settings.xml file describes all printing parameters and their possible values
for eachprinter model. This file is available from:
%EPS_DIR%\Evolis Premium Suite\Model\{printer model}
%EPS_DIR% is either the installation directory for the suite or an environment

variable.
To read the XML file, open it with an appropriate Web browser.
Evolis Premium Suite 2 :Evosettings to manage printer's settings

Primacy 2 works with the new Evolis Premium Suite 2 (release superior to 7.0.0.0)
To get the available settings for Primacy 2, pay attention to use the new evosettings.exe
tool (settings is no more available via the xml file).
This tool is available here (default installation path ) once you have installed Evolis Premium
Suite 2 :
C:\Program Files\Evolis Card Printer 2\Evolis Premium Suite 2\tools\evosettings.exe
The full help/manual of the evosettings utility is available by invoking - - help argument, see
below :
24
Get the current settings for a Primacy 2 thanks to evosettings
Use the following command to get the current setting for a printer:
evosettings -p "Evolis Primacy 2" -l

or
evosettings -p "Evolis Primacy 2" --list
Get all available settings for a Primacy 2 thanks to evosettings
To get all available settings and their possible values for a printer, please use following
command :
Evosettings.exe -p "Evolis Primacy 2" --list-key
25
SETTING.Export Exports parameters
Session Session ID
Format From printer to device
text in text format
xml to a data file (.dat) for the device
Result if format=printer OK if successful

if format=text list of parameters in the following format :
key=value if format=xml export of base64-encoded
configuration file
REQUEST OBJECT
{
"id": "1",
"jsonrpc": "2.0",
"method": "SETTING.Export",
"params": {
"format": "text"
}
}
RESPONSE OBJECT
{
"id": "1",
"jsonrpc": "2.0",
"result": "BBlackManagement=ALLBLACKPOINT; BColorBrightness=VAL10; BColorContrast
=VAL10; BHalftoning=THRESHOLD; BMonochromeContrast=VAL10; BOverlayContrast=VAL10;
BOverlayManagement=FULLVARNISH; BPageRotate180=OFF;
FBlackManagement=ALLBLACKPOINT; FColorBrightness=VAL10; FColorContrast=VAL13;
FHalftoning=THRESHOLD; FMonochromeContrast=VAL10; FOverlayContrast=VAL10;
FOverlayManagement=FULLVARNISH"
}
26
SETTING.End Ends the session
Session Session ID
REQUEST OBJECT
{
"id": "1",
"jsonrpc": "2.0",
"method": "SETTING.End",
"params": {
"session": "SET000001"
}
}
RESPONSE OBJECT
{
"id": "1",
"jsonrpc": "2.0",
"result": "OK"
}
27
SUPERVISION SERVICE
Lists the subscribed devices and their state

Subscribe/unsubscribe a device to a service, with state notification
SUPERVISION.List List all subscribed devices
Level List of Stateless device(s)
List of device(s) with major state
List of device(s) with a major or a minor state
Result printername (if level=0) printername,majorstate(if level=1)
printername,majorstate,minorstate(if level=2)
REQUEST OBJECT
{
"id": "1",
"jsonrpc": "2.0",
"method": "SUPERVISION.List",
"params": {
"level": "2",
}
}
RESPONSE OBJECT
{
"id": "1",
"jsonrpc": "2.0",
"result": "Primacy,READY,PRINTER_READY"
}
If several printers are "subscribed", response to the request will have the following
format, respectively for level=2, level=1 and level=0.
RESPONSE OBJECT
{
"id": "1",
"jsonrpc": "2.0",
"result": " Primacy,READY,PRINTER_READY;Primacy2,WARNING,FEEDER_EMPTY"
}
28
RESPONSE OBJECT
{
"id": "1",
"jsonrpc": "2.0",
"result": " Primacy,READY;Primacy2,WARNING"
}
RESPONSE OBJECT
{
"id": "1",
"jsonrpc": "2.0",
"result": "Primacy,Primacy2"
}
If the level parameter is not specified, then level=0
The major states provide global information on the device.
The minor states offer more detailed information of the major states.
The status reported by the SUPERVISION service is the same status that are
reported by the Print Center, before, after and during a print job
To check a specific status, outside of a print job, it is recommended to use the

GetStatus job request thanks to the CMD Service (binary status) see :
evolis_sdk_binary-status.
29
Supervision.AddDevice Subscribes a new device to the notification service
Device device name
REQUEST OBJECT
{
"id": "1",
"jsonrpc": "2.0",
"method":
"SUPERVISION.AddDevice", "params":
{
"device": "Evolis Zenius"
}
}
RESPONSE OBJECT
{
"id": "1",
"jsonrpc": "2.0",
"result": "OK"
}
SUPERVISION.RemoveDevice Unsubscribes a device to the notification service

Device device name
REQUEST OBJECT
{
"id": "1",
"jsonrpc": "2.0",
"method":
"SUPERVISION.RemoveDevice",
"params": {
"device": "Evolis Zenius"
}
}
RESPONSE OBJECT
{
"id": "1",
"jsonrpc": "2.0",
"result": "OK"
}
30
SUPERVISION.GetState Requests the state of a device
Device device name
Result majorstate, minorstate
REQUEST OBJECT
{
"id": "1",
"jsonrpc": "2.0",
"method": "SUPERVISION.GetState",
"params": {
}
}
RESPONSE OBJECT
{
"id": "1",
"jsonrpc": "2.0",
"result": "READY,PRINTER_READY"
}
The states reported by the SUPERVISION service are the same states that are
reported by the Print Center before, after and during a print job. If it is needed to
test a specific status, for example not reported outside a print job by the Print
Center, it is recommended to use the method GetStatus of the CMD service.
31
SUPERVISION.GetEvent Returns the notification of an unexpected event, as well as
the list of actions for a device
Device device name
Result NONE if no notification
Minorstate, combination of actions
REQUEST OBJECT
{
"id": "1",
"jsonrpc": "2.0",
"method": "SUPERVISION.GetEvent",
"params": {
}
}
RESPONSE OBJECT
{
"id": "1",
"jsonrpc": "2.0",
"result": "ERR_MECHANICAL:CANCEL,RETRY"
}
An unexpected event is notified during printing by the PRINT service or by the

spooler. This process is related to the pop-up notifications from the printer
manager.
32
SUPERVISION.SetEvent Executes an action when an unexpected event is notified on
a device
Device device name
Result minorstate:action possible actions : CANCEL, OK, RETRY
REQUEST OBJECT
{
"id": "1",
"jsonrpc": "2.0",
"method": "SUPERVISION.SetEvent",
"params": {
"action": "FEEDER_EMPTY:CANCEL",
}
}
RESPONSE OBJECT
{
"id": "1",
"jsonrpc": "2.0",
"result": "OK"
}
Sending an action when notified of an unexpected event is equivalent to acting

on the Printer Manager’s feedback notification. In this example, the feeder is
empty and a request for cancelling the printing job is sent.
33
ECHO SERVICE
Check that the ESPF is enabled.

ECHO.Echo Check server's status
Result String sent in request
REQUEST OBJECT
{
"id": "1",
"jsonrpc": "2.0",
"method": "ECHO.Echo",
"params": {
"data": "Hello World"
}
}
RESPONSE OBJECT
{
"id": "1",
"jsonrpc": "2.0",
"result": "Hello World"
}
34
ADD-ON SERVICE
Run a third-party add-on software (mostly for smart and contactless encoding)
ADDON.Launch Run a third-party add-on software

Command name of the application
Data parameters of the application
Result return code of the application
REQUEST OBJECT
{
"id": "1",
"jsonrpc": "2.0",
"method": "ADDON.Launch",
"params": {
"command": "testplugin.exe" "data": "testdata1 testdata2 testdata3"
}
}
RESPONSE OBJECT
{
"id": "1",
"jsonrpc": "2.0",
"result": "0"
}
The Launch method triggers a response as soon as the application is fully executed.
The application must be executed without involving the user.The ADD-ON service
is disabled by default.
The folder hosting the add-ons can be configured in the ESPF service.
35
ESPF SERVICE
Read servers' parameters

Edit servers' parameters
ESPF.GetParam Reads the value of a server parameter

key Parameters name
Result Parameters value
REQUEST OBJECT
{
"id": "1",
"jsonrpc": "2.0",
"method": "ESPF.GetParam",
"params": {
"key": "ESPFServerManager.port"
}
}
RESPONSE OBJECT
{
"id": "1",
"jsonrpc": "2.0",
"result": "18000"
}
36
ESPF.SetParam Edits the value of server parameter
key Parameters name
data new value to be set
result OK if successful
REQUEST OBJECT
{
"id": "1",
"jsonrpc": "2.0",
"method": "ESPF.SetParam",
"params": {
"key": "ESPFServerManager.port",
"data": "18001"
}
}
RESPONSE OBJECT
{
"id": "1",
"jsonrpc": "2.0",
"result": "OK"
}
The following parameters can be read:
• ESPFService.version
• ESPFService.requestlanguageversion:
Following parameters can be read/set:
• ESPFServerManager.port: port number to be used by clients for

socket-based communication with the server.
• ESPFTcpServerConnectionSupervisor.receivetimeout: timeout in ms
before disconnection info data is received via a socket-based
communication with a client.
• ESPFServerManager.tcpenabled: the true value triggers the server’s Socket
layer; the false value disables it.
Other parameters can be edited only through the server’s configuration file :
- For Evolis Premium Suite < 7.0.0.0 : ESPFsvc.properties file
- For Evolis Premium Suite > 7.0.0.0 (Evolis Premium Suite 2):
evoservice.properties
The Socket layer parameters cannot be edited if the layer is enabled.
37
SCANNER SERVICE
Scanner service could be used two ways :

- With a session, meaning scanner is reserved the whole session lifetime. Scanned
images could be retrieved in one on several times (see SCAN.GetImages).
- Without a session scanner is reserved only while the request execution, in case
images are not get in the request, then it is lost. (see SCAN.Acquire)
Only available with Evolis Primacy 2 printer.

Read scanner version
SCAN.Version Reads the value of the scanner version
key Parameters name
REQUEST OBJECT
{
"id": "1",
"jsonrpc": "2.0",
"method": "SCAN.Version",
"params": {
"device": "Evolis Primacy 2"
}
},
RESPONSE OBJECT
{
"id": "1",
"jsonrpc": "2.0",
"result": "WiseCube WIS-1000 2.09.L702A (02:01) [2107-0002]"
}
This request allows to know the current scanner version installed. Only available
with Primacy 2 and Evolis Premium Suite release above 7.0.0.0.
38
Acquire an image
SCAN.Acquire Scan a card with specific parameters
key Parameters name
Example without a session:
REQUEST OBJECT
{
"id": "1",
"jsonrpc": "2.0",
"method": "SCAN.Acquire",
"params": {
"device": "Evolis Primacy 2",
"options": "DPI=300, CARD_SPEED=220",
"images": "TOP, TOP_IR, BOTTOM, BOTTOM_IR",
"eject": false
}
},
RESPONSE OBJECT
{
"id": "1",
"jsonrpc": "2.0",
"result": {
"images": {
"BOTTOM": "base64:<data>",
"BOTTOM_IR": "base64:<data>",
"TOP": "base64:<data>",
"TOP_IR":"base64:<data>"
}
}
}
39
Example with a session:
REQUEST OBJECT
{
"id": "1",
"jsonrpc": "2.0",
"method": "SCAN.Acquire",
"params": {
"session": "SCAN1",
"options": "DPI=300, CARD_SPEED=220",
"images": "TOP, TOP_IR, BOTTOM, BOTTOM_IR",
"eject": false
}
},
RESPONSE OBJECT
{
"id": "1",
"jsonrpc": "2.0",
"result": {
"images": {
"BOTTOM": "base64:<data>",
"BOTTOM_IR": "base64:<data>",
"TOP": "base64:<data>",
"TOP_IR":"base64:<data>"
}
}
}
This request allows to scan a card and get the output as an image. If a card is inside
the printer, it will be scanned, otherwise a card will be inserted.
Image is encoded in base64, it remains possible to get one or several images at a

time.
Available images scan settings :
• TOP: Color image corresponding to the top of the card

• TOP_IR : IR image corresponding to the top of the card
• BOTTOM : Color image corresponding to the bottom of the card
• BOTTOM_IR : IR image corresponding to the bottom of the card
Optional parameters (one or several combinations are possible):
• WIDTH : image width in millimeters , default value :540mm par défaut (CR80 card).
• HEIGHT : image height in millimeters, default value 860mm (CR80 card).
• DPI : 600 or 300, default value 600. Evolis printer is calibrated to scan in 600
DPI resolution, in case scan is performed in 300 DPI resolution, it is required
to adapt the CARD_SPEED value (e.g., 220).
40
• CARD_OFFSET : Synchronization of the scan with the card beginning edge.
Factory setting. Value between 90 and 220.
• CARD_LENGTH : is related to the card's length, default value is 1200 (CR80 card).
• CARD_SPEED : is related to the DPI resolution. Factory settings for 600 DPI.
Value between 150 and 350.
Get current scanner session

SCAN.GetSession Reads the value of the current scanner session
key Parameters name
REQUEST OBJECT
{
"id": "1",
"jsonrpc": "2.0",
"method": "SCAN.GetSession",
},
RESPONSE OBJECT
{
"id": "1",
"jsonrpc": "2.0",
"result": "<Current_Session_value>"
}
This request allows to know the current scanner session. Only available with
Primacy 2 and Evolis Premium Suite release above 7.0.0.0. No required parameters.
41
Start a scanner session
SCAN.Begin Start a scanner session
key Parameters name
REQUEST OBJECT
{
"id": "1",
"jsonrpc": "2.0",
"method": "SCAN.Begin",
"params": {
"device": "Evolis Primacy 2"
}
}
RESPONSE OBJECT
{
"id": "1",
"jsonrpc": "2.0",
"result": "SCAN1"
}
This request allows to start a scanner session. Only available with Primacy 2 and
Evolis Premium Suite release above 7.0.0.0. Only one session at a time. The result is
to use for the other requests of the same session.
42
End a scanner session
SCAN.End End a scanner session
key Parameters name
REQUEST OBJECT
{
"id": "1",
"jsonrpc": "2.0",
"method": "SCAN.End",
"params": {
"device": "SCAN1"
}
}
RESPONSE OBJECT
{
"id": "1",
"jsonrpc": "2.0",
"result": "OK"
}
This request allows to end a scanner session, to free the scanner. Only available with
Primacy 2 and Evolis Premium Suite release above 7.0.0.0. Only one session at a
time. The only parameter to use corresponds to the returned value by a previous
call to "SCAN.Begin" (e.g.: SCAN1).
43
Get images from scanner
SCAN.GetImages Get images from scanner
key Parameters name
REQUEST OBJECT
{
"id": "1",
"jsonrpc": "2.0",
"method": "SCAN.GetImages",
"params": {
"session": "SCAN1",
"images": "TOP, TOP_IR, BOTTOM, BOTTOM_IR"
}
}
RESPONSE OBJECT
{
"id": "1",
"jsonrpc": "2.0",
"result": {
"images": {
"TOP": "base64:...",
"BOTTOM": "base64:...",
}
}
}
This request allows to get the current scanner images, It only works in a session.
This could get images from the previous SCAN.Acquire request. Only available with
Primacy 2 and Evolis Premium Suite release above 7.0.0.0. Only one session at a
time. The only parameter to use corresponds to the returned value by a previous
call to "SCAN.Begin" (e.g.: SCAN1). Parameters are a list of image to get (see
SCAN.Acquire)
44
Send command to the scanner
SCAN.SendCommand Send command to the scanner
key Parameters name
Example without a session:
REQUEST OBJECT
{
"id": "1",
"jsonrpc": "2.0",
"method": "SCAN.SendCommand",
"params": {
"device": "Evolis Primacy 2",
"command": "#GV"
}
}
RESPONSE OBJECT
{
"id": "1",
"jsonrpc": "2.0",
"result": {
"code": 12,
"data": "..."
}
}
}
45
Example with a session:
REQUEST OBJECT
{
"id": "1",
"jsonrpc": "2.0",
"method": "SCAN.SendCommand",
"params": {
"session": "SCAN1",
"command": "#GV"
}
}
RESPONSE OBJECT
{
"id": "1",
"jsonrpc": "2.0",
"result": {
"code": 12,
"data": "..."
}
}
}
This request allows to send a direct command to the scanner (work with or without
a session). Returns will be base 64 encoded in case it contains binary data (with a
"base64:" prefix). Regarding specific commands list, additional information only
upon request.
Parameters could be the following:

- Command : command to send, could be base 64 encoded
- Device : Printer's target name
- Session : Session ID, used only if device parameter is missing
46
APPENDIX
ESPF SERVER CONFIGURATION
The ESPF server can be configured using its configuration file. The server's settings
are considered upon server boot.
The configuration file is in the server setup directory and is named

ESPFSvc.properties (same for all the Evolis Suite as Badgy Premium Suite, Edikio
Printer Suite).
This file hosts general server parameters, as well as parameters specific to services
hosted on the server. The following tables describe a selection of such parameters.
For Primacy 2, and Evolis Premium Suite 2 please refer to this section.
47
Configuration file available settings:
This section gathers the available settings for the Evolis Services Provider
Framework for Evolis Suite (Evolis Premium Suite, Edikio Printer Suite, Badgy
Printer Suite) up to version 6.
For Evolis Premium Suite release above 7.0.0.0 ( Evolis Premium Suite 2), please
refer to this section
Logs settings
Name Value
ESPFService.log The true value enables the debugging logs
(default).
FALSE value disables it.
ESPFService.loglevel Verbose level :
1 Fatal
2 Critical
3 Error (default)
4 Warning
5 Notice
6 Information
7 Debug
ESPFService.logrequest TRUE value enables the requests log.

FALSE value disables it (default).
ESPFService.logrequestoutputdir Defines the directory for requests log files.

(default value is Tmp)
ESPFService.isrelativeoutputdir TRUE value indicates that the directory is

defined as a relative path to the directory where
the service is installed (default).
FALSE value indicates an absolute path.
Named pipe transport layer settings

Name Value
ESPFServerManager.serveraddress Base name of the Named pipe channel to
be used by the server’s clients.
Espf2Server00 for Primacy 2 (EPS >

7.0.0.0)
EspfServer00 for Evolis Suite inferior to
7.0.0.0.
ESPFServerManager.uniqueid Supplementary name for the Named pipe

channel to be used by the server’s clients.
(Name to use = base name + supplementary
name)
BADGY01 for Badgy 100 & 200

EDIKIO01 for Edikio printer Range
48
ESPFServerManager.disablepipeserver TRUE value disables the Named pipe
transport layer upon server boot.
FALSE value enables it (default)
ESPFService.logrequestoutputdir Defines the directory for requests log files.

(default value is Tmp).
ESPFService.isrelativeoutputdir TRUE value indicates that the directory is

defined as a relative path to the directory
where the service is installed (default).
Socket transport layer
Name Value
ESPFServerManager.port States the port number to be used by the
server’s clients.
Default port values :
18000 for the Evolis Premium Suite

18050 for the Badgy.Premium Suite
18100 For Edikio Printer Suite
18004 For Primacy 2 (EPS > version 7.0.0.0,
relies on evoservice.properties file)
ESPFServerManager.enabletcpatstart Supplementary name for the Named pipe

channel to be used by the server’s clients.
(Name to use = base name +
supplementary name)
Parameters for the add-on service

Name Value
ServiceAddOnManager.enabled TRUE value enables the services upon
server boot.
FALSE value disables it (default)
ServiceAddOnManager.addondir Defines the directory for hosting the add-on

applications that can be executed. (default
value is Tmp\\SrvAddOn)
ServiceAddOnManager.isrelativeaddondir TRUE value indicates that the directory is

defined as a relative path to the directory
where the service is installed (default).
49
RETURNED ERRORS
Error returned by the server has different states described in the below matrix,
errors are distributed by service and a general category "All services".
All services
Code -32700
Message (E)Parse error
Description Invalid JSON was received by the server. An error occurred on
the server while parsing the JSON text
Code -32600
Message (E) Invalid Request
Description The JSON sent is not a valid Request object
Code -32601
Message (E) Method not found
Description The method does not exist / is not available
Code -32602
Message (E) Invalid params
Description Invalid method parameter(s)
Code -32603
Message (E) Internal error
Description Internal JSON-RPC Error
Code -32000
Message (E) Service not found
Description The service does not exist / is not available
CMD service
Code 1200
Message (E) Get status error
Description Get status error
Code 1201
Message (E) Send command error
Description Send command error
Code 1202
Message (E) Reset communication error
Description Reset communication error
Code 1300
Message (W) Session already reserved
Description The communication session is already reserved
50
Code 1301
Message (W) Timeout
Description The send command timeouts
Code 1302
Message (W) Device not supervised
Description The target device is not supervised
Code 1303
Message (W) No Status
PRINT service
Code 1600
Message (E) Print error
Description Print Error
Code 1700
Message (W) Printing session already in progress for the device
Description The device has already a printing session in progress
Code 1701
Message (W) Invalid printing session.
Description The session id sent is not a valid printing session id
Code 1702
Message (W) Cannot perform action : action already in progress
Description Cannot perform action: action already in progress
Code 1703
Message (W) Cannot perform action : setting or bitmap missing
Description Cannot perform action: setting or bitmap missing
Code 1704
Message (W) Cannot perform action : processing error
Description Cannot perform action: processing error
Code 1705
Message (W) Cannot perform action : job canceled
Description Cannot perform action: job canceled
51
SETTING service
Code 1400
Message (E) Get error
Description Get Error
Code 1401
Message (E) Set error
Description Set Error
Code 1402
Message (E) Import error
Description import Error
Code 1403
Message (E) Export error
Description Export Error
Code 1500
Message (W) Invalid printing session.
Description The session id sent is not a valid printing session id
Code 1501
Message (W) Cannot perform action : action already in progress
Description Cannot perform action: action already in progress
Code 1502
Message (W) Cannot perform action : import not done
Description (W) Cannot perform action : import not done
SUPERVISION service
Code 1502
Message (W) Cannot perform action : import not done
Description (W) Cannot perform action : import not done
Code 1000
Message (E) Device supervision/un-supervision error
Description The device cannot be supervised/un-supervised
Code 1001
Message (E) Set event action error
Description Set event action error
52
Code 1100
Message (W) Device not found
Description The device cannot be found
Code 1101
Message (W) Device already supervised
Description The device is already supervised
Code 1102
Message (W) Device already un-supervised
Description The device is already un-supervised
Code 1103
Message (W) No event waiting for an action
Description There is no event waiting for an action
Code 1104
Message (W) Event action to set not found
Description The event action to set does not exist / is not available
Code 1105
Message (W) Different event waiting for an action
Description The event waiting for an action is different
ADD-ON service
Code 1800
Message (E) Launch error
Description Launch error
ESPF service
Code 2000
Message (E) Get parameter error
Description Get parameter error
Code 2001
Message (E) Set parameter error
Description Set parameter error
Code 2100
Message (W) The parameter key is invalid
Description The parameter key is invalid
SCANNER service
Code 1900
Message (E) No scanner in the printer
Description No scanner in the printer
53
Code 1901
Message (E) Scanner already in use by someone else
Description Scanner already in use
Code 1902
Message (E) Given session is invalid
Description Session ID in the request is not valid
Code 1903
Message (E) Invalid option value
Description Issue during the scan
Code 1904
Message (E) Invalid images value
Description Images value is not in the right formatting or value is wrong
Code 1905
Message (E) Error while scanning card
Description An unexpected error occurred while scanning the card
54
PRINTERS' STATES
The printer states are those reported by the Print Center.
Major state
Designation Description
OFF Unable to communicate
ERROR Printer error (requests a human intervention)
READY Printer Ready
WARNING Next printing unavailable (requests a human intervention)
A WARNING status is usually reported before the beginning of a printing but

for some specific status. It can be reported only when the printing starts.
An ERROR status is only reported during printing.
Minor state
For Evolis Premium Suite above 7.0.0.0 ( = Evolis Premium Suite 2), some status
changes in the answer of the request :
• WARNING,FEEDER_EMPTY becomes WARNING,DEF_FEEDER_EMPTY

• ERROR,FEEDER_EMPTY becomes ERROR,ERR_FEEDER_EMPTY
• WARNING,RIBBON_ENDED becomes WARNING,DEF_RIBBON_ENDED
• ERROR,RIBBON_ENDED becomes ERROR,ERR_RIBBON_ENDED
• WARNING, LAMINATE_END becomes WARNING,DEF_LAMINATE_END
• ERROR, LAMINATE_END becomes ERROR,ERR_LAMINATE_END
Designation Description Major State Major State

PRINTER_NOT_SUPERVISED Not supervised by Evolis Print OFF
Center
PRINTER_OFFLINE Printer offline OFF
PRINTER_STATUS_DISABLED Status disabled - Printer on-line OFF
ERR_BLANK_TRACK Magnetic encoding failed ERROR
Encoding fails on this card, please
check the card position in the
feeder.
ERR_COVER_OPEN Cover open error ERROR
The cover was opened during the
printing cycle. Close the cover and
click on resume.
ERR_FEATURE Printing not supported ERROR
Print cannot be run because it is
not supported by the printer
ERR_HEAD_TEMP Too high temperature ERROR
Print head temperature too high -
wait until it cools down.
ERR_HOPPER_FULL Output Hopper Full ERROR
Please remove all the printed cards
from the output hopper to resume
printing.
55
ERR_MAGNETIC_DATA Magnetic encoding failed ERROR
Invalid data format.
ERR_MECHANICAL Mechanical error ERROR
A mechanical error has occurred.
ERR_READ_MAGNETIC Magnetic encoding failed ERROR
Magnetic track reading failed.
ERR_REJECT_BOX_FULL Reject Box Full ERROR
Please remove all the cards from
the reject hopper to resume
printing.
ERR_RIBBON_ERROR Ribbon problem ERROR
The ribbon is cut or stuck to the
card.
ERR_WRITE_MAGNETIC Magnetic encoding failed ERROR
Read-after-Write failure.
FEEDER_EMPTY Card feed problem ERROR
(ERR_FEEDER_ERROR) Please check cards, position in the
card feeder and gauge
adjustment.
INF_WRONG_ZONE_EXPIRED Ribbon not valid ERROR
Compatibility problem between
ribbon and printouts credit limit
reached. Please contact your
reseller.
RIBBON_ENDED (ERR) Ribbon end ERROR
Ribbon end, please replace by a
new one.
LAMINATE_END (ERR) Film end ERROR
Film end. Please replace the film.
ERR_LAMINATE Film problem ERROR
Film problem. The film is cut or
stuck to the card.
ERR_LAMI_MECHANICAL Mechanical error ERROR
A mechanical error has occurred in
the lamination module.
ERR_LAMI_TEMPERATURE Temperature error ERROR
The lamination module
encountered a temperature error.
ERR_LAMI_COVER_OPEN Door open during lamination ERROR
The lamination module door got
opened during the lamination
process. Please close it and retry.
INF_CLEANING Regular cleaning required READY
Printer cleaning required.
(this state is reported only when
the printing starts, every 50 cards
approximatively)
INF_CLEANING Insert your adhesive cleaning card READY
(INF_CLEAN_2ND_PASS) Please insert your sticky cleaning
card. 'Cancel' if you want to
proceed with printing.
approximatively)
INF_CLEANING_RUNNING Cleaning in progress READY
INF_ENCODING_RUNNING Encoding in progress READY
INF_PRINTING_RUNNING Printing in progress READY
INF_LAMINATING_RUNNING Lamination in progress READY
56
INF_LAMI_CLEANING_RUNNING Lamination module cleaning in READY
progress
INF_LAMI_UPDATING_FIRMWARE Lamination module firmware READY
update in progress
INF_SLEEP_MODE Printer in Standby mode READY
INF_UPDATING_FIRMWARE Firmware update in progress READY
NOT_FLIP_ACT Single-sided Printer READY
PRINTER_READY Printer ready READY
INF_RIBBON_LOW Ribbon close to the end WARNING

Ribbon close to the end, please
proceed with replenishment.
approximatively, and changes
automatically after 10s)
INF_FEEDER_NEAR_EMPTY Feeder almost empty WARNING
The card feeder is almost empty,
please refill.
the printing starts, every X cards
BUSY Printer busy WARNING
You cannot print while the printer
is busy. Please wait or click on
"Cancel".
the printing starts)
CFG_FLIP Single-sided Printer WARNING
(test if not raised) Your single-sided printer cannot
print your dual-sided design.
CFG_MAGNETIC Magnetic coding option not WARNING
(test if not raised) installed
To continue printing without
magnetic coding click on resume.
CFG_EXTENDED_RESOLUTION Incompatible parameter WARNING
(test if not raised) This resolution parameter is not
compatible with this printer /
ribbon.
DEF_CARD_ON_EJECT Remove card WARNING
Remove the card from the manual
feeder.
DEF_COOLING Cooling in progress WARNING
Printer cooling in progress.
DEF_POWER_SUPPLY Power supply cable WARNING
Please use the power cable that
has been delivered with the printer
in order to not damage the print
quality and the printer.
DEF_COVER_OPEN Cover open WARNING
Close your printer cover.
DEF_HOPPER_FULL Output Hopper Full WARNING
57
Please remove all the printed cards
from the output hopper to resume
printing.
DEF_NO_RIBBON No ribbon WARNING
Replace the ribbon.
DEF_PRINTER_LOCKED Communication with the printer is WARNING
locked
Contact your dealer
DEF_UNSUPPORTED_RIBBON Ribbon incompatible with this WARNING
printer model
The ribbon inserted cannot work
with this printer model.
DEF_WAIT_CARD Waiting for a card insertion WARNING
Please insert your card manually.
ERR_BAD_RIBBON Ribbon installed is incompatible WARNING
with settings
The ribbon installed does not
correspond to the manually
defined settings. Printing cannot
take place.
FEEDER_EMPTY (DEF) Card feed problem WARNING
Please check cards, position in the
card feeder and gauge
adjustment.
INF_CLEANING_ADVANCED Advanced cleaning required WARNING
Printer advanced cleaning is
required.
approximatively)
INF_CLEANING_LAST_OUTWARRA Regular cleaning mandatory WARNING
NTY Click on 'Cancel' and proceed with
cleaning immediately. Would you
continue, this will void the print
head warranty.
INF_CLEANING_REQUIRED Regular cleaning mandatory - No WARNING
card issuance allowed by your
Administrator
Click on 'Cancel' and proceed with
cleaning immediately.
INF_UNKNOWN_RIBBON (1) Ribbon not identified WARNING
Ribbon identification impossible.
Please proceed with Manual
settings.
INF_UNKNOWN_RIBBON (2) Ribbon not identified WARNING
Ribbon identification impossible.
Please proceed with Manual
settings.
INF_WRONG_ZONE_ALERT Ribbon not valid WARNING
ribbon and printer. Less than 50
printouts remaining. Please
contact your reseller.
58
approximatively)
INF_WRONG_ZONE_RIBBON Ribbon not valid WARNING
ribbon and printer. Please contact
your reseller.
approximatively)
RIBBON_ENDED (DEF) Ribbon end WARNING
Ribbon end, please replace by a
new one.
DEF_NO_LAMINATE No film WARNING
No film in lamination module.
Please replace the film.
INF_LAMINATE_UNKNOWN Film not identified WARNING
Unknown film. Please contact your
reseller.
INF_LAMINATE_LOW Film close to the end WARNING
Film close to the end. Please
arrange for replacement.
LAMINATE_END (DEF) Film end WARNING
Film end. Please replace the film.
DEF_LAMINATE_UNSUPPORTED Incompatible film WARNING
Film incompatible with lamination
module. Please contact your
reseller.
DEF_LAMI_COVER_OPEN Door open WARNING
Lamination module door open.
Close the lamination module door.
INF_LAMI_TEMP_NOT_READY Adjusting temperature WARNING
Lamination module temperature
adjustment in progress. Please
wait…
DEF_LAMI_HOPPER_FULL Output jammed WARNING
The lamination output is jammed.
Please remove the card(s) and
retry.
59
Disclaimer
While Evolis makes every effort to deliver high quality products, we do not guarantee that our
products are free from defects. Our SDK, samples and demo software, any content or
documentation delivered in this package (Evolis SDK) is provided "as is". The use of it is at your
own risk.
Evolis makes no warranties as to performance, merchantability, fitness for a particular purpose,

or any other warranties whether expressed or implied.
No oral or written communication from or information provided by Evolis shall create awarranty.
Under no circumstances shall Evolis be liable for direct, indirect, special, incidental, or
consequential damages resulting from the use, misuse, or inability to use this Software
Development Kit (named Evolis SDK), even if Evolis has been advised of the possibility of such
damages
Evolis - 14 Avenue de la Fontaine - ZI Angers-Beaucouzé 49070 Beaucouzé - France

T +33 (0) 241 367 606 - F +33 (0) 241 367 612 - info@evolis.com
www.evolis.com

API Mode Reference-Guide

Uploaded by

Document Information

Original Description:

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

API Mode Reference-Guide

Uploaded by

Copyright:

Available Formats

Evolis SDK

API MODE REFERENCE GUIDE

All communications leverage IPC standard protocols (Socket or Named Pipe).

Overview of the services

• For each service, features could be accessed by calling a set of methods.

SERVICE NAME PURPOSE

CMD Bi-directional communication with the printer

Print Direct Printing of a card

Setting Printer configuration

Supervision Printer’s status management

Echo Test service

ESPF Server configuration

ADD-ON Management of ADD-ON execution

• The params member is an object which member names matching the

For Primacy 2 available settings, please refer to this section

The general syntax to call a method in a JSON request is "SERVICE" Method"

If an unexpected error happens on the server while communicating with a

CMD.SendCommand Send commands in text or binary format

e.g., a base64-encoded Rfv command:

Prints a card, whatever the printing system

The job ID is not unique and is referenced in the printing logs.

PRINT.Set Set the printing parameters

%EPS_DIR%\Evolis Premium Suite\Model\{printer model}

%EPS_DIR% is either the installation directory for the suite or an environment

For Evolis Premium Suite 2, please refer to next page.

evosettings.exe -p "Evolis Primacy 2" -lk

evosettings.exe -p "Evolis Primacy 2" --list-key

The evosettings utility is in "...\"Installation Directory selected during

Below a sample screenshot :

Options are then :

With the following possibilities :

In case BMPVARNISH is set, then a PRINT.SetBitmap is required to configure the

Session JOB ID to set only if you want to close

Loads printing parameters

%EPS_DIR%\Evolis Premium Suite\Model\{printer model}

%EPS_DIR% is either the installation directory for the suite or an environment

To read the XML file, open it with an appropriate Web browser.

Evolis Premium Suite 2 :Evosettings to manage printer's settings

C:\Program Files\Evolis Card Printer 2\Evolis Premium Suite 2\tools\evosettings.exe

evosettings -p "Evolis Primacy 2" -l

Get all available settings for a Primacy 2 thanks to evosettings

Evosettings.exe -p "Evolis Primacy 2" --list-key

Result if format=printer OK if successful

Lists the subscribed devices and their state

If the level parameter is not specified, then level=0

The major states provide global information on the device.

To check a specific status, outside of a print job, it is recommended to use the

SUPERVISION.RemoveDevice Unsubscribes a device to the notification service

An unexpected event is notified during printing by the PRINT service or by the

Sending an action when notified of an unexpected event is equivalent to acting

Check that the ESPF is enabled.

ADDON.Launch Run a third-party add-on software

Read servers' parameters

ESPF.GetParam Reads the value of a server parameter

The following parameters can be read:

Following parameters can be read/set:

• ESPFServerManager.port: port number to be used by clients for

The Socket layer parameters cannot be edited if the layer is enabled.

Scanner service could be used two ways :

Only available with Evolis Primacy 2 printer.

Example without a session:

Image is encoded in base64, it remains possible to get one or several images at a