Table of Contents

Module: anyhw hwdriver/anyhw.py

Top class for all high-level hardware drivers.

This module contains the classes and methods that should be used for creation of hardware connections rather than the individual hardware specific subclasses.

The only exception is the dummydrv, which can be used to reconstruct a dummy hardware object from an image header. That functionality is not available at this abstract level.

The normal way to use this module is to do:

from hwdriver import anyhw
hardware=anyhw.default()

This will establish a connection to the default hardware.

Functions   
default
  default 
default (
        host=None,
        txtout=None,
        sink=None,
        )

Instantiate the default hardware device.

Depending on the configuration files, the default hardware can either be a KappaCCD driver, or a dummy driver. See the description of defaulthardwaretype in the configuration manual.

optional parameters:

txtout

a (pseudo) file where the communication output is copied.

sink

an image sink to be associated with the hardware object. If none is specified, a reasonable default will be created.

Classes   
Driver

Top-level hardware driver class.

PowerUp

Helper class to ensure proper power settings during a measurement.

RoundDetector
SquareDetector

Mixin class with functions specific for a square detector.

error

Exception raised in case of any hardware problems.

generatorerror

Exception raised when there is a problem with a generator setting.

poserror

Exception raised when there is a problem with a goniostat position.


Table of Contents

This document was automatically generated on Tue Nov 25 12:18:58 2008 by HappyDoc version WORKING