SUServoChannel#

Class Arguments

Argument	Type	Default Value
suservo	SUServo
suservo_channel
default_attenuation		19.0
default_profile		0
servo_divider	TFloat	10.0
default_frequency	TFloat	100000000.0
default_amplitude	TFloat	0.0
default_phase	TFloat	0.0
freq_limit	tuple	(0.0, inf)
amp_limit	tuple	(0.0, 1.0)
blind	TBool	False
default_ramp_steps	TInt32	30

Bold arguments are mandatory. For more documentation on the listed arguments refer to the class definition below. If parameters appear in this list but not in the class definition below, please recursively check the linked base classes for the definition of the parameter.

Inheritance Diagram

Example Component Dictionary

   {
    "suservo_example": {
        "classname": "atomiq.components.sinara.suservo.SUServoChannel",
        "arguments": {
            "suservo": "<mandatory parameter (SUServo)>",
            "suservo_channel": "<mandatory parameter ()>",
            "default_attenuation": 19.0,
            "default_profile": 0,
            "servo_divider": 10.0,
            "default_frequency": 100000000.0,
            "default_amplitude": 0.0,
            "default_phase": 0.0,
            "freq_limit": [
                0.0,
                1e999
            ],
            "amp_limit": [
                0.0,
                1.0
            ],
            "blind": false,
            "default_ramp_steps": 30
        }
    }
}

Class Description

class atomiq.components.sinara.suservo.SUServoChannel(suservo, suservo_channel, default_attenuation=19.0, default_profile=0, servo_divider=10.0, *args, **kwargs)

Bases: RFSource, Switchable

A Urukul DDS channel in SUServo configuration as RF Source

If not in servo mode, this can be used just like a normal :class:UrukulChannel

Parameters:

suservo (SUServo) -- The atomiq SUServo component this channel belongs to
suservo_channel -- The artiq SUServo channel from your device_db, e.g. @suservo0_ch2.
default_profile -- Which of the 32 profiles of the SUServo should be used? (default 0)
servo_divider (TFloat) -- Todo: Why do we need this? (default 10.0)

A Parametrizable is an entity that can be controlled by one or more continuous parameter(s)

set(frequency=- 1.0, amplitude=- 1.0, phase=0.0, profile=- 1)

Set the frequency and amplitude of the DDS channel

Frequency/amplitude are set to the last known value if -1 is given.

Parameters:

frequency (TFloat) -- frequency [Hz]. (default -1.0)
amplitude (TFloat) -- If servomode is off, this is the DDS amplitude (0..1). If servomode is on, this is the target voltage on the photodiode. (default -1)
phase (TFloat) -- Phase in rad to be set (default 0.0)
profile (TInt32) --

set_att(attenuation)

Set the hardware attenuation for this urukul channel via cpld.

Parameters:: attenuation (TFloat) -- channel attenuation (0. to 31.0 in 0.5 increments) [dB]

set_amplitude(amplitude)

Set the amplitude of the DDS output

Parameters:: amplitude -- If servomode is off, this is the DDS amplitude (0..1). If servomode is on, this is the target voltage on the photodiode.

on(): Turn on the RF output via the fast switch

off(): Turn off the RF output via the fast switch

set_servomode(enabled)

Switch servo mode of the SUServo on or off

The servo loop in the SUServo gateware (running on the Kasli) can only be switched on globally for all channels. However, we can decide for each channel if the output of the servo loop should be given to the DDS. This function switches the the updating for this channel.

Parameters:: enabled (TBool) -- Whether the servomode should be enabled

arb(duration, samples_amp=[], samples_freq=[], samples_phase=[], repetitions=1, prepare_only=False, run_prepared=False, transform_amp=<function identity_float>, transform_freq=<function identity_float>, transform_phase=<function identity_float>)

Play Arbitrary Samples from a List

This method allows to set the ouput amplitude, frequency an phase according to the values specified in respective lists. The whole sequence is played in the specified duration. The pattern store in the sample list can also be repeated.

We supports a scheme to prepare the arb function before it is acutally used. If that is needed, run this function with prepapre_only = True when the arb should be prepared and with run_only = True when the prepared arb should be played. In both calls the other parameters have to be passed.

Parameters:

samples_amp (TList(TFloat)) -- List of amplitude samples. If this list is empty (default), the amplitude is not modified.
samples_freq (TList(TFloat)) -- List of frequency samples. If this list is empty (default), the frequecy is not modified.
samples_phase (TList(TFloat)) -- List of phase samples. If this list is empty (default), the phase is not modified.
duration (TFloat) -- The time in which the whole sequence of samples should be played back [s].
repetitions (TInt32) -- Number of times the sequence of all samples should be played. (default 1)
prepare_only (TBool) --
run_prepared (TBool) --

ramp(duration, frequency_start=- 1.0, frequency_end=- 1.0, amplitude_start=- 1.0, amplitude_end=- 1.0, ramp_timestep=- 1.0, ramp_steps=- 1)

Ramp frequency and amplitude over a given duration. Parameters default to -1 to indicate no change. If the start frequency/amplitude is set to -1, the ramp starts from the last frequency/amplitude which was set. This method advances the timeline by ´duration´

Parameters:

duration (TFloat) -- ramp duration [s]
frequency_start (TFloat) -- initial frequency [Hz]
frequency_end (TFloat) -- end frequency [Hz]
amplitude_start (TFloat) -- initial amplitude [0..1]
amplitude_end (TFloat) -- end amplitude [0..1]
ramp_timesteps -- time between steps in the ramp [s]
ramp_steps (TInt32) -- number of steps the whole ramp should have. This takes precedence over ramp_timesteps
ramp_timestep (TFloat) --