imatest-control

imatest-control

Version: 1.28.12916488 - Release Date: 2.7.2025

imatest-control basics

The Api has a primary class called ControlSystem. Typically 1 of these needs to be instantiated.

Once the ControlSystem is instantiated, Controllers can be added to the ControlSystem. Likewise, Devices can be added to the Controllers.

After Adding Controllers and Devices, calling ControlSystem.initializeDevices() will connect to all added controllers and devices.

Once Initialized, Commands can be added to devices. If multiple commands are added to a device, the commands are queued.

In order to run the commands, call ControlSystem.Update() or ControlSystem.processAll()

ControlSystem.processAll() updates all commands incrementally and waits until all commands are finished.

Commands

A Command is created by creating command package and adding it to the device:

motionCommand = cntr.MovementCommandPackage()
motionCommand.disp_target = 30
commandStatus = controlSystem.addDeviceCommand(device, motionCommand, flags)

A command will be created with the parameters given in the passed in DeviceCommandPackage.

The following example shows a basic program that controls a “Dummy” Device (a device that does not have actual hardware)

from imatest import control as cntr

import time
import os



#create a Control System
system = cntr.ControlSystem()


#Add Dummy Controller
testCnt = cntr.DummyController()
system.addDeviceController(testCnt)

#Create Dummy Device
testDevice = cntr.DummyDeviceInfo()
testDevice.alias = "test_device"

#Add Dummy Device to Controller
testCnt.addDeviceInfo(testDevice)

#Initialize the devices
system.initializeDevices()


#Add Commands
if(testCnt.isConnected()):
    motionCommand = cntr.MovementCommandPackage()

    #set displacement target
    motionCommand.disp_target = 30
    lastCommand = system.addDeviceCommand(testDevice, motionCommand)


    #Wait until command is finished.
    lastCommand.runFull()


    motionCommand = cntr.MovementCommandPackage()
    motionCommand.disp_target = 0
    lastCommand = system.addDeviceCommand(testDevice, motionCommand)

    #Wait until command is finished.
    lastCommand.runFull()

    motionCommand = cntr.MovementCommandPackage()
    #set displacement target
    motionCommand.disp_target = 50
    lastCommand = system.addDeviceCommand(testDevice, motionCommand)

    #Wait until command is finished.
    lastCommand.runFull()

system.unInitialize()
print("example finished.")

imatest-control examples

KinoFlo_Example

LEDLightBox_Example

from imatest import control as cntr

import time

#Create the Control System 
system = cntr.ControlSystem()

#Optionally Mute Console Print Outs
#system.MuteConsole()

#Add LEDLightBox Controller (LedLightBoxController)
lightBoxCntr = cntr.LedLightBoxController()
lightBoxCntr.port = "COM14"
system.addDeviceController(lightBoxCntr)


#Add LightBox device 
dev1 = cntr.LedLightBoxDevice_High_LUX_LED_Box_Mixed_Info()
dev1.alias = "lightbox"
lightBoxCntr.addDeviceInfo(dev1)


#Control system will connect to devices
system.initializeDevices()



if(lightBoxCntr.isConnected()):


    #Create Commands For Lightbox 1
    command0 = cntr.LedLightBoxCommand_Lighting()
    command0.dimmerIntensityPercent = 0.5
    command0.highLowSetting = False
    command0.colorTemperaturePerc = 0.0
    commandStatus0 = system.addDeviceCommand_Alias("lightbox", command0)

    commandStatus0.runFull()
    time.sleep(2.0)

    command1 = cntr.LedLightBoxCommand_Lighting()
    command1.dimmerIntensityPercent = 0.5
    command1.highLowSetting = True
    command1.colorTemperaturePerc = 0.0
    commandStatus1 = system.addDeviceCommand_Alias("lightbox", command1)

    commandStatus1.runFull()
    time.sleep(2.0)

    command2 = cntr.LedLightBoxCommand_Lighting()
    command2.dimmerIntensityPercent = 0.5
    command2.highLowSetting = False
    command2.colorTemperaturePerc = 1.0
    system.addDeviceCommand_Alias("lightbox", command2)


system.unInitialize()
print("finished")

Zaber_Example

import time
from imatest import control as cntr





system = cntr.ControlSystem()

#Add Zaber Controller
zabCnt = cntr.zaberController()
zabCnt.com_type = "software_serial"
zabCnt.port = "COM7"

system.addDeviceController(zabCnt)

#Add Zaber Device On Controller
dev1 = cntr.ZaberDeviceInfo()
dev1.zaberDeviceAddress = 2
dev1.alias = "slider"
axisInfo = cntr.ZaberAxisInfo()
axisInfo.alias = "primary axis"
dev1.AddAxisInfo(axisInfo)

zabCnt.addDeviceInfo(dev1)


system.initializeDevices()



#Add Zaber Slider Commands
if(zabCnt.isConnected()):
    motionCommand = cntr.MovementCommandPackage()
    motionCommand.disp_target = 30;
    lastCommand = system.addDeviceCommand(dev1, motionCommand)

    lastCommand.runFull()

    motionCommand = cntr.MovementCommandPackage()
    motionCommand.disp_target = 0
    lastCommand = system.addDeviceCommand(dev1, motionCommand)

    lastCommand.runFull()

    motionCommand = cntr.MovementCommandPackage()
    motionCommand.disp_target = 50
    lastCommand = system.addDeviceCommand(dev1, motionCommand);

    lastCommand.runFull()



system.unInitialize()

RoboClaw(actuator)_Example

BenchTopTestStand(Manual_Zaber)_Example

from imatest import control as cntr

import time



system = cntr.ControlSystem()



zaberCont = cntr.zaberController();
zaberCont.alias = "BTS_ZaberController";
zaberCont.port = "COM3";


xAxisDev = cntr.ZaberDeviceInfo();
xAxisDev.alias = "X-Axis";
xAxisInfo = cntr.ZaberAxisInfo();
xAxisInfo.alias = "XAxis";
xAxisInfo.type = "linear";
xAxisInfo.minAccLimit = 14;
xAxisInfo.maxAccLimit = 30;
xAxisDev.zaberDeviceAddress = 2;
xAxisDev.AddAxisInfo(xAxisInfo);

zAxisDev = cntr.ZaberDeviceInfo();
zAxisDev.alias = "Z-Axis";
zAxisDev.zaberDeviceAddress = 1;
zAxisInfo = cntr.ZaberAxisInfo();
zAxisInfo.alias = "ZAxis";
zAxisInfo.type = "linear";
zAxisInfo.minAccLimit = 14;
zAxisInfo.maxAccLimit = 30;

zAxisDev.AddAxisInfo(zAxisInfo);

#zAxisDev.setEnableCommandLogging(True)

zaberCont.addDeviceInfo(xAxisDev);
zaberCont.addDeviceInfo(zAxisDev);

system.addDeviceController(zaberCont);

system.initializeDevices()



#Add Zaber Slider Commands
zCommand = cntr.ZaberCommandSetAxisMovement()
zCommand.disp_target = 800
zCommandStatus = zAxisDev.addCommand(zCommand)

xCommand = cntr.ZaberCommandSetAxisMovement()
xCommand.disp_target = 30
xCommandStatus = xAxisDev.addCommand(xCommand)

zCommandStatus.runFull()
xCommandStatus.runFull()


zCommand = cntr.ZaberCommandSetAxisMovement()
zCommand.disp_target = 900
zCommandStatus2 = zAxisDev.addCommand(zCommand)

xCommand = cntr.ZaberCommandSetAxisMovement()
xCommand.disp_target = 100
xCommandStatus2 = xAxisDev.addCommand(xCommand)

zCommandStatus2.runFull()
xCommandStatus2.runFull()

system.unInitialize()

BenchTopTestStand_Example

from imatest import control as cntr

import time

#create a control system.
system = cntr.ControlSystem()

#refer to BTS manual for pictures showing the Coordinate System.
frame = cntr.BTSFraming()

#specify zaber com port
frame.zaberPort = "COM7"

#initialize the frame. (connect)
frame.initialize(system)

#apply calibration offset if previously used the BTSFraming calibration routines. otherwise dont use.
frame.calibrationOffset = cntr.Vector3D(0,0,-3.54612)

#move the frame to the home reference position.
frame.Home()

#move the center of the chart to 114 mm away from the camera center frame point.
frame.chartCenterFrame_Go_CameraCenterFrame(cntr.Vector3D(0,0,114))

#print the position of the center of the chart relative to the camera center frame point.
print(f'{frame.chartCenterFrame_CameraCenterFrame.x},{frame.chartCenterFrame_CameraCenterFrame.y},{frame.chartCenterFrame_CameraCenterFrame.z}')

system.unInitialize()

imatest-control reference

class controlAPI.ApiCommandPackage

Bases: object

Base Class for command packages

property alias

user definable unique alias for this command package

className()

static staticClassName()

property thisown

The membership flag

controlAPI.As_MovementCommandPackage(obj)

controlAPI.As_MovementStateInfo(obj)

Dynamic Cast a CommandStateInfo pointer into a MovementStateInfo pointer

controlAPI.As_ZaberCommandGetStorageKey(package)

controlAPI.As_ZaberCommandSetAxisMovement(package)

controlAPI.As_ZaberCommandSetStorageKey(package)

class controlAPI.BTSFraming

Bases: CompositeFrameBase

<summary> BTSFraming class, contains methods for control of BTS frames. all dimension Units are in millimeters

https://drive.google.com/file/d/1pRtOPzCtmoEOHzolEsyHNhHvKwgjnRsm/view?usp=drive_link

<summary>

property ChartCenterHome_CameraCenterFrame

<summary> Chart center home position in the cameracenter frame. Units: millimeters <summary>

Home()

Command targetMountFrame to go to TargetMountHome position use if axis’ have been moved manually or without power to reset the BTSFrame.

property calibrationOffset

<summary> Calibration offset (can be obtained by calling doCalibrationAndValidation) <summary> <param name=”calibration”><param>

cameraCenterFrame_To_homeFrame(cameraSpace)

<summary> Transform vector from cameraCenterFrame to homeFrame <summary> <param name=”cameraSpace”><param> <returns><returns>

property chartCenterFrame_CameraCenterFrame

<summary> Current relative location of the chartCenter to the CameraCenter <summary>

chartCenterFrame_Go_CameraCenterFrame(cameraSpace)

<summary> Command the chartCenterFrame to move to a location relative to the CameraFrame <summary>

chartCenterFrame_Go_ChartCenterHomeFrame(homeSpace)

<summary> Command the chartCenterFrame to go somewhere relative to the chartCenterHomeFrame <summary> <param name=”homeSpace”><param>

className()

doCalibrationAndValidation()

<summary> Do calibration and validation routine. prompts the user for micrometer reading. reports validation meaurements returns calibration offset for use later. <summary> <returns><returns>

homeFrame_To_cameraCenterFrame(homeSpace)

<summary> Transform vector in the homeFrame to cameraCenterFrame. <summary> <param name=”homeSpace”><param> <returns><returns>

initialize(system)

initialize the frame using the given config. :param config:

property stageAcceleration

<summary> Acceleration to command the stages to use. <summary>

property stageVelocity

<summary> Velocity to command the stages to use. <summary>

static staticClassName()

property system

property thisown

The membership flag

zaberCont()

zaberDevice1()

zaberDevice1Axis()

zaberDevice2()

zaberDevice2Axis()

property zaberPort

<summary> Serial Port for zaber (ex “COM4”) Set Before initialization. <summary>

class controlAPI.BTSFramingCommandStatusSet(*args, **kwargs)

Bases: CompositeCommandStatusSet

className()

initialize()

<summary> Start the command by internally initializing the thread, binding to the device, and ensuring it is ready to be updated. <summary> <returns><returns>

isBusy()

returns true if the command is currently running

isCancelled()

returns true if the command was cancelled.

isFinished()

returns true if the command has finished. (normally finished or cancelled).

isSuccessful()

isUpdateStepReady()

runASync()

<summary> initialize and start the command async. <summary> <returns><returns>

runFull()

<summary> initializes, and runs the command until it stops (blocking) <summary> <returns><returns>

static staticClassName()

stop()

End the command (cancel)

property thisown

The membership flag

update(stepped=False)

<summary> update the command by allowing it to begin. if stepped = true, will begin to perform 1 update. if stepped = false, will update until finished. <summary> <param name=”stepped”><param> <returns><returns>

updateoverride(stepped=False)

waitFinished()

<summary> Wait for the command to finish. <summary>

waitUpdateReady()

<summary> Wait until command is ready to begin a update step <summary> <returns><returns>

waitUpdateReadyOrFinished()

<summary> Wait until command is ready to begin an update step or it is finished. <summary> <returns><returns>

property xAxis

property zAxis

class controlAPI.CommandCallbacks

Bases: object

DEPRECIATED Base Clase to be overridden by user exposing methods called on command state changes.

className()

onCommandFinished(commandStatus, deviceInfo)

Called when a Command Finishes.

onCommandUpdate(commandStatus, deviceInfo)

Called during command execution

static staticClassName()

property thisown

The membership flag

class controlAPI.CommandStateInfo

Bases: object

className()

property percentFinished

<summary> percentage to command completion. <summary>

static staticClassName()

property thisown

The membership flag

class controlAPI.CommandStatus

Bases: CommandStatusControlMethods

Command Status Object for tracking the current state of a queued or executing command.

property alias

The unique alias for this command.

apiId()

className()

commandPackage()

<summary> The command package associated with the command. <summary> <returns><returns>

controlSystem()

