SEPIA user manual

// Whenever one has connected to a cartridge, the variable "cartridge" is defined:
print(cartridge);

// We can test its name (which will produce "sepia180", "sepia345" or "sepia660"
print(cartridge.objectName);

// This code shows how to check that the right cartridge is connected
if (cartridge.objectName != "sepia180") {
    throw new Error("not connected to SEPIA band 5");
}

// It is strongly recommended to use predefined indices to address
// polarization, SIS element and LNA stage.
// E.g. when cartridge is sepia180 then the script will know about
print(sepia180.POL0);
print(sepia180.POL1);
print(sepia180.SIS1);
print(sepia180.SIS2);
print(sepia180.STAGE1);
print(sepia180.STAGE2);
print(sepia180.STAGE3);
print(sepia180.AMCA);
print(sepia180.AMCB);
print(sepia180.AMCE);

// For a cartridge, the following methods are available:
var withDeflux = true;
cartridge.initBand(withDeflux);   // initialize band with demagnetization and deflux
cartridge.shutdownBand();         // shut down the band
cartridge.resetSisVoltages();     // reset all mixer biases to 0.0
cartridge.resetCoilCurrents();    // reset all mixer coil currents to 0.0
cartridge.resetLNAs();            // reset all LNA voltages/currents to 0.0

// Default settings for each receiver are stored in configuration
// files in directory ~/.config/APEX/, e.g. in file sepia180.conf for SEPIA band 5.
cartridge.setCoilCurrents();      // set all coil currents to default values (from configuration file)
cartridge.setLNADefaults();       // set all LNAs to default values (from configuration file)
cartridge.setPAGateVoltages();    // set all PA gate voltages to default values (from configuration file)

// The following are high level tuning methods, using information from
// the tuning tables to perform their function. Compare with the low
// level routines below, which allow you to tune to arbitrary values.
cartridge.tuneLO(183.0);          // tune LO to 183 GHz, using harmonic from tuning table
cartridge.tuneMixer(sepia180.POL0);  // tune specific mixer polarization
cartridge.tuneSystem(183.0);      // LO tuning followed by tuning of both Polarizations

// create some local variables to hold results:
var mV, mA, T;

// create a local object representing a mixer element
var mixer = new cartridge.Mixer(sepia180.POL0, sepia180.SIS1);
print(mixer);                 // will result in name "POL0_SIS1"
mixer.bias = 0.0;             // set mixer bias (in mV)
mV = mixer.bias;              // get mixer bias (in mV)
mA = mixer.current;           // get mixer current (in mA)
mixer.coilCurrent = 0.0;      // set mixer coil current (in mA)
mA = mixer.coilCurrent;       // get mixer coil current (in mA)
mixer.setLNAenable(true);     // enable LNAs
mixer.setSisOpenLoop(false);  // set mixer in closed loop
mixer.deflux();               // perform a deflux operation
mixer.scan(-2.0, 2.0, 100);   // perform a mixer scan (from, to, steps) and save the trace to disk ...
mixer.saveTrace();            // ... file name will be "POL0SIS1.<timestamp>"

// the following functions act on both mixer elements for a given polarization
T = mixer.mixerTemperature;   // get the mixer temperature (in K)
mA = mixer.heaterCurrent;     // get the heater current (in mA)
mixer.toggleHeater();         // toggle the heater, i.e. switch off, then on
mixer.setHeaterState(false);  // turn the heater on (true) or off (false)

// create some local variables to hold results:
var V, A;

// create a local object representing a power amplifier (PA)
// (it uses just one argument (polarization) in its constructor)
var pa = new cartridge.Amplifier(sepia180.POL0);
print(pa);                    // will result in name "PA_POL0"
pa.gateVoltage = 0.0;         // set the PA gate voltage (in V)
V = pa.gateVoltage;           // get the PA gate voltage (in V)
pa.drainVoltage = 0.0;        // set the PA drain voltage (in V)
V = pa.drainVoltage;          // get the PA drain voltage (in V)
A = pa.drainCurrent;          // get the PA drain current (in A)

