ScriptQueue

class lsst.ts.scriptqueue.ScriptQueue(index, initial_state=<State.STANDBY: 5>, standardpath=None, externalpath=None, verbose=False)

Bases: lsst.ts.salobj.base_csc.BaseCsc

CSC to load and configure scripts, so they can be run.

Parameters:
index : int

ScriptQueue SAL component index:

  • 1 for the Main telescope.
  • 2 for AuxTel.
  • Any allowed value (see Raises) for unit tests.
initial_state : lsst.ts.salobj.State or int, optional

The initial state of the CSC.

standardpath : str, bytes or os.PathLike (optional)

Path to standard SAL scripts. If None then use lsst.ts.standardscripts.get_scripts_dir().

externalpath : str, bytes or os.PathLike (optional)

Path to external SAL scripts. If None then use lsst.ts.externalscripts.get_scripts_dir().

verbose : bool

If True then print diagnostic messages to stdout.

Raises:
ValueError

If index < 0 or > MAX_SAL_INDEX//100,000 - 1. If standardpath or externalpath is not an existing directory.

Attributes Summary

default_initial_state
disabled_or_enabled Return True if the summary state is State.DISABLED or State.ENABLED.
domain
enable_cmdline_state
require_settings
simulation_mode Get the current simulation mode.
summary_state Get the summary state as a State enum.
valid_simulation_modes

Methods Summary

add_arguments(parser) Add arguments to the parser created by make_from_cmd_line.
add_kwargs_from_args(args, kwargs) Add constructor keyword arguments based on parsed arguments.
amain(index, **kwargs) Make a CSC from command-line arguments and run it.
assert_enabled([action]) Assert that an action that requires ENABLED state can be run.
begin_disable(data) Begin do_disable; called before state changes.
begin_enable(data) Begin do_enable; called before state changes.
begin_exitControl(data) Begin do_exitControl; called before state changes.
begin_standby(data) Begin do_standby; called before the state changes.
begin_start(data) Begin do_start; called before state changes.
close([exception, cancel_start]) Shut down, clean up resources and set done_task done.
close_tasks() Shut down the queue, terminate all scripts and free resources.
do_add(data) Add a script to the queue.
do_disable(data) Transition from State.ENABLED to State.DISABLED.
do_enable(data) Transition from State.DISABLED to State.ENABLED.
do_exitControl(data) Transition from State.STANDBY to State.OFFLINE and quit.
do_move(data) Move a script within the queue.
do_pause(data) Pause the queue.
do_requeue(data) Put a script back on the queue with the same configuration.
do_resume(data) Run the queue.
do_setAuthList(data) Update the authorization list.
do_setLogLevel(data) Set logging level.
do_showAvailableScripts([data]) Output a list of available scripts.
do_showQueue(data) Output the queue event.
do_showSchema(data) Output the config schema for a script.
do_showScript(data) Output the script event for one script.
do_standby(data) Transition from State.DISABLED or State.FAULT to State.STANDBY.
do_start(data) Transition from State.STANDBY to State.DISABLED.
do_stopScripts(data) Stop one or more queued scripts and/or the current script.
end_disable(data) End do_disable; called after state changes but before command acknowledged.
end_enable(data) End do_enable; called after state changes but before command acknowledged.
end_exitControl(data) End do_exitControl; called after state changes but before command acknowledged.
end_standby(data) End do_standby; called after state changes but before command acknowledged.
end_start(data) End do_start; called after state changes but before command acknowledged.
fault(code, report[, traceback]) Enter the fault state and output the errorCode event.
handle_summary_state() Called when the summary state has changed.
implement_simulation_mode(simulation_mode) Implement going into or out of simulation mode.
make_from_cmd_line(index, **kwargs) Construct a CSC from command line arguments.
put_log_level() Output the logLevel event.
put_next_visit(script_info) Output the nextVisit event.
put_next_visit_canceled(script_info) Output the nextVisitCanceled event.
put_queue() Output the queued scripts as a queue event.
put_script(script_info[, force_output]) Output information about a script as a script event.
report_summary_state() Report a new value for summary_state, including current state.
set_simulation_mode(simulation_mode) Set the simulation mode.
start() Finish creating the script queue.

Attributes Documentation

default_initial_state = 5
disabled_or_enabled

