SlimLink Class
- class ska_mid_cbf_mcs.slim.slim_link_device.SlimLink(cl, name)[source]
Bases:
SKABaseDevice
TANGO device class for SLIM link device.
- txDeviceName
FQDN of the link’s Tx device
- rxDeviceName
FQDN of the link’s Rx device
- linkName
Link name made up of the Tx and Rx FQDNs
- txIdleCtrlWord
Idle control word read by the link’s Tx device
- rxIdleCtrlWord
Idle control word read by the link’s Rx device
- bitErrorRate
Bit Error Rate (BER) calculated by the link’s Rx device
- counters
An array holding the counter values from the tx and rx devices in the order: [0] rx_word_count [1] rx_packet_count [2] rx_idle_word_count [3] rx_idle_error_count [4] rx_block_lost_count [5] rx_cdr_lost_count [6] tx_word_count [7] tx_packet_count [8] tx_idle_word_count
- simulationMode
Device attribute.
- create_component_manager() SlimLinkComponentManager [source]
Create and return a component manager for this device.
- Returns:
a component manager for this device
- Return type:
- read_txDeviceName() str [source]
Read the txDeviceName attribute.
- Returns:
the txDeviceName FQDN.
- Return type:
- write_txDeviceName(value: str) None [source]
Write the txDeviceName attribute.
- Parameters:
value – the txDeviceName FQDN.
- read_rxDeviceName() str [source]
Read the rxDeviceName attribute.
- Returns:
the rxDeviceName FQDN.
- Return type:
- write_rxDeviceName(value: str) None [source]
Write the rxDeviceName attribute.
- Parameters:
value – the rxDeviceName FQDN.
- read_linkName() str [source]
Read the linkName attribute.
- Returns:
the link name. Empty if not active.
- Return type:
- read_txIdleCtrlWord() int [source]
Read the txIdleCtrlWord attribute.
- Returns:
the HPS tx device’s idle ctrl word.
- Return type:
- read_rxIdleCtrlWord() int [source]
Read the rxIdleCtrlWord attribute.
- Returns:
the HPS rx device’s idle ctrl word.
- Return type:
- read_bitErrorRate() float [source]
Read the bitErrorRate attribute.
- Returns:
the bitErrorRate value.
- Return type:
- read_healthState()[source]
Read the Health State of the device. This overrides the ska-tango-base implementation.
- Returns:
Health State of the device.
- Return type:
HealthState
- write_simulationMode(value)[source]
Set the Simulation Mode of the device. This overrides the ska-tango-base implementation.
- Parameters:
value – SimulationMode
- class InitCommand(target, op_state_model, logger=None)[source]
Bases:
InitCommand
A class for the SlimLink’s init_device() “command”.
- class ConnectTxRxCommand(target, *args, logger=None, **kwargs)[source]
Bases:
ResponseCommand
The command class for the ConnectTxRx command.
Connect the SLIM Tx and Rx HPS devices to form the link.
- ConnectTxRx() tango.DevVarLongStringArray [source]
‘ConnectTxRx’ TANGO command
- Returns:
Tuple containing a return code and a string message indicating the status of the command.
- Return type:
DevVarLongStringArray
- class VerifyConnectionCommand(target, *args, logger=None, **kwargs)[source]
Bases:
ResponseCommand
The command class for the VerifyConnection command.
Run several health checks on the SLIM Link.
- VerifyConnection() tango.DevVarLongStringArray [source]
‘VerifyConnection’ TANGO command
- Returns:
Tuple containing a return code and a string message indicating the status of the command.
- Return type:
DevVarLongStringArray
- class DisconnectTxRxCommand(target, *args, logger=None, **kwargs)[source]
Bases:
ResponseCommand
The command class for the DisconnectTxRx command.
Disconnect the Tx and Rx devices. Set Rx to serial loopback mode.
- DisconnectTxRx() tango.DevVarLongStringArray [source]
‘DisconnectTxRx’ TANGO command
- Returns:
Tuple containing a return code and a string message indicating the status of the command.
- Return type:
DevVarLongStringArray
- class ClearCountersCommand(target, *args, logger=None, **kwargs)[source]
Bases:
ResponseCommand
The command class for the ClearCounters command.
Clear the read counters array on Tx and Rx sides of the SLIM Link.
- ClearCounters() tango.DevVarLongStringArray [source]
‘ClearCounters’ TANGO command
- Returns:
Tuple containing a return code and a string message indicating the status of the command.
- Return type:
DevVarLongStringArray
- 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
andsubgroups
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
andsubgroups
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
SlimLinkClass
- TangoClassName = 'SlimLink'
- 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.