<summary> The control system this command status belongs to. <summary> <returns><returns>

deviceApiId()

deviceController()

<summary> The device controller this command status is associated with. <summary> <returns><returns>

deviceInfo()

<summary> The device this command status is associated with. <summary> <returns><returns>

initialize()

<summary> Start the command by internally initializing the thread, binding to the device, and ensuring it is ready to be updated. <summary> <returns><returns>

isBusy()

returns true if the command is currently running

isCancelled()

returns true if the command was cancelled.

isFinished()

returns true if the command has finished. (normally finished or cancelled).

isSuccessful()

isUpdateStepReady()

runASync()

<summary> initialize and start the command async. <summary> <returns><returns>

runFull()

<summary> initializes, and runs the command until it stops (blocking) <summary> <returns><returns>

stateInfo()

<summary> The command state information associated with the command. <summary> <returns><returns>

static staticClassName()

stop()

End the command (cancel)

property thisown

The membership flag

update(stepped=False)

<summary> update the command by allowing it to begin. if stepped = true, will begin to perform 1 update. if stepped = false, will update until finished. <summary> <param name=”stepped”><param> <returns><returns>

waitFinished()

<summary> Wait for the command to finish. <summary>

waitUpdateReady()

<summary> Wait until command is ready to begin a update step <summary> <returns><returns>

waitUpdateReadyOrFinished()

<summary> Wait until command is ready to begin an update step or it is finished. <summary> <returns><returns>

class controlAPI.CommandStatusControlMethods(*args, **kwargs)

Bases: object

Base class for implementing methods for CommandStatus objects.

className()

initialize()

<summary> Start the command by internally initializing the thread, binding to the device, and ensuring it is ready to be updated. <summary> <returns><returns>

isBusy()

returns true if the command is currently running

isCancelled()

returns true if the command was cancelled.

isFinished()

returns true if the command has finished. (normally finished or cancelled).

isSuccessful()

isUpdateStepReady()

runASync()

<summary> initialize and start the command async. <summary> <returns><returns>

runFull()

<summary> initializes, and runs the command until it stops (blocking) <summary> <returns><returns>

static staticClassName()

stop()

End the command (cancel)

property thisown

The membership flag

update(stepped=False)

<summary> update the command by allowing it to begin. if stepped = true, will begin to perform 1 update. if stepped = false, will update until finished. <summary> <param name=”stepped”><param> <returns><returns>

waitFinished()

<summary> Wait for the command to finish. <summary>

waitUpdateReady()

<summary> Wait until command is ready to begin a update step <summary> <returns><returns>

waitUpdateReadyOrFinished()

<summary> Wait until command is ready to begin an update step or it is finished. <summary> <returns><returns>

class controlAPI.CommunicationCommandPackage

Bases: DeviceCommandPackage

Generic Command to communicate with a device.

property alias

user definable unique alias for this command package

className()

cloneFrom(other)

clone from another device package - should be implemented for custom types. :type other: DeviceCommandPackage :param other:

property continuous

set to true if command is a continous (async/time consuming) command or if it is desired that the command run indefinitely. (tracking command etc) set to false if the command should terminate once a target is reached.

createSharedPtr()

markUpdatePackageReady()

signal the update package is ready to be used in running commands. prepareUpdatePackage() should be called first.

property outgoingBuffer

prepareUpdatePackage()

Creates/Returns the DeviceCommandPackage to be used for updates to a running command. Update package will be a shallow copy of this package. It is expected that markUpdatePackageReady() be called after update package is altered. :rtype: DeviceCommandPackage :return: DeviceCommandPackage*

static staticClassName()

property thisown

The membership flag

class controlAPI.CompositeCommandStatusSet(*args, **kwargs)

Bases: CommandStatusControlMethods

base class for giving access to composite command status sets. and functions to manage groups of commands etc.

className()

initialize()

<summary> Start the command by internally initializing the thread, binding to the device, and ensuring it is ready to be updated. <summary> <returns><returns>

isBusy()

returns true if the command is currently running

isCancelled()

returns true if the command was cancelled.

isFinished()

returns true if the command has finished. (normally finished or cancelled).

isSuccessful()

isUpdateStepReady()

runASync()

<summary> initialize and start the command async. <summary> <returns><returns>

runFull()

<summary> initializes, and runs the command until it stops (blocking) <summary> <returns><returns>

static staticClassName()

stop()

End the command (cancel)

property thisown

The membership flag

update(stepped=False)

<summary> update the command by allowing it to begin. if stepped = true, will begin to perform 1 update. if stepped = false, will update until finished. <summary> <param name=”stepped”><param> <returns><returns>

updateoverride(stepped=False)

waitFinished()

<summary> Wait for the command to finish. <summary>

waitUpdateReady()

<summary> Wait until command is ready to begin a update step <summary> <returns><returns>

waitUpdateReadyOrFinished()

<summary> Wait until command is ready to begin an update step or it is finished. <summary> <returns><returns>

class controlAPI.CompositeFrameBase

Bases: object

className()

static staticClassName()

property system

property thisown

The membership flag

class controlAPI.ControlSystem(*args)

Bases: LoggerFunctionality

Primary class for managing upper-level control over a multi-axis system with different devices. Supports addition of Devices, Controllers, and Control/Commands

addDeviceCommand(device, package)

Add a command to a device.

addDeviceCommandAlias(deviceAlias, package)

Add a command to a device using device alias string

addDeviceCommandDevId(deviceId, package)

Add a command to a device using device id

addDeviceController(controller)

Add a device controller to the control system.

className()

delay(*args)

Overload 1: Add a time delay command to a device

Overload 2: Add a time delay command to a device

getControllerFromAlias(controllerAlias)

Get a controller from its alias string

getDeviceFromAlias(deviceAlias)

Get a device from its alias string

getLogger()

initializeController(controller)

initFriendlyNameBuffer an added device controller.

initializeDevices()

initFriendlyNameBuffer (start initial communication and do checks) on all added controllers/devices

loggerName()

muteConsole()

Mute info messages on console.

runASyncCommandList(commandList)

<summary> Start the list of commands running async, returns immediately. <summary> <param name=”commandList”><param>

runFullCommandListParallel(commandList)

<summary> Run Commands in parallel <summary> <param name=”commandList”><param>

runFullCommandListSeq(commandList)

<summary> Run Commands in order, one after another, fully <summary> <param name=”commandList”><param>

setCommandCallback(callbackObj)

Attach a CommandCallbacks object to the ControlSystem.

static staticClassName()

property thisown

The membership flag

unInitialize()

<summary> De initialize the control system. disconnecting all controllers and devices. user created controllers and devices should remain allocated while this function is called - then can be freed/released afterwards. <summary>

unMuteConsole()

UnMute info message on console.

waitFinishedCommandList(commandList)

<summary> Wait for the list of commands to complete <summary> <param name=”commandList”><param>

class controlAPI.DMXDeviceCommandLightingPackage

Bases: DMXDeviceCommandPackage

<summary> base class for dmx lighting command packages <summary>

property alias

user definable unique alias for this command package

className()

cloneFrom(other)

clone from another device package - should be implemented for custom types. :type other: DeviceCommandPackage :param other:

property continuous

set to true if command is a continous (async/time consuming) command or if it is desired that the command run indefinitely. (tracking command etc) set to false if the command should terminate once a target is reached.

createSharedPtr()

markUpdatePackageReady()

signal the update package is ready to be used in running commands. prepareUpdatePackage() should be called first.

prepareUpdatePackage()

Creates/Returns the DeviceCommandPackage to be used for updates to a running command. Update package will be a shallow copy of this package. It is expected that markUpdatePackageReady() be called after update package is altered. :rtype: DeviceCommandPackage :return: DeviceCommandPackage*

static staticClassName()

property thisown

The membership flag

class controlAPI.DMXDeviceCommandPackage

Bases: DeviceCommandPackage

<summary> base class for dmx command packages <summary>

property alias

user definable unique alias for this command package

className()

cloneFrom(other)

clone from another device package - should be implemented for custom types. :type other: DeviceCommandPackage :param other:

property continuous

set to true if command is a continous (async/time consuming) command or if it is desired that the command run indefinitely. (tracking command etc) set to false if the command should terminate once a target is reached.

createSharedPtr()

markUpdatePackageReady()

signal the update package is ready to be used in running commands. prepareUpdatePackage() should be called first.

prepareUpdatePackage()

Creates/Returns the DeviceCommandPackage to be used for updates to a running command. Update package will be a shallow copy of this package. It is expected that markUpdatePackageReady() be called after update package is altered. :rtype: DeviceCommandPackage :return: DeviceCommandPackage*

static staticClassName()

property thisown

The membership flag

class controlAPI.DMXDeviceCommand_HSLColor8Bit

Bases: DMXDeviceCommandLightingPackage

<summary> command to set the hsl color of a dmx lighting device <summary>

property alias

user definable unique alias for this command package

className()

cloneFrom(other)

clone from another device package - should be implemented for custom types. :type other: DeviceCommandPackage :param other:

property continuous

set to true if command is a continous (async/time consuming) command or if it is desired that the command run indefinitely. (tracking command etc) set to false if the command should terminate once a target is reached.

createSharedPtr()

property h

<summary> hue <summary>

property l

<summary> lightness <summary>

markUpdatePackageReady()

signal the update package is ready to be used in running commands. prepareUpdatePackage() should be called first.

prepareUpdatePackage()

Creates/Returns the DeviceCommandPackage to be used for updates to a running command. Update package will be a shallow copy of this package. It is expected that markUpdatePackageReady() be called after update package is altered. :rtype: DeviceCommandPackage :return: DeviceCommandPackage*

property s

<summary> saturation <summary>

static staticClassName()

property thisown

The membership flag

class controlAPI.DMXDeviceCommand_RGBColor8Bit

Bases: DMXDeviceCommandLightingPackage

<summary> command to set the rgb color of a dmx lighting device <summary>

property alias

user definable unique alias for this command package

property blue

className()

cloneFrom(other)

clone from another device package - should be implemented for custom types. :type other: DeviceCommandPackage :param other:

property continuous

set to true if command is a continous (async/time consuming) command or if it is desired that the command run indefinitely. (tracking command etc) set to false if the command should terminate once a target is reached.

createSharedPtr()

property green

markUpdatePackageReady()

signal the update package is ready to be used in running commands. prepareUpdatePackage() should be called first.

prepareUpdatePackage()

Creates/Returns the DeviceCommandPackage to be used for updates to a running command. Update package will be a shallow copy of this package. It is expected that markUpdatePackageReady() be called after update package is altered. :rtype: DeviceCommandPackage :return: DeviceCommandPackage*

property red

static staticClassName()

property thisown

The membership flag

class controlAPI.DMXDeviceCommand_SetPersonality

Bases: DMXDeviceCommandPackage

<summary> command to set the dmx personality of a dmx lighting device <summary>

property alias

user definable unique alias for this command package

className()

cloneFrom(other)

clone from another device package - should be implemented for custom types. :type other: DeviceCommandPackage :param other:

property continuous

set to true if command is a continous (async/time consuming) command or if it is desired that the command run indefinitely. (tracking command etc) set to false if the command should terminate once a target is reached.

createSharedPtr()

markUpdatePackageReady()

signal the update package is ready to be used in running commands. prepareUpdatePackage() should be called first.

property personalityIndex

prepareUpdatePackage()

Creates/Returns the DeviceCommandPackage to be used for updates to a running command. Update package will be a shallow copy of this package. It is expected that markUpdatePackageReady() be called after update package is altered. :rtype: DeviceCommandPackage :return: DeviceCommandPackage*

static staticClassName()

property thisown

The membership flag

class controlAPI.DMXDeviceInfo

Bases: DeviceInfo

property DMXBaseAddress

addCommandGeneric(package)

property alias

property apiDeviceId

className()

commandLoggingEnabled()

commandLoggingLevel()

controlSystem()

access to owning control system.

deviceController()

access to owning controller.

initializeCommand(commandPackage)

isConnected()

Returns true is the device is currently connected.

property numChannels

preLoopCommandCheck(checkCancelled=True)

setCommandLoggingLevel(level)

Set the command logging level, 0 - regular, 1 - more detail, 2 - even more detail, etc. :type level: int :param level:

setEnableCommandLogging(enable)

set the device to log messages to the console. (default true) :type enable: boolean :param enable:

static staticClassName()

property thisown

The membership flag

class controlAPI.DeviceCommandPackage

Bases: ApiCommandPackage

Base Class containing command parameters needed to run a command for a device. The package is referenced during command updating. so parameters can be changed during command execution.

property alias

user definable unique alias for this command package

className()

cloneFrom(other)

clone from another device package - should be implemented for custom types. :type other: DeviceCommandPackage :param other:

property continuous

set to true if command is a continous (async/time consuming) command or if it is desired that the command run indefinitely. (tracking command etc) set to false if the command should terminate once a target is reached.

createSharedPtr()

markUpdatePackageReady()

signal the update package is ready to be used in running commands. prepareUpdatePackage() should be called first.

prepareUpdatePackage()

Creates/Returns the DeviceCommandPackage to be used for updates to a running command. Update package will be a shallow copy of this package. It is expected that markUpdatePackageReady() be called after update package is altered. :rtype: DeviceCommandPackage :return: DeviceCommandPackage*

static staticClassName()

property thisown

The membership flag

class controlAPI.DeviceController

Bases: LoggerFunctionality

Base Class For Controlling Devices

addDeviceInfo(dev)

<summary> Add a device to the controller. <summary> <param name=”dev”><param>

