ATPneumaticsCsc¶

class lsst.ts.atpneumaticssimulator.ATPneumaticsCsc(initial_state: State = State.STANDBY)¶

Bases: BaseCsc

Simulator for the auxiliary telescope pneumatics controller CSC.

Parameters:

initial_statesalobj.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.

Notes

Events

cellVentsState
eStop
instrumentState
m1CoverLimitSwitches
m1CoverState
m1State
m1VentsLimitSwitches
m1VentsPosition
m2State
mainValveState
powerStatus

Attributes Summary

`default_initial_state`
`disabled_or_enabled`	Return True if the summary state is `State.DISABLED` or `State.ENABLED`.
`domain`
`enable_cmdline_state`
`m1CoversClosing`	Are the M1 covers closing?
`m1CoversOpening`	Are the M1 covers opening?
`m1VentsOpening`	Are the M1 vents opening?
`m1_vents_closing`	Are the M1 vents closing?
`simulation_help`
`simulation_mode`	Get the current simulation mode.
`summary_state`	Get the summary state as a `State` enum.
`valid_simulation_modes`
`version`

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_cell_vents`()	Close the M1 vents.
`close_m1_covers`()	Close the M1 covers.
`close_tasks`()	Shut down pending tasks.
`configure`([m1_covers_close_time, ...])	Configure the CSC.
`do_closeInstrumentAirValve`(data)
`do_closeM1CellVents`(data)
`do_closeM1Cover`(data)
`do_closeMasterAirSupply`(data)
`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_m1CloseAirValve`(data)
`do_m1OpenAirValve`(data)
`do_m1SetPressure`(data)
`do_m2CloseAirValve`(data)
`do_m2OpenAirValve`(data)
`do_m2SetPressure`(data)
`do_openInstrumentAirValve`(data)
`do_openM1CellVents`(data)
`do_openM1Cover`(data)
`do_openMasterAirSupply`(data)
`do_setAuthList`(data)	Update the authorization list.
`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.
`handle_summary_state`()	Called when the summary state has changed.
`implement_simulation_mode`(simulation_mode)	Implement going into or out of simulation mode.
`initialize`()	Initialize events and telemetry.
`make_from_cmd_line`(index, **kwargs)	Construct a CSC from command line arguments.
`open_cell_vents`()	Open the M1 vents.
`open_m1_covers`()	Open the M1 covers.
`put_log_level`()	Output the logLevel event.
`set_cell_vents_events`(closed, opened)	Set m1VentsLimitSwitches, m1VentsPosition and cellVentsState events.
`set_m1_cover_events`(closed, opened)	Set m1CoverLimitSwitches and m1CoverState events.
`set_simulation_mode`(simulation_mode)	Set the simulation mode.
`start`()	Finish constructing the CSC.
`start_phase2`()	Handle the initial state.
`telemetry_loop`()	Output telemetry and events that have changed

Attributes Documentation

default_initial_state: 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 = False¶

m1CoversClosing¶: Are the M1 covers closing?

m1CoversOpening¶: Are the M1 covers opening?

m1VentsOpening¶: Are the M1 vents opening?

m1_vents_closing¶: Are the M1 vents closing?

simulation_help: str | None = None¶

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: Sequence[int] = [1]¶

version = '?-sim'¶

Methods Documentation

classmethod add_arguments(parser: ArgumentParser) → None¶

Add arguments to the parser created by make_from_cmd_line.

Parameters:

parserargparse.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: Namespace, kwargs: dict[str, Any]) → None¶

Add constructor keyword arguments based on parsed arguments.

Parameters:

argsargparse.Namespace: Parsed command.
kwargsdict: 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.

async classmethod amain(index: int | enum.IntEnum | bool | None, **kwargs: Any) → None¶

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

Parameters:

indexint, enum.IntEnum, True, or None

If the CSC is indexed, do one of the following:

