xiapipy 4.33.21

Python API for XIMEA cameras control

xiapipy

xiapipy is the official Python interface to the XIMEA xiAPI, providing full control over XIMEA cameras from Python. It exposes the complete feature set of XIMEA hardware and integrates naturally with popular imaging libraries such as OpenCV and Pillow.

Supported Platforms

OS	Architecture
Windows	x86 32-bit, x86 64-bit
Linux	x86 64-bit, ARM 32-bit, ARM 64-bit
macOS	x86 64-bit, ARM 64-bit (Apple Silicon)

Requirements

• Python 3.x

Optional

• XIMEA Software Package
• numpy (required for get_image_data_numpy())

Installation

pip install xiapipy

Quick Start

from xiapipy import xiapi

# Create camera instance and open device
cam = xiapi.Camera()
cam.open_device()

# Create image buffer and start acquisition
img = xiapi.Image()
cam.start_acquisition()

# Capture a frame
cam.get_image(img)
data = img.get_image_data_numpy()  # returns numpy array

# Clean up
cam.stop_acquisition()
cam.close_device()

Multiple Cameras

cam0 = xiapi.Camera(dev_id=0)
cam1 = xiapi.Camera(dev_id=1)

cam0.open_device()
cam1.open_device()

You can also open a camera by serial number:

cam = xiapi.Camera()
cam.open_device_by_SN("12345678")

Image Data

Retrieved images can be exported as:

• get_image_data_raw() — raw bytes
• get_image_data_numpy() — numpy.ndarray (supports mono, raw, RGB, RGBA formats)

Links

• XIMEA website
• xiAPI Python documentation