Skip to main content

Installation

Requirements​

Use CPython 3.9 or later and select a package that matches your operating system and CPU architecture.

Operating systemCPU architecturePackage platform tag
Windowsx64win_amd64
Linuxx64manylinux_2_31_x86_64
LinuxARM64manylinux_2_31_aarch64

Linux requires glibc 2.31 or later. BLE connections also require a working Bluetooth adapter and running BlueZ and D-Bus services.

Install the Python package​

Obtain the official xenseglovesdk wheel (.whl) package, then run the following command in your target Python environment:

python -m pip install "path/to/your-downloaded-package.whl"

Replace the quoted path with the actual downloaded file path. The cp39-abi3 tag indicates support for Python 3.9 and later standard CPython versions. The package must still match your operating system and CPU architecture.

Verify the installation​

python -c "import xenseglovesdk; print(xenseglovesdk.__version__)"

If the command prints the SDK version, the Python API is ready to use. You do not need to connect a glove for this check.

Prepare the connection​

USB serial​

  1. Connect the glove to the computer with a USB cable that supports data transfer.
  2. Close any application using the glove's serial port.
  3. Use XenseGlove.list_ports() to find the glove's port.

The device may appear as two serial ports. Select the data port (CDC0). Port names typically look like COM5 on Windows or /dev/ttyACM0 or /dev/ttyUSB0 on Linux; use the name returned by the scan. The SDK applies the default serial settings, so you do not need to configure the baud rate manually.

On Linux, your user must have permission to access the serial port. If access is denied, check the device permissions and your user's serial access group membership.

Bluetooth Low Energy (BLE)​

Make sure the glove supports BLE and is powered on, then enable Bluetooth on the computer. The SDK uses the system's first Bluetooth adapter. Check its status with:

from xenseglovesdk import XenseGlove

print(XenseGlove.is_bluetooth_enabled())

True means Bluetooth is enabled. This method only queries the status; system Bluetooth errors may raise an exception.

Once your environment is ready, continue to Quick Start.