diff --git a/master/.buildinfo b/master/.buildinfo index 8ffe55844bf..283e25af2b1 100644 --- a/master/.buildinfo +++ b/master/.buildinfo @@ -1,4 +1,4 @@ # Sphinx build info version 1 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. -config: 43618bcbec33a2370a0b28e76a5f179a +config: 6141b8612b5c075d3fac748857beb7b9 tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/master/_sources/api.rst.txt b/master/_sources/api.rst.txt index e5ee131779b..26904c413e7 100644 --- a/master/_sources/api.rst.txt +++ b/master/_sources/api.rst.txt @@ -108,6 +108,7 @@ pcdsdevices.attenuator pcdsdevices.attenuator.GasAttenuator pcdsdevices.attenuator.GattApertureX pcdsdevices.attenuator.GattApertureY + pcdsdevices.attenuator.SXRGasAtt pcdsdevices.attenuator.SXRLadderAttenuatorBlade pcdsdevices.attenuator.SXRLadderAttenuatorStates pcdsdevices.attenuator.get_blade_enum @@ -237,6 +238,7 @@ pcdsdevices.energy_monitor pcdsdevices.energy_monitor.GEM pcdsdevices.energy_monitor.GMD + pcdsdevices.energy_monitor.GMDPreAmp pcdsdevices.energy_monitor.XGMD pcdsdevices.epics_motor @@ -435,6 +437,16 @@ pcdsdevices.jet pcdsdevices.jet.Injector pcdsdevices.jet.InjectorWithFine +pcdsdevices.keithley +-------------------- + +.. autosummary:: + :toctree: generated + + pcdsdevices.keithley.IM3L0_K2700 + pcdsdevices.keithley.K2700 + pcdsdevices.keithley.K6514 + pcdsdevices.lamp_motion ----------------------- @@ -746,8 +758,6 @@ pcdsdevices.pim pcdsdevices.pim.IM2K0 pcdsdevices.pim.IM3L0 - pcdsdevices.pim.IM3L0_K2700 - pcdsdevices.pim.K2700 pcdsdevices.pim.LCLS2ImagerBase pcdsdevices.pim.LCLS2Target pcdsdevices.pim.PIM @@ -845,6 +855,20 @@ pcdsdevices.pv_positioner pcdsdevices.pv_positioner.PVPositionerDone pcdsdevices.pv_positioner.PVPositionerIsClose +pcdsdevices.qadc +---------------- + +.. autosummary:: + :toctree: generated + + pcdsdevices.qadc.Qadc + pcdsdevices.qadc.Qadc134 + pcdsdevices.qadc.Qadc134Common + pcdsdevices.qadc.Qadc134Lcls2 + pcdsdevices.qadc.QadcCommon + pcdsdevices.qadc.QadcLcls1Timing + pcdsdevices.qadc.QadcLcls2Timing + pcdsdevices.radiation --------------------- @@ -1083,6 +1107,15 @@ pcdsdevices.timetool pcdsdevices.timetool.Timetool pcdsdevices.timetool.TimetoolWithNav +pcdsdevices.tpr +--------------- + +.. autosummary:: + :toctree: generated + + pcdsdevices.tpr.TprMotor + pcdsdevices.tpr.TprTrigger + pcdsdevices.usb_encoder ----------------------- diff --git a/master/_sources/generated/pcdsdevices.attenuator.SXRGasAtt.rst.txt b/master/_sources/generated/pcdsdevices.attenuator.SXRGasAtt.rst.txt new file mode 100644 index 00000000000..5a6441fa30a --- /dev/null +++ b/master/_sources/generated/pcdsdevices.attenuator.SXRGasAtt.rst.txt @@ -0,0 +1,205 @@ +pcdsdevices.attenuator.SXRGasAtt +================================ + +.. currentmodule:: pcdsdevices.attenuator + +.. autoclass:: SXRGasAtt + + + + .. list-table:: Ophyd Device Components + :header-rows: 1 + :widths: auto + + * - Attribute + - Class + - Suffix + - Docs + - Kind + - Notes + + * - transmission + - :class:`~ophyd.signal.EpicsSignal` + - ``:TRANS_RBV`` + - Transmission + - hinted + - + + * - arb_req + - :class:`~ophyd.signal.EpicsSignalRO` + - ``:TRANS_REQ_RBV`` + - Requested transmission + - hinted + - + + * - pressure + - :class:`~ophyd.signal.EpicsSignal` + - ``:GCM:82:PRESS_RBV`` + - Pressure + - hinted + - + + * - pressure_setpoint_rbv + - :class:`~ophyd.signal.EpicsSignalRO` + - ``:CNTRL:SP_RBV`` + - Pressure setpoint + - omitted + - + + * - mode + - :class:`~ophyd.signal.EpicsSignal` + - ``:MODE_RBV`` + - PMPS mode + - hinted + - + + * - control_enable + - :class:`~ophyd.signal.EpicsSignal` + - ``:CNTRL:ON_RBV`` + - + - hinted + - + + * - pressure_control_enable + - :class:`~ophyd.signal.EpicsSignal` + - ``:MODE:PressureControl_RBV`` + - Pressure control mode + - hinted + - + + * - gas_type + - :class:`~ophyd.signal.EpicsSignalRO` + - ``:GAS_TYPE_RBV`` + - Selected gas + - hinted + - + + * - at_target + - :class:`~ophyd.signal.EpicsSignalRO` + - ``:AtTarget_RBV`` + - At target + - hinted + - + + * - moving + - :class:`~ophyd.signal.EpicsSignalRO` + - ``:Moving_RBV`` + - Moving + - hinted + - + + * - gas_att_ok + - :class:`~ophyd.signal.EpicsSignalRO` + - ``:OK_RBV`` + - Ok + - hinted + - + + * - transmission_setpoint_rbv + - :class:`~ophyd.signal.EpicsSignalRO` + - ``:TRANS_SP_RBV`` + - Transmission setpoint + - omitted + - + + * - pressure_control_valve + - :class:`~ophyd.signal.EpicsSignalRO` + - ``:VCN:70:POS_REQ_RBV`` + - Requested position + - omitted + - + + * - valve_n2 + - :class:`~pcdsdevices.valve.VVC` + - ``:VVC:72`` + - Valve n2 + - hinted + - + + * - valve_ar + - :class:`~pcdsdevices.valve.VVC` + - ``:VVC:71`` + - Valve ar + - hinted + - + + * - valve_pressure_control + - :class:`~pcdsdevices.valve.VCN` + - ``:VCN:70`` + - Pressure control valve + - omitted + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + .. rubric:: Methods + + + .. automethod:: configure + .. automethod:: describe + .. automethod:: get + .. automethod:: post_elog_status + .. automethod:: read + .. automethod:: read_configuration + .. automethod:: screen + .. automethod:: setup_mode + .. automethod:: stage_group_instances + .. automethod:: status + .. automethod:: stop + .. automethod:: summary + .. automethod:: trigger + + + + + + .. rubric:: Attributes + + + .. autoattribute:: configuration_attrs + .. autoattribute:: connected + .. autoattribute:: hints + .. autoattribute:: kind + .. autoattribute:: needs_parent + .. autoattribute:: stage_group + .. autoattribute:: subscriptions + + \ No newline at end of file diff --git a/master/_sources/generated/pcdsdevices.energy_monitor.GMD.rst.txt b/master/_sources/generated/pcdsdevices.energy_monitor.GMD.rst.txt index 026d5f35530..ccfb26bcc30 100644 --- a/master/_sources/generated/pcdsdevices.energy_monitor.GMD.rst.txt +++ b/master/_sources/generated/pcdsdevices.energy_monitor.GMD.rst.txt @@ -18,17 +18,161 @@ - Kind - Notes - * - not_implemented - - :class:`~ophyd.signal.SignalRO` + * - avg_int + - :class:`~ophyd.signal.EpicsSignalRO` + - ``:HPS:AvgPulseIntensity`` + - Avg Pulse energy [mJ] + - hinted - + + * - mj + - :class:`~ophyd.signal.EpicsSignalRO` + - ``:HPS:milliJoulesPerPulse`` + - Pulse energy [mJ] + - hinted + - + + * - photons + - :class:`~ophyd.signal.EpicsSignalRO` + - ``:HPS:AvgPhotonsPerPulse`` + - photons + - hinted + - + + * - transmission + - :class:`~ophyd.signal.EpicsSignalRO` + - ``:HPS:AvgTransmission`` + - transmission + - hinted + - + + * - gas_type + - :class:`~ophyd.signal.EpicsSignalRO` + - ``:GAS_TYPE_RBV`` + - Gas Type + - hinted + - + + * - mean_charge + - :class:`~ophyd.signal.EpicsSignal` + - ``:HPS:MeanCharge`` + - Mean Charge used in energy calculation + - normal - + + * - xsection + - :class:`~ophyd.signal.EpicsSignal` + - ``:HPS:CrossSection`` + - Photoionization cross section used in energy calculation + - normal + - + + * - keithley_sum + - :class:`~ophyd.signal.EpicsSignalRO` + - ``:HPS:KeithleySum`` + - + - normal + - + + * - pressure + - :class:`~ophyd.signal.EpicsSignalRO` + - ``:GSR:1:Calib:Pressure:Calc`` + - Gas pressure in energy monitor - normal - + * - mean_charge_source + - :class:`~ophyd.signal.EpicsSignal` + - ``:HPS:MeanCharge:Source`` + - Source value of mean charge (Gas Table or Manual) for energy calculation + - omitted + - + + * - xsection_source + - :class:`~ophyd.signal.EpicsSignal` + - ``:HPS:MeanCharge:Source`` + - Source value of photoionization cross section (Gas Table or Manual) for energy calculation + - omitted + - + + * - temperature + - :class:`~ophyd.signal.EpicsSignalRO` + - ``:RTD:1:TEMP_RBV`` + - + - hinted + - + + * - beam_position_x + - :class:`~ophyd.signal.EpicsSignalRO` + - ``:HPS:PosXSLOW`` + - beam position x in GMD + - hinted + - + + * - beam_position_y + - :class:`~ophyd.signal.EpicsSignalRO` + - ``:HPS:PosYSLOW`` + - beam position y in GMD + - hinted + - + + * - preamp + - :class:`~pcdsdevices.energy_monitor.GMDPreAmp` + - ``:HPS`` + - + - omitted + - + + * - keithley1 + - :class:`~pcdsdevices.keithley.K6514` + - ``:ETM:01`` + - + - omitted + - + + * - keithley2 + - :class:`~pcdsdevices.keithley.K6514` + - ``:ETM:02`` + - + - omitted + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/master/_sources/generated/pcdsdevices.energy_monitor.GMDPreAmp.rst.txt b/master/_sources/generated/pcdsdevices.energy_monitor.GMDPreAmp.rst.txt new file mode 100644 index 00000000000..e89848b879d --- /dev/null +++ b/master/_sources/generated/pcdsdevices.energy_monitor.GMDPreAmp.rst.txt @@ -0,0 +1,129 @@ +pcdsdevices.energy\_monitor.GMDPreAmp +===================================== + +.. currentmodule:: pcdsdevices.energy_monitor + +.. autoclass:: GMDPreAmp + + + + .. list-table:: Ophyd Device Components + :header-rows: 1 + :widths: auto + + * - Attribute + - Class + - Suffix + - Docs + - Kind + - Notes + + * - ion_pre_att + - :class:`~ophyd.signal.EpicsSignal` + - ``:AMP_PREATTN1_RBV`` + - Channel 1 PRE attenuator + - normal + - + + * - ion_post_att + - :class:`~ophyd.signal.EpicsSignal` + - ``:AMP_POSATTN1_RBV`` + - Channel 1 POS attenuator + - normal + - + + * - elec1_pre_att + - :class:`~ophyd.signal.EpicsSignal` + - ``:AMP_PREATTN2_RBV`` + - Channel 2 PRE attenuator + - normal + - + + * - elec1_post_att + - :class:`~ophyd.signal.EpicsSignal` + - ``:AMP_POSATTN2_RBV`` + - Channel 2 POS attenuator + - normal + - + + * - elec2_pre_att + - :class:`~ophyd.signal.EpicsSignal` + - ``:AMP_PREATTN3_RBV`` + - Channel 3 PRE attenuator + - normal + - + + * - elec2_post_att + - :class:`~ophyd.signal.EpicsSignal` + - ``:AMP_POSATTN3_RBV`` + - Channel 3 POS attenuator + - normal + - + + * - spare_pre_att + - :class:`~ophyd.signal.EpicsSignal` + - ``:AMP_PREATTN4_RBV`` + - Channel 4 PRE attenuator + - normal + - + + * - spare_post_att + - :class:`~ophyd.signal.EpicsSignal` + - ``:AMP_POSATTN4_RBV`` + - Channel 4 POS attenuator + - normal + - + + + + + + + + + + + + + + + + + + + + + + + + + + .. rubric:: Methods + + + .. automethod:: configure + .. automethod:: describe + .. automethod:: get + .. automethod:: post_elog_status + .. automethod:: read + .. automethod:: read_configuration + .. automethod:: screen + .. automethod:: status + .. automethod:: stop + .. automethod:: summary + .. automethod:: trigger + + + + + + .. rubric:: Attributes + + + .. autoattribute:: configuration_attrs + .. autoattribute:: connected + .. autoattribute:: hints + .. autoattribute:: kind + .. autoattribute:: subscriptions + + \ No newline at end of file diff --git a/master/_sources/generated/pcdsdevices.pim.IM3L0_K2700.rst.txt b/master/_sources/generated/pcdsdevices.keithley.IM3L0_K2700.rst.txt similarity index 78% rename from master/_sources/generated/pcdsdevices.pim.IM3L0_K2700.rst.txt rename to master/_sources/generated/pcdsdevices.keithley.IM3L0_K2700.rst.txt index 8abb99927d5..403bea4f8fb 100644 --- a/master/_sources/generated/pcdsdevices.pim.IM3L0_K2700.rst.txt +++ b/master/_sources/generated/pcdsdevices.keithley.IM3L0_K2700.rst.txt @@ -1,7 +1,7 @@ -pcdsdevices.pim.IM3L0\_K2700 -============================ +pcdsdevices.keithley.IM3L0\_K2700 +================================= -.. currentmodule:: pcdsdevices.pim +.. currentmodule:: pcdsdevices.keithley .. autoclass:: IM3L0_K2700 @@ -23,42 +23,42 @@ - ``:Identity`` - Identity (name) of this device - normal - - Inherited from :class:`~pcdsdevices.pim.K2700` + - Inherited from :class:`~pcdsdevices.keithley.K2700` * - reading - :class:`~ophyd.signal.EpicsSignalRO` - ``:Reading`` - Trigger and return a new measurement - normal - - Inherited from :class:`~pcdsdevices.pim.K2700` + - Inherited from :class:`~pcdsdevices.keithley.K2700` * - dcv_range - :class:`~ophyd.signal.EpicsSignalRO` - ``:GetDCV`` - DC voltage range - normal - - Inherited from :class:`~pcdsdevices.pim.K2700` + - Inherited from :class:`~pcdsdevices.keithley.K2700` * - acv_range - :class:`~ophyd.signal.EpicsSignalRO` - ``:GetACV`` - AC voltage range - normal - - Inherited from :class:`~pcdsdevices.pim.K2700` + - Inherited from :class:`~pcdsdevices.keithley.K2700` * - dci_range - :class:`~ophyd.signal.EpicsSignalRO` - ``:GetDCI`` - DC current range - normal - - Inherited from :class:`~pcdsdevices.pim.K2700` + - Inherited from :class:`~pcdsdevices.keithley.K2700` * - aci_range - :class:`~ophyd.signal.EpicsSignalRO` - ``:GetACI`` - AC current range - normal - - Inherited from :class:`~pcdsdevices.pim.K2700` + - Inherited from :class:`~pcdsdevices.keithley.K2700` diff --git a/master/_sources/generated/pcdsdevices.pim.K2700.rst.txt b/master/_sources/generated/pcdsdevices.keithley.K2700.rst.txt similarity index 95% rename from master/_sources/generated/pcdsdevices.pim.K2700.rst.txt rename to master/_sources/generated/pcdsdevices.keithley.K2700.rst.txt index 12d00b8885e..6da016dd222 100644 --- a/master/_sources/generated/pcdsdevices.pim.K2700.rst.txt +++ b/master/_sources/generated/pcdsdevices.keithley.K2700.rst.txt @@ -1,7 +1,7 @@ -pcdsdevices.pim.K2700 -===================== +pcdsdevices.keithley.K2700 +========================== -.. currentmodule:: pcdsdevices.pim +.. currentmodule:: pcdsdevices.keithley .. autoclass:: K2700 diff --git a/master/_sources/generated/pcdsdevices.keithley.K6514.rst.txt b/master/_sources/generated/pcdsdevices.keithley.K6514.rst.txt new file mode 100644 index 00000000000..31f43bcefcc --- /dev/null +++ b/master/_sources/generated/pcdsdevices.keithley.K6514.rst.txt @@ -0,0 +1,156 @@ +pcdsdevices.keithley.K6514 +========================== + +.. currentmodule:: pcdsdevices.keithley + +.. autoclass:: K6514 + + + + .. list-table:: Ophyd Device Components + :header-rows: 1 + :widths: auto + + * - Attribute + - Class + - Suffix + - Docs + - Kind + - Notes + + * - avg_enable + - :class:`~ophyd.signal.EpicsSignal` + - ``:AvgEnable`` + - Enable/disable the average function + - normal + - + + * - avg_count + - :class:`~ophyd.signal.EpicsSignal` + - ``:GetAvgCount`` + - Get the averaging factor + - normal + - + + * - avg_mode + - :class:`~ophyd.signal.EpicsSignal` + - ``:PutAvgType`` + - Select filter control: Moving or Repeated + - normal + - + + * - auto_range + - :class:`~ophyd.signal.EpicsSignal` + - ``:PutAutoRange`` + - Enable/disable autorange + - normal + - + + * - current_range + - :class:`~ophyd.signal.EpicsSignal` + - ``:SelectCurrentRange`` + - Set range in amps + - normal + - + + * - damping + - :class:`~ophyd.signal.EpicsSignal` + - ``:PutDamping`` + - Enable/disable current damping + - normal + - + + * - integration_time + - :class:`~ophyd.signal.EpicsSignal` + - ``:GetIntCycles`` + - Set integration time + - hinted + - + + * - measurement_function + - :class:`~ophyd.signal.EpicsSignal` + - ``:PutFunction`` + - Select function - Voltage, Current, Resistance, or Charge + - hinted + - + + * - reading_rate + - :class:`~ophyd.signal.EpicsSignal` + - ``:Reading.SCAN`` + - Reading scan rate/type + - normal + - + + * - reading + - :class:`~ophyd.signal.EpicsSignalRO` + - ``:Reading`` + - Trigger and return a new measurement + - hinted + - + + * - zero_correct + - :class:`~ophyd.signal.EpicsSignal` + - ``:ZeroCorrect`` + - Run zero-correct + - normal + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + .. rubric:: Methods + + + .. automethod:: configure + .. automethod:: describe + .. automethod:: get + .. automethod:: post_elog_status + .. automethod:: read + .. automethod:: read_configuration + .. automethod:: screen + .. automethod:: status + .. automethod:: stop + .. automethod:: summary + .. automethod:: trigger + + + + + + .. rubric:: Attributes + + + .. autoattribute:: configuration_attrs + .. autoattribute:: connected + .. autoattribute:: hints + .. autoattribute:: kind + .. autoattribute:: subscriptions + + \ No newline at end of file diff --git a/master/_sources/generated/pcdsdevices.pim.IM3L0.rst.txt b/master/_sources/generated/pcdsdevices.pim.IM3L0.rst.txt index ede5d01bea9..1d549d805c6 100644 --- a/master/_sources/generated/pcdsdevices.pim.IM3L0.rst.txt +++ b/master/_sources/generated/pcdsdevices.pim.IM3L0.rst.txt @@ -54,7 +54,7 @@ - Inherited from :class:`~pcdsdevices.pim.PPM` * - k2700 - - :class:`~pcdsdevices.pim.IM3L0_K2700` + - :class:`~pcdsdevices.keithley.IM3L0_K2700` - ``:SPM:K2700`` - Digital multimeter to get power readouts for this device. - normal diff --git a/master/_sources/generated/pcdsdevices.qadc.Qadc.rst.txt b/master/_sources/generated/pcdsdevices.qadc.Qadc.rst.txt new file mode 100644 index 00000000000..a66d7222d53 --- /dev/null +++ b/master/_sources/generated/pcdsdevices.qadc.Qadc.rst.txt @@ -0,0 +1,327 @@ +pcdsdevices.qadc.Qadc +===================== + +.. currentmodule:: pcdsdevices.qadc + +.. autoclass:: Qadc + + + + .. list-table:: Ophyd Device Components + :header-rows: 1 + :widths: auto + + * - Attribute + - Class + - Suffix + - Docs + - Kind + - Notes + + * - ch0 + - :class:`~ophyd.signal.EpicsSignal` + - ``:CH0`` + - Input 0 of the ADC + - normal + - Inherited from :class:`~pcdsdevices.qadc.QadcCommon` + + * - ch1 + - :class:`~ophyd.signal.EpicsSignal` + - ``:CH1`` + - Input 1 of the ADC + - normal + - Inherited from :class:`~pcdsdevices.qadc.QadcCommon` + + * - ch2 + - :class:`~ophyd.signal.EpicsSignal` + - ``:CH2`` + - Input 2 of the ADC + - normal + - Inherited from :class:`~pcdsdevices.qadc.QadcCommon` + + * - ch3 + - :class:`~ophyd.signal.EpicsSignal` + - ``:CH3`` + - Input 3 of the ADC + - normal + - Inherited from :class:`~pcdsdevices.qadc.QadcCommon` + + * - config + - :class:`~ophyd.signal.EpicsSignal` + - ``:CONFIG`` + - Write the current config to the QADC + - config + - Inherited from :class:`~pcdsdevices.qadc.QadcCommon` + + * - start + - :class:`~ophyd.signal.EpicsSignal` + - ``:START`` + - Start/stop acquisition + - normal + - Inherited from :class:`~pcdsdevices.qadc.QadcCommon` + + * - gain0_i + - :class:`~ophyd.signal.EpicsSignal` + - ``:GAIN0_I`` + - + - config + - + + * - gain0_ni + - :class:`~ophyd.signal.EpicsSignal` + - ``:GAIN0_NI`` + - + - config + - + + * - gain1_i + - :class:`~ophyd.signal.EpicsSignal` + - ``:GAIN1_I`` + - + - config + - + + * - gain1_ni + - :class:`~ophyd.signal.EpicsSignal` + - ``:GAIN1_NI`` + - + - config + - + + * - gain2_i + - :class:`~ophyd.signal.EpicsSignal` + - ``:GAIN2_I`` + - + - config + - + + * - gain2_ni + - :class:`~ophyd.signal.EpicsSignal` + - ``:GAIN2_NI`` + - + - config + - + + * - gain3_i + - :class:`~ophyd.signal.EpicsSignal` + - ``:GAIN3_I`` + - + - config + - + + * - gain3_ni + - :class:`~ophyd.signal.EpicsSignal` + - ``:GAIN3_NI`` + - + - config + - + + * - ichan + - :class:`~ophyd.signal.EpicsSignal` + - ``:ICHAN`` + - + - config + - + + * - interleave + - :class:`~ophyd.signal.EpicsSignal` + - ``:INTERLEAVE`` + - + - config + - + + * - length + - :class:`~ophyd.signal.EpicsSignal` + - ``:LENGTH`` + - + - config + - + + * - off0_i + - :class:`~ophyd.signal.EpicsSignal` + - ``:OFF0_I`` + - + - config + - + + * - off0_ni + - :class:`~ophyd.signal.EpicsSignal` + - ``:OFF0_NI`` + - + - config + - + + * - off1_i + - :class:`~ophyd.signal.EpicsSignal` + - ``:OFF1_I`` + - + - config + - + + * - off1_ni + - :class:`~ophyd.signal.EpicsSignal` + - ``:OFF1_NI`` + - + - config + - + + * - off2_i + - :class:`~ophyd.signal.EpicsSignal` + - ``:OFF2_I`` + - + - config + - + + * - off2_ni + - :class:`~ophyd.signal.EpicsSignal` + - ``:OFF2_NI`` + - + - config + - + + * - off3_i + - :class:`~ophyd.signal.EpicsSignal` + - ``:OFF3_I`` + - + - config + - + + * - off3_ni + - :class:`~ophyd.signal.EpicsSignal` + - ``:OFF3_NI`` + - + - config + - + + * - out + - :class:`~ophyd.signal.EpicsSignal` + - ``:OUT`` + - + - normal + - + + * - rawdata + - :class:`~ophyd.signal.EpicsSignal` + - ``:RAWDATA`` + - + - normal + - + + * - train + - :class:`~ophyd.signal.EpicsSignal` + - ``:TRAIN`` + - + - config + - + + * - trig_delay + - :class:`~ophyd.signal.EpicsSignal` + - ``:TRIG_DELAY`` + - + - config + - + + * - trig_event + - :class:`~ophyd.signal.EpicsSignal` + - ``:TRIG_EVENT`` + - + - config + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + .. rubric:: Methods + + + .. automethod:: configure + .. automethod:: describe + .. automethod:: get + .. automethod:: post_elog_status + .. automethod:: read + .. automethod:: read_configuration + .. automethod:: screen + .. automethod:: status + .. automethod:: stop + .. automethod:: summary + .. automethod:: trigger + + + + + + .. rubric:: Attributes + + + .. autoattribute:: configuration_attrs + .. autoattribute:: connected + .. autoattribute:: hints + .. autoattribute:: kind + .. autoattribute:: subscriptions + + \ No newline at end of file diff --git a/master/_sources/generated/pcdsdevices.qadc.Qadc134.rst.txt b/master/_sources/generated/pcdsdevices.qadc.Qadc134.rst.txt new file mode 100644 index 00000000000..6b3a83dd9b1 --- /dev/null +++ b/master/_sources/generated/pcdsdevices.qadc.Qadc134.rst.txt @@ -0,0 +1,300 @@ +pcdsdevices.qadc.Qadc134 +======================== + +.. currentmodule:: pcdsdevices.qadc + +.. autoclass:: Qadc134 + + + + .. list-table:: Ophyd Device Components + :header-rows: 1 + :widths: auto + + * - Attribute + - Class + - Suffix + - Docs + - Kind + - Notes + + * - trig_event + - :class:`~ophyd.signal.EpicsSignal` + - ``:TRIG_EVENT_RBV`` + - LCLS-I event code to trigger on + - config + - Inherited from :class:`~pcdsdevices.qadc.QadcLcls1Timing` + + * - ch0 + - :class:`~ophyd.signal.EpicsSignal` + - ``:CH0`` + - Input 0 of the ADC + - normal + - Inherited from :class:`~pcdsdevices.qadc.Qadc134Common` + + * - ch1 + - :class:`~ophyd.signal.EpicsSignal` + - ``:CH1`` + - Input 1 of the ADC + - normal + - Inherited from :class:`~pcdsdevices.qadc.Qadc134Common` + + * - ch2 + - :class:`~ophyd.signal.EpicsSignal` + - ``:CH2`` + - Input 2 of the ADC + - normal + - Inherited from :class:`~pcdsdevices.qadc.Qadc134Common` + + * - ch3 + - :class:`~ophyd.signal.EpicsSignal` + - ``:CH3`` + - Input 3 of the ADC + - normal + - Inherited from :class:`~pcdsdevices.qadc.Qadc134Common` + + * - config + - :class:`~ophyd.signal.EpicsSignal` + - ``:CONFIG`` + - Write the current config to the QADC + - config + - Inherited from :class:`~pcdsdevices.qadc.Qadc134Common` + + * - start + - :class:`~ophyd.signal.EpicsSignal` + - ``:START`` + - Start/stop acquisition + - normal + - Inherited from :class:`~pcdsdevices.qadc.Qadc134Common` + + * - trig_delay + - :class:`~ophyd.signal.EpicsSignal` + - ``:TRIG_DELAY_RBV`` + - Trigger delay in EVR/TPR ticks + - config + - Inherited from :class:`~pcdsdevices.qadc.Qadc134Common` + + * - full_en + - :class:`~ophyd.signal.EpicsSignal` + - ``:FULL_EN_RBV`` + - Enable full stream + - config + - Inherited from :class:`~pcdsdevices.qadc.Qadc134Common` + + * - hi_thresh + - :class:`~ophyd.signal.EpicsSignal` + - ``:HI_THRESH_RBV`` + - High threshold, in Volts + - config + - Inherited from :class:`~pcdsdevices.qadc.Qadc134Common` + + * - hi_thresh_raw + - :class:`~ophyd.signal.EpicsSignal` + - ``:HI_THRESH_RAW_RBV`` + - High threshold, raw + - config + - Inherited from :class:`~pcdsdevices.qadc.Qadc134Common` + + * - ichan + - :class:`~ophyd.signal.EpicsSignal` + - ``:ICHAN_RBV`` + - Channel to interleave on + - config + - Inherited from :class:`~pcdsdevices.qadc.Qadc134Common` + + * - interleave + - :class:`~ophyd.signal.EpicsSignal` + - ``:INTERLEAVE_RBV`` + - Interleave enabled? + - config + - Inherited from :class:`~pcdsdevices.qadc.Qadc134Common` + + * - length + - :class:`~ophyd.signal.EpicsSignal` + - ``:LENGTH_RBV`` + - Waveform length + - config + - Inherited from :class:`~pcdsdevices.qadc.Qadc134Common` + + * - lo_thresh + - :class:`~ophyd.signal.EpicsSignal` + - ``:LO_THRESH_RBV`` + - Low threshold, in Volts + - config + - Inherited from :class:`~pcdsdevices.qadc.Qadc134Common` + + * - lo_thresh_raw + - :class:`~ophyd.signal.EpicsSignal` + - ``:LO_THRESH_RAW_RBV`` + - Low threshold, raw + - config + - Inherited from :class:`~pcdsdevices.qadc.Qadc134Common` + + * - prescale + - :class:`~ophyd.signal.EpicsSignal` + - ``:PRESCALE_RBV`` + - Trigger prescale divider + - config + - Inherited from :class:`~pcdsdevices.qadc.Qadc134Common` + + * - rows_after + - :class:`~ophyd.signal.EpicsSignal` + - ``:ROWS_AFTER_RBV`` + - + - config + - Inherited from :class:`~pcdsdevices.qadc.Qadc134Common` + + * - rows_before + - :class:`~ophyd.signal.EpicsSignal` + - ``:ROWS_BEFORE_RBV`` + - + - config + - Inherited from :class:`~pcdsdevices.qadc.Qadc134Common` + + * - sparse_en + - :class:`~ophyd.signal.EpicsSignal` + - ``:SPARSE_EN_RBV`` + - Enable sparsified mode + - config + - Inherited from :class:`~pcdsdevices.qadc.Qadc134Common` + + * - clear_config + - :class:`~ophyd.signal.EpicsSignal` + - ``:CLEAR_CONFIG`` + - Clear the current configuration + - config + - Inherited from :class:`~pcdsdevices.qadc.Qadc134Common` + + * - out0 + - :class:`~ophyd.signal.EpicsSignal` + - ``:OUT0`` + - Full output zero + - normal + - Inherited from :class:`~pcdsdevices.qadc.Qadc134Common` + + * - out1 + - :class:`~ophyd.signal.EpicsSignal` + - ``:OUT1`` + - Full output one + - normal + - Inherited from :class:`~pcdsdevices.qadc.Qadc134Common` + + * - rawdata0 + - :class:`~ophyd.signal.EpicsSignal` + - ``:RAWDATA0`` + - Raw output zero + - normal + - Inherited from :class:`~pcdsdevices.qadc.Qadc134Common` + + * - rawdata1 + - :class:`~ophyd.signal.EpicsSignal` + - ``:RAWDATA1`` + - Raw output one + - normal + - Inherited from :class:`~pcdsdevices.qadc.Qadc134Common` + + * - sparse0 + - :class:`~ophyd.signal.EpicsSignal` + - ``:SPARSE0`` + - Sparsified output zero + - normal + - Inherited from :class:`~pcdsdevices.qadc.Qadc134Common` + + * - sparse1 + - :class:`~ophyd.signal.EpicsSignal` + - ``:SPARSE1`` + - Sparsified output one + - normal + - Inherited from :class:`~pcdsdevices.qadc.Qadc134Common` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + .. rubric:: Methods + + + .. automethod:: configure + .. automethod:: describe + .. automethod:: get + .. automethod:: post_elog_status + .. automethod:: read + .. automethod:: read_configuration + .. automethod:: screen + .. automethod:: status + .. automethod:: stop + .. automethod:: summary + .. automethod:: trigger + + + + + + .. rubric:: Attributes + + + .. autoattribute:: configuration_attrs + .. autoattribute:: connected + .. autoattribute:: hints + .. autoattribute:: kind + .. autoattribute:: subscriptions + + \ No newline at end of file diff --git a/master/_sources/generated/pcdsdevices.qadc.Qadc134Common.rst.txt b/master/_sources/generated/pcdsdevices.qadc.Qadc134Common.rst.txt new file mode 100644 index 00000000000..2c01f385584 --- /dev/null +++ b/master/_sources/generated/pcdsdevices.qadc.Qadc134Common.rst.txt @@ -0,0 +1,291 @@ +pcdsdevices.qadc.Qadc134Common +============================== + +.. currentmodule:: pcdsdevices.qadc + +.. autoclass:: Qadc134Common + + + + .. list-table:: Ophyd Device Components + :header-rows: 1 + :widths: auto + + * - Attribute + - Class + - Suffix + - Docs + - Kind + - Notes + + * - ch0 + - :class:`~ophyd.signal.EpicsSignal` + - ``:CH0`` + - Input 0 of the ADC + - normal + - Inherited from :class:`~pcdsdevices.qadc.QadcCommon` + + * - ch1 + - :class:`~ophyd.signal.EpicsSignal` + - ``:CH1`` + - Input 1 of the ADC + - normal + - Inherited from :class:`~pcdsdevices.qadc.QadcCommon` + + * - ch2 + - :class:`~ophyd.signal.EpicsSignal` + - ``:CH2`` + - Input 2 of the ADC + - normal + - Inherited from :class:`~pcdsdevices.qadc.QadcCommon` + + * - ch3 + - :class:`~ophyd.signal.EpicsSignal` + - ``:CH3`` + - Input 3 of the ADC + - normal + - Inherited from :class:`~pcdsdevices.qadc.QadcCommon` + + * - config + - :class:`~ophyd.signal.EpicsSignal` + - ``:CONFIG`` + - Write the current config to the QADC + - config + - Inherited from :class:`~pcdsdevices.qadc.QadcCommon` + + * - start + - :class:`~ophyd.signal.EpicsSignal` + - ``:START`` + - Start/stop acquisition + - normal + - Inherited from :class:`~pcdsdevices.qadc.QadcCommon` + + * - trig_delay + - :class:`~ophyd.signal.EpicsSignal` + - ``:TRIG_DELAY_RBV`` + - Trigger delay in EVR/TPR ticks + - config + - + + * - full_en + - :class:`~ophyd.signal.EpicsSignal` + - ``:FULL_EN_RBV`` + - Enable full stream + - config + - + + * - hi_thresh + - :class:`~ophyd.signal.EpicsSignal` + - ``:HI_THRESH_RBV`` + - High threshold, in Volts + - config + - + + * - hi_thresh_raw + - :class:`~ophyd.signal.EpicsSignal` + - ``:HI_THRESH_RAW_RBV`` + - High threshold, raw + - config + - + + * - ichan + - :class:`~ophyd.signal.EpicsSignal` + - ``:ICHAN_RBV`` + - Channel to interleave on + - config + - + + * - interleave + - :class:`~ophyd.signal.EpicsSignal` + - ``:INTERLEAVE_RBV`` + - Interleave enabled? + - config + - + + * - length + - :class:`~ophyd.signal.EpicsSignal` + - ``:LENGTH_RBV`` + - Waveform length + - config + - + + * - lo_thresh + - :class:`~ophyd.signal.EpicsSignal` + - ``:LO_THRESH_RBV`` + - Low threshold, in Volts + - config + - + + * - lo_thresh_raw + - :class:`~ophyd.signal.EpicsSignal` + - ``:LO_THRESH_RAW_RBV`` + - Low threshold, raw + - config + - + + * - prescale + - :class:`~ophyd.signal.EpicsSignal` + - ``:PRESCALE_RBV`` + - Trigger prescale divider + - config + - + + * - rows_after + - :class:`~ophyd.signal.EpicsSignal` + - ``:ROWS_AFTER_RBV`` + - + - config + - + + * - rows_before + - :class:`~ophyd.signal.EpicsSignal` + - ``:ROWS_BEFORE_RBV`` + - + - config + - + + * - sparse_en + - :class:`~ophyd.signal.EpicsSignal` + - ``:SPARSE_EN_RBV`` + - Enable sparsified mode + - config + - + + * - clear_config + - :class:`~ophyd.signal.EpicsSignal` + - ``:CLEAR_CONFIG`` + - Clear the current configuration + - config + - + + * - out0 + - :class:`~ophyd.signal.EpicsSignal` + - ``:OUT0`` + - Full output zero + - normal + - + + * - out1 + - :class:`~ophyd.signal.EpicsSignal` + - ``:OUT1`` + - Full output one + - normal + - + + * - rawdata0 + - :class:`~ophyd.signal.EpicsSignal` + - ``:RAWDATA0`` + - Raw output zero + - normal + - + + * - rawdata1 + - :class:`~ophyd.signal.EpicsSignal` + - ``:RAWDATA1`` + - Raw output one + - normal + - + + * - sparse0 + - :class:`~ophyd.signal.EpicsSignal` + - ``:SPARSE0`` + - Sparsified output zero + - normal + - + + * - sparse1 + - :class:`~ophyd.signal.EpicsSignal` + - ``:SPARSE1`` + - Sparsified output one + - normal + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + .. rubric:: Methods + + + .. automethod:: configure + .. automethod:: describe + .. automethod:: get + .. automethod:: post_elog_status + .. automethod:: read + .. automethod:: read_configuration + .. automethod:: screen + .. automethod:: status + .. automethod:: stop + .. automethod:: summary + .. automethod:: trigger + + + + + + .. rubric:: Attributes + + + .. autoattribute:: configuration_attrs + .. autoattribute:: connected + .. autoattribute:: hints + .. autoattribute:: kind + .. autoattribute:: subscriptions + + \ No newline at end of file diff --git a/master/_sources/generated/pcdsdevices.qadc.Qadc134Lcls2.rst.txt b/master/_sources/generated/pcdsdevices.qadc.Qadc134Lcls2.rst.txt new file mode 100644 index 00000000000..a1cf1a75096 --- /dev/null +++ b/master/_sources/generated/pcdsdevices.qadc.Qadc134Lcls2.rst.txt @@ -0,0 +1,354 @@ +pcdsdevices.qadc.Qadc134Lcls2 +============================= + +.. currentmodule:: pcdsdevices.qadc + +.. autoclass:: Qadc134Lcls2 + + + + .. list-table:: Ophyd Device Components + :header-rows: 1 + :widths: auto + + * - Attribute + - Class + - Suffix + - Docs + - Kind + - Notes + + * - trig_rate_mode + - :class:`~ophyd.signal.EpicsSignal` + - ``:TRIG_RATEMODE`` + - LCLS-II trigger mode + - config + - Inherited from :class:`~pcdsdevices.qadc.QadcLcls2Timing` + + * - trig_fixed_rate + - :class:`~ophyd.signal.EpicsSignal` + - ``:TRIG_FIXEDRATE`` + - Rate to use for fixed trigger mode + - config + - Inherited from :class:`~pcdsdevices.qadc.QadcLcls2Timing` + + * - trig_ac_rate + - :class:`~ophyd.signal.EpicsSignal` + - ``:TRIG_ACRATE`` + - Rate to use for AC trigger mode + - config + - Inherited from :class:`~pcdsdevices.qadc.QadcLcls2Timing` + + * - trig_ts_mask + - :class:`~ophyd.signal.EpicsSignal` + - ``:TRIG_TSMASK`` + - Trigger mask + - config + - Inherited from :class:`~pcdsdevices.qadc.QadcLcls2Timing` + + * - trig_seq_num + - :class:`~ophyd.signal.EpicsSignal` + - ``:TRIG_SEQNUM`` + - Trigger sequence number + - config + - Inherited from :class:`~pcdsdevices.qadc.QadcLcls2Timing` + + * - trig_seq_bit + - :class:`~ophyd.signal.EpicsSignal` + - ``:TRIG_SEQBIT`` + - Trigger sequence bit + - config + - Inherited from :class:`~pcdsdevices.qadc.QadcLcls2Timing` + + * - trig_partition + - :class:`~ophyd.signal.EpicsSignal` + - ``:TRIG_PARTITION`` + - Trigger partition number + - config + - Inherited from :class:`~pcdsdevices.qadc.QadcLcls2Timing` + + * - ch0 + - :class:`~ophyd.signal.EpicsSignal` + - ``:CH0`` + - Input 0 of the ADC + - normal + - Inherited from :class:`~pcdsdevices.qadc.Qadc134Common` + + * - ch1 + - :class:`~ophyd.signal.EpicsSignal` + - ``:CH1`` + - Input 1 of the ADC + - normal + - Inherited from :class:`~pcdsdevices.qadc.Qadc134Common` + + * - ch2 + - :class:`~ophyd.signal.EpicsSignal` + - ``:CH2`` + - Input 2 of the ADC + - normal + - Inherited from :class:`~pcdsdevices.qadc.Qadc134Common` + + * - ch3 + - :class:`~ophyd.signal.EpicsSignal` + - ``:CH3`` + - Input 3 of the ADC + - normal + - Inherited from :class:`~pcdsdevices.qadc.Qadc134Common` + + * - config + - :class:`~ophyd.signal.EpicsSignal` + - ``:CONFIG`` + - Write the current config to the QADC + - config + - Inherited from :class:`~pcdsdevices.qadc.Qadc134Common` + + * - start + - :class:`~ophyd.signal.EpicsSignal` + - ``:START`` + - Start/stop acquisition + - normal + - Inherited from :class:`~pcdsdevices.qadc.Qadc134Common` + + * - trig_delay + - :class:`~ophyd.signal.EpicsSignal` + - ``:TRIG_DELAY_RBV`` + - Trigger delay in EVR/TPR ticks + - config + - Inherited from :class:`~pcdsdevices.qadc.Qadc134Common` + + * - full_en + - :class:`~ophyd.signal.EpicsSignal` + - ``:FULL_EN_RBV`` + - Enable full stream + - config + - Inherited from :class:`~pcdsdevices.qadc.Qadc134Common` + + * - hi_thresh + - :class:`~ophyd.signal.EpicsSignal` + - ``:HI_THRESH_RBV`` + - High threshold, in Volts + - config + - Inherited from :class:`~pcdsdevices.qadc.Qadc134Common` + + * - hi_thresh_raw + - :class:`~ophyd.signal.EpicsSignal` + - ``:HI_THRESH_RAW_RBV`` + - High threshold, raw + - config + - Inherited from :class:`~pcdsdevices.qadc.Qadc134Common` + + * - ichan + - :class:`~ophyd.signal.EpicsSignal` + - ``:ICHAN_RBV`` + - Channel to interleave on + - config + - Inherited from :class:`~pcdsdevices.qadc.Qadc134Common` + + * - interleave + - :class:`~ophyd.signal.EpicsSignal` + - ``:INTERLEAVE_RBV`` + - Interleave enabled? + - config + - Inherited from :class:`~pcdsdevices.qadc.Qadc134Common` + + * - length + - :class:`~ophyd.signal.EpicsSignal` + - ``:LENGTH_RBV`` + - Waveform length + - config + - Inherited from :class:`~pcdsdevices.qadc.Qadc134Common` + + * - lo_thresh + - :class:`~ophyd.signal.EpicsSignal` + - ``:LO_THRESH_RBV`` + - Low threshold, in Volts + - config + - Inherited from :class:`~pcdsdevices.qadc.Qadc134Common` + + * - lo_thresh_raw + - :class:`~ophyd.signal.EpicsSignal` + - ``:LO_THRESH_RAW_RBV`` + - Low threshold, raw + - config + - Inherited from :class:`~pcdsdevices.qadc.Qadc134Common` + + * - prescale + - :class:`~ophyd.signal.EpicsSignal` + - ``:PRESCALE_RBV`` + - Trigger prescale divider + - config + - Inherited from :class:`~pcdsdevices.qadc.Qadc134Common` + + * - rows_after + - :class:`~ophyd.signal.EpicsSignal` + - ``:ROWS_AFTER_RBV`` + - + - config + - Inherited from :class:`~pcdsdevices.qadc.Qadc134Common` + + * - rows_before + - :class:`~ophyd.signal.EpicsSignal` + - ``:ROWS_BEFORE_RBV`` + - + - config + - Inherited from :class:`~pcdsdevices.qadc.Qadc134Common` + + * - sparse_en + - :class:`~ophyd.signal.EpicsSignal` + - ``:SPARSE_EN_RBV`` + - Enable sparsified mode + - config + - Inherited from :class:`~pcdsdevices.qadc.Qadc134Common` + + * - clear_config + - :class:`~ophyd.signal.EpicsSignal` + - ``:CLEAR_CONFIG`` + - Clear the current configuration + - config + - Inherited from :class:`~pcdsdevices.qadc.Qadc134Common` + + * - out0 + - :class:`~ophyd.signal.EpicsSignal` + - ``:OUT0`` + - Full output zero + - normal + - Inherited from :class:`~pcdsdevices.qadc.Qadc134Common` + + * - out1 + - :class:`~ophyd.signal.EpicsSignal` + - ``:OUT1`` + - Full output one + - normal + - Inherited from :class:`~pcdsdevices.qadc.Qadc134Common` + + * - rawdata0 + - :class:`~ophyd.signal.EpicsSignal` + - ``:RAWDATA0`` + - Raw output zero + - normal + - Inherited from :class:`~pcdsdevices.qadc.Qadc134Common` + + * - rawdata1 + - :class:`~ophyd.signal.EpicsSignal` + - ``:RAWDATA1`` + - Raw output one + - normal + - Inherited from :class:`~pcdsdevices.qadc.Qadc134Common` + + * - sparse0 + - :class:`~ophyd.signal.EpicsSignal` + - ``:SPARSE0`` + - Sparsified output zero + - normal + - Inherited from :class:`~pcdsdevices.qadc.Qadc134Common` + + * - sparse1 + - :class:`~ophyd.signal.EpicsSignal` + - ``:SPARSE1`` + - Sparsified output one + - normal + - Inherited from :class:`~pcdsdevices.qadc.Qadc134Common` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + .. rubric:: Methods + + + .. automethod:: configure + .. automethod:: describe + .. automethod:: get + .. automethod:: post_elog_status + .. automethod:: read + .. automethod:: read_configuration + .. automethod:: screen + .. automethod:: status + .. automethod:: stop + .. automethod:: summary + .. automethod:: trigger + + + + + + .. rubric:: Attributes + + + .. autoattribute:: configuration_attrs + .. autoattribute:: connected + .. autoattribute:: hints + .. autoattribute:: kind + .. autoattribute:: subscriptions + + \ No newline at end of file diff --git a/master/_sources/generated/pcdsdevices.qadc.QadcCommon.rst.txt b/master/_sources/generated/pcdsdevices.qadc.QadcCommon.rst.txt new file mode 100644 index 00000000000..6976998d1f2 --- /dev/null +++ b/master/_sources/generated/pcdsdevices.qadc.QadcCommon.rst.txt @@ -0,0 +1,111 @@ +pcdsdevices.qadc.QadcCommon +=========================== + +.. currentmodule:: pcdsdevices.qadc + +.. autoclass:: QadcCommon + + + + .. list-table:: Ophyd Device Components + :header-rows: 1 + :widths: auto + + * - Attribute + - Class + - Suffix + - Docs + - Kind + - Notes + + * - ch0 + - :class:`~ophyd.signal.EpicsSignal` + - ``:CH0`` + - Input 0 of the ADC + - normal + - + + * - ch1 + - :class:`~ophyd.signal.EpicsSignal` + - ``:CH1`` + - Input 1 of the ADC + - normal + - + + * - ch2 + - :class:`~ophyd.signal.EpicsSignal` + - ``:CH2`` + - Input 2 of the ADC + - normal + - + + * - ch3 + - :class:`~ophyd.signal.EpicsSignal` + - ``:CH3`` + - Input 3 of the ADC + - normal + - + + * - config + - :class:`~ophyd.signal.EpicsSignal` + - ``:CONFIG`` + - Write the current config to the QADC + - config + - + + * - start + - :class:`~ophyd.signal.EpicsSignal` + - ``:START`` + - Start/stop acquisition + - normal + - + + + + + + + + + + + + + + + + + + + + + + .. rubric:: Methods + + + .. automethod:: configure + .. automethod:: describe + .. automethod:: get + .. automethod:: post_elog_status + .. automethod:: read + .. automethod:: read_configuration + .. automethod:: screen + .. automethod:: status + .. automethod:: stop + .. automethod:: summary + .. automethod:: trigger + + + + + + .. rubric:: Attributes + + + .. autoattribute:: configuration_attrs + .. autoattribute:: connected + .. autoattribute:: hints + .. autoattribute:: kind + .. autoattribute:: subscriptions + + \ No newline at end of file diff --git a/master/_sources/generated/pcdsdevices.qadc.QadcLcls1Timing.rst.txt b/master/_sources/generated/pcdsdevices.qadc.QadcLcls1Timing.rst.txt new file mode 100644 index 00000000000..76188b08005 --- /dev/null +++ b/master/_sources/generated/pcdsdevices.qadc.QadcLcls1Timing.rst.txt @@ -0,0 +1,66 @@ +pcdsdevices.qadc.QadcLcls1Timing +================================ + +.. currentmodule:: pcdsdevices.qadc + +.. autoclass:: QadcLcls1Timing + + + + .. list-table:: Ophyd Device Components + :header-rows: 1 + :widths: auto + + * - Attribute + - Class + - Suffix + - Docs + - Kind + - Notes + + * - trig_event + - :class:`~ophyd.signal.EpicsSignal` + - ``:TRIG_EVENT_RBV`` + - LCLS-I event code to trigger on + - config + - + + + + + + + + + + + + .. rubric:: Methods + + + .. automethod:: configure + .. automethod:: describe + .. automethod:: get + .. automethod:: post_elog_status + .. automethod:: read + .. automethod:: read_configuration + .. automethod:: screen + .. automethod:: status + .. automethod:: stop + .. automethod:: summary + .. automethod:: trigger + + + + + + .. rubric:: Attributes + + + .. autoattribute:: configuration_attrs + .. autoattribute:: connected + .. autoattribute:: hints + .. autoattribute:: kind + .. autoattribute:: subscriptions + + \ No newline at end of file diff --git a/master/_sources/generated/pcdsdevices.qadc.QadcLcls2Timing.rst.txt b/master/_sources/generated/pcdsdevices.qadc.QadcLcls2Timing.rst.txt new file mode 100644 index 00000000000..0df1bbbcf8b --- /dev/null +++ b/master/_sources/generated/pcdsdevices.qadc.QadcLcls2Timing.rst.txt @@ -0,0 +1,120 @@ +pcdsdevices.qadc.QadcLcls2Timing +================================ + +.. currentmodule:: pcdsdevices.qadc + +.. autoclass:: QadcLcls2Timing + + + + .. list-table:: Ophyd Device Components + :header-rows: 1 + :widths: auto + + * - Attribute + - Class + - Suffix + - Docs + - Kind + - Notes + + * - trig_rate_mode + - :class:`~ophyd.signal.EpicsSignal` + - ``:TRIG_RATEMODE`` + - LCLS-II trigger mode + - config + - + + * - trig_fixed_rate + - :class:`~ophyd.signal.EpicsSignal` + - ``:TRIG_FIXEDRATE`` + - Rate to use for fixed trigger mode + - config + - + + * - trig_ac_rate + - :class:`~ophyd.signal.EpicsSignal` + - ``:TRIG_ACRATE`` + - Rate to use for AC trigger mode + - config + - + + * - trig_ts_mask + - :class:`~ophyd.signal.EpicsSignal` + - ``:TRIG_TSMASK`` + - Trigger mask + - config + - + + * - trig_seq_num + - :class:`~ophyd.signal.EpicsSignal` + - ``:TRIG_SEQNUM`` + - Trigger sequence number + - config + - + + * - trig_seq_bit + - :class:`~ophyd.signal.EpicsSignal` + - ``:TRIG_SEQBIT`` + - Trigger sequence bit + - config + - + + * - trig_partition + - :class:`~ophyd.signal.EpicsSignal` + - ``:TRIG_PARTITION`` + - Trigger partition number + - config + - + + + + + + + + + + + + + + + + + + + + + + + + .. rubric:: Methods + + + .. automethod:: configure + .. automethod:: describe + .. automethod:: get + .. automethod:: post_elog_status + .. automethod:: read + .. automethod:: read_configuration + .. automethod:: screen + .. automethod:: status + .. automethod:: stop + .. automethod:: summary + .. automethod:: trigger + + + + + + .. rubric:: Attributes + + + .. autoattribute:: configuration_attrs + .. autoattribute:: connected + .. autoattribute:: hints + .. autoattribute:: kind + .. autoattribute:: subscriptions + + \ No newline at end of file diff --git a/master/_sources/generated/pcdsdevices.tpr.TprMotor.rst.txt b/master/_sources/generated/pcdsdevices.tpr.TprMotor.rst.txt new file mode 100644 index 00000000000..0aabddb7c61 --- /dev/null +++ b/master/_sources/generated/pcdsdevices.tpr.TprMotor.rst.txt @@ -0,0 +1,133 @@ +pcdsdevices.tpr.TprMotor +======================== + +.. currentmodule:: pcdsdevices.tpr + +.. autoclass:: TprMotor + + + + .. list-table:: Ophyd Device Components + :header-rows: 1 + :widths: auto + + * - Attribute + - Class + - Suffix + - Docs + - Kind + - Notes + + * - done + - :class:`~pcdsdevices.signal.InternalSignal` + - + - + - normal + - Inherited from :class:`~pcdsdevices.pv_positioner.PVPositionerIsClose` + + * - setpoint (FCpt) + - :class:`~ophyd.signal.EpicsSignal` + - ``{self.prefix}{self.sys}TDES`` + - Trigger delay setpoint in nsec + - normal + - + + * - delay_ticks (FCpt) + - :class:`~ophyd.signal.EpicsSignal` + - ``{self.prefix}TDESTICKS`` + - Trigger delay in clock ticks + - omitted + - + + * - delay_taps (FCpt) + - :class:`~ophyd.signal.EpicsSignal` + - ``{self.prefix}TDESTAPS`` + - Trigger delay in delay taps + - omitted + - + + * - readback + - :class:`~pcdsdevices.signal.MultiDerivedSignalRO` + - + - + - normal + - + + + + + + + + + + + + + + + + + + + + .. rubric:: Methods + + + .. automethod:: camonitor + .. automethod:: configure + .. automethod:: describe + .. automethod:: done_comparator + .. automethod:: end_monitor_thread + .. automethod:: get + .. automethod:: move + .. automethod:: mv + .. automethod:: mv_ginput + .. automethod:: mvr + .. automethod:: post_elog_status + .. automethod:: read + .. automethod:: read_configuration + .. automethod:: screen + .. automethod:: set + .. automethod:: set_position + .. automethod:: status + .. automethod:: stop + .. automethod:: summary + .. automethod:: trigger + .. automethod:: tweak + .. automethod:: umv + .. automethod:: umvr + .. automethod:: wait + .. automethod:: wm + .. automethod:: wm_update + + + + + + .. rubric:: Attributes + + + .. autoattribute:: actuate + .. autoattribute:: actuate_value + .. autoattribute:: atol + .. autoattribute:: configuration_attrs + .. autoattribute:: connected + .. autoattribute:: done_value + .. autoattribute:: egu + .. autoattribute:: high_limit + .. autoattribute:: hints + .. autoattribute:: kind + .. autoattribute:: limits + .. autoattribute:: low_limit + .. autoattribute:: moving + .. autoattribute:: position + .. autoattribute:: put_complete + .. autoattribute:: rtol + .. autoattribute:: settle_time + .. autoattribute:: stop_signal + .. autoattribute:: stop_value + .. autoattribute:: subscriptions + .. autoattribute:: timeout + + \ No newline at end of file diff --git a/master/_sources/generated/pcdsdevices.tpr.TprTrigger.rst.txt b/master/_sources/generated/pcdsdevices.tpr.TprTrigger.rst.txt new file mode 100644 index 00000000000..20a25a5fc34 --- /dev/null +++ b/master/_sources/generated/pcdsdevices.tpr.TprTrigger.rst.txt @@ -0,0 +1,261 @@ +pcdsdevices.tpr.TprTrigger +========================== + +.. currentmodule:: pcdsdevices.tpr + +.. autoclass:: TprTrigger + + + + .. list-table:: Ophyd Device Components + :header-rows: 1 + :widths: auto + + * - Attribute + - Class + - Suffix + - Docs + - Kind + - Notes + + * - ratemode (FCpt) + - :class:`~ophyd.signal.EpicsSignal` + - ``{self.prefix}{self.ch}RATEMODE`` + - Channel rate mode selector + - config + - + + * - group (FCpt) + - :class:`~ophyd.signal.EpicsSignal` + - ``{self.prefix}{self.ch}GROUP`` + - Channel group Bit + - omitted + - + + * - seqcode (FCpt) + - :class:`~ophyd.signal.EpicsSignal` + - ``{self.prefix}{self.ch}SEQCODE`` + - Channel sequence code + - omitted + - + + * - fixedrate (FCpt) + - :class:`~ophyd.signal.EpicsSignal` + - ``{self.prefix}{self.ch}FIXEDRATE`` + - Channel Fxed rate selector + - omitted + - + + * - count (FCpt) + - :class:`~ophyd.signal.EpicsSignal` + - ``{self.prefix}{self.ch}CNT`` + - Channel counter + - omitted + - + + * - destmask (FCpt) + - :class:`~ophyd.signal.EpicsSignal` + - ``{self.prefix}{self.ch}DESTMASK`` + - Channel destination mask + - omitted + - + + * - destmode (FCpt) + - :class:`~ophyd.signal.EpicsSignal` + - ``{self.prefix}{self.ch}DESTMODE`` + - Channel destination mode selector + - omitted + - + + * - src (FCpt) + - :class:`~ophyd.signal.EpicsSignal` + - ``{self.prefix}{self.trg}SOURCE`` + - Trigger source + - omitted + - + + * - eventcode (FCpt) + - :class:`~ophyd.signal.EpicsSignal` + - ``{self.prefix}{self.ch}EVCODE`` + - Channel LCLS1 event code + - config + - + + * - eventrate (FCpt) + - :class:`~ophyd.signal.EpicsSignalRO` + - ``{self.prefix}{self.ch}RATE`` + - Channel event rates + - normal + - + + * - label (FCpt) + - :class:`~ophyd.signal.EpicsSignal` + - ``{self.prefix}{self.ch}{self.sys}TCTL.DESC`` + - Enable/disable + - omitted + - + + * - delay_ticks (FCpt) + - :class:`~ophyd.signal.EpicsSignal` + - ``{self.prefix}{self.trg}TDESTICKS`` + - Trigger delay in clock ticks + - omitted + - + + * - delay_taps (FCpt) + - :class:`~ophyd.signal.EpicsSignal` + - ``{self.prefix}{self.trg}TDESTAPS`` + - Trigger delay in delay taps + - omitted + - + + * - delay_setpoint (FCpt) + - :class:`~ophyd.signal.EpicsSignal` + - ``{self.prefix}{self.trg}{self.sys}TDES`` + - Trigger delay setpoint in nsec + - omitted + - + + * - ns_delay + - :class:`~pcdsdevices.signal.MultiDerivedSignal` + - + - Get/set trigger delay in ns + - normal + - + + * - ns_delay_scan (FCpt) + - :class:`~pcdsdevices.tpr.TprMotor` + - ``{self.prefix}{self.trg}`` + - Motor-like tpr interface + - omitted + - + + * - polarity (FCpt) + - :class:`~ophyd.signal.EpicsSignal` + - ``{self.prefix}{self.trg}TPOL`` + - Trigger description + - config + - + + * - width_setpoint (FCpt) + - :class:`~ophyd.signal.EpicsSignal` + - ``{self.prefix}{self.trg}{self.sys}TWID`` + - Trigger width in ns + - omitted + - + + * - width_ticks (FCpt) + - :class:`~ophyd.signal.EpicsSignalRO` + - ``{self.prefix}{self.trg}TWIDTICKS`` + - Trigger width in clock ticks + - omitted + - + + * - width + - :class:`~pcdsdevices.signal.MultiDerivedSignal` + - + - Get/set trigger width in nsec + - normal + - + + * - enable_ch_cmd (FCpt) + - :class:`~ophyd.signal.EpicsSignal` + - ``{self.prefix}{self.ch}{self.sys}TCTL`` + - Channel enable/disable + - omitted + - + + * - enable_trg_cmd (FCpt) + - :class:`~ophyd.signal.EpicsSignal` + - ``{self.prefix}{self.trg}{self.sys}TCTL`` + - Trigger enable/disable + - omitted + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + .. rubric:: Methods + + + .. automethod:: configure + .. automethod:: describe + .. automethod:: disable + .. automethod:: disable_ch + .. automethod:: disable_trg + .. automethod:: enable + .. automethod:: enable_ch + .. automethod:: enable_trg + .. automethod:: get + .. automethod:: post_elog_status + .. automethod:: read + .. automethod:: read_configuration + .. automethod:: screen + .. automethod:: status + .. automethod:: stop + .. automethod:: summary + .. automethod:: trigger + + + + + + .. rubric:: Attributes + + + .. autoattribute:: configuration_attrs + .. autoattribute:: connected + .. autoattribute:: hints + .. autoattribute:: kind + .. autoattribute:: subscriptions + + \ No newline at end of file diff --git a/master/_sources/upcoming_release_notes/1155-Add_LCLS-II_timing_support_for_Qadc134.rst.txt b/master/_sources/upcoming_release_notes/1155-Add_LCLS-II_timing_support_for_Qadc134.rst.txt new file mode 100644 index 00000000000..d461edb19a0 --- /dev/null +++ b/master/_sources/upcoming_release_notes/1155-Add_LCLS-II_timing_support_for_Qadc134.rst.txt @@ -0,0 +1,31 @@ +1155 Add LCLS-II timing support for Qadc134 +################# + +API Breaks +---------- +- N/A + +Features +-------- +- N/A + +Device Updates +-------------- +- Restructured Qadc134 with new Qadc134Common and QadcLcls1Timing parent + classes. + +New Devices +----------- +- Qadc134Lcls2: A class for LCLS-II timing versions of the FMC134 + +Bugfixes +-------- +- N/A + +Maintenance +----------- +- N/A + +Contributors +------------ +- slactjohnson diff --git a/master/_sources/upcoming_release_notes/1178-new-tpr-class.rst.txt b/master/_sources/upcoming_release_notes/1178-new-tpr-class.rst.txt new file mode 100644 index 00000000000..88713fe3dcf --- /dev/null +++ b/master/_sources/upcoming_release_notes/1178-new-tpr-class.rst.txt @@ -0,0 +1,31 @@ +1178 new-tpr-class +################# + +API Breaks +---------- +- N/A + +Features +-------- +- N/A + +Device Updates +-------------- +- N/A + +New Devices +----------- +- New TprTrigger and TprMotor device classes in tpr.py +- Analogous to Trigger and EvrMotor from evr.py + +Bugfixes +-------- +- N/A + +Maintenance +----------- +- N/A + +Contributors +------------ +- KaushikMalapati diff --git a/master/_sources/upcoming_release_notes/1179-tmo_gmd_classes.rst.txt b/master/_sources/upcoming_release_notes/1179-tmo_gmd_classes.rst.txt new file mode 100644 index 00000000000..f6aee871320 --- /dev/null +++ b/master/_sources/upcoming_release_notes/1179-tmo_gmd_classes.rst.txt @@ -0,0 +1,31 @@ +1179 tmo_gmd_classes +################# + +API Breaks +---------- +- Moving K2700 and IM3L0_K2700 to keithley.py + +Features +-------- +- N/A + +Device Updates +-------------- +- N/A + +New Devices +----------- +- K6514, GMD (previously unimplemented), GMDPreAmp, SXRGasAtt +- Taken from /cds/group/pcds/pyps/apps/hutch-python/tmo/tmo/tmo_beamline_control.py with some modifications + +Bugfixes +-------- +- N/A + +Maintenance +----------- +- N/A + +Contributors +------------ +- KaushikMalapati diff --git a/master/_static/documentation_options.js b/master/_static/documentation_options.js index a229518207a..976b04ae7df 100644 --- a/master/_static/documentation_options.js +++ b/master/_static/documentation_options.js @@ -1,5 +1,5 @@ const DOCUMENTATION_OPTIONS = { - VERSION: '8.0.1.dev26+g15141e44', + VERSION: '8.1.1.dev23+g64947168', LANGUAGE: 'en', COLLAPSE_INDEX: false, BUILDER: 'html', diff --git a/master/api.html b/master/api.html index 76a52768f6c..b1abe8bc813 100644 --- a/master/api.html +++ b/master/api.html @@ -4,7 +4,7 @@ -