SERF R8 Reference

Data Stream Source List

0. vector – [f32] Vector magnetic field (pT), 3 columns: x, y, z
1. status – [i8] Status (1 column)
2. cal – [f32] Signal calibration (arb), 3 columns: x, y, z

Command List

Vector magnetometer

• vector.data.active – [u8] Set to 1 to include magnetic field in data stream.
• vector.data.decimation – [u32] Decimation of magnetic field relative to previous data source.
• vector.data.autocutoff – [u8] Set to 1 to automaticaly configure magnetic field IIR lowpass filter according to decimation.
• vector.data.cutoff – [f32] Manually control magnetic field IIR lowpass filter cutoff.
• vector.data.id – [u16] Returns stream ID of magnetic field.

Automated calibration

• auto.zero – Zero magnetic field. If successfully zeroed, will also calibrate.
• auto.zero.rmsthreshold – [f32] Zero magnetic field until the RMS field value in nT is below this level.
• auto.calibrate – Calibrate magnetic field.
• auto.calibrate.threshold – [f32] minimum calibration value considered good.

Signal filter

• filter.highpass.enable – [u8] enable highpass filter.
• filter.highpass.cutoff – [f32] corner frequency (Hz) for highpass filter.

System settings

• mode.axis.x – [u8:0|1] Enable measurement on X axis.
• mode.axis.y – [u8:0|1] Enable measurement on Y axis.
• mode.sleep – [u8:0|1] Enable sleep mode, turns off laser and heaters.

Current supply, X channel

• coil.x.current – [f32] X current output (mA).
• coil.x.current.min – [f32] Y current output, minimum (mA).
• coil.x.current.max – [f32] X current output, maximum (mA).
• coil.x.calibration – [f32] X field calibration (in, for example, nT/mA). Purely a convenience to convert the current to a different scale.
• coil.x.field – [f32] X magnetic field. Scales current according to calibration.
• coil.x.field.min – [f32] X magnetic field, minimum. Scales current minimum according to calibration.
• coil.x.field.max – [f32] X magnetic field, maximum. Scales current maximum according to calibration.
• coil.x.test.enable – [u8] X test test modulation enable.
• coil.x.test.frequency – [f32] X test test modulation frequency (Hz).
• coil.x.test.amplitude – [f32] X test test modulation amplitude (RMS×sqrt(2)).

Current supply, Y channel

• coil.y.current – [f32] Y current output (mA).
• coil.y.current.min – [f32] Y current output, minimum (mA).
• coil.y.current.max – [f32] Y current output, maximum (mA).
• coil.y.calibration – [f32] Y field calibration (in, for example, nT/mA). Purely a convenience to convert the current to a different scale.
• coil.y.field – [f32] Y magnetic field. Scales current according to calibration.
• coil.y.field.min – [f32] Y magnetic field, minimum. Scales current minimum according to calibration.
• coil.y.field.max – [f32] Y magnetic field, maximum. Scales current maximum according to calibration.
• coil.y.test.enable – [u8] Y test test modulation enable.
• coil.y.test.frequency – [f32] Y test test modulation frequency (Hz).
• coil.y.test.amplitude – [f32] Y test test modulation amplitude (RMS×sqrt(2)).

Current supply, Z channel

• coil.z.current – [f32] Z current output (mA).
• coil.z.current.min – [f32] Z current output, minimum (mA).
• coil.z.current.max – [f32] Z current output, maximum (mA).
• coil.z.calibration – [f32] Z field calibration (in, for example, nT/mA). Purely a convenience to convert the current to a different scale.
• coil.z.field – [f32] Z magnetic field. Scales current according to calibration.
• coil.z.field.min – [f32] Z magnetic field, minimum. Scales current minimum according to calibration.
• coil.z.field.max – [f32] Z magnetic field, maximum. Scales current maximum according to calibration.
• coil.z.test.enable – [u8] Z test test modulation enable.
• coil.z.test.frequency – [f32] Z test test modulation frequency (Hz).
• coil.z.test.amplitude – [f32] Z test test modulation amplitude (RMS×sqrt(2)).

Magnetometer calibration

• cal.x – [f32] X field calibration in µV/nT.
• cal.y – [f32] Y field calibration in µV/nT.
• cal.z – [f32] Z field calibration in µV/nT.
• cal.x.enable – [u8] Enable X field calibration measurement using test modulation.
• cal.y.enable – [u8] Enable Y field calibration measurement using test modulation.
• cal.z.enable – [u8] Enable Z field calibration measurement using test modulation.
• cal.data.active – [u8] Set to 1 to include magnetometer calibration in data stream.
• cal.data.decimation – [u32] Decimation of magnetometer calibration relative to previous data source.
• cal.data.autocutoff – [u8] Set to 1 to automaticaly configure magnetometer calibration IIR lowpass filter according to decimation.
• cal.data.cutoff – [f32] Manually control magnetometer calibration IIR lowpass filter cutoff.
• cal.data.id – [u16] Returns stream ID of magnetometer calibration.

