DSP Process API

Module for providing the API to be communicate with the DSP process.

The PstDsprocessApiSimulator is used in testing or simulation mode, while the PstDspProcessApiGrpc is used to connect to a remote application that exposes a gRPC API.

class ska_pst_lmc.dsp.dsp_process_api.PstDspProcessApi(logger: Logger, component_state_callback: Callable)[source]

Abstract class for the API of the DSP process.

This extends from PstProcessApi but provides the specific method of getting the monitoring data.

Initialise the API.

Parameters

  • simulator – the simulator instance to use in the API.

  • logger – the logger to use for the API.

  • component_state_callback – this allows the API to call back to the component manager / TANGO device to deal with state model changes.

class ska_pst_lmc.dsp.dsp_process_api.PstDspProcessApiSimulator(logger: Logger, component_state_callback: Callable, simulator: Optional[PstDspSimulator] = None)[source]

A simulator implemenation version of the API of PstDspProcessApi.

Initialise the API.

Parameters

  • logger – the logger to use for the API.

  • component_state_callback – this allows the API to call back to the component manager / TANGO device to deal with state model changes.

  • simulator – the simulator instance to use in the API.

configure_beam(configuration: dict, task_callback: Callable) → None[source]

Configure the beam.

Parameters

  • configuration – dictionary of parameters to be configured and their requested values

  • task_callback – callable to connect back to the component manager.

deconfigure_beam(task_callback: Callable) → None[source]

Deconfigure the beam.

Parameters

task_callback – callable to connect back to the component manager.

configure_scan(configuration: dict, task_callback: Callable) → None[source]

Configure a scan.

Parameters

  • configuration – the configuration of for the scan.

  • task_callback – callable to connect back to the component manager.

deconfigure_scan(task_callback: Callable) → None[source]

Deconfigure a scan.

Parameters

task_callback – callable to connect back to the component manager.

start_scan(args: dict, task_callback: Callable) → None[source]

Start a scan.

Parameters

  • args – arguments for the scan.

  • task_callback – callable to connect back to the component manager.

stop_scan(task_callback: Callable) → None[source]

Stop a scan.

Parameters

task_callback – callable to connect back to the component manager.

abort(task_callback: Callable) → None[source]

Abort a scan.

Parameters

task_callback – callable to connect back to the component manager.

reset(task_callback: Callable) → None[source]

Reset service when in ABORTED / FAULT state.

Parameters

task_callback – callable to connect back to the component manager.

get_env() → Dict[str, Any][source]

Get simulated environment values for DSP.DISK.