OMG R24 Reference

Data Stream Source List

gradient.data.active – [u8] Set to 1 to include gradient field in data stream.
gradient.data.decimation – [u32] Decimation of gradient field relative to previous data source.
gradient.data.autocutoff – [u8] Set to 1 to automaticaly configure gradient field IIR lowpass filter according to decimation.
gradient.data.cutoff – [f32] Manually control gradient field IIR lowpass filter cutoff.
gradient.data.id – [u16] Returns stream ID of gradient field.
gradient.baseline – [f32] Distance between magnetometers (cm).

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

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

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

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.

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.

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.

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.

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.