From e1b0fcc24ece81a53a0f44433e33ee5e75bfe6b0 Mon Sep 17 00:00:00 2001 From: Robert Jordens Date: Thu, 31 May 2018 16:21:09 +0000 Subject: [PATCH] suservo: add documentation on settings and setup close #1015 --- artiq/coredevice/suservo.py | 22 +++++++++++++++++++++- 1 file changed, 21 insertions(+), 1 deletion(-) diff --git a/artiq/coredevice/suservo.py b/artiq/coredevice/suservo.py index 20ca966cc..93ca1fcf7 100644 --- a/artiq/coredevice/suservo.py +++ b/artiq/coredevice/suservo.py @@ -16,7 +16,27 @@ COEFF_SHIFT = 11 class SUServo: - """Sampler-Urukul Servo configuration device. + """Sampler-Urukul Servo parent and configuration device. + + Sampler-Urukul Servo is a integrated device controlling one + 8-channel ADC (Sampler) and two 4-channel DDS (Urukuls) with a DSP engine + connecting the ADC data and the DDS output amplitudes to enable + feedback. SUServo can for example be used to implement intensity + stabilization of laser beams with an AOM and a photodetector. + + Additionally SUServo supports multiple preconfigured profiles per channel + and features like automatic integrator hold. + + Notes: + + * See the SUServo variant of the Kasli target for an example of how to + connect the gateware and the devices. Sampler and each Urukul need + two EEM connections. + * Ensure that both Urukuls are AD9910 variants and have the on-board + dip switches set to 1100 (first two on, last two off). + * Refer to the Sampler and Urukul documentation and the SUServo + example device database for runtime configuration of the devices + (PLLs, gains, clock routing etc.) :param channel: RTIO channel number :param pgia_device: Name of the Sampler PGIA gain setting SPI bus