property alias

Alias of the controller

apiId()

the assigned Api Id of the controller

checkCommandPackage(deviceId, package)

check validity of command package

className()

disconnect(expected=False)

disconnect the controller, should handle both a manual disconnect and could be called from a comm error disconnect. set expected to false if called from a timeout error or unknown disconnect event. - error messages are printed. set expected to true if a manual disconnection is wanted.- info messages are printed.

getLogger()

isConnected()

returns true if the controller is currently connected.

isSimulated()

return if the controller is simulated. :rtype: boolean :return:

loggerName()

property port

port for connecting, if the device is a serial device this can be “COM3” or “/dev/tty.***”

removeDeviceInfo(dev)

Remove an already added device.

setDisconnectCallback(callback)

set a disconnected callback function to be called when the controller is disconnected.

setSimulated(simulated)

set the simulated flag on the controller - simulated controllers can simulate interaction with attached devices. can only be set before the controller is initialized. :type simulated: boolean :param simulated:

static staticClassName()

property thisown

The membership flag

class controlAPI.DeviceInfo

Bases: HardwareInfo

Base Class for describing a device to be attached to a DeviceController

addCommandGeneric(package)

property alias

property apiDeviceId

className()

commandLoggingEnabled()

commandLoggingLevel()

controlSystem()

access to owning control system.

deviceController()

access to owning controller.

initializeCommand(commandPackage)

isConnected()

Returns true is the device is currently connected.

preLoopCommandCheck(checkCancelled=True)

setCommandLoggingLevel(level)

Set the command logging level, 0 - regular, 1 - more detail, 2 - even more detail, etc. :type level: int :param level:

setEnableCommandLogging(enable)

set the device to log messages to the console. (default true) :type enable: boolean :param enable:

static staticClassName()

property thisown

The membership flag

class controlAPI.DummyController

Bases: DeviceController

<summary> Fully Virtual Controller Example used for controlling DummyDevices

BeginMotion(apiDeviceId)

addDeviceInfo(dev)

<summary> Add a device to the controller. <summary> <param name=”dev”><param>

property alias

Alias of the controller

apiId()

the assigned Api Id of the controller

checkCommandPackage(deviceId, package)

check validity of command package

className()

disconnect(expected=False)

disconnect the controller, should handle both a manual disconnect and could be called from a comm error disconnect. set expected to false if called from a timeout error or unknown disconnect event. - error messages are printed. set expected to true if a manual disconnection is wanted.- info messages are printed.

getLogger()

isConnected()

returns true if the controller is currently connected.

isSimulated()

return if the controller is simulated. :rtype: boolean :return:

loggerName()

property port

port for connecting, if the device is a serial device this can be “COM3” or “/dev/tty.***”

removeDeviceInfo(dev)

Remove an already added device.

setDisconnectCallback(callback)

set a disconnected callback function to be called when the controller is disconnected.

setSimulated(simulated)

set the simulated flag on the controller - simulated controllers can simulate interaction with attached devices. can only be set before the controller is initialized. :type simulated: boolean :param simulated:

static staticClassName()

property thisown

The membership flag

class controlAPI.DummyDeviceInfo

Bases: DeviceInfo

addCommand(package)

addCommandGeneric(package)

property alias

property apiDeviceId

className()

commandLoggingEnabled()

commandLoggingLevel()

controlSystem()

access to owning control system.

deviceController()

access to owning controller.

initializeCommand(commandPackage)

isConnected()

Returns true is the device is currently connected.

preLoopCommandCheck(checkCancelled=True)

setCommandLoggingLevel(level)

Set the command logging level, 0 - regular, 1 - more detail, 2 - even more detail, etc. :type level: int :param level:

setEnableCommandLogging(enable)

set the device to log messages to the console. (default true) :type enable: boolean :param enable:

static staticClassName()

property thisown

The membership flag

property updateDelayTime_S

class controlAPI.EntTecController

Bases: dmxController

<summary> controller for EntTec DMX USB Pro <summary>

addDeviceInfo(dev)

<summary> Add a device to the controller. <summary> <param name=”dev”><param>

property alias

Alias of the controller

apiId()

the assigned Api Id of the controller

checkCommandPackage(deviceId, package)

check validity of command package

className()

disconnect(expected=False)

disconnect the controller, should handle both a manual disconnect and could be called from a comm error disconnect. set expected to false if called from a timeout error or unknown disconnect event. - error messages are printed. set expected to true if a manual disconnection is wanted.- info messages are printed.

getLogger()

isConnected()

returns true if the controller is currently connected.

isSimulated()

return if the controller is simulated. :rtype: boolean :return:

loggerName()

property port

port for connecting, if the device is a serial device this can be “COM3” or “/dev/tty.***”

removeDeviceInfo(dev)

Remove an already added device.

setDisconnectCallback(callback)

set a disconnected callback function to be called when the controller is disconnected.

setSimulated(simulated)

set the simulated flag on the controller - simulated controllers can simulate interaction with attached devices. can only be set before the controller is initialized. :type simulated: boolean :param simulated:

static staticClassName()

property thisown

The membership flag

class controlAPI.ExoLight2DeviceInfo

Bases: DeviceInfo

<summary> Device Info for the ExoLight2 device. <summary>

addCommandGeneric(package)

property alias

property apiDeviceId

property channel

<summary> Channel as attached to the Metaphase ULC2 controller (1 or 2) <summary>

className()

commandLoggingEnabled()

commandLoggingLevel()

controlSystem()

access to owning control system.

deviceController()

access to owning controller.

property driveMode

<summary> Drive Control Mode <summary>

initializeCommand(commandPackage)

isConnected()

Returns true is the device is currently connected.

property modeDCSettings

property modeStrobeSettings

property modeVoltageSettings

property outputEnabled

<summary> Enable output to LED <summary>

preLoopCommandCheck(checkCancelled=True)

setCommandLoggingLevel(level)

Set the command logging level, 0 - regular, 1 - more detail, 2 - even more detail, etc. :type level: int :param level:

setEnableCommandLogging(enable)

set the device to log messages to the console. (default true) :type enable: boolean :param enable:

static staticClassName()

property thisown

The membership flag

property triggerControlsDC

<summary>

<summary>

property triggerPolarity

<summary>

Rising Edge (true) or Falling Edge (false)

<summary>

property triggerType

<summary> Trigger type internal external. <summary>

class controlAPI.ExoLightCommand_SetDCLighting

Bases: ExoLightCommand_SetLighting

<summary> Command to set the lighting (DC current drive mode) of a ExoLight device. <summary>

property alias

user definable unique alias for this command package

className()

cloneFrom(other)

clone from another device package - should be implemented for custom types. :type other: DeviceCommandPackage :param other:

property continuous

set to true if command is a continous (async/time consuming) command or if it is desired that the command run indefinitely. (tracking command etc) set to false if the command should terminate once a target is reached.

createSharedPtr()

property intensityPercent

<summary> percentage of range [20mA to maxMilliAmpsDCMode] to drive the light in DC mode <summary>

markUpdatePackageReady()

signal the update package is ready to be used in running commands. prepareUpdatePackage() should be called first.

property outputEnabled

prepareUpdatePackage()

Creates/Returns the DeviceCommandPackage to be used for updates to a running command. Update package will be a shallow copy of this package. It is expected that markUpdatePackageReady() be called after update package is altered. :rtype: DeviceCommandPackage :return: DeviceCommandPackage*

static staticClassName()

property thisown

The membership flag

class controlAPI.ExoLightCommand_SetLighting

Bases: DeviceCommandPackage

<summary> Command to set the lighting of a ExoLight device. <summary>

property alias

user definable unique alias for this command package

className()

cloneFrom(other)

clone from another device package - should be implemented for custom types. :type other: DeviceCommandPackage :param other:

property continuous

set to true if command is a continous (async/time consuming) command or if it is desired that the command run indefinitely. (tracking command etc) set to false if the command should terminate once a target is reached.

createSharedPtr()

markUpdatePackageReady()

signal the update package is ready to be used in running commands. prepareUpdatePackage() should be called first.

property outputEnabled

prepareUpdatePackage()

Creates/Returns the DeviceCommandPackage to be used for updates to a running command. Update package will be a shallow copy of this package. It is expected that markUpdatePackageReady() be called after update package is altered. :rtype: DeviceCommandPackage :return: DeviceCommandPackage*

static staticClassName()

property thisown

The membership flag

class controlAPI.ExoLightCommand_SetStrobeLighting

Bases: ExoLightCommand_SetLighting

<summary> Command to set the lighting (strobe mode) of a ExoLight device. <summary>

property alias

user definable unique alias for this command package

className()

cloneFrom(other)

clone from another device package - should be implemented for custom types. :type other: DeviceCommandPackage :param other:

property continuous

set to true if command is a continous (async/time consuming) command or if it is desired that the command run indefinitely. (tracking command etc) set to false if the command should terminate once a target is reached.

createSharedPtr()

markUpdatePackageReady()

signal the update package is ready to be used in running commands. prepareUpdatePackage() should be called first.

property outputEnabled

prepareUpdatePackage()

Creates/Returns the DeviceCommandPackage to be used for updates to a running command. Update package will be a shallow copy of this package. It is expected that markUpdatePackageReady() be called after update package is altered. :rtype: DeviceCommandPackage :return: DeviceCommandPackage*

static staticClassName()

property strobeCurrentMilliAmps

<summary> DC Amperage to drive the led (milliamps)

<summary>

property strobePulseWidthMicroSec

<summary> pulse width micro seconds

<summary>

property strobeTriggerDelayMicroSec

<summary> strobe trigger delay in microsecs <summary>

property strobeTriggerPeriodMicroSec

<summary> trigger period in micro seconds

<summary>

property thisown

The membership flag

class controlAPI.ExoLightCommand_SetVoltageLighting

Bases: ExoLightCommand_SetLighting

<summary> Command to set the lighting (voltage mode) of a ExoLight device. <summary>

property alias

user definable unique alias for this command package

className()

cloneFrom(other)

clone from another device package - should be implemented for custom types. :type other: DeviceCommandPackage :param other:

property continuous

set to true if command is a continous (async/time consuming) command or if it is desired that the command run indefinitely. (tracking command etc) set to false if the command should terminate once a target is reached.

createSharedPtr()

markUpdatePackageReady()

signal the update package is ready to be used in running commands. prepareUpdatePackage() should be called first.

property outputEnabled

prepareUpdatePackage()

Creates/Returns the DeviceCommandPackage to be used for updates to a running command. Update package will be a shallow copy of this package. It is expected that markUpdatePackageReady() be called after update package is altered. :rtype: DeviceCommandPackage :return: DeviceCommandPackage*

static staticClassName()

property thisown

The membership flag

property voltage

<summary> output voltage <summary>

class controlAPI.FloatVector(*args)

Bases: object

append(x)

assign(n, x)

back()

begin()

capacity()

clear()

empty()

end()

erase(*args)

front()

get_allocator()

insert(*args)

iterator()

pop()

pop_back()

push_back(x)

rbegin()

rend()

reserve(n)

resize(*args)

size()

swap(v)

property thisown

The membership flag

class controlAPI.HardwareDeviceController

Bases: DeviceController

<summary> Base Class for hardware controllers.

addDeviceInfo(dev)

<summary> Add a device to the controller. <summary> <param name=”dev”><param>

property alias

Alias of the controller

apiId()

the assigned Api Id of the controller

checkCommandPackage(deviceId, package)

check validity of command package

className()

disconnect(expected=False)

disconnect the controller, should handle both a manual disconnect and could be called from a comm error disconnect. set expected to false if called from a timeout error or unknown disconnect event. - error messages are printed. set expected to true if a manual disconnection is wanted.- info messages are printed.

getLogger()

isConnected()

returns true if the controller is currently connected.

isSimulated()

return if the controller is simulated. :rtype: boolean :return:

loggerName()

property port

port for connecting, if the device is a serial device this can be “COM3” or “/dev/tty.***”

removeDeviceInfo(dev)

Remove an already added device.

setDisconnectCallback(callback)

set a disconnected callback function to be called when the controller is disconnected.

setSimulated(simulated)

set the simulated flag on the controller - simulated controllers can simulate interaction with attached devices. can only be set before the controller is initialized. :type simulated: boolean :param simulated:

static staticClassName()

property thisown

The membership flag

class controlAPI.HardwareInfo

Bases: object

property alias

property apiDeviceId

property thisown

The membership flag

class controlAPI.IntVector(*args)

Bases: object

append(x)

assign(n, x)

back()

begin()

capacity()

clear()

empty()

end()

erase(*args)

front()

get_allocator()

insert(*args)

iterator()

pop()

pop_back()

push_back(x)

rbegin()

rend()

reserve(n)

resize(*args)

size()

swap(v)

property thisown

The membership flag

class controlAPI.IsolightPuckCommandStatus

Bases: CommandStatus

<summary> Command status for the isolight puck. <summary>

property alias

The unique alias for this command.

apiId()

className()

commandPackage()

<summary> The command package associated with the command. <summary> <returns><returns>

controlSystem()

<summary> The control system this command status belongs to. <summary> <returns><returns>

deviceApiId()

deviceController()

<summary> The device controller this command status is associated with. <summary> <returns><returns>

deviceInfo()

<summary> The device this command status is associated with. <summary> <returns><returns>

initialize()

<summary> Start the command by internally initializing the thread, binding to the device, and ensuring it is ready to be updated. <summary> <returns><returns>

isBusy()

returns true if the command is currently running

isCancelled()

returns true if the command was cancelled.

