mindtrace-hardware 0.10.0

Hardware integration for Mindtrace

Mindtrace Hardware Module

The Mindtrace Hardware module provides a unified interface for managing industrial hardware components including 2D cameras, 3D stereo cameras, 3D scanners, PLCs, and sensors. Built with a service-first architecture, it supports multiple interface levels from simple scripts to distributed automation systems.

Table of Contents

• Overview
• Architecture
• Installation
• Camera System
• Stereo Camera System
• 3D Scanner System
• PLC System
• Sensor System
• CLI Tools
• Docker Deployment
• Configuration
• Testing
• API Reference
• Tested Hardware

Overview

The hardware module consists of five main subsystems:

• Camera System: Multi-backend camera management (Basler, GenICam, OpenCV) with bandwidth control
• Stereo Camera System: 3D vision with depth measurement and point cloud generation (Basler Stereo ace)
• 3D Scanner System: Industrial 3D scanning with multi-component capture (Photoneo)
• PLC System: Industrial PLC integration (Allen-Bradley) with tag-based operations
• Sensor System: Unified sensor interface for MQTT, HTTP, and Serial protocols

Each subsystem provides:

• Async-first interfaces with sync wrappers
• REST API service layer with MCP tool integration
• Python client libraries for programmatic access
• CLI tools for service management

Architecture

mindtrace/hardware/
├── cameras/                  # 2D camera subsystem
│   ├── core/                 # Camera, AsyncCamera, CameraManager
│   ├── backends/             # Basler, GenICam, OpenCV, Mock
│   └── homography/           # Planar measurement system
├── stereo_cameras/           # 3D stereo camera subsystem
│   ├── core/                 # StereoCamera, StereoCameraManager
│   └── backends/             # Basler Stereo ace
├── scanners_3d/              # 3D scanner subsystem
│   ├── core/                 # AsyncScanner3D, models
│   └── backends/             # Photoneo (harvesters + GenTL)
├── plcs/                     # PLC subsystem
│   ├── core/                 # PLCManager
│   └── backends/             # Allen-Bradley (Logix, SLC, CIP)
├── sensors/                  # Sensor subsystem
│   ├── core/                 # AsyncSensor, SensorManager
│   └── backends/             # MQTT, HTTP, Serial
├── services/                 # REST API services
│   ├── cameras/              # CameraManagerService
│   ├── stereo_cameras/       # StereoCameraService
│   ├── scanners_3d/          # Scanner3DService
│   ├── plcs/                 # PLCManagerService
│   └── sensors/              # SensorManagerService
├── cli/                      # Command-line tools
└── core/                     # Shared config, exceptions

Installation

# Base installation
pip install mindtrace-hardware

# With specific backend support
pip install mindtrace-hardware[cameras-basler]      # Basler cameras
pip install mindtrace-hardware[cameras-genicam]     # GenICam cameras
pip install mindtrace-hardware[cameras-all]         # All camera backends
pip install mindtrace-hardware[stereo-all]          # Stereo cameras
pip install mindtrace-hardware[scanners-3d]         # 3D scanners (Photoneo)
pip install mindtrace-hardware[plcs-all]            # PLC support

SDK Requirements

Hardware Type	Python Package	External SDK
Basler 2D	pypylon	Optional (Viewer/IP Configurator only)
GenICam	harvesters	Required (GenTL Producer)
Stereo ace	pypylon	Required (Supplementary Package)
Photoneo	harvesters	Required (Matrix Vision mvGenTL Producer)

SDK setup commands:

mindtrace-camera-basler install        # Basler Pylon tools (optional)
mindtrace-camera-genicam install       # GenICam CTI files (required)
mindtrace-stereo-basler install        # Stereo supplementary package (required)
mindtrace-scanner-photoneo install     # Matrix Vision mvGenTL Producer (required)

Camera System

Interface Hierarchy

Interface	Async	Multi-Camera	Bandwidth Mgmt	Service API
Camera	No	No	No	No
AsyncCamera	Yes	No	No	No
CameraManager	No	Yes	No	No
AsyncCameraManager	Yes	Yes	Yes	No
CameraManagerService	Yes	Yes	Yes	Yes

Basic Usage

from mindtrace.hardware.cameras.core.camera import Camera

# Simple synchronous usage
camera = Camera(name="OpenCV:opencv_camera_0")
image = camera.capture()
camera.configure(exposure=15000, gain=2.0)
camera.close()

Async Manager with Bandwidth Control

import asyncio
from mindtrace.hardware import CameraManager

async def capture_with_bandwidth_limit():
    async with CameraManager(max_concurrent_captures=2) as manager:
        cameras = manager.discover()
        proxy = await manager.open(cameras[0])
        image = await proxy.capture()
        await proxy.configure(exposure=15000)

