Taurus Extensions

Classes

BaseElement Controller ControllerClass CTExpChannel ExpChannel

Instrument IORegister MeasurementGroup Motor MotorGroup

OneDExpChannel Pool PoolElement PseudoCounter

PseudoMotor TriggerGate TwoDExpChannel ZeroDExpChannel

BaseElement

class BaseElement

Bases: object

The base class for elements in the Pool (Pool itself, Motor, ControllerClass, ExpChannel all should inherit from this class directly or indirectly)

serialize()

str(n=0)

Returns a sequence of strings representing the object in ‘consistent’ way. Default is to return <name>, <controller name>, <axis>

Parameters:n – the number of elements in the tuple.

getName()

getPoolObj()

Get reference to this object’s Pool.

getPoolData()

Get reference to this object’s Pool data.

Controller

class Controller(name, **kw)

Bases: sardana.taurus.core.tango.sardana.pool.PoolElement

Class encapsulating Controller functionality.

getModuleName()

getClassName()

getTypes()

getMainType()

addElement(elem)

removeElement(elem)

getElementByAxis(axis)

getElementByName(name)

getUsedAxes()

Return axes in use by this controller

Returns:list of axes Return type:list<int>

getUsedAxis()

getLastUsedAxis()

Return the last used axis (the highest axis) in this controller

Returns:last used axis Return type:int or None

ControllerClass

class ControllerClass(**kw)

Bases: sardana.taurus.core.tango.sardana.pool.BaseElement

getSimpleFileName()

getFileName()

getClassName()

getType()

getTypes()

getLib()

getGender()

getModel()

getOrganization()

CTExpChannel

class CTExpChannel(name, **kw)

Bases: sardana.taurus.core.tango.sardana.pool.ExpChannel

Class encapsulating CTExpChannel functionality.

ExpChannel

class ExpChannel(name, **kw)

Bases: sardana.taurus.core.tango.sardana.pool.PoolElement

Class encapsulating ExpChannel functionality.

getValueObj_()

Retrurns Value attribute event generator object.

Returns:Value attribute event generator Return type:TangoAttributeEG

..todo:: When support to Taurus 3 will be dropped provide getValueObj. Taurus 3 TaurusDevice class already uses this name.

getValue(force=False)

getValueBufferObj()

getValueBuffer()

valueBufferChanged(value_buffer)

Instrument

class Instrument(**kw)

Bases: sardana.taurus.core.tango.sardana.pool.BaseElement

getFullName()

getParentInstrument()

getParentInstrumentName()

getChildrenInstruments()

getElements()

getType()

IORegister

class IORegister(name, **kw)

Bases: sardana.taurus.core.tango.sardana.pool.PoolElement

Class encapsulating IORegister functionality.

getValueObj()

Deprecated by TEP14.

..warning::

this bck-compat implementation is not perfect because the rvalue of the returned TangoAttributeValue is now a member of TaurusDevState instead of TaurusSWDevState

Deprecated since version 4.0: Use state [agnostic] or stateObj.read [Tango] instead

readValue(force=False)

startWriteValue(new_value, timeout=None)

waitWriteValue(timeout=None)

writeValue(new_value, timeout=None)

writeIORegister(new_value, timeout=None)

writeIOR(new_value, timeout=None)

readIORegister(force=False)

readIOR(force=False)

getValue(force=False)

MeasurementGroup

class MeasurementGroup(name, **kw)

Bases: sardana.taurus.core.tango.sardana.pool.PoolElement

Class encapsulating MeasurementGroup functionality.

cleanUp()

The cleanUp. Default implementation does nothing Overwrite when necessary

getConfigurationAttrEG()

setConfiguration(configuration)

getConfiguration(force=False)

on_configuration_changed(evt_src, evt_type, evt_value)

getTimerName()

getTimer()

getTimerValue()

getMonitorName()

getMonitor()

setTimer(timer_name)

getChannels()

getCounters()

getChannelNames()

getCounterNames()

getChannelLabels()

getCounterLabels()

getChannel(name)

getChannelInfo(name)

getChannelsInfo()

getChannelsEnabledInfo()

Returns information about only enabled channels present in the measurement group in a form of ordered, based on the channel index, list.

Returns:list with channels info Return type:list<TangoChannelInfo>

getCountersInfo()

getValues(parallel=True)

getValueBuffers()

getIntegrationTime()

getIntegrationTimeObj()

setIntegrationTime(ctime)

putIntegrationTime(ctime)

getAcquisitionModeObj()

