diff --git a/master/_sources/api.rst.txt b/master/_sources/api.rst.txt index 7966da07eec..b6f47ee467c 100644 --- a/master/_sources/api.rst.txt +++ b/master/_sources/api.rst.txt @@ -370,6 +370,7 @@ pcdsdevices.gon pcdsdevices.gon.BaseGon pcdsdevices.gon.GonWithDetArm pcdsdevices.gon.Goniometer + pcdsdevices.gon.HxrDiffractometer pcdsdevices.gon.Kappa pcdsdevices.gon.KappaXYZStage pcdsdevices.gon.SamPhi @@ -461,6 +462,16 @@ pcdsdevices.keithley pcdsdevices.keithley.K2700 pcdsdevices.keithley.K6514 +pcdsdevices.lakeshore +--------------------- + +.. autosummary:: + :toctree: generated + + pcdsdevices.lakeshore.Heater + pcdsdevices.lakeshore.Lakeshore336 + pcdsdevices.lakeshore.TemperatureSensor + pcdsdevices.lamp_motion ----------------------- @@ -694,6 +705,7 @@ pcdsdevices.mirror pcdsdevices.mirror.KBOMirrorHEStates pcdsdevices.mirror.KBOMirrorStates pcdsdevices.mirror.MirrorInsertState + pcdsdevices.mirror.MirrorStripe2D2P pcdsdevices.mirror.MirrorStripe2D4P pcdsdevices.mirror.OMMotor pcdsdevices.mirror.OffsetMirror @@ -774,6 +786,7 @@ pcdsdevices.pc :toctree: generated pcdsdevices.pc.PhotonCollimator + pcdsdevices.pc.PhotonCollimatorFDQ pcdsdevices.piezo ----------------- @@ -823,6 +836,7 @@ pcdsdevices.pneumatic :toctree: generated pcdsdevices.pneumatic.BeckhoffPneumatic + pcdsdevices.pneumatic.BeckhoffPneumaticFDQ pcdsdevices.positioner ---------------------- @@ -849,6 +863,7 @@ pcdsdevices.pseudopos pcdsdevices.pseudopos.SyncAxis pcdsdevices.pseudopos.delay_class_factory pcdsdevices.pseudopos.delay_instance_factory + pcdsdevices.pseudopos.is_strictly_increasing pcdsdevices.pulsepicker ----------------------- @@ -1070,6 +1085,7 @@ pcdsdevices.spectrometer pcdsdevices.spectrometer.HXRSpectrometer pcdsdevices.spectrometer.Kmono pcdsdevices.spectrometer.Mono + pcdsdevices.spectrometer.MonoGratingStates pcdsdevices.spectrometer.TMOSpectrometer pcdsdevices.spectrometer.TMOSpectrometerSOLIDATTStates pcdsdevices.spectrometer.VonHamos4Crystal @@ -1220,6 +1236,7 @@ pcdsdevices.valve pcdsdevices.valve.GateValve pcdsdevices.valve.VCN + pcdsdevices.valve.VCN_OpenLoop pcdsdevices.valve.VCN_VAT590 pcdsdevices.valve.VCN_VAT590_Status pcdsdevices.valve.VFS diff --git a/master/_sources/generated/pcdsdevices.gon.HxrDiffractometer.rst.txt b/master/_sources/generated/pcdsdevices.gon.HxrDiffractometer.rst.txt new file mode 100644 index 00000000000..1f8861c7897 --- /dev/null +++ b/master/_sources/generated/pcdsdevices.gon.HxrDiffractometer.rst.txt @@ -0,0 +1,102 @@ +pcdsdevices.gon.HxrDiffractometer +================================= + +.. currentmodule:: pcdsdevices.gon + +.. autoclass:: HxrDiffractometer + + + + .. list-table:: Ophyd Device Components + :header-rows: 1 + :widths: auto + + * - Attribute + - Class + - Suffix + - Docs + - Kind + - Notes + + * - base_h + - :class:`~pcdsdevices.epics_motor.BeckhoffAxis` + - ``BASE_H`` + - + - normal + - + + * - base_v + - :class:`~pcdsdevices.epics_motor.BeckhoffAxis` + - ``BASE_V`` + - + - normal + - + + * - th + - :class:`~pcdsdevices.epics_motor.BeckhoffAxis` + - ``TH`` + - + - normal + - + + * - tth + - :class:`~pcdsdevices.epics_motor.BeckhoffAxis` + - ``TTH`` + - + - normal + - + + * - chi + - :class:`~pcdsdevices.epics_motor.BeckhoffAxis` + - ``CHI`` + - + - 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.lakeshore.Heater.rst.txt b/master/_sources/generated/pcdsdevices.lakeshore.Heater.rst.txt new file mode 100644 index 00000000000..187935d58a0 --- /dev/null +++ b/master/_sources/generated/pcdsdevices.lakeshore.Heater.rst.txt @@ -0,0 +1,75 @@ +pcdsdevices.lakeshore.Heater +============================ + +.. currentmodule:: pcdsdevices.lakeshore + +.. autoclass:: Heater + + + + .. list-table:: Ophyd Device Components + :header-rows: 1 + :widths: auto + + * - Attribute + - Class + - Suffix + - Docs + - Kind + - Notes + + * - htr_state (FCpt) + - :class:`~ophyd.signal.EpicsSignal` + - ``{prefix}:GET_RANGE_{channel}`` + - heater range + - normal + - + + * - htr_state_rbv (FCpt) + - :class:`~ophyd.signal.EpicsSignalRO` + - ``{prefix}:GET_HTRSTAT_{channel}`` + - + - 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.lakeshore.Lakeshore336.rst.txt b/master/_sources/generated/pcdsdevices.lakeshore.Lakeshore336.rst.txt new file mode 100644 index 00000000000..638e2728a39 --- /dev/null +++ b/master/_sources/generated/pcdsdevices.lakeshore.Lakeshore336.rst.txt @@ -0,0 +1,210 @@ +pcdsdevices.lakeshore.Lakeshore336 +================================== + +.. currentmodule:: pcdsdevices.lakeshore + +.. autoclass:: Lakeshore336 + + + + .. list-table:: Ophyd Device Components + :header-rows: 1 + :widths: auto + + * - Attribute + - Class + - Suffix + - Docs + - Kind + - Notes + + * - set_temp_loop_1 + - :class:`~ophyd.signal.EpicsSignal` + - ``:GET_SOLL_1`` + - + - normal + - + + * - set_temp_loop_2 + - :class:`~ophyd.signal.EpicsSignal` + - ``:GET_SOLL_2`` + - + - normal + - + + * - man_loop_1 + - :class:`~ophyd.signal.EpicsSignal` + - ``:GET_MOUT_1`` + - + - normal + - + + * - man_loop_2 + - :class:`~ophyd.signal.EpicsSignal` + - ``:GET_MOUT_2`` + - + - normal + - + + * - an_loop_3 + - :class:`~ophyd.signal.EpicsSignal` + - ``:GET_AOUT_3`` + - + - normal + - + + * - an_loop_4 + - :class:`~ophyd.signal.EpicsSignal` + - ``:GET_AOUT_4`` + - + - normal + - + + * - set_heater_1 + - :class:`~pcdsdevices.lakeshore.Heater` + - + - + - normal + - + + * - set_heater_2 + - :class:`~pcdsdevices.lakeshore.Heater` + - + - + - normal + - + + * - temp_A + - :class:`~pcdsdevices.lakeshore.TemperatureSensor` + - + - + - normal + - + + * - temp_B + - :class:`~pcdsdevices.lakeshore.TemperatureSensor` + - + - + - normal + - + + * - temp_C + - :class:`~pcdsdevices.lakeshore.TemperatureSensor` + - + - + - normal + - + + * - temp_D + - :class:`~pcdsdevices.lakeshore.TemperatureSensor` + - + - + - normal + - + + * - mode + - :class:`~ophyd.signal.EpicsSignal` + - ``GET_MODE`` + - control mode + - normal + - + + * - loop_ramp_1 + - :class:`~ophyd.signal.EpicsSignalRO` + - ``:GET_RAMP_1`` + - + - normal + - + + * - loop_ramp_2 + - :class:`~ophyd.signal.EpicsSignalRO` + - ``:GET_RAMP_2`` + - + - normal + - + + * - htr_out_1 + - :class:`~ophyd.signal.EpicsSignalRO` + - ``:GET_HTR_1`` + - + - normal + - + + * - htr_out_2 + - :class:`~ophyd.signal.EpicsSignalRO` + - ``:GET_HTR_2`` + - + - 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.lakeshore.TemperatureSensor.rst.txt b/master/_sources/generated/pcdsdevices.lakeshore.TemperatureSensor.rst.txt new file mode 100644 index 00000000000..c4e6880557f --- /dev/null +++ b/master/_sources/generated/pcdsdevices.lakeshore.TemperatureSensor.rst.txt @@ -0,0 +1,93 @@ +pcdsdevices.lakeshore.TemperatureSensor +======================================= + +.. currentmodule:: pcdsdevices.lakeshore + +.. autoclass:: TemperatureSensor + + + + .. list-table:: Ophyd Device Components + :header-rows: 1 + :widths: auto + + * - Attribute + - Class + - Suffix + - Docs + - Kind + - Notes + + * - input_name (FCpt) + - :class:`~ophyd.signal.EpicsSignalRO` + - ``{prefix}:GET_INNAME_{channel}`` + - + - config + - + + * - temp (FCpt) + - :class:`~ophyd.signal.EpicsSignalRO` + - ``{prefix}:GET_TEMP_{channel}`` + - + - normal + - + + * - units (FCpt) + - :class:`~ophyd.signal.EpicsSignal` + - ``{prefix}:GET_UNITS_{channel}`` + - + - normal + - + + * - sensor_type (FCpt) + - :class:`~ophyd.signal.EpicsSignalRO` + - ``{prefix}:GET_SENSOR_{channel}`` + - + - 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.mirror.FFMirror.rst.txt b/master/_sources/generated/pcdsdevices.mirror.FFMirror.rst.txt index c3386f68c0d..72ecece510b 100644 --- a/master/_sources/generated/pcdsdevices.mirror.FFMirror.rst.txt +++ b/master/_sources/generated/pcdsdevices.mirror.FFMirror.rst.txt @@ -25,6 +25,13 @@ - omitted - Inherited from :class:`~pcdsdevices.interface.LightpathMixin` + * - coating + - :class:`~pcdsdevices.mirror.TwinCATMirrorStripe` + - ``:COATING:STATE`` + - Control of the coating states via saved positions. + - hinted + - + * - x - :class:`~pcdsdevices.epics_motor.BeckhoffAxisNoOffset` - ``:MMS:X`` @@ -107,6 +114,8 @@ + + diff --git a/master/_sources/generated/pcdsdevices.mirror.FFMirrorZ.rst.txt b/master/_sources/generated/pcdsdevices.mirror.FFMirrorZ.rst.txt index 589119d0b90..469d8f045da 100644 --- a/master/_sources/generated/pcdsdevices.mirror.FFMirrorZ.rst.txt +++ b/master/_sources/generated/pcdsdevices.mirror.FFMirrorZ.rst.txt @@ -46,20 +46,6 @@ - hinted - Inherited from :class:`~pcdsdevices.mirror.FFMirror` - * - cool_flow1 - - :class:`~ophyd.signal.EpicsSignalRO` - - ``:FWM:1_RBV`` - - Axilon Panel Flow Meter Loop 1 - - normal - - Inherited from :class:`~pcdsdevices.mirror.FFMirror` - - * - cool_press - - :class:`~ophyd.signal.EpicsSignalRO` - - ``:PRSM:1_RBV`` - - Axilon Panel Pressure Meter - - normal - - Inherited from :class:`~pcdsdevices.mirror.FFMirror` - * - z - :class:`~pcdsdevices.epics_motor.BeckhoffAxisNoOffset` - ``:MMS:Z`` @@ -67,24 +53,24 @@ - hinted - - * - chin_left_rtd + * - mirror_temp_l - :class:`~pcdsdevices.signal.PytmcSignal` - ``:RTD:CHIN:L:TEMP`` - - + - mirror temperature left chin guard - normal - - * - chin_right_rtd + * - mirror_temp_r - :class:`~pcdsdevices.signal.PytmcSignal` - ``:RTD:CHIN:R:TEMP`` - - + - mirror temperature right chin guard - normal - - * - chin_tail_rtd + * - mirror_temp_tail - :class:`~pcdsdevices.signal.PytmcSignal` - ``:RTD:TAIL:TEMP`` - - + - mirror temperature tail - normal - @@ -116,6 +102,20 @@ - normal - Inherited from :class:`~pcdsdevices.mirror.FFMirror` + * - cool_flow1 + - :class:`~ophyd.signal.EpicsSignalRO` + - ``:FWM:1_RBV`` + - Axilon Panel Flow Meter Loop 1 + - normal + - Inherited from :class:`~pcdsdevices.mirror.FFMirror` + + * - cool_press + - :class:`~ophyd.signal.EpicsSignalRO` + - ``:PRSM:1_RBV`` + - Axilon Panel Pressure Meter + - normal + - Inherited from :class:`~pcdsdevices.mirror.FFMirror` + @@ -177,6 +177,7 @@ .. rubric:: Attributes + .. autoattribute:: coating .. autoattribute:: configuration_attrs .. autoattribute:: connected .. autoattribute:: cool_flow2 diff --git a/master/_sources/generated/pcdsdevices.mirror.KBOMirrorHE.rst.txt b/master/_sources/generated/pcdsdevices.mirror.KBOMirrorHE.rst.txt index 539dfbb3a70..6fad2a44667 100644 --- a/master/_sources/generated/pcdsdevices.mirror.KBOMirrorHE.rst.txt +++ b/master/_sources/generated/pcdsdevices.mirror.KBOMirrorHE.rst.txt @@ -123,6 +123,20 @@ - normal - + * - mirror_temp_l + - :class:`~pcdsdevices.signal.PytmcSignal` + - ``:RTD:CHIN:L:TEMP`` + - mirror temperature left chin guard + - normal + - + + * - mirror_temp_r + - :class:`~pcdsdevices.signal.PytmcSignal` + - ``:RTD:CHIN:R:TEMP`` + - mirror temperature right chin guard + - normal + - + @@ -150,6 +164,10 @@ + + + + diff --git a/master/_sources/generated/pcdsdevices.mirror.KBOMirrorHEStates.rst.txt b/master/_sources/generated/pcdsdevices.mirror.KBOMirrorHEStates.rst.txt index 01f8aae2791..202c8bf1f32 100644 --- a/master/_sources/generated/pcdsdevices.mirror.KBOMirrorHEStates.rst.txt +++ b/master/_sources/generated/pcdsdevices.mirror.KBOMirrorHEStates.rst.txt @@ -102,6 +102,20 @@ - normal - Inherited from :class:`~pcdsdevices.mirror.KBOMirrorHE` + * - mirror_temp_l + - :class:`~pcdsdevices.signal.PytmcSignal` + - ``:RTD:CHIN:L:TEMP`` + - mirror temperature left chin guard + - normal + - Inherited from :class:`~pcdsdevices.mirror.KBOMirrorHE` + + * - mirror_temp_r + - :class:`~pcdsdevices.signal.PytmcSignal` + - ``:RTD:CHIN:R:TEMP`` + - mirror temperature right chin guard + - normal + - Inherited from :class:`~pcdsdevices.mirror.KBOMirrorHE` + * - us_rtd - :class:`~ophyd.signal.EpicsSignalRO` - ``:RTD:BEND:US:1_RBV`` @@ -159,6 +173,10 @@ + + + + diff --git a/master/_sources/generated/pcdsdevices.mirror.MirrorStripe2D2P.rst.txt b/master/_sources/generated/pcdsdevices.mirror.MirrorStripe2D2P.rst.txt new file mode 100644 index 00000000000..854f56ad065 --- /dev/null +++ b/master/_sources/generated/pcdsdevices.mirror.MirrorStripe2D2P.rst.txt @@ -0,0 +1,183 @@ +pcdsdevices.mirror.MirrorStripe2D2P +=================================== + +.. currentmodule:: pcdsdevices.mirror + +.. autoclass:: MirrorStripe2D2P + + + + .. list-table:: Ophyd Device Components + :header-rows: 1 + :widths: auto + + * - Attribute + - Class + - Suffix + - Docs + - Kind + - Notes + + * - state + - :class:`~pcdsdevices.signal.EpicsSignalEditMD` + - ``:GET_RBV`` + - Setpoint and readback for TwinCAT state position. + - hinted + - Inherited from :class:`~pcdsdevices.mirror.TwinCATMirrorStripe` + + * - error + - :class:`~pcdsdevices.signal.PytmcSignal` + - ``:ERR`` + - True if we have an error. + - normal + - Inherited from :class:`~pcdsdevices.mirror.TwinCATMirrorStripe` + + * - error_id + - :class:`~pcdsdevices.signal.PytmcSignal` + - ``:ERRID`` + - Error code. + - normal + - Inherited from :class:`~pcdsdevices.mirror.TwinCATMirrorStripe` + + * - error_message + - :class:`~pcdsdevices.signal.PytmcSignal` + - ``:ERRMSG`` + - Error message + - normal + - Inherited from :class:`~pcdsdevices.mirror.TwinCATMirrorStripe` + + * - busy + - :class:`~pcdsdevices.signal.PytmcSignal` + - ``:BUSY`` + - True if we have an ongoing move. + - normal + - Inherited from :class:`~pcdsdevices.mirror.TwinCATMirrorStripe` + + * - done + - :class:`~pcdsdevices.signal.PytmcSignal` + - ``:DONE`` + - True if we completed the last move. + - normal + - Inherited from :class:`~pcdsdevices.mirror.TwinCATMirrorStripe` + + * - reset_cmd + - :class:`~ophyd.signal.EpicsSignal` + - ``:RESET`` + - Command to reset an error. + - normal + - Inherited from :class:`~pcdsdevices.mirror.TwinCATMirrorStripe` + + * - config (UpdateComponent) + - :class:`~pcdsdevices.state.TwinCATStateConfigDynamic` + - + - Configuration of state positions, deltas, etc. + - omitted + - Inherited from :class:`~pcdsdevices.mirror.TwinCATMirrorStripe` + + * - state_velo + - :class:`~pcdsdevices.signal.MultiDerivedSignal` + - + - State mover velocity. Displays the highest velocity of all the state move destinations and allows bulk writes to all of these velocity settings. Note that this velocity only applies to moves done using the state selector box. + - config + - Inherited from :class:`~pcdsdevices.mirror.TwinCATMirrorStripe` + + * - arb_enable + - :class:`~pcdsdevices.signal.PytmcSignal` + - ``:PMPS:ARB:ENABLE`` + - Enables PMPS pre-emptive protections. This can be disabled to fall back on fast-fault-only protections. Disabling this will also clear arbiter requests. + - config + - Inherited from :class:`~pcdsdevices.mirror.TwinCATMirrorStripe` + + * - maint_mode + - :class:`~pcdsdevices.signal.PytmcSignal` + - ``:PMPS:MAINT`` + - If this is on, we trip a fast fault and then can move the motor freely. Useful for debugging motion issues. + - config + - Inherited from :class:`~pcdsdevices.mirror.TwinCATMirrorStripe` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + .. rubric:: Methods + + + .. automethod:: camonitor + .. automethod:: check_inserted + .. automethod:: check_removed + .. automethod:: check_transmission + .. automethod:: clear_error + .. automethod:: configure + .. automethod:: describe + .. automethod:: end_monitor_thread + .. automethod:: get + .. automethod:: get_state + .. automethod:: insert + .. automethod:: move + .. automethod:: mv + .. automethod:: post_elog_status + .. automethod:: read + .. automethod:: read_configuration + .. automethod:: remove + .. automethod:: screen + .. automethod:: set + .. automethod:: status + .. automethod:: summary + .. automethod:: trigger + .. automethod:: wait + .. automethod:: wm + .. automethod:: wm_update + + + + + + .. rubric:: Attributes + + + .. autoattribute:: configuration_attrs + .. autoattribute:: connected + .. autoattribute:: egu + .. autoattribute:: high_limit + .. autoattribute:: hints + .. autoattribute:: in_states + .. autoattribute:: kind + .. autoattribute:: limits + .. autoattribute:: low_limit + .. autoattribute:: moving + .. autoattribute:: out_states + .. autoattribute:: position + .. autoattribute:: settle_time + .. autoattribute:: states_list + .. autoattribute:: stop + .. autoattribute:: subscriptions + .. autoattribute:: timeout + .. autoattribute:: transmission + + \ No newline at end of file diff --git a/master/_sources/generated/pcdsdevices.mirror.XOffsetMirrorBend.rst.txt b/master/_sources/generated/pcdsdevices.mirror.XOffsetMirrorBend.rst.txt index 97829264ddb..3bff1e84ec0 100644 --- a/master/_sources/generated/pcdsdevices.mirror.XOffsetMirrorBend.rst.txt +++ b/master/_sources/generated/pcdsdevices.mirror.XOffsetMirrorBend.rst.txt @@ -18,6 +18,13 @@ - Kind - Notes + * - coating + - :class:`~pcdsdevices.mirror.MirrorStripe2D2P` + - ``:COATING:STATE`` + - Control of the coating states via saved positions. + - hinted + - + * - lightpath_summary - :class:`~pcdsdevices.signal.SummarySignal` - @@ -251,6 +258,8 @@ + + diff --git a/master/_sources/generated/pcdsdevices.mirror.XOffsetMirrorSwitch.rst.txt b/master/_sources/generated/pcdsdevices.mirror.XOffsetMirrorSwitch.rst.txt index 6a752443925..0938e31012a 100644 --- a/master/_sources/generated/pcdsdevices.mirror.XOffsetMirrorSwitch.rst.txt +++ b/master/_sources/generated/pcdsdevices.mirror.XOffsetMirrorSwitch.rst.txt @@ -25,6 +25,13 @@ - omitted - Inherited from :class:`~pcdsdevices.mirror.XOffsetMirror` + * - coating + - :class:`~pcdsdevices.mirror.TwinCATMirrorStripe` + - ``:COATING:STATE`` + - Control of the coating states via saved positions. + - hinted + - + * - x_up - :class:`~pcdsdevices.epics_motor.BeckhoffAxisNoOffset` - ``:MMS:XUP`` @@ -197,6 +204,8 @@ + + diff --git a/master/_sources/generated/pcdsdevices.mpod_apalis.MPODApalisChannel.rst.txt b/master/_sources/generated/pcdsdevices.mpod_apalis.MPODApalisChannel.rst.txt index 2d7ae3adb3d..ce569be932d 100644 --- a/master/_sources/generated/pcdsdevices.mpod_apalis.MPODApalisChannel.rst.txt +++ b/master/_sources/generated/pcdsdevices.mpod_apalis.MPODApalisChannel.rst.txt @@ -19,9 +19,9 @@ - Notes * - voltage - - :class:`~ophyd.signal.EpicsSignal` + - :class:`~pcdsdevices.signal.EpicsSignalEditMD` - ``:VoltageMeasure`` - - MPOD Channel Voltage Measurement [V] + - MPOD Channel Voltage Measurement [V]. The value of this signal is the actual measured voltage of the channel. If you put to this signal it will change the channel's voltage setpoint. - normal - @@ -33,9 +33,9 @@ - * - current - - :class:`~ophyd.signal.EpicsSignal` + - :class:`~pcdsdevices.signal.EpicsSignalEditMD` - ``:CurrentMeasure`` - - MPOD Channel Current Measure + - MPOD Channel Current Measurement [A]. The value of this signal is the actual measured current of the channel. If you put to this signal it will change the channel's current setpoint. - normal - @@ -53,6 +53,27 @@ - normal - + * - desc + - :class:`~ophyd.signal.EpicsSignal` + - ``:VoltageMeasure.DESC`` + - MPOD Channel Description + - normal + - + + * - last_voltage_set + - :class:`~ophyd.signal.EpicsSignalRO` + - ``:VoltageSet`` + - Readback to verify the MPOD Channel Voltage Setpoint [V]. This is used to compare the measured readback voltage with the last value we set to the channel. To change the voltage, use the voltage signal or the set_voltage helper method. + - normal + - + + * - is_trip + - :class:`~ophyd.signal.EpicsSignalRO` + - ``:isTrip`` + - True if MPOD channel is tripped. + - omitted + - + @@ -65,6 +86,12 @@ + + + + + + @@ -102,5 +129,6 @@ .. autoattribute:: hints .. autoattribute:: kind .. autoattribute:: subscriptions + .. autoattribute:: voltage_setpoint \ No newline at end of file diff --git a/master/_sources/generated/pcdsdevices.pc.PhotonCollimatorFDQ.rst.txt b/master/_sources/generated/pcdsdevices.pc.PhotonCollimatorFDQ.rst.txt new file mode 100644 index 00000000000..acad7a25b19 --- /dev/null +++ b/master/_sources/generated/pcdsdevices.pc.PhotonCollimatorFDQ.rst.txt @@ -0,0 +1,64 @@ +pcdsdevices.pc.PhotonCollimatorFDQ +================================== + +.. currentmodule:: pcdsdevices.pc + +.. autoclass:: PhotonCollimatorFDQ + + + + .. list-table:: Ophyd Device Components + :header-rows: 1 + :widths: auto + + * - Attribute + - Class + - Suffix + - Docs + - Kind + - Notes + + * - flow_meter + - :class:`~pcdsdevices.analog_signals.FDQ` + - + - Device that measures PCW Flow Rate. + - normal + - + + + + + + + + + + + + .. rubric:: Methods + + + .. automethod:: configure + .. automethod:: describe + .. automethod:: get + .. automethod:: read + .. automethod:: read_configuration + .. automethod:: stop + .. automethod:: summary + .. automethod:: trigger + + + + + + .. rubric:: Attributes + + + .. autoattribute:: configuration_attrs + .. autoattribute:: connected + .. autoattribute:: flow_switch + .. autoattribute:: hints + .. autoattribute:: kind + .. autoattribute:: subscriptions + + \ No newline at end of file diff --git a/master/_sources/generated/pcdsdevices.pim.PPMPowerMeter.rst.txt b/master/_sources/generated/pcdsdevices.pim.PPMPowerMeter.rst.txt index 80e01a44d90..89a52f6d2be 100644 --- a/master/_sources/generated/pcdsdevices.pim.PPMPowerMeter.rst.txt +++ b/master/_sources/generated/pcdsdevices.pim.PPMPowerMeter.rst.txt @@ -18,53 +18,88 @@ - Kind - Notes - * - raw_voltage + * - responsivity - :class:`~pcdsdevices.signal.PytmcSignal` - - ``:VOLT`` - - Raw readback from the power meter. + - ``:RESP`` + - Responsivity in V/W, unique for every power meter. - normal - - * - dimensionless + * - background_voltage - :class:`~pcdsdevices.signal.PytmcSignal` - - ``:CALIB`` - - Calibrated dimensionless readback for cross-meter comparisons. + - ``:BACK:VOLT`` + - Background voltage value used to calculate pulse energy. - normal - - * - calibrated_mj + * - auto_background_reset - :class:`~pcdsdevices.signal.PytmcSignal` - - ``:MJ`` - - Calibrated absolute measurement of beam power in physics units. + - ``:BACK:RESET`` + - Set to reset auto background voltage collection. - normal - - * - thermocouple - - :class:`~pcdsdevices.sensors.TwinCATThermocouple` + * - background_mode + - :class:`~pcdsdevices.signal.PytmcSignal` + - ``:BACK:MODE`` + - Can be manual or auto In manual mode, you can collect for a specified number of seconds. In auto mode, a buffer of automatically collected background voltages will be used to calculate the background voltage. + - normal - - - Thermocouple on the power meter holder. + + * - manual_collect + - :class:`~pcdsdevices.signal.PytmcSignal` + - ``:BACK:COLL`` + - Start collecting background voltages for specified time. - normal - - * - calib_offset + * - manual_in_progress - :class:`~pcdsdevices.signal.PytmcSignal` - - ``:CALIB:OFFSET`` - - Calibration parameter to offset raw voltage to zero for the calibrated quantities. Unique per power meter. - - config + - ``:BACK:MANUAL_COLLECTING`` + - Manual collection currntly in progress + - normal - - * - calib_ratio + * - manual_collect_time - :class:`~pcdsdevices.signal.PytmcSignal` - - ``:CALIB:RATIO`` - - Calibration multiplier to convert to the dimensionless constant. Unique per power meter. - - config + - ``:BACK:TIME`` + - Time to collect background voltages for. + - normal + - + + * - raw_voltage + - :class:`~pcdsdevices.signal.PytmcSignal` + - ``:VOLT`` + - Raw readback from the power meter. + - normal + - + + * - calibrated_mj + - :class:`~pcdsdevices.signal.PytmcSignal` + - ``:MJ`` + - Calibrated absolute measurement of beam power in physics units. + - normal - - * - calib_mj_ratio + * - calibrated_uj + - :class:`~pcdsdevices.signal.UnitConversionDerivedSignal` + - + - + - normal + - + + * - wattage - :class:`~pcdsdevices.signal.PytmcSignal` - - ``:CALIB:MJ_RATIO`` - - Calibration multiplier to convert from the dimensionless constant to calibrated scientific quantity. Same for every power meter. - - config + - ``:WATT`` + - Wattage measured by power meter, equals MJ times Beamrate. + - normal + - + + * - thermocouple + - :class:`~pcdsdevices.sensors.TwinCATThermocouple` + - + - Thermocouple on the power meter holder. + - normal - * - raw_voltage_buffer @@ -74,17 +109,17 @@ - omitted - - * - dimensionless_buffer + * - calibrated_mj_buffer - :class:`~pcdsdevices.signal.PytmcSignal` - - ``:CALIB_BUFFER`` - - Array of the last 1000 dimensionless measurements. Polls faster than the EPICS updates. + - ``:MJ_BUFFER`` + - Array of the last 1000 fully calibrated measurements. Polls faster than the EPICS updates. - omitted - - * - calibrated_mj_buffer + * - wattage_buffer - :class:`~pcdsdevices.signal.PytmcSignal` - - ``:MJ_BUFFER`` - - Array of the last 1000 fully calibrated measurements. Polls faster than the EPICS updates. + - ``:WATT_BUFFER`` + - Array of the last 1000 wattages. Polls faster than the EPICS updates. - omitted - @@ -105,6 +140,16 @@ + + + + + + + + + + diff --git a/master/_sources/generated/pcdsdevices.pneumatic.BeckhoffPneumaticFDQ.rst.txt b/master/_sources/generated/pcdsdevices.pneumatic.BeckhoffPneumaticFDQ.rst.txt new file mode 100644 index 00000000000..3481504d636 --- /dev/null +++ b/master/_sources/generated/pcdsdevices.pneumatic.BeckhoffPneumaticFDQ.rst.txt @@ -0,0 +1,226 @@ +pcdsdevices.pneumatic.BeckhoffPneumaticFDQ +========================================== + +.. currentmodule:: pcdsdevices.pneumatic + +.. autoclass:: BeckhoffPneumaticFDQ + + + + .. list-table:: Ophyd Device Components + :header-rows: 1 + :widths: auto + + * - Attribute + - Class + - Suffix + - Docs + - Kind + - Notes + + * - lightpath_summary + - :class:`~pcdsdevices.signal.SummarySignal` + - + - + - omitted + - Inherited from :class:`~pcdsdevices.pneumatic.BeckhoffPneumatic` + + * - limit_switch_in + - :class:`~pcdsdevices.signal.PytmcSignal` + - ``:PLC:bInLimitSwitch`` + - + - normal + - Inherited from :class:`~pcdsdevices.pneumatic.BeckhoffPneumatic` + + * - limit_switch_out + - :class:`~pcdsdevices.signal.PytmcSignal` + - ``:PLC:bOutLimitSwitch`` + - + - normal + - Inherited from :class:`~pcdsdevices.pneumatic.BeckhoffPneumatic` + + * - retract_status + - :class:`~pcdsdevices.signal.PytmcSignal` + - ``:bRetractDigitalOutput`` + - + - normal + - Inherited from :class:`~pcdsdevices.pneumatic.BeckhoffPneumatic` + + * - insert_status + - :class:`~pcdsdevices.signal.PytmcSignal` + - ``:bInsertDigitalOutput`` + - + - normal + - Inherited from :class:`~pcdsdevices.pneumatic.BeckhoffPneumatic` + + * - interlock_ok + - :class:`~pcdsdevices.signal.PytmcSignal` + - ``:bInterlockOK`` + - + - normal + - Inherited from :class:`~pcdsdevices.pneumatic.BeckhoffPneumatic` + + * - insert_ok + - :class:`~pcdsdevices.signal.PytmcSignal` + - ``:bInsertEnable`` + - + - normal + - Inherited from :class:`~pcdsdevices.pneumatic.BeckhoffPneumatic` + + * - retract_ok + - :class:`~pcdsdevices.signal.PytmcSignal` + - ``:bRetractEnable`` + - + - normal + - Inherited from :class:`~pcdsdevices.pneumatic.BeckhoffPneumatic` + + * - insert_signal + - :class:`~pcdsdevices.signal.PytmcSignal` + - ``:CMD:IN`` + - + - normal + - Inherited from :class:`~pcdsdevices.pneumatic.BeckhoffPneumatic` + + * - retract_signal + - :class:`~pcdsdevices.signal.PytmcSignal` + - ``:CMD:OUT`` + - + - normal + - Inherited from :class:`~pcdsdevices.pneumatic.BeckhoffPneumatic` + + * - busy + - :class:`~pcdsdevices.signal.PytmcSignal` + - ``:bBusy`` + - + - normal + - Inherited from :class:`~pcdsdevices.pneumatic.BeckhoffPneumatic` + + * - done + - :class:`~pcdsdevices.signal.PytmcSignal` + - ``:bDone`` + - + - normal + - Inherited from :class:`~pcdsdevices.pneumatic.BeckhoffPneumatic` + + * - reset + - :class:`~pcdsdevices.signal.PytmcSignal` + - ``:bReset`` + - + - normal + - Inherited from :class:`~pcdsdevices.pneumatic.BeckhoffPneumatic` + + * - error + - :class:`~pcdsdevices.signal.PytmcSignal` + - ``:PLC:bError`` + - + - normal + - Inherited from :class:`~pcdsdevices.pneumatic.BeckhoffPneumatic` + + * - error_id + - :class:`~pcdsdevices.signal.PytmcSignal` + - ``:PLC:nErrorId`` + - + - normal + - Inherited from :class:`~pcdsdevices.pneumatic.BeckhoffPneumatic` + + * - error_message + - :class:`~pcdsdevices.signal.PytmcSignal` + - ``:PLC:sErrorMessage`` + - + - normal + - Inherited from :class:`~pcdsdevices.pneumatic.BeckhoffPneumatic` + + * - position_state + - :class:`~pcdsdevices.signal.PytmcSignal` + - ``:nPositionState`` + - + - hinted + - Inherited from :class:`~pcdsdevices.pneumatic.BeckhoffPneumatic` + + * - flow_meter + - :class:`~pcdsdevices.analog_signals.FDQ` + - + - Device that measures PCW Flow Rate. + - normal + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + .. rubric:: Methods + + + .. automethod:: calc_lightpath_state + .. automethod:: callback + .. automethod:: configure + .. automethod:: describe + .. automethod:: get + .. automethod:: get_lightpath_state + .. automethod:: insert + .. automethod:: post_elog_status + .. automethod:: read + .. automethod:: read_configuration + .. automethod:: remove + .. automethod:: screen + .. automethod:: status + .. automethod:: stop + .. automethod:: summary + .. automethod:: trigger + + + + + + .. rubric:: Attributes + + + .. autoattribute:: configuration_attrs + .. autoattribute:: connected + .. autoattribute:: hints + .. autoattribute:: kind + .. autoattribute:: lightpath_cpts + .. autoattribute:: md + .. autoattribute:: subscriptions + + \ No newline at end of file diff --git a/master/_sources/generated/pcdsdevices.pseudopos.is_strictly_increasing.rst.txt b/master/_sources/generated/pcdsdevices.pseudopos.is_strictly_increasing.rst.txt new file mode 100644 index 00000000000..e47f25a2717 --- /dev/null +++ b/master/_sources/generated/pcdsdevices.pseudopos.is_strictly_increasing.rst.txt @@ -0,0 +1,6 @@ +pcdsdevices.pseudopos.is\_strictly\_increasing +============================================== + +.. currentmodule:: pcdsdevices.pseudopos + +.. autofunction:: is_strictly_increasing \ No newline at end of file diff --git a/master/_sources/generated/pcdsdevices.pump.PIPPLC.rst.txt b/master/_sources/generated/pcdsdevices.pump.PIPPLC.rst.txt index 9904d902058..fd9c01dc144 100644 --- a/master/_sources/generated/pcdsdevices.pump.PIPPLC.rst.txt +++ b/master/_sources/generated/pcdsdevices.pump.PIPPLC.rst.txt @@ -116,6 +116,13 @@ - omitted - + * - qpc_name + - :class:`~ophyd.signal.EpicsSignalRO` + - ``:VPCNAME`` + - Quad Ion Pump Controller Name + - config + - + * - qpc_pumpsize - :class:`~ophyd.signal.EpicsSignalRO` - ``:PUMPSIZE`` @@ -170,6 +177,8 @@ + + diff --git a/master/_sources/generated/pcdsdevices.signal.AvgSignal.rst.txt b/master/_sources/generated/pcdsdevices.signal.AvgSignal.rst.txt index 37ac5a21af1..da9cd22ee11 100644 --- a/master/_sources/generated/pcdsdevices.signal.AvgSignal.rst.txt +++ b/master/_sources/generated/pcdsdevices.signal.AvgSignal.rst.txt @@ -18,6 +18,7 @@ .. automethod:: get .. automethod:: read .. automethod:: read_configuration + .. automethod:: reset_buffer .. automethod:: set .. automethod:: trigger diff --git a/master/_sources/generated/pcdsdevices.spectrometer.Mono.rst.txt b/master/_sources/generated/pcdsdevices.spectrometer.Mono.rst.txt index 5f373f79914..b5eca434d35 100644 --- a/master/_sources/generated/pcdsdevices.spectrometer.Mono.rst.txt +++ b/master/_sources/generated/pcdsdevices.spectrometer.Mono.rst.txt @@ -25,6 +25,13 @@ - omitted - Inherited from :class:`~pcdsdevices.interface.LightpathMixin` + * - grating_states + - :class:`~pcdsdevices.spectrometer.MonoGratingStates` + - ``:GRATING:STATE`` + - mono grating states g_h + - normal + - + * - m_pi - :class:`~pcdsdevices.epics_motor.BeckhoffAxisNoOffset` - ``:MMS:M_PI`` @@ -260,6 +267,8 @@ + + diff --git a/master/_sources/generated/pcdsdevices.spectrometer.MonoGratingStates.rst.txt b/master/_sources/generated/pcdsdevices.spectrometer.MonoGratingStates.rst.txt new file mode 100644 index 00000000000..2161181565b --- /dev/null +++ b/master/_sources/generated/pcdsdevices.spectrometer.MonoGratingStates.rst.txt @@ -0,0 +1,183 @@ +pcdsdevices.spectrometer.MonoGratingStates +========================================== + +.. currentmodule:: pcdsdevices.spectrometer + +.. autoclass:: MonoGratingStates + + + + .. list-table:: Ophyd Device Components + :header-rows: 1 + :widths: auto + + * - Attribute + - Class + - Suffix + - Docs + - Kind + - Notes + + * - state + - :class:`~pcdsdevices.signal.EpicsSignalEditMD` + - ``:GET_RBV`` + - Setpoint and readback for TwinCAT state position. + - hinted + - Inherited from :class:`~pcdsdevices.pmps.TwinCATStatePMPS` + + * - error + - :class:`~pcdsdevices.signal.PytmcSignal` + - ``:ERR`` + - True if we have an error. + - normal + - Inherited from :class:`~pcdsdevices.pmps.TwinCATStatePMPS` + + * - error_id + - :class:`~pcdsdevices.signal.PytmcSignal` + - ``:ERRID`` + - Error code. + - normal + - Inherited from :class:`~pcdsdevices.pmps.TwinCATStatePMPS` + + * - error_message + - :class:`~pcdsdevices.signal.PytmcSignal` + - ``:ERRMSG`` + - Error message + - normal + - Inherited from :class:`~pcdsdevices.pmps.TwinCATStatePMPS` + + * - busy + - :class:`~pcdsdevices.signal.PytmcSignal` + - ``:BUSY`` + - True if we have an ongoing move. + - normal + - Inherited from :class:`~pcdsdevices.pmps.TwinCATStatePMPS` + + * - done + - :class:`~pcdsdevices.signal.PytmcSignal` + - ``:DONE`` + - True if we completed the last move. + - normal + - Inherited from :class:`~pcdsdevices.pmps.TwinCATStatePMPS` + + * - reset_cmd + - :class:`~ophyd.signal.EpicsSignal` + - ``:RESET`` + - Command to reset an error. + - normal + - Inherited from :class:`~pcdsdevices.pmps.TwinCATStatePMPS` + + * - config (UpdateComponent) + - :class:`~pcdsdevices.state.TwinCATStateConfigDynamic` + - + - Configuration of state positions, deltas, etc. + - omitted + - Inherited from :class:`~pcdsdevices.pmps.TwinCATStatePMPS` + + * - state_velo + - :class:`~pcdsdevices.signal.MultiDerivedSignal` + - + - State mover velocity. Displays the highest velocity of all the state move destinations and allows bulk writes to all of these velocity settings. Note that this velocity only applies to moves done using the state selector box. + - config + - Inherited from :class:`~pcdsdevices.pmps.TwinCATStatePMPS` + + * - arb_enable + - :class:`~pcdsdevices.signal.PytmcSignal` + - ``:PMPS:ARB:ENABLE`` + - Enables PMPS pre-emptive protections. This can be disabled to fall back on fast-fault-only protections. Disabling this will also clear arbiter requests. + - config + - Inherited from :class:`~pcdsdevices.pmps.TwinCATStatePMPS` + + * - maint_mode + - :class:`~pcdsdevices.signal.PytmcSignal` + - ``:PMPS:MAINT`` + - If this is on, we trip a fast fault and then can move the motor freely. Useful for debugging motion issues. + - config + - Inherited from :class:`~pcdsdevices.pmps.TwinCATStatePMPS` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + .. rubric:: Methods + + + .. automethod:: camonitor + .. automethod:: check_inserted + .. automethod:: check_removed + .. automethod:: check_transmission + .. automethod:: clear_error + .. automethod:: configure + .. automethod:: describe + .. automethod:: end_monitor_thread + .. automethod:: get + .. automethod:: get_state + .. automethod:: insert + .. automethod:: move + .. automethod:: mv + .. automethod:: post_elog_status + .. automethod:: read + .. automethod:: read_configuration + .. automethod:: remove + .. automethod:: screen + .. automethod:: set + .. automethod:: status + .. automethod:: summary + .. automethod:: trigger + .. automethod:: wait + .. automethod:: wm + .. automethod:: wm_update + + + + + + .. rubric:: Attributes + + + .. autoattribute:: configuration_attrs + .. autoattribute:: connected + .. autoattribute:: egu + .. autoattribute:: high_limit + .. autoattribute:: hints + .. autoattribute:: in_states + .. autoattribute:: kind + .. autoattribute:: limits + .. autoattribute:: low_limit + .. autoattribute:: moving + .. autoattribute:: out_states + .. autoattribute:: position + .. autoattribute:: settle_time + .. autoattribute:: states_list + .. autoattribute:: stop + .. autoattribute:: subscriptions + .. autoattribute:: timeout + .. autoattribute:: transmission + + \ No newline at end of file diff --git a/master/_sources/generated/pcdsdevices.spectrometer.TMOSpectrometer.rst.txt b/master/_sources/generated/pcdsdevices.spectrometer.TMOSpectrometer.rst.txt index 9309ffa752d..dae1c013124 100644 --- a/master/_sources/generated/pcdsdevices.spectrometer.TMOSpectrometer.rst.txt +++ b/master/_sources/generated/pcdsdevices.spectrometer.TMOSpectrometer.rst.txt @@ -123,6 +123,13 @@ - normal - + * - flow_meter + - :class:`~pcdsdevices.analog_signals.FDQ` + - + - Device that measures PCW Flow Rate. + - normal + - + @@ -152,6 +159,8 @@ + + diff --git a/master/_sources/generated/pcdsdevices.valve.VCN_OpenLoop.rst.txt b/master/_sources/generated/pcdsdevices.valve.VCN_OpenLoop.rst.txt new file mode 100644 index 00000000000..ef8f87db9cf --- /dev/null +++ b/master/_sources/generated/pcdsdevices.valve.VCN_OpenLoop.rst.txt @@ -0,0 +1,99 @@ +pcdsdevices.valve.VCN\_OpenLoop +=============================== + +.. currentmodule:: pcdsdevices.valve + +.. autoclass:: VCN_OpenLoop + + + + .. list-table:: Ophyd Device Components + :header-rows: 1 + :widths: auto + + * - Attribute + - Class + - Suffix + - Docs + - Kind + - Notes + + * - position_control + - :class:`~ophyd.areadetector.base.EpicsSignalWithRBV` + - ``:POS_REQ`` + - requested positition to control the valve 0-100% + - normal + - + + * - upper_limit + - :class:`~ophyd.areadetector.base.EpicsSignalWithRBV` + - ``:Limit`` + - max upper limit position to open the valve 0-100% + - normal + - + + * - interlock_ok + - :class:`~ophyd.signal.EpicsSignalRO` + - ``:ILK_OK_RBV`` + - interlock ok status + - normal + - + + * - control_mode + - :class:`~ophyd.areadetector.base.EpicsSignalWithRBV` + - ``:STATE`` + - Open mode will open valve to upper limit + - normal + - + + * - pos_ao + - :class:`~ophyd.signal.EpicsSignalRO` + - ``:POS_AO_R_RBV`` + - + - normal + - + + + + + + + + + + + + + + + + + + + + .. rubric:: Methods + + + .. automethod:: configure + .. automethod:: describe + .. automethod:: get + .. automethod:: read + .. automethod:: read_configuration + .. 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/releases.rst.txt b/master/_sources/releases.rst.txt index 7e1629dd722..26a02d519c5 100644 --- a/master/_sources/releases.rst.txt +++ b/master/_sources/releases.rst.txt @@ -5,6 +5,11 @@ Release History v8.6.0 (2024-09-16) =================== +API Breaks +---------- +- Removed ``qpc_name`` (``:VPCNAME`` PV). + This will be brought back in the next release. + Device Features --------------- - Lcls2LaserTiming: Reduce timeout on moves from 2 seconds to 0.2 seconds diff --git a/master/_sources/upcoming_release_notes/1251-Responsive_PPM.rst.txt b/master/_sources/upcoming_release_notes/1251-Responsive_PPM.rst.txt new file mode 100644 index 00000000000..2904c495845 --- /dev/null +++ b/master/_sources/upcoming_release_notes/1251-Responsive_PPM.rst.txt @@ -0,0 +1,30 @@ +1251 Responsive_PPM +################# + +API Breaks +---------- +- N/A + +Features +-------- +- N/A + +Device Updates +-------------- +- Editing PPMPowerMeter and PPM classes to be used with new PPM code that supports automatic background collection, responsivity, wattage, and the new way to calculate pulse energies. + +New Devices +----------- +- N/A + +Bugfixes +-------- +- N/A + +Maintenance +----------- +- N/A + +Contributors +------------ +- KaushikMalapati diff --git a/master/_sources/upcoming_release_notes/1274-Adding_base_class_for_hxr_diffractometer..rst.txt b/master/_sources/upcoming_release_notes/1274-Adding_base_class_for_hxr_diffractometer..rst.txt new file mode 100644 index 00000000000..15e4293e85b --- /dev/null +++ b/master/_sources/upcoming_release_notes/1274-Adding_base_class_for_hxr_diffractometer..rst.txt @@ -0,0 +1,32 @@ +1274 Adding base class for hxr diffractometer. +################# + +API Breaks +---------- +- N/A + +Library Features +---------------- +- N/A + +Device Features +--------------- +- N/A + +New Devices +----------- +- Added `HxrDiffractometer` for the Beckhoff-based HXR diffractomoeter. + This controls the diffractometer in XPP with prefix ``"HXR:GON:MMS"``. + +Bugfixes +-------- +- N/A + +Maintenance +----------- +- N/A + +Contributors +------------ +- c-tsoi +- zllentz diff --git a/master/_sources/upcoming_release_notes/1282-fix_decr_lut.rst.txt b/master/_sources/upcoming_release_notes/1282-fix_decr_lut.rst.txt new file mode 100644 index 00000000000..b71ea55e2f8 --- /dev/null +++ b/master/_sources/upcoming_release_notes/1282-fix_decr_lut.rst.txt @@ -0,0 +1,35 @@ +1282 fix_decr_lut +################# + +API Breaks +---------- +- N/A + +Library Features +---------------- +- N/A + +Device Features +--------------- +- N/A + +New Devices +----------- +- N/A + +Bugfixes +-------- +- Fix an issue where the LookupTablePositioner would fail silently if the + lookup table was not strictly increasing in both axes. + Lookup tables that are strictly decreasing in either axis + will now be supported. + Lookup tables that have inconsistent ordering in either axis will + log a warning when the conversion is done. + +Maintenance +----------- +- N/A + +Contributors +------------ +- zllentz diff --git a/master/_sources/upcoming_release_notes/1283-Adding_base_class_for_lakeshore_336..rst.txt b/master/_sources/upcoming_release_notes/1283-Adding_base_class_for_lakeshore_336..rst.txt new file mode 100644 index 00000000000..edf97f17d49 --- /dev/null +++ b/master/_sources/upcoming_release_notes/1283-Adding_base_class_for_lakeshore_336..rst.txt @@ -0,0 +1,32 @@ +1283 Adding base class for lakeshore 336. +################# + +API Breaks +---------- +- N/A + +Features +-------- +-Base class for lakeshore 336 +-Class for Temperature Sensor +-Class for Heater + +Device Updates +-------------- +- N/A + +New Devices +----------- +- Lakeshore 336 + +Bugfixes +-------- +- N/A + +Maintenance +----------- +- N/A + +Contributors +------------ +- c-tsoi diff --git a/master/_sources/upcoming_release_notes/1284-tmo-flow-sensors.rst.txt b/master/_sources/upcoming_release_notes/1284-tmo-flow-sensors.rst.txt new file mode 100644 index 00000000000..c7a41d426b7 --- /dev/null +++ b/master/_sources/upcoming_release_notes/1284-tmo-flow-sensors.rst.txt @@ -0,0 +1,31 @@ +1284 tmo-flow-sensors +################# + +API Breaks +---------- +- N/A + +Library Features +---------------- +- N/A + +Device Features +--------------- +- add `FDQ` to `TMOSpectrometer` in spectrometer.py + +New Devices +----------- +- `PhotonCollimatorFDQ` +- `BeckhoffPneumaticFDQ` + +Bugfixes +-------- +- N/A + +Maintenance +----------- +- N/A + +Contributors +------------ +- nrwslac diff --git a/master/_sources/upcoming_release_notes/1286-adding_more_targets_into_pa1k4.rst.txt b/master/_sources/upcoming_release_notes/1286-adding_more_targets_into_pa1k4.rst.txt new file mode 100644 index 00000000000..657bff28dd5 --- /dev/null +++ b/master/_sources/upcoming_release_notes/1286-adding_more_targets_into_pa1k4.rst.txt @@ -0,0 +1,30 @@ +1286 adding more targets into pa1k4 +################# + +API Breaks +---------- +- N/A + +Library Features +---------------- +- N/A + +Device Features +--------------- +- CalibrationAxis from 5 -> 7 states + +New Devices +----------- +- N/A + +Bugfixes +-------- +- N/A + +Maintenance +----------- +- N/A + +Contributors +------------ +- tongju12 diff --git a/master/_sources/upcoming_release_notes/1287-fix_lowercase_error.rst.txt b/master/_sources/upcoming_release_notes/1287-fix_lowercase_error.rst.txt new file mode 100644 index 00000000000..47cf91bb0ba --- /dev/null +++ b/master/_sources/upcoming_release_notes/1287-fix_lowercase_error.rst.txt @@ -0,0 +1,30 @@ +1287 fix lowercase error +################# + +API Breaks +---------- +- N/A + +Library Features +---------------- +- N/A + +Device Features +--------------- +- N/A + +New Devices +----------- +- N/A + +Bugfixes +-------- +- Change statecount from 7 to 8 to fix target name lower case issue + +Maintenance +----------- +- N/A + +Contributors +------------ +- tongju12 diff --git a/master/_sources/upcoming_release_notes/1288-mnt_revert_qpc_name.rst.txt b/master/_sources/upcoming_release_notes/1288-mnt_revert_qpc_name.rst.txt new file mode 100644 index 00000000000..22cce14f813 --- /dev/null +++ b/master/_sources/upcoming_release_notes/1288-mnt_revert_qpc_name.rst.txt @@ -0,0 +1,30 @@ +1288 mnt_revert_qpc_name +######################## + +API Breaks +---------- +- N/A + +Library Features +---------------- +- N/A + +Device Features +--------------- +- N/A + +New Devices +----------- +- N/A + +Bugfixes +-------- +- N/A + +Maintenance +----------- +- Restore `PIPPLC`'s ``qpc_name`` component. + +Contributors +------------ +- zllentz diff --git a/master/_sources/upcoming_release_notes/1290-rix-states.rst.txt b/master/_sources/upcoming_release_notes/1290-rix-states.rst.txt new file mode 100644 index 00000000000..2106b19afdb --- /dev/null +++ b/master/_sources/upcoming_release_notes/1290-rix-states.rst.txt @@ -0,0 +1,33 @@ +1290 rix-states +################# + +API Breaks +---------- +- N/A + +Library Features +---------------- +- N/A + +Device Features +--------------- +- `Mono` in `spectrometer.py` gets `MonoGratingStates` +- `XOffsetMirrorSwitch` in `mirror.py` gets `TwinCATMirrorStripe` +- `XOffsetMirrorBend` in `mirror.py` gets `MirrorStripe2D2P` + +New Devices +----------- +- `MonoGratingStates` +- `MirrorStripe2D2P` + +Bugfixes +-------- +- N/A + +Maintenance +----------- +- N/A + +Contributors +------------ +- nrwslac diff --git a/master/_sources/upcoming_release_notes/1291-fix_smarpod_ui_name.rst.txt b/master/_sources/upcoming_release_notes/1291-fix_smarpod_ui_name.rst.txt new file mode 100644 index 00000000000..8869b90b4d7 --- /dev/null +++ b/master/_sources/upcoming_release_notes/1291-fix_smarpod_ui_name.rst.txt @@ -0,0 +1,31 @@ +1291 fix_smarpod_ui_name +################# + +API Breaks +---------- +- N/A + +Library Features +---------------- +- N/A + +Device Features +--------------- +- N/A + +New Devices +----------- +- N/A + +Bugfixes +-------- +- Rename ``Smarpod.detailed.ui`` to ``SmarPod.detailed.ui`` so that it will be + properly discovered by ``typhos`` for the `SmarPod` class. + +Maintenance +----------- +- N/A + +Contributors +------------ +- zllentz diff --git a/master/_sources/upcoming_release_notes/1292-recoving_sp1k4-att_targets.rst.txt b/master/_sources/upcoming_release_notes/1292-recoving_sp1k4-att_targets.rst.txt new file mode 100644 index 00000000000..64c2261fd82 --- /dev/null +++ b/master/_sources/upcoming_release_notes/1292-recoving_sp1k4-att_targets.rst.txt @@ -0,0 +1,30 @@ +1292 recoving sp1k4-att targets +################# + +API Breaks +---------- +- N/A + +Library Features +---------------- +- N/A + +Device Features +--------------- +- recover sp1k4 attenuator targets number from 3 to 5 + +New Devices +----------- +- N/A + +Bugfixes +-------- +- N/A + +Maintenance +----------- +- N/A + +Contributors +------------ +- tongju12 diff --git a/master/_sources/upcoming_release_notes/1293-enh_tmo_mpod_apalis_hotfix.rst.txt b/master/_sources/upcoming_release_notes/1293-enh_tmo_mpod_apalis_hotfix.rst.txt new file mode 100644 index 00000000000..072dde002b3 --- /dev/null +++ b/master/_sources/upcoming_release_notes/1293-enh_tmo_mpod_apalis_hotfix.rst.txt @@ -0,0 +1,40 @@ +1293 enh_tmo_mpod_apalis_hotfix +############################### + +API Breaks +---------- +- N/A + +Library Features +---------------- +- N/A + +Device Features +--------------- +- Add the ``desc``, ``last_voltage_set``, and ``is_trip`` component signals to + `MPODApalisChannel`. These have been helpful during operations at TMO. + ``last_voltage_set`` will also get a ``voltage_setpoint`` alias, which is the + original name as used in TMO's scripts. +- Add proper control limits to `MPODApalisChannel.voltage` and `MPODApalisChannel.current`. + This will give useful errors when someone tries to put values outside of the + channel's supported range. + +New Devices +----------- +- N/A + +Bugfixes +-------- +- Fix an issue where arbitrarily large negative values were permitted to be + passed during the `MPODApalisChannel.set_voltage` method, and where + small values passed to a negative-polarity channel would jump to the + most negative value. Now, this function will clamp all values between + zero and the maximum channel voltage. + +Maintenance +----------- +- Added unit tests to cover the `MPODApalisChannel` changes. + +Contributors +------------ +- zllentz diff --git a/master/_sources/upcoming_release_notes/1295-ffmirror-states.rst.txt b/master/_sources/upcoming_release_notes/1295-ffmirror-states.rst.txt new file mode 100644 index 00000000000..323215592f4 --- /dev/null +++ b/master/_sources/upcoming_release_notes/1295-ffmirror-states.rst.txt @@ -0,0 +1,31 @@ +1295 ffmirror-states +################# + +API Breaks +---------- +- N/A + +Library Features +---------------- +- N/A + +Device Features +--------------- +- `FFMirror` gets `coating` a `TwinCATMirrorStripe` +- `FFMirrorZ` inherits these and sets them `None` + +New Devices +----------- +- N/A + +Bugfixes +-------- +- N/A + +Maintenance +----------- +- N/A + +Contributors +------------ +- nrwslac diff --git a/master/_sources/upcoming_release_notes/1297-avgsignal_trigger.rst.txt b/master/_sources/upcoming_release_notes/1297-avgsignal_trigger.rst.txt new file mode 100644 index 00000000000..b232258ade8 --- /dev/null +++ b/master/_sources/upcoming_release_notes/1297-avgsignal_trigger.rst.txt @@ -0,0 +1,35 @@ +1297 avgsignal_trigger +###################### + +API Breaks +---------- +- N/A + +Library Features +---------------- +- Add the capability for `AvgSignal` to reset itself on trigger, + then wait a duration before marking the trigger as complete. + This lets you use `AvgSignal` in a bluesky plan as a way to + accumulate the time average of a fast-updating signal at each + scan point. To enable this, provide a ``duration`` argument. + +Device Features +--------------- +- N/A + +New Devices +----------- +- N/A + +Bugfixes +-------- +- N/A + +Maintenance +----------- +- Add unit tests for the new `AvgSignal` features. + +Contributors +------------ +- mseaberg +- zllentz diff --git a/master/_sources/upcoming_release_notes/1301-enh_config_las_timing.rst.txt b/master/_sources/upcoming_release_notes/1301-enh_config_las_timing.rst.txt new file mode 100644 index 00000000000..9eb0981851e --- /dev/null +++ b/master/_sources/upcoming_release_notes/1301-enh_config_las_timing.rst.txt @@ -0,0 +1,31 @@ +1301 enh_config_las_timing +########################## + +API Breaks +---------- +- N/A + +Library Features +---------------- +- N/A + +Device Features +--------------- +- Allow init-time configuration of phase shifter inversion and setpoint limits + for `LaserTiming` and `LCLS2LaserTiming` devices. + +New Devices +----------- +- N/A + +Bugfixes +-------- +- N/A + +Maintenance +----------- +- N/A + +Contributors +------------ +- zllentz diff --git a/master/_sources/upcoming_release_notes/1303-PowerMeter_responsivity_update.rst.txt b/master/_sources/upcoming_release_notes/1303-PowerMeter_responsivity_update.rst.txt new file mode 100644 index 00000000000..1fa8c6da6f9 --- /dev/null +++ b/master/_sources/upcoming_release_notes/1303-PowerMeter_responsivity_update.rst.txt @@ -0,0 +1,31 @@ +1303 PowerMeter_responsivity_update +################# + +API Breaks +---------- +- N/A + +Library Features +---------------- +- Added the ability to add custom units for convert_unit with a unit test + +Device Features +--------------- +- Added calibrated_uj and manual_in_progress +- Renamed manual-collections components to have manual in their name to distinguish them from auto-background collection + +New Devices +----------- +- N/A + +Bugfixes +-------- +- Made responsivity component input only like the pytmc pragma so the connection does not fail when looking for the non-RBV pv + +Maintenance +----------- +- N/A + +Contributors +------------ +- KaushikMalapati diff --git a/master/_sources/upcoming_release_notes/1304-chin-rtds.rst.txt b/master/_sources/upcoming_release_notes/1304-chin-rtds.rst.txt new file mode 100644 index 00000000000..1095ecad5f1 --- /dev/null +++ b/master/_sources/upcoming_release_notes/1304-chin-rtds.rst.txt @@ -0,0 +1,31 @@ +1304 chin-rtds +################# + +API Breaks +---------- +- `FFMirrorZ` components `chin_left_rtd`, `chin_right_rtd`, and `chin_tail_rtd` are renamed: `mirror_temp_[l,r,tail]`. + +Library Features +---------------- +- N/A + +Device Features +--------------- +- `KBOMirrorHE` gets 2 new RTD readouts for RTDs installed on the mirror inside vaccum. + +New Devices +----------- +- N/A + +Bugfixes +-------- +- N/A + +Maintenance +----------- +- reorder `cool_flow1` and `cool_flow2` components in `KBOMirrorHE` to the end of the list. +- reorder `mirror_temp_[l,r,tail]` components in `FFMirrorZ` to align with other temperature sensors. + +Contributors +------------ +- nrwslac diff --git a/master/_sources/upcoming_release_notes/1305-Adding_one_more_target_into_TM1K4.rst.txt b/master/_sources/upcoming_release_notes/1305-Adding_one_more_target_into_TM1K4.rst.txt new file mode 100644 index 00000000000..d035cec9745 --- /dev/null +++ b/master/_sources/upcoming_release_notes/1305-Adding_one_more_target_into_TM1K4.rst.txt @@ -0,0 +1,30 @@ +1305 Adding one more target into TM1K4 +################# + +API Breaks +---------- +- N/A + +Library Features +---------------- +- N/A + +Device Features +--------------- +- adding one more target into TM1K4 + +New Devices +----------- +- N/A + +Bugfixes +-------- +- N/A + +Maintenance +----------- +- N/A + +Contributors +------------ +- @tongju12 diff --git a/master/_sources/upcoming_release_notes/1306-Fixing-imprecise-TPR-TICK-NS-constant.rst.txt b/master/_sources/upcoming_release_notes/1306-Fixing-imprecise-TPR-TICK-NS-constant.rst.txt new file mode 100644 index 00000000000..6fb737af9b0 --- /dev/null +++ b/master/_sources/upcoming_release_notes/1306-Fixing-imprecise-TPR-TICK-NS-constant.rst.txt @@ -0,0 +1,31 @@ +1306 Fixing-imprecise-TPR-TICK-NS-constant +################# + +API Breaks +---------- +- N/A + +Library Features +---------------- +- N/A + +Device Features +--------------- +- N/A + +New Devices +----------- +- N/A + +Bugfixes +-------- +- _get_delay, and by extension TprMotor.readback.get() and TprTrigger.ns_delay.get() will no longer calculate wrong delays +because TPR_TICK_NS is now set to the "exact" 70/13 instead of the approximate 5.384. + +Maintenance +----------- +- N/A + +Contributors +------------ +- KaushikMalapati diff --git a/master/_sources/upcoming_release_notes/848-create_new_VCNOpenLoop_device_class.rst.txt b/master/_sources/upcoming_release_notes/848-create_new_VCNOpenLoop_device_class.rst.txt new file mode 100644 index 00000000000..02570d047fd --- /dev/null +++ b/master/_sources/upcoming_release_notes/848-create_new_VCNOpenLoop_device_class.rst.txt @@ -0,0 +1,32 @@ +848 create new VCN_OpenLoop device class +################# + +API Breaks +---------- +- N/A + +Library Features +---------------- +- N/A + +Device Features +--------------- +- N/A + +New Devices +----------- +- VCN_OpenLoop: similar to VCN w/ the removal of 'open' and 'position_readback' + commands. The 'state' member variable has been renamed to 'control_mode' and + the associated doc string was been updated. + +Bugfixes +-------- +- N/A + +Maintenance +----------- +- N/A + +Contributors +------------ +- jozamudi diff --git a/master/_static/css/badge_only.css b/master/_static/css/badge_only.css index c718cee4418..88ba55b965c 100644 --- a/master/_static/css/badge_only.css +++ b/master/_static/css/badge_only.css @@ -1 +1 @@ -.clearfix{*zoom:1}.clearfix:after,.clearfix:before{display:table;content:""}.clearfix:after{clear:both}@font-face{font-family:FontAwesome;font-style:normal;font-weight:400;src:url(fonts/fontawesome-webfont.eot?674f50d287a8c48dc19ba404d20fe713?#iefix) format("embedded-opentype"),url(fonts/fontawesome-webfont.woff2?af7ae505a9eed503f8b8e6982036873e) format("woff2"),url(fonts/fontawesome-webfont.woff?fee66e712a8a08eef5805a46892932ad) format("woff"),url(fonts/fontawesome-webfont.ttf?b06871f281fee6b241d60582ae9369b9) format("truetype"),url(fonts/fontawesome-webfont.svg?912ec66d7572ff821749319396470bde#FontAwesome) format("svg")}.fa:before{font-family:FontAwesome;font-style:normal;font-weight:400;line-height:1}.fa:before,a .fa{text-decoration:inherit}.fa:before,a .fa,li .fa{display:inline-block}li .fa-large:before{width:1.875em}ul.fas{list-style-type:none;margin-left:2em;text-indent:-.8em}ul.fas li .fa{width:.8em}ul.fas li .fa-large:before{vertical-align:baseline}.fa-book:before,.icon-book:before{content:"\f02d"}.fa-caret-down:before,.icon-caret-down:before{content:"\f0d7"}.fa-caret-up:before,.icon-caret-up:before{content:"\f0d8"}.fa-caret-left:before,.icon-caret-left:before{content:"\f0d9"}.fa-caret-right:before,.icon-caret-right:before{content:"\f0da"}.rst-versions{position:fixed;bottom:0;left:0;width:300px;color:#fcfcfc;background:#1f1d1d;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;z-index:400}.rst-versions a{color:#2980b9;text-decoration:none}.rst-versions .rst-badge-small{display:none}.rst-versions .rst-current-version{padding:12px;background-color:#272525;display:block;text-align:right;font-size:90%;cursor:pointer;color:#27ae60}.rst-versions .rst-current-version:after{clear:both;content:"";display:block}.rst-versions .rst-current-version .fa{color:#fcfcfc}.rst-versions .rst-current-version .fa-book,.rst-versions .rst-current-version .icon-book{float:left}.rst-versions .rst-current-version.rst-out-of-date{background-color:#e74c3c;color:#fff}.rst-versions .rst-current-version.rst-active-old-version{background-color:#f1c40f;color:#000}.rst-versions.shift-up{height:auto;max-height:100%;overflow-y:scroll}.rst-versions.shift-up .rst-other-versions{display:block}.rst-versions .rst-other-versions{font-size:90%;padding:12px;color:grey;display:none}.rst-versions .rst-other-versions hr{display:block;height:1px;border:0;margin:20px 0;padding:0;border-top:1px solid #413d3d}.rst-versions .rst-other-versions dd{display:inline-block;margin:0}.rst-versions .rst-other-versions dd a{display:inline-block;padding:6px;color:#fcfcfc}.rst-versions.rst-badge{width:auto;bottom:20px;right:20px;left:auto;border:none;max-width:300px;max-height:90%}.rst-versions.rst-badge .fa-book,.rst-versions.rst-badge .icon-book{float:none;line-height:30px}.rst-versions.rst-badge.shift-up .rst-current-version{text-align:right}.rst-versions.rst-badge.shift-up .rst-current-version .fa-book,.rst-versions.rst-badge.shift-up .rst-current-version .icon-book{float:left}.rst-versions.rst-badge>.rst-current-version{width:auto;height:30px;line-height:30px;padding:0 6px;display:block;text-align:center}@media screen and (max-width:768px){.rst-versions{width:85%;display:none}.rst-versions.shift{display:block}} \ No newline at end of file +.clearfix{*zoom:1}.clearfix:after,.clearfix:before{display:table;content:""}.clearfix:after{clear:both}@font-face{font-family:FontAwesome;font-style:normal;font-weight:400;src:url(fonts/fontawesome-webfont.eot?674f50d287a8c48dc19ba404d20fe713?#iefix) format("embedded-opentype"),url(fonts/fontawesome-webfont.woff2?af7ae505a9eed503f8b8e6982036873e) format("woff2"),url(fonts/fontawesome-webfont.woff?fee66e712a8a08eef5805a46892932ad) format("woff"),url(fonts/fontawesome-webfont.ttf?b06871f281fee6b241d60582ae9369b9) format("truetype"),url(fonts/fontawesome-webfont.svg?912ec66d7572ff821749319396470bde#FontAwesome) format("svg")}.fa:before{font-family:FontAwesome;font-style:normal;font-weight:400;line-height:1}.fa:before,a .fa{text-decoration:inherit}.fa:before,a .fa,li .fa{display:inline-block}li .fa-large:before{width:1.875em}ul.fas{list-style-type:none;margin-left:2em;text-indent:-.8em}ul.fas li .fa{width:.8em}ul.fas li .fa-large:before{vertical-align:baseline}.fa-book:before,.icon-book:before{content:"\f02d"}.fa-caret-down:before,.icon-caret-down:before{content:"\f0d7"}.fa-caret-up:before,.icon-caret-up:before{content:"\f0d8"}.fa-caret-left:before,.icon-caret-left:before{content:"\f0d9"}.fa-caret-right:before,.icon-caret-right:before{content:"\f0da"}.rst-versions{position:fixed;bottom:0;left:0;width:300px;color:#fcfcfc;background:#1f1d1d;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;z-index:400}.rst-versions a{color:#2980b9;text-decoration:none}.rst-versions .rst-badge-small{display:none}.rst-versions .rst-current-version{padding:12px;background-color:#272525;display:block;text-align:right;font-size:90%;cursor:pointer;color:#27ae60}.rst-versions .rst-current-version:after{clear:both;content:"";display:block}.rst-versions .rst-current-version .fa{color:#fcfcfc}.rst-versions .rst-current-version .fa-book,.rst-versions .rst-current-version .icon-book{float:left}.rst-versions .rst-current-version.rst-out-of-date{background-color:#e74c3c;color:#fff}.rst-versions .rst-current-version.rst-active-old-version{background-color:#f1c40f;color:#000}.rst-versions.shift-up{height:auto;max-height:100%;overflow-y:scroll}.rst-versions.shift-up .rst-other-versions{display:block}.rst-versions .rst-other-versions{font-size:90%;padding:12px;color:grey;display:none}.rst-versions .rst-other-versions hr{display:block;height:1px;border:0;margin:20px 0;padding:0;border-top:1px solid #413d3d}.rst-versions .rst-other-versions dd{display:inline-block;margin:0}.rst-versions .rst-other-versions dd a{display:inline-block;padding:6px;color:#fcfcfc}.rst-versions .rst-other-versions .rtd-current-item{font-weight:700}.rst-versions.rst-badge{width:auto;bottom:20px;right:20px;left:auto;border:none;max-width:300px;max-height:90%}.rst-versions.rst-badge .fa-book,.rst-versions.rst-badge .icon-book{float:none;line-height:30px}.rst-versions.rst-badge.shift-up .rst-current-version{text-align:right}.rst-versions.rst-badge.shift-up .rst-current-version .fa-book,.rst-versions.rst-badge.shift-up .rst-current-version .icon-book{float:left}.rst-versions.rst-badge>.rst-current-version{width:auto;height:30px;line-height:30px;padding:0 6px;display:block;text-align:center}@media screen and (max-width:768px){.rst-versions{width:85%;display:none}.rst-versions.shift{display:block}}#flyout-search-form{padding:6px} \ No newline at end of file diff --git a/master/_static/css/theme.css b/master/_static/css/theme.css index 19a446a0e70..0f14f106460 100644 --- a/master/_static/css/theme.css +++ b/master/_static/css/theme.css @@ -1,4 +1,4 @@ html{box-sizing:border-box}*,:after,:before{box-sizing:inherit}article,aside,details,figcaption,figure,footer,header,hgroup,nav,section{display:block}audio,canvas,video{display:inline-block;*display:inline;*zoom:1}[hidden],audio:not([controls]){display:none}*{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box}html{font-size:100%;-webkit-text-size-adjust:100%;-ms-text-size-adjust:100%}body{margin:0}a:active,a:hover{outline:0}abbr[title]{border-bottom:1px dotted}b,strong{font-weight:700}blockquote{margin:0}dfn{font-style:italic}ins{background:#ff9;text-decoration:none}ins,mark{color:#000}mark{background:#ff0;font-style:italic;font-weight:700}.rst-content code,.rst-content tt,code,kbd,pre,samp{font-family:monospace,serif;_font-family:courier new,monospace;font-size:1em}pre{white-space:pre}q{quotes:none}q:after,q:before{content:"";content:none}small{font-size:85%}sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline}sup{top:-.5em}sub{bottom:-.25em}dl,ol,ul{margin:0;padding:0;list-style:none;list-style-image:none}li{list-style:none}dd{margin:0}img{border:0;-ms-interpolation-mode:bicubic;vertical-align:middle;max-width:100%}svg:not(:root){overflow:hidden}figure,form{margin:0}label{cursor:pointer}button,input,select,textarea{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle}button,input{line-height:normal}button,input[type=button],input[type=reset],input[type=submit]{cursor:pointer;-webkit-appearance:button;*overflow:visible}button[disabled],input[disabled]{cursor:default}input[type=search]{-webkit-appearance:textfield;-moz-box-sizing:content-box;-webkit-box-sizing:content-box;box-sizing:content-box}textarea{resize:vertical}table{border-collapse:collapse;border-spacing:0}td{vertical-align:top}.chromeframe{margin:.2em 0;background:#ccc;color:#000;padding:.2em 0}.ir{display:block;border:0;text-indent:-999em;overflow:hidden;background-color:transparent;background-repeat:no-repeat;text-align:left;direction:ltr;*line-height:0}.ir br{display:none}.hidden{display:none!important;visibility:hidden}.visuallyhidden{border:0;clip:rect(0 0 0 0);height:1px;margin:-1px;overflow:hidden;padding:0;position:absolute;width:1px}.visuallyhidden.focusable:active,.visuallyhidden.focusable:focus{clip:auto;height:auto;margin:0;overflow:visible;position:static;width:auto}.invisible{visibility:hidden}.relative{position:relative}big,small{font-size:100%}@media print{body,html,section{background:none!important}*{box-shadow:none!important;text-shadow:none!important;filter:none!important;-ms-filter:none!important}a,a:visited{text-decoration:underline}.ir a:after,a[href^="#"]:after,a[href^="javascript:"]:after{content:""}blockquote,pre{page-break-inside:avoid}thead{display:table-header-group}img,tr{page-break-inside:avoid}img{max-width:100%!important}@page{margin:.5cm}.rst-content .toctree-wrapper>p.caption,h2,h3,p{orphans:3;widows:3}.rst-content .toctree-wrapper>p.caption,h2,h3{page-break-after:avoid}}.btn,.fa:before,.icon:before,.rst-content .admonition,.rst-content .admonition-title:before,.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .code-block-caption .headerlink:before,.rst-content .danger,.rst-content .eqno .headerlink:before,.rst-content .error,.rst-content .hint,.rst-content .important,.rst-content .note,.rst-content .seealso,.rst-content .tip,.rst-content .warning,.rst-content code.download span:first-child:before,.rst-content dl dt .headerlink:before,.rst-content h1 .headerlink:before,.rst-content h2 .headerlink:before,.rst-content h3 .headerlink:before,.rst-content h4 .headerlink:before,.rst-content h5 .headerlink:before,.rst-content h6 .headerlink:before,.rst-content p.caption .headerlink:before,.rst-content p .headerlink:before,.rst-content table>caption .headerlink:before,.rst-content tt.download span:first-child:before,.wy-alert,.wy-dropdown .caret:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before,.wy-menu-vertical li.current>a button.toctree-expand:before,.wy-menu-vertical li.on a button.toctree-expand:before,.wy-menu-vertical li button.toctree-expand:before,input[type=color],input[type=date],input[type=datetime-local],input[type=datetime],input[type=email],input[type=month],input[type=number],input[type=password],input[type=search],input[type=tel],input[type=text],input[type=time],input[type=url],input[type=week],select,textarea{-webkit-font-smoothing:antialiased}.clearfix{*zoom:1}.clearfix:after,.clearfix:before{display:table;content:""}.clearfix:after{clear:both}/*! * Font Awesome 4.7.0 by @davegandy - http://fontawesome.io - @fontawesome * License - http://fontawesome.io/license (Font: SIL OFL 1.1, CSS: MIT License) - */@font-face{font-family:FontAwesome;src:url(fonts/fontawesome-webfont.eot?674f50d287a8c48dc19ba404d20fe713);src:url(fonts/fontawesome-webfont.eot?674f50d287a8c48dc19ba404d20fe713?#iefix&v=4.7.0) format("embedded-opentype"),url(fonts/fontawesome-webfont.woff2?af7ae505a9eed503f8b8e6982036873e) format("woff2"),url(fonts/fontawesome-webfont.woff?fee66e712a8a08eef5805a46892932ad) format("woff"),url(fonts/fontawesome-webfont.ttf?b06871f281fee6b241d60582ae9369b9) format("truetype"),url(fonts/fontawesome-webfont.svg?912ec66d7572ff821749319396470bde#fontawesomeregular) format("svg");font-weight:400;font-style:normal}.fa,.icon,.rst-content .admonition-title,.rst-content .code-block-caption .headerlink,.rst-content .eqno .headerlink,.rst-content code.download span:first-child,.rst-content dl dt .headerlink,.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content p.caption .headerlink,.rst-content p .headerlink,.rst-content table>caption .headerlink,.rst-content tt.download span:first-child,.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand,.wy-menu-vertical li button.toctree-expand{display:inline-block;font:normal normal normal 14px/1 FontAwesome;font-size:inherit;text-rendering:auto;-webkit-font-smoothing:antialiased;-moz-osx-font-smoothing:grayscale}.fa-lg{font-size:1.33333em;line-height:.75em;vertical-align:-15%}.fa-2x{font-size:2em}.fa-3x{font-size:3em}.fa-4x{font-size:4em}.fa-5x{font-size:5em}.fa-fw{width:1.28571em;text-align:center}.fa-ul{padding-left:0;margin-left:2.14286em;list-style-type:none}.fa-ul>li{position:relative}.fa-li{position:absolute;left:-2.14286em;width:2.14286em;top:.14286em;text-align:center}.fa-li.fa-lg{left:-1.85714em}.fa-border{padding:.2em .25em .15em;border:.08em solid #eee;border-radius:.1em}.fa-pull-left{float:left}.fa-pull-right{float:right}.fa-pull-left.icon,.fa.fa-pull-left,.rst-content .code-block-caption .fa-pull-left.headerlink,.rst-content .eqno .fa-pull-left.headerlink,.rst-content .fa-pull-left.admonition-title,.rst-content code.download span.fa-pull-left:first-child,.rst-content dl dt .fa-pull-left.headerlink,.rst-content h1 .fa-pull-left.headerlink,.rst-content h2 .fa-pull-left.headerlink,.rst-content h3 .fa-pull-left.headerlink,.rst-content h4 .fa-pull-left.headerlink,.rst-content h5 .fa-pull-left.headerlink,.rst-content h6 .fa-pull-left.headerlink,.rst-content p .fa-pull-left.headerlink,.rst-content table>caption .fa-pull-left.headerlink,.rst-content tt.download span.fa-pull-left:first-child,.wy-menu-vertical li.current>a button.fa-pull-left.toctree-expand,.wy-menu-vertical li.on a button.fa-pull-left.toctree-expand,.wy-menu-vertical li button.fa-pull-left.toctree-expand{margin-right:.3em}.fa-pull-right.icon,.fa.fa-pull-right,.rst-content .code-block-caption .fa-pull-right.headerlink,.rst-content .eqno .fa-pull-right.headerlink,.rst-content .fa-pull-right.admonition-title,.rst-content code.download span.fa-pull-right:first-child,.rst-content dl dt .fa-pull-right.headerlink,.rst-content h1 .fa-pull-right.headerlink,.rst-content h2 .fa-pull-right.headerlink,.rst-content h3 .fa-pull-right.headerlink,.rst-content h4 .fa-pull-right.headerlink,.rst-content h5 .fa-pull-right.headerlink,.rst-content h6 .fa-pull-right.headerlink,.rst-content p .fa-pull-right.headerlink,.rst-content table>caption .fa-pull-right.headerlink,.rst-content tt.download span.fa-pull-right:first-child,.wy-menu-vertical li.current>a button.fa-pull-right.toctree-expand,.wy-menu-vertical li.on a button.fa-pull-right.toctree-expand,.wy-menu-vertical li button.fa-pull-right.toctree-expand{margin-left:.3em}.pull-right{float:right}.pull-left{float:left}.fa.pull-left,.pull-left.icon,.rst-content .code-block-caption .pull-left.headerlink,.rst-content .eqno .pull-left.headerlink,.rst-content .pull-left.admonition-title,.rst-content code.download span.pull-left:first-child,.rst-content dl dt .pull-left.headerlink,.rst-content h1 .pull-left.headerlink,.rst-content h2 .pull-left.headerlink,.rst-content h3 .pull-left.headerlink,.rst-content h4 .pull-left.headerlink,.rst-content h5 .pull-left.headerlink,.rst-content h6 .pull-left.headerlink,.rst-content p .pull-left.headerlink,.rst-content table>caption .pull-left.headerlink,.rst-content tt.download span.pull-left:first-child,.wy-menu-vertical li.current>a button.pull-left.toctree-expand,.wy-menu-vertical li.on a button.pull-left.toctree-expand,.wy-menu-vertical li button.pull-left.toctree-expand{margin-right:.3em}.fa.pull-right,.pull-right.icon,.rst-content .code-block-caption .pull-right.headerlink,.rst-content .eqno .pull-right.headerlink,.rst-content .pull-right.admonition-title,.rst-content code.download span.pull-right:first-child,.rst-content dl dt .pull-right.headerlink,.rst-content h1 .pull-right.headerlink,.rst-content h2 .pull-right.headerlink,.rst-content h3 .pull-right.headerlink,.rst-content h4 .pull-right.headerlink,.rst-content h5 .pull-right.headerlink,.rst-content h6 .pull-right.headerlink,.rst-content p .pull-right.headerlink,.rst-content table>caption .pull-right.headerlink,.rst-content tt.download span.pull-right:first-child,.wy-menu-vertical li.current>a button.pull-right.toctree-expand,.wy-menu-vertical li.on a button.pull-right.toctree-expand,.wy-menu-vertical li button.pull-right.toctree-expand{margin-left:.3em}.fa-spin{-webkit-animation:fa-spin 2s linear infinite;animation:fa-spin 2s linear infinite}.fa-pulse{-webkit-animation:fa-spin 1s steps(8) infinite;animation:fa-spin 1s steps(8) infinite}@-webkit-keyframes fa-spin{0%{-webkit-transform:rotate(0deg);transform:rotate(0deg)}to{-webkit-transform:rotate(359deg);transform:rotate(359deg)}}@keyframes fa-spin{0%{-webkit-transform:rotate(0deg);transform:rotate(0deg)}to{-webkit-transform:rotate(359deg);transform:rotate(359deg)}}.fa-rotate-90{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=1)";-webkit-transform:rotate(90deg);-ms-transform:rotate(90deg);transform:rotate(90deg)}.fa-rotate-180{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=2)";-webkit-transform:rotate(180deg);-ms-transform:rotate(180deg);transform:rotate(180deg)}.fa-rotate-270{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=3)";-webkit-transform:rotate(270deg);-ms-transform:rotate(270deg);transform:rotate(270deg)}.fa-flip-horizontal{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=0, mirror=1)";-webkit-transform:scaleX(-1);-ms-transform:scaleX(-1);transform:scaleX(-1)}.fa-flip-vertical{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=2, mirror=1)";-webkit-transform:scaleY(-1);-ms-transform:scaleY(-1);transform:scaleY(-1)}:root .fa-flip-horizontal,:root .fa-flip-vertical,:root .fa-rotate-90,:root .fa-rotate-180,:root .fa-rotate-270{filter:none}.fa-stack{position:relative;display:inline-block;width:2em;height:2em;line-height:2em;vertical-align:middle}.fa-stack-1x,.fa-stack-2x{position:absolute;left:0;width:100%;text-align:center}.fa-stack-1x{line-height:inherit}.fa-stack-2x{font-size:2em}.fa-inverse{color:#fff}.fa-glass:before{content:""}.fa-music:before{content:""}.fa-search:before,.icon-search:before{content:""}.fa-envelope-o:before{content:""}.fa-heart:before{content:""}.fa-star:before{content:""}.fa-star-o:before{content:""}.fa-user:before{content:""}.fa-film:before{content:""}.fa-th-large:before{content:""}.fa-th:before{content:""}.fa-th-list:before{content:""}.fa-check:before{content:""}.fa-close:before,.fa-remove:before,.fa-times:before{content:""}.fa-search-plus:before{content:""}.fa-search-minus:before{content:""}.fa-power-off:before{content:""}.fa-signal:before{content:""}.fa-cog:before,.fa-gear:before{content:""}.fa-trash-o:before{content:""}.fa-home:before,.icon-home:before{content:""}.fa-file-o:before{content:""}.fa-clock-o:before{content:""}.fa-road:before{content:""}.fa-download:before,.rst-content code.download span:first-child:before,.rst-content tt.download span:first-child:before{content:""}.fa-arrow-circle-o-down:before{content:""}.fa-arrow-circle-o-up:before{content:""}.fa-inbox:before{content:""}.fa-play-circle-o:before{content:""}.fa-repeat:before,.fa-rotate-right:before{content:""}.fa-refresh:before{content:""}.fa-list-alt:before{content:""}.fa-lock:before{content:""}.fa-flag:before{content:""}.fa-headphones:before{content:""}.fa-volume-off:before{content:""}.fa-volume-down:before{content:""}.fa-volume-up:before{content:""}.fa-qrcode:before{content:""}.fa-barcode:before{content:""}.fa-tag:before{content:""}.fa-tags:before{content:""}.fa-book:before,.icon-book:before{content:""}.fa-bookmark:before{content:""}.fa-print:before{content:""}.fa-camera:before{content:""}.fa-font:before{content:""}.fa-bold:before{content:""}.fa-italic:before{content:""}.fa-text-height:before{content:""}.fa-text-width:before{content:""}.fa-align-left:before{content:""}.fa-align-center:before{content:""}.fa-align-right:before{content:""}.fa-align-justify:before{content:""}.fa-list:before{content:""}.fa-dedent:before,.fa-outdent:before{content:""}.fa-indent:before{content:""}.fa-video-camera:before{content:""}.fa-image:before,.fa-photo:before,.fa-picture-o:before{content:""}.fa-pencil:before{content:""}.fa-map-marker:before{content:""}.fa-adjust:before{content:""}.fa-tint:before{content:""}.fa-edit:before,.fa-pencil-square-o:before{content:""}.fa-share-square-o:before{content:""}.fa-check-square-o:before{content:""}.fa-arrows:before{content:""}.fa-step-backward:before{content:""}.fa-fast-backward:before{content:""}.fa-backward:before{content:""}.fa-play:before{content:""}.fa-pause:before{content:""}.fa-stop:before{content:""}.fa-forward:before{content:""}.fa-fast-forward:before{content:""}.fa-step-forward:before{content:""}.fa-eject:before{content:""}.fa-chevron-left:before{content:""}.fa-chevron-right:before{content:""}.fa-plus-circle:before{content:""}.fa-minus-circle:before{content:""}.fa-times-circle:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before{content:""}.fa-check-circle:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before{content:""}.fa-question-circle:before{content:""}.fa-info-circle:before{content:""}.fa-crosshairs:before{content:""}.fa-times-circle-o:before{content:""}.fa-check-circle-o:before{content:""}.fa-ban:before{content:""}.fa-arrow-left:before{content:""}.fa-arrow-right:before{content:""}.fa-arrow-up:before{content:""}.fa-arrow-down:before{content:""}.fa-mail-forward:before,.fa-share:before{content:""}.fa-expand:before{content:""}.fa-compress:before{content:""}.fa-plus:before{content:""}.fa-minus:before{content:""}.fa-asterisk:before{content:""}.fa-exclamation-circle:before,.rst-content .admonition-title:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before{content:""}.fa-gift:before{content:""}.fa-leaf:before{content:""}.fa-fire:before,.icon-fire:before{content:""}.fa-eye:before{content:""}.fa-eye-slash:before{content:""}.fa-exclamation-triangle:before,.fa-warning:before{content:""}.fa-plane:before{content:""}.fa-calendar:before{content:""}.fa-random:before{content:""}.fa-comment:before{content:""}.fa-magnet:before{content:""}.fa-chevron-up:before{content:""}.fa-chevron-down:before{content:""}.fa-retweet:before{content:""}.fa-shopping-cart:before{content:""}.fa-folder:before{content:""}.fa-folder-open:before{content:""}.fa-arrows-v:before{content:""}.fa-arrows-h:before{content:""}.fa-bar-chart-o:before,.fa-bar-chart:before{content:""}.fa-twitter-square:before{content:""}.fa-facebook-square:before{content:""}.fa-camera-retro:before{content:""}.fa-key:before{content:""}.fa-cogs:before,.fa-gears:before{content:""}.fa-comments:before{content:""}.fa-thumbs-o-up:before{content:""}.fa-thumbs-o-down:before{content:""}.fa-star-half:before{content:""}.fa-heart-o:before{content:""}.fa-sign-out:before{content:""}.fa-linkedin-square:before{content:""}.fa-thumb-tack:before{content:""}.fa-external-link:before{content:""}.fa-sign-in:before{content:""}.fa-trophy:before{content:""}.fa-github-square:before{content:""}.fa-upload:before{content:""}.fa-lemon-o:before{content:""}.fa-phone:before{content:""}.fa-square-o:before{content:""}.fa-bookmark-o:before{content:""}.fa-phone-square:before{content:""}.fa-twitter:before{content:""}.fa-facebook-f:before,.fa-facebook:before{content:""}.fa-github:before,.icon-github:before{content:""}.fa-unlock:before{content:""}.fa-credit-card:before{content:""}.fa-feed:before,.fa-rss:before{content:""}.fa-hdd-o:before{content:""}.fa-bullhorn:before{content:""}.fa-bell:before{content:""}.fa-certificate:before{content:""}.fa-hand-o-right:before{content:""}.fa-hand-o-left:before{content:""}.fa-hand-o-up:before{content:""}.fa-hand-o-down:before{content:""}.fa-arrow-circle-left:before,.icon-circle-arrow-left:before{content:""}.fa-arrow-circle-right:before,.icon-circle-arrow-right:before{content:""}.fa-arrow-circle-up:before{content:""}.fa-arrow-circle-down:before{content:""}.fa-globe:before{content:""}.fa-wrench:before{content:""}.fa-tasks:before{content:""}.fa-filter:before{content:""}.fa-briefcase:before{content:""}.fa-arrows-alt:before{content:""}.fa-group:before,.fa-users:before{content:""}.fa-chain:before,.fa-link:before,.icon-link:before{content:""}.fa-cloud:before{content:""}.fa-flask:before{content:""}.fa-cut:before,.fa-scissors:before{content:""}.fa-copy:before,.fa-files-o:before{content:""}.fa-paperclip:before{content:""}.fa-floppy-o:before,.fa-save:before{content:""}.fa-square:before{content:""}.fa-bars:before,.fa-navicon:before,.fa-reorder:before{content:""}.fa-list-ul:before{content:""}.fa-list-ol:before{content:""}.fa-strikethrough:before{content:""}.fa-underline:before{content:""}.fa-table:before{content:""}.fa-magic:before{content:""}.fa-truck:before{content:""}.fa-pinterest:before{content:""}.fa-pinterest-square:before{content:""}.fa-google-plus-square:before{content:""}.fa-google-plus:before{content:""}.fa-money:before{content:""}.fa-caret-down:before,.icon-caret-down:before,.wy-dropdown .caret:before{content:""}.fa-caret-up:before{content:""}.fa-caret-left:before{content:""}.fa-caret-right:before{content:""}.fa-columns:before{content:""}.fa-sort:before,.fa-unsorted:before{content:""}.fa-sort-desc:before,.fa-sort-down:before{content:""}.fa-sort-asc:before,.fa-sort-up:before{content:""}.fa-envelope:before{content:""}.fa-linkedin:before{content:""}.fa-rotate-left:before,.fa-undo:before{content:""}.fa-gavel:before,.fa-legal:before{content:""}.fa-dashboard:before,.fa-tachometer:before{content:""}.fa-comment-o:before{content:""}.fa-comments-o:before{content:""}.fa-bolt:before,.fa-flash:before{content:""}.fa-sitemap:before{content:""}.fa-umbrella:before{content:""}.fa-clipboard:before,.fa-paste:before{content:""}.fa-lightbulb-o:before{content:""}.fa-exchange:before{content:""}.fa-cloud-download:before{content:""}.fa-cloud-upload:before{content:""}.fa-user-md:before{content:""}.fa-stethoscope:before{content:""}.fa-suitcase:before{content:""}.fa-bell-o:before{content:""}.fa-coffee:before{content:""}.fa-cutlery:before{content:""}.fa-file-text-o:before{content:""}.fa-building-o:before{content:""}.fa-hospital-o:before{content:""}.fa-ambulance:before{content:""}.fa-medkit:before{content:""}.fa-fighter-jet:before{content:""}.fa-beer:before{content:""}.fa-h-square:before{content:""}.fa-plus-square:before{content:""}.fa-angle-double-left:before{content:""}.fa-angle-double-right:before{content:""}.fa-angle-double-up:before{content:""}.fa-angle-double-down:before{content:""}.fa-angle-left:before{content:""}.fa-angle-right:before{content:""}.fa-angle-up:before{content:""}.fa-angle-down:before{content:""}.fa-desktop:before{content:""}.fa-laptop:before{content:""}.fa-tablet:before{content:""}.fa-mobile-phone:before,.fa-mobile:before{content:""}.fa-circle-o:before{content:""}.fa-quote-left:before{content:""}.fa-quote-right:before{content:""}.fa-spinner:before{content:""}.fa-circle:before{content:""}.fa-mail-reply:before,.fa-reply:before{content:""}.fa-github-alt:before{content:""}.fa-folder-o:before{content:""}.fa-folder-open-o:before{content:""}.fa-smile-o:before{content:""}.fa-frown-o:before{content:""}.fa-meh-o:before{content:""}.fa-gamepad:before{content:""}.fa-keyboard-o:before{content:""}.fa-flag-o:before{content:""}.fa-flag-checkered:before{content:""}.fa-terminal:before{content:""}.fa-code:before{content:""}.fa-mail-reply-all:before,.fa-reply-all:before{content:""}.fa-star-half-empty:before,.fa-star-half-full:before,.fa-star-half-o:before{content:""}.fa-location-arrow:before{content:""}.fa-crop:before{content:""}.fa-code-fork:before{content:""}.fa-chain-broken:before,.fa-unlink:before{content:""}.fa-question:before{content:""}.fa-info:before{content:""}.fa-exclamation:before{content:""}.fa-superscript:before{content:""}.fa-subscript:before{content:""}.fa-eraser:before{content:""}.fa-puzzle-piece:before{content:""}.fa-microphone:before{content:""}.fa-microphone-slash:before{content:""}.fa-shield:before{content:""}.fa-calendar-o:before{content:""}.fa-fire-extinguisher:before{content:""}.fa-rocket:before{content:""}.fa-maxcdn:before{content:""}.fa-chevron-circle-left:before{content:""}.fa-chevron-circle-right:before{content:""}.fa-chevron-circle-up:before{content:""}.fa-chevron-circle-down:before{content:""}.fa-html5:before{content:""}.fa-css3:before{content:""}.fa-anchor:before{content:""}.fa-unlock-alt:before{content:""}.fa-bullseye:before{content:""}.fa-ellipsis-h:before{content:""}.fa-ellipsis-v:before{content:""}.fa-rss-square:before{content:""}.fa-play-circle:before{content:""}.fa-ticket:before{content:""}.fa-minus-square:before{content:""}.fa-minus-square-o:before,.wy-menu-vertical li.current>a button.toctree-expand:before,.wy-menu-vertical li.on a button.toctree-expand:before{content:""}.fa-level-up:before{content:""}.fa-level-down:before{content:""}.fa-check-square:before{content:""}.fa-pencil-square:before{content:""}.fa-external-link-square:before{content:""}.fa-share-square:before{content:""}.fa-compass:before{content:""}.fa-caret-square-o-down:before,.fa-toggle-down:before{content:""}.fa-caret-square-o-up:before,.fa-toggle-up:before{content:""}.fa-caret-square-o-right:before,.fa-toggle-right:before{content:""}.fa-eur:before,.fa-euro:before{content:""}.fa-gbp:before{content:""}.fa-dollar:before,.fa-usd:before{content:""}.fa-inr:before,.fa-rupee:before{content:""}.fa-cny:before,.fa-jpy:before,.fa-rmb:before,.fa-yen:before{content:""}.fa-rouble:before,.fa-rub:before,.fa-ruble:before{content:""}.fa-krw:before,.fa-won:before{content:""}.fa-bitcoin:before,.fa-btc:before{content:""}.fa-file:before{content:""}.fa-file-text:before{content:""}.fa-sort-alpha-asc:before{content:""}.fa-sort-alpha-desc:before{content:""}.fa-sort-amount-asc:before{content:""}.fa-sort-amount-desc:before{content:""}.fa-sort-numeric-asc:before{content:""}.fa-sort-numeric-desc:before{content:""}.fa-thumbs-up:before{content:""}.fa-thumbs-down:before{content:""}.fa-youtube-square:before{content:""}.fa-youtube:before{content:""}.fa-xing:before{content:""}.fa-xing-square:before{content:""}.fa-youtube-play:before{content:""}.fa-dropbox:before{content:""}.fa-stack-overflow:before{content:""}.fa-instagram:before{content:""}.fa-flickr:before{content:""}.fa-adn:before{content:""}.fa-bitbucket:before,.icon-bitbucket:before{content:""}.fa-bitbucket-square:before{content:""}.fa-tumblr:before{content:""}.fa-tumblr-square:before{content:""}.fa-long-arrow-down:before{content:""}.fa-long-arrow-up:before{content:""}.fa-long-arrow-left:before{content:""}.fa-long-arrow-right:before{content:""}.fa-apple:before{content:""}.fa-windows:before{content:""}.fa-android:before{content:""}.fa-linux:before{content:""}.fa-dribbble:before{content:""}.fa-skype:before{content:""}.fa-foursquare:before{content:""}.fa-trello:before{content:""}.fa-female:before{content:""}.fa-male:before{content:""}.fa-gittip:before,.fa-gratipay:before{content:""}.fa-sun-o:before{content:""}.fa-moon-o:before{content:""}.fa-archive:before{content:""}.fa-bug:before{content:""}.fa-vk:before{content:""}.fa-weibo:before{content:""}.fa-renren:before{content:""}.fa-pagelines:before{content:""}.fa-stack-exchange:before{content:""}.fa-arrow-circle-o-right:before{content:""}.fa-arrow-circle-o-left:before{content:""}.fa-caret-square-o-left:before,.fa-toggle-left:before{content:""}.fa-dot-circle-o:before{content:""}.fa-wheelchair:before{content:""}.fa-vimeo-square:before{content:""}.fa-try:before,.fa-turkish-lira:before{content:""}.fa-plus-square-o:before,.wy-menu-vertical li button.toctree-expand:before{content:""}.fa-space-shuttle:before{content:""}.fa-slack:before{content:""}.fa-envelope-square:before{content:""}.fa-wordpress:before{content:""}.fa-openid:before{content:""}.fa-bank:before,.fa-institution:before,.fa-university:before{content:""}.fa-graduation-cap:before,.fa-mortar-board:before{content:""}.fa-yahoo:before{content:""}.fa-google:before{content:""}.fa-reddit:before{content:""}.fa-reddit-square:before{content:""}.fa-stumbleupon-circle:before{content:""}.fa-stumbleupon:before{content:""}.fa-delicious:before{content:""}.fa-digg:before{content:""}.fa-pied-piper-pp:before{content:""}.fa-pied-piper-alt:before{content:""}.fa-drupal:before{content:""}.fa-joomla:before{content:""}.fa-language:before{content:""}.fa-fax:before{content:""}.fa-building:before{content:""}.fa-child:before{content:""}.fa-paw:before{content:""}.fa-spoon:before{content:""}.fa-cube:before{content:""}.fa-cubes:before{content:""}.fa-behance:before{content:""}.fa-behance-square:before{content:""}.fa-steam:before{content:""}.fa-steam-square:before{content:""}.fa-recycle:before{content:""}.fa-automobile:before,.fa-car:before{content:""}.fa-cab:before,.fa-taxi:before{content:""}.fa-tree:before{content:""}.fa-spotify:before{content:""}.fa-deviantart:before{content:""}.fa-soundcloud:before{content:""}.fa-database:before{content:""}.fa-file-pdf-o:before{content:""}.fa-file-word-o:before{content:""}.fa-file-excel-o:before{content:""}.fa-file-powerpoint-o:before{content:""}.fa-file-image-o:before,.fa-file-photo-o:before,.fa-file-picture-o:before{content:""}.fa-file-archive-o:before,.fa-file-zip-o:before{content:""}.fa-file-audio-o:before,.fa-file-sound-o:before{content:""}.fa-file-movie-o:before,.fa-file-video-o:before{content:""}.fa-file-code-o:before{content:""}.fa-vine:before{content:""}.fa-codepen:before{content:""}.fa-jsfiddle:before{content:""}.fa-life-bouy:before,.fa-life-buoy:before,.fa-life-ring:before,.fa-life-saver:before,.fa-support:before{content:""}.fa-circle-o-notch:before{content:""}.fa-ra:before,.fa-rebel:before,.fa-resistance:before{content:""}.fa-empire:before,.fa-ge:before{content:""}.fa-git-square:before{content:""}.fa-git:before{content:""}.fa-hacker-news:before,.fa-y-combinator-square:before,.fa-yc-square:before{content:""}.fa-tencent-weibo:before{content:""}.fa-qq:before{content:""}.fa-wechat:before,.fa-weixin:before{content:""}.fa-paper-plane:before,.fa-send:before{content:""}.fa-paper-plane-o:before,.fa-send-o:before{content:""}.fa-history:before{content:""}.fa-circle-thin:before{content:""}.fa-header:before{content:""}.fa-paragraph:before{content:""}.fa-sliders:before{content:""}.fa-share-alt:before{content:""}.fa-share-alt-square:before{content:""}.fa-bomb:before{content:""}.fa-futbol-o:before,.fa-soccer-ball-o:before{content:""}.fa-tty:before{content:""}.fa-binoculars:before{content:""}.fa-plug:before{content:""}.fa-slideshare:before{content:""}.fa-twitch:before{content:""}.fa-yelp:before{content:""}.fa-newspaper-o:before{content:""}.fa-wifi:before{content:""}.fa-calculator:before{content:""}.fa-paypal:before{content:""}.fa-google-wallet:before{content:""}.fa-cc-visa:before{content:""}.fa-cc-mastercard:before{content:""}.fa-cc-discover:before{content:""}.fa-cc-amex:before{content:""}.fa-cc-paypal:before{content:""}.fa-cc-stripe:before{content:""}.fa-bell-slash:before{content:""}.fa-bell-slash-o:before{content:""}.fa-trash:before{content:""}.fa-copyright:before{content:""}.fa-at:before{content:""}.fa-eyedropper:before{content:""}.fa-paint-brush:before{content:""}.fa-birthday-cake:before{content:""}.fa-area-chart:before{content:""}.fa-pie-chart:before{content:""}.fa-line-chart:before{content:""}.fa-lastfm:before{content:""}.fa-lastfm-square:before{content:""}.fa-toggle-off:before{content:""}.fa-toggle-on:before{content:""}.fa-bicycle:before{content:""}.fa-bus:before{content:""}.fa-ioxhost:before{content:""}.fa-angellist:before{content:""}.fa-cc:before{content:""}.fa-ils:before,.fa-shekel:before,.fa-sheqel:before{content:""}.fa-meanpath:before{content:""}.fa-buysellads:before{content:""}.fa-connectdevelop:before{content:""}.fa-dashcube:before{content:""}.fa-forumbee:before{content:""}.fa-leanpub:before{content:""}.fa-sellsy:before{content:""}.fa-shirtsinbulk:before{content:""}.fa-simplybuilt:before{content:""}.fa-skyatlas:before{content:""}.fa-cart-plus:before{content:""}.fa-cart-arrow-down:before{content:""}.fa-diamond:before{content:""}.fa-ship:before{content:""}.fa-user-secret:before{content:""}.fa-motorcycle:before{content:""}.fa-street-view:before{content:""}.fa-heartbeat:before{content:""}.fa-venus:before{content:""}.fa-mars:before{content:""}.fa-mercury:before{content:""}.fa-intersex:before,.fa-transgender:before{content:""}.fa-transgender-alt:before{content:""}.fa-venus-double:before{content:""}.fa-mars-double:before{content:""}.fa-venus-mars:before{content:""}.fa-mars-stroke:before{content:""}.fa-mars-stroke-v:before{content:""}.fa-mars-stroke-h:before{content:""}.fa-neuter:before{content:""}.fa-genderless:before{content:""}.fa-facebook-official:before{content:""}.fa-pinterest-p:before{content:""}.fa-whatsapp:before{content:""}.fa-server:before{content:""}.fa-user-plus:before{content:""}.fa-user-times:before{content:""}.fa-bed:before,.fa-hotel:before{content:""}.fa-viacoin:before{content:""}.fa-train:before{content:""}.fa-subway:before{content:""}.fa-medium:before{content:""}.fa-y-combinator:before,.fa-yc:before{content:""}.fa-optin-monster:before{content:""}.fa-opencart:before{content:""}.fa-expeditedssl:before{content:""}.fa-battery-4:before,.fa-battery-full:before,.fa-battery:before{content:""}.fa-battery-3:before,.fa-battery-three-quarters:before{content:""}.fa-battery-2:before,.fa-battery-half:before{content:""}.fa-battery-1:before,.fa-battery-quarter:before{content:""}.fa-battery-0:before,.fa-battery-empty:before{content:""}.fa-mouse-pointer:before{content:""}.fa-i-cursor:before{content:""}.fa-object-group:before{content:""}.fa-object-ungroup:before{content:""}.fa-sticky-note:before{content:""}.fa-sticky-note-o:before{content:""}.fa-cc-jcb:before{content:""}.fa-cc-diners-club:before{content:""}.fa-clone:before{content:""}.fa-balance-scale:before{content:""}.fa-hourglass-o:before{content:""}.fa-hourglass-1:before,.fa-hourglass-start:before{content:""}.fa-hourglass-2:before,.fa-hourglass-half:before{content:""}.fa-hourglass-3:before,.fa-hourglass-end:before{content:""}.fa-hourglass:before{content:""}.fa-hand-grab-o:before,.fa-hand-rock-o:before{content:""}.fa-hand-paper-o:before,.fa-hand-stop-o:before{content:""}.fa-hand-scissors-o:before{content:""}.fa-hand-lizard-o:before{content:""}.fa-hand-spock-o:before{content:""}.fa-hand-pointer-o:before{content:""}.fa-hand-peace-o:before{content:""}.fa-trademark:before{content:""}.fa-registered:before{content:""}.fa-creative-commons:before{content:""}.fa-gg:before{content:""}.fa-gg-circle:before{content:""}.fa-tripadvisor:before{content:""}.fa-odnoklassniki:before{content:""}.fa-odnoklassniki-square:before{content:""}.fa-get-pocket:before{content:""}.fa-wikipedia-w:before{content:""}.fa-safari:before{content:""}.fa-chrome:before{content:""}.fa-firefox:before{content:""}.fa-opera:before{content:""}.fa-internet-explorer:before{content:""}.fa-television:before,.fa-tv:before{content:""}.fa-contao:before{content:""}.fa-500px:before{content:""}.fa-amazon:before{content:""}.fa-calendar-plus-o:before{content:""}.fa-calendar-minus-o:before{content:""}.fa-calendar-times-o:before{content:""}.fa-calendar-check-o:before{content:""}.fa-industry:before{content:""}.fa-map-pin:before{content:""}.fa-map-signs:before{content:""}.fa-map-o:before{content:""}.fa-map:before{content:""}.fa-commenting:before{content:""}.fa-commenting-o:before{content:""}.fa-houzz:before{content:""}.fa-vimeo:before{content:""}.fa-black-tie:before{content:""}.fa-fonticons:before{content:""}.fa-reddit-alien:before{content:""}.fa-edge:before{content:""}.fa-credit-card-alt:before{content:""}.fa-codiepie:before{content:""}.fa-modx:before{content:""}.fa-fort-awesome:before{content:""}.fa-usb:before{content:""}.fa-product-hunt:before{content:""}.fa-mixcloud:before{content:""}.fa-scribd:before{content:""}.fa-pause-circle:before{content:""}.fa-pause-circle-o:before{content:""}.fa-stop-circle:before{content:""}.fa-stop-circle-o:before{content:""}.fa-shopping-bag:before{content:""}.fa-shopping-basket:before{content:""}.fa-hashtag:before{content:""}.fa-bluetooth:before{content:""}.fa-bluetooth-b:before{content:""}.fa-percent:before{content:""}.fa-gitlab:before,.icon-gitlab:before{content:""}.fa-wpbeginner:before{content:""}.fa-wpforms:before{content:""}.fa-envira:before{content:""}.fa-universal-access:before{content:""}.fa-wheelchair-alt:before{content:""}.fa-question-circle-o:before{content:""}.fa-blind:before{content:""}.fa-audio-description:before{content:""}.fa-volume-control-phone:before{content:""}.fa-braille:before{content:""}.fa-assistive-listening-systems:before{content:""}.fa-american-sign-language-interpreting:before,.fa-asl-interpreting:before{content:""}.fa-deaf:before,.fa-deafness:before,.fa-hard-of-hearing:before{content:""}.fa-glide:before{content:""}.fa-glide-g:before{content:""}.fa-sign-language:before,.fa-signing:before{content:""}.fa-low-vision:before{content:""}.fa-viadeo:before{content:""}.fa-viadeo-square:before{content:""}.fa-snapchat:before{content:""}.fa-snapchat-ghost:before{content:""}.fa-snapchat-square:before{content:""}.fa-pied-piper:before{content:""}.fa-first-order:before{content:""}.fa-yoast:before{content:""}.fa-themeisle:before{content:""}.fa-google-plus-circle:before,.fa-google-plus-official:before{content:""}.fa-fa:before,.fa-font-awesome:before{content:""}.fa-handshake-o:before{content:""}.fa-envelope-open:before{content:""}.fa-envelope-open-o:before{content:""}.fa-linode:before{content:""}.fa-address-book:before{content:""}.fa-address-book-o:before{content:""}.fa-address-card:before,.fa-vcard:before{content:""}.fa-address-card-o:before,.fa-vcard-o:before{content:""}.fa-user-circle:before{content:""}.fa-user-circle-o:before{content:""}.fa-user-o:before{content:""}.fa-id-badge:before{content:""}.fa-drivers-license:before,.fa-id-card:before{content:""}.fa-drivers-license-o:before,.fa-id-card-o:before{content:""}.fa-quora:before{content:""}.fa-free-code-camp:before{content:""}.fa-telegram:before{content:""}.fa-thermometer-4:before,.fa-thermometer-full:before,.fa-thermometer:before{content:""}.fa-thermometer-3:before,.fa-thermometer-three-quarters:before{content:""}.fa-thermometer-2:before,.fa-thermometer-half:before{content:""}.fa-thermometer-1:before,.fa-thermometer-quarter:before{content:""}.fa-thermometer-0:before,.fa-thermometer-empty:before{content:""}.fa-shower:before{content:""}.fa-bath:before,.fa-bathtub:before,.fa-s15:before{content:""}.fa-podcast:before{content:""}.fa-window-maximize:before{content:""}.fa-window-minimize:before{content:""}.fa-window-restore:before{content:""}.fa-times-rectangle:before,.fa-window-close:before{content:""}.fa-times-rectangle-o:before,.fa-window-close-o:before{content:""}.fa-bandcamp:before{content:""}.fa-grav:before{content:""}.fa-etsy:before{content:""}.fa-imdb:before{content:""}.fa-ravelry:before{content:""}.fa-eercast:before{content:""}.fa-microchip:before{content:""}.fa-snowflake-o:before{content:""}.fa-superpowers:before{content:""}.fa-wpexplorer:before{content:""}.fa-meetup:before{content:""}.sr-only{position:absolute;width:1px;height:1px;padding:0;margin:-1px;overflow:hidden;clip:rect(0,0,0,0);border:0}.sr-only-focusable:active,.sr-only-focusable:focus{position:static;width:auto;height:auto;margin:0;overflow:visible;clip:auto}.fa,.icon,.rst-content .admonition-title,.rst-content .code-block-caption .headerlink,.rst-content .eqno .headerlink,.rst-content code.download span:first-child,.rst-content dl dt .headerlink,.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content p.caption .headerlink,.rst-content p .headerlink,.rst-content table>caption .headerlink,.rst-content tt.download span:first-child,.wy-dropdown .caret,.wy-inline-validate.wy-inline-validate-danger .wy-input-context,.wy-inline-validate.wy-inline-validate-info .wy-input-context,.wy-inline-validate.wy-inline-validate-success .wy-input-context,.wy-inline-validate.wy-inline-validate-warning .wy-input-context,.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand,.wy-menu-vertical li button.toctree-expand{font-family:inherit}.fa:before,.icon:before,.rst-content .admonition-title:before,.rst-content .code-block-caption .headerlink:before,.rst-content .eqno .headerlink:before,.rst-content code.download span:first-child:before,.rst-content dl dt .headerlink:before,.rst-content h1 .headerlink:before,.rst-content h2 .headerlink:before,.rst-content h3 .headerlink:before,.rst-content h4 .headerlink:before,.rst-content h5 .headerlink:before,.rst-content h6 .headerlink:before,.rst-content p.caption .headerlink:before,.rst-content p .headerlink:before,.rst-content table>caption .headerlink:before,.rst-content tt.download span:first-child:before,.wy-dropdown .caret:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before,.wy-menu-vertical li.current>a button.toctree-expand:before,.wy-menu-vertical li.on a button.toctree-expand:before,.wy-menu-vertical li button.toctree-expand:before{font-family:FontAwesome;display:inline-block;font-style:normal;font-weight:400;line-height:1;text-decoration:inherit}.rst-content .code-block-caption a .headerlink,.rst-content .eqno a .headerlink,.rst-content a .admonition-title,.rst-content code.download a span:first-child,.rst-content dl dt a .headerlink,.rst-content h1 a .headerlink,.rst-content h2 a .headerlink,.rst-content h3 a .headerlink,.rst-content h4 a .headerlink,.rst-content h5 a .headerlink,.rst-content h6 a .headerlink,.rst-content p.caption a .headerlink,.rst-content p a .headerlink,.rst-content table>caption a .headerlink,.rst-content tt.download a span:first-child,.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand,.wy-menu-vertical li a button.toctree-expand,a .fa,a .icon,a .rst-content .admonition-title,a .rst-content .code-block-caption .headerlink,a .rst-content .eqno .headerlink,a .rst-content code.download span:first-child,a .rst-content dl dt .headerlink,a .rst-content h1 .headerlink,a .rst-content h2 .headerlink,a .rst-content h3 .headerlink,a .rst-content h4 .headerlink,a .rst-content h5 .headerlink,a .rst-content h6 .headerlink,a .rst-content p.caption .headerlink,a .rst-content p .headerlink,a .rst-content table>caption .headerlink,a .rst-content tt.download span:first-child,a .wy-menu-vertical li button.toctree-expand{display:inline-block;text-decoration:inherit}.btn .fa,.btn .icon,.btn .rst-content .admonition-title,.btn .rst-content .code-block-caption .headerlink,.btn .rst-content .eqno .headerlink,.btn .rst-content code.download span:first-child,.btn .rst-content dl dt .headerlink,.btn .rst-content h1 .headerlink,.btn .rst-content h2 .headerlink,.btn .rst-content h3 .headerlink,.btn .rst-content h4 .headerlink,.btn .rst-content h5 .headerlink,.btn .rst-content h6 .headerlink,.btn .rst-content p .headerlink,.btn .rst-content table>caption .headerlink,.btn .rst-content tt.download span:first-child,.btn .wy-menu-vertical li.current>a button.toctree-expand,.btn .wy-menu-vertical li.on a button.toctree-expand,.btn .wy-menu-vertical li button.toctree-expand,.nav .fa,.nav .icon,.nav .rst-content .admonition-title,.nav .rst-content .code-block-caption .headerlink,.nav .rst-content .eqno .headerlink,.nav .rst-content code.download span:first-child,.nav .rst-content dl dt .headerlink,.nav .rst-content h1 .headerlink,.nav .rst-content h2 .headerlink,.nav .rst-content h3 .headerlink,.nav .rst-content h4 .headerlink,.nav .rst-content h5 .headerlink,.nav .rst-content h6 .headerlink,.nav .rst-content p .headerlink,.nav .rst-content table>caption .headerlink,.nav .rst-content tt.download span:first-child,.nav .wy-menu-vertical li.current>a button.toctree-expand,.nav .wy-menu-vertical li.on a button.toctree-expand,.nav .wy-menu-vertical li button.toctree-expand,.rst-content .btn .admonition-title,.rst-content .code-block-caption .btn .headerlink,.rst-content .code-block-caption .nav .headerlink,.rst-content .eqno .btn .headerlink,.rst-content .eqno .nav .headerlink,.rst-content .nav .admonition-title,.rst-content code.download .btn span:first-child,.rst-content code.download .nav span:first-child,.rst-content dl dt .btn .headerlink,.rst-content dl dt .nav .headerlink,.rst-content h1 .btn .headerlink,.rst-content h1 .nav .headerlink,.rst-content h2 .btn .headerlink,.rst-content h2 .nav .headerlink,.rst-content h3 .btn .headerlink,.rst-content h3 .nav .headerlink,.rst-content h4 .btn .headerlink,.rst-content h4 .nav .headerlink,.rst-content h5 .btn .headerlink,.rst-content h5 .nav .headerlink,.rst-content h6 .btn .headerlink,.rst-content h6 .nav .headerlink,.rst-content p .btn .headerlink,.rst-content p .nav .headerlink,.rst-content table>caption .btn .headerlink,.rst-content table>caption .nav .headerlink,.rst-content tt.download .btn span:first-child,.rst-content tt.download .nav span:first-child,.wy-menu-vertical li .btn button.toctree-expand,.wy-menu-vertical li.current>a .btn button.toctree-expand,.wy-menu-vertical li.current>a .nav button.toctree-expand,.wy-menu-vertical li .nav button.toctree-expand,.wy-menu-vertical li.on a .btn button.toctree-expand,.wy-menu-vertical li.on a .nav button.toctree-expand{display:inline}.btn .fa-large.icon,.btn .fa.fa-large,.btn .rst-content .code-block-caption .fa-large.headerlink,.btn .rst-content .eqno .fa-large.headerlink,.btn .rst-content .fa-large.admonition-title,.btn .rst-content code.download span.fa-large:first-child,.btn .rst-content dl dt .fa-large.headerlink,.btn .rst-content h1 .fa-large.headerlink,.btn .rst-content h2 .fa-large.headerlink,.btn .rst-content h3 .fa-large.headerlink,.btn .rst-content h4 .fa-large.headerlink,.btn .rst-content h5 .fa-large.headerlink,.btn .rst-content h6 .fa-large.headerlink,.btn .rst-content p .fa-large.headerlink,.btn .rst-content table>caption .fa-large.headerlink,.btn .rst-content tt.download span.fa-large:first-child,.btn .wy-menu-vertical li button.fa-large.toctree-expand,.nav .fa-large.icon,.nav .fa.fa-large,.nav .rst-content .code-block-caption .fa-large.headerlink,.nav .rst-content .eqno .fa-large.headerlink,.nav .rst-content .fa-large.admonition-title,.nav .rst-content code.download span.fa-large:first-child,.nav .rst-content dl dt .fa-large.headerlink,.nav .rst-content h1 .fa-large.headerlink,.nav .rst-content h2 .fa-large.headerlink,.nav .rst-content h3 .fa-large.headerlink,.nav .rst-content h4 .fa-large.headerlink,.nav .rst-content h5 .fa-large.headerlink,.nav .rst-content h6 .fa-large.headerlink,.nav .rst-content p .fa-large.headerlink,.nav .rst-content table>caption .fa-large.headerlink,.nav .rst-content tt.download span.fa-large:first-child,.nav .wy-menu-vertical li button.fa-large.toctree-expand,.rst-content .btn .fa-large.admonition-title,.rst-content .code-block-caption .btn .fa-large.headerlink,.rst-content .code-block-caption .nav .fa-large.headerlink,.rst-content .eqno .btn .fa-large.headerlink,.rst-content .eqno .nav .fa-large.headerlink,.rst-content .nav .fa-large.admonition-title,.rst-content code.download .btn span.fa-large:first-child,.rst-content code.download .nav span.fa-large:first-child,.rst-content dl dt .btn .fa-large.headerlink,.rst-content dl dt .nav .fa-large.headerlink,.rst-content h1 .btn .fa-large.headerlink,.rst-content h1 .nav .fa-large.headerlink,.rst-content h2 .btn .fa-large.headerlink,.rst-content h2 .nav .fa-large.headerlink,.rst-content h3 .btn .fa-large.headerlink,.rst-content h3 .nav .fa-large.headerlink,.rst-content h4 .btn .fa-large.headerlink,.rst-content h4 .nav .fa-large.headerlink,.rst-content h5 .btn .fa-large.headerlink,.rst-content h5 .nav .fa-large.headerlink,.rst-content h6 .btn .fa-large.headerlink,.rst-content h6 .nav .fa-large.headerlink,.rst-content p .btn .fa-large.headerlink,.rst-content p .nav .fa-large.headerlink,.rst-content table>caption .btn .fa-large.headerlink,.rst-content table>caption .nav .fa-large.headerlink,.rst-content tt.download .btn span.fa-large:first-child,.rst-content tt.download .nav span.fa-large:first-child,.wy-menu-vertical li .btn button.fa-large.toctree-expand,.wy-menu-vertical li .nav button.fa-large.toctree-expand{line-height:.9em}.btn .fa-spin.icon,.btn .fa.fa-spin,.btn .rst-content .code-block-caption .fa-spin.headerlink,.btn .rst-content .eqno .fa-spin.headerlink,.btn .rst-content .fa-spin.admonition-title,.btn .rst-content code.download span.fa-spin:first-child,.btn .rst-content dl dt .fa-spin.headerlink,.btn .rst-content h1 .fa-spin.headerlink,.btn .rst-content h2 .fa-spin.headerlink,.btn .rst-content h3 .fa-spin.headerlink,.btn .rst-content h4 .fa-spin.headerlink,.btn .rst-content h5 .fa-spin.headerlink,.btn .rst-content h6 .fa-spin.headerlink,.btn .rst-content p .fa-spin.headerlink,.btn .rst-content table>caption .fa-spin.headerlink,.btn .rst-content tt.download span.fa-spin:first-child,.btn .wy-menu-vertical li button.fa-spin.toctree-expand,.nav .fa-spin.icon,.nav .fa.fa-spin,.nav .rst-content .code-block-caption .fa-spin.headerlink,.nav .rst-content .eqno .fa-spin.headerlink,.nav .rst-content .fa-spin.admonition-title,.nav .rst-content code.download span.fa-spin:first-child,.nav .rst-content dl dt .fa-spin.headerlink,.nav .rst-content h1 .fa-spin.headerlink,.nav .rst-content h2 .fa-spin.headerlink,.nav .rst-content h3 .fa-spin.headerlink,.nav .rst-content h4 .fa-spin.headerlink,.nav .rst-content h5 .fa-spin.headerlink,.nav .rst-content h6 .fa-spin.headerlink,.nav .rst-content p .fa-spin.headerlink,.nav .rst-content table>caption .fa-spin.headerlink,.nav .rst-content tt.download span.fa-spin:first-child,.nav .wy-menu-vertical li button.fa-spin.toctree-expand,.rst-content .btn .fa-spin.admonition-title,.rst-content .code-block-caption .btn .fa-spin.headerlink,.rst-content .code-block-caption .nav .fa-spin.headerlink,.rst-content .eqno .btn .fa-spin.headerlink,.rst-content .eqno .nav .fa-spin.headerlink,.rst-content .nav .fa-spin.admonition-title,.rst-content code.download .btn span.fa-spin:first-child,.rst-content code.download .nav span.fa-spin:first-child,.rst-content dl dt .btn .fa-spin.headerlink,.rst-content dl dt .nav .fa-spin.headerlink,.rst-content h1 .btn .fa-spin.headerlink,.rst-content h1 .nav .fa-spin.headerlink,.rst-content h2 .btn .fa-spin.headerlink,.rst-content h2 .nav .fa-spin.headerlink,.rst-content h3 .btn .fa-spin.headerlink,.rst-content h3 .nav .fa-spin.headerlink,.rst-content h4 .btn .fa-spin.headerlink,.rst-content h4 .nav .fa-spin.headerlink,.rst-content h5 .btn .fa-spin.headerlink,.rst-content h5 .nav .fa-spin.headerlink,.rst-content h6 .btn .fa-spin.headerlink,.rst-content h6 .nav .fa-spin.headerlink,.rst-content p .btn .fa-spin.headerlink,.rst-content p .nav .fa-spin.headerlink,.rst-content table>caption .btn .fa-spin.headerlink,.rst-content table>caption .nav .fa-spin.headerlink,.rst-content tt.download .btn span.fa-spin:first-child,.rst-content tt.download .nav span.fa-spin:first-child,.wy-menu-vertical li .btn button.fa-spin.toctree-expand,.wy-menu-vertical li .nav button.fa-spin.toctree-expand{display:inline-block}.btn.fa:before,.btn.icon:before,.rst-content .btn.admonition-title:before,.rst-content .code-block-caption .btn.headerlink:before,.rst-content .eqno .btn.headerlink:before,.rst-content code.download span.btn:first-child:before,.rst-content dl dt .btn.headerlink:before,.rst-content h1 .btn.headerlink:before,.rst-content h2 .btn.headerlink:before,.rst-content h3 .btn.headerlink:before,.rst-content h4 .btn.headerlink:before,.rst-content h5 .btn.headerlink:before,.rst-content h6 .btn.headerlink:before,.rst-content p .btn.headerlink:before,.rst-content table>caption .btn.headerlink:before,.rst-content tt.download span.btn:first-child:before,.wy-menu-vertical li button.btn.toctree-expand:before{opacity:.5;-webkit-transition:opacity .05s ease-in;-moz-transition:opacity .05s ease-in;transition:opacity .05s ease-in}.btn.fa:hover:before,.btn.icon:hover:before,.rst-content .btn.admonition-title:hover:before,.rst-content .code-block-caption .btn.headerlink:hover:before,.rst-content .eqno .btn.headerlink:hover:before,.rst-content code.download span.btn:first-child:hover:before,.rst-content dl dt .btn.headerlink:hover:before,.rst-content h1 .btn.headerlink:hover:before,.rst-content h2 .btn.headerlink:hover:before,.rst-content h3 .btn.headerlink:hover:before,.rst-content h4 .btn.headerlink:hover:before,.rst-content h5 .btn.headerlink:hover:before,.rst-content h6 .btn.headerlink:hover:before,.rst-content p .btn.headerlink:hover:before,.rst-content table>caption .btn.headerlink:hover:before,.rst-content tt.download span.btn:first-child:hover:before,.wy-menu-vertical li button.btn.toctree-expand:hover:before{opacity:1}.btn-mini .fa:before,.btn-mini .icon:before,.btn-mini .rst-content .admonition-title:before,.btn-mini .rst-content .code-block-caption .headerlink:before,.btn-mini .rst-content .eqno .headerlink:before,.btn-mini .rst-content code.download span:first-child:before,.btn-mini .rst-content dl dt .headerlink:before,.btn-mini .rst-content h1 .headerlink:before,.btn-mini .rst-content h2 .headerlink:before,.btn-mini .rst-content h3 .headerlink:before,.btn-mini .rst-content h4 .headerlink:before,.btn-mini .rst-content h5 .headerlink:before,.btn-mini .rst-content h6 .headerlink:before,.btn-mini .rst-content p .headerlink:before,.btn-mini .rst-content table>caption .headerlink:before,.btn-mini .rst-content tt.download span:first-child:before,.btn-mini .wy-menu-vertical li button.toctree-expand:before,.rst-content .btn-mini .admonition-title:before,.rst-content .code-block-caption .btn-mini .headerlink:before,.rst-content .eqno .btn-mini .headerlink:before,.rst-content code.download .btn-mini span:first-child:before,.rst-content dl dt .btn-mini .headerlink:before,.rst-content h1 .btn-mini .headerlink:before,.rst-content h2 .btn-mini .headerlink:before,.rst-content h3 .btn-mini .headerlink:before,.rst-content h4 .btn-mini .headerlink:before,.rst-content h5 .btn-mini .headerlink:before,.rst-content h6 .btn-mini .headerlink:before,.rst-content p .btn-mini .headerlink:before,.rst-content table>caption .btn-mini .headerlink:before,.rst-content tt.download .btn-mini span:first-child:before,.wy-menu-vertical li .btn-mini button.toctree-expand:before{font-size:14px;vertical-align:-15%}.rst-content .admonition,.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .danger,.rst-content .error,.rst-content .hint,.rst-content .important,.rst-content .note,.rst-content .seealso,.rst-content .tip,.rst-content .warning,.wy-alert{padding:12px;line-height:24px;margin-bottom:24px;background:#e7f2fa}.rst-content .admonition-title,.wy-alert-title{font-weight:700;display:block;color:#fff;background:#6ab0de;padding:6px 12px;margin:-12px -12px 12px}.rst-content .danger,.rst-content .error,.rst-content .wy-alert-danger.admonition,.rst-content .wy-alert-danger.admonition-todo,.rst-content .wy-alert-danger.attention,.rst-content .wy-alert-danger.caution,.rst-content .wy-alert-danger.hint,.rst-content .wy-alert-danger.important,.rst-content .wy-alert-danger.note,.rst-content .wy-alert-danger.seealso,.rst-content .wy-alert-danger.tip,.rst-content .wy-alert-danger.warning,.wy-alert.wy-alert-danger{background:#fdf3f2}.rst-content .danger .admonition-title,.rst-content .danger .wy-alert-title,.rst-content .error .admonition-title,.rst-content .error .wy-alert-title,.rst-content .wy-alert-danger.admonition-todo .admonition-title,.rst-content .wy-alert-danger.admonition-todo .wy-alert-title,.rst-content .wy-alert-danger.admonition .admonition-title,.rst-content .wy-alert-danger.admonition .wy-alert-title,.rst-content .wy-alert-danger.attention .admonition-title,.rst-content .wy-alert-danger.attention .wy-alert-title,.rst-content .wy-alert-danger.caution .admonition-title,.rst-content .wy-alert-danger.caution .wy-alert-title,.rst-content .wy-alert-danger.hint .admonition-title,.rst-content .wy-alert-danger.hint .wy-alert-title,.rst-content .wy-alert-danger.important .admonition-title,.rst-content .wy-alert-danger.important .wy-alert-title,.rst-content .wy-alert-danger.note .admonition-title,.rst-content .wy-alert-danger.note .wy-alert-title,.rst-content .wy-alert-danger.seealso .admonition-title,.rst-content .wy-alert-danger.seealso .wy-alert-title,.rst-content .wy-alert-danger.tip .admonition-title,.rst-content .wy-alert-danger.tip .wy-alert-title,.rst-content .wy-alert-danger.warning .admonition-title,.rst-content .wy-alert-danger.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-danger .admonition-title,.wy-alert.wy-alert-danger .rst-content .admonition-title,.wy-alert.wy-alert-danger .wy-alert-title{background:#f29f97}.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .warning,.rst-content .wy-alert-warning.admonition,.rst-content .wy-alert-warning.danger,.rst-content .wy-alert-warning.error,.rst-content .wy-alert-warning.hint,.rst-content .wy-alert-warning.important,.rst-content .wy-alert-warning.note,.rst-content .wy-alert-warning.seealso,.rst-content .wy-alert-warning.tip,.wy-alert.wy-alert-warning{background:#ffedcc}.rst-content .admonition-todo .admonition-title,.rst-content .admonition-todo .wy-alert-title,.rst-content .attention .admonition-title,.rst-content .attention .wy-alert-title,.rst-content .caution .admonition-title,.rst-content .caution .wy-alert-title,.rst-content .warning .admonition-title,.rst-content .warning .wy-alert-title,.rst-content .wy-alert-warning.admonition .admonition-title,.rst-content .wy-alert-warning.admonition .wy-alert-title,.rst-content .wy-alert-warning.danger .admonition-title,.rst-content .wy-alert-warning.danger .wy-alert-title,.rst-content .wy-alert-warning.error .admonition-title,.rst-content .wy-alert-warning.error .wy-alert-title,.rst-content .wy-alert-warning.hint .admonition-title,.rst-content .wy-alert-warning.hint .wy-alert-title,.rst-content .wy-alert-warning.important .admonition-title,.rst-content .wy-alert-warning.important .wy-alert-title,.rst-content .wy-alert-warning.note .admonition-title,.rst-content .wy-alert-warning.note .wy-alert-title,.rst-content .wy-alert-warning.seealso .admonition-title,.rst-content .wy-alert-warning.seealso .wy-alert-title,.rst-content .wy-alert-warning.tip .admonition-title,.rst-content .wy-alert-warning.tip .wy-alert-title,.rst-content .wy-alert.wy-alert-warning .admonition-title,.wy-alert.wy-alert-warning .rst-content .admonition-title,.wy-alert.wy-alert-warning .wy-alert-title{background:#f0b37e}.rst-content .note,.rst-content .seealso,.rst-content .wy-alert-info.admonition,.rst-content .wy-alert-info.admonition-todo,.rst-content .wy-alert-info.attention,.rst-content .wy-alert-info.caution,.rst-content .wy-alert-info.danger,.rst-content .wy-alert-info.error,.rst-content .wy-alert-info.hint,.rst-content .wy-alert-info.important,.rst-content .wy-alert-info.tip,.rst-content .wy-alert-info.warning,.wy-alert.wy-alert-info{background:#e7f2fa}.rst-content .note .admonition-title,.rst-content .note .wy-alert-title,.rst-content .seealso .admonition-title,.rst-content .seealso .wy-alert-title,.rst-content .wy-alert-info.admonition-todo .admonition-title,.rst-content .wy-alert-info.admonition-todo .wy-alert-title,.rst-content .wy-alert-info.admonition .admonition-title,.rst-content .wy-alert-info.admonition .wy-alert-title,.rst-content .wy-alert-info.attention .admonition-title,.rst-content .wy-alert-info.attention .wy-alert-title,.rst-content .wy-alert-info.caution .admonition-title,.rst-content .wy-alert-info.caution .wy-alert-title,.rst-content .wy-alert-info.danger .admonition-title,.rst-content .wy-alert-info.danger .wy-alert-title,.rst-content .wy-alert-info.error .admonition-title,.rst-content .wy-alert-info.error .wy-alert-title,.rst-content .wy-alert-info.hint .admonition-title,.rst-content .wy-alert-info.hint .wy-alert-title,.rst-content .wy-alert-info.important .admonition-title,.rst-content .wy-alert-info.important .wy-alert-title,.rst-content .wy-alert-info.tip .admonition-title,.rst-content .wy-alert-info.tip .wy-alert-title,.rst-content .wy-alert-info.warning .admonition-title,.rst-content .wy-alert-info.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-info .admonition-title,.wy-alert.wy-alert-info .rst-content .admonition-title,.wy-alert.wy-alert-info .wy-alert-title{background:#6ab0de}.rst-content .hint,.rst-content .important,.rst-content .tip,.rst-content .wy-alert-success.admonition,.rst-content .wy-alert-success.admonition-todo,.rst-content .wy-alert-success.attention,.rst-content .wy-alert-success.caution,.rst-content .wy-alert-success.danger,.rst-content .wy-alert-success.error,.rst-content .wy-alert-success.note,.rst-content .wy-alert-success.seealso,.rst-content .wy-alert-success.warning,.wy-alert.wy-alert-success{background:#dbfaf4}.rst-content .hint .admonition-title,.rst-content .hint .wy-alert-title,.rst-content .important .admonition-title,.rst-content .important .wy-alert-title,.rst-content .tip .admonition-title,.rst-content .tip .wy-alert-title,.rst-content .wy-alert-success.admonition-todo .admonition-title,.rst-content .wy-alert-success.admonition-todo .wy-alert-title,.rst-content .wy-alert-success.admonition .admonition-title,.rst-content .wy-alert-success.admonition .wy-alert-title,.rst-content .wy-alert-success.attention .admonition-title,.rst-content .wy-alert-success.attention .wy-alert-title,.rst-content .wy-alert-success.caution .admonition-title,.rst-content .wy-alert-success.caution .wy-alert-title,.rst-content .wy-alert-success.danger .admonition-title,.rst-content .wy-alert-success.danger .wy-alert-title,.rst-content .wy-alert-success.error .admonition-title,.rst-content .wy-alert-success.error .wy-alert-title,.rst-content .wy-alert-success.note .admonition-title,.rst-content .wy-alert-success.note .wy-alert-title,.rst-content .wy-alert-success.seealso .admonition-title,.rst-content .wy-alert-success.seealso .wy-alert-title,.rst-content .wy-alert-success.warning .admonition-title,.rst-content .wy-alert-success.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-success .admonition-title,.wy-alert.wy-alert-success .rst-content .admonition-title,.wy-alert.wy-alert-success .wy-alert-title{background:#1abc9c}.rst-content .wy-alert-neutral.admonition,.rst-content .wy-alert-neutral.admonition-todo,.rst-content .wy-alert-neutral.attention,.rst-content .wy-alert-neutral.caution,.rst-content .wy-alert-neutral.danger,.rst-content .wy-alert-neutral.error,.rst-content .wy-alert-neutral.hint,.rst-content .wy-alert-neutral.important,.rst-content .wy-alert-neutral.note,.rst-content .wy-alert-neutral.seealso,.rst-content .wy-alert-neutral.tip,.rst-content .wy-alert-neutral.warning,.wy-alert.wy-alert-neutral{background:#f3f6f6}.rst-content .wy-alert-neutral.admonition-todo .admonition-title,.rst-content .wy-alert-neutral.admonition-todo .wy-alert-title,.rst-content .wy-alert-neutral.admonition .admonition-title,.rst-content .wy-alert-neutral.admonition .wy-alert-title,.rst-content .wy-alert-neutral.attention .admonition-title,.rst-content .wy-alert-neutral.attention .wy-alert-title,.rst-content .wy-alert-neutral.caution .admonition-title,.rst-content .wy-alert-neutral.caution .wy-alert-title,.rst-content .wy-alert-neutral.danger .admonition-title,.rst-content .wy-alert-neutral.danger .wy-alert-title,.rst-content .wy-alert-neutral.error .admonition-title,.rst-content .wy-alert-neutral.error .wy-alert-title,.rst-content .wy-alert-neutral.hint .admonition-title,.rst-content .wy-alert-neutral.hint .wy-alert-title,.rst-content .wy-alert-neutral.important .admonition-title,.rst-content .wy-alert-neutral.important .wy-alert-title,.rst-content .wy-alert-neutral.note .admonition-title,.rst-content .wy-alert-neutral.note .wy-alert-title,.rst-content .wy-alert-neutral.seealso .admonition-title,.rst-content .wy-alert-neutral.seealso .wy-alert-title,.rst-content .wy-alert-neutral.tip .admonition-title,.rst-content .wy-alert-neutral.tip .wy-alert-title,.rst-content .wy-alert-neutral.warning .admonition-title,.rst-content .wy-alert-neutral.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-neutral .admonition-title,.wy-alert.wy-alert-neutral .rst-content .admonition-title,.wy-alert.wy-alert-neutral .wy-alert-title{color:#404040;background:#e1e4e5}.rst-content .wy-alert-neutral.admonition-todo a,.rst-content .wy-alert-neutral.admonition a,.rst-content .wy-alert-neutral.attention a,.rst-content .wy-alert-neutral.caution a,.rst-content .wy-alert-neutral.danger a,.rst-content .wy-alert-neutral.error a,.rst-content .wy-alert-neutral.hint a,.rst-content .wy-alert-neutral.important a,.rst-content .wy-alert-neutral.note a,.rst-content .wy-alert-neutral.seealso a,.rst-content .wy-alert-neutral.tip a,.rst-content .wy-alert-neutral.warning a,.wy-alert.wy-alert-neutral a{color:#2980b9}.rst-content .admonition-todo p:last-child,.rst-content .admonition p:last-child,.rst-content .attention p:last-child,.rst-content .caution p:last-child,.rst-content .danger p:last-child,.rst-content .error p:last-child,.rst-content .hint p:last-child,.rst-content .important p:last-child,.rst-content .note p:last-child,.rst-content .seealso p:last-child,.rst-content .tip p:last-child,.rst-content .warning p:last-child,.wy-alert p:last-child{margin-bottom:0}.wy-tray-container{position:fixed;bottom:0;left:0;z-index:600}.wy-tray-container li{display:block;width:300px;background:transparent;color:#fff;text-align:center;box-shadow:0 5px 5px 0 rgba(0,0,0,.1);padding:0 24px;min-width:20%;opacity:0;height:0;line-height:56px;overflow:hidden;-webkit-transition:all .3s ease-in;-moz-transition:all .3s ease-in;transition:all .3s ease-in}.wy-tray-container li.wy-tray-item-success{background:#27ae60}.wy-tray-container li.wy-tray-item-info{background:#2980b9}.wy-tray-container li.wy-tray-item-warning{background:#e67e22}.wy-tray-container li.wy-tray-item-danger{background:#e74c3c}.wy-tray-container li.on{opacity:1;height:56px}@media screen and (max-width:768px){.wy-tray-container{bottom:auto;top:0;width:100%}.wy-tray-container li{width:100%}}button{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle;cursor:pointer;line-height:normal;-webkit-appearance:button;*overflow:visible}button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0}button[disabled]{cursor:default}.btn{display:inline-block;border-radius:2px;line-height:normal;white-space:nowrap;text-align:center;cursor:pointer;font-size:100%;padding:6px 12px 8px;color:#fff;border:1px solid rgba(0,0,0,.1);background-color:#27ae60;text-decoration:none;font-weight:400;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;box-shadow:inset 0 1px 2px -1px hsla(0,0%,100%,.5),inset 0 -2px 0 0 rgba(0,0,0,.1);outline-none:false;vertical-align:middle;*display:inline;zoom:1;-webkit-user-drag:none;-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none;-webkit-transition:all .1s linear;-moz-transition:all .1s linear;transition:all .1s linear}.btn-hover{background:#2e8ece;color:#fff}.btn:hover{background:#2cc36b;color:#fff}.btn:focus{background:#2cc36b;outline:0}.btn:active{box-shadow:inset 0 -1px 0 0 rgba(0,0,0,.05),inset 0 2px 0 0 rgba(0,0,0,.1);padding:8px 12px 6px}.btn:visited{color:#fff}.btn-disabled,.btn-disabled:active,.btn-disabled:focus,.btn-disabled:hover,.btn:disabled{background-image:none;filter:progid:DXImageTransform.Microsoft.gradient(enabled = false);filter:alpha(opacity=40);opacity:.4;cursor:not-allowed;box-shadow:none}.btn::-moz-focus-inner{padding:0;border:0}.btn-small{font-size:80%}.btn-info{background-color:#2980b9!important}.btn-info:hover{background-color:#2e8ece!important}.btn-neutral{background-color:#f3f6f6!important;color:#404040!important}.btn-neutral:hover{background-color:#e5ebeb!important;color:#404040}.btn-neutral:visited{color:#404040!important}.btn-success{background-color:#27ae60!important}.btn-success:hover{background-color:#295!important}.btn-danger{background-color:#e74c3c!important}.btn-danger:hover{background-color:#ea6153!important}.btn-warning{background-color:#e67e22!important}.btn-warning:hover{background-color:#e98b39!important}.btn-invert{background-color:#222}.btn-invert:hover{background-color:#2f2f2f!important}.btn-link{background-color:transparent!important;color:#2980b9;box-shadow:none;border-color:transparent!important}.btn-link:active,.btn-link:hover{background-color:transparent!important;color:#409ad5!important;box-shadow:none}.btn-link:visited{color:#9b59b6}.wy-btn-group .btn,.wy-control .btn{vertical-align:middle}.wy-btn-group{margin-bottom:24px;*zoom:1}.wy-btn-group:after,.wy-btn-group:before{display:table;content:""}.wy-btn-group:after{clear:both}.wy-dropdown{position:relative;display:inline-block}.wy-dropdown-active .wy-dropdown-menu{display:block}.wy-dropdown-menu{position:absolute;left:0;display:none;float:left;top:100%;min-width:100%;background:#fcfcfc;z-index:100;border:1px solid #cfd7dd;box-shadow:0 2px 2px 0 rgba(0,0,0,.1);padding:12px}.wy-dropdown-menu>dd>a{display:block;clear:both;color:#404040;white-space:nowrap;font-size:90%;padding:0 12px;cursor:pointer}.wy-dropdown-menu>dd>a:hover{background:#2980b9;color:#fff}.wy-dropdown-menu>dd.divider{border-top:1px solid #cfd7dd;margin:6px 0}.wy-dropdown-menu>dd.search{padding-bottom:12px}.wy-dropdown-menu>dd.search input[type=search]{width:100%}.wy-dropdown-menu>dd.call-to-action{background:#e3e3e3;text-transform:uppercase;font-weight:500;font-size:80%}.wy-dropdown-menu>dd.call-to-action:hover{background:#e3e3e3}.wy-dropdown-menu>dd.call-to-action .btn{color:#fff}.wy-dropdown.wy-dropdown-up .wy-dropdown-menu{bottom:100%;top:auto;left:auto;right:0}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu{background:#fcfcfc;margin-top:2px}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu a{padding:6px 12px}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu a:hover{background:#2980b9;color:#fff}.wy-dropdown.wy-dropdown-left .wy-dropdown-menu{right:0;left:auto;text-align:right}.wy-dropdown-arrow:before{content:" ";border-bottom:5px solid #f5f5f5;border-left:5px solid transparent;border-right:5px solid transparent;position:absolute;display:block;top:-4px;left:50%;margin-left:-3px}.wy-dropdown-arrow.wy-dropdown-arrow-left:before{left:11px}.wy-form-stacked select{display:block}.wy-form-aligned .wy-help-inline,.wy-form-aligned input,.wy-form-aligned label,.wy-form-aligned select,.wy-form-aligned textarea{display:inline-block;*display:inline;*zoom:1;vertical-align:middle}.wy-form-aligned .wy-control-group>label{display:inline-block;vertical-align:middle;width:10em;margin:6px 12px 0 0;float:left}.wy-form-aligned .wy-control{float:left}.wy-form-aligned .wy-control label{display:block}.wy-form-aligned .wy-control select{margin-top:6px}fieldset{margin:0}fieldset,legend{border:0;padding:0}legend{width:100%;white-space:normal;margin-bottom:24px;font-size:150%;*margin-left:-7px}label,legend{display:block}label{margin:0 0 .3125em;color:#333;font-size:90%}input,select,textarea{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle}.wy-control-group{margin-bottom:24px;max-width:1200px;margin-left:auto;margin-right:auto;*zoom:1}.wy-control-group:after,.wy-control-group:before{display:table;content:""}.wy-control-group:after{clear:both}.wy-control-group.wy-control-group-required>label:after{content:" *";color:#e74c3c}.wy-control-group .wy-form-full,.wy-control-group .wy-form-halves,.wy-control-group .wy-form-thirds{padding-bottom:12px}.wy-control-group .wy-form-full input[type=color],.wy-control-group .wy-form-full input[type=date],.wy-control-group .wy-form-full input[type=datetime-local],.wy-control-group .wy-form-full input[type=datetime],.wy-control-group .wy-form-full input[type=email],.wy-control-group .wy-form-full input[type=month],.wy-control-group .wy-form-full input[type=number],.wy-control-group .wy-form-full input[type=password],.wy-control-group .wy-form-full input[type=search],.wy-control-group .wy-form-full input[type=tel],.wy-control-group .wy-form-full input[type=text],.wy-control-group .wy-form-full input[type=time],.wy-control-group .wy-form-full input[type=url],.wy-control-group .wy-form-full input[type=week],.wy-control-group .wy-form-full select,.wy-control-group .wy-form-halves input[type=color],.wy-control-group .wy-form-halves input[type=date],.wy-control-group .wy-form-halves input[type=datetime-local],.wy-control-group .wy-form-halves input[type=datetime],.wy-control-group .wy-form-halves input[type=email],.wy-control-group .wy-form-halves input[type=month],.wy-control-group .wy-form-halves input[type=number],.wy-control-group .wy-form-halves input[type=password],.wy-control-group .wy-form-halves input[type=search],.wy-control-group .wy-form-halves input[type=tel],.wy-control-group .wy-form-halves input[type=text],.wy-control-group .wy-form-halves input[type=time],.wy-control-group .wy-form-halves input[type=url],.wy-control-group .wy-form-halves input[type=week],.wy-control-group .wy-form-halves select,.wy-control-group .wy-form-thirds input[type=color],.wy-control-group .wy-form-thirds input[type=date],.wy-control-group .wy-form-thirds input[type=datetime-local],.wy-control-group .wy-form-thirds input[type=datetime],.wy-control-group .wy-form-thirds input[type=email],.wy-control-group .wy-form-thirds input[type=month],.wy-control-group .wy-form-thirds input[type=number],.wy-control-group .wy-form-thirds input[type=password],.wy-control-group .wy-form-thirds input[type=search],.wy-control-group .wy-form-thirds input[type=tel],.wy-control-group .wy-form-thirds input[type=text],.wy-control-group .wy-form-thirds input[type=time],.wy-control-group .wy-form-thirds input[type=url],.wy-control-group .wy-form-thirds input[type=week],.wy-control-group .wy-form-thirds select{width:100%}.wy-control-group .wy-form-full{float:left;display:block;width:100%;margin-right:0}.wy-control-group .wy-form-full:last-child{margin-right:0}.wy-control-group .wy-form-halves{float:left;display:block;margin-right:2.35765%;width:48.82117%}.wy-control-group .wy-form-halves:last-child,.wy-control-group .wy-form-halves:nth-of-type(2n){margin-right:0}.wy-control-group .wy-form-halves:nth-of-type(odd){clear:left}.wy-control-group .wy-form-thirds{float:left;display:block;margin-right:2.35765%;width:31.76157%}.wy-control-group .wy-form-thirds:last-child,.wy-control-group .wy-form-thirds:nth-of-type(3n){margin-right:0}.wy-control-group .wy-form-thirds:nth-of-type(3n+1){clear:left}.wy-control-group.wy-control-group-no-input .wy-control,.wy-control-no-input{margin:6px 0 0;font-size:90%}.wy-control-no-input{display:inline-block}.wy-control-group.fluid-input input[type=color],.wy-control-group.fluid-input input[type=date],.wy-control-group.fluid-input input[type=datetime-local],.wy-control-group.fluid-input input[type=datetime],.wy-control-group.fluid-input input[type=email],.wy-control-group.fluid-input input[type=month],.wy-control-group.fluid-input input[type=number],.wy-control-group.fluid-input input[type=password],.wy-control-group.fluid-input input[type=search],.wy-control-group.fluid-input input[type=tel],.wy-control-group.fluid-input input[type=text],.wy-control-group.fluid-input input[type=time],.wy-control-group.fluid-input input[type=url],.wy-control-group.fluid-input input[type=week]{width:100%}.wy-form-message-inline{padding-left:.3em;color:#666;font-size:90%}.wy-form-message{display:block;color:#999;font-size:70%;margin-top:.3125em;font-style:italic}.wy-form-message p{font-size:inherit;font-style:italic;margin-bottom:6px}.wy-form-message p:last-child{margin-bottom:0}input{line-height:normal}input[type=button],input[type=reset],input[type=submit]{-webkit-appearance:button;cursor:pointer;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;*overflow:visible}input[type=color],input[type=date],input[type=datetime-local],input[type=datetime],input[type=email],input[type=month],input[type=number],input[type=password],input[type=search],input[type=tel],input[type=text],input[type=time],input[type=url],input[type=week]{-webkit-appearance:none;padding:6px;display:inline-block;border:1px solid #ccc;font-size:80%;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;box-shadow:inset 0 1px 3px #ddd;border-radius:0;-webkit-transition:border .3s linear;-moz-transition:border .3s linear;transition:border .3s linear}input[type=datetime-local]{padding:.34375em .625em}input[disabled]{cursor:default}input[type=checkbox],input[type=radio]{padding:0;margin-right:.3125em;*height:13px;*width:13px}input[type=checkbox],input[type=radio],input[type=search]{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box}input[type=search]::-webkit-search-cancel-button,input[type=search]::-webkit-search-decoration{-webkit-appearance:none}input[type=color]:focus,input[type=date]:focus,input[type=datetime-local]:focus,input[type=datetime]:focus,input[type=email]:focus,input[type=month]:focus,input[type=number]:focus,input[type=password]:focus,input[type=search]:focus,input[type=tel]:focus,input[type=text]:focus,input[type=time]:focus,input[type=url]:focus,input[type=week]:focus{outline:0;outline:thin dotted\9;border-color:#333}input.no-focus:focus{border-color:#ccc!important}input[type=checkbox]:focus,input[type=file]:focus,input[type=radio]:focus{outline:thin dotted #333;outline:1px auto #129fea}input[type=color][disabled],input[type=date][disabled],input[type=datetime-local][disabled],input[type=datetime][disabled],input[type=email][disabled],input[type=month][disabled],input[type=number][disabled],input[type=password][disabled],input[type=search][disabled],input[type=tel][disabled],input[type=text][disabled],input[type=time][disabled],input[type=url][disabled],input[type=week][disabled]{cursor:not-allowed;background-color:#fafafa}input:focus:invalid,select:focus:invalid,textarea:focus:invalid{color:#e74c3c;border:1px solid #e74c3c}input:focus:invalid:focus,select:focus:invalid:focus,textarea:focus:invalid:focus{border-color:#e74c3c}input[type=checkbox]:focus:invalid:focus,input[type=file]:focus:invalid:focus,input[type=radio]:focus:invalid:focus{outline-color:#e74c3c}input.wy-input-large{padding:12px;font-size:100%}textarea{overflow:auto;vertical-align:top;width:100%;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif}select,textarea{padding:.5em .625em;display:inline-block;border:1px solid #ccc;font-size:80%;box-shadow:inset 0 1px 3px #ddd;-webkit-transition:border .3s linear;-moz-transition:border .3s linear;transition:border .3s linear}select{border:1px solid #ccc;background-color:#fff}select[multiple]{height:auto}select:focus,textarea:focus{outline:0}input[readonly],select[disabled],select[readonly],textarea[disabled],textarea[readonly]{cursor:not-allowed;background-color:#fafafa}input[type=checkbox][disabled],input[type=radio][disabled]{cursor:not-allowed}.wy-checkbox,.wy-radio{margin:6px 0;color:#404040;display:block}.wy-checkbox input,.wy-radio input{vertical-align:baseline}.wy-form-message-inline{display:inline-block;*display:inline;*zoom:1;vertical-align:middle}.wy-input-prefix,.wy-input-suffix{white-space:nowrap;padding:6px}.wy-input-prefix .wy-input-context,.wy-input-suffix .wy-input-context{line-height:27px;padding:0 8px;display:inline-block;font-size:80%;background-color:#f3f6f6;border:1px solid #ccc;color:#999}.wy-input-suffix .wy-input-context{border-left:0}.wy-input-prefix .wy-input-context{border-right:0}.wy-switch{position:relative;display:block;height:24px;margin-top:12px;cursor:pointer}.wy-switch:before{left:0;top:0;width:36px;height:12px;background:#ccc}.wy-switch:after,.wy-switch:before{position:absolute;content:"";display:block;border-radius:4px;-webkit-transition:all .2s ease-in-out;-moz-transition:all .2s ease-in-out;transition:all .2s ease-in-out}.wy-switch:after{width:18px;height:18px;background:#999;left:-3px;top:-3px}.wy-switch span{position:absolute;left:48px;display:block;font-size:12px;color:#ccc;line-height:1}.wy-switch.active:before{background:#1e8449}.wy-switch.active:after{left:24px;background:#27ae60}.wy-switch.disabled{cursor:not-allowed;opacity:.8}.wy-control-group.wy-control-group-error .wy-form-message,.wy-control-group.wy-control-group-error>label{color:#e74c3c}.wy-control-group.wy-control-group-error input[type=color],.wy-control-group.wy-control-group-error input[type=date],.wy-control-group.wy-control-group-error input[type=datetime-local],.wy-control-group.wy-control-group-error input[type=datetime],.wy-control-group.wy-control-group-error input[type=email],.wy-control-group.wy-control-group-error input[type=month],.wy-control-group.wy-control-group-error input[type=number],.wy-control-group.wy-control-group-error input[type=password],.wy-control-group.wy-control-group-error input[type=search],.wy-control-group.wy-control-group-error input[type=tel],.wy-control-group.wy-control-group-error input[type=text],.wy-control-group.wy-control-group-error input[type=time],.wy-control-group.wy-control-group-error input[type=url],.wy-control-group.wy-control-group-error input[type=week],.wy-control-group.wy-control-group-error textarea{border:1px solid #e74c3c}.wy-inline-validate{white-space:nowrap}.wy-inline-validate .wy-input-context{padding:.5em .625em;display:inline-block;font-size:80%}.wy-inline-validate.wy-inline-validate-success .wy-input-context{color:#27ae60}.wy-inline-validate.wy-inline-validate-danger .wy-input-context{color:#e74c3c}.wy-inline-validate.wy-inline-validate-warning .wy-input-context{color:#e67e22}.wy-inline-validate.wy-inline-validate-info .wy-input-context{color:#2980b9}.rotate-90{-webkit-transform:rotate(90deg);-moz-transform:rotate(90deg);-ms-transform:rotate(90deg);-o-transform:rotate(90deg);transform:rotate(90deg)}.rotate-180{-webkit-transform:rotate(180deg);-moz-transform:rotate(180deg);-ms-transform:rotate(180deg);-o-transform:rotate(180deg);transform:rotate(180deg)}.rotate-270{-webkit-transform:rotate(270deg);-moz-transform:rotate(270deg);-ms-transform:rotate(270deg);-o-transform:rotate(270deg);transform:rotate(270deg)}.mirror{-webkit-transform:scaleX(-1);-moz-transform:scaleX(-1);-ms-transform:scaleX(-1);-o-transform:scaleX(-1);transform:scaleX(-1)}.mirror.rotate-90{-webkit-transform:scaleX(-1) rotate(90deg);-moz-transform:scaleX(-1) rotate(90deg);-ms-transform:scaleX(-1) rotate(90deg);-o-transform:scaleX(-1) rotate(90deg);transform:scaleX(-1) rotate(90deg)}.mirror.rotate-180{-webkit-transform:scaleX(-1) rotate(180deg);-moz-transform:scaleX(-1) rotate(180deg);-ms-transform:scaleX(-1) rotate(180deg);-o-transform:scaleX(-1) rotate(180deg);transform:scaleX(-1) rotate(180deg)}.mirror.rotate-270{-webkit-transform:scaleX(-1) rotate(270deg);-moz-transform:scaleX(-1) rotate(270deg);-ms-transform:scaleX(-1) rotate(270deg);-o-transform:scaleX(-1) rotate(270deg);transform:scaleX(-1) rotate(270deg)}@media only screen and (max-width:480px){.wy-form button[type=submit]{margin:.7em 0 0}.wy-form input[type=color],.wy-form input[type=date],.wy-form input[type=datetime-local],.wy-form input[type=datetime],.wy-form input[type=email],.wy-form input[type=month],.wy-form input[type=number],.wy-form input[type=password],.wy-form input[type=search],.wy-form input[type=tel],.wy-form input[type=text],.wy-form input[type=time],.wy-form input[type=url],.wy-form input[type=week],.wy-form label{margin-bottom:.3em;display:block}.wy-form input[type=color],.wy-form input[type=date],.wy-form input[type=datetime-local],.wy-form input[type=datetime],.wy-form input[type=email],.wy-form input[type=month],.wy-form input[type=number],.wy-form input[type=password],.wy-form input[type=search],.wy-form input[type=tel],.wy-form input[type=time],.wy-form input[type=url],.wy-form input[type=week]{margin-bottom:0}.wy-form-aligned .wy-control-group label{margin-bottom:.3em;text-align:left;display:block;width:100%}.wy-form-aligned .wy-control{margin:1.5em 0 0}.wy-form-message,.wy-form-message-inline,.wy-form .wy-help-inline{display:block;font-size:80%;padding:6px 0}}@media screen and (max-width:768px){.tablet-hide{display:none}}@media screen and (max-width:480px){.mobile-hide{display:none}}.float-left{float:left}.float-right{float:right}.full-width{width:100%}.rst-content table.docutils,.rst-content table.field-list,.wy-table{border-collapse:collapse;border-spacing:0;empty-cells:show;margin-bottom:24px}.rst-content table.docutils caption,.rst-content table.field-list caption,.wy-table caption{color:#000;font:italic 85%/1 arial,sans-serif;padding:1em 0;text-align:center}.rst-content table.docutils td,.rst-content table.docutils th,.rst-content table.field-list td,.rst-content table.field-list th,.wy-table td,.wy-table th{font-size:90%;margin:0;overflow:visible;padding:8px 16px}.rst-content table.docutils td:first-child,.rst-content table.docutils th:first-child,.rst-content table.field-list td:first-child,.rst-content table.field-list th:first-child,.wy-table td:first-child,.wy-table th:first-child{border-left-width:0}.rst-content table.docutils thead,.rst-content table.field-list thead,.wy-table thead{color:#000;text-align:left;vertical-align:bottom;white-space:nowrap}.rst-content table.docutils thead th,.rst-content table.field-list thead th,.wy-table thead th{font-weight:700;border-bottom:2px solid #e1e4e5}.rst-content table.docutils td,.rst-content table.field-list td,.wy-table td{background-color:transparent;vertical-align:middle}.rst-content table.docutils td p,.rst-content table.field-list td p,.wy-table td p{line-height:18px}.rst-content table.docutils td p:last-child,.rst-content table.field-list td p:last-child,.wy-table td p:last-child{margin-bottom:0}.rst-content table.docutils .wy-table-cell-min,.rst-content table.field-list .wy-table-cell-min,.wy-table .wy-table-cell-min{width:1%;padding-right:0}.rst-content table.docutils .wy-table-cell-min input[type=checkbox],.rst-content table.field-list .wy-table-cell-min input[type=checkbox],.wy-table .wy-table-cell-min input[type=checkbox]{margin:0}.wy-table-secondary{color:grey;font-size:90%}.wy-table-tertiary{color:grey;font-size:80%}.rst-content table.docutils:not(.field-list) tr:nth-child(2n-1) td,.wy-table-backed,.wy-table-odd td,.wy-table-striped tr:nth-child(2n-1) td{background-color:#f3f6f6}.rst-content table.docutils,.wy-table-bordered-all{border:1px solid #e1e4e5}.rst-content table.docutils td,.wy-table-bordered-all td{border-bottom:1px solid #e1e4e5;border-left:1px solid #e1e4e5}.rst-content table.docutils tbody>tr:last-child td,.wy-table-bordered-all tbody>tr:last-child td{border-bottom-width:0}.wy-table-bordered{border:1px solid #e1e4e5}.wy-table-bordered-rows td{border-bottom:1px solid #e1e4e5}.wy-table-bordered-rows tbody>tr:last-child td{border-bottom-width:0}.wy-table-horizontal td,.wy-table-horizontal th{border-width:0 0 1px;border-bottom:1px solid #e1e4e5}.wy-table-horizontal tbody>tr:last-child td{border-bottom-width:0}.wy-table-responsive{margin-bottom:24px;max-width:100%;overflow:auto}.wy-table-responsive table{margin-bottom:0!important}.wy-table-responsive table td,.wy-table-responsive table th{white-space:nowrap}a{color:#2980b9;text-decoration:none;cursor:pointer}a:hover{color:#3091d1}a:visited{color:#9b59b6}html{height:100%}body,html{overflow-x:hidden}body{font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;font-weight:400;color:#404040;min-height:100%;background:#edf0f2}.wy-text-left{text-align:left}.wy-text-center{text-align:center}.wy-text-right{text-align:right}.wy-text-large{font-size:120%}.wy-text-normal{font-size:100%}.wy-text-small,small{font-size:80%}.wy-text-strike{text-decoration:line-through}.wy-text-warning{color:#e67e22!important}a.wy-text-warning:hover{color:#eb9950!important}.wy-text-info{color:#2980b9!important}a.wy-text-info:hover{color:#409ad5!important}.wy-text-success{color:#27ae60!important}a.wy-text-success:hover{color:#36d278!important}.wy-text-danger{color:#e74c3c!important}a.wy-text-danger:hover{color:#ed7669!important}.wy-text-neutral{color:#404040!important}a.wy-text-neutral:hover{color:#595959!important}.rst-content .toctree-wrapper>p.caption,h1,h2,h3,h4,h5,h6,legend{margin-top:0;font-weight:700;font-family:Roboto Slab,ff-tisa-web-pro,Georgia,Arial,sans-serif}p{line-height:24px;font-size:16px;margin:0 0 24px}h1{font-size:175%}.rst-content .toctree-wrapper>p.caption,h2{font-size:150%}h3{font-size:125%}h4{font-size:115%}h5{font-size:110%}h6{font-size:100%}hr{display:block;height:1px;border:0;border-top:1px solid #e1e4e5;margin:24px 0;padding:0}.rst-content code,.rst-content tt,code{white-space:nowrap;max-width:100%;background:#fff;border:1px solid #e1e4e5;font-size:75%;padding:0 5px;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;color:#e74c3c;overflow-x:auto}.rst-content tt.code-large,code.code-large{font-size:90%}.rst-content .section ul,.rst-content .toctree-wrapper ul,.rst-content section ul,.wy-plain-list-disc,article ul{list-style:disc;line-height:24px;margin-bottom:24px}.rst-content .section ul li,.rst-content .toctree-wrapper ul li,.rst-content section ul li,.wy-plain-list-disc li,article ul li{list-style:disc;margin-left:24px}.rst-content .section ul li p:last-child,.rst-content .section ul li ul,.rst-content .toctree-wrapper ul li p:last-child,.rst-content .toctree-wrapper ul li ul,.rst-content section ul li p:last-child,.rst-content section ul li ul,.wy-plain-list-disc li p:last-child,.wy-plain-list-disc li ul,article ul li p:last-child,article ul li ul{margin-bottom:0}.rst-content .section ul li li,.rst-content .toctree-wrapper ul li li,.rst-content section ul li li,.wy-plain-list-disc li li,article ul li li{list-style:circle}.rst-content .section ul li li li,.rst-content .toctree-wrapper ul li li li,.rst-content section ul li li li,.wy-plain-list-disc li li li,article ul li li li{list-style:square}.rst-content .section ul li ol li,.rst-content .toctree-wrapper ul li ol li,.rst-content section ul li ol li,.wy-plain-list-disc li ol li,article ul li ol li{list-style:decimal}.rst-content .section ol,.rst-content .section ol.arabic,.rst-content .toctree-wrapper ol,.rst-content .toctree-wrapper ol.arabic,.rst-content section ol,.rst-content section ol.arabic,.wy-plain-list-decimal,article ol{list-style:decimal;line-height:24px;margin-bottom:24px}.rst-content .section ol.arabic li,.rst-content .section ol li,.rst-content .toctree-wrapper ol.arabic li,.rst-content .toctree-wrapper ol li,.rst-content section ol.arabic li,.rst-content section ol li,.wy-plain-list-decimal li,article ol li{list-style:decimal;margin-left:24px}.rst-content .section ol.arabic li ul,.rst-content .section ol li p:last-child,.rst-content .section ol li ul,.rst-content .toctree-wrapper ol.arabic li ul,.rst-content .toctree-wrapper ol li p:last-child,.rst-content .toctree-wrapper ol li ul,.rst-content section ol.arabic li ul,.rst-content section ol li p:last-child,.rst-content section ol li ul,.wy-plain-list-decimal li p:last-child,.wy-plain-list-decimal li ul,article ol li p:last-child,article ol li ul{margin-bottom:0}.rst-content .section ol.arabic li ul li,.rst-content .section ol li ul li,.rst-content .toctree-wrapper ol.arabic li ul li,.rst-content .toctree-wrapper ol li ul li,.rst-content section ol.arabic li ul li,.rst-content section ol li ul li,.wy-plain-list-decimal li ul li,article ol li ul li{list-style:disc}.wy-breadcrumbs{*zoom:1}.wy-breadcrumbs:after,.wy-breadcrumbs:before{display:table;content:""}.wy-breadcrumbs:after{clear:both}.wy-breadcrumbs>li{display:inline-block;padding-top:5px}.wy-breadcrumbs>li.wy-breadcrumbs-aside{float:right}.rst-content .wy-breadcrumbs>li code,.rst-content .wy-breadcrumbs>li tt,.wy-breadcrumbs>li .rst-content tt,.wy-breadcrumbs>li code{all:inherit;color:inherit}.breadcrumb-item:before{content:"/";color:#bbb;font-size:13px;padding:0 6px 0 3px}.wy-breadcrumbs-extra{margin-bottom:0;color:#b3b3b3;font-size:80%;display:inline-block}@media screen and (max-width:480px){.wy-breadcrumbs-extra,.wy-breadcrumbs li.wy-breadcrumbs-aside{display:none}}@media print{.wy-breadcrumbs li.wy-breadcrumbs-aside{display:none}}html{font-size:16px}.wy-affix{position:fixed;top:1.618em}.wy-menu a:hover{text-decoration:none}.wy-menu-horiz{*zoom:1}.wy-menu-horiz:after,.wy-menu-horiz:before{display:table;content:""}.wy-menu-horiz:after{clear:both}.wy-menu-horiz li,.wy-menu-horiz ul{display:inline-block}.wy-menu-horiz li:hover{background:hsla(0,0%,100%,.1)}.wy-menu-horiz li.divide-left{border-left:1px solid #404040}.wy-menu-horiz li.divide-right{border-right:1px solid #404040}.wy-menu-horiz a{height:32px;display:inline-block;line-height:32px;padding:0 16px}.wy-menu-vertical{width:300px}.wy-menu-vertical header,.wy-menu-vertical p.caption{color:#55a5d9;height:32px;line-height:32px;padding:0 1.618em;margin:12px 0 0;display:block;font-weight:700;text-transform:uppercase;font-size:85%;white-space:nowrap}.wy-menu-vertical ul{margin-bottom:0}.wy-menu-vertical li.divide-top{border-top:1px solid #404040}.wy-menu-vertical li.divide-bottom{border-bottom:1px solid #404040}.wy-menu-vertical li.current{background:#e3e3e3}.wy-menu-vertical li.current a{color:grey;border-right:1px solid #c9c9c9;padding:.4045em 2.427em}.wy-menu-vertical li.current a:hover{background:#d6d6d6}.rst-content .wy-menu-vertical li tt,.wy-menu-vertical li .rst-content tt,.wy-menu-vertical li code{border:none;background:inherit;color:inherit;padding-left:0;padding-right:0}.wy-menu-vertical li button.toctree-expand{display:block;float:left;margin-left:-1.2em;line-height:18px;color:#4d4d4d;border:none;background:none;padding:0}.wy-menu-vertical li.current>a,.wy-menu-vertical li.on a{color:#404040;font-weight:700;position:relative;background:#fcfcfc;border:none;padding:.4045em 1.618em}.wy-menu-vertical li.current>a:hover,.wy-menu-vertical li.on a:hover{background:#fcfcfc}.wy-menu-vertical li.current>a:hover button.toctree-expand,.wy-menu-vertical li.on a:hover button.toctree-expand{color:grey}.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand{display:block;line-height:18px;color:#333}.wy-menu-vertical li.toctree-l1.current>a{border-bottom:1px solid #c9c9c9;border-top:1px solid #c9c9c9}.wy-menu-vertical .toctree-l1.current .toctree-l2>ul,.wy-menu-vertical .toctree-l2.current .toctree-l3>ul,.wy-menu-vertical .toctree-l3.current .toctree-l4>ul,.wy-menu-vertical .toctree-l4.current .toctree-l5>ul,.wy-menu-vertical .toctree-l5.current .toctree-l6>ul,.wy-menu-vertical .toctree-l6.current .toctree-l7>ul,.wy-menu-vertical .toctree-l7.current .toctree-l8>ul,.wy-menu-vertical .toctree-l8.current .toctree-l9>ul,.wy-menu-vertical .toctree-l9.current .toctree-l10>ul,.wy-menu-vertical .toctree-l10.current .toctree-l11>ul{display:none}.wy-menu-vertical .toctree-l1.current .current.toctree-l2>ul,.wy-menu-vertical .toctree-l2.current .current.toctree-l3>ul,.wy-menu-vertical .toctree-l3.current .current.toctree-l4>ul,.wy-menu-vertical .toctree-l4.current .current.toctree-l5>ul,.wy-menu-vertical .toctree-l5.current .current.toctree-l6>ul,.wy-menu-vertical .toctree-l6.current .current.toctree-l7>ul,.wy-menu-vertical .toctree-l7.current .current.toctree-l8>ul,.wy-menu-vertical .toctree-l8.current .current.toctree-l9>ul,.wy-menu-vertical .toctree-l9.current .current.toctree-l10>ul,.wy-menu-vertical .toctree-l10.current .current.toctree-l11>ul{display:block}.wy-menu-vertical li.toctree-l3,.wy-menu-vertical li.toctree-l4{font-size:.9em}.wy-menu-vertical li.toctree-l2 a,.wy-menu-vertical li.toctree-l3 a,.wy-menu-vertical li.toctree-l4 a,.wy-menu-vertical li.toctree-l5 a,.wy-menu-vertical li.toctree-l6 a,.wy-menu-vertical li.toctree-l7 a,.wy-menu-vertical li.toctree-l8 a,.wy-menu-vertical li.toctree-l9 a,.wy-menu-vertical li.toctree-l10 a{color:#404040}.wy-menu-vertical li.toctree-l2 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l3 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l4 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l5 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l6 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l7 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l8 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l9 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l10 a:hover button.toctree-expand{color:grey}.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a,.wy-menu-vertical li.toctree-l3.current li.toctree-l4>a,.wy-menu-vertical li.toctree-l4.current li.toctree-l5>a,.wy-menu-vertical li.toctree-l5.current li.toctree-l6>a,.wy-menu-vertical li.toctree-l6.current li.toctree-l7>a,.wy-menu-vertical li.toctree-l7.current li.toctree-l8>a,.wy-menu-vertical li.toctree-l8.current li.toctree-l9>a,.wy-menu-vertical li.toctree-l9.current li.toctree-l10>a,.wy-menu-vertical li.toctree-l10.current li.toctree-l11>a{display:block}.wy-menu-vertical li.toctree-l2.current>a{padding:.4045em 2.427em}.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a{padding:.4045em 1.618em .4045em 4.045em}.wy-menu-vertical li.toctree-l3.current>a{padding:.4045em 4.045em}.wy-menu-vertical li.toctree-l3.current li.toctree-l4>a{padding:.4045em 1.618em .4045em 5.663em}.wy-menu-vertical li.toctree-l4.current>a{padding:.4045em 5.663em}.wy-menu-vertical li.toctree-l4.current li.toctree-l5>a{padding:.4045em 1.618em .4045em 7.281em}.wy-menu-vertical li.toctree-l5.current>a{padding:.4045em 7.281em}.wy-menu-vertical li.toctree-l5.current li.toctree-l6>a{padding:.4045em 1.618em .4045em 8.899em}.wy-menu-vertical li.toctree-l6.current>a{padding:.4045em 8.899em}.wy-menu-vertical li.toctree-l6.current li.toctree-l7>a{padding:.4045em 1.618em .4045em 10.517em}.wy-menu-vertical li.toctree-l7.current>a{padding:.4045em 10.517em}.wy-menu-vertical li.toctree-l7.current li.toctree-l8>a{padding:.4045em 1.618em .4045em 12.135em}.wy-menu-vertical li.toctree-l8.current>a{padding:.4045em 12.135em}.wy-menu-vertical li.toctree-l8.current li.toctree-l9>a{padding:.4045em 1.618em .4045em 13.753em}.wy-menu-vertical li.toctree-l9.current>a{padding:.4045em 13.753em}.wy-menu-vertical li.toctree-l9.current li.toctree-l10>a{padding:.4045em 1.618em .4045em 15.371em}.wy-menu-vertical li.toctree-l10.current>a{padding:.4045em 15.371em}.wy-menu-vertical li.toctree-l10.current li.toctree-l11>a{padding:.4045em 1.618em .4045em 16.989em}.wy-menu-vertical li.toctree-l2.current>a,.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a{background:#c9c9c9}.wy-menu-vertical li.toctree-l2 button.toctree-expand{color:#a3a3a3}.wy-menu-vertical li.toctree-l3.current>a,.wy-menu-vertical li.toctree-l3.current li.toctree-l4>a{background:#bdbdbd}.wy-menu-vertical li.toctree-l3 button.toctree-expand{color:#969696}.wy-menu-vertical li.current ul{display:block}.wy-menu-vertical li ul{margin-bottom:0;display:none}.wy-menu-vertical li ul li a{margin-bottom:0;color:#d9d9d9;font-weight:400}.wy-menu-vertical a{line-height:18px;padding:.4045em 1.618em;display:block;position:relative;font-size:90%;color:#d9d9d9}.wy-menu-vertical a:hover{background-color:#4e4a4a;cursor:pointer}.wy-menu-vertical a:hover button.toctree-expand{color:#d9d9d9}.wy-menu-vertical a:active{background-color:#2980b9;cursor:pointer;color:#fff}.wy-menu-vertical a:active button.toctree-expand{color:#fff}.wy-side-nav-search{display:block;width:300px;padding:.809em;margin-bottom:.809em;z-index:200;background-color:#2980b9;text-align:center;color:#fcfcfc}.wy-side-nav-search input[type=text]{width:100%;border-radius:50px;padding:6px 12px;border-color:#2472a4}.wy-side-nav-search img{display:block;margin:auto auto .809em;height:45px;width:45px;background-color:#2980b9;padding:5px;border-radius:100%}.wy-side-nav-search .wy-dropdown>a,.wy-side-nav-search>a{color:#fcfcfc;font-size:100%;font-weight:700;display:inline-block;padding:4px 6px;margin-bottom:.809em;max-width:100%}.wy-side-nav-search .wy-dropdown>a:hover,.wy-side-nav-search>a:hover{background:hsla(0,0%,100%,.1)}.wy-side-nav-search .wy-dropdown>a img.logo,.wy-side-nav-search>a img.logo{display:block;margin:0 auto;height:auto;width:auto;border-radius:0;max-width:100%;background:transparent}.wy-side-nav-search .wy-dropdown>a.icon img.logo,.wy-side-nav-search>a.icon img.logo{margin-top:.85em}.wy-side-nav-search>div.version{margin-top:-.4045em;margin-bottom:.809em;font-weight:400;color:hsla(0,0%,100%,.3)}.wy-nav .wy-menu-vertical header{color:#2980b9}.wy-nav .wy-menu-vertical a{color:#b3b3b3}.wy-nav .wy-menu-vertical a:hover{background-color:#2980b9;color:#fff}[data-menu-wrap]{-webkit-transition:all .2s ease-in;-moz-transition:all .2s ease-in;transition:all .2s ease-in;position:absolute;opacity:1;width:100%;opacity:0}[data-menu-wrap].move-center{left:0;right:auto;opacity:1}[data-menu-wrap].move-left{right:auto;left:-100%;opacity:0}[data-menu-wrap].move-right{right:-100%;left:auto;opacity:0}.wy-body-for-nav{background:#fcfcfc}.wy-grid-for-nav{position:absolute;width:100%;height:100%}.wy-nav-side{position:fixed;top:0;bottom:0;left:0;padding-bottom:2em;width:300px;overflow-x:hidden;overflow-y:hidden;min-height:100%;color:#9b9b9b;background:#343131;z-index:200}.wy-side-scroll{width:320px;position:relative;overflow-x:hidden;overflow-y:scroll;height:100%}.wy-nav-top{display:none;background:#2980b9;color:#fff;padding:.4045em .809em;position:relative;line-height:50px;text-align:center;font-size:100%;*zoom:1}.wy-nav-top:after,.wy-nav-top:before{display:table;content:""}.wy-nav-top:after{clear:both}.wy-nav-top a{color:#fff;font-weight:700}.wy-nav-top img{margin-right:12px;height:45px;width:45px;background-color:#2980b9;padding:5px;border-radius:100%}.wy-nav-top i{font-size:30px;float:left;cursor:pointer;padding-top:inherit}.wy-nav-content-wrap{margin-left:300px;background:#fcfcfc;min-height:100%}.wy-nav-content{padding:1.618em 3.236em;height:100%;max-width:800px;margin:auto}.wy-body-mask{position:fixed;width:100%;height:100%;background:rgba(0,0,0,.2);display:none;z-index:499}.wy-body-mask.on{display:block}footer{color:grey}footer p{margin-bottom:12px}.rst-content footer span.commit tt,footer span.commit .rst-content tt,footer span.commit code{padding:0;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;font-size:1em;background:none;border:none;color:grey}.rst-footer-buttons{*zoom:1}.rst-footer-buttons:after,.rst-footer-buttons:before{width:100%;display:table;content:""}.rst-footer-buttons:after{clear:both}.rst-breadcrumbs-buttons{margin-top:12px;*zoom:1}.rst-breadcrumbs-buttons:after,.rst-breadcrumbs-buttons:before{display:table;content:""}.rst-breadcrumbs-buttons:after{clear:both}#search-results .search li{margin-bottom:24px;border-bottom:1px solid #e1e4e5;padding-bottom:24px}#search-results .search li:first-child{border-top:1px solid #e1e4e5;padding-top:24px}#search-results .search li a{font-size:120%;margin-bottom:12px;display:inline-block}#search-results .context{color:grey;font-size:90%}.genindextable li>ul{margin-left:24px}@media screen and (max-width:768px){.wy-body-for-nav{background:#fcfcfc}.wy-nav-top{display:block}.wy-nav-side{left:-300px}.wy-nav-side.shift{width:85%;left:0}.wy-menu.wy-menu-vertical,.wy-side-nav-search,.wy-side-scroll{width:auto}.wy-nav-content-wrap{margin-left:0}.wy-nav-content-wrap .wy-nav-content{padding:1.618em}.wy-nav-content-wrap.shift{position:fixed;min-width:100%;left:85%;top:0;height:100%;overflow:hidden}}@media screen and (min-width:1100px){.wy-nav-content-wrap{background:rgba(0,0,0,.05)}.wy-nav-content{margin:0;background:#fcfcfc}}@media print{.rst-versions,.wy-nav-side,footer{display:none}.wy-nav-content-wrap{margin-left:0}}.rst-versions{position:fixed;bottom:0;left:0;width:300px;color:#fcfcfc;background:#1f1d1d;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;z-index:400}.rst-versions a{color:#2980b9;text-decoration:none}.rst-versions .rst-badge-small{display:none}.rst-versions .rst-current-version{padding:12px;background-color:#272525;display:block;text-align:right;font-size:90%;cursor:pointer;color:#27ae60;*zoom:1}.rst-versions .rst-current-version:after,.rst-versions .rst-current-version:before{display:table;content:""}.rst-versions .rst-current-version:after{clear:both}.rst-content .code-block-caption .rst-versions .rst-current-version .headerlink,.rst-content .eqno .rst-versions .rst-current-version .headerlink,.rst-content .rst-versions .rst-current-version .admonition-title,.rst-content code.download .rst-versions .rst-current-version span:first-child,.rst-content dl dt .rst-versions .rst-current-version .headerlink,.rst-content h1 .rst-versions .rst-current-version .headerlink,.rst-content h2 .rst-versions .rst-current-version .headerlink,.rst-content h3 .rst-versions .rst-current-version .headerlink,.rst-content h4 .rst-versions .rst-current-version .headerlink,.rst-content h5 .rst-versions .rst-current-version .headerlink,.rst-content h6 .rst-versions .rst-current-version .headerlink,.rst-content p .rst-versions .rst-current-version .headerlink,.rst-content table>caption .rst-versions .rst-current-version .headerlink,.rst-content tt.download .rst-versions .rst-current-version span:first-child,.rst-versions .rst-current-version .fa,.rst-versions .rst-current-version .icon,.rst-versions .rst-current-version .rst-content .admonition-title,.rst-versions .rst-current-version .rst-content .code-block-caption .headerlink,.rst-versions .rst-current-version .rst-content .eqno .headerlink,.rst-versions .rst-current-version .rst-content code.download span:first-child,.rst-versions .rst-current-version .rst-content dl dt .headerlink,.rst-versions .rst-current-version .rst-content h1 .headerlink,.rst-versions .rst-current-version .rst-content h2 .headerlink,.rst-versions .rst-current-version .rst-content h3 .headerlink,.rst-versions .rst-current-version .rst-content h4 .headerlink,.rst-versions .rst-current-version .rst-content h5 .headerlink,.rst-versions .rst-current-version .rst-content h6 .headerlink,.rst-versions .rst-current-version .rst-content p .headerlink,.rst-versions .rst-current-version .rst-content table>caption .headerlink,.rst-versions .rst-current-version .rst-content tt.download span:first-child,.rst-versions .rst-current-version .wy-menu-vertical li button.toctree-expand,.wy-menu-vertical li .rst-versions .rst-current-version button.toctree-expand{color:#fcfcfc}.rst-versions .rst-current-version .fa-book,.rst-versions .rst-current-version .icon-book{float:left}.rst-versions .rst-current-version.rst-out-of-date{background-color:#e74c3c;color:#fff}.rst-versions .rst-current-version.rst-active-old-version{background-color:#f1c40f;color:#000}.rst-versions.shift-up{height:auto;max-height:100%;overflow-y:scroll}.rst-versions.shift-up .rst-other-versions{display:block}.rst-versions .rst-other-versions{font-size:90%;padding:12px;color:grey;display:none}.rst-versions .rst-other-versions hr{display:block;height:1px;border:0;margin:20px 0;padding:0;border-top:1px solid #413d3d}.rst-versions .rst-other-versions dd{display:inline-block;margin:0}.rst-versions .rst-other-versions dd a{display:inline-block;padding:6px;color:#fcfcfc}.rst-versions.rst-badge{width:auto;bottom:20px;right:20px;left:auto;border:none;max-width:300px;max-height:90%}.rst-versions.rst-badge .fa-book,.rst-versions.rst-badge .icon-book{float:none;line-height:30px}.rst-versions.rst-badge.shift-up .rst-current-version{text-align:right}.rst-versions.rst-badge.shift-up .rst-current-version .fa-book,.rst-versions.rst-badge.shift-up .rst-current-version .icon-book{float:left}.rst-versions.rst-badge>.rst-current-version{width:auto;height:30px;line-height:30px;padding:0 6px;display:block;text-align:center}@media screen and (max-width:768px){.rst-versions{width:85%;display:none}.rst-versions.shift{display:block}}.rst-content .toctree-wrapper>p.caption,.rst-content h1,.rst-content h2,.rst-content h3,.rst-content h4,.rst-content h5,.rst-content h6{margin-bottom:24px}.rst-content img{max-width:100%;height:auto}.rst-content div.figure,.rst-content figure{margin-bottom:24px}.rst-content div.figure .caption-text,.rst-content figure .caption-text{font-style:italic}.rst-content div.figure p:last-child.caption,.rst-content figure p:last-child.caption{margin-bottom:0}.rst-content div.figure.align-center,.rst-content figure.align-center{text-align:center}.rst-content .section>a>img,.rst-content .section>img,.rst-content section>a>img,.rst-content section>img{margin-bottom:24px}.rst-content abbr[title]{text-decoration:none}.rst-content.style-external-links a.reference.external:after{font-family:FontAwesome;content:"\f08e";color:#b3b3b3;vertical-align:super;font-size:60%;margin:0 .2em}.rst-content blockquote{margin-left:24px;line-height:24px;margin-bottom:24px}.rst-content pre.literal-block{white-space:pre;margin:0;padding:12px;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;display:block;overflow:auto}.rst-content div[class^=highlight],.rst-content pre.literal-block{border:1px solid #e1e4e5;overflow-x:auto;margin:1px 0 24px}.rst-content div[class^=highlight] div[class^=highlight],.rst-content pre.literal-block div[class^=highlight]{padding:0;border:none;margin:0}.rst-content div[class^=highlight] td.code{width:100%}.rst-content .linenodiv pre{border-right:1px solid #e6e9ea;margin:0;padding:12px;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;user-select:none;pointer-events:none}.rst-content div[class^=highlight] pre{white-space:pre;margin:0;padding:12px;display:block;overflow:auto}.rst-content div[class^=highlight] pre .hll{display:block;margin:0 -12px;padding:0 12px}.rst-content .linenodiv pre,.rst-content div[class^=highlight] pre,.rst-content pre.literal-block{font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;font-size:12px;line-height:1.4}.rst-content div.highlight .gp,.rst-content div.highlight span.linenos{user-select:none;pointer-events:none}.rst-content div.highlight span.linenos{display:inline-block;padding-left:0;padding-right:12px;margin-right:12px;border-right:1px solid #e6e9ea}.rst-content .code-block-caption{font-style:italic;font-size:85%;line-height:1;padding:1em 0;text-align:center}@media print{.rst-content .codeblock,.rst-content div[class^=highlight],.rst-content div[class^=highlight] pre{white-space:pre-wrap}}.rst-content .admonition,.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .danger,.rst-content .error,.rst-content .hint,.rst-content .important,.rst-content .note,.rst-content .seealso,.rst-content .tip,.rst-content .warning{clear:both}.rst-content .admonition-todo .last,.rst-content .admonition-todo>:last-child,.rst-content .admonition .last,.rst-content .admonition>:last-child,.rst-content .attention .last,.rst-content .attention>:last-child,.rst-content .caution .last,.rst-content .caution>:last-child,.rst-content .danger .last,.rst-content .danger>:last-child,.rst-content .error .last,.rst-content .error>:last-child,.rst-content .hint .last,.rst-content .hint>:last-child,.rst-content .important .last,.rst-content .important>:last-child,.rst-content .note .last,.rst-content .note>:last-child,.rst-content .seealso .last,.rst-content .seealso>:last-child,.rst-content .tip .last,.rst-content .tip>:last-child,.rst-content .warning .last,.rst-content .warning>:last-child{margin-bottom:0}.rst-content .admonition-title:before{margin-right:4px}.rst-content .admonition table{border-color:rgba(0,0,0,.1)}.rst-content .admonition table td,.rst-content .admonition table th{background:transparent!important;border-color:rgba(0,0,0,.1)!important}.rst-content .section ol.loweralpha,.rst-content .section ol.loweralpha>li,.rst-content .toctree-wrapper ol.loweralpha,.rst-content .toctree-wrapper ol.loweralpha>li,.rst-content section ol.loweralpha,.rst-content section ol.loweralpha>li{list-style:lower-alpha}.rst-content .section ol.upperalpha,.rst-content .section ol.upperalpha>li,.rst-content .toctree-wrapper ol.upperalpha,.rst-content .toctree-wrapper ol.upperalpha>li,.rst-content section ol.upperalpha,.rst-content section ol.upperalpha>li{list-style:upper-alpha}.rst-content .section ol li>*,.rst-content .section ul li>*,.rst-content .toctree-wrapper ol li>*,.rst-content .toctree-wrapper ul li>*,.rst-content section ol li>*,.rst-content section ul li>*{margin-top:12px;margin-bottom:12px}.rst-content .section ol li>:first-child,.rst-content .section ul li>:first-child,.rst-content .toctree-wrapper ol li>:first-child,.rst-content .toctree-wrapper ul li>:first-child,.rst-content section ol li>:first-child,.rst-content section ul li>:first-child{margin-top:0}.rst-content .section ol li>p,.rst-content .section ol li>p:last-child,.rst-content .section ul li>p,.rst-content .section ul li>p:last-child,.rst-content .toctree-wrapper ol li>p,.rst-content .toctree-wrapper ol li>p:last-child,.rst-content .toctree-wrapper ul li>p,.rst-content .toctree-wrapper ul li>p:last-child,.rst-content section ol li>p,.rst-content section ol li>p:last-child,.rst-content section ul li>p,.rst-content section ul li>p:last-child{margin-bottom:12px}.rst-content .section ol li>p:only-child,.rst-content .section ol li>p:only-child:last-child,.rst-content .section ul li>p:only-child,.rst-content .section ul li>p:only-child:last-child,.rst-content .toctree-wrapper ol li>p:only-child,.rst-content .toctree-wrapper ol li>p:only-child:last-child,.rst-content .toctree-wrapper ul li>p:only-child,.rst-content .toctree-wrapper ul li>p:only-child:last-child,.rst-content section ol li>p:only-child,.rst-content section ol li>p:only-child:last-child,.rst-content section ul li>p:only-child,.rst-content section ul li>p:only-child:last-child{margin-bottom:0}.rst-content .section ol li>ol,.rst-content .section ol li>ul,.rst-content .section ul li>ol,.rst-content .section ul li>ul,.rst-content .toctree-wrapper ol li>ol,.rst-content .toctree-wrapper ol li>ul,.rst-content .toctree-wrapper ul li>ol,.rst-content .toctree-wrapper ul li>ul,.rst-content section ol li>ol,.rst-content section ol li>ul,.rst-content section ul li>ol,.rst-content section ul li>ul{margin-bottom:12px}.rst-content .section ol.simple li>*,.rst-content .section ol.simple li ol,.rst-content .section ol.simple li ul,.rst-content .section ul.simple li>*,.rst-content .section ul.simple li ol,.rst-content .section ul.simple li ul,.rst-content .toctree-wrapper ol.simple li>*,.rst-content .toctree-wrapper ol.simple li ol,.rst-content .toctree-wrapper ol.simple li ul,.rst-content .toctree-wrapper ul.simple li>*,.rst-content .toctree-wrapper ul.simple li ol,.rst-content .toctree-wrapper ul.simple li ul,.rst-content section ol.simple li>*,.rst-content section ol.simple li ol,.rst-content section ol.simple li ul,.rst-content section ul.simple li>*,.rst-content section ul.simple li ol,.rst-content section ul.simple li ul{margin-top:0;margin-bottom:0}.rst-content .line-block{margin-left:0;margin-bottom:24px;line-height:24px}.rst-content .line-block .line-block{margin-left:24px;margin-bottom:0}.rst-content .topic-title{font-weight:700;margin-bottom:12px}.rst-content .toc-backref{color:#404040}.rst-content .align-right{float:right;margin:0 0 24px 24px}.rst-content .align-left{float:left;margin:0 24px 24px 0}.rst-content .align-center{margin:auto}.rst-content .align-center:not(table){display:block}.rst-content .code-block-caption .headerlink,.rst-content .eqno .headerlink,.rst-content .toctree-wrapper>p.caption .headerlink,.rst-content dl dt .headerlink,.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content p.caption .headerlink,.rst-content p .headerlink,.rst-content table>caption .headerlink{opacity:0;font-size:14px;font-family:FontAwesome;margin-left:.5em}.rst-content .code-block-caption .headerlink:focus,.rst-content .code-block-caption:hover .headerlink,.rst-content .eqno .headerlink:focus,.rst-content .eqno:hover .headerlink,.rst-content .toctree-wrapper>p.caption .headerlink:focus,.rst-content .toctree-wrapper>p.caption:hover .headerlink,.rst-content dl dt .headerlink:focus,.rst-content dl dt:hover .headerlink,.rst-content h1 .headerlink:focus,.rst-content h1:hover .headerlink,.rst-content h2 .headerlink:focus,.rst-content h2:hover .headerlink,.rst-content h3 .headerlink:focus,.rst-content h3:hover .headerlink,.rst-content h4 .headerlink:focus,.rst-content h4:hover .headerlink,.rst-content h5 .headerlink:focus,.rst-content h5:hover .headerlink,.rst-content h6 .headerlink:focus,.rst-content h6:hover .headerlink,.rst-content p.caption .headerlink:focus,.rst-content p.caption:hover .headerlink,.rst-content p .headerlink:focus,.rst-content p:hover .headerlink,.rst-content table>caption .headerlink:focus,.rst-content table>caption:hover .headerlink{opacity:1}.rst-content p a{overflow-wrap:anywhere}.rst-content .wy-table td p,.rst-content .wy-table td ul,.rst-content .wy-table th p,.rst-content .wy-table th ul,.rst-content table.docutils td p,.rst-content table.docutils td ul,.rst-content table.docutils th p,.rst-content table.docutils th ul,.rst-content table.field-list td p,.rst-content table.field-list td ul,.rst-content table.field-list th p,.rst-content table.field-list th ul{font-size:inherit}.rst-content .btn:focus{outline:2px solid}.rst-content table>caption .headerlink:after{font-size:12px}.rst-content .centered{text-align:center}.rst-content .sidebar{float:right;width:40%;display:block;margin:0 0 24px 24px;padding:24px;background:#f3f6f6;border:1px solid #e1e4e5}.rst-content .sidebar dl,.rst-content .sidebar p,.rst-content .sidebar ul{font-size:90%}.rst-content .sidebar .last,.rst-content .sidebar>:last-child{margin-bottom:0}.rst-content .sidebar .sidebar-title{display:block;font-family:Roboto Slab,ff-tisa-web-pro,Georgia,Arial,sans-serif;font-weight:700;background:#e1e4e5;padding:6px 12px;margin:-24px -24px 24px;font-size:100%}.rst-content .highlighted{background:#f1c40f;box-shadow:0 0 0 2px #f1c40f;display:inline;font-weight:700}.rst-content .citation-reference,.rst-content .footnote-reference{vertical-align:baseline;position:relative;top:-.4em;line-height:0;font-size:90%}.rst-content .citation-reference>span.fn-bracket,.rst-content .footnote-reference>span.fn-bracket{display:none}.rst-content .hlist{width:100%}.rst-content dl dt span.classifier:before{content:" : "}.rst-content dl dt span.classifier-delimiter{display:none!important}html.writer-html4 .rst-content table.docutils.citation,html.writer-html4 .rst-content table.docutils.footnote{background:none;border:none}html.writer-html4 .rst-content table.docutils.citation td,html.writer-html4 .rst-content table.docutils.citation tr,html.writer-html4 .rst-content table.docutils.footnote td,html.writer-html4 .rst-content table.docutils.footnote tr{border:none;background-color:transparent!important;white-space:normal}html.writer-html4 .rst-content table.docutils.citation td.label,html.writer-html4 .rst-content table.docutils.footnote td.label{padding-left:0;padding-right:0;vertical-align:top}html.writer-html5 .rst-content dl.citation,html.writer-html5 .rst-content dl.field-list,html.writer-html5 .rst-content dl.footnote{display:grid;grid-template-columns:auto minmax(80%,95%)}html.writer-html5 .rst-content dl.citation>dt,html.writer-html5 .rst-content dl.field-list>dt,html.writer-html5 .rst-content dl.footnote>dt{display:inline-grid;grid-template-columns:max-content auto}html.writer-html5 .rst-content aside.citation,html.writer-html5 .rst-content aside.footnote,html.writer-html5 .rst-content div.citation{display:grid;grid-template-columns:auto auto minmax(.65rem,auto) minmax(40%,95%)}html.writer-html5 .rst-content aside.citation>span.label,html.writer-html5 .rst-content aside.footnote>span.label,html.writer-html5 .rst-content div.citation>span.label{grid-column-start:1;grid-column-end:2}html.writer-html5 .rst-content aside.citation>span.backrefs,html.writer-html5 .rst-content aside.footnote>span.backrefs,html.writer-html5 .rst-content div.citation>span.backrefs{grid-column-start:2;grid-column-end:3;grid-row-start:1;grid-row-end:3}html.writer-html5 .rst-content aside.citation>p,html.writer-html5 .rst-content aside.footnote>p,html.writer-html5 .rst-content div.citation>p{grid-column-start:4;grid-column-end:5}html.writer-html5 .rst-content dl.citation,html.writer-html5 .rst-content dl.field-list,html.writer-html5 .rst-content dl.footnote{margin-bottom:24px}html.writer-html5 .rst-content dl.citation>dt,html.writer-html5 .rst-content dl.field-list>dt,html.writer-html5 .rst-content dl.footnote>dt{padding-left:1rem}html.writer-html5 .rst-content dl.citation>dd,html.writer-html5 .rst-content dl.citation>dt,html.writer-html5 .rst-content dl.field-list>dd,html.writer-html5 .rst-content dl.field-list>dt,html.writer-html5 .rst-content dl.footnote>dd,html.writer-html5 .rst-content dl.footnote>dt{margin-bottom:0}html.writer-html5 .rst-content dl.citation,html.writer-html5 .rst-content dl.footnote{font-size:.9rem}html.writer-html5 .rst-content dl.citation>dt,html.writer-html5 .rst-content dl.footnote>dt{margin:0 .5rem .5rem 0;line-height:1.2rem;word-break:break-all;font-weight:400}html.writer-html5 .rst-content dl.citation>dt>span.brackets:before,html.writer-html5 .rst-content dl.footnote>dt>span.brackets:before{content:"["}html.writer-html5 .rst-content dl.citation>dt>span.brackets:after,html.writer-html5 .rst-content dl.footnote>dt>span.brackets:after{content:"]"}html.writer-html5 .rst-content dl.citation>dt>span.fn-backref,html.writer-html5 .rst-content dl.footnote>dt>span.fn-backref{text-align:left;font-style:italic;margin-left:.65rem;word-break:break-word;word-spacing:-.1rem;max-width:5rem}html.writer-html5 .rst-content dl.citation>dt>span.fn-backref>a,html.writer-html5 .rst-content dl.footnote>dt>span.fn-backref>a{word-break:keep-all}html.writer-html5 .rst-content dl.citation>dt>span.fn-backref>a:not(:first-child):before,html.writer-html5 .rst-content dl.footnote>dt>span.fn-backref>a:not(:first-child):before{content:" "}html.writer-html5 .rst-content dl.citation>dd,html.writer-html5 .rst-content dl.footnote>dd{margin:0 0 .5rem;line-height:1.2rem}html.writer-html5 .rst-content dl.citation>dd p,html.writer-html5 .rst-content dl.footnote>dd p{font-size:.9rem}html.writer-html5 .rst-content aside.citation,html.writer-html5 .rst-content aside.footnote,html.writer-html5 .rst-content div.citation{padding-left:1rem;padding-right:1rem;font-size:.9rem;line-height:1.2rem}html.writer-html5 .rst-content aside.citation p,html.writer-html5 .rst-content aside.footnote p,html.writer-html5 .rst-content div.citation p{font-size:.9rem;line-height:1.2rem;margin-bottom:12px}html.writer-html5 .rst-content aside.citation span.backrefs,html.writer-html5 .rst-content aside.footnote span.backrefs,html.writer-html5 .rst-content div.citation span.backrefs{text-align:left;font-style:italic;margin-left:.65rem;word-break:break-word;word-spacing:-.1rem;max-width:5rem}html.writer-html5 .rst-content aside.citation span.backrefs>a,html.writer-html5 .rst-content aside.footnote span.backrefs>a,html.writer-html5 .rst-content div.citation span.backrefs>a{word-break:keep-all}html.writer-html5 .rst-content aside.citation span.backrefs>a:not(:first-child):before,html.writer-html5 .rst-content aside.footnote span.backrefs>a:not(:first-child):before,html.writer-html5 .rst-content div.citation span.backrefs>a:not(:first-child):before{content:" "}html.writer-html5 .rst-content aside.citation span.label,html.writer-html5 .rst-content aside.footnote span.label,html.writer-html5 .rst-content div.citation span.label{line-height:1.2rem}html.writer-html5 .rst-content aside.citation-list,html.writer-html5 .rst-content aside.footnote-list,html.writer-html5 .rst-content div.citation-list{margin-bottom:24px}html.writer-html5 .rst-content dl.option-list kbd{font-size:.9rem}.rst-content table.docutils.footnote,html.writer-html4 .rst-content table.docutils.citation,html.writer-html5 .rst-content aside.footnote,html.writer-html5 .rst-content aside.footnote-list aside.footnote,html.writer-html5 .rst-content div.citation-list>div.citation,html.writer-html5 .rst-content dl.citation,html.writer-html5 .rst-content dl.footnote{color:grey}.rst-content table.docutils.footnote code,.rst-content table.docutils.footnote tt,html.writer-html4 .rst-content table.docutils.citation code,html.writer-html4 .rst-content table.docutils.citation tt,html.writer-html5 .rst-content aside.footnote-list aside.footnote code,html.writer-html5 .rst-content aside.footnote-list aside.footnote tt,html.writer-html5 .rst-content aside.footnote code,html.writer-html5 .rst-content aside.footnote tt,html.writer-html5 .rst-content div.citation-list>div.citation code,html.writer-html5 .rst-content div.citation-list>div.citation tt,html.writer-html5 .rst-content dl.citation code,html.writer-html5 .rst-content dl.citation tt,html.writer-html5 .rst-content dl.footnote code,html.writer-html5 .rst-content dl.footnote tt{color:#555}.rst-content .wy-table-responsive.citation,.rst-content .wy-table-responsive.footnote{margin-bottom:0}.rst-content .wy-table-responsive.citation+:not(.citation),.rst-content .wy-table-responsive.footnote+:not(.footnote){margin-top:24px}.rst-content .wy-table-responsive.citation:last-child,.rst-content .wy-table-responsive.footnote:last-child{margin-bottom:24px}.rst-content table.docutils th{border-color:#e1e4e5}html.writer-html5 .rst-content table.docutils th{border:1px solid #e1e4e5}html.writer-html5 .rst-content table.docutils td>p,html.writer-html5 .rst-content table.docutils th>p{line-height:1rem;margin-bottom:0;font-size:.9rem}.rst-content table.docutils td .last,.rst-content table.docutils td .last>:last-child{margin-bottom:0}.rst-content table.field-list,.rst-content table.field-list td{border:none}.rst-content table.field-list td p{line-height:inherit}.rst-content table.field-list td>strong{display:inline-block}.rst-content table.field-list .field-name{padding-right:10px;text-align:left;white-space:nowrap}.rst-content table.field-list .field-body{text-align:left}.rst-content code,.rst-content tt{color:#000;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;padding:2px 5px}.rst-content code big,.rst-content code em,.rst-content tt big,.rst-content tt em{font-size:100%!important;line-height:normal}.rst-content code.literal,.rst-content tt.literal{color:#e74c3c;white-space:normal}.rst-content code.xref,.rst-content tt.xref,a .rst-content code,a .rst-content tt{font-weight:700;color:#404040;overflow-wrap:normal}.rst-content kbd,.rst-content pre,.rst-content samp{font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace}.rst-content a code,.rst-content a tt{color:#2980b9}.rst-content dl{margin-bottom:24px}.rst-content dl dt{font-weight:700;margin-bottom:12px}.rst-content dl ol,.rst-content dl p,.rst-content dl table,.rst-content dl ul{margin-bottom:12px}.rst-content dl dd{margin:0 0 12px 24px;line-height:24px}.rst-content dl dd>ol:last-child,.rst-content dl dd>p:last-child,.rst-content dl dd>table:last-child,.rst-content dl dd>ul:last-child{margin-bottom:0}html.writer-html4 .rst-content dl:not(.docutils),html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple){margin-bottom:24px}html.writer-html4 .rst-content dl:not(.docutils)>dt,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt{display:table;margin:6px 0;font-size:90%;line-height:normal;background:#e7f2fa;color:#2980b9;border-top:3px solid #6ab0de;padding:6px;position:relative}html.writer-html4 .rst-content dl:not(.docutils)>dt:before,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt:before{color:#6ab0de}html.writer-html4 .rst-content dl:not(.docutils)>dt .headerlink,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt .headerlink{color:#404040;font-size:100%!important}html.writer-html4 .rst-content dl:not(.docutils) dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt{margin-bottom:6px;border:none;border-left:3px solid #ccc;background:#f0f0f0;color:#555}html.writer-html4 .rst-content dl:not(.docutils) dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt .headerlink,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt .headerlink{color:#404040;font-size:100%!important}html.writer-html4 .rst-content dl:not(.docutils)>dt:first-child,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt:first-child{margin-top:0}html.writer-html4 .rst-content dl:not(.docutils) code.descclassname,html.writer-html4 .rst-content dl:not(.docutils) code.descname,html.writer-html4 .rst-content dl:not(.docutils) tt.descclassname,html.writer-html4 .rst-content dl:not(.docutils) tt.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) code.descclassname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) code.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) tt.descclassname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) tt.descname{background-color:transparent;border:none;padding:0;font-size:100%!important}html.writer-html4 .rst-content dl:not(.docutils) code.descname,html.writer-html4 .rst-content dl:not(.docutils) tt.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) code.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) tt.descname{font-weight:700}html.writer-html4 .rst-content dl:not(.docutils) .optional,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .optional{display:inline-block;padding:0 4px;color:#000;font-weight:700}html.writer-html4 .rst-content dl:not(.docutils) .property,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .property{display:inline-block;padding-right:8px;max-width:100%}html.writer-html4 .rst-content dl:not(.docutils) .k,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .k{font-style:italic}html.writer-html4 .rst-content dl:not(.docutils) .descclassname,html.writer-html4 .rst-content dl:not(.docutils) .descname,html.writer-html4 .rst-content dl:not(.docutils) .sig-name,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .descclassname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .sig-name{font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;color:#000}.rst-content .viewcode-back,.rst-content .viewcode-link{display:inline-block;color:#27ae60;font-size:80%;padding-left:24px}.rst-content .viewcode-back{display:block;float:right}.rst-content p.rubric{margin-bottom:12px;font-weight:700}.rst-content code.download,.rst-content tt.download{background:inherit;padding:inherit;font-weight:400;font-family:inherit;font-size:inherit;color:inherit;border:inherit;white-space:inherit}.rst-content code.download span:first-child,.rst-content tt.download span:first-child{-webkit-font-smoothing:subpixel-antialiased}.rst-content code.download span:first-child:before,.rst-content tt.download span:first-child:before{margin-right:4px}.rst-content .guilabel,.rst-content .menuselection{font-size:80%;font-weight:700;border-radius:4px;padding:2.4px 6px;margin:auto 2px}.rst-content .guilabel,.rst-content .menuselection{border:1px solid #7fbbe3;background:#e7f2fa}.rst-content :not(dl.option-list)>:not(dt):not(kbd):not(.kbd)>.kbd,.rst-content :not(dl.option-list)>:not(dt):not(kbd):not(.kbd)>kbd{color:inherit;font-size:80%;background-color:#fff;border:1px solid #a6a6a6;border-radius:4px;box-shadow:0 2px grey;padding:2.4px 6px;margin:auto 0}.rst-content .versionmodified{font-style:italic}@media screen and (max-width:480px){.rst-content .sidebar{width:100%}}span[id*=MathJax-Span]{color:#404040}.math{text-align:center}@font-face{font-family:Lato;src:url(fonts/lato-normal.woff2?bd03a2cc277bbbc338d464e679fe9942) format("woff2"),url(fonts/lato-normal.woff?27bd77b9162d388cb8d4c4217c7c5e2a) format("woff");font-weight:400;font-style:normal;font-display:block}@font-face{font-family:Lato;src:url(fonts/lato-bold.woff2?cccb897485813c7c256901dbca54ecf2) format("woff2"),url(fonts/lato-bold.woff?d878b6c29b10beca227e9eef4246111b) format("woff");font-weight:700;font-style:normal;font-display:block}@font-face{font-family:Lato;src:url(fonts/lato-bold-italic.woff2?0b6bb6725576b072c5d0b02ecdd1900d) format("woff2"),url(fonts/lato-bold-italic.woff?9c7e4e9eb485b4a121c760e61bc3707c) format("woff");font-weight:700;font-style:italic;font-display:block}@font-face{font-family:Lato;src:url(fonts/lato-normal-italic.woff2?4eb103b4d12be57cb1d040ed5e162e9d) format("woff2"),url(fonts/lato-normal-italic.woff?f28f2d6482446544ef1ea1ccc6dd5892) format("woff");font-weight:400;font-style:italic;font-display:block}@font-face{font-family:Roboto Slab;font-style:normal;font-weight:400;src:url(fonts/Roboto-Slab-Regular.woff2?7abf5b8d04d26a2cafea937019bca958) format("woff2"),url(fonts/Roboto-Slab-Regular.woff?c1be9284088d487c5e3ff0a10a92e58c) format("woff");font-display:block}@font-face{font-family:Roboto Slab;font-style:normal;font-weight:700;src:url(fonts/Roboto-Slab-Bold.woff2?9984f4a9bda09be08e83f2506954adbe) format("woff2"),url(fonts/Roboto-Slab-Bold.woff?bed5564a116b05148e3b3bea6fb1162a) format("woff");font-display:block} \ No newline at end of file + */@font-face{font-family:FontAwesome;src:url(fonts/fontawesome-webfont.eot?674f50d287a8c48dc19ba404d20fe713);src:url(fonts/fontawesome-webfont.eot?674f50d287a8c48dc19ba404d20fe713?#iefix&v=4.7.0) format("embedded-opentype"),url(fonts/fontawesome-webfont.woff2?af7ae505a9eed503f8b8e6982036873e) format("woff2"),url(fonts/fontawesome-webfont.woff?fee66e712a8a08eef5805a46892932ad) format("woff"),url(fonts/fontawesome-webfont.ttf?b06871f281fee6b241d60582ae9369b9) format("truetype"),url(fonts/fontawesome-webfont.svg?912ec66d7572ff821749319396470bde#fontawesomeregular) format("svg");font-weight:400;font-style:normal}.fa,.icon,.rst-content .admonition-title,.rst-content .code-block-caption .headerlink,.rst-content .eqno .headerlink,.rst-content code.download span:first-child,.rst-content dl dt .headerlink,.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content p.caption .headerlink,.rst-content p .headerlink,.rst-content table>caption .headerlink,.rst-content tt.download span:first-child,.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand,.wy-menu-vertical li button.toctree-expand{display:inline-block;font:normal normal normal 14px/1 FontAwesome;font-size:inherit;text-rendering:auto;-webkit-font-smoothing:antialiased;-moz-osx-font-smoothing:grayscale}.fa-lg{font-size:1.33333em;line-height:.75em;vertical-align:-15%}.fa-2x{font-size:2em}.fa-3x{font-size:3em}.fa-4x{font-size:4em}.fa-5x{font-size:5em}.fa-fw{width:1.28571em;text-align:center}.fa-ul{padding-left:0;margin-left:2.14286em;list-style-type:none}.fa-ul>li{position:relative}.fa-li{position:absolute;left:-2.14286em;width:2.14286em;top:.14286em;text-align:center}.fa-li.fa-lg{left:-1.85714em}.fa-border{padding:.2em .25em .15em;border:.08em solid #eee;border-radius:.1em}.fa-pull-left{float:left}.fa-pull-right{float:right}.fa-pull-left.icon,.fa.fa-pull-left,.rst-content .code-block-caption .fa-pull-left.headerlink,.rst-content .eqno .fa-pull-left.headerlink,.rst-content .fa-pull-left.admonition-title,.rst-content code.download span.fa-pull-left:first-child,.rst-content dl dt .fa-pull-left.headerlink,.rst-content h1 .fa-pull-left.headerlink,.rst-content h2 .fa-pull-left.headerlink,.rst-content h3 .fa-pull-left.headerlink,.rst-content h4 .fa-pull-left.headerlink,.rst-content h5 .fa-pull-left.headerlink,.rst-content h6 .fa-pull-left.headerlink,.rst-content p .fa-pull-left.headerlink,.rst-content table>caption .fa-pull-left.headerlink,.rst-content tt.download span.fa-pull-left:first-child,.wy-menu-vertical li.current>a button.fa-pull-left.toctree-expand,.wy-menu-vertical li.on a button.fa-pull-left.toctree-expand,.wy-menu-vertical li button.fa-pull-left.toctree-expand{margin-right:.3em}.fa-pull-right.icon,.fa.fa-pull-right,.rst-content .code-block-caption .fa-pull-right.headerlink,.rst-content .eqno .fa-pull-right.headerlink,.rst-content .fa-pull-right.admonition-title,.rst-content code.download span.fa-pull-right:first-child,.rst-content dl dt .fa-pull-right.headerlink,.rst-content h1 .fa-pull-right.headerlink,.rst-content h2 .fa-pull-right.headerlink,.rst-content h3 .fa-pull-right.headerlink,.rst-content h4 .fa-pull-right.headerlink,.rst-content h5 .fa-pull-right.headerlink,.rst-content h6 .fa-pull-right.headerlink,.rst-content p .fa-pull-right.headerlink,.rst-content table>caption .fa-pull-right.headerlink,.rst-content tt.download span.fa-pull-right:first-child,.wy-menu-vertical li.current>a button.fa-pull-right.toctree-expand,.wy-menu-vertical li.on a button.fa-pull-right.toctree-expand,.wy-menu-vertical li button.fa-pull-right.toctree-expand{margin-left:.3em}.pull-right{float:right}.pull-left{float:left}.fa.pull-left,.pull-left.icon,.rst-content .code-block-caption .pull-left.headerlink,.rst-content .eqno .pull-left.headerlink,.rst-content .pull-left.admonition-title,.rst-content code.download span.pull-left:first-child,.rst-content dl dt .pull-left.headerlink,.rst-content h1 .pull-left.headerlink,.rst-content h2 .pull-left.headerlink,.rst-content h3 .pull-left.headerlink,.rst-content h4 .pull-left.headerlink,.rst-content h5 .pull-left.headerlink,.rst-content h6 .pull-left.headerlink,.rst-content p .pull-left.headerlink,.rst-content table>caption .pull-left.headerlink,.rst-content tt.download span.pull-left:first-child,.wy-menu-vertical li.current>a button.pull-left.toctree-expand,.wy-menu-vertical li.on a button.pull-left.toctree-expand,.wy-menu-vertical li button.pull-left.toctree-expand{margin-right:.3em}.fa.pull-right,.pull-right.icon,.rst-content .code-block-caption .pull-right.headerlink,.rst-content .eqno .pull-right.headerlink,.rst-content .pull-right.admonition-title,.rst-content code.download span.pull-right:first-child,.rst-content dl dt .pull-right.headerlink,.rst-content h1 .pull-right.headerlink,.rst-content h2 .pull-right.headerlink,.rst-content h3 .pull-right.headerlink,.rst-content h4 .pull-right.headerlink,.rst-content h5 .pull-right.headerlink,.rst-content h6 .pull-right.headerlink,.rst-content p .pull-right.headerlink,.rst-content table>caption .pull-right.headerlink,.rst-content tt.download span.pull-right:first-child,.wy-menu-vertical li.current>a button.pull-right.toctree-expand,.wy-menu-vertical li.on a button.pull-right.toctree-expand,.wy-menu-vertical li button.pull-right.toctree-expand{margin-left:.3em}.fa-spin{-webkit-animation:fa-spin 2s linear infinite;animation:fa-spin 2s linear infinite}.fa-pulse{-webkit-animation:fa-spin 1s steps(8) infinite;animation:fa-spin 1s steps(8) infinite}@-webkit-keyframes fa-spin{0%{-webkit-transform:rotate(0deg);transform:rotate(0deg)}to{-webkit-transform:rotate(359deg);transform:rotate(359deg)}}@keyframes fa-spin{0%{-webkit-transform:rotate(0deg);transform:rotate(0deg)}to{-webkit-transform:rotate(359deg);transform:rotate(359deg)}}.fa-rotate-90{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=1)";-webkit-transform:rotate(90deg);-ms-transform:rotate(90deg);transform:rotate(90deg)}.fa-rotate-180{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=2)";-webkit-transform:rotate(180deg);-ms-transform:rotate(180deg);transform:rotate(180deg)}.fa-rotate-270{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=3)";-webkit-transform:rotate(270deg);-ms-transform:rotate(270deg);transform:rotate(270deg)}.fa-flip-horizontal{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=0, mirror=1)";-webkit-transform:scaleX(-1);-ms-transform:scaleX(-1);transform:scaleX(-1)}.fa-flip-vertical{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=2, mirror=1)";-webkit-transform:scaleY(-1);-ms-transform:scaleY(-1);transform:scaleY(-1)}:root .fa-flip-horizontal,:root .fa-flip-vertical,:root .fa-rotate-90,:root .fa-rotate-180,:root .fa-rotate-270{filter:none}.fa-stack{position:relative;display:inline-block;width:2em;height:2em;line-height:2em;vertical-align:middle}.fa-stack-1x,.fa-stack-2x{position:absolute;left:0;width:100%;text-align:center}.fa-stack-1x{line-height:inherit}.fa-stack-2x{font-size:2em}.fa-inverse{color:#fff}.fa-glass:before{content:""}.fa-music:before{content:""}.fa-search:before,.icon-search:before{content:""}.fa-envelope-o:before{content:""}.fa-heart:before{content:""}.fa-star:before{content:""}.fa-star-o:before{content:""}.fa-user:before{content:""}.fa-film:before{content:""}.fa-th-large:before{content:""}.fa-th:before{content:""}.fa-th-list:before{content:""}.fa-check:before{content:""}.fa-close:before,.fa-remove:before,.fa-times:before{content:""}.fa-search-plus:before{content:""}.fa-search-minus:before{content:""}.fa-power-off:before{content:""}.fa-signal:before{content:""}.fa-cog:before,.fa-gear:before{content:""}.fa-trash-o:before{content:""}.fa-home:before,.icon-home:before{content:""}.fa-file-o:before{content:""}.fa-clock-o:before{content:""}.fa-road:before{content:""}.fa-download:before,.rst-content code.download span:first-child:before,.rst-content tt.download span:first-child:before{content:""}.fa-arrow-circle-o-down:before{content:""}.fa-arrow-circle-o-up:before{content:""}.fa-inbox:before{content:""}.fa-play-circle-o:before{content:""}.fa-repeat:before,.fa-rotate-right:before{content:""}.fa-refresh:before{content:""}.fa-list-alt:before{content:""}.fa-lock:before{content:""}.fa-flag:before{content:""}.fa-headphones:before{content:""}.fa-volume-off:before{content:""}.fa-volume-down:before{content:""}.fa-volume-up:before{content:""}.fa-qrcode:before{content:""}.fa-barcode:before{content:""}.fa-tag:before{content:""}.fa-tags:before{content:""}.fa-book:before,.icon-book:before{content:""}.fa-bookmark:before{content:""}.fa-print:before{content:""}.fa-camera:before{content:""}.fa-font:before{content:""}.fa-bold:before{content:""}.fa-italic:before{content:""}.fa-text-height:before{content:""}.fa-text-width:before{content:""}.fa-align-left:before{content:""}.fa-align-center:before{content:""}.fa-align-right:before{content:""}.fa-align-justify:before{content:""}.fa-list:before{content:""}.fa-dedent:before,.fa-outdent:before{content:""}.fa-indent:before{content:""}.fa-video-camera:before{content:""}.fa-image:before,.fa-photo:before,.fa-picture-o:before{content:""}.fa-pencil:before{content:""}.fa-map-marker:before{content:""}.fa-adjust:before{content:""}.fa-tint:before{content:""}.fa-edit:before,.fa-pencil-square-o:before{content:""}.fa-share-square-o:before{content:""}.fa-check-square-o:before{content:""}.fa-arrows:before{content:""}.fa-step-backward:before{content:""}.fa-fast-backward:before{content:""}.fa-backward:before{content:""}.fa-play:before{content:""}.fa-pause:before{content:""}.fa-stop:before{content:""}.fa-forward:before{content:""}.fa-fast-forward:before{content:""}.fa-step-forward:before{content:""}.fa-eject:before{content:""}.fa-chevron-left:before{content:""}.fa-chevron-right:before{content:""}.fa-plus-circle:before{content:""}.fa-minus-circle:before{content:""}.fa-times-circle:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before{content:""}.fa-check-circle:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before{content:""}.fa-question-circle:before{content:""}.fa-info-circle:before{content:""}.fa-crosshairs:before{content:""}.fa-times-circle-o:before{content:""}.fa-check-circle-o:before{content:""}.fa-ban:before{content:""}.fa-arrow-left:before{content:""}.fa-arrow-right:before{content:""}.fa-arrow-up:before{content:""}.fa-arrow-down:before{content:""}.fa-mail-forward:before,.fa-share:before{content:""}.fa-expand:before{content:""}.fa-compress:before{content:""}.fa-plus:before{content:""}.fa-minus:before{content:""}.fa-asterisk:before{content:""}.fa-exclamation-circle:before,.rst-content .admonition-title:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before{content:""}.fa-gift:before{content:""}.fa-leaf:before{content:""}.fa-fire:before,.icon-fire:before{content:""}.fa-eye:before{content:""}.fa-eye-slash:before{content:""}.fa-exclamation-triangle:before,.fa-warning:before{content:""}.fa-plane:before{content:""}.fa-calendar:before{content:""}.fa-random:before{content:""}.fa-comment:before{content:""}.fa-magnet:before{content:""}.fa-chevron-up:before{content:""}.fa-chevron-down:before{content:""}.fa-retweet:before{content:""}.fa-shopping-cart:before{content:""}.fa-folder:before{content:""}.fa-folder-open:before{content:""}.fa-arrows-v:before{content:""}.fa-arrows-h:before{content:""}.fa-bar-chart-o:before,.fa-bar-chart:before{content:""}.fa-twitter-square:before{content:""}.fa-facebook-square:before{content:""}.fa-camera-retro:before{content:""}.fa-key:before{content:""}.fa-cogs:before,.fa-gears:before{content:""}.fa-comments:before{content:""}.fa-thumbs-o-up:before{content:""}.fa-thumbs-o-down:before{content:""}.fa-star-half:before{content:""}.fa-heart-o:before{content:""}.fa-sign-out:before{content:""}.fa-linkedin-square:before{content:""}.fa-thumb-tack:before{content:""}.fa-external-link:before{content:""}.fa-sign-in:before{content:""}.fa-trophy:before{content:""}.fa-github-square:before{content:""}.fa-upload:before{content:""}.fa-lemon-o:before{content:""}.fa-phone:before{content:""}.fa-square-o:before{content:""}.fa-bookmark-o:before{content:""}.fa-phone-square:before{content:""}.fa-twitter:before{content:""}.fa-facebook-f:before,.fa-facebook:before{content:""}.fa-github:before,.icon-github:before{content:""}.fa-unlock:before{content:""}.fa-credit-card:before{content:""}.fa-feed:before,.fa-rss:before{content:""}.fa-hdd-o:before{content:""}.fa-bullhorn:before{content:""}.fa-bell:before{content:""}.fa-certificate:before{content:""}.fa-hand-o-right:before{content:""}.fa-hand-o-left:before{content:""}.fa-hand-o-up:before{content:""}.fa-hand-o-down:before{content:""}.fa-arrow-circle-left:before,.icon-circle-arrow-left:before{content:""}.fa-arrow-circle-right:before,.icon-circle-arrow-right:before{content:""}.fa-arrow-circle-up:before{content:""}.fa-arrow-circle-down:before{content:""}.fa-globe:before{content:""}.fa-wrench:before{content:""}.fa-tasks:before{content:""}.fa-filter:before{content:""}.fa-briefcase:before{content:""}.fa-arrows-alt:before{content:""}.fa-group:before,.fa-users:before{content:""}.fa-chain:before,.fa-link:before,.icon-link:before{content:""}.fa-cloud:before{content:""}.fa-flask:before{content:""}.fa-cut:before,.fa-scissors:before{content:""}.fa-copy:before,.fa-files-o:before{content:""}.fa-paperclip:before{content:""}.fa-floppy-o:before,.fa-save:before{content:""}.fa-square:before{content:""}.fa-bars:before,.fa-navicon:before,.fa-reorder:before{content:""}.fa-list-ul:before{content:""}.fa-list-ol:before{content:""}.fa-strikethrough:before{content:""}.fa-underline:before{content:""}.fa-table:before{content:""}.fa-magic:before{content:""}.fa-truck:before{content:""}.fa-pinterest:before{content:""}.fa-pinterest-square:before{content:""}.fa-google-plus-square:before{content:""}.fa-google-plus:before{content:""}.fa-money:before{content:""}.fa-caret-down:before,.icon-caret-down:before,.wy-dropdown .caret:before{content:""}.fa-caret-up:before{content:""}.fa-caret-left:before{content:""}.fa-caret-right:before{content:""}.fa-columns:before{content:""}.fa-sort:before,.fa-unsorted:before{content:""}.fa-sort-desc:before,.fa-sort-down:before{content:""}.fa-sort-asc:before,.fa-sort-up:before{content:""}.fa-envelope:before{content:""}.fa-linkedin:before{content:""}.fa-rotate-left:before,.fa-undo:before{content:""}.fa-gavel:before,.fa-legal:before{content:""}.fa-dashboard:before,.fa-tachometer:before{content:""}.fa-comment-o:before{content:""}.fa-comments-o:before{content:""}.fa-bolt:before,.fa-flash:before{content:""}.fa-sitemap:before{content:""}.fa-umbrella:before{content:""}.fa-clipboard:before,.fa-paste:before{content:""}.fa-lightbulb-o:before{content:""}.fa-exchange:before{content:""}.fa-cloud-download:before{content:""}.fa-cloud-upload:before{content:""}.fa-user-md:before{content:""}.fa-stethoscope:before{content:""}.fa-suitcase:before{content:""}.fa-bell-o:before{content:""}.fa-coffee:before{content:""}.fa-cutlery:before{content:""}.fa-file-text-o:before{content:""}.fa-building-o:before{content:""}.fa-hospital-o:before{content:""}.fa-ambulance:before{content:""}.fa-medkit:before{content:""}.fa-fighter-jet:before{content:""}.fa-beer:before{content:""}.fa-h-square:before{content:""}.fa-plus-square:before{content:""}.fa-angle-double-left:before{content:""}.fa-angle-double-right:before{content:""}.fa-angle-double-up:before{content:""}.fa-angle-double-down:before{content:""}.fa-angle-left:before{content:""}.fa-angle-right:before{content:""}.fa-angle-up:before{content:""}.fa-angle-down:before{content:""}.fa-desktop:before{content:""}.fa-laptop:before{content:""}.fa-tablet:before{content:""}.fa-mobile-phone:before,.fa-mobile:before{content:""}.fa-circle-o:before{content:""}.fa-quote-left:before{content:""}.fa-quote-right:before{content:""}.fa-spinner:before{content:""}.fa-circle:before{content:""}.fa-mail-reply:before,.fa-reply:before{content:""}.fa-github-alt:before{content:""}.fa-folder-o:before{content:""}.fa-folder-open-o:before{content:""}.fa-smile-o:before{content:""}.fa-frown-o:before{content:""}.fa-meh-o:before{content:""}.fa-gamepad:before{content:""}.fa-keyboard-o:before{content:""}.fa-flag-o:before{content:""}.fa-flag-checkered:before{content:""}.fa-terminal:before{content:""}.fa-code:before{content:""}.fa-mail-reply-all:before,.fa-reply-all:before{content:""}.fa-star-half-empty:before,.fa-star-half-full:before,.fa-star-half-o:before{content:""}.fa-location-arrow:before{content:""}.fa-crop:before{content:""}.fa-code-fork:before{content:""}.fa-chain-broken:before,.fa-unlink:before{content:""}.fa-question:before{content:""}.fa-info:before{content:""}.fa-exclamation:before{content:""}.fa-superscript:before{content:""}.fa-subscript:before{content:""}.fa-eraser:before{content:""}.fa-puzzle-piece:before{content:""}.fa-microphone:before{content:""}.fa-microphone-slash:before{content:""}.fa-shield:before{content:""}.fa-calendar-o:before{content:""}.fa-fire-extinguisher:before{content:""}.fa-rocket:before{content:""}.fa-maxcdn:before{content:""}.fa-chevron-circle-left:before{content:""}.fa-chevron-circle-right:before{content:""}.fa-chevron-circle-up:before{content:""}.fa-chevron-circle-down:before{content:""}.fa-html5:before{content:""}.fa-css3:before{content:""}.fa-anchor:before{content:""}.fa-unlock-alt:before{content:""}.fa-bullseye:before{content:""}.fa-ellipsis-h:before{content:""}.fa-ellipsis-v:before{content:""}.fa-rss-square:before{content:""}.fa-play-circle:before{content:""}.fa-ticket:before{content:""}.fa-minus-square:before{content:""}.fa-minus-square-o:before,.wy-menu-vertical li.current>a button.toctree-expand:before,.wy-menu-vertical li.on a button.toctree-expand:before{content:""}.fa-level-up:before{content:""}.fa-level-down:before{content:""}.fa-check-square:before{content:""}.fa-pencil-square:before{content:""}.fa-external-link-square:before{content:""}.fa-share-square:before{content:""}.fa-compass:before{content:""}.fa-caret-square-o-down:before,.fa-toggle-down:before{content:""}.fa-caret-square-o-up:before,.fa-toggle-up:before{content:""}.fa-caret-square-o-right:before,.fa-toggle-right:before{content:""}.fa-eur:before,.fa-euro:before{content:""}.fa-gbp:before{content:""}.fa-dollar:before,.fa-usd:before{content:""}.fa-inr:before,.fa-rupee:before{content:""}.fa-cny:before,.fa-jpy:before,.fa-rmb:before,.fa-yen:before{content:""}.fa-rouble:before,.fa-rub:before,.fa-ruble:before{content:""}.fa-krw:before,.fa-won:before{content:""}.fa-bitcoin:before,.fa-btc:before{content:""}.fa-file:before{content:""}.fa-file-text:before{content:""}.fa-sort-alpha-asc:before{content:""}.fa-sort-alpha-desc:before{content:""}.fa-sort-amount-asc:before{content:""}.fa-sort-amount-desc:before{content:""}.fa-sort-numeric-asc:before{content:""}.fa-sort-numeric-desc:before{content:""}.fa-thumbs-up:before{content:""}.fa-thumbs-down:before{content:""}.fa-youtube-square:before{content:""}.fa-youtube:before{content:""}.fa-xing:before{content:""}.fa-xing-square:before{content:""}.fa-youtube-play:before{content:""}.fa-dropbox:before{content:""}.fa-stack-overflow:before{content:""}.fa-instagram:before{content:""}.fa-flickr:before{content:""}.fa-adn:before{content:""}.fa-bitbucket:before,.icon-bitbucket:before{content:""}.fa-bitbucket-square:before{content:""}.fa-tumblr:before{content:""}.fa-tumblr-square:before{content:""}.fa-long-arrow-down:before{content:""}.fa-long-arrow-up:before{content:""}.fa-long-arrow-left:before{content:""}.fa-long-arrow-right:before{content:""}.fa-apple:before{content:""}.fa-windows:before{content:""}.fa-android:before{content:""}.fa-linux:before{content:""}.fa-dribbble:before{content:""}.fa-skype:before{content:""}.fa-foursquare:before{content:""}.fa-trello:before{content:""}.fa-female:before{content:""}.fa-male:before{content:""}.fa-gittip:before,.fa-gratipay:before{content:""}.fa-sun-o:before{content:""}.fa-moon-o:before{content:""}.fa-archive:before{content:""}.fa-bug:before{content:""}.fa-vk:before{content:""}.fa-weibo:before{content:""}.fa-renren:before{content:""}.fa-pagelines:before{content:""}.fa-stack-exchange:before{content:""}.fa-arrow-circle-o-right:before{content:""}.fa-arrow-circle-o-left:before{content:""}.fa-caret-square-o-left:before,.fa-toggle-left:before{content:""}.fa-dot-circle-o:before{content:""}.fa-wheelchair:before{content:""}.fa-vimeo-square:before{content:""}.fa-try:before,.fa-turkish-lira:before{content:""}.fa-plus-square-o:before,.wy-menu-vertical li button.toctree-expand:before{content:""}.fa-space-shuttle:before{content:""}.fa-slack:before{content:""}.fa-envelope-square:before{content:""}.fa-wordpress:before{content:""}.fa-openid:before{content:""}.fa-bank:before,.fa-institution:before,.fa-university:before{content:""}.fa-graduation-cap:before,.fa-mortar-board:before{content:""}.fa-yahoo:before{content:""}.fa-google:before{content:""}.fa-reddit:before{content:""}.fa-reddit-square:before{content:""}.fa-stumbleupon-circle:before{content:""}.fa-stumbleupon:before{content:""}.fa-delicious:before{content:""}.fa-digg:before{content:""}.fa-pied-piper-pp:before{content:""}.fa-pied-piper-alt:before{content:""}.fa-drupal:before{content:""}.fa-joomla:before{content:""}.fa-language:before{content:""}.fa-fax:before{content:""}.fa-building:before{content:""}.fa-child:before{content:""}.fa-paw:before{content:""}.fa-spoon:before{content:""}.fa-cube:before{content:""}.fa-cubes:before{content:""}.fa-behance:before{content:""}.fa-behance-square:before{content:""}.fa-steam:before{content:""}.fa-steam-square:before{content:""}.fa-recycle:before{content:""}.fa-automobile:before,.fa-car:before{content:""}.fa-cab:before,.fa-taxi:before{content:""}.fa-tree:before{content:""}.fa-spotify:before{content:""}.fa-deviantart:before{content:""}.fa-soundcloud:before{content:""}.fa-database:before{content:""}.fa-file-pdf-o:before{content:""}.fa-file-word-o:before{content:""}.fa-file-excel-o:before{content:""}.fa-file-powerpoint-o:before{content:""}.fa-file-image-o:before,.fa-file-photo-o:before,.fa-file-picture-o:before{content:""}.fa-file-archive-o:before,.fa-file-zip-o:before{content:""}.fa-file-audio-o:before,.fa-file-sound-o:before{content:""}.fa-file-movie-o:before,.fa-file-video-o:before{content:""}.fa-file-code-o:before{content:""}.fa-vine:before{content:""}.fa-codepen:before{content:""}.fa-jsfiddle:before{content:""}.fa-life-bouy:before,.fa-life-buoy:before,.fa-life-ring:before,.fa-life-saver:before,.fa-support:before{content:""}.fa-circle-o-notch:before{content:""}.fa-ra:before,.fa-rebel:before,.fa-resistance:before{content:""}.fa-empire:before,.fa-ge:before{content:""}.fa-git-square:before{content:""}.fa-git:before{content:""}.fa-hacker-news:before,.fa-y-combinator-square:before,.fa-yc-square:before{content:""}.fa-tencent-weibo:before{content:""}.fa-qq:before{content:""}.fa-wechat:before,.fa-weixin:before{content:""}.fa-paper-plane:before,.fa-send:before{content:""}.fa-paper-plane-o:before,.fa-send-o:before{content:""}.fa-history:before{content:""}.fa-circle-thin:before{content:""}.fa-header:before{content:""}.fa-paragraph:before{content:""}.fa-sliders:before{content:""}.fa-share-alt:before{content:""}.fa-share-alt-square:before{content:""}.fa-bomb:before{content:""}.fa-futbol-o:before,.fa-soccer-ball-o:before{content:""}.fa-tty:before{content:""}.fa-binoculars:before{content:""}.fa-plug:before{content:""}.fa-slideshare:before{content:""}.fa-twitch:before{content:""}.fa-yelp:before{content:""}.fa-newspaper-o:before{content:""}.fa-wifi:before{content:""}.fa-calculator:before{content:""}.fa-paypal:before{content:""}.fa-google-wallet:before{content:""}.fa-cc-visa:before{content:""}.fa-cc-mastercard:before{content:""}.fa-cc-discover:before{content:""}.fa-cc-amex:before{content:""}.fa-cc-paypal:before{content:""}.fa-cc-stripe:before{content:""}.fa-bell-slash:before{content:""}.fa-bell-slash-o:before{content:""}.fa-trash:before{content:""}.fa-copyright:before{content:""}.fa-at:before{content:""}.fa-eyedropper:before{content:""}.fa-paint-brush:before{content:""}.fa-birthday-cake:before{content:""}.fa-area-chart:before{content:""}.fa-pie-chart:before{content:""}.fa-line-chart:before{content:""}.fa-lastfm:before{content:""}.fa-lastfm-square:before{content:""}.fa-toggle-off:before{content:""}.fa-toggle-on:before{content:""}.fa-bicycle:before{content:""}.fa-bus:before{content:""}.fa-ioxhost:before{content:""}.fa-angellist:before{content:""}.fa-cc:before{content:""}.fa-ils:before,.fa-shekel:before,.fa-sheqel:before{content:""}.fa-meanpath:before{content:""}.fa-buysellads:before{content:""}.fa-connectdevelop:before{content:""}.fa-dashcube:before{content:""}.fa-forumbee:before{content:""}.fa-leanpub:before{content:""}.fa-sellsy:before{content:""}.fa-shirtsinbulk:before{content:""}.fa-simplybuilt:before{content:""}.fa-skyatlas:before{content:""}.fa-cart-plus:before{content:""}.fa-cart-arrow-down:before{content:""}.fa-diamond:before{content:""}.fa-ship:before{content:""}.fa-user-secret:before{content:""}.fa-motorcycle:before{content:""}.fa-street-view:before{content:""}.fa-heartbeat:before{content:""}.fa-venus:before{content:""}.fa-mars:before{content:""}.fa-mercury:before{content:""}.fa-intersex:before,.fa-transgender:before{content:""}.fa-transgender-alt:before{content:""}.fa-venus-double:before{content:""}.fa-mars-double:before{content:""}.fa-venus-mars:before{content:""}.fa-mars-stroke:before{content:""}.fa-mars-stroke-v:before{content:""}.fa-mars-stroke-h:before{content:""}.fa-neuter:before{content:""}.fa-genderless:before{content:""}.fa-facebook-official:before{content:""}.fa-pinterest-p:before{content:""}.fa-whatsapp:before{content:""}.fa-server:before{content:""}.fa-user-plus:before{content:""}.fa-user-times:before{content:""}.fa-bed:before,.fa-hotel:before{content:""}.fa-viacoin:before{content:""}.fa-train:before{content:""}.fa-subway:before{content:""}.fa-medium:before{content:""}.fa-y-combinator:before,.fa-yc:before{content:""}.fa-optin-monster:before{content:""}.fa-opencart:before{content:""}.fa-expeditedssl:before{content:""}.fa-battery-4:before,.fa-battery-full:before,.fa-battery:before{content:""}.fa-battery-3:before,.fa-battery-three-quarters:before{content:""}.fa-battery-2:before,.fa-battery-half:before{content:""}.fa-battery-1:before,.fa-battery-quarter:before{content:""}.fa-battery-0:before,.fa-battery-empty:before{content:""}.fa-mouse-pointer:before{content:""}.fa-i-cursor:before{content:""}.fa-object-group:before{content:""}.fa-object-ungroup:before{content:""}.fa-sticky-note:before{content:""}.fa-sticky-note-o:before{content:""}.fa-cc-jcb:before{content:""}.fa-cc-diners-club:before{content:""}.fa-clone:before{content:""}.fa-balance-scale:before{content:""}.fa-hourglass-o:before{content:""}.fa-hourglass-1:before,.fa-hourglass-start:before{content:""}.fa-hourglass-2:before,.fa-hourglass-half:before{content:""}.fa-hourglass-3:before,.fa-hourglass-end:before{content:""}.fa-hourglass:before{content:""}.fa-hand-grab-o:before,.fa-hand-rock-o:before{content:""}.fa-hand-paper-o:before,.fa-hand-stop-o:before{content:""}.fa-hand-scissors-o:before{content:""}.fa-hand-lizard-o:before{content:""}.fa-hand-spock-o:before{content:""}.fa-hand-pointer-o:before{content:""}.fa-hand-peace-o:before{content:""}.fa-trademark:before{content:""}.fa-registered:before{content:""}.fa-creative-commons:before{content:""}.fa-gg:before{content:""}.fa-gg-circle:before{content:""}.fa-tripadvisor:before{content:""}.fa-odnoklassniki:before{content:""}.fa-odnoklassniki-square:before{content:""}.fa-get-pocket:before{content:""}.fa-wikipedia-w:before{content:""}.fa-safari:before{content:""}.fa-chrome:before{content:""}.fa-firefox:before{content:""}.fa-opera:before{content:""}.fa-internet-explorer:before{content:""}.fa-television:before,.fa-tv:before{content:""}.fa-contao:before{content:""}.fa-500px:before{content:""}.fa-amazon:before{content:""}.fa-calendar-plus-o:before{content:""}.fa-calendar-minus-o:before{content:""}.fa-calendar-times-o:before{content:""}.fa-calendar-check-o:before{content:""}.fa-industry:before{content:""}.fa-map-pin:before{content:""}.fa-map-signs:before{content:""}.fa-map-o:before{content:""}.fa-map:before{content:""}.fa-commenting:before{content:""}.fa-commenting-o:before{content:""}.fa-houzz:before{content:""}.fa-vimeo:before{content:""}.fa-black-tie:before{content:""}.fa-fonticons:before{content:""}.fa-reddit-alien:before{content:""}.fa-edge:before{content:""}.fa-credit-card-alt:before{content:""}.fa-codiepie:before{content:""}.fa-modx:before{content:""}.fa-fort-awesome:before{content:""}.fa-usb:before{content:""}.fa-product-hunt:before{content:""}.fa-mixcloud:before{content:""}.fa-scribd:before{content:""}.fa-pause-circle:before{content:""}.fa-pause-circle-o:before{content:""}.fa-stop-circle:before{content:""}.fa-stop-circle-o:before{content:""}.fa-shopping-bag:before{content:""}.fa-shopping-basket:before{content:""}.fa-hashtag:before{content:""}.fa-bluetooth:before{content:""}.fa-bluetooth-b:before{content:""}.fa-percent:before{content:""}.fa-gitlab:before,.icon-gitlab:before{content:""}.fa-wpbeginner:before{content:""}.fa-wpforms:before{content:""}.fa-envira:before{content:""}.fa-universal-access:before{content:""}.fa-wheelchair-alt:before{content:""}.fa-question-circle-o:before{content:""}.fa-blind:before{content:""}.fa-audio-description:before{content:""}.fa-volume-control-phone:before{content:""}.fa-braille:before{content:""}.fa-assistive-listening-systems:before{content:""}.fa-american-sign-language-interpreting:before,.fa-asl-interpreting:before{content:""}.fa-deaf:before,.fa-deafness:before,.fa-hard-of-hearing:before{content:""}.fa-glide:before{content:""}.fa-glide-g:before{content:""}.fa-sign-language:before,.fa-signing:before{content:""}.fa-low-vision:before{content:""}.fa-viadeo:before{content:""}.fa-viadeo-square:before{content:""}.fa-snapchat:before{content:""}.fa-snapchat-ghost:before{content:""}.fa-snapchat-square:before{content:""}.fa-pied-piper:before{content:""}.fa-first-order:before{content:""}.fa-yoast:before{content:""}.fa-themeisle:before{content:""}.fa-google-plus-circle:before,.fa-google-plus-official:before{content:""}.fa-fa:before,.fa-font-awesome:before{content:""}.fa-handshake-o:before{content:""}.fa-envelope-open:before{content:""}.fa-envelope-open-o:before{content:""}.fa-linode:before{content:""}.fa-address-book:before{content:""}.fa-address-book-o:before{content:""}.fa-address-card:before,.fa-vcard:before{content:""}.fa-address-card-o:before,.fa-vcard-o:before{content:""}.fa-user-circle:before{content:""}.fa-user-circle-o:before{content:""}.fa-user-o:before{content:""}.fa-id-badge:before{content:""}.fa-drivers-license:before,.fa-id-card:before{content:""}.fa-drivers-license-o:before,.fa-id-card-o:before{content:""}.fa-quora:before{content:""}.fa-free-code-camp:before{content:""}.fa-telegram:before{content:""}.fa-thermometer-4:before,.fa-thermometer-full:before,.fa-thermometer:before{content:""}.fa-thermometer-3:before,.fa-thermometer-three-quarters:before{content:""}.fa-thermometer-2:before,.fa-thermometer-half:before{content:""}.fa-thermometer-1:before,.fa-thermometer-quarter:before{content:""}.fa-thermometer-0:before,.fa-thermometer-empty:before{content:""}.fa-shower:before{content:""}.fa-bath:before,.fa-bathtub:before,.fa-s15:before{content:""}.fa-podcast:before{content:""}.fa-window-maximize:before{content:""}.fa-window-minimize:before{content:""}.fa-window-restore:before{content:""}.fa-times-rectangle:before,.fa-window-close:before{content:""}.fa-times-rectangle-o:before,.fa-window-close-o:before{content:""}.fa-bandcamp:before{content:""}.fa-grav:before{content:""}.fa-etsy:before{content:""}.fa-imdb:before{content:""}.fa-ravelry:before{content:""}.fa-eercast:before{content:""}.fa-microchip:before{content:""}.fa-snowflake-o:before{content:""}.fa-superpowers:before{content:""}.fa-wpexplorer:before{content:""}.fa-meetup:before{content:""}.sr-only{position:absolute;width:1px;height:1px;padding:0;margin:-1px;overflow:hidden;clip:rect(0,0,0,0);border:0}.sr-only-focusable:active,.sr-only-focusable:focus{position:static;width:auto;height:auto;margin:0;overflow:visible;clip:auto}.fa,.icon,.rst-content .admonition-title,.rst-content .code-block-caption .headerlink,.rst-content .eqno .headerlink,.rst-content code.download span:first-child,.rst-content dl dt .headerlink,.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content p.caption .headerlink,.rst-content p .headerlink,.rst-content table>caption .headerlink,.rst-content tt.download span:first-child,.wy-dropdown .caret,.wy-inline-validate.wy-inline-validate-danger .wy-input-context,.wy-inline-validate.wy-inline-validate-info .wy-input-context,.wy-inline-validate.wy-inline-validate-success .wy-input-context,.wy-inline-validate.wy-inline-validate-warning .wy-input-context,.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand,.wy-menu-vertical li button.toctree-expand{font-family:inherit}.fa:before,.icon:before,.rst-content .admonition-title:before,.rst-content .code-block-caption .headerlink:before,.rst-content .eqno .headerlink:before,.rst-content code.download span:first-child:before,.rst-content dl dt .headerlink:before,.rst-content h1 .headerlink:before,.rst-content h2 .headerlink:before,.rst-content h3 .headerlink:before,.rst-content h4 .headerlink:before,.rst-content h5 .headerlink:before,.rst-content h6 .headerlink:before,.rst-content p.caption .headerlink:before,.rst-content p .headerlink:before,.rst-content table>caption .headerlink:before,.rst-content tt.download span:first-child:before,.wy-dropdown .caret:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before,.wy-menu-vertical li.current>a button.toctree-expand:before,.wy-menu-vertical li.on a button.toctree-expand:before,.wy-menu-vertical li button.toctree-expand:before{font-family:FontAwesome;display:inline-block;font-style:normal;font-weight:400;line-height:1;text-decoration:inherit}.rst-content .code-block-caption a .headerlink,.rst-content .eqno a .headerlink,.rst-content a .admonition-title,.rst-content code.download a span:first-child,.rst-content dl dt a .headerlink,.rst-content h1 a .headerlink,.rst-content h2 a .headerlink,.rst-content h3 a .headerlink,.rst-content h4 a .headerlink,.rst-content h5 a .headerlink,.rst-content h6 a .headerlink,.rst-content p.caption a .headerlink,.rst-content p a .headerlink,.rst-content table>caption a .headerlink,.rst-content tt.download a span:first-child,.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand,.wy-menu-vertical li a button.toctree-expand,a .fa,a .icon,a .rst-content .admonition-title,a .rst-content .code-block-caption .headerlink,a .rst-content .eqno .headerlink,a .rst-content code.download span:first-child,a .rst-content dl dt .headerlink,a .rst-content h1 .headerlink,a .rst-content h2 .headerlink,a .rst-content h3 .headerlink,a .rst-content h4 .headerlink,a .rst-content h5 .headerlink,a .rst-content h6 .headerlink,a .rst-content p.caption .headerlink,a .rst-content p .headerlink,a .rst-content table>caption .headerlink,a .rst-content tt.download span:first-child,a .wy-menu-vertical li button.toctree-expand{display:inline-block;text-decoration:inherit}.btn .fa,.btn .icon,.btn .rst-content .admonition-title,.btn .rst-content .code-block-caption .headerlink,.btn .rst-content .eqno .headerlink,.btn .rst-content code.download span:first-child,.btn .rst-content dl dt .headerlink,.btn .rst-content h1 .headerlink,.btn .rst-content h2 .headerlink,.btn .rst-content h3 .headerlink,.btn .rst-content h4 .headerlink,.btn .rst-content h5 .headerlink,.btn .rst-content h6 .headerlink,.btn .rst-content p .headerlink,.btn .rst-content table>caption .headerlink,.btn .rst-content tt.download span:first-child,.btn .wy-menu-vertical li.current>a button.toctree-expand,.btn .wy-menu-vertical li.on a button.toctree-expand,.btn .wy-menu-vertical li button.toctree-expand,.nav .fa,.nav .icon,.nav .rst-content .admonition-title,.nav .rst-content .code-block-caption .headerlink,.nav .rst-content .eqno .headerlink,.nav .rst-content code.download span:first-child,.nav .rst-content dl dt .headerlink,.nav .rst-content h1 .headerlink,.nav .rst-content h2 .headerlink,.nav .rst-content h3 .headerlink,.nav .rst-content h4 .headerlink,.nav .rst-content h5 .headerlink,.nav .rst-content h6 .headerlink,.nav .rst-content p .headerlink,.nav .rst-content table>caption .headerlink,.nav .rst-content tt.download span:first-child,.nav .wy-menu-vertical li.current>a button.toctree-expand,.nav .wy-menu-vertical li.on a button.toctree-expand,.nav .wy-menu-vertical li button.toctree-expand,.rst-content .btn .admonition-title,.rst-content .code-block-caption .btn .headerlink,.rst-content .code-block-caption .nav .headerlink,.rst-content .eqno .btn .headerlink,.rst-content .eqno .nav .headerlink,.rst-content .nav .admonition-title,.rst-content code.download .btn span:first-child,.rst-content code.download .nav span:first-child,.rst-content dl dt .btn .headerlink,.rst-content dl dt .nav .headerlink,.rst-content h1 .btn .headerlink,.rst-content h1 .nav .headerlink,.rst-content h2 .btn .headerlink,.rst-content h2 .nav .headerlink,.rst-content h3 .btn .headerlink,.rst-content h3 .nav .headerlink,.rst-content h4 .btn .headerlink,.rst-content h4 .nav .headerlink,.rst-content h5 .btn .headerlink,.rst-content h5 .nav .headerlink,.rst-content h6 .btn .headerlink,.rst-content h6 .nav .headerlink,.rst-content p .btn .headerlink,.rst-content p .nav .headerlink,.rst-content table>caption .btn .headerlink,.rst-content table>caption .nav .headerlink,.rst-content tt.download .btn span:first-child,.rst-content tt.download .nav span:first-child,.wy-menu-vertical li .btn button.toctree-expand,.wy-menu-vertical li.current>a .btn button.toctree-expand,.wy-menu-vertical li.current>a .nav button.toctree-expand,.wy-menu-vertical li .nav button.toctree-expand,.wy-menu-vertical li.on a .btn button.toctree-expand,.wy-menu-vertical li.on a .nav button.toctree-expand{display:inline}.btn .fa-large.icon,.btn .fa.fa-large,.btn .rst-content .code-block-caption .fa-large.headerlink,.btn .rst-content .eqno .fa-large.headerlink,.btn .rst-content .fa-large.admonition-title,.btn .rst-content code.download span.fa-large:first-child,.btn .rst-content dl dt .fa-large.headerlink,.btn .rst-content h1 .fa-large.headerlink,.btn .rst-content h2 .fa-large.headerlink,.btn .rst-content h3 .fa-large.headerlink,.btn .rst-content h4 .fa-large.headerlink,.btn .rst-content h5 .fa-large.headerlink,.btn .rst-content h6 .fa-large.headerlink,.btn .rst-content p .fa-large.headerlink,.btn .rst-content table>caption .fa-large.headerlink,.btn .rst-content tt.download span.fa-large:first-child,.btn .wy-menu-vertical li button.fa-large.toctree-expand,.nav .fa-large.icon,.nav .fa.fa-large,.nav .rst-content .code-block-caption .fa-large.headerlink,.nav .rst-content .eqno .fa-large.headerlink,.nav .rst-content .fa-large.admonition-title,.nav .rst-content code.download span.fa-large:first-child,.nav .rst-content dl dt .fa-large.headerlink,.nav .rst-content h1 .fa-large.headerlink,.nav .rst-content h2 .fa-large.headerlink,.nav .rst-content h3 .fa-large.headerlink,.nav .rst-content h4 .fa-large.headerlink,.nav .rst-content h5 .fa-large.headerlink,.nav .rst-content h6 .fa-large.headerlink,.nav .rst-content p .fa-large.headerlink,.nav .rst-content table>caption .fa-large.headerlink,.nav .rst-content tt.download span.fa-large:first-child,.nav .wy-menu-vertical li button.fa-large.toctree-expand,.rst-content .btn .fa-large.admonition-title,.rst-content .code-block-caption .btn .fa-large.headerlink,.rst-content .code-block-caption .nav .fa-large.headerlink,.rst-content .eqno .btn .fa-large.headerlink,.rst-content .eqno .nav .fa-large.headerlink,.rst-content .nav .fa-large.admonition-title,.rst-content code.download .btn span.fa-large:first-child,.rst-content code.download .nav span.fa-large:first-child,.rst-content dl dt .btn .fa-large.headerlink,.rst-content dl dt .nav .fa-large.headerlink,.rst-content h1 .btn .fa-large.headerlink,.rst-content h1 .nav .fa-large.headerlink,.rst-content h2 .btn .fa-large.headerlink,.rst-content h2 .nav .fa-large.headerlink,.rst-content h3 .btn .fa-large.headerlink,.rst-content h3 .nav .fa-large.headerlink,.rst-content h4 .btn .fa-large.headerlink,.rst-content h4 .nav .fa-large.headerlink,.rst-content h5 .btn .fa-large.headerlink,.rst-content h5 .nav .fa-large.headerlink,.rst-content h6 .btn .fa-large.headerlink,.rst-content h6 .nav .fa-large.headerlink,.rst-content p .btn .fa-large.headerlink,.rst-content p .nav .fa-large.headerlink,.rst-content table>caption .btn .fa-large.headerlink,.rst-content table>caption .nav .fa-large.headerlink,.rst-content tt.download .btn span.fa-large:first-child,.rst-content tt.download .nav span.fa-large:first-child,.wy-menu-vertical li .btn button.fa-large.toctree-expand,.wy-menu-vertical li .nav button.fa-large.toctree-expand{line-height:.9em}.btn .fa-spin.icon,.btn .fa.fa-spin,.btn .rst-content .code-block-caption .fa-spin.headerlink,.btn .rst-content .eqno .fa-spin.headerlink,.btn .rst-content .fa-spin.admonition-title,.btn .rst-content code.download span.fa-spin:first-child,.btn .rst-content dl dt .fa-spin.headerlink,.btn .rst-content h1 .fa-spin.headerlink,.btn .rst-content h2 .fa-spin.headerlink,.btn .rst-content h3 .fa-spin.headerlink,.btn .rst-content h4 .fa-spin.headerlink,.btn .rst-content h5 .fa-spin.headerlink,.btn .rst-content h6 .fa-spin.headerlink,.btn .rst-content p .fa-spin.headerlink,.btn .rst-content table>caption .fa-spin.headerlink,.btn .rst-content tt.download span.fa-spin:first-child,.btn .wy-menu-vertical li button.fa-spin.toctree-expand,.nav .fa-spin.icon,.nav .fa.fa-spin,.nav .rst-content .code-block-caption .fa-spin.headerlink,.nav .rst-content .eqno .fa-spin.headerlink,.nav .rst-content .fa-spin.admonition-title,.nav .rst-content code.download span.fa-spin:first-child,.nav .rst-content dl dt .fa-spin.headerlink,.nav .rst-content h1 .fa-spin.headerlink,.nav .rst-content h2 .fa-spin.headerlink,.nav .rst-content h3 .fa-spin.headerlink,.nav .rst-content h4 .fa-spin.headerlink,.nav .rst-content h5 .fa-spin.headerlink,.nav .rst-content h6 .fa-spin.headerlink,.nav .rst-content p .fa-spin.headerlink,.nav .rst-content table>caption .fa-spin.headerlink,.nav .rst-content tt.download span.fa-spin:first-child,.nav .wy-menu-vertical li button.fa-spin.toctree-expand,.rst-content .btn .fa-spin.admonition-title,.rst-content .code-block-caption .btn .fa-spin.headerlink,.rst-content .code-block-caption .nav .fa-spin.headerlink,.rst-content .eqno .btn .fa-spin.headerlink,.rst-content .eqno .nav .fa-spin.headerlink,.rst-content .nav .fa-spin.admonition-title,.rst-content code.download .btn span.fa-spin:first-child,.rst-content code.download .nav span.fa-spin:first-child,.rst-content dl dt .btn .fa-spin.headerlink,.rst-content dl dt .nav .fa-spin.headerlink,.rst-content h1 .btn .fa-spin.headerlink,.rst-content h1 .nav .fa-spin.headerlink,.rst-content h2 .btn .fa-spin.headerlink,.rst-content h2 .nav .fa-spin.headerlink,.rst-content h3 .btn .fa-spin.headerlink,.rst-content h3 .nav .fa-spin.headerlink,.rst-content h4 .btn .fa-spin.headerlink,.rst-content h4 .nav .fa-spin.headerlink,.rst-content h5 .btn .fa-spin.headerlink,.rst-content h5 .nav .fa-spin.headerlink,.rst-content h6 .btn .fa-spin.headerlink,.rst-content h6 .nav .fa-spin.headerlink,.rst-content p .btn .fa-spin.headerlink,.rst-content p .nav .fa-spin.headerlink,.rst-content table>caption .btn .fa-spin.headerlink,.rst-content table>caption .nav .fa-spin.headerlink,.rst-content tt.download .btn span.fa-spin:first-child,.rst-content tt.download .nav span.fa-spin:first-child,.wy-menu-vertical li .btn button.fa-spin.toctree-expand,.wy-menu-vertical li .nav button.fa-spin.toctree-expand{display:inline-block}.btn.fa:before,.btn.icon:before,.rst-content .btn.admonition-title:before,.rst-content .code-block-caption .btn.headerlink:before,.rst-content .eqno .btn.headerlink:before,.rst-content code.download span.btn:first-child:before,.rst-content dl dt .btn.headerlink:before,.rst-content h1 .btn.headerlink:before,.rst-content h2 .btn.headerlink:before,.rst-content h3 .btn.headerlink:before,.rst-content h4 .btn.headerlink:before,.rst-content h5 .btn.headerlink:before,.rst-content h6 .btn.headerlink:before,.rst-content p .btn.headerlink:before,.rst-content table>caption .btn.headerlink:before,.rst-content tt.download span.btn:first-child:before,.wy-menu-vertical li button.btn.toctree-expand:before{opacity:.5;-webkit-transition:opacity .05s ease-in;-moz-transition:opacity .05s ease-in;transition:opacity .05s ease-in}.btn.fa:hover:before,.btn.icon:hover:before,.rst-content .btn.admonition-title:hover:before,.rst-content .code-block-caption .btn.headerlink:hover:before,.rst-content .eqno .btn.headerlink:hover:before,.rst-content code.download span.btn:first-child:hover:before,.rst-content dl dt .btn.headerlink:hover:before,.rst-content h1 .btn.headerlink:hover:before,.rst-content h2 .btn.headerlink:hover:before,.rst-content h3 .btn.headerlink:hover:before,.rst-content h4 .btn.headerlink:hover:before,.rst-content h5 .btn.headerlink:hover:before,.rst-content h6 .btn.headerlink:hover:before,.rst-content p .btn.headerlink:hover:before,.rst-content table>caption .btn.headerlink:hover:before,.rst-content tt.download span.btn:first-child:hover:before,.wy-menu-vertical li button.btn.toctree-expand:hover:before{opacity:1}.btn-mini .fa:before,.btn-mini .icon:before,.btn-mini .rst-content .admonition-title:before,.btn-mini .rst-content .code-block-caption .headerlink:before,.btn-mini .rst-content .eqno .headerlink:before,.btn-mini .rst-content code.download span:first-child:before,.btn-mini .rst-content dl dt .headerlink:before,.btn-mini .rst-content h1 .headerlink:before,.btn-mini .rst-content h2 .headerlink:before,.btn-mini .rst-content h3 .headerlink:before,.btn-mini .rst-content h4 .headerlink:before,.btn-mini .rst-content h5 .headerlink:before,.btn-mini .rst-content h6 .headerlink:before,.btn-mini .rst-content p .headerlink:before,.btn-mini .rst-content table>caption .headerlink:before,.btn-mini .rst-content tt.download span:first-child:before,.btn-mini .wy-menu-vertical li button.toctree-expand:before,.rst-content .btn-mini .admonition-title:before,.rst-content .code-block-caption .btn-mini .headerlink:before,.rst-content .eqno .btn-mini .headerlink:before,.rst-content code.download .btn-mini span:first-child:before,.rst-content dl dt .btn-mini .headerlink:before,.rst-content h1 .btn-mini .headerlink:before,.rst-content h2 .btn-mini .headerlink:before,.rst-content h3 .btn-mini .headerlink:before,.rst-content h4 .btn-mini .headerlink:before,.rst-content h5 .btn-mini .headerlink:before,.rst-content h6 .btn-mini .headerlink:before,.rst-content p .btn-mini .headerlink:before,.rst-content table>caption .btn-mini .headerlink:before,.rst-content tt.download .btn-mini span:first-child:before,.wy-menu-vertical li .btn-mini button.toctree-expand:before{font-size:14px;vertical-align:-15%}.rst-content .admonition,.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .danger,.rst-content .error,.rst-content .hint,.rst-content .important,.rst-content .note,.rst-content .seealso,.rst-content .tip,.rst-content .warning,.wy-alert{padding:12px;line-height:24px;margin-bottom:24px;background:#e7f2fa}.rst-content .admonition-title,.wy-alert-title{font-weight:700;display:block;color:#fff;background:#6ab0de;padding:6px 12px;margin:-12px -12px 12px}.rst-content .danger,.rst-content .error,.rst-content .wy-alert-danger.admonition,.rst-content .wy-alert-danger.admonition-todo,.rst-content .wy-alert-danger.attention,.rst-content .wy-alert-danger.caution,.rst-content .wy-alert-danger.hint,.rst-content .wy-alert-danger.important,.rst-content .wy-alert-danger.note,.rst-content .wy-alert-danger.seealso,.rst-content .wy-alert-danger.tip,.rst-content .wy-alert-danger.warning,.wy-alert.wy-alert-danger{background:#fdf3f2}.rst-content .danger .admonition-title,.rst-content .danger .wy-alert-title,.rst-content .error .admonition-title,.rst-content .error .wy-alert-title,.rst-content .wy-alert-danger.admonition-todo .admonition-title,.rst-content .wy-alert-danger.admonition-todo .wy-alert-title,.rst-content .wy-alert-danger.admonition .admonition-title,.rst-content .wy-alert-danger.admonition .wy-alert-title,.rst-content .wy-alert-danger.attention .admonition-title,.rst-content .wy-alert-danger.attention .wy-alert-title,.rst-content .wy-alert-danger.caution .admonition-title,.rst-content .wy-alert-danger.caution .wy-alert-title,.rst-content .wy-alert-danger.hint .admonition-title,.rst-content .wy-alert-danger.hint .wy-alert-title,.rst-content .wy-alert-danger.important .admonition-title,.rst-content .wy-alert-danger.important .wy-alert-title,.rst-content .wy-alert-danger.note .admonition-title,.rst-content .wy-alert-danger.note .wy-alert-title,.rst-content .wy-alert-danger.seealso .admonition-title,.rst-content .wy-alert-danger.seealso .wy-alert-title,.rst-content .wy-alert-danger.tip .admonition-title,.rst-content .wy-alert-danger.tip .wy-alert-title,.rst-content .wy-alert-danger.warning .admonition-title,.rst-content .wy-alert-danger.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-danger .admonition-title,.wy-alert.wy-alert-danger .rst-content .admonition-title,.wy-alert.wy-alert-danger .wy-alert-title{background:#f29f97}.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .warning,.rst-content .wy-alert-warning.admonition,.rst-content .wy-alert-warning.danger,.rst-content .wy-alert-warning.error,.rst-content .wy-alert-warning.hint,.rst-content .wy-alert-warning.important,.rst-content .wy-alert-warning.note,.rst-content .wy-alert-warning.seealso,.rst-content .wy-alert-warning.tip,.wy-alert.wy-alert-warning{background:#ffedcc}.rst-content .admonition-todo .admonition-title,.rst-content .admonition-todo .wy-alert-title,.rst-content .attention .admonition-title,.rst-content .attention .wy-alert-title,.rst-content .caution .admonition-title,.rst-content .caution .wy-alert-title,.rst-content .warning .admonition-title,.rst-content .warning .wy-alert-title,.rst-content .wy-alert-warning.admonition .admonition-title,.rst-content .wy-alert-warning.admonition .wy-alert-title,.rst-content .wy-alert-warning.danger .admonition-title,.rst-content .wy-alert-warning.danger .wy-alert-title,.rst-content .wy-alert-warning.error .admonition-title,.rst-content .wy-alert-warning.error .wy-alert-title,.rst-content .wy-alert-warning.hint .admonition-title,.rst-content .wy-alert-warning.hint .wy-alert-title,.rst-content .wy-alert-warning.important .admonition-title,.rst-content .wy-alert-warning.important .wy-alert-title,.rst-content .wy-alert-warning.note .admonition-title,.rst-content .wy-alert-warning.note .wy-alert-title,.rst-content .wy-alert-warning.seealso .admonition-title,.rst-content .wy-alert-warning.seealso .wy-alert-title,.rst-content .wy-alert-warning.tip .admonition-title,.rst-content .wy-alert-warning.tip .wy-alert-title,.rst-content .wy-alert.wy-alert-warning .admonition-title,.wy-alert.wy-alert-warning .rst-content .admonition-title,.wy-alert.wy-alert-warning .wy-alert-title{background:#f0b37e}.rst-content .note,.rst-content .seealso,.rst-content .wy-alert-info.admonition,.rst-content .wy-alert-info.admonition-todo,.rst-content .wy-alert-info.attention,.rst-content .wy-alert-info.caution,.rst-content .wy-alert-info.danger,.rst-content .wy-alert-info.error,.rst-content .wy-alert-info.hint,.rst-content .wy-alert-info.important,.rst-content .wy-alert-info.tip,.rst-content .wy-alert-info.warning,.wy-alert.wy-alert-info{background:#e7f2fa}.rst-content .note .admonition-title,.rst-content .note .wy-alert-title,.rst-content .seealso .admonition-title,.rst-content .seealso .wy-alert-title,.rst-content .wy-alert-info.admonition-todo .admonition-title,.rst-content .wy-alert-info.admonition-todo .wy-alert-title,.rst-content .wy-alert-info.admonition .admonition-title,.rst-content .wy-alert-info.admonition .wy-alert-title,.rst-content .wy-alert-info.attention .admonition-title,.rst-content .wy-alert-info.attention .wy-alert-title,.rst-content .wy-alert-info.caution .admonition-title,.rst-content .wy-alert-info.caution .wy-alert-title,.rst-content .wy-alert-info.danger .admonition-title,.rst-content .wy-alert-info.danger .wy-alert-title,.rst-content .wy-alert-info.error .admonition-title,.rst-content .wy-alert-info.error .wy-alert-title,.rst-content .wy-alert-info.hint .admonition-title,.rst-content .wy-alert-info.hint .wy-alert-title,.rst-content .wy-alert-info.important .admonition-title,.rst-content .wy-alert-info.important .wy-alert-title,.rst-content .wy-alert-info.tip .admonition-title,.rst-content .wy-alert-info.tip .wy-alert-title,.rst-content .wy-alert-info.warning .admonition-title,.rst-content .wy-alert-info.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-info .admonition-title,.wy-alert.wy-alert-info .rst-content .admonition-title,.wy-alert.wy-alert-info .wy-alert-title{background:#6ab0de}.rst-content .hint,.rst-content .important,.rst-content .tip,.rst-content .wy-alert-success.admonition,.rst-content .wy-alert-success.admonition-todo,.rst-content .wy-alert-success.attention,.rst-content .wy-alert-success.caution,.rst-content .wy-alert-success.danger,.rst-content .wy-alert-success.error,.rst-content .wy-alert-success.note,.rst-content .wy-alert-success.seealso,.rst-content .wy-alert-success.warning,.wy-alert.wy-alert-success{background:#dbfaf4}.rst-content .hint .admonition-title,.rst-content .hint .wy-alert-title,.rst-content .important .admonition-title,.rst-content .important .wy-alert-title,.rst-content .tip .admonition-title,.rst-content .tip .wy-alert-title,.rst-content .wy-alert-success.admonition-todo .admonition-title,.rst-content .wy-alert-success.admonition-todo .wy-alert-title,.rst-content .wy-alert-success.admonition .admonition-title,.rst-content .wy-alert-success.admonition .wy-alert-title,.rst-content .wy-alert-success.attention .admonition-title,.rst-content .wy-alert-success.attention .wy-alert-title,.rst-content .wy-alert-success.caution .admonition-title,.rst-content .wy-alert-success.caution .wy-alert-title,.rst-content .wy-alert-success.danger .admonition-title,.rst-content .wy-alert-success.danger .wy-alert-title,.rst-content .wy-alert-success.error .admonition-title,.rst-content .wy-alert-success.error .wy-alert-title,.rst-content .wy-alert-success.note .admonition-title,.rst-content .wy-alert-success.note .wy-alert-title,.rst-content .wy-alert-success.seealso .admonition-title,.rst-content .wy-alert-success.seealso .wy-alert-title,.rst-content .wy-alert-success.warning .admonition-title,.rst-content .wy-alert-success.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-success .admonition-title,.wy-alert.wy-alert-success .rst-content .admonition-title,.wy-alert.wy-alert-success .wy-alert-title{background:#1abc9c}.rst-content .wy-alert-neutral.admonition,.rst-content .wy-alert-neutral.admonition-todo,.rst-content .wy-alert-neutral.attention,.rst-content .wy-alert-neutral.caution,.rst-content .wy-alert-neutral.danger,.rst-content .wy-alert-neutral.error,.rst-content .wy-alert-neutral.hint,.rst-content .wy-alert-neutral.important,.rst-content .wy-alert-neutral.note,.rst-content .wy-alert-neutral.seealso,.rst-content .wy-alert-neutral.tip,.rst-content .wy-alert-neutral.warning,.wy-alert.wy-alert-neutral{background:#f3f6f6}.rst-content .wy-alert-neutral.admonition-todo .admonition-title,.rst-content .wy-alert-neutral.admonition-todo .wy-alert-title,.rst-content .wy-alert-neutral.admonition .admonition-title,.rst-content .wy-alert-neutral.admonition .wy-alert-title,.rst-content .wy-alert-neutral.attention .admonition-title,.rst-content .wy-alert-neutral.attention .wy-alert-title,.rst-content .wy-alert-neutral.caution .admonition-title,.rst-content .wy-alert-neutral.caution .wy-alert-title,.rst-content .wy-alert-neutral.danger .admonition-title,.rst-content .wy-alert-neutral.danger .wy-alert-title,.rst-content .wy-alert-neutral.error .admonition-title,.rst-content .wy-alert-neutral.error .wy-alert-title,.rst-content .wy-alert-neutral.hint .admonition-title,.rst-content .wy-alert-neutral.hint .wy-alert-title,.rst-content .wy-alert-neutral.important .admonition-title,.rst-content .wy-alert-neutral.important .wy-alert-title,.rst-content .wy-alert-neutral.note .admonition-title,.rst-content .wy-alert-neutral.note .wy-alert-title,.rst-content .wy-alert-neutral.seealso .admonition-title,.rst-content .wy-alert-neutral.seealso .wy-alert-title,.rst-content .wy-alert-neutral.tip .admonition-title,.rst-content .wy-alert-neutral.tip .wy-alert-title,.rst-content .wy-alert-neutral.warning .admonition-title,.rst-content .wy-alert-neutral.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-neutral .admonition-title,.wy-alert.wy-alert-neutral .rst-content .admonition-title,.wy-alert.wy-alert-neutral .wy-alert-title{color:#404040;background:#e1e4e5}.rst-content .wy-alert-neutral.admonition-todo a,.rst-content .wy-alert-neutral.admonition a,.rst-content .wy-alert-neutral.attention a,.rst-content .wy-alert-neutral.caution a,.rst-content .wy-alert-neutral.danger a,.rst-content .wy-alert-neutral.error a,.rst-content .wy-alert-neutral.hint a,.rst-content .wy-alert-neutral.important a,.rst-content .wy-alert-neutral.note a,.rst-content .wy-alert-neutral.seealso a,.rst-content .wy-alert-neutral.tip a,.rst-content .wy-alert-neutral.warning a,.wy-alert.wy-alert-neutral a{color:#2980b9}.rst-content .admonition-todo p:last-child,.rst-content .admonition p:last-child,.rst-content .attention p:last-child,.rst-content .caution p:last-child,.rst-content .danger p:last-child,.rst-content .error p:last-child,.rst-content .hint p:last-child,.rst-content .important p:last-child,.rst-content .note p:last-child,.rst-content .seealso p:last-child,.rst-content .tip p:last-child,.rst-content .warning p:last-child,.wy-alert p:last-child{margin-bottom:0}.wy-tray-container{position:fixed;bottom:0;left:0;z-index:600}.wy-tray-container li{display:block;width:300px;background:transparent;color:#fff;text-align:center;box-shadow:0 5px 5px 0 rgba(0,0,0,.1);padding:0 24px;min-width:20%;opacity:0;height:0;line-height:56px;overflow:hidden;-webkit-transition:all .3s ease-in;-moz-transition:all .3s ease-in;transition:all .3s ease-in}.wy-tray-container li.wy-tray-item-success{background:#27ae60}.wy-tray-container li.wy-tray-item-info{background:#2980b9}.wy-tray-container li.wy-tray-item-warning{background:#e67e22}.wy-tray-container li.wy-tray-item-danger{background:#e74c3c}.wy-tray-container li.on{opacity:1;height:56px}@media screen and (max-width:768px){.wy-tray-container{bottom:auto;top:0;width:100%}.wy-tray-container li{width:100%}}button{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle;cursor:pointer;line-height:normal;-webkit-appearance:button;*overflow:visible}button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0}button[disabled]{cursor:default}.btn{display:inline-block;border-radius:2px;line-height:normal;white-space:nowrap;text-align:center;cursor:pointer;font-size:100%;padding:6px 12px 8px;color:#fff;border:1px solid rgba(0,0,0,.1);background-color:#27ae60;text-decoration:none;font-weight:400;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;box-shadow:inset 0 1px 2px -1px hsla(0,0%,100%,.5),inset 0 -2px 0 0 rgba(0,0,0,.1);outline-none:false;vertical-align:middle;*display:inline;zoom:1;-webkit-user-drag:none;-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none;-webkit-transition:all .1s linear;-moz-transition:all .1s linear;transition:all .1s linear}.btn-hover{background:#2e8ece;color:#fff}.btn:hover{background:#2cc36b;color:#fff}.btn:focus{background:#2cc36b;outline:0}.btn:active{box-shadow:inset 0 -1px 0 0 rgba(0,0,0,.05),inset 0 2px 0 0 rgba(0,0,0,.1);padding:8px 12px 6px}.btn:visited{color:#fff}.btn-disabled,.btn-disabled:active,.btn-disabled:focus,.btn-disabled:hover,.btn:disabled{background-image:none;filter:progid:DXImageTransform.Microsoft.gradient(enabled = false);filter:alpha(opacity=40);opacity:.4;cursor:not-allowed;box-shadow:none}.btn::-moz-focus-inner{padding:0;border:0}.btn-small{font-size:80%}.btn-info{background-color:#2980b9!important}.btn-info:hover{background-color:#2e8ece!important}.btn-neutral{background-color:#f3f6f6!important;color:#404040!important}.btn-neutral:hover{background-color:#e5ebeb!important;color:#404040}.btn-neutral:visited{color:#404040!important}.btn-success{background-color:#27ae60!important}.btn-success:hover{background-color:#295!important}.btn-danger{background-color:#e74c3c!important}.btn-danger:hover{background-color:#ea6153!important}.btn-warning{background-color:#e67e22!important}.btn-warning:hover{background-color:#e98b39!important}.btn-invert{background-color:#222}.btn-invert:hover{background-color:#2f2f2f!important}.btn-link{background-color:transparent!important;color:#2980b9;box-shadow:none;border-color:transparent!important}.btn-link:active,.btn-link:hover{background-color:transparent!important;color:#409ad5!important;box-shadow:none}.btn-link:visited{color:#9b59b6}.wy-btn-group .btn,.wy-control .btn{vertical-align:middle}.wy-btn-group{margin-bottom:24px;*zoom:1}.wy-btn-group:after,.wy-btn-group:before{display:table;content:""}.wy-btn-group:after{clear:both}.wy-dropdown{position:relative;display:inline-block}.wy-dropdown-active .wy-dropdown-menu{display:block}.wy-dropdown-menu{position:absolute;left:0;display:none;float:left;top:100%;min-width:100%;background:#fcfcfc;z-index:100;border:1px solid #cfd7dd;box-shadow:0 2px 2px 0 rgba(0,0,0,.1);padding:12px}.wy-dropdown-menu>dd>a{display:block;clear:both;color:#404040;white-space:nowrap;font-size:90%;padding:0 12px;cursor:pointer}.wy-dropdown-menu>dd>a:hover{background:#2980b9;color:#fff}.wy-dropdown-menu>dd.divider{border-top:1px solid #cfd7dd;margin:6px 0}.wy-dropdown-menu>dd.search{padding-bottom:12px}.wy-dropdown-menu>dd.search input[type=search]{width:100%}.wy-dropdown-menu>dd.call-to-action{background:#e3e3e3;text-transform:uppercase;font-weight:500;font-size:80%}.wy-dropdown-menu>dd.call-to-action:hover{background:#e3e3e3}.wy-dropdown-menu>dd.call-to-action .btn{color:#fff}.wy-dropdown.wy-dropdown-up .wy-dropdown-menu{bottom:100%;top:auto;left:auto;right:0}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu{background:#fcfcfc;margin-top:2px}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu a{padding:6px 12px}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu a:hover{background:#2980b9;color:#fff}.wy-dropdown.wy-dropdown-left .wy-dropdown-menu{right:0;left:auto;text-align:right}.wy-dropdown-arrow:before{content:" ";border-bottom:5px solid #f5f5f5;border-left:5px solid transparent;border-right:5px solid transparent;position:absolute;display:block;top:-4px;left:50%;margin-left:-3px}.wy-dropdown-arrow.wy-dropdown-arrow-left:before{left:11px}.wy-form-stacked select{display:block}.wy-form-aligned .wy-help-inline,.wy-form-aligned input,.wy-form-aligned label,.wy-form-aligned select,.wy-form-aligned textarea{display:inline-block;*display:inline;*zoom:1;vertical-align:middle}.wy-form-aligned .wy-control-group>label{display:inline-block;vertical-align:middle;width:10em;margin:6px 12px 0 0;float:left}.wy-form-aligned .wy-control{float:left}.wy-form-aligned .wy-control label{display:block}.wy-form-aligned .wy-control select{margin-top:6px}fieldset{margin:0}fieldset,legend{border:0;padding:0}legend{width:100%;white-space:normal;margin-bottom:24px;font-size:150%;*margin-left:-7px}label,legend{display:block}label{margin:0 0 .3125em;color:#333;font-size:90%}input,select,textarea{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle}.wy-control-group{margin-bottom:24px;max-width:1200px;margin-left:auto;margin-right:auto;*zoom:1}.wy-control-group:after,.wy-control-group:before{display:table;content:""}.wy-control-group:after{clear:both}.wy-control-group.wy-control-group-required>label:after{content:" *";color:#e74c3c}.wy-control-group .wy-form-full,.wy-control-group .wy-form-halves,.wy-control-group .wy-form-thirds{padding-bottom:12px}.wy-control-group .wy-form-full input[type=color],.wy-control-group .wy-form-full input[type=date],.wy-control-group .wy-form-full input[type=datetime-local],.wy-control-group .wy-form-full input[type=datetime],.wy-control-group .wy-form-full input[type=email],.wy-control-group .wy-form-full input[type=month],.wy-control-group .wy-form-full input[type=number],.wy-control-group .wy-form-full input[type=password],.wy-control-group .wy-form-full input[type=search],.wy-control-group .wy-form-full input[type=tel],.wy-control-group .wy-form-full input[type=text],.wy-control-group .wy-form-full input[type=time],.wy-control-group .wy-form-full input[type=url],.wy-control-group .wy-form-full input[type=week],.wy-control-group .wy-form-full select,.wy-control-group .wy-form-halves input[type=color],.wy-control-group .wy-form-halves input[type=date],.wy-control-group .wy-form-halves input[type=datetime-local],.wy-control-group .wy-form-halves input[type=datetime],.wy-control-group .wy-form-halves input[type=email],.wy-control-group .wy-form-halves input[type=month],.wy-control-group .wy-form-halves input[type=number],.wy-control-group .wy-form-halves input[type=password],.wy-control-group .wy-form-halves input[type=search],.wy-control-group .wy-form-halves input[type=tel],.wy-control-group .wy-form-halves input[type=text],.wy-control-group .wy-form-halves input[type=time],.wy-control-group .wy-form-halves input[type=url],.wy-control-group .wy-form-halves input[type=week],.wy-control-group .wy-form-halves select,.wy-control-group .wy-form-thirds input[type=color],.wy-control-group .wy-form-thirds input[type=date],.wy-control-group .wy-form-thirds input[type=datetime-local],.wy-control-group .wy-form-thirds input[type=datetime],.wy-control-group .wy-form-thirds input[type=email],.wy-control-group .wy-form-thirds input[type=month],.wy-control-group .wy-form-thirds input[type=number],.wy-control-group .wy-form-thirds input[type=password],.wy-control-group .wy-form-thirds input[type=search],.wy-control-group .wy-form-thirds input[type=tel],.wy-control-group .wy-form-thirds input[type=text],.wy-control-group .wy-form-thirds input[type=time],.wy-control-group .wy-form-thirds input[type=url],.wy-control-group .wy-form-thirds input[type=week],.wy-control-group .wy-form-thirds select{width:100%}.wy-control-group .wy-form-full{float:left;display:block;width:100%;margin-right:0}.wy-control-group .wy-form-full:last-child{margin-right:0}.wy-control-group .wy-form-halves{float:left;display:block;margin-right:2.35765%;width:48.82117%}.wy-control-group .wy-form-halves:last-child,.wy-control-group .wy-form-halves:nth-of-type(2n){margin-right:0}.wy-control-group .wy-form-halves:nth-of-type(odd){clear:left}.wy-control-group .wy-form-thirds{float:left;display:block;margin-right:2.35765%;width:31.76157%}.wy-control-group .wy-form-thirds:last-child,.wy-control-group .wy-form-thirds:nth-of-type(3n){margin-right:0}.wy-control-group .wy-form-thirds:nth-of-type(3n+1){clear:left}.wy-control-group.wy-control-group-no-input .wy-control,.wy-control-no-input{margin:6px 0 0;font-size:90%}.wy-control-no-input{display:inline-block}.wy-control-group.fluid-input input[type=color],.wy-control-group.fluid-input input[type=date],.wy-control-group.fluid-input input[type=datetime-local],.wy-control-group.fluid-input input[type=datetime],.wy-control-group.fluid-input input[type=email],.wy-control-group.fluid-input input[type=month],.wy-control-group.fluid-input input[type=number],.wy-control-group.fluid-input input[type=password],.wy-control-group.fluid-input input[type=search],.wy-control-group.fluid-input input[type=tel],.wy-control-group.fluid-input input[type=text],.wy-control-group.fluid-input input[type=time],.wy-control-group.fluid-input input[type=url],.wy-control-group.fluid-input input[type=week]{width:100%}.wy-form-message-inline{padding-left:.3em;color:#666;font-size:90%}.wy-form-message{display:block;color:#999;font-size:70%;margin-top:.3125em;font-style:italic}.wy-form-message p{font-size:inherit;font-style:italic;margin-bottom:6px}.wy-form-message p:last-child{margin-bottom:0}input{line-height:normal}input[type=button],input[type=reset],input[type=submit]{-webkit-appearance:button;cursor:pointer;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;*overflow:visible}input[type=color],input[type=date],input[type=datetime-local],input[type=datetime],input[type=email],input[type=month],input[type=number],input[type=password],input[type=search],input[type=tel],input[type=text],input[type=time],input[type=url],input[type=week]{-webkit-appearance:none;padding:6px;display:inline-block;border:1px solid #ccc;font-size:80%;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;box-shadow:inset 0 1px 3px #ddd;border-radius:0;-webkit-transition:border .3s linear;-moz-transition:border .3s linear;transition:border .3s linear}input[type=datetime-local]{padding:.34375em .625em}input[disabled]{cursor:default}input[type=checkbox],input[type=radio]{padding:0;margin-right:.3125em;*height:13px;*width:13px}input[type=checkbox],input[type=radio],input[type=search]{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box}input[type=search]::-webkit-search-cancel-button,input[type=search]::-webkit-search-decoration{-webkit-appearance:none}input[type=color]:focus,input[type=date]:focus,input[type=datetime-local]:focus,input[type=datetime]:focus,input[type=email]:focus,input[type=month]:focus,input[type=number]:focus,input[type=password]:focus,input[type=search]:focus,input[type=tel]:focus,input[type=text]:focus,input[type=time]:focus,input[type=url]:focus,input[type=week]:focus{outline:0;outline:thin dotted\9;border-color:#333}input.no-focus:focus{border-color:#ccc!important}input[type=checkbox]:focus,input[type=file]:focus,input[type=radio]:focus{outline:thin dotted #333;outline:1px auto #129fea}input[type=color][disabled],input[type=date][disabled],input[type=datetime-local][disabled],input[type=datetime][disabled],input[type=email][disabled],input[type=month][disabled],input[type=number][disabled],input[type=password][disabled],input[type=search][disabled],input[type=tel][disabled],input[type=text][disabled],input[type=time][disabled],input[type=url][disabled],input[type=week][disabled]{cursor:not-allowed;background-color:#fafafa}input:focus:invalid,select:focus:invalid,textarea:focus:invalid{color:#e74c3c;border:1px solid #e74c3c}input:focus:invalid:focus,select:focus:invalid:focus,textarea:focus:invalid:focus{border-color:#e74c3c}input[type=checkbox]:focus:invalid:focus,input[type=file]:focus:invalid:focus,input[type=radio]:focus:invalid:focus{outline-color:#e74c3c}input.wy-input-large{padding:12px;font-size:100%}textarea{overflow:auto;vertical-align:top;width:100%;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif}select,textarea{padding:.5em .625em;display:inline-block;border:1px solid #ccc;font-size:80%;box-shadow:inset 0 1px 3px #ddd;-webkit-transition:border .3s linear;-moz-transition:border .3s linear;transition:border .3s linear}select{border:1px solid #ccc;background-color:#fff}select[multiple]{height:auto}select:focus,textarea:focus{outline:0}input[readonly],select[disabled],select[readonly],textarea[disabled],textarea[readonly]{cursor:not-allowed;background-color:#fafafa}input[type=checkbox][disabled],input[type=radio][disabled]{cursor:not-allowed}.wy-checkbox,.wy-radio{margin:6px 0;color:#404040;display:block}.wy-checkbox input,.wy-radio input{vertical-align:baseline}.wy-form-message-inline{display:inline-block;*display:inline;*zoom:1;vertical-align:middle}.wy-input-prefix,.wy-input-suffix{white-space:nowrap;padding:6px}.wy-input-prefix .wy-input-context,.wy-input-suffix .wy-input-context{line-height:27px;padding:0 8px;display:inline-block;font-size:80%;background-color:#f3f6f6;border:1px solid #ccc;color:#999}.wy-input-suffix .wy-input-context{border-left:0}.wy-input-prefix .wy-input-context{border-right:0}.wy-switch{position:relative;display:block;height:24px;margin-top:12px;cursor:pointer}.wy-switch:before{left:0;top:0;width:36px;height:12px;background:#ccc}.wy-switch:after,.wy-switch:before{position:absolute;content:"";display:block;border-radius:4px;-webkit-transition:all .2s ease-in-out;-moz-transition:all .2s ease-in-out;transition:all .2s ease-in-out}.wy-switch:after{width:18px;height:18px;background:#999;left:-3px;top:-3px}.wy-switch span{position:absolute;left:48px;display:block;font-size:12px;color:#ccc;line-height:1}.wy-switch.active:before{background:#1e8449}.wy-switch.active:after{left:24px;background:#27ae60}.wy-switch.disabled{cursor:not-allowed;opacity:.8}.wy-control-group.wy-control-group-error .wy-form-message,.wy-control-group.wy-control-group-error>label{color:#e74c3c}.wy-control-group.wy-control-group-error input[type=color],.wy-control-group.wy-control-group-error input[type=date],.wy-control-group.wy-control-group-error input[type=datetime-local],.wy-control-group.wy-control-group-error input[type=datetime],.wy-control-group.wy-control-group-error input[type=email],.wy-control-group.wy-control-group-error input[type=month],.wy-control-group.wy-control-group-error input[type=number],.wy-control-group.wy-control-group-error input[type=password],.wy-control-group.wy-control-group-error input[type=search],.wy-control-group.wy-control-group-error input[type=tel],.wy-control-group.wy-control-group-error input[type=text],.wy-control-group.wy-control-group-error input[type=time],.wy-control-group.wy-control-group-error input[type=url],.wy-control-group.wy-control-group-error input[type=week],.wy-control-group.wy-control-group-error textarea{border:1px solid #e74c3c}.wy-inline-validate{white-space:nowrap}.wy-inline-validate .wy-input-context{padding:.5em .625em;display:inline-block;font-size:80%}.wy-inline-validate.wy-inline-validate-success .wy-input-context{color:#27ae60}.wy-inline-validate.wy-inline-validate-danger .wy-input-context{color:#e74c3c}.wy-inline-validate.wy-inline-validate-warning .wy-input-context{color:#e67e22}.wy-inline-validate.wy-inline-validate-info .wy-input-context{color:#2980b9}.rotate-90{-webkit-transform:rotate(90deg);-moz-transform:rotate(90deg);-ms-transform:rotate(90deg);-o-transform:rotate(90deg);transform:rotate(90deg)}.rotate-180{-webkit-transform:rotate(180deg);-moz-transform:rotate(180deg);-ms-transform:rotate(180deg);-o-transform:rotate(180deg);transform:rotate(180deg)}.rotate-270{-webkit-transform:rotate(270deg);-moz-transform:rotate(270deg);-ms-transform:rotate(270deg);-o-transform:rotate(270deg);transform:rotate(270deg)}.mirror{-webkit-transform:scaleX(-1);-moz-transform:scaleX(-1);-ms-transform:scaleX(-1);-o-transform:scaleX(-1);transform:scaleX(-1)}.mirror.rotate-90{-webkit-transform:scaleX(-1) rotate(90deg);-moz-transform:scaleX(-1) rotate(90deg);-ms-transform:scaleX(-1) rotate(90deg);-o-transform:scaleX(-1) rotate(90deg);transform:scaleX(-1) rotate(90deg)}.mirror.rotate-180{-webkit-transform:scaleX(-1) rotate(180deg);-moz-transform:scaleX(-1) rotate(180deg);-ms-transform:scaleX(-1) rotate(180deg);-o-transform:scaleX(-1) rotate(180deg);transform:scaleX(-1) rotate(180deg)}.mirror.rotate-270{-webkit-transform:scaleX(-1) rotate(270deg);-moz-transform:scaleX(-1) rotate(270deg);-ms-transform:scaleX(-1) rotate(270deg);-o-transform:scaleX(-1) rotate(270deg);transform:scaleX(-1) rotate(270deg)}@media only screen and (max-width:480px){.wy-form button[type=submit]{margin:.7em 0 0}.wy-form input[type=color],.wy-form input[type=date],.wy-form input[type=datetime-local],.wy-form input[type=datetime],.wy-form input[type=email],.wy-form input[type=month],.wy-form input[type=number],.wy-form input[type=password],.wy-form input[type=search],.wy-form input[type=tel],.wy-form input[type=text],.wy-form input[type=time],.wy-form input[type=url],.wy-form input[type=week],.wy-form label{margin-bottom:.3em;display:block}.wy-form input[type=color],.wy-form input[type=date],.wy-form input[type=datetime-local],.wy-form input[type=datetime],.wy-form input[type=email],.wy-form input[type=month],.wy-form input[type=number],.wy-form input[type=password],.wy-form input[type=search],.wy-form input[type=tel],.wy-form input[type=time],.wy-form input[type=url],.wy-form input[type=week]{margin-bottom:0}.wy-form-aligned .wy-control-group label{margin-bottom:.3em;text-align:left;display:block;width:100%}.wy-form-aligned .wy-control{margin:1.5em 0 0}.wy-form-message,.wy-form-message-inline,.wy-form .wy-help-inline{display:block;font-size:80%;padding:6px 0}}@media screen and (max-width:768px){.tablet-hide{display:none}}@media screen and (max-width:480px){.mobile-hide{display:none}}.float-left{float:left}.float-right{float:right}.full-width{width:100%}.rst-content table.docutils,.rst-content table.field-list,.wy-table{border-collapse:collapse;border-spacing:0;empty-cells:show;margin-bottom:24px}.rst-content table.docutils caption,.rst-content table.field-list caption,.wy-table caption{color:#000;font:italic 85%/1 arial,sans-serif;padding:1em 0;text-align:center}.rst-content table.docutils td,.rst-content table.docutils th,.rst-content table.field-list td,.rst-content table.field-list th,.wy-table td,.wy-table th{font-size:90%;margin:0;overflow:visible;padding:8px 16px}.rst-content table.docutils td:first-child,.rst-content table.docutils th:first-child,.rst-content table.field-list td:first-child,.rst-content table.field-list th:first-child,.wy-table td:first-child,.wy-table th:first-child{border-left-width:0}.rst-content table.docutils thead,.rst-content table.field-list thead,.wy-table thead{color:#000;text-align:left;vertical-align:bottom;white-space:nowrap}.rst-content table.docutils thead th,.rst-content table.field-list thead th,.wy-table thead th{font-weight:700;border-bottom:2px solid #e1e4e5}.rst-content table.docutils td,.rst-content table.field-list td,.wy-table td{background-color:transparent;vertical-align:middle}.rst-content table.docutils td p,.rst-content table.field-list td p,.wy-table td p{line-height:18px}.rst-content table.docutils td p:last-child,.rst-content table.field-list td p:last-child,.wy-table td p:last-child{margin-bottom:0}.rst-content table.docutils .wy-table-cell-min,.rst-content table.field-list .wy-table-cell-min,.wy-table .wy-table-cell-min{width:1%;padding-right:0}.rst-content table.docutils .wy-table-cell-min input[type=checkbox],.rst-content table.field-list .wy-table-cell-min input[type=checkbox],.wy-table .wy-table-cell-min input[type=checkbox]{margin:0}.wy-table-secondary{color:grey;font-size:90%}.wy-table-tertiary{color:grey;font-size:80%}.rst-content table.docutils:not(.field-list) tr:nth-child(2n-1) td,.wy-table-backed,.wy-table-odd td,.wy-table-striped tr:nth-child(2n-1) td{background-color:#f3f6f6}.rst-content table.docutils,.wy-table-bordered-all{border:1px solid #e1e4e5}.rst-content table.docutils td,.wy-table-bordered-all td{border-bottom:1px solid #e1e4e5;border-left:1px solid #e1e4e5}.rst-content table.docutils tbody>tr:last-child td,.wy-table-bordered-all tbody>tr:last-child td{border-bottom-width:0}.wy-table-bordered{border:1px solid #e1e4e5}.wy-table-bordered-rows td{border-bottom:1px solid #e1e4e5}.wy-table-bordered-rows tbody>tr:last-child td{border-bottom-width:0}.wy-table-horizontal td,.wy-table-horizontal th{border-width:0 0 1px;border-bottom:1px solid #e1e4e5}.wy-table-horizontal tbody>tr:last-child td{border-bottom-width:0}.wy-table-responsive{margin-bottom:24px;max-width:100%;overflow:auto}.wy-table-responsive table{margin-bottom:0!important}.wy-table-responsive table td,.wy-table-responsive table th{white-space:nowrap}a{color:#2980b9;text-decoration:none;cursor:pointer}a:hover{color:#3091d1}a:visited{color:#9b59b6}html{height:100%}body,html{overflow-x:hidden}body{font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;font-weight:400;color:#404040;min-height:100%;background:#edf0f2}.wy-text-left{text-align:left}.wy-text-center{text-align:center}.wy-text-right{text-align:right}.wy-text-large{font-size:120%}.wy-text-normal{font-size:100%}.wy-text-small,small{font-size:80%}.wy-text-strike{text-decoration:line-through}.wy-text-warning{color:#e67e22!important}a.wy-text-warning:hover{color:#eb9950!important}.wy-text-info{color:#2980b9!important}a.wy-text-info:hover{color:#409ad5!important}.wy-text-success{color:#27ae60!important}a.wy-text-success:hover{color:#36d278!important}.wy-text-danger{color:#e74c3c!important}a.wy-text-danger:hover{color:#ed7669!important}.wy-text-neutral{color:#404040!important}a.wy-text-neutral:hover{color:#595959!important}.rst-content .toctree-wrapper>p.caption,h1,h2,h3,h4,h5,h6,legend{margin-top:0;font-weight:700;font-family:Roboto Slab,ff-tisa-web-pro,Georgia,Arial,sans-serif}p{line-height:24px;font-size:16px;margin:0 0 24px}h1{font-size:175%}.rst-content .toctree-wrapper>p.caption,h2{font-size:150%}h3{font-size:125%}h4{font-size:115%}h5{font-size:110%}h6{font-size:100%}hr{display:block;height:1px;border:0;border-top:1px solid #e1e4e5;margin:24px 0;padding:0}.rst-content code,.rst-content tt,code{white-space:nowrap;max-width:100%;background:#fff;border:1px solid #e1e4e5;font-size:75%;padding:0 5px;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;color:#e74c3c;overflow-x:auto}.rst-content tt.code-large,code.code-large{font-size:90%}.rst-content .section ul,.rst-content .toctree-wrapper ul,.rst-content section ul,.wy-plain-list-disc,article ul{list-style:disc;line-height:24px;margin-bottom:24px}.rst-content .section ul li,.rst-content .toctree-wrapper ul li,.rst-content section ul li,.wy-plain-list-disc li,article ul li{list-style:disc;margin-left:24px}.rst-content .section ul li p:last-child,.rst-content .section ul li ul,.rst-content .toctree-wrapper ul li p:last-child,.rst-content .toctree-wrapper ul li ul,.rst-content section ul li p:last-child,.rst-content section ul li ul,.wy-plain-list-disc li p:last-child,.wy-plain-list-disc li ul,article ul li p:last-child,article ul li ul{margin-bottom:0}.rst-content .section ul li li,.rst-content .toctree-wrapper ul li li,.rst-content section ul li li,.wy-plain-list-disc li li,article ul li li{list-style:circle}.rst-content .section ul li li li,.rst-content .toctree-wrapper ul li li li,.rst-content section ul li li li,.wy-plain-list-disc li li li,article ul li li li{list-style:square}.rst-content .section ul li ol li,.rst-content .toctree-wrapper ul li ol li,.rst-content section ul li ol li,.wy-plain-list-disc li ol li,article ul li ol li{list-style:decimal}.rst-content .section ol,.rst-content .section ol.arabic,.rst-content .toctree-wrapper ol,.rst-content .toctree-wrapper ol.arabic,.rst-content section ol,.rst-content section ol.arabic,.wy-plain-list-decimal,article ol{list-style:decimal;line-height:24px;margin-bottom:24px}.rst-content .section ol.arabic li,.rst-content .section ol li,.rst-content .toctree-wrapper ol.arabic li,.rst-content .toctree-wrapper ol li,.rst-content section ol.arabic li,.rst-content section ol li,.wy-plain-list-decimal li,article ol li{list-style:decimal;margin-left:24px}.rst-content .section ol.arabic li ul,.rst-content .section ol li p:last-child,.rst-content .section ol li ul,.rst-content .toctree-wrapper ol.arabic li ul,.rst-content .toctree-wrapper ol li p:last-child,.rst-content .toctree-wrapper ol li ul,.rst-content section ol.arabic li ul,.rst-content section ol li p:last-child,.rst-content section ol li ul,.wy-plain-list-decimal li p:last-child,.wy-plain-list-decimal li ul,article ol li p:last-child,article ol li ul{margin-bottom:0}.rst-content .section ol.arabic li ul li,.rst-content .section ol li ul li,.rst-content .toctree-wrapper ol.arabic li ul li,.rst-content .toctree-wrapper ol li ul li,.rst-content section ol.arabic li ul li,.rst-content section ol li ul li,.wy-plain-list-decimal li ul li,article ol li ul li{list-style:disc}.wy-breadcrumbs{*zoom:1}.wy-breadcrumbs:after,.wy-breadcrumbs:before{display:table;content:""}.wy-breadcrumbs:after{clear:both}.wy-breadcrumbs>li{display:inline-block;padding-top:5px}.wy-breadcrumbs>li.wy-breadcrumbs-aside{float:right}.rst-content .wy-breadcrumbs>li code,.rst-content .wy-breadcrumbs>li tt,.wy-breadcrumbs>li .rst-content tt,.wy-breadcrumbs>li code{all:inherit;color:inherit}.breadcrumb-item:before{content:"/";color:#bbb;font-size:13px;padding:0 6px 0 3px}.wy-breadcrumbs-extra{margin-bottom:0;color:#b3b3b3;font-size:80%;display:inline-block}@media screen and (max-width:480px){.wy-breadcrumbs-extra,.wy-breadcrumbs li.wy-breadcrumbs-aside{display:none}}@media print{.wy-breadcrumbs li.wy-breadcrumbs-aside{display:none}}html{font-size:16px}.wy-affix{position:fixed;top:1.618em}.wy-menu a:hover{text-decoration:none}.wy-menu-horiz{*zoom:1}.wy-menu-horiz:after,.wy-menu-horiz:before{display:table;content:""}.wy-menu-horiz:after{clear:both}.wy-menu-horiz li,.wy-menu-horiz ul{display:inline-block}.wy-menu-horiz li:hover{background:hsla(0,0%,100%,.1)}.wy-menu-horiz li.divide-left{border-left:1px solid #404040}.wy-menu-horiz li.divide-right{border-right:1px solid #404040}.wy-menu-horiz a{height:32px;display:inline-block;line-height:32px;padding:0 16px}.wy-menu-vertical{width:300px}.wy-menu-vertical header,.wy-menu-vertical p.caption{color:#55a5d9;height:32px;line-height:32px;padding:0 1.618em;margin:12px 0 0;display:block;font-weight:700;text-transform:uppercase;font-size:85%;white-space:nowrap}.wy-menu-vertical ul{margin-bottom:0}.wy-menu-vertical li.divide-top{border-top:1px solid #404040}.wy-menu-vertical li.divide-bottom{border-bottom:1px solid #404040}.wy-menu-vertical li.current{background:#e3e3e3}.wy-menu-vertical li.current a{color:grey;border-right:1px solid #c9c9c9;padding:.4045em 2.427em}.wy-menu-vertical li.current a:hover{background:#d6d6d6}.rst-content .wy-menu-vertical li tt,.wy-menu-vertical li .rst-content tt,.wy-menu-vertical li code{border:none;background:inherit;color:inherit;padding-left:0;padding-right:0}.wy-menu-vertical li button.toctree-expand{display:block;float:left;margin-left:-1.2em;line-height:18px;color:#4d4d4d;border:none;background:none;padding:0}.wy-menu-vertical li.current>a,.wy-menu-vertical li.on a{color:#404040;font-weight:700;position:relative;background:#fcfcfc;border:none;padding:.4045em 1.618em}.wy-menu-vertical li.current>a:hover,.wy-menu-vertical li.on a:hover{background:#fcfcfc}.wy-menu-vertical li.current>a:hover button.toctree-expand,.wy-menu-vertical li.on a:hover button.toctree-expand{color:grey}.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand{display:block;line-height:18px;color:#333}.wy-menu-vertical li.toctree-l1.current>a{border-bottom:1px solid #c9c9c9;border-top:1px solid #c9c9c9}.wy-menu-vertical .toctree-l1.current .toctree-l2>ul,.wy-menu-vertical .toctree-l2.current .toctree-l3>ul,.wy-menu-vertical .toctree-l3.current .toctree-l4>ul,.wy-menu-vertical .toctree-l4.current .toctree-l5>ul,.wy-menu-vertical .toctree-l5.current .toctree-l6>ul,.wy-menu-vertical .toctree-l6.current .toctree-l7>ul,.wy-menu-vertical .toctree-l7.current .toctree-l8>ul,.wy-menu-vertical .toctree-l8.current .toctree-l9>ul,.wy-menu-vertical .toctree-l9.current .toctree-l10>ul,.wy-menu-vertical .toctree-l10.current .toctree-l11>ul{display:none}.wy-menu-vertical .toctree-l1.current .current.toctree-l2>ul,.wy-menu-vertical .toctree-l2.current .current.toctree-l3>ul,.wy-menu-vertical .toctree-l3.current .current.toctree-l4>ul,.wy-menu-vertical .toctree-l4.current .current.toctree-l5>ul,.wy-menu-vertical .toctree-l5.current .current.toctree-l6>ul,.wy-menu-vertical .toctree-l6.current .current.toctree-l7>ul,.wy-menu-vertical .toctree-l7.current .current.toctree-l8>ul,.wy-menu-vertical .toctree-l8.current .current.toctree-l9>ul,.wy-menu-vertical .toctree-l9.current .current.toctree-l10>ul,.wy-menu-vertical .toctree-l10.current .current.toctree-l11>ul{display:block}.wy-menu-vertical li.toctree-l3,.wy-menu-vertical li.toctree-l4{font-size:.9em}.wy-menu-vertical li.toctree-l2 a,.wy-menu-vertical li.toctree-l3 a,.wy-menu-vertical li.toctree-l4 a,.wy-menu-vertical li.toctree-l5 a,.wy-menu-vertical li.toctree-l6 a,.wy-menu-vertical li.toctree-l7 a,.wy-menu-vertical li.toctree-l8 a,.wy-menu-vertical li.toctree-l9 a,.wy-menu-vertical li.toctree-l10 a{color:#404040}.wy-menu-vertical li.toctree-l2 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l3 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l4 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l5 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l6 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l7 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l8 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l9 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l10 a:hover button.toctree-expand{color:grey}.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a,.wy-menu-vertical li.toctree-l3.current li.toctree-l4>a,.wy-menu-vertical li.toctree-l4.current li.toctree-l5>a,.wy-menu-vertical li.toctree-l5.current li.toctree-l6>a,.wy-menu-vertical li.toctree-l6.current li.toctree-l7>a,.wy-menu-vertical li.toctree-l7.current li.toctree-l8>a,.wy-menu-vertical li.toctree-l8.current li.toctree-l9>a,.wy-menu-vertical li.toctree-l9.current li.toctree-l10>a,.wy-menu-vertical li.toctree-l10.current li.toctree-l11>a{display:block}.wy-menu-vertical li.toctree-l2.current>a{padding:.4045em 2.427em}.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a{padding:.4045em 1.618em .4045em 4.045em}.wy-menu-vertical li.toctree-l3.current>a{padding:.4045em 4.045em}.wy-menu-vertical li.toctree-l3.current li.toctree-l4>a{padding:.4045em 1.618em .4045em 5.663em}.wy-menu-vertical li.toctree-l4.current>a{padding:.4045em 5.663em}.wy-menu-vertical li.toctree-l4.current li.toctree-l5>a{padding:.4045em 1.618em .4045em 7.281em}.wy-menu-vertical li.toctree-l5.current>a{padding:.4045em 7.281em}.wy-menu-vertical li.toctree-l5.current li.toctree-l6>a{padding:.4045em 1.618em .4045em 8.899em}.wy-menu-vertical li.toctree-l6.current>a{padding:.4045em 8.899em}.wy-menu-vertical li.toctree-l6.current li.toctree-l7>a{padding:.4045em 1.618em .4045em 10.517em}.wy-menu-vertical li.toctree-l7.current>a{padding:.4045em 10.517em}.wy-menu-vertical li.toctree-l7.current li.toctree-l8>a{padding:.4045em 1.618em .4045em 12.135em}.wy-menu-vertical li.toctree-l8.current>a{padding:.4045em 12.135em}.wy-menu-vertical li.toctree-l8.current li.toctree-l9>a{padding:.4045em 1.618em .4045em 13.753em}.wy-menu-vertical li.toctree-l9.current>a{padding:.4045em 13.753em}.wy-menu-vertical li.toctree-l9.current li.toctree-l10>a{padding:.4045em 1.618em .4045em 15.371em}.wy-menu-vertical li.toctree-l10.current>a{padding:.4045em 15.371em}.wy-menu-vertical li.toctree-l10.current li.toctree-l11>a{padding:.4045em 1.618em .4045em 16.989em}.wy-menu-vertical li.toctree-l2.current>a,.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a{background:#c9c9c9}.wy-menu-vertical li.toctree-l2 button.toctree-expand{color:#a3a3a3}.wy-menu-vertical li.toctree-l3.current>a,.wy-menu-vertical li.toctree-l3.current li.toctree-l4>a{background:#bdbdbd}.wy-menu-vertical li.toctree-l3 button.toctree-expand{color:#969696}.wy-menu-vertical li.current ul{display:block}.wy-menu-vertical li ul{margin-bottom:0;display:none}.wy-menu-vertical li ul li a{margin-bottom:0;color:#d9d9d9;font-weight:400}.wy-menu-vertical a{line-height:18px;padding:.4045em 1.618em;display:block;position:relative;font-size:90%;color:#d9d9d9}.wy-menu-vertical a:hover{background-color:#4e4a4a;cursor:pointer}.wy-menu-vertical a:hover button.toctree-expand{color:#d9d9d9}.wy-menu-vertical a:active{background-color:#2980b9;cursor:pointer;color:#fff}.wy-menu-vertical a:active button.toctree-expand{color:#fff}.wy-side-nav-search{display:block;width:300px;padding:.809em;margin-bottom:.809em;z-index:200;background-color:#2980b9;text-align:center;color:#fcfcfc}.wy-side-nav-search input[type=text]{width:100%;border-radius:50px;padding:6px 12px;border-color:#2472a4}.wy-side-nav-search img{display:block;margin:auto auto .809em;height:45px;width:45px;background-color:#2980b9;padding:5px;border-radius:100%}.wy-side-nav-search .wy-dropdown>a,.wy-side-nav-search>a{color:#fcfcfc;font-size:100%;font-weight:700;display:inline-block;padding:4px 6px;margin-bottom:.809em;max-width:100%}.wy-side-nav-search .wy-dropdown>a:hover,.wy-side-nav-search .wy-dropdown>aactive,.wy-side-nav-search .wy-dropdown>afocus,.wy-side-nav-search>a:hover,.wy-side-nav-search>aactive,.wy-side-nav-search>afocus{background:hsla(0,0%,100%,.1)}.wy-side-nav-search .wy-dropdown>a img.logo,.wy-side-nav-search>a img.logo{display:block;margin:0 auto;height:auto;width:auto;border-radius:0;max-width:100%;background:transparent}.wy-side-nav-search .wy-dropdown>a.icon,.wy-side-nav-search>a.icon{display:block}.wy-side-nav-search .wy-dropdown>a.icon img.logo,.wy-side-nav-search>a.icon img.logo{margin-top:.85em}.wy-side-nav-search>div.switch-menus{position:relative;display:block;margin-top:-.4045em;margin-bottom:.809em;font-weight:400;color:hsla(0,0%,100%,.3)}.wy-side-nav-search>div.switch-menus>div.language-switch,.wy-side-nav-search>div.switch-menus>div.version-switch{display:inline-block;padding:.2em}.wy-side-nav-search>div.switch-menus>div.language-switch select,.wy-side-nav-search>div.switch-menus>div.version-switch select{display:inline-block;margin-right:-2rem;padding-right:2rem;max-width:240px;text-align-last:center;background:none;border:none;border-radius:0;box-shadow:none;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;font-size:1em;font-weight:400;color:hsla(0,0%,100%,.3);cursor:pointer;appearance:none;-webkit-appearance:none;-moz-appearance:none}.wy-side-nav-search>div.switch-menus>div.language-switch select:active,.wy-side-nav-search>div.switch-menus>div.language-switch select:focus,.wy-side-nav-search>div.switch-menus>div.language-switch select:hover,.wy-side-nav-search>div.switch-menus>div.version-switch select:active,.wy-side-nav-search>div.switch-menus>div.version-switch select:focus,.wy-side-nav-search>div.switch-menus>div.version-switch select:hover{background:hsla(0,0%,100%,.1);color:hsla(0,0%,100%,.5)}.wy-side-nav-search>div.switch-menus>div.language-switch select option,.wy-side-nav-search>div.switch-menus>div.version-switch select option{color:#000}.wy-side-nav-search>div.switch-menus>div.language-switch:has(>select):after,.wy-side-nav-search>div.switch-menus>div.version-switch:has(>select):after{display:inline-block;width:1.5em;height:100%;padding:.1em;content:"\f0d7";font-size:1em;line-height:1.2em;font-family:FontAwesome;text-align:center;pointer-events:none;box-sizing:border-box}.wy-nav .wy-menu-vertical header{color:#2980b9}.wy-nav .wy-menu-vertical a{color:#b3b3b3}.wy-nav .wy-menu-vertical a:hover{background-color:#2980b9;color:#fff}[data-menu-wrap]{-webkit-transition:all .2s ease-in;-moz-transition:all .2s ease-in;transition:all .2s ease-in;position:absolute;opacity:1;width:100%;opacity:0}[data-menu-wrap].move-center{left:0;right:auto;opacity:1}[data-menu-wrap].move-left{right:auto;left:-100%;opacity:0}[data-menu-wrap].move-right{right:-100%;left:auto;opacity:0}.wy-body-for-nav{background:#fcfcfc}.wy-grid-for-nav{position:absolute;width:100%;height:100%}.wy-nav-side{position:fixed;top:0;bottom:0;left:0;padding-bottom:2em;width:300px;overflow-x:hidden;overflow-y:hidden;min-height:100%;color:#9b9b9b;background:#343131;z-index:200}.wy-side-scroll{width:320px;position:relative;overflow-x:hidden;overflow-y:scroll;height:100%}.wy-nav-top{display:none;background:#2980b9;color:#fff;padding:.4045em .809em;position:relative;line-height:50px;text-align:center;font-size:100%;*zoom:1}.wy-nav-top:after,.wy-nav-top:before{display:table;content:""}.wy-nav-top:after{clear:both}.wy-nav-top a{color:#fff;font-weight:700}.wy-nav-top img{margin-right:12px;height:45px;width:45px;background-color:#2980b9;padding:5px;border-radius:100%}.wy-nav-top i{font-size:30px;float:left;cursor:pointer;padding-top:inherit}.wy-nav-content-wrap{margin-left:300px;background:#fcfcfc;min-height:100%}.wy-nav-content{padding:1.618em 3.236em;height:100%;max-width:800px;margin:auto}.wy-body-mask{position:fixed;width:100%;height:100%;background:rgba(0,0,0,.2);display:none;z-index:499}.wy-body-mask.on{display:block}footer{color:grey}footer p{margin-bottom:12px}.rst-content footer span.commit tt,footer span.commit .rst-content tt,footer span.commit code{padding:0;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;font-size:1em;background:none;border:none;color:grey}.rst-footer-buttons{*zoom:1}.rst-footer-buttons:after,.rst-footer-buttons:before{width:100%;display:table;content:""}.rst-footer-buttons:after{clear:both}.rst-breadcrumbs-buttons{margin-top:12px;*zoom:1}.rst-breadcrumbs-buttons:after,.rst-breadcrumbs-buttons:before{display:table;content:""}.rst-breadcrumbs-buttons:after{clear:both}#search-results .search li{margin-bottom:24px;border-bottom:1px solid #e1e4e5;padding-bottom:24px}#search-results .search li:first-child{border-top:1px solid #e1e4e5;padding-top:24px}#search-results .search li a{font-size:120%;margin-bottom:12px;display:inline-block}#search-results .context{color:grey;font-size:90%}.genindextable li>ul{margin-left:24px}@media screen and (max-width:768px){.wy-body-for-nav{background:#fcfcfc}.wy-nav-top{display:block}.wy-nav-side{left:-300px}.wy-nav-side.shift{width:85%;left:0}.wy-menu.wy-menu-vertical,.wy-side-nav-search,.wy-side-scroll{width:auto}.wy-nav-content-wrap{margin-left:0}.wy-nav-content-wrap .wy-nav-content{padding:1.618em}.wy-nav-content-wrap.shift{position:fixed;min-width:100%;left:85%;top:0;height:100%;overflow:hidden}}@media screen and (min-width:1100px){.wy-nav-content-wrap{background:rgba(0,0,0,.05)}.wy-nav-content{margin:0;background:#fcfcfc}}@media print{.rst-versions,.wy-nav-side,footer{display:none}.wy-nav-content-wrap{margin-left:0}}.rst-versions{position:fixed;bottom:0;left:0;width:300px;color:#fcfcfc;background:#1f1d1d;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;z-index:400}.rst-versions a{color:#2980b9;text-decoration:none}.rst-versions .rst-badge-small{display:none}.rst-versions .rst-current-version{padding:12px;background-color:#272525;display:block;text-align:right;font-size:90%;cursor:pointer;color:#27ae60;*zoom:1}.rst-versions .rst-current-version:after,.rst-versions .rst-current-version:before{display:table;content:""}.rst-versions .rst-current-version:after{clear:both}.rst-content .code-block-caption .rst-versions .rst-current-version .headerlink,.rst-content .eqno .rst-versions .rst-current-version .headerlink,.rst-content .rst-versions .rst-current-version .admonition-title,.rst-content code.download .rst-versions .rst-current-version span:first-child,.rst-content dl dt .rst-versions .rst-current-version .headerlink,.rst-content h1 .rst-versions .rst-current-version .headerlink,.rst-content h2 .rst-versions .rst-current-version .headerlink,.rst-content h3 .rst-versions .rst-current-version .headerlink,.rst-content h4 .rst-versions .rst-current-version .headerlink,.rst-content h5 .rst-versions .rst-current-version .headerlink,.rst-content h6 .rst-versions .rst-current-version .headerlink,.rst-content p .rst-versions .rst-current-version .headerlink,.rst-content table>caption .rst-versions .rst-current-version .headerlink,.rst-content tt.download .rst-versions .rst-current-version span:first-child,.rst-versions .rst-current-version .fa,.rst-versions .rst-current-version .icon,.rst-versions .rst-current-version .rst-content .admonition-title,.rst-versions .rst-current-version .rst-content .code-block-caption .headerlink,.rst-versions .rst-current-version .rst-content .eqno .headerlink,.rst-versions .rst-current-version .rst-content code.download span:first-child,.rst-versions .rst-current-version .rst-content dl dt .headerlink,.rst-versions .rst-current-version .rst-content h1 .headerlink,.rst-versions .rst-current-version .rst-content h2 .headerlink,.rst-versions .rst-current-version .rst-content h3 .headerlink,.rst-versions .rst-current-version .rst-content h4 .headerlink,.rst-versions .rst-current-version .rst-content h5 .headerlink,.rst-versions .rst-current-version .rst-content h6 .headerlink,.rst-versions .rst-current-version .rst-content p .headerlink,.rst-versions .rst-current-version .rst-content table>caption .headerlink,.rst-versions .rst-current-version .rst-content tt.download span:first-child,.rst-versions .rst-current-version .wy-menu-vertical li button.toctree-expand,.wy-menu-vertical li .rst-versions .rst-current-version button.toctree-expand{color:#fcfcfc}.rst-versions .rst-current-version .fa-book,.rst-versions .rst-current-version .icon-book{float:left}.rst-versions .rst-current-version.rst-out-of-date{background-color:#e74c3c;color:#fff}.rst-versions .rst-current-version.rst-active-old-version{background-color:#f1c40f;color:#000}.rst-versions.shift-up{height:auto;max-height:100%;overflow-y:scroll}.rst-versions.shift-up .rst-other-versions{display:block}.rst-versions .rst-other-versions{font-size:90%;padding:12px;color:grey;display:none}.rst-versions .rst-other-versions hr{display:block;height:1px;border:0;margin:20px 0;padding:0;border-top:1px solid #413d3d}.rst-versions .rst-other-versions dd{display:inline-block;margin:0}.rst-versions .rst-other-versions dd a{display:inline-block;padding:6px;color:#fcfcfc}.rst-versions .rst-other-versions .rtd-current-item{font-weight:700}.rst-versions.rst-badge{width:auto;bottom:20px;right:20px;left:auto;border:none;max-width:300px;max-height:90%}.rst-versions.rst-badge .fa-book,.rst-versions.rst-badge .icon-book{float:none;line-height:30px}.rst-versions.rst-badge.shift-up .rst-current-version{text-align:right}.rst-versions.rst-badge.shift-up .rst-current-version .fa-book,.rst-versions.rst-badge.shift-up .rst-current-version .icon-book{float:left}.rst-versions.rst-badge>.rst-current-version{width:auto;height:30px;line-height:30px;padding:0 6px;display:block;text-align:center}@media screen and (max-width:768px){.rst-versions{width:85%;display:none}.rst-versions.shift{display:block}}#flyout-search-form{padding:6px}.rst-content .toctree-wrapper>p.caption,.rst-content h1,.rst-content h2,.rst-content h3,.rst-content h4,.rst-content h5,.rst-content h6{margin-bottom:24px}.rst-content img{max-width:100%;height:auto}.rst-content div.figure,.rst-content figure{margin-bottom:24px}.rst-content div.figure .caption-text,.rst-content figure .caption-text{font-style:italic}.rst-content div.figure p:last-child.caption,.rst-content figure p:last-child.caption{margin-bottom:0}.rst-content div.figure.align-center,.rst-content figure.align-center{text-align:center}.rst-content .section>a>img,.rst-content .section>img,.rst-content section>a>img,.rst-content section>img{margin-bottom:24px}.rst-content abbr[title]{text-decoration:none}.rst-content.style-external-links a.reference.external:after{font-family:FontAwesome;content:"\f08e";color:#b3b3b3;vertical-align:super;font-size:60%;margin:0 .2em}.rst-content blockquote{margin-left:24px;line-height:24px;margin-bottom:24px}.rst-content pre.literal-block{white-space:pre;margin:0;padding:12px;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;display:block;overflow:auto}.rst-content div[class^=highlight],.rst-content pre.literal-block{border:1px solid #e1e4e5;overflow-x:auto;margin:1px 0 24px}.rst-content div[class^=highlight] div[class^=highlight],.rst-content pre.literal-block div[class^=highlight]{padding:0;border:none;margin:0}.rst-content div[class^=highlight] td.code{width:100%}.rst-content .linenodiv pre{border-right:1px solid #e6e9ea;margin:0;padding:12px;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;user-select:none;pointer-events:none}.rst-content div[class^=highlight] pre{white-space:pre;margin:0;padding:12px;display:block;overflow:auto}.rst-content div[class^=highlight] pre .hll{display:block;margin:0 -12px;padding:0 12px}.rst-content .linenodiv pre,.rst-content div[class^=highlight] pre,.rst-content pre.literal-block{font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;font-size:12px;line-height:1.4}.rst-content div.highlight .gp,.rst-content div.highlight span.linenos{user-select:none;pointer-events:none}.rst-content div.highlight span.linenos{display:inline-block;padding-left:0;padding-right:12px;margin-right:12px;border-right:1px solid #e6e9ea}.rst-content .code-block-caption{font-style:italic;font-size:85%;line-height:1;padding:1em 0;text-align:center}@media print{.rst-content .codeblock,.rst-content div[class^=highlight],.rst-content div[class^=highlight] pre{white-space:pre-wrap}}.rst-content .admonition,.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .danger,.rst-content .error,.rst-content .hint,.rst-content .important,.rst-content .note,.rst-content .seealso,.rst-content .tip,.rst-content .warning{clear:both}.rst-content .admonition-todo .last,.rst-content .admonition-todo>:last-child,.rst-content .admonition .last,.rst-content .admonition>:last-child,.rst-content .attention .last,.rst-content .attention>:last-child,.rst-content .caution .last,.rst-content .caution>:last-child,.rst-content .danger .last,.rst-content .danger>:last-child,.rst-content .error .last,.rst-content .error>:last-child,.rst-content .hint .last,.rst-content .hint>:last-child,.rst-content .important .last,.rst-content .important>:last-child,.rst-content .note .last,.rst-content .note>:last-child,.rst-content .seealso .last,.rst-content .seealso>:last-child,.rst-content .tip .last,.rst-content .tip>:last-child,.rst-content .warning .last,.rst-content .warning>:last-child{margin-bottom:0}.rst-content .admonition-title:before{margin-right:4px}.rst-content .admonition table{border-color:rgba(0,0,0,.1)}.rst-content .admonition table td,.rst-content .admonition table th{background:transparent!important;border-color:rgba(0,0,0,.1)!important}.rst-content .section ol.loweralpha,.rst-content .section ol.loweralpha>li,.rst-content .toctree-wrapper ol.loweralpha,.rst-content .toctree-wrapper ol.loweralpha>li,.rst-content section ol.loweralpha,.rst-content section ol.loweralpha>li{list-style:lower-alpha}.rst-content .section ol.upperalpha,.rst-content .section ol.upperalpha>li,.rst-content .toctree-wrapper ol.upperalpha,.rst-content .toctree-wrapper ol.upperalpha>li,.rst-content section ol.upperalpha,.rst-content section ol.upperalpha>li{list-style:upper-alpha}.rst-content .section ol li>*,.rst-content .section ul li>*,.rst-content .toctree-wrapper ol li>*,.rst-content .toctree-wrapper ul li>*,.rst-content section ol li>*,.rst-content section ul li>*{margin-top:12px;margin-bottom:12px}.rst-content .section ol li>:first-child,.rst-content .section ul li>:first-child,.rst-content .toctree-wrapper ol li>:first-child,.rst-content .toctree-wrapper ul li>:first-child,.rst-content section ol li>:first-child,.rst-content section ul li>:first-child{margin-top:0}.rst-content .section ol li>p,.rst-content .section ol li>p:last-child,.rst-content .section ul li>p,.rst-content .section ul li>p:last-child,.rst-content .toctree-wrapper ol li>p,.rst-content .toctree-wrapper ol li>p:last-child,.rst-content .toctree-wrapper ul li>p,.rst-content .toctree-wrapper ul li>p:last-child,.rst-content section ol li>p,.rst-content section ol li>p:last-child,.rst-content section ul li>p,.rst-content section ul li>p:last-child{margin-bottom:12px}.rst-content .section ol li>p:only-child,.rst-content .section ol li>p:only-child:last-child,.rst-content .section ul li>p:only-child,.rst-content .section ul li>p:only-child:last-child,.rst-content .toctree-wrapper ol li>p:only-child,.rst-content .toctree-wrapper ol li>p:only-child:last-child,.rst-content .toctree-wrapper ul li>p:only-child,.rst-content .toctree-wrapper ul li>p:only-child:last-child,.rst-content section ol li>p:only-child,.rst-content section ol li>p:only-child:last-child,.rst-content section ul li>p:only-child,.rst-content section ul li>p:only-child:last-child{margin-bottom:0}.rst-content .section ol li>ol,.rst-content .section ol li>ul,.rst-content .section ul li>ol,.rst-content .section ul li>ul,.rst-content .toctree-wrapper ol li>ol,.rst-content .toctree-wrapper ol li>ul,.rst-content .toctree-wrapper ul li>ol,.rst-content .toctree-wrapper ul li>ul,.rst-content section ol li>ol,.rst-content section ol li>ul,.rst-content section ul li>ol,.rst-content section ul li>ul{margin-bottom:12px}.rst-content .section ol.simple li>*,.rst-content .section ol.simple li ol,.rst-content .section ol.simple li ul,.rst-content .section ul.simple li>*,.rst-content .section ul.simple li ol,.rst-content .section ul.simple li ul,.rst-content .toctree-wrapper ol.simple li>*,.rst-content .toctree-wrapper ol.simple li ol,.rst-content .toctree-wrapper ol.simple li ul,.rst-content .toctree-wrapper ul.simple li>*,.rst-content .toctree-wrapper ul.simple li ol,.rst-content .toctree-wrapper ul.simple li ul,.rst-content section ol.simple li>*,.rst-content section ol.simple li ol,.rst-content section ol.simple li ul,.rst-content section ul.simple li>*,.rst-content section ul.simple li ol,.rst-content section ul.simple li ul{margin-top:0;margin-bottom:0}.rst-content .line-block{margin-left:0;margin-bottom:24px;line-height:24px}.rst-content .line-block .line-block{margin-left:24px;margin-bottom:0}.rst-content .topic-title{font-weight:700;margin-bottom:12px}.rst-content .toc-backref{color:#404040}.rst-content .align-right{float:right;margin:0 0 24px 24px}.rst-content .align-left{float:left;margin:0 24px 24px 0}.rst-content .align-center{margin:auto}.rst-content .align-center:not(table){display:block}.rst-content .code-block-caption .headerlink,.rst-content .eqno .headerlink,.rst-content .toctree-wrapper>p.caption .headerlink,.rst-content dl dt .headerlink,.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content p.caption .headerlink,.rst-content p .headerlink,.rst-content table>caption .headerlink{opacity:0;font-size:14px;font-family:FontAwesome;margin-left:.5em}.rst-content .code-block-caption .headerlink:focus,.rst-content .code-block-caption:hover .headerlink,.rst-content .eqno .headerlink:focus,.rst-content .eqno:hover .headerlink,.rst-content .toctree-wrapper>p.caption .headerlink:focus,.rst-content .toctree-wrapper>p.caption:hover .headerlink,.rst-content dl dt .headerlink:focus,.rst-content dl dt:hover .headerlink,.rst-content h1 .headerlink:focus,.rst-content h1:hover .headerlink,.rst-content h2 .headerlink:focus,.rst-content h2:hover .headerlink,.rst-content h3 .headerlink:focus,.rst-content h3:hover .headerlink,.rst-content h4 .headerlink:focus,.rst-content h4:hover .headerlink,.rst-content h5 .headerlink:focus,.rst-content h5:hover .headerlink,.rst-content h6 .headerlink:focus,.rst-content h6:hover .headerlink,.rst-content p.caption .headerlink:focus,.rst-content p.caption:hover .headerlink,.rst-content p .headerlink:focus,.rst-content p:hover .headerlink,.rst-content table>caption .headerlink:focus,.rst-content table>caption:hover .headerlink{opacity:1}.rst-content p a{overflow-wrap:anywhere}.rst-content .wy-table td p,.rst-content .wy-table td ul,.rst-content .wy-table th p,.rst-content .wy-table th ul,.rst-content table.docutils td p,.rst-content table.docutils td ul,.rst-content table.docutils th p,.rst-content table.docutils th ul,.rst-content table.field-list td p,.rst-content table.field-list td ul,.rst-content table.field-list th p,.rst-content table.field-list th ul{font-size:inherit}.rst-content .btn:focus{outline:2px solid}.rst-content table>caption .headerlink:after{font-size:12px}.rst-content .centered{text-align:center}.rst-content .sidebar{float:right;width:40%;display:block;margin:0 0 24px 24px;padding:24px;background:#f3f6f6;border:1px solid #e1e4e5}.rst-content .sidebar dl,.rst-content .sidebar p,.rst-content .sidebar ul{font-size:90%}.rst-content .sidebar .last,.rst-content .sidebar>:last-child{margin-bottom:0}.rst-content .sidebar .sidebar-title{display:block;font-family:Roboto Slab,ff-tisa-web-pro,Georgia,Arial,sans-serif;font-weight:700;background:#e1e4e5;padding:6px 12px;margin:-24px -24px 24px;font-size:100%}.rst-content .highlighted{background:#f1c40f;box-shadow:0 0 0 2px #f1c40f;display:inline;font-weight:700}.rst-content .citation-reference,.rst-content .footnote-reference{vertical-align:baseline;position:relative;top:-.4em;line-height:0;font-size:90%}.rst-content .citation-reference>span.fn-bracket,.rst-content .footnote-reference>span.fn-bracket{display:none}.rst-content .hlist{width:100%}.rst-content dl dt span.classifier:before{content:" : "}.rst-content dl dt span.classifier-delimiter{display:none!important}html.writer-html4 .rst-content table.docutils.citation,html.writer-html4 .rst-content table.docutils.footnote{background:none;border:none}html.writer-html4 .rst-content table.docutils.citation td,html.writer-html4 .rst-content table.docutils.citation tr,html.writer-html4 .rst-content table.docutils.footnote td,html.writer-html4 .rst-content table.docutils.footnote tr{border:none;background-color:transparent!important;white-space:normal}html.writer-html4 .rst-content table.docutils.citation td.label,html.writer-html4 .rst-content table.docutils.footnote td.label{padding-left:0;padding-right:0;vertical-align:top}html.writer-html5 .rst-content dl.citation,html.writer-html5 .rst-content dl.field-list,html.writer-html5 .rst-content dl.footnote{display:grid;grid-template-columns:auto minmax(80%,95%)}html.writer-html5 .rst-content dl.citation>dt,html.writer-html5 .rst-content dl.field-list>dt,html.writer-html5 .rst-content dl.footnote>dt{display:inline-grid;grid-template-columns:max-content auto}html.writer-html5 .rst-content aside.citation,html.writer-html5 .rst-content aside.footnote,html.writer-html5 .rst-content div.citation{display:grid;grid-template-columns:auto auto minmax(.65rem,auto) minmax(40%,95%)}html.writer-html5 .rst-content aside.citation>span.label,html.writer-html5 .rst-content aside.footnote>span.label,html.writer-html5 .rst-content div.citation>span.label{grid-column-start:1;grid-column-end:2}html.writer-html5 .rst-content aside.citation>span.backrefs,html.writer-html5 .rst-content aside.footnote>span.backrefs,html.writer-html5 .rst-content div.citation>span.backrefs{grid-column-start:2;grid-column-end:3;grid-row-start:1;grid-row-end:3}html.writer-html5 .rst-content aside.citation>p,html.writer-html5 .rst-content aside.footnote>p,html.writer-html5 .rst-content div.citation>p{grid-column-start:4;grid-column-end:5}html.writer-html5 .rst-content dl.citation,html.writer-html5 .rst-content dl.field-list,html.writer-html5 .rst-content dl.footnote{margin-bottom:24px}html.writer-html5 .rst-content dl.citation>dt,html.writer-html5 .rst-content dl.field-list>dt,html.writer-html5 .rst-content dl.footnote>dt{padding-left:1rem}html.writer-html5 .rst-content dl.citation>dd,html.writer-html5 .rst-content dl.citation>dt,html.writer-html5 .rst-content dl.field-list>dd,html.writer-html5 .rst-content dl.field-list>dt,html.writer-html5 .rst-content dl.footnote>dd,html.writer-html5 .rst-content dl.footnote>dt{margin-bottom:0}html.writer-html5 .rst-content dl.citation,html.writer-html5 .rst-content dl.footnote{font-size:.9rem}html.writer-html5 .rst-content dl.citation>dt,html.writer-html5 .rst-content dl.footnote>dt{margin:0 .5rem .5rem 0;line-height:1.2rem;word-break:break-all;font-weight:400}html.writer-html5 .rst-content dl.citation>dt>span.brackets:before,html.writer-html5 .rst-content dl.footnote>dt>span.brackets:before{content:"["}html.writer-html5 .rst-content dl.citation>dt>span.brackets:after,html.writer-html5 .rst-content dl.footnote>dt>span.brackets:after{content:"]"}html.writer-html5 .rst-content dl.citation>dt>span.fn-backref,html.writer-html5 .rst-content dl.footnote>dt>span.fn-backref{text-align:left;font-style:italic;margin-left:.65rem;word-break:break-word;word-spacing:-.1rem;max-width:5rem}html.writer-html5 .rst-content dl.citation>dt>span.fn-backref>a,html.writer-html5 .rst-content dl.footnote>dt>span.fn-backref>a{word-break:keep-all}html.writer-html5 .rst-content dl.citation>dt>span.fn-backref>a:not(:first-child):before,html.writer-html5 .rst-content dl.footnote>dt>span.fn-backref>a:not(:first-child):before{content:" "}html.writer-html5 .rst-content dl.citation>dd,html.writer-html5 .rst-content dl.footnote>dd{margin:0 0 .5rem;line-height:1.2rem}html.writer-html5 .rst-content dl.citation>dd p,html.writer-html5 .rst-content dl.footnote>dd p{font-size:.9rem}html.writer-html5 .rst-content aside.citation,html.writer-html5 .rst-content aside.footnote,html.writer-html5 .rst-content div.citation{padding-left:1rem;padding-right:1rem;font-size:.9rem;line-height:1.2rem}html.writer-html5 .rst-content aside.citation p,html.writer-html5 .rst-content aside.footnote p,html.writer-html5 .rst-content div.citation p{font-size:.9rem;line-height:1.2rem;margin-bottom:12px}html.writer-html5 .rst-content aside.citation span.backrefs,html.writer-html5 .rst-content aside.footnote span.backrefs,html.writer-html5 .rst-content div.citation span.backrefs{text-align:left;font-style:italic;margin-left:.65rem;word-break:break-word;word-spacing:-.1rem;max-width:5rem}html.writer-html5 .rst-content aside.citation span.backrefs>a,html.writer-html5 .rst-content aside.footnote span.backrefs>a,html.writer-html5 .rst-content div.citation span.backrefs>a{word-break:keep-all}html.writer-html5 .rst-content aside.citation span.backrefs>a:not(:first-child):before,html.writer-html5 .rst-content aside.footnote span.backrefs>a:not(:first-child):before,html.writer-html5 .rst-content div.citation span.backrefs>a:not(:first-child):before{content:" "}html.writer-html5 .rst-content aside.citation span.label,html.writer-html5 .rst-content aside.footnote span.label,html.writer-html5 .rst-content div.citation span.label{line-height:1.2rem}html.writer-html5 .rst-content aside.citation-list,html.writer-html5 .rst-content aside.footnote-list,html.writer-html5 .rst-content div.citation-list{margin-bottom:24px}html.writer-html5 .rst-content dl.option-list kbd{font-size:.9rem}.rst-content table.docutils.footnote,html.writer-html4 .rst-content table.docutils.citation,html.writer-html5 .rst-content aside.footnote,html.writer-html5 .rst-content aside.footnote-list aside.footnote,html.writer-html5 .rst-content div.citation-list>div.citation,html.writer-html5 .rst-content dl.citation,html.writer-html5 .rst-content dl.footnote{color:grey}.rst-content table.docutils.footnote code,.rst-content table.docutils.footnote tt,html.writer-html4 .rst-content table.docutils.citation code,html.writer-html4 .rst-content table.docutils.citation tt,html.writer-html5 .rst-content aside.footnote-list aside.footnote code,html.writer-html5 .rst-content aside.footnote-list aside.footnote tt,html.writer-html5 .rst-content aside.footnote code,html.writer-html5 .rst-content aside.footnote tt,html.writer-html5 .rst-content div.citation-list>div.citation code,html.writer-html5 .rst-content div.citation-list>div.citation tt,html.writer-html5 .rst-content dl.citation code,html.writer-html5 .rst-content dl.citation tt,html.writer-html5 .rst-content dl.footnote code,html.writer-html5 .rst-content dl.footnote tt{color:#555}.rst-content .wy-table-responsive.citation,.rst-content .wy-table-responsive.footnote{margin-bottom:0}.rst-content .wy-table-responsive.citation+:not(.citation),.rst-content .wy-table-responsive.footnote+:not(.footnote){margin-top:24px}.rst-content .wy-table-responsive.citation:last-child,.rst-content .wy-table-responsive.footnote:last-child{margin-bottom:24px}.rst-content table.docutils th{border-color:#e1e4e5}html.writer-html5 .rst-content table.docutils th{border:1px solid #e1e4e5}html.writer-html5 .rst-content table.docutils td>p,html.writer-html5 .rst-content table.docutils th>p{line-height:1rem;margin-bottom:0;font-size:.9rem}.rst-content table.docutils td .last,.rst-content table.docutils td .last>:last-child{margin-bottom:0}.rst-content table.field-list,.rst-content table.field-list td{border:none}.rst-content table.field-list td p{line-height:inherit}.rst-content table.field-list td>strong{display:inline-block}.rst-content table.field-list .field-name{padding-right:10px;text-align:left;white-space:nowrap}.rst-content table.field-list .field-body{text-align:left}.rst-content code,.rst-content tt{color:#000;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;padding:2px 5px}.rst-content code big,.rst-content code em,.rst-content tt big,.rst-content tt em{font-size:100%!important;line-height:normal}.rst-content code.literal,.rst-content tt.literal{color:#e74c3c;white-space:normal}.rst-content code.xref,.rst-content tt.xref,a .rst-content code,a .rst-content tt{font-weight:700;color:#404040;overflow-wrap:normal}.rst-content kbd,.rst-content pre,.rst-content samp{font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace}.rst-content a code,.rst-content a tt{color:#2980b9}.rst-content dl{margin-bottom:24px}.rst-content dl dt{font-weight:700;margin-bottom:12px}.rst-content dl ol,.rst-content dl p,.rst-content dl table,.rst-content dl ul{margin-bottom:12px}.rst-content dl dd{margin:0 0 12px 24px;line-height:24px}.rst-content dl dd>ol:last-child,.rst-content dl dd>p:last-child,.rst-content dl dd>table:last-child,.rst-content dl dd>ul:last-child{margin-bottom:0}html.writer-html4 .rst-content dl:not(.docutils),html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple){margin-bottom:24px}html.writer-html4 .rst-content dl:not(.docutils)>dt,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt{display:table;margin:6px 0;font-size:90%;line-height:normal;background:#e7f2fa;color:#2980b9;border-top:3px solid #6ab0de;padding:6px;position:relative}html.writer-html4 .rst-content dl:not(.docutils)>dt:before,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt:before{color:#6ab0de}html.writer-html4 .rst-content dl:not(.docutils)>dt .headerlink,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt .headerlink{color:#404040;font-size:100%!important}html.writer-html4 .rst-content dl:not(.docutils) dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt{margin-bottom:6px;border:none;border-left:3px solid #ccc;background:#f0f0f0;color:#555}html.writer-html4 .rst-content dl:not(.docutils) dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt .headerlink,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt .headerlink{color:#404040;font-size:100%!important}html.writer-html4 .rst-content dl:not(.docutils)>dt:first-child,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt:first-child{margin-top:0}html.writer-html4 .rst-content dl:not(.docutils) code.descclassname,html.writer-html4 .rst-content dl:not(.docutils) code.descname,html.writer-html4 .rst-content dl:not(.docutils) tt.descclassname,html.writer-html4 .rst-content dl:not(.docutils) tt.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) code.descclassname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) code.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) tt.descclassname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) tt.descname{background-color:transparent;border:none;padding:0;font-size:100%!important}html.writer-html4 .rst-content dl:not(.docutils) code.descname,html.writer-html4 .rst-content dl:not(.docutils) tt.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) code.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) tt.descname{font-weight:700}html.writer-html4 .rst-content dl:not(.docutils) .optional,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .optional{display:inline-block;padding:0 4px;color:#000;font-weight:700}html.writer-html4 .rst-content dl:not(.docutils) .property,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .property{display:inline-block;padding-right:8px;max-width:100%}html.writer-html4 .rst-content dl:not(.docutils) .k,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .k{font-style:italic}html.writer-html4 .rst-content dl:not(.docutils) .descclassname,html.writer-html4 .rst-content dl:not(.docutils) .descname,html.writer-html4 .rst-content dl:not(.docutils) .sig-name,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .descclassname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .sig-name{font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;color:#000}.rst-content .viewcode-back,.rst-content .viewcode-link{display:inline-block;color:#27ae60;font-size:80%;padding-left:24px}.rst-content .viewcode-back{display:block;float:right}.rst-content p.rubric{margin-bottom:12px;font-weight:700}.rst-content code.download,.rst-content tt.download{background:inherit;padding:inherit;font-weight:400;font-family:inherit;font-size:inherit;color:inherit;border:inherit;white-space:inherit}.rst-content code.download span:first-child,.rst-content tt.download span:first-child{-webkit-font-smoothing:subpixel-antialiased}.rst-content code.download span:first-child:before,.rst-content tt.download span:first-child:before{margin-right:4px}.rst-content .guilabel,.rst-content .menuselection{font-size:80%;font-weight:700;border-radius:4px;padding:2.4px 6px;margin:auto 2px}.rst-content .guilabel,.rst-content .menuselection{border:1px solid #7fbbe3;background:#e7f2fa}.rst-content :not(dl.option-list)>:not(dt):not(kbd):not(.kbd)>.kbd,.rst-content :not(dl.option-list)>:not(dt):not(kbd):not(.kbd)>kbd{color:inherit;font-size:80%;background-color:#fff;border:1px solid #a6a6a6;border-radius:4px;box-shadow:0 2px grey;padding:2.4px 6px;margin:auto 0}.rst-content .versionmodified{font-style:italic}@media screen and (max-width:480px){.rst-content .sidebar{width:100%}}span[id*=MathJax-Span]{color:#404040}.math{text-align:center}@font-face{font-family:Lato;src:url(fonts/lato-normal.woff2?bd03a2cc277bbbc338d464e679fe9942) format("woff2"),url(fonts/lato-normal.woff?27bd77b9162d388cb8d4c4217c7c5e2a) format("woff");font-weight:400;font-style:normal;font-display:block}@font-face{font-family:Lato;src:url(fonts/lato-bold.woff2?cccb897485813c7c256901dbca54ecf2) format("woff2"),url(fonts/lato-bold.woff?d878b6c29b10beca227e9eef4246111b) format("woff");font-weight:700;font-style:normal;font-display:block}@font-face{font-family:Lato;src:url(fonts/lato-bold-italic.woff2?0b6bb6725576b072c5d0b02ecdd1900d) format("woff2"),url(fonts/lato-bold-italic.woff?9c7e4e9eb485b4a121c760e61bc3707c) format("woff");font-weight:700;font-style:italic;font-display:block}@font-face{font-family:Lato;src:url(fonts/lato-normal-italic.woff2?4eb103b4d12be57cb1d040ed5e162e9d) format("woff2"),url(fonts/lato-normal-italic.woff?f28f2d6482446544ef1ea1ccc6dd5892) format("woff");font-weight:400;font-style:italic;font-display:block}@font-face{font-family:Roboto Slab;font-style:normal;font-weight:400;src:url(fonts/Roboto-Slab-Regular.woff2?7abf5b8d04d26a2cafea937019bca958) format("woff2"),url(fonts/Roboto-Slab-Regular.woff?c1be9284088d487c5e3ff0a10a92e58c) format("woff");font-display:block}@font-face{font-family:Roboto Slab;font-style:normal;font-weight:700;src:url(fonts/Roboto-Slab-Bold.woff2?9984f4a9bda09be08e83f2506954adbe) format("woff2"),url(fonts/Roboto-Slab-Bold.woff?bed5564a116b05148e3b3bea6fb1162a) format("woff");font-display:block} \ No newline at end of file diff --git a/master/_static/documentation_options.js b/master/_static/documentation_options.js index 6b360b3f8f5..a639c66edc5 100644 --- a/master/_static/documentation_options.js +++ b/master/_static/documentation_options.js @@ -1,5 +1,5 @@ const DOCUMENTATION_OPTIONS = { - VERSION: '8.5.1.dev30+gd6e98430', + VERSION: '8.6.1.dev136+gc5060c80', LANGUAGE: 'en', COLLAPSE_INDEX: false, BUILDER: 'html', diff --git a/master/_static/fonts/Lato/lato-bold.eot b/master/_static/fonts/Lato/lato-bold.eot new file mode 100644 index 00000000000..3361183a419 Binary files /dev/null and b/master/_static/fonts/Lato/lato-bold.eot differ diff --git a/master/_static/fonts/Lato/lato-bold.ttf b/master/_static/fonts/Lato/lato-bold.ttf new file mode 100644 index 00000000000..29f691d5ed0 Binary files /dev/null and b/master/_static/fonts/Lato/lato-bold.ttf differ diff --git a/master/_static/fonts/Lato/lato-bold.woff b/master/_static/fonts/Lato/lato-bold.woff new file mode 100644 index 00000000000..c6dff51f063 Binary files /dev/null and b/master/_static/fonts/Lato/lato-bold.woff differ diff --git a/master/_static/fonts/Lato/lato-bold.woff2 b/master/_static/fonts/Lato/lato-bold.woff2 new file mode 100644 index 00000000000..bb195043cfc Binary files /dev/null and b/master/_static/fonts/Lato/lato-bold.woff2 differ diff --git a/master/_static/fonts/Lato/lato-bolditalic.eot b/master/_static/fonts/Lato/lato-bolditalic.eot new file mode 100644 index 00000000000..3d4154936b4 Binary files /dev/null and b/master/_static/fonts/Lato/lato-bolditalic.eot differ diff --git a/master/_static/fonts/Lato/lato-bolditalic.ttf b/master/_static/fonts/Lato/lato-bolditalic.ttf new file mode 100644 index 00000000000..f402040b3e5 Binary files /dev/null and b/master/_static/fonts/Lato/lato-bolditalic.ttf differ diff --git a/master/_static/fonts/Lato/lato-bolditalic.woff b/master/_static/fonts/Lato/lato-bolditalic.woff new file mode 100644 index 00000000000..88ad05b9ff4 Binary files /dev/null and b/master/_static/fonts/Lato/lato-bolditalic.woff differ diff --git a/master/_static/fonts/Lato/lato-bolditalic.woff2 b/master/_static/fonts/Lato/lato-bolditalic.woff2 new file mode 100644 index 00000000000..c4e3d804b57 Binary files /dev/null and b/master/_static/fonts/Lato/lato-bolditalic.woff2 differ diff --git a/master/_static/fonts/Lato/lato-italic.eot b/master/_static/fonts/Lato/lato-italic.eot new file mode 100644 index 00000000000..3f826421a1d Binary files /dev/null and b/master/_static/fonts/Lato/lato-italic.eot differ diff --git a/master/_static/fonts/Lato/lato-italic.ttf b/master/_static/fonts/Lato/lato-italic.ttf new file mode 100644 index 00000000000..b4bfc9b24aa Binary files /dev/null and b/master/_static/fonts/Lato/lato-italic.ttf differ diff --git a/master/_static/fonts/Lato/lato-italic.woff b/master/_static/fonts/Lato/lato-italic.woff new file mode 100644 index 00000000000..76114bc0336 Binary files /dev/null and b/master/_static/fonts/Lato/lato-italic.woff differ diff --git a/master/_static/fonts/Lato/lato-italic.woff2 b/master/_static/fonts/Lato/lato-italic.woff2 new file mode 100644 index 00000000000..3404f37e2e3 Binary files /dev/null and b/master/_static/fonts/Lato/lato-italic.woff2 differ diff --git a/master/_static/fonts/Lato/lato-regular.eot b/master/_static/fonts/Lato/lato-regular.eot new file mode 100644 index 00000000000..11e3f2a5f0f Binary files /dev/null and b/master/_static/fonts/Lato/lato-regular.eot differ diff --git a/master/_static/fonts/Lato/lato-regular.ttf b/master/_static/fonts/Lato/lato-regular.ttf new file mode 100644 index 00000000000..74decd9ebb8 Binary files /dev/null and b/master/_static/fonts/Lato/lato-regular.ttf differ diff --git a/master/_static/fonts/Lato/lato-regular.woff b/master/_static/fonts/Lato/lato-regular.woff new file mode 100644 index 00000000000..ae1307ff5f4 Binary files /dev/null and b/master/_static/fonts/Lato/lato-regular.woff differ diff --git a/master/_static/fonts/Lato/lato-regular.woff2 b/master/_static/fonts/Lato/lato-regular.woff2 new file mode 100644 index 00000000000..3bf9843328a Binary files /dev/null and b/master/_static/fonts/Lato/lato-regular.woff2 differ diff --git a/master/_static/fonts/RobotoSlab/roboto-slab-v7-bold.eot b/master/_static/fonts/RobotoSlab/roboto-slab-v7-bold.eot new file mode 100644 index 00000000000..79dc8efed34 Binary files /dev/null and b/master/_static/fonts/RobotoSlab/roboto-slab-v7-bold.eot differ diff --git a/master/_static/fonts/RobotoSlab/roboto-slab-v7-bold.ttf b/master/_static/fonts/RobotoSlab/roboto-slab-v7-bold.ttf new file mode 100644 index 00000000000..df5d1df2730 Binary files /dev/null and b/master/_static/fonts/RobotoSlab/roboto-slab-v7-bold.ttf differ diff --git a/master/_static/fonts/RobotoSlab/roboto-slab-v7-bold.woff b/master/_static/fonts/RobotoSlab/roboto-slab-v7-bold.woff new file mode 100644 index 00000000000..6cb60000181 Binary files /dev/null and b/master/_static/fonts/RobotoSlab/roboto-slab-v7-bold.woff differ diff --git a/master/_static/fonts/RobotoSlab/roboto-slab-v7-bold.woff2 b/master/_static/fonts/RobotoSlab/roboto-slab-v7-bold.woff2 new file mode 100644 index 00000000000..7059e23142a Binary files /dev/null and b/master/_static/fonts/RobotoSlab/roboto-slab-v7-bold.woff2 differ diff --git a/master/_static/fonts/RobotoSlab/roboto-slab-v7-regular.eot b/master/_static/fonts/RobotoSlab/roboto-slab-v7-regular.eot new file mode 100644 index 00000000000..2f7ca78a1eb Binary files /dev/null and b/master/_static/fonts/RobotoSlab/roboto-slab-v7-regular.eot differ diff --git a/master/_static/fonts/RobotoSlab/roboto-slab-v7-regular.ttf b/master/_static/fonts/RobotoSlab/roboto-slab-v7-regular.ttf new file mode 100644 index 00000000000..eb52a790736 Binary files /dev/null and b/master/_static/fonts/RobotoSlab/roboto-slab-v7-regular.ttf differ diff --git a/master/_static/fonts/RobotoSlab/roboto-slab-v7-regular.woff b/master/_static/fonts/RobotoSlab/roboto-slab-v7-regular.woff new file mode 100644 index 00000000000..f815f63f99d Binary files /dev/null and b/master/_static/fonts/RobotoSlab/roboto-slab-v7-regular.woff differ diff --git a/master/_static/fonts/RobotoSlab/roboto-slab-v7-regular.woff2 b/master/_static/fonts/RobotoSlab/roboto-slab-v7-regular.woff2 new file mode 100644 index 00000000000..f2c76e5bda1 Binary files /dev/null and b/master/_static/fonts/RobotoSlab/roboto-slab-v7-regular.woff2 differ diff --git a/master/_static/js/html5shiv-printshiv.min.js b/master/_static/js/html5shiv-printshiv.min.js deleted file mode 100644 index 2b43bd062e9..00000000000 --- a/master/_static/js/html5shiv-printshiv.min.js +++ /dev/null @@ -1,4 +0,0 @@ -/** -* @preserve HTML5 Shiv 3.7.3-pre | @afarkas @jdalton @jon_neal @rem | MIT/GPL2 Licensed -*/ -!function(a,b){function c(a,b){var c=a.createElement("p"),d=a.getElementsByTagName("head")[0]||a.documentElement;return c.innerHTML="x",d.insertBefore(c.lastChild,d.firstChild)}function d(){var a=y.elements;return"string"==typeof a?a.split(" "):a}function e(a,b){var c=y.elements;"string"!=typeof c&&(c=c.join(" ")),"string"!=typeof a&&(a=a.join(" ")),y.elements=c+" "+a,j(b)}function f(a){var b=x[a[v]];return b||(b={},w++,a[v]=w,x[w]=b),b}function g(a,c,d){if(c||(c=b),q)return c.createElement(a);d||(d=f(c));var e;return e=d.cache[a]?d.cache[a].cloneNode():u.test(a)?(d.cache[a]=d.createElem(a)).cloneNode():d.createElem(a),!e.canHaveChildren||t.test(a)||e.tagUrn?e:d.frag.appendChild(e)}function h(a,c){if(a||(a=b),q)return a.createDocumentFragment();c=c||f(a);for(var e=c.frag.cloneNode(),g=0,h=d(),i=h.length;i>g;g++)e.createElement(h[g]);return e}function i(a,b){b.cache||(b.cache={},b.createElem=a.createElement,b.createFrag=a.createDocumentFragment,b.frag=b.createFrag()),a.createElement=function(c){return y.shivMethods?g(c,a,b):b.createElem(c)},a.createDocumentFragment=Function("h,f","return function(){var n=f.cloneNode(),c=n.createElement;h.shivMethods&&("+d().join().replace(/[\w\-:]+/g,function(a){return b.createElem(a),b.frag.createElement(a),'c("'+a+'")'})+");return n}")(y,b.frag)}function j(a){a||(a=b);var d=f(a);return!y.shivCSS||p||d.hasCSS||(d.hasCSS=!!c(a,"article,aside,dialog,figcaption,figure,footer,header,hgroup,main,nav,section{display:block}mark{background:#FF0;color:#000}template{display:none}")),q||i(a,d),a}function k(a){for(var b,c=a.getElementsByTagName("*"),e=c.length,f=RegExp("^(?:"+d().join("|")+")$","i"),g=[];e--;)b=c[e],f.test(b.nodeName)&&g.push(b.applyElement(l(b)));return g}function l(a){for(var b,c=a.attributes,d=c.length,e=a.ownerDocument.createElement(A+":"+a.nodeName);d--;)b=c[d],b.specified&&e.setAttribute(b.nodeName,b.nodeValue);return e.style.cssText=a.style.cssText,e}function m(a){for(var b,c=a.split("{"),e=c.length,f=RegExp("(^|[\\s,>+~])("+d().join("|")+")(?=[[\\s,>+~#.:]|$)","gi"),g="$1"+A+"\\:$2";e--;)b=c[e]=c[e].split("}"),b[b.length-1]=b[b.length-1].replace(f,g),c[e]=b.join("}");return c.join("{")}function n(a){for(var b=a.length;b--;)a[b].removeNode()}function o(a){function b(){clearTimeout(g._removeSheetTimer),d&&d.removeNode(!0),d=null}var d,e,g=f(a),h=a.namespaces,i=a.parentWindow;return!B||a.printShived?a:("undefined"==typeof h[A]&&h.add(A),i.attachEvent("onbeforeprint",function(){b();for(var f,g,h,i=a.styleSheets,j=[],l=i.length,n=Array(l);l--;)n[l]=i[l];for(;h=n.pop();)if(!h.disabled&&z.test(h.media)){try{f=h.imports,g=f.length}catch(o){g=0}for(l=0;g>l;l++)n.push(f[l]);try{j.push(h.cssText)}catch(o){}}j=m(j.reverse().join("")),e=k(a),d=c(a,j)}),i.attachEvent("onafterprint",function(){n(e),clearTimeout(g._removeSheetTimer),g._removeSheetTimer=setTimeout(b,500)}),a.printShived=!0,a)}var p,q,r="3.7.3",s=a.html5||{},t=/^<|^(?:button|map|select|textarea|object|iframe|option|optgroup)$/i,u=/^(?:a|b|code|div|fieldset|h1|h2|h3|h4|h5|h6|i|label|li|ol|p|q|span|strong|style|table|tbody|td|th|tr|ul)$/i,v="_html5shiv",w=0,x={};!function(){try{var a=b.createElement("a");a.innerHTML="",p="hidden"in a,q=1==a.childNodes.length||function(){b.createElement("a");var a=b.createDocumentFragment();return"undefined"==typeof a.cloneNode||"undefined"==typeof a.createDocumentFragment||"undefined"==typeof a.createElement}()}catch(c){p=!0,q=!0}}();var y={elements:s.elements||"abbr article aside audio bdi canvas data datalist details dialog figcaption figure footer header hgroup main mark meter nav output picture progress section summary template time video",version:r,shivCSS:s.shivCSS!==!1,supportsUnknownElements:q,shivMethods:s.shivMethods!==!1,type:"default",shivDocument:j,createElement:g,createDocumentFragment:h,addElements:e};a.html5=y,j(b);var z=/^$|\b(?:all|print)\b/,A="html5shiv",B=!q&&function(){var c=b.documentElement;return!("undefined"==typeof b.namespaces||"undefined"==typeof b.parentWindow||"undefined"==typeof c.applyElement||"undefined"==typeof c.removeNode||"undefined"==typeof a.attachEvent)}();y.type+=" print",y.shivPrint=o,o(b),"object"==typeof module&&module.exports&&(module.exports=y)}("undefined"!=typeof window?window:this,document); \ No newline at end of file diff --git a/master/_static/js/html5shiv.min.js b/master/_static/js/html5shiv.min.js deleted file mode 100644 index cd1c674f5e3..00000000000 --- a/master/_static/js/html5shiv.min.js +++ /dev/null @@ -1,4 +0,0 @@ -/** -* @preserve HTML5 Shiv 3.7.3 | @afarkas @jdalton @jon_neal @rem | MIT/GPL2 Licensed -*/ -!function(a,b){function c(a,b){var c=a.createElement("p"),d=a.getElementsByTagName("head")[0]||a.documentElement;return c.innerHTML="x",d.insertBefore(c.lastChild,d.firstChild)}function d(){var a=t.elements;return"string"==typeof a?a.split(" "):a}function e(a,b){var c=t.elements;"string"!=typeof c&&(c=c.join(" ")),"string"!=typeof a&&(a=a.join(" ")),t.elements=c+" "+a,j(b)}function f(a){var b=s[a[q]];return b||(b={},r++,a[q]=r,s[r]=b),b}function g(a,c,d){if(c||(c=b),l)return c.createElement(a);d||(d=f(c));var e;return e=d.cache[a]?d.cache[a].cloneNode():p.test(a)?(d.cache[a]=d.createElem(a)).cloneNode():d.createElem(a),!e.canHaveChildren||o.test(a)||e.tagUrn?e:d.frag.appendChild(e)}function h(a,c){if(a||(a=b),l)return a.createDocumentFragment();c=c||f(a);for(var e=c.frag.cloneNode(),g=0,h=d(),i=h.length;i>g;g++)e.createElement(h[g]);return e}function i(a,b){b.cache||(b.cache={},b.createElem=a.createElement,b.createFrag=a.createDocumentFragment,b.frag=b.createFrag()),a.createElement=function(c){return t.shivMethods?g(c,a,b):b.createElem(c)},a.createDocumentFragment=Function("h,f","return function(){var n=f.cloneNode(),c=n.createElement;h.shivMethods&&("+d().join().replace(/[\w\-:]+/g,function(a){return b.createElem(a),b.frag.createElement(a),'c("'+a+'")'})+");return n}")(t,b.frag)}function j(a){a||(a=b);var d=f(a);return!t.shivCSS||k||d.hasCSS||(d.hasCSS=!!c(a,"article,aside,dialog,figcaption,figure,footer,header,hgroup,main,nav,section{display:block}mark{background:#FF0;color:#000}template{display:none}")),l||i(a,d),a}var k,l,m="3.7.3-pre",n=a.html5||{},o=/^<|^(?:button|map|select|textarea|object|iframe|option|optgroup)$/i,p=/^(?:a|b|code|div|fieldset|h1|h2|h3|h4|h5|h6|i|label|li|ol|p|q|span|strong|style|table|tbody|td|th|tr|ul)$/i,q="_html5shiv",r=0,s={};!function(){try{var a=b.createElement("a");a.innerHTML="",k="hidden"in a,l=1==a.childNodes.length||function(){b.createElement("a");var a=b.createDocumentFragment();return"undefined"==typeof a.cloneNode||"undefined"==typeof a.createDocumentFragment||"undefined"==typeof a.createElement}()}catch(c){k=!0,l=!0}}();var t={elements:n.elements||"abbr article aside audio bdi canvas data datalist details dialog figcaption figure footer header hgroup main mark meter nav output picture progress section summary template time video",version:m,shivCSS:n.shivCSS!==!1,supportsUnknownElements:l,shivMethods:n.shivMethods!==!1,type:"default",shivDocument:j,createElement:g,createDocumentFragment:h,addElements:e};a.html5=t,j(b),"object"==typeof module&&module.exports&&(module.exports=t)}("undefined"!=typeof window?window:this,document); \ No newline at end of file diff --git a/master/_static/js/versions.js b/master/_static/js/versions.js new file mode 100644 index 00000000000..818bc9969f0 --- /dev/null +++ b/master/_static/js/versions.js @@ -0,0 +1,224 @@ +const themeFlyoutDisplay = "hidden"; +const themeVersionSelector = "True"; +const themeLanguageSelector = "True"; + +if (themeFlyoutDisplay === "attached") { + function renderLanguages(config) { + if (!config.projects.translations.length) { + return ""; + } + + const languagesHTML = ` +
+
Languages
+ ${config.projects.translations + .map( + (translation) => ` +
+ ${translation.language.code} +
+ `, + ) + .join("\n")} +
+ `; + return languagesHTML; + } + + function renderVersions(config) { + if (!config.versions.active.length) { + return ""; + } + const versionsHTML = ` +
+
Versions
+ ${config.versions.active + .map( + (version) => ` +
+ ${version.slug} +
+ `, + ) + .join("\n")} +
+ `; + return versionsHTML; + } + + function renderDownloads(config) { + if (!Object.keys(config.versions.current.downloads).length) { + return ""; + } + const downloadsNameDisplay = { + pdf: "PDF", + epub: "Epub", + htmlzip: "HTML", + }; + + const downloadsHTML = ` +
+
Downloads
+ ${Object.entries(config.versions.current.downloads) + .map( + ([name, url]) => ` +
+ ${downloadsNameDisplay[name]} +
+ `, + ) + .join("\n")} +
+ `; + return downloadsHTML; + } + + document.addEventListener("readthedocs-addons-data-ready", function (event) { + const config = event.detail.data(); + + const flyout = ` +
+ + Read the Docs + v: ${config.versions.current.slug} + + +
+
+ ${renderLanguages(config)} + ${renderVersions(config)} + ${renderDownloads(config)} +
+
On Read the Docs
+
+ Project Home +
+
+ Builds +
+
+ Downloads +
+
+
+
Search
+
+
+ +
+
+
+
+ + Hosted by Read the Docs + +
+
+ `; + + // Inject the generated flyout into the body HTML element. + document.body.insertAdjacentHTML("beforeend", flyout); + + // Trigger the Read the Docs Addons Search modal when clicking on the "Search docs" input from inside the flyout. + document + .querySelector("#flyout-search-form") + .addEventListener("focusin", () => { + const event = new CustomEvent("readthedocs-search-show"); + document.dispatchEvent(event); + }); + }) +} + +if (themeLanguageSelector || themeVersionSelector) { + function onSelectorSwitch(event) { + const option = event.target.selectedIndex; + const item = event.target.options[option]; + window.location.href = item.dataset.url; + } + + document.addEventListener("readthedocs-addons-data-ready", function (event) { + const config = event.detail.data(); + + const versionSwitch = document.querySelector( + "div.switch-menus > div.version-switch", + ); + if (themeVersionSelector) { + let versions = config.versions.active; + if (config.versions.current.hidden || config.versions.current.type === "external") { + versions.unshift(config.versions.current); + } + const versionSelect = ` + + `; + + versionSwitch.innerHTML = versionSelect; + versionSwitch.firstElementChild.addEventListener("change", onSelectorSwitch); + } + + const languageSwitch = document.querySelector( + "div.switch-menus > div.language-switch", + ); + + if (themeLanguageSelector) { + if (config.projects.translations.length) { + // Add the current language to the options on the selector + let languages = config.projects.translations.concat( + config.projects.current, + ); + languages = languages.sort((a, b) => + a.language.name.localeCompare(b.language.name), + ); + + const languageSelect = ` + + `; + + languageSwitch.innerHTML = languageSelect; + languageSwitch.firstElementChild.addEventListener("change", onSelectorSwitch); + } + else { + languageSwitch.remove(); + } + } + }); +} + +document.addEventListener("readthedocs-addons-data-ready", function (event) { + // Trigger the Read the Docs Addons Search modal when clicking on "Search docs" input from the topnav. + document + .querySelector("[role='search'] input") + .addEventListener("focusin", () => { + const event = new CustomEvent("readthedocs-search-show"); + document.dispatchEvent(event); + }); +}); \ No newline at end of file diff --git a/master/api.html b/master/api.html index b0c6e454cff..5b0e519469e 100644 --- a/master/api.html +++ b/master/api.html @@ -1,25 +1,23 @@ + + - API — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + API — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -
- 8.5.1.dev30+gd6e98430 -
@@ -328,6 +323,7 @@
  • pcdsdevices.gon.BaseGon
  • pcdsdevices.gon.GonWithDetArm
  • pcdsdevices.gon.Goniometer
  • +
  • pcdsdevices.gon.HxrDiffractometer
  • pcdsdevices.gon.Kappa
  • pcdsdevices.gon.KappaXYZStage
  • pcdsdevices.gon.SamPhi
  • @@ -400,6 +396,12 @@
  • pcdsdevices.keithley.K6514
  • +
  • pcdsdevices.lakeshore +
  • pcdsdevices.lamp_motion
    • pcdsdevices.lamp_motion.LAMP
    • pcdsdevices.lamp_motion.LAMPFlowCell
    • @@ -556,6 +558,7 @@
    • pcdsdevices.mirror.KBOMirrorHEStates
    • pcdsdevices.mirror.KBOMirrorStates
    • pcdsdevices.mirror.MirrorInsertState
    • +
    • pcdsdevices.mirror.MirrorStripe2D2P
    • pcdsdevices.mirror.MirrorStripe2D4P
    • pcdsdevices.mirror.OMMotor
    • pcdsdevices.mirror.OffsetMirror
    • @@ -612,6 +615,7 @@
    • pcdsdevices.pc
    • pcdsdevices.piezo
        @@ -645,6 +649,7 @@
      • pcdsdevices.pneumatic
      • pcdsdevices.positioner
      • pcdsdevices.pulsepicker
          @@ -820,6 +826,7 @@
        • pcdsdevices.spectrometer.HXRSpectrometer
        • pcdsdevices.spectrometer.Kmono
        • pcdsdevices.spectrometer.Mono
        • +
        • pcdsdevices.spectrometer.MonoGratingStates
        • pcdsdevices.spectrometer.TMOSpectrometer
        • pcdsdevices.spectrometer.TMOSpectrometerSOLIDATTStates
        • pcdsdevices.spectrometer.VonHamos4Crystal
        • @@ -922,6 +929,7 @@
        • pcdsdevices.valve
          Returns:
          -

          moved_status (Status) – Status that will be marked as done when the motion is complete.

          +

          moved_status (Status) – Status that will be marked as done when the motion is complete.

          @@ -535,10 +531,10 @@

          pcdsdevices.atm.ATMTarget
          Parameters:
            -
          • position (int or str) – The enumerate state or the corresponding integer.

          • +
          • position (int or str) – The enumerate state or the corresponding integer.

          • moved_cb (callable, optional) – Function to call at the end of motion. i.e. moved_cb(obj=self) will be called when move is complete.

          • -
          • timeout (int or float, optional) – Move timeout in seconds.

          • +
          • timeout (int or float, optional) – Move timeout in seconds.

          Returns:
          @@ -549,7 +545,7 @@

          pcdsdevices.atm.ATMTarget
          -status() str
          +status() str

          Returns a str with the current pv values for the device.

          @@ -560,7 +556,7 @@

          pcdsdevices.atm.ATMTarget
          -trigger() StatusBase
          +trigger() StatusBase

          Trigger the device and return status object.

          This method is responsible for implementing ‘trigger’ or ‘acquire’ functionality of this device.

          @@ -568,14 +564,14 @@

          pcdsdevices.atm.ATMTargetread() method) then this method is also responsible for arranging that the -StatusBase object returned by this method +StatusBase object returned by this method is notified when the device is ready to be read.

          If there is no delay between triggering and being readable, -then this method must return a StatusBase +then this method must return a StatusBase object which is already completed.

          Returns:
          -

          status (StatusBase) – StatusBase object which will be marked +

          status (StatusBase) – StatusBase object which will be marked as complete when the device is ready to be read.

          @@ -693,7 +689,7 @@

          pcdsdevices.atm.ATMTarget
          -subscriptions: ClassVar[FrozenSet[str]] = frozenset({'_req_done', 'acq_done', 'done_moving', 'readback', 'start_moving', 'state'})
          +subscriptions: ClassVar[FrozenSet[str]] = frozenset({'_req_done', 'acq_done', 'done_moving', 'readback', 'start_moving', 'state'})
          diff --git a/master/generated/pcdsdevices.atm.ArrivalTimeMonitor.html b/master/generated/pcdsdevices.atm.ArrivalTimeMonitor.html index 0b8195bee9c..2fdec5feb44 100644 --- a/master/generated/pcdsdevices.atm.ArrivalTimeMonitor.html +++ b/master/generated/pcdsdevices.atm.ArrivalTimeMonitor.html @@ -1,25 +1,23 @@ + + - pcdsdevices.atm.ArrivalTimeMonitor — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.atm.ArrivalTimeMonitor — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -
          - 8.5.1.dev30+gd6e98430 -
          @@ -94,6 +89,7 @@
        • pcdsdevices.ipm
        • pcdsdevices.jet
        • pcdsdevices.keithley
        • +
        • pcdsdevices.lakeshore
        • pcdsdevices.lamp_motion
        • pcdsdevices.lasers.btps
        • pcdsdevices.lasers.counters
        • @@ -282,14 +278,14 @@

          pcdsdevices.atm.ArrivalTimeMonitor
          -configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]
          +configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]

          Configure the device for something during a run

          This default implementation allows the user to change any of the configuration_attrs. Subclasses might override this to perform additional input validation, cleanup, etc.

          Parameters:
          -

          d (dict) – The configuration dictionary. To specify the order that +

          d (dict) – The configuration dictionary. To specify the order that the changes should be made, use an OrderedDict.

          Returns:
          @@ -304,7 +300,7 @@

          pcdsdevices.atm.ArrivalTimeMonitor
          -describe() OrderedDictType[str, Dict[str, Any]]
          +describe() OrderedDictType[str, Dict[str, Any]]

          Provide schema and meta-data for read().

          This keys in the OrderedDict this method returns must match the keys in the OrderedDict return by read().

          @@ -328,7 +324,7 @@

          pcdsdevices.atm.ArrivalTimeMonitor
          -get_lightpath_state(use_cache: bool = True) LightpathState
          +get_lightpath_state(use_cache: bool = True) LightpathState

          Return the current LightpathState

          Returns:
          @@ -345,7 +341,7 @@

          pcdsdevices.atm.ArrivalTimeMonitor
          -read() OrderedDictType[str, Dict[str, Any]]
          +read() OrderedDictType[str, Dict[str, Any]]

          Read data from the device.

          This method is expected to be as instantaneous as possible, with any substantial acquisition time taken care of in @@ -368,7 +364,7 @@

          pcdsdevices.atm.ArrivalTimeMonitor
          -read_configuration() OrderedDictType[str, Dict[str, Any]]
          +read_configuration() OrderedDictType[str, Dict[str, Any]]

          Dictionary mapping names to value dicts with keys: value, timestamp

          To control which fields are included, change the Component kinds on the device, or modify the configuration_attrs list.

          @@ -384,13 +380,13 @@

          pcdsdevices.atm.ArrivalTimeMonitor
          -stage_group_instances() Iterator[OphydObject]
          +stage_group_instances() Iterator[OphydObject]

          Yields an iterator of subdevices that should be staged.

          -status() str
          +status() str

          Returns a str with the current pv values for the device.

          @@ -407,7 +403,7 @@

          pcdsdevices.atm.ArrivalTimeMonitor
          -trigger() StatusBase
          +trigger() StatusBase

          Trigger the device and return status object.

          This method is responsible for implementing ‘trigger’ or ‘acquire’ functionality of this device.

          @@ -415,14 +411,14 @@

          pcdsdevices.atm.ArrivalTimeMonitorread() method) then this method is also responsible for arranging that the -StatusBase object returned by this method +StatusBase object returned by this method is notified when the device is ready to be read.

          If there is no delay between triggering and being readable, -then this method must return a StatusBase +then this method must return a StatusBase object which is already completed.

          Returns:
          -

          status (StatusBase) – StatusBase object which will be marked +

          status (StatusBase) – StatusBase object which will be marked as complete when the device is ready to be read.

          @@ -461,17 +457,17 @@

          pcdsdevices.atm.ArrivalTimeMonitor
          -needs_parent: list[type[OphydObject]] = [<class 'ophyd.signal.AttributeSignal'>, <class 'ophyd.signal.DerivedSignal'>, <class 'ophyd.areadetector.plugins.PluginBase'>, <class 'ophyd.pseudopos.PseudoSingle'>, <class 'pcdsdevices.signal.PVStateSignal'>, <class 'pcdsdevices.signal.AggregateSignal'>]
          +needs_parent: list[type[OphydObject]] = [<class 'ophyd.signal.AttributeSignal'>, <class 'ophyd.signal.DerivedSignal'>, <class 'ophyd.areadetector.plugins.PluginBase'>, <class 'ophyd.pseudopos.PseudoSingle'>, <class 'pcdsdevices.signal.PVStateSignal'>, <class 'pcdsdevices.signal.AggregateSignal'>]

          -stage_group: list[Component] = None
          +stage_group: list[Component] = None
          -subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})
          +subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})

          diff --git a/master/generated/pcdsdevices.atm.MFXATM.html b/master/generated/pcdsdevices.atm.MFXATM.html index 2a1934e6eee..f01e552c94f 100644 --- a/master/generated/pcdsdevices.atm.MFXATM.html +++ b/master/generated/pcdsdevices.atm.MFXATM.html @@ -1,25 +1,23 @@ + + - pcdsdevices.atm.MFXATM — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.atm.MFXATM — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -
          - 8.5.1.dev30+gd6e98430 -
          @@ -94,6 +89,7 @@
        • pcdsdevices.ipm
        • pcdsdevices.jet
        • pcdsdevices.keithley
        • +
        • pcdsdevices.lakeshore
        • pcdsdevices.lamp_motion
        • pcdsdevices.lasers.btps
        • pcdsdevices.lasers.counters
        • @@ -272,14 +268,14 @@

          pcdsdevices.atm.MFXATM
          -configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]
          +configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]

          Configure the device for something during a run

          This default implementation allows the user to change any of the configuration_attrs. Subclasses might override this to perform additional input validation, cleanup, etc.

          Parameters:
          -

          d (dict) – The configuration dictionary. To specify the order that +

          d (dict) – The configuration dictionary. To specify the order that the changes should be made, use an OrderedDict.

          Returns:
          @@ -294,7 +290,7 @@

          pcdsdevices.atm.MFXATM
          -describe() OrderedDictType[str, Dict[str, Any]]
          +describe() OrderedDictType[str, Dict[str, Any]]

          Provide schema and meta-data for read().

          This keys in the OrderedDict this method returns must match the keys in the OrderedDict return by read().

          @@ -318,7 +314,7 @@

          pcdsdevices.atm.MFXATM
          -get_lightpath_state(use_cache: bool = True) LightpathState
          +get_lightpath_state(use_cache: bool = True) LightpathState

          Return the current LightpathState

          Returns:
          @@ -335,7 +331,7 @@

          pcdsdevices.atm.MFXATM
          -read() OrderedDictType[str, Dict[str, Any]]
          +read() OrderedDictType[str, Dict[str, Any]]

          Read data from the device.

          This method is expected to be as instantaneous as possible, with any substantial acquisition time taken care of in @@ -358,7 +354,7 @@

          pcdsdevices.atm.MFXATM
          -read_configuration() OrderedDictType[str, Dict[str, Any]]
          +read_configuration() OrderedDictType[str, Dict[str, Any]]

          Dictionary mapping names to value dicts with keys: value, timestamp

          To control which fields are included, change the Component kinds on the device, or modify the configuration_attrs list.

          @@ -374,13 +370,13 @@

          pcdsdevices.atm.MFXATM
          -stage_group_instances() Iterator[OphydObject]
          +stage_group_instances() Iterator[OphydObject]

          Yields an iterator of subdevices that should be staged.

          -status() str
          +status() str

          Returns a str with the current pv values for the device.

          @@ -397,7 +393,7 @@

          pcdsdevices.atm.MFXATM
          -trigger() StatusBase
          +trigger() StatusBase

          Trigger the device and return status object.

          This method is responsible for implementing ‘trigger’ or ‘acquire’ functionality of this device.

          @@ -405,14 +401,14 @@

          pcdsdevices.atm.MFXATMread() method) then this method is also responsible for arranging that the -StatusBase object returned by this method +StatusBase object returned by this method is notified when the device is ready to be read.

          If there is no delay between triggering and being readable, -then this method must return a StatusBase +then this method must return a StatusBase object which is already completed.

          Returns:
          -

          status (StatusBase) – StatusBase object which will be marked +

          status (StatusBase) – StatusBase object which will be marked as complete when the device is ready to be read.

          @@ -456,17 +452,17 @@

          pcdsdevices.atm.MFXATM
          -needs_parent: list[type[OphydObject]] = [<class 'ophyd.signal.AttributeSignal'>, <class 'ophyd.signal.DerivedSignal'>, <class 'ophyd.areadetector.plugins.PluginBase'>, <class 'ophyd.pseudopos.PseudoSingle'>, <class 'pcdsdevices.signal.PVStateSignal'>, <class 'pcdsdevices.signal.AggregateSignal'>]
          +needs_parent: list[type[OphydObject]] = [<class 'ophyd.signal.AttributeSignal'>, <class 'ophyd.signal.DerivedSignal'>, <class 'ophyd.areadetector.plugins.PluginBase'>, <class 'ophyd.pseudopos.PseudoSingle'>, <class 'pcdsdevices.signal.PVStateSignal'>, <class 'pcdsdevices.signal.AggregateSignal'>]

          -stage_group: list[Component] = None
          +stage_group: list[Component] = None
          -subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})
          +subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})
          diff --git a/master/generated/pcdsdevices.atm.TM1K4.html b/master/generated/pcdsdevices.atm.TM1K4.html index d7ddb100b69..0243e3f3eed 100644 --- a/master/generated/pcdsdevices.atm.TM1K4.html +++ b/master/generated/pcdsdevices.atm.TM1K4.html @@ -1,25 +1,23 @@ + + - pcdsdevices.atm.TM1K4 — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.atm.TM1K4 — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -
          - 8.5.1.dev30+gd6e98430 -
          @@ -94,6 +89,7 @@
        • pcdsdevices.ipm
        • pcdsdevices.jet
        • pcdsdevices.keithley
        • +
        • pcdsdevices.lakeshore
        • pcdsdevices.lamp_motion
        • pcdsdevices.lasers.btps
        • pcdsdevices.lasers.counters
        • @@ -279,14 +275,14 @@

          pcdsdevices.atm.TM1K4
          -configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]
          +configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]

          Configure the device for something during a run

          This default implementation allows the user to change any of the configuration_attrs. Subclasses might override this to perform additional input validation, cleanup, etc.

          Parameters:
          -

          d (dict) – The configuration dictionary. To specify the order that +

          d (dict) – The configuration dictionary. To specify the order that the changes should be made, use an OrderedDict.

          Returns:
          @@ -301,7 +297,7 @@

          pcdsdevices.atm.TM1K4
          -describe() OrderedDictType[str, Dict[str, Any]]
          +describe() OrderedDictType[str, Dict[str, Any]]

          Provide schema and meta-data for read().

          This keys in the OrderedDict this method returns must match the keys in the OrderedDict return by read().

          @@ -325,7 +321,7 @@

          pcdsdevices.atm.TM1K4
          -get_lightpath_state(use_cache: bool = True) LightpathState
          +get_lightpath_state(use_cache: bool = True) LightpathState

          Return the current LightpathState

          Returns:
          @@ -342,7 +338,7 @@

          pcdsdevices.atm.TM1K4
          -read() OrderedDictType[str, Dict[str, Any]]
          +read() OrderedDictType[str, Dict[str, Any]]

          Read data from the device.

          This method is expected to be as instantaneous as possible, with any substantial acquisition time taken care of in @@ -365,7 +361,7 @@

          pcdsdevices.atm.TM1K4
          -read_configuration() OrderedDictType[str, Dict[str, Any]]
          +read_configuration() OrderedDictType[str, Dict[str, Any]]

          Dictionary mapping names to value dicts with keys: value, timestamp

          To control which fields are included, change the Component kinds on the device, or modify the configuration_attrs list.

          @@ -381,13 +377,13 @@

          pcdsdevices.atm.TM1K4
          -stage_group_instances() Iterator[OphydObject]
          +stage_group_instances() Iterator[OphydObject]

          Yields an iterator of subdevices that should be staged.

          -status() str
          +status() str

          Returns a str with the current pv values for the device.

          @@ -404,7 +400,7 @@

          pcdsdevices.atm.TM1K4
          -trigger() StatusBase
          +trigger() StatusBase

          Trigger the device and return status object.

          This method is responsible for implementing ‘trigger’ or ‘acquire’ functionality of this device.

          @@ -412,14 +408,14 @@

          pcdsdevices.atm.TM1K4read() method) then this method is also responsible for arranging that the -StatusBase object returned by this method +StatusBase object returned by this method is notified when the device is ready to be read.

          If there is no delay between triggering and being readable, -then this method must return a StatusBase +then this method must return a StatusBase object which is already completed.

          Returns:
          -

          status (StatusBase) – StatusBase object which will be marked +

          status (StatusBase) – StatusBase object which will be marked as complete when the device is ready to be read.

          @@ -458,17 +454,17 @@

          pcdsdevices.atm.TM1K4
          -needs_parent: list[type[OphydObject]] = [<class 'ophyd.signal.AttributeSignal'>, <class 'ophyd.signal.DerivedSignal'>, <class 'ophyd.areadetector.plugins.PluginBase'>, <class 'ophyd.pseudopos.PseudoSingle'>, <class 'pcdsdevices.signal.PVStateSignal'>, <class 'pcdsdevices.signal.AggregateSignal'>]
          +needs_parent: list[type[OphydObject]] = [<class 'ophyd.signal.AttributeSignal'>, <class 'ophyd.signal.DerivedSignal'>, <class 'ophyd.areadetector.plugins.PluginBase'>, <class 'ophyd.pseudopos.PseudoSingle'>, <class 'pcdsdevices.signal.PVStateSignal'>, <class 'pcdsdevices.signal.AggregateSignal'>]

          -stage_group: list[Component] = None
          +stage_group: list[Component] = None
          -subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})
          +subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})
          diff --git a/master/generated/pcdsdevices.atm.TM1K4Target.html b/master/generated/pcdsdevices.atm.TM1K4Target.html index fd34e4a7cde..f64f3ad7329 100644 --- a/master/generated/pcdsdevices.atm.TM1K4Target.html +++ b/master/generated/pcdsdevices.atm.TM1K4Target.html @@ -1,25 +1,23 @@ + + - pcdsdevices.atm.TM1K4Target — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.atm.TM1K4Target — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -
          - 8.5.1.dev30+gd6e98430 -
          @@ -94,6 +89,7 @@
        • pcdsdevices.ipm
        • pcdsdevices.jet
        • pcdsdevices.keithley
        • +
        • pcdsdevices.lakeshore
        • pcdsdevices.lamp_motion
        • pcdsdevices.lasers.btps
        • pcdsdevices.lasers.counters
        • @@ -205,7 +201,7 @@

          pcdsdevices.atm.TM1K4Target class pcdsdevices.atm.TM1K4Target(prefix, *, name, **kwargs)

          Controls TM1K4’s states, and ATM in TMO.

          -

          Defines the state count as 8 (OUT and 7 targets), two more than the +

          Defines the state count as 9 (OUT and 8 targets), three more than the standard ATM.

          @@ -335,14 +331,14 @@

          pcdsdevices.atm.TM1K4Target
          -configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]
          +configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]

          Configure the device for something during a run

          This default implementation allows the user to change any of the configuration_attrs. Subclasses might override this to perform additional input validation, cleanup, etc.

          Parameters:
          -

          d (dict) – The configuration dictionary. To specify the order that +

          d (dict) – The configuration dictionary. To specify the order that the changes should be made, use an OrderedDict.

          Returns:
          @@ -357,7 +353,7 @@

          pcdsdevices.atm.TM1K4Target
          -describe() OrderedDictType[str, Dict[str, Any]]
          +describe() OrderedDictType[str, Dict[str, Any]]

          Provide schema and meta-data for read().

          This keys in the OrderedDict this method returns must match the keys in the OrderedDict return by read().

          @@ -409,12 +405,12 @@

          pcdsdevices.atm.TM1K4Targetobj, which will be set to this instance.

          -
        • timeout (float, optional) – Maximum time to wait for the motion.

        • -
        • wait (bool, optional) – If True, do not continue until the move is complete.

        • +
        • timeout (float, optional) – Maximum time to wait for the motion.

        • +
        • wait (bool, optional) – If True, do not continue until the move is complete.

        • Returns:
          -

          moved_status (Status) – Status that will be marked as done when the motion is complete.

          +

          moved_status (Status) – Status that will be marked as done when the motion is complete.

          @@ -426,11 +422,11 @@

          pcdsdevices.atm.TM1K4Target
          Parameters:
            -
          • position (int or str) – The enumerate state or the corresponding integer.

          • +
          • position (int or str) – The enumerate state or the corresponding integer.

          • moved_cb (callable, optional) – Function to call at the end of motion. i.e. moved_cb(obj=self) will be called when move is complete.

          • -
          • timeout (int or float, optional) – Move timeout in seconds.

          • -
          • wait (bool, optional) – If True, do not return until the motion has completed.

          • +
          • timeout (int or float, optional) – Move timeout in seconds.

          • +
          • wait (bool, optional) – If True, do not return until the motion has completed.

          Returns:
          @@ -447,12 +443,12 @@

          pcdsdevices.atm.TM1K4TargetParameters:
          • position – Desired end position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • wait (bool, optional) – If True, wait for motion completion before returning. +

          • wait (bool, optional) – If True, wait for motion completion before returning. Defaults to False.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          @@ -466,7 +462,7 @@

          pcdsdevices.atm.TM1K4Target
          -read() OrderedDictType[str, Dict[str, Any]]
          +read() OrderedDictType[str, Dict[str, Any]]

          Read data from the device.

          This method is expected to be as instantaneous as possible, with any substantial acquisition time taken care of in @@ -489,7 +485,7 @@

          pcdsdevices.atm.TM1K4Target
          -read_configuration() OrderedDictType[str, Dict[str, Any]]
          +read_configuration() OrderedDictType[str, Dict[str, Any]]

          Dictionary mapping names to value dicts with keys: value, timestamp

          To control which fields are included, change the Component kinds on the device, or modify the configuration_attrs list.

          @@ -506,12 +502,12 @@

          pcdsdevices.atm.TM1K4Targetobj, which will be set to this instance.

          -
        • timeout (float, optional) – Maximum time to wait for the motion.

        • -
        • wait (bool, optional) – If True, do not continue until the move is complete.

        • +
        • timeout (float, optional) – Maximum time to wait for the motion.

        • +
        • wait (bool, optional) – If True, do not continue until the move is complete.

        • Returns:
          -

          moved_status (Status) – Status that will be marked as done when the motion is complete.

          +

          moved_status (Status) – Status that will be marked as done when the motion is complete.

          @@ -535,10 +531,10 @@

          pcdsdevices.atm.TM1K4Target
          Parameters:
            -
          • position (int or str) – The enumerate state or the corresponding integer.

          • +
          • position (int or str) – The enumerate state or the corresponding integer.

          • moved_cb (callable, optional) – Function to call at the end of motion. i.e. moved_cb(obj=self) will be called when move is complete.

          • -
          • timeout (int or float, optional) – Move timeout in seconds.

          • +
          • timeout (int or float, optional) – Move timeout in seconds.

          Returns:
          @@ -549,7 +545,7 @@

          pcdsdevices.atm.TM1K4Target
          -status() str
          +status() str

          Returns a str with the current pv values for the device.

          @@ -560,7 +556,7 @@

          pcdsdevices.atm.TM1K4Target
          -trigger() StatusBase
          +trigger() StatusBase

          Trigger the device and return status object.

          This method is responsible for implementing ‘trigger’ or ‘acquire’ functionality of this device.

          @@ -568,14 +564,14 @@

          pcdsdevices.atm.TM1K4Targetread() method) then this method is also responsible for arranging that the -StatusBase object returned by this method +StatusBase object returned by this method is notified when the device is ready to be read.

          If there is no delay between triggering and being readable, -then this method must return a StatusBase +then this method must return a StatusBase object which is already completed.

          Returns:
          -

          status (StatusBase) – StatusBase object which will be marked +

          status (StatusBase) – StatusBase object which will be marked as complete when the device is ready to be read.

          @@ -693,7 +689,7 @@

          pcdsdevices.atm.TM1K4Target
          -subscriptions: ClassVar[FrozenSet[str]] = frozenset({'_req_done', 'acq_done', 'done_moving', 'readback', 'start_moving', 'state'})
          +subscriptions: ClassVar[FrozenSet[str]] = frozenset({'_req_done', 'acq_done', 'done_moving', 'readback', 'start_moving', 'state'})
          diff --git a/master/generated/pcdsdevices.atm.TM2K2.html b/master/generated/pcdsdevices.atm.TM2K2.html index 566270874e0..d1bc38bb90d 100644 --- a/master/generated/pcdsdevices.atm.TM2K2.html +++ b/master/generated/pcdsdevices.atm.TM2K2.html @@ -1,25 +1,23 @@ + + - pcdsdevices.atm.TM2K2 — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.atm.TM2K2 — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -
          - 8.5.1.dev30+gd6e98430 -
          @@ -94,6 +89,7 @@
        • pcdsdevices.ipm
        • pcdsdevices.jet
        • pcdsdevices.keithley
        • +
        • pcdsdevices.lakeshore
        • pcdsdevices.lamp_motion
        • pcdsdevices.lasers.btps
        • pcdsdevices.lasers.counters
        • @@ -279,14 +275,14 @@

          pcdsdevices.atm.TM2K2
          -configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]
          +configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]

          Configure the device for something during a run

          This default implementation allows the user to change any of the configuration_attrs. Subclasses might override this to perform additional input validation, cleanup, etc.

          Parameters:
          -

          d (dict) – The configuration dictionary. To specify the order that +

          d (dict) – The configuration dictionary. To specify the order that the changes should be made, use an OrderedDict.

          Returns:
          @@ -301,7 +297,7 @@

          pcdsdevices.atm.TM2K2
          -describe() OrderedDictType[str, Dict[str, Any]]
          +describe() OrderedDictType[str, Dict[str, Any]]

          Provide schema and meta-data for read().

          This keys in the OrderedDict this method returns must match the keys in the OrderedDict return by read().

          @@ -325,7 +321,7 @@

          pcdsdevices.atm.TM2K2
          -get_lightpath_state(use_cache: bool = True) LightpathState
          +get_lightpath_state(use_cache: bool = True) LightpathState

          Return the current LightpathState

          Returns:
          @@ -342,7 +338,7 @@

          pcdsdevices.atm.TM2K2
          -read() OrderedDictType[str, Dict[str, Any]]
          +read() OrderedDictType[str, Dict[str, Any]]

          Read data from the device.

          This method is expected to be as instantaneous as possible, with any substantial acquisition time taken care of in @@ -365,7 +361,7 @@

          pcdsdevices.atm.TM2K2
          -read_configuration() OrderedDictType[str, Dict[str, Any]]
          +read_configuration() OrderedDictType[str, Dict[str, Any]]

          Dictionary mapping names to value dicts with keys: value, timestamp

          To control which fields are included, change the Component kinds on the device, or modify the configuration_attrs list.

          @@ -381,13 +377,13 @@

          pcdsdevices.atm.TM2K2
          -stage_group_instances() Iterator[OphydObject]
          +stage_group_instances() Iterator[OphydObject]

          Yields an iterator of subdevices that should be staged.

          -status() str
          +status() str

          Returns a str with the current pv values for the device.

          @@ -404,7 +400,7 @@

          pcdsdevices.atm.TM2K2
          -trigger() StatusBase
          +trigger() StatusBase

          Trigger the device and return status object.

          This method is responsible for implementing ‘trigger’ or ‘acquire’ functionality of this device.

          @@ -412,14 +408,14 @@

          pcdsdevices.atm.TM2K2read() method) then this method is also responsible for arranging that the -StatusBase object returned by this method +StatusBase object returned by this method is notified when the device is ready to be read.

          If there is no delay between triggering and being readable, -then this method must return a StatusBase +then this method must return a StatusBase object which is already completed.

          Returns:
          -

          status (StatusBase) – StatusBase object which will be marked +

          status (StatusBase) – StatusBase object which will be marked as complete when the device is ready to be read.

          @@ -458,17 +454,17 @@

          pcdsdevices.atm.TM2K2
          -needs_parent: list[type[OphydObject]] = [<class 'ophyd.signal.AttributeSignal'>, <class 'ophyd.signal.DerivedSignal'>, <class 'ophyd.areadetector.plugins.PluginBase'>, <class 'ophyd.pseudopos.PseudoSingle'>, <class 'pcdsdevices.signal.PVStateSignal'>, <class 'pcdsdevices.signal.AggregateSignal'>]
          +needs_parent: list[type[OphydObject]] = [<class 'ophyd.signal.AttributeSignal'>, <class 'ophyd.signal.DerivedSignal'>, <class 'ophyd.areadetector.plugins.PluginBase'>, <class 'ophyd.pseudopos.PseudoSingle'>, <class 'pcdsdevices.signal.PVStateSignal'>, <class 'pcdsdevices.signal.AggregateSignal'>]

          -stage_group: list[Component] = None
          +stage_group: list[Component] = None
          -subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})
          +subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})

          diff --git a/master/generated/pcdsdevices.atm.TM2K2Target.html b/master/generated/pcdsdevices.atm.TM2K2Target.html index 4caddf5fa06..6b684afcf05 100644 --- a/master/generated/pcdsdevices.atm.TM2K2Target.html +++ b/master/generated/pcdsdevices.atm.TM2K2Target.html @@ -1,25 +1,23 @@ + + - pcdsdevices.atm.TM2K2Target — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.atm.TM2K2Target — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -
          - 8.5.1.dev30+gd6e98430 -
          @@ -94,6 +89,7 @@
        • pcdsdevices.ipm
        • pcdsdevices.jet
        • pcdsdevices.keithley
        • +
        • pcdsdevices.lakeshore
        • pcdsdevices.lamp_motion
        • pcdsdevices.lasers.btps
        • pcdsdevices.lasers.counters
        • @@ -335,14 +331,14 @@

          pcdsdevices.atm.TM2K2Target
          -configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]
          +configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]

          Configure the device for something during a run

          This default implementation allows the user to change any of the configuration_attrs. Subclasses might override this to perform additional input validation, cleanup, etc.

          Parameters:
          -

          d (dict) – The configuration dictionary. To specify the order that +

          d (dict) – The configuration dictionary. To specify the order that the changes should be made, use an OrderedDict.

          Returns:
          @@ -357,7 +353,7 @@

          pcdsdevices.atm.TM2K2Target
          -describe() OrderedDictType[str, Dict[str, Any]]
          +describe() OrderedDictType[str, Dict[str, Any]]

          Provide schema and meta-data for read().

          This keys in the OrderedDict this method returns must match the keys in the OrderedDict return by read().

          @@ -409,12 +405,12 @@

          pcdsdevices.atm.TM2K2Targetobj, which will be set to this instance.

          -
        • timeout (float, optional) – Maximum time to wait for the motion.

        • -
        • wait (bool, optional) – If True, do not continue until the move is complete.

        • +
        • timeout (float, optional) – Maximum time to wait for the motion.

        • +
        • wait (bool, optional) – If True, do not continue until the move is complete.

        • Returns:
          -

          moved_status (Status) – Status that will be marked as done when the motion is complete.

          +

          moved_status (Status) – Status that will be marked as done when the motion is complete.

          @@ -426,11 +422,11 @@

          pcdsdevices.atm.TM2K2Target
          Parameters:
            -
          • position (int or str) – The enumerate state or the corresponding integer.

          • +
          • position (int or str) – The enumerate state or the corresponding integer.

          • moved_cb (callable, optional) – Function to call at the end of motion. i.e. moved_cb(obj=self) will be called when move is complete.

          • -
          • timeout (int or float, optional) – Move timeout in seconds.

          • -
          • wait (bool, optional) – If True, do not return until the motion has completed.

          • +
          • timeout (int or float, optional) – Move timeout in seconds.

          • +
          • wait (bool, optional) – If True, do not return until the motion has completed.

          Returns:
          @@ -447,12 +443,12 @@

          pcdsdevices.atm.TM2K2TargetParameters:
          • position – Desired end position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • wait (bool, optional) – If True, wait for motion completion before returning. +

          • wait (bool, optional) – If True, wait for motion completion before returning. Defaults to False.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          @@ -466,7 +462,7 @@

          pcdsdevices.atm.TM2K2Target
          -read() OrderedDictType[str, Dict[str, Any]]
          +read() OrderedDictType[str, Dict[str, Any]]

          Read data from the device.

          This method is expected to be as instantaneous as possible, with any substantial acquisition time taken care of in @@ -489,7 +485,7 @@

          pcdsdevices.atm.TM2K2Target
          -read_configuration() OrderedDictType[str, Dict[str, Any]]
          +read_configuration() OrderedDictType[str, Dict[str, Any]]

          Dictionary mapping names to value dicts with keys: value, timestamp

          To control which fields are included, change the Component kinds on the device, or modify the configuration_attrs list.

          @@ -506,12 +502,12 @@

          pcdsdevices.atm.TM2K2Targetobj, which will be set to this instance.

          -
        • timeout (float, optional) – Maximum time to wait for the motion.

        • -
        • wait (bool, optional) – If True, do not continue until the move is complete.

        • +
        • timeout (float, optional) – Maximum time to wait for the motion.

        • +
        • wait (bool, optional) – If True, do not continue until the move is complete.

        • Returns:
          -

          moved_status (Status) – Status that will be marked as done when the motion is complete.

          +

          moved_status (Status) – Status that will be marked as done when the motion is complete.

          @@ -535,10 +531,10 @@

          pcdsdevices.atm.TM2K2Target
          Parameters:
            -
          • position (int or str) – The enumerate state or the corresponding integer.

          • +
          • position (int or str) – The enumerate state or the corresponding integer.

          • moved_cb (callable, optional) – Function to call at the end of motion. i.e. moved_cb(obj=self) will be called when move is complete.

          • -
          • timeout (int or float, optional) – Move timeout in seconds.

          • +
          • timeout (int or float, optional) – Move timeout in seconds.

          Returns:
          @@ -549,7 +545,7 @@

          pcdsdevices.atm.TM2K2Target
          -status() str
          +status() str

          Returns a str with the current pv values for the device.

          @@ -560,7 +556,7 @@

          pcdsdevices.atm.TM2K2Target
          -trigger() StatusBase
          +trigger() StatusBase

          Trigger the device and return status object.

          This method is responsible for implementing ‘trigger’ or ‘acquire’ functionality of this device.

          @@ -568,14 +564,14 @@

          pcdsdevices.atm.TM2K2Targetread() method) then this method is also responsible for arranging that the -StatusBase object returned by this method +StatusBase object returned by this method is notified when the device is ready to be read.

          If there is no delay between triggering and being readable, -then this method must return a StatusBase +then this method must return a StatusBase object which is already completed.

          Returns:
          -

          status (StatusBase) – StatusBase object which will be marked +

          status (StatusBase) – StatusBase object which will be marked as complete when the device is ready to be read.

          @@ -693,7 +689,7 @@

          pcdsdevices.atm.TM2K2Target
          -subscriptions: ClassVar[FrozenSet[str]] = frozenset({'_req_done', 'acq_done', 'done_moving', 'readback', 'start_moving', 'state'})
          +subscriptions: ClassVar[FrozenSet[str]] = frozenset({'_req_done', 'acq_done', 'done_moving', 'readback', 'start_moving', 'state'})
          diff --git a/master/generated/pcdsdevices.atm.TM2K4.html b/master/generated/pcdsdevices.atm.TM2K4.html index 2e65b454853..683698ecfda 100644 --- a/master/generated/pcdsdevices.atm.TM2K4.html +++ b/master/generated/pcdsdevices.atm.TM2K4.html @@ -1,25 +1,23 @@ + + - pcdsdevices.atm.TM2K4 — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.atm.TM2K4 — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -
          - 8.5.1.dev30+gd6e98430 -
          @@ -94,6 +89,7 @@
        • pcdsdevices.ipm
        • pcdsdevices.jet
        • pcdsdevices.keithley
        • +
        • pcdsdevices.lakeshore
        • pcdsdevices.lamp_motion
        • pcdsdevices.lasers.btps
        • pcdsdevices.lasers.counters
        • @@ -272,14 +268,14 @@

          pcdsdevices.atm.TM2K4
          -configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]
          +configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]

          Configure the device for something during a run

          This default implementation allows the user to change any of the configuration_attrs. Subclasses might override this to perform additional input validation, cleanup, etc.

          Parameters:
          -

          d (dict) – The configuration dictionary. To specify the order that +

          d (dict) – The configuration dictionary. To specify the order that the changes should be made, use an OrderedDict.

          Returns:
          @@ -294,7 +290,7 @@

          pcdsdevices.atm.TM2K4
          -describe() OrderedDictType[str, Dict[str, Any]]
          +describe() OrderedDictType[str, Dict[str, Any]]

          Provide schema and meta-data for read().

          This keys in the OrderedDict this method returns must match the keys in the OrderedDict return by read().

          @@ -318,7 +314,7 @@

          pcdsdevices.atm.TM2K4
          -get_lightpath_state(use_cache: bool = True) LightpathState
          +get_lightpath_state(use_cache: bool = True) LightpathState

          Return the current LightpathState

          Returns:
          @@ -335,7 +331,7 @@

          pcdsdevices.atm.TM2K4
          -read() OrderedDictType[str, Dict[str, Any]]
          +read() OrderedDictType[str, Dict[str, Any]]

          Read data from the device.

          This method is expected to be as instantaneous as possible, with any substantial acquisition time taken care of in @@ -358,7 +354,7 @@

          pcdsdevices.atm.TM2K4
          -read_configuration() OrderedDictType[str, Dict[str, Any]]
          +read_configuration() OrderedDictType[str, Dict[str, Any]]

          Dictionary mapping names to value dicts with keys: value, timestamp

          To control which fields are included, change the Component kinds on the device, or modify the configuration_attrs list.

          @@ -374,13 +370,13 @@

          pcdsdevices.atm.TM2K4
          -stage_group_instances() Iterator[OphydObject]
          +stage_group_instances() Iterator[OphydObject]

          Yields an iterator of subdevices that should be staged.

          -status() str
          +status() str

          Returns a str with the current pv values for the device.

          @@ -397,7 +393,7 @@

          pcdsdevices.atm.TM2K4
          -trigger() StatusBase
          +trigger() StatusBase

          Trigger the device and return status object.

          This method is responsible for implementing ‘trigger’ or ‘acquire’ functionality of this device.

          @@ -405,14 +401,14 @@

          pcdsdevices.atm.TM2K4read() method) then this method is also responsible for arranging that the -StatusBase object returned by this method +StatusBase object returned by this method is notified when the device is ready to be read.

          If there is no delay between triggering and being readable, -then this method must return a StatusBase +then this method must return a StatusBase object which is already completed.

          Returns:
          -

          status (StatusBase) – StatusBase object which will be marked +

          status (StatusBase) – StatusBase object which will be marked as complete when the device is ready to be read.

          @@ -456,17 +452,17 @@

          pcdsdevices.atm.TM2K4
          -needs_parent: list[type[OphydObject]] = [<class 'ophyd.signal.AttributeSignal'>, <class 'ophyd.signal.DerivedSignal'>, <class 'ophyd.areadetector.plugins.PluginBase'>, <class 'ophyd.pseudopos.PseudoSingle'>, <class 'pcdsdevices.signal.PVStateSignal'>, <class 'pcdsdevices.signal.AggregateSignal'>]
          +needs_parent: list[type[OphydObject]] = [<class 'ophyd.signal.AttributeSignal'>, <class 'ophyd.signal.DerivedSignal'>, <class 'ophyd.areadetector.plugins.PluginBase'>, <class 'ophyd.pseudopos.PseudoSingle'>, <class 'pcdsdevices.signal.PVStateSignal'>, <class 'pcdsdevices.signal.AggregateSignal'>]

          -stage_group: list[Component] = None
          +stage_group: list[Component] = None
          -subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})
          +subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})

          diff --git a/master/generated/pcdsdevices.atm.TM2K4Target.html b/master/generated/pcdsdevices.atm.TM2K4Target.html index 1cadeabe133..fde51d4aac0 100644 --- a/master/generated/pcdsdevices.atm.TM2K4Target.html +++ b/master/generated/pcdsdevices.atm.TM2K4Target.html @@ -1,25 +1,23 @@ + + - pcdsdevices.atm.TM2K4Target — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.atm.TM2K4Target — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -
          - 8.5.1.dev30+gd6e98430 -
          @@ -94,6 +89,7 @@
        • pcdsdevices.ipm
        • pcdsdevices.jet
        • pcdsdevices.keithley
        • +
        • pcdsdevices.lakeshore
        • pcdsdevices.lamp_motion
        • pcdsdevices.lasers.btps
        • pcdsdevices.lasers.counters
        • @@ -335,14 +331,14 @@

          pcdsdevices.atm.TM2K4Target
          -configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]
          +configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]

          Configure the device for something during a run

          This default implementation allows the user to change any of the configuration_attrs. Subclasses might override this to perform additional input validation, cleanup, etc.

          Parameters:
          -

          d (dict) – The configuration dictionary. To specify the order that +

          d (dict) – The configuration dictionary. To specify the order that the changes should be made, use an OrderedDict.

          Returns:
          @@ -357,7 +353,7 @@

          pcdsdevices.atm.TM2K4Target
          -describe() OrderedDictType[str, Dict[str, Any]]
          +describe() OrderedDictType[str, Dict[str, Any]]

          Provide schema and meta-data for read().

          This keys in the OrderedDict this method returns must match the keys in the OrderedDict return by read().

          @@ -409,12 +405,12 @@

          pcdsdevices.atm.TM2K4Targetobj, which will be set to this instance.

          -
        • timeout (float, optional) – Maximum time to wait for the motion.

        • -
        • wait (bool, optional) – If True, do not continue until the move is complete.

        • +
        • timeout (float, optional) – Maximum time to wait for the motion.

        • +
        • wait (bool, optional) – If True, do not continue until the move is complete.

        • Returns:
          -

          moved_status (Status) – Status that will be marked as done when the motion is complete.

          +

          moved_status (Status) – Status that will be marked as done when the motion is complete.

          @@ -426,11 +422,11 @@

          pcdsdevices.atm.TM2K4Target
          Parameters:
            -
          • position (int or str) – The enumerate state or the corresponding integer.

          • +
          • position (int or str) – The enumerate state or the corresponding integer.

          • moved_cb (callable, optional) – Function to call at the end of motion. i.e. moved_cb(obj=self) will be called when move is complete.

          • -
          • timeout (int or float, optional) – Move timeout in seconds.

          • -
          • wait (bool, optional) – If True, do not return until the motion has completed.

          • +
          • timeout (int or float, optional) – Move timeout in seconds.

          • +
          • wait (bool, optional) – If True, do not return until the motion has completed.

          Returns:
          @@ -447,12 +443,12 @@

          pcdsdevices.atm.TM2K4TargetParameters:
          • position – Desired end position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • wait (bool, optional) – If True, wait for motion completion before returning. +

          • wait (bool, optional) – If True, wait for motion completion before returning. Defaults to False.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          @@ -466,7 +462,7 @@

          pcdsdevices.atm.TM2K4Target
          -read() OrderedDictType[str, Dict[str, Any]]
          +read() OrderedDictType[str, Dict[str, Any]]

          Read data from the device.

          This method is expected to be as instantaneous as possible, with any substantial acquisition time taken care of in @@ -489,7 +485,7 @@

          pcdsdevices.atm.TM2K4Target
          -read_configuration() OrderedDictType[str, Dict[str, Any]]
          +read_configuration() OrderedDictType[str, Dict[str, Any]]

          Dictionary mapping names to value dicts with keys: value, timestamp

          To control which fields are included, change the Component kinds on the device, or modify the configuration_attrs list.

          @@ -506,12 +502,12 @@

          pcdsdevices.atm.TM2K4Targetobj, which will be set to this instance.

          -
        • timeout (float, optional) – Maximum time to wait for the motion.

        • -
        • wait (bool, optional) – If True, do not continue until the move is complete.

        • +
        • timeout (float, optional) – Maximum time to wait for the motion.

        • +
        • wait (bool, optional) – If True, do not continue until the move is complete.

        • Returns:
          -

          moved_status (Status) – Status that will be marked as done when the motion is complete.

          +

          moved_status (Status) – Status that will be marked as done when the motion is complete.

          @@ -535,10 +531,10 @@

          pcdsdevices.atm.TM2K4Target
          Parameters:
            -
          • position (int or str) – The enumerate state or the corresponding integer.

          • +
          • position (int or str) – The enumerate state or the corresponding integer.

          • moved_cb (callable, optional) – Function to call at the end of motion. i.e. moved_cb(obj=self) will be called when move is complete.

          • -
          • timeout (int or float, optional) – Move timeout in seconds.

          • +
          • timeout (int or float, optional) – Move timeout in seconds.

          Returns:
          @@ -549,7 +545,7 @@

          pcdsdevices.atm.TM2K4Target
          -status() str
          +status() str

          Returns a str with the current pv values for the device.

          @@ -560,7 +556,7 @@

          pcdsdevices.atm.TM2K4Target
          -trigger() StatusBase
          +trigger() StatusBase

          Trigger the device and return status object.

          This method is responsible for implementing ‘trigger’ or ‘acquire’ functionality of this device.

          @@ -568,14 +564,14 @@

          pcdsdevices.atm.TM2K4Targetread() method) then this method is also responsible for arranging that the -StatusBase object returned by this method +StatusBase object returned by this method is notified when the device is ready to be read.

          If there is no delay between triggering and being readable, -then this method must return a StatusBase +then this method must return a StatusBase object which is already completed.

          Returns:
          -

          status (StatusBase) – StatusBase object which will be marked +

          status (StatusBase) – StatusBase object which will be marked as complete when the device is ready to be read.

          @@ -693,7 +689,7 @@

          pcdsdevices.atm.TM2K4Target
          -subscriptions: ClassVar[FrozenSet[str]] = frozenset({'_req_done', 'acq_done', 'done_moving', 'readback', 'start_moving', 'state'})
          +subscriptions: ClassVar[FrozenSet[str]] = frozenset({'_req_done', 'acq_done', 'done_moving', 'readback', 'start_moving', 'state'})
          diff --git a/master/generated/pcdsdevices.attenuator.AT1K2.html b/master/generated/pcdsdevices.attenuator.AT1K2.html index 6258778860a..7c119af3db2 100644 --- a/master/generated/pcdsdevices.attenuator.AT1K2.html +++ b/master/generated/pcdsdevices.attenuator.AT1K2.html @@ -1,25 +1,23 @@ + + - pcdsdevices.attenuator.AT1K2 — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.attenuator.AT1K2 — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -
          - 8.5.1.dev30+gd6e98430 -
          @@ -114,6 +109,7 @@
        • pcdsdevices.ipm
        • pcdsdevices.jet
        • pcdsdevices.keithley
        • +
        • pcdsdevices.lakeshore
        • pcdsdevices.lamp_motion
        • pcdsdevices.lasers.btps
        • pcdsdevices.lasers.counters
        • @@ -233,9 +229,9 @@

          pcdsdevices.attenuator.AT1K2
          Parameters:
            -
          • prefix (str) – Solid Attenuator base PV.

          • -
          • name (str) – Alias for the Solid Attenuator.

          • -
          • calculator_prefix (str) – The prefix for the calculator PVs.

          • +
          • prefix (str) – Solid Attenuator base PV.

          • +
          • name (str) – Alias for the Solid Attenuator.

          • +
          • calculator_prefix (str) – The prefix for the calculator PVs.

          @@ -338,14 +334,14 @@

          pcdsdevices.attenuator.AT1K2
          -configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]
          +configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]

          Configure the device for something during a run

          This default implementation allows the user to change any of the configuration_attrs. Subclasses might override this to perform additional input validation, cleanup, etc.

          Parameters:
          -

          d (dict) – The configuration dictionary. To specify the order that +

          d (dict) – The configuration dictionary. To specify the order that the changes should be made, use an OrderedDict.

          Returns:
          @@ -360,7 +356,7 @@

          pcdsdevices.attenuator.AT1K2
          -describe() OrderedDictType[str, Dict[str, Any]]
          +describe() OrderedDictType[str, Dict[str, Any]]

          Provide schema and meta-data for read().

          This keys in the OrderedDict this method returns must match the keys in the OrderedDict return by read().

          @@ -409,7 +405,7 @@

          pcdsdevices.attenuator.AT1K2float, optional) – Maximum time to wait for the motion. If None, the default timeout +
        • timeout (float, optional) – Maximum time to wait for the motion. If None, the default timeout for this positioner is used.

        • @@ -418,9 +414,9 @@

          pcdsdevices.attenuator.AT1K2Raises:

          @@ -434,12 +430,12 @@

          pcdsdevices.attenuator.AT1K2Parameters:
          • position – Desired end position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • wait (bool, optional) – If True, wait for motion completion before returning. +

          • wait (bool, optional) – If True, wait for motion completion before returning. Defaults to False.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          @@ -461,13 +457,13 @@

          pcdsdevices.attenuator.AT1K2
          Parameters:
            -
          • delta (float) – Desired change in position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • delta (float) – Desired change in position.

          • +
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • wait (bool, optional) – If True, wait for motion completion before returning. +

          • wait (bool, optional) – If True, wait for motion completion before returning. Defaults to False.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          @@ -481,7 +477,7 @@

          pcdsdevices.attenuator.AT1K2
          -read() OrderedDictType[str, Dict[str, Any]]
          +read() OrderedDictType[str, Dict[str, Any]]

          Read data from the device.

          This method is expected to be as instantaneous as possible, with any substantial acquisition time taken care of in @@ -504,7 +500,7 @@

          pcdsdevices.attenuator.AT1K2
          -read_configuration() OrderedDictType[str, Dict[str, Any]]
          +read_configuration() OrderedDictType[str, Dict[str, Any]]

          Dictionary mapping names to value dicts with keys: value, timestamp

          To control which fields are included, change the Component kinds on the device, or modify the configuration_attrs list.

          @@ -520,23 +516,23 @@

          pcdsdevices.attenuator.AT1K2
          -set(new_position: Any, *, timeout: float | None = None, moved_cb: Callable | None = None, wait: bool = False) StatusBase
          +set(new_position: Any, *, timeout: float | None = None, moved_cb: Callable | None = None, wait: bool = False) StatusBase

          Set a value and return a Status object

          Parameters:
            -
          • new_position (object) – The input here is whatever the device requires (this +

          • new_position (object) – The input here is whatever the device requires (this should be over-ridden by the implementation. For example a motor would take a float, a shutter the strings {‘Open’, ‘Close’}, and a goineometer (h, k, l) tuples

          • -
          • timeout (float, optional) – Maximum time to wait for the motion. If None, the default timeout +

          • timeout (float, optional) – Maximum time to wait for the motion. If None, the default timeout for this positioner is used.

          • moved_cb (callable, optional) –

            Deprecated

            Call this callback when movement has finished. This callback must accept one keyword argument: ‘obj’ which will be set to this positioner instance.

          • -
          • wait (bool, optional) –

            Deprecated

            +
          • wait (bool, optional) –

            Deprecated

            If the method should block until the Status object reports it is done.

            Defaults to False

            @@ -558,7 +554,7 @@

            pcdsdevices.attenuator.AT1K2
            -status() str
            +status() str

            Returns a str with the current pv values for the device.

          @@ -575,7 +571,7 @@

          pcdsdevices.attenuator.AT1K2
          -trigger() StatusBase
          +trigger() StatusBase

          Trigger the device and return status object.

          This method is responsible for implementing ‘trigger’ or ‘acquire’ functionality of this device.

          @@ -583,14 +579,14 @@

          pcdsdevices.attenuator.AT1K2read() method) then this method is also responsible for arranging that the -StatusBase object returned by this method +StatusBase object returned by this method is notified when the device is ready to be read.

          If there is no delay between triggering and being readable, -then this method must return a StatusBase +then this method must return a StatusBase object which is already completed.

          Returns:
          -

          status (StatusBase) – StatusBase object which will be marked +

          status (StatusBase) – StatusBase object which will be marked as complete when the device is ready to be read.

          @@ -605,7 +601,7 @@

          pcdsdevices.attenuator.AT1K2
          Parameters:
          -

          scale (float) – starting step size, default = 0.1

          +

          scale (float) – starting step size, default = 0.1

          @@ -617,12 +613,12 @@

          pcdsdevices.attenuator.AT1K2
          Parameters:
            -
          • position (float) – Desired end position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • position (float) – Desired end position.

          • +
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • -
          • newline (bool, optional) – If True, inserts a newline after the updates.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • newline (bool, optional) – If True, inserts a newline after the updates.

          @@ -635,12 +631,12 @@

          pcdsdevices.attenuator.AT1K2
          Parameters:
            -
          • delta (float) – Desired change in position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • delta (float) – Desired change in position.

          • +
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • -
          • newline (bool, optional) – If True, inserts a newline after the updates.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • newline (bool, optional) – If True, inserts a newline after the updates.

          @@ -800,7 +796,7 @@

          pcdsdevices.attenuator.AT1K2
          -subscriptions: ClassVar[FrozenSet[str]] = frozenset({'_req_done', 'acq_done', 'done_moving', 'readback', 'start_moving'})
          +subscriptions: ClassVar[FrozenSet[str]] = frozenset({'_req_done', 'acq_done', 'done_moving', 'readback', 'start_moving'})
          diff --git a/master/generated/pcdsdevices.attenuator.AT1K4.html b/master/generated/pcdsdevices.attenuator.AT1K4.html index 64aa2ff32b6..4b381ca5c3f 100644 --- a/master/generated/pcdsdevices.attenuator.AT1K4.html +++ b/master/generated/pcdsdevices.attenuator.AT1K4.html @@ -1,25 +1,23 @@ + + - pcdsdevices.attenuator.AT1K4 — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.attenuator.AT1K4 — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -
          - 8.5.1.dev30+gd6e98430 -
          @@ -114,6 +109,7 @@
        • pcdsdevices.ipm
        • pcdsdevices.jet
        • pcdsdevices.keithley
        • +
        • pcdsdevices.lakeshore
        • pcdsdevices.lamp_motion
        • pcdsdevices.lasers.btps
        • pcdsdevices.lasers.counters
        • @@ -231,9 +227,9 @@

          pcdsdevices.attenuator.AT1K4
          Parameters:
            -
          • prefix (str) – Solid Attenuator base PV.

          • -
          • name (str) – Alias for the Solid Attenuator.

          • -
          • calculator_prefix (str) – The prefix for the calculator PVs.

          • +
          • prefix (str) – Solid Attenuator base PV.

          • +
          • name (str) – Alias for the Solid Attenuator.

          • +
          • calculator_prefix (str) – The prefix for the calculator PVs.

          @@ -336,14 +332,14 @@

          pcdsdevices.attenuator.AT1K4
          -configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]
          +configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]

          Configure the device for something during a run

          This default implementation allows the user to change any of the configuration_attrs. Subclasses might override this to perform additional input validation, cleanup, etc.

          Parameters:
          -

          d (dict) – The configuration dictionary. To specify the order that +

          d (dict) – The configuration dictionary. To specify the order that the changes should be made, use an OrderedDict.

          Returns:
          @@ -358,7 +354,7 @@

          pcdsdevices.attenuator.AT1K4
          -describe() OrderedDictType[str, Dict[str, Any]]
          +describe() OrderedDictType[str, Dict[str, Any]]

          Provide schema and meta-data for read().

          This keys in the OrderedDict this method returns must match the keys in the OrderedDict return by read().

          @@ -407,7 +403,7 @@

          pcdsdevices.attenuator.AT1K4float, optional) – Maximum time to wait for the motion. If None, the default timeout +
        • timeout (float, optional) – Maximum time to wait for the motion. If None, the default timeout for this positioner is used.

        • @@ -416,9 +412,9 @@

          pcdsdevices.attenuator.AT1K4Raises:

          @@ -432,12 +428,12 @@

          pcdsdevices.attenuator.AT1K4Parameters:
          • position – Desired end position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • wait (bool, optional) – If True, wait for motion completion before returning. +

          • wait (bool, optional) – If True, wait for motion completion before returning. Defaults to False.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          @@ -459,13 +455,13 @@

          pcdsdevices.attenuator.AT1K4
          Parameters:
            -
          • delta (float) – Desired change in position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • delta (float) – Desired change in position.

          • +
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • wait (bool, optional) – If True, wait for motion completion before returning. +

          • wait (bool, optional) – If True, wait for motion completion before returning. Defaults to False.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          @@ -479,7 +475,7 @@

          pcdsdevices.attenuator.AT1K4
          -read() OrderedDictType[str, Dict[str, Any]]
          +read() OrderedDictType[str, Dict[str, Any]]

          Read data from the device.

          This method is expected to be as instantaneous as possible, with any substantial acquisition time taken care of in @@ -502,7 +498,7 @@

          pcdsdevices.attenuator.AT1K4
          -read_configuration() OrderedDictType[str, Dict[str, Any]]
          +read_configuration() OrderedDictType[str, Dict[str, Any]]

          Dictionary mapping names to value dicts with keys: value, timestamp

          To control which fields are included, change the Component kinds on the device, or modify the configuration_attrs list.

          @@ -518,23 +514,23 @@

          pcdsdevices.attenuator.AT1K4
          -set(new_position: Any, *, timeout: float | None = None, moved_cb: Callable | None = None, wait: bool = False) StatusBase
          +set(new_position: Any, *, timeout: float | None = None, moved_cb: Callable | None = None, wait: bool = False) StatusBase

          Set a value and return a Status object

          Parameters:
            -
          • new_position (object) – The input here is whatever the device requires (this +

          • new_position (object) – The input here is whatever the device requires (this should be over-ridden by the implementation. For example a motor would take a float, a shutter the strings {‘Open’, ‘Close’}, and a goineometer (h, k, l) tuples

          • -
          • timeout (float, optional) – Maximum time to wait for the motion. If None, the default timeout +

          • timeout (float, optional) – Maximum time to wait for the motion. If None, the default timeout for this positioner is used.

          • moved_cb (callable, optional) –

            Deprecated

            Call this callback when movement has finished. This callback must accept one keyword argument: ‘obj’ which will be set to this positioner instance.

          • -
          • wait (bool, optional) –

            Deprecated

            +
          • wait (bool, optional) –

            Deprecated

            If the method should block until the Status object reports it is done.

            Defaults to False

            @@ -556,7 +552,7 @@

            pcdsdevices.attenuator.AT1K4
            -status() str
            +status() str

            Returns a str with the current pv values for the device.

          @@ -573,7 +569,7 @@

          pcdsdevices.attenuator.AT1K4
          -trigger() StatusBase
          +trigger() StatusBase

          Trigger the device and return status object.

          This method is responsible for implementing ‘trigger’ or ‘acquire’ functionality of this device.

          @@ -581,14 +577,14 @@

          pcdsdevices.attenuator.AT1K4read() method) then this method is also responsible for arranging that the -StatusBase object returned by this method +StatusBase object returned by this method is notified when the device is ready to be read.

          If there is no delay between triggering and being readable, -then this method must return a StatusBase +then this method must return a StatusBase object which is already completed.

          Returns:
          -

          status (StatusBase) – StatusBase object which will be marked +

          status (StatusBase) – StatusBase object which will be marked as complete when the device is ready to be read.

          @@ -603,7 +599,7 @@

          pcdsdevices.attenuator.AT1K4
          Parameters:
          -

          scale (float) – starting step size, default = 0.1

          +

          scale (float) – starting step size, default = 0.1

          @@ -615,12 +611,12 @@

          pcdsdevices.attenuator.AT1K4
          Parameters:
            -
          • position (float) – Desired end position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • position (float) – Desired end position.

          • +
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • -
          • newline (bool, optional) – If True, inserts a newline after the updates.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • newline (bool, optional) – If True, inserts a newline after the updates.

          @@ -633,12 +629,12 @@

          pcdsdevices.attenuator.AT1K4
          Parameters:
            -
          • delta (float) – Desired change in position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • delta (float) – Desired change in position.

          • +
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • -
          • newline (bool, optional) – If True, inserts a newline after the updates.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • newline (bool, optional) – If True, inserts a newline after the updates.

          @@ -803,7 +799,7 @@

          pcdsdevices.attenuator.AT1K4
          -subscriptions: ClassVar[FrozenSet[str]] = frozenset({'_req_done', 'acq_done', 'done_moving', 'readback', 'start_moving'})
          +subscriptions: ClassVar[FrozenSet[str]] = frozenset({'_req_done', 'acq_done', 'done_moving', 'readback', 'start_moving'})
          diff --git a/master/generated/pcdsdevices.attenuator.AT2K2.html b/master/generated/pcdsdevices.attenuator.AT2K2.html index 24f9f1db7cb..0076c960a43 100644 --- a/master/generated/pcdsdevices.attenuator.AT2K2.html +++ b/master/generated/pcdsdevices.attenuator.AT2K2.html @@ -1,25 +1,23 @@ + + - pcdsdevices.attenuator.AT2K2 — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.attenuator.AT2K2 — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -
          - 8.5.1.dev30+gd6e98430 -
          @@ -114,6 +109,7 @@
        • pcdsdevices.ipm
        • pcdsdevices.jet
        • pcdsdevices.keithley
        • +
        • pcdsdevices.lakeshore
        • pcdsdevices.lamp_motion
        • pcdsdevices.lasers.btps
        • pcdsdevices.lasers.counters
        • @@ -231,9 +227,9 @@

          pcdsdevices.attenuator.AT2K2
          Parameters:
            -
          • prefix (str) – Solid Attenuator base PV.

          • -
          • name (str) – Alias for the Solid Attenuator.

          • -
          • calculator_prefix (str) – The prefix for the calculator PVs.

          • +
          • prefix (str) – Solid Attenuator base PV.

          • +
          • name (str) – Alias for the Solid Attenuator.

          • +
          • calculator_prefix (str) – The prefix for the calculator PVs.

          @@ -343,14 +339,14 @@

          pcdsdevices.attenuator.AT2K2
          -configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]
          +configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]

          Configure the device for something during a run

          This default implementation allows the user to change any of the configuration_attrs. Subclasses might override this to perform additional input validation, cleanup, etc.

          Parameters:
          -

          d (dict) – The configuration dictionary. To specify the order that +

          d (dict) – The configuration dictionary. To specify the order that the changes should be made, use an OrderedDict.

          Returns:
          @@ -365,7 +361,7 @@

          pcdsdevices.attenuator.AT2K2
          -describe() OrderedDictType[str, Dict[str, Any]]
          +describe() OrderedDictType[str, Dict[str, Any]]

          Provide schema and meta-data for read().

          This keys in the OrderedDict this method returns must match the keys in the OrderedDict return by read().

          @@ -414,7 +410,7 @@

          pcdsdevices.attenuator.AT2K2float, optional) – Maximum time to wait for the motion. If None, the default timeout +
        • timeout (float, optional) – Maximum time to wait for the motion. If None, the default timeout for this positioner is used.

        • @@ -423,9 +419,9 @@

          pcdsdevices.attenuator.AT2K2Raises:

          @@ -439,12 +435,12 @@

          pcdsdevices.attenuator.AT2K2Parameters:
          • position – Desired end position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • wait (bool, optional) – If True, wait for motion completion before returning. +

          • wait (bool, optional) – If True, wait for motion completion before returning. Defaults to False.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          @@ -466,13 +462,13 @@

          pcdsdevices.attenuator.AT2K2
          Parameters:
            -
          • delta (float) – Desired change in position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • delta (float) – Desired change in position.

          • +
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • wait (bool, optional) – If True, wait for motion completion before returning. +

          • wait (bool, optional) – If True, wait for motion completion before returning. Defaults to False.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          @@ -486,7 +482,7 @@

          pcdsdevices.attenuator.AT2K2
          -read() OrderedDictType[str, Dict[str, Any]]
          +read() OrderedDictType[str, Dict[str, Any]]

          Read data from the device.

          This method is expected to be as instantaneous as possible, with any substantial acquisition time taken care of in @@ -509,7 +505,7 @@

          pcdsdevices.attenuator.AT2K2
          -read_configuration() OrderedDictType[str, Dict[str, Any]]
          +read_configuration() OrderedDictType[str, Dict[str, Any]]

          Dictionary mapping names to value dicts with keys: value, timestamp

          To control which fields are included, change the Component kinds on the device, or modify the configuration_attrs list.

          @@ -525,23 +521,23 @@

          pcdsdevices.attenuator.AT2K2
          -set(new_position: Any, *, timeout: float | None = None, moved_cb: Callable | None = None, wait: bool = False) StatusBase
          +set(new_position: Any, *, timeout: float | None = None, moved_cb: Callable | None = None, wait: bool = False) StatusBase

          Set a value and return a Status object

          Parameters:
            -
          • new_position (object) – The input here is whatever the device requires (this +

          • new_position (object) – The input here is whatever the device requires (this should be over-ridden by the implementation. For example a motor would take a float, a shutter the strings {‘Open’, ‘Close’}, and a goineometer (h, k, l) tuples

          • -
          • timeout (float, optional) – Maximum time to wait for the motion. If None, the default timeout +

          • timeout (float, optional) – Maximum time to wait for the motion. If None, the default timeout for this positioner is used.

          • moved_cb (callable, optional) –

            Deprecated

            Call this callback when movement has finished. This callback must accept one keyword argument: ‘obj’ which will be set to this positioner instance.

          • -
          • wait (bool, optional) –

            Deprecated

            +
          • wait (bool, optional) –

            Deprecated

            If the method should block until the Status object reports it is done.

            Defaults to False

            @@ -563,7 +559,7 @@

            pcdsdevices.attenuator.AT2K2
            -status() str
            +status() str

            Returns a str with the current pv values for the device.

          @@ -580,7 +576,7 @@

          pcdsdevices.attenuator.AT2K2
          -trigger() StatusBase
          +trigger() StatusBase

          Trigger the device and return status object.

          This method is responsible for implementing ‘trigger’ or ‘acquire’ functionality of this device.

          @@ -588,14 +584,14 @@

          pcdsdevices.attenuator.AT2K2read() method) then this method is also responsible for arranging that the -StatusBase object returned by this method +StatusBase object returned by this method is notified when the device is ready to be read.

          If there is no delay between triggering and being readable, -then this method must return a StatusBase +then this method must return a StatusBase object which is already completed.

          Returns:
          -

          status (StatusBase) – StatusBase object which will be marked +

          status (StatusBase) – StatusBase object which will be marked as complete when the device is ready to be read.

          @@ -610,7 +606,7 @@

          pcdsdevices.attenuator.AT2K2
          Parameters:
          -

          scale (float) – starting step size, default = 0.1

          +

          scale (float) – starting step size, default = 0.1

          @@ -622,12 +618,12 @@

          pcdsdevices.attenuator.AT2K2
          Parameters:
            -
          • position (float) – Desired end position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • position (float) – Desired end position.

          • +
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • -
          • newline (bool, optional) – If True, inserts a newline after the updates.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • newline (bool, optional) – If True, inserts a newline after the updates.

          @@ -640,12 +636,12 @@

          pcdsdevices.attenuator.AT2K2
          Parameters:
            -
          • delta (float) – Desired change in position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • delta (float) – Desired change in position.

          • +
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • -
          • newline (bool, optional) – If True, inserts a newline after the updates.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • newline (bool, optional) – If True, inserts a newline after the updates.

          @@ -805,7 +801,7 @@

          pcdsdevices.attenuator.AT2K2
          -subscriptions: ClassVar[FrozenSet[str]] = frozenset({'_req_done', 'acq_done', 'done_moving', 'readback', 'start_moving'})
          +subscriptions: ClassVar[FrozenSet[str]] = frozenset({'_req_done', 'acq_done', 'done_moving', 'readback', 'start_moving'})
          diff --git a/master/generated/pcdsdevices.attenuator.AT2L0.html b/master/generated/pcdsdevices.attenuator.AT2L0.html index 573982d2647..ec2cc1578c0 100644 --- a/master/generated/pcdsdevices.attenuator.AT2L0.html +++ b/master/generated/pcdsdevices.attenuator.AT2L0.html @@ -1,25 +1,23 @@ + + - pcdsdevices.attenuator.AT2L0 — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.attenuator.AT2L0 — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -
          - 8.5.1.dev30+gd6e98430 -
          @@ -114,6 +109,7 @@
        • pcdsdevices.ipm
        • pcdsdevices.jet
        • pcdsdevices.keithley
        • +
        • pcdsdevices.lakeshore
        • pcdsdevices.lamp_motion
        • pcdsdevices.lasers.btps
        • pcdsdevices.lasers.counters
        • @@ -231,8 +227,8 @@

          pcdsdevices.attenuator.AT2L0
          Parameters:
            -
          • prefix (str) – Solid Attenuator base PV.

          • -
          • name (str) – Alias for the Solid Attenuator.

          • +
          • prefix (str) – Solid Attenuator base PV.

          • +
          • name (str) – Alias for the Solid Attenuator.

          @@ -467,14 +463,14 @@

          pcdsdevices.attenuator.AT2L0
          -configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]
          +configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]

          Configure the device for something during a run

          This default implementation allows the user to change any of the configuration_attrs. Subclasses might override this to perform additional input validation, cleanup, etc.

          Parameters:
          -

          d (dict) – The configuration dictionary. To specify the order that +

          d (dict) – The configuration dictionary. To specify the order that the changes should be made, use an OrderedDict.

          Returns:
          @@ -489,7 +485,7 @@

          pcdsdevices.attenuator.AT2L0
          -describe() OrderedDictType[str, Dict[str, Any]]
          +describe() OrderedDictType[str, Dict[str, Any]]

          Provide schema and meta-data for read().

          This keys in the OrderedDict this method returns must match the keys in the OrderedDict return by read().

          @@ -520,7 +516,7 @@

          pcdsdevices.attenuator.AT2L0
          -get_lightpath_state(use_cache: bool = True) LightpathState
          +get_lightpath_state(use_cache: bool = True) LightpathState

          Grab slightly different PV values for use in same inout calc fn The state is nested one device deeper than LightpathInOutCptMixin expects.

          @@ -538,7 +534,7 @@

          pcdsdevices.attenuator.AT2L0float, optional) – Maximum time to wait for the motion. If None, the default timeout +
        • timeout (float, optional) – Maximum time to wait for the motion. If None, the default timeout for this positioner is used.

        • @@ -547,9 +543,9 @@

          pcdsdevices.attenuator.AT2L0Raises:

          @@ -563,12 +559,12 @@

          pcdsdevices.attenuator.AT2L0Parameters:
          • position – Desired end position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • wait (bool, optional) – If True, wait for motion completion before returning. +

          • wait (bool, optional) – If True, wait for motion completion before returning. Defaults to False.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          @@ -590,13 +586,13 @@

          pcdsdevices.attenuator.AT2L0
          Parameters:
            -
          • delta (float) – Desired change in position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • delta (float) – Desired change in position.

          • +
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • wait (bool, optional) – If True, wait for motion completion before returning. +

          • wait (bool, optional) – If True, wait for motion completion before returning. Defaults to False.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          @@ -616,7 +612,7 @@

          pcdsdevices.attenuator.AT2L0
          -read() OrderedDictType[str, Dict[str, Any]]
          +read() OrderedDictType[str, Dict[str, Any]]

          Read data from the device.

          This method is expected to be as instantaneous as possible, with any substantial acquisition time taken care of in @@ -639,7 +635,7 @@

          pcdsdevices.attenuator.AT2L0
          -read_configuration() OrderedDictType[str, Dict[str, Any]]
          +read_configuration() OrderedDictType[str, Dict[str, Any]]

          Dictionary mapping names to value dicts with keys: value, timestamp

          To control which fields are included, change the Component kinds on the device, or modify the configuration_attrs list.

          @@ -655,23 +651,23 @@

          pcdsdevices.attenuator.AT2L0
          -set(new_position: Any, *, timeout: float | None = None, moved_cb: Callable | None = None, wait: bool = False) StatusBase
          +set(new_position: Any, *, timeout: float | None = None, moved_cb: Callable | None = None, wait: bool = False) StatusBase

          Set a value and return a Status object

          Parameters:
            -
          • new_position (object) – The input here is whatever the device requires (this +

          • new_position (object) – The input here is whatever the device requires (this should be over-ridden by the implementation. For example a motor would take a float, a shutter the strings {‘Open’, ‘Close’}, and a goineometer (h, k, l) tuples

          • -
          • timeout (float, optional) – Maximum time to wait for the motion. If None, the default timeout +

          • timeout (float, optional) – Maximum time to wait for the motion. If None, the default timeout for this positioner is used.

          • moved_cb (callable, optional) –

            Deprecated

            Call this callback when movement has finished. This callback must accept one keyword argument: ‘obj’ which will be set to this positioner instance.

          • -
          • wait (bool, optional) –

            Deprecated

            +
          • wait (bool, optional) –

            Deprecated

            If the method should block until the Status object reports it is done.

            Defaults to False

            @@ -693,7 +689,7 @@

            pcdsdevices.attenuator.AT2L0
            -status() str
            +status() str

            Returns a str with the current pv values for the device.

          @@ -710,7 +706,7 @@

          pcdsdevices.attenuator.AT2L0
          -trigger() StatusBase
          +trigger() StatusBase

          Trigger the device and return status object.

          This method is responsible for implementing ‘trigger’ or ‘acquire’ functionality of this device.

          @@ -718,14 +714,14 @@

          pcdsdevices.attenuator.AT2L0read() method) then this method is also responsible for arranging that the -StatusBase object returned by this method +StatusBase object returned by this method is notified when the device is ready to be read.

          If there is no delay between triggering and being readable, -then this method must return a StatusBase +then this method must return a StatusBase object which is already completed.

          Returns:
          -

          status (StatusBase) – StatusBase object which will be marked +

          status (StatusBase) – StatusBase object which will be marked as complete when the device is ready to be read.

          @@ -740,7 +736,7 @@

          pcdsdevices.attenuator.AT2L0
          Parameters:
          -

          scale (float) – starting step size, default = 0.1

          +

          scale (float) – starting step size, default = 0.1

          @@ -752,12 +748,12 @@

          pcdsdevices.attenuator.AT2L0
          Parameters:
            -
          • position (float) – Desired end position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • position (float) – Desired end position.

          • +
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • -
          • newline (bool, optional) – If True, inserts a newline after the updates.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • newline (bool, optional) – If True, inserts a newline after the updates.

          @@ -770,12 +766,12 @@

          pcdsdevices.attenuator.AT2L0
          Parameters:
            -
          • delta (float) – Desired change in position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • delta (float) – Desired change in position.

          • +
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • -
          • newline (bool, optional) – If True, inserts a newline after the updates.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • newline (bool, optional) – If True, inserts a newline after the updates.

          @@ -935,7 +931,7 @@

          pcdsdevices.attenuator.AT2L0
          -subscriptions: ClassVar[FrozenSet[str]] = frozenset({'_req_done', 'acq_done', 'done_moving', 'readback', 'start_moving'})
          +subscriptions: ClassVar[FrozenSet[str]] = frozenset({'_req_done', 'acq_done', 'done_moving', 'readback', 'start_moving'})
          diff --git a/master/generated/pcdsdevices.attenuator.AttBase.html b/master/generated/pcdsdevices.attenuator.AttBase.html index 7e9c4546de9..704ca049e13 100644 --- a/master/generated/pcdsdevices.attenuator.AttBase.html +++ b/master/generated/pcdsdevices.attenuator.AttBase.html @@ -1,25 +1,23 @@ + + - pcdsdevices.attenuator.AttBase — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.attenuator.AttBase — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -
          - 8.5.1.dev30+gd6e98430 -
          @@ -114,6 +109,7 @@
        • pcdsdevices.ipm
        • pcdsdevices.jet
        • pcdsdevices.keithley
        • +
        • pcdsdevices.lakeshore
        • pcdsdevices.lamp_motion
        • pcdsdevices.lasers.btps
        • pcdsdevices.lasers.counters
        • @@ -328,14 +324,14 @@

          pcdsdevices.attenuator.AttBase
          -configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]
          +configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]

          Configure the device for something during a run

          This default implementation allows the user to change any of the configuration_attrs. Subclasses might override this to perform additional input validation, cleanup, etc.

          Parameters:
          -

          d (dict) – The configuration dictionary. To specify the order that +

          d (dict) – The configuration dictionary. To specify the order that the changes should be made, use an OrderedDict.

          Returns:
          @@ -350,7 +346,7 @@

          pcdsdevices.attenuator.AttBase
          -describe() OrderedDictType[str, Dict[str, Any]]
          +describe() OrderedDictType[str, Dict[str, Any]]

          Provide schema and meta-data for read().

          This keys in the OrderedDict this method returns must match the keys in the OrderedDict return by read().

          @@ -394,11 +390,11 @@

          pcdsdevices.attenuator.AttBase
          Parameters:
            -
          • position (float) – Position to move to

          • +
          • position (float) – Position to move to

          • moved_cb (callable) – Call this callback when movement has finished. This callback must accept one keyword argument: ‘obj’ which will be set to this positioner instance.

          • -
          • timeout (float, optional) – Maximum time to wait for the motion. If None, the default timeout +

          • timeout (float, optional) – Maximum time to wait for the motion. If None, the default timeout for this positioner is used.

          @@ -407,9 +403,9 @@

          pcdsdevices.attenuator.AttBaseRaises:
            -
          • TimeoutError – When motion takes longer than timeout

          • -
          • ValueError – On invalid positions

          • -
          • RuntimeError – If motion fails other than timing out, including when a move is +

          • TimeoutError – When motion takes longer than timeout

          • +
          • ValueError – On invalid positions

          • +
          • RuntimeError – If motion fails other than timing out, including when a move is attempted while another move is already in progress.

          @@ -424,12 +420,12 @@

          pcdsdevices.attenuator.AttBaseParameters:
          • position – Desired end position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • wait (bool, optional) – If True, wait for motion completion before returning. +

          • wait (bool, optional) – If True, wait for motion completion before returning. Defaults to False.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          @@ -451,13 +447,13 @@

          pcdsdevices.attenuator.AttBase
          Parameters:
            -
          • delta (float) – Desired change in position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • delta (float) – Desired change in position.

          • +
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • wait (bool, optional) – If True, wait for motion completion before returning. +

          • wait (bool, optional) – If True, wait for motion completion before returning. Defaults to False.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          @@ -471,7 +467,7 @@

          pcdsdevices.attenuator.AttBase
          -read() OrderedDictType[str, Dict[str, Any]]
          +read() OrderedDictType[str, Dict[str, Any]]

          Read data from the device.

          This method is expected to be as instantaneous as possible, with any substantial acquisition time taken care of in @@ -494,7 +490,7 @@

          pcdsdevices.attenuator.AttBase
          -read_configuration() OrderedDictType[str, Dict[str, Any]]
          +read_configuration() OrderedDictType[str, Dict[str, Any]]

          Dictionary mapping names to value dicts with keys: value, timestamp

          To control which fields are included, change the Component kinds on the device, or modify the configuration_attrs list.

          @@ -516,23 +512,23 @@

          pcdsdevices.attenuator.AttBase
          -set(new_position: Any, *, timeout: float | None = None, moved_cb: Callable | None = None, wait: bool = False) StatusBase
          +set(new_position: Any, *, timeout: float | None = None, moved_cb: Callable | None = None, wait: bool = False) StatusBase

          Set a value and return a Status object

          Parameters:
            -
          • new_position (object) – The input here is whatever the device requires (this +

          • new_position (object) – The input here is whatever the device requires (this should be over-ridden by the implementation. For example a motor would take a float, a shutter the strings {‘Open’, ‘Close’}, and a goineometer (h, k, l) tuples

          • -
          • timeout (float, optional) – Maximum time to wait for the motion. If None, the default timeout +

          • timeout (float, optional) – Maximum time to wait for the motion. If None, the default timeout for this positioner is used.

          • moved_cb (callable, optional) –

            Deprecated

            Call this callback when movement has finished. This callback must accept one keyword argument: ‘obj’ which will be set to this positioner instance.

          • -
          • wait (bool, optional) –

            Deprecated

            +
          • wait (bool, optional) –

            Deprecated

            If the method should block until the Status object reports it is done.

            Defaults to False

            @@ -567,7 +563,7 @@

            pcdsdevices.attenuator.AttBase
            -status() str
            +status() str

            Returns a str with the current pv values for the device.

          @@ -584,7 +580,7 @@

          pcdsdevices.attenuator.AttBase
          -trigger() StatusBase
          +trigger() StatusBase

          Trigger the device and return status object.

          This method is responsible for implementing ‘trigger’ or ‘acquire’ functionality of this device.

          @@ -592,14 +588,14 @@

          pcdsdevices.attenuator.AttBaseread() method) then this method is also responsible for arranging that the -StatusBase object returned by this method +StatusBase object returned by this method is notified when the device is ready to be read.

          If there is no delay between triggering and being readable, -then this method must return a StatusBase +then this method must return a StatusBase object which is already completed.

          Returns:
          -

          status (StatusBase) – StatusBase object which will be marked +

          status (StatusBase) – StatusBase object which will be marked as complete when the device is ready to be read.

          @@ -614,7 +610,7 @@

          pcdsdevices.attenuator.AttBase
          Parameters:
          -

          scale (float) – starting step size, default = 0.1

          +

          scale (float) – starting step size, default = 0.1

          @@ -626,12 +622,12 @@

          pcdsdevices.attenuator.AttBase
          Parameters:
            -
          • position (float) – Desired end position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • position (float) – Desired end position.

          • +
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • -
          • newline (bool, optional) – If True, inserts a newline after the updates.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • newline (bool, optional) – If True, inserts a newline after the updates.

          @@ -644,12 +640,12 @@

          pcdsdevices.attenuator.AttBase
          Parameters:
            -
          • delta (float) – Desired change in position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • delta (float) – Desired change in position.

          • +
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • -
          • newline (bool, optional) – If True, inserts a newline after the updates.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • newline (bool, optional) – If True, inserts a newline after the updates.

          @@ -780,7 +776,7 @@

          pcdsdevices.attenuator.AttBase
          -subscriptions: ClassVar[FrozenSet[str]] = frozenset({'_req_done', 'acq_done', 'done_moving', 'readback', 'start_moving', 'state'})
          +subscriptions: ClassVar[FrozenSet[str]] = frozenset({'_req_done', 'acq_done', 'done_moving', 'readback', 'start_moving', 'state'})
          diff --git a/master/generated/pcdsdevices.attenuator.AttBaseWith3rdHarmonic.html b/master/generated/pcdsdevices.attenuator.AttBaseWith3rdHarmonic.html index 58989293d4a..8a1135cd7ca 100644 --- a/master/generated/pcdsdevices.attenuator.AttBaseWith3rdHarmonic.html +++ b/master/generated/pcdsdevices.attenuator.AttBaseWith3rdHarmonic.html @@ -1,25 +1,23 @@ + + - pcdsdevices.attenuator.AttBaseWith3rdHarmonic — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.attenuator.AttBaseWith3rdHarmonic — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -
          - 8.5.1.dev30+gd6e98430 -
          @@ -114,6 +109,7 @@
        • pcdsdevices.ipm
        • pcdsdevices.jet
        • pcdsdevices.keithley
        • +
        • pcdsdevices.lakeshore
        • pcdsdevices.lamp_motion
        • pcdsdevices.lasers.btps
        • pcdsdevices.lasers.counters
        • @@ -368,14 +364,14 @@

          pcdsdevices.attenuator.AttBaseWith3rdHarmonic
          -configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]
          +configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]

          Configure the device for something during a run

          This default implementation allows the user to change any of the configuration_attrs. Subclasses might override this to perform additional input validation, cleanup, etc.

          Parameters:
          -

          d (dict) – The configuration dictionary. To specify the order that +

          d (dict) – The configuration dictionary. To specify the order that the changes should be made, use an OrderedDict.

          Returns:
          @@ -390,7 +386,7 @@

          pcdsdevices.attenuator.AttBaseWith3rdHarmonic
          -describe() OrderedDictType[str, Dict[str, Any]]
          +describe() OrderedDictType[str, Dict[str, Any]]

          Provide schema and meta-data for read().

          This keys in the OrderedDict this method returns must match the keys in the OrderedDict return by read().

          @@ -434,11 +430,11 @@

          pcdsdevices.attenuator.AttBaseWith3rdHarmonic
          Parameters:
            -
          • position (float) – Position to move to

          • +
          • position (float) – Position to move to

          • moved_cb (callable) – Call this callback when movement has finished. This callback must accept one keyword argument: ‘obj’ which will be set to this positioner instance.

          • -
          • timeout (float, optional) – Maximum time to wait for the motion. If None, the default timeout +

          • timeout (float, optional) – Maximum time to wait for the motion. If None, the default timeout for this positioner is used.

          @@ -447,9 +443,9 @@

          pcdsdevices.attenuator.AttBaseWith3rdHarmonicRaises:
            -
          • TimeoutError – When motion takes longer than timeout

          • -
          • ValueError – On invalid positions

          • -
          • RuntimeError – If motion fails other than timing out, including when a move is +

          • TimeoutError – When motion takes longer than timeout

          • +
          • ValueError – On invalid positions

          • +
          • RuntimeError – If motion fails other than timing out, including when a move is attempted while another move is already in progress.

          @@ -464,12 +460,12 @@

          pcdsdevices.attenuator.AttBaseWith3rdHarmonicParameters:
          • position – Desired end position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • wait (bool, optional) – If True, wait for motion completion before returning. +

          • wait (bool, optional) – If True, wait for motion completion before returning. Defaults to False.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          @@ -491,13 +487,13 @@

          pcdsdevices.attenuator.AttBaseWith3rdHarmonic
          Parameters:
            -
          • delta (float) – Desired change in position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • delta (float) – Desired change in position.

          • +
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • wait (bool, optional) – If True, wait for motion completion before returning. +

          • wait (bool, optional) – If True, wait for motion completion before returning. Defaults to False.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          @@ -511,7 +507,7 @@

          pcdsdevices.attenuator.AttBaseWith3rdHarmonic
          -read() OrderedDictType[str, Dict[str, Any]]
          +read() OrderedDictType[str, Dict[str, Any]]

          Read data from the device.

          This method is expected to be as instantaneous as possible, with any substantial acquisition time taken care of in @@ -534,7 +530,7 @@

          pcdsdevices.attenuator.AttBaseWith3rdHarmonic
          -read_configuration() OrderedDictType[str, Dict[str, Any]]
          +read_configuration() OrderedDictType[str, Dict[str, Any]]

          Dictionary mapping names to value dicts with keys: value, timestamp

          To control which fields are included, change the Component kinds on the device, or modify the configuration_attrs list.

          @@ -556,23 +552,23 @@

          pcdsdevices.attenuator.AttBaseWith3rdHarmonic
          -set(new_position: Any, *, timeout: float | None = None, moved_cb: Callable | None = None, wait: bool = False) StatusBase
          +set(new_position: Any, *, timeout: float | None = None, moved_cb: Callable | None = None, wait: bool = False) StatusBase

          Set a value and return a Status object

          Parameters:
            -
          • new_position (object) – The input here is whatever the device requires (this +

          • new_position (object) – The input here is whatever the device requires (this should be over-ridden by the implementation. For example a motor would take a float, a shutter the strings {‘Open’, ‘Close’}, and a goineometer (h, k, l) tuples

          • -
          • timeout (float, optional) – Maximum time to wait for the motion. If None, the default timeout +

          • timeout (float, optional) – Maximum time to wait for the motion. If None, the default timeout for this positioner is used.

          • moved_cb (callable, optional) –

            Deprecated

            Call this callback when movement has finished. This callback must accept one keyword argument: ‘obj’ which will be set to this positioner instance.

          • -
          • wait (bool, optional) –

            Deprecated

            +
          • wait (bool, optional) –

            Deprecated

            If the method should block until the Status object reports it is done.

            Defaults to False

            @@ -607,7 +603,7 @@

            pcdsdevices.attenuator.AttBaseWith3rdHarmonic
            -status() str
            +status() str

            Returns a str with the current pv values for the device.

          @@ -624,7 +620,7 @@

          pcdsdevices.attenuator.AttBaseWith3rdHarmonic
          -trigger() StatusBase
          +trigger() StatusBase

          Trigger the device and return status object.

          This method is responsible for implementing ‘trigger’ or ‘acquire’ functionality of this device.

          @@ -632,14 +628,14 @@

          pcdsdevices.attenuator.AttBaseWith3rdHarmonicread() method) then this method is also responsible for arranging that the -StatusBase object returned by this method +StatusBase object returned by this method is notified when the device is ready to be read.

          If there is no delay between triggering and being readable, -then this method must return a StatusBase +then this method must return a StatusBase object which is already completed.

          Returns:
          -

          status (StatusBase) – StatusBase object which will be marked +

          status (StatusBase) – StatusBase object which will be marked as complete when the device is ready to be read.

          @@ -654,7 +650,7 @@

          pcdsdevices.attenuator.AttBaseWith3rdHarmonic
          Parameters:
          -

          scale (float) – starting step size, default = 0.1

          +

          scale (float) – starting step size, default = 0.1

          @@ -666,12 +662,12 @@

          pcdsdevices.attenuator.AttBaseWith3rdHarmonic
          Parameters:
            -
          • position (float) – Desired end position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • position (float) – Desired end position.

          • +
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • -
          • newline (bool, optional) – If True, inserts a newline after the updates.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • newline (bool, optional) – If True, inserts a newline after the updates.

          @@ -684,12 +680,12 @@

          pcdsdevices.attenuator.AttBaseWith3rdHarmonic
          Parameters:
            -
          • delta (float) – Desired change in position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • delta (float) – Desired change in position.

          • +
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • -
          • newline (bool, optional) – If True, inserts a newline after the updates.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • newline (bool, optional) – If True, inserts a newline after the updates.

          @@ -820,7 +816,7 @@

          pcdsdevices.attenuator.AttBaseWith3rdHarmonic
          -subscriptions: ClassVar[FrozenSet[str]] = frozenset({'_req_done', 'acq_done', 'done_moving', 'readback', 'start_moving', 'state'})
          +subscriptions: ClassVar[FrozenSet[str]] = frozenset({'_req_done', 'acq_done', 'done_moving', 'readback', 'start_moving', 'state'})
          diff --git a/master/generated/pcdsdevices.attenuator.AttBaseWith3rdHarmonicLP.html b/master/generated/pcdsdevices.attenuator.AttBaseWith3rdHarmonicLP.html index 1207bfa0727..a9cd214be8c 100644 --- a/master/generated/pcdsdevices.attenuator.AttBaseWith3rdHarmonicLP.html +++ b/master/generated/pcdsdevices.attenuator.AttBaseWith3rdHarmonicLP.html @@ -1,25 +1,23 @@ + + - pcdsdevices.attenuator.AttBaseWith3rdHarmonicLP — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.attenuator.AttBaseWith3rdHarmonicLP — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -
          - 8.5.1.dev30+gd6e98430 -
          @@ -114,6 +109,7 @@
        • pcdsdevices.ipm
        • pcdsdevices.jet
        • pcdsdevices.keithley
        • +
        • pcdsdevices.lakeshore
        • pcdsdevices.lamp_motion
        • pcdsdevices.lasers.btps
        • pcdsdevices.lasers.counters
        • @@ -390,14 +386,14 @@

          pcdsdevices.attenuator.AttBaseWith3rdHarmonicLP
          -configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]
          +configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]

          Configure the device for something during a run

          This default implementation allows the user to change any of the configuration_attrs. Subclasses might override this to perform additional input validation, cleanup, etc.

          Parameters:
          -

          d (dict) – The configuration dictionary. To specify the order that +

          d (dict) – The configuration dictionary. To specify the order that the changes should be made, use an OrderedDict.

          Returns:
          @@ -412,7 +408,7 @@

          pcdsdevices.attenuator.AttBaseWith3rdHarmonicLP
          -describe() OrderedDictType[str, Dict[str, Any]]
          +describe() OrderedDictType[str, Dict[str, Any]]

          Provide schema and meta-data for read().

          This keys in the OrderedDict this method returns must match the keys in the OrderedDict return by read().

          @@ -443,7 +439,7 @@

          pcdsdevices.attenuator.AttBaseWith3rdHarmonicLP
          -get_lightpath_state(use_cache: bool = True) LightpathState
          +get_lightpath_state(use_cache: bool = True) LightpathState

          Return the current LightpathState

          Returns:
          @@ -467,11 +463,11 @@

          pcdsdevices.attenuator.AttBaseWith3rdHarmonicLP
          Parameters:
            -
          • position (float) – Position to move to

          • +
          • position (float) – Position to move to

          • moved_cb (callable) – Call this callback when movement has finished. This callback must accept one keyword argument: ‘obj’ which will be set to this positioner instance.

          • -
          • timeout (float, optional) – Maximum time to wait for the motion. If None, the default timeout +

          • timeout (float, optional) – Maximum time to wait for the motion. If None, the default timeout for this positioner is used.

          @@ -480,9 +476,9 @@

          pcdsdevices.attenuator.AttBaseWith3rdHarmonicLPRaises:
            -
          • TimeoutError – When motion takes longer than timeout

          • -
          • ValueError – On invalid positions

          • -
          • RuntimeError – If motion fails other than timing out, including when a move is +

          • TimeoutError – When motion takes longer than timeout

          • +
          • ValueError – On invalid positions

          • +
          • RuntimeError – If motion fails other than timing out, including when a move is attempted while another move is already in progress.

          @@ -497,12 +493,12 @@

          pcdsdevices.attenuator.AttBaseWith3rdHarmonicLPParameters:
          • position – Desired end position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • wait (bool, optional) – If True, wait for motion completion before returning. +

          • wait (bool, optional) – If True, wait for motion completion before returning. Defaults to False.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          @@ -524,13 +520,13 @@

          pcdsdevices.attenuator.AttBaseWith3rdHarmonicLP
          Parameters:
            -
          • delta (float) – Desired change in position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • delta (float) – Desired change in position.

          • +
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • wait (bool, optional) – If True, wait for motion completion before returning. +

          • wait (bool, optional) – If True, wait for motion completion before returning. Defaults to False.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          @@ -544,7 +540,7 @@

          pcdsdevices.attenuator.AttBaseWith3rdHarmonicLP
          -read() OrderedDictType[str, Dict[str, Any]]
          +read() OrderedDictType[str, Dict[str, Any]]

          Read data from the device.

          This method is expected to be as instantaneous as possible, with any substantial acquisition time taken care of in @@ -567,7 +563,7 @@

          pcdsdevices.attenuator.AttBaseWith3rdHarmonicLP
          -read_configuration() OrderedDictType[str, Dict[str, Any]]
          +read_configuration() OrderedDictType[str, Dict[str, Any]]

          Dictionary mapping names to value dicts with keys: value, timestamp

          To control which fields are included, change the Component kinds on the device, or modify the configuration_attrs list.

          @@ -589,23 +585,23 @@

          pcdsdevices.attenuator.AttBaseWith3rdHarmonicLP
          -set(new_position: Any, *, timeout: float | None = None, moved_cb: Callable | None = None, wait: bool = False) StatusBase
          +set(new_position: Any, *, timeout: float | None = None, moved_cb: Callable | None = None, wait: bool = False) StatusBase

          Set a value and return a Status object

          Parameters:
            -
          • new_position (object) – The input here is whatever the device requires (this +

          • new_position (object) – The input here is whatever the device requires (this should be over-ridden by the implementation. For example a motor would take a float, a shutter the strings {‘Open’, ‘Close’}, and a goineometer (h, k, l) tuples

          • -
          • timeout (float, optional) – Maximum time to wait for the motion. If None, the default timeout +

          • timeout (float, optional) – Maximum time to wait for the motion. If None, the default timeout for this positioner is used.

          • moved_cb (callable, optional) –

            Deprecated

            Call this callback when movement has finished. This callback must accept one keyword argument: ‘obj’ which will be set to this positioner instance.

          • -
          • wait (bool, optional) –

            Deprecated

            +
          • wait (bool, optional) –

            Deprecated

            If the method should block until the Status object reports it is done.

            Defaults to False

            @@ -640,7 +636,7 @@

            pcdsdevices.attenuator.AttBaseWith3rdHarmonicLP
            -status() str
            +status() str

            Returns a str with the current pv values for the device.

          @@ -657,7 +653,7 @@

          pcdsdevices.attenuator.AttBaseWith3rdHarmonicLP
          -trigger() StatusBase
          +trigger() StatusBase

          Trigger the device and return status object.

          This method is responsible for implementing ‘trigger’ or ‘acquire’ functionality of this device.

          @@ -665,14 +661,14 @@

          pcdsdevices.attenuator.AttBaseWith3rdHarmonicLPread() method) then this method is also responsible for arranging that the -StatusBase object returned by this method +StatusBase object returned by this method is notified when the device is ready to be read.

          If there is no delay between triggering and being readable, -then this method must return a StatusBase +then this method must return a StatusBase object which is already completed.

          Returns:
          -

          status (StatusBase) – StatusBase object which will be marked +

          status (StatusBase) – StatusBase object which will be marked as complete when the device is ready to be read.

          @@ -687,7 +683,7 @@

          pcdsdevices.attenuator.AttBaseWith3rdHarmonicLP
          Parameters:
          -

          scale (float) – starting step size, default = 0.1

          +

          scale (float) – starting step size, default = 0.1

          @@ -699,12 +695,12 @@

          pcdsdevices.attenuator.AttBaseWith3rdHarmonicLP
          Parameters:
            -
          • position (float) – Desired end position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • position (float) – Desired end position.

          • +
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • -
          • newline (bool, optional) – If True, inserts a newline after the updates.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • newline (bool, optional) – If True, inserts a newline after the updates.

          @@ -717,12 +713,12 @@

          pcdsdevices.attenuator.AttBaseWith3rdHarmonicLP
          Parameters:
            -
          • delta (float) – Desired change in position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • delta (float) – Desired change in position.

          • +
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • -
          • newline (bool, optional) – If True, inserts a newline after the updates.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • newline (bool, optional) – If True, inserts a newline after the updates.

          @@ -863,7 +859,7 @@

          pcdsdevices.attenuator.AttBaseWith3rdHarmonicLP
          -subscriptions: ClassVar[FrozenSet[str]] = frozenset({'_req_done', 'acq_done', 'done_moving', 'readback', 'start_moving', 'state'})
          +subscriptions: ClassVar[FrozenSet[str]] = frozenset({'_req_done', 'acq_done', 'done_moving', 'readback', 'start_moving', 'state'})
          diff --git a/master/generated/pcdsdevices.attenuator.Attenuator.html b/master/generated/pcdsdevices.attenuator.Attenuator.html index eb50c982e35..bdf76b98fe8 100644 --- a/master/generated/pcdsdevices.attenuator.Attenuator.html +++ b/master/generated/pcdsdevices.attenuator.Attenuator.html @@ -1,25 +1,23 @@ + + - pcdsdevices.attenuator.Attenuator — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.attenuator.Attenuator — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -
          - 8.5.1.dev30+gd6e98430 -
          @@ -114,6 +109,7 @@
        • pcdsdevices.ipm
        • pcdsdevices.jet
        • pcdsdevices.keithley
        • +
        • pcdsdevices.lakeshore
        • pcdsdevices.lamp_motion
        • pcdsdevices.lasers.btps
        • pcdsdevices.lasers.counters
        • @@ -232,9 +228,9 @@

          pcdsdevices.attenuator.Attenuator
          Parameters:
            -
          • prefix (str) – The EPICS prefix that identifies the attenuator, e.g. ‘XPP:ATT’

          • -
          • n_filters (int) – The number of filters in the attenuator.

          • -
          • name (str) – An identifying name for the attenuator.

          • +
          • prefix (str) – The EPICS prefix that identifies the attenuator, e.g. ‘XPP:ATT’

          • +
          • n_filters (int) – The number of filters in the attenuator.

          • +
          • name (str) – An identifying name for the attenuator.

          diff --git a/master/generated/pcdsdevices.attenuator.AttenuatorCalculatorBase.html b/master/generated/pcdsdevices.attenuator.AttenuatorCalculatorBase.html index 43dcaba46e0..b55bfb8db8b 100644 --- a/master/generated/pcdsdevices.attenuator.AttenuatorCalculatorBase.html +++ b/master/generated/pcdsdevices.attenuator.AttenuatorCalculatorBase.html @@ -1,25 +1,23 @@ + + - pcdsdevices.attenuator.AttenuatorCalculatorBase — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.attenuator.AttenuatorCalculatorBase — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -
          - 8.5.1.dev30+gd6e98430 -
          @@ -114,6 +109,7 @@
        • pcdsdevices.ipm
        • pcdsdevices.jet
        • pcdsdevices.keithley
        • +
        • pcdsdevices.lakeshore
        • pcdsdevices.lamp_motion
        • pcdsdevices.lasers.btps
        • pcdsdevices.lasers.counters
        • @@ -376,9 +372,9 @@

          pcdsdevices.attenuator.AttenuatorCalculatorBase
          Parameters:
            -
          • transmission (float) – The desired transmission, in the range [0, 1].

          • -
          • energy (float, optional) – The photon energy to use for the calculation.

          • -
          • use_floor (bool, optional) – Select floor or ceiling transmission estimation. Defaults to +

          • transmission (float) – The desired transmission, in the range [0, 1].

          • +
          • energy (float, optional) – The photon energy to use for the calculation.

          • +
          • use_floor (bool, optional) – Select floor or ceiling transmission estimation. Defaults to floor.

          @@ -387,14 +383,14 @@

          pcdsdevices.attenuator.AttenuatorCalculatorBase
          -configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]
          +configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]

          Configure the device for something during a run

          This default implementation allows the user to change any of the configuration_attrs. Subclasses might override this to perform additional input validation, cleanup, etc.

          Parameters:
          -

          d (dict) – The configuration dictionary. To specify the order that +

          d (dict) – The configuration dictionary. To specify the order that the changes should be made, use an OrderedDict.

          Returns:
          @@ -409,7 +405,7 @@

          pcdsdevices.attenuator.AttenuatorCalculatorBase
          -describe() OrderedDictType[str, Dict[str, Any]]
          +describe() OrderedDictType[str, Dict[str, Any]]

          Provide schema and meta-data for read().

          This keys in the OrderedDict this method returns must match the keys in the OrderedDict return by read().

          @@ -457,7 +453,7 @@

          pcdsdevices.attenuator.AttenuatorCalculatorBase
          -read() OrderedDictType[str, Dict[str, Any]]
          +read() OrderedDictType[str, Dict[str, Any]]

          Read data from the device.

          This method is expected to be as instantaneous as possible, with any substantial acquisition time taken care of in @@ -480,7 +476,7 @@

          pcdsdevices.attenuator.AttenuatorCalculatorBase
          -read_configuration() OrderedDictType[str, Dict[str, Any]]
          +read_configuration() OrderedDictType[str, Dict[str, Any]]

          Dictionary mapping names to value dicts with keys: value, timestamp

          To control which fields are included, change the Component kinds on the device, or modify the configuration_attrs list.

          @@ -496,7 +492,7 @@

          pcdsdevices.attenuator.AttenuatorCalculatorBase
          -status() str
          +status() str

          Returns a str with the current pv values for the device.

          @@ -513,7 +509,7 @@

          pcdsdevices.attenuator.AttenuatorCalculatorBase
          -trigger() StatusBase
          +trigger() StatusBase

          Trigger the device and return status object.

          This method is responsible for implementing ‘trigger’ or ‘acquire’ functionality of this device.

          @@ -521,14 +517,14 @@

          pcdsdevices.attenuator.AttenuatorCalculatorBaseread() method) then this method is also responsible for arranging that the -StatusBase object returned by this method +StatusBase object returned by this method is notified when the device is ready to be read.

          If there is no delay between triggering and being readable, -then this method must return a StatusBase +then this method must return a StatusBase object which is already completed.

          Returns:
          -

          status (StatusBase) – StatusBase object which will be marked +

          status (StatusBase) – StatusBase object which will be marked as complete when the device is ready to be read.

          @@ -557,7 +553,7 @@

          pcdsdevices.attenuator.AttenuatorCalculatorBase
          -subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})
          +subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})

          diff --git a/master/generated/pcdsdevices.attenuator.AttenuatorCalculatorFilter.html b/master/generated/pcdsdevices.attenuator.AttenuatorCalculatorFilter.html index f8bf06d1081..40bb27ff4e0 100644 --- a/master/generated/pcdsdevices.attenuator.AttenuatorCalculatorFilter.html +++ b/master/generated/pcdsdevices.attenuator.AttenuatorCalculatorFilter.html @@ -1,25 +1,23 @@ + + - pcdsdevices.attenuator.AttenuatorCalculatorFilter — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.attenuator.AttenuatorCalculatorFilter — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -
          - 8.5.1.dev30+gd6e98430 -
          @@ -114,6 +109,7 @@
        • pcdsdevices.ipm
        • pcdsdevices.jet
        • pcdsdevices.keithley
        • +
        • pcdsdevices.lakeshore
        • pcdsdevices.lamp_motion
        • pcdsdevices.lasers.btps
        • pcdsdevices.lasers.counters
        • @@ -290,14 +286,14 @@

          pcdsdevices.attenuator.AttenuatorCalculatorFilterMethods

          -configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]
          +configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]

          Configure the device for something during a run

          This default implementation allows the user to change any of the configuration_attrs. Subclasses might override this to perform additional input validation, cleanup, etc.

          Parameters:
          -

          d (dict) – The configuration dictionary. To specify the order that +

          d (dict) – The configuration dictionary. To specify the order that the changes should be made, use an OrderedDict.

          Returns:
          @@ -312,7 +308,7 @@

          pcdsdevices.attenuator.AttenuatorCalculatorFilter
          -describe() OrderedDictType[str, Dict[str, Any]]
          +describe() OrderedDictType[str, Dict[str, Any]]

          Provide schema and meta-data for read().

          This keys in the OrderedDict this method returns must match the keys in the OrderedDict return by read().

          @@ -342,7 +338,7 @@

          pcdsdevices.attenuator.AttenuatorCalculatorFilter
          -read() OrderedDictType[str, Dict[str, Any]]
          +read() OrderedDictType[str, Dict[str, Any]]

          Read data from the device.

          This method is expected to be as instantaneous as possible, with any substantial acquisition time taken care of in @@ -365,7 +361,7 @@

          pcdsdevices.attenuator.AttenuatorCalculatorFilter
          -read_configuration() OrderedDictType[str, Dict[str, Any]]
          +read_configuration() OrderedDictType[str, Dict[str, Any]]

          Dictionary mapping names to value dicts with keys: value, timestamp

          To control which fields are included, change the Component kinds on the device, or modify the configuration_attrs list.

          @@ -381,7 +377,7 @@

          pcdsdevices.attenuator.AttenuatorCalculatorFilter
          -status() str
          +status() str

          Returns a str with the current pv values for the device.

          @@ -398,7 +394,7 @@

          pcdsdevices.attenuator.AttenuatorCalculatorFilter
          -trigger() StatusBase
          +trigger() StatusBase

          Trigger the device and return status object.

          This method is responsible for implementing ‘trigger’ or ‘acquire’ functionality of this device.

          @@ -406,14 +402,14 @@

          pcdsdevices.attenuator.AttenuatorCalculatorFilterread() method) then this method is also responsible for arranging that the -StatusBase object returned by this method +StatusBase object returned by this method is notified when the device is ready to be read.

          If there is no delay between triggering and being readable, -then this method must return a StatusBase +then this method must return a StatusBase object which is already completed.

          Returns:
          -

          status (StatusBase) – StatusBase object which will be marked +

          status (StatusBase) – StatusBase object which will be marked as complete when the device is ready to be read.

          @@ -442,7 +438,7 @@

          pcdsdevices.attenuator.AttenuatorCalculatorFilter
          -subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})
          +subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})

          diff --git a/master/generated/pcdsdevices.attenuator.AttenuatorCalculatorSXR_Blade.html b/master/generated/pcdsdevices.attenuator.AttenuatorCalculatorSXR_Blade.html index a63f6b29a99..42343e8fe0a 100644 --- a/master/generated/pcdsdevices.attenuator.AttenuatorCalculatorSXR_Blade.html +++ b/master/generated/pcdsdevices.attenuator.AttenuatorCalculatorSXR_Blade.html @@ -1,25 +1,23 @@ + + - pcdsdevices.attenuator.AttenuatorCalculatorSXR_Blade — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.attenuator.AttenuatorCalculatorSXR_Blade — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -
          - 8.5.1.dev30+gd6e98430 -
          @@ -114,6 +109,7 @@
        • pcdsdevices.ipm
        • pcdsdevices.jet
        • pcdsdevices.keithley
        • +
        • pcdsdevices.lakeshore
        • pcdsdevices.lamp_motion
        • pcdsdevices.lasers.btps
        • pcdsdevices.lasers.counters
        • @@ -354,14 +350,14 @@

          pcdsdevices.attenuator.AttenuatorCalculatorSXR_BladeMethods

          -configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]
          +configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]

          Configure the device for something during a run

          This default implementation allows the user to change any of the configuration_attrs. Subclasses might override this to perform additional input validation, cleanup, etc.

          Parameters:
          -

          d (dict) – The configuration dictionary. To specify the order that +

          d (dict) – The configuration dictionary. To specify the order that the changes should be made, use an OrderedDict.

          Returns:
          @@ -376,7 +372,7 @@

          pcdsdevices.attenuator.AttenuatorCalculatorSXR_Blade
          -describe() OrderedDictType[str, Dict[str, Any]]
          +describe() OrderedDictType[str, Dict[str, Any]]

          Provide schema and meta-data for read().

          This keys in the OrderedDict this method returns must match the keys in the OrderedDict return by read().

          @@ -406,7 +402,7 @@

          pcdsdevices.attenuator.AttenuatorCalculatorSXR_Blade
          -read() OrderedDictType[str, Dict[str, Any]]
          +read() OrderedDictType[str, Dict[str, Any]]

          Read data from the device.

          This method is expected to be as instantaneous as possible, with any substantial acquisition time taken care of in @@ -429,7 +425,7 @@

          pcdsdevices.attenuator.AttenuatorCalculatorSXR_Blade
          -read_configuration() OrderedDictType[str, Dict[str, Any]]
          +read_configuration() OrderedDictType[str, Dict[str, Any]]

          Dictionary mapping names to value dicts with keys: value, timestamp

          To control which fields are included, change the Component kinds on the device, or modify the configuration_attrs list.

          @@ -445,7 +441,7 @@

          pcdsdevices.attenuator.AttenuatorCalculatorSXR_Blade
          -status() str
          +status() str

          Returns a str with the current pv values for the device.

          @@ -462,7 +458,7 @@

          pcdsdevices.attenuator.AttenuatorCalculatorSXR_Blade
          -trigger() StatusBase
          +trigger() StatusBase

          Trigger the device and return status object.

          This method is responsible for implementing ‘trigger’ or ‘acquire’ functionality of this device.

          @@ -470,14 +466,14 @@

          pcdsdevices.attenuator.AttenuatorCalculatorSXR_Bladeread() method) then this method is also responsible for arranging that the -StatusBase object returned by this method +StatusBase object returned by this method is notified when the device is ready to be read.

          If there is no delay between triggering and being readable, -then this method must return a StatusBase +then this method must return a StatusBase object which is already completed.

          Returns:
          -

          status (StatusBase) – StatusBase object which will be marked +

          status (StatusBase) – StatusBase object which will be marked as complete when the device is ready to be read.

          @@ -506,7 +502,7 @@

          pcdsdevices.attenuator.AttenuatorCalculatorSXR_Blade
          -subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})
          +subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})

          diff --git a/master/generated/pcdsdevices.attenuator.AttenuatorCalculatorSXR_FourBlade.html b/master/generated/pcdsdevices.attenuator.AttenuatorCalculatorSXR_FourBlade.html index 582d07f1f70..15fd758e677 100644 --- a/master/generated/pcdsdevices.attenuator.AttenuatorCalculatorSXR_FourBlade.html +++ b/master/generated/pcdsdevices.attenuator.AttenuatorCalculatorSXR_FourBlade.html @@ -1,25 +1,23 @@ + + - pcdsdevices.attenuator.AttenuatorCalculatorSXR_FourBlade — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.attenuator.AttenuatorCalculatorSXR_FourBlade — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -
          - 8.5.1.dev30+gd6e98430 -
          @@ -114,6 +109,7 @@
        • pcdsdevices.ipm
        • pcdsdevices.jet
        • pcdsdevices.keithley
        • +
        • pcdsdevices.lakeshore
        • pcdsdevices.lamp_motion
        • pcdsdevices.lasers.btps
        • pcdsdevices.lasers.counters
        • @@ -228,8 +224,8 @@

          pcdsdevices.attenuator.AttenuatorCalculatorSXR_FourBlade
          Parameters:
            -
          • prefix (str) – Full Solid Attenuator base PV.

          • -
          • name (str) – Alias for the Solid Attenuator.

          • +
          • prefix (str) – Full Solid Attenuator base PV.

          • +
          • name (str) – Alias for the Solid Attenuator.

          @@ -412,9 +408,9 @@

          pcdsdevices.attenuator.AttenuatorCalculatorSXR_FourBlade
          Parameters:
            -
          • transmission (float) – The desired transmission, in the range [0, 1].

          • -
          • energy (float, optional) – The photon energy to use for the calculation.

          • -
          • use_floor (bool, optional) – Select floor or ceiling transmission estimation. Defaults to +

          • transmission (float) – The desired transmission, in the range [0, 1].

          • +
          • energy (float, optional) – The photon energy to use for the calculation.

          • +
          • use_floor (bool, optional) – Select floor or ceiling transmission estimation. Defaults to floor.

          @@ -423,14 +419,14 @@

          pcdsdevices.attenuator.AttenuatorCalculatorSXR_FourBlade
          -configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]
          +configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]

          Configure the device for something during a run

          This default implementation allows the user to change any of the configuration_attrs. Subclasses might override this to perform additional input validation, cleanup, etc.

          Parameters:
          -

          d (dict) – The configuration dictionary. To specify the order that +

          d (dict) – The configuration dictionary. To specify the order that the changes should be made, use an OrderedDict.

          Returns:
          @@ -445,7 +441,7 @@

          pcdsdevices.attenuator.AttenuatorCalculatorSXR_FourBlade
          -describe() OrderedDictType[str, Dict[str, Any]]
          +describe() OrderedDictType[str, Dict[str, Any]]

          Provide schema and meta-data for read().

          This keys in the OrderedDict this method returns must match the keys in the OrderedDict return by read().

          @@ -493,7 +489,7 @@

          pcdsdevices.attenuator.AttenuatorCalculatorSXR_FourBlade
          -read() OrderedDictType[str, Dict[str, Any]]
          +read() OrderedDictType[str, Dict[str, Any]]

          Read data from the device.

          This method is expected to be as instantaneous as possible, with any substantial acquisition time taken care of in @@ -516,7 +512,7 @@

          pcdsdevices.attenuator.AttenuatorCalculatorSXR_FourBlade
          -read_configuration() OrderedDictType[str, Dict[str, Any]]
          +read_configuration() OrderedDictType[str, Dict[str, Any]]

          Dictionary mapping names to value dicts with keys: value, timestamp

          To control which fields are included, change the Component kinds on the device, or modify the configuration_attrs list.

          @@ -532,7 +528,7 @@

          pcdsdevices.attenuator.AttenuatorCalculatorSXR_FourBlade
          -status() str
          +status() str

          Returns a str with the current pv values for the device.

          @@ -549,7 +545,7 @@

          pcdsdevices.attenuator.AttenuatorCalculatorSXR_FourBlade
          -trigger() StatusBase
          +trigger() StatusBase

          Trigger the device and return status object.

          This method is responsible for implementing ‘trigger’ or ‘acquire’ functionality of this device.

          @@ -557,14 +553,14 @@

          pcdsdevices.attenuator.AttenuatorCalculatorSXR_FourBladeread() method) then this method is also responsible for arranging that the -StatusBase object returned by this method +StatusBase object returned by this method is notified when the device is ready to be read.

          If there is no delay between triggering and being readable, -then this method must return a StatusBase +then this method must return a StatusBase object which is already completed.

          Returns:
          -

          status (StatusBase) – StatusBase object which will be marked +

          status (StatusBase) – StatusBase object which will be marked as complete when the device is ready to be read.

          @@ -603,7 +599,7 @@

          pcdsdevices.attenuator.AttenuatorCalculatorSXR_FourBlade
          -subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})
          +subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})

          diff --git a/master/generated/pcdsdevices.attenuator.AttenuatorCalculatorSXR_TwoBlade.html b/master/generated/pcdsdevices.attenuator.AttenuatorCalculatorSXR_TwoBlade.html index 482ec2a4cb4..e88935a31aa 100644 --- a/master/generated/pcdsdevices.attenuator.AttenuatorCalculatorSXR_TwoBlade.html +++ b/master/generated/pcdsdevices.attenuator.AttenuatorCalculatorSXR_TwoBlade.html @@ -1,25 +1,23 @@ + + - pcdsdevices.attenuator.AttenuatorCalculatorSXR_TwoBlade — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.attenuator.AttenuatorCalculatorSXR_TwoBlade — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -
          - 8.5.1.dev30+gd6e98430 -
          @@ -114,6 +109,7 @@
        • pcdsdevices.ipm
        • pcdsdevices.jet
        • pcdsdevices.keithley
        • +
        • pcdsdevices.lakeshore
        • pcdsdevices.lamp_motion
        • pcdsdevices.lasers.btps
        • pcdsdevices.lasers.counters
        • @@ -228,8 +224,8 @@

          pcdsdevices.attenuator.AttenuatorCalculatorSXR_TwoBlade
          Parameters:
            -
          • prefix (str) – Full Solid Attenuator base PV.

          • -
          • name (str) – Alias for the Solid Attenuator.

          • +
          • prefix (str) – Full Solid Attenuator base PV.

          • +
          • name (str) – Alias for the Solid Attenuator.

          @@ -398,9 +394,9 @@

          pcdsdevices.attenuator.AttenuatorCalculatorSXR_TwoBlade
          Parameters:
            -
          • transmission (float) – The desired transmission, in the range [0, 1].

          • -
          • energy (float, optional) – The photon energy to use for the calculation.

          • -
          • use_floor (bool, optional) – Select floor or ceiling transmission estimation. Defaults to +

          • transmission (float) – The desired transmission, in the range [0, 1].

          • +
          • energy (float, optional) – The photon energy to use for the calculation.

          • +
          • use_floor (bool, optional) – Select floor or ceiling transmission estimation. Defaults to floor.

          @@ -409,14 +405,14 @@

          pcdsdevices.attenuator.AttenuatorCalculatorSXR_TwoBlade
          -configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]
          +configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]

          Configure the device for something during a run

          This default implementation allows the user to change any of the configuration_attrs. Subclasses might override this to perform additional input validation, cleanup, etc.

          Parameters:
          -

          d (dict) – The configuration dictionary. To specify the order that +

          d (dict) – The configuration dictionary. To specify the order that the changes should be made, use an OrderedDict.

          Returns:
          @@ -431,7 +427,7 @@

          pcdsdevices.attenuator.AttenuatorCalculatorSXR_TwoBlade
          -describe() OrderedDictType[str, Dict[str, Any]]
          +describe() OrderedDictType[str, Dict[str, Any]]

          Provide schema and meta-data for read().

          This keys in the OrderedDict this method returns must match the keys in the OrderedDict return by read().

          @@ -479,7 +475,7 @@

          pcdsdevices.attenuator.AttenuatorCalculatorSXR_TwoBlade
          -read() OrderedDictType[str, Dict[str, Any]]
          +read() OrderedDictType[str, Dict[str, Any]]

          Read data from the device.

          This method is expected to be as instantaneous as possible, with any substantial acquisition time taken care of in @@ -502,7 +498,7 @@

          pcdsdevices.attenuator.AttenuatorCalculatorSXR_TwoBlade
          -read_configuration() OrderedDictType[str, Dict[str, Any]]
          +read_configuration() OrderedDictType[str, Dict[str, Any]]

          Dictionary mapping names to value dicts with keys: value, timestamp

          To control which fields are included, change the Component kinds on the device, or modify the configuration_attrs list.

          @@ -518,7 +514,7 @@

          pcdsdevices.attenuator.AttenuatorCalculatorSXR_TwoBlade
          -status() str
          +status() str

          Returns a str with the current pv values for the device.

          @@ -535,7 +531,7 @@

          pcdsdevices.attenuator.AttenuatorCalculatorSXR_TwoBlade
          -trigger() StatusBase
          +trigger() StatusBase

          Trigger the device and return status object.

          This method is responsible for implementing ‘trigger’ or ‘acquire’ functionality of this device.

          @@ -543,14 +539,14 @@

          pcdsdevices.attenuator.AttenuatorCalculatorSXR_TwoBladeread() method) then this method is also responsible for arranging that the -StatusBase object returned by this method +StatusBase object returned by this method is notified when the device is ready to be read.

          If there is no delay between triggering and being readable, -then this method must return a StatusBase +then this method must return a StatusBase object which is already completed.

          Returns:
          -

          status (StatusBase) – StatusBase object which will be marked +

          status (StatusBase) – StatusBase object which will be marked as complete when the device is ready to be read.

          @@ -589,7 +585,7 @@

          pcdsdevices.attenuator.AttenuatorCalculatorSXR_TwoBlade
          -subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})
          +subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})

          diff --git a/master/generated/pcdsdevices.attenuator.AttenuatorCalculator_AT2L0.html b/master/generated/pcdsdevices.attenuator.AttenuatorCalculator_AT2L0.html index 8eeef428c69..347166010b7 100644 --- a/master/generated/pcdsdevices.attenuator.AttenuatorCalculator_AT2L0.html +++ b/master/generated/pcdsdevices.attenuator.AttenuatorCalculator_AT2L0.html @@ -1,25 +1,23 @@ + + - pcdsdevices.attenuator.AttenuatorCalculator_AT2L0 — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.attenuator.AttenuatorCalculator_AT2L0 — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -
          - 8.5.1.dev30+gd6e98430 -
          @@ -114,6 +109,7 @@
        • pcdsdevices.ipm
        • pcdsdevices.jet
        • pcdsdevices.keithley
        • +
        • pcdsdevices.lakeshore
        • pcdsdevices.lamp_motion
        • pcdsdevices.lasers.btps
        • pcdsdevices.lasers.counters
        • @@ -228,8 +224,8 @@

          pcdsdevices.attenuator.AttenuatorCalculator_AT2L0
          Parameters:
            -
          • prefix (str) – Full Solid Attenuator base PV.

          • -
          • name (str) – Alias for the Solid Attenuator.

          • +
          • prefix (str) – Full Solid Attenuator base PV.

          • +
          • name (str) – Alias for the Solid Attenuator.

          @@ -531,9 +527,9 @@

          pcdsdevices.attenuator.AttenuatorCalculator_AT2L0
          Parameters:
            -
          • transmission (float) – The desired transmission, in the range [0, 1].

          • -
          • energy (float, optional) – The photon energy to use for the calculation.

          • -
          • use_floor (bool, optional) – Select floor or ceiling transmission estimation. Defaults to +

          • transmission (float) – The desired transmission, in the range [0, 1].

          • +
          • energy (float, optional) – The photon energy to use for the calculation.

          • +
          • use_floor (bool, optional) – Select floor or ceiling transmission estimation. Defaults to floor.

          @@ -542,14 +538,14 @@

          pcdsdevices.attenuator.AttenuatorCalculator_AT2L0
          -configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]
          +configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]

          Configure the device for something during a run

          This default implementation allows the user to change any of the configuration_attrs. Subclasses might override this to perform additional input validation, cleanup, etc.

          Parameters:
          -

          d (dict) – The configuration dictionary. To specify the order that +

          d (dict) – The configuration dictionary. To specify the order that the changes should be made, use an OrderedDict.

          Returns:
          @@ -564,7 +560,7 @@

          pcdsdevices.attenuator.AttenuatorCalculator_AT2L0
          -describe() OrderedDictType[str, Dict[str, Any]]
          +describe() OrderedDictType[str, Dict[str, Any]]

          Provide schema and meta-data for read().

          This keys in the OrderedDict this method returns must match the keys in the OrderedDict return by read().

          @@ -612,7 +608,7 @@

          pcdsdevices.attenuator.AttenuatorCalculator_AT2L0
          -read() OrderedDictType[str, Dict[str, Any]]
          +read() OrderedDictType[str, Dict[str, Any]]

          Read data from the device.

          This method is expected to be as instantaneous as possible, with any substantial acquisition time taken care of in @@ -635,7 +631,7 @@

          pcdsdevices.attenuator.AttenuatorCalculator_AT2L0
          -read_configuration() OrderedDictType[str, Dict[str, Any]]
          +read_configuration() OrderedDictType[str, Dict[str, Any]]

          Dictionary mapping names to value dicts with keys: value, timestamp

          To control which fields are included, change the Component kinds on the device, or modify the configuration_attrs list.

          @@ -651,7 +647,7 @@

          pcdsdevices.attenuator.AttenuatorCalculator_AT2L0
          -status() str
          +status() str

          Returns a str with the current pv values for the device.

          @@ -668,7 +664,7 @@

          pcdsdevices.attenuator.AttenuatorCalculator_AT2L0
          -trigger() StatusBase
          +trigger() StatusBase

          Trigger the device and return status object.

          This method is responsible for implementing ‘trigger’ or ‘acquire’ functionality of this device.

          @@ -676,14 +672,14 @@

          pcdsdevices.attenuator.AttenuatorCalculator_AT2L0read() method) then this method is also responsible for arranging that the -StatusBase object returned by this method +StatusBase object returned by this method is notified when the device is ready to be read.

          If there is no delay between triggering and being readable, -then this method must return a StatusBase +then this method must return a StatusBase object which is already completed.

          Returns:
          -

          status (StatusBase) – StatusBase object which will be marked +

          status (StatusBase) – StatusBase object which will be marked as complete when the device is ready to be read.

          @@ -722,7 +718,7 @@

          pcdsdevices.attenuator.AttenuatorCalculator_AT2L0
          -subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})
          +subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})

          diff --git a/master/generated/pcdsdevices.attenuator.AttenuatorSXR_Ladder.html b/master/generated/pcdsdevices.attenuator.AttenuatorSXR_Ladder.html index 1f5e434d5fc..64db30a9df9 100644 --- a/master/generated/pcdsdevices.attenuator.AttenuatorSXR_Ladder.html +++ b/master/generated/pcdsdevices.attenuator.AttenuatorSXR_Ladder.html @@ -1,25 +1,23 @@ + + - pcdsdevices.attenuator.AttenuatorSXR_Ladder — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.attenuator.AttenuatorSXR_Ladder — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -
          - 8.5.1.dev30+gd6e98430 -
          @@ -114,6 +109,7 @@
        • pcdsdevices.ipm
        • pcdsdevices.jet
        • pcdsdevices.keithley
        • +
        • pcdsdevices.lakeshore
        • pcdsdevices.lamp_motion
        • pcdsdevices.lasers.btps
        • pcdsdevices.lasers.counters
        • @@ -231,9 +227,9 @@

          pcdsdevices.attenuator.AttenuatorSXR_Ladder
          Parameters:
            -
          • prefix (str) – Solid Attenuator base PV.

          • -
          • name (str) – Alias for the Solid Attenuator.

          • -
          • calculator_prefix (str) – The prefix for the calculator PVs.

          • +
          • prefix (str) – Solid Attenuator base PV.

          • +
          • name (str) – Alias for the Solid Attenuator.

          • +
          • calculator_prefix (str) – The prefix for the calculator PVs.

          @@ -343,14 +339,14 @@

          pcdsdevices.attenuator.AttenuatorSXR_Ladder
          -configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]
          +configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]

          Configure the device for something during a run

          This default implementation allows the user to change any of the configuration_attrs. Subclasses might override this to perform additional input validation, cleanup, etc.

          Parameters:
          -

          d (dict) – The configuration dictionary. To specify the order that +

          d (dict) – The configuration dictionary. To specify the order that the changes should be made, use an OrderedDict.

          Returns:
          @@ -365,7 +361,7 @@

          pcdsdevices.attenuator.AttenuatorSXR_Ladder
          -describe() OrderedDictType[str, Dict[str, Any]]
          +describe() OrderedDictType[str, Dict[str, Any]]

          Provide schema and meta-data for read().

          This keys in the OrderedDict this method returns must match the keys in the OrderedDict return by read().

          @@ -414,7 +410,7 @@

          pcdsdevices.attenuator.AttenuatorSXR_Ladderfloat, optional) – Maximum time to wait for the motion. If None, the default timeout +
        • timeout (float, optional) – Maximum time to wait for the motion. If None, the default timeout for this positioner is used.

        • @@ -423,9 +419,9 @@

          pcdsdevices.attenuator.AttenuatorSXR_LadderRaises:

          @@ -439,12 +435,12 @@

          pcdsdevices.attenuator.AttenuatorSXR_LadderParameters:
          • position – Desired end position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • wait (bool, optional) – If True, wait for motion completion before returning. +

          • wait (bool, optional) – If True, wait for motion completion before returning. Defaults to False.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          @@ -466,13 +462,13 @@

          pcdsdevices.attenuator.AttenuatorSXR_Ladder
          Parameters:
            -
          • delta (float) – Desired change in position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • delta (float) – Desired change in position.

          • +
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • wait (bool, optional) – If True, wait for motion completion before returning. +

          • wait (bool, optional) – If True, wait for motion completion before returning. Defaults to False.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          @@ -486,7 +482,7 @@

          pcdsdevices.attenuator.AttenuatorSXR_Ladder
          -read() OrderedDictType[str, Dict[str, Any]]
          +read() OrderedDictType[str, Dict[str, Any]]

          Read data from the device.

          This method is expected to be as instantaneous as possible, with any substantial acquisition time taken care of in @@ -509,7 +505,7 @@

          pcdsdevices.attenuator.AttenuatorSXR_Ladder
          -read_configuration() OrderedDictType[str, Dict[str, Any]]
          +read_configuration() OrderedDictType[str, Dict[str, Any]]

          Dictionary mapping names to value dicts with keys: value, timestamp

          To control which fields are included, change the Component kinds on the device, or modify the configuration_attrs list.

          @@ -525,23 +521,23 @@

          pcdsdevices.attenuator.AttenuatorSXR_Ladder
          -set(new_position: Any, *, timeout: float | None = None, moved_cb: Callable | None = None, wait: bool = False) StatusBase
          +set(new_position: Any, *, timeout: float | None = None, moved_cb: Callable | None = None, wait: bool = False) StatusBase

          Set a value and return a Status object

          Parameters:
            -
          • new_position (object) – The input here is whatever the device requires (this +

          • new_position (object) – The input here is whatever the device requires (this should be over-ridden by the implementation. For example a motor would take a float, a shutter the strings {‘Open’, ‘Close’}, and a goineometer (h, k, l) tuples

          • -
          • timeout (float, optional) – Maximum time to wait for the motion. If None, the default timeout +

          • timeout (float, optional) – Maximum time to wait for the motion. If None, the default timeout for this positioner is used.

          • moved_cb (callable, optional) –

            Deprecated

            Call this callback when movement has finished. This callback must accept one keyword argument: ‘obj’ which will be set to this positioner instance.

          • -
          • wait (bool, optional) –

            Deprecated

            +
          • wait (bool, optional) –

            Deprecated

            If the method should block until the Status object reports it is done.

            Defaults to False

            @@ -563,7 +559,7 @@

            pcdsdevices.attenuator.AttenuatorSXR_Ladder
            -status() str
            +status() str

            Returns a str with the current pv values for the device.

          @@ -580,7 +576,7 @@

          pcdsdevices.attenuator.AttenuatorSXR_Ladder
          -trigger() StatusBase
          +trigger() StatusBase

          Trigger the device and return status object.

          This method is responsible for implementing ‘trigger’ or ‘acquire’ functionality of this device.

          @@ -588,14 +584,14 @@

          pcdsdevices.attenuator.AttenuatorSXR_Ladderread() method) then this method is also responsible for arranging that the -StatusBase object returned by this method +StatusBase object returned by this method is notified when the device is ready to be read.

          If there is no delay between triggering and being readable, -then this method must return a StatusBase +then this method must return a StatusBase object which is already completed.

          Returns:
          -

          status (StatusBase) – StatusBase object which will be marked +

          status (StatusBase) – StatusBase object which will be marked as complete when the device is ready to be read.

          @@ -610,7 +606,7 @@

          pcdsdevices.attenuator.AttenuatorSXR_Ladder
          Parameters:
          -

          scale (float) – starting step size, default = 0.1

          +

          scale (float) – starting step size, default = 0.1

          @@ -622,12 +618,12 @@

          pcdsdevices.attenuator.AttenuatorSXR_Ladder
          Parameters:
            -
          • position (float) – Desired end position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • position (float) – Desired end position.

          • +
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • -
          • newline (bool, optional) – If True, inserts a newline after the updates.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • newline (bool, optional) – If True, inserts a newline after the updates.

          @@ -640,12 +636,12 @@

          pcdsdevices.attenuator.AttenuatorSXR_Ladder
          Parameters:
            -
          • delta (float) – Desired change in position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • delta (float) – Desired change in position.

          • +
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • -
          • newline (bool, optional) – If True, inserts a newline after the updates.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • newline (bool, optional) – If True, inserts a newline after the updates.

          @@ -805,7 +801,7 @@

          pcdsdevices.attenuator.AttenuatorSXR_Ladder
          -subscriptions: ClassVar[FrozenSet[str]] = frozenset({'_req_done', 'acq_done', 'done_moving', 'readback', 'start_moving'})
          +subscriptions: ClassVar[FrozenSet[str]] = frozenset({'_req_done', 'acq_done', 'done_moving', 'readback', 'start_moving'})
          diff --git a/master/generated/pcdsdevices.attenuator.AttenuatorSXR_LadderTwoBladeLBD.html b/master/generated/pcdsdevices.attenuator.AttenuatorSXR_LadderTwoBladeLBD.html index 09df5ada8a0..3bf293e950e 100644 --- a/master/generated/pcdsdevices.attenuator.AttenuatorSXR_LadderTwoBladeLBD.html +++ b/master/generated/pcdsdevices.attenuator.AttenuatorSXR_LadderTwoBladeLBD.html @@ -1,25 +1,23 @@ + + - pcdsdevices.attenuator.AttenuatorSXR_LadderTwoBladeLBD — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.attenuator.AttenuatorSXR_LadderTwoBladeLBD — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -
          - 8.5.1.dev30+gd6e98430 -
          @@ -114,6 +109,7 @@
        • pcdsdevices.ipm
        • pcdsdevices.jet
        • pcdsdevices.keithley
        • +
        • pcdsdevices.lakeshore
        • pcdsdevices.lamp_motion
        • pcdsdevices.lasers.btps
        • pcdsdevices.lasers.counters
        • @@ -232,9 +228,9 @@

          pcdsdevices.attenuator.AttenuatorSXR_LadderTwoBladeLBD
          Parameters:
            -
          • prefix (str) – Solid Attenuator base PV.

          • -
          • name (str) – Alias for the Solid Attenuator.

          • -
          • calculator_prefix (str) – The prefix for the calculator PVs.

          • +
          • prefix (str) – Solid Attenuator base PV.

          • +
          • name (str) – Alias for the Solid Attenuator.

          • +
          • calculator_prefix (str) – The prefix for the calculator PVs.

          @@ -337,14 +333,14 @@

          pcdsdevices.attenuator.AttenuatorSXR_LadderTwoBladeLBD
          -configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]
          +configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]

          Configure the device for something during a run

          This default implementation allows the user to change any of the configuration_attrs. Subclasses might override this to perform additional input validation, cleanup, etc.

          Parameters:
          -

          d (dict) – The configuration dictionary. To specify the order that +

          d (dict) – The configuration dictionary. To specify the order that the changes should be made, use an OrderedDict.

          Returns:
          @@ -359,7 +355,7 @@

          pcdsdevices.attenuator.AttenuatorSXR_LadderTwoBladeLBD
          -describe() OrderedDictType[str, Dict[str, Any]]
          +describe() OrderedDictType[str, Dict[str, Any]]

          Provide schema and meta-data for read().

          This keys in the OrderedDict this method returns must match the keys in the OrderedDict return by read().

          @@ -408,7 +404,7 @@

          pcdsdevices.attenuator.AttenuatorSXR_LadderTwoBladeLBD

          moved_cb (callable) – Call this callback when movement has finished. This callback must accept one keyword argument: ‘obj’ which will be set to this positioner instance.

          -
        • timeout (float, optional) – Maximum time to wait for the motion. If None, the default timeout +

        • timeout (float, optional) – Maximum time to wait for the motion. If None, the default timeout for this positioner is used.

        • @@ -417,9 +413,9 @@

          pcdsdevices.attenuator.AttenuatorSXR_LadderTwoBladeLBD
          Raises:

          @@ -433,12 +429,12 @@

          pcdsdevices.attenuator.AttenuatorSXR_LadderTwoBladeLBDParameters:
          • position – Desired end position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • wait (bool, optional) – If True, wait for motion completion before returning. +

          • wait (bool, optional) – If True, wait for motion completion before returning. Defaults to False.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          @@ -460,13 +456,13 @@

          pcdsdevices.attenuator.AttenuatorSXR_LadderTwoBladeLBD
          Parameters:
            -
          • delta (float) – Desired change in position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • delta (float) – Desired change in position.

          • +
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • wait (bool, optional) – If True, wait for motion completion before returning. +

          • wait (bool, optional) – If True, wait for motion completion before returning. Defaults to False.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          @@ -480,7 +476,7 @@

          pcdsdevices.attenuator.AttenuatorSXR_LadderTwoBladeLBD
          -read() OrderedDictType[str, Dict[str, Any]]
          +read() OrderedDictType[str, Dict[str, Any]]

          Read data from the device.

          This method is expected to be as instantaneous as possible, with any substantial acquisition time taken care of in @@ -503,7 +499,7 @@

          pcdsdevices.attenuator.AttenuatorSXR_LadderTwoBladeLBD
          -read_configuration() OrderedDictType[str, Dict[str, Any]]
          +read_configuration() OrderedDictType[str, Dict[str, Any]]

          Dictionary mapping names to value dicts with keys: value, timestamp

          To control which fields are included, change the Component kinds on the device, or modify the configuration_attrs list.

          @@ -519,23 +515,23 @@

          pcdsdevices.attenuator.AttenuatorSXR_LadderTwoBladeLBD
          -set(new_position: Any, *, timeout: float | None = None, moved_cb: Callable | None = None, wait: bool = False) StatusBase
          +set(new_position: Any, *, timeout: float | None = None, moved_cb: Callable | None = None, wait: bool = False) StatusBase

          Set a value and return a Status object

          Parameters:
            -
          • new_position (object) – The input here is whatever the device requires (this +

          • new_position (object) – The input here is whatever the device requires (this should be over-ridden by the implementation. For example a motor would take a float, a shutter the strings {‘Open’, ‘Close’}, and a goineometer (h, k, l) tuples

          • -
          • timeout (float, optional) – Maximum time to wait for the motion. If None, the default timeout +

          • timeout (float, optional) – Maximum time to wait for the motion. If None, the default timeout for this positioner is used.

          • moved_cb (callable, optional) –

            Deprecated

            Call this callback when movement has finished. This callback must accept one keyword argument: ‘obj’ which will be set to this positioner instance.

          • -
          • wait (bool, optional) –

            Deprecated

            +
          • wait (bool, optional) –

            Deprecated

            If the method should block until the Status object reports it is done.

            Defaults to False

            @@ -557,7 +553,7 @@

            pcdsdevices.attenuator.AttenuatorSXR_LadderTwoBladeLBD
            -status() str
            +status() str

            Returns a str with the current pv values for the device.

          @@ -574,7 +570,7 @@

          pcdsdevices.attenuator.AttenuatorSXR_LadderTwoBladeLBD
          -trigger() StatusBase
          +trigger() StatusBase

          Trigger the device and return status object.

          This method is responsible for implementing ‘trigger’ or ‘acquire’ functionality of this device.

          @@ -582,14 +578,14 @@

          pcdsdevices.attenuator.AttenuatorSXR_LadderTwoBladeLBDread() method) then this method is also responsible for arranging that the -StatusBase object returned by this method +StatusBase object returned by this method is notified when the device is ready to be read.

          If there is no delay between triggering and being readable, -then this method must return a StatusBase +then this method must return a StatusBase object which is already completed.

          Returns:
          -

          status (StatusBase) – StatusBase object which will be marked +

          status (StatusBase) – StatusBase object which will be marked as complete when the device is ready to be read.

          @@ -604,7 +600,7 @@

          pcdsdevices.attenuator.AttenuatorSXR_LadderTwoBladeLBD
          Parameters:
          -

          scale (float) – starting step size, default = 0.1

          +

          scale (float) – starting step size, default = 0.1

          @@ -616,12 +612,12 @@

          pcdsdevices.attenuator.AttenuatorSXR_LadderTwoBladeLBD
          Parameters:
            -
          • position (float) – Desired end position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • position (float) – Desired end position.

          • +
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • -
          • newline (bool, optional) – If True, inserts a newline after the updates.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • newline (bool, optional) – If True, inserts a newline after the updates.

          @@ -634,12 +630,12 @@

          pcdsdevices.attenuator.AttenuatorSXR_LadderTwoBladeLBD
          Parameters:
            -
          • delta (float) – Desired change in position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • delta (float) – Desired change in position.

          • +
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • -
          • newline (bool, optional) – If True, inserts a newline after the updates.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • newline (bool, optional) – If True, inserts a newline after the updates.

          @@ -799,7 +795,7 @@

          pcdsdevices.attenuator.AttenuatorSXR_LadderTwoBladeLBD
          -subscriptions: ClassVar[FrozenSet[str]] = frozenset({'_req_done', 'acq_done', 'done_moving', 'readback', 'start_moving'})
          +subscriptions: ClassVar[FrozenSet[str]] = frozenset({'_req_done', 'acq_done', 'done_moving', 'readback', 'start_moving'})
          diff --git a/master/generated/pcdsdevices.attenuator.FEESolidAttenuatorBlade.html b/master/generated/pcdsdevices.attenuator.FEESolidAttenuatorBlade.html index 0aeb5ef3904..c234852dc6f 100644 --- a/master/generated/pcdsdevices.attenuator.FEESolidAttenuatorBlade.html +++ b/master/generated/pcdsdevices.attenuator.FEESolidAttenuatorBlade.html @@ -1,25 +1,23 @@ + + - pcdsdevices.attenuator.FEESolidAttenuatorBlade — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.attenuator.FEESolidAttenuatorBlade — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -
          - 8.5.1.dev30+gd6e98430 -
          @@ -114,6 +109,7 @@
        • pcdsdevices.ipm
        • pcdsdevices.jet
        • pcdsdevices.keithley
        • +
        • pcdsdevices.lakeshore
        • pcdsdevices.lamp_motion
        • pcdsdevices.lasers.btps
        • pcdsdevices.lasers.counters
        • @@ -257,14 +253,14 @@

          pcdsdevices.attenuator.FEESolidAttenuatorBladeMethods

          -configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]
          +configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]

          Configure the device for something during a run

          This default implementation allows the user to change any of the configuration_attrs. Subclasses might override this to perform additional input validation, cleanup, etc.

          Parameters:
          -

          d (dict) – The configuration dictionary. To specify the order that +

          d (dict) – The configuration dictionary. To specify the order that the changes should be made, use an OrderedDict.

          Returns:
          @@ -279,7 +275,7 @@

          pcdsdevices.attenuator.FEESolidAttenuatorBlade
          -describe() OrderedDictType[str, Dict[str, Any]]
          +describe() OrderedDictType[str, Dict[str, Any]]

          Provide schema and meta-data for read().

          This keys in the OrderedDict this method returns must match the keys in the OrderedDict return by read().

          @@ -309,7 +305,7 @@

          pcdsdevices.attenuator.FEESolidAttenuatorBlade
          -read() OrderedDictType[str, Dict[str, Any]]
          +read() OrderedDictType[str, Dict[str, Any]]

          Read data from the device.

          This method is expected to be as instantaneous as possible, with any substantial acquisition time taken care of in @@ -332,7 +328,7 @@

          pcdsdevices.attenuator.FEESolidAttenuatorBlade
          -read_configuration() OrderedDictType[str, Dict[str, Any]]
          +read_configuration() OrderedDictType[str, Dict[str, Any]]

          Dictionary mapping names to value dicts with keys: value, timestamp

          To control which fields are included, change the Component kinds on the device, or modify the configuration_attrs list.

          @@ -348,7 +344,7 @@

          pcdsdevices.attenuator.FEESolidAttenuatorBlade
          -status() str
          +status() str

          Returns a str with the current pv values for the device.

          @@ -365,7 +361,7 @@

          pcdsdevices.attenuator.FEESolidAttenuatorBlade
          -trigger() StatusBase
          +trigger() StatusBase

          Trigger the device and return status object.

          This method is responsible for implementing ‘trigger’ or ‘acquire’ functionality of this device.

          @@ -373,14 +369,14 @@

          pcdsdevices.attenuator.FEESolidAttenuatorBladeread() method) then this method is also responsible for arranging that the -StatusBase object returned by this method +StatusBase object returned by this method is notified when the device is ready to be read.

          If there is no delay between triggering and being readable, -then this method must return a StatusBase +then this method must return a StatusBase object which is already completed.

          Returns:
          -

          status (StatusBase) – StatusBase object which will be marked +

          status (StatusBase) – StatusBase object which will be marked as complete when the device is ready to be read.

          @@ -409,7 +405,7 @@

          pcdsdevices.attenuator.FEESolidAttenuatorBlade
          -subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})
          +subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})

          diff --git a/master/generated/pcdsdevices.attenuator.FEESolidAttenuatorStates.html b/master/generated/pcdsdevices.attenuator.FEESolidAttenuatorStates.html index e8ccd2bde52..06334187d73 100644 --- a/master/generated/pcdsdevices.attenuator.FEESolidAttenuatorStates.html +++ b/master/generated/pcdsdevices.attenuator.FEESolidAttenuatorStates.html @@ -1,25 +1,23 @@ + + - pcdsdevices.attenuator.FEESolidAttenuatorStates — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.attenuator.FEESolidAttenuatorStates — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -
          - 8.5.1.dev30+gd6e98430 -
          @@ -114,6 +109,7 @@
        • pcdsdevices.ipm
        • pcdsdevices.jet
        • pcdsdevices.keithley
        • +
        • pcdsdevices.lakeshore
        • pcdsdevices.lamp_motion
        • pcdsdevices.lasers.btps
        • pcdsdevices.lasers.counters
        • @@ -341,14 +337,14 @@

          pcdsdevices.attenuator.FEESolidAttenuatorStates
          -configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]
          +configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]

          Configure the device for something during a run

          This default implementation allows the user to change any of the configuration_attrs. Subclasses might override this to perform additional input validation, cleanup, etc.

          Parameters:
          -

          d (dict) – The configuration dictionary. To specify the order that +

          d (dict) – The configuration dictionary. To specify the order that the changes should be made, use an OrderedDict.

          Returns:
          @@ -363,7 +359,7 @@

          pcdsdevices.attenuator.FEESolidAttenuatorStates
          -describe() OrderedDictType[str, Dict[str, Any]]
          +describe() OrderedDictType[str, Dict[str, Any]]

          Provide schema and meta-data for read().

          This keys in the OrderedDict this method returns must match the keys in the OrderedDict return by read().

          @@ -415,12 +411,12 @@

          pcdsdevices.attenuator.FEESolidAttenuatorStatesobj, which will be set to this instance.

          -
        • timeout (float, optional) – Maximum time to wait for the motion.

        • -
        • wait (bool, optional) – If True, do not continue until the move is complete.

        • +
        • timeout (float, optional) – Maximum time to wait for the motion.

        • +
        • wait (bool, optional) – If True, do not continue until the move is complete.

        • Returns:
          -

          moved_status (Status) – Status that will be marked as done when the motion is complete.

          +

          moved_status (Status) – Status that will be marked as done when the motion is complete.

          @@ -432,11 +428,11 @@

          pcdsdevices.attenuator.FEESolidAttenuatorStates
          Parameters:
            -
          • position (int or str) – The enumerate state or the corresponding integer.

          • +
          • position (int or str) – The enumerate state or the corresponding integer.

          • moved_cb (callable, optional) – Function to call at the end of motion. i.e. moved_cb(obj=self) will be called when move is complete.

          • -
          • timeout (int or float, optional) – Move timeout in seconds.

          • -
          • wait (bool, optional) – If True, do not return until the motion has completed.

          • +
          • timeout (int or float, optional) – Move timeout in seconds.

          • +
          • wait (bool, optional) – If True, do not return until the motion has completed.

          Returns:
          @@ -453,12 +449,12 @@

          pcdsdevices.attenuator.FEESolidAttenuatorStatesParameters:
          • position – Desired end position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • wait (bool, optional) – If True, wait for motion completion before returning. +

          • wait (bool, optional) – If True, wait for motion completion before returning. Defaults to False.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          @@ -472,7 +468,7 @@

          pcdsdevices.attenuator.FEESolidAttenuatorStates
          -read() OrderedDictType[str, Dict[str, Any]]
          +read() OrderedDictType[str, Dict[str, Any]]

          Read data from the device.

          This method is expected to be as instantaneous as possible, with any substantial acquisition time taken care of in @@ -495,7 +491,7 @@

          pcdsdevices.attenuator.FEESolidAttenuatorStates
          -read_configuration() OrderedDictType[str, Dict[str, Any]]
          +read_configuration() OrderedDictType[str, Dict[str, Any]]

          Dictionary mapping names to value dicts with keys: value, timestamp

          To control which fields are included, change the Component kinds on the device, or modify the configuration_attrs list.

          @@ -512,12 +508,12 @@

          pcdsdevices.attenuator.FEESolidAttenuatorStatesobj, which will be set to this instance.

          -
        • timeout (float, optional) – Maximum time to wait for the motion.

        • -
        • wait (bool, optional) – If True, do not continue until the move is complete.

        • +
        • timeout (float, optional) – Maximum time to wait for the motion.

        • +
        • wait (bool, optional) – If True, do not continue until the move is complete.

        • Returns:
          -

          moved_status (Status) – Status that will be marked as done when the motion is complete.

          +

          moved_status (Status) – Status that will be marked as done when the motion is complete.

          @@ -541,10 +537,10 @@

          pcdsdevices.attenuator.FEESolidAttenuatorStates
          Parameters:
            -
          • position (int or str) – The enumerate state or the corresponding integer.

          • +
          • position (int or str) – The enumerate state or the corresponding integer.

          • moved_cb (callable, optional) – Function to call at the end of motion. i.e. moved_cb(obj=self) will be called when move is complete.

          • -
          • timeout (int or float, optional) – Move timeout in seconds.

          • +
          • timeout (int or float, optional) – Move timeout in seconds.

          Returns:
          @@ -555,7 +551,7 @@

          pcdsdevices.attenuator.FEESolidAttenuatorStates
          -status() str
          +status() str

          Returns a str with the current pv values for the device.

          @@ -566,7 +562,7 @@

          pcdsdevices.attenuator.FEESolidAttenuatorStates
          -trigger() StatusBase
          +trigger() StatusBase

          Trigger the device and return status object.

          This method is responsible for implementing ‘trigger’ or ‘acquire’ functionality of this device.

          @@ -574,14 +570,14 @@

          pcdsdevices.attenuator.FEESolidAttenuatorStatesread() method) then this method is also responsible for arranging that the -StatusBase object returned by this method +StatusBase object returned by this method is notified when the device is ready to be read.

          If there is no delay between triggering and being readable, -then this method must return a StatusBase +then this method must return a StatusBase object which is already completed.

          Returns:
          -

          status (StatusBase) – StatusBase object which will be marked +

          status (StatusBase) – StatusBase object which will be marked as complete when the device is ready to be read.

          @@ -699,7 +695,7 @@

          pcdsdevices.attenuator.FEESolidAttenuatorStates
          -subscriptions: ClassVar[FrozenSet[str]] = frozenset({'_req_done', 'acq_done', 'done_moving', 'readback', 'start_moving', 'state'})
          +subscriptions: ClassVar[FrozenSet[str]] = frozenset({'_req_done', 'acq_done', 'done_moving', 'readback', 'start_moving', 'state'})
          diff --git a/master/generated/pcdsdevices.attenuator.FeeAtt.html b/master/generated/pcdsdevices.attenuator.FeeAtt.html index cde9477e23c..a0ec5ce35ce 100644 --- a/master/generated/pcdsdevices.attenuator.FeeAtt.html +++ b/master/generated/pcdsdevices.attenuator.FeeAtt.html @@ -1,25 +1,23 @@ + + - pcdsdevices.attenuator.FeeAtt — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.attenuator.FeeAtt — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -
          - 8.5.1.dev30+gd6e98430 -
          @@ -114,6 +109,7 @@
        • pcdsdevices.ipm
        • pcdsdevices.jet
        • pcdsdevices.keithley
        • +
        • pcdsdevices.lakeshore
        • pcdsdevices.lamp_motion
        • pcdsdevices.lasers.btps
        • pcdsdevices.lasers.counters
        • @@ -401,14 +397,14 @@

          pcdsdevices.attenuator.FeeAtt
          -configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]
          +configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]

          Configure the device for something during a run

          This default implementation allows the user to change any of the configuration_attrs. Subclasses might override this to perform additional input validation, cleanup, etc.

          Parameters:
          -

          d (dict) – The configuration dictionary. To specify the order that +

          d (dict) – The configuration dictionary. To specify the order that the changes should be made, use an OrderedDict.

          Returns:
          @@ -423,7 +419,7 @@

          pcdsdevices.attenuator.FeeAtt
          -describe() OrderedDictType[str, Dict[str, Any]]
          +describe() OrderedDictType[str, Dict[str, Any]]

          Provide schema and meta-data for read().

          This keys in the OrderedDict this method returns must match the keys in the OrderedDict return by read().

          @@ -454,7 +450,7 @@

          pcdsdevices.attenuator.FeeAtt
          -get_lightpath_state(use_cache: bool = True) LightpathState
          +get_lightpath_state(use_cache: bool = True) LightpathState

          Return the current LightpathState

          Returns:
          @@ -478,11 +474,11 @@

          pcdsdevices.attenuator.FeeAtt
          Parameters:
            -
          • position (float) – Position to move to

          • +
          • position (float) – Position to move to

          • moved_cb (callable) – Call this callback when movement has finished. This callback must accept one keyword argument: ‘obj’ which will be set to this positioner instance.

          • -
          • timeout (float, optional) – Maximum time to wait for the motion. If None, the default timeout +

          • timeout (float, optional) – Maximum time to wait for the motion. If None, the default timeout for this positioner is used.

          @@ -491,9 +487,9 @@

          pcdsdevices.attenuator.FeeAttRaises:
            -
          • TimeoutError – When motion takes longer than timeout

          • -
          • ValueError – On invalid positions

          • -
          • RuntimeError – If motion fails other than timing out, including when a move is +

          • TimeoutError – When motion takes longer than timeout

          • +
          • ValueError – On invalid positions

          • +
          • RuntimeError – If motion fails other than timing out, including when a move is attempted while another move is already in progress.

          @@ -508,12 +504,12 @@

          pcdsdevices.attenuator.FeeAttParameters:
          • position – Desired end position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • wait (bool, optional) – If True, wait for motion completion before returning. +

          • wait (bool, optional) – If True, wait for motion completion before returning. Defaults to False.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          @@ -535,13 +531,13 @@

          pcdsdevices.attenuator.FeeAtt
          Parameters:
            -
          • delta (float) – Desired change in position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • delta (float) – Desired change in position.

          • +
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • wait (bool, optional) – If True, wait for motion completion before returning. +

          • wait (bool, optional) – If True, wait for motion completion before returning. Defaults to False.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          @@ -555,7 +551,7 @@

          pcdsdevices.attenuator.FeeAtt
          -read() OrderedDictType[str, Dict[str, Any]]
          +read() OrderedDictType[str, Dict[str, Any]]

          Read data from the device.

          This method is expected to be as instantaneous as possible, with any substantial acquisition time taken care of in @@ -578,7 +574,7 @@

          pcdsdevices.attenuator.FeeAtt
          -read_configuration() OrderedDictType[str, Dict[str, Any]]
          +read_configuration() OrderedDictType[str, Dict[str, Any]]

          Dictionary mapping names to value dicts with keys: value, timestamp

          To control which fields are included, change the Component kinds on the device, or modify the configuration_attrs list.

          @@ -600,23 +596,23 @@

          pcdsdevices.attenuator.FeeAtt
          -set(new_position: Any, *, timeout: float | None = None, moved_cb: Callable | None = None, wait: bool = False) StatusBase
          +set(new_position: Any, *, timeout: float | None = None, moved_cb: Callable | None = None, wait: bool = False) StatusBase

          Set a value and return a Status object

          Parameters:
            -
          • new_position (object) – The input here is whatever the device requires (this +

          • new_position (object) – The input here is whatever the device requires (this should be over-ridden by the implementation. For example a motor would take a float, a shutter the strings {‘Open’, ‘Close’}, and a goineometer (h, k, l) tuples

          • -
          • timeout (float, optional) – Maximum time to wait for the motion. If None, the default timeout +

          • timeout (float, optional) – Maximum time to wait for the motion. If None, the default timeout for this positioner is used.

          • moved_cb (callable, optional) –

            Deprecated

            Call this callback when movement has finished. This callback must accept one keyword argument: ‘obj’ which will be set to this positioner instance.

          • -
          • wait (bool, optional) –

            Deprecated

            +
          • wait (bool, optional) –

            Deprecated

            If the method should block until the Status object reports it is done.

            Defaults to False

            @@ -651,7 +647,7 @@

            pcdsdevices.attenuator.FeeAtt
            -status() str
            +status() str

            Returns a str with the current pv values for the device.

          @@ -668,7 +664,7 @@

          pcdsdevices.attenuator.FeeAtt
          -trigger() StatusBase
          +trigger() StatusBase

          Trigger the device and return status object.

          This method is responsible for implementing ‘trigger’ or ‘acquire’ functionality of this device.

          @@ -676,14 +672,14 @@

          pcdsdevices.attenuator.FeeAttread() method) then this method is also responsible for arranging that the -StatusBase object returned by this method +StatusBase object returned by this method is notified when the device is ready to be read.

          If there is no delay between triggering and being readable, -then this method must return a StatusBase +then this method must return a StatusBase object which is already completed.

          Returns:
          -

          status (StatusBase) – StatusBase object which will be marked +

          status (StatusBase) – StatusBase object which will be marked as complete when the device is ready to be read.

          @@ -698,7 +694,7 @@

          pcdsdevices.attenuator.FeeAtt
          Parameters:
          -

          scale (float) – starting step size, default = 0.1

          +

          scale (float) – starting step size, default = 0.1

          @@ -710,12 +706,12 @@

          pcdsdevices.attenuator.FeeAtt
          Parameters:
            -
          • position (float) – Desired end position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • position (float) – Desired end position.

          • +
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • -
          • newline (bool, optional) – If True, inserts a newline after the updates.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • newline (bool, optional) – If True, inserts a newline after the updates.

          @@ -728,12 +724,12 @@

          pcdsdevices.attenuator.FeeAtt
          Parameters:
            -
          • delta (float) – Desired change in position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • delta (float) – Desired change in position.

          • +
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • -
          • newline (bool, optional) – If True, inserts a newline after the updates.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • newline (bool, optional) – If True, inserts a newline after the updates.

          @@ -884,7 +880,7 @@

          pcdsdevices.attenuator.FeeAtt
          -subscriptions: ClassVar[FrozenSet[str]] = frozenset({'_req_done', 'acq_done', 'done_moving', 'readback', 'start_moving', 'state'})
          +subscriptions: ClassVar[FrozenSet[str]] = frozenset({'_req_done', 'acq_done', 'done_moving', 'readback', 'start_moving', 'state'})
          diff --git a/master/generated/pcdsdevices.attenuator.FeeFilter.html b/master/generated/pcdsdevices.attenuator.FeeFilter.html index e2aab610a4a..de560e93770 100644 --- a/master/generated/pcdsdevices.attenuator.FeeFilter.html +++ b/master/generated/pcdsdevices.attenuator.FeeFilter.html @@ -1,25 +1,23 @@ + + - pcdsdevices.attenuator.FeeFilter — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.attenuator.FeeFilter — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -
          - 8.5.1.dev30+gd6e98430 -
          @@ -114,6 +109,7 @@
        • pcdsdevices.ipm
        • pcdsdevices.jet
        • pcdsdevices.keithley
        • +
        • pcdsdevices.lakeshore
        • pcdsdevices.lamp_motion
        • pcdsdevices.lasers.btps
        • pcdsdevices.lasers.counters
        • @@ -285,14 +281,14 @@

          pcdsdevices.attenuator.FeeFilter
          -configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]
          +configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]

          Configure the device for something during a run

          This default implementation allows the user to change any of the configuration_attrs. Subclasses might override this to perform additional input validation, cleanup, etc.

          Parameters:
          -

          d (dict) – The configuration dictionary. To specify the order that +

          d (dict) – The configuration dictionary. To specify the order that the changes should be made, use an OrderedDict.

          Returns:
          @@ -307,7 +303,7 @@

          pcdsdevices.attenuator.FeeFilter
          -describe() OrderedDictType[str, Dict[str, Any]]
          +describe() OrderedDictType[str, Dict[str, Any]]

          Provide schema and meta-data for read().

          This keys in the OrderedDict this method returns must match the keys in the OrderedDict return by read().

          @@ -359,12 +355,12 @@

          pcdsdevices.attenuator.FeeFilterobj, which will be set to this instance.

          -
        • timeout (float, optional) – Maximum time to wait for the motion.

        • -
        • wait (bool, optional) – If True, do not continue until the move is complete.

        • +
        • timeout (float, optional) – Maximum time to wait for the motion.

        • +
        • wait (bool, optional) – If True, do not continue until the move is complete.

        • Returns:
          -

          moved_status (Status) – Status that will be marked as done when the motion is complete.

          +

          moved_status (Status) – Status that will be marked as done when the motion is complete.

          @@ -376,11 +372,11 @@

          pcdsdevices.attenuator.FeeFilter
          Parameters:
            -
          • position (int or str) – The enumerate state or the corresponding integer.

          • +
          • position (int or str) – The enumerate state or the corresponding integer.

          • moved_cb (callable, optional) – Function to call at the end of motion. i.e. moved_cb(obj=self) will be called when move is complete.

          • -
          • timeout (int or float, optional) – Move timeout in seconds.

          • -
          • wait (bool, optional) – If True, do not return until the motion has completed.

          • +
          • timeout (int or float, optional) – Move timeout in seconds.

          • +
          • wait (bool, optional) – If True, do not return until the motion has completed.

          Returns:
          @@ -397,12 +393,12 @@

          pcdsdevices.attenuator.FeeFilterParameters:
          • position – Desired end position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • wait (bool, optional) – If True, wait for motion completion before returning. +

          • wait (bool, optional) – If True, wait for motion completion before returning. Defaults to False.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          @@ -416,7 +412,7 @@

          pcdsdevices.attenuator.FeeFilter
          -read() OrderedDictType[str, Dict[str, Any]]
          +read() OrderedDictType[str, Dict[str, Any]]

          Read data from the device.

          This method is expected to be as instantaneous as possible, with any substantial acquisition time taken care of in @@ -439,7 +435,7 @@

          pcdsdevices.attenuator.FeeFilter
          -read_configuration() OrderedDictType[str, Dict[str, Any]]
          +read_configuration() OrderedDictType[str, Dict[str, Any]]

          Dictionary mapping names to value dicts with keys: value, timestamp

          To control which fields are included, change the Component kinds on the device, or modify the configuration_attrs list.

          @@ -456,12 +452,12 @@

          pcdsdevices.attenuator.FeeFilterobj, which will be set to this instance.

          -
        • timeout (float, optional) – Maximum time to wait for the motion.

        • -
        • wait (bool, optional) – If True, do not continue until the move is complete.

        • +
        • timeout (float, optional) – Maximum time to wait for the motion.

        • +
        • wait (bool, optional) – If True, do not continue until the move is complete.

        • Returns:
          -

          moved_status (Status) – Status that will be marked as done when the motion is complete.

          +

          moved_status (Status) – Status that will be marked as done when the motion is complete.

          @@ -485,10 +481,10 @@

          pcdsdevices.attenuator.FeeFilter
          Parameters:
            -
          • position (int or str) – The enumerate state or the corresponding integer.

          • +
          • position (int or str) – The enumerate state or the corresponding integer.

          • moved_cb (callable, optional) – Function to call at the end of motion. i.e. moved_cb(obj=self) will be called when move is complete.

          • -
          • timeout (int or float, optional) – Move timeout in seconds.

          • +
          • timeout (int or float, optional) – Move timeout in seconds.

          Returns:
          @@ -504,7 +500,7 @@

          pcdsdevices.attenuator.FeeFilter
          -trigger() StatusBase
          +trigger() StatusBase

          Trigger the device and return status object.

          This method is responsible for implementing ‘trigger’ or ‘acquire’ functionality of this device.

          @@ -512,14 +508,14 @@

          pcdsdevices.attenuator.FeeFilterread() method) then this method is also responsible for arranging that the -StatusBase object returned by this method +StatusBase object returned by this method is notified when the device is ready to be read.

          If there is no delay between triggering and being readable, -then this method must return a StatusBase +then this method must return a StatusBase object which is already completed.

          Returns:
          -

          status (StatusBase) – StatusBase object which will be marked +

          status (StatusBase) – StatusBase object which will be marked as complete when the device is ready to be read.

          @@ -637,7 +633,7 @@

          pcdsdevices.attenuator.FeeFilter
          -subscriptions: ClassVar[FrozenSet[str]] = frozenset({'_req_done', 'acq_done', 'done_moving', 'readback', 'start_moving', 'state'})
          +subscriptions: ClassVar[FrozenSet[str]] = frozenset({'_req_done', 'acq_done', 'done_moving', 'readback', 'start_moving', 'state'})
          diff --git a/master/generated/pcdsdevices.attenuator.Filter.html b/master/generated/pcdsdevices.attenuator.Filter.html index 318dcc20433..7b76c11fd46 100644 --- a/master/generated/pcdsdevices.attenuator.Filter.html +++ b/master/generated/pcdsdevices.attenuator.Filter.html @@ -1,25 +1,23 @@ + + - pcdsdevices.attenuator.Filter — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.attenuator.Filter — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -
          - 8.5.1.dev30+gd6e98430 -
          @@ -114,6 +109,7 @@
        • pcdsdevices.ipm
        • pcdsdevices.jet
        • pcdsdevices.keithley
        • +
        • pcdsdevices.lakeshore
        • pcdsdevices.lamp_motion
        • pcdsdevices.lasers.btps
        • pcdsdevices.lasers.counters
        • @@ -313,14 +309,14 @@

          pcdsdevices.attenuator.Filter
          -configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]
          +configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]

          Configure the device for something during a run

          This default implementation allows the user to change any of the configuration_attrs. Subclasses might override this to perform additional input validation, cleanup, etc.

          Parameters:
          -

          d (dict) – The configuration dictionary. To specify the order that +

          d (dict) – The configuration dictionary. To specify the order that the changes should be made, use an OrderedDict.

          Returns:
          @@ -335,7 +331,7 @@

          pcdsdevices.attenuator.Filter
          -describe() OrderedDictType[str, Dict[str, Any]]
          +describe() OrderedDictType[str, Dict[str, Any]]

          Provide schema and meta-data for read().

          This keys in the OrderedDict this method returns must match the keys in the OrderedDict return by read().

          @@ -387,12 +383,12 @@

          pcdsdevices.attenuator.Filterobj, which will be set to this instance.

          -
        • timeout (float, optional) – Maximum time to wait for the motion.

        • -
        • wait (bool, optional) – If True, do not continue until the move is complete.

        • +
        • timeout (float, optional) – Maximum time to wait for the motion.

        • +
        • wait (bool, optional) – If True, do not continue until the move is complete.

        • Returns:
          -

          moved_status (Status) – Status that will be marked as done when the motion is complete.

          +

          moved_status (Status) – Status that will be marked as done when the motion is complete.

          @@ -404,11 +400,11 @@

          pcdsdevices.attenuator.Filter
          Parameters:
            -
          • position (int or str) – The enumerate state or the corresponding integer.

          • +
          • position (int or str) – The enumerate state or the corresponding integer.

          • moved_cb (callable, optional) – Function to call at the end of motion. i.e. moved_cb(obj=self) will be called when move is complete.

          • -
          • timeout (int or float, optional) – Move timeout in seconds.

          • -
          • wait (bool, optional) – If True, do not return until the motion has completed.

          • +
          • timeout (int or float, optional) – Move timeout in seconds.

          • +
          • wait (bool, optional) – If True, do not return until the motion has completed.

          Returns:
          @@ -425,12 +421,12 @@

          pcdsdevices.attenuator.FilterParameters:
          • position – Desired end position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • wait (bool, optional) – If True, wait for motion completion before returning. +

          • wait (bool, optional) – If True, wait for motion completion before returning. Defaults to False.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          @@ -444,7 +440,7 @@

          pcdsdevices.attenuator.Filter
          -read() OrderedDictType[str, Dict[str, Any]]
          +read() OrderedDictType[str, Dict[str, Any]]

          Read data from the device.

          This method is expected to be as instantaneous as possible, with any substantial acquisition time taken care of in @@ -467,7 +463,7 @@

          pcdsdevices.attenuator.Filter
          -read_configuration() OrderedDictType[str, Dict[str, Any]]
          +read_configuration() OrderedDictType[str, Dict[str, Any]]

          Dictionary mapping names to value dicts with keys: value, timestamp

          To control which fields are included, change the Component kinds on the device, or modify the configuration_attrs list.

          @@ -484,12 +480,12 @@

          pcdsdevices.attenuator.Filterobj, which will be set to this instance.

          -
        • timeout (float, optional) – Maximum time to wait for the motion.

        • -
        • wait (bool, optional) – If True, do not continue until the move is complete.

        • +
        • timeout (float, optional) – Maximum time to wait for the motion.

        • +
        • wait (bool, optional) – If True, do not continue until the move is complete.

        • Returns:
          -

          moved_status (Status) – Status that will be marked as done when the motion is complete.

          +

          moved_status (Status) – Status that will be marked as done when the motion is complete.

          @@ -513,10 +509,10 @@

          pcdsdevices.attenuator.Filter
          Parameters:
            -
          • position (int or str) – The enumerate state or the corresponding integer.

          • +
          • position (int or str) – The enumerate state or the corresponding integer.

          • moved_cb (callable, optional) – Function to call at the end of motion. i.e. moved_cb(obj=self) will be called when move is complete.

          • -
          • timeout (int or float, optional) – Move timeout in seconds.

          • +
          • timeout (int or float, optional) – Move timeout in seconds.

          Returns:
          @@ -532,7 +528,7 @@

          pcdsdevices.attenuator.Filter
          -trigger() StatusBase
          +trigger() StatusBase

          Trigger the device and return status object.

          This method is responsible for implementing ‘trigger’ or ‘acquire’ functionality of this device.

          @@ -540,14 +536,14 @@

          pcdsdevices.attenuator.Filterread() method) then this method is also responsible for arranging that the -StatusBase object returned by this method +StatusBase object returned by this method is notified when the device is ready to be read.

          If there is no delay between triggering and being readable, -then this method must return a StatusBase +then this method must return a StatusBase object which is already completed.

          Returns:
          -

          status (StatusBase) – StatusBase object which will be marked +

          status (StatusBase) – StatusBase object which will be marked as complete when the device is ready to be read.

          @@ -665,7 +661,7 @@

          pcdsdevices.attenuator.Filter
          -subscriptions: ClassVar[FrozenSet[str]] = frozenset({'_req_done', 'acq_done', 'done_moving', 'readback', 'start_moving', 'state'})
          +subscriptions: ClassVar[FrozenSet[str]] = frozenset({'_req_done', 'acq_done', 'done_moving', 'readback', 'start_moving', 'state'})
          diff --git a/master/generated/pcdsdevices.attenuator.GasAttenuator.html b/master/generated/pcdsdevices.attenuator.GasAttenuator.html index 5644ef64f06..890577e7940 100644 --- a/master/generated/pcdsdevices.attenuator.GasAttenuator.html +++ b/master/generated/pcdsdevices.attenuator.GasAttenuator.html @@ -1,25 +1,23 @@ + + - pcdsdevices.attenuator.GasAttenuator — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.attenuator.GasAttenuator — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -
          - 8.5.1.dev30+gd6e98430 -
          @@ -114,6 +109,7 @@
        • pcdsdevices.ipm
        • pcdsdevices.jet
        • pcdsdevices.keithley
        • +
        • pcdsdevices.lakeshore
        • pcdsdevices.lamp_motion
        • pcdsdevices.lasers.btps
        • pcdsdevices.lasers.counters
        • @@ -228,8 +224,8 @@

          pcdsdevices.attenuator.GasAttenuator
          Parameters:
            -
          • prefix (str) – Full Gas Attenuator base PV.

          • -
          • name (str) – Alias for the Gas Attenuator.

          • +
          • prefix (str) – Full Gas Attenuator base PV.

          • +
          • name (str) – Alias for the Gas Attenuator.

          @@ -260,14 +256,14 @@

          pcdsdevices.attenuator.GasAttenuatorMethods

          -configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]
          +configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]

          Configure the device for something during a run

          This default implementation allows the user to change any of the configuration_attrs. Subclasses might override this to perform additional input validation, cleanup, etc.

          Parameters:
          -

          d (dict) – The configuration dictionary. To specify the order that +

          d (dict) – The configuration dictionary. To specify the order that the changes should be made, use an OrderedDict.

          Returns:
          @@ -282,7 +278,7 @@

          pcdsdevices.attenuator.GasAttenuator
          -describe() OrderedDictType[str, Dict[str, Any]]
          +describe() OrderedDictType[str, Dict[str, Any]]

          Provide schema and meta-data for read().

          This keys in the OrderedDict this method returns must match the keys in the OrderedDict return by read().

          @@ -312,7 +308,7 @@

          pcdsdevices.attenuator.GasAttenuator
          -read() OrderedDictType[str, Dict[str, Any]]
          +read() OrderedDictType[str, Dict[str, Any]]

          Read data from the device.

          This method is expected to be as instantaneous as possible, with any substantial acquisition time taken care of in @@ -335,7 +331,7 @@

          pcdsdevices.attenuator.GasAttenuator
          -read_configuration() OrderedDictType[str, Dict[str, Any]]
          +read_configuration() OrderedDictType[str, Dict[str, Any]]

          Dictionary mapping names to value dicts with keys: value, timestamp

          To control which fields are included, change the Component kinds on the device, or modify the configuration_attrs list.

          @@ -351,7 +347,7 @@

          pcdsdevices.attenuator.GasAttenuator
          -status() str
          +status() str

          Returns a str with the current pv values for the device.

          @@ -368,7 +364,7 @@

          pcdsdevices.attenuator.GasAttenuator
          -trigger() StatusBase
          +trigger() StatusBase

          Trigger the device and return status object.

          This method is responsible for implementing ‘trigger’ or ‘acquire’ functionality of this device.

          @@ -376,14 +372,14 @@

          pcdsdevices.attenuator.GasAttenuatorread() method) then this method is also responsible for arranging that the -StatusBase object returned by this method +StatusBase object returned by this method is notified when the device is ready to be read.

          If there is no delay between triggering and being readable, -then this method must return a StatusBase +then this method must return a StatusBase object which is already completed.

          Returns:
          -

          status (StatusBase) – StatusBase object which will be marked +

          status (StatusBase) – StatusBase object which will be marked as complete when the device is ready to be read.

          @@ -412,7 +408,7 @@

          pcdsdevices.attenuator.GasAttenuator
          -subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})
          +subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})

          diff --git a/master/generated/pcdsdevices.attenuator.GattApertureX.html b/master/generated/pcdsdevices.attenuator.GattApertureX.html index aa25a5e5598..ddf18c8b799 100644 --- a/master/generated/pcdsdevices.attenuator.GattApertureX.html +++ b/master/generated/pcdsdevices.attenuator.GattApertureX.html @@ -1,25 +1,23 @@ + + - pcdsdevices.attenuator.GattApertureX — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.attenuator.GattApertureX — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -
          - 8.5.1.dev30+gd6e98430 -
          @@ -114,6 +109,7 @@
        • pcdsdevices.ipm
        • pcdsdevices.jet
        • pcdsdevices.keithley
        • +
        • pcdsdevices.lakeshore
        • pcdsdevices.lamp_motion
        • pcdsdevices.lasers.btps
        • pcdsdevices.lasers.counters
        • @@ -357,14 +353,14 @@

          pcdsdevices.attenuator.GattApertureX
          -configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]
          +configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]

          Configure the device for something during a run

          This default implementation allows the user to change any of the configuration_attrs. Subclasses might override this to perform additional input validation, cleanup, etc.

          Parameters:
          -

          d (dict) – The configuration dictionary. To specify the order that +

          d (dict) – The configuration dictionary. To specify the order that the changes should be made, use an OrderedDict.

          Returns:
          @@ -379,7 +375,7 @@

          pcdsdevices.attenuator.GattApertureX
          -describe() OrderedDictType[str, Dict[str, Any]]
          +describe() OrderedDictType[str, Dict[str, Any]]

          Provide schema and meta-data for read().

          This keys in the OrderedDict this method returns must match the keys in the OrderedDict return by read().

          @@ -431,12 +427,12 @@

          pcdsdevices.attenuator.GattApertureXobj, which will be set to this instance.

          -
        • timeout (float, optional) – Maximum time to wait for the motion.

        • -
        • wait (bool, optional) – If True, do not continue until the move is complete.

        • +
        • timeout (float, optional) – Maximum time to wait for the motion.

        • +
        • wait (bool, optional) – If True, do not continue until the move is complete.

        • Returns:
          -

          moved_status (Status) – Status that will be marked as done when the motion is complete.

          +

          moved_status (Status) – Status that will be marked as done when the motion is complete.

          @@ -448,11 +444,11 @@

          pcdsdevices.attenuator.GattApertureX
          Parameters:
            -
          • position (int or str) – The enumerate state or the corresponding integer.

          • +
          • position (int or str) – The enumerate state or the corresponding integer.

          • moved_cb (callable, optional) – Function to call at the end of motion. i.e. moved_cb(obj=self) will be called when move is complete.

          • -
          • timeout (int or float, optional) – Move timeout in seconds.

          • -
          • wait (bool, optional) – If True, do not return until the motion has completed.

          • +
          • timeout (int or float, optional) – Move timeout in seconds.

          • +
          • wait (bool, optional) – If True, do not return until the motion has completed.

          Returns:
          @@ -469,12 +465,12 @@

          pcdsdevices.attenuator.GattApertureXParameters:
          • position – Desired end position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • wait (bool, optional) – If True, wait for motion completion before returning. +

          • wait (bool, optional) – If True, wait for motion completion before returning. Defaults to False.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          @@ -488,7 +484,7 @@

          pcdsdevices.attenuator.GattApertureX
          -read() OrderedDictType[str, Dict[str, Any]]
          +read() OrderedDictType[str, Dict[str, Any]]

          Read data from the device.

          This method is expected to be as instantaneous as possible, with any substantial acquisition time taken care of in @@ -511,7 +507,7 @@

          pcdsdevices.attenuator.GattApertureX
          -read_configuration() OrderedDictType[str, Dict[str, Any]]
          +read_configuration() OrderedDictType[str, Dict[str, Any]]

          Dictionary mapping names to value dicts with keys: value, timestamp

          To control which fields are included, change the Component kinds on the device, or modify the configuration_attrs list.

          @@ -528,12 +524,12 @@

          pcdsdevices.attenuator.GattApertureXobj, which will be set to this instance.

          -
        • timeout (float, optional) – Maximum time to wait for the motion.

        • -
        • wait (bool, optional) – If True, do not continue until the move is complete.

        • +
        • timeout (float, optional) – Maximum time to wait for the motion.

        • +
        • wait (bool, optional) – If True, do not continue until the move is complete.

        • Returns:
          -

          moved_status (Status) – Status that will be marked as done when the motion is complete.

          +

          moved_status (Status) – Status that will be marked as done when the motion is complete.

          @@ -557,10 +553,10 @@

          pcdsdevices.attenuator.GattApertureX
          Parameters:
            -
          • position (int or str) – The enumerate state or the corresponding integer.

          • +
          • position (int or str) – The enumerate state or the corresponding integer.

          • moved_cb (callable, optional) – Function to call at the end of motion. i.e. moved_cb(obj=self) will be called when move is complete.

          • -
          • timeout (int or float, optional) – Move timeout in seconds.

          • +
          • timeout (int or float, optional) – Move timeout in seconds.

          Returns:
          @@ -571,7 +567,7 @@

          pcdsdevices.attenuator.GattApertureX
          -status() str
          +status() str

          Returns a str with the current pv values for the device.

          @@ -582,7 +578,7 @@

          pcdsdevices.attenuator.GattApertureX
          -trigger() StatusBase
          +trigger() StatusBase

          Trigger the device and return status object.

          This method is responsible for implementing ‘trigger’ or ‘acquire’ functionality of this device.

          @@ -590,14 +586,14 @@

          pcdsdevices.attenuator.GattApertureXread() method) then this method is also responsible for arranging that the -StatusBase object returned by this method +StatusBase object returned by this method is notified when the device is ready to be read.

          If there is no delay between triggering and being readable, -then this method must return a StatusBase +then this method must return a StatusBase object which is already completed.

          Returns:
          -

          status (StatusBase) – StatusBase object which will be marked +

          status (StatusBase) – StatusBase object which will be marked as complete when the device is ready to be read.

          @@ -715,7 +711,7 @@

          pcdsdevices.attenuator.GattApertureX
          -subscriptions: ClassVar[FrozenSet[str]] = frozenset({'_req_done', 'acq_done', 'done_moving', 'readback', 'start_moving', 'state'})
          +subscriptions: ClassVar[FrozenSet[str]] = frozenset({'_req_done', 'acq_done', 'done_moving', 'readback', 'start_moving', 'state'})
          diff --git a/master/generated/pcdsdevices.attenuator.GattApertureY.html b/master/generated/pcdsdevices.attenuator.GattApertureY.html index b8bfce8e0f3..4eac5fa5f2b 100644 --- a/master/generated/pcdsdevices.attenuator.GattApertureY.html +++ b/master/generated/pcdsdevices.attenuator.GattApertureY.html @@ -1,25 +1,23 @@ + + - pcdsdevices.attenuator.GattApertureY — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.attenuator.GattApertureY — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -
          - 8.5.1.dev30+gd6e98430 -
          @@ -114,6 +109,7 @@
        • pcdsdevices.ipm
        • pcdsdevices.jet
        • pcdsdevices.keithley
        • +
        • pcdsdevices.lakeshore
        • pcdsdevices.lamp_motion
        • pcdsdevices.lasers.btps
        • pcdsdevices.lasers.counters
        • @@ -357,14 +353,14 @@

          pcdsdevices.attenuator.GattApertureY
          -configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]
          +configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]

          Configure the device for something during a run

          This default implementation allows the user to change any of the configuration_attrs. Subclasses might override this to perform additional input validation, cleanup, etc.

          Parameters:
          -

          d (dict) – The configuration dictionary. To specify the order that +

          d (dict) – The configuration dictionary. To specify the order that the changes should be made, use an OrderedDict.

          Returns:
          @@ -379,7 +375,7 @@

          pcdsdevices.attenuator.GattApertureY
          -describe() OrderedDictType[str, Dict[str, Any]]
          +describe() OrderedDictType[str, Dict[str, Any]]

          Provide schema and meta-data for read().

          This keys in the OrderedDict this method returns must match the keys in the OrderedDict return by read().

          @@ -431,12 +427,12 @@

          pcdsdevices.attenuator.GattApertureYobj, which will be set to this instance.

          -
        • timeout (float, optional) – Maximum time to wait for the motion.

        • -
        • wait (bool, optional) – If True, do not continue until the move is complete.

        • +
        • timeout (float, optional) – Maximum time to wait for the motion.

        • +
        • wait (bool, optional) – If True, do not continue until the move is complete.

        • Returns:
          -

          moved_status (Status) – Status that will be marked as done when the motion is complete.

          +

          moved_status (Status) – Status that will be marked as done when the motion is complete.

          @@ -448,11 +444,11 @@

          pcdsdevices.attenuator.GattApertureY
          Parameters:
            -
          • position (int or str) – The enumerate state or the corresponding integer.

          • +
          • position (int or str) – The enumerate state or the corresponding integer.

          • moved_cb (callable, optional) – Function to call at the end of motion. i.e. moved_cb(obj=self) will be called when move is complete.

          • -
          • timeout (int or float, optional) – Move timeout in seconds.

          • -
          • wait (bool, optional) – If True, do not return until the motion has completed.

          • +
          • timeout (int or float, optional) – Move timeout in seconds.

          • +
          • wait (bool, optional) – If True, do not return until the motion has completed.

          Returns:
          @@ -469,12 +465,12 @@

          pcdsdevices.attenuator.GattApertureYParameters:
          • position – Desired end position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • wait (bool, optional) – If True, wait for motion completion before returning. +

          • wait (bool, optional) – If True, wait for motion completion before returning. Defaults to False.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          @@ -488,7 +484,7 @@

          pcdsdevices.attenuator.GattApertureY
          -read() OrderedDictType[str, Dict[str, Any]]
          +read() OrderedDictType[str, Dict[str, Any]]

          Read data from the device.

          This method is expected to be as instantaneous as possible, with any substantial acquisition time taken care of in @@ -511,7 +507,7 @@

          pcdsdevices.attenuator.GattApertureY
          -read_configuration() OrderedDictType[str, Dict[str, Any]]
          +read_configuration() OrderedDictType[str, Dict[str, Any]]

          Dictionary mapping names to value dicts with keys: value, timestamp

          To control which fields are included, change the Component kinds on the device, or modify the configuration_attrs list.

          @@ -528,12 +524,12 @@

          pcdsdevices.attenuator.GattApertureYobj, which will be set to this instance.

          -
        • timeout (float, optional) – Maximum time to wait for the motion.

        • -
        • wait (bool, optional) – If True, do not continue until the move is complete.

        • +
        • timeout (float, optional) – Maximum time to wait for the motion.

        • +
        • wait (bool, optional) – If True, do not continue until the move is complete.

        • Returns:
          -

          moved_status (Status) – Status that will be marked as done when the motion is complete.

          +

          moved_status (Status) – Status that will be marked as done when the motion is complete.

          @@ -557,10 +553,10 @@

          pcdsdevices.attenuator.GattApertureY
          Parameters:
            -
          • position (int or str) – The enumerate state or the corresponding integer.

          • +
          • position (int or str) – The enumerate state or the corresponding integer.

          • moved_cb (callable, optional) – Function to call at the end of motion. i.e. moved_cb(obj=self) will be called when move is complete.

          • -
          • timeout (int or float, optional) – Move timeout in seconds.

          • +
          • timeout (int or float, optional) – Move timeout in seconds.

          Returns:
          @@ -571,7 +567,7 @@

          pcdsdevices.attenuator.GattApertureY
          -status() str
          +status() str

          Returns a str with the current pv values for the device.

          @@ -582,7 +578,7 @@

          pcdsdevices.attenuator.GattApertureY
          -trigger() StatusBase
          +trigger() StatusBase

          Trigger the device and return status object.

          This method is responsible for implementing ‘trigger’ or ‘acquire’ functionality of this device.

          @@ -590,14 +586,14 @@

          pcdsdevices.attenuator.GattApertureYread() method) then this method is also responsible for arranging that the -StatusBase object returned by this method +StatusBase object returned by this method is notified when the device is ready to be read.

          If there is no delay between triggering and being readable, -then this method must return a StatusBase +then this method must return a StatusBase object which is already completed.

          Returns:
          -

          status (StatusBase) – StatusBase object which will be marked +

          status (StatusBase) – StatusBase object which will be marked as complete when the device is ready to be read.

          @@ -715,7 +711,7 @@

          pcdsdevices.attenuator.GattApertureY
          -subscriptions: ClassVar[FrozenSet[str]] = frozenset({'_req_done', 'acq_done', 'done_moving', 'readback', 'start_moving', 'state'})
          +subscriptions: ClassVar[FrozenSet[str]] = frozenset({'_req_done', 'acq_done', 'done_moving', 'readback', 'start_moving', 'state'})
          diff --git a/master/generated/pcdsdevices.attenuator.SXRGasAtt.html b/master/generated/pcdsdevices.attenuator.SXRGasAtt.html index 7a40f87bd60..4d3a33f45f2 100644 --- a/master/generated/pcdsdevices.attenuator.SXRGasAtt.html +++ b/master/generated/pcdsdevices.attenuator.SXRGasAtt.html @@ -1,25 +1,23 @@ + + - pcdsdevices.attenuator.SXRGasAtt — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.attenuator.SXRGasAtt — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -
          - 8.5.1.dev30+gd6e98430 -
          @@ -114,6 +109,7 @@
        • pcdsdevices.ipm
        • pcdsdevices.jet
        • pcdsdevices.keithley
        • +
        • pcdsdevices.lakeshore
        • pcdsdevices.lamp_motion
        • pcdsdevices.lasers.btps
        • pcdsdevices.lasers.counters
        • @@ -353,14 +349,14 @@

          pcdsdevices.attenuator.SXRGasAttMethods

          -configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]
          +configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]

          Configure the device for something during a run

          This default implementation allows the user to change any of the configuration_attrs. Subclasses might override this to perform additional input validation, cleanup, etc.

          Parameters:
          -

          d (dict) – The configuration dictionary. To specify the order that +

          d (dict) – The configuration dictionary. To specify the order that the changes should be made, use an OrderedDict.

          Returns:
          @@ -375,7 +371,7 @@

          pcdsdevices.attenuator.SXRGasAtt
          -describe() OrderedDictType[str, Dict[str, Any]]
          +describe() OrderedDictType[str, Dict[str, Any]]

          Provide schema and meta-data for read().

          This keys in the OrderedDict this method returns must match the keys in the OrderedDict return by read().

          @@ -405,7 +401,7 @@

          pcdsdevices.attenuator.SXRGasAtt
          -read() OrderedDictType[str, Dict[str, Any]]
          +read() OrderedDictType[str, Dict[str, Any]]

          Read data from the device.

          This method is expected to be as instantaneous as possible, with any substantial acquisition time taken care of in @@ -428,7 +424,7 @@

          pcdsdevices.attenuator.SXRGasAtt
          -read_configuration() OrderedDictType[str, Dict[str, Any]]
          +read_configuration() OrderedDictType[str, Dict[str, Any]]

          Dictionary mapping names to value dicts with keys: value, timestamp

          To control which fields are included, change the Component kinds on the device, or modify the configuration_attrs list.

          @@ -449,10 +445,10 @@

          pcdsdevices.attenuator.SXRGasAtt
          Parameters:
            -
          • mode (str, either "PMPS" or "Local")

          • +
          • mode (str, either "PMPS" or "Local")

          • attenuator. (Mode for)

          • -
          • control_type (str, optional) – Set control type in “Local” mode, either “transmission” or “pressure” control. The default is ‘transmission’.

          • -
          • gas_type (str, optional) – Change gas type to “N2” or “Ar”. The default is None.If None is passed the attenuator uses the current gas.

          • +
          • control_type (str, optional) – Set control type in “Local” mode, either “transmission” or “pressure” control. The default is ‘transmission’.

          • +
          • gas_type (str, optional) – Change gas type to “N2” or “Ar”. The default is None.If None is passed the attenuator uses the current gas.

          @@ -460,13 +456,13 @@

          pcdsdevices.attenuator.SXRGasAtt
          -stage_group_instances() Iterator[OphydObject]
          +stage_group_instances() Iterator[OphydObject]

          Yields an iterator of subdevices that should be staged.

          -status() str
          +status() str

          Returns a str with the current pv values for the device.

          @@ -483,7 +479,7 @@

          pcdsdevices.attenuator.SXRGasAtt
          -trigger() StatusBase
          +trigger() StatusBase

          Trigger the device and return status object.

          This method is responsible for implementing ‘trigger’ or ‘acquire’ functionality of this device.

          @@ -491,14 +487,14 @@

          pcdsdevices.attenuator.SXRGasAttread() method) then this method is also responsible for arranging that the -StatusBase object returned by this method +StatusBase object returned by this method is notified when the device is ready to be read.

          If there is no delay between triggering and being readable, -then this method must return a StatusBase +then this method must return a StatusBase object which is already completed.

          Returns:
          -

          status (StatusBase) – StatusBase object which will be marked +

          status (StatusBase) – StatusBase object which will be marked as complete when the device is ready to be read.

          @@ -527,17 +523,17 @@

          pcdsdevices.attenuator.SXRGasAtt
          -needs_parent: list[type[OphydObject]] = [<class 'ophyd.signal.AttributeSignal'>, <class 'ophyd.signal.DerivedSignal'>, <class 'ophyd.areadetector.plugins.PluginBase'>, <class 'ophyd.pseudopos.PseudoSingle'>, <class 'pcdsdevices.signal.PVStateSignal'>, <class 'pcdsdevices.signal.AggregateSignal'>]
          +needs_parent: list[type[OphydObject]] = [<class 'ophyd.signal.AttributeSignal'>, <class 'ophyd.signal.DerivedSignal'>, <class 'ophyd.areadetector.plugins.PluginBase'>, <class 'ophyd.pseudopos.PseudoSingle'>, <class 'pcdsdevices.signal.PVStateSignal'>, <class 'pcdsdevices.signal.AggregateSignal'>]

          -stage_group: list[Component] = None
          +stage_group: list[Component] = None
          -subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})
          +subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})

          diff --git a/master/generated/pcdsdevices.attenuator.SXRLadderAttenuatorBlade.html b/master/generated/pcdsdevices.attenuator.SXRLadderAttenuatorBlade.html index dbb5460e9bb..185f90eb452 100644 --- a/master/generated/pcdsdevices.attenuator.SXRLadderAttenuatorBlade.html +++ b/master/generated/pcdsdevices.attenuator.SXRLadderAttenuatorBlade.html @@ -1,25 +1,23 @@ + + - pcdsdevices.attenuator.SXRLadderAttenuatorBlade — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.attenuator.SXRLadderAttenuatorBlade — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -
          - 8.5.1.dev30+gd6e98430 -
          @@ -114,6 +109,7 @@
        • pcdsdevices.ipm
        • pcdsdevices.jet
        • pcdsdevices.keithley
        • +
        • pcdsdevices.lakeshore
        • pcdsdevices.lamp_motion
        • pcdsdevices.lasers.btps
        • pcdsdevices.lasers.counters
        • @@ -257,14 +253,14 @@

          pcdsdevices.attenuator.SXRLadderAttenuatorBladeMethods

          -configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]
          +configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]

          Configure the device for something during a run

          This default implementation allows the user to change any of the configuration_attrs. Subclasses might override this to perform additional input validation, cleanup, etc.

          Parameters:
          -

          d (dict) – The configuration dictionary. To specify the order that +

          d (dict) – The configuration dictionary. To specify the order that the changes should be made, use an OrderedDict.

          Returns:
          @@ -279,7 +275,7 @@

          pcdsdevices.attenuator.SXRLadderAttenuatorBlade
          -describe() OrderedDictType[str, Dict[str, Any]]
          +describe() OrderedDictType[str, Dict[str, Any]]

          Provide schema and meta-data for read().

          This keys in the OrderedDict this method returns must match the keys in the OrderedDict return by read().

          @@ -309,7 +305,7 @@

          pcdsdevices.attenuator.SXRLadderAttenuatorBlade
          -read() OrderedDictType[str, Dict[str, Any]]
          +read() OrderedDictType[str, Dict[str, Any]]

          Read data from the device.

          This method is expected to be as instantaneous as possible, with any substantial acquisition time taken care of in @@ -332,7 +328,7 @@

          pcdsdevices.attenuator.SXRLadderAttenuatorBlade
          -read_configuration() OrderedDictType[str, Dict[str, Any]]
          +read_configuration() OrderedDictType[str, Dict[str, Any]]

          Dictionary mapping names to value dicts with keys: value, timestamp

          To control which fields are included, change the Component kinds on the device, or modify the configuration_attrs list.

          @@ -348,7 +344,7 @@

          pcdsdevices.attenuator.SXRLadderAttenuatorBlade
          -status() str
          +status() str

          Returns a str with the current pv values for the device.

          @@ -365,7 +361,7 @@

          pcdsdevices.attenuator.SXRLadderAttenuatorBlade
          -trigger() StatusBase
          +trigger() StatusBase

          Trigger the device and return status object.

          This method is responsible for implementing ‘trigger’ or ‘acquire’ functionality of this device.

          @@ -373,14 +369,14 @@

          pcdsdevices.attenuator.SXRLadderAttenuatorBladeread() method) then this method is also responsible for arranging that the -StatusBase object returned by this method +StatusBase object returned by this method is notified when the device is ready to be read.

          If there is no delay between triggering and being readable, -then this method must return a StatusBase +then this method must return a StatusBase object which is already completed.

          Returns:
          -

          status (StatusBase) – StatusBase object which will be marked +

          status (StatusBase) – StatusBase object which will be marked as complete when the device is ready to be read.

          @@ -409,7 +405,7 @@

          pcdsdevices.attenuator.SXRLadderAttenuatorBlade
          -subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})
          +subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})

          diff --git a/master/generated/pcdsdevices.attenuator.SXRLadderAttenuatorStates.html b/master/generated/pcdsdevices.attenuator.SXRLadderAttenuatorStates.html index 3e902f7e418..5d398a31b1f 100644 --- a/master/generated/pcdsdevices.attenuator.SXRLadderAttenuatorStates.html +++ b/master/generated/pcdsdevices.attenuator.SXRLadderAttenuatorStates.html @@ -1,25 +1,23 @@ + + - pcdsdevices.attenuator.SXRLadderAttenuatorStates — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.attenuator.SXRLadderAttenuatorStates — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -
          - 8.5.1.dev30+gd6e98430 -
          @@ -114,6 +109,7 @@
        • pcdsdevices.ipm
        • pcdsdevices.jet
        • pcdsdevices.keithley
        • +
        • pcdsdevices.lakeshore
        • pcdsdevices.lamp_motion
        • pcdsdevices.lasers.btps
        • pcdsdevices.lasers.counters
        • @@ -341,14 +337,14 @@

          pcdsdevices.attenuator.SXRLadderAttenuatorStates
          -configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]
          +configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]

          Configure the device for something during a run

          This default implementation allows the user to change any of the configuration_attrs. Subclasses might override this to perform additional input validation, cleanup, etc.

          Parameters:
          -

          d (dict) – The configuration dictionary. To specify the order that +

          d (dict) – The configuration dictionary. To specify the order that the changes should be made, use an OrderedDict.

          Returns:
          @@ -363,7 +359,7 @@

          pcdsdevices.attenuator.SXRLadderAttenuatorStates
          -describe() OrderedDictType[str, Dict[str, Any]]
          +describe() OrderedDictType[str, Dict[str, Any]]

          Provide schema and meta-data for read().

          This keys in the OrderedDict this method returns must match the keys in the OrderedDict return by read().

          @@ -415,12 +411,12 @@

          pcdsdevices.attenuator.SXRLadderAttenuatorStatesobj, which will be set to this instance.

          -
        • timeout (float, optional) – Maximum time to wait for the motion.

        • -
        • wait (bool, optional) – If True, do not continue until the move is complete.

        • +
        • timeout (float, optional) – Maximum time to wait for the motion.

        • +
        • wait (bool, optional) – If True, do not continue until the move is complete.

        • Returns:
          -

          moved_status (Status) – Status that will be marked as done when the motion is complete.

          +

          moved_status (Status) – Status that will be marked as done when the motion is complete.

          @@ -432,11 +428,11 @@

          pcdsdevices.attenuator.SXRLadderAttenuatorStates
          Parameters:
            -
          • position (int or str) – The enumerate state or the corresponding integer.

          • +
          • position (int or str) – The enumerate state or the corresponding integer.

          • moved_cb (callable, optional) – Function to call at the end of motion. i.e. moved_cb(obj=self) will be called when move is complete.

          • -
          • timeout (int or float, optional) – Move timeout in seconds.

          • -
          • wait (bool, optional) – If True, do not return until the motion has completed.

          • +
          • timeout (int or float, optional) – Move timeout in seconds.

          • +
          • wait (bool, optional) – If True, do not return until the motion has completed.

          Returns:
          @@ -453,12 +449,12 @@

          pcdsdevices.attenuator.SXRLadderAttenuatorStatesParameters:
          • position – Desired end position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • wait (bool, optional) – If True, wait for motion completion before returning. +

          • wait (bool, optional) – If True, wait for motion completion before returning. Defaults to False.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          @@ -472,7 +468,7 @@

          pcdsdevices.attenuator.SXRLadderAttenuatorStates
          -read() OrderedDictType[str, Dict[str, Any]]
          +read() OrderedDictType[str, Dict[str, Any]]

          Read data from the device.

          This method is expected to be as instantaneous as possible, with any substantial acquisition time taken care of in @@ -495,7 +491,7 @@

          pcdsdevices.attenuator.SXRLadderAttenuatorStates
          -read_configuration() OrderedDictType[str, Dict[str, Any]]
          +read_configuration() OrderedDictType[str, Dict[str, Any]]

          Dictionary mapping names to value dicts with keys: value, timestamp

          To control which fields are included, change the Component kinds on the device, or modify the configuration_attrs list.

          @@ -512,12 +508,12 @@

          pcdsdevices.attenuator.SXRLadderAttenuatorStatesobj, which will be set to this instance.

          -
        • timeout (float, optional) – Maximum time to wait for the motion.

        • -
        • wait (bool, optional) – If True, do not continue until the move is complete.

        • +
        • timeout (float, optional) – Maximum time to wait for the motion.

        • +
        • wait (bool, optional) – If True, do not continue until the move is complete.

        • Returns:
          -

          moved_status (Status) – Status that will be marked as done when the motion is complete.

          +

          moved_status (Status) – Status that will be marked as done when the motion is complete.

          @@ -541,10 +537,10 @@

          pcdsdevices.attenuator.SXRLadderAttenuatorStates
          Parameters:
            -
          • position (int or str) – The enumerate state or the corresponding integer.

          • +
          • position (int or str) – The enumerate state or the corresponding integer.

          • moved_cb (callable, optional) – Function to call at the end of motion. i.e. moved_cb(obj=self) will be called when move is complete.

          • -
          • timeout (int or float, optional) – Move timeout in seconds.

          • +
          • timeout (int or float, optional) – Move timeout in seconds.

          Returns:
          @@ -555,7 +551,7 @@

          pcdsdevices.attenuator.SXRLadderAttenuatorStates
          -status() str
          +status() str

          Returns a str with the current pv values for the device.

          @@ -566,7 +562,7 @@

          pcdsdevices.attenuator.SXRLadderAttenuatorStates
          -trigger() StatusBase
          +trigger() StatusBase

          Trigger the device and return status object.

          This method is responsible for implementing ‘trigger’ or ‘acquire’ functionality of this device.

          @@ -574,14 +570,14 @@

          pcdsdevices.attenuator.SXRLadderAttenuatorStatesread() method) then this method is also responsible for arranging that the -StatusBase object returned by this method +StatusBase object returned by this method is notified when the device is ready to be read.

          If there is no delay between triggering and being readable, -then this method must return a StatusBase +then this method must return a StatusBase object which is already completed.

          Returns:
          -

          status (StatusBase) – StatusBase object which will be marked +

          status (StatusBase) – StatusBase object which will be marked as complete when the device is ready to be read.

          @@ -699,7 +695,7 @@

          pcdsdevices.attenuator.SXRLadderAttenuatorStates
          -subscriptions: ClassVar[FrozenSet[str]] = frozenset({'_req_done', 'acq_done', 'done_moving', 'readback', 'start_moving', 'state'})
          +subscriptions: ClassVar[FrozenSet[str]] = frozenset({'_req_done', 'acq_done', 'done_moving', 'readback', 'start_moving', 'state'})
          diff --git a/master/generated/pcdsdevices.attenuator.get_blade_enum.html b/master/generated/pcdsdevices.attenuator.get_blade_enum.html index 2b2fe6a498b..8b1abdaee8e 100644 --- a/master/generated/pcdsdevices.attenuator.get_blade_enum.html +++ b/master/generated/pcdsdevices.attenuator.get_blade_enum.html @@ -1,25 +1,23 @@ + + - pcdsdevices.attenuator.get_blade_enum — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.attenuator.get_blade_enum — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -
          - 8.5.1.dev30+gd6e98430 -
          @@ -114,6 +109,7 @@
        • pcdsdevices.ipm
        • pcdsdevices.jet
        • pcdsdevices.keithley
        • +
        • pcdsdevices.lakeshore
        • pcdsdevices.lamp_motion
        • pcdsdevices.lasers.btps
        • pcdsdevices.lasers.counters
        • diff --git a/master/generated/pcdsdevices.attenuator.render_ascii_att.html b/master/generated/pcdsdevices.attenuator.render_ascii_att.html index 9211630d751..f5647ce9b95 100644 --- a/master/generated/pcdsdevices.attenuator.render_ascii_att.html +++ b/master/generated/pcdsdevices.attenuator.render_ascii_att.html @@ -1,25 +1,23 @@ + + - pcdsdevices.attenuator.render_ascii_att — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.attenuator.render_ascii_att — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -
          - 8.5.1.dev30+gd6e98430 -
          @@ -114,6 +109,7 @@
        • pcdsdevices.ipm
        • pcdsdevices.jet
        • pcdsdevices.keithley
        • +
        • pcdsdevices.lakeshore
        • pcdsdevices.lamp_motion
        • pcdsdevices.lasers.btps
        • pcdsdevices.lasers.counters
        • @@ -228,8 +224,8 @@

          pcdsdevices.attenuator.render_ascii_att
          Parameters:
            -
          • blade_states (list of BladeStateEnum) – The elements of this list represent the current blade states.

          • -
          • start_index (int, optional) – The starting filter index.

          • +
          • blade_states (list of BladeStateEnum) – The elements of this list represent the current blade states.

          • +
          • start_index (int, optional) – The starting filter index.

          Returns:
          diff --git a/master/generated/pcdsdevices.beam_stats.BeamEnergyRequest.html b/master/generated/pcdsdevices.beam_stats.BeamEnergyRequest.html index 5d4ebb96c17..e038447b7c0 100644 --- a/master/generated/pcdsdevices.beam_stats.BeamEnergyRequest.html +++ b/master/generated/pcdsdevices.beam_stats.BeamEnergyRequest.html @@ -1,25 +1,23 @@ + + - pcdsdevices.beam_stats.BeamEnergyRequest — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.beam_stats.BeamEnergyRequest — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -
          - 8.5.1.dev30+gd6e98430 -
          @@ -93,6 +88,7 @@
        • pcdsdevices.ipm
        • pcdsdevices.jet
        • pcdsdevices.keithley
        • +
        • pcdsdevices.lakeshore
        • pcdsdevices.lamp_motion
        • pcdsdevices.lasers.btps
        • pcdsdevices.lasers.counters
        • @@ -202,7 +198,7 @@

          pcdsdevices.beam_stats.BeamEnergyRequest

          -class pcdsdevices.beam_stats.BeamEnergyRequest(*args, acr_status_suffix: str | None = None, **kwargs)
          +class pcdsdevices.beam_stats.BeamEnergyRequest(*args, acr_status_suffix: str | None = None, **kwargs)

          Positioner to request beam color changes from ACR in eV.

          It is up to ACR how to and whether to fulfill these requests. This is often fulfilled by moving the Vernier but can also be a more involved process.

          @@ -222,9 +218,9 @@

          pcdsdevices.beam_stats.BeamEnergyRequest
          Parameters:
            -
          • prefix (str) – PV prefix for the request setpoint. This should always be a hutch name.

          • -
          • name (str, required keyword) – Name to use for this device in log messages, data streams, etc.

          • -
          • skip_small_moves (bool, optional) – Has no effect if using the wait-on-PV version of the class, but will +

          • prefix (str) – PV prefix for the request setpoint. This should always be a hutch name.

          • +
          • name (str, required keyword) – Name to use for this device in log messages, data streams, etc.

          • +
          • skip_small_moves (bool, optional) – Has no effect if using the wait-on-PV version of the class, but will take effect for the no-wait version of the class. Defaults to True, which ignores move requests that are smaller than the atol factor. If False, we’ll perform every requested move. @@ -233,17 +229,17 @@

            pcdsdevices.beam_stats.BeamEnergyRequestint, optional) – Has no effect if using the wait-on-PV version of the class, but will +
          • atol (int, optional) – Has no effect if using the wait-on-PV version of the class, but will take effect for the no-wait version of the class. Absolute tolerance that determines when the move is done and when to skip moves using the skip_small_moves parameter.

          • -
          • line (str, optional) – Whether to use the K line or L line PV. If provided this should be a +

          • line (str, optional) – Whether to use the K line or L line PV. If provided this should be a string with a single character. The K line PVs have “EPHOTK” in them, the L line PVs just have “EPHOT”. This will default to the line associated with the prefix hutch name, or to L line failing that.

          • -
          • pv_index (int, optional) – Whether to move the first PV (1) or the second PV (2). This is relevant +

          • pv_index (int, optional) – Whether to move the first PV (1) or the second PV (2). This is relevant 2-color mode or when scanning combined K and Vernier. Defaults to 1.

          • -
          • acr_status_suffix (str, optional) – If provided, we’ll wait on the ACR PV specified by +

          • acr_status_suffix (str, optional) – If provided, we’ll wait on the ACR PV specified by SIOC:SYS0:ML07:{suffix}. The selected PV should be 0 while the device is moving and 1 when it is done.

          @@ -291,14 +287,14 @@

          pcdsdevices.beam_stats.BeamEnergyRequest
          -configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]
          +configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]

          Configure the device for something during a run

          This default implementation allows the user to change any of the configuration_attrs. Subclasses might override this to perform additional input validation, cleanup, etc.

          Parameters:
          -

          d (dict) – The configuration dictionary. To specify the order that +

          d (dict) – The configuration dictionary. To specify the order that the changes should be made, use an OrderedDict.

          Returns:
          @@ -313,7 +309,7 @@

          pcdsdevices.beam_stats.BeamEnergyRequest
          -describe() OrderedDictType[str, Dict[str, Any]]
          +describe() OrderedDictType[str, Dict[str, Any]]

          Provide schema and meta-data for read().

          This keys in the OrderedDict this method returns must match the keys in the OrderedDict return by read().

          @@ -361,7 +357,7 @@

          pcdsdevices.beam_stats.BeamEnergyRequestfloat, optional) – Maximum time to wait for the motion. If None, the default timeout +
        • timeout (float, optional) – Maximum time to wait for the motion. If None, the default timeout for this positioner is used.

        • @@ -370,9 +366,9 @@

          pcdsdevices.beam_stats.BeamEnergyRequestRaises:

          @@ -386,12 +382,12 @@

          pcdsdevices.beam_stats.BeamEnergyRequestParameters:
          • position – Desired end position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • wait (bool, optional) – If True, wait for motion completion before returning. +

          • wait (bool, optional) – If True, wait for motion completion before returning. Defaults to False.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          @@ -413,13 +409,13 @@

          pcdsdevices.beam_stats.BeamEnergyRequest
          Parameters:
            -
          • delta (float) – Desired change in position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • delta (float) – Desired change in position.

          • +
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • wait (bool, optional) – If True, wait for motion completion before returning. +

          • wait (bool, optional) – If True, wait for motion completion before returning. Defaults to False.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          @@ -433,7 +429,7 @@

          pcdsdevices.beam_stats.BeamEnergyRequest
          -read() OrderedDictType[str, Dict[str, Any]]
          +read() OrderedDictType[str, Dict[str, Any]]

          Read data from the device.

          This method is expected to be as instantaneous as possible, with any substantial acquisition time taken care of in @@ -456,7 +452,7 @@

          pcdsdevices.beam_stats.BeamEnergyRequest
          -read_configuration() OrderedDictType[str, Dict[str, Any]]
          +read_configuration() OrderedDictType[str, Dict[str, Any]]

          Dictionary mapping names to value dicts with keys: value, timestamp

          To control which fields are included, change the Component kinds on the device, or modify the configuration_attrs list.

          @@ -472,23 +468,23 @@

          pcdsdevices.beam_stats.BeamEnergyRequest
          -set(new_position: Any, *, timeout: float | None = None, moved_cb: Callable | None = None, wait: bool = False) StatusBase
          +set(new_position: Any, *, timeout: float | None = None, moved_cb: Callable | None = None, wait: bool = False) StatusBase

          Set a value and return a Status object

          Parameters:
            -
          • new_position (object) – The input here is whatever the device requires (this +

          • new_position (object) – The input here is whatever the device requires (this should be over-ridden by the implementation. For example a motor would take a float, a shutter the strings {‘Open’, ‘Close’}, and a goineometer (h, k, l) tuples

          • -
          • timeout (float, optional) – Maximum time to wait for the motion. If None, the default timeout +

          • timeout (float, optional) – Maximum time to wait for the motion. If None, the default timeout for this positioner is used.

          • moved_cb (callable, optional) –

            Deprecated

            Call this callback when movement has finished. This callback must accept one keyword argument: ‘obj’ which will be set to this positioner instance.

          • -
          • wait (bool, optional) –

            Deprecated

            +
          • wait (bool, optional) –

            Deprecated

            If the method should block until the Status object reports it is done.

            Defaults to False

            @@ -510,7 +506,7 @@

            pcdsdevices.beam_stats.BeamEnergyRequest
            -status() str
            +status() str

            Returns a str with the current pv values for the device.

          @@ -527,7 +523,7 @@

          pcdsdevices.beam_stats.BeamEnergyRequest
          -trigger() StatusBase
          +trigger() StatusBase

          Trigger the device and return status object.

          This method is responsible for implementing ‘trigger’ or ‘acquire’ functionality of this device.

          @@ -535,14 +531,14 @@

          pcdsdevices.beam_stats.BeamEnergyRequestread() method) then this method is also responsible for arranging that the -StatusBase object returned by this method +StatusBase object returned by this method is notified when the device is ready to be read.

          If there is no delay between triggering and being readable, -then this method must return a StatusBase +then this method must return a StatusBase object which is already completed.

          Returns:
          -

          status (StatusBase) – StatusBase object which will be marked +

          status (StatusBase) – StatusBase object which will be marked as complete when the device is ready to be read.

          @@ -557,7 +553,7 @@

          pcdsdevices.beam_stats.BeamEnergyRequest
          Parameters:
          -

          scale (float) – starting step size, default = 0.1

          +

          scale (float) – starting step size, default = 0.1

          @@ -569,12 +565,12 @@

          pcdsdevices.beam_stats.BeamEnergyRequest
          Parameters:
            -
          • position (float) – Desired end position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • position (float) – Desired end position.

          • +
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • -
          • newline (bool, optional) – If True, inserts a newline after the updates.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • newline (bool, optional) – If True, inserts a newline after the updates.

          @@ -587,12 +583,12 @@

          pcdsdevices.beam_stats.BeamEnergyRequest
          Parameters:
            -
          • delta (float) – Desired change in position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • delta (float) – Desired change in position.

          • +
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • -
          • newline (bool, optional) – If True, inserts a newline after the updates.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • newline (bool, optional) – If True, inserts a newline after the updates.

          @@ -707,7 +703,7 @@

          pcdsdevices.beam_stats.BeamEnergyRequest
          -subscriptions: ClassVar[FrozenSet[str]] = frozenset({'_req_done', 'acq_done', 'done_moving', 'readback', 'start_moving'})
          +subscriptions: ClassVar[FrozenSet[str]] = frozenset({'_req_done', 'acq_done', 'done_moving', 'readback', 'start_moving'})
          diff --git a/master/generated/pcdsdevices.beam_stats.BeamEnergyRequestACRWait.html b/master/generated/pcdsdevices.beam_stats.BeamEnergyRequestACRWait.html index f7b32c35fa5..e74f603aadc 100644 --- a/master/generated/pcdsdevices.beam_stats.BeamEnergyRequestACRWait.html +++ b/master/generated/pcdsdevices.beam_stats.BeamEnergyRequestACRWait.html @@ -1,25 +1,23 @@ + + - pcdsdevices.beam_stats.BeamEnergyRequestACRWait — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.beam_stats.BeamEnergyRequestACRWait — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -
          - 8.5.1.dev30+gd6e98430 -
          @@ -93,6 +88,7 @@
        • pcdsdevices.ipm
        • pcdsdevices.jet
        • pcdsdevices.keithley
        • +
        • pcdsdevices.lakeshore
        • pcdsdevices.lamp_motion
        • pcdsdevices.lasers.btps
        • pcdsdevices.lasers.counters
        • @@ -202,7 +198,7 @@

          pcdsdevices.beam_stats.BeamEnergyRequestACRWait

          -class pcdsdevices.beam_stats.BeamEnergyRequestACRWait(*args, acr_status_suffix: str | None = None, **kwargs)
          +class pcdsdevices.beam_stats.BeamEnergyRequestACRWait(*args, acr_status_suffix: str | None = None, **kwargs)

          BeamEnergyRequest variant that does wait on a PV.

          It will report done when the ACR status PV indicates done and will not use the atol parameter.

          @@ -255,14 +251,14 @@

          pcdsdevices.beam_stats.BeamEnergyRequestACRWait
          -configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]
          +configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]

          Configure the device for something during a run

          This default implementation allows the user to change any of the configuration_attrs. Subclasses might override this to perform additional input validation, cleanup, etc.

          Parameters:
          -

          d (dict) – The configuration dictionary. To specify the order that +

          d (dict) – The configuration dictionary. To specify the order that the changes should be made, use an OrderedDict.

          Returns:
          @@ -277,7 +273,7 @@

          pcdsdevices.beam_stats.BeamEnergyRequestACRWait
          -describe() OrderedDictType[str, Dict[str, Any]]
          +describe() OrderedDictType[str, Dict[str, Any]]

          Provide schema and meta-data for read().

          This keys in the OrderedDict this method returns must match the keys in the OrderedDict return by read().

          @@ -318,7 +314,7 @@

          pcdsdevices.beam_stats.BeamEnergyRequestACRWaitfloat, optional) – Maximum time to wait for the motion. If None, the default timeout +
        • timeout (float, optional) – Maximum time to wait for the motion. If None, the default timeout for this positioner is used.

        • @@ -327,9 +323,9 @@

          pcdsdevices.beam_stats.BeamEnergyRequestACRWaitRaises:

          @@ -343,12 +339,12 @@

          pcdsdevices.beam_stats.BeamEnergyRequestACRWaitParameters:
          • position – Desired end position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • wait (bool, optional) – If True, wait for motion completion before returning. +

          • wait (bool, optional) – If True, wait for motion completion before returning. Defaults to False.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          @@ -370,13 +366,13 @@

          pcdsdevices.beam_stats.BeamEnergyRequestACRWait
          Parameters:
            -
          • delta (float) – Desired change in position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • delta (float) – Desired change in position.

          • +
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • wait (bool, optional) – If True, wait for motion completion before returning. +

          • wait (bool, optional) – If True, wait for motion completion before returning. Defaults to False.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          @@ -390,7 +386,7 @@

          pcdsdevices.beam_stats.BeamEnergyRequestACRWait
          -read() OrderedDictType[str, Dict[str, Any]]
          +read() OrderedDictType[str, Dict[str, Any]]

          Read data from the device.

          This method is expected to be as instantaneous as possible, with any substantial acquisition time taken care of in @@ -413,7 +409,7 @@

          pcdsdevices.beam_stats.BeamEnergyRequestACRWait
          -read_configuration() OrderedDictType[str, Dict[str, Any]]
          +read_configuration() OrderedDictType[str, Dict[str, Any]]

          Dictionary mapping names to value dicts with keys: value, timestamp

          To control which fields are included, change the Component kinds on the device, or modify the configuration_attrs list.

          @@ -429,23 +425,23 @@

          pcdsdevices.beam_stats.BeamEnergyRequestACRWait
          -set(new_position: Any, *, timeout: float | None = None, moved_cb: Callable | None = None, wait: bool = False) StatusBase
          +set(new_position: Any, *, timeout: float | None = None, moved_cb: Callable | None = None, wait: bool = False) StatusBase

          Set a value and return a Status object

          Parameters:
            -
          • new_position (object) – The input here is whatever the device requires (this +

          • new_position (object) – The input here is whatever the device requires (this should be over-ridden by the implementation. For example a motor would take a float, a shutter the strings {‘Open’, ‘Close’}, and a goineometer (h, k, l) tuples

          • -
          • timeout (float, optional) – Maximum time to wait for the motion. If None, the default timeout +

          • timeout (float, optional) – Maximum time to wait for the motion. If None, the default timeout for this positioner is used.

          • moved_cb (callable, optional) –

            Deprecated

            Call this callback when movement has finished. This callback must accept one keyword argument: ‘obj’ which will be set to this positioner instance.

          • -
          • wait (bool, optional) –

            Deprecated

            +
          • wait (bool, optional) –

            Deprecated

            If the method should block until the Status object reports it is done.

            Defaults to False

            @@ -467,7 +463,7 @@

            pcdsdevices.beam_stats.BeamEnergyRequestACRWait
            -status() str
            +status() str

            Returns a str with the current pv values for the device.

          @@ -484,7 +480,7 @@

          pcdsdevices.beam_stats.BeamEnergyRequestACRWait
          -trigger() StatusBase
          +trigger() StatusBase

          Trigger the device and return status object.

          This method is responsible for implementing ‘trigger’ or ‘acquire’ functionality of this device.

          @@ -492,14 +488,14 @@

          pcdsdevices.beam_stats.BeamEnergyRequestACRWaitread() method) then this method is also responsible for arranging that the -StatusBase object returned by this method +StatusBase object returned by this method is notified when the device is ready to be read.

          If there is no delay between triggering and being readable, -then this method must return a StatusBase +then this method must return a StatusBase object which is already completed.

          Returns:
          -

          status (StatusBase) – StatusBase object which will be marked +

          status (StatusBase) – StatusBase object which will be marked as complete when the device is ready to be read.

          @@ -514,7 +510,7 @@

          pcdsdevices.beam_stats.BeamEnergyRequestACRWait
          Parameters:
          -

          scale (float) – starting step size, default = 0.1

          +

          scale (float) – starting step size, default = 0.1

          @@ -526,12 +522,12 @@

          pcdsdevices.beam_stats.BeamEnergyRequestACRWait
          Parameters:
            -
          • position (float) – Desired end position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • position (float) – Desired end position.

          • +
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • -
          • newline (bool, optional) – If True, inserts a newline after the updates.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • newline (bool, optional) – If True, inserts a newline after the updates.

          @@ -544,12 +540,12 @@

          pcdsdevices.beam_stats.BeamEnergyRequestACRWait
          Parameters:
            -
          • delta (float) – Desired change in position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • delta (float) – Desired change in position.

          • +
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • -
          • newline (bool, optional) – If True, inserts a newline after the updates.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • newline (bool, optional) – If True, inserts a newline after the updates.

          @@ -701,7 +697,7 @@

          pcdsdevices.beam_stats.BeamEnergyRequestACRWait
          -subscriptions: ClassVar[FrozenSet[str]] = frozenset({'_req_done', 'acq_done', 'done_moving', 'readback', 'start_moving'})
          +subscriptions: ClassVar[FrozenSet[str]] = frozenset({'_req_done', 'acq_done', 'done_moving', 'readback', 'start_moving'})
          diff --git a/master/generated/pcdsdevices.beam_stats.BeamEnergyRequestNoWait.html b/master/generated/pcdsdevices.beam_stats.BeamEnergyRequestNoWait.html index 14787b832e8..5a667b95775 100644 --- a/master/generated/pcdsdevices.beam_stats.BeamEnergyRequestNoWait.html +++ b/master/generated/pcdsdevices.beam_stats.BeamEnergyRequestNoWait.html @@ -1,25 +1,23 @@ + + - pcdsdevices.beam_stats.BeamEnergyRequestNoWait — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.beam_stats.BeamEnergyRequestNoWait — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -
          - 8.5.1.dev30+gd6e98430 -
          @@ -93,6 +88,7 @@
        • pcdsdevices.ipm
        • pcdsdevices.jet
        • pcdsdevices.keithley
        • +
        • pcdsdevices.lakeshore
        • pcdsdevices.lamp_motion
        • pcdsdevices.lasers.btps
        • pcdsdevices.lasers.counters
        • @@ -202,7 +198,7 @@

          pcdsdevices.beam_stats.BeamEnergyRequestNoWait

          -class pcdsdevices.beam_stats.BeamEnergyRequestNoWait(*args, acr_status_suffix: str | None = None, **kwargs)
          +class pcdsdevices.beam_stats.BeamEnergyRequestNoWait(*args, acr_status_suffix: str | None = None, **kwargs)

          BeamEnergyRequest variant that does not wait on a PV.

          It will report done immediately and ignore moves that are smaller than atol.

          @@ -255,14 +251,14 @@

          pcdsdevices.beam_stats.BeamEnergyRequestNoWait
          -configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]
          +configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]

          Configure the device for something during a run

          This default implementation allows the user to change any of the configuration_attrs. Subclasses might override this to perform additional input validation, cleanup, etc.

          Parameters:
          -

          d (dict) – The configuration dictionary. To specify the order that +

          d (dict) – The configuration dictionary. To specify the order that the changes should be made, use an OrderedDict.

          Returns:
          @@ -277,7 +273,7 @@

          pcdsdevices.beam_stats.BeamEnergyRequestNoWait
          -describe() OrderedDictType[str, Dict[str, Any]]
          +describe() OrderedDictType[str, Dict[str, Any]]

          Provide schema and meta-data for read().

          This keys in the OrderedDict this method returns must match the keys in the OrderedDict return by read().

          @@ -318,7 +314,7 @@

          pcdsdevices.beam_stats.BeamEnergyRequestNoWaitfloat, optional) – Maximum time to wait for the motion. If None, the default timeout +
        • timeout (float, optional) – Maximum time to wait for the motion. If None, the default timeout for this positioner is used.

        • @@ -327,9 +323,9 @@

          pcdsdevices.beam_stats.BeamEnergyRequestNoWaitRaises:

          @@ -343,12 +339,12 @@

          pcdsdevices.beam_stats.BeamEnergyRequestNoWaitParameters:
          • position – Desired end position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • wait (bool, optional) – If True, wait for motion completion before returning. +

          • wait (bool, optional) – If True, wait for motion completion before returning. Defaults to False.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          @@ -370,13 +366,13 @@

          pcdsdevices.beam_stats.BeamEnergyRequestNoWait
          Parameters:
            -
          • delta (float) – Desired change in position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • delta (float) – Desired change in position.

          • +
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • wait (bool, optional) – If True, wait for motion completion before returning. +

          • wait (bool, optional) – If True, wait for motion completion before returning. Defaults to False.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          @@ -390,7 +386,7 @@

          pcdsdevices.beam_stats.BeamEnergyRequestNoWait
          -read() OrderedDictType[str, Dict[str, Any]]
          +read() OrderedDictType[str, Dict[str, Any]]

          Read data from the device.

          This method is expected to be as instantaneous as possible, with any substantial acquisition time taken care of in @@ -413,7 +409,7 @@

          pcdsdevices.beam_stats.BeamEnergyRequestNoWait
          -read_configuration() OrderedDictType[str, Dict[str, Any]]
          +read_configuration() OrderedDictType[str, Dict[str, Any]]

          Dictionary mapping names to value dicts with keys: value, timestamp

          To control which fields are included, change the Component kinds on the device, or modify the configuration_attrs list.

          @@ -429,23 +425,23 @@

          pcdsdevices.beam_stats.BeamEnergyRequestNoWait
          -set(new_position: Any, *, timeout: float | None = None, moved_cb: Callable | None = None, wait: bool = False) StatusBase
          +set(new_position: Any, *, timeout: float | None = None, moved_cb: Callable | None = None, wait: bool = False) StatusBase

          Set a value and return a Status object

          Parameters:
            -
          • new_position (object) – The input here is whatever the device requires (this +

          • new_position (object) – The input here is whatever the device requires (this should be over-ridden by the implementation. For example a motor would take a float, a shutter the strings {‘Open’, ‘Close’}, and a goineometer (h, k, l) tuples

          • -
          • timeout (float, optional) – Maximum time to wait for the motion. If None, the default timeout +

          • timeout (float, optional) – Maximum time to wait for the motion. If None, the default timeout for this positioner is used.

          • moved_cb (callable, optional) –

            Deprecated

            Call this callback when movement has finished. This callback must accept one keyword argument: ‘obj’ which will be set to this positioner instance.

          • -
          • wait (bool, optional) –

            Deprecated

            +
          • wait (bool, optional) –

            Deprecated

            If the method should block until the Status object reports it is done.

            Defaults to False

            @@ -467,7 +463,7 @@

            pcdsdevices.beam_stats.BeamEnergyRequestNoWait
            -status() str
            +status() str

            Returns a str with the current pv values for the device.

          @@ -484,7 +480,7 @@

          pcdsdevices.beam_stats.BeamEnergyRequestNoWait
          -trigger() StatusBase
          +trigger() StatusBase

          Trigger the device and return status object.

          This method is responsible for implementing ‘trigger’ or ‘acquire’ functionality of this device.

          @@ -492,14 +488,14 @@

          pcdsdevices.beam_stats.BeamEnergyRequestNoWaitread() method) then this method is also responsible for arranging that the -StatusBase object returned by this method +StatusBase object returned by this method is notified when the device is ready to be read.

          If there is no delay between triggering and being readable, -then this method must return a StatusBase +then this method must return a StatusBase object which is already completed.

          Returns:
          -

          status (StatusBase) – StatusBase object which will be marked +

          status (StatusBase) – StatusBase object which will be marked as complete when the device is ready to be read.

          @@ -514,7 +510,7 @@

          pcdsdevices.beam_stats.BeamEnergyRequestNoWait
          Parameters:
          -

          scale (float) – starting step size, default = 0.1

          +

          scale (float) – starting step size, default = 0.1

          @@ -526,12 +522,12 @@

          pcdsdevices.beam_stats.BeamEnergyRequestNoWait
          Parameters:
            -
          • position (float) – Desired end position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • position (float) – Desired end position.

          • +
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • -
          • newline (bool, optional) – If True, inserts a newline after the updates.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • newline (bool, optional) – If True, inserts a newline after the updates.

          @@ -544,12 +540,12 @@

          pcdsdevices.beam_stats.BeamEnergyRequestNoWait
          Parameters:
            -
          • delta (float) – Desired change in position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • delta (float) – Desired change in position.

          • +
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • -
          • newline (bool, optional) – If True, inserts a newline after the updates.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • newline (bool, optional) – If True, inserts a newline after the updates.

          @@ -706,7 +702,7 @@

          pcdsdevices.beam_stats.BeamEnergyRequestNoWait
          -subscriptions: ClassVar[FrozenSet[str]] = frozenset({'_req_done', 'acq_done', 'done_moving', 'readback', 'start_moving'})
          +subscriptions: ClassVar[FrozenSet[str]] = frozenset({'_req_done', 'acq_done', 'done_moving', 'readback', 'start_moving'})
          diff --git a/master/generated/pcdsdevices.beam_stats.BeamStats.html b/master/generated/pcdsdevices.beam_stats.BeamStats.html index 80e15c0ea73..5bbabed1d1c 100644 --- a/master/generated/pcdsdevices.beam_stats.BeamStats.html +++ b/master/generated/pcdsdevices.beam_stats.BeamStats.html @@ -1,25 +1,23 @@ + + - pcdsdevices.beam_stats.BeamStats — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.beam_stats.BeamStats — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -
          - 8.5.1.dev30+gd6e98430 -
          @@ -93,6 +88,7 @@
        • pcdsdevices.ipm
        • pcdsdevices.jet
        • pcdsdevices.keithley
        • +
        • pcdsdevices.lakeshore
        • pcdsdevices.lamp_motion
        • pcdsdevices.lasers.btps
        • pcdsdevices.lasers.counters
        • @@ -262,14 +258,14 @@

          pcdsdevices.beam_stats.BeamStatsMethods

          -configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]
          +configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]

          Configure the device for something during a run

          This default implementation allows the user to change any of the configuration_attrs. Subclasses might override this to perform additional input validation, cleanup, etc.

          Parameters:
          -

          d (dict) – The configuration dictionary. To specify the order that +

          d (dict) – The configuration dictionary. To specify the order that the changes should be made, use an OrderedDict.

          Returns:
          @@ -284,7 +280,7 @@

          pcdsdevices.beam_stats.BeamStats
          -describe() OrderedDictType[str, Dict[str, Any]]
          +describe() OrderedDictType[str, Dict[str, Any]]

          Provide schema and meta-data for read().

          This keys in the OrderedDict this method returns must match the keys in the OrderedDict return by read().

          @@ -314,7 +310,7 @@

          pcdsdevices.beam_stats.BeamStats
          -read() OrderedDictType[str, Dict[str, Any]]
          +read() OrderedDictType[str, Dict[str, Any]]

          Read data from the device.

          This method is expected to be as instantaneous as possible, with any substantial acquisition time taken care of in @@ -337,7 +333,7 @@

          pcdsdevices.beam_stats.BeamStats
          -read_configuration() OrderedDictType[str, Dict[str, Any]]
          +read_configuration() OrderedDictType[str, Dict[str, Any]]

          Dictionary mapping names to value dicts with keys: value, timestamp

          To control which fields are included, change the Component kinds on the device, or modify the configuration_attrs list.

          @@ -353,7 +349,7 @@

          pcdsdevices.beam_stats.BeamStats
          -status() str
          +status() str

          Returns a str with the current pv values for the device.

          @@ -370,7 +366,7 @@

          pcdsdevices.beam_stats.BeamStats
          -trigger() StatusBase
          +trigger() StatusBase

          Trigger the device and return status object.

          This method is responsible for implementing ‘trigger’ or ‘acquire’ functionality of this device.

          @@ -378,14 +374,14 @@

          pcdsdevices.beam_stats.BeamStatsread() method) then this method is also responsible for arranging that the -StatusBase object returned by this method +StatusBase object returned by this method is notified when the device is ready to be read.

          If there is no delay between triggering and being readable, -then this method must return a StatusBase +then this method must return a StatusBase object which is already completed.

          Returns:
          -

          status (StatusBase) – StatusBase object which will be marked +

          status (StatusBase) – StatusBase object which will be marked as complete when the device is ready to be read.

          @@ -414,7 +410,7 @@

          pcdsdevices.beam_stats.BeamStats
          -subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})
          +subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})

          diff --git a/master/generated/pcdsdevices.beam_stats.FakeBeamEnergyRequest.html b/master/generated/pcdsdevices.beam_stats.FakeBeamEnergyRequest.html index 0e7f4b8fbc7..f94ba118d3f 100644 --- a/master/generated/pcdsdevices.beam_stats.FakeBeamEnergyRequest.html +++ b/master/generated/pcdsdevices.beam_stats.FakeBeamEnergyRequest.html @@ -1,25 +1,23 @@ + + - pcdsdevices.beam_stats.FakeBeamEnergyRequest — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.beam_stats.FakeBeamEnergyRequest — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -
          - 8.5.1.dev30+gd6e98430 -
          @@ -93,6 +88,7 @@
        • pcdsdevices.ipm
        • pcdsdevices.jet
        • pcdsdevices.keithley
        • +
        • pcdsdevices.lakeshore
        • pcdsdevices.lamp_motion
        • pcdsdevices.lasers.btps
        • pcdsdevices.lasers.counters
        • @@ -202,7 +198,7 @@

          pcdsdevices.beam_stats.FakeBeamEnergyRequest

          -class pcdsdevices.beam_stats.FakeBeamEnergyRequest(*args, acr_status_suffix: str | None = None, **kwargs)
          +class pcdsdevices.beam_stats.FakeBeamEnergyRequest(*args, acr_status_suffix: str | None = None, **kwargs)

          Required setup for fake classes to work properly with __new__ splitting

          Ophyd Device Components
          @@ -246,14 +242,14 @@

          pcdsdevices.beam_stats.FakeBeamEnergyRequest
          -configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]
          +configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]

          Configure the device for something during a run

          This default implementation allows the user to change any of the configuration_attrs. Subclasses might override this to perform additional input validation, cleanup, etc.

          Parameters:
          -

          d (dict) – The configuration dictionary. To specify the order that +

          d (dict) – The configuration dictionary. To specify the order that the changes should be made, use an OrderedDict.

          Returns:
          @@ -268,7 +264,7 @@

          pcdsdevices.beam_stats.FakeBeamEnergyRequest
          -describe() OrderedDictType[str, Dict[str, Any]]
          +describe() OrderedDictType[str, Dict[str, Any]]

          Provide schema and meta-data for read().

          This keys in the OrderedDict this method returns must match the keys in the OrderedDict return by read().

          @@ -316,7 +312,7 @@

          pcdsdevices.beam_stats.FakeBeamEnergyRequestfloat, optional) – Maximum time to wait for the motion. If None, the default timeout +
        • timeout (float, optional) – Maximum time to wait for the motion. If None, the default timeout for this positioner is used.

        • @@ -325,9 +321,9 @@

          pcdsdevices.beam_stats.FakeBeamEnergyRequestRaises:

          @@ -341,12 +337,12 @@

          pcdsdevices.beam_stats.FakeBeamEnergyRequestParameters:
          • position – Desired end position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • wait (bool, optional) – If True, wait for motion completion before returning. +

          • wait (bool, optional) – If True, wait for motion completion before returning. Defaults to False.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          @@ -368,13 +364,13 @@

          pcdsdevices.beam_stats.FakeBeamEnergyRequest
          Parameters:
            -
          • delta (float) – Desired change in position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • delta (float) – Desired change in position.

          • +
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • wait (bool, optional) – If True, wait for motion completion before returning. +

          • wait (bool, optional) – If True, wait for motion completion before returning. Defaults to False.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          @@ -388,7 +384,7 @@

          pcdsdevices.beam_stats.FakeBeamEnergyRequest
          -read() OrderedDictType[str, Dict[str, Any]]
          +read() OrderedDictType[str, Dict[str, Any]]

          Read data from the device.

          This method is expected to be as instantaneous as possible, with any substantial acquisition time taken care of in @@ -411,7 +407,7 @@

          pcdsdevices.beam_stats.FakeBeamEnergyRequest
          -read_configuration() OrderedDictType[str, Dict[str, Any]]
          +read_configuration() OrderedDictType[str, Dict[str, Any]]

          Dictionary mapping names to value dicts with keys: value, timestamp

          To control which fields are included, change the Component kinds on the device, or modify the configuration_attrs list.

          @@ -427,23 +423,23 @@

          pcdsdevices.beam_stats.FakeBeamEnergyRequest
          -set(new_position: Any, *, timeout: float | None = None, moved_cb: Callable | None = None, wait: bool = False) StatusBase
          +set(new_position: Any, *, timeout: float | None = None, moved_cb: Callable | None = None, wait: bool = False) StatusBase

          Set a value and return a Status object

          Parameters:
            -
          • new_position (object) – The input here is whatever the device requires (this +

          • new_position (object) – The input here is whatever the device requires (this should be over-ridden by the implementation. For example a motor would take a float, a shutter the strings {‘Open’, ‘Close’}, and a goineometer (h, k, l) tuples

          • -
          • timeout (float, optional) – Maximum time to wait for the motion. If None, the default timeout +

          • timeout (float, optional) – Maximum time to wait for the motion. If None, the default timeout for this positioner is used.

          • moved_cb (callable, optional) –

            Deprecated

            Call this callback when movement has finished. This callback must accept one keyword argument: ‘obj’ which will be set to this positioner instance.

          • -
          • wait (bool, optional) –

            Deprecated

            +
          • wait (bool, optional) –

            Deprecated

            If the method should block until the Status object reports it is done.

            Defaults to False

            @@ -465,7 +461,7 @@

            pcdsdevices.beam_stats.FakeBeamEnergyRequest
            -status() str
            +status() str

            Returns a str with the current pv values for the device.

          @@ -482,7 +478,7 @@

          pcdsdevices.beam_stats.FakeBeamEnergyRequest
          -trigger() StatusBase
          +trigger() StatusBase

          Trigger the device and return status object.

          This method is responsible for implementing ‘trigger’ or ‘acquire’ functionality of this device.

          @@ -490,14 +486,14 @@

          pcdsdevices.beam_stats.FakeBeamEnergyRequestread() method) then this method is also responsible for arranging that the -StatusBase object returned by this method +StatusBase object returned by this method is notified when the device is ready to be read.

          If there is no delay between triggering and being readable, -then this method must return a StatusBase +then this method must return a StatusBase object which is already completed.

          Returns:
          -

          status (StatusBase) – StatusBase object which will be marked +

          status (StatusBase) – StatusBase object which will be marked as complete when the device is ready to be read.

          @@ -512,7 +508,7 @@

          pcdsdevices.beam_stats.FakeBeamEnergyRequest
          Parameters:
          -

          scale (float) – starting step size, default = 0.1

          +

          scale (float) – starting step size, default = 0.1

          @@ -524,12 +520,12 @@

          pcdsdevices.beam_stats.FakeBeamEnergyRequest
          Parameters:
            -
          • position (float) – Desired end position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • position (float) – Desired end position.

          • +
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • -
          • newline (bool, optional) – If True, inserts a newline after the updates.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • newline (bool, optional) – If True, inserts a newline after the updates.

          @@ -542,12 +538,12 @@

          pcdsdevices.beam_stats.FakeBeamEnergyRequest
          Parameters:
            -
          • delta (float) – Desired change in position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • delta (float) – Desired change in position.

          • +
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • -
          • newline (bool, optional) – If True, inserts a newline after the updates.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • newline (bool, optional) – If True, inserts a newline after the updates.

          @@ -662,7 +658,7 @@

          pcdsdevices.beam_stats.FakeBeamEnergyRequest
          -subscriptions: ClassVar[FrozenSet[str]] = frozenset({'_req_done', 'acq_done', 'done_moving', 'readback', 'start_moving'})
          +subscriptions: ClassVar[FrozenSet[str]] = frozenset({'_req_done', 'acq_done', 'done_moving', 'readback', 'start_moving'})
          diff --git a/master/generated/pcdsdevices.beam_stats.FakeBeamEnergyRequestACRWait.html b/master/generated/pcdsdevices.beam_stats.FakeBeamEnergyRequestACRWait.html index de4c09754f2..7888e2fb4cf 100644 --- a/master/generated/pcdsdevices.beam_stats.FakeBeamEnergyRequestACRWait.html +++ b/master/generated/pcdsdevices.beam_stats.FakeBeamEnergyRequestACRWait.html @@ -1,25 +1,23 @@ + + - pcdsdevices.beam_stats.FakeBeamEnergyRequestACRWait — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.beam_stats.FakeBeamEnergyRequestACRWait — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -
          - 8.5.1.dev30+gd6e98430 -
          @@ -93,6 +88,7 @@
        • pcdsdevices.ipm
        • pcdsdevices.jet
        • pcdsdevices.keithley
        • +
        • pcdsdevices.lakeshore
        • pcdsdevices.lamp_motion
        • pcdsdevices.lasers.btps
        • pcdsdevices.lasers.counters
        • @@ -202,7 +198,7 @@

          pcdsdevices.beam_stats.FakeBeamEnergyRequestACRWait

          -class pcdsdevices.beam_stats.FakeBeamEnergyRequestACRWait(*args, acr_status_suffix: str | None = None, **kwargs)
          +class pcdsdevices.beam_stats.FakeBeamEnergyRequestACRWait(*args, acr_status_suffix: str | None = None, **kwargs)

          Ophyd Device Components
          @@ -252,14 +248,14 @@

          pcdsdevices.beam_stats.FakeBeamEnergyRequestACRWait
          -configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]
          +configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]

          Configure the device for something during a run

          This default implementation allows the user to change any of the configuration_attrs. Subclasses might override this to perform additional input validation, cleanup, etc.

          Parameters:
          -

          d (dict) – The configuration dictionary. To specify the order that +

          d (dict) – The configuration dictionary. To specify the order that the changes should be made, use an OrderedDict.

          Returns:
          @@ -274,7 +270,7 @@

          pcdsdevices.beam_stats.FakeBeamEnergyRequestACRWait
          -describe() OrderedDictType[str, Dict[str, Any]]
          +describe() OrderedDictType[str, Dict[str, Any]]

          Provide schema and meta-data for read().

          This keys in the OrderedDict this method returns must match the keys in the OrderedDict return by read().

          @@ -315,7 +311,7 @@

          pcdsdevices.beam_stats.FakeBeamEnergyRequestACRWait

          moved_cb (callable) – Call this callback when movement has finished. This callback must accept one keyword argument: ‘obj’ which will be set to this positioner instance.

          -
        • timeout (float, optional) – Maximum time to wait for the motion. If None, the default timeout +

        • timeout (float, optional) – Maximum time to wait for the motion. If None, the default timeout for this positioner is used.

        • @@ -324,9 +320,9 @@

          pcdsdevices.beam_stats.FakeBeamEnergyRequestACRWait
          Raises:

          @@ -340,12 +336,12 @@

          pcdsdevices.beam_stats.FakeBeamEnergyRequestACRWaitParameters:
          • position – Desired end position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • wait (bool, optional) – If True, wait for motion completion before returning. +

          • wait (bool, optional) – If True, wait for motion completion before returning. Defaults to False.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          @@ -367,13 +363,13 @@

          pcdsdevices.beam_stats.FakeBeamEnergyRequestACRWait
          Parameters:
            -
          • delta (float) – Desired change in position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • delta (float) – Desired change in position.

          • +
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • wait (bool, optional) – If True, wait for motion completion before returning. +

          • wait (bool, optional) – If True, wait for motion completion before returning. Defaults to False.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          @@ -387,7 +383,7 @@

          pcdsdevices.beam_stats.FakeBeamEnergyRequestACRWait
          -read() OrderedDictType[str, Dict[str, Any]]
          +read() OrderedDictType[str, Dict[str, Any]]

          Read data from the device.

          This method is expected to be as instantaneous as possible, with any substantial acquisition time taken care of in @@ -410,7 +406,7 @@

          pcdsdevices.beam_stats.FakeBeamEnergyRequestACRWait
          -read_configuration() OrderedDictType[str, Dict[str, Any]]
          +read_configuration() OrderedDictType[str, Dict[str, Any]]

          Dictionary mapping names to value dicts with keys: value, timestamp

          To control which fields are included, change the Component kinds on the device, or modify the configuration_attrs list.

          @@ -426,23 +422,23 @@

          pcdsdevices.beam_stats.FakeBeamEnergyRequestACRWait
          -set(new_position: Any, *, timeout: float | None = None, moved_cb: Callable | None = None, wait: bool = False) StatusBase
          +set(new_position: Any, *, timeout: float | None = None, moved_cb: Callable | None = None, wait: bool = False) StatusBase

          Set a value and return a Status object

          Parameters:
            -
          • new_position (object) – The input here is whatever the device requires (this +

          • new_position (object) – The input here is whatever the device requires (this should be over-ridden by the implementation. For example a motor would take a float, a shutter the strings {‘Open’, ‘Close’}, and a goineometer (h, k, l) tuples

          • -
          • timeout (float, optional) – Maximum time to wait for the motion. If None, the default timeout +

          • timeout (float, optional) – Maximum time to wait for the motion. If None, the default timeout for this positioner is used.

          • moved_cb (callable, optional) –

            Deprecated

            Call this callback when movement has finished. This callback must accept one keyword argument: ‘obj’ which will be set to this positioner instance.

          • -
          • wait (bool, optional) –

            Deprecated

            +
          • wait (bool, optional) –

            Deprecated

            If the method should block until the Status object reports it is done.

            Defaults to False

            @@ -464,7 +460,7 @@

            pcdsdevices.beam_stats.FakeBeamEnergyRequestACRWait
            -status() str
            +status() str

            Returns a str with the current pv values for the device.

          @@ -481,7 +477,7 @@

          pcdsdevices.beam_stats.FakeBeamEnergyRequestACRWait
          -trigger() StatusBase
          +trigger() StatusBase

          Trigger the device and return status object.

          This method is responsible for implementing ‘trigger’ or ‘acquire’ functionality of this device.

          @@ -489,14 +485,14 @@

          pcdsdevices.beam_stats.FakeBeamEnergyRequestACRWaitread() method) then this method is also responsible for arranging that the -StatusBase object returned by this method +StatusBase object returned by this method is notified when the device is ready to be read.

          If there is no delay between triggering and being readable, -then this method must return a StatusBase +then this method must return a StatusBase object which is already completed.

          Returns:
          -

          status (StatusBase) – StatusBase object which will be marked +

          status (StatusBase) – StatusBase object which will be marked as complete when the device is ready to be read.

          @@ -511,7 +507,7 @@

          pcdsdevices.beam_stats.FakeBeamEnergyRequestACRWait
          Parameters:
          -

          scale (float) – starting step size, default = 0.1

          +

          scale (float) – starting step size, default = 0.1

          @@ -523,12 +519,12 @@

          pcdsdevices.beam_stats.FakeBeamEnergyRequestACRWait
          Parameters:
            -
          • position (float) – Desired end position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • position (float) – Desired end position.

          • +
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • -
          • newline (bool, optional) – If True, inserts a newline after the updates.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • newline (bool, optional) – If True, inserts a newline after the updates.

          @@ -541,12 +537,12 @@

          pcdsdevices.beam_stats.FakeBeamEnergyRequestACRWait
          Parameters:
            -
          • delta (float) – Desired change in position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • delta (float) – Desired change in position.

          • +
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • -
          • newline (bool, optional) – If True, inserts a newline after the updates.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • newline (bool, optional) – If True, inserts a newline after the updates.

          @@ -698,7 +694,7 @@

          pcdsdevices.beam_stats.FakeBeamEnergyRequestACRWait
          -subscriptions: ClassVar[FrozenSet[str]] = frozenset({'_req_done', 'acq_done', 'done_moving', 'readback', 'start_moving'})
          +subscriptions: ClassVar[FrozenSet[str]] = frozenset({'_req_done', 'acq_done', 'done_moving', 'readback', 'start_moving'})
          diff --git a/master/generated/pcdsdevices.beam_stats.FakeBeamEnergyRequestNoWait.html b/master/generated/pcdsdevices.beam_stats.FakeBeamEnergyRequestNoWait.html index c2e1e569ef4..b559be20850 100644 --- a/master/generated/pcdsdevices.beam_stats.FakeBeamEnergyRequestNoWait.html +++ b/master/generated/pcdsdevices.beam_stats.FakeBeamEnergyRequestNoWait.html @@ -1,25 +1,23 @@ + + - pcdsdevices.beam_stats.FakeBeamEnergyRequestNoWait — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.beam_stats.FakeBeamEnergyRequestNoWait — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -
          - 8.5.1.dev30+gd6e98430 -
          @@ -93,6 +88,7 @@
        • pcdsdevices.ipm
        • pcdsdevices.jet
        • pcdsdevices.keithley
        • +
        • pcdsdevices.lakeshore
        • pcdsdevices.lamp_motion
        • pcdsdevices.lasers.btps
        • pcdsdevices.lasers.counters
        • @@ -202,7 +198,7 @@

          pcdsdevices.beam_stats.FakeBeamEnergyRequestNoWait

          -class pcdsdevices.beam_stats.FakeBeamEnergyRequestNoWait(*args, acr_status_suffix: str | None = None, **kwargs)
          +class pcdsdevices.beam_stats.FakeBeamEnergyRequestNoWait(*args, acr_status_suffix: str | None = None, **kwargs)

          Ophyd Device Components
          @@ -252,14 +248,14 @@

          pcdsdevices.beam_stats.FakeBeamEnergyRequestNoWait
          -configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]
          +configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]

          Configure the device for something during a run

          This default implementation allows the user to change any of the configuration_attrs. Subclasses might override this to perform additional input validation, cleanup, etc.

          Parameters:
          -

          d (dict) – The configuration dictionary. To specify the order that +

          d (dict) – The configuration dictionary. To specify the order that the changes should be made, use an OrderedDict.

          Returns:
          @@ -274,7 +270,7 @@

          pcdsdevices.beam_stats.FakeBeamEnergyRequestNoWait
          -describe() OrderedDictType[str, Dict[str, Any]]
          +describe() OrderedDictType[str, Dict[str, Any]]

          Provide schema and meta-data for read().

          This keys in the OrderedDict this method returns must match the keys in the OrderedDict return by read().

          @@ -315,7 +311,7 @@

          pcdsdevices.beam_stats.FakeBeamEnergyRequestNoWait

          moved_cb (callable) – Call this callback when movement has finished. This callback must accept one keyword argument: ‘obj’ which will be set to this positioner instance.

          -
        • timeout (float, optional) – Maximum time to wait for the motion. If None, the default timeout +

        • timeout (float, optional) – Maximum time to wait for the motion. If None, the default timeout for this positioner is used.

        • @@ -324,9 +320,9 @@

          pcdsdevices.beam_stats.FakeBeamEnergyRequestNoWait
          Raises:

          @@ -340,12 +336,12 @@

          pcdsdevices.beam_stats.FakeBeamEnergyRequestNoWaitParameters:
          • position – Desired end position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • wait (bool, optional) – If True, wait for motion completion before returning. +

          • wait (bool, optional) – If True, wait for motion completion before returning. Defaults to False.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          @@ -367,13 +363,13 @@

          pcdsdevices.beam_stats.FakeBeamEnergyRequestNoWait
          Parameters:
            -
          • delta (float) – Desired change in position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • delta (float) – Desired change in position.

          • +
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • wait (bool, optional) – If True, wait for motion completion before returning. +

          • wait (bool, optional) – If True, wait for motion completion before returning. Defaults to False.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          @@ -387,7 +383,7 @@

          pcdsdevices.beam_stats.FakeBeamEnergyRequestNoWait
          -read() OrderedDictType[str, Dict[str, Any]]
          +read() OrderedDictType[str, Dict[str, Any]]

          Read data from the device.

          This method is expected to be as instantaneous as possible, with any substantial acquisition time taken care of in @@ -410,7 +406,7 @@

          pcdsdevices.beam_stats.FakeBeamEnergyRequestNoWait
          -read_configuration() OrderedDictType[str, Dict[str, Any]]
          +read_configuration() OrderedDictType[str, Dict[str, Any]]

          Dictionary mapping names to value dicts with keys: value, timestamp

          To control which fields are included, change the Component kinds on the device, or modify the configuration_attrs list.

          @@ -426,23 +422,23 @@

          pcdsdevices.beam_stats.FakeBeamEnergyRequestNoWait
          -set(new_position: Any, *, timeout: float | None = None, moved_cb: Callable | None = None, wait: bool = False) StatusBase
          +set(new_position: Any, *, timeout: float | None = None, moved_cb: Callable | None = None, wait: bool = False) StatusBase

          Set a value and return a Status object

          Parameters:
            -
          • new_position (object) – The input here is whatever the device requires (this +

          • new_position (object) – The input here is whatever the device requires (this should be over-ridden by the implementation. For example a motor would take a float, a shutter the strings {‘Open’, ‘Close’}, and a goineometer (h, k, l) tuples

          • -
          • timeout (float, optional) – Maximum time to wait for the motion. If None, the default timeout +

          • timeout (float, optional) – Maximum time to wait for the motion. If None, the default timeout for this positioner is used.

          • moved_cb (callable, optional) –

            Deprecated

            Call this callback when movement has finished. This callback must accept one keyword argument: ‘obj’ which will be set to this positioner instance.

          • -
          • wait (bool, optional) –

            Deprecated

            +
          • wait (bool, optional) –

            Deprecated

            If the method should block until the Status object reports it is done.

            Defaults to False

            @@ -464,7 +460,7 @@

            pcdsdevices.beam_stats.FakeBeamEnergyRequestNoWait
            -status() str
            +status() str

            Returns a str with the current pv values for the device.

          @@ -481,7 +477,7 @@

          pcdsdevices.beam_stats.FakeBeamEnergyRequestNoWait
          -trigger() StatusBase
          +trigger() StatusBase

          Trigger the device and return status object.

          This method is responsible for implementing ‘trigger’ or ‘acquire’ functionality of this device.

          @@ -489,14 +485,14 @@

          pcdsdevices.beam_stats.FakeBeamEnergyRequestNoWaitread() method) then this method is also responsible for arranging that the -StatusBase object returned by this method +StatusBase object returned by this method is notified when the device is ready to be read.

          If there is no delay between triggering and being readable, -then this method must return a StatusBase +then this method must return a StatusBase object which is already completed.

          Returns:
          -

          status (StatusBase) – StatusBase object which will be marked +

          status (StatusBase) – StatusBase object which will be marked as complete when the device is ready to be read.

          @@ -511,7 +507,7 @@

          pcdsdevices.beam_stats.FakeBeamEnergyRequestNoWait
          Parameters:
          -

          scale (float) – starting step size, default = 0.1

          +

          scale (float) – starting step size, default = 0.1

          @@ -523,12 +519,12 @@

          pcdsdevices.beam_stats.FakeBeamEnergyRequestNoWait
          Parameters:
            -
          • position (float) – Desired end position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • position (float) – Desired end position.

          • +
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • -
          • newline (bool, optional) – If True, inserts a newline after the updates.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • newline (bool, optional) – If True, inserts a newline after the updates.

          @@ -541,12 +537,12 @@

          pcdsdevices.beam_stats.FakeBeamEnergyRequestNoWait
          Parameters:
            -
          • delta (float) – Desired change in position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • delta (float) – Desired change in position.

          • +
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • -
          • newline (bool, optional) – If True, inserts a newline after the updates.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • newline (bool, optional) – If True, inserts a newline after the updates.

          @@ -703,7 +699,7 @@

          pcdsdevices.beam_stats.FakeBeamEnergyRequestNoWait
          -subscriptions: ClassVar[FrozenSet[str]] = frozenset({'_req_done', 'acq_done', 'done_moving', 'readback', 'start_moving'})
          +subscriptions: ClassVar[FrozenSet[str]] = frozenset({'_req_done', 'acq_done', 'done_moving', 'readback', 'start_moving'})
          diff --git a/master/generated/pcdsdevices.beam_stats.LCLS.html b/master/generated/pcdsdevices.beam_stats.LCLS.html index 07a32a21e71..62a4757828c 100644 --- a/master/generated/pcdsdevices.beam_stats.LCLS.html +++ b/master/generated/pcdsdevices.beam_stats.LCLS.html @@ -1,25 +1,23 @@ + + - pcdsdevices.beam_stats.LCLS — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.beam_stats.LCLS — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -
          - 8.5.1.dev30+gd6e98430 -
          @@ -93,6 +88,7 @@
        • pcdsdevices.ipm
        • pcdsdevices.jet
        • pcdsdevices.keithley
        • +
        • pcdsdevices.lakeshore
        • pcdsdevices.lamp_motion
        • pcdsdevices.lasers.btps
        • pcdsdevices.lasers.counters
        • @@ -401,14 +397,14 @@

          pcdsdevices.beam_stats.LCLS
          -configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]
          +configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]

          Configure the device for something during a run

          This default implementation allows the user to change any of the configuration_attrs. Subclasses might override this to perform additional input validation, cleanup, etc.

          Parameters:
          -

          d (dict) – The configuration dictionary. To specify the order that +

          d (dict) – The configuration dictionary. To specify the order that the changes should be made, use an OrderedDict.

          Returns:
          @@ -423,7 +419,7 @@

          pcdsdevices.beam_stats.LCLS
          -describe() OrderedDictType[str, Dict[str, Any]]
          +describe() OrderedDictType[str, Dict[str, Any]]

          Provide schema and meta-data for read().

          This keys in the OrderedDict this method returns must match the keys in the OrderedDict return by read().

          @@ -453,7 +449,7 @@

          pcdsdevices.beam_stats.LCLS
          -read() OrderedDictType[str, Dict[str, Any]]
          +read() OrderedDictType[str, Dict[str, Any]]

          Read data from the device.

          This method is expected to be as instantaneous as possible, with any substantial acquisition time taken care of in @@ -476,7 +472,7 @@

          pcdsdevices.beam_stats.LCLS
          -read_configuration() OrderedDictType[str, Dict[str, Any]]
          +read_configuration() OrderedDictType[str, Dict[str, Any]]

          Dictionary mapping names to value dicts with keys: value, timestamp

          To control which fields are included, change the Component kinds on the device, or modify the configuration_attrs list.

          @@ -492,7 +488,7 @@

          pcdsdevices.beam_stats.LCLS
          -status() str
          +status() str

          Returns a str with the current pv values for the device.

          @@ -509,7 +505,7 @@

          pcdsdevices.beam_stats.LCLS
          -trigger() StatusBase
          +trigger() StatusBase

          Trigger the device and return status object.

          This method is responsible for implementing ‘trigger’ or ‘acquire’ functionality of this device.

          @@ -517,14 +513,14 @@

          pcdsdevices.beam_stats.LCLSread() method) then this method is also responsible for arranging that the -StatusBase object returned by this method +StatusBase object returned by this method is notified when the device is ready to be read.

          If there is no delay between triggering and being readable, -then this method must return a StatusBase +then this method must return a StatusBase object which is already completed.

          Returns:
          -

          status (StatusBase) – StatusBase object which will be marked +

          status (StatusBase) – StatusBase object which will be marked as complete when the device is ready to be read.

          @@ -553,7 +549,7 @@

          pcdsdevices.beam_stats.LCLS
          -subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})
          +subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})

          diff --git a/master/generated/pcdsdevices.ccm.CCM.html b/master/generated/pcdsdevices.ccm.CCM.html index 710a0e31811..d892edacc8e 100644 --- a/master/generated/pcdsdevices.ccm.CCM.html +++ b/master/generated/pcdsdevices.ccm.CCM.html @@ -1,25 +1,23 @@ + + - pcdsdevices.ccm.CCM — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.ccm.CCM — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -
          - 8.5.1.dev30+gd6e98430 -
          @@ -101,6 +96,7 @@
        • pcdsdevices.ipm
        • pcdsdevices.jet
        • pcdsdevices.keithley
        • +
        • pcdsdevices.lakeshore
        • pcdsdevices.lamp_motion
        • pcdsdevices.lasers.btps
        • pcdsdevices.lasers.counters
        • @@ -210,7 +206,7 @@

          pcdsdevices.ccm.CCM

          -class pcdsdevices.ccm.CCM(*, prefix: str | None = None, in_pos: float, out_pos: float, **kwargs)
          +class pcdsdevices.ccm.CCM(*, prefix: str | None = None, in_pos: float, out_pos: float, **kwargs)

          The full CCM assembly.

          This requires a huge number of motor pv prefixes to be passed in. Pay attention to this docstring because most of the arguments are in @@ -218,26 +214,26 @@

          pcdsdevices.ccm.CCM
          Parameters:
            -
          • prefix (str, optional) – Devices are required to have a positional argument here, +

          • prefix (str, optional) – Devices are required to have a positional argument here, but this is not used. If provided, it should be the same as alio_prefix.

          • -
          • in_pos (float, required keyword) – The x position to consider as “inserted” into the beam.

          • -
          • out_pos (float, required keyword) – The x position to consider as “removed” from the beam.

          • -
          • alio_prefix (str, required keyword) – The PV prefix of the Alio motor, e.g. XPP:MON:MPZ:07A

          • -
          • theta2fine_prefix (str, required keyword) – The PV prefix of the motor that controls the fine adjustment +

          • in_pos (float, required keyword) – The x position to consider as “inserted” into the beam.

          • +
          • out_pos (float, required keyword) – The x position to consider as “removed” from the beam.

          • +
          • alio_prefix (str, required keyword) – The PV prefix of the Alio motor, e.g. XPP:MON:MPZ:07A

          • +
          • theta2fine_prefix (str, required keyword) – The PV prefix of the motor that controls the fine adjustment of the of the second crystal’s theta angle.

          • -
          • theta2coarse_prefix (str, required keyword) – The PV prefix of the motor that controls the coarse adjustment +

          • theta2coarse_prefix (str, required keyword) – The PV prefix of the motor that controls the coarse adjustment of the of the second crystal’s theta angle.

          • -
          • chi2_prefix (str, required keyword) – The PV prefix of the motor that controls the adjustment +

          • chi2_prefix (str, required keyword) – The PV prefix of the motor that controls the adjustment of the of the second crystal’s chi angle.

          • -
          • x_down_prefix (str, required keyword) – The prefix for the downstream ccm x translation motor (x1).

          • -
          • x_up_prefix (str, required keyword) – The prefix for the upstream ccm x translation motor (x2).

          • -
          • y_down_prefix (str, required keyword) – The prefix for the downstream ccm y translation motor (y1).

          • -
          • y_up_north_prefix (str, required keyword) – The prefix for the north upstream ccm y translation motor (y2).

          • -
          • y_up_south_prefix (str, required keyword) – The prefix for the south upstream ccm y translation motor (y3).

          • -
          • acr_status_pv_index (int) – The index for the energy request PV in the case of the acr status +

          • x_down_prefix (str, required keyword) – The prefix for the downstream ccm x translation motor (x1).

          • +
          • x_up_prefix (str, required keyword) – The prefix for the upstream ccm x translation motor (x2).

          • +
          • y_down_prefix (str, required keyword) – The prefix for the downstream ccm y translation motor (y1).

          • +
          • y_up_north_prefix (str, required keyword) – The prefix for the north upstream ccm y translation motor (y2).

          • +
          • y_up_south_prefix (str, required keyword) – The prefix for the south upstream ccm y translation motor (y3).

          • +
          • acr_status_pv_index (int) – The index for the energy request PV in the case of the acr status wait. Default: 2.

          • -
          • acr_status_suffix (str) – The suffix for the ACR status energy change move. Default to ‘AO805’

          • +
          • acr_status_suffix (str) – The suffix for the ACR status energy change move. Default to ‘AO805’

          @@ -356,21 +352,21 @@

          pcdsdevices.ccm.CCMMethods

          -calc_lightpath_state(x_up: float) LightpathState
          +calc_lightpath_state(x_up: float) LightpathState

          Update the fields used by the lightpath to determine in/out.

          Compares the x position with the saved in and out values.

          -configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]
          +configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]

          Configure the device for something during a run

          This default implementation allows the user to change any of the configuration_attrs. Subclasses might override this to perform additional input validation, cleanup, etc.

          Parameters:
          -

          d (dict) – The configuration dictionary. To specify the order that +

          d (dict) – The configuration dictionary. To specify the order that the changes should be made, use an OrderedDict.

          Returns:
          @@ -385,7 +381,7 @@

          pcdsdevices.ccm.CCM
          -describe() OrderedDictType[str, Dict[str, Any]]
          +describe() OrderedDictType[str, Dict[str, Any]]

          Provide schema and meta-data for read().

          This keys in the OrderedDict this method returns must match the keys in the OrderedDict return by read().

          @@ -409,7 +405,7 @@

          pcdsdevices.ccm.CCM
          -get_lightpath_state(use_cache: bool = True) LightpathState
          +get_lightpath_state(use_cache: bool = True) LightpathState

          Return the current LightpathState

          Returns:
          @@ -420,11 +416,11 @@

          pcdsdevices.ccm.CCM
          -insert(wait: bool = False) MoveStatus
          +insert(wait: bool = False) MoveStatus

          Move the x motors to the saved “in” position.

          Parameters:
          -

          wait (bool, optional) – If True, wait for the move to complete. +

          wait (bool, optional) – If True, wait for the move to complete. If False, return without waiting.

          Returns:
          @@ -442,7 +438,7 @@

          pcdsdevices.ccm.CCM
          -read() OrderedDictType[str, Dict[str, Any]]
          +read() OrderedDictType[str, Dict[str, Any]]

          Read data from the device.

          This method is expected to be as instantaneous as possible, with any substantial acquisition time taken care of in @@ -465,7 +461,7 @@

          pcdsdevices.ccm.CCM
          -read_configuration() OrderedDictType[str, Dict[str, Any]]
          +read_configuration() OrderedDictType[str, Dict[str, Any]]

          Dictionary mapping names to value dicts with keys: value, timestamp

          To control which fields are included, change the Component kinds on the device, or modify the configuration_attrs list.

          @@ -473,11 +469,11 @@

          pcdsdevices.ccm.CCM
          -remove(wait: bool = False) MoveStatus
          +remove(wait: bool = False) MoveStatus

          Move the x motors to the saved “out” position.

          Parameters:
          -

          wait (bool, optional) – If True, wait for the move to complete. +

          wait (bool, optional) – If True, wait for the move to complete. If False, return without waiting.

          Returns:
          @@ -489,7 +485,7 @@

          pcdsdevices.ccm.CCM
          -reset_calc_constant_defaults(confirm: bool = True) None
          +reset_calc_constant_defaults(confirm: bool = True) None

          Put the default values into the ccm constants.

          This can be useful if values were reset due to autosave errors or if they’ve otherwise accidentally been set to crazy values.

          @@ -500,7 +496,7 @@

          pcdsdevices.ccm.CCM
          Parameters:
          -

          confirm (bool, optional) – If True, we’ll ask for confirmation from the user before doing +

          confirm (bool, optional) – If True, we’ll ask for confirmation from the user before doing the reset. This is because an accidental reset can cost some time as we scramble to figure out what the values should be restored to.

          @@ -518,13 +514,13 @@

          pcdsdevices.ccm.CCM
          -stage_group_instances() Iterator[OphydObject]
          +stage_group_instances() Iterator[OphydObject]

          Yields an iterator of subdevices that should be staged.

          -status() str
          +status() str

          Returns a str with the current pv values for the device.

          @@ -541,7 +537,7 @@

          pcdsdevices.ccm.CCM
          -trigger() StatusBase
          +trigger() StatusBase

          Trigger the device and return status object.

          This method is responsible for implementing ‘trigger’ or ‘acquire’ functionality of this device.

          @@ -549,14 +545,14 @@

          pcdsdevices.ccm.CCMread() method) then this method is also responsible for arranging that the -StatusBase object returned by this method +StatusBase object returned by this method is notified when the device is ready to be read.

          If there is no delay between triggering and being readable, -then this method must return a StatusBase +then this method must return a StatusBase object which is already completed.

          Returns:
          -

          status (StatusBase) – StatusBase object which will be marked +

          status (StatusBase) – StatusBase object which will be marked as complete when the device is ready to be read.

          @@ -564,7 +560,7 @@

          pcdsdevices.ccm.CCM
          -warn_invalid_constants(only_new: bool = False) None
          +warn_invalid_constants(only_new: bool = False) None

          Warn if we have invalid values for our calculation constants.

          The motivation here is twofold: 1. It should be easy for the user to know what is wrong and

          @@ -610,7 +606,7 @@

          pcdsdevices.ccm.CCM
          Parameters:
          -

          only_new (bool, optional) – If False, the default, always show us the warnings. +

          only_new (bool, optional) – If False, the default, always show us the warnings. If True, do not show warnings if they have not changed.

          @@ -685,17 +681,17 @@

          pcdsdevices.ccm.CCM
          -needs_parent: list[type[OphydObject]] = [<class 'ophyd.signal.AttributeSignal'>, <class 'ophyd.signal.DerivedSignal'>, <class 'ophyd.areadetector.plugins.PluginBase'>, <class 'ophyd.pseudopos.PseudoSingle'>, <class 'pcdsdevices.signal.PVStateSignal'>, <class 'pcdsdevices.signal.AggregateSignal'>]
          +needs_parent: list[type[OphydObject]] = [<class 'ophyd.signal.AttributeSignal'>, <class 'ophyd.signal.DerivedSignal'>, <class 'ophyd.areadetector.plugins.PluginBase'>, <class 'ophyd.pseudopos.PseudoSingle'>, <class 'pcdsdevices.signal.PVStateSignal'>, <class 'pcdsdevices.signal.AggregateSignal'>]

          -stage_group: list[Component] = None
          +stage_group: list[Component] = None
          -subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})
          +subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})
          diff --git a/master/generated/pcdsdevices.ccm.CCMAlio.html b/master/generated/pcdsdevices.ccm.CCMAlio.html index 0b5e76c9e1b..ea84ff71e0a 100644 --- a/master/generated/pcdsdevices.ccm.CCMAlio.html +++ b/master/generated/pcdsdevices.ccm.CCMAlio.html @@ -1,25 +1,23 @@ + + - pcdsdevices.ccm.CCMAlio — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.ccm.CCMAlio — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -
          - 8.5.1.dev30+gd6e98430 -
          @@ -101,6 +96,7 @@
        • pcdsdevices.ipm
        • pcdsdevices.jet
        • pcdsdevices.keithley
        • +
        • pcdsdevices.lakeshore
        • pcdsdevices.lamp_motion
        • pcdsdevices.lasers.btps
        • pcdsdevices.lasers.counters
        • @@ -276,14 +272,14 @@

          pcdsdevices.ccm.CCMAlio
          -configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]
          +configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]

          Configure the device for something during a run

          This default implementation allows the user to change any of the configuration_attrs. Subclasses might override this to perform additional input validation, cleanup, etc.

          Parameters:
          -

          d (dict) – The configuration dictionary. To specify the order that +

          d (dict) – The configuration dictionary. To specify the order that the changes should be made, use an OrderedDict.

          Returns:
          @@ -298,7 +294,7 @@

          pcdsdevices.ccm.CCMAlio
          -describe() OrderedDictType[str, Dict[str, Any]]
          +describe() OrderedDictType[str, Dict[str, Any]]

          Provide schema and meta-data for read().

          This keys in the OrderedDict this method returns must match the keys in the OrderedDict return by read().

          @@ -335,14 +331,14 @@

          pcdsdevices.ccm.CCMAlio
          -home() None
          +home() None

          Finds the reference used for the Alio’s position.

          Same as pressing “HOME” in the edm screen.

          -kill() None
          +kill() None

          Terminates the motion PID

          Same as pressing “KILL” in the edm screen.

          @@ -359,7 +355,7 @@

          pcdsdevices.ccm.CCMAlio

          moved_cb (callable) – Call this callback when movement has finished. This callback must accept one keyword argument: ‘obj’ which will be set to this positioner instance.

          -
        • timeout (float, optional) – Maximum time to wait for the motion. If None, the default timeout +

        • timeout (float, optional) – Maximum time to wait for the motion. If None, the default timeout for this positioner is used.

        • @@ -368,9 +364,9 @@

          pcdsdevices.ccm.CCMAlio
          Raises:

          @@ -384,12 +380,12 @@

          pcdsdevices.ccm.CCMAlioParameters:
          • position – Desired end position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • wait (bool, optional) – If True, wait for motion completion before returning. +

          • wait (bool, optional) – If True, wait for motion completion before returning. Defaults to False.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          @@ -411,13 +407,13 @@

          pcdsdevices.ccm.CCMAlio
          Parameters:
            -
          • delta (float) – Desired change in position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • delta (float) – Desired change in position.

          • +
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • wait (bool, optional) – If True, wait for motion completion before returning. +

          • wait (bool, optional) – If True, wait for motion completion before returning. Defaults to False.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          @@ -431,7 +427,7 @@

          pcdsdevices.ccm.CCMAlio
          -read() OrderedDictType[str, Dict[str, Any]]
          +read() OrderedDictType[str, Dict[str, Any]]

          Read data from the device.

          This method is expected to be as instantaneous as possible, with any substantial acquisition time taken care of in @@ -454,7 +450,7 @@

          pcdsdevices.ccm.CCMAlio
          -read_configuration() OrderedDictType[str, Dict[str, Any]]
          +read_configuration() OrderedDictType[str, Dict[str, Any]]

          Dictionary mapping names to value dicts with keys: value, timestamp

          To control which fields are included, change the Component kinds on the device, or modify the configuration_attrs list.

          @@ -470,23 +466,23 @@

          pcdsdevices.ccm.CCMAlio
          -set(new_position: Any, *, timeout: float | None = None, moved_cb: Callable | None = None, wait: bool = False) StatusBase
          +set(new_position: Any, *, timeout: float | None = None, moved_cb: Callable | None = None, wait: bool = False) StatusBase

          Set a value and return a Status object

          Parameters:
            -
          • new_position (object) – The input here is whatever the device requires (this +

          • new_position (object) – The input here is whatever the device requires (this should be over-ridden by the implementation. For example a motor would take a float, a shutter the strings {‘Open’, ‘Close’}, and a goineometer (h, k, l) tuples

          • -
          • timeout (float, optional) – Maximum time to wait for the motion. If None, the default timeout +

          • timeout (float, optional) – Maximum time to wait for the motion. If None, the default timeout for this positioner is used.

          • moved_cb (callable, optional) –

            Deprecated

            Call this callback when movement has finished. This callback must accept one keyword argument: ‘obj’ which will be set to this positioner instance.

          • -
          • wait (bool, optional) –

            Deprecated

            +
          • wait (bool, optional) –

            Deprecated

            If the method should block until the Status object reports it is done.

            Defaults to False

            @@ -508,7 +504,7 @@

            pcdsdevices.ccm.CCMAlio
            -status() str
            +status() str

            Returns a str with the current pv values for the device.

          @@ -525,7 +521,7 @@

          pcdsdevices.ccm.CCMAlio
          -trigger() StatusBase
          +trigger() StatusBase

          Trigger the device and return status object.

          This method is responsible for implementing ‘trigger’ or ‘acquire’ functionality of this device.

          @@ -533,14 +529,14 @@

          pcdsdevices.ccm.CCMAlioread() method) then this method is also responsible for arranging that the -StatusBase object returned by this method +StatusBase object returned by this method is notified when the device is ready to be read.

          If there is no delay between triggering and being readable, -then this method must return a StatusBase +then this method must return a StatusBase object which is already completed.

          Returns:
          -

          status (StatusBase) – StatusBase object which will be marked +

          status (StatusBase) – StatusBase object which will be marked as complete when the device is ready to be read.

          @@ -555,7 +551,7 @@

          pcdsdevices.ccm.CCMAlio
          Parameters:
          -

          scale (float) – starting step size, default = 0.1

          +

          scale (float) – starting step size, default = 0.1

          @@ -567,12 +563,12 @@

          pcdsdevices.ccm.CCMAlio
          Parameters:
            -
          • position (float) – Desired end position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • position (float) – Desired end position.

          • +
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • -
          • newline (bool, optional) – If True, inserts a newline after the updates.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • newline (bool, optional) – If True, inserts a newline after the updates.

          @@ -585,12 +581,12 @@

          pcdsdevices.ccm.CCMAlio
          Parameters:
            -
          • delta (float) – Desired change in position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • delta (float) – Desired change in position.

          • +
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • -
          • newline (bool, optional) – If True, inserts a newline after the updates.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • newline (bool, optional) – If True, inserts a newline after the updates.

          @@ -732,7 +728,7 @@

          pcdsdevices.ccm.CCMAlio
          -subscriptions: ClassVar[FrozenSet[str]] = frozenset({'_req_done', 'acq_done', 'done_moving', 'readback', 'start_moving'})
          +subscriptions: ClassVar[FrozenSet[str]] = frozenset({'_req_done', 'acq_done', 'done_moving', 'readback', 'start_moving'})
          diff --git a/master/generated/pcdsdevices.ccm.CCMConstantsMixin.html b/master/generated/pcdsdevices.ccm.CCMConstantsMixin.html index bdb8b53691b..5bb5fbcfaa2 100644 --- a/master/generated/pcdsdevices.ccm.CCMConstantsMixin.html +++ b/master/generated/pcdsdevices.ccm.CCMConstantsMixin.html @@ -1,25 +1,23 @@ + + - pcdsdevices.ccm.CCMConstantsMixin — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.ccm.CCMConstantsMixin — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -
          - 8.5.1.dev30+gd6e98430 -
          @@ -101,6 +96,7 @@
        • pcdsdevices.ipm
        • pcdsdevices.jet
        • pcdsdevices.keithley
        • +
        • pcdsdevices.lakeshore
        • pcdsdevices.lamp_motion
        • pcdsdevices.lasers.btps
        • pcdsdevices.lasers.counters
        • @@ -210,7 +206,7 @@

          pcdsdevices.ccm.CCMConstantsMixin

          -class pcdsdevices.ccm.CCMConstantsMixin(prefix: str, *args, **kwargs)
          +class pcdsdevices.ccm.CCMConstantsMixin(prefix: str, *args, **kwargs)

          Mixin class that includes PVs that hold CCM constants.

          This allows us to keep the CCM parameters synchronized between sessions and between different devices in the same session.

          @@ -263,14 +259,14 @@

          pcdsdevices.ccm.CCMConstantsMixinMethods

          -configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]
          +configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]

          Configure the device for something during a run

          This default implementation allows the user to change any of the configuration_attrs. Subclasses might override this to perform additional input validation, cleanup, etc.

          Parameters:
          -

          d (dict) – The configuration dictionary. To specify the order that +

          d (dict) – The configuration dictionary. To specify the order that the changes should be made, use an OrderedDict.

          Returns:
          @@ -285,7 +281,7 @@

          pcdsdevices.ccm.CCMConstantsMixin
          -describe() OrderedDictType[str, Dict[str, Any]]
          +describe() OrderedDictType[str, Dict[str, Any]]

          Provide schema and meta-data for read().

          This keys in the OrderedDict this method returns must match the keys in the OrderedDict return by read().

          @@ -309,7 +305,7 @@

          pcdsdevices.ccm.CCMConstantsMixin
          -read() OrderedDictType[str, Dict[str, Any]]
          +read() OrderedDictType[str, Dict[str, Any]]

          Read data from the device.

          This method is expected to be as instantaneous as possible, with any substantial acquisition time taken care of in @@ -332,7 +328,7 @@

          pcdsdevices.ccm.CCMConstantsMixin
          -read_configuration() OrderedDictType[str, Dict[str, Any]]
          +read_configuration() OrderedDictType[str, Dict[str, Any]]

          Dictionary mapping names to value dicts with keys: value, timestamp

          To control which fields are included, change the Component kinds on the device, or modify the configuration_attrs list.

          @@ -340,7 +336,7 @@

          pcdsdevices.ccm.CCMConstantsMixin
          -reset_calc_constant_defaults(confirm: bool = True) None
          +reset_calc_constant_defaults(confirm: bool = True) None

          Put the default values into the ccm constants.

          This can be useful if values were reset due to autosave errors or if they’ve otherwise accidentally been set to crazy values.

          @@ -351,7 +347,7 @@

          pcdsdevices.ccm.CCMConstantsMixin
          Parameters:
          -

          confirm (bool, optional) – If True, we’ll ask for confirmation from the user before doing +

          confirm (bool, optional) – If True, we’ll ask for confirmation from the user before doing the reset. This is because an accidental reset can cost some time as we scramble to figure out what the values should be restored to.

          @@ -372,7 +368,7 @@

          pcdsdevices.ccm.CCMConstantsMixin
          -trigger() StatusBase
          +trigger() StatusBase

          Trigger the device and return status object.

          This method is responsible for implementing ‘trigger’ or ‘acquire’ functionality of this device.

          @@ -380,14 +376,14 @@

          pcdsdevices.ccm.CCMConstantsMixinread() method) then this method is also responsible for arranging that the -StatusBase object returned by this method +StatusBase object returned by this method is notified when the device is ready to be read.

          If there is no delay between triggering and being readable, -then this method must return a StatusBase +then this method must return a StatusBase object which is already completed.

          Returns:
          -

          status (StatusBase) – StatusBase object which will be marked +

          status (StatusBase) – StatusBase object which will be marked as complete when the device is ready to be read.

          @@ -395,7 +391,7 @@

          pcdsdevices.ccm.CCMConstantsMixin
          -warn_invalid_constants(only_new: bool = False) None
          +warn_invalid_constants(only_new: bool = False) None

          Warn if we have invalid values for our calculation constants.

          The motivation here is twofold: 1. It should be easy for the user to know what is wrong and

          @@ -441,7 +437,7 @@

          pcdsdevices.ccm.CCMConstantsMixin
          Parameters:
          -

          only_new (bool, optional) – If False, the default, always show us the warnings. +

          only_new (bool, optional) – If False, the default, always show us the warnings. If True, do not show warnings if they have not changed.

          @@ -506,7 +502,7 @@

          pcdsdevices.ccm.CCMConstantsMixin
          -subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})
          +subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})

          diff --git a/master/generated/pcdsdevices.ccm.CCMEnergy.html b/master/generated/pcdsdevices.ccm.CCMEnergy.html index 280bce8fdff..d8561845da1 100644 --- a/master/generated/pcdsdevices.ccm.CCMEnergy.html +++ b/master/generated/pcdsdevices.ccm.CCMEnergy.html @@ -1,25 +1,23 @@ + + - pcdsdevices.ccm.CCMEnergy — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.ccm.CCMEnergy — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -
          - 8.5.1.dev30+gd6e98430 -
          @@ -101,6 +96,7 @@
        • pcdsdevices.ipm
        • pcdsdevices.jet
        • pcdsdevices.keithley
        • +
        • pcdsdevices.lakeshore
        • pcdsdevices.lamp_motion
        • pcdsdevices.lasers.btps
        • pcdsdevices.lasers.counters
        • @@ -217,7 +213,7 @@

          pcdsdevices.ccm.CCMEnergy
          Parameters:
          -

          prefix (str) – The PV prefix of the Alio motor, e.g. XPP:MON:MPZ:07A

          +

          prefix (str) – The PV prefix of the Alio motor, e.g. XPP:MON:MPZ:07A

          Ophyd Device Components
          @@ -300,11 +296,11 @@

          pcdsdevices.ccm.CCMEnergyMethods

          -alio_to_energy(alio: float) float
          +alio_to_energy(alio: float) float

          Converts alio to energy.

          Parameters:
          -

          alio (float) – The alio position in mm

          +

          alio (float) – The alio position in mm

          Returns:

          energy (float) – The photon energy (color) in keV.

          @@ -331,14 +327,14 @@

          pcdsdevices.ccm.CCMEnergy
          -configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]
          +configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]

          Configure the device for something during a run

          This default implementation allows the user to change any of the configuration_attrs. Subclasses might override this to perform additional input validation, cleanup, etc.

          Parameters:
          -

          d (dict) – The configuration dictionary. To specify the order that +

          d (dict) – The configuration dictionary. To specify the order that the changes should be made, use an OrderedDict.

          Returns:
          @@ -353,7 +349,7 @@

          pcdsdevices.ccm.CCMEnergy
          -describe() OrderedDictType[str, Dict[str, Any]]
          +describe() OrderedDictType[str, Dict[str, Any]]

          Provide schema and meta-data for read().

          This keys in the OrderedDict this method returns must match the keys in the OrderedDict return by read().

          @@ -376,11 +372,11 @@

          pcdsdevices.ccm.CCMEnergy
          -energy_to_alio(energy: float) float
          +energy_to_alio(energy: float) float

          Converts energy to alio.

          Parameters:
          -

          energy (float) – The photon energy (color) in keV.

          +

          energy (float) – The photon energy (color) in keV.

          Returns:

          alio (float) – The alio position in mm

          @@ -433,8 +429,8 @@

          pcdsdevices.ccm.CCMEnergyParameters:

          @@ -448,12 +444,12 @@

          pcdsdevices.ccm.CCMEnergyParameters:
          • position – Desired end position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • wait (bool, optional) – If True, wait for motion completion before returning. +

          • wait (bool, optional) – If True, wait for motion completion before returning. Defaults to False.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          @@ -475,13 +471,13 @@

          pcdsdevices.ccm.CCMEnergy
          Parameters:
            -
          • delta (float) – Desired change in position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • delta (float) – Desired change in position.

          • +
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • wait (bool, optional) – If True, wait for motion completion before returning. +

          • wait (bool, optional) – If True, wait for motion completion before returning. Defaults to False.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          @@ -495,7 +491,7 @@

          pcdsdevices.ccm.CCMEnergy
          -read() OrderedDictType[str, Dict[str, Any]]
          +read() OrderedDictType[str, Dict[str, Any]]

          Read data from the device.

          This method is expected to be as instantaneous as possible, with any substantial acquisition time taken care of in @@ -518,7 +514,7 @@

          pcdsdevices.ccm.CCMEnergy
          -read_configuration() OrderedDictType[str, Dict[str, Any]]
          +read_configuration() OrderedDictType[str, Dict[str, Any]]

          Dictionary mapping names to value dicts with keys: value, timestamp

          To control which fields are included, change the Component kinds on the device, or modify the configuration_attrs list.

          @@ -526,7 +522,7 @@

          pcdsdevices.ccm.CCMEnergy
          -reset_calc_constant_defaults(confirm: bool = True) None
          +reset_calc_constant_defaults(confirm: bool = True) None

          Put the default values into the ccm constants.

          This can be useful if values were reset due to autosave errors or if they’ve otherwise accidentally been set to crazy values.

          @@ -537,7 +533,7 @@

          pcdsdevices.ccm.CCMEnergy
          Parameters:
          -

          confirm (bool, optional) – If True, we’ll ask for confirmation from the user before doing +

          confirm (bool, optional) – If True, we’ll ask for confirmation from the user before doing the reset. This is because an accidental reset can cost some time as we scramble to figure out what the values should be restored to.

          @@ -569,7 +565,7 @@

          pcdsdevices.ccm.CCMEnergy
          -set_current_position(energy: float) None
          +set_current_position(energy: float) None

          Adjust the offset to make input energy the current position.

          This changes the value of the theta0 PV.

          @@ -583,7 +579,7 @@

          pcdsdevices.ccm.CCMEnergy
          -status() str
          +status() str

          Returns a str with the current pv values for the device.

          @@ -612,7 +608,7 @@

          pcdsdevices.ccm.CCMEnergy
          -trigger() StatusBase
          +trigger() StatusBase

          Trigger the device and return status object.

          This method is responsible for implementing ‘trigger’ or ‘acquire’ functionality of this device.

          @@ -620,14 +616,14 @@

          pcdsdevices.ccm.CCMEnergyread() method) then this method is also responsible for arranging that the -StatusBase object returned by this method +StatusBase object returned by this method is notified when the device is ready to be read.

          If there is no delay between triggering and being readable, -then this method must return a StatusBase +then this method must return a StatusBase object which is already completed.

          Returns:
          -

          status (StatusBase) – StatusBase object which will be marked +

          status (StatusBase) – StatusBase object which will be marked as complete when the device is ready to be read.

          @@ -642,7 +638,7 @@

          pcdsdevices.ccm.CCMEnergy
          Parameters:
          -

          scale (float) – starting step size, default = 0.1

          +

          scale (float) – starting step size, default = 0.1

          @@ -654,12 +650,12 @@

          pcdsdevices.ccm.CCMEnergy
          Parameters:
            -
          • position (float) – Desired end position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • position (float) – Desired end position.

          • +
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • -
          • newline (bool, optional) – If True, inserts a newline after the updates.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • newline (bool, optional) – If True, inserts a newline after the updates.

          @@ -672,12 +668,12 @@

          pcdsdevices.ccm.CCMEnergy
          Parameters:
            -
          • delta (float) – Desired change in position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • delta (float) – Desired change in position.

          • +
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • -
          • newline (bool, optional) – If True, inserts a newline after the updates.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • newline (bool, optional) – If True, inserts a newline after the updates.

          @@ -690,7 +686,7 @@

          pcdsdevices.ccm.CCMEnergy
          -warn_invalid_constants(only_new: bool = False) None
          +warn_invalid_constants(only_new: bool = False) None

          Warn if we have invalid values for our calculation constants.

          The motivation here is twofold: 1. It should be easy for the user to know what is wrong and

          @@ -736,7 +732,7 @@

          pcdsdevices.ccm.CCMEnergy
          Parameters:
          -

          only_new (bool, optional) – If False, the default, always show us the warnings. +

          only_new (bool, optional) – If False, the default, always show us the warnings. If True, do not show warnings if they have not changed.

          @@ -906,7 +902,7 @@

          pcdsdevices.ccm.CCMEnergy
          -subscriptions: ClassVar[FrozenSet[str]] = frozenset({'_req_done', 'acq_done', 'done_moving', 'readback', 'start_moving'})
          +subscriptions: ClassVar[FrozenSet[str]] = frozenset({'_req_done', 'acq_done', 'done_moving', 'readback', 'start_moving'})
          diff --git a/master/generated/pcdsdevices.ccm.CCMEnergyWithACRStatus.html b/master/generated/pcdsdevices.ccm.CCMEnergyWithACRStatus.html index b339cd98f5e..297afef4e8e 100644 --- a/master/generated/pcdsdevices.ccm.CCMEnergyWithACRStatus.html +++ b/master/generated/pcdsdevices.ccm.CCMEnergyWithACRStatus.html @@ -1,25 +1,23 @@ + + - pcdsdevices.ccm.CCMEnergyWithACRStatus — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.ccm.CCMEnergyWithACRStatus — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -
          - 8.5.1.dev30+gd6e98430 -
          @@ -101,6 +96,7 @@
        • pcdsdevices.ipm
        • pcdsdevices.jet
        • pcdsdevices.keithley
        • +
        • pcdsdevices.lakeshore
        • pcdsdevices.lamp_motion
        • pcdsdevices.lasers.btps
        • pcdsdevices.lasers.counters
        • @@ -210,7 +206,7 @@

          pcdsdevices.ccm.CCMEnergyWithACRStatus

          -class pcdsdevices.ccm.CCMEnergyWithACRStatus(prefix: str, hutch: str | None = None, acr_status_suffix='AO805', pv_index=2, **kwargs)
          +class pcdsdevices.ccm.CCMEnergyWithACRStatus(prefix: str, hutch: str | None = None, acr_status_suffix='AO805', pv_index=2, **kwargs)

          CCM energy motor and ACR beam energy request with status. Note that in this case vernier indicates any ways that ACR will act on the photon energy request. This includes the Vernier, but can also lead to @@ -218,11 +214,11 @@

          pcdsdevices.ccm.CCMEnergyWithACRStatus
          Parameters:
            -
          • prefix (str) – The PV prefix of the Alio motor, e.g. XPP:MON:MPZ:07A

          • -
          • hutch (str, optional) – The hutch we’re in. This informs us as to which vernier +

          • prefix (str) – The PV prefix of the Alio motor, e.g. XPP:MON:MPZ:07A

          • +
          • hutch (str, optional) – The hutch we’re in. This informs us as to which vernier PVs to write to. If omitted, we can guess this from the prefix.

          • -
          • acr_status_sufix (str) – Prefix to the SIOC PV that ACR uses to report the move status. +

          • acr_status_sufix (str) – Prefix to the SIOC PV that ACR uses to report the move status. For HXR this usually is ‘AO805’.

          @@ -314,11 +310,11 @@

          pcdsdevices.ccm.CCMEnergyWithACRStatusMethods

          -alio_to_energy(alio: float) float
          +alio_to_energy(alio: float) float

          Converts alio to energy.

          Parameters:
          -

          alio (float) – The alio position in mm

          +

          alio (float) – The alio position in mm

          Returns:

          energy (float) – The photon energy (color) in keV.

          @@ -345,14 +341,14 @@

          pcdsdevices.ccm.CCMEnergyWithACRStatus
          -configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]
          +configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]

          Configure the device for something during a run

          This default implementation allows the user to change any of the configuration_attrs. Subclasses might override this to perform additional input validation, cleanup, etc.

          Parameters:
          -

          d (dict) – The configuration dictionary. To specify the order that +

          d (dict) – The configuration dictionary. To specify the order that the changes should be made, use an OrderedDict.

          Returns:
          @@ -367,7 +363,7 @@

          pcdsdevices.ccm.CCMEnergyWithACRStatus
          -describe() OrderedDictType[str, Dict[str, Any]]
          +describe() OrderedDictType[str, Dict[str, Any]]

          Provide schema and meta-data for read().

          This keys in the OrderedDict this method returns must match the keys in the OrderedDict return by read().

          @@ -390,11 +386,11 @@

          pcdsdevices.ccm.CCMEnergyWithACRStatus
          -energy_to_alio(energy: float) float
          +energy_to_alio(energy: float) float

          Converts energy to alio.

          Parameters:
          -

          energy (float) – The photon energy (color) in keV.

          +

          energy (float) – The photon energy (color) in keV.

          Returns:

          alio (float) – The alio position in mm

          @@ -449,8 +445,8 @@

          pcdsdevices.ccm.CCMEnergyWithACRStatusParameters:

          @@ -464,12 +460,12 @@

          pcdsdevices.ccm.CCMEnergyWithACRStatusParameters:
          • position – Desired end position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • wait (bool, optional) – If True, wait for motion completion before returning. +

          • wait (bool, optional) – If True, wait for motion completion before returning. Defaults to False.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          @@ -491,13 +487,13 @@

          pcdsdevices.ccm.CCMEnergyWithACRStatus
          Parameters:
            -
          • delta (float) – Desired change in position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • delta (float) – Desired change in position.

          • +
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • wait (bool, optional) – If True, wait for motion completion before returning. +

          • wait (bool, optional) – If True, wait for motion completion before returning. Defaults to False.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          @@ -511,7 +507,7 @@

          pcdsdevices.ccm.CCMEnergyWithACRStatus
          -read() OrderedDictType[str, Dict[str, Any]]
          +read() OrderedDictType[str, Dict[str, Any]]

          Read data from the device.

          This method is expected to be as instantaneous as possible, with any substantial acquisition time taken care of in @@ -534,7 +530,7 @@

          pcdsdevices.ccm.CCMEnergyWithACRStatus
          -read_configuration() OrderedDictType[str, Dict[str, Any]]
          +read_configuration() OrderedDictType[str, Dict[str, Any]]

          Dictionary mapping names to value dicts with keys: value, timestamp

          To control which fields are included, change the Component kinds on the device, or modify the configuration_attrs list.

          @@ -542,7 +538,7 @@

          pcdsdevices.ccm.CCMEnergyWithACRStatus
          -reset_calc_constant_defaults(confirm: bool = True) None
          +reset_calc_constant_defaults(confirm: bool = True) None

          Put the default values into the ccm constants.

          This can be useful if values were reset due to autosave errors or if they’ve otherwise accidentally been set to crazy values.

          @@ -553,7 +549,7 @@

          pcdsdevices.ccm.CCMEnergyWithACRStatus
          Parameters:
          -

          confirm (bool, optional) – If True, we’ll ask for confirmation from the user before doing +

          confirm (bool, optional) – If True, we’ll ask for confirmation from the user before doing the reset. This is because an accidental reset can cost some time as we scramble to figure out what the values should be restored to.

          @@ -585,7 +581,7 @@

          pcdsdevices.ccm.CCMEnergyWithACRStatus
          -set_current_position(energy: float) None
          +set_current_position(energy: float) None

          Adjust the offset to make input energy the current position.

          This changes the value of the theta0 PV.

          @@ -599,7 +595,7 @@

          pcdsdevices.ccm.CCMEnergyWithACRStatus
          -status() str
          +status() str

          Returns a str with the current pv values for the device.

          @@ -628,7 +624,7 @@

          pcdsdevices.ccm.CCMEnergyWithACRStatus
          -trigger() StatusBase
          +trigger() StatusBase

          Trigger the device and return status object.

          This method is responsible for implementing ‘trigger’ or ‘acquire’ functionality of this device.

          @@ -636,14 +632,14 @@

          pcdsdevices.ccm.CCMEnergyWithACRStatusread() method) then this method is also responsible for arranging that the -StatusBase object returned by this method +StatusBase object returned by this method is notified when the device is ready to be read.

          If there is no delay between triggering and being readable, -then this method must return a StatusBase +then this method must return a StatusBase object which is already completed.

          Returns:
          -

          status (StatusBase) – StatusBase object which will be marked +

          status (StatusBase) – StatusBase object which will be marked as complete when the device is ready to be read.

          @@ -658,7 +654,7 @@

          pcdsdevices.ccm.CCMEnergyWithACRStatus
          Parameters:
          -

          scale (float) – starting step size, default = 0.1

          +

          scale (float) – starting step size, default = 0.1

          @@ -670,12 +666,12 @@

          pcdsdevices.ccm.CCMEnergyWithACRStatus
          Parameters:
            -
          • position (float) – Desired end position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • position (float) – Desired end position.

          • +
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • -
          • newline (bool, optional) – If True, inserts a newline after the updates.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • newline (bool, optional) – If True, inserts a newline after the updates.

          @@ -688,12 +684,12 @@

          pcdsdevices.ccm.CCMEnergyWithACRStatus
          Parameters:
            -
          • delta (float) – Desired change in position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • delta (float) – Desired change in position.

          • +
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • -
          • newline (bool, optional) – If True, inserts a newline after the updates.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • newline (bool, optional) – If True, inserts a newline after the updates.

          @@ -706,7 +702,7 @@

          pcdsdevices.ccm.CCMEnergyWithACRStatus
          -warn_invalid_constants(only_new: bool = False) None
          +warn_invalid_constants(only_new: bool = False) None

          Warn if we have invalid values for our calculation constants.

          The motivation here is twofold: 1. It should be easy for the user to know what is wrong and

          @@ -752,7 +748,7 @@

          pcdsdevices.ccm.CCMEnergyWithACRStatus
          Parameters:
          -

          only_new (bool, optional) – If False, the default, always show us the warnings. +

          only_new (bool, optional) – If False, the default, always show us the warnings. If True, do not show warnings if they have not changed.

          @@ -922,7 +918,7 @@

          pcdsdevices.ccm.CCMEnergyWithACRStatus
          -subscriptions: ClassVar[FrozenSet[str]] = frozenset({'_req_done', 'acq_done', 'done_moving', 'readback', 'start_moving'})
          +subscriptions: ClassVar[FrozenSet[str]] = frozenset({'_req_done', 'acq_done', 'done_moving', 'readback', 'start_moving'})
          @@ -957,7 +953,7 @@

          pcdsdevices.ccm.CCMEnergyWithACRStatus
          -hutch: str
          +hutch: str

          diff --git a/master/generated/pcdsdevices.ccm.CCMEnergyWithVernier.html b/master/generated/pcdsdevices.ccm.CCMEnergyWithVernier.html index 9933bc174b7..f9e18dceb31 100644 --- a/master/generated/pcdsdevices.ccm.CCMEnergyWithVernier.html +++ b/master/generated/pcdsdevices.ccm.CCMEnergyWithVernier.html @@ -1,25 +1,23 @@ + + - pcdsdevices.ccm.CCMEnergyWithVernier — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.ccm.CCMEnergyWithVernier — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -
          - 8.5.1.dev30+gd6e98430 -
          @@ -101,6 +96,7 @@
        • pcdsdevices.ipm
        • pcdsdevices.jet
        • pcdsdevices.keithley
        • +
        • pcdsdevices.lakeshore
        • pcdsdevices.lamp_motion
        • pcdsdevices.lasers.btps
        • pcdsdevices.lasers.counters
        • @@ -210,7 +206,7 @@

          pcdsdevices.ccm.CCMEnergyWithVernier

          -class pcdsdevices.ccm.CCMEnergyWithVernier(prefix: str, hutch: str | None = None, **kwargs)
          +class pcdsdevices.ccm.CCMEnergyWithVernier(prefix: str, hutch: str | None = None, **kwargs)

          CCM energy motor and the vernier.

          Moves the alio based on the requested energy using the values of the calculation constants, and reports the current energy @@ -221,8 +217,8 @@

          pcdsdevices.ccm.CCMEnergyWithVernier
          Parameters:
            -
          • prefix (str) – The PV prefix of the Alio motor, e.g. XPP:MON:MPZ:07A

          • -
          • hutch (str, optional) – The hutch we’re in. This informs us as to which vernier +

          • prefix (str) – The PV prefix of the Alio motor, e.g. XPP:MON:MPZ:07A

          • +
          • hutch (str, optional) – The hutch we’re in. This informs us as to which vernier PVs to write to. If omitted, we can guess this from the prefix.

          @@ -315,11 +311,11 @@

          pcdsdevices.ccm.CCMEnergyWithVernierMethods

          -alio_to_energy(alio: float) float
          +alio_to_energy(alio: float) float

          Converts alio to energy.

          Parameters:
          -

          alio (float) – The alio position in mm

          +

          alio (float) – The alio position in mm

          Returns:

          energy (float) – The photon energy (color) in keV.

          @@ -346,14 +342,14 @@

          pcdsdevices.ccm.CCMEnergyWithVernier
          -configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]
          +configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]

          Configure the device for something during a run

          This default implementation allows the user to change any of the configuration_attrs. Subclasses might override this to perform additional input validation, cleanup, etc.

          Parameters:
          -

          d (dict) – The configuration dictionary. To specify the order that +

          d (dict) – The configuration dictionary. To specify the order that the changes should be made, use an OrderedDict.

          Returns:
          @@ -368,7 +364,7 @@

          pcdsdevices.ccm.CCMEnergyWithVernier
          -describe() OrderedDictType[str, Dict[str, Any]]
          +describe() OrderedDictType[str, Dict[str, Any]]

          Provide schema and meta-data for read().

          This keys in the OrderedDict this method returns must match the keys in the OrderedDict return by read().

          @@ -391,11 +387,11 @@

          pcdsdevices.ccm.CCMEnergyWithVernier
          -energy_to_alio(energy: float) float
          +energy_to_alio(energy: float) float

          Converts energy to alio.

          Parameters:
          -

          energy (float) – The photon energy (color) in keV.

          +

          energy (float) – The photon energy (color) in keV.

          Returns:

          alio (float) – The alio position in mm

          @@ -450,8 +446,8 @@

          pcdsdevices.ccm.CCMEnergyWithVernierParameters:

          @@ -465,12 +461,12 @@

          pcdsdevices.ccm.CCMEnergyWithVernierParameters:
          • position – Desired end position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • wait (bool, optional) – If True, wait for motion completion before returning. +

          • wait (bool, optional) – If True, wait for motion completion before returning. Defaults to False.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          @@ -492,13 +488,13 @@

          pcdsdevices.ccm.CCMEnergyWithVernier
          Parameters:
            -
          • delta (float) – Desired change in position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • delta (float) – Desired change in position.

          • +
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • wait (bool, optional) – If True, wait for motion completion before returning. +

          • wait (bool, optional) – If True, wait for motion completion before returning. Defaults to False.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          @@ -512,7 +508,7 @@

          pcdsdevices.ccm.CCMEnergyWithVernier
          -read() OrderedDictType[str, Dict[str, Any]]
          +read() OrderedDictType[str, Dict[str, Any]]

          Read data from the device.

          This method is expected to be as instantaneous as possible, with any substantial acquisition time taken care of in @@ -535,7 +531,7 @@

          pcdsdevices.ccm.CCMEnergyWithVernier
          -read_configuration() OrderedDictType[str, Dict[str, Any]]
          +read_configuration() OrderedDictType[str, Dict[str, Any]]

          Dictionary mapping names to value dicts with keys: value, timestamp

          To control which fields are included, change the Component kinds on the device, or modify the configuration_attrs list.

          @@ -543,7 +539,7 @@

          pcdsdevices.ccm.CCMEnergyWithVernier
          -reset_calc_constant_defaults(confirm: bool = True) None
          +reset_calc_constant_defaults(confirm: bool = True) None

          Put the default values into the ccm constants.

          This can be useful if values were reset due to autosave errors or if they’ve otherwise accidentally been set to crazy values.

          @@ -554,7 +550,7 @@

          pcdsdevices.ccm.CCMEnergyWithVernier
          Parameters:
          -

          confirm (bool, optional) – If True, we’ll ask for confirmation from the user before doing +

          confirm (bool, optional) – If True, we’ll ask for confirmation from the user before doing the reset. This is because an accidental reset can cost some time as we scramble to figure out what the values should be restored to.

          @@ -586,7 +582,7 @@

          pcdsdevices.ccm.CCMEnergyWithVernier
          -set_current_position(energy: float) None
          +set_current_position(energy: float) None

          Adjust the offset to make input energy the current position.

          This changes the value of the theta0 PV.

          @@ -600,7 +596,7 @@

          pcdsdevices.ccm.CCMEnergyWithVernier
          -status() str
          +status() str

          Returns a str with the current pv values for the device.

          @@ -629,7 +625,7 @@

          pcdsdevices.ccm.CCMEnergyWithVernier
          -trigger() StatusBase
          +trigger() StatusBase

          Trigger the device and return status object.

          This method is responsible for implementing ‘trigger’ or ‘acquire’ functionality of this device.

          @@ -637,14 +633,14 @@

          pcdsdevices.ccm.CCMEnergyWithVernierread() method) then this method is also responsible for arranging that the -StatusBase object returned by this method +StatusBase object returned by this method is notified when the device is ready to be read.

          If there is no delay between triggering and being readable, -then this method must return a StatusBase +then this method must return a StatusBase object which is already completed.

          Returns:
          -

          status (StatusBase) – StatusBase object which will be marked +

          status (StatusBase) – StatusBase object which will be marked as complete when the device is ready to be read.

          @@ -659,7 +655,7 @@

          pcdsdevices.ccm.CCMEnergyWithVernier
          Parameters:
          -

          scale (float) – starting step size, default = 0.1

          +

          scale (float) – starting step size, default = 0.1

          @@ -671,12 +667,12 @@

          pcdsdevices.ccm.CCMEnergyWithVernier
          Parameters:
            -
          • position (float) – Desired end position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • position (float) – Desired end position.

          • +
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • -
          • newline (bool, optional) – If True, inserts a newline after the updates.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • newline (bool, optional) – If True, inserts a newline after the updates.

          @@ -689,12 +685,12 @@

          pcdsdevices.ccm.CCMEnergyWithVernier
          Parameters:
            -
          • delta (float) – Desired change in position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • delta (float) – Desired change in position.

          • +
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • -
          • newline (bool, optional) – If True, inserts a newline after the updates.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • newline (bool, optional) – If True, inserts a newline after the updates.

          @@ -707,7 +703,7 @@

          pcdsdevices.ccm.CCMEnergyWithVernier
          -warn_invalid_constants(only_new: bool = False) None
          +warn_invalid_constants(only_new: bool = False) None

          Warn if we have invalid values for our calculation constants.

          The motivation here is twofold: 1. It should be easy for the user to know what is wrong and

          @@ -753,7 +749,7 @@

          pcdsdevices.ccm.CCMEnergyWithVernier
          Parameters:
          -

          only_new (bool, optional) – If False, the default, always show us the warnings. +

          only_new (bool, optional) – If False, the default, always show us the warnings. If True, do not show warnings if they have not changed.

          @@ -923,7 +919,7 @@

          pcdsdevices.ccm.CCMEnergyWithVernier
          -subscriptions: ClassVar[FrozenSet[str]] = frozenset({'_req_done', 'acq_done', 'done_moving', 'readback', 'start_moving'})
          +subscriptions: ClassVar[FrozenSet[str]] = frozenset({'_req_done', 'acq_done', 'done_moving', 'readback', 'start_moving'})
          @@ -958,7 +954,7 @@

          pcdsdevices.ccm.CCMEnergyWithVernier
          -hutch: str
          +hutch: str

          diff --git a/master/generated/pcdsdevices.ccm.CCMMotor.html b/master/generated/pcdsdevices.ccm.CCMMotor.html index 03e69ad28cd..8af2216a5b8 100644 --- a/master/generated/pcdsdevices.ccm.CCMMotor.html +++ b/master/generated/pcdsdevices.ccm.CCMMotor.html @@ -1,25 +1,23 @@ + + - pcdsdevices.ccm.CCMMotor — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.ccm.CCMMotor — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -
          - 8.5.1.dev30+gd6e98430 -
          @@ -101,6 +96,7 @@
        • pcdsdevices.ipm
        • pcdsdevices.jet
        • pcdsdevices.keithley
        • +
        • pcdsdevices.lakeshore
        • pcdsdevices.lamp_motion
        • pcdsdevices.lasers.btps
        • pcdsdevices.lasers.counters
        • @@ -261,14 +257,14 @@

          pcdsdevices.ccm.CCMMotor
          -configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]
          +configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]

          Configure the device for something during a run

          This default implementation allows the user to change any of the configuration_attrs. Subclasses might override this to perform additional input validation, cleanup, etc.

          Parameters:
          -

          d (dict) – The configuration dictionary. To specify the order that +

          d (dict) – The configuration dictionary. To specify the order that the changes should be made, use an OrderedDict.

          Returns:
          @@ -283,7 +279,7 @@

          pcdsdevices.ccm.CCMMotor
          -describe() OrderedDictType[str, Dict[str, Any]]
          +describe() OrderedDictType[str, Dict[str, Any]]

          Provide schema and meta-data for read().

          This keys in the OrderedDict this method returns must match the keys in the OrderedDict return by read().

          @@ -330,7 +326,7 @@

          pcdsdevices.ccm.CCMMotorfloat, optional) – Maximum time to wait for the motion. If None, the default timeout +
        • timeout (float, optional) – Maximum time to wait for the motion. If None, the default timeout for this positioner is used.

        • @@ -339,9 +335,9 @@

          pcdsdevices.ccm.CCMMotorRaises:

          @@ -355,12 +351,12 @@

          pcdsdevices.ccm.CCMMotorParameters:
          • position – Desired end position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • wait (bool, optional) – If True, wait for motion completion before returning. +

          • wait (bool, optional) – If True, wait for motion completion before returning. Defaults to False.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          @@ -382,13 +378,13 @@

          pcdsdevices.ccm.CCMMotor
          Parameters:
            -
          • delta (float) – Desired change in position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • delta (float) – Desired change in position.

          • +
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • wait (bool, optional) – If True, wait for motion completion before returning. +

          • wait (bool, optional) – If True, wait for motion completion before returning. Defaults to False.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          @@ -402,7 +398,7 @@

          pcdsdevices.ccm.CCMMotor
          -read() OrderedDictType[str, Dict[str, Any]]
          +read() OrderedDictType[str, Dict[str, Any]]

          Read data from the device.

          This method is expected to be as instantaneous as possible, with any substantial acquisition time taken care of in @@ -425,7 +421,7 @@

          pcdsdevices.ccm.CCMMotor
          -read_configuration() OrderedDictType[str, Dict[str, Any]]
          +read_configuration() OrderedDictType[str, Dict[str, Any]]

          Dictionary mapping names to value dicts with keys: value, timestamp

          To control which fields are included, change the Component kinds on the device, or modify the configuration_attrs list.

          @@ -441,23 +437,23 @@

          pcdsdevices.ccm.CCMMotor
          -set(new_position: Any, *, timeout: float | None = None, moved_cb: Callable | None = None, wait: bool = False) StatusBase
          +set(new_position: Any, *, timeout: float | None = None, moved_cb: Callable | None = None, wait: bool = False) StatusBase

          Set a value and return a Status object

          Parameters:
            -
          • new_position (object) – The input here is whatever the device requires (this +

          • new_position (object) – The input here is whatever the device requires (this should be over-ridden by the implementation. For example a motor would take a float, a shutter the strings {‘Open’, ‘Close’}, and a goineometer (h, k, l) tuples

          • -
          • timeout (float, optional) – Maximum time to wait for the motion. If None, the default timeout +

          • timeout (float, optional) – Maximum time to wait for the motion. If None, the default timeout for this positioner is used.

          • moved_cb (callable, optional) –

            Deprecated

            Call this callback when movement has finished. This callback must accept one keyword argument: ‘obj’ which will be set to this positioner instance.

          • -
          • wait (bool, optional) –

            Deprecated

            +
          • wait (bool, optional) –

            Deprecated

            If the method should block until the Status object reports it is done.

            Defaults to False

            @@ -479,7 +475,7 @@

            pcdsdevices.ccm.CCMMotor
            -status() str
            +status() str

            Returns a str with the current pv values for the device.

          @@ -496,7 +492,7 @@

          pcdsdevices.ccm.CCMMotor
          -trigger() StatusBase
          +trigger() StatusBase

          Trigger the device and return status object.

          This method is responsible for implementing ‘trigger’ or ‘acquire’ functionality of this device.

          @@ -504,14 +500,14 @@

          pcdsdevices.ccm.CCMMotorread() method) then this method is also responsible for arranging that the -StatusBase object returned by this method +StatusBase object returned by this method is notified when the device is ready to be read.

          If there is no delay between triggering and being readable, -then this method must return a StatusBase +then this method must return a StatusBase object which is already completed.

          Returns:
          -

          status (StatusBase) – StatusBase object which will be marked +

          status (StatusBase) – StatusBase object which will be marked as complete when the device is ready to be read.

          @@ -526,7 +522,7 @@

          pcdsdevices.ccm.CCMMotor
          Parameters:
          -

          scale (float) – starting step size, default = 0.1

          +

          scale (float) – starting step size, default = 0.1

          @@ -538,12 +534,12 @@

          pcdsdevices.ccm.CCMMotor
          Parameters:
            -
          • position (float) – Desired end position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • position (float) – Desired end position.

          • +
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • -
          • newline (bool, optional) – If True, inserts a newline after the updates.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • newline (bool, optional) – If True, inserts a newline after the updates.

          @@ -556,12 +552,12 @@

          pcdsdevices.ccm.CCMMotor
          Parameters:
            -
          • delta (float) – Desired change in position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • delta (float) – Desired change in position.

          • +
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • -
          • newline (bool, optional) – If True, inserts a newline after the updates.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • newline (bool, optional) – If True, inserts a newline after the updates.

          @@ -703,7 +699,7 @@

          pcdsdevices.ccm.CCMMotor
          -subscriptions: ClassVar[FrozenSet[str]] = frozenset({'_req_done', 'acq_done', 'done_moving', 'readback', 'start_moving'})
          +subscriptions: ClassVar[FrozenSet[str]] = frozenset({'_req_done', 'acq_done', 'done_moving', 'readback', 'start_moving'})
          diff --git a/master/generated/pcdsdevices.ccm.CCMPico.html b/master/generated/pcdsdevices.ccm.CCMPico.html index 3033f0676d4..c82e2d72242 100644 --- a/master/generated/pcdsdevices.ccm.CCMPico.html +++ b/master/generated/pcdsdevices.ccm.CCMPico.html @@ -1,25 +1,23 @@ + + - pcdsdevices.ccm.CCMPico — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.ccm.CCMPico — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -
          - 8.5.1.dev30+gd6e98430 -
          @@ -101,6 +96,7 @@
        • pcdsdevices.ipm
        • pcdsdevices.jet
        • pcdsdevices.keithley
        • +
        • pcdsdevices.lakeshore
        • pcdsdevices.lamp_motion
        • pcdsdevices.lasers.btps
        • pcdsdevices.lasers.counters
        • @@ -459,14 +455,14 @@

          pcdsdevices.ccm.CCMPico
          -configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]
          +configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]

          Configure the device for something during a run

          This default implementation allows the user to change any of the configuration_attrs. Subclasses might override this to perform additional input validation, cleanup, etc.

          Parameters:
          -

          d (dict) – The configuration dictionary. To specify the order that +

          d (dict) – The configuration dictionary. To specify the order that the changes should be made, use an OrderedDict.

          Returns:
          @@ -481,7 +477,7 @@

          pcdsdevices.ccm.CCMPico
          -describe() OrderedDictType[str, Dict[str, Any]]
          +describe() OrderedDictType[str, Dict[str, Any]]

          Provide schema and meta-data for read().

          This keys in the OrderedDict this method returns must match the keys in the OrderedDict return by read().

          @@ -543,8 +539,8 @@

          pcdsdevices.ccm.CCMPico
          Parameters:
            -
          • high (float) – Limit of travel in the positive direction.

          • -
          • low (float) – Limit of travel in the negative direction.

          • +
          • high (float) – Limit of travel in the positive direction.

          • +
          • low (float) – Limit of travel in the negative direction.

          @@ -569,7 +565,7 @@

          pcdsdevices.ccm.CCMPico
          -move(position: float, wait: bool = True, **kwargs) MoveStatus
          +move(position: float, wait: bool = True, **kwargs) MoveStatus

          Move to a specified position, optionally waiting for motion to complete.

          @@ -579,7 +575,7 @@

          pcdsdevices.ccm.CCMPico

          moved_cb (callable) – Call this callback when movement has finished. This callback must accept one keyword argument: ‘obj’ which will be set to this positioner instance.

          -
        • timeout (float, optional) – Maximum time to wait for the motion. If None, the default timeout +

        • timeout (float, optional) – Maximum time to wait for the motion. If None, the default timeout for this positioner is used.

        • @@ -588,9 +584,9 @@

          pcdsdevices.ccm.CCMPico
          Raises:

          @@ -604,12 +600,12 @@

          pcdsdevices.ccm.CCMPicoParameters:
          • position – Desired end position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • wait (bool, optional) – If True, wait for motion completion before returning. +

          • wait (bool, optional) – If True, wait for motion completion before returning. Defaults to False.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          @@ -631,13 +627,13 @@

          pcdsdevices.ccm.CCMPico
          Parameters:
            -
          • delta (float) – Desired change in position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • delta (float) – Desired change in position.

          • +
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • wait (bool, optional) – If True, wait for motion completion before returning. +

          • wait (bool, optional) – If True, wait for motion completion before returning. Defaults to False.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          @@ -651,7 +647,7 @@

          pcdsdevices.ccm.CCMPico
          -read() OrderedDictType[str, Dict[str, Any]]
          +read() OrderedDictType[str, Dict[str, Any]]

          Read data from the device.

          This method is expected to be as instantaneous as possible, with any substantial acquisition time taken care of in @@ -674,7 +670,7 @@

          pcdsdevices.ccm.CCMPico
          -read_configuration() OrderedDictType[str, Dict[str, Any]]
          +read_configuration() OrderedDictType[str, Dict[str, Any]]

          Dictionary mapping names to value dicts with keys: value, timestamp

          To control which fields are included, change the Component kinds on the device, or modify the configuration_attrs list.

          @@ -690,23 +686,23 @@

          pcdsdevices.ccm.CCMPico
          -set(new_position: Any, *, timeout: float | None = None, moved_cb: Callable | None = None, wait: bool = False) StatusBase
          +set(new_position: Any, *, timeout: float | None = None, moved_cb: Callable | None = None, wait: bool = False) StatusBase

          Set a value and return a Status object

          Parameters:
            -
          • new_position (object) – The input here is whatever the device requires (this +

          • new_position (object) – The input here is whatever the device requires (this should be over-ridden by the implementation. For example a motor would take a float, a shutter the strings {‘Open’, ‘Close’}, and a goineometer (h, k, l) tuples

          • -
          • timeout (float, optional) – Maximum time to wait for the motion. If None, the default timeout +

          • timeout (float, optional) – Maximum time to wait for the motion. If None, the default timeout for this positioner is used.

          • moved_cb (callable, optional) –

            Deprecated

            Call this callback when movement has finished. This callback must accept one keyword argument: ‘obj’ which will be set to this positioner instance.

          • -
          • wait (bool, optional) –

            Deprecated

            +
          • wait (bool, optional) –

            Deprecated

            If the method should block until the Status object reports it is done.

            Defaults to False

            @@ -737,10 +733,10 @@

            pcdsdevices.ccm.CCMPico

            Limit of travel in the positive direction.

            Parameters:
            -

            value (float) – High limit value to be set.

            +

            value (float) – High limit value to be set.

            Raises:
            -

            ValueError – When motor in motion or position outside of limit.

            +

            ValueError – When motor in motion or position outside of limit.

          @@ -758,8 +754,8 @@

          pcdsdevices.ccm.CCMPico
          Parameters:
            -
          • high (float) – Limit of travel in the positive direction.

          • -
          • low (float) – Limit of travel in the negative direction.

          • +
          • high (float) – Limit of travel in the positive direction.

          • +
          • low (float) – Limit of travel in the negative direction.

          @@ -771,10 +767,10 @@

          pcdsdevices.ccm.CCMPico

          Set the low limit.

          Parameters:
          -

          value (float) – Limit of travel in the negative direction.

          +

          value (float) – Limit of travel in the negative direction.

          Raises:
          -

          ValueError – When motor in motion or position outside of limit.

          +

          ValueError – When motor in motion or position outside of limit.

          @@ -788,7 +784,7 @@

          pcdsdevices.ccm.CCMPico
          -status() str
          +status() str

          Returns a str with the current pv values for the device.

          @@ -805,7 +801,7 @@

          pcdsdevices.ccm.CCMPico
          -trigger() StatusBase
          +trigger() StatusBase

          Trigger the device and return status object.

          This method is responsible for implementing ‘trigger’ or ‘acquire’ functionality of this device.

          @@ -813,14 +809,14 @@

          pcdsdevices.ccm.CCMPicoread() method) then this method is also responsible for arranging that the -StatusBase object returned by this method +StatusBase object returned by this method is notified when the device is ready to be read.

          If there is no delay between triggering and being readable, -then this method must return a StatusBase +then this method must return a StatusBase object which is already completed.

          Returns:
          -

          status (StatusBase) – StatusBase object which will be marked +

          status (StatusBase) – StatusBase object which will be marked as complete when the device is ready to be read.

          @@ -835,7 +831,7 @@

          pcdsdevices.ccm.CCMPico
          Parameters:
          -

          scale (float) – starting step size, default = 0.1

          +

          scale (float) – starting step size, default = 0.1

          @@ -847,12 +843,12 @@

          pcdsdevices.ccm.CCMPico
          Parameters:
            -
          • position (float) – Desired end position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • position (float) – Desired end position.

          • +
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • -
          • newline (bool, optional) – If True, inserts a newline after the updates.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • newline (bool, optional) – If True, inserts a newline after the updates.

          @@ -865,12 +861,12 @@

          pcdsdevices.ccm.CCMPico
          Parameters:
            -
          • delta (float) – Desired change in position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • delta (float) – Desired change in position.

          • +
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • -
          • newline (bool, optional) – If True, inserts a newline after the updates.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • newline (bool, optional) – If True, inserts a newline after the updates.

          @@ -990,7 +986,7 @@

          pcdsdevices.ccm.CCMPico
          -subscriptions: ClassVar[FrozenSet[str]] = frozenset({'_req_done', 'acq_done', 'done_moving', 'readback', 'start_moving'})
          +subscriptions: ClassVar[FrozenSet[str]] = frozenset({'_req_done', 'acq_done', 'done_moving', 'readback', 'start_moving'})
          diff --git a/master/generated/pcdsdevices.ccm.CCMX.html b/master/generated/pcdsdevices.ccm.CCMX.html index 3739318aa16..25faf50c09c 100644 --- a/master/generated/pcdsdevices.ccm.CCMX.html +++ b/master/generated/pcdsdevices.ccm.CCMX.html @@ -1,25 +1,23 @@ + + - pcdsdevices.ccm.CCMX — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.ccm.CCMX — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -
          - 8.5.1.dev30+gd6e98430 -
          @@ -101,6 +96,7 @@
        • pcdsdevices.ipm
        • pcdsdevices.jet
        • pcdsdevices.keithley
        • +
        • pcdsdevices.lakeshore
        • pcdsdevices.lamp_motion
        • pcdsdevices.lasers.btps
        • pcdsdevices.lasers.counters
        • @@ -210,7 +206,7 @@

          pcdsdevices.ccm.CCMX

          -class pcdsdevices.ccm.CCMX(prefix: str | None = None, **kwargs)
          +class pcdsdevices.ccm.CCMX(prefix: str | None = None, **kwargs)

          Combined motion of the CCM X motors.

          You can use this device like a motor, and the position setpoint will be forwarded to both x motors.

          @@ -218,11 +214,11 @@

          pcdsdevices.ccm.CCMX
          Parameters:
            -
          • prefix (str, optional) – Devices are required to have a positional argument here, +

          • prefix (str, optional) – Devices are required to have a positional argument here, but this is not used. If provided, it should be the same as down_prefix (x1).

          • -
          • down_prefix (str, required keyword) – The prefix for the downstream ccm x translation motor (x1).

          • -
          • up_prefix (str, required keyword) – The prefix for the upstream ccm x translation motor (x2).

          • +
          • down_prefix (str, required keyword) – The prefix for the downstream ccm x translation motor (x1).

          • +
          • up_prefix (str, required keyword) – The prefix for the upstream ccm x translation motor (x2).

          @@ -281,14 +277,14 @@

          pcdsdevices.ccm.CCMX
          -configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]
          +configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]

          Configure the device for something during a run

          This default implementation allows the user to change any of the configuration_attrs. Subclasses might override this to perform additional input validation, cleanup, etc.

          Parameters:
          -

          d (dict) – The configuration dictionary. To specify the order that +

          d (dict) – The configuration dictionary. To specify the order that the changes should be made, use an OrderedDict.

          Returns:
          @@ -309,7 +305,7 @@

          pcdsdevices.ccm.CCMX
          -describe() OrderedDictType[str, Dict[str, Any]]
          +describe() OrderedDictType[str, Dict[str, Any]]

          Provide schema and meta-data for read().

          This keys in the OrderedDict this method returns must match the keys in the OrderedDict return by read().

          @@ -401,7 +397,7 @@

          pcdsdevices.ccm.CCMX

          moved_cb (callable) – Call this callback when movement has finished. This callback must accept one keyword argument: ‘obj’ which will be set to this positioner instance.

          -
        • timeout (float, optional) – Maximum time to wait for the motion. If None, the default timeout +

        • timeout (float, optional) – Maximum time to wait for the motion. If None, the default timeout for this positioner is used.

        • @@ -410,9 +406,9 @@

          pcdsdevices.ccm.CCMX
          Raises:

          @@ -429,8 +425,8 @@

          pcdsdevices.ccm.CCMXParameters:

          @@ -444,12 +440,12 @@

          pcdsdevices.ccm.CCMXParameters:
          • position – Desired end position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • wait (bool, optional) – If True, wait for motion completion before returning. +

          • wait (bool, optional) – If True, wait for motion completion before returning. Defaults to False.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          @@ -471,13 +467,13 @@

          pcdsdevices.ccm.CCMX
          Parameters:
            -
          • delta (float) – Desired change in position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • delta (float) – Desired change in position.

          • +
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • wait (bool, optional) – If True, wait for motion completion before returning. +

          • wait (bool, optional) – If True, wait for motion completion before returning. Defaults to False.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          @@ -491,7 +487,7 @@

          pcdsdevices.ccm.CCMX
          -read() OrderedDictType[str, Dict[str, Any]]
          +read() OrderedDictType[str, Dict[str, Any]]

          Read data from the device.

          This method is expected to be as instantaneous as possible, with any substantial acquisition time taken care of in @@ -514,7 +510,7 @@

          pcdsdevices.ccm.CCMX
          -read_configuration() OrderedDictType[str, Dict[str, Any]]
          +read_configuration() OrderedDictType[str, Dict[str, Any]]

          Dictionary mapping names to value dicts with keys: value, timestamp

          To control which fields are included, change the Component kinds on the device, or modify the configuration_attrs list.

          @@ -564,7 +560,7 @@

          pcdsdevices.ccm.CCMX
          -status() str
          +status() str

          Returns a str with the current pv values for the device.

          @@ -593,7 +589,7 @@

          pcdsdevices.ccm.CCMX
          -trigger() StatusBase
          +trigger() StatusBase

          Trigger the device and return status object.

          This method is responsible for implementing ‘trigger’ or ‘acquire’ functionality of this device.

          @@ -601,14 +597,14 @@

          pcdsdevices.ccm.CCMXread() method) then this method is also responsible for arranging that the -StatusBase object returned by this method +StatusBase object returned by this method is notified when the device is ready to be read.

          If there is no delay between triggering and being readable, -then this method must return a StatusBase +then this method must return a StatusBase object which is already completed.

          Returns:
          -

          status (StatusBase) – StatusBase object which will be marked +

          status (StatusBase) – StatusBase object which will be marked as complete when the device is ready to be read.

          @@ -623,7 +619,7 @@

          pcdsdevices.ccm.CCMX
          Parameters:
          -

          scale (float) – starting step size, default = 0.1

          +

          scale (float) – starting step size, default = 0.1

          @@ -635,12 +631,12 @@

          pcdsdevices.ccm.CCMX
          Parameters:
            -
          • position (float) – Desired end position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • position (float) – Desired end position.

          • +
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • -
          • newline (bool, optional) – If True, inserts a newline after the updates.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • newline (bool, optional) – If True, inserts a newline after the updates.

          @@ -653,12 +649,12 @@

          pcdsdevices.ccm.CCMX
          Parameters:
            -
          • delta (float) – Desired change in position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • delta (float) – Desired change in position.

          • +
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • -
          • newline (bool, optional) – If True, inserts a newline after the updates.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • newline (bool, optional) – If True, inserts a newline after the updates.

          @@ -827,7 +823,7 @@

          pcdsdevices.ccm.CCMX
          -subscriptions: ClassVar[FrozenSet[str]] = frozenset({'_req_done', 'acq_done', 'done_moving', 'readback', 'start_moving'})
          +subscriptions: ClassVar[FrozenSet[str]] = frozenset({'_req_done', 'acq_done', 'done_moving', 'readback', 'start_moving'})
          diff --git a/master/generated/pcdsdevices.ccm.CCMY.html b/master/generated/pcdsdevices.ccm.CCMY.html index d0eb277f5e7..d65a6ba689a 100644 --- a/master/generated/pcdsdevices.ccm.CCMY.html +++ b/master/generated/pcdsdevices.ccm.CCMY.html @@ -1,25 +1,23 @@ + + - pcdsdevices.ccm.CCMY — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.ccm.CCMY — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -
          - 8.5.1.dev30+gd6e98430 -
          @@ -101,6 +96,7 @@
        • pcdsdevices.ipm
        • pcdsdevices.jet
        • pcdsdevices.keithley
        • +
        • pcdsdevices.lakeshore
        • pcdsdevices.lamp_motion
        • pcdsdevices.lasers.btps
        • pcdsdevices.lasers.counters
        • @@ -210,7 +206,7 @@

          pcdsdevices.ccm.CCMY

          -class pcdsdevices.ccm.CCMY(prefix: str | None = None, **kwargs)
          +class pcdsdevices.ccm.CCMY(prefix: str | None = None, **kwargs)

          Combined motion of the CCM Y motors.

          You can use this device like a motor, and the position setpoint will be forwarded to all three y motors.

          @@ -218,12 +214,12 @@

          pcdsdevices.ccm.CCMY
          Parameters:
            -
          • prefix (str, optional) – Devices are required to have a positional argument here, +

          • prefix (str, optional) – Devices are required to have a positional argument here, but this is not used. If provided, it should be the same as down_prefix (y1).

          • -
          • down_prefix (str, required keyword) – The prefix for the downstream ccm y translation motor (y1).

          • -
          • up_north_prefix (str, required keyword) – The prefix for the north upstream ccm y translation motor (y2).

          • -
          • up_south_prefix (str, required keyword) – The prefix for the south upstream ccm y translation motor (y3).

          • +
          • down_prefix (str, required keyword) – The prefix for the downstream ccm y translation motor (y1).

          • +
          • up_north_prefix (str, required keyword) – The prefix for the north upstream ccm y translation motor (y2).

          • +
          • up_south_prefix (str, required keyword) – The prefix for the south upstream ccm y translation motor (y3).

          @@ -289,14 +285,14 @@

          pcdsdevices.ccm.CCMY
          -configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]
          +configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]

          Configure the device for something during a run

          This default implementation allows the user to change any of the configuration_attrs. Subclasses might override this to perform additional input validation, cleanup, etc.

          Parameters:
          -

          d (dict) – The configuration dictionary. To specify the order that +

          d (dict) – The configuration dictionary. To specify the order that the changes should be made, use an OrderedDict.

          Returns:
          @@ -317,7 +313,7 @@

          pcdsdevices.ccm.CCMY
          -describe() OrderedDictType[str, Dict[str, Any]]
          +describe() OrderedDictType[str, Dict[str, Any]]

          Provide schema and meta-data for read().

          This keys in the OrderedDict this method returns must match the keys in the OrderedDict return by read().

          @@ -409,7 +405,7 @@

          pcdsdevices.ccm.CCMY

          moved_cb (callable) – Call this callback when movement has finished. This callback must accept one keyword argument: ‘obj’ which will be set to this positioner instance.

          -
        • timeout (float, optional) – Maximum time to wait for the motion. If None, the default timeout +

        • timeout (float, optional) – Maximum time to wait for the motion. If None, the default timeout for this positioner is used.

        • @@ -418,9 +414,9 @@

          pcdsdevices.ccm.CCMY
          Raises:

          @@ -437,8 +433,8 @@

          pcdsdevices.ccm.CCMYParameters:

          @@ -452,12 +448,12 @@

          pcdsdevices.ccm.CCMYParameters:
          • position – Desired end position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • wait (bool, optional) – If True, wait for motion completion before returning. +

          • wait (bool, optional) – If True, wait for motion completion before returning. Defaults to False.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          @@ -479,13 +475,13 @@

          pcdsdevices.ccm.CCMY
          Parameters:
            -
          • delta (float) – Desired change in position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • delta (float) – Desired change in position.

          • +
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • wait (bool, optional) – If True, wait for motion completion before returning. +

          • wait (bool, optional) – If True, wait for motion completion before returning. Defaults to False.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          @@ -499,7 +495,7 @@

          pcdsdevices.ccm.CCMY
          -read() OrderedDictType[str, Dict[str, Any]]
          +read() OrderedDictType[str, Dict[str, Any]]

          Read data from the device.

          This method is expected to be as instantaneous as possible, with any substantial acquisition time taken care of in @@ -522,7 +518,7 @@

          pcdsdevices.ccm.CCMY
          -read_configuration() OrderedDictType[str, Dict[str, Any]]
          +read_configuration() OrderedDictType[str, Dict[str, Any]]

          Dictionary mapping names to value dicts with keys: value, timestamp

          To control which fields are included, change the Component kinds on the device, or modify the configuration_attrs list.

          @@ -572,7 +568,7 @@

          pcdsdevices.ccm.CCMY
          -status() str
          +status() str

          Returns a str with the current pv values for the device.

          @@ -601,7 +597,7 @@

          pcdsdevices.ccm.CCMY
          -trigger() StatusBase
          +trigger() StatusBase

          Trigger the device and return status object.

          This method is responsible for implementing ‘trigger’ or ‘acquire’ functionality of this device.

          @@ -609,14 +605,14 @@

          pcdsdevices.ccm.CCMYread() method) then this method is also responsible for arranging that the -StatusBase object returned by this method +StatusBase object returned by this method is notified when the device is ready to be read.

          If there is no delay between triggering and being readable, -then this method must return a StatusBase +then this method must return a StatusBase object which is already completed.

          Returns:
          -

          status (StatusBase) – StatusBase object which will be marked +

          status (StatusBase) – StatusBase object which will be marked as complete when the device is ready to be read.

          @@ -631,7 +627,7 @@

          pcdsdevices.ccm.CCMY
          Parameters:
          -

          scale (float) – starting step size, default = 0.1

          +

          scale (float) – starting step size, default = 0.1

          @@ -643,12 +639,12 @@

          pcdsdevices.ccm.CCMY
          Parameters:
            -
          • position (float) – Desired end position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • position (float) – Desired end position.

          • +
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • -
          • newline (bool, optional) – If True, inserts a newline after the updates.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • newline (bool, optional) – If True, inserts a newline after the updates.

          @@ -661,12 +657,12 @@

          pcdsdevices.ccm.CCMY
          Parameters:
            -
          • delta (float) – Desired change in position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • delta (float) – Desired change in position.

          • +
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • -
          • newline (bool, optional) – If True, inserts a newline after the updates.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • newline (bool, optional) – If True, inserts a newline after the updates.

          @@ -835,7 +831,7 @@

          pcdsdevices.ccm.CCMY
          -subscriptions: ClassVar[FrozenSet[str]] = frozenset({'_req_done', 'acq_done', 'done_moving', 'readback', 'start_moving'})
          +subscriptions: ClassVar[FrozenSet[str]] = frozenset({'_req_done', 'acq_done', 'done_moving', 'readback', 'start_moving'})
          diff --git a/master/generated/pcdsdevices.ccm.alio_to_theta.html b/master/generated/pcdsdevices.ccm.alio_to_theta.html index d847ba52e5b..f069fbfff61 100644 --- a/master/generated/pcdsdevices.ccm.alio_to_theta.html +++ b/master/generated/pcdsdevices.ccm.alio_to_theta.html @@ -1,25 +1,23 @@ + + - pcdsdevices.ccm.alio_to_theta — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.ccm.alio_to_theta — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -
          - 8.5.1.dev30+gd6e98430 -
          @@ -101,6 +96,7 @@
        • pcdsdevices.ipm
        • pcdsdevices.jet
        • pcdsdevices.keithley
        • +
        • pcdsdevices.lakeshore
        • pcdsdevices.lamp_motion
        • pcdsdevices.lasers.btps
        • pcdsdevices.lasers.counters
        • @@ -210,7 +206,7 @@

          pcdsdevices.ccm.alio_to_theta

          -pcdsdevices.ccm.alio_to_theta(alio: float, theta0: float, gr: float, gd: float) float
          +pcdsdevices.ccm.alio_to_theta(alio: float, theta0: float, gr: float, gd: float) float

          Converts alio position (mm) to theta angle (rad).

          Conversion function theta_angle = f(x) = 2arctan * [(sqrt(x^2 + D^2 + 2Rx) - D)/(2R + x)] diff --git a/master/generated/pcdsdevices.ccm.energy_to_wavelength.html b/master/generated/pcdsdevices.ccm.energy_to_wavelength.html index eb790a61b48..6d484d5fa39 100644 --- a/master/generated/pcdsdevices.ccm.energy_to_wavelength.html +++ b/master/generated/pcdsdevices.ccm.energy_to_wavelength.html @@ -1,25 +1,23 @@ + + - pcdsdevices.ccm.energy_to_wavelength — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.ccm.energy_to_wavelength — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -

          - 8.5.1.dev30+gd6e98430 -
          @@ -101,6 +96,7 @@
        • pcdsdevices.ipm
        • pcdsdevices.jet
        • pcdsdevices.keithley
        • +
        • pcdsdevices.lakeshore
        • pcdsdevices.lamp_motion
        • pcdsdevices.lasers.btps
        • pcdsdevices.lasers.counters
        • @@ -210,7 +206,7 @@

          pcdsdevices.ccm.energy_to_wavelength

          -pcdsdevices.ccm.energy_to_wavelength(energy: float) float
          +pcdsdevices.ccm.energy_to_wavelength(energy: float) float

          Converts photon energy (keV) to wavelength (A).

          diff --git a/master/generated/pcdsdevices.ccm.theta_to_alio.html b/master/generated/pcdsdevices.ccm.theta_to_alio.html index 1c169f2b26b..d415ae4bdbb 100644 --- a/master/generated/pcdsdevices.ccm.theta_to_alio.html +++ b/master/generated/pcdsdevices.ccm.theta_to_alio.html @@ -1,25 +1,23 @@ + + - pcdsdevices.ccm.theta_to_alio — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.ccm.theta_to_alio — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -
          - 8.5.1.dev30+gd6e98430 -
          @@ -101,6 +96,7 @@
        • pcdsdevices.ipm
        • pcdsdevices.jet
        • pcdsdevices.keithley
        • +
        • pcdsdevices.lakeshore
        • pcdsdevices.lamp_motion
        • pcdsdevices.lasers.btps
        • pcdsdevices.lasers.counters
        • @@ -210,7 +206,7 @@

          pcdsdevices.ccm.theta_to_alio

          -pcdsdevices.ccm.theta_to_alio(theta: float, theta0: float, gr: float, gd: float) float
          +pcdsdevices.ccm.theta_to_alio(theta: float, theta0: float, gr: float, gd: float) float

          Converts theta angle (rad) to alio position (mm).

          Theta_B: scattering angle, the angle reduces when rotating clockwise

          (Bragg angle)

          diff --git a/master/generated/pcdsdevices.ccm.theta_to_wavelength.html b/master/generated/pcdsdevices.ccm.theta_to_wavelength.html index 3de7bc16611..dbcb2a571f2 100644 --- a/master/generated/pcdsdevices.ccm.theta_to_wavelength.html +++ b/master/generated/pcdsdevices.ccm.theta_to_wavelength.html @@ -1,25 +1,23 @@ + + - pcdsdevices.ccm.theta_to_wavelength — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.ccm.theta_to_wavelength — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -
          - 8.5.1.dev30+gd6e98430 -
          @@ -101,6 +96,7 @@
        • pcdsdevices.ipm
        • pcdsdevices.jet
        • pcdsdevices.keithley
        • +
        • pcdsdevices.lakeshore
        • pcdsdevices.lamp_motion
        • pcdsdevices.lasers.btps
        • pcdsdevices.lasers.counters
        • @@ -210,7 +206,7 @@

          pcdsdevices.ccm.theta_to_wavelength

          -pcdsdevices.ccm.theta_to_wavelength(theta: float, dspacing: float) float
          +pcdsdevices.ccm.theta_to_wavelength(theta: float, dspacing: float) float

          Converts theta angle (rad) to wavelength (A).

          diff --git a/master/generated/pcdsdevices.ccm.wavelength_to_energy.html b/master/generated/pcdsdevices.ccm.wavelength_to_energy.html index 4ac8df0b9e4..8daeb50b547 100644 --- a/master/generated/pcdsdevices.ccm.wavelength_to_energy.html +++ b/master/generated/pcdsdevices.ccm.wavelength_to_energy.html @@ -1,25 +1,23 @@ + + - pcdsdevices.ccm.wavelength_to_energy — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.ccm.wavelength_to_energy — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -
          - 8.5.1.dev30+gd6e98430 -
          @@ -101,6 +96,7 @@
        • pcdsdevices.ipm
        • pcdsdevices.jet
        • pcdsdevices.keithley
        • +
        • pcdsdevices.lakeshore
        • pcdsdevices.lamp_motion
        • pcdsdevices.lasers.btps
        • pcdsdevices.lasers.counters
        • @@ -210,7 +206,7 @@

          pcdsdevices.ccm.wavelength_to_energy

          -pcdsdevices.ccm.wavelength_to_energy(wavelength: float) float
          +pcdsdevices.ccm.wavelength_to_energy(wavelength: float) float

          Converts wavelength (A) to photon energy (keV).

          diff --git a/master/generated/pcdsdevices.ccm.wavelength_to_theta.html b/master/generated/pcdsdevices.ccm.wavelength_to_theta.html index 1973b4e1f17..b766edbac2c 100644 --- a/master/generated/pcdsdevices.ccm.wavelength_to_theta.html +++ b/master/generated/pcdsdevices.ccm.wavelength_to_theta.html @@ -1,25 +1,23 @@ + + - pcdsdevices.ccm.wavelength_to_theta — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.ccm.wavelength_to_theta — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -
          - 8.5.1.dev30+gd6e98430 -
          @@ -101,6 +96,7 @@
        • pcdsdevices.ipm
        • pcdsdevices.jet
        • pcdsdevices.keithley
        • +
        • pcdsdevices.lakeshore
        • pcdsdevices.lamp_motion
        • pcdsdevices.lasers.btps
        • pcdsdevices.lasers.counters
        • @@ -210,7 +206,7 @@

          pcdsdevices.ccm.wavelength_to_theta

          -pcdsdevices.ccm.wavelength_to_theta(wavelength: float, dspacing: float) float
          +pcdsdevices.ccm.wavelength_to_theta(wavelength: float, dspacing: float) float

          Converts wavelength (A) to theta angle (rad).

          diff --git a/master/generated/pcdsdevices.crix_motion.QuadraticBeckhoffMotor.html b/master/generated/pcdsdevices.crix_motion.QuadraticBeckhoffMotor.html index 96c16d16e0a..39d09f2fd37 100644 --- a/master/generated/pcdsdevices.crix_motion.QuadraticBeckhoffMotor.html +++ b/master/generated/pcdsdevices.crix_motion.QuadraticBeckhoffMotor.html @@ -1,25 +1,23 @@ + + - pcdsdevices.crix_motion.QuadraticBeckhoffMotor — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.crix_motion.QuadraticBeckhoffMotor — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -
          - 8.5.1.dev30+gd6e98430 -
          @@ -89,6 +84,7 @@
        • pcdsdevices.ipm
        • pcdsdevices.jet
        • pcdsdevices.keithley
        • +
        • pcdsdevices.lakeshore
        • pcdsdevices.lamp_motion
        • pcdsdevices.lasers.btps
        • pcdsdevices.lasers.counters
        • @@ -198,7 +194,7 @@

          pcdsdevices.crix_motion.QuadraticBeckhoffMotor

          -class pcdsdevices.crix_motion.QuadraticBeckhoffMotor(prefix: str, *, name: str, ca: float, cb: float, cc: float, pol: int, limits: tuple[float, float], **kwargs)
          +class pcdsdevices.crix_motion.QuadraticBeckhoffMotor(prefix: str, *, name: str, ca: float, cb: float, cc: float, pol: int, limits: tuple[float, float], **kwargs)

          Pseudomotor of the form calc = ax^2 + bx + c.

          This represents a linear BeckhoffAxis that turns a crystal. The translation from linear (mm) motion to angular (mrad) @@ -207,16 +203,16 @@

          pcdsdevices.crix_motion.QuadraticBeckhoffMotor
          Parameters:
            -
          • prefix (str) – The motor record prefix of the underlying real BeckhoffAxis.

          • -
          • name (str, required keyword) – The name of the device to use as a reference.

          • -
          • ca (float, required keyword) – The “a” constant in the best-fit polynomial.

          • -
          • cb (float, required keyword) – The “b” constant in the best-fit polynomial.

          • -
          • cc (float, required keyword) – The “c” constant in the best-fit polynomial.

          • +
          • prefix (str) – The motor record prefix of the underlying real BeckhoffAxis.

          • +
          • name (str, required keyword) – The name of the device to use as a reference.

          • +
          • ca (float, required keyword) – The “a” constant in the best-fit polynomial.

          • +
          • cb (float, required keyword) – The “b” constant in the best-fit polynomial.

          • +
          • cc (float, required keyword) – The “c” constant in the best-fit polynomial.

          • pol (-1 or 1, required keyword) – The polarity of the best-fit curve when converting back from calculated position to real position for requesting a move. The inverse of a quadratic function has two solutions at most points, so we need to pick which one is correct.

          • -
          • limits (tuple of floats, required keyword) – The limits to enforce on moves of the calculated axis. +

          • limits (tuple of floats, required keyword) – The limits to enforce on moves of the calculated axis. This should be a tuple of size 2.

          @@ -297,14 +293,14 @@

          pcdsdevices.crix_motion.QuadraticBeckhoffMotor
          -configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]
          +configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]

          Configure the device for something during a run

          This default implementation allows the user to change any of the configuration_attrs. Subclasses might override this to perform additional input validation, cleanup, etc.

          Parameters:
          -

          d (dict) – The configuration dictionary. To specify the order that +

          d (dict) – The configuration dictionary. To specify the order that the changes should be made, use an OrderedDict.

          Returns:
          @@ -319,7 +315,7 @@

          pcdsdevices.crix_motion.QuadraticBeckhoffMotor
          -describe() OrderedDictType[str, Dict[str, Any]]
          +describe() OrderedDictType[str, Dict[str, Any]]

          Provide schema and meta-data for read().

          This keys in the OrderedDict this method returns must match the keys in the OrderedDict return by read().

          @@ -342,7 +338,7 @@

          pcdsdevices.crix_motion.QuadraticBeckhoffMotor
          -forward(pseudo_pos: NamedTuple) NamedTuple
          +forward(pseudo_pos: NamedTuple) NamedTuple

          Calculate the position of the motor in mm given the mrad angle.

          This is called when we request a move and when we check if the position requested is within the limits of the linear motor.

          @@ -363,7 +359,7 @@

          pcdsdevices.crix_motion.QuadraticBeckhoffMotor
          -inverse(real_pos: NamedTuple) NamedTuple
          +inverse(real_pos: NamedTuple) NamedTuple

          Calculate the position of the crystal in mrad given the mm position.

          This is called when we check the current position of the PseudoPositioner.

          @@ -381,7 +377,7 @@

          pcdsdevices.crix_motion.QuadraticBeckhoffMotorfloat, optional) – Maximum time to wait for the motion. If None, the default timeout +
        • timeout (float, optional) – Maximum time to wait for the motion. If None, the default timeout for this positioner is used.

        • @@ -390,9 +386,9 @@

          pcdsdevices.crix_motion.QuadraticBeckhoffMotorRaises:

          @@ -409,8 +405,8 @@

          pcdsdevices.crix_motion.QuadraticBeckhoffMotorParameters:

          @@ -424,12 +420,12 @@

          pcdsdevices.crix_motion.QuadraticBeckhoffMotorParameters:
          • position – Desired end position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • wait (bool, optional) – If True, wait for motion completion before returning. +

          • wait (bool, optional) – If True, wait for motion completion before returning. Defaults to False.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          @@ -451,13 +447,13 @@

          pcdsdevices.crix_motion.QuadraticBeckhoffMotor
          Parameters:
            -
          • delta (float) – Desired change in position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • delta (float) – Desired change in position.

          • +
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • wait (bool, optional) – If True, wait for motion completion before returning. +

          • wait (bool, optional) – If True, wait for motion completion before returning. Defaults to False.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          @@ -471,7 +467,7 @@

          pcdsdevices.crix_motion.QuadraticBeckhoffMotor
          -read() OrderedDictType[str, Dict[str, Any]]
          +read() OrderedDictType[str, Dict[str, Any]]

          Read data from the device.

          This method is expected to be as instantaneous as possible, with any substantial acquisition time taken care of in @@ -494,7 +490,7 @@

          pcdsdevices.crix_motion.QuadraticBeckhoffMotor
          -read_configuration() OrderedDictType[str, Dict[str, Any]]
          +read_configuration() OrderedDictType[str, Dict[str, Any]]

          Dictionary mapping names to value dicts with keys: value, timestamp

          To control which fields are included, change the Component kinds on the device, or modify the configuration_attrs list.

          @@ -544,7 +540,7 @@

          pcdsdevices.crix_motion.QuadraticBeckhoffMotor
          -status() str
          +status() str

          Returns a str with the current pv values for the device.

          @@ -573,7 +569,7 @@

          pcdsdevices.crix_motion.QuadraticBeckhoffMotor
          -trigger() StatusBase
          +trigger() StatusBase

          Trigger the device and return status object.

          This method is responsible for implementing ‘trigger’ or ‘acquire’ functionality of this device.

          @@ -581,14 +577,14 @@

          pcdsdevices.crix_motion.QuadraticBeckhoffMotorread() method) then this method is also responsible for arranging that the -StatusBase object returned by this method +StatusBase object returned by this method is notified when the device is ready to be read.

          If there is no delay between triggering and being readable, -then this method must return a StatusBase +then this method must return a StatusBase object which is already completed.

          Returns:
          -

          status (StatusBase) – StatusBase object which will be marked +

          status (StatusBase) – StatusBase object which will be marked as complete when the device is ready to be read.

          @@ -603,7 +599,7 @@

          pcdsdevices.crix_motion.QuadraticBeckhoffMotor
          Parameters:
          -

          scale (float) – starting step size, default = 0.1

          +

          scale (float) – starting step size, default = 0.1

          @@ -615,12 +611,12 @@

          pcdsdevices.crix_motion.QuadraticBeckhoffMotor
          Parameters:
            -
          • position (float) – Desired end position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • position (float) – Desired end position.

          • +
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • -
          • newline (bool, optional) – If True, inserts a newline after the updates.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • newline (bool, optional) – If True, inserts a newline after the updates.

          @@ -633,12 +629,12 @@

          pcdsdevices.crix_motion.QuadraticBeckhoffMotor
          Parameters:
            -
          • delta (float) – Desired change in position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • delta (float) – Desired change in position.

          • +
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • -
          • newline (bool, optional) – If True, inserts a newline after the updates.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • newline (bool, optional) – If True, inserts a newline after the updates.

          @@ -777,7 +773,7 @@

          pcdsdevices.crix_motion.QuadraticBeckhoffMotor
          -subscriptions: ClassVar[FrozenSet[str]] = frozenset({'_req_done', 'acq_done', 'done_moving', 'readback', 'start_moving'})
          +subscriptions: ClassVar[FrozenSet[str]] = frozenset({'_req_done', 'acq_done', 'done_moving', 'readback', 'start_moving'})
          diff --git a/master/generated/pcdsdevices.crix_motion.QuadraticSimMotor.html b/master/generated/pcdsdevices.crix_motion.QuadraticSimMotor.html index 2720b7e29f6..63b5f54c602 100644 --- a/master/generated/pcdsdevices.crix_motion.QuadraticSimMotor.html +++ b/master/generated/pcdsdevices.crix_motion.QuadraticSimMotor.html @@ -1,25 +1,23 @@ + + - pcdsdevices.crix_motion.QuadraticSimMotor — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.crix_motion.QuadraticSimMotor — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -
          - 8.5.1.dev30+gd6e98430 -
          @@ -89,6 +84,7 @@
        • pcdsdevices.ipm
        • pcdsdevices.jet
        • pcdsdevices.keithley
        • +
        • pcdsdevices.lakeshore
        • pcdsdevices.lamp_motion
        • pcdsdevices.lasers.btps
        • pcdsdevices.lasers.counters
        • @@ -198,7 +194,7 @@

          pcdsdevices.crix_motion.QuadraticSimMotor

          -class pcdsdevices.crix_motion.QuadraticSimMotor(prefix: str, *, name: str, ca: float, cb: float, cc: float, pol: int, limits: tuple[float, float], **kwargs)
          +class pcdsdevices.crix_motion.QuadraticSimMotor(prefix: str, *, name: str, ca: float, cb: float, cc: float, pol: int, limits: tuple[float, float], **kwargs)

          Simulated version of the QuadraticBeckhoffMotor for offline testing.

          @@ -276,14 +272,14 @@

          pcdsdevices.crix_motion.QuadraticSimMotor
          -configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]
          +configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]

          Configure the device for something during a run

          This default implementation allows the user to change any of the configuration_attrs. Subclasses might override this to perform additional input validation, cleanup, etc.

          Parameters:
          -

          d (dict) – The configuration dictionary. To specify the order that +

          d (dict) – The configuration dictionary. To specify the order that the changes should be made, use an OrderedDict.

          Returns:
          @@ -298,7 +294,7 @@

          pcdsdevices.crix_motion.QuadraticSimMotor
          -describe() OrderedDictType[str, Dict[str, Any]]
          +describe() OrderedDictType[str, Dict[str, Any]]

          Provide schema and meta-data for read().

          This keys in the OrderedDict this method returns must match the keys in the OrderedDict return by read().

          @@ -321,7 +317,7 @@

          pcdsdevices.crix_motion.QuadraticSimMotor
          -forward(pseudo_pos: NamedTuple) NamedTuple
          +forward(pseudo_pos: NamedTuple) NamedTuple

          Calculate the position of the motor in mm given the mrad angle.

          This is called when we request a move and when we check if the position requested is within the limits of the linear motor.

          @@ -342,7 +338,7 @@

          pcdsdevices.crix_motion.QuadraticSimMotor
          -inverse(real_pos: NamedTuple) NamedTuple
          +inverse(real_pos: NamedTuple) NamedTuple

          Calculate the position of the crystal in mrad given the mm position.

          This is called when we check the current position of the PseudoPositioner.

          @@ -360,7 +356,7 @@

          pcdsdevices.crix_motion.QuadraticSimMotorfloat, optional) – Maximum time to wait for the motion. If None, the default timeout +
        • timeout (float, optional) – Maximum time to wait for the motion. If None, the default timeout for this positioner is used.

        • @@ -369,9 +365,9 @@

          pcdsdevices.crix_motion.QuadraticSimMotorRaises:

          @@ -388,8 +384,8 @@

          pcdsdevices.crix_motion.QuadraticSimMotorParameters:
          @@ -403,12 +399,12 @@

          pcdsdevices.crix_motion.QuadraticSimMotorParameters:
          • position – Desired end position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • wait (bool, optional) – If True, wait for motion completion before returning. +

          • wait (bool, optional) – If True, wait for motion completion before returning. Defaults to False.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          @@ -430,13 +426,13 @@

          pcdsdevices.crix_motion.QuadraticSimMotor
          Parameters:
            -
          • delta (float) – Desired change in position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • delta (float) – Desired change in position.

          • +
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • wait (bool, optional) – If True, wait for motion completion before returning. +

          • wait (bool, optional) – If True, wait for motion completion before returning. Defaults to False.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          @@ -450,7 +446,7 @@

          pcdsdevices.crix_motion.QuadraticSimMotor
          -read() OrderedDictType[str, Dict[str, Any]]
          +read() OrderedDictType[str, Dict[str, Any]]

          Read data from the device.

          This method is expected to be as instantaneous as possible, with any substantial acquisition time taken care of in @@ -473,7 +469,7 @@

          pcdsdevices.crix_motion.QuadraticSimMotor
          -read_configuration() OrderedDictType[str, Dict[str, Any]]
          +read_configuration() OrderedDictType[str, Dict[str, Any]]

          Dictionary mapping names to value dicts with keys: value, timestamp

          To control which fields are included, change the Component kinds on the device, or modify the configuration_attrs list.

          @@ -523,7 +519,7 @@

          pcdsdevices.crix_motion.QuadraticSimMotor
          -status() str
          +status() str

          Returns a str with the current pv values for the device.

          @@ -552,7 +548,7 @@

          pcdsdevices.crix_motion.QuadraticSimMotor
          -trigger() StatusBase
          +trigger() StatusBase

          Trigger the device and return status object.

          This method is responsible for implementing ‘trigger’ or ‘acquire’ functionality of this device.

          @@ -560,14 +556,14 @@

          pcdsdevices.crix_motion.QuadraticSimMotorread() method) then this method is also responsible for arranging that the -StatusBase object returned by this method +StatusBase object returned by this method is notified when the device is ready to be read.

          If there is no delay between triggering and being readable, -then this method must return a StatusBase +then this method must return a StatusBase object which is already completed.

          Returns:
          -

          status (StatusBase) – StatusBase object which will be marked +

          status (StatusBase) – StatusBase object which will be marked as complete when the device is ready to be read.

          @@ -582,7 +578,7 @@

          pcdsdevices.crix_motion.QuadraticSimMotor
          Parameters:
          -

          scale (float) – starting step size, default = 0.1

          +

          scale (float) – starting step size, default = 0.1

          @@ -594,12 +590,12 @@

          pcdsdevices.crix_motion.QuadraticSimMotor
          Parameters:
            -
          • position (float) – Desired end position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • position (float) – Desired end position.

          • +
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • -
          • newline (bool, optional) – If True, inserts a newline after the updates.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • newline (bool, optional) – If True, inserts a newline after the updates.

          @@ -612,12 +608,12 @@

          pcdsdevices.crix_motion.QuadraticSimMotor
          Parameters:
            -
          • delta (float) – Desired change in position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • delta (float) – Desired change in position.

          • +
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • -
          • newline (bool, optional) – If True, inserts a newline after the updates.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • newline (bool, optional) – If True, inserts a newline after the updates.

          @@ -756,7 +752,7 @@

          pcdsdevices.crix_motion.QuadraticSimMotor
          -subscriptions: ClassVar[FrozenSet[str]] = frozenset({'_req_done', 'acq_done', 'done_moving', 'readback', 'start_moving'})
          +subscriptions: ClassVar[FrozenSet[str]] = frozenset({'_req_done', 'acq_done', 'done_moving', 'readback', 'start_moving'})
          diff --git a/master/generated/pcdsdevices.crix_motion.VLSOptics.html b/master/generated/pcdsdevices.crix_motion.VLSOptics.html index 8dc68bec269..0aabb8c4a10 100644 --- a/master/generated/pcdsdevices.crix_motion.VLSOptics.html +++ b/master/generated/pcdsdevices.crix_motion.VLSOptics.html @@ -1,25 +1,23 @@ + + - pcdsdevices.crix_motion.VLSOptics — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.crix_motion.VLSOptics — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -
          - 8.5.1.dev30+gd6e98430 -
          @@ -89,6 +84,7 @@
        • pcdsdevices.ipm
        • pcdsdevices.jet
        • pcdsdevices.keithley
        • +
        • pcdsdevices.lakeshore
        • pcdsdevices.lamp_motion
        • pcdsdevices.lasers.btps
        • pcdsdevices.lasers.counters
        • @@ -204,8 +200,8 @@

          pcdsdevices.crix_motion.VLSOptics
          Parameters:
            -
          • prefix (str,) – This value is currently unused.

          • -
          • name (str, required keyword) – This value is used to name the subcomponents.

          • +
          • prefix (str,) – This value is currently unused.

          • +
          • name (str, required keyword) – This value is used to name the subcomponents.

          @@ -240,14 +236,14 @@

          pcdsdevices.crix_motion.VLSOpticsMethods

          -configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]
          +configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]

          Configure the device for something during a run

          This default implementation allows the user to change any of the configuration_attrs. Subclasses might override this to perform additional input validation, cleanup, etc.

          Parameters:
          -

          d (dict) – The configuration dictionary. To specify the order that +

          d (dict) – The configuration dictionary. To specify the order that the changes should be made, use an OrderedDict.

          Returns:
          @@ -262,7 +258,7 @@

          pcdsdevices.crix_motion.VLSOptics
          -describe() OrderedDictType[str, Dict[str, Any]]
          +describe() OrderedDictType[str, Dict[str, Any]]

          Provide schema and meta-data for read().

          This keys in the OrderedDict this method returns must match the keys in the OrderedDict return by read().

          @@ -286,7 +282,7 @@

          pcdsdevices.crix_motion.VLSOptics
          -read() OrderedDictType[str, Dict[str, Any]]
          +read() OrderedDictType[str, Dict[str, Any]]

          Read data from the device.

          This method is expected to be as instantaneous as possible, with any substantial acquisition time taken care of in @@ -309,7 +305,7 @@

          pcdsdevices.crix_motion.VLSOptics
          -read_configuration() OrderedDictType[str, Dict[str, Any]]
          +read_configuration() OrderedDictType[str, Dict[str, Any]]

          Dictionary mapping names to value dicts with keys: value, timestamp

          To control which fields are included, change the Component kinds on the device, or modify the configuration_attrs list.

          @@ -317,7 +313,7 @@

          pcdsdevices.crix_motion.VLSOptics
          -stage_group_instances() Iterator[OphydObject]
          +stage_group_instances() Iterator[OphydObject]

          Yields an iterator of subdevices that should be staged.

          @@ -334,7 +330,7 @@

          pcdsdevices.crix_motion.VLSOptics
          -trigger() StatusBase
          +trigger() StatusBase

          Trigger the device and return status object.

          This method is responsible for implementing ‘trigger’ or ‘acquire’ functionality of this device.

          @@ -342,14 +338,14 @@

          pcdsdevices.crix_motion.VLSOpticsread() method) then this method is also responsible for arranging that the -StatusBase object returned by this method +StatusBase object returned by this method is notified when the device is ready to be read.

          If there is no delay between triggering and being readable, -then this method must return a StatusBase +then this method must return a StatusBase object which is already completed.

          Returns:
          -

          status (StatusBase) – StatusBase object which will be marked +

          status (StatusBase) – StatusBase object which will be marked as complete when the device is ready to be read.

          @@ -378,17 +374,17 @@

          pcdsdevices.crix_motion.VLSOptics
          -needs_parent: list[type[OphydObject]] = [<class 'ophyd.signal.AttributeSignal'>, <class 'ophyd.signal.DerivedSignal'>, <class 'ophyd.areadetector.plugins.PluginBase'>, <class 'ophyd.pseudopos.PseudoSingle'>, <class 'pcdsdevices.signal.PVStateSignal'>, <class 'pcdsdevices.signal.AggregateSignal'>]
          +needs_parent: list[type[OphydObject]] = [<class 'ophyd.signal.AttributeSignal'>, <class 'ophyd.signal.DerivedSignal'>, <class 'ophyd.areadetector.plugins.PluginBase'>, <class 'ophyd.pseudopos.PseudoSingle'>, <class 'pcdsdevices.signal.PVStateSignal'>, <class 'pcdsdevices.signal.AggregateSignal'>]

          -stage_group: list[Component] = None
          +stage_group: list[Component] = None
          -subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})
          +subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})

          diff --git a/master/generated/pcdsdevices.crix_motion.VLSOpticsSim.html b/master/generated/pcdsdevices.crix_motion.VLSOpticsSim.html index 53015672af9..1fb36a7c653 100644 --- a/master/generated/pcdsdevices.crix_motion.VLSOpticsSim.html +++ b/master/generated/pcdsdevices.crix_motion.VLSOpticsSim.html @@ -1,25 +1,23 @@ + + - pcdsdevices.crix_motion.VLSOpticsSim — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.crix_motion.VLSOpticsSim — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -
          - 8.5.1.dev30+gd6e98430 -
          @@ -89,6 +84,7 @@
        • pcdsdevices.ipm
        • pcdsdevices.jet
        • pcdsdevices.keithley
        • +
        • pcdsdevices.lakeshore
        • pcdsdevices.lamp_motion
        • pcdsdevices.lasers.btps
        • pcdsdevices.lasers.counters
        • @@ -231,14 +227,14 @@

          pcdsdevices.crix_motion.VLSOpticsSimMethods

          -configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]
          +configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]

          Configure the device for something during a run

          This default implementation allows the user to change any of the configuration_attrs. Subclasses might override this to perform additional input validation, cleanup, etc.

          Parameters:
          -

          d (dict) – The configuration dictionary. To specify the order that +

          d (dict) – The configuration dictionary. To specify the order that the changes should be made, use an OrderedDict.

          Returns:
          @@ -253,7 +249,7 @@

          pcdsdevices.crix_motion.VLSOpticsSim
          -describe() OrderedDictType[str, Dict[str, Any]]
          +describe() OrderedDictType[str, Dict[str, Any]]

          Provide schema and meta-data for read().

          This keys in the OrderedDict this method returns must match the keys in the OrderedDict return by read().

          @@ -277,7 +273,7 @@

          pcdsdevices.crix_motion.VLSOpticsSim
          -read() OrderedDictType[str, Dict[str, Any]]
          +read() OrderedDictType[str, Dict[str, Any]]

          Read data from the device.

          This method is expected to be as instantaneous as possible, with any substantial acquisition time taken care of in @@ -300,7 +296,7 @@

          pcdsdevices.crix_motion.VLSOpticsSim
          -read_configuration() OrderedDictType[str, Dict[str, Any]]
          +read_configuration() OrderedDictType[str, Dict[str, Any]]

          Dictionary mapping names to value dicts with keys: value, timestamp

          To control which fields are included, change the Component kinds on the device, or modify the configuration_attrs list.

          @@ -308,7 +304,7 @@

          pcdsdevices.crix_motion.VLSOpticsSim
          -stage_group_instances() Iterator[OphydObject]
          +stage_group_instances() Iterator[OphydObject]

          Yields an iterator of subdevices that should be staged.

          @@ -325,7 +321,7 @@

          pcdsdevices.crix_motion.VLSOpticsSim
          -trigger() StatusBase
          +trigger() StatusBase

          Trigger the device and return status object.

          This method is responsible for implementing ‘trigger’ or ‘acquire’ functionality of this device.

          @@ -333,14 +329,14 @@

          pcdsdevices.crix_motion.VLSOpticsSimread() method) then this method is also responsible for arranging that the -StatusBase object returned by this method +StatusBase object returned by this method is notified when the device is ready to be read.

          If there is no delay between triggering and being readable, -then this method must return a StatusBase +then this method must return a StatusBase object which is already completed.

          Returns:
          -

          status (StatusBase) – StatusBase object which will be marked +

          status (StatusBase) – StatusBase object which will be marked as complete when the device is ready to be read.

          @@ -369,17 +365,17 @@

          pcdsdevices.crix_motion.VLSOpticsSim
          -needs_parent: list[type[OphydObject]] = [<class 'ophyd.signal.AttributeSignal'>, <class 'ophyd.signal.DerivedSignal'>, <class 'ophyd.areadetector.plugins.PluginBase'>, <class 'ophyd.pseudopos.PseudoSingle'>, <class 'pcdsdevices.signal.PVStateSignal'>, <class 'pcdsdevices.signal.AggregateSignal'>]
          +needs_parent: list[type[OphydObject]] = [<class 'ophyd.signal.AttributeSignal'>, <class 'ophyd.signal.DerivedSignal'>, <class 'ophyd.areadetector.plugins.PluginBase'>, <class 'ophyd.pseudopos.PseudoSingle'>, <class 'pcdsdevices.signal.PVStateSignal'>, <class 'pcdsdevices.signal.AggregateSignal'>]

          -stage_group: list[Component] = None
          +stage_group: list[Component] = None
          -subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})
          +subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})

          diff --git a/master/generated/pcdsdevices.cvmi_motion.CVMI.html b/master/generated/pcdsdevices.cvmi_motion.CVMI.html index f12fcc512cc..68ee39730ee 100644 --- a/master/generated/pcdsdevices.cvmi_motion.CVMI.html +++ b/master/generated/pcdsdevices.cvmi_motion.CVMI.html @@ -1,25 +1,23 @@ + + - pcdsdevices.cvmi_motion.CVMI — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.cvmi_motion.CVMI — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -
          - 8.5.1.dev30+gd6e98430 -
          @@ -87,6 +82,7 @@
        • pcdsdevices.ipm
        • pcdsdevices.jet
        • pcdsdevices.keithley
        • +
        • pcdsdevices.lakeshore
        • pcdsdevices.lamp_motion
        • pcdsdevices.lasers.btps
        • pcdsdevices.lasers.counters
        • @@ -203,11 +199,11 @@

          pcdsdevices.cvmi_motion.CVMI
          Parameters:
            -
          • prefix (str) – Base PV for the LAMP motion system

          • -
          • desc (str) – Description field for LED.

          • -
          • pct (str) – Illumination percentage of a particular endstation LED.

          • -
          • pwr (str) – ON/OFF powered boolean of a particular endstation LED.

          • -
          • name (str) – Alias for the device

          • +
          • prefix (str) – Base PV for the LAMP motion system

          • +
          • desc (str) – Description field for LED.

          • +
          • pct (str) – Illumination percentage of a particular endstation LED.

          • +
          • pwr (str) – ON/OFF powered boolean of a particular endstation LED.

          • +
          • name (str) – Alias for the device

          @@ -291,14 +287,14 @@

          pcdsdevices.cvmi_motion.CVMIMethods

          -configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]
          +configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]

          Configure the device for something during a run

          This default implementation allows the user to change any of the configuration_attrs. Subclasses might override this to perform additional input validation, cleanup, etc.

          Parameters:
          -

          d (dict) – The configuration dictionary. To specify the order that +

          d (dict) – The configuration dictionary. To specify the order that the changes should be made, use an OrderedDict.

          Returns:
          @@ -313,7 +309,7 @@

          pcdsdevices.cvmi_motion.CVMI
          -describe() OrderedDictType[str, Dict[str, Any]]
          +describe() OrderedDictType[str, Dict[str, Any]]

          Provide schema and meta-data for read().

          This keys in the OrderedDict this method returns must match the keys in the OrderedDict return by read().

          @@ -343,7 +339,7 @@

          pcdsdevices.cvmi_motion.CVMI
          -read() OrderedDictType[str, Dict[str, Any]]
          +read() OrderedDictType[str, Dict[str, Any]]

          Read data from the device.

          This method is expected to be as instantaneous as possible, with any substantial acquisition time taken care of in @@ -366,7 +362,7 @@

          pcdsdevices.cvmi_motion.CVMI
          -read_configuration() OrderedDictType[str, Dict[str, Any]]
          +read_configuration() OrderedDictType[str, Dict[str, Any]]

          Dictionary mapping names to value dicts with keys: value, timestamp

          To control which fields are included, change the Component kinds on the device, or modify the configuration_attrs list.

          @@ -382,13 +378,13 @@

          pcdsdevices.cvmi_motion.CVMI
          -stage_group_instances() Iterator[OphydObject]
          +stage_group_instances() Iterator[OphydObject]

          Yields an iterator of subdevices that should be staged.

          -status() str
          +status() str

          Returns a str with the current pv values for the device.

          @@ -405,7 +401,7 @@

          pcdsdevices.cvmi_motion.CVMI
          -trigger() StatusBase
          +trigger() StatusBase

          Trigger the device and return status object.

          This method is responsible for implementing ‘trigger’ or ‘acquire’ functionality of this device.

          @@ -413,14 +409,14 @@

          pcdsdevices.cvmi_motion.CVMIread() method) then this method is also responsible for arranging that the -StatusBase object returned by this method +StatusBase object returned by this method is notified when the device is ready to be read.

          If there is no delay between triggering and being readable, -then this method must return a StatusBase +then this method must return a StatusBase object which is already completed.

          Returns:
          -

          status (StatusBase) – StatusBase object which will be marked +

          status (StatusBase) – StatusBase object which will be marked as complete when the device is ready to be read.

          @@ -449,17 +445,17 @@

          pcdsdevices.cvmi_motion.CVMI
          -needs_parent: list[type[OphydObject]] = [<class 'ophyd.signal.AttributeSignal'>, <class 'ophyd.signal.DerivedSignal'>, <class 'ophyd.areadetector.plugins.PluginBase'>, <class 'ophyd.pseudopos.PseudoSingle'>, <class 'pcdsdevices.signal.PVStateSignal'>, <class 'pcdsdevices.signal.AggregateSignal'>]
          +needs_parent: list[type[OphydObject]] = [<class 'ophyd.signal.AttributeSignal'>, <class 'ophyd.signal.DerivedSignal'>, <class 'ophyd.areadetector.plugins.PluginBase'>, <class 'ophyd.pseudopos.PseudoSingle'>, <class 'pcdsdevices.signal.PVStateSignal'>, <class 'pcdsdevices.signal.AggregateSignal'>]

          -stage_group: list[Component] = None
          +stage_group: list[Component] = None
          -subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})
          +subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})

          diff --git a/master/generated/pcdsdevices.cvmi_motion.KTOF.html b/master/generated/pcdsdevices.cvmi_motion.KTOF.html index 7e8f60ed4ad..4d015a282b0 100644 --- a/master/generated/pcdsdevices.cvmi_motion.KTOF.html +++ b/master/generated/pcdsdevices.cvmi_motion.KTOF.html @@ -1,25 +1,23 @@ + + - pcdsdevices.cvmi_motion.KTOF — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.cvmi_motion.KTOF — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -
          - 8.5.1.dev30+gd6e98430 -
          @@ -87,6 +82,7 @@
        • pcdsdevices.ipm
        • pcdsdevices.jet
        • pcdsdevices.keithley
        • +
        • pcdsdevices.lakeshore
        • pcdsdevices.lamp_motion
        • pcdsdevices.lasers.btps
        • pcdsdevices.lasers.counters
        • @@ -203,8 +199,8 @@

          pcdsdevices.cvmi_motion.KTOF
          Parameters:
            -
          • prefix (str) – Base PV for the LAMP motion system

          • -
          • name (str) – Alias for the device

          • +
          • prefix (str) – Base PV for the LAMP motion system

          • +
          • name (str) – Alias for the device

          @@ -246,14 +242,14 @@

          pcdsdevices.cvmi_motion.KTOFMethods

          -configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]
          +configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]

          Configure the device for something during a run

          This default implementation allows the user to change any of the configuration_attrs. Subclasses might override this to perform additional input validation, cleanup, etc.

          Parameters:
          -

          d (dict) – The configuration dictionary. To specify the order that +

          d (dict) – The configuration dictionary. To specify the order that the changes should be made, use an OrderedDict.

          Returns:
          @@ -268,7 +264,7 @@

          pcdsdevices.cvmi_motion.KTOF
          -describe() OrderedDictType[str, Dict[str, Any]]
          +describe() OrderedDictType[str, Dict[str, Any]]

          Provide schema and meta-data for read().

          This keys in the OrderedDict this method returns must match the keys in the OrderedDict return by read().

          @@ -298,7 +294,7 @@

          pcdsdevices.cvmi_motion.KTOF
          -read() OrderedDictType[str, Dict[str, Any]]
          +read() OrderedDictType[str, Dict[str, Any]]

          Read data from the device.

          This method is expected to be as instantaneous as possible, with any substantial acquisition time taken care of in @@ -321,7 +317,7 @@

          pcdsdevices.cvmi_motion.KTOF
          -read_configuration() OrderedDictType[str, Dict[str, Any]]
          +read_configuration() OrderedDictType[str, Dict[str, Any]]

          Dictionary mapping names to value dicts with keys: value, timestamp

          To control which fields are included, change the Component kinds on the device, or modify the configuration_attrs list.

          @@ -337,13 +333,13 @@

          pcdsdevices.cvmi_motion.KTOF
          -stage_group_instances() Iterator[OphydObject]
          +stage_group_instances() Iterator[OphydObject]

          Yields an iterator of subdevices that should be staged.

          -status() str
          +status() str

          Returns a str with the current pv values for the device.

          @@ -360,7 +356,7 @@

          pcdsdevices.cvmi_motion.KTOF
          -trigger() StatusBase
          +trigger() StatusBase

          Trigger the device and return status object.

          This method is responsible for implementing ‘trigger’ or ‘acquire’ functionality of this device.

          @@ -368,14 +364,14 @@

          pcdsdevices.cvmi_motion.KTOFread() method) then this method is also responsible for arranging that the -StatusBase object returned by this method +StatusBase object returned by this method is notified when the device is ready to be read.

          If there is no delay between triggering and being readable, -then this method must return a StatusBase +then this method must return a StatusBase object which is already completed.

          Returns:
          -

          status (StatusBase) – StatusBase object which will be marked +

          status (StatusBase) – StatusBase object which will be marked as complete when the device is ready to be read.

          @@ -404,17 +400,17 @@

          pcdsdevices.cvmi_motion.KTOF
          -needs_parent: list[type[OphydObject]] = [<class 'ophyd.signal.AttributeSignal'>, <class 'ophyd.signal.DerivedSignal'>, <class 'ophyd.areadetector.plugins.PluginBase'>, <class 'ophyd.pseudopos.PseudoSingle'>, <class 'pcdsdevices.signal.PVStateSignal'>, <class 'pcdsdevices.signal.AggregateSignal'>]
          +needs_parent: list[type[OphydObject]] = [<class 'ophyd.signal.AttributeSignal'>, <class 'ophyd.signal.DerivedSignal'>, <class 'ophyd.areadetector.plugins.PluginBase'>, <class 'ophyd.pseudopos.PseudoSingle'>, <class 'pcdsdevices.signal.PVStateSignal'>, <class 'pcdsdevices.signal.AggregateSignal'>]

          -stage_group: list[Component] = None
          +stage_group: list[Component] = None
          -subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})
          +subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})
          diff --git a/master/generated/pcdsdevices.dc_devices.ICT.html b/master/generated/pcdsdevices.dc_devices.ICT.html index 46c5a66a94b..45e88642536 100644 --- a/master/generated/pcdsdevices.dc_devices.ICT.html +++ b/master/generated/pcdsdevices.dc_devices.ICT.html @@ -1,25 +1,23 @@ + + - pcdsdevices.dc_devices.ICT — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.dc_devices.ICT — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -
          - 8.5.1.dev30+gd6e98430 -
          @@ -88,6 +83,7 @@
        • pcdsdevices.ipm
        • pcdsdevices.jet
        • pcdsdevices.keithley
        • +
        • pcdsdevices.lakeshore
        • pcdsdevices.lamp_motion
        • pcdsdevices.lasers.btps
        • pcdsdevices.lasers.counters
        • @@ -314,14 +310,14 @@

          pcdsdevices.dc_devices.ICTMethods

          -configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]
          +configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]

          Configure the device for something during a run

          This default implementation allows the user to change any of the configuration_attrs. Subclasses might override this to perform additional input validation, cleanup, etc.

          Parameters:
          -

          d (dict) – The configuration dictionary. To specify the order that +

          d (dict) – The configuration dictionary. To specify the order that the changes should be made, use an OrderedDict.

          Returns:
          @@ -336,7 +332,7 @@

          pcdsdevices.dc_devices.ICT
          -describe() OrderedDictType[str, Dict[str, Any]]
          +describe() OrderedDictType[str, Dict[str, Any]]

          Provide schema and meta-data for read().

          This keys in the OrderedDict this method returns must match the keys in the OrderedDict return by read().

          @@ -366,7 +362,7 @@

          pcdsdevices.dc_devices.ICT
          -read() OrderedDictType[str, Dict[str, Any]]
          +read() OrderedDictType[str, Dict[str, Any]]

          Read data from the device.

          This method is expected to be as instantaneous as possible, with any substantial acquisition time taken care of in @@ -389,7 +385,7 @@

          pcdsdevices.dc_devices.ICT
          -read_configuration() OrderedDictType[str, Dict[str, Any]]
          +read_configuration() OrderedDictType[str, Dict[str, Any]]

          Dictionary mapping names to value dicts with keys: value, timestamp

          To control which fields are included, change the Component kinds on the device, or modify the configuration_attrs list.

          @@ -405,13 +401,13 @@

          pcdsdevices.dc_devices.ICT
          -stage_group_instances() Iterator[OphydObject]
          +stage_group_instances() Iterator[OphydObject]

          Yields an iterator of subdevices that should be staged.

          -status() str
          +status() str

          Returns a str with the current pv values for the device.

          @@ -428,7 +424,7 @@

          pcdsdevices.dc_devices.ICT
          -trigger() StatusBase
          +trigger() StatusBase

          Trigger the device and return status object.

          This method is responsible for implementing ‘trigger’ or ‘acquire’ functionality of this device.

          @@ -436,14 +432,14 @@

          pcdsdevices.dc_devices.ICTread() method) then this method is also responsible for arranging that the -StatusBase object returned by this method +StatusBase object returned by this method is notified when the device is ready to be read.

          If there is no delay between triggering and being readable, -then this method must return a StatusBase +then this method must return a StatusBase object which is already completed.

          Returns:
          -

          status (StatusBase) – StatusBase object which will be marked +

          status (StatusBase) – StatusBase object which will be marked as complete when the device is ready to be read.

          @@ -472,17 +468,17 @@

          pcdsdevices.dc_devices.ICT
          -needs_parent: list[type[OphydObject]] = [<class 'ophyd.signal.AttributeSignal'>, <class 'ophyd.signal.DerivedSignal'>, <class 'ophyd.areadetector.plugins.PluginBase'>, <class 'ophyd.pseudopos.PseudoSingle'>, <class 'pcdsdevices.signal.PVStateSignal'>, <class 'pcdsdevices.signal.AggregateSignal'>]
          +needs_parent: list[type[OphydObject]] = [<class 'ophyd.signal.AttributeSignal'>, <class 'ophyd.signal.DerivedSignal'>, <class 'ophyd.areadetector.plugins.PluginBase'>, <class 'ophyd.pseudopos.PseudoSingle'>, <class 'pcdsdevices.signal.PVStateSignal'>, <class 'pcdsdevices.signal.AggregateSignal'>]

          -stage_group: list[Component] = None
          +stage_group: list[Component] = None
          -subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})
          +subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})
          diff --git a/master/generated/pcdsdevices.dc_devices.ICTBus.html b/master/generated/pcdsdevices.dc_devices.ICTBus.html index be28a9ab4cb..33607e62f0e 100644 --- a/master/generated/pcdsdevices.dc_devices.ICTBus.html +++ b/master/generated/pcdsdevices.dc_devices.ICTBus.html @@ -1,25 +1,23 @@ + + - pcdsdevices.dc_devices.ICTBus — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.dc_devices.ICTBus — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -
          - 8.5.1.dev30+gd6e98430 -
          @@ -88,6 +83,7 @@
        • pcdsdevices.ipm
        • pcdsdevices.jet
        • pcdsdevices.keithley
        • +
        • pcdsdevices.lakeshore
        • pcdsdevices.lamp_motion
        • pcdsdevices.lasers.btps
        • pcdsdevices.lasers.counters
        • @@ -202,8 +198,8 @@

          pcdsdevices.dc_devices.ICTBus
          Parameters:
            -
          • prefix (str) – The base PV of the relevant ICT.

          • -
          • bus (str) – The output bus on the ICT, ‘A’ or ‘B’.

          • +
          • prefix (str) – The base PV of the relevant ICT.

          • +
          • bus (str) – The output bus on the ICT, ‘A’ or ‘B’.

          @@ -245,14 +241,14 @@

          pcdsdevices.dc_devices.ICTBusMethods

          -configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]
          +configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]

          Configure the device for something during a run

          This default implementation allows the user to change any of the configuration_attrs. Subclasses might override this to perform additional input validation, cleanup, etc.

          Parameters:
          -

          d (dict) – The configuration dictionary. To specify the order that +

          d (dict) – The configuration dictionary. To specify the order that the changes should be made, use an OrderedDict.

          Returns:
          @@ -272,7 +268,7 @@

          pcdsdevices.dc_devices.ICTBus
          -describe() OrderedDictType[str, Dict[str, Any]]
          +describe() OrderedDictType[str, Dict[str, Any]]

          Provide schema and meta-data for read().

          This keys in the OrderedDict this method returns must match the keys in the OrderedDict return by read().

          @@ -296,7 +292,7 @@

          pcdsdevices.dc_devices.ICTBus
          -read() OrderedDictType[str, Dict[str, Any]]
          +read() OrderedDictType[str, Dict[str, Any]]

          Read data from the device.

          This method is expected to be as instantaneous as possible, with any substantial acquisition time taken care of in @@ -319,7 +315,7 @@

          pcdsdevices.dc_devices.ICTBus
          -read_configuration() OrderedDictType[str, Dict[str, Any]]
          +read_configuration() OrderedDictType[str, Dict[str, Any]]

          Dictionary mapping names to value dicts with keys: value, timestamp

          To control which fields are included, change the Component kinds on the device, or modify the configuration_attrs list.

          @@ -338,7 +334,7 @@

          pcdsdevices.dc_devices.ICTBus
          -trigger() StatusBase
          +trigger() StatusBase

          Trigger the device and return status object.

          This method is responsible for implementing ‘trigger’ or ‘acquire’ functionality of this device.

          @@ -346,14 +342,14 @@

          pcdsdevices.dc_devices.ICTBusread() method) then this method is also responsible for arranging that the -StatusBase object returned by this method +StatusBase object returned by this method is notified when the device is ready to be read.

          If there is no delay between triggering and being readable, -then this method must return a StatusBase +then this method must return a StatusBase object which is already completed.

          Returns:
          -

          status (StatusBase) – StatusBase object which will be marked +

          status (StatusBase) – StatusBase object which will be marked as complete when the device is ready to be read.

          @@ -387,7 +383,7 @@

          pcdsdevices.dc_devices.ICTBus
          -subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})
          +subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})

          diff --git a/master/generated/pcdsdevices.dc_devices.ICTChannel.html b/master/generated/pcdsdevices.dc_devices.ICTChannel.html index 106c853173c..4d5279b2360 100644 --- a/master/generated/pcdsdevices.dc_devices.ICTChannel.html +++ b/master/generated/pcdsdevices.dc_devices.ICTChannel.html @@ -1,25 +1,23 @@ + + - pcdsdevices.dc_devices.ICTChannel — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.dc_devices.ICTChannel — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -
          - 8.5.1.dev30+gd6e98430 -
          @@ -88,6 +83,7 @@
        • pcdsdevices.ipm
        • pcdsdevices.jet
        • pcdsdevices.keithley
        • +
        • pcdsdevices.lakeshore
        • pcdsdevices.lamp_motion
        • pcdsdevices.lasers.btps
        • pcdsdevices.lasers.counters
        • @@ -202,8 +198,8 @@

          pcdsdevices.dc_devices.ICTChannel
          Parameters:
            -
          • prefix (str) – The base PV of the relevant ICT.

          • -
          • channel (str) – The output channel on the ICT, e.g. ‘1A’, ‘3B’, etc.

          • +
          • prefix (str) – The base PV of the relevant ICT.

          • +
          • channel (str) – The output channel on the ICT, e.g. ‘1A’, ‘3B’, etc.

          @@ -252,14 +248,14 @@

          pcdsdevices.dc_devices.ICTChannelMethods

          -configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]
          +configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]

          Configure the device for something during a run

          This default implementation allows the user to change any of the configuration_attrs. Subclasses might override this to perform additional input validation, cleanup, etc.

          Parameters:
          -

          d (dict) – The configuration dictionary. To specify the order that +

          d (dict) – The configuration dictionary. To specify the order that the changes should be made, use an OrderedDict.

          Returns:
          @@ -279,7 +275,7 @@

          pcdsdevices.dc_devices.ICTChannel
          -describe() OrderedDictType[str, Dict[str, Any]]
          +describe() OrderedDictType[str, Dict[str, Any]]

          Provide schema and meta-data for read().

          This keys in the OrderedDict this method returns must match the keys in the OrderedDict return by read().

          @@ -313,7 +309,7 @@

          pcdsdevices.dc_devices.ICTChannel
          -read() OrderedDictType[str, Dict[str, Any]]
          +read() OrderedDictType[str, Dict[str, Any]]

          Read data from the device.

          This method is expected to be as instantaneous as possible, with any substantial acquisition time taken care of in @@ -336,7 +332,7 @@

          pcdsdevices.dc_devices.ICTChannel
          -read_configuration() OrderedDictType[str, Dict[str, Any]]
          +read_configuration() OrderedDictType[str, Dict[str, Any]]

          Dictionary mapping names to value dicts with keys: value, timestamp

          To control which fields are included, change the Component kinds on the device, or modify the configuration_attrs list.

          @@ -355,7 +351,7 @@

          pcdsdevices.dc_devices.ICTChannel
          -trigger() StatusBase
          +trigger() StatusBase

          Trigger the device and return status object.

          This method is responsible for implementing ‘trigger’ or ‘acquire’ functionality of this device.

          @@ -363,14 +359,14 @@

          pcdsdevices.dc_devices.ICTChannelread() method) then this method is also responsible for arranging that the -StatusBase object returned by this method +StatusBase object returned by this method is notified when the device is ready to be read.

          If there is no delay between triggering and being readable, -then this method must return a StatusBase +then this method must return a StatusBase object which is already completed.

          Returns:
          -

          status (StatusBase) – StatusBase object which will be marked +

          status (StatusBase) – StatusBase object which will be marked as complete when the device is ready to be read.

          @@ -399,7 +395,7 @@

          pcdsdevices.dc_devices.ICTChannel
          -subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})
          +subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})

          diff --git a/master/generated/pcdsdevices.delay_generator.DelayGenerator.html b/master/generated/pcdsdevices.delay_generator.DelayGenerator.html index 54466b0e061..5ce8ff9c7f8 100644 --- a/master/generated/pcdsdevices.delay_generator.DelayGenerator.html +++ b/master/generated/pcdsdevices.delay_generator.DelayGenerator.html @@ -1,25 +1,23 @@ + + - pcdsdevices.delay_generator.DelayGenerator — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.delay_generator.DelayGenerator — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -
          - 8.5.1.dev30+gd6e98430 -
          @@ -88,6 +83,7 @@
        • pcdsdevices.ipm
        • pcdsdevices.jet
        • pcdsdevices.keithley
        • +
        • pcdsdevices.lakeshore
        • pcdsdevices.lamp_motion
        • pcdsdevices.lasers.btps
        • pcdsdevices.lasers.counters
        • @@ -285,14 +281,14 @@

          pcdsdevices.delay_generator.DelayGeneratorMethods

          -configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]
          +configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]

          Configure the device for something during a run

          This default implementation allows the user to change any of the configuration_attrs. Subclasses might override this to perform additional input validation, cleanup, etc.

          Parameters:
          -

          d (dict) – The configuration dictionary. To specify the order that +

          d (dict) – The configuration dictionary. To specify the order that the changes should be made, use an OrderedDict.

          Returns:
          @@ -307,7 +303,7 @@

          pcdsdevices.delay_generator.DelayGenerator
          -describe() OrderedDictType[str, Dict[str, Any]]
          +describe() OrderedDictType[str, Dict[str, Any]]

          Provide schema and meta-data for read().

          This keys in the OrderedDict this method returns must match the keys in the OrderedDict return by read().

          @@ -357,7 +353,7 @@

          pcdsdevices.delay_generator.DelayGenerator
          -read() OrderedDictType[str, Dict[str, Any]]
          +read() OrderedDictType[str, Dict[str, Any]]

          Read data from the device.

          This method is expected to be as instantaneous as possible, with any substantial acquisition time taken care of in @@ -380,7 +376,7 @@

          pcdsdevices.delay_generator.DelayGenerator
          -read_configuration() OrderedDictType[str, Dict[str, Any]]
          +read_configuration() OrderedDictType[str, Dict[str, Any]]

          Dictionary mapping names to value dicts with keys: value, timestamp

          To control which fields are included, change the Component kinds on the device, or modify the configuration_attrs list.

          @@ -406,7 +402,7 @@

          pcdsdevices.delay_generator.DelayGenerator
          -status() str
          +status() str

          Returns a str with the current pv values for the device.

          @@ -423,7 +419,7 @@

          pcdsdevices.delay_generator.DelayGenerator
          -trigger() StatusBase
          +trigger() StatusBase

          Trigger the device and return status object.

          This method is responsible for implementing ‘trigger’ or ‘acquire’ functionality of this device.

          @@ -431,14 +427,14 @@

          pcdsdevices.delay_generator.DelayGeneratorread() method) then this method is also responsible for arranging that the -StatusBase object returned by this method +StatusBase object returned by this method is notified when the device is ready to be read.

          If there is no delay between triggering and being readable, -then this method must return a StatusBase +then this method must return a StatusBase object which is already completed.

          Returns:
          -

          status (StatusBase) – StatusBase object which will be marked +

          status (StatusBase) – StatusBase object which will be marked as complete when the device is ready to be read.

          @@ -467,7 +463,7 @@

          pcdsdevices.delay_generator.DelayGenerator
          -subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})
          +subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})

          diff --git a/master/generated/pcdsdevices.delay_generator.DelayGeneratorBase.html b/master/generated/pcdsdevices.delay_generator.DelayGeneratorBase.html index af86cd888eb..083a53f36c7 100644 --- a/master/generated/pcdsdevices.delay_generator.DelayGeneratorBase.html +++ b/master/generated/pcdsdevices.delay_generator.DelayGeneratorBase.html @@ -1,25 +1,23 @@ + + - pcdsdevices.delay_generator.DelayGeneratorBase — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.delay_generator.DelayGeneratorBase — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -
          - 8.5.1.dev30+gd6e98430 -
          @@ -88,6 +83,7 @@
        • pcdsdevices.ipm
        • pcdsdevices.jet
        • pcdsdevices.keithley
        • +
        • pcdsdevices.lakeshore
        • pcdsdevices.lamp_motion
        • pcdsdevices.lasers.btps
        • pcdsdevices.lasers.counters
        • @@ -202,8 +198,8 @@

          pcdsdevices.delay_generator.DelayGeneratorBase
          Parameters:
            -
          • prefix (str) – Base PV for the delay generator.

          • -
          • name (str) – Alias for the device

          • +
          • prefix (str) – Base PV for the delay generator.

          • +
          • name (str) – Alias for the device

          @@ -238,14 +234,14 @@

          pcdsdevices.delay_generator.DelayGeneratorBaseMethods

          -configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]
          +configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]

          Configure the device for something during a run

          This default implementation allows the user to change any of the configuration_attrs. Subclasses might override this to perform additional input validation, cleanup, etc.

          Parameters:
          -

          d (dict) – The configuration dictionary. To specify the order that +

          d (dict) – The configuration dictionary. To specify the order that the changes should be made, use an OrderedDict.

          Returns:
          @@ -260,7 +256,7 @@

          pcdsdevices.delay_generator.DelayGeneratorBase
          -describe() OrderedDictType[str, Dict[str, Any]]
          +describe() OrderedDictType[str, Dict[str, Any]]

          Provide schema and meta-data for read().

          This keys in the OrderedDict this method returns must match the keys in the OrderedDict return by read().

          @@ -310,7 +306,7 @@

          pcdsdevices.delay_generator.DelayGeneratorBase
          -read() OrderedDictType[str, Dict[str, Any]]
          +read() OrderedDictType[str, Dict[str, Any]]

          Read data from the device.

          This method is expected to be as instantaneous as possible, with any substantial acquisition time taken care of in @@ -333,7 +329,7 @@

          pcdsdevices.delay_generator.DelayGeneratorBase
          -read_configuration() OrderedDictType[str, Dict[str, Any]]
          +read_configuration() OrderedDictType[str, Dict[str, Any]]

          Dictionary mapping names to value dicts with keys: value, timestamp

          To control which fields are included, change the Component kinds on the device, or modify the configuration_attrs list.

          @@ -359,7 +355,7 @@

          pcdsdevices.delay_generator.DelayGeneratorBase
          -status() str
          +status() str

          Returns a str with the current pv values for the device.

          @@ -376,7 +372,7 @@

          pcdsdevices.delay_generator.DelayGeneratorBase
          -trigger() StatusBase
          +trigger() StatusBase

          Trigger the device and return status object.

          This method is responsible for implementing ‘trigger’ or ‘acquire’ functionality of this device.

          @@ -384,14 +380,14 @@

          pcdsdevices.delay_generator.DelayGeneratorBaseread() method) then this method is also responsible for arranging that the -StatusBase object returned by this method +StatusBase object returned by this method is notified when the device is ready to be read.

          If there is no delay between triggering and being readable, -then this method must return a StatusBase +then this method must return a StatusBase object which is already completed.

          Returns:
          -

          status (StatusBase) – StatusBase object which will be marked +

          status (StatusBase) – StatusBase object which will be marked as complete when the device is ready to be read.

          @@ -420,7 +416,7 @@

          pcdsdevices.delay_generator.DelayGeneratorBase
          -subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})
          +subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})

          diff --git a/master/generated/pcdsdevices.delay_generator.DgChannel.html b/master/generated/pcdsdevices.delay_generator.DgChannel.html index b1d4cd49d8c..31e7b39d5ef 100644 --- a/master/generated/pcdsdevices.delay_generator.DgChannel.html +++ b/master/generated/pcdsdevices.delay_generator.DgChannel.html @@ -1,25 +1,23 @@ + + - pcdsdevices.delay_generator.DgChannel — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.delay_generator.DgChannel — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -
          - 8.5.1.dev30+gd6e98430 -
          @@ -88,6 +83,7 @@
        • pcdsdevices.ipm
        • pcdsdevices.jet
        • pcdsdevices.keithley
        • +
        • pcdsdevices.lakeshore
        • pcdsdevices.lamp_motion
        • pcdsdevices.lasers.btps
        • pcdsdevices.lasers.counters
        • @@ -202,8 +198,8 @@

          pcdsdevices.delay_generator.DgChannel
          Parameters:
            -
          • prefix (str) – Base PV for the delay generator channel

          • -
          • name (str) – Alias of the channel

          • +
          • prefix (str) – Base PV for the delay generator channel

          • +
          • name (str) – Alias of the channel

          @@ -245,14 +241,14 @@

          pcdsdevices.delay_generator.DgChannelMethods

          -configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]
          +configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]

          Configure the device for something during a run

          This default implementation allows the user to change any of the configuration_attrs. Subclasses might override this to perform additional input validation, cleanup, etc.

          Parameters:
          -

          d (dict) – The configuration dictionary. To specify the order that +

          d (dict) – The configuration dictionary. To specify the order that the changes should be made, use an OrderedDict.

          Returns:
          @@ -267,7 +263,7 @@

          pcdsdevices.delay_generator.DgChannel
          -describe() OrderedDictType[str, Dict[str, Any]]
          +describe() OrderedDictType[str, Dict[str, Any]]

          Provide schema and meta-data for read().

          This keys in the OrderedDict this method returns must match the keys in the OrderedDict return by read().

          @@ -303,7 +299,7 @@

          pcdsdevices.delay_generator.DgChannel
          -read() OrderedDictType[str, Dict[str, Any]]
          +read() OrderedDictType[str, Dict[str, Any]]

          Read data from the device.

          This method is expected to be as instantaneous as possible, with any substantial acquisition time taken care of in @@ -326,7 +322,7 @@

          pcdsdevices.delay_generator.DgChannel
          -read_configuration() OrderedDictType[str, Dict[str, Any]]
          +read_configuration() OrderedDictType[str, Dict[str, Any]]

          Dictionary mapping names to value dicts with keys: value, timestamp

          To control which fields are included, change the Component kinds on the device, or modify the configuration_attrs list.

          @@ -352,7 +348,7 @@

          pcdsdevices.delay_generator.DgChannel
          -status() str
          +status() str

          Returns a str with the current pv values for the device.

          @@ -369,7 +365,7 @@

          pcdsdevices.delay_generator.DgChannel
          -trigger() StatusBase
          +trigger() StatusBase

          Trigger the device and return status object.

          This method is responsible for implementing ‘trigger’ or ‘acquire’ functionality of this device.

          @@ -377,14 +373,14 @@

          pcdsdevices.delay_generator.DgChannelread() method) then this method is also responsible for arranging that the -StatusBase object returned by this method +StatusBase object returned by this method is notified when the device is ready to be read.

          If there is no delay between triggering and being readable, -then this method must return a StatusBase +then this method must return a StatusBase object which is already completed.

          Returns:
          -

          status (StatusBase) – StatusBase object which will be marked +

          status (StatusBase) – StatusBase object which will be marked as complete when the device is ready to be read.

          @@ -413,7 +409,7 @@

          pcdsdevices.delay_generator.DgChannel
          -subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})
          +subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})

          diff --git a/master/generated/pcdsdevices.device.GroupDevice.html b/master/generated/pcdsdevices.device.GroupDevice.html index 1a998fdf222..168c6e17ea2 100644 --- a/master/generated/pcdsdevices.device.GroupDevice.html +++ b/master/generated/pcdsdevices.device.GroupDevice.html @@ -1,25 +1,23 @@ + + - pcdsdevices.device.GroupDevice — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.device.GroupDevice — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -
          - 8.5.1.dev30+gd6e98430 -
          @@ -88,6 +83,7 @@
        • pcdsdevices.ipm
        • pcdsdevices.jet
        • pcdsdevices.keithley
        • +
        • pcdsdevices.lakeshore
        • pcdsdevices.lamp_motion
        • pcdsdevices.lasers.btps
        • pcdsdevices.lasers.counters
        • @@ -237,14 +233,14 @@

          pcdsdevices.device.GroupDeviceMethods

          -configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]
          +configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]

          Configure the device for something during a run

          This default implementation allows the user to change any of the configuration_attrs. Subclasses might override this to perform additional input validation, cleanup, etc.

          Parameters:
          -

          d (dict) – The configuration dictionary. To specify the order that +

          d (dict) – The configuration dictionary. To specify the order that the changes should be made, use an OrderedDict.

          Returns:
          @@ -259,7 +255,7 @@

          pcdsdevices.device.GroupDevice
          -describe() OrderedDictType[str, Dict[str, Any]]
          +describe() OrderedDictType[str, Dict[str, Any]]

          Provide schema and meta-data for read().

          This keys in the OrderedDict this method returns must match the keys in the OrderedDict return by read().

          @@ -283,7 +279,7 @@

          pcdsdevices.device.GroupDevice
          -read() OrderedDictType[str, Dict[str, Any]]
          +read() OrderedDictType[str, Dict[str, Any]]

          Read data from the device.

          This method is expected to be as instantaneous as possible, with any substantial acquisition time taken care of in @@ -306,7 +302,7 @@

          pcdsdevices.device.GroupDevice
          -read_configuration() OrderedDictType[str, Dict[str, Any]]
          +read_configuration() OrderedDictType[str, Dict[str, Any]]

          Dictionary mapping names to value dicts with keys: value, timestamp

          To control which fields are included, change the Component kinds on the device, or modify the configuration_attrs list.

          @@ -314,7 +310,7 @@

          pcdsdevices.device.GroupDevice
          -stage_group_instances() Iterator[OphydObject]
          +stage_group_instances() Iterator[OphydObject]

          Yields an iterator of subdevices that should be staged.

          @@ -331,7 +327,7 @@

          pcdsdevices.device.GroupDevice
          -trigger() StatusBase
          +trigger() StatusBase

          Trigger the device and return status object.

          This method is responsible for implementing ‘trigger’ or ‘acquire’ functionality of this device.

          @@ -339,14 +335,14 @@

          pcdsdevices.device.GroupDeviceread() method) then this method is also responsible for arranging that the -StatusBase object returned by this method +StatusBase object returned by this method is notified when the device is ready to be read.

          If there is no delay between triggering and being readable, -then this method must return a StatusBase +then this method must return a StatusBase object which is already completed.

          Returns:
          -

          status (StatusBase) – StatusBase object which will be marked +

          status (StatusBase) – StatusBase object which will be marked as complete when the device is ready to be read.

          @@ -375,17 +371,17 @@

          pcdsdevices.device.GroupDevice
          -needs_parent: list[type[OphydObject]] = [<class 'ophyd.signal.AttributeSignal'>, <class 'ophyd.signal.DerivedSignal'>, <class 'ophyd.areadetector.plugins.PluginBase'>, <class 'ophyd.pseudopos.PseudoSingle'>, <class 'pcdsdevices.signal.PVStateSignal'>, <class 'pcdsdevices.signal.AggregateSignal'>]
          +needs_parent: list[type[OphydObject]] = [<class 'ophyd.signal.AttributeSignal'>, <class 'ophyd.signal.DerivedSignal'>, <class 'ophyd.areadetector.plugins.PluginBase'>, <class 'ophyd.pseudopos.PseudoSingle'>, <class 'pcdsdevices.signal.PVStateSignal'>, <class 'pcdsdevices.signal.AggregateSignal'>]

          -stage_group: list[Component] = None
          +stage_group: list[Component] = None
          -subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})
          +subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})
          diff --git a/master/generated/pcdsdevices.device.InterfaceDevice.html b/master/generated/pcdsdevices.device.InterfaceDevice.html index e1148cea401..b97f8f3b5b6 100644 --- a/master/generated/pcdsdevices.device.InterfaceDevice.html +++ b/master/generated/pcdsdevices.device.InterfaceDevice.html @@ -1,25 +1,23 @@ + + - pcdsdevices.device.InterfaceDevice — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.device.InterfaceDevice — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -
          - 8.5.1.dev30+gd6e98430 -
          @@ -88,6 +83,7 @@
        • pcdsdevices.ipm
        • pcdsdevices.jet
        • pcdsdevices.keithley
        • +
        • pcdsdevices.lakeshore
        • pcdsdevices.lamp_motion
        • pcdsdevices.lasers.btps
        • pcdsdevices.lasers.counters
        • @@ -223,14 +219,14 @@

          pcdsdevices.device.InterfaceDeviceMethods

          -configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]
          +configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]

          Configure the device for something during a run

          This default implementation allows the user to change any of the configuration_attrs. Subclasses might override this to perform additional input validation, cleanup, etc.

          Parameters:
          -

          d (dict) – The configuration dictionary. To specify the order that +

          d (dict) – The configuration dictionary. To specify the order that the changes should be made, use an OrderedDict.

          Returns:
          @@ -245,7 +241,7 @@

          pcdsdevices.device.InterfaceDevice
          -describe() OrderedDictType[str, Dict[str, Any]]
          +describe() OrderedDictType[str, Dict[str, Any]]

          Provide schema and meta-data for read().

          This keys in the OrderedDict this method returns must match the keys in the OrderedDict return by read().

          @@ -269,7 +265,7 @@

          pcdsdevices.device.InterfaceDevice
          -read() OrderedDictType[str, Dict[str, Any]]
          +read() OrderedDictType[str, Dict[str, Any]]

          Read data from the device.

          This method is expected to be as instantaneous as possible, with any substantial acquisition time taken care of in @@ -292,7 +288,7 @@

          pcdsdevices.device.InterfaceDevice
          -read_configuration() OrderedDictType[str, Dict[str, Any]]
          +read_configuration() OrderedDictType[str, Dict[str, Any]]

          Dictionary mapping names to value dicts with keys: value, timestamp

          To control which fields are included, change the Component kinds on the device, or modify the configuration_attrs list.

          @@ -311,7 +307,7 @@

          pcdsdevices.device.InterfaceDevice
          -trigger() StatusBase
          +trigger() StatusBase

          Trigger the device and return status object.

          This method is responsible for implementing ‘trigger’ or ‘acquire’ functionality of this device.

          @@ -319,14 +315,14 @@

          pcdsdevices.device.InterfaceDeviceread() method) then this method is also responsible for arranging that the -StatusBase object returned by this method +StatusBase object returned by this method is notified when the device is ready to be read.

          If there is no delay between triggering and being readable, -then this method must return a StatusBase +then this method must return a StatusBase object which is already completed.

          Returns:
          -

          status (StatusBase) – StatusBase object which will be marked +

          status (StatusBase) – StatusBase object which will be marked as complete when the device is ready to be read.

          @@ -355,7 +351,7 @@

          pcdsdevices.device.InterfaceDevice
          -subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})
          +subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})

          diff --git a/master/generated/pcdsdevices.device.to_interface.html b/master/generated/pcdsdevices.device.to_interface.html index 74eaf57fc23..345db521c28 100644 --- a/master/generated/pcdsdevices.device.to_interface.html +++ b/master/generated/pcdsdevices.device.to_interface.html @@ -1,25 +1,23 @@ + + - pcdsdevices.device.to_interface — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.device.to_interface — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -
          - 8.5.1.dev30+gd6e98430 -
          @@ -88,6 +83,7 @@
        • pcdsdevices.ipm
        • pcdsdevices.jet
        • pcdsdevices.keithley
        • +
        • pcdsdevices.lakeshore
        • pcdsdevices.lamp_motion
        • pcdsdevices.lasers.btps
        • pcdsdevices.lasers.counters
        • diff --git a/master/generated/pcdsdevices.digital_signals.J120K.html b/master/generated/pcdsdevices.digital_signals.J120K.html index 14defb44c2a..66f1f5d7e8f 100644 --- a/master/generated/pcdsdevices.digital_signals.J120K.html +++ b/master/generated/pcdsdevices.digital_signals.J120K.html @@ -1,25 +1,23 @@ + + - pcdsdevices.digital_signals.J120K — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.digital_signals.J120K — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -
          - 8.5.1.dev30+gd6e98430 -
          @@ -86,6 +81,7 @@
        • pcdsdevices.ipm
        • pcdsdevices.jet
        • pcdsdevices.keithley
        • +
        • pcdsdevices.lakeshore
        • pcdsdevices.lamp_motion
        • pcdsdevices.lasers.btps
        • pcdsdevices.lasers.counters
        • @@ -221,14 +217,14 @@

          pcdsdevices.digital_signals.J120KMethods

          -configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]
          +configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]

          Configure the device for something during a run

          This default implementation allows the user to change any of the configuration_attrs. Subclasses might override this to perform additional input validation, cleanup, etc.

          Parameters:
          -

          d (dict) – The configuration dictionary. To specify the order that +

          d (dict) – The configuration dictionary. To specify the order that the changes should be made, use an OrderedDict.

          Returns:
          @@ -243,7 +239,7 @@

          pcdsdevices.digital_signals.J120K
          -describe() OrderedDictType[str, Dict[str, Any]]
          +describe() OrderedDictType[str, Dict[str, Any]]

          Provide schema and meta-data for read().

          This keys in the OrderedDict this method returns must match the keys in the OrderedDict return by read().

          @@ -273,7 +269,7 @@

          pcdsdevices.digital_signals.J120K
          -read() OrderedDictType[str, Dict[str, Any]]
          +read() OrderedDictType[str, Dict[str, Any]]

          Read data from the device.

          This method is expected to be as instantaneous as possible, with any substantial acquisition time taken care of in @@ -296,7 +292,7 @@

          pcdsdevices.digital_signals.J120K
          -read_configuration() OrderedDictType[str, Dict[str, Any]]
          +read_configuration() OrderedDictType[str, Dict[str, Any]]

          Dictionary mapping names to value dicts with keys: value, timestamp

          To control which fields are included, change the Component kinds on the device, or modify the configuration_attrs list.

          @@ -312,7 +308,7 @@

          pcdsdevices.digital_signals.J120K
          -status() str
          +status() str

          Returns a str with the current pv values for the device.

          @@ -329,7 +325,7 @@

          pcdsdevices.digital_signals.J120K
          -trigger() StatusBase
          +trigger() StatusBase

          Trigger the device and return status object.

          This method is responsible for implementing ‘trigger’ or ‘acquire’ functionality of this device.

          @@ -337,14 +333,14 @@

          pcdsdevices.digital_signals.J120Kread() method) then this method is also responsible for arranging that the -StatusBase object returned by this method +StatusBase object returned by this method is notified when the device is ready to be read.

          If there is no delay between triggering and being readable, -then this method must return a StatusBase +then this method must return a StatusBase object which is already completed.

          Returns:
          -

          status (StatusBase) – StatusBase object which will be marked +

          status (StatusBase) – StatusBase object which will be marked as complete when the device is ready to be read.

          @@ -373,7 +369,7 @@

          pcdsdevices.digital_signals.J120K
          -subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})
          +subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})

          diff --git a/master/generated/pcdsdevices.digitizers.Qadc.html b/master/generated/pcdsdevices.digitizers.Qadc.html index 29fc68c13f1..d78a9812553 100644 --- a/master/generated/pcdsdevices.digitizers.Qadc.html +++ b/master/generated/pcdsdevices.digitizers.Qadc.html @@ -1,25 +1,23 @@ + + - pcdsdevices.digitizers.Qadc — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.digitizers.Qadc — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -
          - 8.5.1.dev30+gd6e98430 -
          @@ -107,6 +102,7 @@
        • pcdsdevices.ipm
        • pcdsdevices.jet
        • pcdsdevices.keithley
        • +
        • pcdsdevices.lakeshore
        • pcdsdevices.lamp_motion
        • pcdsdevices.lasers.btps
        • pcdsdevices.lasers.counters
        • @@ -445,14 +441,14 @@

          pcdsdevices.digitizers.QadcMethods

          -configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]
          +configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]

          Configure the device for something during a run

          This default implementation allows the user to change any of the configuration_attrs. Subclasses might override this to perform additional input validation, cleanup, etc.

          Parameters:
          -

          d (dict) – The configuration dictionary. To specify the order that +

          d (dict) – The configuration dictionary. To specify the order that the changes should be made, use an OrderedDict.

          Returns:
          @@ -467,7 +463,7 @@

          pcdsdevices.digitizers.Qadc
          -describe() OrderedDictType[str, Dict[str, Any]]
          +describe() OrderedDictType[str, Dict[str, Any]]

          Provide schema and meta-data for read().

          This keys in the OrderedDict this method returns must match the keys in the OrderedDict return by read().

          @@ -497,7 +493,7 @@

          pcdsdevices.digitizers.Qadc
          -read() OrderedDictType[str, Dict[str, Any]]
          +read() OrderedDictType[str, Dict[str, Any]]

          Read data from the device.

          This method is expected to be as instantaneous as possible, with any substantial acquisition time taken care of in @@ -520,7 +516,7 @@

          pcdsdevices.digitizers.Qadc
          -read_configuration() OrderedDictType[str, Dict[str, Any]]
          +read_configuration() OrderedDictType[str, Dict[str, Any]]

          Dictionary mapping names to value dicts with keys: value, timestamp

          To control which fields are included, change the Component kinds on the device, or modify the configuration_attrs list.

          @@ -536,7 +532,7 @@

          pcdsdevices.digitizers.Qadc
          -status() str
          +status() str

          Returns a str with the current pv values for the device.

          @@ -553,7 +549,7 @@

          pcdsdevices.digitizers.Qadc
          -trigger() StatusBase
          +trigger() StatusBase

          Trigger the device and return status object.

          This method is responsible for implementing ‘trigger’ or ‘acquire’ functionality of this device.

          @@ -561,14 +557,14 @@

          pcdsdevices.digitizers.Qadcread() method) then this method is also responsible for arranging that the -StatusBase object returned by this method +StatusBase object returned by this method is notified when the device is ready to be read.

          If there is no delay between triggering and being readable, -then this method must return a StatusBase +then this method must return a StatusBase object which is already completed.

          Returns:
          -

          status (StatusBase) – StatusBase object which will be marked +

          status (StatusBase) – StatusBase object which will be marked as complete when the device is ready to be read.

          @@ -597,7 +593,7 @@

          pcdsdevices.digitizers.Qadc
          -subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})
          +subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})

          diff --git a/master/generated/pcdsdevices.digitizers.Qadc134.html b/master/generated/pcdsdevices.digitizers.Qadc134.html index 39b33f4dcaf..a5f4c23a701 100644 --- a/master/generated/pcdsdevices.digitizers.Qadc134.html +++ b/master/generated/pcdsdevices.digitizers.Qadc134.html @@ -1,25 +1,23 @@ + + - pcdsdevices.digitizers.Qadc134 — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.digitizers.Qadc134 — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -
          - 8.5.1.dev30+gd6e98430 -
          @@ -107,6 +102,7 @@
        • pcdsdevices.ipm
        • pcdsdevices.jet
        • pcdsdevices.keithley
        • +
        • pcdsdevices.lakeshore
        • pcdsdevices.lamp_motion
        • pcdsdevices.lasers.btps
        • pcdsdevices.lasers.counters
        • @@ -368,14 +364,14 @@

          pcdsdevices.digitizers.Qadc134Methods

          -configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]
          +configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]

          Configure the device for something during a run

          This default implementation allows the user to change any of the configuration_attrs. Subclasses might override this to perform additional input validation, cleanup, etc.

          Parameters:
          -

          d (dict) – The configuration dictionary. To specify the order that +

          d (dict) – The configuration dictionary. To specify the order that the changes should be made, use an OrderedDict.

          Returns:
          @@ -390,7 +386,7 @@

          pcdsdevices.digitizers.Qadc134
          -describe() OrderedDictType[str, Dict[str, Any]]
          +describe() OrderedDictType[str, Dict[str, Any]]

          Provide schema and meta-data for read().

          This keys in the OrderedDict this method returns must match the keys in the OrderedDict return by read().

          @@ -420,7 +416,7 @@

          pcdsdevices.digitizers.Qadc134
          -read() OrderedDictType[str, Dict[str, Any]]
          +read() OrderedDictType[str, Dict[str, Any]]

          Read data from the device.

          This method is expected to be as instantaneous as possible, with any substantial acquisition time taken care of in @@ -443,7 +439,7 @@

          pcdsdevices.digitizers.Qadc134
          -read_configuration() OrderedDictType[str, Dict[str, Any]]
          +read_configuration() OrderedDictType[str, Dict[str, Any]]

          Dictionary mapping names to value dicts with keys: value, timestamp

          To control which fields are included, change the Component kinds on the device, or modify the configuration_attrs list.

          @@ -459,7 +455,7 @@

          pcdsdevices.digitizers.Qadc134
          -status() str
          +status() str

          Returns a str with the current pv values for the device.

          @@ -476,7 +472,7 @@

          pcdsdevices.digitizers.Qadc134
          -trigger() StatusBase
          +trigger() StatusBase

          Trigger the device and return status object.

          This method is responsible for implementing ‘trigger’ or ‘acquire’ functionality of this device.

          @@ -484,14 +480,14 @@

          pcdsdevices.digitizers.Qadc134read() method) then this method is also responsible for arranging that the -StatusBase object returned by this method +StatusBase object returned by this method is notified when the device is ready to be read.

          If there is no delay between triggering and being readable, -then this method must return a StatusBase +then this method must return a StatusBase object which is already completed.

          Returns:
          -

          status (StatusBase) – StatusBase object which will be marked +

          status (StatusBase) – StatusBase object which will be marked as complete when the device is ready to be read.

          @@ -520,7 +516,7 @@

          pcdsdevices.digitizers.Qadc134
          -subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})
          +subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})

          diff --git a/master/generated/pcdsdevices.digitizers.Qadc134Sparsification.html b/master/generated/pcdsdevices.digitizers.Qadc134Sparsification.html index 47695b3f5bf..7e8b9776b5a 100644 --- a/master/generated/pcdsdevices.digitizers.Qadc134Sparsification.html +++ b/master/generated/pcdsdevices.digitizers.Qadc134Sparsification.html @@ -1,25 +1,23 @@ + + - pcdsdevices.digitizers.Qadc134Sparsification — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.digitizers.Qadc134Sparsification — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -
          - 8.5.1.dev30+gd6e98430 -
          @@ -107,6 +102,7 @@
        • pcdsdevices.ipm
        • pcdsdevices.jet
        • pcdsdevices.keithley
        • +
        • pcdsdevices.lakeshore
        • pcdsdevices.lamp_motion
        • pcdsdevices.lasers.btps
        • pcdsdevices.lasers.counters
        • @@ -284,14 +280,14 @@

          pcdsdevices.digitizers.Qadc134SparsificationMethods

          -configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]
          +configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]

          Configure the device for something during a run

          This default implementation allows the user to change any of the configuration_attrs. Subclasses might override this to perform additional input validation, cleanup, etc.

          Parameters:
          -

          d (dict) – The configuration dictionary. To specify the order that +

          d (dict) – The configuration dictionary. To specify the order that the changes should be made, use an OrderedDict.

          Returns:
          @@ -306,7 +302,7 @@

          pcdsdevices.digitizers.Qadc134Sparsification
          -describe() OrderedDictType[str, Dict[str, Any]]
          +describe() OrderedDictType[str, Dict[str, Any]]

          Provide schema and meta-data for read().

          This keys in the OrderedDict this method returns must match the keys in the OrderedDict return by read().

          @@ -336,7 +332,7 @@

          pcdsdevices.digitizers.Qadc134Sparsification
          -read() OrderedDictType[str, Dict[str, Any]]
          +read() OrderedDictType[str, Dict[str, Any]]

          Read data from the device.

          This method is expected to be as instantaneous as possible, with any substantial acquisition time taken care of in @@ -359,7 +355,7 @@

          pcdsdevices.digitizers.Qadc134Sparsification
          -read_configuration() OrderedDictType[str, Dict[str, Any]]
          +read_configuration() OrderedDictType[str, Dict[str, Any]]

          Dictionary mapping names to value dicts with keys: value, timestamp

          To control which fields are included, change the Component kinds on the device, or modify the configuration_attrs list.

          @@ -375,7 +371,7 @@

          pcdsdevices.digitizers.Qadc134Sparsification
          -status() str
          +status() str

          Returns a str with the current pv values for the device.

          @@ -392,7 +388,7 @@

          pcdsdevices.digitizers.Qadc134Sparsification
          -trigger() StatusBase
          +trigger() StatusBase

          Trigger the device and return status object.

          This method is responsible for implementing ‘trigger’ or ‘acquire’ functionality of this device.

          @@ -400,14 +396,14 @@

          pcdsdevices.digitizers.Qadc134Sparsificationread() method) then this method is also responsible for arranging that the -StatusBase object returned by this method +StatusBase object returned by this method is notified when the device is ready to be read.

          If there is no delay between triggering and being readable, -then this method must return a StatusBase +then this method must return a StatusBase object which is already completed.

          Returns:
          -

          status (StatusBase) – StatusBase object which will be marked +

          status (StatusBase) – StatusBase object which will be marked as complete when the device is ready to be read.

          @@ -436,7 +432,7 @@

          pcdsdevices.digitizers.Qadc134Sparsification
          -subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})
          +subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})

          diff --git a/master/generated/pcdsdevices.digitizers.QadcBase.html b/master/generated/pcdsdevices.digitizers.QadcBase.html index 86f127ef786..f77828d6339 100644 --- a/master/generated/pcdsdevices.digitizers.QadcBase.html +++ b/master/generated/pcdsdevices.digitizers.QadcBase.html @@ -1,25 +1,23 @@ + + - pcdsdevices.digitizers.QadcBase — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.digitizers.QadcBase — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -
          - 8.5.1.dev30+gd6e98430 -
          @@ -107,6 +102,7 @@
        • pcdsdevices.ipm
        • pcdsdevices.jet
        • pcdsdevices.keithley
        • +
        • pcdsdevices.lakeshore
        • pcdsdevices.lamp_motion
        • pcdsdevices.lasers.btps
        • pcdsdevices.lasers.counters
        • @@ -270,14 +266,14 @@

          pcdsdevices.digitizers.QadcBaseMethods

          -configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]
          +configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]

          Configure the device for something during a run

          This default implementation allows the user to change any of the configuration_attrs. Subclasses might override this to perform additional input validation, cleanup, etc.

          Parameters:
          -

          d (dict) – The configuration dictionary. To specify the order that +

          d (dict) – The configuration dictionary. To specify the order that the changes should be made, use an OrderedDict.

          Returns:
          @@ -292,7 +288,7 @@

          pcdsdevices.digitizers.QadcBase
          -describe() OrderedDictType[str, Dict[str, Any]]
          +describe() OrderedDictType[str, Dict[str, Any]]

          Provide schema and meta-data for read().

          This keys in the OrderedDict this method returns must match the keys in the OrderedDict return by read().

          @@ -322,7 +318,7 @@

          pcdsdevices.digitizers.QadcBase
          -read() OrderedDictType[str, Dict[str, Any]]
          +read() OrderedDictType[str, Dict[str, Any]]

          Read data from the device.

          This method is expected to be as instantaneous as possible, with any substantial acquisition time taken care of in @@ -345,7 +341,7 @@

          pcdsdevices.digitizers.QadcBase
          -read_configuration() OrderedDictType[str, Dict[str, Any]]
          +read_configuration() OrderedDictType[str, Dict[str, Any]]

          Dictionary mapping names to value dicts with keys: value, timestamp

          To control which fields are included, change the Component kinds on the device, or modify the configuration_attrs list.

          @@ -361,7 +357,7 @@

          pcdsdevices.digitizers.QadcBase
          -status() str
          +status() str

          Returns a str with the current pv values for the device.

          @@ -378,7 +374,7 @@

          pcdsdevices.digitizers.QadcBase
          -trigger() StatusBase
          +trigger() StatusBase

          Trigger the device and return status object.

          This method is responsible for implementing ‘trigger’ or ‘acquire’ functionality of this device.

          @@ -386,14 +382,14 @@

          pcdsdevices.digitizers.QadcBaseread() method) then this method is also responsible for arranging that the -StatusBase object returned by this method +StatusBase object returned by this method is notified when the device is ready to be read.

          If there is no delay between triggering and being readable, -then this method must return a StatusBase +then this method must return a StatusBase object which is already completed.

          Returns:
          -

          status (StatusBase) – StatusBase object which will be marked +

          status (StatusBase) – StatusBase object which will be marked as complete when the device is ready to be read.

          @@ -422,7 +418,7 @@

          pcdsdevices.digitizers.QadcBase
          -subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})
          +subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})

          diff --git a/master/generated/pcdsdevices.digitizers.Wave8V2.html b/master/generated/pcdsdevices.digitizers.Wave8V2.html index 2c1e7ed2a9a..71ac0bd089e 100644 --- a/master/generated/pcdsdevices.digitizers.Wave8V2.html +++ b/master/generated/pcdsdevices.digitizers.Wave8V2.html @@ -1,25 +1,23 @@ + + - pcdsdevices.digitizers.Wave8V2 — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.digitizers.Wave8V2 — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -
          - 8.5.1.dev30+gd6e98430 -
          @@ -107,6 +102,7 @@
        • pcdsdevices.ipm
        • pcdsdevices.jet
        • pcdsdevices.keithley
        • +
        • pcdsdevices.lakeshore
        • pcdsdevices.lamp_motion
        • pcdsdevices.lasers.btps
        • pcdsdevices.lasers.counters
        • @@ -473,14 +469,14 @@

          pcdsdevices.digitizers.Wave8V2Methods

          -configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]
          +configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]

          Configure the device for something during a run

          This default implementation allows the user to change any of the configuration_attrs. Subclasses might override this to perform additional input validation, cleanup, etc.

          Parameters:
          -

          d (dict) – The configuration dictionary. To specify the order that +

          d (dict) – The configuration dictionary. To specify the order that the changes should be made, use an OrderedDict.

          Returns:
          @@ -495,7 +491,7 @@

          pcdsdevices.digitizers.Wave8V2
          -describe() OrderedDictType[str, Dict[str, Any]]
          +describe() OrderedDictType[str, Dict[str, Any]]

          Provide schema and meta-data for read().

          This keys in the OrderedDict this method returns must match the keys in the OrderedDict return by read().

          @@ -525,7 +521,7 @@

          pcdsdevices.digitizers.Wave8V2
          -read() OrderedDictType[str, Dict[str, Any]]
          +read() OrderedDictType[str, Dict[str, Any]]

          Read data from the device.

          This method is expected to be as instantaneous as possible, with any substantial acquisition time taken care of in @@ -548,7 +544,7 @@

          pcdsdevices.digitizers.Wave8V2
          -read_configuration() OrderedDictType[str, Dict[str, Any]]
          +read_configuration() OrderedDictType[str, Dict[str, Any]]

          Dictionary mapping names to value dicts with keys: value, timestamp

          To control which fields are included, change the Component kinds on the device, or modify the configuration_attrs list.

          @@ -564,7 +560,7 @@

          pcdsdevices.digitizers.Wave8V2
          -status() str
          +status() str

          Returns a str with the current pv values for the device.

          @@ -581,7 +577,7 @@

          pcdsdevices.digitizers.Wave8V2
          -trigger() StatusBase
          +trigger() StatusBase

          Trigger the device and return status object.

          This method is responsible for implementing ‘trigger’ or ‘acquire’ functionality of this device.

          @@ -589,14 +585,14 @@

          pcdsdevices.digitizers.Wave8V2read() method) then this method is also responsible for arranging that the -StatusBase object returned by this method +StatusBase object returned by this method is notified when the device is ready to be read.

          If there is no delay between triggering and being readable, -then this method must return a StatusBase +then this method must return a StatusBase object which is already completed.

          Returns:
          -

          status (StatusBase) – StatusBase object which will be marked +

          status (StatusBase) – StatusBase object which will be marked as complete when the device is ready to be read.

          @@ -625,7 +621,7 @@

          pcdsdevices.digitizers.Wave8V2
          -subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})
          +subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})

          diff --git a/master/generated/pcdsdevices.digitizers.Wave8V2ADCDelayLanes.html b/master/generated/pcdsdevices.digitizers.Wave8V2ADCDelayLanes.html index 0be918c5c92..43bf2403904 100644 --- a/master/generated/pcdsdevices.digitizers.Wave8V2ADCDelayLanes.html +++ b/master/generated/pcdsdevices.digitizers.Wave8V2ADCDelayLanes.html @@ -1,25 +1,23 @@ + + - pcdsdevices.digitizers.Wave8V2ADCDelayLanes — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.digitizers.Wave8V2ADCDelayLanes — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -
          - 8.5.1.dev30+gd6e98430 -
          @@ -107,6 +102,7 @@
        • pcdsdevices.ipm
        • pcdsdevices.jet
        • pcdsdevices.keithley
        • +
        • pcdsdevices.lakeshore
        • pcdsdevices.lamp_motion
        • pcdsdevices.lasers.btps
        • pcdsdevices.lasers.counters
        • @@ -291,14 +287,14 @@

          pcdsdevices.digitizers.Wave8V2ADCDelayLanesMethods

          -configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]
          +configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]

          Configure the device for something during a run

          This default implementation allows the user to change any of the configuration_attrs. Subclasses might override this to perform additional input validation, cleanup, etc.

          Parameters:
          -

          d (dict) – The configuration dictionary. To specify the order that +

          d (dict) – The configuration dictionary. To specify the order that the changes should be made, use an OrderedDict.

          Returns:
          @@ -313,7 +309,7 @@

          pcdsdevices.digitizers.Wave8V2ADCDelayLanes
          -describe() OrderedDictType[str, Dict[str, Any]]
          +describe() OrderedDictType[str, Dict[str, Any]]

          Provide schema and meta-data for read().

          This keys in the OrderedDict this method returns must match the keys in the OrderedDict return by read().

          @@ -343,7 +339,7 @@

          pcdsdevices.digitizers.Wave8V2ADCDelayLanes
          -read() OrderedDictType[str, Dict[str, Any]]
          +read() OrderedDictType[str, Dict[str, Any]]

          Read data from the device.

          This method is expected to be as instantaneous as possible, with any substantial acquisition time taken care of in @@ -366,7 +362,7 @@

          pcdsdevices.digitizers.Wave8V2ADCDelayLanes
          -read_configuration() OrderedDictType[str, Dict[str, Any]]
          +read_configuration() OrderedDictType[str, Dict[str, Any]]

          Dictionary mapping names to value dicts with keys: value, timestamp

          To control which fields are included, change the Component kinds on the device, or modify the configuration_attrs list.

          @@ -382,7 +378,7 @@

          pcdsdevices.digitizers.Wave8V2ADCDelayLanes
          -status() str
          +status() str

          Returns a str with the current pv values for the device.

          @@ -399,7 +395,7 @@

          pcdsdevices.digitizers.Wave8V2ADCDelayLanes
          -trigger() StatusBase
          +trigger() StatusBase

          Trigger the device and return status object.

          This method is responsible for implementing ‘trigger’ or ‘acquire’ functionality of this device.

          @@ -407,14 +403,14 @@

          pcdsdevices.digitizers.Wave8V2ADCDelayLanesread() method) then this method is also responsible for arranging that the -StatusBase object returned by this method +StatusBase object returned by this method is notified when the device is ready to be read.

          If there is no delay between triggering and being readable, -then this method must return a StatusBase +then this method must return a StatusBase object which is already completed.

          Returns:
          -

          status (StatusBase) – StatusBase object which will be marked +

          status (StatusBase) – StatusBase object which will be marked as complete when the device is ready to be read.

          @@ -443,7 +439,7 @@

          pcdsdevices.digitizers.Wave8V2ADCDelayLanes
          -subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})
          +subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})

          diff --git a/master/generated/pcdsdevices.digitizers.Wave8V2ADCRegs.html b/master/generated/pcdsdevices.digitizers.Wave8V2ADCRegs.html index b21ae84947e..cb34741562b 100644 --- a/master/generated/pcdsdevices.digitizers.Wave8V2ADCRegs.html +++ b/master/generated/pcdsdevices.digitizers.Wave8V2ADCRegs.html @@ -1,25 +1,23 @@ + + - pcdsdevices.digitizers.Wave8V2ADCRegs — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.digitizers.Wave8V2ADCRegs — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -
          - 8.5.1.dev30+gd6e98430 -
          @@ -107,6 +102,7 @@
        • pcdsdevices.ipm
        • pcdsdevices.jet
        • pcdsdevices.keithley
        • +
        • pcdsdevices.lakeshore
        • pcdsdevices.lamp_motion
        • pcdsdevices.lasers.btps
        • pcdsdevices.lasers.counters
        • @@ -361,14 +357,14 @@

          pcdsdevices.digitizers.Wave8V2ADCRegsMethods

          -configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]
          +configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]

          Configure the device for something during a run

          This default implementation allows the user to change any of the configuration_attrs. Subclasses might override this to perform additional input validation, cleanup, etc.

          Parameters:
          -

          d (dict) – The configuration dictionary. To specify the order that +

          d (dict) – The configuration dictionary. To specify the order that the changes should be made, use an OrderedDict.

          Returns:
          @@ -383,7 +379,7 @@

          pcdsdevices.digitizers.Wave8V2ADCRegs
          -describe() OrderedDictType[str, Dict[str, Any]]
          +describe() OrderedDictType[str, Dict[str, Any]]

          Provide schema and meta-data for read().

          This keys in the OrderedDict this method returns must match the keys in the OrderedDict return by read().

          @@ -413,7 +409,7 @@

          pcdsdevices.digitizers.Wave8V2ADCRegs
          -read() OrderedDictType[str, Dict[str, Any]]
          +read() OrderedDictType[str, Dict[str, Any]]

          Read data from the device.

          This method is expected to be as instantaneous as possible, with any substantial acquisition time taken care of in @@ -436,7 +432,7 @@

          pcdsdevices.digitizers.Wave8V2ADCRegs
          -read_configuration() OrderedDictType[str, Dict[str, Any]]
          +read_configuration() OrderedDictType[str, Dict[str, Any]]

          Dictionary mapping names to value dicts with keys: value, timestamp

          To control which fields are included, change the Component kinds on the device, or modify the configuration_attrs list.

          @@ -452,7 +448,7 @@

          pcdsdevices.digitizers.Wave8V2ADCRegs
          -status() str
          +status() str

          Returns a str with the current pv values for the device.

          @@ -469,7 +465,7 @@

          pcdsdevices.digitizers.Wave8V2ADCRegs
          -trigger() StatusBase
          +trigger() StatusBase

          Trigger the device and return status object.

          This method is responsible for implementing ‘trigger’ or ‘acquire’ functionality of this device.

          @@ -477,14 +473,14 @@

          pcdsdevices.digitizers.Wave8V2ADCRegsread() method) then this method is also responsible for arranging that the -StatusBase object returned by this method +StatusBase object returned by this method is notified when the device is ready to be read.

          If there is no delay between triggering and being readable, -then this method must return a StatusBase +then this method must return a StatusBase object which is already completed.

          Returns:
          -

          status (StatusBase) – StatusBase object which will be marked +

          status (StatusBase) – StatusBase object which will be marked as complete when the device is ready to be read.

          @@ -513,7 +509,7 @@

          pcdsdevices.digitizers.Wave8V2ADCRegs
          -subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})
          +subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})

          diff --git a/master/generated/pcdsdevices.digitizers.Wave8V2ADCSampleReadout.html b/master/generated/pcdsdevices.digitizers.Wave8V2ADCSampleReadout.html index 040e8a32285..792029e5334 100644 --- a/master/generated/pcdsdevices.digitizers.Wave8V2ADCSampleReadout.html +++ b/master/generated/pcdsdevices.digitizers.Wave8V2ADCSampleReadout.html @@ -1,25 +1,23 @@ + + - pcdsdevices.digitizers.Wave8V2ADCSampleReadout — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.digitizers.Wave8V2ADCSampleReadout — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -
          - 8.5.1.dev30+gd6e98430 -
          @@ -107,6 +102,7 @@
        • pcdsdevices.ipm
        • pcdsdevices.jet
        • pcdsdevices.keithley
        • +
        • pcdsdevices.lakeshore
        • pcdsdevices.lamp_motion
        • pcdsdevices.lasers.btps
        • pcdsdevices.lasers.counters
        • @@ -284,14 +280,14 @@

          pcdsdevices.digitizers.Wave8V2ADCSampleReadoutMethods

          -configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]
          +configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]

          Configure the device for something during a run

          This default implementation allows the user to change any of the configuration_attrs. Subclasses might override this to perform additional input validation, cleanup, etc.

          Parameters:
          -

          d (dict) – The configuration dictionary. To specify the order that +

          d (dict) – The configuration dictionary. To specify the order that the changes should be made, use an OrderedDict.

          Returns:
          @@ -306,7 +302,7 @@

          pcdsdevices.digitizers.Wave8V2ADCSampleReadout
          -describe() OrderedDictType[str, Dict[str, Any]]
          +describe() OrderedDictType[str, Dict[str, Any]]

          Provide schema and meta-data for read().

          This keys in the OrderedDict this method returns must match the keys in the OrderedDict return by read().

          @@ -336,7 +332,7 @@

          pcdsdevices.digitizers.Wave8V2ADCSampleReadout
          -read() OrderedDictType[str, Dict[str, Any]]
          +read() OrderedDictType[str, Dict[str, Any]]

          Read data from the device.

          This method is expected to be as instantaneous as possible, with any substantial acquisition time taken care of in @@ -359,7 +355,7 @@

          pcdsdevices.digitizers.Wave8V2ADCSampleReadout
          -read_configuration() OrderedDictType[str, Dict[str, Any]]
          +read_configuration() OrderedDictType[str, Dict[str, Any]]

          Dictionary mapping names to value dicts with keys: value, timestamp

          To control which fields are included, change the Component kinds on the device, or modify the configuration_attrs list.

          @@ -375,7 +371,7 @@

          pcdsdevices.digitizers.Wave8V2ADCSampleReadout
          -status() str
          +status() str

          Returns a str with the current pv values for the device.

          @@ -392,7 +388,7 @@

          pcdsdevices.digitizers.Wave8V2ADCSampleReadout
          -trigger() StatusBase
          +trigger() StatusBase

          Trigger the device and return status object.

          This method is responsible for implementing ‘trigger’ or ‘acquire’ functionality of this device.

          @@ -400,14 +396,14 @@

          pcdsdevices.digitizers.Wave8V2ADCSampleReadoutread() method) then this method is also responsible for arranging that the -StatusBase object returned by this method +StatusBase object returned by this method is notified when the device is ready to be read.

          If there is no delay between triggering and being readable, -then this method must return a StatusBase +then this method must return a StatusBase object which is already completed.

          Returns:
          -

          status (StatusBase) – StatusBase object which will be marked +

          status (StatusBase) – StatusBase object which will be marked as complete when the device is ready to be read.

          @@ -436,7 +432,7 @@

          pcdsdevices.digitizers.Wave8V2ADCSampleReadout
          -subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})
          +subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})

          diff --git a/master/generated/pcdsdevices.digitizers.Wave8V2ADCSamples.html b/master/generated/pcdsdevices.digitizers.Wave8V2ADCSamples.html index 9ab4b446842..bf37c7517b5 100644 --- a/master/generated/pcdsdevices.digitizers.Wave8V2ADCSamples.html +++ b/master/generated/pcdsdevices.digitizers.Wave8V2ADCSamples.html @@ -1,25 +1,23 @@ + + - pcdsdevices.digitizers.Wave8V2ADCSamples — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.digitizers.Wave8V2ADCSamples — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -
          - 8.5.1.dev30+gd6e98430 -
          @@ -107,6 +102,7 @@
        • pcdsdevices.ipm
        • pcdsdevices.jet
        • pcdsdevices.keithley
        • +
        • pcdsdevices.lakeshore
        • pcdsdevices.lamp_motion
        • pcdsdevices.lasers.btps
        • pcdsdevices.lasers.counters
        • @@ -291,14 +287,14 @@

          pcdsdevices.digitizers.Wave8V2ADCSamplesMethods

          -configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]
          +configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]

          Configure the device for something during a run

          This default implementation allows the user to change any of the configuration_attrs. Subclasses might override this to perform additional input validation, cleanup, etc.

          Parameters:
          -

          d (dict) – The configuration dictionary. To specify the order that +

          d (dict) – The configuration dictionary. To specify the order that the changes should be made, use an OrderedDict.

          Returns:
          @@ -313,7 +309,7 @@

          pcdsdevices.digitizers.Wave8V2ADCSamples
          -describe() OrderedDictType[str, Dict[str, Any]]
          +describe() OrderedDictType[str, Dict[str, Any]]

          Provide schema and meta-data for read().

          This keys in the OrderedDict this method returns must match the keys in the OrderedDict return by read().

          @@ -343,7 +339,7 @@

          pcdsdevices.digitizers.Wave8V2ADCSamples
          -read() OrderedDictType[str, Dict[str, Any]]
          +read() OrderedDictType[str, Dict[str, Any]]

          Read data from the device.

          This method is expected to be as instantaneous as possible, with any substantial acquisition time taken care of in @@ -366,7 +362,7 @@

          pcdsdevices.digitizers.Wave8V2ADCSamples
          -read_configuration() OrderedDictType[str, Dict[str, Any]]
          +read_configuration() OrderedDictType[str, Dict[str, Any]]

          Dictionary mapping names to value dicts with keys: value, timestamp

          To control which fields are included, change the Component kinds on the device, or modify the configuration_attrs list.

          @@ -382,7 +378,7 @@

          pcdsdevices.digitizers.Wave8V2ADCSamples
          -status() str
          +status() str

          Returns a str with the current pv values for the device.

          @@ -399,7 +395,7 @@

          pcdsdevices.digitizers.Wave8V2ADCSamples
          -trigger() StatusBase
          +trigger() StatusBase

          Trigger the device and return status object.

          This method is responsible for implementing ‘trigger’ or ‘acquire’ functionality of this device.

          @@ -407,14 +403,14 @@

          pcdsdevices.digitizers.Wave8V2ADCSamplesread() method) then this method is also responsible for arranging that the -StatusBase object returned by this method +StatusBase object returned by this method is notified when the device is ready to be read.

          If there is no delay between triggering and being readable, -then this method must return a StatusBase +then this method must return a StatusBase object which is already completed.

          Returns:
          -

          status (StatusBase) – StatusBase object which will be marked +

          status (StatusBase) – StatusBase object which will be marked as complete when the device is ready to be read.

          @@ -443,7 +439,7 @@

          pcdsdevices.digitizers.Wave8V2ADCSamples
          -subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})
          +subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})

          diff --git a/master/generated/pcdsdevices.digitizers.Wave8V2AxiVersion.html b/master/generated/pcdsdevices.digitizers.Wave8V2AxiVersion.html index 667aaeb25f4..31b074a6b6d 100644 --- a/master/generated/pcdsdevices.digitizers.Wave8V2AxiVersion.html +++ b/master/generated/pcdsdevices.digitizers.Wave8V2AxiVersion.html @@ -1,25 +1,23 @@ + + - pcdsdevices.digitizers.Wave8V2AxiVersion — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.digitizers.Wave8V2AxiVersion — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -
          - 8.5.1.dev30+gd6e98430 -
          @@ -107,6 +102,7 @@
        • pcdsdevices.ipm
        • pcdsdevices.jet
        • pcdsdevices.keithley
        • +
        • pcdsdevices.lakeshore
        • pcdsdevices.lamp_motion
        • pcdsdevices.lasers.btps
        • pcdsdevices.lasers.counters
        • @@ -277,14 +273,14 @@

          pcdsdevices.digitizers.Wave8V2AxiVersionMethods

          -configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]
          +configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]

          Configure the device for something during a run

          This default implementation allows the user to change any of the configuration_attrs. Subclasses might override this to perform additional input validation, cleanup, etc.

          Parameters:
          -

          d (dict) – The configuration dictionary. To specify the order that +

          d (dict) – The configuration dictionary. To specify the order that the changes should be made, use an OrderedDict.

          Returns:
          @@ -299,7 +295,7 @@

          pcdsdevices.digitizers.Wave8V2AxiVersion
          -describe() OrderedDictType[str, Dict[str, Any]]
          +describe() OrderedDictType[str, Dict[str, Any]]

          Provide schema and meta-data for read().

          This keys in the OrderedDict this method returns must match the keys in the OrderedDict return by read().

          @@ -329,7 +325,7 @@

          pcdsdevices.digitizers.Wave8V2AxiVersion
          -read() OrderedDictType[str, Dict[str, Any]]
          +read() OrderedDictType[str, Dict[str, Any]]

          Read data from the device.

          This method is expected to be as instantaneous as possible, with any substantial acquisition time taken care of in @@ -352,7 +348,7 @@

          pcdsdevices.digitizers.Wave8V2AxiVersion
          -read_configuration() OrderedDictType[str, Dict[str, Any]]
          +read_configuration() OrderedDictType[str, Dict[str, Any]]

          Dictionary mapping names to value dicts with keys: value, timestamp

          To control which fields are included, change the Component kinds on the device, or modify the configuration_attrs list.

          @@ -368,7 +364,7 @@

          pcdsdevices.digitizers.Wave8V2AxiVersion
          -status() str
          +status() str

          Returns a str with the current pv values for the device.

          @@ -385,7 +381,7 @@

          pcdsdevices.digitizers.Wave8V2AxiVersion
          -trigger() StatusBase
          +trigger() StatusBase

          Trigger the device and return status object.

          This method is responsible for implementing ‘trigger’ or ‘acquire’ functionality of this device.

          @@ -393,14 +389,14 @@

          pcdsdevices.digitizers.Wave8V2AxiVersionread() method) then this method is also responsible for arranging that the -StatusBase object returned by this method +StatusBase object returned by this method is notified when the device is ready to be read.

          If there is no delay between triggering and being readable, -then this method must return a StatusBase +then this method must return a StatusBase object which is already completed.

          Returns:
          -

          status (StatusBase) – StatusBase object which will be marked +

          status (StatusBase) – StatusBase object which will be marked as complete when the device is ready to be read.

          @@ -429,7 +425,7 @@

          pcdsdevices.digitizers.Wave8V2AxiVersion
          -subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})
          +subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})

          diff --git a/master/generated/pcdsdevices.digitizers.Wave8V2EventBuilder.html b/master/generated/pcdsdevices.digitizers.Wave8V2EventBuilder.html index 6fea5362f97..84d42a4245a 100644 --- a/master/generated/pcdsdevices.digitizers.Wave8V2EventBuilder.html +++ b/master/generated/pcdsdevices.digitizers.Wave8V2EventBuilder.html @@ -1,25 +1,23 @@ + + - pcdsdevices.digitizers.Wave8V2EventBuilder — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.digitizers.Wave8V2EventBuilder — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -
          - 8.5.1.dev30+gd6e98430 -
          @@ -107,6 +102,7 @@
        • pcdsdevices.ipm
        • pcdsdevices.jet
        • pcdsdevices.keithley
        • +
        • pcdsdevices.lakeshore
        • pcdsdevices.lamp_motion
        • pcdsdevices.lasers.btps
        • pcdsdevices.lasers.counters
        • @@ -361,14 +357,14 @@

          pcdsdevices.digitizers.Wave8V2EventBuilderMethods

          -configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]
          +configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]

          Configure the device for something during a run

          This default implementation allows the user to change any of the configuration_attrs. Subclasses might override this to perform additional input validation, cleanup, etc.

          Parameters:
          -

          d (dict) – The configuration dictionary. To specify the order that +

          d (dict) – The configuration dictionary. To specify the order that the changes should be made, use an OrderedDict.

          Returns:
          @@ -383,7 +379,7 @@

          pcdsdevices.digitizers.Wave8V2EventBuilder
          -describe() OrderedDictType[str, Dict[str, Any]]
          +describe() OrderedDictType[str, Dict[str, Any]]

          Provide schema and meta-data for read().

          This keys in the OrderedDict this method returns must match the keys in the OrderedDict return by read().

          @@ -413,7 +409,7 @@

          pcdsdevices.digitizers.Wave8V2EventBuilder
          -read() OrderedDictType[str, Dict[str, Any]]
          +read() OrderedDictType[str, Dict[str, Any]]

          Read data from the device.

          This method is expected to be as instantaneous as possible, with any substantial acquisition time taken care of in @@ -436,7 +432,7 @@

          pcdsdevices.digitizers.Wave8V2EventBuilder
          -read_configuration() OrderedDictType[str, Dict[str, Any]]
          +read_configuration() OrderedDictType[str, Dict[str, Any]]

          Dictionary mapping names to value dicts with keys: value, timestamp

          To control which fields are included, change the Component kinds on the device, or modify the configuration_attrs list.

          @@ -452,7 +448,7 @@

          pcdsdevices.digitizers.Wave8V2EventBuilder
          -status() str
          +status() str

          Returns a str with the current pv values for the device.

          @@ -469,7 +465,7 @@

          pcdsdevices.digitizers.Wave8V2EventBuilder
          -trigger() StatusBase
          +trigger() StatusBase

          Trigger the device and return status object.

          This method is responsible for implementing ‘trigger’ or ‘acquire’ functionality of this device.

          @@ -477,14 +473,14 @@

          pcdsdevices.digitizers.Wave8V2EventBuilderread() method) then this method is also responsible for arranging that the -StatusBase object returned by this method +StatusBase object returned by this method is notified when the device is ready to be read.

          If there is no delay between triggering and being readable, -then this method must return a StatusBase +then this method must return a StatusBase object which is already completed.

          Returns:
          -

          status (StatusBase) – StatusBase object which will be marked +

          status (StatusBase) – StatusBase object which will be marked as complete when the device is ready to be read.

          @@ -513,7 +509,7 @@

          pcdsdevices.digitizers.Wave8V2EventBuilder
          -subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})
          +subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})

          diff --git a/master/generated/pcdsdevices.digitizers.Wave8V2EvrV2.html b/master/generated/pcdsdevices.digitizers.Wave8V2EvrV2.html index 6ef007aeb1b..358b134a878 100644 --- a/master/generated/pcdsdevices.digitizers.Wave8V2EvrV2.html +++ b/master/generated/pcdsdevices.digitizers.Wave8V2EvrV2.html @@ -1,25 +1,23 @@ + + - pcdsdevices.digitizers.Wave8V2EvrV2 — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.digitizers.Wave8V2EvrV2 — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -
          - 8.5.1.dev30+gd6e98430 -
          @@ -107,6 +102,7 @@
        • pcdsdevices.ipm
        • pcdsdevices.jet
        • pcdsdevices.keithley
        • +
        • pcdsdevices.lakeshore
        • pcdsdevices.lamp_motion
        • pcdsdevices.lasers.btps
        • pcdsdevices.lasers.counters
        • @@ -305,14 +301,14 @@

          pcdsdevices.digitizers.Wave8V2EvrV2Methods

          -configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]
          +configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]

          Configure the device for something during a run

          This default implementation allows the user to change any of the configuration_attrs. Subclasses might override this to perform additional input validation, cleanup, etc.

          Parameters:
          -

          d (dict) – The configuration dictionary. To specify the order that +

          d (dict) – The configuration dictionary. To specify the order that the changes should be made, use an OrderedDict.

          Returns:
          @@ -327,7 +323,7 @@

          pcdsdevices.digitizers.Wave8V2EvrV2
          -describe() OrderedDictType[str, Dict[str, Any]]
          +describe() OrderedDictType[str, Dict[str, Any]]

          Provide schema and meta-data for read().

          This keys in the OrderedDict this method returns must match the keys in the OrderedDict return by read().

          @@ -357,7 +353,7 @@

          pcdsdevices.digitizers.Wave8V2EvrV2
          -read() OrderedDictType[str, Dict[str, Any]]
          +read() OrderedDictType[str, Dict[str, Any]]

          Read data from the device.

          This method is expected to be as instantaneous as possible, with any substantial acquisition time taken care of in @@ -380,7 +376,7 @@

          pcdsdevices.digitizers.Wave8V2EvrV2
          -read_configuration() OrderedDictType[str, Dict[str, Any]]
          +read_configuration() OrderedDictType[str, Dict[str, Any]]

          Dictionary mapping names to value dicts with keys: value, timestamp

          To control which fields are included, change the Component kinds on the device, or modify the configuration_attrs list.

          @@ -396,7 +392,7 @@

          pcdsdevices.digitizers.Wave8V2EvrV2
          -status() str
          +status() str

          Returns a str with the current pv values for the device.

          @@ -413,7 +409,7 @@

          pcdsdevices.digitizers.Wave8V2EvrV2
          -trigger() StatusBase
          +trigger() StatusBase

          Trigger the device and return status object.

          This method is responsible for implementing ‘trigger’ or ‘acquire’ functionality of this device.

          @@ -421,14 +417,14 @@

          pcdsdevices.digitizers.Wave8V2EvrV2read() method) then this method is also responsible for arranging that the -StatusBase object returned by this method +StatusBase object returned by this method is notified when the device is ready to be read.

          If there is no delay between triggering and being readable, -then this method must return a StatusBase +then this method must return a StatusBase object which is already completed.

          Returns:
          -

          status (StatusBase) – StatusBase object which will be marked +

          status (StatusBase) – StatusBase object which will be marked as complete when the device is ready to be read.

          @@ -457,7 +453,7 @@

          pcdsdevices.digitizers.Wave8V2EvrV2
          -subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})
          +subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})

          diff --git a/master/generated/pcdsdevices.digitizers.Wave8V2Integrators.html b/master/generated/pcdsdevices.digitizers.Wave8V2Integrators.html index e49ead76aa7..49ee3249aef 100644 --- a/master/generated/pcdsdevices.digitizers.Wave8V2Integrators.html +++ b/master/generated/pcdsdevices.digitizers.Wave8V2Integrators.html @@ -1,25 +1,23 @@ + + - pcdsdevices.digitizers.Wave8V2Integrators — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.digitizers.Wave8V2Integrators — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -
          - 8.5.1.dev30+gd6e98430 -
          @@ -107,6 +102,7 @@
        • pcdsdevices.ipm
        • pcdsdevices.jet
        • pcdsdevices.keithley
        • +
        • pcdsdevices.lakeshore
        • pcdsdevices.lamp_motion
        • pcdsdevices.lasers.btps
        • pcdsdevices.lasers.counters
        • @@ -375,14 +371,14 @@

          pcdsdevices.digitizers.Wave8V2IntegratorsMethods

          -configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]
          +configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]

          Configure the device for something during a run

          This default implementation allows the user to change any of the configuration_attrs. Subclasses might override this to perform additional input validation, cleanup, etc.

          Parameters:
          -

          d (dict) – The configuration dictionary. To specify the order that +

          d (dict) – The configuration dictionary. To specify the order that the changes should be made, use an OrderedDict.

          Returns:
          @@ -397,7 +393,7 @@

          pcdsdevices.digitizers.Wave8V2Integrators
          -describe() OrderedDictType[str, Dict[str, Any]]
          +describe() OrderedDictType[str, Dict[str, Any]]

          Provide schema and meta-data for read().

          This keys in the OrderedDict this method returns must match the keys in the OrderedDict return by read().

          @@ -427,7 +423,7 @@

          pcdsdevices.digitizers.Wave8V2Integrators
          -read() OrderedDictType[str, Dict[str, Any]]
          +read() OrderedDictType[str, Dict[str, Any]]

          Read data from the device.

          This method is expected to be as instantaneous as possible, with any substantial acquisition time taken care of in @@ -450,7 +446,7 @@

          pcdsdevices.digitizers.Wave8V2Integrators
          -read_configuration() OrderedDictType[str, Dict[str, Any]]
          +read_configuration() OrderedDictType[str, Dict[str, Any]]

          Dictionary mapping names to value dicts with keys: value, timestamp

          To control which fields are included, change the Component kinds on the device, or modify the configuration_attrs list.

          @@ -466,7 +462,7 @@

          pcdsdevices.digitizers.Wave8V2Integrators
          -status() str
          +status() str

          Returns a str with the current pv values for the device.

          @@ -483,7 +479,7 @@

          pcdsdevices.digitizers.Wave8V2Integrators
          -trigger() StatusBase
          +trigger() StatusBase

          Trigger the device and return status object.

          This method is responsible for implementing ‘trigger’ or ‘acquire’ functionality of this device.

          @@ -491,14 +487,14 @@

          pcdsdevices.digitizers.Wave8V2Integratorsread() method) then this method is also responsible for arranging that the -StatusBase object returned by this method +StatusBase object returned by this method is notified when the device is ready to be read.

          If there is no delay between triggering and being readable, -then this method must return a StatusBase +then this method must return a StatusBase object which is already completed.

          Returns:
          -

          status (StatusBase) – StatusBase object which will be marked +

          status (StatusBase) – StatusBase object which will be marked as complete when the device is ready to be read.

          @@ -527,7 +523,7 @@

          pcdsdevices.digitizers.Wave8V2Integrators
          -subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})
          +subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})

          diff --git a/master/generated/pcdsdevices.digitizers.Wave8V2PgpMon.html b/master/generated/pcdsdevices.digitizers.Wave8V2PgpMon.html index 5428c78a7f1..a82fdda12d6 100644 --- a/master/generated/pcdsdevices.digitizers.Wave8V2PgpMon.html +++ b/master/generated/pcdsdevices.digitizers.Wave8V2PgpMon.html @@ -1,25 +1,23 @@ + + - pcdsdevices.digitizers.Wave8V2PgpMon — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.digitizers.Wave8V2PgpMon — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -
          - 8.5.1.dev30+gd6e98430 -
          @@ -107,6 +102,7 @@
        • pcdsdevices.ipm
        • pcdsdevices.jet
        • pcdsdevices.keithley
        • +
        • pcdsdevices.lakeshore
        • pcdsdevices.lamp_motion
        • pcdsdevices.lasers.btps
        • pcdsdevices.lasers.counters
        • @@ -403,14 +399,14 @@

          pcdsdevices.digitizers.Wave8V2PgpMonMethods

          -configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]
          +configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]

          Configure the device for something during a run

          This default implementation allows the user to change any of the configuration_attrs. Subclasses might override this to perform additional input validation, cleanup, etc.

          Parameters:
          -

          d (dict) – The configuration dictionary. To specify the order that +

          d (dict) – The configuration dictionary. To specify the order that the changes should be made, use an OrderedDict.

          Returns:
          @@ -425,7 +421,7 @@

          pcdsdevices.digitizers.Wave8V2PgpMon
          -describe() OrderedDictType[str, Dict[str, Any]]
          +describe() OrderedDictType[str, Dict[str, Any]]

          Provide schema and meta-data for read().

          This keys in the OrderedDict this method returns must match the keys in the OrderedDict return by read().

          @@ -455,7 +451,7 @@

          pcdsdevices.digitizers.Wave8V2PgpMon
          -read() OrderedDictType[str, Dict[str, Any]]
          +read() OrderedDictType[str, Dict[str, Any]]

          Read data from the device.

          This method is expected to be as instantaneous as possible, with any substantial acquisition time taken care of in @@ -478,7 +474,7 @@

          pcdsdevices.digitizers.Wave8V2PgpMon
          -read_configuration() OrderedDictType[str, Dict[str, Any]]
          +read_configuration() OrderedDictType[str, Dict[str, Any]]

          Dictionary mapping names to value dicts with keys: value, timestamp

          To control which fields are included, change the Component kinds on the device, or modify the configuration_attrs list.

          @@ -494,7 +490,7 @@

          pcdsdevices.digitizers.Wave8V2PgpMon
          -status() str
          +status() str

          Returns a str with the current pv values for the device.

          @@ -511,7 +507,7 @@

          pcdsdevices.digitizers.Wave8V2PgpMon
          -trigger() StatusBase
          +trigger() StatusBase

          Trigger the device and return status object.

          This method is responsible for implementing ‘trigger’ or ‘acquire’ functionality of this device.

          @@ -519,14 +515,14 @@

          pcdsdevices.digitizers.Wave8V2PgpMonread() method) then this method is also responsible for arranging that the -StatusBase object returned by this method +StatusBase object returned by this method is notified when the device is ready to be read.

          If there is no delay between triggering and being readable, -then this method must return a StatusBase +then this method must return a StatusBase object which is already completed.

          Returns:
          -

          status (StatusBase) – StatusBase object which will be marked +

          status (StatusBase) – StatusBase object which will be marked as complete when the device is ready to be read.

          @@ -555,7 +551,7 @@

          pcdsdevices.digitizers.Wave8V2PgpMon
          -subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})
          +subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})

          diff --git a/master/generated/pcdsdevices.digitizers.Wave8V2RawBuffers.html b/master/generated/pcdsdevices.digitizers.Wave8V2RawBuffers.html index 72d480c1b05..8ee5115eddf 100644 --- a/master/generated/pcdsdevices.digitizers.Wave8V2RawBuffers.html +++ b/master/generated/pcdsdevices.digitizers.Wave8V2RawBuffers.html @@ -1,25 +1,23 @@ + + - pcdsdevices.digitizers.Wave8V2RawBuffers — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.digitizers.Wave8V2RawBuffers — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -
          - 8.5.1.dev30+gd6e98430 -
          @@ -107,6 +102,7 @@
        • pcdsdevices.ipm
        • pcdsdevices.jet
        • pcdsdevices.keithley
        • +
        • pcdsdevices.lakeshore
        • pcdsdevices.lamp_motion
        • pcdsdevices.lasers.btps
        • pcdsdevices.lasers.counters
        • @@ -347,14 +343,14 @@

          pcdsdevices.digitizers.Wave8V2RawBuffersMethods

          -configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]
          +configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]

          Configure the device for something during a run

          This default implementation allows the user to change any of the configuration_attrs. Subclasses might override this to perform additional input validation, cleanup, etc.

          Parameters:
          -

          d (dict) – The configuration dictionary. To specify the order that +

          d (dict) – The configuration dictionary. To specify the order that the changes should be made, use an OrderedDict.

          Returns:
          @@ -369,7 +365,7 @@

          pcdsdevices.digitizers.Wave8V2RawBuffers
          -describe() OrderedDictType[str, Dict[str, Any]]
          +describe() OrderedDictType[str, Dict[str, Any]]

          Provide schema and meta-data for read().

          This keys in the OrderedDict this method returns must match the keys in the OrderedDict return by read().

          @@ -399,7 +395,7 @@

          pcdsdevices.digitizers.Wave8V2RawBuffers
          -read() OrderedDictType[str, Dict[str, Any]]
          +read() OrderedDictType[str, Dict[str, Any]]

          Read data from the device.

          This method is expected to be as instantaneous as possible, with any substantial acquisition time taken care of in @@ -422,7 +418,7 @@

          pcdsdevices.digitizers.Wave8V2RawBuffers
          -read_configuration() OrderedDictType[str, Dict[str, Any]]
          +read_configuration() OrderedDictType[str, Dict[str, Any]]

          Dictionary mapping names to value dicts with keys: value, timestamp

          To control which fields are included, change the Component kinds on the device, or modify the configuration_attrs list.

          @@ -438,7 +434,7 @@

          pcdsdevices.digitizers.Wave8V2RawBuffers
          -status() str
          +status() str

          Returns a str with the current pv values for the device.

          @@ -455,7 +451,7 @@

          pcdsdevices.digitizers.Wave8V2RawBuffers
          -trigger() StatusBase
          +trigger() StatusBase

          Trigger the device and return status object.

          This method is responsible for implementing ‘trigger’ or ‘acquire’ functionality of this device.

          @@ -463,14 +459,14 @@

          pcdsdevices.digitizers.Wave8V2RawBuffersread() method) then this method is also responsible for arranging that the -StatusBase object returned by this method +StatusBase object returned by this method is notified when the device is ready to be read.

          If there is no delay between triggering and being readable, -then this method must return a StatusBase +then this method must return a StatusBase object which is already completed.

          Returns:
          -

          status (StatusBase) – StatusBase object which will be marked +

          status (StatusBase) – StatusBase object which will be marked as complete when the device is ready to be read.

          @@ -499,7 +495,7 @@

          pcdsdevices.digitizers.Wave8V2RawBuffers
          -subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})
          +subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})

          diff --git a/master/generated/pcdsdevices.digitizers.Wave8V2Sfp.html b/master/generated/pcdsdevices.digitizers.Wave8V2Sfp.html index d67596ec020..6eaaa1fe987 100644 --- a/master/generated/pcdsdevices.digitizers.Wave8V2Sfp.html +++ b/master/generated/pcdsdevices.digitizers.Wave8V2Sfp.html @@ -1,25 +1,23 @@ + + - pcdsdevices.digitizers.Wave8V2Sfp — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.digitizers.Wave8V2Sfp — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -
          - 8.5.1.dev30+gd6e98430 -
          @@ -107,6 +102,7 @@
        • pcdsdevices.ipm
        • pcdsdevices.jet
        • pcdsdevices.keithley
        • +
        • pcdsdevices.lakeshore
        • pcdsdevices.lamp_motion
        • pcdsdevices.lasers.btps
        • pcdsdevices.lasers.counters
        • @@ -270,14 +266,14 @@

          pcdsdevices.digitizers.Wave8V2SfpMethods

          -configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]
          +configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]

          Configure the device for something during a run

          This default implementation allows the user to change any of the configuration_attrs. Subclasses might override this to perform additional input validation, cleanup, etc.

          Parameters:
          -

          d (dict) – The configuration dictionary. To specify the order that +

          d (dict) – The configuration dictionary. To specify the order that the changes should be made, use an OrderedDict.

          Returns:
          @@ -292,7 +288,7 @@

          pcdsdevices.digitizers.Wave8V2Sfp
          -describe() OrderedDictType[str, Dict[str, Any]]
          +describe() OrderedDictType[str, Dict[str, Any]]

          Provide schema and meta-data for read().

          This keys in the OrderedDict this method returns must match the keys in the OrderedDict return by read().

          @@ -322,7 +318,7 @@

          pcdsdevices.digitizers.Wave8V2Sfp
          -read() OrderedDictType[str, Dict[str, Any]]
          +read() OrderedDictType[str, Dict[str, Any]]

          Read data from the device.

          This method is expected to be as instantaneous as possible, with any substantial acquisition time taken care of in @@ -345,7 +341,7 @@

          pcdsdevices.digitizers.Wave8V2Sfp
          -read_configuration() OrderedDictType[str, Dict[str, Any]]
          +read_configuration() OrderedDictType[str, Dict[str, Any]]

          Dictionary mapping names to value dicts with keys: value, timestamp

          To control which fields are included, change the Component kinds on the device, or modify the configuration_attrs list.

          @@ -361,7 +357,7 @@

          pcdsdevices.digitizers.Wave8V2Sfp
          -status() str
          +status() str

          Returns a str with the current pv values for the device.

          @@ -378,7 +374,7 @@

          pcdsdevices.digitizers.Wave8V2Sfp
          -trigger() StatusBase
          +trigger() StatusBase

          Trigger the device and return status object.

          This method is responsible for implementing ‘trigger’ or ‘acquire’ functionality of this device.

          @@ -386,14 +382,14 @@

          pcdsdevices.digitizers.Wave8V2Sfpread() method) then this method is also responsible for arranging that the -StatusBase object returned by this method +StatusBase object returned by this method is notified when the device is ready to be read.

          If there is no delay between triggering and being readable, -then this method must return a StatusBase +then this method must return a StatusBase object which is already completed.

          Returns:
          -

          status (StatusBase) – StatusBase object which will be marked +

          status (StatusBase) – StatusBase object which will be marked as complete when the device is ready to be read.

          @@ -422,7 +418,7 @@

          pcdsdevices.digitizers.Wave8V2Sfp
          -subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})
          +subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})

          diff --git a/master/generated/pcdsdevices.digitizers.Wave8V2Simple.html b/master/generated/pcdsdevices.digitizers.Wave8V2Simple.html index 50ac15f2125..bb145c5d180 100644 --- a/master/generated/pcdsdevices.digitizers.Wave8V2Simple.html +++ b/master/generated/pcdsdevices.digitizers.Wave8V2Simple.html @@ -1,25 +1,23 @@ + + - pcdsdevices.digitizers.Wave8V2Simple — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.digitizers.Wave8V2Simple — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -
          - 8.5.1.dev30+gd6e98430 -
          @@ -107,6 +102,7 @@
        • pcdsdevices.ipm
        • pcdsdevices.jet
        • pcdsdevices.keithley
        • +
        • pcdsdevices.lakeshore
        • pcdsdevices.lamp_motion
        • pcdsdevices.lasers.btps
        • pcdsdevices.lasers.counters
        • @@ -306,14 +302,14 @@

          pcdsdevices.digitizers.Wave8V2SimpleMethods

          -configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]
          +configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]

          Configure the device for something during a run

          This default implementation allows the user to change any of the configuration_attrs. Subclasses might override this to perform additional input validation, cleanup, etc.

          Parameters:
          -

          d (dict) – The configuration dictionary. To specify the order that +

          d (dict) – The configuration dictionary. To specify the order that the changes should be made, use an OrderedDict.

          Returns:
          @@ -328,7 +324,7 @@

          pcdsdevices.digitizers.Wave8V2Simple
          -describe() OrderedDictType[str, Dict[str, Any]]
          +describe() OrderedDictType[str, Dict[str, Any]]

          Provide schema and meta-data for read().

          This keys in the OrderedDict this method returns must match the keys in the OrderedDict return by read().

          @@ -358,7 +354,7 @@

          pcdsdevices.digitizers.Wave8V2Simple
          -read() OrderedDictType[str, Dict[str, Any]]
          +read() OrderedDictType[str, Dict[str, Any]]

          Read data from the device.

          This method is expected to be as instantaneous as possible, with any substantial acquisition time taken care of in @@ -381,7 +377,7 @@

          pcdsdevices.digitizers.Wave8V2Simple
          -read_configuration() OrderedDictType[str, Dict[str, Any]]
          +read_configuration() OrderedDictType[str, Dict[str, Any]]

          Dictionary mapping names to value dicts with keys: value, timestamp

          To control which fields are included, change the Component kinds on the device, or modify the configuration_attrs list.

          @@ -397,7 +393,7 @@

          pcdsdevices.digitizers.Wave8V2Simple
          -status() str
          +status() str

          Returns a str with the current pv values for the device.

          @@ -414,7 +410,7 @@

          pcdsdevices.digitizers.Wave8V2Simple
          -trigger() StatusBase
          +trigger() StatusBase

          Trigger the device and return status object.

          This method is responsible for implementing ‘trigger’ or ‘acquire’ functionality of this device.

          @@ -422,14 +418,14 @@

          pcdsdevices.digitizers.Wave8V2Simpleread() method) then this method is also responsible for arranging that the -StatusBase object returned by this method +StatusBase object returned by this method is notified when the device is ready to be read.

          If there is no delay between triggering and being readable, -then this method must return a StatusBase +then this method must return a StatusBase object which is already completed.

          Returns:
          -

          status (StatusBase) – StatusBase object which will be marked +

          status (StatusBase) – StatusBase object which will be marked as complete when the device is ready to be read.

          @@ -458,7 +454,7 @@

          pcdsdevices.digitizers.Wave8V2Simple
          -subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})
          +subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})

          diff --git a/master/generated/pcdsdevices.digitizers.Wave8V2SystemRegs.html b/master/generated/pcdsdevices.digitizers.Wave8V2SystemRegs.html index 198b07a604e..1666812b9bb 100644 --- a/master/generated/pcdsdevices.digitizers.Wave8V2SystemRegs.html +++ b/master/generated/pcdsdevices.digitizers.Wave8V2SystemRegs.html @@ -1,25 +1,23 @@ + + - pcdsdevices.digitizers.Wave8V2SystemRegs — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.digitizers.Wave8V2SystemRegs — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -
          - 8.5.1.dev30+gd6e98430 -
          @@ -107,6 +102,7 @@
        • pcdsdevices.ipm
        • pcdsdevices.jet
        • pcdsdevices.keithley
        • +
        • pcdsdevices.lakeshore
        • pcdsdevices.lamp_motion
        • pcdsdevices.lasers.btps
        • pcdsdevices.lasers.counters
        • @@ -361,14 +357,14 @@

          pcdsdevices.digitizers.Wave8V2SystemRegsMethods

          -configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]
          +configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]

          Configure the device for something during a run

          This default implementation allows the user to change any of the configuration_attrs. Subclasses might override this to perform additional input validation, cleanup, etc.

          Parameters:
          -

          d (dict) – The configuration dictionary. To specify the order that +

          d (dict) – The configuration dictionary. To specify the order that the changes should be made, use an OrderedDict.

          Returns:
          @@ -383,7 +379,7 @@

          pcdsdevices.digitizers.Wave8V2SystemRegs
          -describe() OrderedDictType[str, Dict[str, Any]]
          +describe() OrderedDictType[str, Dict[str, Any]]

          Provide schema and meta-data for read().

          This keys in the OrderedDict this method returns must match the keys in the OrderedDict return by read().

          @@ -413,7 +409,7 @@

          pcdsdevices.digitizers.Wave8V2SystemRegs
          -read() OrderedDictType[str, Dict[str, Any]]
          +read() OrderedDictType[str, Dict[str, Any]]

          Read data from the device.

          This method is expected to be as instantaneous as possible, with any substantial acquisition time taken care of in @@ -436,7 +432,7 @@

          pcdsdevices.digitizers.Wave8V2SystemRegs
          -read_configuration() OrderedDictType[str, Dict[str, Any]]
          +read_configuration() OrderedDictType[str, Dict[str, Any]]

          Dictionary mapping names to value dicts with keys: value, timestamp

          To control which fields are included, change the Component kinds on the device, or modify the configuration_attrs list.

          @@ -452,7 +448,7 @@

          pcdsdevices.digitizers.Wave8V2SystemRegs
          -status() str
          +status() str

          Returns a str with the current pv values for the device.

          @@ -469,7 +465,7 @@

          pcdsdevices.digitizers.Wave8V2SystemRegs
          -trigger() StatusBase
          +trigger() StatusBase

          Trigger the device and return status object.

          This method is responsible for implementing ‘trigger’ or ‘acquire’ functionality of this device.

          @@ -477,14 +473,14 @@

          pcdsdevices.digitizers.Wave8V2SystemRegsread() method) then this method is also responsible for arranging that the -StatusBase object returned by this method +StatusBase object returned by this method is notified when the device is ready to be read.

          If there is no delay between triggering and being readable, -then this method must return a StatusBase +then this method must return a StatusBase object which is already completed.

          Returns:
          -

          status (StatusBase) – StatusBase object which will be marked +

          status (StatusBase) – StatusBase object which will be marked as complete when the device is ready to be read.

          @@ -513,7 +509,7 @@

          pcdsdevices.digitizers.Wave8V2SystemRegs
          -subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})
          +subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})

          diff --git a/master/generated/pcdsdevices.digitizers.Wave8V2Timing.html b/master/generated/pcdsdevices.digitizers.Wave8V2Timing.html index 2291aaa5b51..c907473b912 100644 --- a/master/generated/pcdsdevices.digitizers.Wave8V2Timing.html +++ b/master/generated/pcdsdevices.digitizers.Wave8V2Timing.html @@ -1,25 +1,23 @@ + + - pcdsdevices.digitizers.Wave8V2Timing — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.digitizers.Wave8V2Timing — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -
          - 8.5.1.dev30+gd6e98430 -
          @@ -107,6 +102,7 @@
        • pcdsdevices.ipm
        • pcdsdevices.jet
        • pcdsdevices.keithley
        • +
        • pcdsdevices.lakeshore
        • pcdsdevices.lamp_motion
        • pcdsdevices.lasers.btps
        • pcdsdevices.lasers.counters
        • @@ -326,14 +322,14 @@

          pcdsdevices.digitizers.Wave8V2TimingMethods

          -configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]
          +configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]

          Configure the device for something during a run

          This default implementation allows the user to change any of the configuration_attrs. Subclasses might override this to perform additional input validation, cleanup, etc.

          Parameters:
          -

          d (dict) – The configuration dictionary. To specify the order that +

          d (dict) – The configuration dictionary. To specify the order that the changes should be made, use an OrderedDict.

          Returns:
          @@ -348,7 +344,7 @@

          pcdsdevices.digitizers.Wave8V2Timing
          -describe() OrderedDictType[str, Dict[str, Any]]
          +describe() OrderedDictType[str, Dict[str, Any]]

          Provide schema and meta-data for read().

          This keys in the OrderedDict this method returns must match the keys in the OrderedDict return by read().

          @@ -378,7 +374,7 @@

          pcdsdevices.digitizers.Wave8V2Timing
          -read() OrderedDictType[str, Dict[str, Any]]
          +read() OrderedDictType[str, Dict[str, Any]]

          Read data from the device.

          This method is expected to be as instantaneous as possible, with any substantial acquisition time taken care of in @@ -401,7 +397,7 @@

          pcdsdevices.digitizers.Wave8V2Timing
          -read_configuration() OrderedDictType[str, Dict[str, Any]]
          +read_configuration() OrderedDictType[str, Dict[str, Any]]

          Dictionary mapping names to value dicts with keys: value, timestamp

          To control which fields are included, change the Component kinds on the device, or modify the configuration_attrs list.

          @@ -417,7 +413,7 @@

          pcdsdevices.digitizers.Wave8V2Timing
          -status() str
          +status() str

          Returns a str with the current pv values for the device.

          @@ -434,7 +430,7 @@

          pcdsdevices.digitizers.Wave8V2Timing
          -trigger() StatusBase
          +trigger() StatusBase

          Trigger the device and return status object.

          This method is responsible for implementing ‘trigger’ or ‘acquire’ functionality of this device.

          @@ -442,14 +438,14 @@

          pcdsdevices.digitizers.Wave8V2Timingread() method) then this method is also responsible for arranging that the -StatusBase object returned by this method +StatusBase object returned by this method is notified when the device is ready to be read.

          If there is no delay between triggering and being readable, -then this method must return a StatusBase +then this method must return a StatusBase object which is already completed.

          Returns:
          -

          status (StatusBase) – StatusBase object which will be marked +

          status (StatusBase) – StatusBase object which will be marked as complete when the device is ready to be read.

          @@ -478,7 +474,7 @@

          pcdsdevices.digitizers.Wave8V2Timing
          -subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})
          +subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})

          diff --git a/master/generated/pcdsdevices.digitizers.Wave8V2TriggerEventManager.html b/master/generated/pcdsdevices.digitizers.Wave8V2TriggerEventManager.html index 3bf7978f31f..ab25dbbc1ef 100644 --- a/master/generated/pcdsdevices.digitizers.Wave8V2TriggerEventManager.html +++ b/master/generated/pcdsdevices.digitizers.Wave8V2TriggerEventManager.html @@ -1,25 +1,23 @@ + + - pcdsdevices.digitizers.Wave8V2TriggerEventManager — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.digitizers.Wave8V2TriggerEventManager — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -
          - 8.5.1.dev30+gd6e98430 -
          @@ -107,6 +102,7 @@
        • pcdsdevices.ipm
        • pcdsdevices.jet
        • pcdsdevices.keithley
        • +
        • pcdsdevices.lakeshore
        • pcdsdevices.lamp_motion
        • pcdsdevices.lasers.btps
        • pcdsdevices.lasers.counters
        • @@ -347,14 +343,14 @@

          pcdsdevices.digitizers.Wave8V2TriggerEventManagerMethods

          -configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]
          +configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]

          Configure the device for something during a run

          This default implementation allows the user to change any of the configuration_attrs. Subclasses might override this to perform additional input validation, cleanup, etc.

          Parameters:
          -

          d (dict) – The configuration dictionary. To specify the order that +

          d (dict) – The configuration dictionary. To specify the order that the changes should be made, use an OrderedDict.

          Returns:
          @@ -369,7 +365,7 @@

          pcdsdevices.digitizers.Wave8V2TriggerEventManager
          -describe() OrderedDictType[str, Dict[str, Any]]
          +describe() OrderedDictType[str, Dict[str, Any]]

          Provide schema and meta-data for read().

          This keys in the OrderedDict this method returns must match the keys in the OrderedDict return by read().

          @@ -399,7 +395,7 @@

          pcdsdevices.digitizers.Wave8V2TriggerEventManager
          -read() OrderedDictType[str, Dict[str, Any]]
          +read() OrderedDictType[str, Dict[str, Any]]

          Read data from the device.

          This method is expected to be as instantaneous as possible, with any substantial acquisition time taken care of in @@ -422,7 +418,7 @@

          pcdsdevices.digitizers.Wave8V2TriggerEventManager
          -read_configuration() OrderedDictType[str, Dict[str, Any]]
          +read_configuration() OrderedDictType[str, Dict[str, Any]]

          Dictionary mapping names to value dicts with keys: value, timestamp

          To control which fields are included, change the Component kinds on the device, or modify the configuration_attrs list.

          @@ -438,7 +434,7 @@

          pcdsdevices.digitizers.Wave8V2TriggerEventManager
          -status() str
          +status() str

          Returns a str with the current pv values for the device.

          @@ -455,7 +451,7 @@

          pcdsdevices.digitizers.Wave8V2TriggerEventManager
          -trigger() StatusBase
          +trigger() StatusBase

          Trigger the device and return status object.

          This method is responsible for implementing ‘trigger’ or ‘acquire’ functionality of this device.

          @@ -463,14 +459,14 @@

          pcdsdevices.digitizers.Wave8V2TriggerEventManagerread() method) then this method is also responsible for arranging that the -StatusBase object returned by this method +StatusBase object returned by this method is notified when the device is ready to be read.

          If there is no delay between triggering and being readable, -then this method must return a StatusBase +then this method must return a StatusBase object which is already completed.

          Returns:
          -

          status (StatusBase) – StatusBase object which will be marked +

          status (StatusBase) – StatusBase object which will be marked as complete when the device is ready to be read.

          @@ -499,7 +495,7 @@

          pcdsdevices.digitizers.Wave8V2TriggerEventManager
          -subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})
          +subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})

          diff --git a/master/generated/pcdsdevices.digitizers.Wave8V2XpmMini.html b/master/generated/pcdsdevices.digitizers.Wave8V2XpmMini.html index 8df188803dd..3451449a1a6 100644 --- a/master/generated/pcdsdevices.digitizers.Wave8V2XpmMini.html +++ b/master/generated/pcdsdevices.digitizers.Wave8V2XpmMini.html @@ -1,25 +1,23 @@ + + - pcdsdevices.digitizers.Wave8V2XpmMini — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.digitizers.Wave8V2XpmMini — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -
          - 8.5.1.dev30+gd6e98430 -
          @@ -107,6 +102,7 @@
        • pcdsdevices.ipm
        • pcdsdevices.jet
        • pcdsdevices.keithley
        • +
        • pcdsdevices.lakeshore
        • pcdsdevices.lamp_motion
        • pcdsdevices.lasers.btps
        • pcdsdevices.lasers.counters
        • @@ -270,14 +266,14 @@

          pcdsdevices.digitizers.Wave8V2XpmMiniMethods

          -configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]
          +configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]

          Configure the device for something during a run

          This default implementation allows the user to change any of the configuration_attrs. Subclasses might override this to perform additional input validation, cleanup, etc.

          Parameters:
          -

          d (dict) – The configuration dictionary. To specify the order that +

          d (dict) – The configuration dictionary. To specify the order that the changes should be made, use an OrderedDict.

          Returns:
          @@ -292,7 +288,7 @@

          pcdsdevices.digitizers.Wave8V2XpmMini
          -describe() OrderedDictType[str, Dict[str, Any]]
          +describe() OrderedDictType[str, Dict[str, Any]]

          Provide schema and meta-data for read().

          This keys in the OrderedDict this method returns must match the keys in the OrderedDict return by read().

          @@ -322,7 +318,7 @@

          pcdsdevices.digitizers.Wave8V2XpmMini
          -read() OrderedDictType[str, Dict[str, Any]]
          +read() OrderedDictType[str, Dict[str, Any]]

          Read data from the device.

          This method is expected to be as instantaneous as possible, with any substantial acquisition time taken care of in @@ -345,7 +341,7 @@

          pcdsdevices.digitizers.Wave8V2XpmMini
          -read_configuration() OrderedDictType[str, Dict[str, Any]]
          +read_configuration() OrderedDictType[str, Dict[str, Any]]

          Dictionary mapping names to value dicts with keys: value, timestamp

          To control which fields are included, change the Component kinds on the device, or modify the configuration_attrs list.

          @@ -361,7 +357,7 @@

          pcdsdevices.digitizers.Wave8V2XpmMini
          -status() str
          +status() str

          Returns a str with the current pv values for the device.

          @@ -378,7 +374,7 @@

          pcdsdevices.digitizers.Wave8V2XpmMini
          -trigger() StatusBase
          +trigger() StatusBase

          Trigger the device and return status object.

          This method is responsible for implementing ‘trigger’ or ‘acquire’ functionality of this device.

          @@ -386,14 +382,14 @@

          pcdsdevices.digitizers.Wave8V2XpmMiniread() method) then this method is also responsible for arranging that the -StatusBase object returned by this method +StatusBase object returned by this method is notified when the device is ready to be read.

          If there is no delay between triggering and being readable, -then this method must return a StatusBase +then this method must return a StatusBase object which is already completed.

          Returns:
          -

          status (StatusBase) – StatusBase object which will be marked +

          status (StatusBase) – StatusBase object which will be marked as complete when the device is ready to be read.

          @@ -422,7 +418,7 @@

          pcdsdevices.digitizers.Wave8V2XpmMini
          -subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})
          +subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})

          diff --git a/master/generated/pcdsdevices.digitizers.Wave8V2XpmMsg.html b/master/generated/pcdsdevices.digitizers.Wave8V2XpmMsg.html index 1ea537cf160..5a6c8085c11 100644 --- a/master/generated/pcdsdevices.digitizers.Wave8V2XpmMsg.html +++ b/master/generated/pcdsdevices.digitizers.Wave8V2XpmMsg.html @@ -1,25 +1,23 @@ + + - pcdsdevices.digitizers.Wave8V2XpmMsg — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.digitizers.Wave8V2XpmMsg — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -
          - 8.5.1.dev30+gd6e98430 -
          @@ -107,6 +102,7 @@
        • pcdsdevices.ipm
        • pcdsdevices.jet
        • pcdsdevices.keithley
        • +
        • pcdsdevices.lakeshore
        • pcdsdevices.lamp_motion
        • pcdsdevices.lasers.btps
        • pcdsdevices.lasers.counters
        • @@ -326,14 +322,14 @@

          pcdsdevices.digitizers.Wave8V2XpmMsgMethods

          -configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]
          +configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]

          Configure the device for something during a run

          This default implementation allows the user to change any of the configuration_attrs. Subclasses might override this to perform additional input validation, cleanup, etc.

          Parameters:
          -

          d (dict) – The configuration dictionary. To specify the order that +

          d (dict) – The configuration dictionary. To specify the order that the changes should be made, use an OrderedDict.

          Returns:
          @@ -348,7 +344,7 @@

          pcdsdevices.digitizers.Wave8V2XpmMsg
          -describe() OrderedDictType[str, Dict[str, Any]]
          +describe() OrderedDictType[str, Dict[str, Any]]

          Provide schema and meta-data for read().

          This keys in the OrderedDict this method returns must match the keys in the OrderedDict return by read().

          @@ -378,7 +374,7 @@

          pcdsdevices.digitizers.Wave8V2XpmMsg
          -read() OrderedDictType[str, Dict[str, Any]]
          +read() OrderedDictType[str, Dict[str, Any]]

          Read data from the device.

          This method is expected to be as instantaneous as possible, with any substantial acquisition time taken care of in @@ -401,7 +397,7 @@

          pcdsdevices.digitizers.Wave8V2XpmMsg
          -read_configuration() OrderedDictType[str, Dict[str, Any]]
          +read_configuration() OrderedDictType[str, Dict[str, Any]]

          Dictionary mapping names to value dicts with keys: value, timestamp

          To control which fields are included, change the Component kinds on the device, or modify the configuration_attrs list.

          @@ -417,7 +413,7 @@

          pcdsdevices.digitizers.Wave8V2XpmMsg
          -status() str
          +status() str

          Returns a str with the current pv values for the device.

          @@ -434,7 +430,7 @@

          pcdsdevices.digitizers.Wave8V2XpmMsg
          -trigger() StatusBase
          +trigger() StatusBase

          Trigger the device and return status object.

          This method is responsible for implementing ‘trigger’ or ‘acquire’ functionality of this device.

          @@ -442,14 +438,14 @@

          pcdsdevices.digitizers.Wave8V2XpmMsgread() method) then this method is also responsible for arranging that the -StatusBase object returned by this method +StatusBase object returned by this method is notified when the device is ready to be read.

          If there is no delay between triggering and being readable, -then this method must return a StatusBase +then this method must return a StatusBase object which is already completed.

          Returns:
          -

          status (StatusBase) – StatusBase object which will be marked +

          status (StatusBase) – StatusBase object which will be marked as complete when the device is ready to be read.

          @@ -478,7 +474,7 @@

          pcdsdevices.digitizers.Wave8V2XpmMsg
          -subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})
          +subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})

          diff --git a/master/generated/pcdsdevices.energy_monitor.GEM.html b/master/generated/pcdsdevices.energy_monitor.GEM.html index 0049d0a38ad..eb527f88b12 100644 --- a/master/generated/pcdsdevices.energy_monitor.GEM.html +++ b/master/generated/pcdsdevices.energy_monitor.GEM.html @@ -1,25 +1,23 @@ + + - pcdsdevices.energy_monitor.GEM — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.energy_monitor.GEM — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -
          - 8.5.1.dev30+gd6e98430 -
          @@ -89,6 +84,7 @@
        • pcdsdevices.ipm
        • pcdsdevices.jet
        • pcdsdevices.keithley
        • +
        • pcdsdevices.lakeshore
        • pcdsdevices.lamp_motion
        • pcdsdevices.lasers.btps
        • pcdsdevices.lasers.counters
        • @@ -204,8 +200,8 @@

          pcdsdevices.energy_monitor.GEM
          Parameters:
            -
          • prefix (str) – Full GEM base PV.

          • -
          • name (str) – Name to refer to the GEM.

          • +
          • prefix (str) – Full GEM base PV.

          • +
          • name (str) – Name to refer to the GEM.

          @@ -233,14 +229,14 @@

          pcdsdevices.energy_monitor.GEMMethods

          -configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]
          +configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]

          Configure the device for something during a run

          This default implementation allows the user to change any of the configuration_attrs. Subclasses might override this to perform additional input validation, cleanup, etc.

          Parameters:
          -

          d (dict) – The configuration dictionary. To specify the order that +

          d (dict) – The configuration dictionary. To specify the order that the changes should be made, use an OrderedDict.

          Returns:
          @@ -255,7 +251,7 @@

          pcdsdevices.energy_monitor.GEM
          -describe() OrderedDictType[str, Dict[str, Any]]
          +describe() OrderedDictType[str, Dict[str, Any]]

          Provide schema and meta-data for read().

          This keys in the OrderedDict this method returns must match the keys in the OrderedDict return by read().

          @@ -285,7 +281,7 @@

          pcdsdevices.energy_monitor.GEM
          -read() OrderedDictType[str, Dict[str, Any]]
          +read() OrderedDictType[str, Dict[str, Any]]

          Read data from the device.

          This method is expected to be as instantaneous as possible, with any substantial acquisition time taken care of in @@ -308,7 +304,7 @@

          pcdsdevices.energy_monitor.GEM
          -read_configuration() OrderedDictType[str, Dict[str, Any]]
          +read_configuration() OrderedDictType[str, Dict[str, Any]]

          Dictionary mapping names to value dicts with keys: value, timestamp

          To control which fields are included, change the Component kinds on the device, or modify the configuration_attrs list.

          @@ -324,7 +320,7 @@

          pcdsdevices.energy_monitor.GEM
          -status() str
          +status() str

          Returns a str with the current pv values for the device.

          @@ -341,7 +337,7 @@

          pcdsdevices.energy_monitor.GEM
          -trigger() StatusBase
          +trigger() StatusBase

          Trigger the device and return status object.

          This method is responsible for implementing ‘trigger’ or ‘acquire’ functionality of this device.

          @@ -349,14 +345,14 @@

          pcdsdevices.energy_monitor.GEMread() method) then this method is also responsible for arranging that the -StatusBase object returned by this method +StatusBase object returned by this method is notified when the device is ready to be read.

          If there is no delay between triggering and being readable, -then this method must return a StatusBase +then this method must return a StatusBase object which is already completed.

          Returns:
          -

          status (StatusBase) – StatusBase object which will be marked +

          status (StatusBase) – StatusBase object which will be marked as complete when the device is ready to be read.

          @@ -385,7 +381,7 @@

          pcdsdevices.energy_monitor.GEM
          -subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})
          +subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})

          diff --git a/master/generated/pcdsdevices.energy_monitor.GMD.html b/master/generated/pcdsdevices.energy_monitor.GMD.html index a57a4a90a29..482bc8048f2 100644 --- a/master/generated/pcdsdevices.energy_monitor.GMD.html +++ b/master/generated/pcdsdevices.energy_monitor.GMD.html @@ -1,25 +1,23 @@ + + - pcdsdevices.energy_monitor.GMD — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.energy_monitor.GMD — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -
          - 8.5.1.dev30+gd6e98430 -
          @@ -89,6 +84,7 @@
        • pcdsdevices.ipm
        • pcdsdevices.jet
        • pcdsdevices.keithley
        • +
        • pcdsdevices.lakeshore
        • pcdsdevices.lamp_motion
        • pcdsdevices.lasers.btps
        • pcdsdevices.lasers.counters
        • @@ -204,8 +200,8 @@

          pcdsdevices.energy_monitor.GMD
          Parameters:
            -
          • prefix (str) – Full GMD base PV.

          • -
          • name (str) – Name to refer to the GMD.

          • +
          • prefix (str) – Full GMD base PV.

          • +
          • name (str) – Name to refer to the GMD.

          @@ -345,14 +341,14 @@

          pcdsdevices.energy_monitor.GMDMethods

          -configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]
          +configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]

          Configure the device for something during a run

          This default implementation allows the user to change any of the configuration_attrs. Subclasses might override this to perform additional input validation, cleanup, etc.

          Parameters:
          -

          d (dict) – The configuration dictionary. To specify the order that +

          d (dict) – The configuration dictionary. To specify the order that the changes should be made, use an OrderedDict.

          Returns:
          @@ -367,7 +363,7 @@

          pcdsdevices.energy_monitor.GMD
          -describe() OrderedDictType[str, Dict[str, Any]]
          +describe() OrderedDictType[str, Dict[str, Any]]

          Provide schema and meta-data for read().

          This keys in the OrderedDict this method returns must match the keys in the OrderedDict return by read().

          @@ -397,7 +393,7 @@

          pcdsdevices.energy_monitor.GMD
          -read() OrderedDictType[str, Dict[str, Any]]
          +read() OrderedDictType[str, Dict[str, Any]]

          Read data from the device.

          This method is expected to be as instantaneous as possible, with any substantial acquisition time taken care of in @@ -420,7 +416,7 @@

          pcdsdevices.energy_monitor.GMD
          -read_configuration() OrderedDictType[str, Dict[str, Any]]
          +read_configuration() OrderedDictType[str, Dict[str, Any]]

          Dictionary mapping names to value dicts with keys: value, timestamp

          To control which fields are included, change the Component kinds on the device, or modify the configuration_attrs list.

          @@ -436,7 +432,7 @@

          pcdsdevices.energy_monitor.GMD
          -status() str
          +status() str

          Returns a str with the current pv values for the device.

          @@ -453,7 +449,7 @@

          pcdsdevices.energy_monitor.GMD
          -trigger() StatusBase
          +trigger() StatusBase

          Trigger the device and return status object.

          This method is responsible for implementing ‘trigger’ or ‘acquire’ functionality of this device.

          @@ -461,14 +457,14 @@

          pcdsdevices.energy_monitor.GMDread() method) then this method is also responsible for arranging that the -StatusBase object returned by this method +StatusBase object returned by this method is notified when the device is ready to be read.

          If there is no delay between triggering and being readable, -then this method must return a StatusBase +then this method must return a StatusBase object which is already completed.

          Returns:
          -

          status (StatusBase) – StatusBase object which will be marked +

          status (StatusBase) – StatusBase object which will be marked as complete when the device is ready to be read.

          @@ -497,7 +493,7 @@

          pcdsdevices.energy_monitor.GMD
          -subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})
          +subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})

          diff --git a/master/generated/pcdsdevices.energy_monitor.GMDPreAmp.html b/master/generated/pcdsdevices.energy_monitor.GMDPreAmp.html index 1ac1b2bd221..7a8bd9b9044 100644 --- a/master/generated/pcdsdevices.energy_monitor.GMDPreAmp.html +++ b/master/generated/pcdsdevices.energy_monitor.GMDPreAmp.html @@ -1,25 +1,23 @@ + + - pcdsdevices.energy_monitor.GMDPreAmp — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.energy_monitor.GMDPreAmp — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -
          - 8.5.1.dev30+gd6e98430 -
          @@ -89,6 +84,7 @@
        • pcdsdevices.ipm
        • pcdsdevices.jet
        • pcdsdevices.keithley
        • +
        • pcdsdevices.lakeshore
        • pcdsdevices.lamp_motion
        • pcdsdevices.lasers.btps
        • pcdsdevices.lasers.counters
        • @@ -272,14 +268,14 @@

          pcdsdevices.energy_monitor.GMDPreAmpMethods

          -configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]
          +configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]

          Configure the device for something during a run

          This default implementation allows the user to change any of the configuration_attrs. Subclasses might override this to perform additional input validation, cleanup, etc.

          Parameters:
          -

          d (dict) – The configuration dictionary. To specify the order that +

          d (dict) – The configuration dictionary. To specify the order that the changes should be made, use an OrderedDict.

          Returns:
          @@ -294,7 +290,7 @@

          pcdsdevices.energy_monitor.GMDPreAmp
          -describe() OrderedDictType[str, Dict[str, Any]]
          +describe() OrderedDictType[str, Dict[str, Any]]

          Provide schema and meta-data for read().

          This keys in the OrderedDict this method returns must match the keys in the OrderedDict return by read().

          @@ -324,7 +320,7 @@

          pcdsdevices.energy_monitor.GMDPreAmp
          -read() OrderedDictType[str, Dict[str, Any]]
          +read() OrderedDictType[str, Dict[str, Any]]

          Read data from the device.

          This method is expected to be as instantaneous as possible, with any substantial acquisition time taken care of in @@ -347,7 +343,7 @@

          pcdsdevices.energy_monitor.GMDPreAmp
          -read_configuration() OrderedDictType[str, Dict[str, Any]]
          +read_configuration() OrderedDictType[str, Dict[str, Any]]

          Dictionary mapping names to value dicts with keys: value, timestamp

          To control which fields are included, change the Component kinds on the device, or modify the configuration_attrs list.

          @@ -363,7 +359,7 @@

          pcdsdevices.energy_monitor.GMDPreAmp
          -status() str
          +status() str

          Returns a str with the current pv values for the device.

          @@ -380,7 +376,7 @@

          pcdsdevices.energy_monitor.GMDPreAmp
          -trigger() StatusBase
          +trigger() StatusBase

          Trigger the device and return status object.

          This method is responsible for implementing ‘trigger’ or ‘acquire’ functionality of this device.

          @@ -388,14 +384,14 @@

          pcdsdevices.energy_monitor.GMDPreAmpread() method) then this method is also responsible for arranging that the -StatusBase object returned by this method +StatusBase object returned by this method is notified when the device is ready to be read.

          If there is no delay between triggering and being readable, -then this method must return a StatusBase +then this method must return a StatusBase object which is already completed.

          Returns:
          -

          status (StatusBase) – StatusBase object which will be marked +

          status (StatusBase) – StatusBase object which will be marked as complete when the device is ready to be read.

          @@ -424,7 +420,7 @@

          pcdsdevices.energy_monitor.GMDPreAmp
          -subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})
          +subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})

          diff --git a/master/generated/pcdsdevices.energy_monitor.XGMD.html b/master/generated/pcdsdevices.energy_monitor.XGMD.html index ce2497f11d9..377187c34c0 100644 --- a/master/generated/pcdsdevices.energy_monitor.XGMD.html +++ b/master/generated/pcdsdevices.energy_monitor.XGMD.html @@ -1,25 +1,23 @@ + + - pcdsdevices.energy_monitor.XGMD — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.energy_monitor.XGMD — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -
          - 8.5.1.dev30+gd6e98430 -
          @@ -89,6 +84,7 @@
        • pcdsdevices.ipm
        • pcdsdevices.jet
        • pcdsdevices.keithley
        • +
        • pcdsdevices.lakeshore
        • pcdsdevices.lamp_motion
        • pcdsdevices.lasers.btps
        • pcdsdevices.lasers.counters
        • @@ -204,8 +200,8 @@

          pcdsdevices.energy_monitor.XGMD
          Parameters:
            -
          • prefix (str) – Full XGMD base PV.

          • -
          • name (str) – Name to refer to the XGMD.

          • +
          • prefix (str) – Full XGMD base PV.

          • +
          • name (str) – Name to refer to the XGMD.

          @@ -233,14 +229,14 @@

          pcdsdevices.energy_monitor.XGMDMethods

          -configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]
          +configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]

          Configure the device for something during a run

          This default implementation allows the user to change any of the configuration_attrs. Subclasses might override this to perform additional input validation, cleanup, etc.

          Parameters:
          -

          d (dict) – The configuration dictionary. To specify the order that +

          d (dict) – The configuration dictionary. To specify the order that the changes should be made, use an OrderedDict.

          Returns:
          @@ -255,7 +251,7 @@

          pcdsdevices.energy_monitor.XGMD
          -describe() OrderedDictType[str, Dict[str, Any]]
          +describe() OrderedDictType[str, Dict[str, Any]]

          Provide schema and meta-data for read().

          This keys in the OrderedDict this method returns must match the keys in the OrderedDict return by read().

          @@ -285,7 +281,7 @@

          pcdsdevices.energy_monitor.XGMD
          -read() OrderedDictType[str, Dict[str, Any]]
          +read() OrderedDictType[str, Dict[str, Any]]

          Read data from the device.

          This method is expected to be as instantaneous as possible, with any substantial acquisition time taken care of in @@ -308,7 +304,7 @@

          pcdsdevices.energy_monitor.XGMD
          -read_configuration() OrderedDictType[str, Dict[str, Any]]
          +read_configuration() OrderedDictType[str, Dict[str, Any]]

          Dictionary mapping names to value dicts with keys: value, timestamp

          To control which fields are included, change the Component kinds on the device, or modify the configuration_attrs list.

          @@ -324,7 +320,7 @@

          pcdsdevices.energy_monitor.XGMD
          -status() str
          +status() str

          Returns a str with the current pv values for the device.

          @@ -341,7 +337,7 @@

          pcdsdevices.energy_monitor.XGMD
          -trigger() StatusBase
          +trigger() StatusBase

          Trigger the device and return status object.

          This method is responsible for implementing ‘trigger’ or ‘acquire’ functionality of this device.

          @@ -349,14 +345,14 @@

          pcdsdevices.energy_monitor.XGMDread() method) then this method is also responsible for arranging that the -StatusBase object returned by this method +StatusBase object returned by this method is notified when the device is ready to be read.

          If there is no delay between triggering and being readable, -then this method must return a StatusBase +then this method must return a StatusBase object which is already completed.

          Returns:
          -

          status (StatusBase) – StatusBase object which will be marked +

          status (StatusBase) – StatusBase object which will be marked as complete when the device is ready to be read.

          @@ -385,7 +381,7 @@

          pcdsdevices.energy_monitor.XGMD
          -subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})
          +subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})

          diff --git a/master/generated/pcdsdevices.epics_motor.BeckhoffAxis.html b/master/generated/pcdsdevices.epics_motor.BeckhoffAxis.html index 3a3dcde379e..d164edaa6f1 100644 --- a/master/generated/pcdsdevices.epics_motor.BeckhoffAxis.html +++ b/master/generated/pcdsdevices.epics_motor.BeckhoffAxis.html @@ -1,25 +1,23 @@ + + - pcdsdevices.epics_motor.BeckhoffAxis — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.epics_motor.BeckhoffAxis — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -
          - 8.5.1.dev30+gd6e98430 -
          @@ -109,6 +104,7 @@
        • pcdsdevices.ipm
        • pcdsdevices.jet
        • pcdsdevices.keithley
        • +
        • pcdsdevices.lakeshore
        • pcdsdevices.lamp_motion
        • pcdsdevices.lasers.btps
        • pcdsdevices.lasers.counters
        • @@ -226,10 +222,10 @@

          pcdsdevices.epics_motor.BeckhoffAxis
          Parameters:
            -
          • prefix (str) – The EPICS PV prefix for this motor.

          • -
          • name (str) – An identifying name for this motor.

          • -
          • settle_time (float, optional) – The amount of extra time to wait before interpreting a move as done.

          • -
          • timeout (float, optional) – The amount of time to wait before automatically marking a long +

          • prefix (str) – The EPICS PV prefix for this motor.

          • +
          • name (str) – An identifying name for this motor.

          • +
          • settle_time (float, optional) – The amount of extra time to wait before interpreting a move as done.

          • +
          • timeout (float, optional) – The amount of time to wait before automatically marking a long in-progress move as failed.

          @@ -484,14 +480,14 @@

          pcdsdevices.epics_motor.BeckhoffAxis
          -configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]
          +configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]

          Configure the device for something during a run

          This default implementation allows the user to change any of the configuration_attrs. Subclasses might override this to perform additional input validation, cleanup, etc.

          Parameters:
          -

          d (dict) – The configuration dictionary. To specify the order that +

          d (dict) – The configuration dictionary. To specify the order that the changes should be made, use an OrderedDict.

          Returns:
          @@ -506,7 +502,7 @@

          pcdsdevices.epics_motor.BeckhoffAxis
          -describe() OrderedDictType[str, Dict[str, Any]]
          +describe() OrderedDictType[str, Dict[str, Any]]

          Provide schema and meta-data for read().

          This keys in the OrderedDict this method returns must match the keys in the OrderedDict return by read().

          @@ -568,8 +564,8 @@

          pcdsdevices.epics_motor.BeckhoffAxis
          Parameters:
            -
          • high (float) – Limit of travel in the positive direction.

          • -
          • low (float) – Limit of travel in the negative direction.

          • +
          • high (float) – Limit of travel in the positive direction.

          • +
          • low (float) – Limit of travel in the negative direction.

          @@ -592,7 +588,7 @@

          pcdsdevices.epics_motor.BeckhoffAxis
          -move(position: float, wait: bool = True, **kwargs) MoveStatus
          +move(position: float, wait: bool = True, **kwargs) MoveStatus

          Move to a specified position, optionally waiting for motion to complete.

          @@ -602,7 +598,7 @@

          pcdsdevices.epics_motor.BeckhoffAxisfloat, optional) – Maximum time to wait for the motion. If None, the default timeout +
        • timeout (float, optional) – Maximum time to wait for the motion. If None, the default timeout for this positioner is used.

        • @@ -611,9 +607,9 @@

          pcdsdevices.epics_motor.BeckhoffAxisRaises:
          @@ -627,12 +623,12 @@

          pcdsdevices.epics_motor.BeckhoffAxisParameters:
          • position – Desired end position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • wait (bool, optional) – If True, wait for motion completion before returning. +

          • wait (bool, optional) – If True, wait for motion completion before returning. Defaults to False.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          @@ -654,13 +650,13 @@

          pcdsdevices.epics_motor.BeckhoffAxis
          Parameters:
            -
          • delta (float) – Desired change in position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • delta (float) – Desired change in position.

          • +
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • wait (bool, optional) – If True, wait for motion completion before returning. +

          • wait (bool, optional) – If True, wait for motion completion before returning. Defaults to False.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          @@ -674,7 +670,7 @@

          pcdsdevices.epics_motor.BeckhoffAxis
          -read() OrderedDictType[str, Dict[str, Any]]
          +read() OrderedDictType[str, Dict[str, Any]]

          Read data from the device.

          This method is expected to be as instantaneous as possible, with any substantial acquisition time taken care of in @@ -697,7 +693,7 @@

          pcdsdevices.epics_motor.BeckhoffAxis
          -read_configuration() OrderedDictType[str, Dict[str, Any]]
          +read_configuration() OrderedDictType[str, Dict[str, Any]]

          Dictionary mapping names to value dicts with keys: value, timestamp

          To control which fields are included, change the Component kinds on the device, or modify the configuration_attrs list.

          @@ -713,23 +709,23 @@

          pcdsdevices.epics_motor.BeckhoffAxis
          -set(new_position: Any, *, timeout: float | None = None, moved_cb: Callable | None = None, wait: bool = False) StatusBase
          +set(new_position: Any, *, timeout: float | None = None, moved_cb: Callable | None = None, wait: bool = False) StatusBase

          Set a value and return a Status object

          Parameters:
            -
          • new_position (object) – The input here is whatever the device requires (this +

          • new_position (object) – The input here is whatever the device requires (this should be over-ridden by the implementation. For example a motor would take a float, a shutter the strings {‘Open’, ‘Close’}, and a goineometer (h, k, l) tuples

          • -
          • timeout (float, optional) – Maximum time to wait for the motion. If None, the default timeout +

          • timeout (float, optional) – Maximum time to wait for the motion. If None, the default timeout for this positioner is used.

          • moved_cb (callable, optional) –

            Deprecated

            Call this callback when movement has finished. This callback must accept one keyword argument: ‘obj’ which will be set to this positioner instance.

          • -
          • wait (bool, optional) –

            Deprecated

            +
          • wait (bool, optional) –

            Deprecated

            If the method should block until the Status object reports it is done.

            Defaults to False

            @@ -760,10 +756,10 @@

            pcdsdevices.epics_motor.BeckhoffAxis
            Parameters:
            -

            value (float) – High limit value to be set.

            +

            value (float) – High limit value to be set.

            Raises:
            -

            ValueError – When motor in motion or position outside of limit.

            +

            ValueError – When motor in motion or position outside of limit.

          @@ -781,8 +777,8 @@

          pcdsdevices.epics_motor.BeckhoffAxis
          Parameters:
            -
          • high (float) – Limit of travel in the positive direction.

          • -
          • low (float) – Limit of travel in the negative direction.

          • +
          • high (float) – Limit of travel in the positive direction.

          • +
          • low (float) – Limit of travel in the negative direction.

          @@ -794,10 +790,10 @@

          pcdsdevices.epics_motor.BeckhoffAxis
          Parameters:
          -

          value (float) – Limit of travel in the negative direction.

          +

          value (float) – Limit of travel in the negative direction.

          Raises:
          -

          ValueError – When motor in motion or position outside of limit.

          +

          ValueError – When motor in motion or position outside of limit.

          @@ -811,7 +807,7 @@

          pcdsdevices.epics_motor.BeckhoffAxis
          -status() str
          +status() str

          Returns a str with the current pv values for the device.

          @@ -828,7 +824,7 @@

          pcdsdevices.epics_motor.BeckhoffAxis
          -trigger() StatusBase
          +trigger() StatusBase

          Trigger the device and return status object.

          This method is responsible for implementing ‘trigger’ or ‘acquire’ functionality of this device.

          @@ -836,14 +832,14 @@

          pcdsdevices.epics_motor.BeckhoffAxisread() method) then this method is also responsible for arranging that the -StatusBase object returned by this method +StatusBase object returned by this method is notified when the device is ready to be read.

          If there is no delay between triggering and being readable, -then this method must return a StatusBase +then this method must return a StatusBase object which is already completed.

          Returns:
          -

          status (StatusBase) – StatusBase object which will be marked +

          status (StatusBase) – StatusBase object which will be marked as complete when the device is ready to be read.

          @@ -858,7 +854,7 @@

          pcdsdevices.epics_motor.BeckhoffAxis
          Parameters:
          -

          scale (float) – starting step size, default = 0.1

          +

          scale (float) – starting step size, default = 0.1

          @@ -870,12 +866,12 @@

          pcdsdevices.epics_motor.BeckhoffAxis
          Parameters:
            -
          • position (float) – Desired end position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • position (float) – Desired end position.

          • +
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • -
          • newline (bool, optional) – If True, inserts a newline after the updates.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • newline (bool, optional) – If True, inserts a newline after the updates.

          @@ -888,12 +884,12 @@

          pcdsdevices.epics_motor.BeckhoffAxis
          Parameters:
            -
          • delta (float) – Desired change in position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • delta (float) – Desired change in position.

          • +
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • -
          • newline (bool, optional) – If True, inserts a newline after the updates.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • newline (bool, optional) – If True, inserts a newline after the updates.

          @@ -1023,7 +1019,7 @@

          pcdsdevices.epics_motor.BeckhoffAxis
          -subscriptions: ClassVar[FrozenSet[str]] = frozenset({'_req_done', 'acq_done', 'done_moving', 'readback', 'start_moving'})
          +subscriptions: ClassVar[FrozenSet[str]] = frozenset({'_req_done', 'acq_done', 'done_moving', 'readback', 'start_moving'})
          diff --git a/master/generated/pcdsdevices.epics_motor.BeckhoffAxisEPS.html b/master/generated/pcdsdevices.epics_motor.BeckhoffAxisEPS.html index 205b7b6a81a..7fe758a4135 100644 --- a/master/generated/pcdsdevices.epics_motor.BeckhoffAxisEPS.html +++ b/master/generated/pcdsdevices.epics_motor.BeckhoffAxisEPS.html @@ -1,25 +1,23 @@ + + - pcdsdevices.epics_motor.BeckhoffAxisEPS — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.epics_motor.BeckhoffAxisEPS — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -
          - 8.5.1.dev30+gd6e98430 -
          @@ -109,6 +104,7 @@
        • pcdsdevices.ipm
        • pcdsdevices.jet
        • pcdsdevices.keithley
        • +
        • pcdsdevices.lakeshore
        • pcdsdevices.lamp_motion
        • pcdsdevices.lasers.btps
        • pcdsdevices.lasers.counters
        • @@ -473,14 +469,14 @@

          pcdsdevices.epics_motor.BeckhoffAxisEPS
          -configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]
          +configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]

          Configure the device for something during a run

          This default implementation allows the user to change any of the configuration_attrs. Subclasses might override this to perform additional input validation, cleanup, etc.

          Parameters:
          -

          d (dict) – The configuration dictionary. To specify the order that +

          d (dict) – The configuration dictionary. To specify the order that the changes should be made, use an OrderedDict.

          Returns:
          @@ -495,7 +491,7 @@

          pcdsdevices.epics_motor.BeckhoffAxisEPS
          -describe() OrderedDictType[str, Dict[str, Any]]
          +describe() OrderedDictType[str, Dict[str, Any]]

          Provide schema and meta-data for read().

          This keys in the OrderedDict this method returns must match the keys in the OrderedDict return by read().

          @@ -557,8 +553,8 @@

          pcdsdevices.epics_motor.BeckhoffAxisEPS
          Parameters:
            -
          • high (float) – Limit of travel in the positive direction.

          • -
          • low (float) – Limit of travel in the negative direction.

          • +
          • high (float) – Limit of travel in the positive direction.

          • +
          • low (float) – Limit of travel in the negative direction.

          @@ -581,7 +577,7 @@

          pcdsdevices.epics_motor.BeckhoffAxisEPS
          -move(position: float, wait: bool = True, **kwargs) MoveStatus
          +move(position: float, wait: bool = True, **kwargs) MoveStatus

          Move to a specified position, optionally waiting for motion to complete.

          @@ -591,7 +587,7 @@

          pcdsdevices.epics_motor.BeckhoffAxisEPSfloat, optional) – Maximum time to wait for the motion. If None, the default timeout +
        • timeout (float, optional) – Maximum time to wait for the motion. If None, the default timeout for this positioner is used.

        • @@ -600,9 +596,9 @@

          pcdsdevices.epics_motor.BeckhoffAxisEPSRaises:

          @@ -616,12 +612,12 @@

          pcdsdevices.epics_motor.BeckhoffAxisEPSParameters:
          • position – Desired end position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • wait (bool, optional) – If True, wait for motion completion before returning. +

          • wait (bool, optional) – If True, wait for motion completion before returning. Defaults to False.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          @@ -643,13 +639,13 @@

          pcdsdevices.epics_motor.BeckhoffAxisEPS
          Parameters:
            -
          • delta (float) – Desired change in position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • delta (float) – Desired change in position.

          • +
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • wait (bool, optional) – If True, wait for motion completion before returning. +

          • wait (bool, optional) – If True, wait for motion completion before returning. Defaults to False.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          @@ -663,7 +659,7 @@

          pcdsdevices.epics_motor.BeckhoffAxisEPS
          -read() OrderedDictType[str, Dict[str, Any]]
          +read() OrderedDictType[str, Dict[str, Any]]

          Read data from the device.

          This method is expected to be as instantaneous as possible, with any substantial acquisition time taken care of in @@ -686,7 +682,7 @@

          pcdsdevices.epics_motor.BeckhoffAxisEPS
          -read_configuration() OrderedDictType[str, Dict[str, Any]]
          +read_configuration() OrderedDictType[str, Dict[str, Any]]

          Dictionary mapping names to value dicts with keys: value, timestamp

          To control which fields are included, change the Component kinds on the device, or modify the configuration_attrs list.

          @@ -702,23 +698,23 @@

          pcdsdevices.epics_motor.BeckhoffAxisEPS
          -set(new_position: Any, *, timeout: float | None = None, moved_cb: Callable | None = None, wait: bool = False) StatusBase
          +set(new_position: Any, *, timeout: float | None = None, moved_cb: Callable | None = None, wait: bool = False) StatusBase

          Set a value and return a Status object

          Parameters:
            -
          • new_position (object) – The input here is whatever the device requires (this +

          • new_position (object) – The input here is whatever the device requires (this should be over-ridden by the implementation. For example a motor would take a float, a shutter the strings {‘Open’, ‘Close’}, and a goineometer (h, k, l) tuples

          • -
          • timeout (float, optional) – Maximum time to wait for the motion. If None, the default timeout +

          • timeout (float, optional) – Maximum time to wait for the motion. If None, the default timeout for this positioner is used.

          • moved_cb (callable, optional) –

            Deprecated

            Call this callback when movement has finished. This callback must accept one keyword argument: ‘obj’ which will be set to this positioner instance.

          • -
          • wait (bool, optional) –

            Deprecated

            +
          • wait (bool, optional) –

            Deprecated

            If the method should block until the Status object reports it is done.

            Defaults to False

            @@ -749,10 +745,10 @@

            pcdsdevices.epics_motor.BeckhoffAxisEPS
            Parameters:
            -

            value (float) – High limit value to be set.

            +

            value (float) – High limit value to be set.

            Raises:
            -

            ValueError – When motor in motion or position outside of limit.

            +

            ValueError – When motor in motion or position outside of limit.

          @@ -770,8 +766,8 @@

          pcdsdevices.epics_motor.BeckhoffAxisEPS
          Parameters:
            -
          • high (float) – Limit of travel in the positive direction.

          • -
          • low (float) – Limit of travel in the negative direction.

          • +
          • high (float) – Limit of travel in the positive direction.

          • +
          • low (float) – Limit of travel in the negative direction.

          @@ -783,10 +779,10 @@

          pcdsdevices.epics_motor.BeckhoffAxisEPS
          Parameters:
          -

          value (float) – Limit of travel in the negative direction.

          +

          value (float) – Limit of travel in the negative direction.

          Raises:
          -

          ValueError – When motor in motion or position outside of limit.

          +

          ValueError – When motor in motion or position outside of limit.

          @@ -800,7 +796,7 @@

          pcdsdevices.epics_motor.BeckhoffAxisEPS
          -status() str
          +status() str

          Returns a str with the current pv values for the device.

          @@ -817,7 +813,7 @@

          pcdsdevices.epics_motor.BeckhoffAxisEPS
          -trigger() StatusBase
          +trigger() StatusBase

          Trigger the device and return status object.

          This method is responsible for implementing ‘trigger’ or ‘acquire’ functionality of this device.

          @@ -825,14 +821,14 @@

          pcdsdevices.epics_motor.BeckhoffAxisEPSread() method) then this method is also responsible for arranging that the -StatusBase object returned by this method +StatusBase object returned by this method is notified when the device is ready to be read.

          If there is no delay between triggering and being readable, -then this method must return a StatusBase +then this method must return a StatusBase object which is already completed.

          Returns:
          -

          status (StatusBase) – StatusBase object which will be marked +

          status (StatusBase) – StatusBase object which will be marked as complete when the device is ready to be read.

          @@ -847,7 +843,7 @@

          pcdsdevices.epics_motor.BeckhoffAxisEPS
          Parameters:
          -

          scale (float) – starting step size, default = 0.1

          +

          scale (float) – starting step size, default = 0.1

          @@ -859,12 +855,12 @@

          pcdsdevices.epics_motor.BeckhoffAxisEPS
          Parameters:
            -
          • position (float) – Desired end position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • position (float) – Desired end position.

          • +
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • -
          • newline (bool, optional) – If True, inserts a newline after the updates.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • newline (bool, optional) – If True, inserts a newline after the updates.

          @@ -877,12 +873,12 @@

          pcdsdevices.epics_motor.BeckhoffAxisEPS
          Parameters:
            -
          • delta (float) – Desired change in position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • delta (float) – Desired change in position.

          • +
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • -
          • newline (bool, optional) – If True, inserts a newline after the updates.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • newline (bool, optional) – If True, inserts a newline after the updates.

          @@ -1012,7 +1008,7 @@

          pcdsdevices.epics_motor.BeckhoffAxisEPS
          -subscriptions: ClassVar[FrozenSet[str]] = frozenset({'_req_done', 'acq_done', 'done_moving', 'readback', 'start_moving'})
          +subscriptions: ClassVar[FrozenSet[str]] = frozenset({'_req_done', 'acq_done', 'done_moving', 'readback', 'start_moving'})
          diff --git a/master/generated/pcdsdevices.epics_motor.BeckhoffAxisEPSCustom.html b/master/generated/pcdsdevices.epics_motor.BeckhoffAxisEPSCustom.html index 294c4f412c7..c1d0f77e24b 100644 --- a/master/generated/pcdsdevices.epics_motor.BeckhoffAxisEPSCustom.html +++ b/master/generated/pcdsdevices.epics_motor.BeckhoffAxisEPSCustom.html @@ -1,25 +1,23 @@ + + - pcdsdevices.epics_motor.BeckhoffAxisEPSCustom — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.epics_motor.BeckhoffAxisEPSCustom — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -
          - 8.5.1.dev30+gd6e98430 -
          @@ -109,6 +104,7 @@
        • pcdsdevices.ipm
        • pcdsdevices.jet
        • pcdsdevices.keithley
        • +
        • pcdsdevices.lakeshore
        • pcdsdevices.lamp_motion
        • pcdsdevices.lasers.btps
        • pcdsdevices.lasers.counters
        • @@ -473,14 +469,14 @@

          pcdsdevices.epics_motor.BeckhoffAxisEPSCustom
          -configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]
          +configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]

          Configure the device for something during a run

          This default implementation allows the user to change any of the configuration_attrs. Subclasses might override this to perform additional input validation, cleanup, etc.

          Parameters:
          -

          d (dict) – The configuration dictionary. To specify the order that +

          d (dict) – The configuration dictionary. To specify the order that the changes should be made, use an OrderedDict.

          Returns:
          @@ -495,7 +491,7 @@

          pcdsdevices.epics_motor.BeckhoffAxisEPSCustom
          -describe() OrderedDictType[str, Dict[str, Any]]
          +describe() OrderedDictType[str, Dict[str, Any]]

          Provide schema and meta-data for read().

          This keys in the OrderedDict this method returns must match the keys in the OrderedDict return by read().

          @@ -557,8 +553,8 @@

          pcdsdevices.epics_motor.BeckhoffAxisEPSCustom
          Parameters:
            -
          • high (float) – Limit of travel in the positive direction.

          • -
          • low (float) – Limit of travel in the negative direction.

          • +
          • high (float) – Limit of travel in the positive direction.

          • +
          • low (float) – Limit of travel in the negative direction.

          @@ -581,7 +577,7 @@

          pcdsdevices.epics_motor.BeckhoffAxisEPSCustom
          -move(position: float, wait: bool = True, **kwargs) MoveStatus
          +move(position: float, wait: bool = True, **kwargs) MoveStatus

          Move to a specified position, optionally waiting for motion to complete.

          @@ -591,7 +587,7 @@

          pcdsdevices.epics_motor.BeckhoffAxisEPSCustomfloat, optional) – Maximum time to wait for the motion. If None, the default timeout +
        • timeout (float, optional) – Maximum time to wait for the motion. If None, the default timeout for this positioner is used.

        • @@ -600,9 +596,9 @@

          pcdsdevices.epics_motor.BeckhoffAxisEPSCustomRaises:

          @@ -616,12 +612,12 @@

          pcdsdevices.epics_motor.BeckhoffAxisEPSCustomParameters:
          • position – Desired end position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • wait (bool, optional) – If True, wait for motion completion before returning. +

          • wait (bool, optional) – If True, wait for motion completion before returning. Defaults to False.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          @@ -643,13 +639,13 @@

          pcdsdevices.epics_motor.BeckhoffAxisEPSCustom
          Parameters:
            -
          • delta (float) – Desired change in position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • delta (float) – Desired change in position.

          • +
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • wait (bool, optional) – If True, wait for motion completion before returning. +

          • wait (bool, optional) – If True, wait for motion completion before returning. Defaults to False.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          @@ -663,7 +659,7 @@

          pcdsdevices.epics_motor.BeckhoffAxisEPSCustom
          -read() OrderedDictType[str, Dict[str, Any]]
          +read() OrderedDictType[str, Dict[str, Any]]

          Read data from the device.

          This method is expected to be as instantaneous as possible, with any substantial acquisition time taken care of in @@ -686,7 +682,7 @@

          pcdsdevices.epics_motor.BeckhoffAxisEPSCustom
          -read_configuration() OrderedDictType[str, Dict[str, Any]]
          +read_configuration() OrderedDictType[str, Dict[str, Any]]

          Dictionary mapping names to value dicts with keys: value, timestamp

          To control which fields are included, change the Component kinds on the device, or modify the configuration_attrs list.

          @@ -702,23 +698,23 @@

          pcdsdevices.epics_motor.BeckhoffAxisEPSCustom
          -set(new_position: Any, *, timeout: float | None = None, moved_cb: Callable | None = None, wait: bool = False) StatusBase
          +set(new_position: Any, *, timeout: float | None = None, moved_cb: Callable | None = None, wait: bool = False) StatusBase

          Set a value and return a Status object

          Parameters:
            -
          • new_position (object) – The input here is whatever the device requires (this +

          • new_position (object) – The input here is whatever the device requires (this should be over-ridden by the implementation. For example a motor would take a float, a shutter the strings {‘Open’, ‘Close’}, and a goineometer (h, k, l) tuples

          • -
          • timeout (float, optional) – Maximum time to wait for the motion. If None, the default timeout +

          • timeout (float, optional) – Maximum time to wait for the motion. If None, the default timeout for this positioner is used.

          • moved_cb (callable, optional) –

            Deprecated

            Call this callback when movement has finished. This callback must accept one keyword argument: ‘obj’ which will be set to this positioner instance.

          • -
          • wait (bool, optional) –

            Deprecated

            +
          • wait (bool, optional) –

            Deprecated

            If the method should block until the Status object reports it is done.

            Defaults to False

            @@ -749,10 +745,10 @@

            pcdsdevices.epics_motor.BeckhoffAxisEPSCustom
            Parameters:
            -

            value (float) – High limit value to be set.

            +

            value (float) – High limit value to be set.

            Raises:
            -

            ValueError – When motor in motion or position outside of limit.

            +

            ValueError – When motor in motion or position outside of limit.

          @@ -770,8 +766,8 @@

          pcdsdevices.epics_motor.BeckhoffAxisEPSCustom
          Parameters:
            -
          • high (float) – Limit of travel in the positive direction.

          • -
          • low (float) – Limit of travel in the negative direction.

          • +
          • high (float) – Limit of travel in the positive direction.

          • +
          • low (float) – Limit of travel in the negative direction.

          @@ -783,10 +779,10 @@

          pcdsdevices.epics_motor.BeckhoffAxisEPSCustom
          Parameters:
          -

          value (float) – Limit of travel in the negative direction.

          +

          value (float) – Limit of travel in the negative direction.

          Raises:
          -

          ValueError – When motor in motion or position outside of limit.

          +

          ValueError – When motor in motion or position outside of limit.

          @@ -800,7 +796,7 @@

          pcdsdevices.epics_motor.BeckhoffAxisEPSCustom
          -status() str
          +status() str

          Returns a str with the current pv values for the device.

          @@ -817,7 +813,7 @@

          pcdsdevices.epics_motor.BeckhoffAxisEPSCustom
          -trigger() StatusBase
          +trigger() StatusBase

          Trigger the device and return status object.

          This method is responsible for implementing ‘trigger’ or ‘acquire’ functionality of this device.

          @@ -825,14 +821,14 @@

          pcdsdevices.epics_motor.BeckhoffAxisEPSCustomread() method) then this method is also responsible for arranging that the -StatusBase object returned by this method +StatusBase object returned by this method is notified when the device is ready to be read.

          If there is no delay between triggering and being readable, -then this method must return a StatusBase +then this method must return a StatusBase object which is already completed.

          Returns:
          -

          status (StatusBase) – StatusBase object which will be marked +

          status (StatusBase) – StatusBase object which will be marked as complete when the device is ready to be read.

          @@ -847,7 +843,7 @@

          pcdsdevices.epics_motor.BeckhoffAxisEPSCustom
          Parameters:
          -

          scale (float) – starting step size, default = 0.1

          +

          scale (float) – starting step size, default = 0.1

          @@ -859,12 +855,12 @@

          pcdsdevices.epics_motor.BeckhoffAxisEPSCustom
          Parameters:
            -
          • position (float) – Desired end position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • position (float) – Desired end position.

          • +
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • -
          • newline (bool, optional) – If True, inserts a newline after the updates.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • newline (bool, optional) – If True, inserts a newline after the updates.

          @@ -877,12 +873,12 @@

          pcdsdevices.epics_motor.BeckhoffAxisEPSCustom
          Parameters:
            -
          • delta (float) – Desired change in position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • delta (float) – Desired change in position.

          • +
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • -
          • newline (bool, optional) – If True, inserts a newline after the updates.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • newline (bool, optional) – If True, inserts a newline after the updates.

          @@ -1012,7 +1008,7 @@

          pcdsdevices.epics_motor.BeckhoffAxisEPSCustom
          -subscriptions: ClassVar[FrozenSet[str]] = frozenset({'_req_done', 'acq_done', 'done_moving', 'readback', 'start_moving'})
          +subscriptions: ClassVar[FrozenSet[str]] = frozenset({'_req_done', 'acq_done', 'done_moving', 'readback', 'start_moving'})
          diff --git a/master/generated/pcdsdevices.epics_motor.BeckhoffAxisNoOffset.html b/master/generated/pcdsdevices.epics_motor.BeckhoffAxisNoOffset.html index 5433ad419c2..b1b3ceafee1 100644 --- a/master/generated/pcdsdevices.epics_motor.BeckhoffAxisNoOffset.html +++ b/master/generated/pcdsdevices.epics_motor.BeckhoffAxisNoOffset.html @@ -1,25 +1,23 @@ + + - pcdsdevices.epics_motor.BeckhoffAxisNoOffset — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.epics_motor.BeckhoffAxisNoOffset — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -
          - 8.5.1.dev30+gd6e98430 -
          @@ -109,6 +104,7 @@
        • pcdsdevices.ipm
        • pcdsdevices.jet
        • pcdsdevices.keithley
        • +
        • pcdsdevices.lakeshore
        • pcdsdevices.lamp_motion
        • pcdsdevices.lasers.btps
        • pcdsdevices.lasers.counters
        • @@ -499,14 +495,14 @@

          pcdsdevices.epics_motor.BeckhoffAxisNoOffset
          -configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]
          +configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]

          Configure the device for something during a run

          This default implementation allows the user to change any of the configuration_attrs. Subclasses might override this to perform additional input validation, cleanup, etc.

          Parameters:
          -

          d (dict) – The configuration dictionary. To specify the order that +

          d (dict) – The configuration dictionary. To specify the order that the changes should be made, use an OrderedDict.

          Returns:
          @@ -521,7 +517,7 @@

          pcdsdevices.epics_motor.BeckhoffAxisNoOffset
          -describe() OrderedDictType[str, Dict[str, Any]]
          +describe() OrderedDictType[str, Dict[str, Any]]

          Provide schema and meta-data for read().

          This keys in the OrderedDict this method returns must match the keys in the OrderedDict return by read().

          @@ -583,8 +579,8 @@

          pcdsdevices.epics_motor.BeckhoffAxisNoOffset
          Parameters:
            -
          • high (float) – Limit of travel in the positive direction.

          • -
          • low (float) – Limit of travel in the negative direction.

          • +
          • high (float) – Limit of travel in the positive direction.

          • +
          • low (float) – Limit of travel in the negative direction.

          @@ -607,7 +603,7 @@

          pcdsdevices.epics_motor.BeckhoffAxisNoOffset
          -move(position: float, wait: bool = True, **kwargs) MoveStatus
          +move(position: float, wait: bool = True, **kwargs) MoveStatus

          Move to a specified position, optionally waiting for motion to complete.

          @@ -617,7 +613,7 @@

          pcdsdevices.epics_motor.BeckhoffAxisNoOffsetfloat, optional) – Maximum time to wait for the motion. If None, the default timeout +
        • timeout (float, optional) – Maximum time to wait for the motion. If None, the default timeout for this positioner is used.

        • @@ -626,9 +622,9 @@

          pcdsdevices.epics_motor.BeckhoffAxisNoOffsetRaises:

          @@ -642,12 +638,12 @@

          pcdsdevices.epics_motor.BeckhoffAxisNoOffsetParameters:
          • position – Desired end position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • wait (bool, optional) – If True, wait for motion completion before returning. +

          • wait (bool, optional) – If True, wait for motion completion before returning. Defaults to False.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          @@ -669,13 +665,13 @@

          pcdsdevices.epics_motor.BeckhoffAxisNoOffset
          Parameters:
            -
          • delta (float) – Desired change in position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • delta (float) – Desired change in position.

          • +
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • wait (bool, optional) – If True, wait for motion completion before returning. +

          • wait (bool, optional) – If True, wait for motion completion before returning. Defaults to False.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          @@ -689,7 +685,7 @@

          pcdsdevices.epics_motor.BeckhoffAxisNoOffset
          -read() OrderedDictType[str, Dict[str, Any]]
          +read() OrderedDictType[str, Dict[str, Any]]

          Read data from the device.

          This method is expected to be as instantaneous as possible, with any substantial acquisition time taken care of in @@ -712,7 +708,7 @@

          pcdsdevices.epics_motor.BeckhoffAxisNoOffset
          -read_configuration() OrderedDictType[str, Dict[str, Any]]
          +read_configuration() OrderedDictType[str, Dict[str, Any]]

          Dictionary mapping names to value dicts with keys: value, timestamp

          To control which fields are included, change the Component kinds on the device, or modify the configuration_attrs list.

          @@ -728,23 +724,23 @@

          pcdsdevices.epics_motor.BeckhoffAxisNoOffset
          -set(new_position: Any, *, timeout: float | None = None, moved_cb: Callable | None = None, wait: bool = False) StatusBase
          +set(new_position: Any, *, timeout: float | None = None, moved_cb: Callable | None = None, wait: bool = False) StatusBase

          Set a value and return a Status object

          Parameters:
            -
          • new_position (object) – The input here is whatever the device requires (this +

          • new_position (object) – The input here is whatever the device requires (this should be over-ridden by the implementation. For example a motor would take a float, a shutter the strings {‘Open’, ‘Close’}, and a goineometer (h, k, l) tuples

          • -
          • timeout (float, optional) – Maximum time to wait for the motion. If None, the default timeout +

          • timeout (float, optional) – Maximum time to wait for the motion. If None, the default timeout for this positioner is used.

          • moved_cb (callable, optional) –

            Deprecated

            Call this callback when movement has finished. This callback must accept one keyword argument: ‘obj’ which will be set to this positioner instance.

          • -
          • wait (bool, optional) –

            Deprecated

            +
          • wait (bool, optional) –

            Deprecated

            If the method should block until the Status object reports it is done.

            Defaults to False

            @@ -775,10 +771,10 @@

            pcdsdevices.epics_motor.BeckhoffAxisNoOffset
            Parameters:
            -

            value (float) – High limit value to be set.

            +

            value (float) – High limit value to be set.

            Raises:
            -

            ValueError – When motor in motion or position outside of limit.

            +

            ValueError – When motor in motion or position outside of limit.

          @@ -796,8 +792,8 @@

          pcdsdevices.epics_motor.BeckhoffAxisNoOffset
          Parameters:
            -
          • high (float) – Limit of travel in the positive direction.

          • -
          • low (float) – Limit of travel in the negative direction.

          • +
          • high (float) – Limit of travel in the positive direction.

          • +
          • low (float) – Limit of travel in the negative direction.

          @@ -809,10 +805,10 @@

          pcdsdevices.epics_motor.BeckhoffAxisNoOffset
          Parameters:
          -

          value (float) – Limit of travel in the negative direction.

          +

          value (float) – Limit of travel in the negative direction.

          Raises:
          -

          ValueError – When motor in motion or position outside of limit.

          +

          ValueError – When motor in motion or position outside of limit.

          @@ -826,7 +822,7 @@

          pcdsdevices.epics_motor.BeckhoffAxisNoOffset
          -status() str
          +status() str

          Returns a str with the current pv values for the device.

          @@ -843,7 +839,7 @@

          pcdsdevices.epics_motor.BeckhoffAxisNoOffset
          -trigger() StatusBase
          +trigger() StatusBase

          Trigger the device and return status object.

          This method is responsible for implementing ‘trigger’ or ‘acquire’ functionality of this device.

          @@ -851,14 +847,14 @@

          pcdsdevices.epics_motor.BeckhoffAxisNoOffsetread() method) then this method is also responsible for arranging that the -StatusBase object returned by this method +StatusBase object returned by this method is notified when the device is ready to be read.

          If there is no delay between triggering and being readable, -then this method must return a StatusBase +then this method must return a StatusBase object which is already completed.

          Returns:
          -

          status (StatusBase) – StatusBase object which will be marked +

          status (StatusBase) – StatusBase object which will be marked as complete when the device is ready to be read.

          @@ -873,7 +869,7 @@

          pcdsdevices.epics_motor.BeckhoffAxisNoOffset
          Parameters:
          -

          scale (float) – starting step size, default = 0.1

          +

          scale (float) – starting step size, default = 0.1

          @@ -885,12 +881,12 @@

          pcdsdevices.epics_motor.BeckhoffAxisNoOffset
          Parameters:
            -
          • position (float) – Desired end position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • position (float) – Desired end position.

          • +
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • -
          • newline (bool, optional) – If True, inserts a newline after the updates.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • newline (bool, optional) – If True, inserts a newline after the updates.

          @@ -903,12 +899,12 @@

          pcdsdevices.epics_motor.BeckhoffAxisNoOffset
          Parameters:
            -
          • delta (float) – Desired change in position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • delta (float) – Desired change in position.

          • +
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • -
          • newline (bool, optional) – If True, inserts a newline after the updates.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • newline (bool, optional) – If True, inserts a newline after the updates.

          @@ -1038,7 +1034,7 @@

          pcdsdevices.epics_motor.BeckhoffAxisNoOffset
          -subscriptions: ClassVar[FrozenSet[str]] = frozenset({'_req_done', 'acq_done', 'done_moving', 'readback', 'start_moving'})
          +subscriptions: ClassVar[FrozenSet[str]] = frozenset({'_req_done', 'acq_done', 'done_moving', 'readback', 'start_moving'})
          diff --git a/master/generated/pcdsdevices.epics_motor.BeckhoffAxisPLC.html b/master/generated/pcdsdevices.epics_motor.BeckhoffAxisPLC.html index 036893f8a73..4c6f1df61d4 100644 --- a/master/generated/pcdsdevices.epics_motor.BeckhoffAxisPLC.html +++ b/master/generated/pcdsdevices.epics_motor.BeckhoffAxisPLC.html @@ -1,25 +1,23 @@ + + - pcdsdevices.epics_motor.BeckhoffAxisPLC — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.epics_motor.BeckhoffAxisPLC — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -
          - 8.5.1.dev30+gd6e98430 -
          @@ -109,6 +104,7 @@
        • pcdsdevices.ipm
        • pcdsdevices.jet
        • pcdsdevices.keithley
        • +
        • pcdsdevices.lakeshore
        • pcdsdevices.lamp_motion
        • pcdsdevices.lasers.btps
        • pcdsdevices.lasers.counters
        • @@ -307,14 +303,14 @@

          pcdsdevices.epics_motor.BeckhoffAxisPLCMethods

          -configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]
          +configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]

          Configure the device for something during a run

          This default implementation allows the user to change any of the configuration_attrs. Subclasses might override this to perform additional input validation, cleanup, etc.

          Parameters:
          -

          d (dict) – The configuration dictionary. To specify the order that +

          d (dict) – The configuration dictionary. To specify the order that the changes should be made, use an OrderedDict.

          Returns:
          @@ -329,7 +325,7 @@

          pcdsdevices.epics_motor.BeckhoffAxisPLC
          -describe() OrderedDictType[str, Dict[str, Any]]
          +describe() OrderedDictType[str, Dict[str, Any]]

          Provide schema and meta-data for read().

          This keys in the OrderedDict this method returns must match the keys in the OrderedDict return by read().

          @@ -353,7 +349,7 @@

          pcdsdevices.epics_motor.BeckhoffAxisPLC
          -read() OrderedDictType[str, Dict[str, Any]]
          +read() OrderedDictType[str, Dict[str, Any]]

          Read data from the device.

          This method is expected to be as instantaneous as possible, with any substantial acquisition time taken care of in @@ -376,7 +372,7 @@

          pcdsdevices.epics_motor.BeckhoffAxisPLC
          -read_configuration() OrderedDictType[str, Dict[str, Any]]
          +read_configuration() OrderedDictType[str, Dict[str, Any]]

          Dictionary mapping names to value dicts with keys: value, timestamp

          To control which fields are included, change the Component kinds on the device, or modify the configuration_attrs list.

          @@ -395,7 +391,7 @@

          pcdsdevices.epics_motor.BeckhoffAxisPLC
          -trigger() StatusBase
          +trigger() StatusBase

          Trigger the device and return status object.

          This method is responsible for implementing ‘trigger’ or ‘acquire’ functionality of this device.

          @@ -403,14 +399,14 @@

          pcdsdevices.epics_motor.BeckhoffAxisPLCread() method) then this method is also responsible for arranging that the -StatusBase object returned by this method +StatusBase object returned by this method is notified when the device is ready to be read.

          If there is no delay between triggering and being readable, -then this method must return a StatusBase +then this method must return a StatusBase object which is already completed.

          Returns:
          -

          status (StatusBase) – StatusBase object which will be marked +

          status (StatusBase) – StatusBase object which will be marked as complete when the device is ready to be read.

          @@ -439,7 +435,7 @@

          pcdsdevices.epics_motor.BeckhoffAxisPLC
          -subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})
          +subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})

          diff --git a/master/generated/pcdsdevices.epics_motor.BeckhoffAxisPLCEPS.html b/master/generated/pcdsdevices.epics_motor.BeckhoffAxisPLCEPS.html index 26e7137d478..f98de9b7703 100644 --- a/master/generated/pcdsdevices.epics_motor.BeckhoffAxisPLCEPS.html +++ b/master/generated/pcdsdevices.epics_motor.BeckhoffAxisPLCEPS.html @@ -1,25 +1,23 @@ + + - pcdsdevices.epics_motor.BeckhoffAxisPLCEPS — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.epics_motor.BeckhoffAxisPLCEPS — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -
          - 8.5.1.dev30+gd6e98430 -
          @@ -109,6 +104,7 @@
        • pcdsdevices.ipm
        • pcdsdevices.jet
        • pcdsdevices.keithley
        • +
        • pcdsdevices.lakeshore
        • pcdsdevices.lamp_motion
        • pcdsdevices.lasers.btps
        • pcdsdevices.lasers.counters
        • @@ -331,14 +327,14 @@

          pcdsdevices.epics_motor.BeckhoffAxisPLCEPSMethods

          -configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]
          +configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]

          Configure the device for something during a run

          This default implementation allows the user to change any of the configuration_attrs. Subclasses might override this to perform additional input validation, cleanup, etc.

          Parameters:
          -

          d (dict) – The configuration dictionary. To specify the order that +

          d (dict) – The configuration dictionary. To specify the order that the changes should be made, use an OrderedDict.

          Returns:
          @@ -353,7 +349,7 @@

          pcdsdevices.epics_motor.BeckhoffAxisPLCEPS
          -describe() OrderedDictType[str, Dict[str, Any]]
          +describe() OrderedDictType[str, Dict[str, Any]]

          Provide schema and meta-data for read().

          This keys in the OrderedDict this method returns must match the keys in the OrderedDict return by read().

          @@ -377,7 +373,7 @@

          pcdsdevices.epics_motor.BeckhoffAxisPLCEPS
          -read() OrderedDictType[str, Dict[str, Any]]
          +read() OrderedDictType[str, Dict[str, Any]]

          Read data from the device.

          This method is expected to be as instantaneous as possible, with any substantial acquisition time taken care of in @@ -400,7 +396,7 @@

          pcdsdevices.epics_motor.BeckhoffAxisPLCEPS
          -read_configuration() OrderedDictType[str, Dict[str, Any]]
          +read_configuration() OrderedDictType[str, Dict[str, Any]]

          Dictionary mapping names to value dicts with keys: value, timestamp

          To control which fields are included, change the Component kinds on the device, or modify the configuration_attrs list.

          @@ -419,7 +415,7 @@

          pcdsdevices.epics_motor.BeckhoffAxisPLCEPS
          -trigger() StatusBase
          +trigger() StatusBase

          Trigger the device and return status object.

          This method is responsible for implementing ‘trigger’ or ‘acquire’ functionality of this device.

          @@ -427,14 +423,14 @@

          pcdsdevices.epics_motor.BeckhoffAxisPLCEPSread() method) then this method is also responsible for arranging that the -StatusBase object returned by this method +StatusBase object returned by this method is notified when the device is ready to be read.

          If there is no delay between triggering and being readable, -then this method must return a StatusBase +then this method must return a StatusBase object which is already completed.

          Returns:
          -

          status (StatusBase) – StatusBase object which will be marked +

          status (StatusBase) – StatusBase object which will be marked as complete when the device is ready to be read.

          @@ -463,7 +459,7 @@

          pcdsdevices.epics_motor.BeckhoffAxisPLCEPS
          -subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})
          +subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})

          diff --git a/master/generated/pcdsdevices.epics_motor.BeckhoffAxisPLC_Pre140.html b/master/generated/pcdsdevices.epics_motor.BeckhoffAxisPLC_Pre140.html index b644c90b2ad..26f72443673 100644 --- a/master/generated/pcdsdevices.epics_motor.BeckhoffAxisPLC_Pre140.html +++ b/master/generated/pcdsdevices.epics_motor.BeckhoffAxisPLC_Pre140.html @@ -1,25 +1,23 @@ + + - pcdsdevices.epics_motor.BeckhoffAxisPLC_Pre140 — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.epics_motor.BeckhoffAxisPLC_Pre140 — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -
          - 8.5.1.dev30+gd6e98430 -
          @@ -109,6 +104,7 @@
        • pcdsdevices.ipm
        • pcdsdevices.jet
        • pcdsdevices.keithley
        • +
        • pcdsdevices.lakeshore
        • pcdsdevices.lamp_motion
        • pcdsdevices.lasers.btps
        • pcdsdevices.lasers.counters
        • @@ -279,14 +275,14 @@

          pcdsdevices.epics_motor.BeckhoffAxisPLC_Pre140Methods

          -configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]
          +configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]

          Configure the device for something during a run

          This default implementation allows the user to change any of the configuration_attrs. Subclasses might override this to perform additional input validation, cleanup, etc.

          Parameters:
          -

          d (dict) – The configuration dictionary. To specify the order that +

          d (dict) – The configuration dictionary. To specify the order that the changes should be made, use an OrderedDict.

          Returns:
          @@ -301,7 +297,7 @@

          pcdsdevices.epics_motor.BeckhoffAxisPLC_Pre140
          -describe() OrderedDictType[str, Dict[str, Any]]
          +describe() OrderedDictType[str, Dict[str, Any]]

          Provide schema and meta-data for read().

          This keys in the OrderedDict this method returns must match the keys in the OrderedDict return by read().

          @@ -325,7 +321,7 @@

          pcdsdevices.epics_motor.BeckhoffAxisPLC_Pre140
          -read() OrderedDictType[str, Dict[str, Any]]
          +read() OrderedDictType[str, Dict[str, Any]]

          Read data from the device.

          This method is expected to be as instantaneous as possible, with any substantial acquisition time taken care of in @@ -348,7 +344,7 @@

          pcdsdevices.epics_motor.BeckhoffAxisPLC_Pre140
          -read_configuration() OrderedDictType[str, Dict[str, Any]]
          +read_configuration() OrderedDictType[str, Dict[str, Any]]

          Dictionary mapping names to value dicts with keys: value, timestamp

          To control which fields are included, change the Component kinds on the device, or modify the configuration_attrs list.

          @@ -367,7 +363,7 @@

          pcdsdevices.epics_motor.BeckhoffAxisPLC_Pre140
          -trigger() StatusBase
          +trigger() StatusBase

          Trigger the device and return status object.

          This method is responsible for implementing ‘trigger’ or ‘acquire’ functionality of this device.

          @@ -375,14 +371,14 @@

          pcdsdevices.epics_motor.BeckhoffAxisPLC_Pre140read() method) then this method is also responsible for arranging that the -StatusBase object returned by this method +StatusBase object returned by this method is notified when the device is ready to be read.

          If there is no delay between triggering and being readable, -then this method must return a StatusBase +then this method must return a StatusBase object which is already completed.

          Returns:
          -

          status (StatusBase) – StatusBase object which will be marked +

          status (StatusBase) – StatusBase object which will be marked as complete when the device is ready to be read.

          @@ -426,7 +422,7 @@

          pcdsdevices.epics_motor.BeckhoffAxisPLC_Pre140
          -subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})
          +subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})

          diff --git a/master/generated/pcdsdevices.epics_motor.BeckhoffAxis_Pre140.html b/master/generated/pcdsdevices.epics_motor.BeckhoffAxis_Pre140.html index fc6c59ffd1b..3e2489b8478 100644 --- a/master/generated/pcdsdevices.epics_motor.BeckhoffAxis_Pre140.html +++ b/master/generated/pcdsdevices.epics_motor.BeckhoffAxis_Pre140.html @@ -1,25 +1,23 @@ + + - pcdsdevices.epics_motor.BeckhoffAxis_Pre140 — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.epics_motor.BeckhoffAxis_Pre140 — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -
          - 8.5.1.dev30+gd6e98430 -
          @@ -109,6 +104,7 @@
        • pcdsdevices.ipm
        • pcdsdevices.jet
        • pcdsdevices.keithley
        • +
        • pcdsdevices.lakeshore
        • pcdsdevices.lamp_motion
        • pcdsdevices.lasers.btps
        • pcdsdevices.lasers.counters
        • @@ -473,14 +469,14 @@

          pcdsdevices.epics_motor.BeckhoffAxis_Pre140
          -configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]
          +configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]

          Configure the device for something during a run

          This default implementation allows the user to change any of the configuration_attrs. Subclasses might override this to perform additional input validation, cleanup, etc.

          Parameters:
          -

          d (dict) – The configuration dictionary. To specify the order that +

          d (dict) – The configuration dictionary. To specify the order that the changes should be made, use an OrderedDict.

          Returns:
          @@ -495,7 +491,7 @@

          pcdsdevices.epics_motor.BeckhoffAxis_Pre140
          -describe() OrderedDictType[str, Dict[str, Any]]
          +describe() OrderedDictType[str, Dict[str, Any]]

          Provide schema and meta-data for read().

          This keys in the OrderedDict this method returns must match the keys in the OrderedDict return by read().

          @@ -557,8 +553,8 @@

          pcdsdevices.epics_motor.BeckhoffAxis_Pre140
          Parameters:
            -
          • high (float) – Limit of travel in the positive direction.

          • -
          • low (float) – Limit of travel in the negative direction.

          • +
          • high (float) – Limit of travel in the positive direction.

          • +
          • low (float) – Limit of travel in the negative direction.

          @@ -578,7 +574,7 @@

          pcdsdevices.epics_motor.BeckhoffAxis_Pre140
          -move(position: float, wait: bool = True, **kwargs) MoveStatus
          +move(position: float, wait: bool = True, **kwargs) MoveStatus

          Move to a specified position, optionally waiting for motion to complete.

          @@ -588,7 +584,7 @@

          pcdsdevices.epics_motor.BeckhoffAxis_Pre140float, optional) – Maximum time to wait for the motion. If None, the default timeout +
        • timeout (float, optional) – Maximum time to wait for the motion. If None, the default timeout for this positioner is used.

        • @@ -597,9 +593,9 @@

          pcdsdevices.epics_motor.BeckhoffAxis_Pre140Raises:

          @@ -613,12 +609,12 @@

          pcdsdevices.epics_motor.BeckhoffAxis_Pre140Parameters:
          • position – Desired end position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • wait (bool, optional) – If True, wait for motion completion before returning. +

          • wait (bool, optional) – If True, wait for motion completion before returning. Defaults to False.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          @@ -640,13 +636,13 @@

          pcdsdevices.epics_motor.BeckhoffAxis_Pre140
          Parameters:
            -
          • delta (float) – Desired change in position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • delta (float) – Desired change in position.

          • +
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • wait (bool, optional) – If True, wait for motion completion before returning. +

          • wait (bool, optional) – If True, wait for motion completion before returning. Defaults to False.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          @@ -660,7 +656,7 @@

          pcdsdevices.epics_motor.BeckhoffAxis_Pre140
          -read() OrderedDictType[str, Dict[str, Any]]
          +read() OrderedDictType[str, Dict[str, Any]]

          Read data from the device.

          This method is expected to be as instantaneous as possible, with any substantial acquisition time taken care of in @@ -683,7 +679,7 @@

          pcdsdevices.epics_motor.BeckhoffAxis_Pre140
          -read_configuration() OrderedDictType[str, Dict[str, Any]]
          +read_configuration() OrderedDictType[str, Dict[str, Any]]

          Dictionary mapping names to value dicts with keys: value, timestamp

          To control which fields are included, change the Component kinds on the device, or modify the configuration_attrs list.

          @@ -699,23 +695,23 @@

          pcdsdevices.epics_motor.BeckhoffAxis_Pre140
          -set(new_position: Any, *, timeout: float | None = None, moved_cb: Callable | None = None, wait: bool = False) StatusBase
          +set(new_position: Any, *, timeout: float | None = None, moved_cb: Callable | None = None, wait: bool = False) StatusBase

          Set a value and return a Status object

          Parameters:
            -
          • new_position (object) – The input here is whatever the device requires (this +

          • new_position (object) – The input here is whatever the device requires (this should be over-ridden by the implementation. For example a motor would take a float, a shutter the strings {‘Open’, ‘Close’}, and a goineometer (h, k, l) tuples

          • -
          • timeout (float, optional) – Maximum time to wait for the motion. If None, the default timeout +

          • timeout (float, optional) – Maximum time to wait for the motion. If None, the default timeout for this positioner is used.

          • moved_cb (callable, optional) –

            Deprecated

            Call this callback when movement has finished. This callback must accept one keyword argument: ‘obj’ which will be set to this positioner instance.

          • -
          • wait (bool, optional) –

            Deprecated

            +
          • wait (bool, optional) –

            Deprecated

            If the method should block until the Status object reports it is done.

            Defaults to False

            @@ -746,10 +742,10 @@

            pcdsdevices.epics_motor.BeckhoffAxis_Pre140
            Parameters:
            -

            value (float) – High limit value to be set.

            +

            value (float) – High limit value to be set.

            Raises:
            -

            ValueError – When motor in motion or position outside of limit.

            +

            ValueError – When motor in motion or position outside of limit.

          @@ -767,8 +763,8 @@

          pcdsdevices.epics_motor.BeckhoffAxis_Pre140
          Parameters:
            -
          • high (float) – Limit of travel in the positive direction.

          • -
          • low (float) – Limit of travel in the negative direction.

          • +
          • high (float) – Limit of travel in the positive direction.

          • +
          • low (float) – Limit of travel in the negative direction.

          @@ -780,10 +776,10 @@

          pcdsdevices.epics_motor.BeckhoffAxis_Pre140
          Parameters:
          -

          value (float) – Limit of travel in the negative direction.

          +

          value (float) – Limit of travel in the negative direction.

          Raises:
          -

          ValueError – When motor in motion or position outside of limit.

          +

          ValueError – When motor in motion or position outside of limit.

          @@ -797,7 +793,7 @@

          pcdsdevices.epics_motor.BeckhoffAxis_Pre140
          -status() str
          +status() str

          Returns a str with the current pv values for the device.

          @@ -814,7 +810,7 @@

          pcdsdevices.epics_motor.BeckhoffAxis_Pre140
          -trigger() StatusBase
          +trigger() StatusBase

          Trigger the device and return status object.

          This method is responsible for implementing ‘trigger’ or ‘acquire’ functionality of this device.

          @@ -822,14 +818,14 @@

          pcdsdevices.epics_motor.BeckhoffAxis_Pre140read() method) then this method is also responsible for arranging that the -StatusBase object returned by this method +StatusBase object returned by this method is notified when the device is ready to be read.

          If there is no delay between triggering and being readable, -then this method must return a StatusBase +then this method must return a StatusBase object which is already completed.

          Returns:
          -

          status (StatusBase) – StatusBase object which will be marked +

          status (StatusBase) – StatusBase object which will be marked as complete when the device is ready to be read.

          @@ -844,7 +840,7 @@

          pcdsdevices.epics_motor.BeckhoffAxis_Pre140
          Parameters:
          -

          scale (float) – starting step size, default = 0.1

          +

          scale (float) – starting step size, default = 0.1

          @@ -856,12 +852,12 @@

          pcdsdevices.epics_motor.BeckhoffAxis_Pre140
          Parameters:
            -
          • position (float) – Desired end position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • position (float) – Desired end position.

          • +
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • -
          • newline (bool, optional) – If True, inserts a newline after the updates.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • newline (bool, optional) – If True, inserts a newline after the updates.

          @@ -874,12 +870,12 @@

          pcdsdevices.epics_motor.BeckhoffAxis_Pre140
          Parameters:
            -
          • delta (float) – Desired change in position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • delta (float) – Desired change in position.

          • +
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • -
          • newline (bool, optional) – If True, inserts a newline after the updates.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • newline (bool, optional) – If True, inserts a newline after the updates.

          @@ -1009,7 +1005,7 @@

          pcdsdevices.epics_motor.BeckhoffAxis_Pre140
          -subscriptions: ClassVar[FrozenSet[str]] = frozenset({'_req_done', 'acq_done', 'done_moving', 'readback', 'start_moving'})
          +subscriptions: ClassVar[FrozenSet[str]] = frozenset({'_req_done', 'acq_done', 'done_moving', 'readback', 'start_moving'})
          diff --git a/master/generated/pcdsdevices.epics_motor.EpicsMotorInterface.html b/master/generated/pcdsdevices.epics_motor.EpicsMotorInterface.html index e6417189205..2dd3e91446f 100644 --- a/master/generated/pcdsdevices.epics_motor.EpicsMotorInterface.html +++ b/master/generated/pcdsdevices.epics_motor.EpicsMotorInterface.html @@ -1,25 +1,23 @@ + + - pcdsdevices.epics_motor.EpicsMotorInterface — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.epics_motor.EpicsMotorInterface — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -
          - 8.5.1.dev30+gd6e98430 -

          @@ -281,84 +277,84 @@

          pcdsdevices.epics_motor.EpicsMotorInterfaceEpicsMotor

          +

          - + - + - + - + - + - + - + - + - + - + - + @@ -371,7 +367,7 @@

          pcdsdevices.epics_motor.EpicsMotorInterfaceEpicsMotor

          +

          @@ -384,35 +380,35 @@

          pcdsdevices.epics_motor.EpicsMotorInterfaceEpicsMotor

          +

          - + - + - + - + @@ -489,14 +485,14 @@

          pcdsdevices.epics_motor.EpicsMotorInterface
          -configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]
          +configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]

          Configure the device for something during a run

          This default implementation allows the user to change any of the configuration_attrs. Subclasses might override this to perform additional input validation, cleanup, etc.

          Parameters:
          -

          d (dict) – The configuration dictionary. To specify the order that +

          d (dict) – The configuration dictionary. To specify the order that the changes should be made, use an OrderedDict.

          Returns:
          @@ -511,7 +507,7 @@

          pcdsdevices.epics_motor.EpicsMotorInterface
          -describe() OrderedDictType[str, Dict[str, Any]]
          +describe() OrderedDictType[str, Dict[str, Any]]

          Provide schema and meta-data for read().

          This keys in the OrderedDict this method returns must match the keys in the OrderedDict return by read().

          @@ -573,8 +569,8 @@

          pcdsdevices.epics_motor.EpicsMotorInterface
          Parameters:
            -
          • high (float) – Limit of travel in the positive direction.

          • -
          • low (float) – Limit of travel in the negative direction.

          • +
          • high (float) – Limit of travel in the positive direction.

          • +
          • low (float) – Limit of travel in the negative direction.

          @@ -599,7 +595,7 @@

          pcdsdevices.epics_motor.EpicsMotorInterface
          -move(position: float, wait: bool = True, **kwargs) MoveStatus
          +move(position: float, wait: bool = True, **kwargs) MoveStatus

          Move to a specified position, optionally waiting for motion to complete.

          @@ -609,7 +605,7 @@

          pcdsdevices.epics_motor.EpicsMotorInterfacefloat, optional) – Maximum time to wait for the motion. If None, the default timeout +
        • timeout (float, optional) – Maximum time to wait for the motion. If None, the default timeout for this positioner is used.

        • @@ -618,9 +614,9 @@

          pcdsdevices.epics_motor.EpicsMotorInterfaceRaises:
          @@ -634,12 +630,12 @@

          pcdsdevices.epics_motor.EpicsMotorInterfaceParameters:
          • position – Desired end position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • wait (bool, optional) – If True, wait for motion completion before returning. +

          • wait (bool, optional) – If True, wait for motion completion before returning. Defaults to False.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          @@ -661,13 +657,13 @@

          pcdsdevices.epics_motor.EpicsMotorInterface
          Parameters:
            -
          • delta (float) – Desired change in position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • delta (float) – Desired change in position.

          • +
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • wait (bool, optional) – If True, wait for motion completion before returning. +

          • wait (bool, optional) – If True, wait for motion completion before returning. Defaults to False.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          @@ -681,7 +677,7 @@

          pcdsdevices.epics_motor.EpicsMotorInterface
          -read() OrderedDictType[str, Dict[str, Any]]
          +read() OrderedDictType[str, Dict[str, Any]]

          Read data from the device.

          This method is expected to be as instantaneous as possible, with any substantial acquisition time taken care of in @@ -704,7 +700,7 @@

          pcdsdevices.epics_motor.EpicsMotorInterface
          -read_configuration() OrderedDictType[str, Dict[str, Any]]
          +read_configuration() OrderedDictType[str, Dict[str, Any]]

          Dictionary mapping names to value dicts with keys: value, timestamp

          To control which fields are included, change the Component kinds on the device, or modify the configuration_attrs list.

          @@ -720,23 +716,23 @@

          pcdsdevices.epics_motor.EpicsMotorInterface
          -set(new_position: Any, *, timeout: float | None = None, moved_cb: Callable | None = None, wait: bool = False) StatusBase
          +set(new_position: Any, *, timeout: float | None = None, moved_cb: Callable | None = None, wait: bool = False) StatusBase

          Set a value and return a Status object

          Parameters:
            -
          • new_position (object) – The input here is whatever the device requires (this +

          • new_position (object) – The input here is whatever the device requires (this should be over-ridden by the implementation. For example a motor would take a float, a shutter the strings {‘Open’, ‘Close’}, and a goineometer (h, k, l) tuples

          • -
          • timeout (float, optional) – Maximum time to wait for the motion. If None, the default timeout +

          • timeout (float, optional) – Maximum time to wait for the motion. If None, the default timeout for this positioner is used.

          • moved_cb (callable, optional) –

            Deprecated

            Call this callback when movement has finished. This callback must accept one keyword argument: ‘obj’ which will be set to this positioner instance.

          • -
          • wait (bool, optional) –

            Deprecated

            +
          • wait (bool, optional) –

            Deprecated

            If the method should block until the Status object reports it is done.

            Defaults to False

            @@ -767,10 +763,10 @@

            pcdsdevices.epics_motor.EpicsMotorInterface
            Parameters:
            -

            value (float) – High limit value to be set.

            +

            value (float) – High limit value to be set.

            Raises:
            -

            ValueError – When motor in motion or position outside of limit.

            +

            ValueError – When motor in motion or position outside of limit.

          @@ -788,8 +784,8 @@

          pcdsdevices.epics_motor.EpicsMotorInterface
          Parameters:
            -
          • high (float) – Limit of travel in the positive direction.

          • -
          • low (float) – Limit of travel in the negative direction.

          • +
          • high (float) – Limit of travel in the positive direction.

          • +
          • low (float) – Limit of travel in the negative direction.

          @@ -801,10 +797,10 @@

          pcdsdevices.epics_motor.EpicsMotorInterface
          Parameters:
          -

          value (float) – Limit of travel in the negative direction.

          +

          value (float) – Limit of travel in the negative direction.

          Raises:
          -

          ValueError – When motor in motion or position outside of limit.

          +

          ValueError – When motor in motion or position outside of limit.

          @@ -818,7 +814,7 @@

          pcdsdevices.epics_motor.EpicsMotorInterface
          -status() str
          +status() str

          Returns a str with the current pv values for the device.

          @@ -835,7 +831,7 @@

          pcdsdevices.epics_motor.EpicsMotorInterface
          -trigger() StatusBase
          +trigger() StatusBase

          Trigger the device and return status object.

          This method is responsible for implementing ‘trigger’ or ‘acquire’ functionality of this device.

          @@ -843,14 +839,14 @@

          pcdsdevices.epics_motor.EpicsMotorInterfaceread() method) then this method is also responsible for arranging that the -StatusBase object returned by this method +StatusBase object returned by this method is notified when the device is ready to be read.

          If there is no delay between triggering and being readable, -then this method must return a StatusBase +then this method must return a StatusBase object which is already completed.

          Returns:
          -

          status (StatusBase) – StatusBase object which will be marked +

          status (StatusBase) – StatusBase object which will be marked as complete when the device is ready to be read.

          @@ -865,7 +861,7 @@

          pcdsdevices.epics_motor.EpicsMotorInterface
          Parameters:
          -

          scale (float) – starting step size, default = 0.1

          +

          scale (float) – starting step size, default = 0.1

          @@ -877,12 +873,12 @@

          pcdsdevices.epics_motor.EpicsMotorInterface
          Parameters:
            -
          • position (float) – Desired end position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • position (float) – Desired end position.

          • +
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • -
          • newline (bool, optional) – If True, inserts a newline after the updates.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • newline (bool, optional) – If True, inserts a newline after the updates.

          @@ -895,12 +891,12 @@

          pcdsdevices.epics_motor.EpicsMotorInterface
          Parameters:
            -
          • delta (float) – Desired change in position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • delta (float) – Desired change in position.

          • +
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • -
          • newline (bool, optional) – If True, inserts a newline after the updates.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • newline (bool, optional) – If True, inserts a newline after the updates.

          @@ -1020,7 +1016,7 @@

          pcdsdevices.epics_motor.EpicsMotorInterface
          -subscriptions: ClassVar[FrozenSet[str]] = frozenset({'_req_done', 'acq_done', 'done_moving', 'readback', 'start_moving'})
          +subscriptions: ClassVar[FrozenSet[str]] = frozenset({'_req_done', 'acq_done', 'done_moving', 'readback', 'start_moving'})
          diff --git a/master/generated/pcdsdevices.epics_motor.IMS.html b/master/generated/pcdsdevices.epics_motor.IMS.html index 32991f9a7b3..665a14317e9 100644 --- a/master/generated/pcdsdevices.epics_motor.IMS.html +++ b/master/generated/pcdsdevices.epics_motor.IMS.html @@ -1,25 +1,23 @@ + + - pcdsdevices.epics_motor.IMS — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.epics_motor.IMS — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -
          - 8.5.1.dev30+gd6e98430 -
          @@ -109,6 +104,7 @@
        • pcdsdevices.ipm
        • pcdsdevices.jet
        • pcdsdevices.keithley
        • +
        • pcdsdevices.lakeshore
        • pcdsdevices.lamp_motion
        • pcdsdevices.lasers.btps
        • pcdsdevices.lasers.counters
        • @@ -224,10 +220,10 @@

          pcdsdevices.epics_motor.IMS
          Parameters:
            -
          • prefix (str) – The EPICS PV prefix for this motor.

          • -
          • name (str) – An identifying name for this motor.

          • -
          • settle_time (float, optional) – The amount of extra time to wait before interpreting a move as done.

          • -
          • timeout (float, optional) – The amount of time to wait before automatically marking a long +

          • prefix (str) – The EPICS PV prefix for this motor.

          • +
          • name (str) – An identifying name for this motor.

          • +
          • settle_time (float, optional) – The amount of extra time to wait before interpreting a move as done.

          • +
          • timeout (float, optional) – The amount of time to wait before automatically marking a long in-progress move as failed.

          @@ -572,7 +568,7 @@

          pcdsdevices.epics_motor.IMS
          -describe() OrderedDictType[str, Dict[str, Any]]
          +describe() OrderedDictType[str, Dict[str, Any]]

          Provide schema and meta-data for read().

          This keys in the OrderedDict this method returns must match the keys in the OrderedDict return by read().

          @@ -593,7 +589,7 @@

          pcdsdevices.epics_motor.IMS
          Parameters:
          -

          cfgname (str) – The name of the configuration to compare the settings to. If +

          cfgname (str) – The name of the configuration to compare the settings to. If this is None, use the current configuration.

          Returns:
          @@ -670,7 +666,7 @@

          pcdsdevices.epics_motor.IMS
          Parameters:
          -

          cfgname (str) – The name of the configuration

          +

          cfgname (str) – The name of the configuration

          Returns:

          A dictionary mapping field names to the configured values

          @@ -684,7 +680,7 @@

          pcdsdevices.epics_motor.IMS
          Parameters:
          -

          pv (str) – Default is None

          +

          pv (str) – Default is None

          Returns:

          cdict (dict) – A dictionary mapping field names (str) to values.

          @@ -711,8 +707,8 @@

          pcdsdevices.epics_motor.IMS
          Parameters:
            -
          • high (float) – Limit of travel in the positive direction.

          • -
          • low (float) – Limit of travel in the negative direction.

          • +
          • high (float) – Limit of travel in the positive direction.

          • +
          • low (float) – Limit of travel in the negative direction.

          @@ -737,7 +733,7 @@

          pcdsdevices.epics_motor.IMS
          -move(position: float, wait: bool = True, **kwargs) MoveStatus
          +move(position: float, wait: bool = True, **kwargs) MoveStatus

          Move to a specified position, optionally waiting for motion to complete.

          @@ -747,7 +743,7 @@

          pcdsdevices.epics_motor.IMSfloat, optional) – Maximum time to wait for the motion. If None, the default timeout +
        • timeout (float, optional) – Maximum time to wait for the motion. If None, the default timeout for this positioner is used.

        • @@ -756,9 +752,9 @@

          pcdsdevices.epics_motor.IMSRaises:
          @@ -772,12 +768,12 @@

          pcdsdevices.epics_motor.IMSParameters:
          • position – Desired end position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • wait (bool, optional) – If True, wait for motion completion before returning. +

          • wait (bool, optional) – If True, wait for motion completion before returning. Defaults to False.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          @@ -799,13 +795,13 @@

          pcdsdevices.epics_motor.IMS
          Parameters:
            -
          • delta (float) – Desired change in position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • delta (float) – Desired change in position.

          • +
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • wait (bool, optional) – If True, wait for motion completion before returning. +

          • wait (bool, optional) – If True, wait for motion completion before returning. Defaults to False.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          @@ -819,7 +815,7 @@

          pcdsdevices.epics_motor.IMS
          -read() OrderedDictType[str, Dict[str, Any]]
          +read() OrderedDictType[str, Dict[str, Any]]

          Read data from the device.

          This method is expected to be as instantaneous as possible, with any substantial acquisition time taken care of in @@ -842,7 +838,7 @@

          pcdsdevices.epics_motor.IMS
          -read_configuration() OrderedDictType[str, Dict[str, Any]]
          +read_configuration() OrderedDictType[str, Dict[str, Any]]

          Dictionary mapping names to value dicts with keys: value, timestamp

          To control which fields are included, change the Component kinds on the device, or modify the configuration_attrs list.

          @@ -850,17 +846,17 @@

          pcdsdevices.epics_motor.IMS
          -reinitialize(wait: bool = False, timeout: float = 10.0) SubscriptionStatus
          +reinitialize(wait: bool = False, timeout: float = 10.0) SubscriptionStatus

          Reinitialize the IMS motor.

          Parameters:
            -
          • wait (bool, optional) – Wait for the motor to be fully intialized.

          • -
          • timeout (float, optional) – If the re-initialization takes too long, raise an error.

          • +
          • wait (bool, optional) – Wait for the motor to be fully intialized.

          • +
          • timeout (float, optional) – If the re-initialization takes too long, raise an error.

          Returns:
          -

          SubscriptionStatus – Status object reporting the initialization state of the motor.

          +

          SubscriptionStatus – Status object reporting the initialization state of the motor.

          @@ -873,23 +869,23 @@

          pcdsdevices.epics_motor.IMS
          -set(new_position: Any, *, timeout: float | None = None, moved_cb: Callable | None = None, wait: bool = False) StatusBase
          +set(new_position: Any, *, timeout: float | None = None, moved_cb: Callable | None = None, wait: bool = False) StatusBase

          Set a value and return a Status object

          Parameters:
            -
          • new_position (object) – The input here is whatever the device requires (this +

          • new_position (object) – The input here is whatever the device requires (this should be over-ridden by the implementation. For example a motor would take a float, a shutter the strings {‘Open’, ‘Close’}, and a goineometer (h, k, l) tuples

          • -
          • timeout (float, optional) – Maximum time to wait for the motion. If None, the default timeout +

          • timeout (float, optional) – Maximum time to wait for the motion. If None, the default timeout for this positioner is used.

          • moved_cb (callable, optional) –

            Deprecated

            Call this callback when movement has finished. This callback must accept one keyword argument: ‘obj’ which will be set to this positioner instance.

          • -
          • wait (bool, optional) –

            Deprecated

            +
          • wait (bool, optional) –

            Deprecated

            If the method should block until the Status object reports it is done.

            Defaults to False

            @@ -918,10 +914,10 @@

            pcdsdevices.epics_motor.IMS
            Parameters:
            -

            value (float) – High limit value to be set.

            +

            value (float) – High limit value to be set.

            Raises:
            -

            ValueError – When motor in motion or position outside of limit.

            +

            ValueError – When motor in motion or position outside of limit.

          @@ -939,8 +935,8 @@

          pcdsdevices.epics_motor.IMS
          Parameters:
            -
          • high (float) – Limit of travel in the positive direction.

          • -
          • low (float) – Limit of travel in the negative direction.

          • +
          • high (float) – Limit of travel in the positive direction.

          • +
          • low (float) – Limit of travel in the negative direction.

          @@ -952,10 +948,10 @@

          pcdsdevices.epics_motor.IMS
          Parameters:
          -

          value (float) – Limit of travel in the negative direction.

          +

          value (float) – Limit of travel in the negative direction.

          Raises:
          -

          ValueError – When motor in motion or position outside of limit.

          +

          ValueError – When motor in motion or position outside of limit.

          @@ -995,7 +991,7 @@

          pcdsdevices.epics_motor.IMS
          -status() str
          +status() str

          Returns a str with the current pv values for the device.

          @@ -1012,7 +1008,7 @@

          pcdsdevices.epics_motor.IMS
          -trigger() StatusBase
          +trigger() StatusBase

          Trigger the device and return status object.

          This method is responsible for implementing ‘trigger’ or ‘acquire’ functionality of this device.

          @@ -1020,14 +1016,14 @@

          pcdsdevices.epics_motor.IMSread() method) then this method is also responsible for arranging that the -StatusBase object returned by this method +StatusBase object returned by this method is notified when the device is ready to be read.

          If there is no delay between triggering and being readable, -then this method must return a StatusBase +then this method must return a StatusBase object which is already completed.

          Returns:
          -

          status (StatusBase) – StatusBase object which will be marked +

          status (StatusBase) – StatusBase object which will be marked as complete when the device is ready to be read.

          @@ -1042,7 +1038,7 @@

          pcdsdevices.epics_motor.IMS
          Parameters:
          -

          scale (float) – starting step size, default = 0.1

          +

          scale (float) – starting step size, default = 0.1

          @@ -1054,12 +1050,12 @@

          pcdsdevices.epics_motor.IMS
          Parameters:
            -
          • position (float) – Desired end position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • position (float) – Desired end position.

          • +
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • -
          • newline (bool, optional) – If True, inserts a newline after the updates.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • newline (bool, optional) – If True, inserts a newline after the updates.

          @@ -1072,12 +1068,12 @@

          pcdsdevices.epics_motor.IMS
          Parameters:
            -
          • delta (float) – Desired change in position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • delta (float) – Desired change in position.

          • +
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • -
          • newline (bool, optional) – If True, inserts a newline after the updates.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • newline (bool, optional) – If True, inserts a newline after the updates.

          @@ -1202,7 +1198,7 @@

          pcdsdevices.epics_motor.IMS
          -subscriptions: ClassVar[FrozenSet[str]] = frozenset({'_req_done', 'acq_done', 'done_moving', 'readback', 'start_moving'})
          +subscriptions: ClassVar[FrozenSet[str]] = frozenset({'_req_done', 'acq_done', 'done_moving', 'readback', 'start_moving'})
          diff --git a/master/generated/pcdsdevices.epics_motor.MMC100.html b/master/generated/pcdsdevices.epics_motor.MMC100.html index bc0d8de6927..ca783088de6 100644 --- a/master/generated/pcdsdevices.epics_motor.MMC100.html +++ b/master/generated/pcdsdevices.epics_motor.MMC100.html @@ -1,25 +1,23 @@ + + - pcdsdevices.epics_motor.MMC100 — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.epics_motor.MMC100 — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -
          - 8.5.1.dev30+gd6e98430 -
          @@ -109,6 +104,7 @@
        • pcdsdevices.ipm
        • pcdsdevices.jet
        • pcdsdevices.keithley
        • +
        • pcdsdevices.lakeshore
        • pcdsdevices.lamp_motion
        • pcdsdevices.lasers.btps
        • pcdsdevices.lasers.counters
        • @@ -226,10 +222,10 @@

          pcdsdevices.epics_motor.MMC100
          Parameters:
            -
          • prefix (str) – The EPICS PV prefix for this motor.

          • -
          • name (str) – An identifying name for this motor.

          • -
          • settle_time (float, optional) – The amount of extra time to wait before interpreting a move as done.

          • -
          • timeout (float, optional) – The amount of time to wait before automatically marking a long +

          • prefix (str) – The EPICS PV prefix for this motor.

          • +
          • name (str) – An identifying name for this motor.

          • +
          • settle_time (float, optional) – The amount of extra time to wait before interpreting a move as done.

          • +
          • timeout (float, optional) – The amount of time to wait before automatically marking a long in-progress move as failed.

          @@ -485,14 +481,14 @@

          pcdsdevices.epics_motor.MMC100
          -configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]
          +configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]

          Configure the device for something during a run

          This default implementation allows the user to change any of the configuration_attrs. Subclasses might override this to perform additional input validation, cleanup, etc.

          Parameters:
          -

          d (dict) – The configuration dictionary. To specify the order that +

          d (dict) – The configuration dictionary. To specify the order that the changes should be made, use an OrderedDict.

          Returns:
          @@ -507,7 +503,7 @@

          pcdsdevices.epics_motor.MMC100
          -describe() OrderedDictType[str, Dict[str, Any]]
          +describe() OrderedDictType[str, Dict[str, Any]]

          Provide schema and meta-data for read().

          This keys in the OrderedDict this method returns must match the keys in the OrderedDict return by read().

          @@ -569,8 +565,8 @@

          pcdsdevices.epics_motor.MMC100
          Parameters:
            -
          • high (float) – Limit of travel in the positive direction.

          • -
          • low (float) – Limit of travel in the negative direction.

          • +
          • high (float) – Limit of travel in the positive direction.

          • +
          • low (float) – Limit of travel in the negative direction.

          @@ -595,7 +591,7 @@

          pcdsdevices.epics_motor.MMC100
          -move(position: float, wait: bool = True, **kwargs) MoveStatus
          +move(position: float, wait: bool = True, **kwargs) MoveStatus

          Move to a specified position, optionally waiting for motion to complete.

          @@ -605,7 +601,7 @@

          pcdsdevices.epics_motor.MMC100float, optional) – Maximum time to wait for the motion. If None, the default timeout +
        • timeout (float, optional) – Maximum time to wait for the motion. If None, the default timeout for this positioner is used.

        • @@ -614,9 +610,9 @@

          pcdsdevices.epics_motor.MMC100Raises:

          @@ -630,12 +626,12 @@

          pcdsdevices.epics_motor.MMC100Parameters:
          • position – Desired end position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • wait (bool, optional) – If True, wait for motion completion before returning. +

          • wait (bool, optional) – If True, wait for motion completion before returning. Defaults to False.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          @@ -657,13 +653,13 @@

          pcdsdevices.epics_motor.MMC100
          Parameters:
            -
          • delta (float) – Desired change in position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • delta (float) – Desired change in position.

          • +
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • wait (bool, optional) – If True, wait for motion completion before returning. +

          • wait (bool, optional) – If True, wait for motion completion before returning. Defaults to False.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          @@ -677,7 +673,7 @@

          pcdsdevices.epics_motor.MMC100
          -read() OrderedDictType[str, Dict[str, Any]]
          +read() OrderedDictType[str, Dict[str, Any]]

          Read data from the device.

          This method is expected to be as instantaneous as possible, with any substantial acquisition time taken care of in @@ -700,7 +696,7 @@

          pcdsdevices.epics_motor.MMC100
          -read_configuration() OrderedDictType[str, Dict[str, Any]]
          +read_configuration() OrderedDictType[str, Dict[str, Any]]

          Dictionary mapping names to value dicts with keys: value, timestamp

          To control which fields are included, change the Component kinds on the device, or modify the configuration_attrs list.

          @@ -714,23 +710,23 @@

          pcdsdevices.epics_motor.MMC100
          -set(new_position: Any, *, timeout: float | None = None, moved_cb: Callable | None = None, wait: bool = False) StatusBase
          +set(new_position: Any, *, timeout: float | None = None, moved_cb: Callable | None = None, wait: bool = False) StatusBase

          Set a value and return a Status object

          Parameters:
            -
          • new_position (object) – The input here is whatever the device requires (this +

          • new_position (object) – The input here is whatever the device requires (this should be over-ridden by the implementation. For example a motor would take a float, a shutter the strings {‘Open’, ‘Close’}, and a goineometer (h, k, l) tuples

          • -
          • timeout (float, optional) – Maximum time to wait for the motion. If None, the default timeout +

          • timeout (float, optional) – Maximum time to wait for the motion. If None, the default timeout for this positioner is used.

          • moved_cb (callable, optional) –

            Deprecated

            Call this callback when movement has finished. This callback must accept one keyword argument: ‘obj’ which will be set to this positioner instance.

          • -
          • wait (bool, optional) –

            Deprecated

            +
          • wait (bool, optional) –

            Deprecated

            If the method should block until the Status object reports it is done.

            Defaults to False

            @@ -759,10 +755,10 @@

            pcdsdevices.epics_motor.MMC100
            Parameters:
            -

            value (float) – High limit value to be set.

            +

            value (float) – High limit value to be set.

            Raises:
            -

            ValueError – When motor in motion or position outside of limit.

            +

            ValueError – When motor in motion or position outside of limit.

          @@ -780,8 +776,8 @@

          pcdsdevices.epics_motor.MMC100
          Parameters:
            -
          • high (float) – Limit of travel in the positive direction.

          • -
          • low (float) – Limit of travel in the negative direction.

          • +
          • high (float) – Limit of travel in the positive direction.

          • +
          • low (float) – Limit of travel in the negative direction.

          @@ -793,10 +789,10 @@

          pcdsdevices.epics_motor.MMC100
          Parameters:
          -

          value (float) – Limit of travel in the negative direction.

          +

          value (float) – Limit of travel in the negative direction.

          Raises:
          -

          ValueError – When motor in motion or position outside of limit.

          +

          ValueError – When motor in motion or position outside of limit.

          @@ -831,7 +827,7 @@

          pcdsdevices.epics_motor.MMC100
          -status() str
          +status() str

          Returns a str with the current pv values for the device.

          @@ -848,7 +844,7 @@

          pcdsdevices.epics_motor.MMC100
          -trigger() StatusBase
          +trigger() StatusBase

          Trigger the device and return status object.

          This method is responsible for implementing ‘trigger’ or ‘acquire’ functionality of this device.

          @@ -856,14 +852,14 @@

          pcdsdevices.epics_motor.MMC100read() method) then this method is also responsible for arranging that the -StatusBase object returned by this method +StatusBase object returned by this method is notified when the device is ready to be read.

          If there is no delay between triggering and being readable, -then this method must return a StatusBase +then this method must return a StatusBase object which is already completed.

          Returns:
          -

          status (StatusBase) – StatusBase object which will be marked +

          status (StatusBase) – StatusBase object which will be marked as complete when the device is ready to be read.

          @@ -878,7 +874,7 @@

          pcdsdevices.epics_motor.MMC100
          Parameters:
          -

          scale (float) – starting step size, default = 0.1

          +

          scale (float) – starting step size, default = 0.1

          @@ -890,12 +886,12 @@

          pcdsdevices.epics_motor.MMC100
          Parameters:
            -
          • position (float) – Desired end position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • position (float) – Desired end position.

          • +
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • -
          • newline (bool, optional) – If True, inserts a newline after the updates.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • newline (bool, optional) – If True, inserts a newline after the updates.

          @@ -908,12 +904,12 @@

          pcdsdevices.epics_motor.MMC100
          Parameters:
            -
          • delta (float) – Desired change in position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • delta (float) – Desired change in position.

          • +
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • -
          • newline (bool, optional) – If True, inserts a newline after the updates.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • newline (bool, optional) – If True, inserts a newline after the updates.

          @@ -1033,7 +1029,7 @@

          pcdsdevices.epics_motor.MMC100
          -subscriptions: ClassVar[FrozenSet[str]] = frozenset({'_req_done', 'acq_done', 'done_moving', 'readback', 'start_moving'})
          +subscriptions: ClassVar[FrozenSet[str]] = frozenset({'_req_done', 'acq_done', 'done_moving', 'readback', 'start_moving'})
          diff --git a/master/generated/pcdsdevices.epics_motor.Motor.html b/master/generated/pcdsdevices.epics_motor.Motor.html index ca4b3ecb751..073566bf90d 100644 --- a/master/generated/pcdsdevices.epics_motor.Motor.html +++ b/master/generated/pcdsdevices.epics_motor.Motor.html @@ -1,25 +1,23 @@ + + - pcdsdevices.epics_motor.Motor — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.epics_motor.Motor — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -
          - 8.5.1.dev30+gd6e98430 -
          @@ -109,6 +104,7 @@
        • pcdsdevices.ipm
        • pcdsdevices.jet
        • pcdsdevices.keithley
        • +
        • pcdsdevices.lakeshore
        • pcdsdevices.lamp_motion
        • pcdsdevices.lasers.btps
        • pcdsdevices.lasers.counters
        • @@ -268,7 +264,7 @@

          pcdsdevices.epics_motor.Motor
          Parameters:
            -
          • prefix (str) – Prefix of motor.

          • +
          • prefix (str) – Prefix of motor.

          • kwargs – Passed to class constructor.

          diff --git a/master/generated/pcdsdevices.epics_motor.Newport.html b/master/generated/pcdsdevices.epics_motor.Newport.html index 1826a296fb4..a6283b7394c 100644 --- a/master/generated/pcdsdevices.epics_motor.Newport.html +++ b/master/generated/pcdsdevices.epics_motor.Newport.html @@ -1,25 +1,23 @@ + + - pcdsdevices.epics_motor.Newport — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.epics_motor.Newport — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -
          - 8.5.1.dev30+gd6e98430 -
          @@ -109,6 +104,7 @@
        • pcdsdevices.ipm
        • pcdsdevices.jet
        • pcdsdevices.keithley
        • +
        • pcdsdevices.lakeshore
        • pcdsdevices.lamp_motion
        • pcdsdevices.lasers.btps
        • pcdsdevices.lasers.counters
        • @@ -227,10 +223,10 @@

          pcdsdevices.epics_motor.Newport
          Parameters:
            -
          • prefix (str) – The EPICS PV prefix for this motor.

          • -
          • name (str) – An identifying name for this motor.

          • -
          • settle_time (float, optional) – The amount of extra time to wait before interpreting a move as done.

          • -
          • timeout (float, optional) – The amount of time to wait before automatically marking a long +

          • prefix (str) – The EPICS PV prefix for this motor.

          • +
          • name (str) – An identifying name for this motor.

          • +
          • settle_time (float, optional) – The amount of extra time to wait before interpreting a move as done.

          • +
          • timeout (float, optional) – The amount of time to wait before automatically marking a long in-progress move as failed.

          @@ -499,14 +495,14 @@

          pcdsdevices.epics_motor.Newport
          -configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]
          +configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]

          Configure the device for something during a run

          This default implementation allows the user to change any of the configuration_attrs. Subclasses might override this to perform additional input validation, cleanup, etc.

          Parameters:
          -

          d (dict) – The configuration dictionary. To specify the order that +

          d (dict) – The configuration dictionary. To specify the order that the changes should be made, use an OrderedDict.

          Returns:
          @@ -521,7 +517,7 @@

          pcdsdevices.epics_motor.Newport
          -describe() OrderedDictType[str, Dict[str, Any]]
          +describe() OrderedDictType[str, Dict[str, Any]]

          Provide schema and meta-data for read().

          This keys in the OrderedDict this method returns must match the keys in the OrderedDict return by read().

          @@ -583,8 +579,8 @@

          pcdsdevices.epics_motor.Newport
          Parameters:
            -
          • high (float) – Limit of travel in the positive direction.

          • -
          • low (float) – Limit of travel in the negative direction.

          • +
          • high (float) – Limit of travel in the positive direction.

          • +
          • low (float) – Limit of travel in the negative direction.

          @@ -609,7 +605,7 @@

          pcdsdevices.epics_motor.Newport
          -move(position: float, wait: bool = True, **kwargs) MoveStatus
          +move(position: float, wait: bool = True, **kwargs) MoveStatus

          Move to a specified position, optionally waiting for motion to complete.

          @@ -619,7 +615,7 @@

          pcdsdevices.epics_motor.Newportfloat, optional) – Maximum time to wait for the motion. If None, the default timeout +
        • timeout (float, optional) – Maximum time to wait for the motion. If None, the default timeout for this positioner is used.

        • @@ -628,9 +624,9 @@

          pcdsdevices.epics_motor.NewportRaises:

          @@ -644,12 +640,12 @@

          pcdsdevices.epics_motor.NewportParameters:
          • position – Desired end position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • wait (bool, optional) – If True, wait for motion completion before returning. +

          • wait (bool, optional) – If True, wait for motion completion before returning. Defaults to False.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          @@ -671,13 +667,13 @@

          pcdsdevices.epics_motor.Newport
          Parameters:
            -
          • delta (float) – Desired change in position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • delta (float) – Desired change in position.

          • +
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • wait (bool, optional) – If True, wait for motion completion before returning. +

          • wait (bool, optional) – If True, wait for motion completion before returning. Defaults to False.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          @@ -691,7 +687,7 @@

          pcdsdevices.epics_motor.Newport
          -read() OrderedDictType[str, Dict[str, Any]]
          +read() OrderedDictType[str, Dict[str, Any]]

          Read data from the device.

          This method is expected to be as instantaneous as possible, with any substantial acquisition time taken care of in @@ -714,7 +710,7 @@

          pcdsdevices.epics_motor.Newport
          -read_configuration() OrderedDictType[str, Dict[str, Any]]
          +read_configuration() OrderedDictType[str, Dict[str, Any]]

          Dictionary mapping names to value dicts with keys: value, timestamp

          To control which fields are included, change the Component kinds on the device, or modify the configuration_attrs list.

          @@ -728,23 +724,23 @@

          pcdsdevices.epics_motor.Newport
          -set(new_position: Any, *, timeout: float | None = None, moved_cb: Callable | None = None, wait: bool = False) StatusBase
          +set(new_position: Any, *, timeout: float | None = None, moved_cb: Callable | None = None, wait: bool = False) StatusBase

          Set a value and return a Status object

          Parameters:
            -
          • new_position (object) – The input here is whatever the device requires (this +

          • new_position (object) – The input here is whatever the device requires (this should be over-ridden by the implementation. For example a motor would take a float, a shutter the strings {‘Open’, ‘Close’}, and a goineometer (h, k, l) tuples

          • -
          • timeout (float, optional) – Maximum time to wait for the motion. If None, the default timeout +

          • timeout (float, optional) – Maximum time to wait for the motion. If None, the default timeout for this positioner is used.

          • moved_cb (callable, optional) –

            Deprecated

            Call this callback when movement has finished. This callback must accept one keyword argument: ‘obj’ which will be set to this positioner instance.

          • -
          • wait (bool, optional) –

            Deprecated

            +
          • wait (bool, optional) –

            Deprecated

            If the method should block until the Status object reports it is done.

            Defaults to False

            @@ -773,10 +769,10 @@

            pcdsdevices.epics_motor.Newport
            Parameters:
            -

            value (float) – High limit value to be set.

            +

            value (float) – High limit value to be set.

            Raises:
            -

            ValueError – When motor in motion or position outside of limit.

            +

            ValueError – When motor in motion or position outside of limit.

          @@ -794,8 +790,8 @@

          pcdsdevices.epics_motor.Newport
          Parameters:
            -
          • high (float) – Limit of travel in the positive direction.

          • -
          • low (float) – Limit of travel in the negative direction.

          • +
          • high (float) – Limit of travel in the positive direction.

          • +
          • low (float) – Limit of travel in the negative direction.

          @@ -807,10 +803,10 @@

          pcdsdevices.epics_motor.Newport
          Parameters:
          -

          value (float) – Limit of travel in the negative direction.

          +

          value (float) – Limit of travel in the negative direction.

          Raises:
          -

          ValueError – When motor in motion or position outside of limit.

          +

          ValueError – When motor in motion or position outside of limit.

          @@ -845,7 +841,7 @@

          pcdsdevices.epics_motor.Newport
          -status() str
          +status() str

          Returns a str with the current pv values for the device.

          @@ -862,7 +858,7 @@

          pcdsdevices.epics_motor.Newport
          -trigger() StatusBase
          +trigger() StatusBase

          Trigger the device and return status object.

          This method is responsible for implementing ‘trigger’ or ‘acquire’ functionality of this device.

          @@ -870,14 +866,14 @@

          pcdsdevices.epics_motor.Newportread() method) then this method is also responsible for arranging that the -StatusBase object returned by this method +StatusBase object returned by this method is notified when the device is ready to be read.

          If there is no delay between triggering and being readable, -then this method must return a StatusBase +then this method must return a StatusBase object which is already completed.

          Returns:
          -

          status (StatusBase) – StatusBase object which will be marked +

          status (StatusBase) – StatusBase object which will be marked as complete when the device is ready to be read.

          @@ -892,7 +888,7 @@

          pcdsdevices.epics_motor.Newport
          Parameters:
          -

          scale (float) – starting step size, default = 0.1

          +

          scale (float) – starting step size, default = 0.1

          @@ -904,12 +900,12 @@

          pcdsdevices.epics_motor.Newport
          Parameters:
            -
          • position (float) – Desired end position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • position (float) – Desired end position.

          • +
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • -
          • newline (bool, optional) – If True, inserts a newline after the updates.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • newline (bool, optional) – If True, inserts a newline after the updates.

          @@ -922,12 +918,12 @@

          pcdsdevices.epics_motor.Newport
          Parameters:
            -
          • delta (float) – Desired change in position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • delta (float) – Desired change in position.

          • +
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • -
          • newline (bool, optional) – If True, inserts a newline after the updates.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • newline (bool, optional) – If True, inserts a newline after the updates.

          @@ -1047,7 +1043,7 @@

          pcdsdevices.epics_motor.Newport
          -subscriptions: ClassVar[FrozenSet[str]] = frozenset({'_req_done', 'acq_done', 'done_moving', 'readback', 'start_moving'})
          +subscriptions: ClassVar[FrozenSet[str]] = frozenset({'_req_done', 'acq_done', 'done_moving', 'readback', 'start_moving'})
          diff --git a/master/generated/pcdsdevices.epics_motor.OffsetIMSWithPreset.html b/master/generated/pcdsdevices.epics_motor.OffsetIMSWithPreset.html index 8bf39d216a9..de3f7860af9 100644 --- a/master/generated/pcdsdevices.epics_motor.OffsetIMSWithPreset.html +++ b/master/generated/pcdsdevices.epics_motor.OffsetIMSWithPreset.html @@ -1,25 +1,23 @@ + + - pcdsdevices.epics_motor.OffsetIMSWithPreset — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.epics_motor.OffsetIMSWithPreset — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -
          - 8.5.1.dev30+gd6e98430 -
          @@ -109,6 +104,7 @@
        • pcdsdevices.ipm
        • pcdsdevices.jet
        • pcdsdevices.keithley
        • +
        • pcdsdevices.lakeshore
        • pcdsdevices.lamp_motion
        • pcdsdevices.lasers.btps
        • pcdsdevices.lasers.counters
        • @@ -283,14 +279,14 @@

          pcdsdevices.epics_motor.OffsetIMSWithPreset
          -configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]
          +configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]

          Configure the device for something during a run

          This default implementation allows the user to change any of the configuration_attrs. Subclasses might override this to perform additional input validation, cleanup, etc.

          Parameters:
          -

          d (dict) – The configuration dictionary. To specify the order that +

          d (dict) – The configuration dictionary. To specify the order that the changes should be made, use an OrderedDict.

          Returns:
          @@ -305,7 +301,7 @@

          pcdsdevices.epics_motor.OffsetIMSWithPreset
          -describe() OrderedDictType[str, Dict[str, Any]]
          +describe() OrderedDictType[str, Dict[str, Any]]

          Provide schema and meta-data for read().

          This keys in the OrderedDict this method returns must match the keys in the OrderedDict return by read().

          @@ -328,7 +324,7 @@

          pcdsdevices.epics_motor.OffsetIMSWithPreset
          -forward(pseudo_pos: tuple) tuple
          +forward(pseudo_pos: tuple) tuple

          Calculate a RealPosition from a given PseudoPosition.

          Parameters:
          @@ -350,7 +346,7 @@

          pcdsdevices.epics_motor.OffsetIMSWithPreset
          -inverse(real_pos: tuple) tuple
          +inverse(real_pos: tuple) tuple

          Calculate a PseudoPosition from a given RealPosition.

          Parameters:
          @@ -374,7 +370,7 @@

          pcdsdevices.epics_motor.OffsetIMSWithPresetfloat, optional) – Maximum time to wait for the motion. If None, the default timeout +
        • timeout (float, optional) – Maximum time to wait for the motion. If None, the default timeout for this positioner is used.

        • @@ -383,9 +379,9 @@

          pcdsdevices.epics_motor.OffsetIMSWithPresetRaises:

          @@ -402,8 +398,8 @@

          pcdsdevices.epics_motor.OffsetIMSWithPresetParameters:

          @@ -417,12 +413,12 @@

          pcdsdevices.epics_motor.OffsetIMSWithPresetParameters:
          • position – Desired end position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • wait (bool, optional) – If True, wait for motion completion before returning. +

          • wait (bool, optional) – If True, wait for motion completion before returning. Defaults to False.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          @@ -444,13 +440,13 @@

          pcdsdevices.epics_motor.OffsetIMSWithPreset
          Parameters:
            -
          • delta (float) – Desired change in position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • delta (float) – Desired change in position.

          • +
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • wait (bool, optional) – If True, wait for motion completion before returning. +

          • wait (bool, optional) – If True, wait for motion completion before returning. Defaults to False.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          @@ -464,7 +460,7 @@

          pcdsdevices.epics_motor.OffsetIMSWithPreset
          -read() OrderedDictType[str, Dict[str, Any]]
          +read() OrderedDictType[str, Dict[str, Any]]

          Read data from the device.

          This method is expected to be as instantaneous as possible, with any substantial acquisition time taken care of in @@ -487,7 +483,7 @@

          pcdsdevices.epics_motor.OffsetIMSWithPreset
          -read_configuration() OrderedDictType[str, Dict[str, Any]]
          +read_configuration() OrderedDictType[str, Dict[str, Any]]

          Dictionary mapping names to value dicts with keys: value, timestamp

          To control which fields are included, change the Component kinds on the device, or modify the configuration_attrs list.

          @@ -538,7 +534,7 @@

          pcdsdevices.epics_motor.OffsetIMSWithPreset
          -status() str
          +status() str

          Returns a str with the current pv values for the device.

          @@ -567,7 +563,7 @@

          pcdsdevices.epics_motor.OffsetIMSWithPreset
          -trigger() StatusBase
          +trigger() StatusBase

          Trigger the device and return status object.

          This method is responsible for implementing ‘trigger’ or ‘acquire’ functionality of this device.

          @@ -575,14 +571,14 @@

          pcdsdevices.epics_motor.OffsetIMSWithPresetread() method) then this method is also responsible for arranging that the -StatusBase object returned by this method +StatusBase object returned by this method is notified when the device is ready to be read.

          If there is no delay between triggering and being readable, -then this method must return a StatusBase +then this method must return a StatusBase object which is already completed.

          Returns:
          -

          status (StatusBase) – StatusBase object which will be marked +

          status (StatusBase) – StatusBase object which will be marked as complete when the device is ready to be read.

          @@ -597,7 +593,7 @@

          pcdsdevices.epics_motor.OffsetIMSWithPreset
          Parameters:
          -

          scale (float) – starting step size, default = 0.1

          +

          scale (float) – starting step size, default = 0.1

          @@ -609,12 +605,12 @@

          pcdsdevices.epics_motor.OffsetIMSWithPreset
          Parameters:
            -
          • position (float) – Desired end position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • position (float) – Desired end position.

          • +
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • -
          • newline (bool, optional) – If True, inserts a newline after the updates.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • newline (bool, optional) – If True, inserts a newline after the updates.

          @@ -627,12 +623,12 @@

          pcdsdevices.epics_motor.OffsetIMSWithPreset
          Parameters:
            -
          • delta (float) – Desired change in position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • delta (float) – Desired change in position.

          • +
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • -
          • newline (bool, optional) – If True, inserts a newline after the updates.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • newline (bool, optional) – If True, inserts a newline after the updates.

          @@ -771,7 +767,7 @@

          pcdsdevices.epics_motor.OffsetIMSWithPreset
          -subscriptions: ClassVar[FrozenSet[str]] = frozenset({'_req_done', 'acq_done', 'done_moving', 'readback', 'start_moving'})
          +subscriptions: ClassVar[FrozenSet[str]] = frozenset({'_req_done', 'acq_done', 'done_moving', 'readback', 'start_moving'})
          diff --git a/master/generated/pcdsdevices.epics_motor.OffsetMotor.html b/master/generated/pcdsdevices.epics_motor.OffsetMotor.html index 7c43c62f353..135962a975a 100644 --- a/master/generated/pcdsdevices.epics_motor.OffsetMotor.html +++ b/master/generated/pcdsdevices.epics_motor.OffsetMotor.html @@ -1,25 +1,23 @@ + + - pcdsdevices.epics_motor.OffsetMotor — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.epics_motor.OffsetMotor — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -
          - 8.5.1.dev30+gd6e98430 -
          @@ -109,6 +104,7 @@
        • pcdsdevices.ipm
        • pcdsdevices.jet
        • pcdsdevices.keithley
        • +
        • pcdsdevices.lakeshore
        • pcdsdevices.lamp_motion
        • pcdsdevices.lasers.btps
        • pcdsdevices.lasers.counters
        • @@ -274,14 +270,14 @@

          pcdsdevices.epics_motor.OffsetMotor
          -configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]
          +configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]

          Configure the device for something during a run

          This default implementation allows the user to change any of the configuration_attrs. Subclasses might override this to perform additional input validation, cleanup, etc.

          Parameters:
          -

          d (dict) – The configuration dictionary. To specify the order that +

          d (dict) – The configuration dictionary. To specify the order that the changes should be made, use an OrderedDict.

          Returns:
          @@ -296,7 +292,7 @@

          pcdsdevices.epics_motor.OffsetMotor
          -describe() OrderedDictType[str, Dict[str, Any]]
          +describe() OrderedDictType[str, Dict[str, Any]]

          Provide schema and meta-data for read().

          This keys in the OrderedDict this method returns must match the keys in the OrderedDict return by read().

          @@ -319,7 +315,7 @@

          pcdsdevices.epics_motor.OffsetMotor
          -forward(pseudo_pos: tuple) tuple
          +forward(pseudo_pos: tuple) tuple

          Calculate a RealPosition from a given PseudoPosition.

          Parameters:
          @@ -341,7 +337,7 @@

          pcdsdevices.epics_motor.OffsetMotor
          -inverse(real_pos: tuple) tuple
          +inverse(real_pos: tuple) tuple

          Calculate a PseudoPosition from a given RealPosition.

          Parameters:
          @@ -365,7 +361,7 @@

          pcdsdevices.epics_motor.OffsetMotorfloat, optional) – Maximum time to wait for the motion. If None, the default timeout +
        • timeout (float, optional) – Maximum time to wait for the motion. If None, the default timeout for this positioner is used.

        • @@ -374,9 +370,9 @@

          pcdsdevices.epics_motor.OffsetMotorRaises:

          @@ -393,8 +389,8 @@

          pcdsdevices.epics_motor.OffsetMotorParameters:

          @@ -408,12 +404,12 @@

          pcdsdevices.epics_motor.OffsetMotorParameters:
          • position – Desired end position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • wait (bool, optional) – If True, wait for motion completion before returning. +

          • wait (bool, optional) – If True, wait for motion completion before returning. Defaults to False.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          @@ -435,13 +431,13 @@

          pcdsdevices.epics_motor.OffsetMotor
          Parameters:
            -
          • delta (float) – Desired change in position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • delta (float) – Desired change in position.

          • +
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • wait (bool, optional) – If True, wait for motion completion before returning. +

          • wait (bool, optional) – If True, wait for motion completion before returning. Defaults to False.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          @@ -455,7 +451,7 @@

          pcdsdevices.epics_motor.OffsetMotor
          -read() OrderedDictType[str, Dict[str, Any]]
          +read() OrderedDictType[str, Dict[str, Any]]

          Read data from the device.

          This method is expected to be as instantaneous as possible, with any substantial acquisition time taken care of in @@ -478,7 +474,7 @@

          pcdsdevices.epics_motor.OffsetMotor
          -read_configuration() OrderedDictType[str, Dict[str, Any]]
          +read_configuration() OrderedDictType[str, Dict[str, Any]]

          Dictionary mapping names to value dicts with keys: value, timestamp

          To control which fields are included, change the Component kinds on the device, or modify the configuration_attrs list.

          @@ -527,7 +523,7 @@

          pcdsdevices.epics_motor.OffsetMotor
          -status() str
          +status() str

          Returns a str with the current pv values for the device.

          @@ -556,7 +552,7 @@

          pcdsdevices.epics_motor.OffsetMotor
          -trigger() StatusBase
          +trigger() StatusBase

          Trigger the device and return status object.

          This method is responsible for implementing ‘trigger’ or ‘acquire’ functionality of this device.

          @@ -564,14 +560,14 @@

          pcdsdevices.epics_motor.OffsetMotorread() method) then this method is also responsible for arranging that the -StatusBase object returned by this method +StatusBase object returned by this method is notified when the device is ready to be read.

          If there is no delay between triggering and being readable, -then this method must return a StatusBase +then this method must return a StatusBase object which is already completed.

          Returns:
          -

          status (StatusBase) – StatusBase object which will be marked +

          status (StatusBase) – StatusBase object which will be marked as complete when the device is ready to be read.

          @@ -586,7 +582,7 @@

          pcdsdevices.epics_motor.OffsetMotor
          Parameters:
          -

          scale (float) – starting step size, default = 0.1

          +

          scale (float) – starting step size, default = 0.1

          @@ -598,12 +594,12 @@

          pcdsdevices.epics_motor.OffsetMotor
          Parameters:
            -
          • position (float) – Desired end position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • position (float) – Desired end position.

          • +
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • -
          • newline (bool, optional) – If True, inserts a newline after the updates.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • newline (bool, optional) – If True, inserts a newline after the updates.

          @@ -616,12 +612,12 @@

          pcdsdevices.epics_motor.OffsetMotor
          Parameters:
            -
          • delta (float) – Desired change in position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • delta (float) – Desired change in position.

          • +
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • -
          • newline (bool, optional) – If True, inserts a newline after the updates.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • newline (bool, optional) – If True, inserts a newline after the updates.

          @@ -760,7 +756,7 @@

          pcdsdevices.epics_motor.OffsetMotor
          -subscriptions: ClassVar[FrozenSet[str]] = frozenset({'_req_done', 'acq_done', 'done_moving', 'readback', 'start_moving'})
          +subscriptions: ClassVar[FrozenSet[str]] = frozenset({'_req_done', 'acq_done', 'done_moving', 'readback', 'start_moving'})
          diff --git a/master/generated/pcdsdevices.epics_motor.PCDSMotorBase.html b/master/generated/pcdsdevices.epics_motor.PCDSMotorBase.html index 9c5f8197dc2..baf1eaf33e2 100644 --- a/master/generated/pcdsdevices.epics_motor.PCDSMotorBase.html +++ b/master/generated/pcdsdevices.epics_motor.PCDSMotorBase.html @@ -1,25 +1,23 @@ + + - pcdsdevices.epics_motor.PCDSMotorBase — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.epics_motor.PCDSMotorBase — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -
          - 8.5.1.dev30+gd6e98430 -
          @@ -109,6 +104,7 @@
        • pcdsdevices.ipm
        • pcdsdevices.jet
        • pcdsdevices.keithley
        • +
        • pcdsdevices.lakeshore
        • pcdsdevices.lamp_motion
        • pcdsdevices.lasers.btps
        • pcdsdevices.lasers.counters
        • @@ -494,14 +490,14 @@

          pcdsdevices.epics_motor.PCDSMotorBase
          -configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]
          +configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]

          Configure the device for something during a run

          This default implementation allows the user to change any of the configuration_attrs. Subclasses might override this to perform additional input validation, cleanup, etc.

          Parameters:
          -

          d (dict) – The configuration dictionary. To specify the order that +

          d (dict) – The configuration dictionary. To specify the order that the changes should be made, use an OrderedDict.

          Returns:
          @@ -516,7 +512,7 @@

          pcdsdevices.epics_motor.PCDSMotorBase
          -describe() OrderedDictType[str, Dict[str, Any]]
          +describe() OrderedDictType[str, Dict[str, Any]]

          Provide schema and meta-data for read().

          This keys in the OrderedDict this method returns must match the keys in the OrderedDict return by read().

          @@ -578,8 +574,8 @@

          pcdsdevices.epics_motor.PCDSMotorBase
          Parameters:
            -
          • high (float) – Limit of travel in the positive direction.

          • -
          • low (float) – Limit of travel in the negative direction.

          • +
          • high (float) – Limit of travel in the positive direction.

          • +
          • low (float) – Limit of travel in the negative direction.

          @@ -604,7 +600,7 @@

          pcdsdevices.epics_motor.PCDSMotorBase
          -move(position: float, wait: bool = True, **kwargs) MoveStatus
          +move(position: float, wait: bool = True, **kwargs) MoveStatus

          Move to a specified position, optionally waiting for motion to complete.

          @@ -614,7 +610,7 @@

          pcdsdevices.epics_motor.PCDSMotorBasefloat, optional) – Maximum time to wait for the motion. If None, the default timeout +
        • timeout (float, optional) – Maximum time to wait for the motion. If None, the default timeout for this positioner is used.

        • @@ -623,9 +619,9 @@

          pcdsdevices.epics_motor.PCDSMotorBaseRaises:

          @@ -639,12 +635,12 @@

          pcdsdevices.epics_motor.PCDSMotorBaseParameters:
          • position – Desired end position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • wait (bool, optional) – If True, wait for motion completion before returning. +

          • wait (bool, optional) – If True, wait for motion completion before returning. Defaults to False.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          @@ -666,13 +662,13 @@

          pcdsdevices.epics_motor.PCDSMotorBase
          Parameters:
            -
          • delta (float) – Desired change in position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • delta (float) – Desired change in position.

          • +
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • wait (bool, optional) – If True, wait for motion completion before returning. +

          • wait (bool, optional) – If True, wait for motion completion before returning. Defaults to False.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          @@ -686,7 +682,7 @@

          pcdsdevices.epics_motor.PCDSMotorBase
          -read() OrderedDictType[str, Dict[str, Any]]
          +read() OrderedDictType[str, Dict[str, Any]]

          Read data from the device.

          This method is expected to be as instantaneous as possible, with any substantial acquisition time taken care of in @@ -709,7 +705,7 @@

          pcdsdevices.epics_motor.PCDSMotorBase
          -read_configuration() OrderedDictType[str, Dict[str, Any]]
          +read_configuration() OrderedDictType[str, Dict[str, Any]]

          Dictionary mapping names to value dicts with keys: value, timestamp

          To control which fields are included, change the Component kinds on the device, or modify the configuration_attrs list.

          @@ -723,23 +719,23 @@

          pcdsdevices.epics_motor.PCDSMotorBase
          -set(new_position: Any, *, timeout: float | None = None, moved_cb: Callable | None = None, wait: bool = False) StatusBase
          +set(new_position: Any, *, timeout: float | None = None, moved_cb: Callable | None = None, wait: bool = False) StatusBase

          Set a value and return a Status object

          Parameters:
            -
          • new_position (object) – The input here is whatever the device requires (this +

          • new_position (object) – The input here is whatever the device requires (this should be over-ridden by the implementation. For example a motor would take a float, a shutter the strings {‘Open’, ‘Close’}, and a goineometer (h, k, l) tuples

          • -
          • timeout (float, optional) – Maximum time to wait for the motion. If None, the default timeout +

          • timeout (float, optional) – Maximum time to wait for the motion. If None, the default timeout for this positioner is used.

          • moved_cb (callable, optional) –

            Deprecated

            Call this callback when movement has finished. This callback must accept one keyword argument: ‘obj’ which will be set to this positioner instance.

          • -
          • wait (bool, optional) –

            Deprecated

            +
          • wait (bool, optional) –

            Deprecated

            If the method should block until the Status object reports it is done.

            Defaults to False

            @@ -768,10 +764,10 @@

            pcdsdevices.epics_motor.PCDSMotorBase
            Parameters:
            -

            value (float) – High limit value to be set.

            +

            value (float) – High limit value to be set.

            Raises:
            -

            ValueError – When motor in motion or position outside of limit.

            +

            ValueError – When motor in motion or position outside of limit.

          @@ -789,8 +785,8 @@

          pcdsdevices.epics_motor.PCDSMotorBase
          Parameters:
            -
          • high (float) – Limit of travel in the positive direction.

          • -
          • low (float) – Limit of travel in the negative direction.

          • +
          • high (float) – Limit of travel in the positive direction.

          • +
          • low (float) – Limit of travel in the negative direction.

          @@ -802,10 +798,10 @@

          pcdsdevices.epics_motor.PCDSMotorBase
          Parameters:
          -

          value (float) – Limit of travel in the negative direction.

          +

          value (float) – Limit of travel in the negative direction.

          Raises:
          -

          ValueError – When motor in motion or position outside of limit.

          +

          ValueError – When motor in motion or position outside of limit.

          @@ -840,7 +836,7 @@

          pcdsdevices.epics_motor.PCDSMotorBase
          -status() str
          +status() str

          Returns a str with the current pv values for the device.

          @@ -857,7 +853,7 @@

          pcdsdevices.epics_motor.PCDSMotorBase
          -trigger() StatusBase
          +trigger() StatusBase

          Trigger the device and return status object.

          This method is responsible for implementing ‘trigger’ or ‘acquire’ functionality of this device.

          @@ -865,14 +861,14 @@

          pcdsdevices.epics_motor.PCDSMotorBaseread() method) then this method is also responsible for arranging that the -StatusBase object returned by this method +StatusBase object returned by this method is notified when the device is ready to be read.

          If there is no delay between triggering and being readable, -then this method must return a StatusBase +then this method must return a StatusBase object which is already completed.

          Returns:
          -

          status (StatusBase) – StatusBase object which will be marked +

          status (StatusBase) – StatusBase object which will be marked as complete when the device is ready to be read.

          @@ -887,7 +883,7 @@

          pcdsdevices.epics_motor.PCDSMotorBase
          Parameters:
          -

          scale (float) – starting step size, default = 0.1

          +

          scale (float) – starting step size, default = 0.1

          @@ -899,12 +895,12 @@

          pcdsdevices.epics_motor.PCDSMotorBase
          Parameters:
            -
          • position (float) – Desired end position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • position (float) – Desired end position.

          • +
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • -
          • newline (bool, optional) – If True, inserts a newline after the updates.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • newline (bool, optional) – If True, inserts a newline after the updates.

          @@ -917,12 +913,12 @@

          pcdsdevices.epics_motor.PCDSMotorBase
          Parameters:
            -
          • delta (float) – Desired change in position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • delta (float) – Desired change in position.

          • +
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • -
          • newline (bool, optional) – If True, inserts a newline after the updates.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • newline (bool, optional) – If True, inserts a newline after the updates.

          @@ -1042,7 +1038,7 @@

          pcdsdevices.epics_motor.PCDSMotorBase
          -subscriptions: ClassVar[FrozenSet[str]] = frozenset({'_req_done', 'acq_done', 'done_moving', 'readback', 'start_moving'})
          +subscriptions: ClassVar[FrozenSet[str]] = frozenset({'_req_done', 'acq_done', 'done_moving', 'readback', 'start_moving'})
          diff --git a/master/generated/pcdsdevices.epics_motor.PI_M824.html b/master/generated/pcdsdevices.epics_motor.PI_M824.html index 1496287ec15..cebd0e1f45b 100644 --- a/master/generated/pcdsdevices.epics_motor.PI_M824.html +++ b/master/generated/pcdsdevices.epics_motor.PI_M824.html @@ -1,25 +1,23 @@ + + - pcdsdevices.epics_motor.PI_M824 — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.epics_motor.PI_M824 — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -
          - 8.5.1.dev30+gd6e98430 -
          @@ -109,6 +104,7 @@
        • pcdsdevices.ipm
        • pcdsdevices.jet
        • pcdsdevices.keithley
        • +
        • pcdsdevices.lakeshore
        • pcdsdevices.lamp_motion
        • pcdsdevices.lasers.btps
        • pcdsdevices.lasers.counters
        • @@ -269,14 +265,14 @@

          pcdsdevices.epics_motor.PI_M824
          -configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]
          +configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]

          Configure the device for something during a run

          This default implementation allows the user to change any of the configuration_attrs. Subclasses might override this to perform additional input validation, cleanup, etc.

          Parameters:
          -

          d (dict) – The configuration dictionary. To specify the order that +

          d (dict) – The configuration dictionary. To specify the order that the changes should be made, use an OrderedDict.

          Returns:
          @@ -291,7 +287,7 @@

          pcdsdevices.epics_motor.PI_M824
          -describe() OrderedDictType[str, Dict[str, Any]]
          +describe() OrderedDictType[str, Dict[str, Any]]

          Provide schema and meta-data for read().

          This keys in the OrderedDict this method returns must match the keys in the OrderedDict return by read().

          @@ -338,7 +334,7 @@

          pcdsdevices.epics_motor.PI_M824float, optional) – Maximum time to wait for the motion. If None, the default timeout +
        • timeout (float, optional) – Maximum time to wait for the motion. If None, the default timeout for this positioner is used.

        • @@ -347,9 +343,9 @@

          pcdsdevices.epics_motor.PI_M824Raises:

          @@ -363,12 +359,12 @@

          pcdsdevices.epics_motor.PI_M824Parameters:
          • position – Desired end position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • wait (bool, optional) – If True, wait for motion completion before returning. +

          • wait (bool, optional) – If True, wait for motion completion before returning. Defaults to False.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          @@ -390,13 +386,13 @@

          pcdsdevices.epics_motor.PI_M824
          Parameters:
            -
          • delta (float) – Desired change in position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • delta (float) – Desired change in position.

          • +
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • wait (bool, optional) – If True, wait for motion completion before returning. +

          • wait (bool, optional) – If True, wait for motion completion before returning. Defaults to False.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          @@ -410,7 +406,7 @@

          pcdsdevices.epics_motor.PI_M824
          -read() OrderedDictType[str, Dict[str, Any]]
          +read() OrderedDictType[str, Dict[str, Any]]

          Read data from the device.

          This method is expected to be as instantaneous as possible, with any substantial acquisition time taken care of in @@ -433,7 +429,7 @@

          pcdsdevices.epics_motor.PI_M824
          -read_configuration() OrderedDictType[str, Dict[str, Any]]
          +read_configuration() OrderedDictType[str, Dict[str, Any]]

          Dictionary mapping names to value dicts with keys: value, timestamp

          To control which fields are included, change the Component kinds on the device, or modify the configuration_attrs list.

          @@ -449,23 +445,23 @@

          pcdsdevices.epics_motor.PI_M824
          -set(new_position: Any, *, timeout: float | None = None, moved_cb: Callable | None = None, wait: bool = False) StatusBase
          +set(new_position: Any, *, timeout: float | None = None, moved_cb: Callable | None = None, wait: bool = False) StatusBase

          Set a value and return a Status object

          Parameters:
            -
          • new_position (object) – The input here is whatever the device requires (this +

          • new_position (object) – The input here is whatever the device requires (this should be over-ridden by the implementation. For example a motor would take a float, a shutter the strings {‘Open’, ‘Close’}, and a goineometer (h, k, l) tuples

          • -
          • timeout (float, optional) – Maximum time to wait for the motion. If None, the default timeout +

          • timeout (float, optional) – Maximum time to wait for the motion. If None, the default timeout for this positioner is used.

          • moved_cb (callable, optional) –

            Deprecated

            Call this callback when movement has finished. This callback must accept one keyword argument: ‘obj’ which will be set to this positioner instance.

          • -
          • wait (bool, optional) –

            Deprecated

            +
          • wait (bool, optional) –

            Deprecated

            If the method should block until the Status object reports it is done.

            Defaults to False

            @@ -487,7 +483,7 @@

            pcdsdevices.epics_motor.PI_M824
            -status() str
            +status() str

            Returns a str with the current pv values for the device.

          @@ -504,7 +500,7 @@

          pcdsdevices.epics_motor.PI_M824
          -trigger() StatusBase
          +trigger() StatusBase

          Trigger the device and return status object.

          This method is responsible for implementing ‘trigger’ or ‘acquire’ functionality of this device.

          @@ -512,14 +508,14 @@

          pcdsdevices.epics_motor.PI_M824read() method) then this method is also responsible for arranging that the -StatusBase object returned by this method +StatusBase object returned by this method is notified when the device is ready to be read.

          If there is no delay between triggering and being readable, -then this method must return a StatusBase +then this method must return a StatusBase object which is already completed.

          Returns:
          -

          status (StatusBase) – StatusBase object which will be marked +

          status (StatusBase) – StatusBase object which will be marked as complete when the device is ready to be read.

          @@ -534,7 +530,7 @@

          pcdsdevices.epics_motor.PI_M824
          Parameters:
          -

          scale (float) – starting step size, default = 0.1

          +

          scale (float) – starting step size, default = 0.1

          @@ -546,12 +542,12 @@

          pcdsdevices.epics_motor.PI_M824
          Parameters:
            -
          • position (float) – Desired end position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • position (float) – Desired end position.

          • +
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • -
          • newline (bool, optional) – If True, inserts a newline after the updates.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • newline (bool, optional) – If True, inserts a newline after the updates.

          @@ -564,12 +560,12 @@

          pcdsdevices.epics_motor.PI_M824
          Parameters:
            -
          • delta (float) – Desired change in position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • delta (float) – Desired change in position.

          • +
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • -
          • newline (bool, optional) – If True, inserts a newline after the updates.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • newline (bool, optional) – If True, inserts a newline after the updates.

          @@ -711,7 +707,7 @@

          pcdsdevices.epics_motor.PI_M824
          -subscriptions: ClassVar[FrozenSet[str]] = frozenset({'_req_done', 'acq_done', 'done_moving', 'readback', 'start_moving'})
          +subscriptions: ClassVar[FrozenSet[str]] = frozenset({'_req_done', 'acq_done', 'done_moving', 'readback', 'start_moving'})
          diff --git a/master/generated/pcdsdevices.epics_motor.PMC100.html b/master/generated/pcdsdevices.epics_motor.PMC100.html index 153bd13f519..b871e68aa08 100644 --- a/master/generated/pcdsdevices.epics_motor.PMC100.html +++ b/master/generated/pcdsdevices.epics_motor.PMC100.html @@ -1,25 +1,23 @@ + + - pcdsdevices.epics_motor.PMC100 — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.epics_motor.PMC100 — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -
          - 8.5.1.dev30+gd6e98430 -
          @@ -109,6 +104,7 @@
        • pcdsdevices.ipm
        • pcdsdevices.jet
        • pcdsdevices.keithley
        • +
        • pcdsdevices.lakeshore
        • pcdsdevices.lamp_motion
        • pcdsdevices.lasers.btps
        • pcdsdevices.lasers.counters
        • @@ -226,10 +222,10 @@

          pcdsdevices.epics_motor.PMC100
          Parameters:
            -
          • prefix (str) – The EPICS PV prefix for this motor.

          • -
          • name (str) – An identifying name for this motor.

          • -
          • settle_time (float, optional) – The amount of extra time to wait before interpreting a move as done.

          • -
          • timeout (float, optional) – The amount of time to wait before automatically marking a long +

          • prefix (str) – The EPICS PV prefix for this motor.

          • +
          • name (str) – An identifying name for this motor.

          • +
          • settle_time (float, optional) – The amount of extra time to wait before interpreting a move as done.

          • +
          • timeout (float, optional) – The amount of time to wait before automatically marking a long in-progress move as failed.

          @@ -485,14 +481,14 @@

          pcdsdevices.epics_motor.PMC100
          -configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]
          +configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]

          Configure the device for something during a run

          This default implementation allows the user to change any of the configuration_attrs. Subclasses might override this to perform additional input validation, cleanup, etc.

          Parameters:
          -

          d (dict) – The configuration dictionary. To specify the order that +

          d (dict) – The configuration dictionary. To specify the order that the changes should be made, use an OrderedDict.

          Returns:
          @@ -507,7 +503,7 @@

          pcdsdevices.epics_motor.PMC100
          -describe() OrderedDictType[str, Dict[str, Any]]
          +describe() OrderedDictType[str, Dict[str, Any]]

          Provide schema and meta-data for read().

          This keys in the OrderedDict this method returns must match the keys in the OrderedDict return by read().

          @@ -569,8 +565,8 @@

          pcdsdevices.epics_motor.PMC100
          Parameters:
            -
          • high (float) – Limit of travel in the positive direction.

          • -
          • low (float) – Limit of travel in the negative direction.

          • +
          • high (float) – Limit of travel in the positive direction.

          • +
          • low (float) – Limit of travel in the negative direction.

          @@ -595,7 +591,7 @@

          pcdsdevices.epics_motor.PMC100
          -move(position: float, wait: bool = True, **kwargs) MoveStatus
          +move(position: float, wait: bool = True, **kwargs) MoveStatus

          Move to a specified position, optionally waiting for motion to complete.

          @@ -605,7 +601,7 @@

          pcdsdevices.epics_motor.PMC100float, optional) – Maximum time to wait for the motion. If None, the default timeout +
        • timeout (float, optional) – Maximum time to wait for the motion. If None, the default timeout for this positioner is used.

        • @@ -614,9 +610,9 @@

          pcdsdevices.epics_motor.PMC100Raises:

          @@ -630,12 +626,12 @@

          pcdsdevices.epics_motor.PMC100Parameters:
          • position – Desired end position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • wait (bool, optional) – If True, wait for motion completion before returning. +

          • wait (bool, optional) – If True, wait for motion completion before returning. Defaults to False.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          @@ -657,13 +653,13 @@

          pcdsdevices.epics_motor.PMC100
          Parameters:
            -
          • delta (float) – Desired change in position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • delta (float) – Desired change in position.

          • +
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • wait (bool, optional) – If True, wait for motion completion before returning. +

          • wait (bool, optional) – If True, wait for motion completion before returning. Defaults to False.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          @@ -677,7 +673,7 @@

          pcdsdevices.epics_motor.PMC100
          -read() OrderedDictType[str, Dict[str, Any]]
          +read() OrderedDictType[str, Dict[str, Any]]

          Read data from the device.

          This method is expected to be as instantaneous as possible, with any substantial acquisition time taken care of in @@ -700,7 +696,7 @@

          pcdsdevices.epics_motor.PMC100
          -read_configuration() OrderedDictType[str, Dict[str, Any]]
          +read_configuration() OrderedDictType[str, Dict[str, Any]]

          Dictionary mapping names to value dicts with keys: value, timestamp

          To control which fields are included, change the Component kinds on the device, or modify the configuration_attrs list.

          @@ -714,23 +710,23 @@

          pcdsdevices.epics_motor.PMC100
          -set(new_position: Any, *, timeout: float | None = None, moved_cb: Callable | None = None, wait: bool = False) StatusBase
          +set(new_position: Any, *, timeout: float | None = None, moved_cb: Callable | None = None, wait: bool = False) StatusBase

          Set a value and return a Status object

          Parameters:
            -
          • new_position (object) – The input here is whatever the device requires (this +

          • new_position (object) – The input here is whatever the device requires (this should be over-ridden by the implementation. For example a motor would take a float, a shutter the strings {‘Open’, ‘Close’}, and a goineometer (h, k, l) tuples

          • -
          • timeout (float, optional) – Maximum time to wait for the motion. If None, the default timeout +

          • timeout (float, optional) – Maximum time to wait for the motion. If None, the default timeout for this positioner is used.

          • moved_cb (callable, optional) –

            Deprecated

            Call this callback when movement has finished. This callback must accept one keyword argument: ‘obj’ which will be set to this positioner instance.

          • -
          • wait (bool, optional) –

            Deprecated

            +
          • wait (bool, optional) –

            Deprecated

            If the method should block until the Status object reports it is done.

            Defaults to False

            @@ -759,10 +755,10 @@

            pcdsdevices.epics_motor.PMC100
            Parameters:
            -

            value (float) – High limit value to be set.

            +

            value (float) – High limit value to be set.

            Raises:
            -

            ValueError – When motor in motion or position outside of limit.

            +

            ValueError – When motor in motion or position outside of limit.

          @@ -780,8 +776,8 @@

          pcdsdevices.epics_motor.PMC100
          Parameters:
            -
          • high (float) – Limit of travel in the positive direction.

          • -
          • low (float) – Limit of travel in the negative direction.

          • +
          • high (float) – Limit of travel in the positive direction.

          • +
          • low (float) – Limit of travel in the negative direction.

          @@ -793,10 +789,10 @@

          pcdsdevices.epics_motor.PMC100
          Parameters:
          -

          value (float) – Limit of travel in the negative direction.

          +

          value (float) – Limit of travel in the negative direction.

          Raises:
          -

          ValueError – When motor in motion or position outside of limit.

          +

          ValueError – When motor in motion or position outside of limit.

          @@ -831,7 +827,7 @@

          pcdsdevices.epics_motor.PMC100
          -status() str
          +status() str

          Returns a str with the current pv values for the device.

          @@ -848,7 +844,7 @@

          pcdsdevices.epics_motor.PMC100
          -trigger() StatusBase
          +trigger() StatusBase

          Trigger the device and return status object.

          This method is responsible for implementing ‘trigger’ or ‘acquire’ functionality of this device.

          @@ -856,14 +852,14 @@

          pcdsdevices.epics_motor.PMC100read() method) then this method is also responsible for arranging that the -StatusBase object returned by this method +StatusBase object returned by this method is notified when the device is ready to be read.

          If there is no delay between triggering and being readable, -then this method must return a StatusBase +then this method must return a StatusBase object which is already completed.

          Returns:
          -

          status (StatusBase) – StatusBase object which will be marked +

          status (StatusBase) – StatusBase object which will be marked as complete when the device is ready to be read.

          @@ -878,7 +874,7 @@

          pcdsdevices.epics_motor.PMC100
          Parameters:
          -

          scale (float) – starting step size, default = 0.1

          +

          scale (float) – starting step size, default = 0.1

          @@ -890,12 +886,12 @@

          pcdsdevices.epics_motor.PMC100
          Parameters:
            -
          • position (float) – Desired end position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • position (float) – Desired end position.

          • +
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • -
          • newline (bool, optional) – If True, inserts a newline after the updates.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • newline (bool, optional) – If True, inserts a newline after the updates.

          @@ -908,12 +904,12 @@

          pcdsdevices.epics_motor.PMC100
          Parameters:
            -
          • delta (float) – Desired change in position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • delta (float) – Desired change in position.

          • +
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • -
          • newline (bool, optional) – If True, inserts a newline after the updates.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • newline (bool, optional) – If True, inserts a newline after the updates.

          @@ -1033,7 +1029,7 @@

          pcdsdevices.epics_motor.PMC100
          -subscriptions: ClassVar[FrozenSet[str]] = frozenset({'_req_done', 'acq_done', 'done_moving', 'readback', 'start_moving'})
          +subscriptions: ClassVar[FrozenSet[str]] = frozenset({'_req_done', 'acq_done', 'done_moving', 'readback', 'start_moving'})
          diff --git a/master/generated/pcdsdevices.epics_motor.SmarAct.html b/master/generated/pcdsdevices.epics_motor.SmarAct.html index 5f5f6845b95..fad8ee71c1b 100644 --- a/master/generated/pcdsdevices.epics_motor.SmarAct.html +++ b/master/generated/pcdsdevices.epics_motor.SmarAct.html @@ -1,25 +1,23 @@ + + - pcdsdevices.epics_motor.SmarAct — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.epics_motor.SmarAct — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -
          - 8.5.1.dev30+gd6e98430 -
          @@ -109,6 +104,7 @@
        • pcdsdevices.ipm
        • pcdsdevices.jet
        • pcdsdevices.keithley
        • +
        • pcdsdevices.lakeshore
        • pcdsdevices.lamp_motion
        • pcdsdevices.lasers.btps
        • pcdsdevices.lasers.counters
        • @@ -541,14 +537,14 @@

          pcdsdevices.epics_motor.SmarAct
          -configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]
          +configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]

          Configure the device for something during a run

          This default implementation allows the user to change any of the configuration_attrs. Subclasses might override this to perform additional input validation, cleanup, etc.

          Parameters:
          -

          d (dict) – The configuration dictionary. To specify the order that +

          d (dict) – The configuration dictionary. To specify the order that the changes should be made, use an OrderedDict.

          Returns:
          @@ -563,7 +559,7 @@

          pcdsdevices.epics_motor.SmarAct
          -describe() OrderedDictType[str, Dict[str, Any]]
          +describe() OrderedDictType[str, Dict[str, Any]]

          Provide schema and meta-data for read().

          This keys in the OrderedDict this method returns must match the keys in the OrderedDict return by read().

          @@ -625,8 +621,8 @@

          pcdsdevices.epics_motor.SmarAct
          Parameters:
            -
          • high (float) – Limit of travel in the positive direction.

          • -
          • low (float) – Limit of travel in the negative direction.

          • +
          • high (float) – Limit of travel in the positive direction.

          • +
          • low (float) – Limit of travel in the negative direction.

          @@ -651,7 +647,7 @@

          pcdsdevices.epics_motor.SmarAct
          -move(position: float, wait: bool = True, **kwargs) MoveStatus
          +move(position: float, wait: bool = True, **kwargs) MoveStatus

          Move to a specified position, optionally waiting for motion to complete.

          @@ -661,7 +657,7 @@

          pcdsdevices.epics_motor.SmarActfloat, optional) – Maximum time to wait for the motion. If None, the default timeout +
        • timeout (float, optional) – Maximum time to wait for the motion. If None, the default timeout for this positioner is used.

        • @@ -670,9 +666,9 @@

          pcdsdevices.epics_motor.SmarActRaises:

          @@ -686,12 +682,12 @@

          pcdsdevices.epics_motor.SmarActParameters:
          • position – Desired end position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • wait (bool, optional) – If True, wait for motion completion before returning. +

          • wait (bool, optional) – If True, wait for motion completion before returning. Defaults to False.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          @@ -713,13 +709,13 @@

          pcdsdevices.epics_motor.SmarAct
          Parameters:
            -
          • delta (float) – Desired change in position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • delta (float) – Desired change in position.

          • +
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • wait (bool, optional) – If True, wait for motion completion before returning. +

          • wait (bool, optional) – If True, wait for motion completion before returning. Defaults to False.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          @@ -733,7 +729,7 @@

          pcdsdevices.epics_motor.SmarAct
          -read() OrderedDictType[str, Dict[str, Any]]
          +read() OrderedDictType[str, Dict[str, Any]]

          Read data from the device.

          This method is expected to be as instantaneous as possible, with any substantial acquisition time taken care of in @@ -756,7 +752,7 @@

          pcdsdevices.epics_motor.SmarAct
          -read_configuration() OrderedDictType[str, Dict[str, Any]]
          +read_configuration() OrderedDictType[str, Dict[str, Any]]

          Dictionary mapping names to value dicts with keys: value, timestamp

          To control which fields are included, change the Component kinds on the device, or modify the configuration_attrs list.

          @@ -772,23 +768,23 @@

          pcdsdevices.epics_motor.SmarAct
          -set(new_position: Any, *, timeout: float | None = None, moved_cb: Callable | None = None, wait: bool = False) StatusBase
          +set(new_position: Any, *, timeout: float | None = None, moved_cb: Callable | None = None, wait: bool = False) StatusBase

          Set a value and return a Status object

          Parameters:
            -
          • new_position (object) – The input here is whatever the device requires (this +

          • new_position (object) – The input here is whatever the device requires (this should be over-ridden by the implementation. For example a motor would take a float, a shutter the strings {‘Open’, ‘Close’}, and a goineometer (h, k, l) tuples

          • -
          • timeout (float, optional) – Maximum time to wait for the motion. If None, the default timeout +

          • timeout (float, optional) – Maximum time to wait for the motion. If None, the default timeout for this positioner is used.

          • moved_cb (callable, optional) –

            Deprecated

            Call this callback when movement has finished. This callback must accept one keyword argument: ‘obj’ which will be set to this positioner instance.

          • -
          • wait (bool, optional) –

            Deprecated

            +
          • wait (bool, optional) –

            Deprecated

            If the method should block until the Status object reports it is done.

            Defaults to False

            @@ -819,10 +815,10 @@

            pcdsdevices.epics_motor.SmarAct
            Parameters:
            -

            value (float) – High limit value to be set.

            +

            value (float) – High limit value to be set.

            Raises:
            -

            ValueError – When motor in motion or position outside of limit.

            +

            ValueError – When motor in motion or position outside of limit.

          @@ -840,8 +836,8 @@

          pcdsdevices.epics_motor.SmarAct
          Parameters:
            -
          • high (float) – Limit of travel in the positive direction.

          • -
          • low (float) – Limit of travel in the negative direction.

          • +
          • high (float) – Limit of travel in the positive direction.

          • +
          • low (float) – Limit of travel in the negative direction.

          @@ -853,10 +849,10 @@

          pcdsdevices.epics_motor.SmarAct
          Parameters:
          -

          value (float) – Limit of travel in the negative direction.

          +

          value (float) – Limit of travel in the negative direction.

          Raises:
          -

          ValueError – When motor in motion or position outside of limit.

          +

          ValueError – When motor in motion or position outside of limit.

          @@ -870,7 +866,7 @@

          pcdsdevices.epics_motor.SmarAct
          -status() str
          +status() str

          Returns a str with the current pv values for the device.

          @@ -887,7 +883,7 @@

          pcdsdevices.epics_motor.SmarAct
          -trigger() StatusBase
          +trigger() StatusBase

          Trigger the device and return status object.

          This method is responsible for implementing ‘trigger’ or ‘acquire’ functionality of this device.

          @@ -895,14 +891,14 @@

          pcdsdevices.epics_motor.SmarActread() method) then this method is also responsible for arranging that the -StatusBase object returned by this method +StatusBase object returned by this method is notified when the device is ready to be read.

          If there is no delay between triggering and being readable, -then this method must return a StatusBase +then this method must return a StatusBase object which is already completed.

          Returns:
          -

          status (StatusBase) – StatusBase object which will be marked +

          status (StatusBase) – StatusBase object which will be marked as complete when the device is ready to be read.

          @@ -917,7 +913,7 @@

          pcdsdevices.epics_motor.SmarAct
          Parameters:
          -

          scale (float) – starting step size, default = 0.1

          +

          scale (float) – starting step size, default = 0.1

          @@ -929,12 +925,12 @@

          pcdsdevices.epics_motor.SmarAct
          Parameters:
            -
          • position (float) – Desired end position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • position (float) – Desired end position.

          • +
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • -
          • newline (bool, optional) – If True, inserts a newline after the updates.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • newline (bool, optional) – If True, inserts a newline after the updates.

          @@ -947,12 +943,12 @@

          pcdsdevices.epics_motor.SmarAct
          Parameters:
            -
          • delta (float) – Desired change in position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • delta (float) – Desired change in position.

          • +
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • -
          • newline (bool, optional) – If True, inserts a newline after the updates.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • newline (bool, optional) – If True, inserts a newline after the updates.

          @@ -1072,7 +1068,7 @@

          pcdsdevices.epics_motor.SmarAct
          -subscriptions: ClassVar[FrozenSet[str]] = frozenset({'_req_done', 'acq_done', 'done_moving', 'readback', 'start_moving'})
          +subscriptions: ClassVar[FrozenSet[str]] = frozenset({'_req_done', 'acq_done', 'done_moving', 'readback', 'start_moving'})
          diff --git a/master/generated/pcdsdevices.epics_motor.SmarActEncodedTipTilt.html b/master/generated/pcdsdevices.epics_motor.SmarActEncodedTipTilt.html index 200cb8cdb16..07bf192a0ca 100644 --- a/master/generated/pcdsdevices.epics_motor.SmarActEncodedTipTilt.html +++ b/master/generated/pcdsdevices.epics_motor.SmarActEncodedTipTilt.html @@ -1,25 +1,23 @@ + + - pcdsdevices.epics_motor.SmarActEncodedTipTilt — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.epics_motor.SmarActEncodedTipTilt — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -
          - 8.5.1.dev30+gd6e98430 -
          @@ -109,6 +104,7 @@
        • pcdsdevices.ipm
        • pcdsdevices.jet
        • pcdsdevices.keithley
        • +
        • pcdsdevices.lakeshore
        • pcdsdevices.lamp_motion
        • pcdsdevices.lasers.btps
        • pcdsdevices.lasers.counters
        • @@ -253,14 +249,14 @@

          pcdsdevices.epics_motor.SmarActEncodedTipTiltMethods

          -configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]
          +configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]

          Configure the device for something during a run

          This default implementation allows the user to change any of the configuration_attrs. Subclasses might override this to perform additional input validation, cleanup, etc.

          Parameters:
          -

          d (dict) – The configuration dictionary. To specify the order that +

          d (dict) – The configuration dictionary. To specify the order that the changes should be made, use an OrderedDict.

          Returns:
          @@ -275,7 +271,7 @@

          pcdsdevices.epics_motor.SmarActEncodedTipTilt
          -describe() OrderedDictType[str, Dict[str, Any]]
          +describe() OrderedDictType[str, Dict[str, Any]]

          Provide schema and meta-data for read().

          This keys in the OrderedDict this method returns must match the keys in the OrderedDict return by read().

          @@ -299,7 +295,7 @@

          pcdsdevices.epics_motor.SmarActEncodedTipTilt
          -read() OrderedDictType[str, Dict[str, Any]]
          +read() OrderedDictType[str, Dict[str, Any]]

          Read data from the device.

          This method is expected to be as instantaneous as possible, with any substantial acquisition time taken care of in @@ -322,7 +318,7 @@

          pcdsdevices.epics_motor.SmarActEncodedTipTilt
          -read_configuration() OrderedDictType[str, Dict[str, Any]]
          +read_configuration() OrderedDictType[str, Dict[str, Any]]

          Dictionary mapping names to value dicts with keys: value, timestamp

          To control which fields are included, change the Component kinds on the device, or modify the configuration_attrs list.

          @@ -341,7 +337,7 @@

          pcdsdevices.epics_motor.SmarActEncodedTipTilt
          -trigger() StatusBase
          +trigger() StatusBase

          Trigger the device and return status object.

          This method is responsible for implementing ‘trigger’ or ‘acquire’ functionality of this device.

          @@ -349,14 +345,14 @@

          pcdsdevices.epics_motor.SmarActEncodedTipTiltread() method) then this method is also responsible for arranging that the -StatusBase object returned by this method +StatusBase object returned by this method is notified when the device is ready to be read.

          If there is no delay between triggering and being readable, -then this method must return a StatusBase +then this method must return a StatusBase object which is already completed.

          Returns:
          -

          status (StatusBase) – StatusBase object which will be marked +

          status (StatusBase) – StatusBase object which will be marked as complete when the device is ready to be read.

          @@ -385,7 +381,7 @@

          pcdsdevices.epics_motor.SmarActEncodedTipTilt
          -subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})
          +subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})

          diff --git a/master/generated/pcdsdevices.epics_motor.SmarActOpenLoop.html b/master/generated/pcdsdevices.epics_motor.SmarActOpenLoop.html index c22b10e9a5d..f866522bbdd 100644 --- a/master/generated/pcdsdevices.epics_motor.SmarActOpenLoop.html +++ b/master/generated/pcdsdevices.epics_motor.SmarActOpenLoop.html @@ -1,25 +1,23 @@ + + - pcdsdevices.epics_motor.SmarActOpenLoop — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.epics_motor.SmarActOpenLoop — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -
          - 8.5.1.dev30+gd6e98430 -
          @@ -109,6 +104,7 @@
        • pcdsdevices.ipm
        • pcdsdevices.jet
        • pcdsdevices.keithley
        • +
        • pcdsdevices.lakeshore
        • pcdsdevices.lamp_motion
        • pcdsdevices.lasers.btps
        • pcdsdevices.lasers.counters
        • @@ -310,14 +306,14 @@

          pcdsdevices.epics_motor.SmarActOpenLoopMethods

          -configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]
          +configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]

          Configure the device for something during a run

          This default implementation allows the user to change any of the configuration_attrs. Subclasses might override this to perform additional input validation, cleanup, etc.

          Parameters:
          -

          d (dict) – The configuration dictionary. To specify the order that +

          d (dict) – The configuration dictionary. To specify the order that the changes should be made, use an OrderedDict.

          Returns:
          @@ -332,7 +328,7 @@

          pcdsdevices.epics_motor.SmarActOpenLoop
          -describe() OrderedDictType[str, Dict[str, Any]]
          +describe() OrderedDictType[str, Dict[str, Any]]

          Provide schema and meta-data for read().

          This keys in the OrderedDict this method returns must match the keys in the OrderedDict return by read().

          @@ -356,7 +352,7 @@

          pcdsdevices.epics_motor.SmarActOpenLoop
          -read() OrderedDictType[str, Dict[str, Any]]
          +read() OrderedDictType[str, Dict[str, Any]]

          Read data from the device.

          This method is expected to be as instantaneous as possible, with any substantial acquisition time taken care of in @@ -379,7 +375,7 @@

          pcdsdevices.epics_motor.SmarActOpenLoop
          -read_configuration() OrderedDictType[str, Dict[str, Any]]
          +read_configuration() OrderedDictType[str, Dict[str, Any]]

          Dictionary mapping names to value dicts with keys: value, timestamp

          To control which fields are included, change the Component kinds on the device, or modify the configuration_attrs list.

          @@ -398,7 +394,7 @@

          pcdsdevices.epics_motor.SmarActOpenLoop
          -trigger() StatusBase
          +trigger() StatusBase

          Trigger the device and return status object.

          This method is responsible for implementing ‘trigger’ or ‘acquire’ functionality of this device.

          @@ -406,14 +402,14 @@

          pcdsdevices.epics_motor.SmarActOpenLoopread() method) then this method is also responsible for arranging that the -StatusBase object returned by this method +StatusBase object returned by this method is notified when the device is ready to be read.

          If there is no delay between triggering and being readable, -then this method must return a StatusBase +then this method must return a StatusBase object which is already completed.

          Returns:
          -

          status (StatusBase) – StatusBase object which will be marked +

          status (StatusBase) – StatusBase object which will be marked as complete when the device is ready to be read.

          @@ -442,7 +438,7 @@

          pcdsdevices.epics_motor.SmarActOpenLoop
          -subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})
          +subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})

          diff --git a/master/generated/pcdsdevices.epics_motor.SmarActOpenLoopPositioner.html b/master/generated/pcdsdevices.epics_motor.SmarActOpenLoopPositioner.html index 6f9d19e6793..4ce7ae8bb5b 100644 --- a/master/generated/pcdsdevices.epics_motor.SmarActOpenLoopPositioner.html +++ b/master/generated/pcdsdevices.epics_motor.SmarActOpenLoopPositioner.html @@ -1,25 +1,23 @@ + + - pcdsdevices.epics_motor.SmarActOpenLoopPositioner — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.epics_motor.SmarActOpenLoopPositioner — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -
          - 8.5.1.dev30+gd6e98430 -
          @@ -109,6 +104,7 @@
        • pcdsdevices.ipm
        • pcdsdevices.jet
        • pcdsdevices.keithley
        • +
        • pcdsdevices.lakeshore
        • pcdsdevices.lamp_motion
        • pcdsdevices.lasers.btps
        • pcdsdevices.lasers.counters
        • @@ -277,14 +273,14 @@

          pcdsdevices.epics_motor.SmarActOpenLoopPositioner
          -configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]
          +configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]

          Configure the device for something during a run

          This default implementation allows the user to change any of the configuration_attrs. Subclasses might override this to perform additional input validation, cleanup, etc.

          Parameters:
          -

          d (dict) – The configuration dictionary. To specify the order that +

          d (dict) – The configuration dictionary. To specify the order that the changes should be made, use an OrderedDict.

          Returns:
          @@ -299,7 +295,7 @@

          pcdsdevices.epics_motor.SmarActOpenLoopPositioner
          -describe() OrderedDictType[str, Dict[str, Any]]
          +describe() OrderedDictType[str, Dict[str, Any]]

          Provide schema and meta-data for read().

          This keys in the OrderedDict this method returns must match the keys in the OrderedDict return by read().

          @@ -346,7 +342,7 @@

          pcdsdevices.epics_motor.SmarActOpenLoopPositioner

          moved_cb (callable) – Call this callback when movement has finished. This callback must accept one keyword argument: ‘obj’ which will be set to this positioner instance.

          -
        • timeout (float, optional) – Maximum time to wait for the motion. If None, the default timeout +

        • timeout (float, optional) – Maximum time to wait for the motion. If None, the default timeout for this positioner is used.

        • @@ -355,9 +351,9 @@

          pcdsdevices.epics_motor.SmarActOpenLoopPositioner
          Raises:

          @@ -371,12 +367,12 @@

          pcdsdevices.epics_motor.SmarActOpenLoopPositionerParameters:
          • position – Desired end position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • wait (bool, optional) – If True, wait for motion completion before returning. +

          • wait (bool, optional) – If True, wait for motion completion before returning. Defaults to False.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          @@ -398,13 +394,13 @@

          pcdsdevices.epics_motor.SmarActOpenLoopPositioner
          Parameters:
            -
          • delta (float) – Desired change in position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • delta (float) – Desired change in position.

          • +
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • wait (bool, optional) – If True, wait for motion completion before returning. +

          • wait (bool, optional) – If True, wait for motion completion before returning. Defaults to False.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          @@ -418,7 +414,7 @@

          pcdsdevices.epics_motor.SmarActOpenLoopPositioner
          -read() OrderedDictType[str, Dict[str, Any]]
          +read() OrderedDictType[str, Dict[str, Any]]

          Read data from the device.

          This method is expected to be as instantaneous as possible, with any substantial acquisition time taken care of in @@ -441,7 +437,7 @@

          pcdsdevices.epics_motor.SmarActOpenLoopPositioner
          -read_configuration() OrderedDictType[str, Dict[str, Any]]
          +read_configuration() OrderedDictType[str, Dict[str, Any]]

          Dictionary mapping names to value dicts with keys: value, timestamp

          To control which fields are included, change the Component kinds on the device, or modify the configuration_attrs list.

          @@ -457,23 +453,23 @@

          pcdsdevices.epics_motor.SmarActOpenLoopPositioner
          -set(new_position: Any, *, timeout: float | None = None, moved_cb: Callable | None = None, wait: bool = False) StatusBase
          +set(new_position: Any, *, timeout: float | None = None, moved_cb: Callable | None = None, wait: bool = False) StatusBase

          Set a value and return a Status object

          Parameters:
            -
          • new_position (object) – The input here is whatever the device requires (this +

          • new_position (object) – The input here is whatever the device requires (this should be over-ridden by the implementation. For example a motor would take a float, a shutter the strings {‘Open’, ‘Close’}, and a goineometer (h, k, l) tuples

          • -
          • timeout (float, optional) – Maximum time to wait for the motion. If None, the default timeout +

          • timeout (float, optional) – Maximum time to wait for the motion. If None, the default timeout for this positioner is used.

          • moved_cb (callable, optional) –

            Deprecated

            Call this callback when movement has finished. This callback must accept one keyword argument: ‘obj’ which will be set to this positioner instance.

          • -
          • wait (bool, optional) –

            Deprecated

            +
          • wait (bool, optional) –

            Deprecated

            If the method should block until the Status object reports it is done.

            Defaults to False

            @@ -495,7 +491,7 @@

            pcdsdevices.epics_motor.SmarActOpenLoopPositioner
            -status() str
            +status() str

            Returns a str with the current pv values for the device.

          @@ -512,7 +508,7 @@

          pcdsdevices.epics_motor.SmarActOpenLoopPositioner
          -trigger() StatusBase
          +trigger() StatusBase

          Trigger the device and return status object.

          This method is responsible for implementing ‘trigger’ or ‘acquire’ functionality of this device.

          @@ -520,14 +516,14 @@

          pcdsdevices.epics_motor.SmarActOpenLoopPositionerread() method) then this method is also responsible for arranging that the -StatusBase object returned by this method +StatusBase object returned by this method is notified when the device is ready to be read.

          If there is no delay between triggering and being readable, -then this method must return a StatusBase +then this method must return a StatusBase object which is already completed.

          Returns:
          -

          status (StatusBase) – StatusBase object which will be marked +

          status (StatusBase) – StatusBase object which will be marked as complete when the device is ready to be read.

          @@ -542,7 +538,7 @@

          pcdsdevices.epics_motor.SmarActOpenLoopPositioner
          Parameters:
          -

          scale (float) – starting step size, default = 0.1

          +

          scale (float) – starting step size, default = 0.1

          @@ -554,12 +550,12 @@

          pcdsdevices.epics_motor.SmarActOpenLoopPositioner
          Parameters:
            -
          • position (float) – Desired end position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • position (float) – Desired end position.

          • +
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • -
          • newline (bool, optional) – If True, inserts a newline after the updates.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • newline (bool, optional) – If True, inserts a newline after the updates.

          @@ -572,12 +568,12 @@

          pcdsdevices.epics_motor.SmarActOpenLoopPositioner
          Parameters:
            -
          • delta (float) – Desired change in position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • delta (float) – Desired change in position.

          • +
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • -
          • newline (bool, optional) – If True, inserts a newline after the updates.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • newline (bool, optional) – If True, inserts a newline after the updates.

          @@ -713,7 +709,7 @@

          pcdsdevices.epics_motor.SmarActOpenLoopPositioner
          -subscriptions: ClassVar[FrozenSet[str]] = frozenset({'_req_done', 'acq_done', 'done_moving', 'readback', 'start_moving'})
          +subscriptions: ClassVar[FrozenSet[str]] = frozenset({'_req_done', 'acq_done', 'done_moving', 'readback', 'start_moving'})
          diff --git a/master/generated/pcdsdevices.epics_motor.SmarActPicoscale.html b/master/generated/pcdsdevices.epics_motor.SmarActPicoscale.html index 05974bdfd76..6d1d1caf614 100644 --- a/master/generated/pcdsdevices.epics_motor.SmarActPicoscale.html +++ b/master/generated/pcdsdevices.epics_motor.SmarActPicoscale.html @@ -1,25 +1,23 @@ + + - pcdsdevices.epics_motor.SmarActPicoscale — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.epics_motor.SmarActPicoscale — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -
          - 8.5.1.dev30+gd6e98430 -
          @@ -109,6 +104,7 @@
        • pcdsdevices.ipm
        • pcdsdevices.jet
        • pcdsdevices.keithley
        • +
        • pcdsdevices.lakeshore
        • pcdsdevices.lamp_motion
        • pcdsdevices.lasers.btps
        • pcdsdevices.lasers.counters
        • @@ -633,14 +629,14 @@

          pcdsdevices.epics_motor.SmarActPicoscale
          -configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]
          +configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]

          Configure the device for something during a run

          This default implementation allows the user to change any of the configuration_attrs. Subclasses might override this to perform additional input validation, cleanup, etc.

          Parameters:
          -

          d (dict) – The configuration dictionary. To specify the order that +

          d (dict) – The configuration dictionary. To specify the order that the changes should be made, use an OrderedDict.

          Returns:
          @@ -655,7 +651,7 @@

          pcdsdevices.epics_motor.SmarActPicoscale
          -describe() OrderedDictType[str, Dict[str, Any]]
          +describe() OrderedDictType[str, Dict[str, Any]]

          Provide schema and meta-data for read().

          This keys in the OrderedDict this method returns must match the keys in the OrderedDict return by read().

          @@ -717,8 +713,8 @@

          pcdsdevices.epics_motor.SmarActPicoscale
          Parameters:
            -
          • high (float) – Limit of travel in the positive direction.

          • -
          • low (float) – Limit of travel in the negative direction.

          • +
          • high (float) – Limit of travel in the positive direction.

          • +
          • low (float) – Limit of travel in the negative direction.

          @@ -743,7 +739,7 @@

          pcdsdevices.epics_motor.SmarActPicoscale
          -move(position: float, wait: bool = True, **kwargs) MoveStatus
          +move(position: float, wait: bool = True, **kwargs) MoveStatus

          Move to a specified position, optionally waiting for motion to complete.

          @@ -753,7 +749,7 @@

          pcdsdevices.epics_motor.SmarActPicoscalefloat, optional) – Maximum time to wait for the motion. If None, the default timeout +
        • timeout (float, optional) – Maximum time to wait for the motion. If None, the default timeout for this positioner is used.

        • @@ -762,9 +758,9 @@

          pcdsdevices.epics_motor.SmarActPicoscaleRaises:

          @@ -778,12 +774,12 @@

          pcdsdevices.epics_motor.SmarActPicoscaleParameters:
          • position – Desired end position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • wait (bool, optional) – If True, wait for motion completion before returning. +

          • wait (bool, optional) – If True, wait for motion completion before returning. Defaults to False.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          @@ -805,13 +801,13 @@

          pcdsdevices.epics_motor.SmarActPicoscale
          Parameters:
            -
          • delta (float) – Desired change in position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • delta (float) – Desired change in position.

          • +
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • wait (bool, optional) – If True, wait for motion completion before returning. +

          • wait (bool, optional) – If True, wait for motion completion before returning. Defaults to False.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          @@ -825,7 +821,7 @@

          pcdsdevices.epics_motor.SmarActPicoscale
          -read() OrderedDictType[str, Dict[str, Any]]
          +read() OrderedDictType[str, Dict[str, Any]]

          Read data from the device.

          This method is expected to be as instantaneous as possible, with any substantial acquisition time taken care of in @@ -848,7 +844,7 @@

          pcdsdevices.epics_motor.SmarActPicoscale
          -read_configuration() OrderedDictType[str, Dict[str, Any]]
          +read_configuration() OrderedDictType[str, Dict[str, Any]]

          Dictionary mapping names to value dicts with keys: value, timestamp

          To control which fields are included, change the Component kinds on the device, or modify the configuration_attrs list.

          @@ -864,23 +860,23 @@

          pcdsdevices.epics_motor.SmarActPicoscale
          -set(new_position: Any, *, timeout: float | None = None, moved_cb: Callable | None = None, wait: bool = False) StatusBase
          +set(new_position: Any, *, timeout: float | None = None, moved_cb: Callable | None = None, wait: bool = False) StatusBase

          Set a value and return a Status object

          Parameters:
            -
          • new_position (object) – The input here is whatever the device requires (this +

          • new_position (object) – The input here is whatever the device requires (this should be over-ridden by the implementation. For example a motor would take a float, a shutter the strings {‘Open’, ‘Close’}, and a goineometer (h, k, l) tuples

          • -
          • timeout (float, optional) – Maximum time to wait for the motion. If None, the default timeout +

          • timeout (float, optional) – Maximum time to wait for the motion. If None, the default timeout for this positioner is used.

          • moved_cb (callable, optional) –

            Deprecated

            Call this callback when movement has finished. This callback must accept one keyword argument: ‘obj’ which will be set to this positioner instance.

          • -
          • wait (bool, optional) –

            Deprecated

            +
          • wait (bool, optional) –

            Deprecated

            If the method should block until the Status object reports it is done.

            Defaults to False

            @@ -911,10 +907,10 @@

            pcdsdevices.epics_motor.SmarActPicoscale
            Parameters:
            -

            value (float) – High limit value to be set.

            +

            value (float) – High limit value to be set.

            Raises:
            -

            ValueError – When motor in motion or position outside of limit.

            +

            ValueError – When motor in motion or position outside of limit.

          @@ -932,8 +928,8 @@

          pcdsdevices.epics_motor.SmarActPicoscale
          Parameters:
            -
          • high (float) – Limit of travel in the positive direction.

          • -
          • low (float) – Limit of travel in the negative direction.

          • +
          • high (float) – Limit of travel in the positive direction.

          • +
          • low (float) – Limit of travel in the negative direction.

          @@ -945,10 +941,10 @@

          pcdsdevices.epics_motor.SmarActPicoscale
          Parameters:
          -

          value (float) – Limit of travel in the negative direction.

          +

          value (float) – Limit of travel in the negative direction.

          Raises:
          -

          ValueError – When motor in motion or position outside of limit.

          +

          ValueError – When motor in motion or position outside of limit.

          @@ -962,7 +958,7 @@

          pcdsdevices.epics_motor.SmarActPicoscale
          -status() str
          +status() str

          Returns a str with the current pv values for the device.

          @@ -979,7 +975,7 @@

          pcdsdevices.epics_motor.SmarActPicoscale
          -trigger() StatusBase
          +trigger() StatusBase

          Trigger the device and return status object.

          This method is responsible for implementing ‘trigger’ or ‘acquire’ functionality of this device.

          @@ -987,14 +983,14 @@

          pcdsdevices.epics_motor.SmarActPicoscaleread() method) then this method is also responsible for arranging that the -StatusBase object returned by this method +StatusBase object returned by this method is notified when the device is ready to be read.

          If there is no delay between triggering and being readable, -then this method must return a StatusBase +then this method must return a StatusBase object which is already completed.

          Returns:
          -

          status (StatusBase) – StatusBase object which will be marked +

          status (StatusBase) – StatusBase object which will be marked as complete when the device is ready to be read.

          @@ -1009,7 +1005,7 @@

          pcdsdevices.epics_motor.SmarActPicoscale
          Parameters:
          -

          scale (float) – starting step size, default = 0.1

          +

          scale (float) – starting step size, default = 0.1

          @@ -1021,12 +1017,12 @@

          pcdsdevices.epics_motor.SmarActPicoscale
          Parameters:
            -
          • position (float) – Desired end position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • position (float) – Desired end position.

          • +
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • -
          • newline (bool, optional) – If True, inserts a newline after the updates.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • newline (bool, optional) – If True, inserts a newline after the updates.

          @@ -1039,12 +1035,12 @@

          pcdsdevices.epics_motor.SmarActPicoscale
          Parameters:
            -
          • delta (float) – Desired change in position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • delta (float) – Desired change in position.

          • +
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • -
          • newline (bool, optional) – If True, inserts a newline after the updates.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • newline (bool, optional) – If True, inserts a newline after the updates.

          @@ -1164,7 +1160,7 @@

          pcdsdevices.epics_motor.SmarActPicoscale
          -subscriptions: ClassVar[FrozenSet[str]] = frozenset({'_req_done', 'acq_done', 'done_moving', 'readback', 'start_moving'})
          +subscriptions: ClassVar[FrozenSet[str]] = frozenset({'_req_done', 'acq_done', 'done_moving', 'readback', 'start_moving'})
          diff --git a/master/generated/pcdsdevices.epics_motor.SmarActTipTilt.html b/master/generated/pcdsdevices.epics_motor.SmarActTipTilt.html index 5adc0d130a4..969b6aa6aab 100644 --- a/master/generated/pcdsdevices.epics_motor.SmarActTipTilt.html +++ b/master/generated/pcdsdevices.epics_motor.SmarActTipTilt.html @@ -1,25 +1,23 @@ + + - pcdsdevices.epics_motor.SmarActTipTilt — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.epics_motor.SmarActTipTilt — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -
          - 8.5.1.dev30+gd6e98430 -
          @@ -109,6 +104,7 @@
        • pcdsdevices.ipm
        • pcdsdevices.jet
        • pcdsdevices.keithley
        • +
        • pcdsdevices.lakeshore
        • pcdsdevices.lamp_motion
        • pcdsdevices.lasers.btps
        • pcdsdevices.lasers.counters
        • @@ -270,14 +266,14 @@

          Parameters:Methods

          -configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]
          +configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]

          Configure the device for something during a run

          This default implementation allows the user to change any of the configuration_attrs. Subclasses might override this to perform additional input validation, cleanup, etc.

          Parameters:
          -

          d (dict) – The configuration dictionary. To specify the order that +

          d (dict) – The configuration dictionary. To specify the order that the changes should be made, use an OrderedDict.

          Returns:
          @@ -292,7 +288,7 @@

          Parameters:
          -describe() OrderedDictType[str, Dict[str, Any]]
          +describe() OrderedDictType[str, Dict[str, Any]]

          Provide schema and meta-data for read().

          This keys in the OrderedDict this method returns must match the keys in the OrderedDict return by read().

          @@ -316,7 +312,7 @@

          Parameters:
          -read() OrderedDictType[str, Dict[str, Any]]
          +read() OrderedDictType[str, Dict[str, Any]]

          Read data from the device.

          This method is expected to be as instantaneous as possible, with any substantial acquisition time taken care of in @@ -339,7 +335,7 @@

          Parameters:
          -read_configuration() OrderedDictType[str, Dict[str, Any]]
          +read_configuration() OrderedDictType[str, Dict[str, Any]]

          Dictionary mapping names to value dicts with keys: value, timestamp

          To control which fields are included, change the Component kinds on the device, or modify the configuration_attrs list.

          @@ -358,7 +354,7 @@

          Parameters:
          -trigger() StatusBase
          +trigger() StatusBase

          Trigger the device and return status object.

          This method is responsible for implementing ‘trigger’ or ‘acquire’ functionality of this device.

          @@ -366,14 +362,14 @@

          Parameters:read() method) then this method is also responsible for arranging that the -StatusBase object returned by this method +StatusBase object returned by this method is notified when the device is ready to be read.

          If there is no delay between triggering and being readable, -then this method must return a StatusBase +then this method must return a StatusBase object which is already completed.

          Returns:
          -

          status (StatusBase) – StatusBase object which will be marked +

          status (StatusBase) – StatusBase object which will be marked as complete when the device is ready to be read.

          @@ -402,7 +398,7 @@

          Parameters:
          -subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})
          +subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})

          diff --git a/master/generated/pcdsdevices.eps.EPS.html b/master/generated/pcdsdevices.eps.EPS.html index 6ee729df391..80456f3a2c7 100644 --- a/master/generated/pcdsdevices.eps.EPS.html +++ b/master/generated/pcdsdevices.eps.EPS.html @@ -1,25 +1,23 @@ + + - pcdsdevices.eps.EPS — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.eps.EPS — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -
          - 8.5.1.dev30+gd6e98430 -
          @@ -86,6 +81,7 @@
        • pcdsdevices.ipm
        • pcdsdevices.jet
        • pcdsdevices.keithley
        • +
        • pcdsdevices.lakeshore
        • pcdsdevices.lamp_motion
        • pcdsdevices.lasers.btps
        • pcdsdevices.lasers.counters
        • @@ -258,14 +254,14 @@

          pcdsdevices.eps.EPSMethods

          -configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]
          +configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]

          Configure the device for something during a run

          This default implementation allows the user to change any of the configuration_attrs. Subclasses might override this to perform additional input validation, cleanup, etc.

          Parameters:
          -

          d (dict) – The configuration dictionary. To specify the order that +

          d (dict) – The configuration dictionary. To specify the order that the changes should be made, use an OrderedDict.

          Returns:
          @@ -280,7 +276,7 @@

          pcdsdevices.eps.EPS
          -describe() OrderedDictType[str, Dict[str, Any]]
          +describe() OrderedDictType[str, Dict[str, Any]]

          Provide schema and meta-data for read().

          This keys in the OrderedDict this method returns must match the keys in the OrderedDict return by read().

          @@ -310,7 +306,7 @@

          pcdsdevices.eps.EPS
          -read() OrderedDictType[str, Dict[str, Any]]
          +read() OrderedDictType[str, Dict[str, Any]]

          Read data from the device.

          This method is expected to be as instantaneous as possible, with any substantial acquisition time taken care of in @@ -333,7 +329,7 @@

          pcdsdevices.eps.EPS
          -read_configuration() OrderedDictType[str, Dict[str, Any]]
          +read_configuration() OrderedDictType[str, Dict[str, Any]]

          Dictionary mapping names to value dicts with keys: value, timestamp

          To control which fields are included, change the Component kinds on the device, or modify the configuration_attrs list.

          @@ -349,7 +345,7 @@

          pcdsdevices.eps.EPS
          -status() str
          +status() str

          Returns a str with the current pv values for the device.

          @@ -366,7 +362,7 @@

          pcdsdevices.eps.EPS
          -trigger() StatusBase
          +trigger() StatusBase

          Trigger the device and return status object.

          This method is responsible for implementing ‘trigger’ or ‘acquire’ functionality of this device.

          @@ -374,14 +370,14 @@

          pcdsdevices.eps.EPSread() method) then this method is also responsible for arranging that the -StatusBase object returned by this method +StatusBase object returned by this method is notified when the device is ready to be read.

          If there is no delay between triggering and being readable, -then this method must return a StatusBase +then this method must return a StatusBase object which is already completed.

          Returns:
          -

          status (StatusBase) – StatusBase object which will be marked +

          status (StatusBase) – StatusBase object which will be marked as complete when the device is ready to be read.

          @@ -410,7 +406,7 @@

          pcdsdevices.eps.EPS
          -subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})
          +subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})

          diff --git a/master/generated/pcdsdevices.evr.EvrMotor.html b/master/generated/pcdsdevices.evr.EvrMotor.html index 0bb4059622d..cbd3fb77522 100644 --- a/master/generated/pcdsdevices.evr.EvrMotor.html +++ b/master/generated/pcdsdevices.evr.EvrMotor.html @@ -1,25 +1,23 @@ + + - pcdsdevices.evr.EvrMotor — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.evr.EvrMotor — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -
          - 8.5.1.dev30+gd6e98430 -
          @@ -87,6 +82,7 @@
        • pcdsdevices.ipm
        • pcdsdevices.jet
        • pcdsdevices.keithley
        • +
        • pcdsdevices.lakeshore
        • pcdsdevices.lamp_motion
        • pcdsdevices.lasers.btps
        • pcdsdevices.lasers.counters
        • @@ -249,14 +245,14 @@

          pcdsdevices.evr.EvrMotor
          -configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]
          +configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]

          Configure the device for something during a run

          This default implementation allows the user to change any of the configuration_attrs. Subclasses might override this to perform additional input validation, cleanup, etc.

          Parameters:
          -

          d (dict) – The configuration dictionary. To specify the order that +

          d (dict) – The configuration dictionary. To specify the order that the changes should be made, use an OrderedDict.

          Returns:
          @@ -271,7 +267,7 @@

          pcdsdevices.evr.EvrMotor
          -describe() OrderedDictType[str, Dict[str, Any]]
          +describe() OrderedDictType[str, Dict[str, Any]]

          Provide schema and meta-data for read().

          This keys in the OrderedDict this method returns must match the keys in the OrderedDict return by read().

          @@ -318,7 +314,7 @@

          pcdsdevices.evr.EvrMotorfloat, optional) – Maximum time to wait for the motion. If None, the default timeout +
        • timeout (float, optional) – Maximum time to wait for the motion. If None, the default timeout for this positioner is used.

        • @@ -327,9 +323,9 @@

          pcdsdevices.evr.EvrMotorRaises:

          @@ -343,12 +339,12 @@

          pcdsdevices.evr.EvrMotorParameters:
          • position – Desired end position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • wait (bool, optional) – If True, wait for motion completion before returning. +

          • wait (bool, optional) – If True, wait for motion completion before returning. Defaults to False.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          @@ -370,13 +366,13 @@

          pcdsdevices.evr.EvrMotor
          Parameters:
            -
          • delta (float) – Desired change in position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • delta (float) – Desired change in position.

          • +
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • wait (bool, optional) – If True, wait for motion completion before returning. +

          • wait (bool, optional) – If True, wait for motion completion before returning. Defaults to False.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          @@ -390,7 +386,7 @@

          pcdsdevices.evr.EvrMotor
          -read() OrderedDictType[str, Dict[str, Any]]
          +read() OrderedDictType[str, Dict[str, Any]]

          Read data from the device.

          This method is expected to be as instantaneous as possible, with any substantial acquisition time taken care of in @@ -413,7 +409,7 @@

          pcdsdevices.evr.EvrMotor
          -read_configuration() OrderedDictType[str, Dict[str, Any]]
          +read_configuration() OrderedDictType[str, Dict[str, Any]]

          Dictionary mapping names to value dicts with keys: value, timestamp

          To control which fields are included, change the Component kinds on the device, or modify the configuration_attrs list.

          @@ -429,23 +425,23 @@

          pcdsdevices.evr.EvrMotor
          -set(new_position: Any, *, timeout: float | None = None, moved_cb: Callable | None = None, wait: bool = False) StatusBase
          +set(new_position: Any, *, timeout: float | None = None, moved_cb: Callable | None = None, wait: bool = False) StatusBase

          Set a value and return a Status object

          Parameters:
            -
          • new_position (object) – The input here is whatever the device requires (this +

          • new_position (object) – The input here is whatever the device requires (this should be over-ridden by the implementation. For example a motor would take a float, a shutter the strings {‘Open’, ‘Close’}, and a goineometer (h, k, l) tuples

          • -
          • timeout (float, optional) – Maximum time to wait for the motion. If None, the default timeout +

          • timeout (float, optional) – Maximum time to wait for the motion. If None, the default timeout for this positioner is used.

          • moved_cb (callable, optional) –

            Deprecated

            Call this callback when movement has finished. This callback must accept one keyword argument: ‘obj’ which will be set to this positioner instance.

          • -
          • wait (bool, optional) –

            Deprecated

            +
          • wait (bool, optional) –

            Deprecated

            If the method should block until the Status object reports it is done.

            Defaults to False

            @@ -467,7 +463,7 @@

            pcdsdevices.evr.EvrMotor
            -status() str
            +status() str

            Returns a str with the current pv values for the device.

          @@ -484,7 +480,7 @@

          pcdsdevices.evr.EvrMotor
          -trigger() StatusBase
          +trigger() StatusBase

          Trigger the device and return status object.

          This method is responsible for implementing ‘trigger’ or ‘acquire’ functionality of this device.

          @@ -492,14 +488,14 @@

          pcdsdevices.evr.EvrMotorread() method) then this method is also responsible for arranging that the -StatusBase object returned by this method +StatusBase object returned by this method is notified when the device is ready to be read.

          If there is no delay between triggering and being readable, -then this method must return a StatusBase +then this method must return a StatusBase object which is already completed.

          Returns:
          -

          status (StatusBase) – StatusBase object which will be marked +

          status (StatusBase) – StatusBase object which will be marked as complete when the device is ready to be read.

          @@ -514,7 +510,7 @@

          pcdsdevices.evr.EvrMotor
          Parameters:
          -

          scale (float) – starting step size, default = 0.1

          +

          scale (float) – starting step size, default = 0.1

          @@ -526,12 +522,12 @@

          pcdsdevices.evr.EvrMotor
          Parameters:
            -
          • position (float) – Desired end position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • position (float) – Desired end position.

          • +
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • -
          • newline (bool, optional) – If True, inserts a newline after the updates.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • newline (bool, optional) – If True, inserts a newline after the updates.

          @@ -544,12 +540,12 @@

          pcdsdevices.evr.EvrMotor
          Parameters:
            -
          • delta (float) – Desired change in position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • delta (float) – Desired change in position.

          • +
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • -
          • newline (bool, optional) – If True, inserts a newline after the updates.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • newline (bool, optional) – If True, inserts a newline after the updates.

          @@ -691,7 +687,7 @@

          pcdsdevices.evr.EvrMotor
          -subscriptions: ClassVar[FrozenSet[str]] = frozenset({'_req_done', 'acq_done', 'done_moving', 'readback', 'start_moving'})
          +subscriptions: ClassVar[FrozenSet[str]] = frozenset({'_req_done', 'acq_done', 'done_moving', 'readback', 'start_moving'})
          diff --git a/master/generated/pcdsdevices.evr.Trigger.html b/master/generated/pcdsdevices.evr.Trigger.html index dcae8daba06..153bb7855c1 100644 --- a/master/generated/pcdsdevices.evr.Trigger.html +++ b/master/generated/pcdsdevices.evr.Trigger.html @@ -1,25 +1,23 @@ + + - pcdsdevices.evr.Trigger — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.evr.Trigger — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -
          - 8.5.1.dev30+gd6e98430 -
          @@ -87,6 +82,7 @@
        • pcdsdevices.ipm
        • pcdsdevices.jet
        • pcdsdevices.keithley
        • +
        • pcdsdevices.lakeshore
        • pcdsdevices.lamp_motion
        • pcdsdevices.lasers.btps
        • pcdsdevices.lasers.counters
        • @@ -271,14 +267,14 @@

          pcdsdevices.evr.TriggerMethods

          -configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]
          +configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]

          Configure the device for something during a run

          This default implementation allows the user to change any of the configuration_attrs. Subclasses might override this to perform additional input validation, cleanup, etc.

          Parameters:
          -

          d (dict) – The configuration dictionary. To specify the order that +

          d (dict) – The configuration dictionary. To specify the order that the changes should be made, use an OrderedDict.

          Returns:
          @@ -293,7 +289,7 @@

          pcdsdevices.evr.Trigger
          -describe() OrderedDictType[str, Dict[str, Any]]
          +describe() OrderedDictType[str, Dict[str, Any]]

          Provide schema and meta-data for read().

          This keys in the OrderedDict this method returns must match the keys in the OrderedDict return by read().

          @@ -335,7 +331,7 @@

          pcdsdevices.evr.Trigger
          -read() OrderedDictType[str, Dict[str, Any]]
          +read() OrderedDictType[str, Dict[str, Any]]

          Read data from the device.

          This method is expected to be as instantaneous as possible, with any substantial acquisition time taken care of in @@ -358,7 +354,7 @@

          pcdsdevices.evr.Trigger
          -read_configuration() OrderedDictType[str, Dict[str, Any]]
          +read_configuration() OrderedDictType[str, Dict[str, Any]]

          Dictionary mapping names to value dicts with keys: value, timestamp

          To control which fields are included, change the Component kinds on the device, or modify the configuration_attrs list.

          @@ -374,7 +370,7 @@

          pcdsdevices.evr.Trigger
          -status() str
          +status() str

          Returns a str with the current pv values for the device.

          @@ -391,7 +387,7 @@

          pcdsdevices.evr.Trigger
          -trigger() StatusBase
          +trigger() StatusBase

          Trigger the device and return status object.

          This method is responsible for implementing ‘trigger’ or ‘acquire’ functionality of this device.

          @@ -399,14 +395,14 @@

          pcdsdevices.evr.Triggerread() method) then this method is also responsible for arranging that the -StatusBase object returned by this method +StatusBase object returned by this method is notified when the device is ready to be read.

          If there is no delay between triggering and being readable, -then this method must return a StatusBase +then this method must return a StatusBase object which is already completed.

          Returns:
          -

          status (StatusBase) – StatusBase object which will be marked +

          status (StatusBase) – StatusBase object which will be marked as complete when the device is ready to be read.

          @@ -435,7 +431,7 @@

          pcdsdevices.evr.Trigger
          -subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})
          +subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})

          diff --git a/master/generated/pcdsdevices.example.Example3D.html b/master/generated/pcdsdevices.example.Example3D.html index dff54933b83..7f1ceb07124 100644 --- a/master/generated/pcdsdevices.example.Example3D.html +++ b/master/generated/pcdsdevices.example.Example3D.html @@ -1,25 +1,23 @@ + + - pcdsdevices.example.Example3D — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.example.Example3D — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -
          - 8.5.1.dev30+gd6e98430 -
          @@ -91,6 +86,7 @@
        • pcdsdevices.ipm
        • pcdsdevices.jet
        • pcdsdevices.keithley
        • +
        • pcdsdevices.lakeshore
        • pcdsdevices.lamp_motion
        • pcdsdevices.lasers.btps
        • pcdsdevices.lasers.counters
        • @@ -269,14 +265,14 @@

          pcdsdevices.example.Example3DMethods

          -configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]
          +configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]

          Configure the device for something during a run

          This default implementation allows the user to change any of the configuration_attrs. Subclasses might override this to perform additional input validation, cleanup, etc.

          Parameters:
          -

          d (dict) – The configuration dictionary. To specify the order that +

          d (dict) – The configuration dictionary. To specify the order that the changes should be made, use an OrderedDict.

          Returns:
          @@ -291,7 +287,7 @@

          pcdsdevices.example.Example3D
          -describe() OrderedDictType[str, Dict[str, Any]]
          +describe() OrderedDictType[str, Dict[str, Any]]

          Provide schema and meta-data for read().

          This keys in the OrderedDict this method returns must match the keys in the OrderedDict return by read().

          @@ -321,7 +317,7 @@

          pcdsdevices.example.Example3D
          -read() OrderedDictType[str, Dict[str, Any]]
          +read() OrderedDictType[str, Dict[str, Any]]

          Read data from the device.

          This method is expected to be as instantaneous as possible, with any substantial acquisition time taken care of in @@ -344,7 +340,7 @@

          pcdsdevices.example.Example3D
          -read_configuration() OrderedDictType[str, Dict[str, Any]]
          +read_configuration() OrderedDictType[str, Dict[str, Any]]

          Dictionary mapping names to value dicts with keys: value, timestamp

          To control which fields are included, change the Component kinds on the device, or modify the configuration_attrs list.

          @@ -360,7 +356,7 @@

          pcdsdevices.example.Example3D
          -status() str
          +status() str

          Returns a str with the current pv values for the device.

          @@ -377,7 +373,7 @@

          pcdsdevices.example.Example3D
          -trigger() StatusBase
          +trigger() StatusBase

          Trigger the device and return status object.

          This method is responsible for implementing ‘trigger’ or ‘acquire’ functionality of this device.

          @@ -385,14 +381,14 @@

          pcdsdevices.example.Example3Dread() method) then this method is also responsible for arranging that the -StatusBase object returned by this method +StatusBase object returned by this method is notified when the device is ready to be read.

          If there is no delay between triggering and being readable, -then this method must return a StatusBase +then this method must return a StatusBase object which is already completed.

          Returns:
          -

          status (StatusBase) – StatusBase object which will be marked +

          status (StatusBase) – StatusBase object which will be marked as complete when the device is ready to be read.

          @@ -421,7 +417,7 @@

          pcdsdevices.example.Example3D
          -subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})
          +subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})

          diff --git a/master/generated/pcdsdevices.example.Example3DStates.html b/master/generated/pcdsdevices.example.Example3DStates.html index 7c70505dfb8..810723daa61 100644 --- a/master/generated/pcdsdevices.example.Example3DStates.html +++ b/master/generated/pcdsdevices.example.Example3DStates.html @@ -1,25 +1,23 @@ + + - pcdsdevices.example.Example3DStates — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.example.Example3DStates — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -
          - 8.5.1.dev30+gd6e98430 -
          @@ -91,6 +86,7 @@
        • pcdsdevices.ipm
        • pcdsdevices.jet
        • pcdsdevices.keithley
        • +
        • pcdsdevices.lakeshore
        • pcdsdevices.lamp_motion
        • pcdsdevices.lasers.btps
        • pcdsdevices.lasers.counters
        • @@ -331,14 +327,14 @@

          pcdsdevices.example.Example3DStates
          -configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]
          +configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]

          Configure the device for something during a run

          This default implementation allows the user to change any of the configuration_attrs. Subclasses might override this to perform additional input validation, cleanup, etc.

          Parameters:
          -

          d (dict) – The configuration dictionary. To specify the order that +

          d (dict) – The configuration dictionary. To specify the order that the changes should be made, use an OrderedDict.

          Returns:
          @@ -353,7 +349,7 @@

          pcdsdevices.example.Example3DStates
          -describe() OrderedDictType[str, Dict[str, Any]]
          +describe() OrderedDictType[str, Dict[str, Any]]

          Provide schema and meta-data for read().

          This keys in the OrderedDict this method returns must match the keys in the OrderedDict return by read().

          @@ -405,12 +401,12 @@

          pcdsdevices.example.Example3DStatesobj, which will be set to this instance.

          -
        • timeout (float, optional) – Maximum time to wait for the motion.

        • -
        • wait (bool, optional) – If True, do not continue until the move is complete.

        • +
        • timeout (float, optional) – Maximum time to wait for the motion.

        • +
        • wait (bool, optional) – If True, do not continue until the move is complete.

        • Returns:
          -

          moved_status (Status) – Status that will be marked as done when the motion is complete.

          +

          moved_status (Status) – Status that will be marked as done when the motion is complete.

          @@ -422,11 +418,11 @@

          pcdsdevices.example.Example3DStates
          Parameters:
            -
          • position (int or str) – The enumerate state or the corresponding integer.

          • +
          • position (int or str) – The enumerate state or the corresponding integer.

          • moved_cb (callable, optional) – Function to call at the end of motion. i.e. moved_cb(obj=self) will be called when move is complete.

          • -
          • timeout (int or float, optional) – Move timeout in seconds.

          • -
          • wait (bool, optional) – If True, do not return until the motion has completed.

          • +
          • timeout (int or float, optional) – Move timeout in seconds.

          • +
          • wait (bool, optional) – If True, do not return until the motion has completed.

          Returns:
          @@ -443,12 +439,12 @@

          pcdsdevices.example.Example3DStatesParameters:
          • position – Desired end position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • wait (bool, optional) – If True, wait for motion completion before returning. +

          • wait (bool, optional) – If True, wait for motion completion before returning. Defaults to False.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          @@ -462,7 +458,7 @@

          pcdsdevices.example.Example3DStates
          -read() OrderedDictType[str, Dict[str, Any]]
          +read() OrderedDictType[str, Dict[str, Any]]

          Read data from the device.

          This method is expected to be as instantaneous as possible, with any substantial acquisition time taken care of in @@ -485,7 +481,7 @@

          pcdsdevices.example.Example3DStates
          -read_configuration() OrderedDictType[str, Dict[str, Any]]
          +read_configuration() OrderedDictType[str, Dict[str, Any]]

          Dictionary mapping names to value dicts with keys: value, timestamp

          To control which fields are included, change the Component kinds on the device, or modify the configuration_attrs list.

          @@ -502,12 +498,12 @@

          pcdsdevices.example.Example3DStatesobj, which will be set to this instance.

          -
        • timeout (float, optional) – Maximum time to wait for the motion.

        • -
        • wait (bool, optional) – If True, do not continue until the move is complete.

        • +
        • timeout (float, optional) – Maximum time to wait for the motion.

        • +
        • wait (bool, optional) – If True, do not continue until the move is complete.

        • Returns:
          -

          moved_status (Status) – Status that will be marked as done when the motion is complete.

          +

          moved_status (Status) – Status that will be marked as done when the motion is complete.

          @@ -531,10 +527,10 @@

          pcdsdevices.example.Example3DStates
          Parameters:
            -
          • position (int or str) – The enumerate state or the corresponding integer.

          • +
          • position (int or str) – The enumerate state or the corresponding integer.

          • moved_cb (callable, optional) – Function to call at the end of motion. i.e. moved_cb(obj=self) will be called when move is complete.

          • -
          • timeout (int or float, optional) – Move timeout in seconds.

          • +
          • timeout (int or float, optional) – Move timeout in seconds.

          Returns:
          @@ -545,7 +541,7 @@

          pcdsdevices.example.Example3DStates
          -status() str
          +status() str

          Returns a str with the current pv values for the device.

          @@ -556,7 +552,7 @@

          pcdsdevices.example.Example3DStates
          -trigger() StatusBase
          +trigger() StatusBase

          Trigger the device and return status object.

          This method is responsible for implementing ‘trigger’ or ‘acquire’ functionality of this device.

          @@ -564,14 +560,14 @@

          pcdsdevices.example.Example3DStatesread() method) then this method is also responsible for arranging that the -StatusBase object returned by this method +StatusBase object returned by this method is notified when the device is ready to be read.

          If there is no delay between triggering and being readable, -then this method must return a StatusBase +then this method must return a StatusBase object which is already completed.

          Returns:
          -

          status (StatusBase) – StatusBase object which will be marked +

          status (StatusBase) – StatusBase object which will be marked as complete when the device is ready to be read.

          @@ -689,7 +685,7 @@

          pcdsdevices.example.Example3DStates
          -subscriptions: ClassVar[FrozenSet[str]] = frozenset({'_req_done', 'acq_done', 'done_moving', 'readback', 'start_moving', 'state'})
          +subscriptions: ClassVar[FrozenSet[str]] = frozenset({'_req_done', 'acq_done', 'done_moving', 'readback', 'start_moving', 'state'})
          diff --git a/master/generated/pcdsdevices.example.ExampleL2L.html b/master/generated/pcdsdevices.example.ExampleL2L.html index f8c6afda1cc..2e54fbdfd76 100644 --- a/master/generated/pcdsdevices.example.ExampleL2L.html +++ b/master/generated/pcdsdevices.example.ExampleL2L.html @@ -1,25 +1,23 @@ + + - pcdsdevices.example.ExampleL2L — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.example.ExampleL2L — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -
          - 8.5.1.dev30+gd6e98430 -
          @@ -91,6 +86,7 @@
        • pcdsdevices.ipm
        • pcdsdevices.jet
        • pcdsdevices.keithley
        • +
        • pcdsdevices.lakeshore
        • pcdsdevices.lamp_motion
        • pcdsdevices.lasers.btps
        • pcdsdevices.lasers.counters
        • @@ -241,14 +237,14 @@

          pcdsdevices.example.ExampleL2LMethods

          -configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]
          +configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]

          Configure the device for something during a run

          This default implementation allows the user to change any of the configuration_attrs. Subclasses might override this to perform additional input validation, cleanup, etc.

          Parameters:
          -

          d (dict) – The configuration dictionary. To specify the order that +

          d (dict) – The configuration dictionary. To specify the order that the changes should be made, use an OrderedDict.

          Returns:
          @@ -263,7 +259,7 @@

          pcdsdevices.example.ExampleL2L
          -describe() OrderedDictType[str, Dict[str, Any]]
          +describe() OrderedDictType[str, Dict[str, Any]]

          Provide schema and meta-data for read().

          This keys in the OrderedDict this method returns must match the keys in the OrderedDict return by read().

          @@ -293,7 +289,7 @@

          pcdsdevices.example.ExampleL2L
          -read() OrderedDictType[str, Dict[str, Any]]
          +read() OrderedDictType[str, Dict[str, Any]]

          Read data from the device.

          This method is expected to be as instantaneous as possible, with any substantial acquisition time taken care of in @@ -316,7 +312,7 @@

          pcdsdevices.example.ExampleL2L
          -read_configuration() OrderedDictType[str, Dict[str, Any]]
          +read_configuration() OrderedDictType[str, Dict[str, Any]]

          Dictionary mapping names to value dicts with keys: value, timestamp

          To control which fields are included, change the Component kinds on the device, or modify the configuration_attrs list.

          @@ -332,7 +328,7 @@

          pcdsdevices.example.ExampleL2L
          -status() str
          +status() str

          Returns a str with the current pv values for the device.

          @@ -349,7 +345,7 @@

          pcdsdevices.example.ExampleL2L
          -trigger() StatusBase
          +trigger() StatusBase

          Trigger the device and return status object.

          This method is responsible for implementing ‘trigger’ or ‘acquire’ functionality of this device.

          @@ -357,14 +353,14 @@

          pcdsdevices.example.ExampleL2Lread() method) then this method is also responsible for arranging that the -StatusBase object returned by this method +StatusBase object returned by this method is notified when the device is ready to be read.

          If there is no delay between triggering and being readable, -then this method must return a StatusBase +then this method must return a StatusBase object which is already completed.

          Returns:
          -

          status (StatusBase) – StatusBase object which will be marked +

          status (StatusBase) – StatusBase object which will be marked as complete when the device is ready to be read.

          @@ -393,7 +389,7 @@

          pcdsdevices.example.ExampleL2L
          -subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})
          +subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})

          diff --git a/master/generated/pcdsdevices.example.ExampleL2LStates.html b/master/generated/pcdsdevices.example.ExampleL2LStates.html index 5342626d09c..fae7f8880c8 100644 --- a/master/generated/pcdsdevices.example.ExampleL2LStates.html +++ b/master/generated/pcdsdevices.example.ExampleL2LStates.html @@ -1,25 +1,23 @@ + + - pcdsdevices.example.ExampleL2LStates — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.example.ExampleL2LStates — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -
          - 8.5.1.dev30+gd6e98430 -
          @@ -91,6 +86,7 @@
        • pcdsdevices.ipm
        • pcdsdevices.jet
        • pcdsdevices.keithley
        • +
        • pcdsdevices.lakeshore
        • pcdsdevices.lamp_motion
        • pcdsdevices.lasers.btps
        • pcdsdevices.lasers.counters
        • @@ -318,14 +314,14 @@

          pcdsdevices.example.ExampleL2LStates
          -configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]
          +configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]

          Configure the device for something during a run

          This default implementation allows the user to change any of the configuration_attrs. Subclasses might override this to perform additional input validation, cleanup, etc.

          Parameters:
          -

          d (dict) – The configuration dictionary. To specify the order that +

          d (dict) – The configuration dictionary. To specify the order that the changes should be made, use an OrderedDict.

          Returns:
          @@ -340,7 +336,7 @@

          pcdsdevices.example.ExampleL2LStates
          -describe() OrderedDictType[str, Dict[str, Any]]
          +describe() OrderedDictType[str, Dict[str, Any]]

          Provide schema and meta-data for read().

          This keys in the OrderedDict this method returns must match the keys in the OrderedDict return by read().

          @@ -392,12 +388,12 @@

          pcdsdevices.example.ExampleL2LStatesobj, which will be set to this instance.

          -
        • timeout (float, optional) – Maximum time to wait for the motion.

        • -
        • wait (bool, optional) – If True, do not continue until the move is complete.

        • +
        • timeout (float, optional) – Maximum time to wait for the motion.

        • +
        • wait (bool, optional) – If True, do not continue until the move is complete.

        • Returns:
          -

          moved_status (Status) – Status that will be marked as done when the motion is complete.

          +

          moved_status (Status) – Status that will be marked as done when the motion is complete.

          @@ -409,11 +405,11 @@

          pcdsdevices.example.ExampleL2LStates
          Parameters:
            -
          • position (int or str) – The enumerate state or the corresponding integer.

          • +
          • position (int or str) – The enumerate state or the corresponding integer.

          • moved_cb (callable, optional) – Function to call at the end of motion. i.e. moved_cb(obj=self) will be called when move is complete.

          • -
          • timeout (int or float, optional) – Move timeout in seconds.

          • -
          • wait (bool, optional) – If True, do not return until the motion has completed.

          • +
          • timeout (int or float, optional) – Move timeout in seconds.

          • +
          • wait (bool, optional) – If True, do not return until the motion has completed.

          Returns:
          @@ -430,12 +426,12 @@

          pcdsdevices.example.ExampleL2LStatesParameters:
          • position – Desired end position.

          • -
          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer +

          • timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

          • -
          • wait (bool, optional) – If True, wait for motion completion before returning. +

          • wait (bool, optional) – If True, wait for motion completion before returning. Defaults to False.

          • -
          • log (bool, optional) – If True, logs the move at INFO level.

          • +
          • log (bool, optional) – If True, logs the move at INFO level.

          @@ -449,7 +445,7 @@

          pcdsdevices.example.ExampleL2LStates
          -read() OrderedDictType[str, Dict[str, Any]]
          +read() OrderedDictType[str, Dict[str, Any]]

          Read data from the device.

          This method is expected to be as instantaneous as possible, with any substantial acquisition time taken care of in @@ -472,7 +468,7 @@

          pcdsdevices.example.ExampleL2LStates
          -read_configuration() OrderedDictType[str, Dict[str, Any]]
          +read_configuration() OrderedDictType[str, Dict[str, Any]]

          Dictionary mapping names to value dicts with keys: value, timestamp

          To control which fields are included, change the Component kinds on the device, or modify the configuration_attrs list.

          @@ -489,12 +485,12 @@

          pcdsdevices.example.ExampleL2LStatesobj, which will be set to this instance.

          -
        • timeout (float, optional) – Maximum time to wait for the motion.

        • -
        • wait (bool, optional) – If True, do not continue until the move is complete.

        • +
        • timeout (float, optional) – Maximum time to wait for the motion.

        • +
        • wait (bool, optional) – If True, do not continue until the move is complete.

        • Returns:
          -

          moved_status (Status) – Status that will be marked as done when the motion is complete.

          +

          moved_status (Status) – Status that will be marked as done when the motion is complete.

          @@ -518,10 +514,10 @@

          pcdsdevices.example.ExampleL2LStates
          Parameters:
            -
          • position (int or str) – The enumerate state or the corresponding integer.

          • +
          • position (int or str) – The enumerate state or the corresponding integer.

          • moved_cb (callable, optional) – Function to call at the end of motion. i.e. moved_cb(obj=self) will be called when move is complete.

          • -
          • timeout (int or float, optional) – Move timeout in seconds.

          • +
          • timeout (int or float, optional) – Move timeout in seconds.

          Returns:
          @@ -532,7 +528,7 @@

          pcdsdevices.example.ExampleL2LStates
          -status() str
          +status() str

          Returns a str with the current pv values for the device.

          @@ -543,7 +539,7 @@

          pcdsdevices.example.ExampleL2LStates
          -trigger() StatusBase
          +trigger() StatusBase

          Trigger the device and return status object.

          This method is responsible for implementing ‘trigger’ or ‘acquire’ functionality of this device.

          @@ -551,14 +547,14 @@

          pcdsdevices.example.ExampleL2LStatesread() method) then this method is also responsible for arranging that the -StatusBase object returned by this method +StatusBase object returned by this method is notified when the device is ready to be read.

          If there is no delay between triggering and being readable, -then this method must return a StatusBase +then this method must return a StatusBase object which is already completed.

          Returns:
          -

          status (StatusBase) – StatusBase object which will be marked +

          status (StatusBase) – StatusBase object which will be marked as complete when the device is ready to be read.

          @@ -676,7 +672,7 @@

          pcdsdevices.example.ExampleL2LStates
          -subscriptions: ClassVar[FrozenSet[str]] = frozenset({'_req_done', 'acq_done', 'done_moving', 'readback', 'start_moving', 'state'})
          +subscriptions: ClassVar[FrozenSet[str]] = frozenset({'_req_done', 'acq_done', 'done_moving', 'readback', 'start_moving', 'state'})
          diff --git a/master/generated/pcdsdevices.example.PLCExampleMotion.html b/master/generated/pcdsdevices.example.PLCExampleMotion.html index b28d9e983f2..926e3ecdad6 100644 --- a/master/generated/pcdsdevices.example.PLCExampleMotion.html +++ b/master/generated/pcdsdevices.example.PLCExampleMotion.html @@ -1,25 +1,23 @@ + + - pcdsdevices.example.PLCExampleMotion — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.example.PLCExampleMotion — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -
          - 8.5.1.dev30+gd6e98430 -
          @@ -91,6 +86,7 @@
        • pcdsdevices.ipm
        • pcdsdevices.jet
        • pcdsdevices.keithley
        • +
        • pcdsdevices.lakeshore
        • pcdsdevices.lamp_motion
        • pcdsdevices.lasers.btps
        • pcdsdevices.lasers.counters
        • @@ -200,7 +196,7 @@

          pcdsdevices.example.PLCExampleMotion

          -class pcdsdevices.example.PLCExampleMotion(prefix: str = 'PLC:TST:MOT:', name: str = 'plc_example_motion')
          +class pcdsdevices.example.PLCExampleMotion(prefix: str = 'PLC:TST:MOT:', name: str = 'plc_example_motion')

          This matches the IOC for lcls-plc-example-motion

          It can be ran as a typhos screen using: typhos pcdsdevices.example.PLCExampleMotion[]

          @@ -269,21 +265,21 @@

          pcdsdevices.example.PLCExampleMotionMethods

          -all_pvnames() list[str]
          +all_pvnames() list[str]

          Get all the pvnames that should be included in the IOC.

          This is to help with debugging.

          -configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]
          +configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]

          Configure the device for something during a run

          This default implementation allows the user to change any of the configuration_attrs. Subclasses might override this to perform additional input validation, cleanup, etc.

          Parameters:
          -

          d (dict) – The configuration dictionary. To specify the order that +

          d (dict) – The configuration dictionary. To specify the order that the changes should be made, use an OrderedDict.

          Returns:
          @@ -298,7 +294,7 @@

          pcdsdevices.example.PLCExampleMotion
          -describe() OrderedDictType[str, Dict[str, Any]]
          +describe() OrderedDictType[str, Dict[str, Any]]

          Provide schema and meta-data for read().

          This keys in the OrderedDict this method returns must match the keys in the OrderedDict return by read().

          @@ -314,7 +310,7 @@

          pcdsdevices.example.PLCExampleMotion
          -disconnected_pvnames() list[str]
          +disconnected_pvnames() list[str]

          Get all of the pvnames that are currently disconnected.

          This is to help with debugging.

          @@ -335,7 +331,7 @@

          pcdsdevices.example.PLCExampleMotion
          -read() OrderedDictType[str, Dict[str, Any]]
          +read() OrderedDictType[str, Dict[str, Any]]

          Read data from the device.

          This method is expected to be as instantaneous as possible, with any substantial acquisition time taken care of in @@ -358,7 +354,7 @@

          pcdsdevices.example.PLCExampleMotion
          -read_configuration() OrderedDictType[str, Dict[str, Any]]
          +read_configuration() OrderedDictType[str, Dict[str, Any]]

          Dictionary mapping names to value dicts with keys: value, timestamp

          To control which fields are included, change the Component kinds on the device, or modify the configuration_attrs list.

          @@ -374,7 +370,7 @@

          pcdsdevices.example.PLCExampleMotion
          -status() str
          +status() str

          Returns a str with the current pv values for the device.

          @@ -391,7 +387,7 @@

          pcdsdevices.example.PLCExampleMotion
          -trigger() StatusBase
          +trigger() StatusBase

          Trigger the device and return status object.

          This method is responsible for implementing ‘trigger’ or ‘acquire’ functionality of this device.

          @@ -399,14 +395,14 @@

          pcdsdevices.example.PLCExampleMotionread() method) then this method is also responsible for arranging that the -StatusBase object returned by this method +StatusBase object returned by this method is notified when the device is ready to be read.

          If there is no delay between triggering and being readable, -then this method must return a StatusBase +then this method must return a StatusBase object which is already completed.

          Returns:
          -

          status (StatusBase) – StatusBase object which will be marked +

          status (StatusBase) – StatusBase object which will be marked as complete when the device is ready to be read.

          @@ -435,7 +431,7 @@

          pcdsdevices.example.PLCExampleMotion
          -subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})
          +subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})

          diff --git a/master/generated/pcdsdevices.example.PLCOnlyXPIM.html b/master/generated/pcdsdevices.example.PLCOnlyXPIM.html index 23b47c07b0c..0e76468035c 100644 --- a/master/generated/pcdsdevices.example.PLCOnlyXPIM.html +++ b/master/generated/pcdsdevices.example.PLCOnlyXPIM.html @@ -1,25 +1,23 @@ + + - pcdsdevices.example.PLCOnlyXPIM — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.example.PLCOnlyXPIM — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -
          - 8.5.1.dev30+gd6e98430 -
          @@ -91,6 +86,7 @@
        • pcdsdevices.ipm
        • pcdsdevices.jet
        • pcdsdevices.keithley
        • +
        • pcdsdevices.lakeshore
        • pcdsdevices.lamp_motion
        • pcdsdevices.lasers.btps
        • pcdsdevices.lasers.counters
        • @@ -312,14 +308,14 @@

          pcdsdevices.example.PLCOnlyXPIM
          -configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]
          +configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]

          Configure the device for something during a run

          This default implementation allows the user to change any of the configuration_attrs. Subclasses might override this to perform additional input validation, cleanup, etc.

          Parameters:
          -

          d (dict) – The configuration dictionary. To specify the order that +

          d (dict) – The configuration dictionary. To specify the order that the changes should be made, use an OrderedDict.

          Returns:
          @@ -334,7 +330,7 @@

          pcdsdevices.example.PLCOnlyXPIM
          -describe() OrderedDictType[str, Dict[str, Any]]
          +describe() OrderedDictType[str, Dict[str, Any]]

          Provide schema and meta-data for read().

          This keys in the OrderedDict this method returns must match the keys in the OrderedDict return by read().

          @@ -358,7 +354,7 @@

          pcdsdevices.example.PLCOnlyXPIM
          -get_lightpath_state(use_cache: bool = True) LightpathState
          +get_lightpath_state(use_cache: bool = True) LightpathState

          Return the current LightpathState

          Returns:
          @@ -375,7 +371,7 @@

          pcdsdevices.example.PLCOnlyXPIM
          -read() OrderedDictType[str, Dict[str, Any]]
          +read() OrderedDictType[str, Dict[str, Any]]

          Read data from the device.

          This method is expected to be as instantaneous as possible, with any substantial acquisition time taken care of in @@ -398,7 +394,7 @@

          pcdsdevices.example.PLCOnlyXPIM
          -read_configuration() OrderedDictType[str, Dict[str, Any]]
          +read_configuration() OrderedDictType[str, Dict[str, Any]]

          Dictionary mapping names to value dicts with keys: value, timestamp

          To control which fields are included, change the Component kinds on the device, or modify the configuration_attrs list.

          @@ -414,13 +410,13 @@

          pcdsdevices.example.PLCOnlyXPIM
          -stage_group_instances() Iterator[OphydObject]
          +stage_group_instances() Iterator[OphydObject]

          Yields an iterator of subdevices that should be staged.

          -status() str
          +status() str

          Returns a str with the current pv values for the device.

          @@ -437,7 +433,7 @@

          pcdsdevices.example.PLCOnlyXPIM
          -trigger() StatusBase
          +trigger() StatusBase

          Trigger the device and return status object.

          This method is responsible for implementing ‘trigger’ or ‘acquire’ functionality of this device.

          @@ -445,14 +441,14 @@

          pcdsdevices.example.PLCOnlyXPIMread() method) then this method is also responsible for arranging that the -StatusBase object returned by this method +StatusBase object returned by this method is notified when the device is ready to be read.

          If there is no delay between triggering and being readable, -then this method must return a StatusBase +then this method must return a StatusBase object which is already completed.

          Returns:
          -

          status (StatusBase) – StatusBase object which will be marked +

          status (StatusBase) – StatusBase object which will be marked as complete when the device is ready to be read.

          @@ -496,17 +492,17 @@

          pcdsdevices.example.PLCOnlyXPIM
          -needs_parent: list[type[OphydObject]] = [<class 'ophyd.signal.AttributeSignal'>, <class 'ophyd.signal.DerivedSignal'>, <class 'ophyd.areadetector.plugins.PluginBase'>, <class 'ophyd.pseudopos.PseudoSingle'>, <class 'pcdsdevices.signal.PVStateSignal'>, <class 'pcdsdevices.signal.AggregateSignal'>]
          +needs_parent: list[type[OphydObject]] = [<class 'ophyd.signal.AttributeSignal'>, <class 'ophyd.signal.DerivedSignal'>, <class 'ophyd.areadetector.plugins.PluginBase'>, <class 'ophyd.pseudopos.PseudoSingle'>, <class 'pcdsdevices.signal.PVStateSignal'>, <class 'pcdsdevices.signal.AggregateSignal'>]

          -stage_group: list[Component] = None
          +stage_group: list[Component] = None
          -subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})
          +subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})
          diff --git a/master/generated/pcdsdevices.fms.LCP1.html b/master/generated/pcdsdevices.fms.LCP1.html index 69ac746f6f3..be23e229dd4 100644 --- a/master/generated/pcdsdevices.fms.LCP1.html +++ b/master/generated/pcdsdevices.fms.LCP1.html @@ -1,25 +1,23 @@ + + - pcdsdevices.fms.LCP1 — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.fms.LCP1 — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -
          - 8.5.1.dev30+gd6e98430 -
          @@ -100,6 +95,7 @@
        • pcdsdevices.ipm
        • pcdsdevices.jet
        • pcdsdevices.keithley
        • +
        • pcdsdevices.lakeshore
        • pcdsdevices.lamp_motion
        • pcdsdevices.lasers.btps
        • pcdsdevices.lasers.counters
        • @@ -347,14 +343,14 @@

          pcdsdevices.fms.LCP1Methods

          -configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]
          +configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]

          Configure the device for something during a run

          This default implementation allows the user to change any of the configuration_attrs. Subclasses might override this to perform additional input validation, cleanup, etc.

          Parameters:
          -

          d (dict) – The configuration dictionary. To specify the order that +

          d (dict) – The configuration dictionary. To specify the order that the changes should be made, use an OrderedDict.

          Returns:
          @@ -369,7 +365,7 @@

          pcdsdevices.fms.LCP1
          -describe() OrderedDictType[str, Dict[str, Any]]
          +describe() OrderedDictType[str, Dict[str, Any]]

          Provide schema and meta-data for read().

          This keys in the OrderedDict this method returns must match the keys in the OrderedDict return by read().

          @@ -393,7 +389,7 @@

          pcdsdevices.fms.LCP1
          -read() OrderedDictType[str, Dict[str, Any]]
          +read() OrderedDictType[str, Dict[str, Any]]

          Read data from the device.

          This method is expected to be as instantaneous as possible, with any substantial acquisition time taken care of in @@ -416,7 +412,7 @@

          pcdsdevices.fms.LCP1
          -read_configuration() OrderedDictType[str, Dict[str, Any]]
          +read_configuration() OrderedDictType[str, Dict[str, Any]]

          Dictionary mapping names to value dicts with keys: value, timestamp

          To control which fields are included, change the Component kinds on the device, or modify the configuration_attrs list.

          @@ -435,7 +431,7 @@

          pcdsdevices.fms.LCP1
          -trigger() StatusBase
          +trigger() StatusBase

          Trigger the device and return status object.

          This method is responsible for implementing ‘trigger’ or ‘acquire’ functionality of this device.

          @@ -443,14 +439,14 @@

          pcdsdevices.fms.LCP1read() method) then this method is also responsible for arranging that the -StatusBase object returned by this method +StatusBase object returned by this method is notified when the device is ready to be read.

          If there is no delay between triggering and being readable, -then this method must return a StatusBase +then this method must return a StatusBase object which is already completed.

          Returns:
          -

          status (StatusBase) – StatusBase object which will be marked +

          status (StatusBase) – StatusBase object which will be marked as complete when the device is ready to be read.

          @@ -479,7 +475,7 @@

          pcdsdevices.fms.LCP1
          -subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})
          +subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})

          diff --git a/master/generated/pcdsdevices.fms.LCP2.html b/master/generated/pcdsdevices.fms.LCP2.html index 4867129043d..6aa5206e783 100644 --- a/master/generated/pcdsdevices.fms.LCP2.html +++ b/master/generated/pcdsdevices.fms.LCP2.html @@ -1,25 +1,23 @@ + + - pcdsdevices.fms.LCP2 — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.fms.LCP2 — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -
          - 8.5.1.dev30+gd6e98430 -
          @@ -100,6 +95,7 @@
        • pcdsdevices.ipm
        • pcdsdevices.jet
        • pcdsdevices.keithley
        • +
        • pcdsdevices.lakeshore
        • pcdsdevices.lamp_motion
        • pcdsdevices.lasers.btps
        • pcdsdevices.lasers.counters
        • @@ -361,14 +357,14 @@

          pcdsdevices.fms.LCP2Methods

          -configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]
          +configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]

          Configure the device for something during a run

          This default implementation allows the user to change any of the configuration_attrs. Subclasses might override this to perform additional input validation, cleanup, etc.

          Parameters:
          -

          d (dict) – The configuration dictionary. To specify the order that +

          d (dict) – The configuration dictionary. To specify the order that the changes should be made, use an OrderedDict.

          Returns:
          @@ -383,7 +379,7 @@

          pcdsdevices.fms.LCP2
          -describe() OrderedDictType[str, Dict[str, Any]]
          +describe() OrderedDictType[str, Dict[str, Any]]

          Provide schema and meta-data for read().

          This keys in the OrderedDict this method returns must match the keys in the OrderedDict return by read().

          @@ -407,7 +403,7 @@

          pcdsdevices.fms.LCP2
          -read() OrderedDictType[str, Dict[str, Any]]
          +read() OrderedDictType[str, Dict[str, Any]]

          Read data from the device.

          This method is expected to be as instantaneous as possible, with any substantial acquisition time taken care of in @@ -430,7 +426,7 @@

          pcdsdevices.fms.LCP2
          -read_configuration() OrderedDictType[str, Dict[str, Any]]
          +read_configuration() OrderedDictType[str, Dict[str, Any]]

          Dictionary mapping names to value dicts with keys: value, timestamp

          To control which fields are included, change the Component kinds on the device, or modify the configuration_attrs list.

          @@ -449,7 +445,7 @@

          pcdsdevices.fms.LCP2
          -trigger() StatusBase
          +trigger() StatusBase

          Trigger the device and return status object.

          This method is responsible for implementing ‘trigger’ or ‘acquire’ functionality of this device.

          @@ -457,14 +453,14 @@

          pcdsdevices.fms.LCP2read() method) then this method is also responsible for arranging that the -StatusBase object returned by this method +StatusBase object returned by this method is notified when the device is ready to be read.

          If there is no delay between triggering and being readable, -then this method must return a StatusBase +then this method must return a StatusBase object which is already completed.

          Returns:
          -

          status (StatusBase) – StatusBase object which will be marked +

          status (StatusBase) – StatusBase object which will be marked as complete when the device is ready to be read.

          @@ -493,7 +489,7 @@

          pcdsdevices.fms.LCP2
          -subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})
          +subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})

          diff --git a/master/generated/pcdsdevices.fms.PDU_Humidity2.html b/master/generated/pcdsdevices.fms.PDU_Humidity2.html index bb01802e042..c8d52585f2e 100644 --- a/master/generated/pcdsdevices.fms.PDU_Humidity2.html +++ b/master/generated/pcdsdevices.fms.PDU_Humidity2.html @@ -1,25 +1,23 @@ + + - pcdsdevices.fms.PDU_Humidity2 — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.fms.PDU_Humidity2 — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -
          - 8.5.1.dev30+gd6e98430 -
          @@ -100,6 +95,7 @@
        • pcdsdevices.ipm
        • pcdsdevices.jet
        • pcdsdevices.keithley
        • +
        • pcdsdevices.lakeshore
        • pcdsdevices.lamp_motion
        • pcdsdevices.lasers.btps
        • pcdsdevices.lasers.counters
        • @@ -243,14 +239,14 @@

          pcdsdevices.fms.PDU_Humidity2Methods

          -configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]
          +configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]

          Configure the device for something during a run

          This default implementation allows the user to change any of the configuration_attrs. Subclasses might override this to perform additional input validation, cleanup, etc.

          Parameters:
          -

          d (dict) – The configuration dictionary. To specify the order that +

          d (dict) – The configuration dictionary. To specify the order that the changes should be made, use an OrderedDict.

          Returns:
          @@ -265,7 +261,7 @@

          pcdsdevices.fms.PDU_Humidity2
          -describe() OrderedDictType[str, Dict[str, Any]]
          +describe() OrderedDictType[str, Dict[str, Any]]

          Provide schema and meta-data for read().

          This keys in the OrderedDict this method returns must match the keys in the OrderedDict return by read().

          @@ -289,7 +285,7 @@

          pcdsdevices.fms.PDU_Humidity2
          -read() OrderedDictType[str, Dict[str, Any]]
          +read() OrderedDictType[str, Dict[str, Any]]

          Read data from the device.

          This method is expected to be as instantaneous as possible, with any substantial acquisition time taken care of in @@ -312,7 +308,7 @@

          pcdsdevices.fms.PDU_Humidity2
          -read_configuration() OrderedDictType[str, Dict[str, Any]]
          +read_configuration() OrderedDictType[str, Dict[str, Any]]

          Dictionary mapping names to value dicts with keys: value, timestamp

          To control which fields are included, change the Component kinds on the device, or modify the configuration_attrs list.

          @@ -331,7 +327,7 @@

          pcdsdevices.fms.PDU_Humidity2
          -trigger() StatusBase
          +trigger() StatusBase

          Trigger the device and return status object.

          This method is responsible for implementing ‘trigger’ or ‘acquire’ functionality of this device.

          @@ -339,14 +335,14 @@

          pcdsdevices.fms.PDU_Humidity2read() method) then this method is also responsible for arranging that the -StatusBase object returned by this method +StatusBase object returned by this method is notified when the device is ready to be read.

          If there is no delay between triggering and being readable, -then this method must return a StatusBase +then this method must return a StatusBase object which is already completed.

          Returns:
          -

          status (StatusBase) – StatusBase object which will be marked +

          status (StatusBase) – StatusBase object which will be marked as complete when the device is ready to be read.

          @@ -375,7 +371,7 @@

          pcdsdevices.fms.PDU_Humidity2
          -subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})
          +subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})

          diff --git a/master/generated/pcdsdevices.fms.PDU_Humidity4.html b/master/generated/pcdsdevices.fms.PDU_Humidity4.html index f58a711c845..595c5ac0035 100644 --- a/master/generated/pcdsdevices.fms.PDU_Humidity4.html +++ b/master/generated/pcdsdevices.fms.PDU_Humidity4.html @@ -1,25 +1,23 @@ + + - pcdsdevices.fms.PDU_Humidity4 — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.fms.PDU_Humidity4 — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -
          - 8.5.1.dev30+gd6e98430 -
          @@ -100,6 +95,7 @@
        • pcdsdevices.ipm
        • pcdsdevices.jet
        • pcdsdevices.keithley
        • +
        • pcdsdevices.lakeshore
        • pcdsdevices.lamp_motion
        • pcdsdevices.lasers.btps
        • pcdsdevices.lasers.counters
        • @@ -256,14 +252,14 @@

          pcdsdevices.fms.PDU_Humidity4Methods

          -configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]
          +configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]

          Configure the device for something during a run

          This default implementation allows the user to change any of the configuration_attrs. Subclasses might override this to perform additional input validation, cleanup, etc.

          Parameters:
          -

          d (dict) – The configuration dictionary. To specify the order that +

          d (dict) – The configuration dictionary. To specify the order that the changes should be made, use an OrderedDict.

          Returns:
          @@ -278,7 +274,7 @@

          pcdsdevices.fms.PDU_Humidity4
          -describe() OrderedDictType[str, Dict[str, Any]]
          +describe() OrderedDictType[str, Dict[str, Any]]

          Provide schema and meta-data for read().

          This keys in the OrderedDict this method returns must match the keys in the OrderedDict return by read().

          @@ -302,7 +298,7 @@

          pcdsdevices.fms.PDU_Humidity4
          -read() OrderedDictType[str, Dict[str, Any]]
          +read() OrderedDictType[str, Dict[str, Any]]

          Read data from the device.

          This method is expected to be as instantaneous as possible, with any substantial acquisition time taken care of in @@ -325,7 +321,7 @@

          pcdsdevices.fms.PDU_Humidity4
          -read_configuration() OrderedDictType[str, Dict[str, Any]]
          +read_configuration() OrderedDictType[str, Dict[str, Any]]

          Dictionary mapping names to value dicts with keys: value, timestamp

          To control which fields are included, change the Component kinds on the device, or modify the configuration_attrs list.

          @@ -344,7 +340,7 @@

          pcdsdevices.fms.PDU_Humidity4
          -trigger() StatusBase
          +trigger() StatusBase

          Trigger the device and return status object.

          This method is responsible for implementing ‘trigger’ or ‘acquire’ functionality of this device.

          @@ -352,14 +348,14 @@

          pcdsdevices.fms.PDU_Humidity4read() method) then this method is also responsible for arranging that the -StatusBase object returned by this method +StatusBase object returned by this method is notified when the device is ready to be read.

          If there is no delay between triggering and being readable, -then this method must return a StatusBase +then this method must return a StatusBase object which is already completed.

          Returns:
          -

          status (StatusBase) – StatusBase object which will be marked +

          status (StatusBase) – StatusBase object which will be marked as complete when the device is ready to be read.

          @@ -388,7 +384,7 @@

          pcdsdevices.fms.PDU_Humidity4
          -subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})
          +subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})

          diff --git a/master/generated/pcdsdevices.fms.PDU_Humidity6.html b/master/generated/pcdsdevices.fms.PDU_Humidity6.html index 96c86989257..a026936051c 100644 --- a/master/generated/pcdsdevices.fms.PDU_Humidity6.html +++ b/master/generated/pcdsdevices.fms.PDU_Humidity6.html @@ -1,25 +1,23 @@ + + - pcdsdevices.fms.PDU_Humidity6 — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.fms.PDU_Humidity6 — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -
          - 8.5.1.dev30+gd6e98430 -
          @@ -100,6 +95,7 @@
        • pcdsdevices.ipm
        • pcdsdevices.jet
        • pcdsdevices.keithley
        • +
        • pcdsdevices.lakeshore
        • pcdsdevices.lamp_motion
        • pcdsdevices.lasers.btps
        • pcdsdevices.lasers.counters
        • @@ -271,14 +267,14 @@

          pcdsdevices.fms.PDU_Humidity6Methods

          -configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]
          +configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]

          Configure the device for something during a run

          This default implementation allows the user to change any of the configuration_attrs. Subclasses might override this to perform additional input validation, cleanup, etc.

          Parameters:
          -

          d (dict) – The configuration dictionary. To specify the order that +

          d (dict) – The configuration dictionary. To specify the order that the changes should be made, use an OrderedDict.

          Returns:
          @@ -293,7 +289,7 @@

          pcdsdevices.fms.PDU_Humidity6
          -describe() OrderedDictType[str, Dict[str, Any]]
          +describe() OrderedDictType[str, Dict[str, Any]]

          Provide schema and meta-data for read().

          This keys in the OrderedDict this method returns must match the keys in the OrderedDict return by read().

          @@ -317,7 +313,7 @@

          pcdsdevices.fms.PDU_Humidity6
          -read() OrderedDictType[str, Dict[str, Any]]
          +read() OrderedDictType[str, Dict[str, Any]]

          Read data from the device.

          This method is expected to be as instantaneous as possible, with any substantial acquisition time taken care of in @@ -340,7 +336,7 @@

          pcdsdevices.fms.PDU_Humidity6
          -read_configuration() OrderedDictType[str, Dict[str, Any]]
          +read_configuration() OrderedDictType[str, Dict[str, Any]]

          Dictionary mapping names to value dicts with keys: value, timestamp

          To control which fields are included, change the Component kinds on the device, or modify the configuration_attrs list.

          @@ -359,7 +355,7 @@

          pcdsdevices.fms.PDU_Humidity6
          -trigger() StatusBase
          +trigger() StatusBase

          Trigger the device and return status object.

          This method is responsible for implementing ‘trigger’ or ‘acquire’ functionality of this device.

          @@ -367,14 +363,14 @@

          pcdsdevices.fms.PDU_Humidity6read() method) then this method is also responsible for arranging that the -StatusBase object returned by this method +StatusBase object returned by this method is notified when the device is ready to be read.

          If there is no delay between triggering and being readable, -then this method must return a StatusBase +then this method must return a StatusBase object which is already completed.

          Returns:
          -

          status (StatusBase) – StatusBase object which will be marked +

          status (StatusBase) – StatusBase object which will be marked as complete when the device is ready to be read.

          @@ -403,7 +399,7 @@

          pcdsdevices.fms.PDU_Humidity6
          -subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})
          +subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})

          diff --git a/master/generated/pcdsdevices.fms.PDU_Humidity8.html b/master/generated/pcdsdevices.fms.PDU_Humidity8.html index 93125dbb886..1a4a981c9a8 100644 --- a/master/generated/pcdsdevices.fms.PDU_Humidity8.html +++ b/master/generated/pcdsdevices.fms.PDU_Humidity8.html @@ -1,25 +1,23 @@ + + - pcdsdevices.fms.PDU_Humidity8 — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.fms.PDU_Humidity8 — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -
          - 8.5.1.dev30+gd6e98430 -
          @@ -100,6 +95,7 @@
        • pcdsdevices.ipm
        • pcdsdevices.jet
        • pcdsdevices.keithley
        • +
        • pcdsdevices.lakeshore
        • pcdsdevices.lamp_motion
        • pcdsdevices.lasers.btps
        • pcdsdevices.lasers.counters
        • @@ -285,14 +281,14 @@

          pcdsdevices.fms.PDU_Humidity8Methods

          -configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]
          +configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]

          Configure the device for something during a run

          This default implementation allows the user to change any of the configuration_attrs. Subclasses might override this to perform additional input validation, cleanup, etc.

          Parameters:
          -

          d (dict) – The configuration dictionary. To specify the order that +

          d (dict) – The configuration dictionary. To specify the order that the changes should be made, use an OrderedDict.

          Returns:
          @@ -307,7 +303,7 @@

          pcdsdevices.fms.PDU_Humidity8
          -describe() OrderedDictType[str, Dict[str, Any]]
          +describe() OrderedDictType[str, Dict[str, Any]]

          Provide schema and meta-data for read().

          This keys in the OrderedDict this method returns must match the keys in the OrderedDict return by read().

          @@ -331,7 +327,7 @@

          pcdsdevices.fms.PDU_Humidity8
          -read() OrderedDictType[str, Dict[str, Any]]
          +read() OrderedDictType[str, Dict[str, Any]]

          Read data from the device.

          This method is expected to be as instantaneous as possible, with any substantial acquisition time taken care of in @@ -354,7 +350,7 @@

          pcdsdevices.fms.PDU_Humidity8
          -read_configuration() OrderedDictType[str, Dict[str, Any]]
          +read_configuration() OrderedDictType[str, Dict[str, Any]]

          Dictionary mapping names to value dicts with keys: value, timestamp

          To control which fields are included, change the Component kinds on the device, or modify the configuration_attrs list.

          @@ -373,7 +369,7 @@

          pcdsdevices.fms.PDU_Humidity8
          -trigger() StatusBase
          +trigger() StatusBase

          Trigger the device and return status object.

          This method is responsible for implementing ‘trigger’ or ‘acquire’ functionality of this device.

          @@ -381,14 +377,14 @@

          pcdsdevices.fms.PDU_Humidity8read() method) then this method is also responsible for arranging that the -StatusBase object returned by this method +StatusBase object returned by this method is notified when the device is ready to be read.

          If there is no delay between triggering and being readable, -then this method must return a StatusBase +then this method must return a StatusBase object which is already completed.

          Returns:
          -

          status (StatusBase) – StatusBase object which will be marked +

          status (StatusBase) – StatusBase object which will be marked as complete when the device is ready to be read.

          @@ -417,7 +413,7 @@

          pcdsdevices.fms.PDU_Humidity8
          -subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})
          +subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})

          diff --git a/master/generated/pcdsdevices.fms.PDU_Load1.html b/master/generated/pcdsdevices.fms.PDU_Load1.html index abb1bd3dcc9..7359ae84b26 100644 --- a/master/generated/pcdsdevices.fms.PDU_Load1.html +++ b/master/generated/pcdsdevices.fms.PDU_Load1.html @@ -1,25 +1,23 @@ + + - pcdsdevices.fms.PDU_Load1 — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.fms.PDU_Load1 — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -
          - 8.5.1.dev30+gd6e98430 -
          @@ -100,6 +95,7 @@
        • pcdsdevices.ipm
        • pcdsdevices.jet
        • pcdsdevices.keithley
        • +
        • pcdsdevices.lakeshore
        • pcdsdevices.lamp_motion
        • pcdsdevices.lasers.btps
        • pcdsdevices.lasers.counters
        • @@ -235,14 +231,14 @@

          pcdsdevices.fms.PDU_Load1Methods

          -configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]
          +configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]

          Configure the device for something during a run

          This default implementation allows the user to change any of the configuration_attrs. Subclasses might override this to perform additional input validation, cleanup, etc.

          Parameters:
          -

          d (dict) – The configuration dictionary. To specify the order that +

          d (dict) – The configuration dictionary. To specify the order that the changes should be made, use an OrderedDict.

          Returns:
          @@ -257,7 +253,7 @@

          pcdsdevices.fms.PDU_Load1
          -describe() OrderedDictType[str, Dict[str, Any]]
          +describe() OrderedDictType[str, Dict[str, Any]]

          Provide schema and meta-data for read().

          This keys in the OrderedDict this method returns must match the keys in the OrderedDict return by read().

          @@ -281,7 +277,7 @@

          pcdsdevices.fms.PDU_Load1
          -read() OrderedDictType[str, Dict[str, Any]]
          +read() OrderedDictType[str, Dict[str, Any]]

          Read data from the device.

          This method is expected to be as instantaneous as possible, with any substantial acquisition time taken care of in @@ -304,7 +300,7 @@

          pcdsdevices.fms.PDU_Load1
          -read_configuration() OrderedDictType[str, Dict[str, Any]]
          +read_configuration() OrderedDictType[str, Dict[str, Any]]

          Dictionary mapping names to value dicts with keys: value, timestamp

          To control which fields are included, change the Component kinds on the device, or modify the configuration_attrs list.

          @@ -323,7 +319,7 @@

          pcdsdevices.fms.PDU_Load1
          -trigger() StatusBase
          +trigger() StatusBase

          Trigger the device and return status object.

          This method is responsible for implementing ‘trigger’ or ‘acquire’ functionality of this device.

          @@ -331,14 +327,14 @@

          pcdsdevices.fms.PDU_Load1read() method) then this method is also responsible for arranging that the -StatusBase object returned by this method +StatusBase object returned by this method is notified when the device is ready to be read.

          If there is no delay between triggering and being readable, -then this method must return a StatusBase +then this method must return a StatusBase object which is already completed.

          Returns:
          -

          status (StatusBase) – StatusBase object which will be marked +

          status (StatusBase) – StatusBase object which will be marked as complete when the device is ready to be read.

          @@ -367,7 +363,7 @@

          pcdsdevices.fms.PDU_Load1
          -subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})
          +subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})

          diff --git a/master/generated/pcdsdevices.fms.PDU_Load2.html b/master/generated/pcdsdevices.fms.PDU_Load2.html index af23517b246..74829d378cf 100644 --- a/master/generated/pcdsdevices.fms.PDU_Load2.html +++ b/master/generated/pcdsdevices.fms.PDU_Load2.html @@ -1,25 +1,23 @@ + + - pcdsdevices.fms.PDU_Load2 — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.fms.PDU_Load2 — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -
          - 8.5.1.dev30+gd6e98430 -
          @@ -100,6 +95,7 @@
        • pcdsdevices.ipm
        • pcdsdevices.jet
        • pcdsdevices.keithley
        • +
        • pcdsdevices.lakeshore
        • pcdsdevices.lamp_motion
        • pcdsdevices.lasers.btps
        • pcdsdevices.lasers.counters
        • @@ -242,14 +238,14 @@

          pcdsdevices.fms.PDU_Load2Methods

          -configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]
          +configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]

          Configure the device for something during a run

          This default implementation allows the user to change any of the configuration_attrs. Subclasses might override this to perform additional input validation, cleanup, etc.

          Parameters:
          -

          d (dict) – The configuration dictionary. To specify the order that +

          d (dict) – The configuration dictionary. To specify the order that the changes should be made, use an OrderedDict.

          Returns:
          @@ -264,7 +260,7 @@

          pcdsdevices.fms.PDU_Load2
          -describe() OrderedDictType[str, Dict[str, Any]]
          +describe() OrderedDictType[str, Dict[str, Any]]

          Provide schema and meta-data for read().

          This keys in the OrderedDict this method returns must match the keys in the OrderedDict return by read().

          @@ -288,7 +284,7 @@

          pcdsdevices.fms.PDU_Load2
          -read() OrderedDictType[str, Dict[str, Any]]
          +read() OrderedDictType[str, Dict[str, Any]]

          Read data from the device.

          This method is expected to be as instantaneous as possible, with any substantial acquisition time taken care of in @@ -311,7 +307,7 @@

          pcdsdevices.fms.PDU_Load2
          -read_configuration() OrderedDictType[str, Dict[str, Any]]
          +read_configuration() OrderedDictType[str, Dict[str, Any]]

          Dictionary mapping names to value dicts with keys: value, timestamp

          To control which fields are included, change the Component kinds on the device, or modify the configuration_attrs list.

          @@ -330,7 +326,7 @@

          pcdsdevices.fms.PDU_Load2
          -trigger() StatusBase
          +trigger() StatusBase

          Trigger the device and return status object.

          This method is responsible for implementing ‘trigger’ or ‘acquire’ functionality of this device.

          @@ -338,14 +334,14 @@

          pcdsdevices.fms.PDU_Load2read() method) then this method is also responsible for arranging that the -StatusBase object returned by this method +StatusBase object returned by this method is notified when the device is ready to be read.

          If there is no delay between triggering and being readable, -then this method must return a StatusBase +then this method must return a StatusBase object which is already completed.

          Returns:
          -

          status (StatusBase) – StatusBase object which will be marked +

          status (StatusBase) – StatusBase object which will be marked as complete when the device is ready to be read.

          @@ -374,7 +370,7 @@

          pcdsdevices.fms.PDU_Load2
          -subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})
          +subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})

          diff --git a/master/generated/pcdsdevices.fms.PDU_Load3.html b/master/generated/pcdsdevices.fms.PDU_Load3.html index 682c09c00dd..8010fb5759a 100644 --- a/master/generated/pcdsdevices.fms.PDU_Load3.html +++ b/master/generated/pcdsdevices.fms.PDU_Load3.html @@ -1,25 +1,23 @@ + + - pcdsdevices.fms.PDU_Load3 — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.fms.PDU_Load3 — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -
          - 8.5.1.dev30+gd6e98430 -
          @@ -100,6 +95,7 @@
        • pcdsdevices.ipm
        • pcdsdevices.jet
        • pcdsdevices.keithley
        • +
        • pcdsdevices.lakeshore
        • pcdsdevices.lamp_motion
        • pcdsdevices.lasers.btps
        • pcdsdevices.lasers.counters
        • @@ -249,14 +245,14 @@

          pcdsdevices.fms.PDU_Load3Methods

          -configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]
          +configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]

          Configure the device for something during a run

          This default implementation allows the user to change any of the configuration_attrs. Subclasses might override this to perform additional input validation, cleanup, etc.

          Parameters:
          -

          d (dict) – The configuration dictionary. To specify the order that +

          d (dict) – The configuration dictionary. To specify the order that the changes should be made, use an OrderedDict.

          Returns:
          @@ -271,7 +267,7 @@

          pcdsdevices.fms.PDU_Load3
          -describe() OrderedDictType[str, Dict[str, Any]]
          +describe() OrderedDictType[str, Dict[str, Any]]

          Provide schema and meta-data for read().

          This keys in the OrderedDict this method returns must match the keys in the OrderedDict return by read().

          @@ -295,7 +291,7 @@

          pcdsdevices.fms.PDU_Load3
          -read() OrderedDictType[str, Dict[str, Any]]
          +read() OrderedDictType[str, Dict[str, Any]]

          Read data from the device.

          This method is expected to be as instantaneous as possible, with any substantial acquisition time taken care of in @@ -318,7 +314,7 @@

          pcdsdevices.fms.PDU_Load3
          -read_configuration() OrderedDictType[str, Dict[str, Any]]
          +read_configuration() OrderedDictType[str, Dict[str, Any]]

          Dictionary mapping names to value dicts with keys: value, timestamp

          To control which fields are included, change the Component kinds on the device, or modify the configuration_attrs list.

          @@ -337,7 +333,7 @@

          pcdsdevices.fms.PDU_Load3
          -trigger() StatusBase
          +trigger() StatusBase

          Trigger the device and return status object.

          This method is responsible for implementing ‘trigger’ or ‘acquire’ functionality of this device.

          @@ -345,14 +341,14 @@

          pcdsdevices.fms.PDU_Load3read() method) then this method is also responsible for arranging that the -StatusBase object returned by this method +StatusBase object returned by this method is notified when the device is ready to be read.

          If there is no delay between triggering and being readable, -then this method must return a StatusBase +then this method must return a StatusBase object which is already completed.

          Returns:
          -

          status (StatusBase) – StatusBase object which will be marked +

          status (StatusBase) – StatusBase object which will be marked as complete when the device is ready to be read.

          @@ -381,7 +377,7 @@

          pcdsdevices.fms.PDU_Load3
          -subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})
          +subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})

          diff --git a/master/generated/pcdsdevices.fms.PDU_Load4.html b/master/generated/pcdsdevices.fms.PDU_Load4.html index c2753bea951..d940c119243 100644 --- a/master/generated/pcdsdevices.fms.PDU_Load4.html +++ b/master/generated/pcdsdevices.fms.PDU_Load4.html @@ -1,25 +1,23 @@ + + - pcdsdevices.fms.PDU_Load4 — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.fms.PDU_Load4 — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -
          - 8.5.1.dev30+gd6e98430 -
          @@ -100,6 +95,7 @@
        • pcdsdevices.ipm
        • pcdsdevices.jet
        • pcdsdevices.keithley
        • +
        • pcdsdevices.lakeshore
        • pcdsdevices.lamp_motion
        • pcdsdevices.lasers.btps
        • pcdsdevices.lasers.counters
        • @@ -256,14 +252,14 @@

          pcdsdevices.fms.PDU_Load4Methods

          -configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]
          +configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]

          Configure the device for something during a run

          This default implementation allows the user to change any of the configuration_attrs. Subclasses might override this to perform additional input validation, cleanup, etc.

          Parameters:
          -

          d (dict) – The configuration dictionary. To specify the order that +

          d (dict) – The configuration dictionary. To specify the order that the changes should be made, use an OrderedDict.

          Returns:
          @@ -278,7 +274,7 @@

          pcdsdevices.fms.PDU_Load4
          -describe() OrderedDictType[str, Dict[str, Any]]
          +describe() OrderedDictType[str, Dict[str, Any]]

          Provide schema and meta-data for read().

          This keys in the OrderedDict this method returns must match the keys in the OrderedDict return by read().

          @@ -302,7 +298,7 @@

          pcdsdevices.fms.PDU_Load4
          -read() OrderedDictType[str, Dict[str, Any]]
          +read() OrderedDictType[str, Dict[str, Any]]

          Read data from the device.

          This method is expected to be as instantaneous as possible, with any substantial acquisition time taken care of in @@ -325,7 +321,7 @@

          pcdsdevices.fms.PDU_Load4
          -read_configuration() OrderedDictType[str, Dict[str, Any]]
          +read_configuration() OrderedDictType[str, Dict[str, Any]]

          Dictionary mapping names to value dicts with keys: value, timestamp

          To control which fields are included, change the Component kinds on the device, or modify the configuration_attrs list.

          @@ -344,7 +340,7 @@

          pcdsdevices.fms.PDU_Load4
          -trigger() StatusBase
          +trigger() StatusBase

          Trigger the device and return status object.

          This method is responsible for implementing ‘trigger’ or ‘acquire’ functionality of this device.

          @@ -352,14 +348,14 @@

          pcdsdevices.fms.PDU_Load4read() method) then this method is also responsible for arranging that the -StatusBase object returned by this method +StatusBase object returned by this method is notified when the device is ready to be read.

          If there is no delay between triggering and being readable, -then this method must return a StatusBase +then this method must return a StatusBase object which is already completed.

          Returns:
          -

          status (StatusBase) – StatusBase object which will be marked +

          status (StatusBase) – StatusBase object which will be marked as complete when the device is ready to be read.

          @@ -388,7 +384,7 @@

          pcdsdevices.fms.PDU_Load4
          -subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})
          +subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})

          diff --git a/master/generated/pcdsdevices.fms.PDU_Temp2.html b/master/generated/pcdsdevices.fms.PDU_Temp2.html index 11f1ea3f211..d7682ebf70c 100644 --- a/master/generated/pcdsdevices.fms.PDU_Temp2.html +++ b/master/generated/pcdsdevices.fms.PDU_Temp2.html @@ -1,25 +1,23 @@ + + - pcdsdevices.fms.PDU_Temp2 — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.fms.PDU_Temp2 — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -
          - 8.5.1.dev30+gd6e98430 -
          @@ -100,6 +95,7 @@
        • pcdsdevices.ipm
        • pcdsdevices.jet
        • pcdsdevices.keithley
        • +
        • pcdsdevices.lakeshore
        • pcdsdevices.lamp_motion
        • pcdsdevices.lasers.btps
        • pcdsdevices.lasers.counters
        • @@ -243,14 +239,14 @@

          pcdsdevices.fms.PDU_Temp2Methods

          -configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]
          +configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]

          Configure the device for something during a run

          This default implementation allows the user to change any of the configuration_attrs. Subclasses might override this to perform additional input validation, cleanup, etc.

          Parameters:
          -

          d (dict) – The configuration dictionary. To specify the order that +

          d (dict) – The configuration dictionary. To specify the order that the changes should be made, use an OrderedDict.

          Returns:
          @@ -265,7 +261,7 @@

          pcdsdevices.fms.PDU_Temp2
          -describe() OrderedDictType[str, Dict[str, Any]]
          +describe() OrderedDictType[str, Dict[str, Any]]

          Provide schema and meta-data for read().

          This keys in the OrderedDict this method returns must match the keys in the OrderedDict return by read().

          @@ -289,7 +285,7 @@

          pcdsdevices.fms.PDU_Temp2
          -read() OrderedDictType[str, Dict[str, Any]]
          +read() OrderedDictType[str, Dict[str, Any]]

          Read data from the device.

          This method is expected to be as instantaneous as possible, with any substantial acquisition time taken care of in @@ -312,7 +308,7 @@

          pcdsdevices.fms.PDU_Temp2
          -read_configuration() OrderedDictType[str, Dict[str, Any]]
          +read_configuration() OrderedDictType[str, Dict[str, Any]]

          Dictionary mapping names to value dicts with keys: value, timestamp

          To control which fields are included, change the Component kinds on the device, or modify the configuration_attrs list.

          @@ -331,7 +327,7 @@

          pcdsdevices.fms.PDU_Temp2
          -trigger() StatusBase
          +trigger() StatusBase

          Trigger the device and return status object.

          This method is responsible for implementing ‘trigger’ or ‘acquire’ functionality of this device.

          @@ -339,14 +335,14 @@

          pcdsdevices.fms.PDU_Temp2read() method) then this method is also responsible for arranging that the -StatusBase object returned by this method +StatusBase object returned by this method is notified when the device is ready to be read.

          If there is no delay between triggering and being readable, -then this method must return a StatusBase +then this method must return a StatusBase object which is already completed.

          Returns:
          -

          status (StatusBase) – StatusBase object which will be marked +

          status (StatusBase) – StatusBase object which will be marked as complete when the device is ready to be read.

          @@ -375,7 +371,7 @@

          pcdsdevices.fms.PDU_Temp2
          -subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})
          +subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})

          diff --git a/master/generated/pcdsdevices.fms.PDU_Temp4.html b/master/generated/pcdsdevices.fms.PDU_Temp4.html index 6c75f998ad5..a87dbbbe61c 100644 --- a/master/generated/pcdsdevices.fms.PDU_Temp4.html +++ b/master/generated/pcdsdevices.fms.PDU_Temp4.html @@ -1,25 +1,23 @@ + + - pcdsdevices.fms.PDU_Temp4 — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.fms.PDU_Temp4 — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -
          - 8.5.1.dev30+gd6e98430 -
          @@ -100,6 +95,7 @@
        • pcdsdevices.ipm
        • pcdsdevices.jet
        • pcdsdevices.keithley
        • +
        • pcdsdevices.lakeshore
        • pcdsdevices.lamp_motion
        • pcdsdevices.lasers.btps
        • pcdsdevices.lasers.counters
        • @@ -256,14 +252,14 @@

          pcdsdevices.fms.PDU_Temp4Methods

          -configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]
          +configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]

          Configure the device for something during a run

          This default implementation allows the user to change any of the configuration_attrs. Subclasses might override this to perform additional input validation, cleanup, etc.

          Parameters:
          -

          d (dict) – The configuration dictionary. To specify the order that +

          d (dict) – The configuration dictionary. To specify the order that the changes should be made, use an OrderedDict.

          Returns:
          @@ -278,7 +274,7 @@

          pcdsdevices.fms.PDU_Temp4
          -describe() OrderedDictType[str, Dict[str, Any]]
          +describe() OrderedDictType[str, Dict[str, Any]]

          Provide schema and meta-data for read().

          This keys in the OrderedDict this method returns must match the keys in the OrderedDict return by read().

          @@ -302,7 +298,7 @@

          pcdsdevices.fms.PDU_Temp4
          -read() OrderedDictType[str, Dict[str, Any]]
          +read() OrderedDictType[str, Dict[str, Any]]

          Read data from the device.

          This method is expected to be as instantaneous as possible, with any substantial acquisition time taken care of in @@ -325,7 +321,7 @@

          pcdsdevices.fms.PDU_Temp4
          -read_configuration() OrderedDictType[str, Dict[str, Any]]
          +read_configuration() OrderedDictType[str, Dict[str, Any]]

          Dictionary mapping names to value dicts with keys: value, timestamp

          To control which fields are included, change the Component kinds on the device, or modify the configuration_attrs list.

          @@ -344,7 +340,7 @@

          pcdsdevices.fms.PDU_Temp4
          -trigger() StatusBase
          +trigger() StatusBase

          Trigger the device and return status object.

          This method is responsible for implementing ‘trigger’ or ‘acquire’ functionality of this device.

          @@ -352,14 +348,14 @@

          pcdsdevices.fms.PDU_Temp4read() method) then this method is also responsible for arranging that the -StatusBase object returned by this method +StatusBase object returned by this method is notified when the device is ready to be read.

          If there is no delay between triggering and being readable, -then this method must return a StatusBase +then this method must return a StatusBase object which is already completed.

          Returns:
          -

          status (StatusBase) – StatusBase object which will be marked +

          status (StatusBase) – StatusBase object which will be marked as complete when the device is ready to be read.

          @@ -388,7 +384,7 @@

          pcdsdevices.fms.PDU_Temp4
          -subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})
          +subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})

          diff --git a/master/generated/pcdsdevices.fms.PDU_Temp6.html b/master/generated/pcdsdevices.fms.PDU_Temp6.html index a86c4ebd5f6..695573f3705 100644 --- a/master/generated/pcdsdevices.fms.PDU_Temp6.html +++ b/master/generated/pcdsdevices.fms.PDU_Temp6.html @@ -1,25 +1,23 @@ + + - pcdsdevices.fms.PDU_Temp6 — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.fms.PDU_Temp6 — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -
          - 8.5.1.dev30+gd6e98430 -
          @@ -100,6 +95,7 @@
        • pcdsdevices.ipm
        • pcdsdevices.jet
        • pcdsdevices.keithley
        • +
        • pcdsdevices.lakeshore
        • pcdsdevices.lamp_motion
        • pcdsdevices.lasers.btps
        • pcdsdevices.lasers.counters
        • @@ -271,14 +267,14 @@

          pcdsdevices.fms.PDU_Temp6Methods

          -configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]
          +configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]

          Configure the device for something during a run

          This default implementation allows the user to change any of the configuration_attrs. Subclasses might override this to perform additional input validation, cleanup, etc.

          Parameters:
          -

          d (dict) – The configuration dictionary. To specify the order that +

          d (dict) – The configuration dictionary. To specify the order that the changes should be made, use an OrderedDict.

          Returns:
          @@ -293,7 +289,7 @@

          pcdsdevices.fms.PDU_Temp6
          -describe() OrderedDictType[str, Dict[str, Any]]
          +describe() OrderedDictType[str, Dict[str, Any]]

          Provide schema and meta-data for read().

          This keys in the OrderedDict this method returns must match the keys in the OrderedDict return by read().

          @@ -317,7 +313,7 @@

          pcdsdevices.fms.PDU_Temp6
          -read() OrderedDictType[str, Dict[str, Any]]
          +read() OrderedDictType[str, Dict[str, Any]]

          Read data from the device.

          This method is expected to be as instantaneous as possible, with any substantial acquisition time taken care of in @@ -340,7 +336,7 @@

          pcdsdevices.fms.PDU_Temp6
          -read_configuration() OrderedDictType[str, Dict[str, Any]]
          +read_configuration() OrderedDictType[str, Dict[str, Any]]

          Dictionary mapping names to value dicts with keys: value, timestamp

          To control which fields are included, change the Component kinds on the device, or modify the configuration_attrs list.

          @@ -359,7 +355,7 @@

          pcdsdevices.fms.PDU_Temp6
          -trigger() StatusBase
          +trigger() StatusBase

          Trigger the device and return status object.

          This method is responsible for implementing ‘trigger’ or ‘acquire’ functionality of this device.

          @@ -367,14 +363,14 @@

          pcdsdevices.fms.PDU_Temp6read() method) then this method is also responsible for arranging that the -StatusBase object returned by this method +StatusBase object returned by this method is notified when the device is ready to be read.

          If there is no delay between triggering and being readable, -then this method must return a StatusBase +then this method must return a StatusBase object which is already completed.

          Returns:
          -

          status (StatusBase) – StatusBase object which will be marked +

          status (StatusBase) – StatusBase object which will be marked as complete when the device is ready to be read.

          @@ -403,7 +399,7 @@

          pcdsdevices.fms.PDU_Temp6
          -subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})
          +subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})

          diff --git a/master/generated/pcdsdevices.fms.PDU_Temp8.html b/master/generated/pcdsdevices.fms.PDU_Temp8.html index d5202d38b40..c9350f470b9 100644 --- a/master/generated/pcdsdevices.fms.PDU_Temp8.html +++ b/master/generated/pcdsdevices.fms.PDU_Temp8.html @@ -1,25 +1,23 @@ + + - pcdsdevices.fms.PDU_Temp8 — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.fms.PDU_Temp8 — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -
          - 8.5.1.dev30+gd6e98430 -
          @@ -100,6 +95,7 @@
        • pcdsdevices.ipm
        • pcdsdevices.jet
        • pcdsdevices.keithley
        • +
        • pcdsdevices.lakeshore
        • pcdsdevices.lamp_motion
        • pcdsdevices.lasers.btps
        • pcdsdevices.lasers.counters
        • @@ -285,14 +281,14 @@

          pcdsdevices.fms.PDU_Temp8Methods

          -configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]
          +configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]

          Configure the device for something during a run

          This default implementation allows the user to change any of the configuration_attrs. Subclasses might override this to perform additional input validation, cleanup, etc.

          Parameters:
          -

          d (dict) – The configuration dictionary. To specify the order that +

          d (dict) – The configuration dictionary. To specify the order that the changes should be made, use an OrderedDict.

          Returns:
          @@ -307,7 +303,7 @@

          pcdsdevices.fms.PDU_Temp8
          -describe() OrderedDictType[str, Dict[str, Any]]
          +describe() OrderedDictType[str, Dict[str, Any]]

          Provide schema and meta-data for read().

          This keys in the OrderedDict this method returns must match the keys in the OrderedDict return by read().

          @@ -331,7 +327,7 @@

          pcdsdevices.fms.PDU_Temp8
          -read() OrderedDictType[str, Dict[str, Any]]
          +read() OrderedDictType[str, Dict[str, Any]]

          Read data from the device.

          This method is expected to be as instantaneous as possible, with any substantial acquisition time taken care of in @@ -354,7 +350,7 @@

          pcdsdevices.fms.PDU_Temp8
          -read_configuration() OrderedDictType[str, Dict[str, Any]]
          +read_configuration() OrderedDictType[str, Dict[str, Any]]

          Dictionary mapping names to value dicts with keys: value, timestamp

          To control which fields are included, change the Component kinds on the device, or modify the configuration_attrs list.

          @@ -373,7 +369,7 @@

          pcdsdevices.fms.PDU_Temp8
          -trigger() StatusBase
          +trigger() StatusBase

          Trigger the device and return status object.

          This method is responsible for implementing ‘trigger’ or ‘acquire’ functionality of this device.

          @@ -381,14 +377,14 @@

          pcdsdevices.fms.PDU_Temp8read() method) then this method is also responsible for arranging that the -StatusBase object returned by this method +StatusBase object returned by this method is notified when the device is ready to be read.

          If there is no delay between triggering and being readable, -then this method must return a StatusBase +then this method must return a StatusBase object which is already completed.

          Returns:
          -

          status (StatusBase) – StatusBase object which will be marked +

          status (StatusBase) – StatusBase object which will be marked as complete when the device is ready to be read.

          @@ -417,7 +413,7 @@

          pcdsdevices.fms.PDU_Temp8
          -subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})
          +subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})

          diff --git a/master/generated/pcdsdevices.fms.Setra5000.html b/master/generated/pcdsdevices.fms.Setra5000.html index 48f732d4a28..ab379768f03 100644 --- a/master/generated/pcdsdevices.fms.Setra5000.html +++ b/master/generated/pcdsdevices.fms.Setra5000.html @@ -1,25 +1,23 @@ + + - pcdsdevices.fms.Setra5000 — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.fms.Setra5000 — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -
          - 8.5.1.dev30+gd6e98430 -
          @@ -100,6 +95,7 @@
        • pcdsdevices.ipm
        • pcdsdevices.jet
        • pcdsdevices.keithley
        • +
        • pcdsdevices.lakeshore
        • pcdsdevices.lamp_motion
        • pcdsdevices.lasers.btps
        • pcdsdevices.lasers.counters
        • @@ -311,14 +307,14 @@

          pcdsdevices.fms.Setra5000Methods

          -configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]
          +configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]

          Configure the device for something during a run

          This default implementation allows the user to change any of the configuration_attrs. Subclasses might override this to perform additional input validation, cleanup, etc.

          Parameters:
          -

          d (dict) – The configuration dictionary. To specify the order that +

          d (dict) – The configuration dictionary. To specify the order that the changes should be made, use an OrderedDict.

          Returns:
          @@ -333,7 +329,7 @@

          pcdsdevices.fms.Setra5000
          -describe() OrderedDictType[str, Dict[str, Any]]
          +describe() OrderedDictType[str, Dict[str, Any]]

          Provide schema and meta-data for read().

          This keys in the OrderedDict this method returns must match the keys in the OrderedDict return by read().

          @@ -357,7 +353,7 @@

          pcdsdevices.fms.Setra5000
          -read() OrderedDictType[str, Dict[str, Any]]
          +read() OrderedDictType[str, Dict[str, Any]]

          Read data from the device.

          This method is expected to be as instantaneous as possible, with any substantial acquisition time taken care of in @@ -380,7 +376,7 @@

          pcdsdevices.fms.Setra5000
          -read_configuration() OrderedDictType[str, Dict[str, Any]]
          +read_configuration() OrderedDictType[str, Dict[str, Any]]

          Dictionary mapping names to value dicts with keys: value, timestamp

          To control which fields are included, change the Component kinds on the device, or modify the configuration_attrs list.

          @@ -399,7 +395,7 @@

          pcdsdevices.fms.Setra5000
          -trigger() StatusBase
          +trigger() StatusBase

          Trigger the device and return status object.

          This method is responsible for implementing ‘trigger’ or ‘acquire’ functionality of this device.

          @@ -407,14 +403,14 @@

          pcdsdevices.fms.Setra5000read() method) then this method is also responsible for arranging that the -StatusBase object returned by this method +StatusBase object returned by this method is notified when the device is ready to be read.

          If there is no delay between triggering and being readable, -then this method must return a StatusBase +then this method must return a StatusBase object which is already completed.

          Returns:
          -

          status (StatusBase) – StatusBase object which will be marked +

          status (StatusBase) – StatusBase object which will be marked as complete when the device is ready to be read.

          @@ -443,7 +439,7 @@

          pcdsdevices.fms.Setra5000
          -subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})
          +subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})

          diff --git a/master/generated/pcdsdevices.gauge.BaseGauge.html b/master/generated/pcdsdevices.gauge.BaseGauge.html index 991bd2de4fe..0efe0da1147 100644 --- a/master/generated/pcdsdevices.gauge.BaseGauge.html +++ b/master/generated/pcdsdevices.gauge.BaseGauge.html @@ -1,25 +1,23 @@ + + - pcdsdevices.gauge.BaseGauge — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.gauge.BaseGauge — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -
          - 8.5.1.dev30+gd6e98430 -
          @@ -105,6 +100,7 @@
        • pcdsdevices.ipm
        • pcdsdevices.jet
        • pcdsdevices.keithley
        • +
        • pcdsdevices.lakeshore
        • pcdsdevices.lamp_motion
        • pcdsdevices.lasers.btps
        • pcdsdevices.lasers.counters
        • @@ -222,8 +218,8 @@

          pcdsdevices.gauge.BaseGauge
          Parameters:
            -
          • prefix (str) – Full gauge base PV.

          • -
          • name (str) – A name to refer to the gauge.

          • +
          • prefix (str) – Full gauge base PV.

          • +
          • name (str) – A name to refer to the gauge.

          @@ -286,14 +282,14 @@

          pcdsdevices.gauge.BaseGaugeMethods

          -configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]
          +configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]

          Configure the device for something during a run

          This default implementation allows the user to change any of the configuration_attrs. Subclasses might override this to perform additional input validation, cleanup, etc.

          Parameters:
          -

          d (dict) – The configuration dictionary. To specify the order that +

          d (dict) – The configuration dictionary. To specify the order that the changes should be made, use an OrderedDict.

          Returns:
          @@ -308,7 +304,7 @@

          pcdsdevices.gauge.BaseGauge
          -describe() OrderedDictType[str, Dict[str, Any]]
          +describe() OrderedDictType[str, Dict[str, Any]]

          Provide schema and meta-data for read().

          This keys in the OrderedDict this method returns must match the keys in the OrderedDict return by read().

          @@ -338,7 +334,7 @@

          pcdsdevices.gauge.BaseGauge
          -read() OrderedDictType[str, Dict[str, Any]]
          +read() OrderedDictType[str, Dict[str, Any]]

          Read data from the device.

          This method is expected to be as instantaneous as possible, with any substantial acquisition time taken care of in @@ -361,7 +357,7 @@

          pcdsdevices.gauge.BaseGauge
          -read_configuration() OrderedDictType[str, Dict[str, Any]]
          +read_configuration() OrderedDictType[str, Dict[str, Any]]

          Dictionary mapping names to value dicts with keys: value, timestamp

          To control which fields are included, change the Component kinds on the device, or modify the configuration_attrs list.

          @@ -388,7 +384,7 @@

          pcdsdevices.gauge.BaseGauge
          -trigger() StatusBase
          +trigger() StatusBase

          Trigger the device and return status object.

          This method is responsible for implementing ‘trigger’ or ‘acquire’ functionality of this device.

          @@ -396,14 +392,14 @@

          pcdsdevices.gauge.BaseGaugeread() method) then this method is also responsible for arranging that the -StatusBase object returned by this method +StatusBase object returned by this method is notified when the device is ready to be read.

          If there is no delay between triggering and being readable, -then this method must return a StatusBase +then this method must return a StatusBase object which is already completed.

          Returns:
          -

          status (StatusBase) – StatusBase object which will be marked +

          status (StatusBase) – StatusBase object which will be marked as complete when the device is ready to be read.

          @@ -432,7 +428,7 @@

          pcdsdevices.gauge.BaseGauge
          -subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})
          +subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})

          diff --git a/master/generated/pcdsdevices.gauge.GCC500PLC.html b/master/generated/pcdsdevices.gauge.GCC500PLC.html index 107fafba797..23b9d4965dc 100644 --- a/master/generated/pcdsdevices.gauge.GCC500PLC.html +++ b/master/generated/pcdsdevices.gauge.GCC500PLC.html @@ -1,25 +1,23 @@ + + - pcdsdevices.gauge.GCC500PLC — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.gauge.GCC500PLC — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -
          - 8.5.1.dev30+gd6e98430 -

          - + @@ -264,7 +260,7 @@

          pcdsdevices.gauge.GCC500PLCGCCPLC

          - + @@ -278,14 +274,14 @@

          pcdsdevices.gauge.GCC500PLCGCCPLC

          - + - + @@ -299,7 +295,7 @@

          pcdsdevices.gauge.GCC500PLCGCCPLC

          - + @@ -331,14 +327,14 @@

          pcdsdevices.gauge.GCC500PLCMethods

          -configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]
          +configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]

          Configure the device for something during a run

          This default implementation allows the user to change any of the configuration_attrs. Subclasses might override this to perform additional input validation, cleanup, etc.

          Parameters:
          -

          d (dict) – The configuration dictionary. To specify the order that +

          d (dict) – The configuration dictionary. To specify the order that the changes should be made, use an OrderedDict.

          Returns:
          @@ -353,7 +349,7 @@

          pcdsdevices.gauge.GCC500PLC
          -describe() OrderedDictType[str, Dict[str, Any]]
          +describe() OrderedDictType[str, Dict[str, Any]]

          Provide schema and meta-data for read().

          This keys in the OrderedDict this method returns must match the keys in the OrderedDict return by read().

          @@ -377,7 +373,7 @@

          pcdsdevices.gauge.GCC500PLC
          -read() OrderedDictType[str, Dict[str, Any]]
          +read() OrderedDictType[str, Dict[str, Any]]

          Read data from the device.

          This method is expected to be as instantaneous as possible, with any substantial acquisition time taken care of in @@ -400,7 +396,7 @@

          pcdsdevices.gauge.GCC500PLC
          -read_configuration() OrderedDictType[str, Dict[str, Any]]
          +read_configuration() OrderedDictType[str, Dict[str, Any]]

          Dictionary mapping names to value dicts with keys: value, timestamp

          To control which fields are included, change the Component kinds on the device, or modify the configuration_attrs list.

          @@ -419,7 +415,7 @@

          pcdsdevices.gauge.GCC500PLC
          -trigger() StatusBase
          +trigger() StatusBase

          Trigger the device and return status object.

          This method is responsible for implementing ‘trigger’ or ‘acquire’ functionality of this device.

          @@ -427,14 +423,14 @@

          pcdsdevices.gauge.GCC500PLCread() method) then this method is also responsible for arranging that the -StatusBase object returned by this method +StatusBase object returned by this method is notified when the device is ready to be read.

          If there is no delay between triggering and being readable, -then this method must return a StatusBase +then this method must return a StatusBase object which is already completed.

          Returns:
          -

          status (StatusBase) – StatusBase object which will be marked +

          status (StatusBase) – StatusBase object which will be marked as complete when the device is ready to be read.

          @@ -463,7 +459,7 @@

          pcdsdevices.gauge.GCC500PLC
          -subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})
          +subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})

          diff --git a/master/generated/pcdsdevices.gauge.GCCPLC.html b/master/generated/pcdsdevices.gauge.GCCPLC.html index 30d223dc912..834ac950ba4 100644 --- a/master/generated/pcdsdevices.gauge.GCCPLC.html +++ b/master/generated/pcdsdevices.gauge.GCCPLC.html @@ -1,25 +1,23 @@ + + - pcdsdevices.gauge.GCCPLC — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.gauge.GCCPLC — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -
          - 8.5.1.dev30+gd6e98430 -

          - + @@ -264,7 +260,7 @@

          pcdsdevices.gauge.GCCPLCGaugePLC

          - + @@ -278,14 +274,14 @@

          pcdsdevices.gauge.GCCPLC

          - + - + @@ -299,7 +295,7 @@

          pcdsdevices.gauge.GCCPLC

          - + @@ -317,14 +313,14 @@

          pcdsdevices.gauge.GCCPLCMethods

          -configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]
          +configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]

          Configure the device for something during a run

          This default implementation allows the user to change any of the configuration_attrs. Subclasses might override this to perform additional input validation, cleanup, etc.

          Parameters:
          -

          d (dict) – The configuration dictionary. To specify the order that +

          d (dict) – The configuration dictionary. To specify the order that the changes should be made, use an OrderedDict.

          Returns:
          @@ -339,7 +335,7 @@

          pcdsdevices.gauge.GCCPLC
          -describe() OrderedDictType[str, Dict[str, Any]]
          +describe() OrderedDictType[str, Dict[str, Any]]

          Provide schema and meta-data for read().

          This keys in the OrderedDict this method returns must match the keys in the OrderedDict return by read().

          @@ -363,7 +359,7 @@

          pcdsdevices.gauge.GCCPLC
          -read() OrderedDictType[str, Dict[str, Any]]
          +read() OrderedDictType[str, Dict[str, Any]]

          Read data from the device.

          This method is expected to be as instantaneous as possible, with any substantial acquisition time taken care of in @@ -386,7 +382,7 @@

          pcdsdevices.gauge.GCCPLC
          -read_configuration() OrderedDictType[str, Dict[str, Any]]
          +read_configuration() OrderedDictType[str, Dict[str, Any]]

          Dictionary mapping names to value dicts with keys: value, timestamp

          To control which fields are included, change the Component kinds on the device, or modify the configuration_attrs list.

          @@ -405,7 +401,7 @@

          pcdsdevices.gauge.GCCPLC
          -trigger() StatusBase
          +trigger() StatusBase

          Trigger the device and return status object.

          This method is responsible for implementing ‘trigger’ or ‘acquire’ functionality of this device.

          @@ -413,14 +409,14 @@

          pcdsdevices.gauge.GCCPLCread() method) then this method is also responsible for arranging that the -StatusBase object returned by this method +StatusBase object returned by this method is notified when the device is ready to be read.

          If there is no delay between triggering and being readable, -then this method must return a StatusBase +then this method must return a StatusBase object which is already completed.

          Returns:
          -

          status (StatusBase) – StatusBase object which will be marked +

          status (StatusBase) – StatusBase object which will be marked as complete when the device is ready to be read.

          @@ -449,7 +445,7 @@

          pcdsdevices.gauge.GCCPLC
          -subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})
          +subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})

          diff --git a/master/generated/pcdsdevices.gauge.GCT.html b/master/generated/pcdsdevices.gauge.GCT.html index ee8ed0a5bef..27783c0b02f 100644 --- a/master/generated/pcdsdevices.gauge.GCT.html +++ b/master/generated/pcdsdevices.gauge.GCT.html @@ -1,25 +1,23 @@ + + - pcdsdevices.gauge.GCT — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.gauge.GCT — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -
          - 8.5.1.dev30+gd6e98430 -
          @@ -105,6 +100,7 @@
        • pcdsdevices.ipm
        • pcdsdevices.jet
        • pcdsdevices.keithley
        • +
        • pcdsdevices.lakeshore
        • pcdsdevices.lamp_motion
        • pcdsdevices.lasers.btps
        • pcdsdevices.lasers.counters
        • @@ -254,14 +250,14 @@

          pcdsdevices.gauge.GCTMethods

          -configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]
          +configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]

          Configure the device for something during a run

          This default implementation allows the user to change any of the configuration_attrs. Subclasses might override this to perform additional input validation, cleanup, etc.

          Parameters:
          -

          d (dict) – The configuration dictionary. To specify the order that +

          d (dict) – The configuration dictionary. To specify the order that the changes should be made, use an OrderedDict.

          Returns:
          @@ -276,7 +272,7 @@

          pcdsdevices.gauge.GCT
          -describe() OrderedDictType[str, Dict[str, Any]]
          +describe() OrderedDictType[str, Dict[str, Any]]

          Provide schema and meta-data for read().

          This keys in the OrderedDict this method returns must match the keys in the OrderedDict return by read().

          @@ -300,7 +296,7 @@

          pcdsdevices.gauge.GCT
          -read() OrderedDictType[str, Dict[str, Any]]
          +read() OrderedDictType[str, Dict[str, Any]]

          Read data from the device.

          This method is expected to be as instantaneous as possible, with any substantial acquisition time taken care of in @@ -323,7 +319,7 @@

          pcdsdevices.gauge.GCT
          -read_configuration() OrderedDictType[str, Dict[str, Any]]
          +read_configuration() OrderedDictType[str, Dict[str, Any]]

          Dictionary mapping names to value dicts with keys: value, timestamp

          To control which fields are included, change the Component kinds on the device, or modify the configuration_attrs list.

          @@ -342,7 +338,7 @@

          pcdsdevices.gauge.GCT
          -trigger() StatusBase
          +trigger() StatusBase

          Trigger the device and return status object.

          This method is responsible for implementing ‘trigger’ or ‘acquire’ functionality of this device.

          @@ -350,14 +346,14 @@

          pcdsdevices.gauge.GCTread() method) then this method is also responsible for arranging that the -StatusBase object returned by this method +StatusBase object returned by this method is notified when the device is ready to be read.

          If there is no delay between triggering and being readable, -then this method must return a StatusBase +then this method must return a StatusBase object which is already completed.

          Returns:
          -

          status (StatusBase) – StatusBase object which will be marked +

          status (StatusBase) – StatusBase object which will be marked as complete when the device is ready to be read.

          @@ -386,7 +382,7 @@

          pcdsdevices.gauge.GCT
          -subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})
          +subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})

          diff --git a/master/generated/pcdsdevices.gauge.GFSPLC.html b/master/generated/pcdsdevices.gauge.GFSPLC.html index 3bf9a395a80..6ea55174c37 100644 --- a/master/generated/pcdsdevices.gauge.GFSPLC.html +++ b/master/generated/pcdsdevices.gauge.GFSPLC.html @@ -1,25 +1,23 @@ + + - pcdsdevices.gauge.GFSPLC — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.gauge.GFSPLC — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -
          - 8.5.1.dev30+gd6e98430 -

          - + @@ -264,7 +260,7 @@

          pcdsdevices.gauge.GFSPLCGCCPLC

          - + @@ -278,14 +274,14 @@

          pcdsdevices.gauge.GFSPLCGCCPLC

          - + - + @@ -299,7 +295,7 @@

          pcdsdevices.gauge.GFSPLCGCCPLC

          - + @@ -324,14 +320,14 @@

          pcdsdevices.gauge.GFSPLCMethods

          -configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]
          +configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]

          Configure the device for something during a run

          This default implementation allows the user to change any of the configuration_attrs. Subclasses might override this to perform additional input validation, cleanup, etc.

          Parameters:
          -

          d (dict) – The configuration dictionary. To specify the order that +

          d (dict) – The configuration dictionary. To specify the order that the changes should be made, use an OrderedDict.

          Returns:
          @@ -346,7 +342,7 @@

          pcdsdevices.gauge.GFSPLC
          -describe() OrderedDictType[str, Dict[str, Any]]
          +describe() OrderedDictType[str, Dict[str, Any]]

          Provide schema and meta-data for read().

          This keys in the OrderedDict this method returns must match the keys in the OrderedDict return by read().

          @@ -370,7 +366,7 @@

          pcdsdevices.gauge.GFSPLC
          -read() OrderedDictType[str, Dict[str, Any]]
          +read() OrderedDictType[str, Dict[str, Any]]

          Read data from the device.

          This method is expected to be as instantaneous as possible, with any substantial acquisition time taken care of in @@ -393,7 +389,7 @@

          pcdsdevices.gauge.GFSPLC
          -read_configuration() OrderedDictType[str, Dict[str, Any]]
          +read_configuration() OrderedDictType[str, Dict[str, Any]]

          Dictionary mapping names to value dicts with keys: value, timestamp

          To control which fields are included, change the Component kinds on the device, or modify the configuration_attrs list.

          @@ -412,7 +408,7 @@

          pcdsdevices.gauge.GFSPLC
          -trigger() StatusBase
          +trigger() StatusBase

          Trigger the device and return status object.

          This method is responsible for implementing ‘trigger’ or ‘acquire’ functionality of this device.

          @@ -420,14 +416,14 @@

          pcdsdevices.gauge.GFSPLCread() method) then this method is also responsible for arranging that the -StatusBase object returned by this method +StatusBase object returned by this method is notified when the device is ready to be read.

          If there is no delay between triggering and being readable, -then this method must return a StatusBase +then this method must return a StatusBase object which is already completed.

          Returns:
          -

          status (StatusBase) – StatusBase object which will be marked +

          status (StatusBase) – StatusBase object which will be marked as complete when the device is ready to be read.

          @@ -456,7 +452,7 @@

          pcdsdevices.gauge.GFSPLC
          -subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})
          +subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})

          diff --git a/master/generated/pcdsdevices.gauge.GHCPLC.html b/master/generated/pcdsdevices.gauge.GHCPLC.html index 930b257bd90..bca81a96530 100644 --- a/master/generated/pcdsdevices.gauge.GHCPLC.html +++ b/master/generated/pcdsdevices.gauge.GHCPLC.html @@ -1,25 +1,23 @@ + + - pcdsdevices.gauge.GHCPLC — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.gauge.GHCPLC — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -
          - 8.5.1.dev30+gd6e98430 -

          - + @@ -264,7 +260,7 @@

          pcdsdevices.gauge.GHCPLCGaugePLC

          - + @@ -278,14 +274,14 @@

          pcdsdevices.gauge.GHCPLC

          - + - + @@ -303,14 +299,14 @@

          pcdsdevices.gauge.GHCPLCMethods

          -configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]
          +configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]

          Configure the device for something during a run

          This default implementation allows the user to change any of the configuration_attrs. Subclasses might override this to perform additional input validation, cleanup, etc.

          Parameters:
          -

          d (dict) – The configuration dictionary. To specify the order that +

          d (dict) – The configuration dictionary. To specify the order that the changes should be made, use an OrderedDict.

          Returns:
          @@ -325,7 +321,7 @@

          pcdsdevices.gauge.GHCPLC
          -describe() OrderedDictType[str, Dict[str, Any]]
          +describe() OrderedDictType[str, Dict[str, Any]]

          Provide schema and meta-data for read().

          This keys in the OrderedDict this method returns must match the keys in the OrderedDict return by read().

          @@ -349,7 +345,7 @@

          pcdsdevices.gauge.GHCPLC
          -read() OrderedDictType[str, Dict[str, Any]]
          +read() OrderedDictType[str, Dict[str, Any]]

          Read data from the device.

          This method is expected to be as instantaneous as possible, with any substantial acquisition time taken care of in @@ -372,7 +368,7 @@

          pcdsdevices.gauge.GHCPLC
          -read_configuration() OrderedDictType[str, Dict[str, Any]]
          +read_configuration() OrderedDictType[str, Dict[str, Any]]

          Dictionary mapping names to value dicts with keys: value, timestamp

          To control which fields are included, change the Component kinds on the device, or modify the configuration_attrs list.

          @@ -391,7 +387,7 @@

          pcdsdevices.gauge.GHCPLC
          -trigger() StatusBase
          +trigger() StatusBase

          Trigger the device and return status object.

          This method is responsible for implementing ‘trigger’ or ‘acquire’ functionality of this device.

          @@ -399,14 +395,14 @@

          pcdsdevices.gauge.GHCPLCread() method) then this method is also responsible for arranging that the -StatusBase object returned by this method +StatusBase object returned by this method is notified when the device is ready to be read.

          If there is no delay between triggering and being readable, -then this method must return a StatusBase +then this method must return a StatusBase object which is already completed.

          Returns:
          -

          status (StatusBase) – StatusBase object which will be marked +

          status (StatusBase) – StatusBase object which will be marked as complete when the device is ready to be read.

          @@ -435,7 +431,7 @@

          pcdsdevices.gauge.GHCPLC
          -subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})
          +subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})

          diff --git a/master/generated/pcdsdevices.gauge.GaugeColdCathode.html b/master/generated/pcdsdevices.gauge.GaugeColdCathode.html index 70360b75df6..383fed4b2b1 100644 --- a/master/generated/pcdsdevices.gauge.GaugeColdCathode.html +++ b/master/generated/pcdsdevices.gauge.GaugeColdCathode.html @@ -1,25 +1,23 @@ + + - pcdsdevices.gauge.GaugeColdCathode — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.gauge.GaugeColdCathode — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -
          - 8.5.1.dev30+gd6e98430 -
          @@ -105,6 +100,7 @@
        • pcdsdevices.ipm
        • pcdsdevices.jet
        • pcdsdevices.keithley
        • +
        • pcdsdevices.lakeshore
        • pcdsdevices.lamp_motion
        • pcdsdevices.lasers.btps
        • pcdsdevices.lasers.counters
        • @@ -324,14 +320,14 @@

          pcdsdevices.gauge.GaugeColdCathodeMethods

          -configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]
          +configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]

          Configure the device for something during a run

          This default implementation allows the user to change any of the configuration_attrs. Subclasses might override this to perform additional input validation, cleanup, etc.

          Parameters:
          -

          d (dict) – The configuration dictionary. To specify the order that +

          d (dict) – The configuration dictionary. To specify the order that the changes should be made, use an OrderedDict.

          Returns:
          @@ -346,7 +342,7 @@

          pcdsdevices.gauge.GaugeColdCathode
          -describe() OrderedDictType[str, Dict[str, Any]]
          +describe() OrderedDictType[str, Dict[str, Any]]

          Provide schema and meta-data for read().

          This keys in the OrderedDict this method returns must match the keys in the OrderedDict return by read().

          @@ -376,7 +372,7 @@

          pcdsdevices.gauge.GaugeColdCathode
          -read() OrderedDictType[str, Dict[str, Any]]
          +read() OrderedDictType[str, Dict[str, Any]]

          Read data from the device.

          This method is expected to be as instantaneous as possible, with any substantial acquisition time taken care of in @@ -399,7 +395,7 @@

          pcdsdevices.gauge.GaugeColdCathode
          -read_configuration() OrderedDictType[str, Dict[str, Any]]
          +read_configuration() OrderedDictType[str, Dict[str, Any]]

          Dictionary mapping names to value dicts with keys: value, timestamp

          To control which fields are included, change the Component kinds on the device, or modify the configuration_attrs list.

          @@ -426,7 +422,7 @@

          pcdsdevices.gauge.GaugeColdCathode
          -trigger() StatusBase
          +trigger() StatusBase

          Trigger the device and return status object.

          This method is responsible for implementing ‘trigger’ or ‘acquire’ functionality of this device.

          @@ -434,14 +430,14 @@

          pcdsdevices.gauge.GaugeColdCathoderead() method) then this method is also responsible for arranging that the -StatusBase object returned by this method +StatusBase object returned by this method is notified when the device is ready to be read.

          If there is no delay between triggering and being readable, -then this method must return a StatusBase +then this method must return a StatusBase object which is already completed.

          Returns:
          -

          status (StatusBase) – StatusBase object which will be marked +

          status (StatusBase) – StatusBase object which will be marked as complete when the device is ready to be read.

          @@ -470,7 +466,7 @@

          pcdsdevices.gauge.GaugeColdCathode
          -subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})
          +subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})

          diff --git a/master/generated/pcdsdevices.gauge.GaugePLC.html b/master/generated/pcdsdevices.gauge.GaugePLC.html index de7cdc382b5..62c2646e86f 100644 --- a/master/generated/pcdsdevices.gauge.GaugePLC.html +++ b/master/generated/pcdsdevices.gauge.GaugePLC.html @@ -1,25 +1,23 @@ + + - pcdsdevices.gauge.GaugePLC — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.gauge.GaugePLC — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -
          - 8.5.1.dev30+gd6e98430 -

          - + @@ -270,14 +266,14 @@

          pcdsdevices.gauge.GaugePLCMethods

          -configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]
          +configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]

          Configure the device for something during a run

          This default implementation allows the user to change any of the configuration_attrs. Subclasses might override this to perform additional input validation, cleanup, etc.

          Parameters:
          -

          d (dict) – The configuration dictionary. To specify the order that +

          d (dict) – The configuration dictionary. To specify the order that the changes should be made, use an OrderedDict.

          Returns:
          @@ -292,7 +288,7 @@

          pcdsdevices.gauge.GaugePLC
          -describe() OrderedDictType[str, Dict[str, Any]]
          +describe() OrderedDictType[str, Dict[str, Any]]

          Provide schema and meta-data for read().

          This keys in the OrderedDict this method returns must match the keys in the OrderedDict return by read().

          @@ -316,7 +312,7 @@

          pcdsdevices.gauge.GaugePLC
          -read() OrderedDictType[str, Dict[str, Any]]
          +read() OrderedDictType[str, Dict[str, Any]]

          Read data from the device.

          This method is expected to be as instantaneous as possible, with any substantial acquisition time taken care of in @@ -339,7 +335,7 @@

          pcdsdevices.gauge.GaugePLC
          -read_configuration() OrderedDictType[str, Dict[str, Any]]
          +read_configuration() OrderedDictType[str, Dict[str, Any]]

          Dictionary mapping names to value dicts with keys: value, timestamp

          To control which fields are included, change the Component kinds on the device, or modify the configuration_attrs list.

          @@ -358,7 +354,7 @@

          pcdsdevices.gauge.GaugePLC
          -trigger() StatusBase
          +trigger() StatusBase

          Trigger the device and return status object.

          This method is responsible for implementing ‘trigger’ or ‘acquire’ functionality of this device.

          @@ -366,14 +362,14 @@

          pcdsdevices.gauge.GaugePLCread() method) then this method is also responsible for arranging that the -StatusBase object returned by this method +StatusBase object returned by this method is notified when the device is ready to be read.

          If there is no delay between triggering and being readable, -then this method must return a StatusBase +then this method must return a StatusBase object which is already completed.

          Returns:
          -

          status (StatusBase) – StatusBase object which will be marked +

          status (StatusBase) – StatusBase object which will be marked as complete when the device is ready to be read.

          @@ -402,7 +398,7 @@

          pcdsdevices.gauge.GaugePLC
          -subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})
          +subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})

          diff --git a/master/generated/pcdsdevices.gauge.GaugePirani.html b/master/generated/pcdsdevices.gauge.GaugePirani.html index dc118f6060a..75dbd47be80 100644 --- a/master/generated/pcdsdevices.gauge.GaugePirani.html +++ b/master/generated/pcdsdevices.gauge.GaugePirani.html @@ -1,25 +1,23 @@ + + - pcdsdevices.gauge.GaugePirani — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.gauge.GaugePirani — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -
          - 8.5.1.dev30+gd6e98430 -
          @@ -105,6 +100,7 @@
        • pcdsdevices.ipm
        • pcdsdevices.jet
        • pcdsdevices.keithley
        • +
        • pcdsdevices.lakeshore
        • pcdsdevices.lamp_motion
        • pcdsdevices.lasers.btps
        • pcdsdevices.lasers.counters
        • @@ -275,14 +271,14 @@

          pcdsdevices.gauge.GaugePiraniMethods

          -configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]
          +configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]

          Configure the device for something during a run

          This default implementation allows the user to change any of the configuration_attrs. Subclasses might override this to perform additional input validation, cleanup, etc.

          Parameters:
          -

          d (dict) – The configuration dictionary. To specify the order that +

          d (dict) – The configuration dictionary. To specify the order that the changes should be made, use an OrderedDict.

          Returns:
          @@ -297,7 +293,7 @@

          pcdsdevices.gauge.GaugePirani
          -describe() OrderedDictType[str, Dict[str, Any]]
          +describe() OrderedDictType[str, Dict[str, Any]]

          Provide schema and meta-data for read().

          This keys in the OrderedDict this method returns must match the keys in the OrderedDict return by read().

          @@ -327,7 +323,7 @@

          pcdsdevices.gauge.GaugePirani
          -read() OrderedDictType[str, Dict[str, Any]]
          +read() OrderedDictType[str, Dict[str, Any]]

          Read data from the device.

          This method is expected to be as instantaneous as possible, with any substantial acquisition time taken care of in @@ -350,7 +346,7 @@

          pcdsdevices.gauge.GaugePirani
          -read_configuration() OrderedDictType[str, Dict[str, Any]]
          +read_configuration() OrderedDictType[str, Dict[str, Any]]

          Dictionary mapping names to value dicts with keys: value, timestamp

          To control which fields are included, change the Component kinds on the device, or modify the configuration_attrs list.

          @@ -377,7 +373,7 @@

          pcdsdevices.gauge.GaugePirani
          -trigger() StatusBase
          +trigger() StatusBase

          Trigger the device and return status object.

          This method is responsible for implementing ‘trigger’ or ‘acquire’ functionality of this device.

          @@ -385,14 +381,14 @@

          pcdsdevices.gauge.GaugePiraniread() method) then this method is also responsible for arranging that the -StatusBase object returned by this method +StatusBase object returned by this method is notified when the device is ready to be read.

          If there is no delay between triggering and being readable, -then this method must return a StatusBase +then this method must return a StatusBase object which is already completed.

          Returns:
          -

          status (StatusBase) – StatusBase object which will be marked +

          status (StatusBase) – StatusBase object which will be marked as complete when the device is ready to be read.

          @@ -421,7 +417,7 @@

          pcdsdevices.gauge.GaugePirani
          -subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})
          +subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})

          diff --git a/master/generated/pcdsdevices.gauge.GaugeSerial.html b/master/generated/pcdsdevices.gauge.GaugeSerial.html index 5d4a21d49e4..e724cbd0722 100644 --- a/master/generated/pcdsdevices.gauge.GaugeSerial.html +++ b/master/generated/pcdsdevices.gauge.GaugeSerial.html @@ -1,25 +1,23 @@ + + - pcdsdevices.gauge.GaugeSerial — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.gauge.GaugeSerial — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -
          - 8.5.1.dev30+gd6e98430 -
          @@ -105,6 +100,7 @@
        • pcdsdevices.ipm
        • pcdsdevices.jet
        • pcdsdevices.keithley
        • +
        • pcdsdevices.lakeshore
        • pcdsdevices.lamp_motion
        • pcdsdevices.lasers.btps
        • pcdsdevices.lasers.counters
        • @@ -478,14 +474,14 @@

          pcdsdevices.gauge.GaugeSerialMethods

          -configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]
          +configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]

          Configure the device for something during a run

          This default implementation allows the user to change any of the configuration_attrs. Subclasses might override this to perform additional input validation, cleanup, etc.

          Parameters:
          -

          d (dict) – The configuration dictionary. To specify the order that +

          d (dict) – The configuration dictionary. To specify the order that the changes should be made, use an OrderedDict.

          Returns:
          @@ -500,7 +496,7 @@

          pcdsdevices.gauge.GaugeSerial
          -describe() OrderedDictType[str, Dict[str, Any]]
          +describe() OrderedDictType[str, Dict[str, Any]]

          Provide schema and meta-data for read().

          This keys in the OrderedDict this method returns must match the keys in the OrderedDict return by read().

          @@ -524,7 +520,7 @@

          pcdsdevices.gauge.GaugeSerial
          -read() OrderedDictType[str, Dict[str, Any]]
          +read() OrderedDictType[str, Dict[str, Any]]

          Read data from the device.

          This method is expected to be as instantaneous as possible, with any substantial acquisition time taken care of in @@ -547,7 +543,7 @@

          pcdsdevices.gauge.GaugeSerial
          -read_configuration() OrderedDictType[str, Dict[str, Any]]
          +read_configuration() OrderedDictType[str, Dict[str, Any]]

          Dictionary mapping names to value dicts with keys: value, timestamp

          To control which fields are included, change the Component kinds on the device, or modify the configuration_attrs list.

          @@ -566,7 +562,7 @@

          pcdsdevices.gauge.GaugeSerial
          -trigger() StatusBase
          +trigger() StatusBase

          Trigger the device and return status object.

          This method is responsible for implementing ‘trigger’ or ‘acquire’ functionality of this device.

          @@ -574,14 +570,14 @@

          pcdsdevices.gauge.GaugeSerialread() method) then this method is also responsible for arranging that the -StatusBase object returned by this method +StatusBase object returned by this method is notified when the device is ready to be read.

          If there is no delay between triggering and being readable, -then this method must return a StatusBase +then this method must return a StatusBase object which is already completed.

          Returns:
          -

          status (StatusBase) – StatusBase object which will be marked +

          status (StatusBase) – StatusBase object which will be marked as complete when the device is ready to be read.

          @@ -610,7 +606,7 @@

          pcdsdevices.gauge.GaugeSerial
          -subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})
          +subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})

          diff --git a/master/generated/pcdsdevices.gauge.GaugeSerialGCC.html b/master/generated/pcdsdevices.gauge.GaugeSerialGCC.html index 6434f1ce8f3..bd593ef24a1 100644 --- a/master/generated/pcdsdevices.gauge.GaugeSerialGCC.html +++ b/master/generated/pcdsdevices.gauge.GaugeSerialGCC.html @@ -1,25 +1,23 @@ + + - pcdsdevices.gauge.GaugeSerialGCC — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.gauge.GaugeSerialGCC — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -
          - 8.5.1.dev30+gd6e98430 -
          @@ -105,6 +100,7 @@
        • pcdsdevices.ipm
        • pcdsdevices.jet
        • pcdsdevices.keithley
        • +
        • pcdsdevices.lakeshore
        • pcdsdevices.lamp_motion
        • pcdsdevices.lasers.btps
        • pcdsdevices.lasers.counters
        • @@ -681,14 +677,14 @@

          pcdsdevices.gauge.GaugeSerialGCCMethods

          -configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]
          +configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]

          Configure the device for something during a run

          This default implementation allows the user to change any of the configuration_attrs. Subclasses might override this to perform additional input validation, cleanup, etc.

          Parameters:
          -

          d (dict) – The configuration dictionary. To specify the order that +

          d (dict) – The configuration dictionary. To specify the order that the changes should be made, use an OrderedDict.

          Returns:
          @@ -703,7 +699,7 @@

          pcdsdevices.gauge.GaugeSerialGCC
          -describe() OrderedDictType[str, Dict[str, Any]]
          +describe() OrderedDictType[str, Dict[str, Any]]

          Provide schema and meta-data for read().

          This keys in the OrderedDict this method returns must match the keys in the OrderedDict return by read().

          @@ -727,7 +723,7 @@

          pcdsdevices.gauge.GaugeSerialGCC
          -read() OrderedDictType[str, Dict[str, Any]]
          +read() OrderedDictType[str, Dict[str, Any]]

          Read data from the device.

          This method is expected to be as instantaneous as possible, with any substantial acquisition time taken care of in @@ -750,7 +746,7 @@

          pcdsdevices.gauge.GaugeSerialGCC
          -read_configuration() OrderedDictType[str, Dict[str, Any]]
          +read_configuration() OrderedDictType[str, Dict[str, Any]]

          Dictionary mapping names to value dicts with keys: value, timestamp

          To control which fields are included, change the Component kinds on the device, or modify the configuration_attrs list.

          @@ -769,7 +765,7 @@

          pcdsdevices.gauge.GaugeSerialGCC
          -trigger() StatusBase
          +trigger() StatusBase

          Trigger the device and return status object.

          This method is responsible for implementing ‘trigger’ or ‘acquire’ functionality of this device.

          @@ -777,14 +773,14 @@

          pcdsdevices.gauge.GaugeSerialGCCread() method) then this method is also responsible for arranging that the -StatusBase object returned by this method +StatusBase object returned by this method is notified when the device is ready to be read.

          If there is no delay between triggering and being readable, -then this method must return a StatusBase +then this method must return a StatusBase object which is already completed.

          Returns:
          -

          status (StatusBase) – StatusBase object which will be marked +

          status (StatusBase) – StatusBase object which will be marked as complete when the device is ready to be read.

          @@ -813,7 +809,7 @@

          pcdsdevices.gauge.GaugeSerialGCC
          -subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})
          +subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})

          diff --git a/master/generated/pcdsdevices.gauge.GaugeSerialGPI.html b/master/generated/pcdsdevices.gauge.GaugeSerialGPI.html index c57b85be287..8b182f22c84 100644 --- a/master/generated/pcdsdevices.gauge.GaugeSerialGPI.html +++ b/master/generated/pcdsdevices.gauge.GaugeSerialGPI.html @@ -1,25 +1,23 @@ + + - pcdsdevices.gauge.GaugeSerialGPI — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.gauge.GaugeSerialGPI — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -
          - 8.5.1.dev30+gd6e98430 -
          @@ -105,6 +100,7 @@
        • pcdsdevices.ipm
        • pcdsdevices.jet
        • pcdsdevices.keithley
        • +
        • pcdsdevices.lakeshore
        • pcdsdevices.lamp_motion
        • pcdsdevices.lasers.btps
        • pcdsdevices.lasers.counters
        • @@ -513,14 +509,14 @@

          pcdsdevices.gauge.GaugeSerialGPIMethods

          -configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]
          +configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]

          Configure the device for something during a run

          This default implementation allows the user to change any of the configuration_attrs. Subclasses might override this to perform additional input validation, cleanup, etc.

          Parameters:
          -

          d (dict) – The configuration dictionary. To specify the order that +

          d (dict) – The configuration dictionary. To specify the order that the changes should be made, use an OrderedDict.

          Returns:
          @@ -535,7 +531,7 @@

          pcdsdevices.gauge.GaugeSerialGPI
          -describe() OrderedDictType[str, Dict[str, Any]]
          +describe() OrderedDictType[str, Dict[str, Any]]

          Provide schema and meta-data for read().

          This keys in the OrderedDict this method returns must match the keys in the OrderedDict return by read().

          @@ -559,7 +555,7 @@

          pcdsdevices.gauge.GaugeSerialGPI
          -read() OrderedDictType[str, Dict[str, Any]]
          +read() OrderedDictType[str, Dict[str, Any]]

          Read data from the device.

          This method is expected to be as instantaneous as possible, with any substantial acquisition time taken care of in @@ -582,7 +578,7 @@

          pcdsdevices.gauge.GaugeSerialGPI
          -read_configuration() OrderedDictType[str, Dict[str, Any]]
          +read_configuration() OrderedDictType[str, Dict[str, Any]]

          Dictionary mapping names to value dicts with keys: value, timestamp

          To control which fields are included, change the Component kinds on the device, or modify the configuration_attrs list.

          @@ -601,7 +597,7 @@

          pcdsdevices.gauge.GaugeSerialGPI
          -trigger() StatusBase
          +trigger() StatusBase

          Trigger the device and return status object.

          This method is responsible for implementing ‘trigger’ or ‘acquire’ functionality of this device.

          @@ -609,14 +605,14 @@

          pcdsdevices.gauge.GaugeSerialGPIread() method) then this method is also responsible for arranging that the -StatusBase object returned by this method +StatusBase object returned by this method is notified when the device is ready to be read.

          If there is no delay between triggering and being readable, -then this method must return a StatusBase +then this method must return a StatusBase object which is already completed.

          Returns:
          -

          status (StatusBase) – StatusBase object which will be marked +

          status (StatusBase) – StatusBase object which will be marked as complete when the device is ready to be read.

          @@ -645,7 +641,7 @@

          pcdsdevices.gauge.GaugeSerialGPI
          -subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})
          +subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})

          diff --git a/master/generated/pcdsdevices.gauge.GaugeSet.html b/master/generated/pcdsdevices.gauge.GaugeSet.html index c422c527bc0..c1f3847f799 100644 --- a/master/generated/pcdsdevices.gauge.GaugeSet.html +++ b/master/generated/pcdsdevices.gauge.GaugeSet.html @@ -1,25 +1,23 @@ + + - pcdsdevices.gauge.GaugeSet — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.gauge.GaugeSet — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -
          - 8.5.1.dev30+gd6e98430 -
          @@ -105,6 +100,7 @@
        • pcdsdevices.ipm
        • pcdsdevices.jet
        • pcdsdevices.keithley
        • +
        • pcdsdevices.lakeshore
        • pcdsdevices.lamp_motion
        • pcdsdevices.lasers.btps
        • pcdsdevices.lasers.counters
        • @@ -219,10 +215,10 @@

          pcdsdevices.gauge.GaugeSet
          Parameters:
            -
          • prefix (str) – Gauge base PV (up to ‘GCC’/’GPI’).

          • -
          • name (str) – Name to refer to the gauge set.

          • -
          • index (str or int) – Index for gauge (e.g. ‘02’ or 3).

          • -
          • prefix_controller (str, optional) – Base PV for the controller.

          • +
          • prefix (str) – Gauge base PV (up to ‘GCC’/’GPI’).

          • +
          • name (str) – Name to refer to the gauge set.

          • +
          • index (str or int) – Index for gauge (e.g. ‘02’ or 3).

          • +
          • prefix_controller (str, optional) – Base PV for the controller.

          • onlyGCC (optional) – If defined and not False, set has no Pirani.

          diff --git a/master/generated/pcdsdevices.gauge.GaugeSetBase.html b/master/generated/pcdsdevices.gauge.GaugeSetBase.html index 4a863490243..2e9d62cefbe 100644 --- a/master/generated/pcdsdevices.gauge.GaugeSetBase.html +++ b/master/generated/pcdsdevices.gauge.GaugeSetBase.html @@ -1,25 +1,23 @@ + + - pcdsdevices.gauge.GaugeSetBase — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.gauge.GaugeSetBase — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -
          - 8.5.1.dev30+gd6e98430 -
          @@ -105,6 +100,7 @@
        • pcdsdevices.ipm
        • pcdsdevices.jet
        • pcdsdevices.keithley
        • +
        • pcdsdevices.lakeshore
        • pcdsdevices.lamp_motion
        • pcdsdevices.lasers.btps
        • pcdsdevices.lasers.counters
        • @@ -219,9 +215,9 @@

          pcdsdevices.gauge.GaugeSetBase
          Parameters:
            -
          • prefix (str) – Gauge base PV (up to GCC/GPI).

          • -
          • name (str) – Alias for the gauge set.

          • -
          • index (str or int) – Index for gauge (e.g. ‘02’ or 3).

          • +
          • prefix (str) – Gauge base PV (up to GCC/GPI).

          • +
          • name (str) – Alias for the gauge set.

          • +
          • index (str or int) – Index for gauge (e.g. ‘02’ or 3).

          @@ -249,14 +245,14 @@

          pcdsdevices.gauge.GaugeSetBaseMethods

          -configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]
          +configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]

          Configure the device for something during a run

          This default implementation allows the user to change any of the configuration_attrs. Subclasses might override this to perform additional input validation, cleanup, etc.

          Parameters:
          -

          d (dict) – The configuration dictionary. To specify the order that +

          d (dict) – The configuration dictionary. To specify the order that the changes should be made, use an OrderedDict.

          Returns:
          @@ -271,7 +267,7 @@

          pcdsdevices.gauge.GaugeSetBase
          -describe() OrderedDictType[str, Dict[str, Any]]
          +describe() OrderedDictType[str, Dict[str, Any]]

          Provide schema and meta-data for read().

          This keys in the OrderedDict this method returns must match the keys in the OrderedDict return by read().

          @@ -311,7 +307,7 @@

          pcdsdevices.gauge.GaugeSetBase
          -read() OrderedDictType[str, Dict[str, Any]]
          +read() OrderedDictType[str, Dict[str, Any]]

          Read data from the device.

          This method is expected to be as instantaneous as possible, with any substantial acquisition time taken care of in @@ -334,7 +330,7 @@

          pcdsdevices.gauge.GaugeSetBase
          -read_configuration() OrderedDictType[str, Dict[str, Any]]
          +read_configuration() OrderedDictType[str, Dict[str, Any]]

          Dictionary mapping names to value dicts with keys: value, timestamp

          To control which fields are included, change the Component kinds on the device, or modify the configuration_attrs list.

          @@ -350,7 +346,7 @@

          pcdsdevices.gauge.GaugeSetBase
          -status() str
          +status() str

          Returns a str with the current pv values for the device.

          @@ -367,7 +363,7 @@

          pcdsdevices.gauge.GaugeSetBase
          -trigger() StatusBase
          +trigger() StatusBase

          Trigger the device and return status object.

          This method is responsible for implementing ‘trigger’ or ‘acquire’ functionality of this device.

          @@ -375,14 +371,14 @@

          pcdsdevices.gauge.GaugeSetBaseread() method) then this method is also responsible for arranging that the -StatusBase object returned by this method +StatusBase object returned by this method is notified when the device is ready to be read.

          If there is no delay between triggering and being readable, -then this method must return a StatusBase +then this method must return a StatusBase object which is already completed.

          Returns:
          -

          status (StatusBase) – StatusBase object which will be marked +

          status (StatusBase) – StatusBase object which will be marked as complete when the device is ready to be read.

          @@ -411,7 +407,7 @@

          pcdsdevices.gauge.GaugeSetBase
          -subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})
          +subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})

          diff --git a/master/generated/pcdsdevices.gauge.GaugeSetMks.html b/master/generated/pcdsdevices.gauge.GaugeSetMks.html index 8823f563e10..d27ee03bf11 100644 --- a/master/generated/pcdsdevices.gauge.GaugeSetMks.html +++ b/master/generated/pcdsdevices.gauge.GaugeSetMks.html @@ -1,25 +1,23 @@ + + - pcdsdevices.gauge.GaugeSetMks — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.gauge.GaugeSetMks — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -
          - 8.5.1.dev30+gd6e98430 -
          @@ -105,6 +100,7 @@
        • pcdsdevices.ipm
        • pcdsdevices.jet
        • pcdsdevices.keithley
        • +
        • pcdsdevices.lakeshore
        • pcdsdevices.lamp_motion
        • pcdsdevices.lasers.btps
        • pcdsdevices.lasers.counters
        • @@ -219,9 +215,9 @@

          pcdsdevices.gauge.GaugeSetMks
          Parameters:
            -
          • prefix (str) – Gauge base PV (up to GCC/GPI).

          • -
          • name (str) – Alias for the gauge set.

          • -
          • index (str or int) – Index for gauge (e.g. ‘02’ or 3).

          • +
          • prefix (str) – Gauge base PV (up to GCC/GPI).

          • +
          • name (str) – Alias for the gauge set.

          • +
          • index (str or int) – Index for gauge (e.g. ‘02’ or 3).

          @@ -260,14 +256,14 @@

          pcdsdevices.gauge.GaugeSetMksMethods

          -configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]
          +configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]

          Configure the device for something during a run

          This default implementation allows the user to change any of the configuration_attrs. Subclasses might override this to perform additional input validation, cleanup, etc.

          Parameters:
          -

          d (dict) – The configuration dictionary. To specify the order that +

          d (dict) – The configuration dictionary. To specify the order that the changes should be made, use an OrderedDict.

          Returns:
          @@ -282,7 +278,7 @@

          pcdsdevices.gauge.GaugeSetMks
          -describe() OrderedDictType[str, Dict[str, Any]]
          +describe() OrderedDictType[str, Dict[str, Any]]

          Provide schema and meta-data for read().

          This keys in the OrderedDict this method returns must match the keys in the OrderedDict return by read().

          @@ -322,7 +318,7 @@

          pcdsdevices.gauge.GaugeSetMks
          -read() OrderedDictType[str, Dict[str, Any]]
          +read() OrderedDictType[str, Dict[str, Any]]

          Read data from the device.

          This method is expected to be as instantaneous as possible, with any substantial acquisition time taken care of in @@ -345,7 +341,7 @@

          pcdsdevices.gauge.GaugeSetMks
          -read_configuration() OrderedDictType[str, Dict[str, Any]]
          +read_configuration() OrderedDictType[str, Dict[str, Any]]

          Dictionary mapping names to value dicts with keys: value, timestamp

          To control which fields are included, change the Component kinds on the device, or modify the configuration_attrs list.

          @@ -361,7 +357,7 @@

          pcdsdevices.gauge.GaugeSetMks
          -status() str
          +status() str

          Returns a str with the current pv values for the device.

          @@ -378,7 +374,7 @@

          pcdsdevices.gauge.GaugeSetMks
          -trigger() StatusBase
          +trigger() StatusBase

          Trigger the device and return status object.

          This method is responsible for implementing ‘trigger’ or ‘acquire’ functionality of this device.

          @@ -386,14 +382,14 @@

          pcdsdevices.gauge.GaugeSetMksread() method) then this method is also responsible for arranging that the -StatusBase object returned by this method +StatusBase object returned by this method is notified when the device is ready to be read.

          If there is no delay between triggering and being readable, -then this method must return a StatusBase +then this method must return a StatusBase object which is already completed.

          Returns:
          -

          status (StatusBase) – StatusBase object which will be marked +

          status (StatusBase) – StatusBase object which will be marked as complete when the device is ready to be read.

          @@ -422,7 +418,7 @@

          pcdsdevices.gauge.GaugeSetMks
          -subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})
          +subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})

          diff --git a/master/generated/pcdsdevices.gauge.GaugeSetPirani.html b/master/generated/pcdsdevices.gauge.GaugeSetPirani.html index 4bfd371019b..0084d3cf688 100644 --- a/master/generated/pcdsdevices.gauge.GaugeSetPirani.html +++ b/master/generated/pcdsdevices.gauge.GaugeSetPirani.html @@ -1,25 +1,23 @@ + + - pcdsdevices.gauge.GaugeSetPirani — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.gauge.GaugeSetPirani — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -
          - 8.5.1.dev30+gd6e98430 -
          @@ -105,6 +100,7 @@
        • pcdsdevices.ipm
        • pcdsdevices.jet
        • pcdsdevices.keithley
        • +
        • pcdsdevices.lakeshore
        • pcdsdevices.lamp_motion
        • pcdsdevices.lasers.btps
        • pcdsdevices.lasers.counters
        • @@ -219,9 +215,9 @@

          pcdsdevices.gauge.GaugeSetPirani
          Parameters:
            -
          • prefix (str) – Gauge base PV (up to GCC/GPI).

          • -
          • name (str) – Alias for the gauge set.

          • -
          • index (str or int) – Index for gauge (e.g. ‘02’ or 3).

          • +
          • prefix (str) – Gauge base PV (up to GCC/GPI).

          • +
          • name (str) – Alias for the gauge set.

          • +
          • index (str or int) – Index for gauge (e.g. ‘02’ or 3).

          @@ -256,14 +252,14 @@

          pcdsdevices.gauge.GaugeSetPiraniMethods

          -configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]
          +configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]

          Configure the device for something during a run

          This default implementation allows the user to change any of the configuration_attrs. Subclasses might override this to perform additional input validation, cleanup, etc.

          Parameters:
          -

          d (dict) – The configuration dictionary. To specify the order that +

          d (dict) – The configuration dictionary. To specify the order that the changes should be made, use an OrderedDict.

          Returns:
          @@ -278,7 +274,7 @@

          pcdsdevices.gauge.GaugeSetPirani
          -describe() OrderedDictType[str, Dict[str, Any]]
          +describe() OrderedDictType[str, Dict[str, Any]]

          Provide schema and meta-data for read().

          This keys in the OrderedDict this method returns must match the keys in the OrderedDict return by read().

          @@ -318,7 +314,7 @@

          pcdsdevices.gauge.GaugeSetPirani
          -read() OrderedDictType[str, Dict[str, Any]]
          +read() OrderedDictType[str, Dict[str, Any]]

          Read data from the device.

          This method is expected to be as instantaneous as possible, with any substantial acquisition time taken care of in @@ -341,7 +337,7 @@

          pcdsdevices.gauge.GaugeSetPirani
          -read_configuration() OrderedDictType[str, Dict[str, Any]]
          +read_configuration() OrderedDictType[str, Dict[str, Any]]

          Dictionary mapping names to value dicts with keys: value, timestamp

          To control which fields are included, change the Component kinds on the device, or modify the configuration_attrs list.

          @@ -357,7 +353,7 @@

          pcdsdevices.gauge.GaugeSetPirani
          -status() str
          +status() str

          Returns a str with the current pv values for the device.

          @@ -374,7 +370,7 @@

          pcdsdevices.gauge.GaugeSetPirani
          -trigger() StatusBase
          +trigger() StatusBase

          Trigger the device and return status object.

          This method is responsible for implementing ‘trigger’ or ‘acquire’ functionality of this device.

          @@ -382,14 +378,14 @@

          pcdsdevices.gauge.GaugeSetPiraniread() method) then this method is also responsible for arranging that the -StatusBase object returned by this method +StatusBase object returned by this method is notified when the device is ready to be read.

          If there is no delay between triggering and being readable, -then this method must return a StatusBase +then this method must return a StatusBase object which is already completed.

          Returns:
          -

          status (StatusBase) – StatusBase object which will be marked +

          status (StatusBase) – StatusBase object which will be marked as complete when the device is ready to be read.

          @@ -418,7 +414,7 @@

          pcdsdevices.gauge.GaugeSetPirani
          -subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})
          +subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})

          diff --git a/master/generated/pcdsdevices.gauge.GaugeSetPiraniMks.html b/master/generated/pcdsdevices.gauge.GaugeSetPiraniMks.html index 6dcdd9ab848..75a87a3dd60 100644 --- a/master/generated/pcdsdevices.gauge.GaugeSetPiraniMks.html +++ b/master/generated/pcdsdevices.gauge.GaugeSetPiraniMks.html @@ -1,25 +1,23 @@ + + - pcdsdevices.gauge.GaugeSetPiraniMks — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.gauge.GaugeSetPiraniMks — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -
          - 8.5.1.dev30+gd6e98430 -
          @@ -105,6 +100,7 @@
        • pcdsdevices.ipm
        • pcdsdevices.jet
        • pcdsdevices.keithley
        • +
        • pcdsdevices.lakeshore
        • pcdsdevices.lamp_motion
        • pcdsdevices.lasers.btps
        • pcdsdevices.lasers.counters
        • @@ -219,9 +215,9 @@

          pcdsdevices.gauge.GaugeSetPiraniMks
          Parameters:
            -
          • prefix (str) – Gauge base PV (up to GCC/GPI).

          • -
          • name (str) – Alias for the gauge set.

          • -
          • index (str or int) – Index for gauge (e.g. ‘02’ or 3).

          • +
          • prefix (str) – Gauge base PV (up to GCC/GPI).

          • +
          • name (str) – Alias for the gauge set.

          • +
          • index (str or int) – Index for gauge (e.g. ‘02’ or 3).

          @@ -267,14 +263,14 @@

          pcdsdevices.gauge.GaugeSetPiraniMksMethods

          -configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]
          +configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]

          Configure the device for something during a run

          This default implementation allows the user to change any of the configuration_attrs. Subclasses might override this to perform additional input validation, cleanup, etc.

          Parameters:
          -

          d (dict) – The configuration dictionary. To specify the order that +

          d (dict) – The configuration dictionary. To specify the order that the changes should be made, use an OrderedDict.

          Returns:
          @@ -289,7 +285,7 @@

          pcdsdevices.gauge.GaugeSetPiraniMks
          -describe() OrderedDictType[str, Dict[str, Any]]
          +describe() OrderedDictType[str, Dict[str, Any]]

          Provide schema and meta-data for read().

          This keys in the OrderedDict this method returns must match the keys in the OrderedDict return by read().

          @@ -329,7 +325,7 @@

          pcdsdevices.gauge.GaugeSetPiraniMks
          -read() OrderedDictType[str, Dict[str, Any]]
          +read() OrderedDictType[str, Dict[str, Any]]

          Read data from the device.

          This method is expected to be as instantaneous as possible, with any substantial acquisition time taken care of in @@ -352,7 +348,7 @@

          pcdsdevices.gauge.GaugeSetPiraniMks
          -read_configuration() OrderedDictType[str, Dict[str, Any]]
          +read_configuration() OrderedDictType[str, Dict[str, Any]]

          Dictionary mapping names to value dicts with keys: value, timestamp

          To control which fields are included, change the Component kinds on the device, or modify the configuration_attrs list.

          @@ -368,7 +364,7 @@

          pcdsdevices.gauge.GaugeSetPiraniMks
          -status() str
          +status() str

          Returns a str with the current pv values for the device.

          @@ -385,7 +381,7 @@

          pcdsdevices.gauge.GaugeSetPiraniMks
          -trigger() StatusBase
          +trigger() StatusBase

          Trigger the device and return status object.

          This method is responsible for implementing ‘trigger’ or ‘acquire’ functionality of this device.

          @@ -393,14 +389,14 @@

          pcdsdevices.gauge.GaugeSetPiraniMksread() method) then this method is also responsible for arranging that the -StatusBase object returned by this method +StatusBase object returned by this method is notified when the device is ready to be read.

          If there is no delay between triggering and being readable, -then this method must return a StatusBase +then this method must return a StatusBase object which is already completed.

          Returns:
          -

          status (StatusBase) – StatusBase object which will be marked +

          status (StatusBase) – StatusBase object which will be marked as complete when the device is ready to be read.

          @@ -429,7 +425,7 @@

          pcdsdevices.gauge.GaugeSetPiraniMks
          -subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})
          +subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})

          diff --git a/master/generated/pcdsdevices.gauge.MKS937AController.html b/master/generated/pcdsdevices.gauge.MKS937AController.html index 6df73998a69..db9c3580a6a 100644 --- a/master/generated/pcdsdevices.gauge.MKS937AController.html +++ b/master/generated/pcdsdevices.gauge.MKS937AController.html @@ -1,25 +1,23 @@ + + - pcdsdevices.gauge.MKS937AController — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.gauge.MKS937AController — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -
          - 8.5.1.dev30+gd6e98430 -
          @@ -105,6 +100,7 @@
        • pcdsdevices.ipm
        • pcdsdevices.jet
        • pcdsdevices.keithley
        • +
        • pcdsdevices.lakeshore
        • pcdsdevices.lamp_motion
        • pcdsdevices.lasers.btps
        • pcdsdevices.lasers.counters
        • @@ -331,14 +327,14 @@

          pcdsdevices.gauge.MKS937AControllerMethods

          -configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]
          +configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]

          Configure the device for something during a run

          This default implementation allows the user to change any of the configuration_attrs. Subclasses might override this to perform additional input validation, cleanup, etc.

          Parameters:
          -

          d (dict) – The configuration dictionary. To specify the order that +

          d (dict) – The configuration dictionary. To specify the order that the changes should be made, use an OrderedDict.

          Returns:
          @@ -353,7 +349,7 @@

          pcdsdevices.gauge.MKS937AController
          -describe() OrderedDictType[str, Dict[str, Any]]
          +describe() OrderedDictType[str, Dict[str, Any]]

          Provide schema and meta-data for read().

          This keys in the OrderedDict this method returns must match the keys in the OrderedDict return by read().

          @@ -377,7 +373,7 @@

          pcdsdevices.gauge.MKS937AController
          -read() OrderedDictType[str, Dict[str, Any]]
          +read() OrderedDictType[str, Dict[str, Any]]

          Read data from the device.

          This method is expected to be as instantaneous as possible, with any substantial acquisition time taken care of in @@ -400,7 +396,7 @@

          pcdsdevices.gauge.MKS937AController
          -read_configuration() OrderedDictType[str, Dict[str, Any]]
          +read_configuration() OrderedDictType[str, Dict[str, Any]]

          Dictionary mapping names to value dicts with keys: value, timestamp

          To control which fields are included, change the Component kinds on the device, or modify the configuration_attrs list.

          @@ -419,7 +415,7 @@

          pcdsdevices.gauge.MKS937AController
          -trigger() StatusBase
          +trigger() StatusBase

          Trigger the device and return status object.

          This method is responsible for implementing ‘trigger’ or ‘acquire’ functionality of this device.

          @@ -427,14 +423,14 @@

          pcdsdevices.gauge.MKS937AControllerread() method) then this method is also responsible for arranging that the -StatusBase object returned by this method +StatusBase object returned by this method is notified when the device is ready to be read.

          If there is no delay between triggering and being readable, -then this method must return a StatusBase +then this method must return a StatusBase object which is already completed.

          Returns:
          -

          status (StatusBase) – StatusBase object which will be marked +

          status (StatusBase) – StatusBase object which will be marked as complete when the device is ready to be read.

          @@ -463,7 +459,7 @@

          pcdsdevices.gauge.MKS937AController
          -subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})
          +subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})

          diff --git a/master/generated/pcdsdevices.gauge.MKS937BController.html b/master/generated/pcdsdevices.gauge.MKS937BController.html index a58d424743d..0af196d8a0e 100644 --- a/master/generated/pcdsdevices.gauge.MKS937BController.html +++ b/master/generated/pcdsdevices.gauge.MKS937BController.html @@ -1,25 +1,23 @@ + + - pcdsdevices.gauge.MKS937BController — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.gauge.MKS937BController — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -
          - 8.5.1.dev30+gd6e98430 -
          @@ -105,6 +100,7 @@
        • pcdsdevices.ipm
        • pcdsdevices.jet
        • pcdsdevices.keithley
        • +
        • pcdsdevices.lakeshore
        • pcdsdevices.lamp_motion
        • pcdsdevices.lasers.btps
        • pcdsdevices.lasers.counters
        • @@ -317,14 +313,14 @@

          pcdsdevices.gauge.MKS937BControllerMethods

          -configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]
          +configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]

          Configure the device for something during a run

          This default implementation allows the user to change any of the configuration_attrs. Subclasses might override this to perform additional input validation, cleanup, etc.

          Parameters:
          -

          d (dict) – The configuration dictionary. To specify the order that +

          d (dict) – The configuration dictionary. To specify the order that the changes should be made, use an OrderedDict.

          Returns:
          @@ -339,7 +335,7 @@

          pcdsdevices.gauge.MKS937BController
          -describe() OrderedDictType[str, Dict[str, Any]]
          +describe() OrderedDictType[str, Dict[str, Any]]

          Provide schema and meta-data for read().

          This keys in the OrderedDict this method returns must match the keys in the OrderedDict return by read().

          @@ -363,7 +359,7 @@

          pcdsdevices.gauge.MKS937BController
          -read() OrderedDictType[str, Dict[str, Any]]
          +read() OrderedDictType[str, Dict[str, Any]]

          Read data from the device.

          This method is expected to be as instantaneous as possible, with any substantial acquisition time taken care of in @@ -386,7 +382,7 @@

          pcdsdevices.gauge.MKS937BController
          -read_configuration() OrderedDictType[str, Dict[str, Any]]
          +read_configuration() OrderedDictType[str, Dict[str, Any]]

          Dictionary mapping names to value dicts with keys: value, timestamp

          To control which fields are included, change the Component kinds on the device, or modify the configuration_attrs list.

          @@ -405,7 +401,7 @@

          pcdsdevices.gauge.MKS937BController
          -trigger() StatusBase
          +trigger() StatusBase

          Trigger the device and return status object.

          This method is responsible for implementing ‘trigger’ or ‘acquire’ functionality of this device.

          @@ -413,14 +409,14 @@

          pcdsdevices.gauge.MKS937BControllerread() method) then this method is also responsible for arranging that the -StatusBase object returned by this method +StatusBase object returned by this method is notified when the device is ready to be read.

          If there is no delay between triggering and being readable, -then this method must return a StatusBase +then this method must return a StatusBase object which is already completed.

          Returns:
          -

          status (StatusBase) – StatusBase object which will be marked +

          status (StatusBase) – StatusBase object which will be marked as complete when the device is ready to be read.

          @@ -449,7 +445,7 @@

          pcdsdevices.gauge.MKS937BController
          -subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})
          +subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})

          diff --git a/master/generated/pcdsdevices.gauge.MKS937a.html b/master/generated/pcdsdevices.gauge.MKS937a.html index 053777cd824..8c3cdc8094c 100644 --- a/master/generated/pcdsdevices.gauge.MKS937a.html +++ b/master/generated/pcdsdevices.gauge.MKS937a.html @@ -1,25 +1,23 @@ + + - pcdsdevices.gauge.MKS937a — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.gauge.MKS937a — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -
          - 8.5.1.dev30+gd6e98430 -
          @@ -105,6 +100,7 @@
        • pcdsdevices.ipm
        • pcdsdevices.jet
        • pcdsdevices.keithley
        • +
        • pcdsdevices.lakeshore
        • pcdsdevices.lamp_motion
        • pcdsdevices.lasers.btps
        • pcdsdevices.lasers.counters
        • @@ -219,8 +215,8 @@

          pcdsdevices.gauge.MKS937a
          Parameters:
            -
          • prefix (str) – Full Gauge controller base PV.

          • -
          • name (str) – A name to refer to the gauge controller.

          • +
          • prefix (str) – Full Gauge controller base PV.

          • +
          • name (str) – A name to refer to the gauge controller.

          @@ -304,14 +300,14 @@

          pcdsdevices.gauge.MKS937aMethods

          -configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]
          +configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]

          Configure the device for something during a run

          This default implementation allows the user to change any of the configuration_attrs. Subclasses might override this to perform additional input validation, cleanup, etc.

          Parameters:
          -

          d (dict) – The configuration dictionary. To specify the order that +

          d (dict) – The configuration dictionary. To specify the order that the changes should be made, use an OrderedDict.

          Returns:
          @@ -326,7 +322,7 @@

          pcdsdevices.gauge.MKS937a
          -describe() OrderedDictType[str, Dict[str, Any]]
          +describe() OrderedDictType[str, Dict[str, Any]]

          Provide schema and meta-data for read().

          This keys in the OrderedDict this method returns must match the keys in the OrderedDict return by read().

          @@ -356,7 +352,7 @@

          pcdsdevices.gauge.MKS937a
          -read() OrderedDictType[str, Dict[str, Any]]
          +read() OrderedDictType[str, Dict[str, Any]]

          Read data from the device.

          This method is expected to be as instantaneous as possible, with any substantial acquisition time taken care of in @@ -379,7 +375,7 @@

          pcdsdevices.gauge.MKS937a
          -read_configuration() OrderedDictType[str, Dict[str, Any]]
          +read_configuration() OrderedDictType[str, Dict[str, Any]]

          Dictionary mapping names to value dicts with keys: value, timestamp

          To control which fields are included, change the Component kinds on the device, or modify the configuration_attrs list.

          @@ -395,7 +391,7 @@

          pcdsdevices.gauge.MKS937a
          -status() str
          +status() str

          Returns a str with the current pv values for the device.

          @@ -412,7 +408,7 @@

          pcdsdevices.gauge.MKS937a
          -trigger() StatusBase
          +trigger() StatusBase

          Trigger the device and return status object.

          This method is responsible for implementing ‘trigger’ or ‘acquire’ functionality of this device.

          @@ -420,14 +416,14 @@

          pcdsdevices.gauge.MKS937aread() method) then this method is also responsible for arranging that the -StatusBase object returned by this method +StatusBase object returned by this method is notified when the device is ready to be read.

          If there is no delay between triggering and being readable, -then this method must return a StatusBase +then this method must return a StatusBase object which is already completed.

          Returns:
          -

          status (StatusBase) – StatusBase object which will be marked +

          status (StatusBase) – StatusBase object which will be marked as complete when the device is ready to be read.

          @@ -456,7 +452,7 @@

          pcdsdevices.gauge.MKS937a
          -subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})
          +subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})

          diff --git a/master/generated/pcdsdevices.gon.BaseGon.html b/master/generated/pcdsdevices.gon.BaseGon.html index 2a748c9b85a..69bac9a9bb2 100644 --- a/master/generated/pcdsdevices.gon.BaseGon.html +++ b/master/generated/pcdsdevices.gon.BaseGon.html @@ -1,25 +1,23 @@ + + - pcdsdevices.gon.BaseGon — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.gon.BaseGon — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -
          - 8.5.1.dev30+gd6e98430 -
          @@ -81,6 +76,7 @@
        • pcdsdevices.gon.GonWithDetArm
        • pcdsdevices.gon.Goniometer
        • +
        • pcdsdevices.gon.HxrDiffractometer
        • pcdsdevices.gon.Kappa
        • pcdsdevices.gon.KappaXYZStage
        • pcdsdevices.gon.SamPhi
        • @@ -94,6 +90,7 @@
        • pcdsdevices.ipm
        • pcdsdevices.jet
        • pcdsdevices.keithley
        • +
        • pcdsdevices.lakeshore
        • pcdsdevices.lamp_motion
        • pcdsdevices.lasers.btps
        • pcdsdevices.lasers.counters
        • @@ -210,12 +207,12 @@

          pcdsdevices.gon.BaseGon
          Parameters:
            -
          • name (str) – A name to refer to the goniometer device.

          • -
          • prefix_hor (str) – The EPICS base PV of the common-horizontal motor.

          • -
          • prefix_ver (str) – The EPICS base PV of the common-vertical motor.

          • -
          • prefix_rot (str) – The EPICS base PV of the common-rotation motor.

          • -
          • prefix_tip (str) – The EPICS base PV of the sample-stage’s tip motor.

          • -
          • prefix_tilt (str) – The EPICS base PV of the sample-stage’s tilt motor.

          • +
          • name (str) – A name to refer to the goniometer device.

          • +
          • prefix_hor (str) – The EPICS base PV of the common-horizontal motor.

          • +
          • prefix_ver (str) – The EPICS base PV of the common-vertical motor.

          • +
          • prefix_rot (str) – The EPICS base PV of the common-rotation motor.

          • +
          • prefix_tip (str) – The EPICS base PV of the sample-stage’s tip motor.

          • +
          • prefix_tilt (str) – The EPICS base PV of the sample-stage’s tilt motor.

          @@ -271,14 +268,14 @@

          pcdsdevices.gon.BaseGonMethods

          -configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]
          +configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]

          Configure the device for something during a run

          This default implementation allows the user to change any of the configuration_attrs. Subclasses might override this to perform additional input validation, cleanup, etc.

          Parameters:
          -

          d (dict) – The configuration dictionary. To specify the order that +

          d (dict) – The configuration dictionary. To specify the order that the changes should be made, use an OrderedDict.

          Returns:
          @@ -293,7 +290,7 @@

          pcdsdevices.gon.BaseGon
          -describe() OrderedDictType[str, Dict[str, Any]]
          +describe() OrderedDictType[str, Dict[str, Any]]

          Provide schema and meta-data for read().

          This keys in the OrderedDict this method returns must match the keys in the OrderedDict return by read().

          @@ -323,7 +320,7 @@

          pcdsdevices.gon.BaseGon
          -read() OrderedDictType[str, Dict[str, Any]]
          +read() OrderedDictType[str, Dict[str, Any]]

          Read data from the device.

          This method is expected to be as instantaneous as possible, with any substantial acquisition time taken care of in @@ -346,7 +343,7 @@

          pcdsdevices.gon.BaseGon
          -read_configuration() OrderedDictType[str, Dict[str, Any]]
          +read_configuration() OrderedDictType[str, Dict[str, Any]]

          Dictionary mapping names to value dicts with keys: value, timestamp

          To control which fields are included, change the Component kinds on the device, or modify the configuration_attrs list.

          @@ -362,13 +359,13 @@

          pcdsdevices.gon.BaseGon
          -stage_group_instances() Iterator[OphydObject]
          +stage_group_instances() Iterator[OphydObject]

          Yields an iterator of subdevices that should be staged.

          -status() str
          +status() str

          Returns a str with the current pv values for the device.

          @@ -385,7 +382,7 @@

          pcdsdevices.gon.BaseGon
          -trigger() StatusBase
          +trigger() StatusBase

          Trigger the device and return status object.

          This method is responsible for implementing ‘trigger’ or ‘acquire’ functionality of this device.

          @@ -393,14 +390,14 @@

          pcdsdevices.gon.BaseGonread() method) then this method is also responsible for arranging that the -StatusBase object returned by this method +StatusBase object returned by this method is notified when the device is ready to be read.

          If there is no delay between triggering and being readable, -then this method must return a StatusBase +then this method must return a StatusBase object which is already completed.

          Returns:
          -

          status (StatusBase) – StatusBase object which will be marked +

          status (StatusBase) – StatusBase object which will be marked as complete when the device is ready to be read.

          @@ -429,17 +426,17 @@

          pcdsdevices.gon.BaseGon
          -needs_parent: list[type[OphydObject]] = [<class 'ophyd.signal.AttributeSignal'>, <class 'ophyd.signal.DerivedSignal'>, <class 'ophyd.areadetector.plugins.PluginBase'>, <class 'ophyd.pseudopos.PseudoSingle'>, <class 'pcdsdevices.signal.PVStateSignal'>, <class 'pcdsdevices.signal.AggregateSignal'>]
          +needs_parent: list[type[OphydObject]] = [<class 'ophyd.signal.AttributeSignal'>, <class 'ophyd.signal.DerivedSignal'>, <class 'ophyd.areadetector.plugins.PluginBase'>, <class 'ophyd.pseudopos.PseudoSingle'>, <class 'pcdsdevices.signal.PVStateSignal'>, <class 'pcdsdevices.signal.AggregateSignal'>]

          -stage_group: list[Component] = None
          +stage_group: list[Component] = None
          -subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})
          +subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})
          diff --git a/master/generated/pcdsdevices.gon.GonWithDetArm.html b/master/generated/pcdsdevices.gon.GonWithDetArm.html index 1ce9f0181a1..b74a7d136dc 100644 --- a/master/generated/pcdsdevices.gon.GonWithDetArm.html +++ b/master/generated/pcdsdevices.gon.GonWithDetArm.html @@ -1,25 +1,23 @@ + + - pcdsdevices.gon.GonWithDetArm — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.gon.GonWithDetArm — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + @@ -38,9 +36,6 @@ PCDS Devices -
          - 8.5.1.dev30+gd6e98430 -
          @@ -81,6 +76,7 @@
        • pcdsdevices.gon.Goniometer
        • +
        • pcdsdevices.gon.HxrDiffractometer
        • pcdsdevices.gon.Kappa
        • pcdsdevices.gon.KappaXYZStage
        • pcdsdevices.gon.SamPhi
        • @@ -94,6 +90,7 @@
        • pcdsdevices.ipm
        • pcdsdevices.jet
        • pcdsdevices.keithley
        • +
        • pcdsdevices.lakeshore
        • pcdsdevices.lamp_motion
        • pcdsdevices.lasers.btps
        • pcdsdevices.lasers.counters
        • @@ -210,15 +207,15 @@

          pcdsdevices.gon.GonWithDetArm
          Parameters:
            -
          • name (str) – A name to refer to the goniometer device.

          • -
          • prefix_hor (str) – The EPICS base PV of the common-horizontal motor.

          • -
          • prefix_ver (str) – The EPICS base PV of the common-vertical motor.

          • -
          • prefix_rot (str) – The EPICS base PV of the common-rotation motor.

          • -
          • prefix_tip (str) – The EPICS base PV of the sample-stage’s tip motor.

          • -
          • prefix_tilt (str) – The EPICS base PV of the sample-stage’s tilt motor.

          • -
          • prefix_2theta (str) – The EPICS base PV of the detector arm’s 2theta rotation motor.

          • -
          • prefix_dettilt (str) – The EPICS base PV of the detector stage’s tilt motor.

          • -
          • prefix_detver (str) – The EPICS base PV of the detector stage’s vertical motor.

          • +
          • name (str) – A name to refer to the goniometer device.

          • +
          • prefix_hor (str) – The EPICS base PV of the common-horizontal motor.

          • +
          • prefix_ver (str) – The EPICS base PV of the common-vertical motor.

          • +
          • prefix_rot (str) – The EPICS base PV of the common-rotation motor.

          • +
          • prefix_tip (str) – The EPICS base PV of the sample-stage’s tip motor.

          • +
          • prefix_tilt (str) – The EPICS base PV of the sample-stage’s tilt motor.

          • +
          • prefix_2theta (str) – The EPICS base PV of the detector arm’s 2theta rotation motor.

          • +
          • prefix_dettilt (str) – The EPICS base PV of the detector stage’s tilt motor.

          • +
          • prefix_detver (str) – The EPICS base PV of the detector stage’s vertical motor.

          @@ -295,14 +292,14 @@

          pcdsdevices.gon.GonWithDetArmMethods

          -configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]
          +configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]

          Configure the device for something during a run

          This default implementation allows the user to change any of the configuration_attrs. Subclasses might override this to perform additional input validation, cleanup, etc.

          Parameters:
          -

          d (dict) – The configuration dictionary. To specify the order that +

          d (dict) – The configuration dictionary. To specify the order that the changes should be made, use an OrderedDict.

          Returns:
          @@ -317,7 +314,7 @@

          pcdsdevices.gon.GonWithDetArm
          -describe() OrderedDictType[str, Dict[str, Any]]
          +describe() OrderedDictType[str, Dict[str, Any]]

          Provide schema and meta-data for read().

          This keys in the OrderedDict this method returns must match the keys in the OrderedDict return by read().

          @@ -347,7 +344,7 @@

          pcdsdevices.gon.GonWithDetArm
          -read() OrderedDictType[str, Dict[str, Any]]
          +read() OrderedDictType[str, Dict[str, Any]]

          Read data from the device.

          This method is expected to be as instantaneous as possible, with any substantial acquisition time taken care of in @@ -370,7 +367,7 @@

          pcdsdevices.gon.GonWithDetArm
          -read_configuration() OrderedDictType[str, Dict[str, Any]]
          +read_configuration() OrderedDictType[str, Dict[str, Any]]

          Dictionary mapping names to value dicts with keys: value, timestamp

          To control which fields are included, change the Component kinds on the device, or modify the configuration_attrs list.

          @@ -386,13 +383,13 @@

          pcdsdevices.gon.GonWithDetArm
          -stage_group_instances() Iterator[OphydObject]
          +stage_group_instances() Iterator[OphydObject]

          Yields an iterator of subdevices that should be staged.

          -status() str
          +status() str

          Returns a str with the current pv values for the device.

          @@ -409,7 +406,7 @@

          pcdsdevices.gon.GonWithDetArm
          -trigger() StatusBase
          +trigger() StatusBase

          Trigger the device and return status object.

          This method is responsible for implementing ‘trigger’ or ‘acquire’ functionality of this device.

          @@ -417,14 +414,14 @@

          pcdsdevices.gon.GonWithDetArmread() method) then this method is also responsible for arranging that the -StatusBase object returned by this method +StatusBase object returned by this method is notified when the device is ready to be read.

          If there is no delay between triggering and being readable, -then this method must return a StatusBase +then this method must return a StatusBase object which is already completed.

          Returns:
          -

          status (StatusBase) – StatusBase object which will be marked +

          status (StatusBase) – StatusBase object which will be marked as complete when the device is ready to be read.

          @@ -453,17 +450,17 @@

          pcdsdevices.gon.GonWithDetArm
          -needs_parent: list[type[OphydObject]] = [<class 'ophyd.signal.AttributeSignal'>, <class 'ophyd.signal.DerivedSignal'>, <class 'ophyd.areadetector.plugins.PluginBase'>, <class 'ophyd.pseudopos.PseudoSingle'>, <class 'pcdsdevices.signal.PVStateSignal'>, <class 'pcdsdevices.signal.AggregateSignal'>]
          +needs_parent: list[type[OphydObject]] = [<class 'ophyd.signal.AttributeSignal'>, <class 'ophyd.signal.DerivedSignal'>, <class 'ophyd.areadetector.plugins.PluginBase'>, <class 'ophyd.pseudopos.PseudoSingle'>, <class 'pcdsdevices.signal.PVStateSignal'>, <class 'pcdsdevices.signal.AggregateSignal'>]

          -stage_group: list[Component] = None
          +stage_group: list[Component] = None
          -subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})
          +subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})
          diff --git a/master/generated/pcdsdevices.gon.Goniometer.html b/master/generated/pcdsdevices.gon.Goniometer.html index 715da930b73..5ba87a03c83 100644 --- a/master/generated/pcdsdevices.gon.Goniometer.html +++ b/master/generated/pcdsdevices.gon.Goniometer.html @@ -1,29 +1,27 @@ + + - pcdsdevices.gon.Goniometer — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.gon.Goniometer — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + - + @@ -38,9 +36,6 @@ PCDS Devices -
          - 8.5.1.dev30+gd6e98430 -
          @@ -81,6 +76,7 @@
        • Goniometer()
        • +
        • pcdsdevices.gon.HxrDiffractometer
        • pcdsdevices.gon.Kappa
        • pcdsdevices.gon.KappaXYZStage
        • pcdsdevices.gon.SamPhi
        • @@ -94,6 +90,7 @@
        • pcdsdevices.ipm
        • pcdsdevices.jet
        • pcdsdevices.keithley
        • +
        • pcdsdevices.lakeshore
        • pcdsdevices.lamp_motion
        • pcdsdevices.lasers.btps
        • pcdsdevices.lasers.counters
        • @@ -213,15 +210,15 @@

          pcdsdevices.gon.Goniometer
          Parameters:
            -
          • name (str) – A name to refer to the goniometer device.

          • -
          • prefix_hor (str) – The EPICS base PV of the common-horizontal motor.

          • -
          • prefix_ver (str) – The EPICS base PV of the common-vertical motor.

          • -
          • prefix_rot (str) – The EPICS base PV of the common-rotation motor.

          • -
          • prefix_tip (str) – The EPICS base PV of the sample-stage’s tip motor.

          • -
          • prefix_tilt (str) – The EPICS base PV of the sample-stage’s tilt motor.

          • -
          • prefix_2theta (str, optional) – The EPICS base PV of the detector arm’s 2theta rotation motor.

          • -
          • prefix_dettilt (str, optional) – The EPICS base PV of the detector stage’s tilt motor.

          • -
          • prefix_detver (str, optional) – The EPICS base PV of the detector stage’s vertical motor.

          • +
          • name (str) – A name to refer to the goniometer device.

          • +
          • prefix_hor (str) – The EPICS base PV of the common-horizontal motor.

          • +
          • prefix_ver (str) – The EPICS base PV of the common-vertical motor.

          • +
          • prefix_rot (str) – The EPICS base PV of the common-rotation motor.

          • +
          • prefix_tip (str) – The EPICS base PV of the sample-stage’s tip motor.

          • +
          • prefix_tilt (str) – The EPICS base PV of the sample-stage’s tilt motor.

          • +
          • prefix_2theta (str, optional) – The EPICS base PV of the detector arm’s 2theta rotation motor.

          • +
          • prefix_dettilt (str, optional) – The EPICS base PV of the detector stage’s tilt motor.

          • +
          • prefix_detver (str, optional) – The EPICS base PV of the detector stage’s vertical motor.

          @@ -234,7 +231,7 @@

          pcdsdevices.gon.Goniometer - +


          diff --git a/master/generated/pcdsdevices.gon.HxrDiffractometer.html b/master/generated/pcdsdevices.gon.HxrDiffractometer.html new file mode 100644 index 00000000000..d0473617e96 --- /dev/null +++ b/master/generated/pcdsdevices.gon.HxrDiffractometer.html @@ -0,0 +1,455 @@ + + + + + + + + + pcdsdevices.gon.HxrDiffractometer — PCDS Devices 8.6.1.dev136+gc5060c80 documentation + + + + + + + + + + + + + + + + + + + +
          + + +
          + +
          +
          +
          + +
          +
          +
          +
          + +
          +

          pcdsdevices.gon.HxrDiffractometer

          +
          +
          +class pcdsdevices.gon.HxrDiffractometer(*args, **kwargs)
          +

          Class for Beckhoff-based diffractometer.

          +
          +
          Parameters:
          +
            +
          • prefix (str) – The EPICS base PV of the diffractometer stages

          • +
          • name (str, keyword-only) – A name to refer to the device

          • +
          +
          +
          +

          Ophyd Device Components

          Inherited from EpicsMotor

          user_setpoint (UpdateComponent)

          EpicsSignalEditMD

          Inherited from EpicsMotor

          user_offset

          EpicsSignal

          .OFF

          config

          Inherited from EpicsMotor

          Inherited from EpicsMotor

          user_offset_dir

          EpicsSignal

          .DIR

          config

          Inherited from EpicsMotor

          Inherited from EpicsMotor

          offset_freeze_switch

          EpicsSignal

          .FOFF

          omitted

          Inherited from EpicsMotor

          Inherited from EpicsMotor

          set_use_switch

          EpicsSignal

          .SET

          omitted

          Inherited from EpicsMotor

          Inherited from EpicsMotor

          velocity

          EpicsSignal

          .VELO

          config

          Inherited from EpicsMotor

          Inherited from EpicsMotor

          acceleration

          EpicsSignal

          .ACCL

          config

          Inherited from EpicsMotor

          Inherited from EpicsMotor

          motor_egu

          EpicsSignal

          .EGU

          config

          Inherited from EpicsMotor

          Inherited from EpicsMotor

          motor_is_moving

          EpicsSignalRO

          .MOVN

          normal

          Inherited from EpicsMotor

          Inherited from EpicsMotor

          motor_done_move

          EpicsSignalRO

          .DMOV

          omitted

          Inherited from EpicsMotor

          Inherited from EpicsMotor

          high_limit_switch

          EpicsSignalRO

          .HLS

          normal

          Inherited from EpicsMotor

          Inherited from EpicsMotor

          low_limit_switch

          EpicsSignalRO

          .LLS

          normal

          Inherited from EpicsMotor

          Inherited from EpicsMotor

          high_limit_travel (UpdateComponent)

          EpicsSignal

          Inherited from EpicsMotor

          low_limit_travel (UpdateComponent)

          EpicsSignal

          Inherited from EpicsMotor

          direction_of_travel

          EpicsSignal

          .TDIR

          normal

          Inherited from EpicsMotor

          Inherited from EpicsMotor

          motor_stop

          EpicsSignal

          .STOP

          normal

          Inherited from EpicsMotor

          Inherited from EpicsMotor

          home_forward

          EpicsSignal

          .HOMF

          normal

          Inherited from EpicsMotor

          Inherited from EpicsMotor

          home_reverse

          EpicsSignal

          .HOMR

          normal

          Inherited from EpicsMotor

          Inherited from EpicsMotor

          disabled

          EpicsSignal

          at_vac_setpoint

          EpicsSignalWithRBV

          EpicsSignalWithRBV

          :VAC_SP

          At vacuum setpoint for all gauges

          config

          high_voltage_on

          EpicsSignalWithRBV

          EpicsSignalWithRBV

          :HV_SW

          command to switch the high voltage on

          normal

          protection_setpoint

          EpicsSignalWithRBV

          EpicsSignalWithRBV

          :PRO_SP

          Protection setpoint for ion gauges at which the gauge turns off

          normal

          Inherited from GCCPLC

          setpoint_hysterisis

          EpicsSignalWithRBV

          EpicsSignalWithRBV

          :SP_HYS

          Protection setpoint hysteresis

          config

          auto_on

          EpicsSignalWithRBV

          EpicsSignalWithRBV

          :Auto_On

          Setting to automatically turn on the gauge when thereference gauge pressure is below protection setpoint

          config

          at_vac_setpoint

          EpicsSignalWithRBV

          EpicsSignalWithRBV

          :VAC_SP

          At vacuum setpoint for all gauges

          config

          high_voltage_on

          EpicsSignalWithRBV

          EpicsSignalWithRBV

          :HV_SW

          command to switch the high voltage on

          normal

          protection_setpoint

          EpicsSignalWithRBV

          EpicsSignalWithRBV

          :PRO_SP

          Protection setpoint for ion gauges at which the gauge turns off

          normal

          setpoint_hysterisis

          EpicsSignalWithRBV

          EpicsSignalWithRBV

          :SP_HYS

          Protection setpoint hysteresis

          config

          auto_on

          EpicsSignalWithRBV

          EpicsSignalWithRBV

          :Auto_On

          Setting to automatically turn on the gauge when thereference gauge pressure is below protection setpoint

          config

          at_vac_setpoint

          EpicsSignalWithRBV

          EpicsSignalWithRBV

          :VAC_SP

          At vacuum setpoint for all gauges

          config

          high_voltage_on

          EpicsSignalWithRBV

          EpicsSignalWithRBV

          :HV_SW

          command to switch the high voltage on

          normal

          protection_setpoint

          EpicsSignalWithRBV

          EpicsSignalWithRBV

          :PRO_SP

          Protection setpoint for ion gauges at which the gauge turns off

          normal

          Inherited from GCCPLC

          setpoint_hysterisis

          EpicsSignalWithRBV

          EpicsSignalWithRBV

          :SP_HYS

          Protection setpoint hysteresis

          config

          auto_on

          EpicsSignalWithRBV

          EpicsSignalWithRBV

          :Auto_On

          Setting to automatically turn on the gauge when thereference gauge pressure is below protection setpoint

          config

          at_vac_setpoint

          EpicsSignalWithRBV

          EpicsSignalWithRBV

          :VAC_SP

          At vacuum setpoint for all gauges

          config

          high_voltage_on

          EpicsSignalWithRBV

          EpicsSignalWithRBV

          :HV_SW

          command to switch the high voltage on

          normal

          protection_setpoint

          EpicsSignalWithRBV

          EpicsSignalWithRBV

          :PRO_SP

          Protection setpoint for ion gauges at which the gauge turns off

          normal

          setpoint_hysterisis

          EpicsSignalWithRBV

          EpicsSignalWithRBV

          :SP_HYS

          Protection setpoint hysteresis

          config

          at_vac_setpoint

          EpicsSignalWithRBV

          EpicsSignalWithRBV

          :VAC_SP

          At vacuum setpoint for all gauges

          config

          + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          Ophyd Device Components

          Attribute

          Class

          Suffix

          Docs

          Kind

          Notes

          base_h

          BeckhoffAxis

          BASE_H

          normal

          base_v

          BeckhoffAxis

          BASE_V

          normal

          th

          BeckhoffAxis

          TH

          normal

          tth

          BeckhoffAxis

          TTH

          normal

          chi

          BeckhoffAxis

          CHI

          normal

          +

          Methods

          +
          +
          +configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]
          +

          Configure the device for something during a run

          +

          This default implementation allows the user to change any of the +configuration_attrs. Subclasses might override this to perform +additional input validation, cleanup, etc.

          +
          +
          Parameters:
          +

          d (dict) – The configuration dictionary. To specify the order that +the changes should be made, use an OrderedDict.

          +
          +
          Returns:
          +

            +
          • (old, new) tuple of dictionaries

          • +
          • Where old and new are pre- and post-configure configuration states.

          • +
          +

          +
          +
          +
          + +
          +
          +describe() OrderedDictType[str, Dict[str, Any]]
          +

          Provide schema and meta-data for read().

          +

          This keys in the OrderedDict this method returns must match the +keys in the OrderedDict return by read().

          +

          This provides schema related information, (ex shape, dtype), the +source (ex PV name), and if available, units, limits, precision etc.

          +
          +
          Returns:
          +

          data_keys (OrderedDict) – The keys must be strings and the values must be dict-like +with the event_model.event_descriptor.data_key schema.

          +
          +
          +
          + +
          +
          +get(**kwargs)
          +

          Get the value of all components in the device

          +

          Keyword arguments are passed onto each signal.get(). Components +beginning with an underscore will not be included.

          +
          + +
          +
          +post_elog_status()
          +

          Post device status to the primary elog, if possible.

          +
          + +
          +
          +read() OrderedDictType[str, Dict[str, Any]]
          +

          Read data from the device.

          +

          This method is expected to be as instantaneous as possible, +with any substantial acquisition time taken care of in +trigger().

          +

          The OrderedDict returned by this method must have identical +keys (in the same order) as the OrderedDict returned by +describe().

          +

          By convention, the first key in the return is the ‘primary’ key +and maybe used by heuristics in bluesky.

          +

          The values in the ordered dictionary must be dict (-likes) with the +keys {'value', 'timestamp'}. The 'value' may have any type, +the timestamp must be a float UNIX epoch timestamp in UTC.

          +
          +
          Returns:
          +

          data (OrderedDict) – The keys must be strings and the values must be dict-like +with the keys {'value', 'timestamp'}

          +
          +
          +
          + +
          +
          +read_configuration() OrderedDictType[str, Dict[str, Any]]
          +

          Dictionary mapping names to value dicts with keys: value, timestamp

          +

          To control which fields are included, change the Component kinds on the +device, or modify the configuration_attrs list.

          +
          + +
          +
          +screen()
          +

          Open a screen for controlling the device.

          +

          Default behavior is the typhos screen, but this method can +be overridden for more specialized screens.

          +
          + +
          +
          +status() str
          +

          Returns a str with the current pv values for the device.

          +
          + +
          +
          +stop(*, success=False)
          +

          Stop the Device and all (instantiated) subdevices

          +
          + +
          +
          +summary()
          +
          + +
          +
          +trigger() StatusBase
          +

          Trigger the device and return status object.

          +

          This method is responsible for implementing ‘trigger’ or +‘acquire’ functionality of this device.

          +

          If there is an appreciable time between triggering the device +and it being able to be read (via the +read() method) then this method is +also responsible for arranging that the +StatusBase object returned by this method +is notified when the device is ready to be read.

          +

          If there is no delay between triggering and being readable, +then this method must return a StatusBase +object which is already completed.

          +
          +
          Returns:
          +

          status (StatusBase) – StatusBase object which will be marked +as complete when the device is ready to be read.

          +
          +
          +
          + +

          Attributes

          +
          +
          +configuration_attrs
          +
          + +
          +
          +connected
          +
          + +
          +
          +hints
          +
          + +
          +
          +kind
          +
          + +
          +
          +subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})
          +
          + +
          + + + + +

          +

          + +

          +

  • + +
    + + + + \ No newline at end of file diff --git a/master/generated/pcdsdevices.gon.Kappa.html b/master/generated/pcdsdevices.gon.Kappa.html index 89029eb5447..10773cb4513 100644 --- a/master/generated/pcdsdevices.gon.Kappa.html +++ b/master/generated/pcdsdevices.gon.Kappa.html @@ -1,30 +1,28 @@ + + - pcdsdevices.gon.Kappa — PCDS Devices 8.5.1.dev30+gd6e98430 documentation + pcdsdevices.gon.Kappa — PCDS Devices 8.6.1.dev136+gc5060c80 documentation - + - - - - - - - - + + + + + + - + @@ -38,9 +36,6 @@ PCDS Devices -
    - 8.5.1.dev30+gd6e98430 -
    @@ -78,6 +73,7 @@
  • pcdsdevices.gon.BaseGon
  • pcdsdevices.gon.GonWithDetArm
  • pcdsdevices.gon.Goniometer
  • +
  • pcdsdevices.gon.HxrDiffractometer
  • pcdsdevices.gon.Kappa @@ -94,6 +90,7 @@
  • pcdsdevices.ipm
  • pcdsdevices.jet
  • pcdsdevices.keithley
  • +
  • pcdsdevices.lakeshore
  • pcdsdevices.lamp_motion
  • pcdsdevices.lasers.btps
  • pcdsdevices.lasers.counters
  • @@ -215,18 +212,18 @@

    pcdsdevices.gon.Kappa
    Parameters:
      -
    • name (str) – A name to refer to the Kappa stage device.

    • -
    • prefix_x (str) – The EPICS base PV of the Kappa stage’s x motor.

    • -
    • prefix_y (str) – The EPICS base PV of the Kappa stage’s y motor.

    • -
    • prefix_z (str) – The EPICS base PV of the Kappa stage’s z motor.

    • -
    • prefix_eta (str) – The EPICS base PV of the Kappa stage’s eta motor.

    • -
    • prefix_kappa (str) – The EPICS base PV of the Kappa stage’s kappa motor.

    • -
    • prefix_phi (str) – The EPICS base PV of the Kappa stage’s phi motor.

    • -
    • eta_max_step (int, optional) – Maximum eta motor step, the largest move eta motor can make without +

    • name (str) – A name to refer to the Kappa stage device.

    • +
    • prefix_x (str) – The EPICS base PV of the Kappa stage’s x motor.

    • +
    • prefix_y (str) – The EPICS base PV of the Kappa stage’s y motor.

    • +
    • prefix_z (str) – The EPICS base PV of the Kappa stage’s z motor.

    • +
    • prefix_eta (str) – The EPICS base PV of the Kappa stage’s eta motor.

    • +
    • prefix_kappa (str) – The EPICS base PV of the Kappa stage’s kappa motor.

    • +
    • prefix_phi (str) – The EPICS base PV of the Kappa stage’s phi motor.

    • +
    • eta_max_step (int, optional) – Maximum eta motor step, the largest move eta motor can make without user’s confirmation. Defaults to 2.

    • -
    • kappa_max_step (int, optional) – Maximum kappa motor step, the largest move kappa motor can make +

    • kappa_max_step (int, optional) – Maximum kappa motor step, the largest move kappa motor can make without user’s confirmation. Defaults to 2.

    • -
    • phi_max_step (int, optional) – Maximum phi motor step, the largest move phi motor can make without +

    • phi_max_step (int, optional) – Maximum phi motor step, the largest move phi motor can make without user’s confirmation. Defaults to 2.

    • kappa_ang (number, optional) – The angle of the kappa motor relative to the eta motor, in degrees. Defaults to 50.

    • @@ -327,7 +324,7 @@

      pcdsdevices.gon.Kappa

    Returns:
    -

    move_on (bool) – True if motor step is smaller than the respective max step and/or +

    move_on (bool) – True if motor step is smaller than the respective max step and/or the user has confirmed yes.

    @@ -341,14 +338,14 @@

    pcdsdevices.gon.Kappa
    -configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]
    +configure(d: Dict[str, Any]) Tuple[Dict[str, Any], Dict[str, Any]]

    Configure the device for something during a run

    This default implementation allows the user to change any of the configuration_attrs. Subclasses might override this to perform additional input validation, cleanup, etc.

    Parameters:
    -

    d (dict) – The configuration dictionary. To specify the order that +

    d (dict) – The configuration dictionary. To specify the order that the changes should be made, use an OrderedDict.

    Returns:
    @@ -363,7 +360,7 @@

    pcdsdevices.gon.Kappa
    -describe() OrderedDictType[str, Dict[str, Any]]
    +describe() OrderedDictType[str, Dict[str, Any]]

    Provide schema and meta-data for read().

    This keys in the OrderedDict this method returns must match the keys in the OrderedDict return by read().

    @@ -471,8 +468,8 @@

    pcdsdevices.gon.KappaParameters:

    @@ -486,7 +483,7 @@

    pcdsdevices.gon.Kappa
    -read() OrderedDictType[str, Dict[str, Any]]
    +read() OrderedDictType[str, Dict[str, Any]]

    Read data from the device.

    This method is expected to be as instantaneous as possible, with any substantial acquisition time taken care of in @@ -509,7 +506,7 @@

    pcdsdevices.gon.Kappa
    -read_configuration() OrderedDictType[str, Dict[str, Any]]
    +read_configuration() OrderedDictType[str, Dict[str, Any]]

    Dictionary mapping names to value dicts with keys: value, timestamp

    To control which fields are included, change the Component kinds on the device, or modify the configuration_attrs list.

    @@ -552,13 +549,13 @@

    pcdsdevices.gon.Kappa
    -stage_group_instances() Iterator[OphydObject]
    +stage_group_instances() Iterator[OphydObject]

    Yields an iterator of subdevices that should be staged.

    -status() str
    +status() str

    Returns a str with the current pv values for the device.

    @@ -587,7 +584,7 @@

    pcdsdevices.gon.Kappa
    -trigger() StatusBase
    +trigger() StatusBase

    Trigger the device and return status object.

    This method is responsible for implementing ‘trigger’ or ‘acquire’ functionality of this device.

    @@ -595,14 +592,14 @@

    pcdsdevices.gon.Kapparead() method) then this method is also responsible for arranging that the -StatusBase object returned by this method +StatusBase object returned by this method is notified when the device is ready to be read.

    If there is no delay between triggering and being readable, -then this method must return a StatusBase +then this method must return a StatusBase object which is already completed.

    Returns:
    -

    status (StatusBase) – StatusBase object which will be marked +

    status (StatusBase) – StatusBase object which will be marked as complete when the device is ready to be read.

    @@ -696,7 +693,7 @@

    pcdsdevices.gon.Kappa
    -needs_parent: list[type[OphydObject]] = [<class 'ophyd.signal.AttributeSignal'>, <class 'ophyd.signal.DerivedSignal'>, <class 'ophyd.areadetector.plugins.PluginBase'>, <class 'ophyd.pseudopos.PseudoSingle'>, <class 'pcdsdevices.signal.PVStateSignal'>, <class 'pcdsdevices.signal.AggregateSignal'>]
    +needs_parent: list[type[OphydObject]] = [<class 'ophyd.signal.AttributeSignal'>, <class 'ophyd.signal.DerivedSignal'>, <class 'ophyd.areadetector.plugins.PluginBase'>, <class 'ophyd.pseudopos.PseudoSingle'>, <class 'pcdsdevices.signal.PVStateSignal'>, <class 'pcdsdevices.signal.AggregateSignal'>]
    @@ -748,12 +745,12 @@

    pcdsdevices.gon.Kappa
    -stage_group: list[Component] = [FormattedComponent(IMS, '{self._prefix_eta}', kind='normal'), FormattedComponent(IMS, '{self._prefix_kappa}', kind='normal'), FormattedComponent(IMS, '{self._prefix_phi}', kind='normal')]
    +stage_group: list[Component] = [FormattedComponent(IMS, '{self._prefix_eta}', kind='normal'), FormattedComponent(IMS, '{self._prefix_kappa}', kind='normal'), FormattedComponent(IMS, '{self._prefix_phi}', kind='normal')]

    -subscriptions: ClassVar[FrozenSet[str]] = frozenset({'_req_done', 'acq_done', 'done_moving', 'readback', 'start_moving'})
    +subscriptions: ClassVar[FrozenSet[str]] = frozenset({'_req_done', 'acq_done', 'done_moving', 'readback', 'start_moving'})
    @@ -776,7 +773,7 @@

    pcdsdevices.gon.Kappa