ATPneumaticsCsc

class lsst.ts.ATPneumaticsSimulator.ATPneumaticsCsc(initial_state=<State.STANDBY: 5>)

Bases: lsst.ts.salobj.base_csc.BaseCsc

Simulator for the auxiliary telescope pneumatics controller CSC.

Parameters:
initial_state : salobj.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

disabled_or_enabled Return True if the summary state is State.DISABLED or State.ENABLED.
domain
m1CoversClosing Are the M1 covers closing?
m1CoversOpening Are the M1 covers opening?
m1VentsClosing Are the M1 vents closing?
m1VentsOpening Are the M1 vents opening?
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; called before state changes.
close([exception]) Shut down, clean up resources and set done_task done.
closeCellVents() Close the M1 vents.
closeM1Covers() 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.
openCellVents() Open the M1 vents.
openM1Covers() Open the M1 covers.
put_log_level() Output the logLevel event.
report_summary_state() Report a new value for summary_state, including current state.
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.
telemetry_loop() Output telemetry and events that have changed

Attributes Documentation

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
m1CoversClosing

Are the M1 covers closing?

m1CoversOpening

Are the M1 covers opening?

m1VentsClosing

Are the M1 vents closing?

m1VentsOpening

Are the M1 vents opening?

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; called before state changes.

Parameters:
data : DataType

Command data

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.

closeCellVents()

Close the M1 vents.

closeM1Covers()

Close the M1 covers.

close_tasks()

Shut down pending tasks. Called by close.

configure(m1_covers_close_time=20, m1_covers_open_time=20, cell_vents_close_time=5, cell_vents_open_time=1, m1_pressure=5, m2_pressure=6, main_pressure=10, cell_load=100)

Configure the CSC.

Parameters:
m1_covers_close_time : float

Time to close M1 mirror covers (sec)

m1_covers_open_time : float

Time to open M1 mirror covers (sec)

cell_vents_close_time : float

Time to close cell vents (sec)

cell_vents_open_time : float

Time to open cell vents (sec)

m1_pressure : float

Initial M1 air pressure (units?)

m2_pressure : float

Initial M2 air pressure (units?)

cell_load : float

Initial cell load (units?)

do_closeInstrumentAirValve(data)
do_closeM1CellVents(data)
do_closeM1Cover(data)
do_closeMasterAirSupply(data)
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_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.

Parameters:
data : cmd_setAuthList.DataType

Authorization lists.

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

Parameters:
simulation_mode : int

Requested simulation mode; 0 for normal operation.

Raises:
ExpectedError

If simulation_mode is not a supported value.

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

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

openCellVents()

Open the M1 vents.

openM1Covers()

Open the M1 covers.

put_log_level()

Output the logLevel event.

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_cell_vents_events(closed, opened)

Set m1VentsLimitSwitches, m1VentsPosition and cellVentsState events.

Output any changes.

Parameters:
closed : bool

Are the closed switches active?

opened : bool

Are the opened switches active?

set_m1_cover_events(closed, opened)

Set m1CoverLimitSwitches and m1CoverState events.

Output any changes.

Parameters:
closed : bool

Are the closed switches active?

opened : bool

Are the opened switches active?

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 constructing the CSC.

telemetry_loop()

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.