isFinished()

returns true if the command has finished. (normally finished or cancelled).

isSuccessful()

isUpdateStepReady()

runASync()

<summary> initialize and start the command async. <summary> <returns><returns>

runFull()

<summary> initializes, and runs the command until it stops (blocking) <summary> <returns><returns>

stateInfo()

<summary> The command state information associated with the command. <summary> <returns><returns>

static staticClassName()

stop()

End the command (cancel)

property thisown

The membership flag

update(stepped=False)

<summary> update the command by allowing it to begin. if stepped = true, will begin to perform 1 update. if stepped = false, will update until finished. <summary> <param name=”stepped”><param> <returns><returns>

waitFinished()

<summary> Wait for the command to finish. <summary>

waitUpdateReady()

<summary> Wait until command is ready to begin a update step <summary> <returns><returns>

waitUpdateReadyOrFinished()

<summary> Wait until command is ready to begin an update step or it is finished. <summary> <returns><returns>

class controlAPI.IsolightPuckCommand_Update

Bases: DeviceCommandPackage

<summary> Command to update the lighting and take light sensor reading from the isolight puck. <summary>

property alias

user definable unique alias for this command package

className()

cloneFrom(other)

clone from another device package - should be implemented for custom types. :type other: DeviceCommandPackage :param other:

property continuous

set to true if command is a continous (async/time consuming) command or if it is desired that the command run indefinitely. (tracking command etc) set to false if the command should terminate once a target is reached.

createSharedPtr()

property ledPattern

<summary> LED pattern <summary>

markUpdatePackageReady()

signal the update package is ready to be used in running commands. prepareUpdatePackage() should be called first.

prepareUpdatePackage()

Creates/Returns the DeviceCommandPackage to be used for updates to a running command. Update package will be a shallow copy of this package. It is expected that markUpdatePackageReady() be called after update package is altered. :rtype: DeviceCommandPackage :return: DeviceCommandPackage*

static staticClassName()

property thisown

The membership flag

class controlAPI.IsolightPuckController

Bases: HardwareDeviceController

<summary> Controller for the isolight puck. <summary>

addDeviceInfo(dev)

<summary> Add a device to the controller. <summary> <param name=”dev”><param>

property alias

Alias of the controller

apiId()

the assigned Api Id of the controller

checkCommandPackage(deviceId, package)

check validity of command package

className()

disconnect(expected=False)

disconnect the controller, should handle both a manual disconnect and could be called from a comm error disconnect. set expected to false if called from a timeout error or unknown disconnect event. - error messages are printed. set expected to true if a manual disconnection is wanted.- info messages are printed.

getLogger()

isConnected()

returns true if the controller is currently connected.

isSimulated()

return if the controller is simulated. :rtype: boolean :return:

loggerName()

property port

port for connecting, if the device is a serial device this can be “COM3” or “/dev/tty.***”

removeDeviceInfo(dev)

Remove an already added device.

setDisconnectCallback(callback)

set a disconnected callback function to be called when the controller is disconnected.

setSimulated(simulated)

set the simulated flag on the controller - simulated controllers can simulate interaction with attached devices. can only be set before the controller is initialized. :type simulated: boolean :param simulated:

static staticClassName()

property thisown

The membership flag

class controlAPI.IsolightPuckDeviceInfo

Bases: DeviceInfo

<summary> Device Info for the isolight puck. <summary>

addCommand(package)

addCommandGeneric(package)

property alias

property apiDeviceId

className()

commandLoggingEnabled()

commandLoggingLevel()

controlSystem()

access to owning control system.

deviceController()

access to owning controller.

initializeCommand(commandPackage)

isConnected()

Returns true is the device is currently connected.

property port

Sereal Port Associated with the puck

preLoopCommandCheck(checkCancelled=True)

setCommandLoggingLevel(level)

Set the command logging level, 0 - regular, 1 - more detail, 2 - even more detail, etc. :type level: int :param level:

setEnableCommandLogging(enable)

set the device to log messages to the console. (default true) :type enable: boolean :param enable:

static staticClassName()

property thisown

The membership flag

property updateRateMS

<summary> suggested update rate of the internal sensor in milliseconds, sensor may increase this in order to take accurate readings. <summary>

class controlAPI.IsolightPuckUpdateStateInfo

Bases: CommandStateInfo

<summary> State Info providing readings from the isolight puck sensor. <summary>

className()

property percentFinished

<summary> percentage to command completion. <summary>

property sensor_GRXYZ_X

<summary> GRXYZ values <summary>

property sensor_GRXYZ_Y

property sensor_GRXYZ_Z

property sensor_cct

<summary> correlated color temperature (K) <summary>

property sensor_lightlevel

<summary> light level in lux <summary>

property sensor_u_prime

<summary> Yu’v’ color space <summary>

property sensor_v_prime

property sensor_x_normalized

<summary> normalized x,y,z values <summary>

property sensor_y_normalized

property sensor_z_normalized

static staticClassName()

property thisown

The membership flag

class controlAPI.KinoFloDeviceCommand_RGBColor8Bit

Bases: DMXDeviceCommand_RGBColor8Bit

property alias

user definable unique alias for this command package

property blue

property cct

className()

cloneFrom(other)

clone from another device package - should be implemented for custom types. :type other: DeviceCommandPackage :param other:

property continuous

set to true if command is a continous (async/time consuming) command or if it is desired that the command run indefinitely. (tracking command etc) set to false if the command should terminate once a target is reached.

createSharedPtr()

property dimmer

property green

property greenMagenta

markUpdatePackageReady()

signal the update package is ready to be used in running commands. prepareUpdatePackage() should be called first.

prepareUpdatePackage()

Creates/Returns the DeviceCommandPackage to be used for updates to a running command. Update package will be a shallow copy of this package. It is expected that markUpdatePackageReady() be called after update package is altered. :rtype: DeviceCommandPackage :return: DeviceCommandPackage*

property red

static staticClassName()

property thisown

The membership flag

class controlAPI.KinoFloDeviceInfo

Bases: DMXDeviceInfo

property DMXBaseAddress

addCommandGeneric(package)

property alias

property apiDeviceId

className()

commandLoggingEnabled()

commandLoggingLevel()

controlSystem()

access to owning control system.

deviceController()

access to owning controller.

initializeCommand(commandPackage)

isConnected()

Returns true is the device is currently connected.

property numChannels

preLoopCommandCheck(checkCancelled=True)

setCommandLoggingLevel(level)

Set the command logging level, 0 - regular, 1 - more detail, 2 - even more detail, etc. :type level: int :param level:

setEnableCommandLogging(enable)

set the device to log messages to the console. (default true) :type enable: boolean :param enable:

static staticClassName()

property thisown

The membership flag

class controlAPI.LedLightBoxCommand_Lighting

Bases: DeviceCommandPackage

<summary> Command to set the lighting of a led light box. <summary>

property alias

user definable unique alias for this command package

className()

cloneFrom(other)

clone from another device package - should be implemented for custom types. :type other: DeviceCommandPackage :param other:

property colorTemperaturePerc

property continuous

set to true if command is a continous (async/time consuming) command or if it is desired that the command run indefinitely. (tracking command etc) set to false if the command should terminate once a target is reached.

createSharedPtr()

property dimmerIntensityPercent

property flickerDutyCyclePercent

property flickerFrequencyHz

property highLowSetting

markUpdatePackageReady()

signal the update package is ready to be used in running commands. prepareUpdatePackage() should be called first.

prepareUpdatePackage()

Creates/Returns the DeviceCommandPackage to be used for updates to a running command. Update package will be a shallow copy of this package. It is expected that markUpdatePackageReady() be called after update package is altered. :rtype: DeviceCommandPackage :return: DeviceCommandPackage*

static staticClassName()

property thisown

The membership flag

class controlAPI.LedLightBoxController

Bases: LedLightBoxControllerBase

<summary> controller for LedLightBox <summary>

addDeviceInfo(dev)

<summary> Add a device to the controller. <summary> <param name=”dev”><param>

property alias

Alias of the controller

apiId()

the assigned Api Id of the controller

checkCommandPackage(deviceId, package)

check validity of command package

className()

disconnect(expected=False)

disconnect the controller, should handle both a manual disconnect and could be called from a comm error disconnect. set expected to false if called from a timeout error or unknown disconnect event. - error messages are printed. set expected to true if a manual disconnection is wanted.- info messages are printed.

getLogger()

isConnected()

returns true if the controller is currently connected.

isSimulated()

return if the controller is simulated. :rtype: boolean :return:

loggerName()

property port

port for connecting, if the device is a serial device this can be “COM3” or “/dev/tty.***”

removeDeviceInfo(dev)

Remove an already added device.

setDisconnectCallback(callback)

set a disconnected callback function to be called when the controller is disconnected.

setSimulated(simulated)

set the simulated flag on the controller - simulated controllers can simulate interaction with attached devices. can only be set before the controller is initialized. :type simulated: boolean :param simulated:

static staticClassName()

property thisown

The membership flag

class controlAPI.LedLightBoxControllerBase

Bases: HardwareDeviceController

<summary> base class for led light box controllers <summary>

addDeviceInfo(dev)

<summary> Add a device to the controller. <summary> <param name=”dev”><param>

property alias

Alias of the controller

apiId()

the assigned Api Id of the controller

checkCommandPackage(deviceId, package)

check validity of command package

className()

disconnect(expected=False)

disconnect the controller, should handle both a manual disconnect and could be called from a comm error disconnect. set expected to false if called from a timeout error or unknown disconnect event. - error messages are printed. set expected to true if a manual disconnection is wanted.- info messages are printed.

getLogger()

isConnected()

returns true if the controller is currently connected.

isSimulated()

return if the controller is simulated. :rtype: boolean :return:

loggerName()

property port

port for connecting, if the device is a serial device this can be “COM3” or “/dev/tty.***”

removeDeviceInfo(dev)

Remove an already added device.

setDisconnectCallback(callback)

set a disconnected callback function to be called when the controller is disconnected.

setSimulated(simulated)

set the simulated flag on the controller - simulated controllers can simulate interaction with attached devices. can only be set before the controller is initialized. :type simulated: boolean :param simulated:

static staticClassName()

property thisown

The membership flag

class controlAPI.LedLightBoxDeviceInfo

Bases: DeviceInfo

<summary> https://www.imatest.com/product/imatest-led-lightbox/ <summary>

addCommandGeneric(package)

property alias

property apiDeviceId

className()

commandLoggingEnabled()

commandLoggingLevel()

controlSystem()

access to owning control system.

deviceController()

access to owning controller.

property highLowCapable

initializeCommand(commandPackage)

isConnected()

Returns true is the device is currently connected.

property isPanel

property maxDimmerIntegerHigh

property maxDimmerIntegerLow

property mixedCapable

preLoopCommandCheck(checkCancelled=True)

setCommandLoggingLevel(level)

Set the command logging level, 0 - regular, 1 - more detail, 2 - even more detail, etc. :type level: int :param level:

setEnableCommandLogging(enable)

set the device to log messages to the console. (default true) :type enable: boolean :param enable:

static staticClassName()

property thisown

The membership flag

class controlAPI.LedLightBoxDevice_High_LUX_LED_Box_Mixed_Info

Bases: LedLightBoxDeviceInfo

<summary> device info for High_LUX_LED_Box_Mixed <summary>

addCommand(package)

addCommandGeneric(package)

property alias

property apiDeviceId

className()

commandLoggingEnabled()

commandLoggingLevel()

controlSystem()

access to owning control system.

deviceController()

access to owning controller.

static friendlyName()

property highLowCapable

initializeCommand(commandPackage)

isConnected()

Returns true is the device is currently connected.

property isPanel

property maxDimmerIntegerHigh

property maxDimmerIntegerLow

property mixedCapable

preLoopCommandCheck(checkCancelled=True)

setCommandLoggingLevel(level)

Set the command logging level, 0 - regular, 1 - more detail, 2 - even more detail, etc. :type level: int :param level:

setEnableCommandLogging(enable)

set the device to log messages to the console. (default true) :type enable: boolean :param enable:

static staticClassName()

property thisown

The membership flag

class controlAPI.LedLightBoxDevice_High_LUX_LED_Box_Single_Info

Bases: LedLightBoxDeviceInfo

<summary> device info for High_LUX_LED_Box_Single <summary>

addCommand(package)

addCommandGeneric(package)

property alias

property apiDeviceId

className()

commandLoggingEnabled()

commandLoggingLevel()

controlSystem()

access to owning control system.

deviceController()

access to owning controller.

static friendlyName()

property highLowCapable

initializeCommand(commandPackage)

isConnected()

Returns true is the device is currently connected.

property isPanel

property maxDimmerIntegerHigh

property maxDimmerIntegerLow

property mixedCapable

preLoopCommandCheck(checkCancelled=True)

setCommandLoggingLevel(level)

Set the command logging level, 0 - regular, 1 - more detail, 2 - even more detail, etc. :type level: int :param level:

setEnableCommandLogging(enable)

set the device to log messages to the console. (default true) :type enable: boolean :param enable:

static staticClassName()

property thisown

The membership flag

class controlAPI.LedLightBoxDevice_Standard_LED_Box_Mixed_Info

Bases: LedLightBoxDeviceInfo

<summary> device info for Standard_LED_Box_Mixed <summary>

addCommand(package)

addCommandGeneric(package)

property alias

property apiDeviceId

className()

commandLoggingEnabled()

commandLoggingLevel()

controlSystem()

access to owning control system.

deviceController()

access to owning controller.