// create some local variables to hold results:
var V, A;

// create a local object representing a low noise amplifier (LNA)
// (it uses just three arguments (pol, sis and stage) in its constructor)
var lna = new cartridge.Amplifier(sepia180.POL0, sepia180.SIS1, sepia180.STAGE1);
print(lna);                   // will result in name "LNA_POL0_SIS1_STAGE1"
lna.drainVoltage = 0.0;       // set drain voltage (in V)
V = lna.drainVoltage;         // get drain voltage (in V)
lna.drainCurrent = 0.0;       // set drain current (in A)
A = lna.drainCurrent;         // get drain current (in A)
V = lna.gateVoltage;          // get gate voltage (in V)

// create some local variables to hold results:
var ghz, dbm, yig, flag;

// create a local object representing a local oscillator
var LO = new cartridge.Oscillator();
print(LO);                    // will result in name "LO"
LO.yig = 1000;                // set the YIG oscillator (0..4095)
yig = LO.yig;                 // get the last YIG setting
LO.synthFreq = 15.0;          // set the synthesizer frequency (in GHz)
ghz = LO.synthFreq;           // get the synthesizer frequency (in GHz)
LO.synthLevel = 12.0;         // set the synthesizer level (in dBm)
dbm = LO.synthLevel;          // get the synthesizer level (in dBm)
LO.tune(180.0, 6);            // tune the LO to 180 GHz, using 6th harmonic
flag = LO.lockLatch;          // get state of unlock detect latch
LO.clearLatch();              // clear the latch

// create some local variables to hold results:
var V, A;

// create a local object representing an active multiplier chain (AMC)
var amc = new cartridge.Multiplier();
print(amc);                                // will result in name "AMC"
V = amc.drainVoltage(sepia660.AMCA);       // get drain voltage of AMCA (in V)
amc.setDrainVoltage(sepia660.AMCA, 0.0);   // set drain voltage of AMCA (in V)
V = amc.gateVoltage(sepia660.AMCA);        // get drain current of AMCA (in V)
A = amc.drainCurrent(sepia660.AMCA);       // set drain current of AMCA (in V)
V = amc.monitor5V();
V = amc.multiDVoltage();

// create some local variables to hold results:
var V, p, T;

// create a local object representing the PLL
var pll = new cartridge.PLL();
print(PLL);                   // will result in name "PLL"
if (pll.locked) ...;          // check if locked
V = pll.corrVoltage;          // PLL correction voltage (in V)
V = pll.lockVoltage;          // PLL lock voltage (in V)
p = pll.refTotalPower;        // PLL reference total power
p = pll.ifTotalPower;         // PLL IF total power
T = pll.assemblyTemperature;  // PLL asssembly temperature (in C)

// By first looking up tuning parameters from the tuning table, and
// then perform the actual tunings using those values , we can mimic
// what the high level tuning methods from above would do.
var params = Tuning(183.0);   // look up given LO frequency in the tuning table
// The returned array of parameter values consists of the following:
var ghz      = params[ 0];
var harmonic = params[ 1];
var maxPower = params[ 2];
var bias1    = params[ 3];
var bias2    = params[ 4];
var imix1    = params[ 5];
var imix2    = params[ 6];
var paa      = params[ 7];
var bias3    = params[ 8];
var bias4    = params[ 9];
var imix3    = params[10];
var imix4    = params[11];
var pab      = params[12];

// low level routine for tuning the LO
LO.tune(ghz, harmonic);

// low level routine for tuning the mixers
mixer = new cartridge.Mixer(sepia180.POL0, sepia180.SIS1);
var Igoal = imix1;
mixer.tune(bias1, bias2, Igoal, maxPower);  // tune the mixer

// same for other polarization
mixer = new cartridge.Mixer(sepia180.POL1, sepia180.SIS1);
var Igoal = imix3;
mixer.tune(bias3, bias4, Igoal, maxPower);  // tune the mixer