PoolDevice

Generic Tango Pool Device base classes

Classes

PoolDevice

Inheritance diagram of PoolDevice
class PoolDevice(dclass, name)[source]

Bases: SardanaDevice

Base Tango Pool device class

ExtremeErrorStates = (tango._tango.DevState.FAULT, tango._tango.DevState.UNKNOWN)

list of extreme error states

BusyStates = (tango._tango.DevState.MOVING, tango._tango.DevState.RUNNING)

list of busy states

BusyRetries = 3

Maximum number of retries in a busy state

init(name)[source]

initialize the device once in the object lifetime. Override when necessary but always call the method from your super class

Parameters:

name (str) – device name

get_id()[source]

Returns the element id from database (name or numeric id).

Return type:

Union[str, int]

Returns:

the element id

get_ctrl_id()[source]

Returns the controller id from database (name or numeric id).

Return type:

Union[str, int]

Returns:

the controller id

get_instrument_id()[source]

Returns the instrument id from database (name or numeric id).

Return type:

Union[str, int]

Returns:

the instrument id

property pool_device

The tango pool device

property pool

The sardana pool object

get_element()[source]

Returns the underlying pool element object

Return type:

PoolElement

Returns:

the underlying pool element object

set_element(element)[source]

Associates this device with the sardana element

Parameters:

element (PoolElement) – the sardana element

Return type:

None

property element: PoolElement

The underlying sardana element

init_device()[source]

Initialize the device. Called during startup after init() and every time the tango Init command is executed. Override when necessary but always call the method from your super class

delete_device()[source]

Clean the device. Called during shutdown and every time the tango Init command is executed. Override when necessary but always call the method from your super class

Abort()[source]

The tango abort command. Aborts the active operation

is_Abort_allowed()[source]

Returns True if it is allowed to execute the tango abort command

Return type:

bool

Returns:

True if it is allowed to execute the tango abort command or False otherwise

Stop()[source]

The tango stop command. Stops the active operation

is_Stop_allowed()[source]

Returns True if it is allowed to execute the tango stop command

Return type:

bool

Returns:

True if it is allowed to execute the tango stop command or False otherwise

Release()[source]

The tango release command. Release the active operation

is_Release_allowed()[source]

Returns True if it is allowed to execute the tango release command

Return type:

bool

Returns:

True if it is allowed to execute the tango release command or False otherwise

get_dynamic_attributes()[source]

Returns the standard dynamic and fully dynamic attributes for this device. The return is a tuple of two dictionaries:

  • standard attributes: caseless dictionary with key being the attribute name and value is a tuple of attribute name(str), tango information, attribute information

  • dynamic attributes: caseless dictionary with key being the attribute name and value is a tuple of attribute name(str), tango information, attribute information

tango information

seq< CmdArgType, AttrDataFormat, AttrWriteType >

attribute information

attribute information as returned by the sardana controller

Return type:

Tuple[CaselessDict, CaselessDict]

Returns:

the standard dynamic and fully dynamic attributes

initialize_dynamic_attributes()[source]

Initializes this device dynamic attributes

remove_unwanted_dynamic_attributes(new_std_attrs, new_dyn_attrs)[source]

Removes unwanted dynamic attributes from previous device creation

add_dynamic_attribute(attr_name, data_info, attr_info, read, write, is_allowed)[source]

Adds a single dynamic attribute

Parameters:

  • attr_name (str) – the attribute name

  • data_info (Tuple[CmdArgType, AttrDataFormat, AttrWriteType]) – tango attribute information

  • attr_info (Any) – attribute information

  • read (Any) – read method for the attribute

  • write (Any) – write method for the attribute

  • is_allowed (Any) – is allowed method

Return type:

Attr

add_standard_attribute(attr_name, data_info, attr_info, read, write, is_allowed)[source]

Adds a single standard dynamic attribute

Parameters:

  • attr_name (str) – the attribute name

  • data_info (Tuple[CmdArgType, AttrDataFormat, AttrWriteType]) – tango attribute information

  • attr_info (Any) – attribute information

  • read (Any) – read method for the attribute

  • write (Any) – write method for the attribute

  • is_allowed (Any) – is allowed method

Return type:

Attr

read_DynamicAttribute(attr)[source]

Generic read dynamic attribute. Default implementation raises NotImplementedError

Parameters:

attr (Attribute) – attribute to be read

Raises:

NotImplementedError

Return type:

None

write_DynamicAttribute(attr)[source]

