Controller device

CspSubElementController.

Controller device for SKA CSP Subelement.

class CspControllerComponentManager(*args: Any, **kwargs: Any)

A stub for a CSP controller component manager.

class CspSubElementController(*args: Any, **kwargs: Any)

Controller 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’

create_component_manager() → ComponentManagerT

Create and return a component manager for this device.

Raises:

NotImplementedError – because it is not implemented.

powerDelayStandbyOn

Device attribute.

powerDelayStandbyOff

Device attribute.

onProgress

Device attribute.

onMaximumDuration

Device attribute.

onMeasuredDuration

Device attribute.

standbyProgress

Device attribute.

standbyMaximumDuration

Device attribute.

standbyMeasuredDuration

Device attribute.

offProgress

Device attribute.

offMaximumDuration

Device attribute.

offMeasuredDuration

Device attribute.

totalOutputDataRateToSdp

Device attribute.

loadFirmwareProgress

Device attribute.

loadFirmwareMaximumDuration

Device attribute.

loadFirmwareMeasuredDuration

Device attribute.

init_command_objects() → None

Set up the command objects.

class InitCommand(*args: Any, **kwargs: Any)

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

do(*args: Any, **kwargs: Any) → Tuple[ResultCode, str]

Stateless hook for device initialisation.

Parameters:

• args – positional arguments to this do method

• kwargs – keyword arguments to this do method

Returns:

A tuple containing a return code and a string message indicating status. The message is for information purpose only.

read_powerDelayStandbyOn() → float

Return the powerDelayStandbyOn attribute.

Returns:

the powerDelayStandbyOn attribute.

write_powerDelayStandbyOn(value: float) → None

Set the powerDelayStandbyOn attribute.

Parameters:

value – the new standby-on power delay.

read_onProgress() → int

Return the onProgress attribute.

Returns:

the onProgress attribute.

read_onMaximumDuration() → float

Return the onMaximumDuration attribute.

Returns:

the onMaximumDuration attribute.

write_onMaximumDuration(value: float) → None

Set the onMaximumDuration attribute.

Parameters:

value – the new maximum duration

read_onMeasuredDuration() → float

Return the onMeasuredDuration attribute.

Returns:

the onMeasuredDuration attribute.

read_standbyProgress() → int

Return the standbyProgress attribute.

Returns:

the standbyProgress attribute.

read_standbyMaximumDuration() → float

Return the standbyMaximumDuration attribute.

Returns:

the standbyMaximumDuration attribute.

write_standbyMaximumDuration(value: float) → None

Set the standbyMaximumDuration attribute.

Parameters:

value – the new maximum duration

read_standbyMeasuredDuration() → float

Return the standbyMeasuredDuration attribute.

Returns:

the standbyMeasuredDuration attribute.

read_offProgress() → int

Return the offProgress attribute.

Returns:

the offProgress attribute.

read_offMaximumDuration() → float

Return the offMaximumDuration attribute.

Returns:

the offMaximumDuration attribute.

write_offMaximumDuration(value: float) → None

Set the offMaximumDuration attribute.

Parameters:

value – the new maximum duration.

read_offMeasuredDuration() → float

Return the offMeasuredDuration attribute.

Returns:

the offMeasuredDuration attribute.

read_totalOutputDataRateToSdp() → float

Return the totalOutputDataRateToSdp attribute.

Returns:

the totalOutputDataRateToSdp attribute.

read_powerDelayStandbyOff() → float

Return the powerDelayStandbyOff attribute.

Returns:

the powerDelayStandbyOff attribute.

write_powerDelayStandbyOff(value: float) → None

Set the powerDelayStandbyOff attribute.

Parameters:

value – the new standby-off power delay.

read_loadFirmwareProgress() → int

Return the loadFirmwareProgress attribute.

Returns:

the loadFirmwareProgress attribute.

read_loadFirmwareMaximumDuration() → float

Return the loadFirmwareMaximumDuration attribute.

Returns:

the loadFirmwareMaximumDuration attribute.

write_loadFirmwareMaximumDuration(value: float) → None

Set the loadFirmwareMaximumDuration attribute.

Parameters:

value – the new maximum duration.

read_loadFirmwareMeasuredDuration() → float

Return the loadFirmwareMeasuredDuration attribute.

Returns:

the loadFirmwareMeasuredDuration attribute.

class LoadFirmwareCommand(*args: Any, **kwargs: Any)

A class for the LoadFirmware command.

Initialise a new LoadFirmwareCommand instance.

Parameters:

logger – a logger for the command to log with

do(*args: Any, **kwargs: Any) → Tuple[ResultCode, str]

Stateless hook for device LoadFirmware() command.

Parameters:

• args – positional arguments to this do method

• kwargs – keyword arguments to this do method

Returns:

A tuple containing a return code and a string message indicating status. The message is for information purpose only.

class PowerOnDevicesCommand(*args: Any, **kwargs: Any)

A class for the CspSubElementController’s PowerOnDevices command.

Initialise a new PowerOnDevicesCommand`` instance.

Parameters:

logger – a logger for the command to log with

do(*args: Any, **kwargs: Any) → Tuple[ResultCode, str]

Stateless hook for device PowerOnDevices() command.

Parameters:

• args – positional arguments to this do method

• kwargs – keyword arguments to this do method

Returns:

A tuple containing a return code and a string message indicating status. The message is for information purpose only.

class PowerOffDevicesCommand(*args: Any, **kwargs: Any)

A class for the CspSubElementController’s PowerOffDevices command.

Initialise a new PowerOffDevicesCommand instance.

Parameters:

logger – a logger for the command to log with

do(*args: Any, **kwargs: Any) → Tuple[ResultCode, str]

Stateless hook for device PowerOffDevices() command.

Parameters:

• args – positional arguments to this do method

• kwargs – keyword arguments to this do method

Returns:

A tuple containing a return code and a string message indicating status. The message is for information purpose only.

class ReInitDevicesCommand(*args: Any, **kwargs: Any)

A class for the CspSubElementController’s ReInitDevices command.

Initialise a new ReInitDevicesCommand instance.

Parameters:

logger – a logger for the command to log with

do(*args: Any, **kwargs: Any) → Tuple[ResultCode, str]

Stateless hook for device ReInitDevices() command.

Parameters:

• args – positional arguments to this do method

• kwargs – keyword arguments to this do method

Returns:

A tuple containing a return code and a string message indicating status. The message is for information purpose only.

is_LoadFirmware_allowed() → bool

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

Returns:

True if command is allowed

is_PowerOnDevices_allowed() → bool

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

Returns:

True if command is allowed

is_PowerOffDevices_allowed() → bool

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

Returns:

True if command is allowed

is_ReInitDevices_allowed() → bool

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

Returns:

True if command is allowed

main(*args: str, **kwargs: str) → int

Entry point for module.

Parameters:

• args – positional arguments

• kwargs – named arguments

Returns:

exit code