ChimeraTK DeviceAccess Python Bindings

Overview

ChimeraTK DeviceAccess Python Bindings provide Pythonic access to the ChimeraTK DeviceAccess library, a C++ device access library for register-based devices.

The bindings enable Python developers to:

  • Access hardware registers by name through an intuitive accessor interface

  • Read and write device data with automatic type conversion

  • Work with scalar, array, and structured data types

  • Utilize transfer groups for synchronized access to multiple registers

  • Leverage data consistency groups for coherent data reading

All read and write operations are synchronous and blocking until the data transfer is complete, asynchronous operations are available for push-based data updates.

Quick Start

To get started with the Python bindings, see the Getting Started guide for:

  • Installation instructions

  • Your first device access example

  • Basic accessor usage patterns

Tutorials and Examples

Learn by example with our comprehensive tutorials:

User Guide

For more detailed information, refer to the User Guide which covers:

  • Understanding accessors

  • Data type conversion

  • Error handling and exceptions

  • Best practices

  • Advanced features

API Reference

Complete API documentation is available in the API Reference section.

The main module is deviceaccess module which provides:

  • Device class for opening and managing connections

  • Various accessor types for different data structures

  • Register information retrieval

  • Transfer group and data consistency group management

Questions and Troubleshooting

Indices and Tables