max-scw/baslercameraadapter

Provides a Python-based web-server to connect to a Basler camera (using PyPylon)

BaslerCameraAdapter

Provides a Python-based web-server REST API to connect to a Basler camera (using PyPylon)

It uses FastAPI to spin up a minimal web server that wraps the Python-package pypylon in a web-api. (This again wraps the Pylon Camera Software Suite into a Python-package.)

The new sever can be packaged as a virtual (Docker) container. Find released images on DockerHub under https://hub.docker.com/u/maxscw.

Structure

The repository is structured as follows:

BaslerCameraAdapter
+-- docs <- auxiliary files for documentation (basically screenshots)
|-- BaslerCamera.py <- python code to interact with a Basler camera
|-- BaslerCameraAdapter.Dockerfile  <- Dockerfile for camera service
|-- docker-compose.yml  <- exemplatory docker-compose call
|-- LICENSE
|-- main.py  <- fastAPI server to communicate with the Basler camera
|-- README.md
|-- requirements.txt  <- pip requirements
|-- utils_env_vars.py <- helper functions that provide the ability to configure the server

Usage

The default entrypoint (/) provides basic information but rather just assures that the server is up.

See docs (endpoint /docs) for details. This endpoint is the charm of FastAPI.

The documentation is automatically created with Swagger and provides and overview of all available endpoints as well as the ability to try them out with a convenient interface.

Installation

Python

python ./main.py

or use uvicorn directly (always assuming that all package requirements.txt are installed)

uvicorn main:app --host=0.0.0.0 --port=5051

Docker

Use a virtualization engine like docker or podman:

docker build --tag=camera-adapter -f BaslerCameraAdapter.Dockerfile .

or the corresponding compose plugins on the example file (docker-compose.yml):

docker compose up -d

See example file for configuration options via environment variables.

Acknowledgments / Disclaimer

This project is no official project of Basler. It relies on the official pypylon package which is available under the BSD 3-Clause License.

Author

• max-scw

Status

active