static friendlyName()

property highLowCapable

initializeCommand(commandPackage)

isConnected()

Returns true is the device is currently connected.

property isPanel

property maxDimmerIntegerHigh

property maxDimmerIntegerLow

property mixedCapable

preLoopCommandCheck(checkCancelled=True)

setCommandLoggingLevel(level)

Set the command logging level, 0 - regular, 1 - more detail, 2 - even more detail, etc. :type level: int :param level:

setEnableCommandLogging(enable)

set the device to log messages to the console. (default true) :type enable: boolean :param enable:

static staticClassName()

property thisown

The membership flag

class controlAPI.LedLightBoxDevice_Standard_LED_Box_Single_Info

Bases: LedLightBoxDeviceInfo

<summary> device info for Standard_LED_Box_Single <summary>

addCommand(package)

addCommandGeneric(package)

property alias

property apiDeviceId

className()

commandLoggingEnabled()

commandLoggingLevel()

controlSystem()

access to owning control system.

deviceController()

access to owning controller.

static friendlyName()

property highLowCapable

initializeCommand(commandPackage)

isConnected()

Returns true is the device is currently connected.

property isPanel

property maxDimmerIntegerHigh

property maxDimmerIntegerLow

property mixedCapable

preLoopCommandCheck(checkCancelled=True)

setCommandLoggingLevel(level)

Set the command logging level, 0 - regular, 1 - more detail, 2 - even more detail, etc. :type level: int :param level:

setEnableCommandLogging(enable)

set the device to log messages to the console. (default true) :type enable: boolean :param enable:

static staticClassName()

property thisown

The membership flag

class controlAPI.LedLightBoxDevice_Ultra_High_Illumination_Flickering_Info

Bases: LedLightBoxDeviceInfo

<summary> device info for Ultra_High_Illumination_Flickering <summary>

addCommand(package)

addCommandGeneric(package)

property alias

property apiDeviceId

className()

commandLoggingEnabled()

commandLoggingLevel()

controlSystem()

access to owning control system.

deviceController()

access to owning controller.

static friendlyName()

property highLowCapable

initializeCommand(commandPackage)

isConnected()

Returns true is the device is currently connected.

property isPanel

property maxDimmerIntegerHigh

property maxDimmerIntegerLow

property mixedCapable

preLoopCommandCheck(checkCancelled=True)

setCommandLoggingLevel(level)

Set the command logging level, 0 - regular, 1 - more detail, 2 - even more detail, etc. :type level: int :param level:

setEnableCommandLogging(enable)

set the device to log messages to the console. (default true) :type enable: boolean :param enable:

static staticClassName()

property thisown

The membership flag

class controlAPI.LedLightPanelCommand_SetLighting

Bases: LedLightBoxCommand_Lighting

<summary> Command to set the lighting of a led light panel. <summary>

property alias

user definable unique alias for this command package

className()

cloneFrom(other)

clone from another device package - should be implemented for custom types. :type other: DeviceCommandPackage :param other:

property colorTemperaturePerc

property continuous

set to true if command is a continous (async/time consuming) command or if it is desired that the command run indefinitely. (tracking command etc) set to false if the command should terminate once a target is reached.

createSharedPtr()

property dimmerIntensityPercent

property flickerDutyCyclePercent

property flickerFrequencyHz

property highLowSetting

markUpdatePackageReady()

signal the update package is ready to be used in running commands. prepareUpdatePackage() should be called first.

prepareUpdatePackage()

Creates/Returns the DeviceCommandPackage to be used for updates to a running command. Update package will be a shallow copy of this package. It is expected that markUpdatePackageReady() be called after update package is altered. :rtype: DeviceCommandPackage :return: DeviceCommandPackage*

static staticClassName()

property thisown

The membership flag

class controlAPI.LedLightPanel_Single_Info

Bases: LedLightBoxDeviceInfo

<summary> https://www.imatest.com/wp-content/uploads/2019/04/Imatest-LED-Light-Panel_Info-Sheet.pdf <summary>

addCommand(package)

addCommandGeneric(package)

property alias

property apiDeviceId

className()

commandLoggingEnabled()

commandLoggingLevel()

controlSystem()

access to owning control system.

deviceController()

access to owning controller.

static friendlyName()

property highLowCapable

initializeCommand(commandPackage)

isConnected()

Returns true is the device is currently connected.

property isPanel

property maxDimmerIntegerHigh

property maxDimmerIntegerLow

property mixedCapable

preLoopCommandCheck(checkCancelled=True)

setCommandLoggingLevel(level)

Set the command logging level, 0 - regular, 1 - more detail, 2 - even more detail, etc. :type level: int :param level:

setEnableCommandLogging(enable)

set the device to log messages to the console. (default true) :type enable: boolean :param enable:

static staticClassName()

property thisown

The membership flag

class controlAPI.LiftingColumnCommandGetEncoderPos

Bases: DeviceCommandPackage

<summary> Get the Internal Encoder Count of the RoboClaw <summary>

property alias

user definable unique alias for this command package

className()

cloneFrom(other)

clone from another device package - should be implemented for custom types. :type other: DeviceCommandPackage :param other:

property continuous

set to true if command is a continous (async/time consuming) command or if it is desired that the command run indefinitely. (tracking command etc) set to false if the command should terminate once a target is reached.

createSharedPtr()

markUpdatePackageReady()

signal the update package is ready to be used in running commands. prepareUpdatePackage() should be called first.

prepareUpdatePackage()

Creates/Returns the DeviceCommandPackage to be used for updates to a running command. Update package will be a shallow copy of this package. It is expected that markUpdatePackageReady() be called after update package is altered. :rtype: DeviceCommandPackage :return: DeviceCommandPackage*

static staticClassName()

property thisown

The membership flag

class controlAPI.LiftingColumnCommandMovementPackage

Bases: MovementCommandPackage

<summary>

Movement command for roboclaw. <summary>

Units_Degrees = 1

Units_Millimeters = 0

property acc_target

Acc Target ex: (Millimeters/S^2)

property alias

user definable unique alias for this command package

className()

cloneFrom(other)

clone from another device package - should be implemented for custom types. :type other: DeviceCommandPackage :param other:

property continuous

set to true if command is a continous (async/time consuming) command or if it is desired that the command run indefinitely. (tracking command etc) set to false if the command should terminate once a target is reached.

createSharedPtr()

property disp_absolute

whether position should be global to device or relative to starting position when command starts.

property disp_target

Position Target ex: (Millimeters)

property expectStall

<summary> stall expected flag - set to true if expecting a stall. (useful to home against mechanical limit) <summary>

markUpdatePackageReady()

signal the update package is ready to be used in running commands. prepareUpdatePackage() should be called first.

prepareUpdatePackage()

Creates/Returns the DeviceCommandPackage to be used for updates to a running command. Update package will be a shallow copy of this package. It is expected that markUpdatePackageReady() be called after update package is altered. :rtype: DeviceCommandPackage :return: DeviceCommandPackage*

static staticClassName()

property thisown

The membership flag

property trackAcc

Track Acceleration Target (if acc_target is non-zero)

property trackDisp

Enable Track Displacement Target

property trackVel

Track Velocity Target (if vel_target is non-zero)

property units

property vel_target

Vel Target ex: (Millimeters/S)

class controlAPI.LiftingColumnCommandSetEncoderPos

Bases: DeviceCommandPackage

<summary> Set the Internal Encoder Count of the RoboClaw <summary>

property alias

user definable unique alias for this command package

className()

cloneFrom(other)

clone from another device package - should be implemented for custom types. :type other: DeviceCommandPackage :param other:

property continuous

set to true if command is a continous (async/time consuming) command or if it is desired that the command run indefinitely. (tracking command etc) set to false if the command should terminate once a target is reached.

property counts

createSharedPtr()

markUpdatePackageReady()

signal the update package is ready to be used in running commands. prepareUpdatePackage() should be called first.

prepareUpdatePackage()

Creates/Returns the DeviceCommandPackage to be used for updates to a running command. Update package will be a shallow copy of this package. It is expected that markUpdatePackageReady() be called after update package is altered. :rtype: DeviceCommandPackage :return: DeviceCommandPackage*

static staticClassName()

property thisown

The membership flag

class controlAPI.LiftingColumnCommandStatus

Bases: CommandStatus

<summary> Lifting Column Command Status <summary>

property alias

The unique alias for this command.

apiId()

className()

commandPackage()

<summary> The command package associated with the command. <summary> <returns><returns>

controlSystem()

<summary> The control system this command status belongs to. <summary> <returns><returns>

deviceApiId()

deviceController()

<summary> The device controller this command status is associated with. <summary> <returns><returns>

deviceInfo()

<summary> The device this command status is associated with. <summary> <returns><returns>

initialize()

<summary> Start the command by internally initializing the thread, binding to the device, and ensuring it is ready to be updated. <summary> <returns><returns>

isBusy()

returns true if the command is currently running

isCancelled()

returns true if the command was cancelled.

isFinished()

returns true if the command has finished. (normally finished or cancelled).

isSuccessful()

isUpdateStepReady()

runASync()

<summary> initialize and start the command async. <summary> <returns><returns>

runFull()

<summary> initializes, and runs the command until it stops (blocking) <summary> <returns><returns>

stateInfo()

<summary> The command state information associated with the command. <summary> <returns><returns>

static staticClassName()

stop()

End the command (cancel)

property thisown

The membership flag

update(stepped=False)

<summary> update the command by allowing it to begin. if stepped = true, will begin to perform 1 update. if stepped = false, will update until finished. <summary> <param name=”stepped”><param> <returns><returns>

waitFinished()

<summary> Wait for the command to finish. <summary>

waitUpdateReady()

<summary> Wait until command is ready to begin a update step <summary> <returns><returns>

waitUpdateReadyOrFinished()

<summary> Wait until command is ready to begin an update step or it is finished. <summary> <returns><returns>

class controlAPI.LiftingColumnController

Bases: HardwareDeviceController

<summary> controller for Lifting Column <summary>

addDeviceInfo(dev)

<summary> Add a device to the controller. <summary> <param name=”dev”><param>

property alias

Alias of the controller

apiId()

the assigned Api Id of the controller

checkCommandPackage(deviceId, package)

check validity of command package

className()

disconnect(expected=False)

disconnect the controller, should handle both a manual disconnect and could be called from a comm error disconnect. set expected to false if called from a timeout error or unknown disconnect event. - error messages are printed. set expected to true if a manual disconnection is wanted.- info messages are printed.

getLogger()

isConnected()

returns true if the controller is currently connected.

isSimulated()

return if the controller is simulated. :rtype: boolean :return:

loggerName()

property port

port for connecting, if the device is a serial device this can be “COM3” or “/dev/tty.***”

removeDeviceInfo(dev)

Remove an already added device.

setDisconnectCallback(callback)

set a disconnected callback function to be called when the controller is disconnected.

setSimulated(simulated)

set the simulated flag on the controller - simulated controllers can simulate interaction with attached devices. can only be set before the controller is initialized. :type simulated: boolean :param simulated:

static staticClassName()

property thisown

The membership flag

class controlAPI.LiftingColumnDeviceInfo

Bases: DeviceInfo

<summary> Device Info for the Lifting Column <summary>

property QPSS

addCommand(package)

addCommandGeneric(package)

property alias

property apiDeviceId

className()

commandLoggingEnabled()

commandLoggingLevel()

controlSystem()

access to owning control system.

property countsPerMM

<summary> Counts Per millimeter <summary>

deviceController()

access to owning controller.

property encoderDeadZone

initializeCommand(commandPackage)

isConnected()

Returns true is the device is currently connected.

property maxDutyCycle

<summary> duty cycle (power factor) (0 - 100) <summary>

property mm_s_p_duty

<summary> (millimeters/s)/(dutyCycle) ratio <summary>

preLoopCommandCheck(checkCancelled=True)

property roboClawAddress

setCommandLoggingLevel(level)

Set the command logging level, 0 - regular, 1 - more detail, 2 - even more detail, etc. :type level: int :param level:

setEnableCommandLogging(enable)

set the device to log messages to the console. (default true) :type enable: boolean :param enable:

static staticClassName()

property thisown

The membership flag

class controlAPI.LiftingColumnMovementStateInfo

Bases: MovementStateInfo

<summary> Lifting Column Movement State Info <summary>

className()

property currentAcc

property currentPos

property currentTargetAcc

property currentTargetPos

property currentTargetVel

property currentVel

property homing

property isHomed

property isStalled

<summary> indicates if the column has stalled (normal cases: at lower limit or upper limit - or under high load) <summary>

property percentFinished

<summary> percentage to command completion. <summary>

property referencePos

property signedDir

static staticClassName()

property thisown

The membership flag

class controlAPI.LoggerFunctionality

Bases: object

base class implementing logger functionality for classes.

className()

getLogger()

loggerName()

static staticClassName()

property thisown

The membership flag

class controlAPI.LoopBackComController

Bases: DeviceController

addDeviceInfo(dev)

<summary> Add a device to the controller. <summary> <param name=”dev”><param>

property alias

Alias of the controller

apiId()

the assigned Api Id of the controller

checkCommandPackage(deviceId, package)

check validity of command package

className()

disconnect(expected=False)

disconnect the controller, should handle both a manual disconnect and could be called from a comm error disconnect. set expected to false if called from a timeout error or unknown disconnect event. - error messages are printed. set expected to true if a manual disconnection is wanted.- info messages are printed.

getLogger()

isConnected()

returns true if the controller is currently connected.

isSimulated()

return if the controller is simulated. :rtype: boolean :return:

