ConfigurableCsc

class lsst.ts.salobj.ConfigurableCsc(name, index, schema_path, config_dir=None, initial_state=<State.STANDBY: 5>, simulation_mode=0, initial_simulation_mode=0)

Bases: lsst.ts.salobj.BaseCsc, abc.ABC

Base class for a configurable Commandable SAL Component (CSC)

Parameters:
name : str

Name of SAL component.

index : int or None

SAL component index, or 0 or None if the component is not indexed.

schema_path : str

Path to a schema file used to validate configuration files The recommended path is <package_root>/"schema"/f"{name}.yaml" for example:

schema_path = pathlib.Path(__file__).resolve().parents[4] / “schema” / f”{name}.yaml”

config_dir : str (optional)

Directory of configuration files, or None for the standard configuration directory (obtained from get_default_config_dir). This is provided for unit testing.

initial_state : State or int (optional)

The initial state of the CSC. This is provided for unit testing, as real CSCs should start up in State.STANDBY, the default.

simulation_mode : int (optional)

Simulation mode. The default is 0: do not simulate.

initial_simulation_mode : int (optional)

A deprecated synonym for simulation_mode.
Raises:
ValueError

If config_dir is not a directory, initial_state is invalid, or simulation_mode and initial_simulation_mode are both nonzero.

salobj.ExpectedError

If simulation_mode is invalid. Note: you will only see this error if you await start_task.

Notes

Configuration

Configuration is handled by the start command, as follows:

  • The settingsToApply field specifies a path to a configuration file found in the package specified by config_pkg in a subdirectory with the name of this SAL component (e.g. Test or ATDomeTrajectory).
  • The configuration file is validated against the schema specified by specified schema_path. This includes setting default values from the schema and validating the result again (in case the default values are invalid).
  • The validated configuration is converted to a struct-like object using types.SimpleNamespace.
  • The configuration is passed to the configure method, which subclasses must override. Note that configure is called just before summary state changes from State.STANDBY to State.DISABLED.

Constructor

The constructor does the following, beyond the parent class constructor:

Attributes:
config_dir : pathlib.Path

Get or set the configuration directory.

config_validator : DefaultingValidator

Validator for configuration files that also sets default values for omitted items.

schema_version : str

Configuration schema version, as specified in the schema as the final word of the title. Used to find the config_dir.

Attributes Summary

config_dir Get or set the configuration directory.
disabled_or_enabled Return True if the summary state is State.DISABLED or State.ENABLED.
domain
simulation_mode Get the current simulation mode.
summary_state Get the summary state as a State enum.

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; configure the CSC before changing state.
close([exception]) Shut down, clean up resources and set done_task done.
close_tasks() Shut down pending tasks.
configure(config) Configure the CSC.
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_setLogLevel(data) Set logging level.
do_standby(data) Transition from State.DISABLED or State.FAULT to State.STANDBY.
do_start(data) Transition from State.STANDBY to State.DISABLED.
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.
get_config_pkg() Get the name of the configuration package, e.g.
get_default_config_dir() Compute the default directory for configuration files.
handle_summary_state() Called when the summary state has changed.
implement_simulation_mode(simulation_mode) Implement going into or out of simulation mode.
main(index, **kwargs) Start the CSC from the command line.
make_from_cmd_line(index, **kwargs) Construct a CSC from command line arguments.
put_log_level() Output the logLevel event.
read_config_dir() Set self.config_label_dict and output evt_settingVersions.
report_summary_state() Report a new value for summary_state, including current state.
set_simulation_mode(simulation_mode) Set the simulation mode.
set_summary_state(summary_state) Set the summary state
start() Finish constructing the CSC.

Attributes Documentation

config_dir

Get or set the configuration directory.

Parameters:
config_dir : str, bytes, or pathlib.Path

New configuration directory.
Returns:
config_dir : pathlib.Path

Absolute path to the configuration directory.
Raises:
ValueError

If the new configuration dir is not a directory.
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
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.

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, True, False or None