getAcquisitionMode()

setAcquisitionMode(acqMode)

getSynchronizationObj()

getSynchronization()

setSynchronization(synchronization)

getNbStartsObj()

setNbStarts(starts)

getNbStarts()

getMoveableObj()

getMoveable()

getLatencyTimeObj()

getLatencyTime()

setMoveable(moveable=None)

valueBufferChanged(channel, value_buffer)

Receive value buffer updates, pre-process them, and call the subscribed callback.

Parameters:

• channel (ExpChannel) – channel that reports value buffer update
• value_buffer (str) – json encoded value buffer update, it contains at least values and indexes

subscribeValueBuffer(cb=None)

Subscribe to channels’ value buffer update events. If no callback is passed, the default channel’s callback is subscribed which will store the data in the channel’s value_buffer attribute.

Parameters:cb (callable) – callback to be subscribed, None means subscribe the default channel’s callback

unsubscribeValueBuffer(cb=None)

Unsubscribe from channels’ value buffer events. If no callback is passed, unsubscribe the channel’s default callback.

Parameters:cb (callable) – callback to be unsubscribed, None means unsubscribe the default channel’s callback

enableChannels(channels)

Enable acquisition of the indicated channels.

Parameters:channels – (seq<str>) a sequence of strings indicating channel names

disableChannels(channels)

Disable acquisition of the indicated channels.

Parameters:channels – (seq<str>) a sequence of strings indicating channel names

prepare()

count_raw(start_time=None)

go(*args, **kwargs)

count_continuous(synchronization, value_buffer_cb=None)

Execute measurement process according to the given synchronization description.

Parameters:

• synchronization (list of groups with equidistant synchronizations) – synchronization description
• value_buffer_cb (callable) – callback on value buffer updates

Returns:

state and eventually value buffers if no callback was passed

Return type:

tuple<list<DevState>,<list>>

Todo

Think of unifying measure with count.

Note

The measure method has been included in MeasurementGroup class on a provisional basis. Backwards incompatible changes (up to and including removal of the method) may occur if deemed necessary by the core developers.

startCount(**kwargs)

waitCount(timeout=None, id=None)

Wait for the operation to finish

Parameters:

• timeout (float) – optional timeout (seconds)
• id (tuple(float)) – id of the opertation returned by start

count(*args, **kwargs)

stopCount(wait_ready=True, timeout=None)

stop(wait_ready=True, timeout=None)

Motor

class Motor(name, **kw)

Bases: sardana.taurus.core.tango.sardana.pool.PoolElement, sardana.taurus.core.tango.sardana.motion.Moveable

Class encapsulating Motor functionality.

getPosition(force=False)

getDialPosition(force=False)

getVelocity(force=False)

getAcceleration(force=False)

getDeceleration(force=False)

getBaseRate(force=False)

getBacklash(force=False)

getLimitSwitches(force=False)

getOffset(force=False)

getStepPerUnit(force=False)

getSign(force=False)

getSimulationMode(force=False)

getPositionObj()

getDialPositionObj()

getVelocityObj()

getAccelerationObj()

getDecelerationObj()

getBaseRateObj()

getBacklashObj()

getLimitSwitchesObj()

getOffsetObj()

getStepPerUnitObj()

getSimulationModeObj()

setVelocity(value)

setAcceleration(value)

setDeceleration(value)

setBaseRate(value)

setBacklash(value)

setOffset(value)

setStepPerUnit(value)

setSign(value)

go(*args, **kwargs)

startMove(**kwargs)

waitMove(timeout=None, id=None)

Wait for the operation to finish

Parameters:

• timeout (float) – optional timeout (seconds)
• id (tuple(float)) – id of the opertation returned by start

move(*args, **kwargs)

getLastMotionTime()

Returns the time it took for last go operation

getTotalLastMotionTime()

Returns the time it took for last go operation, including dead time to prepare, wait for events, etc

iterMove(**kwargs)

readPosition(force=False)

getMoveableSource()

getSize()

getIndex(name)

MotorGroup

class MotorGroup(name, **kw)

Bases: sardana.taurus.core.tango.sardana.pool.PoolElement, sardana.taurus.core.tango.sardana.motion.Moveable

Class encapsulating MotorGroup functionality.

getMotorNames()

hasMotor(name)

getPosition(force=False)

getPositionObj()

go(*args, **kwargs)

startMove(**kwargs)

waitMove(timeout=None, id=None)

Wait for the operation to finish

Parameters:

• timeout (float) – optional timeout (seconds)
• id (tuple(float)) – id of the opertation returned by start

move(*args, **kwargs)

getLastMotionTime()

Returns the time it took for last go operation

getTotalLastMotionTime()

Returns the time it took for last go operation, including dead time to prepare, wait for events, etc

readPosition(force=False)

getMoveableSource()

getSize()

getIndex(name)

OneDExpChannel

class OneDExpChannel(name, **kw)

Bases: sardana.taurus.core.tango.sardana.pool.ExpChannel

Class encapsulating OneDExpChannel functionality.

Pool

class Pool(name, **kw)

Bases: taurus.core.tango.tangodevice.TangoDevice, sardana.taurus.core.tango.sardana.motion.MoveableSource

Class encapsulating device Pool functionality.

getObject(element_info)

on_elements_changed(evt_src, evt_type, evt_value)

getElementsInfo()

getElements()

getElementInfo(name)

getElementNamesOfType(elem_type)

getElementsOfType(elem_type)

getElementsWithInterface(interface)

getElementWithInterface(elem_name, interface)

getObj(name, elem_type=None)

getMoveable(seq<string> names) → Moveable

Returns a moveable object that handles all the moveable items given in names.

createMotorGroup(mg_name, elements)

createMeasurementGroup(mg_name, elements)

deleteMeasurementGroup(name)

createElement(name, ctrl, axis=None)

renameElement(old_name, new_name)

deleteElement(name)

createController(class_name, name, *props)

deleteController(name)

PoolElement

class PoolElement(name, **kwargs)

Bases: sardana.taurus.core.tango.sardana.pool.BaseElement, taurus.core.tango.tangodevice.TangoDevice

Base class for a Pool element device.

getPoolObj()

Get reference to this object’s Pool.

getPoolData()

Get reference to this object’s Pool data.

cleanUp()

The cleanUp. Default implementation does nothing Overwrite when necessary

reserve(obj)

unreserve()

isReserved(obj=None)

getReservedWR()

getReserved()

dump_attributes()

getStateEG()

getControllerName()

getControllerObj()

getAxis()

getType()

waitReady(timeout=None)

getAttrEG(name)

Returns the TangoAttributeEG object

getAttrObj(name)

Returns the taurus.core.tangoattribute.TangoAttribute object

getInstrumentObj()

getInstrumentName(force=False)

getInstrument()

start(**kwargs)

waitFinish(timeout=None, id=None)

Wait for the operation to finish

Parameters:

• timeout (float) – optional timeout (seconds)
• id (tuple(float)) – id of the opertation returned by start

go(**kwargs)

getLastGoTime()

Returns the time it took for last go operation

getTotalLastGoTime()

Returns the time it took for last go operation, including dead time to prepare, wait for events, etc

abort(wait_ready=True, timeout=None)

stop(wait_ready=True, timeout=None)

information(tab=' ')

PseudoCounter

class PseudoCounter(name, **kw)

Bases: sardana.taurus.core.tango.sardana.pool.ExpChannel

Class encapsulating PseudoCounter functionality.

PseudoMotor

class PseudoMotor(name, **kw)

Bases: sardana.taurus.core.tango.sardana.pool.PoolElement, sardana.taurus.core.tango.sardana.motion.Moveable

Class encapsulating PseudoMotor functionality.

getPosition(force=False)

getDialPosition(force=False)

getPositionObj()

getDialPositionObj()

go(*args, **kwargs)

startMove(**kwargs)

waitMove(timeout=None, id=None)

Wait for the operation to finish

Parameters:

• timeout (float) – optional timeout (seconds)
• id (tuple(float)) – id of the opertation returned by start

move(*args, **kwargs)

getLastMotionTime()

Returns the time it took for last go operation

getTotalLastMotionTime()

Returns the time it took for last go operation, including dead time to prepare, wait for events, etc

readPosition(force=False)

getMoveableSource()

getSize()

getIndex(name)

TriggerGate

class TriggerGate(name, **kwargs)

Bases: sardana.taurus.core.tango.sardana.pool.PoolElement

Class encapsulating TriggerGate functionality.

TwoDExpChannel

class TwoDExpChannel(name, **kw)

Bases: sardana.taurus.core.tango.sardana.pool.ExpChannel

Class encapsulating TwoDExpChannel functionality.

ZeroDExpChannel

class ZeroDExpChannel(name, **kw)

Bases: sardana.taurus.core.tango.sardana.pool.ExpChannel

Class encapsulating ZeroDExpChannel functionality.