loggerName()

property port

port for connecting, if the device is a serial device this can be “COM3” or “/dev/tty.***”

removeDeviceInfo(dev)

Remove an already added device.

setDisconnectCallback(callback)

set a disconnected callback function to be called when the controller is disconnected.

setSimulated(simulated)

set the simulated flag on the controller - simulated controllers can simulate interaction with attached devices. can only be set before the controller is initialized. :type simulated: boolean :param simulated:

static staticClassName()

property thisown

The membership flag

class controlAPI.LoopBackComDeviceInfo

Bases: DeviceInfo

addCommand(package)

addCommandGeneric(package)

property alias

property apiDeviceId

className()

commandLoggingEnabled()

commandLoggingLevel()

controlSystem()

access to owning control system.

deviceController()

access to owning controller.

initializeCommand(commandPackage)

isConnected()

Returns true is the device is currently connected.

preLoopCommandCheck(checkCancelled=True)

setCommandLoggingLevel(level)

Set the command logging level, 0 - regular, 1 - more detail, 2 - even more detail, etc. :type level: int :param level:

setEnableCommandLogging(enable)

set the device to log messages to the console. (default true) :type enable: boolean :param enable:

static staticClassName()

property thisown

The membership flag

class controlAPI.LowLightSensorCommandStatus

Bases: CommandStatus

<summary> Command Status for the Low Light Sensor <summary>

property alias

The unique alias for this command.

apiId()

className()

commandPackage()

<summary> The command package associated with the command. <summary> <returns><returns>

controlSystem()

<summary> The control system this command status belongs to. <summary> <returns><returns>

deviceApiId()

deviceController()

<summary> The device controller this command status is associated with. <summary> <returns><returns>

deviceInfo()

<summary> The device this command status is associated with. <summary> <returns><returns>

initialize()

<summary> Start the command by internally initializing the thread, binding to the device, and ensuring it is ready to be updated. <summary> <returns><returns>

isBusy()

returns true if the command is currently running

isCancelled()

returns true if the command was cancelled.

isFinished()

returns true if the command has finished. (normally finished or cancelled).

isSuccessful()

isUpdateStepReady()

runASync()

<summary> initialize and start the command async. <summary> <returns><returns>

runFull()

<summary> initializes, and runs the command until it stops (blocking) <summary> <returns><returns>

stateInfo()

<summary> The command state information associated with the command. <summary> <returns><returns>

static staticClassName()

stop()

End the command (cancel)

property thisown

The membership flag

update(stepped=False)

<summary> update the command by allowing it to begin. if stepped = true, will begin to perform 1 update. if stepped = false, will update until finished. <summary> <param name=”stepped”><param> <returns><returns>

waitFinished()

<summary> Wait for the command to finish. <summary>

waitUpdateReady()

<summary> Wait until command is ready to begin a update step <summary> <returns><returns>

waitUpdateReadyOrFinished()

<summary> Wait until command is ready to begin an update step or it is finished. <summary> <returns><returns>

class controlAPI.LowLightSensorCommand_Update

Bases: DeviceCommandPackage

<summary> Command to update the lighting and take light sensor reading <summary>

property alias

user definable unique alias for this command package

className()

cloneFrom(other)

clone from another device package - should be implemented for custom types. :type other: DeviceCommandPackage :param other:

property continuous

set to true if command is a continous (async/time consuming) command or if it is desired that the command run indefinitely. (tracking command etc) set to false if the command should terminate once a target is reached.

createSharedPtr()

markUpdatePackageReady()

signal the update package is ready to be used in running commands. prepareUpdatePackage() should be called first.

prepareUpdatePackage()

Creates/Returns the DeviceCommandPackage to be used for updates to a running command. Update package will be a shallow copy of this package. It is expected that markUpdatePackageReady() be called after update package is altered. :rtype: DeviceCommandPackage :return: DeviceCommandPackage*

static staticClassName()

property thisown

The membership flag

class controlAPI.LowLightSensorController

Bases: HardwareDeviceController

<summary> Controller for the Low Light Sensor <summary>

addDeviceInfo(dev)

<summary> Add a device to the controller. <summary> <param name=”dev”><param>

property alias

Alias of the controller

apiId()

the assigned Api Id of the controller

checkCommandPackage(deviceId, package)

check validity of command package

className()

disconnect(expected=False)

disconnect the controller, should handle both a manual disconnect and could be called from a comm error disconnect. set expected to false if called from a timeout error or unknown disconnect event. - error messages are printed. set expected to true if a manual disconnection is wanted.- info messages are printed.

getLogger()

isConnected()

returns true if the controller is currently connected.

isSimulated()

return if the controller is simulated. :rtype: boolean :return:

loggerName()

property port

port for connecting, if the device is a serial device this can be “COM3” or “/dev/tty.***”

removeDeviceInfo(dev)

Remove an already added device.

setDisconnectCallback(callback)

set a disconnected callback function to be called when the controller is disconnected.

setSimulated(simulated)

set the simulated flag on the controller - simulated controllers can simulate interaction with attached devices. can only be set before the controller is initialized. :type simulated: boolean :param simulated:

static staticClassName()

property thisown

The membership flag

class controlAPI.LowLightSensorDeviceInfo

Bases: DeviceInfo

<summary> Device Info for the Low Light Sensor <summary>

addCommand(package)

addCommandGeneric(package)

property alias

property apiDeviceId

className()

commandLoggingEnabled()

commandLoggingLevel()

controlSystem()

access to owning control system.

deviceController()

access to owning controller.

initializeCommand(commandPackage)

isConnected()

Returns true is the device is currently connected.

preLoopCommandCheck(checkCancelled=True)

setCommandLoggingLevel(level)

Set the command logging level, 0 - regular, 1 - more detail, 2 - even more detail, etc. :type level: int :param level:

setEnableCommandLogging(enable)

set the device to log messages to the console. (default true) :type enable: boolean :param enable:

static staticClassName()

property thisown

The membership flag

class controlAPI.LowLightSensorUpdateStateInfo

Bases: CommandStateInfo

<summary> State Info providing readings from the low light sensor <summary>

className()

property lx

property percentFinished

<summary> percentage to command completion. <summary>

static staticClassName()

property thisown

The membership flag

class controlAPI.LowLightSensor_DataInfo

Bases: object

<summary> Data Info for the Low Light Sensor <summary>

property fLx

property thisown

The membership flag

class controlAPI.MOTYZ_Framing

Bases: CompositeFrameBase

<summary> The MOTYZ_Framing object can be calibrated to the coordinates of a target chart by calling frame.calibrate() and following the prompts to enter in distance values from the chart center using the range finder. MOTYZ_Frame. state can be saved by saving/restoring the chartDisplacement_Ref, chartDisplacement, and liftingCol_refPos variables at any time if the frame is in the same position after calibration. <summary>

calibrate()

<summary> prompt for distance measurement to calibrate the frame. <summary>

property chartDisplacement_Ref

homed chart displacement (set by calibration routine)

className()

property currentChartDisplacement

<summary> current chart displacement - read only after calling go_Chart_YZ <summary>

go_Chart_YZ(chartDisplacement)

<summary> Go to liftingCol_refPos position chartDistance millimeters away from the chart. <summary>

home()

Home all Axis.

initialize(system)

<summary> Initialize the frame (always required first) <summary> <param name=”system”><param>

property liftingCol_refPos

<summary> lifting col referance position (set by calibration routine) <summary>

property liftingColumnPort

<summary> Serial Port for Lifting Column. (ex “COM5”) <summary>

property stageAcceleration

<summary> stage acceleration to use when moving <summary>

property stageVelocity

<summary> stage velocity to use when moving <summary>

static staticClassName()

property system

property thisown

The membership flag

property zaberPort

<summary> Serial Port for zaber (ex “COM4”) <summary>

class controlAPI.MonitorCommandPackage

Bases: DeviceCommandPackage

Base class command to get current state of device.

property alias

user definable unique alias for this command package

className()

cloneFrom(other)

clone from another device package - should be implemented for custom types. :type other: DeviceCommandPackage :param other:

property continuous

set to true if command is a continous (async/time consuming) command or if it is desired that the command run indefinitely. (tracking command etc) set to false if the command should terminate once a target is reached.

createSharedPtr()

markUpdatePackageReady()

signal the update package is ready to be used in running commands. prepareUpdatePackage() should be called first.

prepareUpdatePackage()

Creates/Returns the DeviceCommandPackage to be used for updates to a running command. Update package will be a shallow copy of this package. It is expected that markUpdatePackageReady() be called after update package is altered. :rtype: DeviceCommandPackage :return: DeviceCommandPackage*

static staticClassName()

property thisown

The membership flag

class controlAPI.MovementCommandPackage

Bases: DeviceCommandPackage

Generic Movement Command Supported on moving devices

Units_Degrees = 1

Units_Millimeters = 0

property acc_target

Acc Target ex: (Millimeters/S^2)

property alias

user definable unique alias for this command package

className()

cloneFrom(other)

clone from another device package - should be implemented for custom types. :type other: DeviceCommandPackage :param other:

property continuous

set to true if command is a continous (async/time consuming) command or if it is desired that the command run indefinitely. (tracking command etc) set to false if the command should terminate once a target is reached.

createSharedPtr()

property disp_absolute

whether position should be global to device or relative to starting position when command starts.

property disp_target

Position Target ex: (Millimeters)

markUpdatePackageReady()

signal the update package is ready to be used in running commands. prepareUpdatePackage() should be called first.

prepareUpdatePackage()

Creates/Returns the DeviceCommandPackage to be used for updates to a running command. Update package will be a shallow copy of this package. It is expected that markUpdatePackageReady() be called after update package is altered. :rtype: DeviceCommandPackage :return: DeviceCommandPackage*

static staticClassName()

property thisown

The membership flag

property trackAcc

Track Acceleration Target (if acc_target is non-zero)

property trackDisp

Enable Track Displacement Target

property trackVel

Track Velocity Target (if vel_target is non-zero)

property units

property vel_target

Vel Target ex: (Millimeters/S)

class controlAPI.MovementStateInfo

Bases: CommandStateInfo

base class for representing the movement state of a command at any time.

className()

property currentAcc

property currentPos

property currentTargetAcc

property currentTargetPos

property currentTargetVel

property currentVel

property homing

property isHomed

property percentFinished

<summary> percentage to command completion. <summary>

property referencePos

property signedDir

static staticClassName()

property thisown

The membership flag

class controlAPI.PheonixMecanoActuator

Bases: LiftingColumnDeviceInfo

<summary> Device Info for the Pheonix Mecano Actuator (DEPRECATED) <summary>

property QPSS

addCommand(package)

addCommandGeneric(package)

property alias

property apiDeviceId

className()

commandLoggingEnabled()

commandLoggingLevel()

controlSystem()

access to owning control system.

property countsPerMM

<summary> Counts Per millimeter <summary>

deviceController()

access to owning controller.

property encoderDeadZone

initializeCommand(commandPackage)

isConnected()

Returns true is the device is currently connected.

property maxDutyCycle

<summary> duty cycle (power factor) (0 - 100) <summary>

property mm_s_p_duty

<summary> (millimeters/s)/(dutyCycle) ratio <summary>

preLoopCommandCheck(checkCancelled=True)

property roboClawAddress

setCommandLoggingLevel(level)

Set the command logging level, 0 - regular, 1 - more detail, 2 - even more detail, etc. :type level: int :param level:

setEnableCommandLogging(enable)

set the device to log messages to the console. (default true) :type enable: boolean :param enable:

static staticClassName()

property thisown

The membership flag

class controlAPI.PhysicalAxisControlInfo

Bases: object

base class representing a physical axis (linear or rotational, with movement limits)

property isRadial

property maxAccLimit

property maxPosLimit

property maxVelLimit

property minAccLimit

property minPosLimit

property minVelLimit

property submittedToApi

property thisown

The membership flag

class controlAPI.SpectralSensorCommandStatus

Bases: CommandStatus

<summary> Command Status for the Spectral Sensor <summary>

property alias

The unique alias for this command.

apiId()

className()

commandPackage()

<summary> The command package associated with the command. <summary> <returns><returns>

controlSystem()

<summary> The control system this command status belongs to. <summary> <returns><returns>

deviceApiId()

deviceController()

<summary> The device controller this command status is associated with. <summary> <returns><returns>

deviceInfo()

<summary> The device this command status is associated with. <summary> <returns><returns>

initialize()

<summary> Start the command by internally initializing the thread, binding to the device, and ensuring it is ready to be updated. <summary> <returns><returns>

isBusy()

returns true if the command is currently running

isCancelled()

returns true if the command was cancelled.

isFinished()

returns true if the command has finished. (normally finished or cancelled).

isSuccessful()

isUpdateStepReady()

runASync()

<summary> initialize and start the command async. <summary> <returns><returns>

runFull()

<summary> initializes, and runs the command until it stops (blocking) <summary> <returns><returns>

stateInfo()

<summary> The command state information associated with the command. <summary> <returns><returns>

static staticClassName()

stop()

End the command (cancel)

property thisown

The membership flag

update(stepped=False)

<summary> update the command by allowing it to begin. if stepped = true, will begin to perform 1 update. if stepped = false, will update until finished. <summary> <param name=”stepped”><param> <returns><returns>

waitFinished()

<summary> Wait for the command to finish. <summary>

waitUpdateReady()

<summary> Wait until command is ready to begin a update step <summary> <returns><returns>

waitUpdateReadyOrFinished()

