OMG R5 Reference
Source List
field– [f64] Magnetic Field (nT), 1 columns: B
Command List
Total magnetic field
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.
Device configuration memory
dev.conf.autosave– [i16] Automatically save configuration specified number of seconds after changes; -1 disables. Maximum one million writes.dev.conf.save– Save configuration. Configuration is used on next power cycle.dev.conf.load– Load configuration from last saved version.dev.conf.size– Size of configuration.dev.conf.enabled– Enable loading of configuration on boot.dev.conf.reset– Return to factory defaults.
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 sampling. Synchronization: provide atl_timebase_infostruct and deliver an external clock.dev.firmware.upload– Used to upload firmware into RAM. 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.password– Unlock privileged mode by passing correct password.dev.umode– Return to user mode (hides privileged features).dev.mcu.model– MCU model number.dev.mcu.free_mem– Free memory.dev.mcu.startup_mem– Free memory after startup.dev.rdp– [u8] Firmware readout protection.dev.firmware.hash– [40b] Firmware revision, git hash.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.data.exmachina– Reconfigure stream.
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.rpc.unlock– If RPCs are locked out, force unlocking.
Communications port configuration
dev.port.boot_mode– [u8] Startup mode of this port 1=text, 0=binary.dev.port.text– Change mode of this port to text.dev.port.binary– Change mode of this port to binary.dev.port.count– [u32] Number of control ports.