Taurus Extensions¶
Classes
BaseElement¶

-
class
BaseElement
[source]¶ Bases:
object
The base class for elements in the Pool (Pool itself, Motor, ControllerClass, ExpChannel all should inherit from this class directly or indirectly)
Controller¶

-
class
Controller
(name, **kw)[source]¶ Bases:
sardana.taurus.core.tango.sardana.pool.PoolElement
Class encapsulating Controller functionality.
ControllerClass¶

CTExpChannel¶

ExpChannel¶

-
class
ExpChannel
(name, **kw)[source]¶ Bases:
sardana.taurus.core.tango.sardana.pool.PoolElement
Class encapsulating ExpChannel functionality.
-
getValueObj_
()[source]¶ 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.
-
getValueRefObj
()[source]¶ Return ValueRef attribute event generator object.
Returns: ValueRef attribute event generator Return type: TangoAttributeEG
-
go
(*args, **kwargs)[source]¶ Count and report count result.
Configuration measurement, then start and wait until finish.
Note
The count (go) method API is partially experimental (value references may be changed to values whenever possible in the future). Backwards incompatible changes may occur if deemed necessary by the core developers.
Returns: state and value (or value reference - experimental) Return type: tuple
-
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)¶ Count and report count result.
Configuration measurement, then start and wait until finish.
Note
The count (go) method API is partially experimental (value references may be changed to values whenever possible in the future). Backwards incompatible changes may occur if deemed necessary by the core developers.
Returns: state and value (or value reference - experimental) Return type: tuple
-
stopCount
(wait_ready=True, timeout=None)¶
-
stop
(wait_ready=True, timeout=None)¶
-
Instrument¶

IORegister¶

-
class
IORegister
(name, **kw)[source]¶ Bases:
sardana.taurus.core.tango.sardana.pool.PoolElement
Class encapsulating IORegister functionality.
-
getValueObj
()[source]¶ - 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
-
writeIORegister
(new_value, timeout=None)¶
-
writeIOR
(new_value, timeout=None)¶
-
readIORegister
(force=False)¶
-
readIOR
(force=False)¶
-
getValue
(force=False)¶
-
MeasurementGroup¶

-
class
MeasurementGroup
(name, **kw)[source]¶ Bases:
sardana.taurus.core.tango.sardana.pool.PoolElement
Class encapsulating MeasurementGroup functionality.
-
getChannelsEnabledInfo
()[source]¶ 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>
-
valueBufferChanged
(channel, value_buffer)[source]¶ 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)[source]¶ 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)[source]¶ 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
-
valueRefBufferChanged
(channel, value_ref_buffer)[source]¶ Receive value ref buffer updates, pre-process them, and call the subscribed callback.
Parameters: - channel (ExpChannel) – channel that reports value ref buffer update
- value_ref_buffer (
str
) – json encoded value ref buffer update, it contains at least value refs and indexes
-
subscribeValueRefBuffer
(cb=None)[source]¶ Subscribe to channels’ value ref 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
-
unsubscribeValueRefBuffer
(cb=None)[source]¶ Unsubscribe from channels’ value ref 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)[source]¶ Enable acquisition of the indicated channels.
Parameters: channels – (seq<str>) a sequence of strings indicating channel names
-
disableChannels
(channels)[source]¶ Disable acquisition of the indicated channels.
Parameters: channels – (seq<str>) a sequence of strings indicating channel names
-
count_raw
(start_time=None)[source]¶ Raw count and report count values.
Simply start and wait until finish, no configuration nor preparation.
Note
The count_raw method API is partially experimental (value references may be changed to values whenever possible in the future). Backwards incompatible changes may occur if deemed necessary by the core developers.
Parameters: start_time ( float
) – start time of the whole count operation, if not passed a current timestamp will be usedReturns: channel names and values (or value references - experimental) Return type: dict
where keys are channel full names and values are channel values (or value references - experimental)
-
go
(*args, **kwargs)[source]¶ Count and report count values.
Configuration and prepare for measurement, then start and wait until finish.
Note
The count (go) method API is partially experimental (value references may be changed to values whenever possible in the future). Backwards incompatible changes may occur if deemed necessary by the core developers.
Returns: channel names and values (or value references - experimental) Return type: dict
where keys are channel full names and values are channel values (or value references - experimental)
-
count_continuous
(synchronization, value_buffer_cb=None)[source]¶ 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)¶ Count and report count values.
Configuration and prepare for measurement, then start and wait until finish.
Note
The count (go) method API is partially experimental (value references may be changed to values whenever possible in the future). Backwards incompatible changes may occur if deemed necessary by the core developers.
Returns: channel names and values (or value references - experimental) Return type: dict
where keys are channel full names and values are channel values (or value references - experimental)
-
stopCount
(wait_ready=True, timeout=None)¶
-
stop
(wait_ready=True, timeout=None)¶
-
Motor¶

-
class
Motor
(name, **kw)[source]¶ Bases:
sardana.taurus.core.tango.sardana.pool.PoolElement
,sardana.taurus.core.tango.sardana.motion.Moveable
Class encapsulating Motor functionality.
-
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
-
MotorGroup¶

-
class
MotorGroup
(name, **kw)[source]¶ Bases:
sardana.taurus.core.tango.sardana.pool.PoolElement
,sardana.taurus.core.tango.sardana.motion.Moveable
Class encapsulating MotorGroup functionality.
-
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
-
OneDExpChannel¶

Pool¶

-
class
Pool
(name, **kw)[source]¶ Bases:
taurus.core.tango.tangodevice.TangoDevice
,sardana.taurus.core.tango.sardana.motion.MoveableSource
Class encapsulating device Pool functionality.
PoolElement¶

-
class
PoolElement
(name, **kwargs)[source]¶ Bases:
sardana.taurus.core.tango.sardana.pool.BaseElement
,taurus.core.tango.tangodevice.TangoDevice
Base class for a Pool element device.
-
waitFinish
(timeout=None, id=None)[source]¶ Wait for the operation to finish
Parameters: - timeout (float) – optional timeout (seconds)
- id (tuple(float)) – id of the opertation returned by start
-
PseudoCounter¶

-
class
PseudoCounter
(name, **kw)[source]¶ Bases:
sardana.taurus.core.tango.sardana.pool.ExpChannel
Class encapsulating PseudoCounter functionality.
PseudoMotor¶

-
class
PseudoMotor
(name, **kw)[source]¶ Bases:
sardana.taurus.core.tango.sardana.pool.PoolElement
,sardana.taurus.core.tango.sardana.motion.Moveable
Class encapsulating PseudoMotor functionality.
-
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
-
TriggerGate¶

-
class
TriggerGate
(name, **kwargs)[source]¶ Bases:
sardana.taurus.core.tango.sardana.pool.PoolElement
Class encapsulating TriggerGate functionality.
TwoDExpChannel¶

ZeroDExpChannel¶

-
class
ZeroDExpChannel
(name, **kw)[source]¶ Bases:
sardana.taurus.core.tango.sardana.pool.ExpChannel
Class encapsulating ZeroDExpChannel functionality.