Slim Class

class ska_mid_cbf_mcs.slim.slim_device.Slim(cl, name)[source]

Bases: SKABaseDevice

TANGO device class for controlling and monitoring the SLIM

MAX_NUM_LINKS = 16

Links: TANGO property

meshConfiguration: Mesh configuration in a YAML string. This is the string provided in Configure. Returns empty string if not already configured

linkFQDNs: the Tango device FQDN of the active links.

linkNames: Returns the names of the active links.

healthSummary: Returns a list with the health state of each link. True if OK. False if the link is in a bad state.

bitErrorRate: Returns the bit-error rate of each link in a list

simulationMode: Device attribute.

always_executed_hook() → None[source]

Perform actions that are executed before every device command.

This is a Tango hook.

delete_device() → None[source]

Clean up any resources prior to device deletion.

This method is a Tango hook that is called by the device destructor and by the device Init command. It allows for any memory or other resources allocated in the init_device method to be released prior to device deletion.

init_command_objects() → None[source]: Sets up the command objects.

create_component_manager() → SlimComponentManager[source]

Create and return a component manager for this device.

Returns:: a component manager for this device.
Return type:: SlimComponentManager

class InitCommand(target, op_state_model, logger=None)[source]

Bases: InitCommand

A class for the init_device() “command”.

do() → tuple[ska_tango_base.commands.ResultCode, str][source]

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)

class OnCommand(target, op_state_model, logger=None)[source]

Bases: OnCommand

The command class for the On command.

do() → Tuple[ResultCode, str][source]

Implement On command functionality.

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 OffCommand(target, op_state_model, logger=None)[source]

Bases: OffCommand

The command class for the Off command.

do() → Tuple[ResultCode, str][source]

Implement Off command functionality.

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 ConfigureCommand(target, *args, logger=None, **kwargs)[source]

Bases: ResponseCommand

The command class for the Configure command.

is_allowed() → bool[source]

Determine if Configure is allowed (allowed when Devstate is ON).

Returns:: if Configure is allowed
Return type:: bool

do(argin: str) → Tuple[ResultCode, str][source]

Configure command. Configures the SLIM as provided in the input string.

Parameters:: argin – mesh configuration as a string in YAML format.
Returns:: A tuple containing a return code and a string message indicating status. The message is for information purpose only.
Return type:: (ResultCode, str)

Configure(argin: str) → tango.DevVarLongStringArray[source]

‘Configure’ TANGO command

Parameters:: arg (DevString) – mesh configuration as a string in YAML format
Returns:: Tuple containing a return code and a string message indicating the status of the command.
Return type:: DevVarLongStringArray

write_simulationMode(value: SimulationMode) → None[source]

Overrides the base class implementation. Additionally set the simulation mode of link devices to the same value.

Parameters:: value – SimulationMode

read_simulationMode() → SimulationMode[source]: Reads simulation mode. Overrides the base class implementation.

DebugDevice()

Enable remote debugging of this device.

To modify behaviour for this command, modify the do() method of the command class: DebugDeviceCommand.

GetVersionInfo()

Return the version information of the device.

To modify behaviour for this command, modify the do() method of the command class.

Returns:: Version details of the device.

GroupDefinitions

Device property.

Each string in the list is a JSON serialised dict defining the group_name, devices and subgroups in the group. A Tango Group object is created for each item in the list, according to the hierarchy defined. This provides easy access to the managed devices in bulk, or individually.

The general format of the list is as follows, with optional devices and subgroups keys:

[ {"group_name": "<name>",
   "devices": ["<dev name>", ...]},
  {"group_name": "<name>",
   "devices": ["<dev name>", "<dev name>", ...],
   "subgroups" : [{<nested group>},
                    {<nested group>}, ...]},
  ...
  ]

For example, a hierarchy of racks, servers and switches:

[ {"group_name": "servers",
   "devices": ["elt/server/1", "elt/server/2",
                 "elt/server/3", "elt/server/4"]},
  {"group_name": "switches",
   "devices": ["elt/switch/A", "elt/switch/B"]},
  {"group_name": "pdus",
   "devices": ["elt/pdu/rackA", "elt/pdu/rackB"]},
  {"group_name": "racks",
   "subgroups": [
        {"group_name": "rackA",
         "devices": ["elt/server/1", "elt/server/2",
                       "elt/switch/A", "elt/pdu/rackA"]},
        {"group_name": "rackB",
         "devices": ["elt/server/3", "elt/server/4",
                       "elt/switch/B", "elt/pdu/rackB"],
         "subgroups": []}
   ]} ]

LoggingLevelDefault

Device property.

Default logging level at device startup. See LoggingLevel

LoggingTargetsDefault

Device property.

Default logging targets at device startup. See the project readme for details.

Off()

Turn the device off.

To modify behaviour for this command, modify the do() method of the command class.

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

On()

Turn device on.

To modify behaviour for this command, modify the do() method of the command class.

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

Reset()

Reset the device from the FAULT state.

To modify behaviour for this command, modify the do() method of the command class.

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

SkaLevel

Device property.

Indication of importance of the device in the SKA hierarchy to support drill-down navigation: 1..6, with 1 highest.

Standby()

Put the device into standby mode.

To modify behaviour for this command, modify the do() method of the command class.

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

TangoClassClass: alias of SlimClass

TangoClassName = 'Slim'

adminMode: Device attribute.

buildState: Device attribute.

controlMode: Device attribute.

healthState: Device attribute.

loggingLevel

Device attribute.

See LoggingLevel

loggingTargets: Device attribute.

testMode: Device attribute.

versionId: Device attribute.