Enumerations Reference

CardFace

evolis.CardFace
ValueIntDescription
FRONT0Front face of the card
BACK1Back face of the card

RibbonType

evolis.RibbonType
ValueIntDescription
UNKNOWN-1Unknown / unreadable
YMCKO0Standard color+overlay (most common for Primacy)
YMCKOS3YMCKO with scratch
YMCKOS135YMCKO scratch 1/3
YMCKOK4YMCKO+K double resin
YMCKOKS139YMCKOK scratch 1/3
YMCKOKOS10YMCKO+K+O+S
YMCKOO13YMCKO double overlay
KO1Black + overlay
KBLACK100Black resin only
KWHITE105White resin
KRED103Red resin
KGREEN102Green resin
KBLUE101Blue resin
KSCRATCH108Scratch-off
KMETALSILVER107Silver metallic
KMETALGOLD106Gold metallic
KSIGNATURE114Signature panel
KWAX112Wax black
KPREMIUM115Premium black
KRMS116RMS black
HOLO91Holographic
SOKO12Silver+overlay
YMCFK1002Avansia YMCFK
YMCK1000Avansia YMCK
YMCKS1050Avansia YMCKS
YMCKH1003Avansia YMCKH
YMCKI1004Avansia YMCKI
YMCKK1001Avansia YMCKK
YMCKKS1051Avansia YMCKKS
YMCKKI1005Avansia YMCKKI
KBLACK_R1100Avansia black resin
CLEAR2000Clear laminate

ReturnCode

evolis.ReturnCode

Success

ValueIntDescription
OK0Success

General Errors

ValueIntDescription
EUNDEFINED-1Undefined error
EINTERNAL-2Internal logic error
ECANCELLED-3Operation cancelled
EDISABLED-4Feature disabled
EUNSUPPORTED-5Feature not supported
EPARAMS-6Invalid parameters
ETIMEOUT-7Timeout

Session Errors

ValueIntDescription
SESSION_ETIMEOUT-10Session reservation expired
SESSION_EBUSY-11Printer in use
SESSION_DISABLED-12Session management is off
SESSION_FAILED-13Failed to reserve
SESSION_ENABLED-14Operation not allowed with session management on
ValueIntDescription
PRINT_EDATA-20Invalid image/settings data
PRINT_NEEDACTION-21Printer not ready (ribbon, cover, feeder…)
PRINT_EMECHANICAL-22Mechanical error during printing
PRINT_WAITCARDINSERT-23Avansia: waiting for card insert
PRINT_WAITCARDEJECT-24Avansia: waiting for card eject
PRINT_EUNKNOWNRIBBON-25GRibbonType setting missing
PRINT_ENOIMAGE-26No image provided
PRINT_WSETTING-27Driver settings partially failed
PRINT_EJOB-28Print job not created / expired
PRINT_ESESSION-29No session available

Laminator Errors

ValueIntDescription
LAM_ENOCOM-40Laminator missing / no communication
LAM_EDEVICE-41Device is not a laminator
LAM_ERROR-42Laminator error
LAM_EVALUE-43Unexpected laminator value

Magnetic Errors

ValueIntDescription
MAG_ERROR-50Magnetic read/write error
MAG_EDATA-51Invalid magnetic data
MAG_EBLANK-52Magnetic track blank

Printer Communication Errors

ValueIntDescription
PRINTER_ENOCOM-60Printer offline
PRINTER_EREPLY-61Printer replied with ERR
PRINTER_EOTHER-62macOS: USB in use by other software
PRINTER_EBUSY-63macOS: CUPS is printing
PRINTER_NOSTATUS-64Statuses disabled on printer
PRINTER_EMODEL-65Invalid printer model
PRINTER_NETWORK_ERROR-80Network operation error
PRINTER_NETWORK_ECERT-81Invalid certificate

Card / Smart / System / User / Service Errors

RangeDescription
-200 to -201Card movement errors
-300 to -303Smart card errors
-500 to -503System/OS errors
-600 to -604User authentication errors
-700 to -701Sandbox errors
-10000 to -10006EPS service errors
-20000 to -20500HTTP errors

OpenMode

evolis.OpenMode

Controls how the SDK connects to the printer.

ValueDescription
AUTOAutomatic (recommended)
(other values depend on platform)USB / TCP / supervised

State.Major

evolis.State.Major
ValueDescription
OFFPrinter offline / not connected
READYPrinter ready
WARNINGPrinter has a non-blocking warning
ERRORPrinter has a blocking error

State.Minor

Hundreds of sub-states. Key ones for day-to-day use:

ValueDescription
PRINTER_READYFully ready to print
DEF_NO_RIBBONNo ribbon installed
DEF_FEEDER_EMPTYFeeder is empty
DEF_COVER_OPENCover is open
ERR_MECHANICALMechanical jam
ERR_RIBBON_ERRORRibbon error
INF_PRINTING_RUNNINGJob currently printing
INF_SLEEP_MODEPrinter in sleep mode

CardPos

evolis.CardPos

Used with Connection.set_card_pos().


InputTray / OutputTray

evolis.InputTray
evolis.OutputTray

Enumerate available input/output positions (feeder, hopper, manual, bezel, etc.).


ErrorManagement

evolis.ErrorManagement
ValueDescription
PRINTERPrinter handles errors autonomously
SOFTWAREYour application handles errors
SUPERVISEDEPS service handles errors

MagCoercivity

evolis.MagCoercivity
ValueDescription
OFFNo coercivity
LOCOLow coercivity
HICOHigh coercivity

MagFormat / MagTrackNumber

evolis.MagFormat
evolis.MagTrackNumber   # TRACK1=0, TRACK2=1, TRACK3=2

BezelBehavior

evolis.BezelBehavior

Controls what happens after the BEZEL delay expires.


Feeder

evolis.Feeder

Used with KC Max printers that have multiple card feeders.


LaminatorIndex / LaminatorMode / LaminatorFilmType

evolis.LaminatorIndex
evolis.LaminatorMode
evolis.LaminatorFilmType

For printers with attached lamination modules.


ScanImage / ScanOption

evolis.ScanImage
evolis.ScanOption

For printers with the WiseCube scanner option.


LogLevel

evolis.LogLevel

Used with Evolis.set_log_level().


ServiceAction

evolis.ServiceAction

Actions to reply to EPS service events (e.g. RETRY, CANCEL, IGNORE).


Model

evolis.Model

Represents every printer model known by the SDK.


RwCardType

evolis.RwCardType
ValueDescription
MBLACKBlack rewritable card
MBLUEBlue rewritable card
CUSTOM_FRONTCustom front
CUSTOM_DUPLEXCustom duplex