Most terminals are read directly over the network and need nothing else. A few connection types use the manufacturer's own Windows software (an "SDK") on the connector PC. Today that is only the ZKTeco SDK. This page explains when you need it, how to install it step by step, what the checks mean, and the licence rules.
Preview and honesty note. The SDK path has been built and checked with software simulations only. It has not been run against a real SDK installation on a Windows PC, and not on real terminals of every model. Details that may differ on a real PC: the registry layout, the behaviour of
regsvr32, the exact answers of the SDK to some calls. Try it on one device first. If it does not work, the built-in direct connection is always available.
#Do you need it?
Probably not. For most ZKTeco terminals choose ZKTeco (direct): it reads punches and users, sets the clock, restarts the device and edits users, and has been verified on a real iFace702. Use the SDK type only if you need what direct cannot do:
| Feature | ZKTeco direct | ZKTeco SDK |
|---|---|---|
| Read punches, users and device clock | Yes | Yes |
| Edit, add, delete users; set clock; restart | Yes | Yes |
| Enable / disable a user on the device | No ("not supported here") | Yes |
| Copy faces and fingerprints between two devices | No | Yes |
| User photos, snapshot photos at punches | No | Yes |
| Live punch events | No (polling) | Yes, software-tested only (best with the 64-bit SDK) |
| Needs software on the PC | No | Yes: the ZKTeco SDK, registered |
| Verified on a real device | Yes (iFace702, read-only features) | No (simulated only) |
Changes to devices must also be allowed on the connector page (see Install) and need the owner for the advanced ones.
#Step by step: the 64-bit SDK (recommended)
You need the connector PC to be Windows (64-bit) and administrator rights.
- Download the ZKTeco Standalone SDK yourself, from ZKTeco. SolaHR never bundles or redistributes it. You accept ZKTeco's licence terms when you download it. Use version 6.3.1.37 or later: it contains a folder named
64bitwith a real 64-bitzkemkeeper.dllthat matches the 64-bit connector. See the note below about where to get it. - Unpack the package somewhere on the PC (for example under your Downloads folder).
- Open the
64bitfolder, right-click Register_SDK_x64.bat and choose Run as administrator. It copies the SDK files to the Windows system folder and registerszkemkeeper.dllfor you. - In SolaHR (device page, Set up the required software) or on the connector page, press Verify installation.
- Read the checks. When all are Ready, the device card leaves Setup required and Test connection works.
Where to get the SDK. ZKTeco publishes SDK material in its Download Center (category SDK) and keeps a Standalone-SDK repository on its GitHub account. At the time of writing we could check that the repository holds an older 32-bit pack (Communication Protocol SDK 6.2.4.11) and that the Download Center's SDK list shows other SDKs (fingerprint and visible-light modules); we could not confirm a public link to 6.3.1.37. Some ZKTeco downloads need a free member login. If you cannot find it, ask ZKTeco or your ZKTeco distributor for the "Standalone SDK 6.3.1.37 or later, 64-bit". The link shown in SolaHR is not independently verified either.
#What the readiness checks mean
| Check | Meaning | If it says Missing |
|---|---|---|
| Windows | The PC runs Windows. | An SDK type cannot run on another system ("This connection type cannot run on that PC"). |
| Python COM component | The connector can talk to Windows components (pywin32). | Part of the connector. Reinstall or upgrade the connector. |
| SDK registered | Windows knows the SDK (zkemkeeper). |
Run Register_SDK_x64.bat as administrator. |
| DLL file | The registered zkemkeeper.dll exists on disk. |
Register again; do not move or delete the files afterwards. |
| Bitness | The SDK is 32-bit or 64-bit, and the connector is 64-bit. | A 32-bit-only SDK does not fit directly: use the 64-bit SDK, or the fallback below. |
Readiness runs before every connection test and poll. A missing SDK is a status, "Setup required": SolaHR does not retry in a loop and does not call the device unreachable.
#Fallback: an older, 32-bit-only SDK
Older packs have only a 32-bit component, which the 64-bit connector cannot load directly. The connector page then offers Choose DLL / Register (administrator rights; Windows will ask you to confirm). It does exactly this and nothing more:
- checks that the chosen file is a local file named exactly
zkemkeeper.dlland is a real Windows DLL; - registers that one file with Windows (
regsvr32); - if the file is 32-bit, makes Windows host it in a separate 32-bit helper process.
It never downloads anything, never runs other files and never changes a device. For safety, when the connector runs as a service it only registers a DLL under Program Files or Windows; for a DLL elsewhere an administrator runs solahr-dc sdk-setup --dll <path> from an elevated command prompt. solahr-dc readiness prints the current report and solahr-dc sdk-setup --candidates lists copies of the DLL it can find. Live events may be unreliable through this route; use the 64-bit SDK for them. To undo: regsvr32 /u <path to dll>. Uninstalling Device Connect leaves your SDK registration alone.
#If the SDK does not work: use the built-in connection
In the Set up the required software panel press Use the built-in connection instead. After you confirm, SolaHR changes the connection type to the direct one, keeps the IP address and port, drops the SDK settings, and tests the device again. Punches and employee mappings are kept. Nothing is switched without your confirmation.
#Vendor licence restrictions and other vendors
| Vendor SDK | Status in Device Connect | Restrictions to know |
|---|---|---|
ZKTeco Standalone SDK (zkemkeeper) |
Implemented, software-tested only | Licensed by ZKTeco. Not bundled, not redistributable by us: you download it from ZKTeco and accept its terms (the GitHub repository we checked shows no licence text, so read the terms that come with your download). Windows only. Registration is machine-wide and needs administrator rights. |
| Suprema G-SDK | Planned, not implemented | Suprema's G-SDK repository says downloads move to the Suprema Download Center (from 2 March 2026) and no licence is stated there; downloads may require a partner login. Today Suprema devices are read through a BioStar 2 server instead. |
| Hikvision Device Network SDK | Not planned | Not needed: Hikvision terminals are read over ISAPI (web protocol). Hikvision's SDK pages exist for your own projects; its ISAPI developer guides on the TPP portal need a signed agreement and partner details. |
| Anviz CrossChex SDK | Not planned | Not needed: Anviz is read over its network protocol or CrossChex Cloud. Anviz has an SDK download page for your own projects. |
Nothing here is legal advice: always read the licence that comes with a vendor's download.