Console Commands
Aqua-Scope devices provide a text console for diagnostics, setup and maintenance. Commands can be entered through several interfaces interchangeably — responses appear on the same channel.
Access Methods
| Interface | Requirement | Note |
|---|---|---|
| USB-C / Serial | Serial connection at 115200 bps, 8N1 | Full access including local-only commands |
| Bluetooth (BLE) | App in setup mode or BLE active | Setup and general commands |
| Local web server | WiFi device with web server enabled | Input via /shell, output via /console (see Local Web Server) |
A few commands are available only on the local serial console and are flagged accordingly below.
General Commands
| Command | Arguments | Description |
|---|---|---|
status | — | Returns the system status flag register as 16-bit hex |
alarm | — | Returns active alarms and blocked alarms as hex values |
heap | — | Currently free heap memory in bytes |
echo | — | Test command, returns echo ok |
consolelog | — | Dumps the buffered console log line by line |
beep | <code> | Activates the buzzer with the given pattern |
valve | <value> | Sets the valve state (device-dependent, e.g. 0/100 = closed/open) |
mon | <interval> | Sets the monitoring interval in seconds |
resetc | — | Reboots into portal mode |
Configuration
| Command | Arguments | Description |
|---|---|---|
configlist | — | Lists all configuration registers with their current value |
configget | <no> | Returns the value of configuration register <no> (hex and decimal) |
configset | <no> <value> | Sets configuration register <no> to <value> |
configreset | — | Resets all configuration registers to factory defaults (local console only) |
factory | 2010 | Performs a factory reset — 2010 is the safety confirmation (local console only) |
hwversion | <value> | Permanently writes the hardware version into the file system |
Factory Reset
factory 2010 and configreset permanently erase your settings. Use these commands only when re-commissioning the device.
WiFi and Cloud Setup
These short commands are mainly used in portal mode and over Bluetooth during device commissioning. Values are passed separated by a space (e.g. sid MyWiFi).
| Command | Argument | Meaning |
|---|---|---|
sid | <ssid> | WiFi SSID |
wpa | <password> | WiFi password (WPA2) |
mal | <email> | Registration email |
wce | <url> | Server URL for JSON webhook |
wto | <token> | Security token |
mse | <server> | MQTT broker hostname |
mpo | <port> | MQTT broker port |
mus | <user> | MQTT user name |
mpa | <password> | MQTT password |
sto | — | Stores MQTT/web configuration and reconnects |
getdata | — | Returns the current WiFi and server configuration (over BLE) |
In addition, the legacy short forms ws <ssid>, ww <wpa> and em <email> are accepted for backward compatibility.
Communication and Interfaces
| Command | Arguments | Description |
|---|---|---|
comms | — | Shows MQTT and JSON configuration (local console only) |
modbus | 1 | Switches the serial interface to Modbus RTU at 9600 bps and reboots |
otw | — | Starts a firmware update via XMODEM over UART |
AQM (Ultrasonic Clamp)
These commands are available on AQM devices and control the internal MSP430 co-processor:
| Command | Arguments | Description |
|---|---|---|
mspu | <command> | Sends a command directly to the MSP430 (pass-through) |
mspi | <command> | Processes an MSP command internally |
mspuid | — | Reads the unique device ID of the MSP430 |
mspr | — | Performs a hardware reset of the MSP430 |
mspe | <bsl-command> | Puts the MSP430 into BSL update mode |
mspota | — | Starts the OTA programming of the MSP430 |
mspbsl | — | Starts a BSL firmware update of the MSP430 over UART |
sleep | — | Puts the device into sleep mode |
LoRaWAN
| Command | Arguments | Description |
|---|---|---|
buffers | — | Dumps the contents of the LoRa transmit buffer |
sensors | — | Lists the internally captured sensor values |
ULP / MC8 (Low-Power Devices)
These commands are available on devices with a ULP co-processor (e.g. AQS, AQX, MCL).
| Command | Arguments | Description |
|---|---|---|
appmenu | <option> | Selects an application menu option |
ulp_restart | — | Restarts the ULP co-processor |
ulpstatus | — | Returns the ULP status as a hex value |
ulpmode | <mode> | Sets the AQS algorithm mode |
i2c_init | — | Initialises the I²C bus |
i2c_start | — | Reads the pressure sensor once |
i2c_fix | — | Reactivates the I²C sensor after a hang |
ubilink | <port> <p2> <p3> <p4> <p5> | Sends a UBI-TX frame with the given bytes |
Examples
# Check status and alarms
status
alarm
# Read register 13, then set it to 60
configget 13
configset 13 60
# Start firmware update
otw
# Restore factory defaults (local console only, with confirmation value)
factory 2010
Notes
- Commands are terminated with
\n(LF) or\r\n(CRLF). - Numeric arguments can be entered in decimal or hexadecimal (
0x…). - The console accepts at most 64 characters per input line.
- Commands marked "local console only" are intentionally not executed via BLE or the web server.