SlimComponentManager Class

class ska_mid_cbf_mcs.slim.slim_component_manager.SlimComponentManager(*args: Any, **kwargs: Any)[source]

Manages a Serial Lightweight Interconnect Mesh (SLIM).

start_communicating() → None[source]: Establish communication with the component, then start monitoring.

stop_communicating() → None[source]: Stop communication with the component.

property is_communicating: bool

Returns whether or not the SLIM can be communicated with.

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

On command. Currently just returns OK. The device does nothing until mesh configuration is provided via the Configure 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)

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

Off command. Disconnects SLIM Links if mesh is configured, else returns OK.

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(config_str) → Tuple[ResultCode, str][source]

Configure command. Parses the mesh configuration.

Parameters:: config_str – a string in YAML format describing the links to be created.
Returns:: A tuple containing a return code and a string message indicating status. The message is for information purpose only.
Return type:: (ResultCode, str)

get_configuration_string() → str[source]

Returns the configurations string used to configure the SLIM.

get_link_fqdns() → List[str][source]

Returns a list of SLIM Link FQDNs.

get_link_names() → List[str][source]

Returns a list of SLIM Link names, formatted ‘tx_device_name->rx_device_name’.

get_health_summary() → List[HealthState][source]

Returns a list of HealthState enums describing the status of each link.

get_bit_error_rate() → List[float][source]

Returns a list containing the bit-error rates for each link.