The official python wrapper for the Basler pylon Camera Software Suite.
Please Note: This project is offered with no technical support by Basler AG. You are welcome to post any questions or issues on GitHub or on ImagingHub.
- Install pylon.
- Download a binary wheel from the releases page.
- Install the wheel using
pip3 install <your downloaded wheel>.whl
- Look at samples/grab.py in this repository
The easiest way to get pypylon is to install a prebuild wheel.
Binary releases are available on the releases page.
Building the pypylon bindings is supported and tested on Windows and Linux.
You need a few more things to compile pypylon:
- A compiler for your system (Visual Studio on Windows, gcc on linux)
- swig >= 3.0.12
To build pypylon from source:
git clone https://github.com/basler/pypylon.git
cd pypylon
pip install .
See the grab sample in the samples directory.
Excerpt:
from pypylon import pylon
camera = pylon.InstantCamera(pylon.TlFactory.GetInstance().CreateFirstDevice())
camera.Open()
# demonstrate some feature access
new_width = camera.Width.GetValue() - camera.Width.GetInc()
if new_width >= camera.Width.GetMin():
camera.Width.SetValue(new_width)
numberOfImagesToGrab = 100
camera.StartGrabbingMax(numberOfImagesToGrab)
while camera.IsGrabbing():
grabResult = camera.RetrieveResult(5000, pylon.TimeoutHandling_ThrowException)
if grabResult.GrabSucceeded():
# Access the image data.
print("SizeX: ", grabResult.Width)
print("SizeY: ", grabResult.Height)
img = grabResult.Array
print("Gray value of first pixel: ", img[0, 0])
grabResult.Release()
camera.Close()
Pull requests to pypylon are very welcome. To help you getting started with pypylon improvements, here are some hints:
python setup.py develop
This will "link" the local pypylon source directory into your python installation. It will not package the pylon libraries and always use the installed pylon.
After changing pypylon, execute python setup.py build
and test...
NOTE: The unit tests try to import
pypylon....
, so they run against the installed version of pypylon.
python -m unittest tests/....
python tests/....
- For USB 3.0 cameras to work on Linux, you need to install appropriate udev rules. The easiest way to get them is to install an official pylon package from https://www.baslerweb.com/pylon.