Status byte

• status.data.active – [u8] Set to 1 to include status in data stream.
• status.data.decimation – [u32] Decimation of status relative to previous data source.
• status.data.id – [u16] Returns stream ID of status.
• status.laser – [f32] Fraction original laser power.

Device configuration memory

• dev.conf.autosave – [i16] Automatically save configuration specified number of seconds after changes; -1 disables. Maximum 10,000 writes.
• dev.conf.save – Save configuration. Configuration is used on next power cycle.
• dev.conf.load – Load configuration from last saved version.
• dev.conf.verbose – [u8] Send a log message every time settings are saved.

Device information

• dev.name – Short name of device.
• dev.model – Short name of device.
• dev.desc – Description of device.
• dev.serial – Serial number assigned to device.
• dev.revision – [u16] Hardware revision number.
• dev.version_major – [u16] Software version, major rev number in major.minor format.
• dev.version_minor – [u16] Software version, minor rev number in major.minor format.
• dev.lock – Attempts to secure advisory lock. No effect in device; useful for multi-client access control.
• dev.unlock – Unlock the advisory lock. No effective in device; useful for multi-client access control.
• dev.systime – [u64] Time elapsed since boot counted by microcontroller.
• dev.loglevel – [u8] Set max level of log messages sent by device.
• dev.session – [u32] Random number set at power on.
• dev.start – Start or restart operation. Synchronization: provide a tl_timebase_info struct and deliver an external clock.
• dev.stop – Halt operation.
• dev.reboot – Restart device controller.
• dev.synctime – Updates the timebase properties for an external clock. Expects a tl_timebase_info struct.
• dev.firmware.upload – Used to upload firmware into RAM. Must issue dev.stop first. See the tio-firmware-upgrade in tio-tools.
• dev.firmware.upgrade – Used to commit firmware to flash. See the tio-firmware-upgrade in tio-tools.
• dev.firmware.serial – Serial number/identifier of firmware.

Data stream introspection

Devices have multiple data sources, sampled on specific timebases, which can be selected for streaming.

• data.rate – Specify primary source data rate (Hz)
• data.timebase.list – Number of timebases availbale on device; internal clock, external clock, etc.
• data.timebase.info – Request with timebase ID, reply with timebase metadata.
• data.timebase.send – Request with timebase ID, sends timebase metadata.
• data.source.list – Number of data sources available on device.
• data.source.info – Request with data source ID, reply with source metadata.
• data.source.send – Request with data source ID, sends soure metadata as source update.
• data.stream.list – Number of data streams. Most systems have only one data stream.
• data.stream.info – Request with data stream ID, reply with stream metadata.
• data.stream.send – Request with data stream ID, sends data stream metadata as stream update.
• data.stream.columns – Number of active columns in stream.
• data.list – List active streams. Request with ID to enumerate stream names.
• data.send_all – Iteratively sends metadata on all timebases, sources, and streams.
• data.atomic – Preface a set of atomic data stream changes.
• data.apply – Apply data stream changes atomically.

Command introspection

• rpc.list – No argument: List number of RPCs. Pass [u16] ID number: returns name of RPC.
• rpc.info – [u16] Return RPC metadata, 16 bits.
• rpc.listinfo – Same as rpc.list, but prepends rpc.info metadata.
• rpc.id – Return 16 bit ID number for named RPC.
• rpc.name – [u16] Return RPC name string for 16 bit ID number.

Communications port configuration

• dev.port.mode.text – Change mode of this port to text. A valid text rpc also switches the interface to text mode.
• dev.port.mode.binary – Change mode of this port to binary. A valid binary rpc also switches the interface to binary mode.
• dev.port.mode.boot_text – Change power-on mode of this port to text.
• dev.port.mode.boot_binary – Change power-on mode of this port to binary.
• dev.port.rate – [u32] Change bitrate of this port.
• dev.port.rate.near – [u32] Report actual port bitrate.
• dev.port.rate.min – [u32] Specify minimum port bitrate.
• dev.port.rate.max – [u32] Specify maximum port bitrate. It can be necessary to reduce the maximum bitrate on longer cables.
• dev.port.maxrate – [u32] Read the maximum supported bitrate for this port.
• dev.port.count – [u32] Number of control ports.