SKA CSP Sub-element Master¶

This module implements a general Master device for a CSP Sub-element.

CspSubElementMaster

Master device for SKA CSP Subelement.

class ska_tango_base.CspSubElementMaster(*args, **kwargs)¶

Master device for SKA CSP Subelement.

Properties:

Device Property
PowerDelayStandbyOn
Delay in sec between power-up stages in Standby<-> On transitions.

Type:’DevFloat’
PowerDelayStandByOff
Delay in sec between power-up stages in Standby-> Off transition.

Type:’DevFloat’

class InitCommand(target, state_model, logger=None)¶

A class for the CspSubElementMaster’s init_device() “command”.

do()¶

Stateless hook for device initialisation.

Returns:	A tuple containing a return code and a string message indicating status. The message is for information purpose only.
Return type:	(ResultCode, str)

LoadFirmware(argin)¶

Deploy new versions of software and firmware and trigger a restart so that a Component initializes using a newly deployed version.

Parameters:	argin ('DevVarStringArray') – A list of three strings: - The file name or a pointer to the filename specified as URL. - the list of components that use software or firmware package (file), - checksum or signing Ex: [‘file://firmware.txt’,’test/dev/1, test/dev/2, test/dev/3’, ‘918698a7fea3fa9da5996db001d33628’]
Returns:	A tuple containing a return code and a string message indicating status. The message is for information purpose only.
Return type:	(ResultCode, str)

class LoadFirmwareCommand(target, state_model, logger=None)¶

A class for the CspSubElementMaster’s LoadFirmware command.

check_allowed()¶

Check if the command is in the proper state (State/adminMode) to be executed. The master device has to be in OFF/MAINTENACE to process the LoadFirmware command.

Raises:	`CommandError` if command not allowed
Returns:	`True` if the command is allowed.
Return type:	boolean

do(argin)¶

Stateless hook for device LoadFirmware() command.

Returns:	A tuple containing a return code and a string message indicating status. The message is for information purpose only.
Return type:	(ResultCode, str)

PowerDelayStandbyOff¶: Used by autodoc_mock_imports.

PowerDelayStandbyOn¶: Used by autodoc_mock_imports.

PowerOffDevices(argin)¶

Power-off a selected list of devices.

Parameters:	argin ('DevVarStringArray') – List of devices (FQDNs) to power-off.
Returns:	A tuple containing a return code and a string message indicating status. The message is for information purpose only.
Return type:	(ResultCode, str)

class PowerOffDevicesCommand(target, state_model, logger=None)¶

A class for the CspSubElementMaster’s PowerOffDevices command.

check_allowed()¶

Check if the command is in the proper state to be executed. The master device has to be in ON to process the PowerOffDevices command.

: raises: CommandError if command not allowed : return: True if the command is allowed. : rtype: boolean

do(argin)¶

Stateless hook for device PowerOffDevices() command.

Returns:	A tuple containing a return code and a string message indicating status. The message is for information purpose only.
Return type:	(ResultCode, str)

PowerOnDevices(argin)¶

Power-on a selected list of devices.

Parameters:	argin ('DevVarStringArray') – List of devices (FQDNs) to power-on.
Returns:	A tuple containing a return code and a string message indicating status. The message is for information purpose only.
Return type:	(ResultCode, str)

class PowerOnDevicesCommand(target, state_model, logger=None)¶

A class for the CspSubElementMaster’s PowerOnDevices command.

check_allowed()¶

Check if the command is in the proper state to be executed. The master device has to be in ON to process the PowerOnDevices command.

: raises: CommandError if command not allowed : return: True if the command is allowed. : rtype: boolean

do(argin)¶

Stateless hook for device PowerOnDevices() command.

Returns:	A tuple containing a return code and a string message indicating status. The message is for information purpose only.
Return type:	(ResultCode, str)

ReInitDevices(argin)¶

Reinitialize the devices passed in the input argument. The exact functionality may vary for different devices and sub-systems, each TANGO Device/Server should define what does ReInitDevices means. Ex: ReInitDevices FPGA -> reset ReInitDevices Master -> Restart ReInitDevices Leaf PC -> reboot

Parameters:	argin ('DevVarStringArray') – List of devices (FQDNs) to re-initialize.
Returns:	A tuple containing a return code and a string message indicating status. The message is for information purpose only.
Return type:	(ResultCode, str)

class ReInitDevicesCommand(target, state_model, logger=None)¶

A class for the CspSubElementMaster’s ReInitDevices command.

check_allowed()¶

Check if the command is in the proper state to be executed. The master device has to be in ON to process the ReInitDevices command.

: raises: CommandError if command not allowed : return: True if the command is allowed. : rtype: boolean

do(argin)¶

Stateless hook for device ReInitDevices() command.

Returns:	A tuple containing a return code and a string message indicating status. The message is for information purpose only.
Return type:	(ResultCode, str)

always_executed_hook()¶: Method always executed before any TANGO command is executed.

delete_device()¶

Hook to delete resources allocated in init_device.

This method allows for any memory or other resources allocated in the init_device method to be released. This method is called by the device destructor and by the device Init command.

init_command_objects()¶: Sets up the command objects

is_LoadFirmware_allowed()¶

Check if the LoadFirmware command is allowed in the current state.

Raises:	`CommandError` if command not allowed
Returns:	`True` if command is allowed
Return type:	boolean

is_PowerOffDevices_allowed()¶

Check if the PowerOffDevices command is allowed in the current state.

Raises:	`tango.DevFailed` if command not allowed
Returns:	`True` if command is allowed
Return type:	boolean

is_PowerOnDevices_allowed()¶

Check if the PowerOnDevice command is allowed in the current state.

:raises tango.DevFailed if command not allowed :return True if command is allowed :rtype: boolean

is_ReInitDevices_allowed()¶

Check if the ReInitDevices command is allowed in the current state.

Raises:	`tango.DevFailed` if command not allowed
Returns:	`True` if command is allowed
Return type:	boolean

loadFirmwareMaximumDuration¶: Used by autodoc_mock_imports.

loadFirmwareMeasuredDuration¶: Used by autodoc_mock_imports.

loadFirmwareProgress¶: Used by autodoc_mock_imports.

offMaximumDuration¶: Used by autodoc_mock_imports.

offMeasuredDuration¶: Used by autodoc_mock_imports.

offProgress¶: Used by autodoc_mock_imports.

onMaximumDuration¶: Used by autodoc_mock_imports.

onMeasuredDuration¶: Used by autodoc_mock_imports.

onProgress¶: Used by autodoc_mock_imports.

powerDelayStandbyOff¶: Used by autodoc_mock_imports.

powerDelayStandbyOn¶: Used by autodoc_mock_imports.

read_loadFirmwareMaximumDuration()¶: Return the loadFirmwareMaximumDuration attribute.

read_loadFirmwareMeasuredDuration()¶: Return the loadFirmwareMeasuredDuration attribute.

read_loadFirmwareProgress()¶: Return the loadFirmwareProgress attribute.

read_offMaximumDuration()¶: Return the offMaximumDuration attribute.

read_offMeasuredDuration()¶: Return the offMeasuredDuration attribute.

read_offProgress()¶: Return the offProgress attribute.

read_onMaximumDuration()¶: Return the onMaximumDuration attribute.

read_onMeasuredDuration()¶: Return the onMeasuredDuration attribute.

read_onProgress()¶: Return the onProgress attribute.

read_powerDelayStandbyOff()¶: Return the powerDelayStandbyOff attribute.

read_powerDelayStandbyOn()¶: Return the powerDelayStandbyOn attribute.

read_standbyMaximumDuration()¶: Return the standbyMaximumDuration attribute.

read_standbyMeasuredDuration()¶: Return the standbyMeasuredDuration attribute.

read_standbyProgress()¶: Return the standbyProgress attribute.

read_totalOutputDataRateToSdp()¶: Return the totalOutputDataRateToSdp attribute.

standbyMaximumDuration¶: Used by autodoc_mock_imports.

standbyMeasuredDuration¶: Used by autodoc_mock_imports.

standbyProgress¶: Used by autodoc_mock_imports.

totalOutputDataRateToSdp¶: Used by autodoc_mock_imports.

write_loadFirmwareMaximumDuration(value)¶: Set the loadFirmwareMaximumDuration attribute.

write_offMaximumDuration(value)¶: Set the offMaximumDuration attribute.

write_onMaximumDuration(value)¶: Set the onMaximumDuration attribute.

write_powerDelayStandbyOff(value)¶: Set the powerDelayStandbyOff attribute.

write_powerDelayStandbyOn(value)¶: Set the powerDelayStandbyOn attribute.

write_standbyMaximumDuration(value)¶: Set the standbyMaximumDuration attribute.