CSB R10 Reference
Command List
Current supply, X channel
coil.x.current– [f32] X current output (mA).coil.x.current.max– [f32] X current output (mA).coil.x.current.scale– [f32] X current calibration/scale factor.coil.x.current.offset– [f32] X current output offset adjustment.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.max– [f32] X magnetic field, maximum. Scales current maximum according to calibration.coil.x.modulation.amplitude– [f32] X modulation amplitude (RMS×sqrt(2)) (mA).coil.x.modulation.frequency– [f32] X modulation frequency (Hz).
Current supply, Y channel
coil.y.current– [f32] Y current output (mA).coil.y.current.max– [f32] Y current output (mA).coil.y.current.scale– [f32] Y current calibration/scale factor.coil.y.current.offset– [f32] Y current output offset adjustment.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.max– [f32] Y magnetic field, maximum. Scales current maximum according to calibration.coil.y.modulation.amplitude– [f32] Y modulation amplitude (RMS×sqrt(2)) (mA).coil.y.modulation.frequency– [f32] Y modulation frequency (Hz).
Current supply, Z channel
coil.z.current– [f32] Z current output (mA).coil.z.current.max– [f32] Z current output (mA).coil.z.current.scale– [f32] Z current calibration/scale factor.coil.z.current.offset– [f32] Z current output offset adjustment.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.max– [f32] Z magnetic field, maximum. Scales current maximum according to calibration.coil.z.modulation.amplitude– [f32] Z modulation amplitude (RMS×sqrt(2)) (mA).coil.z.modulation.frequency– [f32] Z modulation frequency (Hz).
Current supply calibration defaults
Standard calibration values for a few standard coils.
coil.defaults.MS1R9– Coil calibration for Twinleaf MS-1 R9coil.defaults.MS2R9– Coil calibration for Twinleaf MS-2 R9
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.
Device information
dev.name– Short name of device.dev.desc– Description of device.dev.serial– Serial number assigned to device.dev.revision– [u16] Hardware revision number.dev.firmware.rev– [40b] Firmware revision, git hash.dev.firmware.tstamp– [u32] Firmware timestamp, unix epoch.dev.firmware.osver– [u16] Firmware OS version.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.uid– [16b] Unique identifier of hardware.dev.mcu.id– Hardware identifier of microcontroller.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.
Data stream introspection
Devices have multiple data sources, sampled on specific timebases, which can be selected for streaming.
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.pstream.list– Number of data sources available on device.data.pstream.info– Request with data source ID, reply with source metadata.data.pstream.send– Request with data source ID, sends soure metadata as source update.data.dstream.list– Number of data streams. Most systems have only one data stream.data.dstream.info– Request with data stream ID, reply with dstream metadata.data.dstream.send– Request with data stream ID, sends data stream metadata as dstream update.data.dstream.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.boot_mode– [u8] 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.