sick_visionary_python_base

Table of Contents

• Overview
• License
• Supported Hardware
• Getting started
  • Linux
  • Windows PowerShell
• Support

Overview

This repository provides the base interfaces to access SICK Visionary devices. Using the classes in this module parameters can be queried and configured, status information can be accessed and 3D image data streams can be set up and controlled.

Supported protocols are:

• CoLa-B for parametrization as used by the Visionary-S CX device.

• CoLa-2 for parametrization as used by the Visionary-T Mini CX device.

• the SICK Blob format for streaming data.

License

The source code is released under The Unlicense.

Supported Hardware

device name	part no.	description	firmware version
Visionary-T Mini CX (V3S105-1AAAAAA)	1112649	3D time-of-flight camera	2.1.0 & ✔ 4.0.1
Visionary-S CX (V3S102-1AAAAAA, V3S102-1AABAAB)	1090184 1090185	3D structured light stereovision camera with RGB data	6.0.0 & ✔ 6.5.2

Getting started

Before you begin, ensure Python 3.8 or newer is installed on your system.

This repository provides setup scripts that create a virtual environment, install the package with its runtime dependencies, and install the local development tools from requirements.txt.

Linux

./setup_linux_env.sh
source .venv_python_base/bin/activate

Windows PowerShell

./setup_windows_env.ps1
.\.venv_python_base\Scripts\Activate.ps1

Manual setup (optional)

If you prefer to create the environment yourself:

python -m venv .venv_python_base
# Linux/macOS
source .venv_python_base/bin/activate
# Windows PowerShell
# .\.venv_python_base\Scripts\Activate.ps1
python -m pip install --upgrade pip
python -m pip install -r requirements.txt
pre-commit install

The package runtime dependencies are declared in pyproject.toml. The requirements.txt file installs the package in editable mode and adds the local formatting and linting tools used by pre-commit.

Support

Depending on the nature of your question, there are two support channels:

1. For questions regarding the code shared in this repo please check the FAQ first and search if an issue already exists. If a related issue doesn’t exist, you can open a new issue using the issue form.

2. For application or device specific questions look for common solutions and knowledge articles on the Sick Support Portal. If your question is not answered there, open a ticket on the Sick Support Portal.