asyncio.run(capture_with_bandwidth_limit())

Service Layer

from mindtrace.hardware.services import CameraManagerService

# Launch REST API + MCP tools
CameraManagerService.launch(port=8002, block=True)

Supported Backends

Backend	SDK	Use Case
Basler	pypylon	GigE industrial cameras
GenICam	harvesters	GenICam-compliant cameras
OpenCV	opencv-python	USB cameras, webcams
Mock	Built-in	Testing, CI/CD

Homography Measurement

Convert pixel coordinates to real-world measurements:

from mindtrace.hardware import HomographyCalibrator, HomographyMeasurer

# Calibrate
calibrator = HomographyCalibrator()
calibration = calibrator.calibrate_checkerboard(
    image=checkerboard_image,
    board_size=(8, 6),
    square_size=25.0,
    world_unit="mm"
)
calibration.save("calibration.json")

# Measure
measurer = HomographyMeasurer(calibration)
measured = measurer.measure_bounding_box(detection_bbox, target_unit="cm")
print(f"Size: {measured.width_world:.2f} x {measured.height_world:.2f} cm")

See Homography Documentation for details.

Stereo Camera System

Interface Hierarchy

Interface	Async	Multi-Camera	Service API
StereoCamera	Yes	No	No
StereoCameraManager	Yes	Yes	No
StereoCameraService	Yes	Yes	Yes

Basic Usage

import asyncio
from mindtrace.hardware.stereo_cameras import StereoCamera

async def capture_3d():
    camera = StereoCamera(name="BaslerStereoAce:40644640")
    await camera.initialize()

    # Capture stereo pair
    stereo_data = await camera.capture_rectified()

    # Generate point cloud
    point_cloud = await camera.capture_point_cloud()
    print(f"Points: {point_cloud.points.shape}")

    await camera.close()

asyncio.run(capture_3d())

Service Layer

# Via CLI
mindtrace-hw stereo start

# Programmatically
from mindtrace.hardware.services.stereo_cameras import StereoCameraService
StereoCameraService.launch(port=8004, block=True)

Configuration Parameters

Parameter	Description	Default
depth_range	Measurement range (min, max) in meters	(0.5, 3.0)
illumination_mode	AlwaysActive (fast) or AlternateActive (clean)	AlwaysActive
binning	Horizontal/vertical binning (1-4)	(1, 1)
depth_quality	Full, High, Normal, Low	Normal
exposure_time	Exposure in microseconds	8000.0
trigger_mode	continuous or trigger	continuous

See Stereo Camera Documentation for details.

3D Scanner System

Interface Hierarchy

Interface	Async	Multi-Scanner	Service API
AsyncScanner3D	Yes	No	No
Scanner3DService	Yes	Yes	Yes

Basic Usage

import asyncio
from mindtrace.hardware.scanners_3d import AsyncScanner3D

async def capture_scan():
    scanner = await AsyncScanner3D.open("Photoneo:DVJ-104")

    # Capture multi-component scan
    result = await scanner.capture(
        enable_range=True,
        enable_intensity=True,
        enable_confidence=True,
        enable_normal=True,
        enable_color=True,
    )
    print(f"Range: {result.range_shape}")
    print(f"Intensity: {result.intensity_shape}")

    # Generate point cloud
    point_cloud = await scanner.capture_point_cloud(include_colors=True)
    print(f"Points: {point_cloud.num_points}")
    point_cloud.save_ply("output.ply")

    await scanner.close()

asyncio.run(capture_scan())

Service Layer

# Via CLI
mindtrace-hw scanner3d start

# Programmatically
from mindtrace.hardware.services.scanners_3d import Scanner3DService
Scanner3DService.launch(port=8005, block=True)

Supported Backends

Backend	SDK	Hardware
Photoneo	harvesters + mvGenTL	PhoXi 3D Scanner (S/M/L/XL), MotionCam-3D
MockPhotoneo	Built-in	Testing and development (no hardware needed)

Capture Modalities

Modality	Description	Data Shape
Range	Depth/distance map	(H, W) float32
Intensity	Reflected light intensity	(H, W) float32
Confidence	Per-pixel confidence	(H, W) float32
Normal	Surface normal vectors	(H, W, 3) float32
Color	RGB color texture	(H, W, 3) uint8

Configuration Parameters

Operation Settings:

Parameter	Description	Options/Range
operation_mode	Scanner mode	Camera, Scanner, Mode_2D
coding_strategy	Structured light strategy	Normal, Interreflections, HighFrequency
coding_quality	Quality/speed tradeoff	Ultra, High, Fast
maximum_fps	Max frames per second	0-100

Exposure Settings:

