This PR improves docstrings and does some cleanup for ESCRYODET-472, which is the SLAC JIRA issue for adding external triggering to the downsampler. Also adds a convenience function get_timing_fiber_status for confirming a slot 2 carrier receiving timing over fiber and distributing it over the backplane is receiving timing data and has its crossbar configured properly, and reverts to our prior convention of using downsample instead of downsampler in the names of all functions related to downsampling.
Description
Backwards compatible changes in this PR include:
Improved or added missing docstrings for the write_ps_en, get_cryo_card_temp, get_crossbar_output_config, get_downsample_factor, get_downsample_external_bitmask, and set_filter_disable functions.
Adds warning if get_cryo_card_temp returns a negative temperature (which usually only happens if no cryostat card is connected).
Adds get_timing_fiber_status function which if run on a slot2 system distributing timing on the backplane to other SMuRF systems, checks if the slot2 system is receiving timing and properly configured to distribute those signals into the backplane via the crossbar configuration.
Changes names of the set_downsampler_internal_factor and get_downsampler_internal_factor back to set_downsample_factor and get_downsample_factor. Elsewhere any new functions relating to downsampler use downsample in their name instead of downsampler.
Issue
This PR improves docstrings and does some cleanup for ESCRYODET-472, which is the SLAC JIRA issue for adding external triggering to the downsampler. Also adds a convenience function
get_timing_fiber_statusfor confirming a slot 2 carrier receiving timing over fiber and distributing it over the backplane is receiving timing data and has its crossbar configured properly, and reverts to our prior convention of usingdownsampleinstead ofdownsamplerin the names of all functions related to downsampling.Description
Backwards compatible changes in this PR include:
write_ps_en,get_cryo_card_temp,get_crossbar_output_config,get_downsample_factor,get_downsample_external_bitmask, andset_filter_disablefunctions.get_cryo_card_tempreturns a negative temperature (which usually only happens if no cryostat card is connected).get_timing_fiber_statusfunction which if run on a slot2 system distributing timing on the backplane to other SMuRF systems, checks if the slot2 system is receiving timing and properly configured to distribute those signals into the backplane via the crossbar configuration.set_downsampler_internal_factorandget_downsampler_internal_factorback toset_downsample_factorandget_downsample_factor. Elsewhere any new functions relating to downsampler use downsample in their name instead of downsampler.