Table Of Contents

Previous topic

Group

Next topic

Enumerations & other classes

This Page

Information classes

See also Event configuration information

Attribute

class PyTango.AttributeAlarmInfo

A structure containing available alarm information for an attribute with the folowing members:

  • min_alarm : (str) low alarm level
  • max_alarm : (str) high alarm level
  • min_warning : (str) low warning level
  • max_warning : (str) high warning level
  • delta_t : (str) time delta
  • delta_val : (str) value delta
  • extensions : (StdStringVector) extensions (currently not used)
class PyTango.AttributeDimension

A structure containing x and y attribute data dimensions with the following members:

  • dim_x : (int) x dimension
  • dim_y : (int) y dimension
class PyTango.AttributeInfo

A structure (inheriting from DeviceAttributeConfig) containing available information for an attribute with the following members:

  • disp_level : (DispLevel) display level (OPERATOR, EXPERT)
Inherited members are:
  • name : (str) attribute name
  • writable : (AttrWriteType) write type (R, W, RW, R with W)
  • data_format : (AttrDataFormat) data format (SCALAR, SPECTRUM, IMAGE)
  • data_type : (int) attribute type (float, string,..)
  • max_dim_x : (int) first dimension of attribute (spectrum or image attributes)
  • max_dim_y : (int) second dimension of attribute(image attribute)
  • description : (int) attribute description
  • label : (str) attribute label (Voltage, time, ...)
  • unit : (str) attribute unit (V, ms, ...)
  • standard_unit : (str) standard unit
  • display_unit : (str) display unit
  • format : (str) how to display the attribute value (ex: for floats could be ‘%6.2f’)
  • min_value : (str) minimum allowed value
  • max_value : (str) maximum allowed value
  • min_alarm : (str) low alarm level
  • max_alarm : (str) high alarm level
  • writable_attr_name : (str) name of the writable attribute
  • extensions : (StdStringVector) extensions (currently not used)
class PyTango.AttributeInfoEx

A structure (inheriting from AttributeInfo) containing available information for an attribute with the following members:

  • alarms : object containing alarm information (see AttributeAlarmInfo).
  • events : object containing event information (see AttributeEventInfo).
  • sys_extensions : StdStringVector
Inherited members are:
  • name : (str) attribute name
  • writable : (AttrWriteType) write type (R, W, RW, R with W)
  • data_format : (AttrDataFormat) data format (SCALAR, SPECTRUM, IMAGE)
  • data_type : (int) attribute type (float, string,..)
  • max_dim_x : (int) first dimension of attribute (spectrum or image attributes)
  • max_dim_y : (int) second dimension of attribute(image attribute)
  • description : (int) attribute description
  • label : (str) attribute label (Voltage, time, ...)
  • unit : (str) attribute unit (V, ms, ...)
  • standard_unit : (str) standard unit
  • display_unit : (str) display unit
  • format : (str) how to display the attribute value (ex: for floats could be ‘%6.2f’)
  • min_value : (str) minimum allowed value
  • max_value : (str) maximum allowed value
  • min_alarm : (str) low alarm level
  • max_alarm : (str) high alarm level
  • writable_attr_name : (str) name of the writable attribute
  • extensions : (StdStringVector) extensions (currently not used)
  • disp_level : (DispLevel) display level (OPERATOR, EXPERT)

see also PyTango.AttributeInfo

class PyTango.DeviceAttributeConfig

A base structure containing available information for an attribute with the following members:

  • name : (str) attribute name
  • writable : (AttrWriteType) write type (R, W, RW, R with W)
  • data_format : (AttrDataFormat) data format (SCALAR, SPECTRUM, IMAGE)
  • data_type : (int) attribute type (float, string,..)
  • max_dim_x : (int) first dimension of attribute (spectrum or image attributes)
  • max_dim_y : (int) second dimension of attribute(image attribute)
  • description : (int) attribute description
  • label : (str) attribute label (Voltage, time, ...)
  • unit : (str) attribute unit (V, ms, ...)
  • standard_unit : (str) standard unit
  • display_unit : (str) display unit
  • format : (str) how to display the attribute value (ex: for floats could be ‘%6.2f’)
  • min_value : (str) minimum allowed value
  • max_value : (str) maximum allowed value
  • min_alarm : (str) low alarm level
  • max_alarm : (str) high alarm level
  • writable_attr_name : (str) name of the writable attribute
  • extensions : (StdStringVector) extensions (currently not used)

