Evolis SDK for Python — Documentation Index

Version: 9.3.0
Package: pip install Evolis-SDK

Files

File	Contents
01-quickstart.md	Installation, minimal examples, black-only print
02-connection.md	`Connection` class — full API reference
03-print-session.md	`PrintSession` class — images, settings, printing
04-print-black-example.md	Complete black-to-card-front examples (Primacy)
05-setting-keys.md	All `SettingKey` values with types and allowed values
06-enums.md	All enumerations (`CardFace`, `RibbonType`, `ReturnCode`, `State`, …)
07-mag-session.md	`MagSession` — magnetic stripe read/write
08-scan-session.md	`ScanSession` — WiseCube scanner
09-service.md	`Service` — EPS supervision service
10-evolis-class.md	`Evolis` — global library management, device discovery, logging
11-laminator.md	Laminator control via `Connection`

Quick Reference — Print Black to Card Front

import evolis
 
with evolis.Connection("Evolis Primacy") as co:
    state = co.get_state()
    if state.major == evolis.State.Major.READY:
        ps = evolis.PrintSession(co)
        # 1bpp monochrome BMP — uses the K (black resin) panel only
        ps.set_black(evolis.CardFace.FRONT, "/path/to/black_front_1bpp.bmp")
        rc = ps.print()
        print("Result:", rc)

Key Classes

Class	Purpose
`evolis.Connection`	Open/close printer, card movement, status, settings
`evolis.PrintSession`	Configure and execute a print job
`evolis.MagSession`	Read/write magnetic stripe data
`evolis.ScanSession`	Scan a card with the optional scanner module
`evolis.Service`	Manage the EPS supervision service
`evolis.Evolis`	Library version, device list, logging configuration

Most Important Enums

Enum	Key values
`evolis.CardFace`	`FRONT`, `BACK`
`evolis.RibbonType`	`YMCKO`, `KBLACK`, `KO`, …
`evolis.ReturnCode`	`OK`, `PRINT_NEEDACTION`, `PRINT_EMECHANICAL`, …
`evolis.State.Major`	`READY`, `WARNING`, `ERROR`, `OFF`
`evolis.SettingKey`	`FBlackManagement`, `FOverlayManagement`, `Resolution`, …

Home Quickstart