<summary> Wait until command is ready to begin an update step or it is finished. <summary> <returns><returns>

class controlAPI.SpectralSensorCommand_Update

Bases: DeviceCommandPackage

<summary> Command to update the lighting and take light sensor reading from the isolight puck. <summary>

property alias

user definable unique alias for this command package

className()

cloneFrom(other)

clone from another device package - should be implemented for custom types. :type other: DeviceCommandPackage :param other:

property continuous

set to true if command is a continous (async/time consuming) command or if it is desired that the command run indefinitely. (tracking command etc) set to false if the command should terminate once a target is reached.

createSharedPtr()

property integralTime_US

<summary> Time in microseconds the device should integrate over for each end-result sample <summary>

markUpdatePackageReady()

signal the update package is ready to be used in running commands. prepareUpdatePackage() should be called first.

prepareUpdatePackage()

Creates/Returns the DeviceCommandPackage to be used for updates to a running command. Update package will be a shallow copy of this package. It is expected that markUpdatePackageReady() be called after update package is altered. :rtype: DeviceCommandPackage :return: DeviceCommandPackage*

static staticClassName()

property thisown

The membership flag

class controlAPI.SpectralSensorController

Bases: HardwareDeviceController

<summary> Controller for the Spectral Sensor <summary>

addDeviceInfo(dev)

<summary> Add a device to the controller. <summary> <param name=”dev”><param>

property alias

Alias of the controller

apiId()

the assigned Api Id of the controller

checkCommandPackage(deviceId, package)

check validity of command package

className()

disconnect(expected=False)

disconnect the controller, should handle both a manual disconnect and could be called from a comm error disconnect. set expected to false if called from a timeout error or unknown disconnect event. - error messages are printed. set expected to true if a manual disconnection is wanted.- info messages are printed.

getLogger()

isConnected()

returns true if the controller is currently connected.

isSimulated()

return if the controller is simulated. :rtype: boolean :return:

loggerName()

property port

port for connecting, if the device is a serial device this can be “COM3” or “/dev/tty.***”

removeDeviceInfo(dev)

Remove an already added device.

setDisconnectCallback(callback)

set a disconnected callback function to be called when the controller is disconnected.

setSimulated(simulated)

set the simulated flag on the controller - simulated controllers can simulate interaction with attached devices. can only be set before the controller is initialized. :type simulated: boolean :param simulated:

static staticClassName()

property thisown

The membership flag

class controlAPI.SpectralSensorDeviceInfo

Bases: DeviceInfo

<summary> Device Info for the Spectral Sensor <summary>

addCommand(package)

addCommandGeneric(package)

property alias

property apiDeviceId

className()

commandLoggingEnabled()

commandLoggingLevel()

controlSystem()

access to owning control system.

deviceController()

access to owning controller.

initializeCommand(commandPackage)

isConnected()

Returns true is the device is currently connected.

preLoopCommandCheck(checkCancelled=True)

setCommandLoggingLevel(level)

Set the command logging level, 0 - regular, 1 - more detail, 2 - even more detail, etc. :type level: int :param level:

setEnableCommandLogging(enable)

set the device to log messages to the console. (default true) :type enable: boolean :param enable:

static staticClassName()

property thisown

The membership flag

class controlAPI.SpectralSensorUpdateStateInfo

Bases: CommandStateInfo

<summary> State Info providing readings from the SpectralSensor <summary>

property CentreWave

property CentroidWave

property DominantWave

property EndTestWave

property EndTestWaveIdx

property HlafWidth

property IntegTime0

property Mark

property PeakWave

property Purity

property Ra

property Ri

property Spect1nmData

property StartTestWave

property StartTestWaveIdx

property TestDate

property TestTime

property VDark

property VDarkDAC

property VPeak

property cct

className()

property duv

property fBraito

property fEfc

property fGraito

property fLx

property fRraito

property fSP

property iType

Spectrograph/lighting data

property iVer

property percentFinished

<summary> percentage to command completion. <summary>

static staticClassName()

property thisown

The membership flag

property u

property u2

property v

property v2

property x

property y

class controlAPI.SpectralSensor_SpecDataInfo

Bases: object

<summary> Data Info for the Spectral Sensor <summary>

property CentreWave

property CentroidWave

property DominantWave

property EndTestWave

property EndTestWaveIdx

property HlafWidth

property IntegTime0

property Mark

property PeakWave

property Purity

property Ra

property Ri

property Spect1nmData

property StartTestWave

property StartTestWaveIdx

property TestDate

property TestTime

property VDark

property VDarkDAC

property VPeak

property cct

property duv

property fBraito

property fEfc

property fGraito

property fLx

property fRraito

property fSP

property iType

property iVer

property thisown

The membership flag

property u

property u2

property v

property v2

property x

property y

class controlAPI.SwigPyIterator(*args, **kwargs)

Bases: object

advance(n)

copy()

decr(n=1)

distance(x)

equal(x)

incr(n=1)

next()

previous()

property thisown

The membership flag

value()

class controlAPI.SynchronizeDeviceCommand

Bases: DeviceCommandPackage

Command that synchronizes multiple commands to finish at a certain time

property alias

user definable unique alias for this command package

className()

cloneFrom(other)

clone from another device package - should be implemented for custom types. :type other: DeviceCommandPackage :param other:

property continuous

set to true if command is a continous (async/time consuming) command or if it is desired that the command run indefinitely. (tracking command etc) set to false if the command should terminate once a target is reached.

createSharedPtr()

markUpdatePackageReady()

signal the update package is ready to be used in running commands. prepareUpdatePackage() should be called first.

prepareUpdatePackage()

Creates/Returns the DeviceCommandPackage to be used for updates to a running command. Update package will be a shallow copy of this package. It is expected that markUpdatePackageReady() be called after update package is altered. :rtype: DeviceCommandPackage :return: DeviceCommandPackage*

static staticClassName()

property thisown

The membership flag

class controlAPI.ThorLabsUPLED_Controller

Bases: HardwareDeviceController

<summary> controller for ThorLabs UPLED devices <summary>

addDeviceInfo(dev)

<summary> Add a device to the controller. <summary> <param name=”dev”><param>

property alias

Alias of the controller

apiId()

the assigned Api Id of the controller

checkCommandPackage(deviceId, package)

check validity of command package

className()

disconnect(expected=False)

disconnect the controller, should handle both a manual disconnect and could be called from a comm error disconnect. set expected to false if called from a timeout error or unknown disconnect event. - error messages are printed. set expected to true if a manual disconnection is wanted.- info messages are printed.

getLogger()

isConnected()

returns true if the controller is currently connected.

isSimulated()

return if the controller is simulated. :rtype: boolean :return:

loggerName()

property port

port for connecting, if the device is a serial device this can be “COM3” or “/dev/tty.***”

removeDeviceInfo(dev)

Remove an already added device.

sendIntensityCommand(apiDeviceId, intensityPercent)

setDisconnectCallback(callback)

set a disconnected callback function to be called when the controller is disconnected.

setSimulated(simulated)

set the simulated flag on the controller - simulated controllers can simulate interaction with attached devices. can only be set before the controller is initialized. :type simulated: boolean :param simulated:

static staticClassName()

property thisown

The membership flag

class controlAPI.ThorLabsUPLED_DeviceInfo

Bases: DeviceInfo

<summary> Device Info for the ThorLabs UPLED device. <summary>

addCommandGeneric(package)

property alias

property apiDeviceId

className()

commandLoggingEnabled()

commandLoggingLevel()

controlSystem()

access to owning control system.

deviceController()

access to owning controller.

initializeCommand(commandPackage)

isConnected()

Returns true is the device is currently connected.

preLoopCommandCheck(checkCancelled=True)

setCommandLoggingLevel(level)

Set the command logging level, 0 - regular, 1 - more detail, 2 - even more detail, etc. :type level: int :param level:

setEnableCommandLogging(enable)

set the device to log messages to the console. (default true) :type enable: boolean :param enable:

static staticClassName()

property thisown

The membership flag

class controlAPI.ThorLabsUPLED_SetLighting

Bases: DeviceCommandPackage

<summary> Command to set the lighting of a ThorLabs UPLED device. <summary>

property alias

user definable unique alias for this command package

className()

cloneFrom(other)

clone from another device package - should be implemented for custom types. :type other: DeviceCommandPackage :param other:

property continuous

set to true if command is a continous (async/time consuming) command or if it is desired that the command run indefinitely. (tracking command etc) set to false if the command should terminate once a target is reached.

createSharedPtr()

property intensityPercent

markUpdatePackageReady()

signal the update package is ready to be used in running commands. prepareUpdatePackage() should be called first.

prepareUpdatePackage()

Creates/Returns the DeviceCommandPackage to be used for updates to a running command. Update package will be a shallow copy of this package. It is expected that markUpdatePackageReady() be called after update package is altered. :rtype: DeviceCommandPackage :return: DeviceCommandPackage*

static staticClassName()

property thisown

The membership flag

class controlAPI.ThousliteCommand_SetLighting

Bases: DeviceCommandPackage

<summary> Command to set the lighting of a Thouslite device. <summary>

property alias

user definable unique alias for this command package

className()

cloneFrom(other)

clone from another device package - should be implemented for custom types. :type other: DeviceCommandPackage :param other:

property continuous

set to true if command is a continous (async/time consuming) command or if it is desired that the command run indefinitely. (tracking command etc) set to false if the command should terminate once a target is reached.

createSharedPtr()

markUpdatePackageReady()

signal the update package is ready to be used in running commands. prepareUpdatePackage() should be called first.

prepareUpdatePackage()

Creates/Returns the DeviceCommandPackage to be used for updates to a running command. Update package will be a shallow copy of this package. It is expected that markUpdatePackageReady() be called after update package is altered. :rtype: DeviceCommandPackage :return: DeviceCommandPackage*

property recipe

light intensity for the 14 channels.

0 - 1023 all 0 will turn off LEDCube power. % Channels:

1 -> White (Broad spectrum) 2 -> Orange (585nm) 3 -> Lt Orange (Broad spectrum) 4 -> Blue-Green (480nm) 5 -> Red (660nm) 6 -> Green-Blue (505nm) 7 -> Green (520nm) 8 -> Blue (445nm) 9 -> Lt Violet (420nm) 10 -> Red (635nm) 11 -> Yellow-Grn (545nm) 12 -> Dk Violet (405nm) 13 -> Red (670nm) 14 -> Red/IR (700/850nm)

static staticClassName()

property thisown

The membership flag

class controlAPI.ThousliteController

Bases: HardwareDeviceController

<summary> controller for Thouslite devices <summary>

addDeviceInfo(dev)

<summary> Add a device to the controller. <summary> <param name=”dev”><param>

property alias

Alias of the controller

apiId()

the assigned Api Id of the controller

property apiMajorVersion

<summary> The Api version (1 or 2) to use when communicating with the thouslite, default is 1 (older models) <summary>

property baudrate

<summary> The baudrate to connect to the controller (9600 for older models, 115200 for newer touch screen controller) only used with apiMajorVersion = 2 <summary>

checkCommandPackage(deviceId, package)

check validity of command package

className()

disconnect(expected=False)

disconnect the controller, should handle both a manual disconnect and could be called from a comm error disconnect. set expected to false if called from a timeout error or unknown disconnect event. - error messages are printed. set expected to true if a manual disconnection is wanted.- info messages are printed.

getLogger()

isConnected()

returns true if the controller is currently connected.

isSimulated()

return if the controller is simulated. :rtype: boolean :return:

loggerName()

property port

port for connecting, if the device is a serial device this can be “COM3” or “/dev/tty.***”

removeDeviceInfo(dev)

Remove an already added device.

setDisconnectCallback(callback)

set a disconnected callback function to be called when the controller is disconnected.

setSimulated(simulated)

set the simulated flag on the controller - simulated controllers can simulate interaction with attached devices. can only be set before the controller is initialized. :type simulated: boolean :param simulated:

static staticClassName()

property thisown

The membership flag

class controlAPI.ThousliteDeviceInfo

Bases: DeviceInfo

<summary> Device Info for the Thouslite device. <summary>

addCommand(package)

addCommandGeneric(package)

property alias

property apiDeviceId

className()

commandLoggingEnabled()

commandLoggingLevel()

controlSystem()

access to owning control system.

property cubeId

The unique ID of the LEDCube as shown on the side.

deviceController()

access to owning controller.

initializeCommand(commandPackage)

isConnected()

Returns true is the device is currently connected.

preLoopCommandCheck(checkCancelled=True)

setCommandLoggingLevel(level)

Set the command logging level, 0 - regular, 1 - more detail, 2 - even more detail, etc. :type level: int :param level:

setEnableCommandLogging(enable)

set the device to log messages to the console. (default true) :type enable: boolean :param enable:

static staticClassName()

property thisown

The membership flag

class controlAPI.TimeDelayDeviceCommand

Bases: DeviceCommandPackage

Command that adds a time delay.

property alias

user definable unique alias for this command package

className()

cloneFrom(other)

clone from another device package - should be implemented for custom types. :type other: DeviceCommandPackage :param other:

property continuous

set to true if command is a continous (async/time consuming) command or if it is desired that the command run indefinitely. (tracking command etc) set to false if the command should terminate once a target is reached.

createSharedPtr()

markUpdatePackageReady()

signal the update package is ready to be used in running commands. prepareUpdatePackage() should be called first.

prepareUpdatePackage()

Creates/Returns the DeviceCommandPackage to be used for updates to a running command. Update package will be a shallow copy of this package. It is expected that markUpdatePackageReady() be called after update package is altered. :rtype: DeviceCommandPackage :return: DeviceCommandPackage*

