Skip to content

Session

Examples use --loopback so they run without a board. Drop the flag (or pass --usb) against hardware.

bash
s32 --loopback hello
s32 --loopback ping
s32 --loopback schema
s32 --loopback job
s32 --loopback reset

hello

Protocol version, firmware version, capability bits, serial number, and limits (knob/macro/rack counts, screen geometry, max payload).

A mismatching protocol version fails the session instead of misparsing frames. This CLI speaks protocol 1.

ping

Empty round-trip. Confirms the editor interface is alive.

reset

Abort in-flight read/write streams, clear the event queue, and resubscribe. The CLI re-subscribes to all events afterwards.

job [HANDLE]

Storage job status. Omit HANDLE for the idle/last job. Many jobs complete immediately; Busy means poll again.

abort

Drop an in-flight push stream. Safe if nothing is writing.

schema

Device types, parameter counts, and enum tables (macro modes, menus, LFO parameters). Machine-readable dump:

bash
s32 --loopback schema --emit-schema-json /tmp/schema.json
s32 --usb schema --emit-schema-json schema.json

Over loopback the schema is a fixture. Capture the real tables from --usb.

version

bash
s32 --version          # CLI + protocol, no device
s32 --loopback version # same; firmware if a session is open