mpylab.device.prb_ar_fm7004 module¶
Driver for the Amplifier Research FM7004/FL7018 field probe setup.
- class mpylab.device.prb_ar_fm7004.FIELDPROBE(**kw)
Bases:
FIELDPROBEConcrete field probe driver for the AR FM7004 controller.
- Parameters:
kw (mapping) – Keyword arguments forwarded to the field-probe base class.
- GetBatteryState()
Return a fixed battery-state placeholder.
- Returns:
Status code and placeholder state
1.0.- Return type:
tuple of (int, float)
- GetData()
Return one three-axis electric-field vector.
- Returns:
Status code and x-, y-, and z-axis field strengths in V/m. The quantities include the frequency-dependent probe uncertainty.
- Return type:
tuple of (int, list of scuq.quantities.Quantity)
- GetDataNB(retrigger=False)
Return data via the blocking acquisition path.
- Parameters:
retrigger (bool or str, optional) – Whether to trigger the next acquisition after returning the current value.
- Returns:
Result returned by
GetData().- Return type:
tuple of (int, list of scuq.quantities.Quantity)
- Init(ini=None, channel=None, ignore_bus=None)
Initialize probe communication and enable correction mode.
- Parameters:
ini (path-like or file-like, optional) – INI configuration source.
channel (int, optional) – One-based probe channel number.
- Returns:
Driver initialization status.
- Return type:
int
- SetFreq(freq)
Set probe frequency and return its readback.
- Parameters:
freq (float) – Correction frequency in Hz.
- Returns:
Status code and confirmed frequency in Hz, or
Noneif the readback could not be parsed.- Return type:
tuple of (int, float or None)
- mpylab.device.prb_ar_fm7004.main()
Start the legacy UI test harness for this probe driver.
- mpylab.device.prb_ar_fm7004.test()
Create and initialize a test field-probe instance.
- Returns:
Initialized probe using the embedded example configuration.
- Return type: