dodal.devices.synchrotron.Synchrotron

class dodal.devices.synchrotron.Synchrotron

A StandardReadable device that represents a synchrotron facility, providing access to various synchrotron parameters and operational status.

Parameters:

• signal_prefix (str, optional) – Beamline part of PV. Defaults to Prefix.SIGNAL.

• status_prefix (str, optional) – Status part of PV. Defaults to Prefix.STATUS.

• topup_prefix (str, optional) – Top-up part of PV. Defaults to Prefix.TOP_UP.

• name (str, optional) – Name of the device. Defaults to an empty string.

current

Read-only signal for the synchrotron ring current. Standard optional field in NXsource component of nexus file.

Type:

SignalR[float]

energy

Read-only signal for the synchrotron ring energy. Standard optional field in NXsource component of nexus file.

Type:

SignalR[float]

probe

Read-only signal for the probe type. Defaults to "x-ray". Standard optional field in NXsource component of nexus file.

Type:

SignalR[str]

type

Read-only signal for the synchrotron type. Defaults to "Synchrotron X-ray Source". Standard optional field in NXsource component of nexus file.

Type:

SignalR[str]

synchrotron_mode

current state of the synchrotron ring. Standard optional field "mode" in NXsource component of nexus file.

Type:

SignalR[SynchrotronMode]

machine_user_countdown

If current mode in user, counts down the number of seconds until the end of the current period.

Type:

SignalR[float]

top_up_start_countdown

counter that runs to zero at the start of TopUp and remains there until the fill is complete when it resets to time before next TopUp fill. Used in data acquisition to avoid beam intensity change during topup.

Type:

SignalR[float]

top_up_countdown

counter that runs to zero at the start of TopUp fill and is reset immediately to the time to next TopUp fill once TopUp starts.

Type:

SignalR[float]

top_up_end_countdown

counter that runs to zero at the end of TopUp fill and resets immediately to an estimate of the time before the end of the next TopUp fill. Used in data acquisition to avoid beam intensity change during topup.

Type:

SignalR[float]

fill_period

time between TopUp (in minutes).Used in data acquisition to monitor synchrotron state.

Type:

signalR[float]

top_up_state

tracks whether TopUp is currently running or not. If it is anything other than Running or Stopping TopUp isn’t active so will not disturb the beam. Used in data acquisition to confirm TopUp state.

Type:

signalR[TopUpState]

Methods

Attributes