microSAM R8 Reference
Source List
field– [f64] Magnetic field (nT) Bsignal– [u8] Signal ()status– [u8] Status ()
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 ID of total field.
Lock signal strength
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.id– [u16] Returns ID of lock signal strength.
Status byte
status.data.active– [u8] Set to 1 to include lock signal strength in data stream.status.data.decimation– [u32] Decimation of lock signal strength relative to previous data source.status.data.id– [u16] Returns ID of lock signal strength.
Device configuration memory
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.dev.start– Start or restart sampling. Expects external clock if passed a tl_timebase_info struct.
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.