UDP Command Reference
All commands are plain text sent to port 55152. Replies arrive on port 55153, at the IP address that sent the command. See the overview for the message format.
Reply notation: OK … and ERR … lines are status replies (a #id prefix is added when the command carried one). data means the command answers with its own data line(s) and no OK line.
State and information
| Command | Reply |
|---|---|
INFO | OK INFO fw=… proto=… state=… … |
GET_CONFIG | OK GET_CONFIG fs=… lower=… upper=… … |
GET_HEADSTAGE | OK GET_HEADSTAGE state=… chip=… channels=… |
GET_CHANNELS | data CHANNELS <n> |
SET_CHANNELS <n> | OK SET_CHANNELS limit=<n> |
STATUS | data STATUS <RUN|STOP> … |
GET_TIME | data TIME <ms> |
VERSION | data version string |
HELP | data command list |
IDENTIFY | data HMCLS ip=<ip> |
GET_IP | data IP <ip> src=<source> |
Acquisition
| Command | Reply |
|---|---|
SETUP [DEFAULTS] | OK SETUP fs=… lower=… … config_id=… |
START / RUN | OK START |
STOP / PAUSE | OK STOP |
SPEED <value> | OK SPEED … fs=<Hz> |
LOWER <Hz> | OK LOWER request=… applied=… |
UPPER <Hz> | OK UPPER request=… applied=… |
DSP <Hz>|ON|OFF | OK DSP … |
SET_CHIP_MODE <HW|SIM> | OK SET_CHIP_MODE mode=… |
GET_CHIP_MODE | data CHIP_MODE <mode> |
H ON / H OFF | OK H ON / OK H OFF |
GET_H | data H enabled=… one_shot=… |
Signal analysis
| Command | Reply |
|---|---|
RMS ON / RMS OFF | OK RMS ON / OK RMS OFF |
GET_RMS <ch>|ALL | data RMS … |
SPIKE ON <k> … | OK SPIKE ON k=… pol=… … |
SPIKE OFF | OK SPIKE OFF |
SPIKE MASK … | OK SPIKE MASK mask=0x… |
GET_SPIKE <ch>|ALL | data SPIKE … / SPIKE_ALL … |
Impedance
| Command | Reply |
|---|---|
ZCHECK <ch> | data ZCHECK <ch> <value> kOhm |
ZCHECK_SCAN | data ZCHECK_SCAN_BEGIN … ZCHECK_SCAN_END |
DEEP_ZCHECK <N> <M> [ch] | data DEEP_ZCHECK_BEGIN … DEEP_ZCHECK_END |
Destination, network and flags
| Command | Reply |
|---|---|
DEST <ip>|NONE | OK DEST dest=… |
GET_DEST | OK GET_DEST dest=… |
NET <ip> <cmd> | OK NET ip=<ip> |
FLAG SET <n> | OK FLAG SET |
FLAG PEEK <n> | data FLAG <n> <0|1> |
FLAG TAKE <n> | data FLAG <n> <0|1> |
I2C and indicators
| Command | Reply |
|---|---|
SCAN_I2C | data I2C 0x… … |
I2C WRITE <addr> <reg> <val…> | OK I2C WRITE bytes=<n> |
I2C READ <addr> <reg> <len> | data I2C 0x… … |
G_ON / G_OFF | OK G_ON / OK G_OFF |
R_ON / R_OFF | OK R_ON / OK R_OFF |
Y_ON / Y_OFF | OK Y_ON / OK Y_OFF |
MONITOR_ON / MONITOR_OFF | OK MONITOR_ON / OK MONITOR_OFF |
Events
Lines starting with EVT are sent to the board's owner when something changes: see Events.