Specify True to make index a required command-line argument that accepts any nonzero index.
Specify an enum.IntEnum class to make index a required command-line argument that only accepts the enum values.
Specify a non-zero integer to use that index. This is rare; if the CSC is indexed then the user should usually be allowed to specify the index.

If the CSC is not indexed, specify None or 0.

**kwargsdict, optional

Additional keyword arguments for your CSC’s constructor.

assert_enabled(action: str = '') → None¶

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

Parameters:

actionstr, 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.

async begin_disable(data: BaseMsgType) → None¶

Begin do_disable; called before state changes.

Parameters:

dataDataType: Command data

async begin_enable(data: BaseMsgType) → None¶

Begin do_enable; called before state changes.

Parameters:

dataDataType: Command data

async begin_exitControl(data: BaseMsgType) → None¶

Begin do_exitControl; called before state changes.

Parameters:

dataDataType: Command data

async begin_standby(data: BaseMsgType) → None¶

Begin do_standby; called before the state changes.

Parameters:

dataDataType: Command data

async begin_start(data: BaseMsgType) → None¶

Begin do_start; called before state changes.

Parameters:

dataDataType: Command data

async close(exception: Optional[Exception] = None, cancel_start: bool = True) → 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:

exceptionException, 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_startbool, 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.

async close_cell_vents() → None¶: Close the M1 vents.

async close_m1_covers() → None¶: Close the M1 covers.

async close_tasks() → None¶: Shut down pending tasks. Called by close.

async configure(m1_covers_close_time: float = 20, m1_covers_open_time: float = 20, cell_vents_close_time: float = 5, cell_vents_open_time: float = 1, m1_pressure: float = 5, m2_pressure: float = 6, main_pressure: float = 10, cell_load: float = 100) → None¶

Configure the CSC.

Parameters:

m1_covers_close_timefloat: Time to close M1 mirror covers (sec)
m1_covers_open_timefloat: Time to open M1 mirror covers (sec)
cell_vents_close_timefloat: Time to close cell vents (sec)
cell_vents_open_timefloat: Time to open cell vents (sec)
m1_pressurefloat: Initial M1 air pressure (units?)
m2_pressurefloat: Initial M2 air pressure (units?)
main_pressurefloat: Initial main air pressure (units?)
cell_loadfloat: Initial cell load (units?)

async do_closeInstrumentAirValve(data: SimpleNamespace) → None¶

async do_closeM1CellVents(data: SimpleNamespace) → None¶

async do_closeM1Cover(data: SimpleNamespace) → None¶

async do_closeMasterAirSupply(data: SimpleNamespace) → None¶

async do_disable(data: BaseMsgType) → None¶

Transition from State.ENABLED to State.DISABLED.

Parameters:

datacmd_disable.DataType: Command data

async do_enable(data: BaseMsgType) → None¶

Transition from State.DISABLED to State.ENABLED.

Parameters:

datacmd_enable.DataType: Command data

async do_exitControl(data: BaseMsgType) → None¶

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

Parameters:

datacmd_exitControl.DataType: Command data

async do_m1CloseAirValve(data: SimpleNamespace) → None¶

async do_m1OpenAirValve(data: SimpleNamespace) → None¶

async do_m1SetPressure(data: SimpleNamespace) → None¶

async do_m2CloseAirValve(data: SimpleNamespace) → None¶

async do_m2OpenAirValve(data: SimpleNamespace) → None¶

async do_m2SetPressure(data: SimpleNamespace) → None¶

async do_openInstrumentAirValve(data: SimpleNamespace) → None¶

async do_openM1CellVents(data: SimpleNamespace) → None¶

async do_openM1Cover(data: SimpleNamespace) → None¶

async do_openMasterAirSupply(data: SimpleNamespace) → None¶

async do_setAuthList(data: BaseMsgType) → None¶

Update the authorization list.

Parameters:

datacmd_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.

