Door

Classes

Door

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

Bases: SardanaDevice

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 – device name

get_door()[source]
set_door(door)[source]
property door
property macro_server_device
property macro_server
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

get_id()[source]

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

Return type:

Union[str, int]

Returns:

the door id

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

on_door_changed(event_source, event_type, event_value)[source]
property macro_executor
getRunningMacro()[source]
always_executed_hook(self: tango._tango.Device_6Impl) None[source]
dev_status(self: tango._tango.Device_6Impl) str[source]
readLogAttr(attr)[source]
read_Critical(attr)
read_Error(attr)
read_Warning(attr)
read_Info(attr)
read_Output(attr)
read_Debug(attr)
read_Trace(attr)
read_Input(attr)[source]
write_Input(attr)[source]
sendRecordData(format, data)[source]
getLogAttr(name)[source]
read_Result(attr)[source]
read_RecordData(attr)[source]
read_MacroStatus(attr)[source]
read_ReservedElements(attr)[source]
AbortMacro()[source]
ReleaseMacro()[source]
is_ReleaseMacro_allowed()[source]
PauseMacro()[source]
is_PauseMacro_allowed()[source]
StopMacro()[source]
is_StopMacro_allowed()[source]
ResumeMacro()[source]
is_ResumeMacro_allowed()[source]
RunMacro(par_str_list)[source]
is_RunMacro_allowed()[source]
SimulateMacro(par_str_list)[source]
GetMacroEnv(<macro name>[, <env var. name>]) [<env var name>, <value>][source]
is_GetMacroEnv_allowed()[source]

DoorClass

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

Bases: SardanaDeviceClass

class_property_list = {}

Sardana device class properties definition

device_property_list = {'Id': [CmdArgType.DevLong64, 'Internal ID', [0]], 'MacroServerName': [CmdArgType.DevString, 'Name of the macro server device to connect to. [default: None, meaning connect to the first registered macroserver', None], 'MaxMsgBufferSize': [CmdArgType.DevLong, 'Maximum size for the Output, Result, Error, Warning, Debug and Info buffers', [512]]}

Sardana device properties definition

cmd_list = {'AbortMacro': [[CmdArgType.DevVoid, ''], [CmdArgType.DevVoid, '']], 'GetMacroEnv': [[CmdArgType.DevVarStringArray, 'Macro name followed by an optional list of environment names'], [CmdArgType.DevVarStringArray, 'Macro environment as a list of JSON-encoded keys-value pairs']], 'PauseMacro': [[CmdArgType.DevVoid, ''], [CmdArgType.DevVoid, '']], 'ReleaseMacro': [[CmdArgType.DevVoid, ''], [CmdArgType.DevVoid, '']], 'ResumeMacro': [[CmdArgType.DevVoid, ''], [CmdArgType.DevVoid, '']], 'RunMacro': [[CmdArgType.DevVarStringArray, 'Macro name and parameters'], [CmdArgType.DevVarStringArray, 'Macro Result']], 'SimulateMacro': [[CmdArgType.DevVarStringArray, 'Macro name and parameters'], [CmdArgType.DevVarStringArray, 'Macro statistics']], 'StopMacro': [[CmdArgType.DevVoid, ''], [CmdArgType.DevVoid, '']]}

Sardana device command definition

attr_list = {'Critical': [[CmdArgType.DevString, AttrDataFormat.SPECTRUM, AttrWriteType.READ, 512], {'label': 'Macro critical error message'}], 'Debug': [[CmdArgType.DevString, AttrDataFormat.SPECTRUM, AttrWriteType.READ, 512], {'label': 'Macro debug message'}], 'Error': [[CmdArgType.DevString, AttrDataFormat.SPECTRUM, AttrWriteType.READ, 512], {'label': 'Macro error message'}], 'Info': [[CmdArgType.DevString, AttrDataFormat.SPECTRUM, AttrWriteType.READ, 512], {'label': 'Macro information message'}], 'Input': [[CmdArgType.DevString, AttrDataFormat.SCALAR, AttrWriteType.READ_WRITE], {'label': 'Macro input prompt'}], 'MacroStatus': [[CmdArgType.DevEncoded, AttrDataFormat.SCALAR, AttrWriteType.READ], {'label': 'Macro Status'}], 'Output': [[CmdArgType.DevString, AttrDataFormat.SPECTRUM, AttrWriteType.READ, 512], {'label': 'Macro output message'}], 'RecordData': [[CmdArgType.DevEncoded, AttrDataFormat.SCALAR, AttrWriteType.READ], {'label': 'Record Data'}], 'ReservedElements': [[CmdArgType.DevEncoded, AttrDataFormat.SCALAR, AttrWriteType.READ], {'label': 'Reserved macro elements'}], 'Result': [[CmdArgType.DevString, AttrDataFormat.SPECTRUM, AttrWriteType.READ, 512], {'label': 'Result for the last macro'}], 'Warning': [[CmdArgType.DevString, AttrDataFormat.SPECTRUM, AttrWriteType.READ, 512], {'label': 'Macro warning message'}]}

Sardana device attribute definition