Generic write dynamic attribute. Default implementation raises NotImplementedError

Parameters:

attr (Attribute) – attribute to be written

Raises:

NotImplementedError

Return type:

None

is_DynamicAttribute_allowed(req_type)[source]

Generic is dynamic attribute allowed. Default implementation calls _is_allowed()

Parameters:

req_type (Any) – request type

Return type:

bool

dev_state()[source]

Calculates and returns the device state. Called by Tango on a read state request.

Return type:

DevState

Returns:

the device state

dev_status()[source]

Calculates and returns the device status. Called by Tango on a read status request.

Return type:

str

Returns:

the device status

wait_for_operation()[source]

Waits for an operation to finish. It uses the maxumum number of retries. Sleeps 0.01s between retries.

Raises:

Exception in case of a timeout

Restore()[source]

Restore tango command. Restores the attributes to their former glory. This applies to memorized writable attributes which have a set point stored in the database

get_restore_data()[source]
get_attributes_to_restore()[source]
restore_attribute(attribute, write_meth, db_value)[source]

PoolDeviceClass

Inheritance diagram of PoolDeviceClass
class PoolDeviceClass(name)[source]

Bases: SardanaDeviceClass

Base Tango Pool Device Class class

class_property_list = {}

Sardana device class properties definition

See also

Write a server (original API)

device_property_list = {'Force_HW_Read': [tango._tango.CmdArgType.DevBoolean, 'Force a hardware read of value even when in operation (motion/acquisition', False], 'Id': [tango._tango.CmdArgType.DevLong64, 'Internal ID', 0]}

Sardana device properties definition

See also

Write a server (original API)

cmd_list = {'Abort': [[tango._tango.CmdArgType.DevVoid, ''], [tango._tango.CmdArgType.DevVoid, '']], 'Release': [[tango._tango.CmdArgType.DevVoid, ''], [tango._tango.CmdArgType.DevVoid, '']], 'Restore': [[tango._tango.CmdArgType.DevVoid, ''], [tango._tango.CmdArgType.DevVoid, '']], 'Stop': [[tango._tango.CmdArgType.DevVoid, ''], [tango._tango.CmdArgType.DevVoid, '']]}

Sardana device command definition

See also

Write a server (original API)

attr_list = {}

Sardana device attribute definition

See also

Write a server (original API)

standard_attr_list = {}

PoolElementDevice

Inheritance diagram of PoolElementDevice
class PoolElementDevice(dclass, name)[source]

Bases: PoolDevice

Base Tango Pool Element Device class

ignore_memorized_attrs_during_initialization = ()
init_device()[source]

Initialize the device. Called during startup after init() and every time the tango Init command is executed. Override when necessary but always call the method from your super class

initialize_attribute_values()[source]

Initialize attribute values.

delete_device()[source]

Clean the device. Called during shutdown and every time the tango Init command is executed. Override when necessary but always call the method from your super class

read_Instrument(attr)[source]

Read the value of the Instrument tango attribute. Returns the instrument full name or empty string if this element doesn’t belong to any instrument

Parameters:

attr (Attribute) – tango instrument attribute

Return type:

None

write_Instrument(attr)[source]

Write the value of the Instrument tango attribute. Sets a new instrument full name or empty string if this element doesn’t belong to any instrument. The instrument must have been previously created.

Parameters:

attr (Attribute) – tango instrument attribute

Return type:

None

get_dynamic_attributes()[source]

Override of PoolDevice.get_dynamic_attributes. Returns the standard dynamic and fully dynamic attributes for this device. The return is a tuple of two dictionaries:

  • standard attributes: caseless dictionary with key being the attribute name and value is a tuple of attribute name(str), tango information, attribute information

  • dynamic attributes: caseless dictionary with key being the attribute name and value is a tuple of attribute name(str), tango information, attribute information

tango information

seq< CmdArgType, AttrDataFormat, AttrWriteType >

attribute information

attribute information as returned by the sardana controller

Return type:

Tuple[CaselessDict, CaselessDict]

Returns:

the standard dynamic and fully dynamic attributes

read_DynamicAttribute(attr)[source]

Read a generic dynamic attribute. Calls the controller of this element to get the dynamic attribute value

Parameters:

attr (Attribute) – tango attribute

Return type:

None

write_DynamicAttribute(attr)[source]

Write a generic dynamic attribute. Calls the controller of this element to get the dynamic attribute value

Parameters:

attr (Attribute) – tango attribute