Command

class PyTango.DevCommandInfo
A device command info with the following members:
  • cmd_name : (str) command name
  • cmd_tag : command as binary value (for TACO)
  • in_type : (CmdArgType) input type
  • out_type : (CmdArgType) output type
  • in_type_desc : (str) description of input type
  • out_type_desc : (str) description of output type

New in PyTango 7.0.0

class PyTango.CommandInfo
A device command info (inheriting from DevCommandInfo) with the following members:
  • disp_level : (DispLevel) command display level
Inherited members are (from DevCommandInfo):
  • cmd_name : (str) command name
  • cmd_tag : (str) command as binary value (for TACO)
  • in_type : (CmdArgType) input type
  • out_type : (CmdArgType) output type
  • in_type_desc : (str) description of input type
  • out_type_desc : (str) description of output type

Other

class PyTango.DeviceInfo

A structure containing available information for a device with the following members,

  • dev_class : string
  • server_id : string
  • server_host : string
  • server_version : integer
  • doc_url : string
class PyTango.LockerInfo

A structure with information about the locker with the folowing members,

  • ll : (PyTango.LockerLanguage) the locker language
  • li : (pid_t / UUID) the locker id
  • locker_host : (string) the host
  • locker_class : (string) the class

pid_t should be an int, UUID should be a tuple of four numbers.

New in PyTango 7.0.0

class PyTango.PollDevice

A structure containing PollDevice information the following members,

  • dev_name : string
  • ind_list : sequence<long>

New in PyTango 7.0.0

Storage classes

Attribute: DeviceAttribute

class PyTango.DeviceAttribute(da=None)

This is the fundamental type for RECEIVING data from device attributes.

It contains several fields. The most important ones depend on the ExtractAs method used to get the value. Normally they are:

  • value : Normal scalar value or numpy array of values.
  • w_value : The write part of the attribute.

See other ExtractAs for different possibilities. There are some more fields, these really fixed:

  • name : (str)
  • data_format : (AttrDataFormat) Attribute format
  • quality : (AttrQuality)
  • time : (TimeVal)
  • dim_x : (int) attribute dimension x
  • dim_y : (int) attribute dimension y
  • w_dim_x : (int) attribute written dimension x
  • w_dim_y : (int) attribute written dimension y
  • r_rimension : (tuple) Attribute read dimensions.
  • w_dimension : (tuple) Attribute written dimensions.
  • nb_read : (int) attribute read total length
  • nb_written : (int) attribute written total length
And two methods:
  • get_date
  • get_err_stack
get_date()

get_date (self) -> TimeVal

Get the time at which the attribute was read by the server.

Note: It’s the same as reading the “time” attribute.

Parameters:None
Return:(TimeVal) The attribute read timestamp.
get_err_stack()

get_err_stack (self) -> sequence<DevError>

Returns the error stack reported by the server when the attribute was read.
Parameters:None
Return:(sequence<DevError>)

Command: DeviceData

Device data is the type used internally by Tango to deal with command parameters and return values. You don’t usually need to deal with it, as command_inout will automatically convert the parameters from any other type and the result value to another type.

You can still use them, using command_inout_raw to get the result in a DeviceData.

You also may deal with it when reading command history.

class PyTango.DeviceData

This is the fundamental type for sending and receiving data from device commands. The values can be inserted and extracted using the insert() and extract() methods.

extract()

extract (self) -> any

Get the actual value stored in the DeviceData.
Parameters:None
Return:Whatever is stored there, or None.
get_type()

get_type (self) -> CmdArgType

This method returns the Tango data type of the data inside the DeviceData object.
Parameters:None
Return:The content arg type.
insert()

insert (self, data_type, value) -> None

Inserts a value in the DeviceData.
Parameters:
data_type:
value:(any) The value to insert
Return:

Whatever is stored there, or None.

is_empty()

is_empty (self) -> bool

It can be used to test whether the DeviceData object has been initialized or not.
Parameters:None
Return:True or False depending on whether the DeviceData object contains data or not.

History classes

class PyTango.DeviceAttributeHistory
Bases: PyTango._PyTango.DeviceAttribute

See DeviceAttribute.

class PyTango.DeviceDataHistory
Bases: PyTango._PyTango.DeviceData

See DeviceData.