Return True if the summary state is State.DISABLED or State.ENABLED.

This is useful in handle_summary_state to determine if you should start or stop a telemetry loop, and connect to or disconnect from an external controller

domain
enable_cmdline_state = True
require_settings = False
simulation_mode

Get the current simulation mode.

0 means normal operation (no simulation).

Raises:
ExpectedError

If the new simulation mode is not a supported value.

summary_state

Get the summary state as a State enum.

valid_simulation_modes = [0]

Methods Documentation

classmethod add_arguments(parser)

Add arguments to the parser created by make_from_cmd_line.

Parameters:
parser : argparse.ArgumentParser

The argument parser.

Notes

If you override this method then you should almost certainly override add_kwargs_from_args as well.

classmethod add_kwargs_from_args(args, kwargs)

Add constructor keyword arguments based on parsed arguments.

Parameters:
args : argparse.namespace

Parsed command.

kwargs : dict

Keyword argument dict for the constructor. Update this based on args. The index argument will already be present if relevant.

Notes

If you override this method then you should almost certainly override add_arguments as well.

classmethod amain(index, **kwargs)

Make a CSC from command-line arguments and run it.

Parameters:
index : int, enum.IntEnum, True, False or None

If the CSC is indexed: specify True make index a required command-line argument that accepts any index, or an enum.IntEnum class to make index a required command-line argument that only accepts the enum values. If the CSC is not indexed specify None or 0.

**kwargs : dict, optional

Additional keyword arguments for your CSC’s constructor.

assert_enabled(action='')

Assert that an action that requires ENABLED state can be run.

Parameters:
action : str, optional

Action attempted. Not needed if this is called at the beginning of a do_... method, since the user will know what command was called.

begin_disable(data)

Begin do_disable; called before state changes.

Parameters:
data : DataType

Command data

begin_enable(data)

Begin do_enable; called before state changes.

Parameters:
data : DataType

Command data

begin_exitControl(data)

Begin do_exitControl; called before state changes.

Parameters:
data : DataType

Command data

begin_standby(data)

Begin do_standby; called before the state changes.

Parameters:
data : DataType

Command data

begin_start(data)

Begin do_start; called before state changes.

Parameters:
data : DataType

Command data

close(exception=None, cancel_start=True)

Shut down, clean up resources and set done_task done.

May be called multiple times. The first call closes the Controller; subsequent calls wait until the Controller is closed.

Subclasses should override close_tasks instead of close, unless you have a good reason to do otherwise.

Parameters:
exception : Exception, optional

The exception that caused stopping, if any, in which case the self.done_task exception is set to this value. Specify None for a normal exit, in which case the self.done_task result is set to None.

cancel_start : bool, optional

Cancel the start task? Leave this true unless calling this from the start task.

Notes

Removes the SAL log handler, calls close_tasks to stop all background tasks, pauses briefly to allow final SAL messages to be sent, then closes the dds domain.

close_tasks()

Shut down the queue, terminate all scripts and free resources.

do_add(data)

Add a script to the queue.

Start and configure a script SAL component, but don’t run it.

On success the result field of the final acknowledgement contains str(index) where index is the SAL index of the added Script.

do_disable(data)

Transition from State.ENABLED to State.DISABLED.

Parameters:
data : cmd_disable.DataType

Command data

do_enable(data)

Transition from State.DISABLED to State.ENABLED.

Parameters:
data : cmd_enable.DataType

Command data

do_exitControl(data)

Transition from State.STANDBY to State.OFFLINE and quit.

Parameters:
data : cmd_exitControl.DataType

Command data

do_move(data)

Move a script within the queue.

do_pause(data)

Pause the queue. A no-op if already paused.

Unlike most commands, this can be issued in any state.

Parameters:
data : cmd_pause.DataType (optional)

Command data. Ignored.

do_requeue(data)

Put a script back on the queue with the same configuration.

do_resume(data)

Run the queue. A no-op if already running.

Parameters:
data : cmd_resume.DataType (optional)

Command data. Ignored.

do_setAuthList(data)

Update the authorization list.

Parameters:
data : cmd_setAuthList.DataType

Authorization lists.

Notes

