SYNC8 R3 Reference
Data Stream Source List
status
– [u8] Status bits (1 column)
Command List
Synchronization control
sync.start
– Start synchronous sampling.sync.stop
– Stop synchronous sampling.sync.passthrough
– Pass through data without processing or reordering.sync.downsample
– [u32] Reduce output data rate by integer decimation of data stream.sync.externalreference
– [u8] Enable 10 MHz reference frequency input.
Ethernet networking
Ethernet network settings may be modified and then applied using the net.apply
command. Setting a hostname permits mDNS access at hostname.local
.
net.hostname
– [string] Name for mDNS lookup; access atudp://hostname.local
.net.mode
– [string] Choosedhcp
,static
,auto
.net.address
– [string] Device IP address, like10.0.1.100
.net.gateway
– [string] Gateway IP address, like10.0.1.1
.net.netmask
– [string] Netmask, like255.255.255.0
.net.apply
– Commits changes to network settings.
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.
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 atl_timebase_info
struct and deliver an external clock.dev.reboot
– Restart device controller.dev.synctime
– Updates the timebase properties for an external clock. Expects atl_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.