CBPCSC#

class lsst.ts.cbp.CBPCSC(simulation_mode=0, initial_state=State.STANDBY, config_dir=None)#

Bases: ConfigurableCsc

This defines the CBP CSC using ts_salobj.

Parameters:

simulation_mode (int, optional) –
Supported simulation mode values
- 0: normal operation
- 1: mock controller
initial_state (lsst.ts.salobj.State, optional) – Initial state is meant for unit tests, defaults to lsst.ts.salobj.State.STANDBY
config_dir (None or str or pathlib.Path, optional) – Meant for unit tests. Tells the CSC where to look for the configuration files. Normal operation will always be in a configuration repository returned get_config_dir.

component#

Type:: CBPComponent

simulator#

Type:: None or MockServer

telemetry_task#

Type:: asyncio.Future

telemetry_interval#

The interval that telemetry is published.

Type:: float

in_position_timeout#

The time to wait for all encoders of the CBP to be in position.

Type:: int

Attributes Summary

`position`	Is all of the axes of the CBP in position.
`valid_simulation_modes`	The valid simulation modes for the CBP.
`version`

Methods Summary

`assert_unparked`()
`close_tasks`()	Shut down pending tasks.
`configure`(config)	Configure the CSC.
`do_changeMask`(data)	Changes the mask.
`do_changeMaskRotation`(data)	Changes the mask rotation variable and moves the current mask to that rotation value.
`do_move`(data)	Move the CBP mount to a specified position.
`do_park`(data)	Park the CBP.
`do_setFocus`(data)	Sets the focus.
`do_unpark`(data)	Unpark the CBP.
`get_config_pkg`()	Return the name of the configuration repository.
`handle_summary_state`()	Handle the summary state.
`in_position`()	Wait for all axes of the CBP to be in position.
`telemetry`()	Publish the updated telemetry.

Attributes Documentation

position#: Is all of the axes of the CBP in position.

valid_simulation_modes: Sequence[int] = (0, 1)#: The valid simulation modes for the CBP.

version = '1.5.3a3.dev6+gf57a57059'#

Methods Documentation

assert_unparked()#

async close_tasks()#: Shut down pending tasks. Called by close.

async configure(config)#

Configure the CSC.

Parameters:: config (types.SimpleNamespace)

async do_changeMask(data)#

Changes the mask.

Parameters:: data (cmd_changeMask.DataType)

async do_changeMaskRotation(data)#

Changes the mask rotation variable and moves the current mask to that rotation value.

Parameters:: data (cmd_changeMaskRotation.DataType)

async do_move(data)#

Move the CBP mount to a specified position.

Parameters:: data (cmd_move.DataType)

async do_park(data)#

Park the CBP.

Parameters:: data (cmd_park.DataType)

async do_setFocus(data)#

Sets the focus.

Parameters:: data (cmd_setFocus.DataType)

async do_unpark(data)#

Unpark the CBP.

Parameters:: data (cmd_unpark.DataType)

static get_config_pkg()#: Return the name of the configuration repository.

async handle_summary_state()#: Handle the summary state.

async in_position()#

Wait for all axes of the CBP to be in position.

In this case, in position is defined as the encoder values being within tolerance to the target values.

async telemetry()#: Publish the updated telemetry.