Parameter	Description	Range
exposure_time	Exposure in milliseconds	10.24-100.352
shutter_multiplier	Shutter multiplier	1-10
scan_multiplier	Scan multiplier	1-10

Lighting Settings:

Parameter	Description	Range
led_power	LED illumination power	0-4095
laser_power	Laser/projector power	1-4095

Processing Settings:

Parameter	Description	Range
normals_estimation_radius	Normal estimation radius	0-4
max_inaccuracy	Maximum allowed inaccuracy	0-100
calibration_volume_only	Filter to calibration volume	bool
hole_filling	Enable hole filling	bool

Trigger Settings:

Parameter	Description	Options
trigger_mode	Trigger mode	Software, Hardware, Continuous
hardware_trigger_signal	Trigger edge	Falling, Rising, Both

Optimal Configuration for Accuracy

from mindtrace.hardware.scanners_3d import AsyncScanner3D, ScannerConfiguration, CodingQuality, CodingStrategy

async def high_accuracy_capture():
    scanner = await AsyncScanner3D.open()

    config = ScannerConfiguration(
        coding_quality=CodingQuality.ULTRA,
        coding_strategy=CodingStrategy.INTERREFLECTIONS,
        exposure_time=20.0,
        shutter_multiplier=2,
        led_power=4095,
        laser_power=4095,
        normals_estimation_radius=2,
        max_inaccuracy=3.0,
        hole_filling=True,
    )
    await scanner.set_configuration(config)

    point_cloud = await scanner.capture_point_cloud(include_colors=True)
    point_cloud.save_ply("high_accuracy.ply")

    await scanner.close()

See 3D Scanner Documentation for details.

PLC System

Supported Drivers

Driver	Target PLCs	Addressing
LogixDriver	ControlLogix, CompactLogix	Tag-based (Motor1_Speed)
SLCDriver	SLC500, MicroLogix	Data files (N7:0, B3:1)
CIPDriver	PowerFlex, I/O Modules	CIP objects (Parameter:10)

Basic Usage

import asyncio
from mindtrace.hardware import PLCManager

async def plc_operations():
    manager = PLCManager()
    await manager.register_plc("Line1", "192.168.1.100", plc_type="logix")
    await manager.connect_plc("Line1")

    # Read/write operations
    values = await manager.read_tags("Line1", ["Motor_Speed", "Status"])
    await manager.write_tag("Line1", "Command", True)

    await manager.cleanup()

asyncio.run(plc_operations())

Service Layer

# Via CLI
mindtrace-hw plc start

# Programmatically
from mindtrace.hardware.services import PLCManagerService
PLCManagerService.launch(port=8003, block=True)

See PLC Documentation for details.

Sensor System

Supported Backends

Protocol	Status
MQTT	Implemented
HTTP	Planned
Serial	Planned

Basic Usage

from mindtrace.hardware.sensors import AsyncSensor, MQTTSensorBackend

backend = MQTTSensorBackend("mqtt://localhost:1883")
async with AsyncSensor("temp001", backend, "sensors/temperature") as sensor:
    data = await sensor.read()
    print(f"Temperature: {data}")

See Sensor Documentation for details.

CLI Tools

Service Management

# Start services
mindtrace-hw camera start
mindtrace-hw stereo start
mindtrace-hw scanner3d start
mindtrace-hw plc start

# Check status
mindtrace-hw status

# Stop all services
mindtrace-hw stop

SDK Setup

# Basler 2D (optional - for Viewer/IP Configurator)
mindtrace-camera-basler install

# GenICam CTI files (required for GenICam cameras)
mindtrace-camera-genicam install

# Stereo supplementary package (required for stereo cameras)
mindtrace-stereo-basler install

# Matrix Vision mvGenTL Producer (required for Photoneo scanners)
mindtrace-scanner-photoneo install

# Verify Photoneo setup
mindtrace-scanner-photoneo verify

See CLI Documentation for details.

Docker Deployment

Pre-configured Docker images for each service:

Service	Port	Image
Camera	8002	mindtrace-camera
Stereo	8004	mindtrace-stereo
Scanner 3D	8005	mindtrace-scanner3d
PLC	8003	mindtrace-plc
Sensors	8006	mindtrace-sensors

# Build (from repo root)
docker build -f docker/hardware/camera/Dockerfile \
  --build-arg INSTALL_BASLER=true \
  -t mindtrace-camera:basler .

# Run (GigE cameras require host network)
docker run -d --network host mindtrace-camera:basler

# Verify
curl http://localhost:8002/health

See Docker Documentation for details.

Configuration

Environment Variables

# Camera settings
export MINDTRACE_HW_CAMERA_MAX_CONCURRENT_CAPTURES=2
export MINDTRACE_HW_CAMERA_DEFAULT_EXPOSURE=1000.0
export MINDTRACE_HW_CAMERA_TIMEOUT_MS=5000

