set_summary_state

async lsst.ts.salobj.set_summary_state(remote: lsst.ts.salobj.remote.Remote, state: lsst.ts.salobj.sal_enums.State, settingsToApply: Optional[str] = '', timeout: float = 30) → List[lsst.ts.salobj.sal_enums.State]

Put a CSC into the specified summary state.

Parameters

remoteRemote

Remote for the CSC to be enabled.

stateState or int

Desired summary state.

settingsToApplystr or None

SettingsToApply argument for the start command. Ignored unless the CSC has to be taken from state State.STANDBY to State.DISABLED.

timeoutfloat

Timeout for each state transition command and a possible initial summaryState read (sec).

Returns

stateslist [State]

A list of the initial summary state and all summary states this function transitioned the CSC through, ending with the desired state.

Notes

This function assumes the CSC is listening to SAL commands. If the CSC is not running then this function will time out (unless the last reported summary state has been cached and matches state.