If the CSC is indexed: specify True make index a required command line argument, or specify a non-zero int to use that index. If the CSC is not indexed: specify None or 0.

**kwargs : dict (optional)

Additional keyword arguments for your CSC’s constructor. If any arguments match those from the command line the command line values will be used.
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; configure the CSC before changing state.

Parameters:
data : cmd_start.DataType

Command data

Notes

The settingsToApply field must be one of:

  • The name of a config label or config file
  • The name and version of a config file, formatted as <file_name>:<version>, where the version is a git reference, such as a git tag or commit hash. This form does not support labels.
close(exception=None)

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.

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 pending tasks. Called by close.

configure(config)

Configure the CSC.

Parameters:
config : object

The configuration as described by the schema at schema_path, as a struct-like object.

Notes

Called when running the start command, just before changing summary state from State.STANDBY to State.DISABLED.

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_setLogLevel(data)

Set logging level.

Parameters:
data : cmd_setLogLevel.DataType

Logging level.
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
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=None, report='', traceback='')

Enter the fault state and output the errorCode event.

Parameters:
code : int (optional)

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 (optional)

Description of the error.

traceback : str (optional)

Description of the traceback, if any.
static get_config_pkg()

Get the name of the configuration package, e.g. “ts_config_ocs”.

get_default_config_dir()

Compute the default directory for configuration files.

Returns:
config_dir : pathlib.Path

Default configuration directory.
Raises:
RuntimeError

If environment variable “{config_pkg}_DIR” is not defined or does not point to a directory, or points to a directory that does not contain a subdirectory with the name of this SAL component.

Notes

The base directory is environment variable “{config_pkg}_DIR”, where config_pkg = self.get_config_pkg() changed to uppercase. Configuration files are found in the subdirectory whose name is:

<SAL component name>/<schema version>

For example

Test/v1
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.

Parameters:
simulation_mode : int

Requested simulation mode; 0 for normal operation.
Raises:
ExpectedError

If simulation_mode is not a supported value.

ValueError

If simulation_mode and initial_simulation_mode are both nonzero. Only one can be specified.

Notes

Subclasses should override this method to implement simulation mode. The implementation should:

  • Check the value of simulation_mode and raise ExpectedError if not supported.
  • If simulation_mode is 0 then go out of simulation mode.
  • If simulation_mode is nonzero then enter the requested simulation mode.
classmethod main(index, **kwargs)

Start the CSC from the command line.

Parameters:
index : int, True, False or None

If the CSC is indexed: specify True make index a required command line argument, or specify a non-zero int to use that index. If the CSC is not indexed: specify None or 0.

**kwargs : dict (optional)

Additional keyword arguments for your CSC’s constructor. If any arguments match those from the command line the command line values will be used.
Returns:
csc : cls

The CSC.

Notes

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

classmethod make_from_cmd_line(index, **kwargs)

Construct a CSC from command line arguments.

Parameters:
index : int, True, False or None

If the CSC is indexed: specify True make index a required command line argument, or specify a non-zero int to use that index. If the CSC is not indexed: specify None or 0.

**kwargs : dict (optional)

Additional keyword arguments for your CSC’s constructor. If any arguments match those from the command line the command line values will be used.
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.

read_config_dir()

Set self.config_label_dict and output evt_settingVersions.

Set self.config_label_dict from self.config_dir/_labels.yaml. Output the settingVersions event as follows:

  • recommendedSettingsLabels is a comma-separated list of labels in self.config_label_dict, truncated by omitting labels if necessary.
  • recommendedSettingsVersion is derived from git information for self.config_dir, if it is a git repository, else “”.
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.
set_summary_state(summary_state)

Set the summary state

Parameters:
summary_state : State or int

The new summary state

If you set the state then it is reported as a summaryState event.
You can set summary_state to a `State` constant or to
the integer equivalent.
Raises:
ValueError

If the new summary state is an invalid integer.
start()

Finish constructing the CSC.