async do_setLogLevel(data: BaseMsgType) → None¶

Set logging level.

Parameters:

datacmd_setLogLevel.DataType: Logging level.

async do_standby(data: BaseMsgType) → None¶

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

Parameters:

datacmd_standby.DataType: Command data

async do_start(data: BaseMsgType) → None¶

Transition from State.STANDBY to State.DISABLED.

Parameters:

datacmd_start.DataType: Command data

async end_disable(data: BaseMsgType) → None¶

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

Parameters:

dataDataType: Command data

async end_enable(data: BaseMsgType) → None¶

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

Parameters:

dataDataType: Command data

async end_exitControl(data: BaseMsgType) → None¶

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

Parameters:

dataDataType: Command data

async end_standby(data: BaseMsgType) → None¶

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

Parameters:

dataDataType: Command data

async end_start(data: BaseMsgType) → None¶

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

Parameters:

dataDataType: Command data

async fault(code: int | None, report: str, traceback: str = '') → None¶

Enter the fault state and output the errorCode event.

Parameters:

codeint: 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.
reportstr: Description of the error.
tracebackstr, optional: Description of the traceback, if any.

async handle_summary_state() → None¶

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

async implement_simulation_mode(simulation_mode: int) → None¶

Implement going into or out of simulation mode.

Deprecated. See simulation mode for details.

Parameters:

simulation_modeint: Requested simulation mode; 0 for normal operation.

Raises:

ExpectedError: If simulation_mode is not a supported value.

async initialize() → None¶

Initialize events and telemetry.

instrumentState
m1CoverLimitSwitches
m1CoverState
m1SetPressure
m1State
cellVentsState (should be named m1VentsState)
m1VentsLimitSwitches
m1VentsPosition
m2SetPressure
m2State
mainValveState
powerStatus

classmethod make_from_cmd_line(index: int | enum.IntEnum | bool | None, **kwargs: Any) → BaseCsc¶

Construct a CSC from command line arguments.

Parameters:

indexint, enum.IntEnum, True, or None

If the CSC is indexed, do one of the following:

Specify True to make index a required command-line argument that accepts any nonzero index.
Specify an enum.IntEnum class to make index a required command-line argument that only accepts the enum values.
Specify a non-zero integer to use that index. This is rare; if the CSC is indexed then the user should usually be allowed to specify the index.

If the CSC is not indexed, specify None or 0.

**kwargsdict, optional

Additional keyword arguments for your CSC’s constructor.

Returns:

csccls: The CSC.

Notes

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

async open_cell_vents() → None¶: Open the M1 vents.

async open_m1_covers() → None¶: Open the M1 covers.

async put_log_level() → None¶: Output the logLevel event.

async set_cell_vents_events(closed: bool, opened: bool) → None¶

Set m1VentsLimitSwitches, m1VentsPosition and cellVentsState events.

Output any changes.

Parameters:

closedbool: Are the closed switches active?
openedbool: Are the opened switches active?

async set_m1_cover_events(closed: bool, opened: bool) → None¶

Set m1CoverLimitSwitches and m1CoverState events.

Output any changes.

Parameters:

closedbool: Are the closed switches active?
openedbool: Are the opened switches active?

async set_simulation_mode(simulation_mode: int) → None¶

Set the simulation mode.

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

Parameters:

simulation_modeint: Requested simulation mode; 0 for normal operation.

async start() → None¶

Finish constructing the CSC.

Call set_simulation_mode. If this fails, set self.start_task to the exception, call stop, making the CSC unusable, and return.
Call handle_summary_state
Set self.start_task done.

async start_phase2() → None¶

Handle the initial state.

Called after start.

async telemetry_loop() → None¶

Output telemetry and events that have changed

Notes

Here are the telemetry topics that are output:

m1AirPressure
m2AirPressure
mainAirSourcePressure
loadCell

See update_events for the events that are output.

Navigation

ATPneumaticsCsc¶