static staticClassName()

property thisown

The membership flag

property time_s

<summary> time in seconds to wait. <summary>

class controlAPI.ULC2Controller

Bases: HardwareDeviceController

<summary> base class controller for ULC2 <summary>

addDeviceInfo(dev)

<summary> Add a device to the controller. <summary> <param name=”dev”><param>

property alias

Alias of the controller

apiId()

the assigned Api Id of the controller

checkCommandPackage(deviceId, package)

check validity of command package

className()

disconnect(expected=False)

disconnect the controller, should handle both a manual disconnect and could be called from a comm error disconnect. set expected to false if called from a timeout error or unknown disconnect event. - error messages are printed. set expected to true if a manual disconnection is wanted.- info messages are printed.

getLogger()

property ipAddress

isConnected()

returns true if the controller is currently connected.

isSimulated()

return if the controller is simulated. :rtype: boolean :return:

property localUdpPort

loggerName()

property port

port for connecting, if the device is a serial device this can be “COM3” or “/dev/tty.***”

removeDeviceInfo(dev)

Remove an already added device.

setDisconnectCallback(callback)

set a disconnected callback function to be called when the controller is disconnected.

setSimulated(simulated)

set the simulated flag on the controller - simulated controllers can simulate interaction with attached devices. can only be set before the controller is initialized. :type simulated: boolean :param simulated:

static staticClassName()

property thisown

The membership flag

class controlAPI.ULC2_DC_Mode

Bases: object

property maxMilliAmpsDCMode

<summary> mac milliamps allowed to drive in DC mode. <summary>

property thisown

The membership flag

class controlAPI.ULC2_STROBE_Mode

Bases: object

property strobeMilliAmpsLimit

<summary> strobe mode <summary>

property strobePulseWidthMaxLimitMicroSec

<summary> strobe mode <summary>

property strobeTriggerPeriodLimitMicroSec

<summary> strobe mode <summary>

property thisown

The membership flag

class controlAPI.ULC2_VOLTAGE_Mode

Bases: object

property thisown

The membership flag

property voltagelimitVolts

<summary> strobe mode <summary>

class controlAPI.VCXFraming

Bases: CompositeFrameBase

<summary> DEPRECIATED. VCX Framing class, contains methods for control of VCX frames. all dimension Units are in millimeters

property camera_ChartCenterFrame

<summary> Current Camera Position in ChartCenter Frame. <summary>

property camera_MechanicalOriginFrame

<summary> Current Camera position in mechanicalorigin Frame. <summary>

property camera_MountBaseFrame

<summary> Camera position relative to the MountBaseFrame. <summary>

chartCenterFrame_To_MechanicalOriginFrame(chartCenterSpace)

transform vector in the chartcenter frame to the mechanical origin frame. :type chartCenterSpace: Vector3D :param chartCenterSpace: :rtype: Vector3D :return:

property chartCenter__MechanicalOriginFrame

<summary> chart center position Relative to mechanical base point. “Vector B” Units: millimeters <summary>

className()

property home__MechanicalOriginFrame

<summary> Home position of table relative to mechanical base point. “Vector A” Units: millimeters <summary>

initialize(system)

property liftingColumnPort

<summary> Serial Port for Lifting Column. (ex “COM5”) <summary>

mechanicalOriginFrame_To_HomeFrame(mechanicalSpace)

transform vector in the mechanicalorigin frame to the home frame. :type mechanicalSpace: Vector3D :param mechanicalSpace: :rtype: Vector3D :return:

mountBaseFrame_To_MechanicalOriginFrame(mountbaseSpace)

<summary> transform vector in mountbase space to mechanical origin frame space. <summary> <param name=”mountbaseSpace”><param> <returns><returns>

mountBase_GoTo_Home()

mountBase_Go_ChartCenterFrame(chartSpace, omega)

mountBase_Go_HomeFrame(displacement, omega)

mountBase_Go_MechanicalOriginFrame(mechSpace, omega)

property mountBase_MechanicalOriginFrame

current target mount position in the mechanical origin frame.

property mountBase_Omega_MechanicalOriginFrame

current rotation of MountBase in the mechanicalOrigin frame.

static staticClassName()

property system

targetMountHomeFrame_To_MechanicaOriginFrame(homeSpace)

transform vector in the home frame to the mechanicalorigin frame. (offset) :type homeSpace: Vector3D :param homeSpace: :rtype: Vector3D :return:

property thisown

The membership flag

property zaberPort

<summary> Serial Port for zaber (ex “COM4”) <summary>

class controlAPI.Vector3D(*args)

Bases: object

primative 3D Vector

IsZero()

<summary> return true if vector is unset (0,0,0) (no fuzzy compare) <summary> <returns><returns>

property thisown

The membership flag

property x

property y

property z

class controlAPI.ZaberAxisInfo

Bases: PhysicalAxisControlInfo

<summary> Axis Info for attaching to a Zaber Device <summary>

property alias

property apiAxisIdx

property isRadial

property maxAccLimit

property maxPosLimit

property maxVelLimit

property minAccLimit

property minPosLimit

property minVelLimit

property submittedToApi

property thisown

The membership flag

class controlAPI.ZaberCommandGetStorageKey

Bases: DeviceCommandPackage

<summary> command to get the storage key / value on a zaber device. <summary>

property alias

user definable unique alias for this command package

className()

cloneFrom(other)

clone from another device package - should be implemented for custom types. :type other: DeviceCommandPackage :param other:

property continuous

set to true if command is a continous (async/time consuming) command or if it is desired that the command run indefinitely. (tracking command etc) set to false if the command should terminate once a target is reached.

createSharedPtr()

property key

<summary> Zaber Storage Key <summary>

markUpdatePackageReady()

signal the update package is ready to be used in running commands. prepareUpdatePackage() should be called first.

prepareUpdatePackage()

Creates/Returns the DeviceCommandPackage to be used for updates to a running command. Update package will be a shallow copy of this package. It is expected that markUpdatePackageReady() be called after update package is altered. :rtype: DeviceCommandPackage :return: DeviceCommandPackage*

static staticClassName()

property thisown

The membership flag

class controlAPI.ZaberCommandSetAxisMovement

Bases: MovementCommandPackage

<summary> command to set axis movement on a zaber device <summary>

Units_Degrees = 1

Units_Millimeters = 0

property acc_target

Acc Target ex: (Millimeters/S^2)

property alias

user definable unique alias for this command package

className()

cloneFrom(other)

clone from another device package - should be implemented for custom types. :type other: DeviceCommandPackage :param other:

property continuous

set to true if command is a continous (async/time consuming) command or if it is desired that the command run indefinitely. (tracking command etc) set to false if the command should terminate once a target is reached.

createSharedPtr()

property disp_absolute

whether position should be global to device or relative to starting position when command starts.

property disp_target

Position Target ex: (Millimeters)

property doNativeHome

<summary> Ignores all other parameters and calls home() on the zaber device. <summary>

markUpdatePackageReady()

signal the update package is ready to be used in running commands. prepareUpdatePackage() should be called first.

prepareUpdatePackage()

Creates/Returns the DeviceCommandPackage to be used for updates to a running command. Update package will be a shallow copy of this package. It is expected that markUpdatePackageReady() be called after update package is altered. :rtype: DeviceCommandPackage :return: DeviceCommandPackage*

static staticClassName()

property thisown

The membership flag

property trackAcc

Track Acceleration Target (if acc_target is non-zero)

property trackDisp

Enable Track Displacement Target

property trackVel

Track Velocity Target (if vel_target is non-zero)

property units

property vel_target

Vel Target ex: (Millimeters/S)

property zaberAxisId

class controlAPI.ZaberCommandSetStorageKey

Bases: DeviceCommandPackage

<summary> command to set the storage key / value on a zaber device. <summary>

property alias

user definable unique alias for this command package

className()

cloneFrom(other)

clone from another device package - should be implemented for custom types. :type other: DeviceCommandPackage :param other:

property continuous

set to true if command is a continous (async/time consuming) command or if it is desired that the command run indefinitely. (tracking command etc) set to false if the command should terminate once a target is reached.

createSharedPtr()

property key

<summary> Zaber Storage Key <summary>

markUpdatePackageReady()

signal the update package is ready to be used in running commands. prepareUpdatePackage() should be called first.

property number

prepareUpdatePackage()

Creates/Returns the DeviceCommandPackage to be used for updates to a running command. Update package will be a shallow copy of this package. It is expected that markUpdatePackageReady() be called after update package is altered. :rtype: DeviceCommandPackage :return: DeviceCommandPackage*

static staticClassName()

property thisown

The membership flag

class controlAPI.ZaberCommandStorageKeyStateInfo

Bases: CommandStateInfo

<summary> state info for storage keystate of a zaber device. <summary>

className()

property percentFinished

<summary> percentage to command completion. <summary>

static staticClassName()

property thisown

The membership flag

property value

class controlAPI.ZaberDeviceInfo

Bases: DeviceInfo

<summary> Device Info for a single Zaber device. <summary>

AddAxisInfo(axis)

addCommand(package)

addCommandGeneric(package)

property alias

property apiDeviceId

className()

commandLoggingEnabled()

commandLoggingLevel()

controlSystem()

access to owning control system.

deviceController()

access to owning controller.

initializeCommand(commandPacakge)

property internals

isConnected()

Returns true is the device is currently connected.

property motionSim

preLoopCommandCheck(checkCancelled=True)

setCommandLoggingLevel(level)

Set the command logging level, 0 - regular, 1 - more detail, 2 - even more detail, etc. :type level: int :param level:

setEnableCommandLogging(enable)

set the device to log messages to the console. (default true) :type enable: boolean :param enable:

static staticClassName()

property thisown

The membership flag

property zaberDeviceAddress

controlAPI.addLogPath(logFilePath)

Add a new log path for log files to be created in. :type logFilePath: string :param logFilePath:

controlAPI.basicFunc(a, b)

class controlAPI.controlGuiInterface

Bases: object

property noUserLoadMode

wait until the GUI is closed.

open(argc, argv)

open the control GUI in a seperate thread.

property thisown

The membership flag

update()

class controlAPI.dmxController

Bases: HardwareDeviceController

<summary> controller base class for dmx devices <summary>

addDeviceInfo(dev)

<summary> Add a device to the controller. <summary> <param name=”dev”><param>

property alias

Alias of the controller

apiId()

the assigned Api Id of the controller

checkCommandPackage(deviceId, package)

check validity of command package

className()

disconnect(expected=False)

disconnect the controller, should handle both a manual disconnect and could be called from a comm error disconnect. set expected to false if called from a timeout error or unknown disconnect event. - error messages are printed. set expected to true if a manual disconnection is wanted.- info messages are printed.

getLogger()

isConnected()

returns true if the controller is currently connected.

isSimulated()

return if the controller is simulated. :rtype: boolean :return:

loggerName()

property port

port for connecting, if the device is a serial device this can be “COM3” or “/dev/tty.***”

removeDeviceInfo(dev)

Remove an already added device.

setDisconnectCallback(callback)

set a disconnected callback function to be called when the controller is disconnected.

setSimulated(simulated)

set the simulated flag on the controller - simulated controllers can simulate interaction with attached devices. can only be set before the controller is initialized. :type simulated: boolean :param simulated:

static staticClassName()

property thisown

The membership flag

controlAPI.getRuntimeDependancyPath()

controlAPI.getRuntimeLibraryPath()

controlAPI.homeSpace_To_Zaber(home)

<summary>

<summary> <param name=”home”><param> <returns><returns>

controlAPI.logLocation(index)

return the full path of the log location :type index: int :param index: the log location index (default 0) :rtype: string :return: the log location as a string.

controlAPI.printTestErrorMessage()

print a test error message from the library

controlAPI.printTestErrorThrowMessage()

print a test error message from the library and throw an exception

controlAPI.printTestMessage()

print a test message from the library

controlAPI.pythonPrintLogFunction()

controlAPI.raiseTestSIGSEG()

raise a test SIGSEGV signal from the library :rtype: int :return:

controlAPI.throwTestException()

throw a test exception from the library :rtype: int :return:

class controlAPI.zaberController

Bases: HardwareDeviceController

<summary> controller for Zaber devices <summary>

addDeviceInfo(dev)

<summary> Add a device to the controller. <summary> <param name=”dev”><param>

property alias

Alias of the controller

apiId()

the assigned Api Id of the controller

checkCommandPackage(deviceId, package)

check validity of command package

className()

disconnect(expected=False)

disconnect the controller, should handle both a manual disconnect and could be called from a comm error disconnect. set expected to false if called from a timeout error or unknown disconnect event. - error messages are printed. set expected to true if a manual disconnection is wanted.- info messages are printed.

getLogger()

isConnected()

returns true if the controller is currently connected.

isSimulated()

return if the controller is simulated. :rtype: boolean :return:

loggerName()

property port

port for connecting, if the device is a serial device this can be “COM3” or “/dev/tty.***”

removeDeviceInfo(dev)

Remove an already added device.

setDisconnectCallback(callback)

set a disconnected callback function to be called when the controller is disconnected.

setSimulated(simulated)

set the simulated flag on the controller - simulated controllers can simulate interaction with attached devices. can only be set before the controller is initialized. :type simulated: boolean :param simulated:

static staticClassName()

property thisown

The membership flag

controlAPI.zaber_To_HomeSpace(zaber)

<summary> convert zaber axis positions to homespace coordinates. <summary> <param name=”zaber”><param> <returns><returns>