Skip to main content

The python wrapper for the Basler pylon Camera Software Suite.

Project description

pypylon

The official python wrapper for the Basler pylon Camera Software Suite.

Background information about usage of pypylon, programming samples and jupyter notebooks can also be found at pypylon-samples.

Please Note: This project is offered with limited technical support by Basler AG. You are welcome to post any questions or issues on GitHub. For additional technical assistance, please reach out to our official Support team.

Build Status

Getting Started

  • Install pylon This is strongly recommended but not mandatory. See known issues for further details.
  • Install pypylon: pip3 install pypylon For more installation options and the supported systems please read the Installation paragraph.
  • Look at samples/grab.py or use the following snippet:
from pypylon import pylon

camera = pylon.InstantCamera(pylon.TlFactory.GetInstance().CreateFirstDevice())
camera.Open()

# demonstrate some feature access
new_width = camera.Width.Value - camera.Width.Inc
if new_width >= camera.Width.Min:
    camera.Width.Value = 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()

Getting Started with pylon Data Processing

from pypylon import pylondataprocessing
import os

resultCollector = pylondataprocessing.GenericOutputObserver()
recipe = pylondataprocessing.Recipe()
recipe.Load('dataprocessing_barcode.precipe')
recipe.RegisterAllOutputsObserver(resultCollector, pylon.RegistrationMode_Append);
recipe.Start()

for i in range(0, 100):
    if resultCollector.GetWaitObject().Wait(5000):
        result = resultCollector.RetrieveResult()
        # Print the barcodes
        variant = result["Barcodes"]
        if not variant.HasError():
            # Print result data
            for barcodeIndex in range(0, variant.NumArrayValues):
                print(variant.GetArrayValue(barcodeIndex).ToString())
        else:
            print("Error: " + variant.GetErrorDescription())
    else:
        print("Result timeout")
        break

recipe.Unload()

Update your code to pypylon >= 3.0.0

The current pypylon implementation allows direct feature assignment:

cam.Gain = 42

This assignment style is deprecated with pypylon 3.0.0, as it prevents full typing support for pypylon.

The recommended assignment style is now:

cam.Gain.Value = 42

To identify the locations in your code that have to be updated, run with enabled warnings:

PYTHONWARNINGS=default python script.py

Installation

Prerequisites

  • Installed pylon For the binary installation this is not mandatory but strongly recommended. See known issues for further details.
  • Installed python with pip
  • Installed CodeMeter Runtime when you want to use pylon vTools and the pylon Data Processing API extension on your platform.

pylon OS Versions and Features

Please note that the pylon Camera Software Suite may support different operating system versions and features than pypylon. For latest information on pylon refer to: https://www.baslerweb.com/en/software/pylon/ In addition, check the release notes of your pylon installation. For instance:

  • pylon Camera Software Suite 8.1.0 supports Windows 10/11 64 bit, Linux x86_64 and Linux aarch64 with glibc version >= 2.31 or newer, macOS Sonoma or newer.
  • pylon vTools are supported on pylon 7.0.0 and newer.
  • pylon vTools are supported on pypylon 3.0 and newer only on Windows 10/11 64 bit, Linux x86_64 and Linux aarch64.
  • For pylon vTools that require a license refer to: https://www.baslerweb.com/en/software/pylon-vtools/
  • CXP-12: To use CXP with pypylon >= 4.0.0 you need to install the CXP GenTL producer and drivers using the pylon Camera Software Suite setup.
  • For accessing Basler 3D cameras, e.g. Basler blaze, installation of pylon Camera Software Suite 8.1.0 and the latest pylon Supplementary Package for blaze is required.

Binary Installation

The easiest way to get pypylon is to install a prebuild wheel. Binary releases for most architectures are available on pypi**. To install pypylon open your favourite terminal and run:

pip3 install pypylon

The following versions are available on pypi:

3.9 3.10 3.11 3.12 3.13
Windows 64bit x x x x x
Linux x86_64* x x x x x
Linux aarch64* x x x x x
macOS x86_64** x x x x x
macOS arm64** x x x x x

Additional Notes on binary packages:

  • (*) The linux 64bit binaries are manylinux_2_31 conformant. This is roughly equivalent to a minimum glibc version >= 2.31. :warning: You need at least pip 20.3 to install them.
  • (**) macOS binaries are built for macOS >= 14.0 (Sonoma)

Installation from Source

Building the pypylon bindings is supported and tested on Windows, Linux and macOS

You need a few more things to compile pypylon:

  • An installation of pylon SDK for your platform
  • A compiler for your system (Visual Studio on Windows, gcc on linux, xCode commandline tools on macOS)
  • Python development files (e.g. sudo apt install python-dev on linux)
  • swig 4.3
    • For all 64bit platforms you can install the tool via pip install "swig==4.3"

To build pypylon from source:

git clone https://github.com/basler/pypylon.git
cd pypylon
pip install .

If pylon SDK is not installed in a default location you have to specify the location from the environment

  • on Linux: export PYLON_ROOT=<installation directory of pylon SDK>
  • on macOS: export PYLON_FRAMEWORK_LOCATION=<framework base folder that contains pylon.framework>

Development

Pull requests to pypylon are very welcome. To help you getting started with pypylon improvements, here are some hints:

Starting Development

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...

Running Unit Tests

NOTE: The unit tests try to import pypylon...., so they run against the installed version of pypylon.

pytest tests/....

Known Issues

  • 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 the official pylon package.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distributions

pypylon-4.2.0-cp39-abi3-win_amd64.whl (95.8 MB view details)

Uploaded CPython 3.9+Windows x86-64

pypylon-4.2.0-cp39-abi3-manylinux_2_31_x86_64.whl (88.6 MB view details)

Uploaded CPython 3.9+manylinux: glibc 2.31+ x86-64

pypylon-4.2.0-cp39-abi3-manylinux_2_31_aarch64.whl (77.1 MB view details)

Uploaded CPython 3.9+manylinux: glibc 2.31+ ARM64

pypylon-4.2.0-cp39-abi3-macosx_14_0_x86_64.whl (31.4 MB view details)

Uploaded CPython 3.9+macOS 14.0+ x86-64

pypylon-4.2.0-cp39-abi3-macosx_14_0_arm64.whl (31.4 MB view details)

Uploaded CPython 3.9+macOS 14.0+ ARM64

File details

Details for the file pypylon-4.2.0-cp39-abi3-win_amd64.whl.

File metadata

  • Download URL: pypylon-4.2.0-cp39-abi3-win_amd64.whl
  • Upload date:
  • Size: 95.8 MB
  • Tags: CPython 3.9+, Windows x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.9.13

File hashes

Hashes for pypylon-4.2.0-cp39-abi3-win_amd64.whl
Algorithm Hash digest
SHA256 a7a13978f1a8e352b9cecc1334eef06e0bb0262e58dfa4de9bc317c5b8afaf1d
MD5 eaf203656670113f1464279186fc4ef1
BLAKE2b-256 9e85fb75dafe3ad1b928930efb753c97aec79efe74fbdc1a590516e5e96e01ca

See more details on using hashes here.

File details

Details for the file pypylon-4.2.0-cp39-abi3-manylinux_2_31_x86_64.whl.

File metadata

File hashes

Hashes for pypylon-4.2.0-cp39-abi3-manylinux_2_31_x86_64.whl
Algorithm Hash digest
SHA256 d66b7367e1ddd0b312b785bbc9688de5a2d5f4f083e095084bf5a4a978729d8f
MD5 4badbb0bede3328d61df7203abc2ca27
BLAKE2b-256 c6cc2d06b6f3c73808d8e7aff5de954e3ee9ce7a2532be9ea6b62427ac01eece

See more details on using hashes here.

File details

Details for the file pypylon-4.2.0-cp39-abi3-manylinux_2_31_aarch64.whl.

File metadata

File hashes

Hashes for pypylon-4.2.0-cp39-abi3-manylinux_2_31_aarch64.whl
Algorithm Hash digest
SHA256 3a4ba03737d8f70d734577875a387e086ae74ecd165650c0f1141d37bcaf2468
MD5 7ff1ffdd80b9ec15b433c03b47a911da
BLAKE2b-256 343c4cfae184eb81c225769d25f38a686de529f5fc3759822b9d86095b8b7bc7

See more details on using hashes here.

File details

Details for the file pypylon-4.2.0-cp39-abi3-macosx_14_0_x86_64.whl.

File metadata

File hashes

Hashes for pypylon-4.2.0-cp39-abi3-macosx_14_0_x86_64.whl
Algorithm Hash digest
SHA256 75383fb9c6ed0d484e327f7bbe4047123f1e704a23a5c658eca1710a901c8bfe
MD5 5486ab79f7dc4b2c5d96f6e7fb1b5834
BLAKE2b-256 eb19ae12f9402fa65b4b653e1f7c3e7e7a7332c816ba08dd7ee8ccce9b6f01a8

See more details on using hashes here.

File details

Details for the file pypylon-4.2.0-cp39-abi3-macosx_14_0_arm64.whl.

File metadata

File hashes

Hashes for pypylon-4.2.0-cp39-abi3-macosx_14_0_arm64.whl
Algorithm Hash digest
SHA256 ee1c89eff3caba2212b29cc3b86ff589b0b1ca131e635a225ae4c37249cf9838
MD5 ff3e71a21144271931754075a9418d94
BLAKE2b-256 1d1df7e2237566bd4bd0bd38e3a6fb1a6c7ef88e19884290f258b33bdba5d8c5

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page