# Stereo camera settings
export MINDTRACE_HW_STEREO_CAMERA_TIMEOUT_MS=20000
export MINDTRACE_HW_STEREO_CAMERA_DEPTH_RANGE_MIN=0.5
export MINDTRACE_HW_STEREO_CAMERA_DEPTH_RANGE_MAX=3.0
export MINDTRACE_HW_STEREO_CAMERA_ILLUMINATION_MODE=AlwaysActive
export MINDTRACE_HW_STEREO_CAMERA_DEPTH_QUALITY=Normal

# 3D scanner settings
export MINDTRACE_HW_SCANNER_TIMEOUT_MS=30000
export MINDTRACE_HW_SCANNER_EXPOSURE_TIME=20.0
export MINDTRACE_HW_SCANNER_CODING_QUALITY=Ultra
export MINDTRACE_HW_SCANNER_LED_POWER=4095
export MINDTRACE_HW_SCANNER_LASER_POWER=4095

# PLC settings
export MINDTRACE_HW_PLC_CONNECTION_TIMEOUT=10.0
export MINDTRACE_HW_PLC_READ_TIMEOUT=5.0

# Backend control
export MINDTRACE_HW_CAMERA_BASLER_ENABLED=true
export MINDTRACE_HW_CAMERA_GENICAM_ENABLED=true
export MINDTRACE_HW_SCANNER_PHOTONEO_ENABLED=true

Configuration File

{
  "cameras": {
    "max_concurrent_captures": 2,
    "timeout_ms": 5000
  },
  "stereo_cameras": {
    "timeout_ms": 20000,
    "depth_range_min": 0.5,
    "depth_range_max": 3.0,
    "illumination_mode": "AlwaysActive",
    "depth_quality": "Normal"
  },
  "scanners_3d": {
    "timeout_ms": 30000,
    "exposure_time": 20.0,
    "coding_quality": "Ultra",
    "coding_strategy": "Interreflections",
    "led_power": 4095,
    "laser_power": 4095
  },
  "plcs": {
    "connection_timeout": 10.0,
    "read_timeout": 5.0
  }
}

Testing

# Unit tests
pytest tests/unit/mindtrace/hardware/

# Integration tests
pytest tests/integration/mindtrace/hardware/

# With mock backends
export MINDTRACE_HW_CAMERA_MOCK_ENABLED=true
export MINDTRACE_HW_SCANNER_MOCK_ENABLED=true
pytest tests/

API Reference

Service Endpoints

Each service exposes REST endpoints at:

• Swagger UI: http://localhost:{port}/docs
• ReDoc: http://localhost:{port}/redoc

Service	Port	Documentation
Camera	8002	http://localhost:8002/docs
Stereo	8004	http://localhost:8004/docs
Scanner 3D	8005	http://localhost:8005/docs
PLC	8003	http://localhost:8003/docs

MCP Integration

Services automatically expose MCP tools:

{
  "mcpServers": {
    "mindtrace_cameras": {"url": "http://localhost:8002/mcp-server/mcp/"},
    "mindtrace_plcs": {"url": "http://localhost:8003/mcp-server/mcp/"},
    "mindtrace_stereo": {"url": "http://localhost:8004/mcp-server/mcp/"},
    "mindtrace_scanner3d": {"url": "http://localhost:8005/mcp-server/mcp/"}
  }
}

Exception Hierarchy

HardwareError
├── HardwareOperationError
├── HardwareTimeoutError
└── SDKNotAvailableError

CameraError
├── CameraNotFoundError
├── CameraCaptureError
├── CameraConnectionError
└── CameraConfigurationError

ScannerError
├── ScannerNotFoundError
├── ScannerCaptureError
├── ScannerConnectionError
└── ScannerConfigurationError

PLCError
├── PLCConnectionError
└── PLCTagError

Tested Hardware

The following hardware has been tested and validated with this module:

2D Cameras

Manufacturer	Model	Interface	Backend
Basler	ace series	GigE	Basler
Various	GenICam-compliant	GigE	GenICam

Stereo Cameras

Manufacturer	Model	Interface	Backend
Basler	Stereo ace (dual ace2 Pro)	GigE	BaslerStereoAce

3D Scanners

Manufacturer	Model	Interface	Backend
Photoneo	PhoXi 3D Scanner (S, M, L, XL)	GigE (GenTL)	Photoneo
Photoneo	MotionCam-3D / MotionCam-3D Color	GigE (GenTL)	Photoneo

PLCs

Manufacturer	Model	Protocol
Allen-Bradley	ControlLogix	EtherNet/IP
Allen-Bradley	CompactLogix	EtherNet/IP

License

Apache-2.0. See LICENSE file for details.