Summary

Though the raw commands that the XID devices accept are well documented, it is better to use our open source C++ or Python, for a simple reason: you get better timing, 2 millisecond delay and jitter free.

Repo Notes

Our XID libraries are dependent on other libraries, e.g. Boost. When checking out a library, make sure to include the submodules so that other dependencies are also loaded:

   git submodule init

   git submodule update

You should have a binaries_boost folder in the repo root if everything’s pulled.

The repo can be found at

     https://github.com/cedrus-opensource/xid_device_library/

The pyxid2 library can be downloaded from

     https://github.com/cedrus-opensource/pyxid

or

     https://pypi.org/project/pyxid2/

The “xid_commands.py” file in the same folder offers a fairly comprehensive code sample.

The C++ library supports all the XID 2 features. The Python one supports almost all features; we will add more features based on customer requests.

Third Party Libraries

Unreal Engine

Bertrand Richard at Université Gustave Eiffel has developed a plug-in that wraps the XID 2 library and allows users to interact with it using Unreal's visual scripting (Blueprint). The plug-in is open sourced at

     https://github.com/brifsttar/XID2

Python for Linux

Christopher Brown has developed a Python module for Linux:

     https://gitlab.com/cabrown/triggers

Its only dependency is pyserial.

Back to XID main page
Last revision: Oct 29, 2025