Add items if the data string starts with “+”, ignoring duplicates (both with respect to the existing items and within the data string). Remove items if the data string starts with “-“, ignoring missing items (items specified for removal that do not exist). Ignore whitespace after each comma and after the +/- prefix.

do_setLogLevel(data)

Set logging level.

Parameters:
data : cmd_setLogLevel.DataType

Logging level.

do_showAvailableScripts(data=None)

Output a list of available scripts.

Parameters:
data : cmd_showAvailableScripts.DataType

Command data. Ignored.

do_showQueue(data)

Output the queue event.

Parameters:
data : cmd_showQueue.DataType (optional)

Command data. Ignored.

do_showSchema(data)

Output the config schema for a script.

Parameters:
data : cmd_showSchema.DataType

Command data specifying the script.

do_showScript(data)

Output the script event for one script.

Parameters:
data : cmd_showScript.DataType (optional)

Command data. Ignored.

do_standby(data)

Transition from State.DISABLED or State.FAULT to State.STANDBY.

Parameters:
data : cmd_standby.DataType

Command data

do_start(data)

Transition from State.STANDBY to State.DISABLED.

Parameters:
data : cmd_start.DataType

Command data

do_stopScripts(data)

Stop one or more queued scripts and/or the current script.

If you stop the current script, it is moved to the history. If you stop queued scripts they are not not moved to the history.

end_disable(data)

End do_disable; called after state changes but before command acknowledged.

Parameters:
data : DataType

Command data

end_enable(data)

End do_enable; called after state changes but before command acknowledged.

Parameters:
data : DataType

Command data

end_exitControl(data)

End do_exitControl; called after state changes but before command acknowledged.

Parameters:
data : DataType

Command data

end_standby(data)

End do_standby; called after state changes but before command acknowledged.

Parameters:
data : DataType

Command data

end_start(data)

End do_start; called after state changes but before command acknowledged.

Parameters:
data : DataType

Command data

fault(code, report, traceback='')

Enter the fault state and output the errorCode event.

Parameters:
code : int

Error code for the errorCode event. If None then errorCode is not output and you should output it yourself. Specifying None is deprecated; please always specify an integer error code.

report : str

Description of the error.

traceback : str, optional

Description of the traceback, if any.

handle_summary_state()

Called when the summary state has changed.

Override to perform tasks such as starting and stopping telemetry (example).

Notes

The versions in BaseCsc and ConfigurableCsc do nothing, so if you subclass one of those you do not need to call await super().handle_summary_state().

implement_simulation_mode(simulation_mode)

Implement going into or out of simulation mode.

Deprecated. See simulation mode for details.

Parameters:
simulation_mode : int

Requested simulation mode; 0 for normal operation.

Raises:
ExpectedError

If simulation_mode is not a supported value.

classmethod make_from_cmd_line(index, **kwargs)

Construct a CSC from command line arguments.

Parameters:
index : int, enum.IntEnum, True, False or None

If the CSC is indexed: specify True make index a required command-line argument that accepts any index, or an enum.IntEnum class to make index a required command-line argument that only accepts the enum values. If the CSC is not indexed specify None or 0.

**kwargs : dict, optional

Additional keyword arguments for your CSC’s constructor.

Returns:
csc : cls

The CSC.

Notes

To add additional command-line arguments, override add_arguments and add_kwargs_from_args.

put_log_level()

Output the logLevel event.

put_next_visit(script_info)

Output the nextVisit event.

put_next_visit_canceled(script_info)

Output the nextVisitCanceled event.

put_queue()

Output the queued scripts as a queue event.

The data is put even if the queue has not changed. That way commands which alter the queue can rely on the event being published, even if the command has no effect (e.g. moving a script before itself).

put_script(script_info, force_output=False)

Output information about a script as a script event.

Designed to be used as a QueueModel script_callback.

Parameters:
script_info : ScriptInfo

Information about the script.

force_output : bool (optional)

If True the output even if not changed.

report_summary_state()

Report a new value for summary_state, including current state.

Subclasses may wish to override for code that depends on the current state (rather than the state transition command that got it into that state).

set_simulation_mode(simulation_mode)

Set the simulation mode.

Await implement_simulation_mode, update the simulation mode property and report the new value.

Parameters:
simulation_mode : int

Requested simulation mode; 0 for normal operation.

start()

Finish creating the script queue.