Return type:

None

read_SimulationMode(attr)[source]

Read the current simulation mode.

Parameters:

attr (Attribute) – tango attribute

Return type:

None

write_SimulationMode(attr)[source]

Sets the simulation mode.

Parameters:

attr (Attribute) – tango attribute

Return type:

None

PoolElementDeviceClass

Inheritance diagram of PoolElementDeviceClass
class PoolElementDeviceClass(name)[source]

Bases: PoolDeviceClass

Base Tango Pool Element Device Class class

device_property_list = {'Axis': [tango._tango.CmdArgType.DevLong64, 'Axis in the controller', [0]], 'Ctrl_id': [tango._tango.CmdArgType.DevString, 'Controller ID', [0]], 'Force_HW_Read': [tango._tango.CmdArgType.DevBoolean, 'Force a hardware read of value even when in operation (motion/acquisition', False], 'Id': [tango._tango.CmdArgType.DevLong64, 'Internal ID', 0], 'Instrument_id': [tango._tango.CmdArgType.DevString, 'Instrument ID', [0]]}

Sardana device properties definition

See also

Write a server (original API)

attr_list = {'Instrument': [[tango._tango.CmdArgType.DevString, tango._tango.AttrDataFormat.SCALAR, tango._tango.AttrWriteType.READ_WRITE], {'Display level': tango._tango.DispLevel.EXPERT, 'label': 'Instrument'}], 'SimulationMode': [[tango._tango.CmdArgType.DevBoolean, tango._tango.AttrDataFormat.SCALAR, tango._tango.AttrWriteType.READ_WRITE], {'label': 'Simulation mode'}]}

Sardana device attribute definition

See also

Write a server (original API)

cmd_list = {'Abort': [[tango._tango.CmdArgType.DevVoid, ''], [tango._tango.CmdArgType.DevVoid, '']], 'Release': [[tango._tango.CmdArgType.DevVoid, ''], [tango._tango.CmdArgType.DevVoid, '']], 'Restore': [[tango._tango.CmdArgType.DevVoid, ''], [tango._tango.CmdArgType.DevVoid, '']], 'Stop': [[tango._tango.CmdArgType.DevVoid, ''], [tango._tango.CmdArgType.DevVoid, '']]}

Sardana device command definition

See also

Write a server (original API)

get_standard_attr_info(attr)[source]

Returns information about the standard attribute

Parameters:

attr (str) – attribute name

Returns:

a sequence of tango data_type, data format

PoolGroupDevice

Inheritance diagram of PoolGroupDevice
class PoolGroupDevice(dclass, name)[source]

Bases: PoolDevice

Base Tango Pool Group Device class

read_ElementList(attr)[source]

Read the element list.

Parameters:

attr (Attribute) – tango attribute

Return type:

None

get_element_names()[source]

Returns the list of element names.

Returns:

a list of attribute names

elements_changed(evt_src, evt_type, evt_value)[source]

Callback for when the elements of this group changed

PoolGroupDeviceClass

Inheritance diagram of PoolGroupDeviceClass
class PoolGroupDeviceClass(name)[source]

Bases: PoolDeviceClass

Base Tango Pool Group Device Class class

device_property_list = {'Elements': [tango._tango.CmdArgType.DevVarStringArray, 'elements in the group', []], 'Force_HW_Read': [tango._tango.CmdArgType.DevBoolean, 'Force a hardware read of value even when in operation (motion/acquisition', False], 'Id': [tango._tango.CmdArgType.DevLong64, 'Internal ID', 0]}

Sardana device properties definition

See also

Write a server (original API)

cmd_list = {'Abort': [[tango._tango.CmdArgType.DevVoid, ''], [tango._tango.CmdArgType.DevVoid, '']], 'Release': [[tango._tango.CmdArgType.DevVoid, ''], [tango._tango.CmdArgType.DevVoid, '']], 'Restore': [[tango._tango.CmdArgType.DevVoid, ''], [tango._tango.CmdArgType.DevVoid, '']], 'Stop': [[tango._tango.CmdArgType.DevVoid, ''], [tango._tango.CmdArgType.DevVoid, '']]}

Sardana device command definition

See also

Write a server (original API)

attr_list = {'ElementList': [[tango._tango.CmdArgType.DevString, tango._tango.AttrDataFormat.SPECTRUM, tango._tango.AttrWriteType.READ, 4096]]}

Sardana device attribute definition

See also

Write a server (original API)