doc/help/API-Reference.md
The command-by-command reference below is regenerated by hand and drifts behind the C++ registry over time. The protocol shape, the connection details, and the prose sections (overview, security, usage, recommended patterns, troubleshooting) are kept current. The per-command sections under Complete Command Reference are best read as a structured tour, not a contract.
The authoritative live surface is whatever the running server registers at startup (
app/src/API/Handlers/*.cpp). To enumerate it:
- Legacy JSON: send
api.getCommands(no params). It returns{name, description}for every registered command.- MCP: send
tools/listover JSON-RPC 2.0 (see MCP Client) for the same surface plus full per-command input schemas.- REPL:
python test_api.py listfrom examples/API Test/.- From the AI Assistant:
meta.listCategoriesfollowed bymeta.listCommandsandmeta.describeCommand.
The Serial Studio API Server is a TCP server that listens on port 7777 (default) and accepts JSON-formatted commands to control Serial Studio programmatically. It provides programmatic control over Serial Studio through a TCP socket connection.
Identifier conventions. Most API commands address objects through some combination of
sourceId,groupId,datasetId,index, anduniqueId. They look interchangeable but are not. See the Dataset Identity Model for the rules of thumb (mutate by(groupId, datasetId), read byuniqueId, position byindex).
The API Server is available in both Serial Studio GPL and Serial Studio Pro builds:
Legend:
The commands in this document are also reachable from inside Serial Studio's scripting surfaces (Lua and JavaScript) via a generic apiCall() gateway. No TCP socket required: the call is dispatched in-process on the dashboard thread. The gateway is default-deny: only a small read-only allow-list is callable with no setup, and every other command returns METHOD_NOT_ALLOWED unless the project opts in via apiCall.allowFullSurface. See Frame Parser Scripting for the allow-list, rate limits, and examples.
local r = apiCall("project.dataset.list")
if r.ok then
print("Got " .. #r.result.datasets .. " datasets")
end
const r = apiCall("dashboard.getStatus");
if (!r.ok) console.warn(r.error);
Return shape: { ok, result?, error?, errorCode?, errorData? }. See Frame Parser Scripting -> apiCall for the full signature, examples, and the list of focused helpers (clearPlots, deviceWrite, actionFire, setActiveWorkspace, ...) that exist as thin shortcuts over apiCall.
apiCall runs synchronously and never throws. Treat it as a one-shot, event-driven trigger, not as something to invoke on every frame.
Launch Serial Studio
Enable the API Server:
Test the connection using curl (or any TCP client):
echo '{"type":"command","id":"1","command":"io.getStatus"}' | nc localhost 7777
Download the Python test client (optional):
examples/API Test/ in the Serial Studio repositorypython test_api.py send io.getStatusThe API Server starts immediately and will remember your preference across restarts.
Test the API is running:
# Linux/macOS
nc -zv 127.0.0.1 7777
# Or test with the Python client
cd examples/API\ Test
python test_api.py send io.getStatus
Expected output:
{
"isConnected": false,
"paused": false,
"busType": 0,
"configurationOk": false
}
The API Server always listens on port 7777; the port is not configurable. By default it is:
When external connections are enabled, the server binds to all interfaces and non-loopback clients must authenticate with an access token. See Authentication for External Connections.
By default, the API Server only accepts connections from 127.0.0.1 (localhost). In this default configuration it is:
This is the recommended configuration for most users. Remote access is opt-in: enabling Allow External API Connections binds the server to all interfaces and requires non-loopback clients to authenticate (see Authentication for External Connections).
By default the server binds to localhost only and requires no authentication, so any local process can connect. This is safe on single-user machines; on shared or multi-user systems, remember that any local process can control Serial Studio.
When external connections are enabled, the server also accepts connections from other machines. To keep that exposure safe, every non-loopback client must authenticate with an access token before any command or raw data is honored. Loopback (127.0.0.1 / ::1) clients are always exempt, so existing local tooling keeps working unchanged.
Implications:
The access token gate applies only to non-loopback clients and only when external connections are enabled. Local (loopback) clients never need a token, so scripts running on the same machine are unaffected.
Where to find the token
The token is generated automatically the first time external connections are enabled and persists across restarts.
How a client authenticates
A non-loopback client must send an auth handshake as its first line, before any other command:
{"type":"auth","token":"<your-token>"}
On success the server replies, and the connection stays authenticated for its lifetime:
{"type":"response","success":true,"result":{"authenticated":true}}
Any command sent before authenticating is rejected with an EXECUTION_ERROR ("Authentication required"), and the connection is closed after a few failed attempts. Loopback clients skip this step entirely.
Example (Python)
import json
import socket
TOKEN = "paste-your-token-here"
sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
sock.connect(("192.168.1.50", 7777)) # the machine running Serial Studio
# Authenticate first (required only for non-loopback connections).
sock.sendall((json.dumps({"type": "auth", "token": TOKEN}) + "\n").encode())
print(sock.recv(4096).decode()) # {"type":"response","success":true,...}
# Now send commands as usual.
status = {"type": "command", "id": "1", "command": "io.getStatus"}
sock.sendall((json.dumps(status) + "\n").encode())
print(sock.recv(65536).decode())
sock.close()
Token storage. The token is kept in cleartext in Serial Studio's application settings, alongside other preferences. Treat it like a password: anyone holding it with network access to port 7777 can control Serial Studio. Regenerate it if you suspect it leaked, and keep external connections disabled unless you need them.
For production or multi-user systems:
Ensure your firewall does not expose port 7777 externally:
Linux:
# Check if port is listening externally
netstat -tuln | grep 7777
# Should show: 127.0.0.1:7777 (not 0.0.0.0:7777)
Windows:
netstat -an | findstr 7777
macOS:
netstat -an | grep 7777
# Good: Validate inputs before sending to API
python validate_config.py && python configure_device.py
# Bad: Blindly forwarding untrusted data to API
curl http://external-source/config.json | python send_to_api.py
# Good: Use local scripts with known behavior
./scripts/connect_uart.py
# Bad: Running unknown scripts with API access
wget http://example.com/script.py && python script.py
Best Practices:
Rate limiting and basic connection logging are already present. The server enforces a per-window message cap (clients that exceed it are disconnected), and connect, disconnect, and authentication events are logged.
Planned security features (not yet implemented):
The API is designed for:
# Automated hardware-in-the-loop testing using test_api.py
import subprocess
import time
# Configure device
subprocess.run(["python", "test_api.py", "send", "io.setBusType", "-p", "busType=0"])
subprocess.run(["python", "test_api.py", "send", "io.uart.setBaudRate", "-p", "baudRate=115200"])
subprocess.run(["python", "test_api.py", "send", "io.uart.setPortIndex", "-p", "portIndex=0"])
subprocess.run(["python", "test_api.py", "send", "io.connect"])
# Your test code here - e.g., send test commands, read responses, etc.
# Export data for later analysis
subprocess.run(["python", "test_api.py", "send", "csvExport.setEnabled", "-p", "enabled=true"])
time.sleep(10) # Let it record data
subprocess.run(["python", "test_api.py", "send", "csvExport.close"])
# Your analysis code here - e.g., parse CSV, validate data ranges, etc.
# Production line testing using the API client
import json
import socket
def send_command(command, params=None):
sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
sock.connect(("127.0.0.1", 7777))
msg = {"type": "command", "id": "qa", "command": command}
if params:
msg["params"] = params
sock.sendall((json.dumps(msg) + "\n").encode())
response = json.loads(sock.recv(65536).decode())
sock.close()
return response
# Example: Test 100 units in production
for unit_id in range(100):
send_command("io.connect")
# Your testing logic here - e.g., send test commands,
# read sensor values, validate against specifications
send_command("io.disconnect")
# Your logging/reporting logic here
#!/bin/bash
# Example: Multi-device coordination using shell scripts
# Setup device connection
python test_api.py send io.setBusType -p busType=0
python test_api.py send io.uart.setBaudRate -p baudRate=115200
python test_api.py send io.connect
python test_api.py send csvExport.setEnabled -p enabled=true
# Monitor connection for extended experiment (e.g., 24 hours)
for i in {1..1440}; do # 1440 = 24 hours * 60 minutes
STATUS=$(python test_api.py send io.getStatus --json)
IS_CONNECTED=$(echo $STATUS | jq -r '.result.isConnected')
if [ "$IS_CONNECTED" != "true" ]; then
echo "$(date): Connection lost, reconnecting..." >> experiment.log
python test_api.py send io.connect
fi
sleep 60 # Check every minute
done
python test_api.py send csvExport.close
echo "$(date): Experiment complete" >> experiment.log
# Example: Raspberry Pi sensor gateway
import subprocess
import json
import time
while True:
result = subprocess.run(
["python", "test_api.py", "send", "io.getStatus", "--json"],
capture_output=True, text=True
)
status = json.loads(result.stdout)
# Your cloud upload logic here - e.g., HTTP POST, MQTT publish, etc.
# Example data to send:
# {
# "connected": status["result"]["isConnected"],
# "bus_type": status["result"]["busType"],
# "timestamp": time.time()
# }
time.sleep(300) # Check every 5 minutes
# Example: GitLab CI / GitHub Actions workflow
jobs:
hardware_test:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Start Serial Studio
run: |
# Start Serial Studio in background (assuming it's installed)
serial-studio &
sleep 5
- name: Configure Device via API
run: |
cd examples/API\ Test
python test_api.py send io.setBusType -p busType=0
python test_api.py send io.uart.setBaudRate -p baudRate=115200
python test_api.py send io.connect
- name: Run Your Hardware Tests
run: |
# Your test commands here
# e.g., send test data, verify responses, etc.
python test_api.py send io.getStatus
#!/bin/bash
# Example: Classroom demonstration automation
# Step 1: Connect to Arduino
python test_api.py send io.setBusType -p busType=0
python test_api.py send io.uart.setBaudRate -p baudRate=9600
python test_api.py send io.uart.setPortIndex -p portIndex=0
python test_api.py send io.connect
sleep 2
# Step 2: Enable CSV logging
python test_api.py send csvExport.setEnabled -p enabled=true
echo "Recording data for 30 seconds..."
sleep 30
# Step 3: Stop recording
python test_api.py send csvExport.close
echo "Data saved to CSV file"
# Analyze the data with your own tools (e.g., Python, Excel, MATLAB, etc.)
127.0.0.1 (localhost only)7777 (default)\n)sequenceDiagram
participant Client
participant Server as Serial Studio API Server
Client->>Server: Connect to 127.0.0.1:7777
Client->>Server: Send JSON command + \n
Note right of Server: Process
Server->>Client: JSON response + \n
Client->>Server: (keep connection open for more)
Client->>Server: Close connection
127.0.0.1:7777\n)The API server accepts multiple concurrent client connections. Each client operates independently:
# Multiple clients can connect simultaneously
client1 = connect_to_api() # Control connection
client2 = connect_to_api() # Monitoring connection
client3 = connect_to_api() # Data export control
# Command responses go only to the socket that sent the command.
# Push messages (frames, raw data, lifecycle events) go to every client.
status = client1.send("io.getStatus")
# State changes made by one client are visible to all clients
Connection lifecycle:
127.0.0.1:7777gRPC: The entire API is also available via gRPC on port 8888, with high-performance binary streaming. See the gRPC Server documentation.
All messages are JSON objects terminated by a newline (\n). The server processes one command per connection or multiple commands in sequence.
The API supports two message types:
{
"type": "command",
"id": "unique-request-id",
"command": "io.getStatus",
"params": {
"key": "value"
}
}
Fields:
type (string, required): Always "command" for single commandsid (string, optional): Unique identifier for this request (echoed in response)command (string, required): Command name (e.g., "io.connect")params (object, optional): Parameters for the command{
"type": "batch",
"id": "batch-request-id",
"commands": [
{
"command": "io.setBusType",
"id": "cmd-1",
"params": {"busType": 0}
},
{
"command": "io.uart.setBaudRate",
"id": "cmd-2",
"params": {"baudRate": 115200}
}
]
}
Fields:
type (string, required): Always "batch" for batch requestsid (string, optional): Unique identifier for the entire batchcommands (array, required): Array of command objects{
"type": "response",
"id": "unique-request-id",
"success": true,
"result": {
"isConnected": false,
"paused": false
}
}
Fields:
type (string): Always "response"id (string): Matches the request IDsuccess (boolean): true if command succeededresult (object): Command-specific result data{
"type": "response",
"id": "unique-request-id",
"success": false,
"error": {
"code": "INVALID_PARAM",
"message": "Invalid port: 70000. Valid range: 1-65535"
}
}
Error Codes:
| Code | Description | Example |
|---|---|---|
INVALID_JSON | Malformed JSON message | Missing closing brace, invalid syntax |
INVALID_MESSAGE_TYPE | Unknown or missing message type | "type": "unknown" or missing type field |
UNKNOWN_COMMAND | Command not recognized | "command": "invalid.command" |
INVALID_PARAM | Parameter value out of range or invalid | Port 70000, negative baud rate |
MISSING_PARAM | Required parameter not provided | Missing baudRate for setBaudRate |
EXECUTION_ERROR | Command failed during execution | Disconnect when not connected |
OPERATION_FAILED | Operation could not be completed | File I/O error, hardware error |
{
"type": "response",
"id": "batch-request-id",
"success": false,
"results": [
{
"id": "cmd-1",
"success": true,
"result": {"busType": 0}
},
{
"id": "cmd-2",
"success": false,
"error": {"code": "INVALID_PARAM", "message": "..."}
}
]
}
Notes:
success is false if any command failsresults arrayBesides command responses, the server writes unsolicited JSON lines to every connected client:
| Message | When it is sent |
|---|---|
{"frames": [{"data": {...}}, ...]} | Batch of parsed dashboard frames, pushed as data arrives |
{"data": "<base64>"} | Raw bytes received from the device, base64-encoded |
{"event": "connected"} / {"event": "disconnected"} | Device connection lifecycle changes |
A client that issues commands on a long-lived socket while a device is streaming must demultiplex incoming lines: a line whose type field is "response" answers a command (match it to the request by id); lines with a frames, data, or event key are push messages. A naive recv() after send() can pick up a frame batch instead of the response.
The API provides 300+ commands across multiple modules; enumerate the live surface with api.getCommands:
The per-module counts below are approximate and drift behind the C++
registry; treat api.getCommands as the source of truth.
GPL Build:
Pro Build Additional:
api.getCommandsReturns every command the live server exposes, with descriptions.
Parameters: None
Returns:
{
"commands": [
{"name": "io.connect", "description": "Open the configured connection"},
{"name": "io.uart.setBaudRate", "description": "Set the UART baud rate (params: baudRate)"}
]
}
Example:
python test_api.py send api.getCommands
Over MCP, the equivalent is the standard
tools/listJSON-RPC method, which returns the same surface plus per-command input schemas.
Connection and bus management:
io.getStatusGet current connection status and configuration.
Parameters: None
Returns:
{
"isConnected": false,
"paused": false,
"busType": 0,
"busTypeLabel": "UART (serial port)",
"busTypeSlug": "uart",
"configurationOk": true,
"readOnly": false,
"readWrite": true,
"busTypeName": "UART/COM",
"_summary": "Not connected. UART (serial port) is configured and ready to open."
}
io.listBusesGet list of supported bus types.
Parameters: None
Returns:
{
"buses": [
{"index": 0, "name": "UART/COM"},
{"index": 1, "name": "Network Socket"},
{"index": 2, "name": "Bluetooth LE"}
]
}
io.setBusTypeSet the active bus/driver type.
Parameters:
busType (int): 0=UART, 1=Network, 2=BLE, 3=Audio, 4=Modbus, 5=CAN, 6=USB, 7=HID, 8=Process (3-8 require Pro)Example:
python test_api.py send io.setBusType -p busType=0
io.setPausedPause or resume data processing.
Parameters:
paused (bool): true to pause, false to resumeExample:
python test_api.py send io.setPaused -p paused=true
io.connectOpen connection to the configured device.
Parameters: None
Returns:
{
"connected": true
}
Errors:
EXECUTION_ERROR: Already connected or configuration invalidExample:
python test_api.py send io.connect
io.disconnectClose current device connection.
Parameters: None
Returns:
{
"connected": false
}
Errors:
EXECUTION_ERROR: Not connectedExample:
python test_api.py send io.disconnect
io.writeDataSend data to the connected device.
Parameters:
data (string): Base64-encoded data to sendReturns:
{
"bytesWritten": 12
}
Example:
# Send "Hello World" (SGVsbG8gV29ybGQ= in Base64)
echo -n "Hello World" | base64 # SGVsbG8gV29ybGQ=
python test_api.py send io.writeData -p data=SGVsbG8gV29ybGQ=
Errors:
EXECUTION_ERROR: Not connected, or device write denied by the userMISSING_PARAM: Missing data parameterINVALID_PARAM: Invalid base64 encodingDevice-write commands (
io.writeData,io.ble.writeCharacteristic,console.send) sent by a remote API/MCP client trigger a one-time consent prompt; the user's answer is remembered. Headless runs cannot show the prompt, so set the environment variableSERIAL_STUDIO_API_AUTO_CONSENT=1to allow API device writes in that mode (used by CI).
Frame-detection mode and start/finish delimiter sequences are no longer live runtime commands. They are per-source project settings configured in the Project Editor (or via
project.source.update) and persisted in the.ssprojfile.
Serial port configuration:
io.uart.getConfigGet current UART configuration.
Parameters: None
Returns:
{
"portIndex": 1,
"portName": "/dev/ttyUSB0",
"baudRate": 115200,
"parityIndex": 0,
"parityName": "None",
"dataBitsIndex": 3,
"dataBitsValue": 8,
"stopBitsIndex": 0,
"stopBitsValue": 1,
"flowControlIndex": 0,
"flowControlName": "None",
"dtrEnabled": true,
"autoReconnect": false,
"isOpen": false,
"configurationOk": true
}
io.uart.listPortsGet list of available serial ports.
Parameters: None
Returns:
{
"portList": [
{"index": 0, "name": "COM1"},
{"index": 1, "name": "COM3"}
],
"currentPortIndex": 0,
"ports": [
{"index": 0, "name": "None"},
{"index": 1, "name": "/dev/ttyUSB0"}
]
}
io.uart.listBaudRatesGet list of common baud rates.
Parameters: None
Returns:
{
"baudRateList": ["110", "150", "300", "1200", "2400", "4800", "9600", "19200", "38400", "57600", "115200", "230400", "256000", "460800", "576000", "921600"],
"currentBaudRate": 9600,
"baudRates": [
{"index": 0, "value": 1200},
{"index": 1, "value": 2400}
]
}
io.uart.setDeviceRegister a custom serial port device name.
Parameters:
device (string): Device name (e.g., "COM3", "/dev/ttyUSB0")Example:
python test_api.py send io.uart.setDevice -p device=COM3
io.uart.setPortIndexSelect serial port by index from port list.
Parameters:
portIndex (int): Index from getPortListExample:
python test_api.py send io.uart.setPortIndex -p portIndex=0
io.uart.setBaudRateSet baud rate.
Parameters:
baudRate (int): Baud rate (e.g., 9600, 115200)Example:
python test_api.py send io.uart.setBaudRate -p baudRate=115200
io.uart.setParitySet parity mode.
Parameters:
parityIndex (int): 0=None, 1=Even, 2=Odd, 3=Space, 4=MarkExample:
python test_api.py send io.uart.setParity -p parityIndex=0
io.uart.setDataBitsSet data bits.
Parameters:
dataBitsIndex (int): 0=5 bits, 1=6 bits, 2=7 bits, 3=8 bitsExample:
python test_api.py send io.uart.setDataBits -p dataBitsIndex=3
io.uart.setStopBitsSet stop bits.
Parameters:
stopBitsIndex (int): 0=1 bit, 1=1.5 bits, 2=2 bitsExample:
python test_api.py send io.uart.setStopBits -p stopBitsIndex=0
io.uart.setFlowControlSet flow control mode.
Parameters:
flowControlIndex (int): 0=None, 1=Hardware, 2=SoftwareExample:
python test_api.py send io.uart.setFlowControl -p flowControlIndex=0
io.uart.setDtrEnabledEnable or disable DTR signal.
Parameters:
dtrEnabled (bool): true to enable, false to disableExample:
python test_api.py send io.uart.setDtrEnabled -p dtrEnabled=false
io.uart.setAutoReconnectSet auto-reconnect behavior.
Parameters:
autoReconnect (bool): true to enable, false to disableExample:
python test_api.py send io.uart.setAutoReconnect -p autoReconnect=true
TCP/UDP configuration:
io.network.getConfigGet current network configuration.
Parameters: None
Returns:
{
"socketTypeIndex": 0,
"socketTypeName": "TCP",
"remoteAddress": "192.168.1.1",
"tcpPort": 8080,
"udpLocalPort": 0,
"udpRemotePort": 8081,
"udpMulticast": false,
"isOpen": false
}
io.network.listSocketTypesGet list of available socket types.
Parameters: None
Returns:
{
"socketTypes": [
{"index": 0, "name": "TCP"},
{"index": 1, "name": "UDP"}
]
}
io.network.setRemoteAddressSet remote host address.
Parameters:
address (string): IP address or hostnameExample:
python test_api.py send io.network.setRemoteAddress -p address=192.168.1.100
io.network.setTcpPortSet TCP port number.
Parameters:
port (int): Port number (1-65535)Example:
python test_api.py send io.network.setTcpPort -p port=8080
io.network.setUdpLocalPortSet UDP local port.
Parameters:
port (int): Port number (0-65535, 0=any available port)Example:
python test_api.py send io.network.setUdpLocalPort -p port=9000
io.network.setUdpRemotePortSet UDP remote port.
Parameters:
port (int): Port number (1-65535)Example:
python test_api.py send io.network.setUdpRemotePort -p port=9001
io.network.setSocketTypeSet socket type.
Parameters:
socketTypeIndex (int): 0=TCP (client), 1=UDP. Serial Studio does not act as a TCP server.Example:
python test_api.py send io.network.setSocketType -p socketTypeIndex=0
io.network.setUdpMulticastEnable or disable UDP multicast.
Parameters:
enabled (bool): true to enable, false to disableExample:
python test_api.py send io.network.setUdpMulticast -p enabled=false
io.network.lookupPerform DNS lookup for a hostname.
Parameters:
host (string): Hostname to resolveReturns:
{
"host": "example.com",
"addresses": ["93.184.216.34"]
}
Example:
python test_api.py send io.network.lookup -p host=google.com
BLE device management:
io.ble.getStatusGet Bluetooth adapter status.
Parameters: None
Returns:
{
"operatingSystemSupported": true,
"adapterAvailable": true,
"isOpen": false,
"deviceCount": 0
}
io.ble.getConfigGet current BLE configuration.
Parameters: None
Returns:
{
"deviceIndex": -1,
"characteristicIndex": 0,
"isOpen": false,
"configurationOk": false,
"deviceName": "Arduino BLE",
"characteristicName": "Temperature"
}
io.ble.listDevicesGet list of discovered BLE devices.
Parameters: None
Returns:
{
"deviceList": [
{"index": 0, "name": "My BLE Device"},
{"index": 1, "name": "Heart Rate Monitor"}
],
"currentDeviceIndex": -1,
"devices": [
{"index": 0, "name": "Arduino BLE", "address": "00:11:22:33:44:55"}
]
}
io.ble.listServicesGet list of services for selected device.
Parameters: None
Returns:
{
"serviceList": [
{"index": 0, "name": "Generic Access"},
{"index": 1, "name": "Heart Rate"}
],
"services": [
{"index": 0, "name": "Environmental Sensing", "uuid": "181A"}
]
}
io.ble.listCharacteristicsGet list of characteristics for selected service.
Parameters: None
Returns:
{
"characteristicList": [
{"index": 0, "name": "Heart Rate Measurement"}
],
"currentCharacteristicIndex": -1,
"characteristics": [
{"index": 0, "name": "Temperature", "uuid": "2A6E"}
]
}
io.ble.startDiscoveryStart scanning for BLE devices.
Parameters: None
Example:
python test_api.py send io.ble.startDiscovery
io.ble.selectDeviceSelect a discovered BLE device.
Parameters:
deviceIndex (int): Device index from listDevicesExample:
python test_api.py send io.ble.selectDevice -p deviceIndex=0
io.ble.selectServiceSelect a BLE service.
Parameters:
serviceIndex (int): Service index from listServicesExample:
python test_api.py send io.ble.selectService -p serviceIndex=0
io.ble.setCharacteristicIndexSelect a BLE characteristic.
Parameters:
characteristicIndex (int): Characteristic index from listCharacteristicsExample:
python test_api.py send io.ble.setCharacteristicIndex -p characteristicIndex=0
CSV file export control:
csvExport.getStatusGet CSV export status.
Parameters: None
Returns:
{
"enabled": false,
"isOpen": false
}
csvExport.setEnabledEnable or disable CSV export.
Parameters:
enabled (bool): true to enable, false to disableExample:
python test_api.py send csvExport.setEnabled -p enabled=true
csvExport.closeClose current CSV file.
Parameters: None
Example:
python test_api.py send csvExport.close
CSV file playback control:
csvPlayer.openOpen a CSV file for playback.
Parameters:
filePath (string): Path to CSV fileExample:
python test_api.py send csvPlayer.open -p filePath=/path/to/data.csv
csvPlayer.closeClose current CSV file.
Parameters: None
csvPlayer.playStart playback.
Parameters: None
csvPlayer.pausePause playback.
Parameters: None
csvPlayer.toggleToggle play/pause state.
Parameters: None
csvPlayer.nextFrameAdvance to next frame.
Parameters: None
csvPlayer.previousFrameGo to previous frame.
Parameters: None
csvPlayer.setProgressSeek to position in file.
Parameters:
progress (double): Position from 0.0 to 1.0Example:
python test_api.py send csvPlayer.setProgress -p progress=0.5
csvPlayer.getStatusGet player status.
Parameters: None
Returns:
{
"isOpen": true,
"isPlaying": false,
"frameCount": 1000,
"framePosition": 500,
"progress": 0.5,
"timestamp": "00:05:23.456",
"filename": "data.csv"
}
Console/terminal control:
console.setEchoEnable or disable echo mode.
Parameters:
enabled (bool): true to enable, false to disableconsole.setShowTimestampShow or hide timestamps.
Parameters:
enabled (bool): true to show, false to hideconsole.setDisplayModeSet display mode.
Parameters:
modeIndex (int): 0=PlainText, 1=Hexadecimalconsole.setDataModeSet data mode.
Parameters:
modeIndex (int): 0=UTF8, 1=Hexadecimalconsole.setLineEndingSet line ending mode.
Parameters:
endingIndex (int): 0=None, 1=LF, 2=CR, 3=CRLFconsole.setFontFamilySet console font.
Parameters:
fontFamily (string): Font nameconsole.setFontSizeSet console font size.
Parameters:
fontSize (int): Font size in pointsconsole.setChecksumMethodSet checksum method.
Parameters:
methodIndex (int): Checksum method indexconsole.clearClear console output.
Parameters: None
console.sendSend data to device.
Parameters:
data (string): Data to sendconsole.getConfigGet console configuration.
Parameters: None
Returns:
{
"echo": false,
"showTimestamp": true,
"displayMode": 0,
"dataMode": 0,
"lineEnding": 1,
"fontFamily": "Courier New",
"fontSize": 10,
"checksumMethod": 0
}
Dashboard settings and visualization control:
dashboard.getStatusGet all dashboard configuration settings.
Parameters: None
Returns:
{
"operationMode": 0,
"operationModeName": "ProjectFile",
"fps": 60,
"timeRange": 10.0,
"widgetCount": 3,
"datasetCount": 12,
"running": false
}
Example:
python test_api.py send dashboard.getStatus
dashboard.setOperationModeSet the dashboard operation mode.
Parameters:
mode (int): 0=ProjectFile, 1=ConsoleOnly, 2=QuickPlotReturns:
{
"mode": 0,
"modeName": "ProjectFile"
}
Example:
python test_api.py send dashboard.setOperationMode -p mode=1
Operation Modes:
0 - ProjectFile: Use a JSON project file to define dashboard layout1 - ConsoleOnly: No parsing. Raw bytes flow only to the terminal, no dashboard.2 - QuickPlot: Automatic plotting of incoming numeric datadashboard.getOperationModeGet the current dashboard operation mode.
Parameters: None
Returns:
{
"mode": 0,
"modeName": "ProjectFile"
}
Example:
python test_api.py send dashboard.getOperationMode
dashboard.setFpsSet the visualization refresh rate.
Parameters:
fps (int): Refresh rate in frames per second (1-240 Hz)Returns:
{
"fps": 60
}
Example:
python test_api.py send dashboard.setFps -p fps=60
Notes:
dashboard.getFpsGet the current visualization refresh rate.
Parameters: None
Returns:
{
"fps": 60
}
Example:
python test_api.py send dashboard.getFps
dashboard.setTimeRangeSet the visible plot time window, in seconds.
Parameters:
seconds (double): Visible plot time window in seconds (0.001-300)Returns:
{
"seconds": 10.0
}
Example:
python test_api.py send dashboard.setTimeRange -p seconds=10
Notes:
project.dashboard.setTimeRange (per-project; survives project reload)dashboard.getTimeRangeGet the current visible plot time window, in seconds.
Parameters: None
Returns:
{
"seconds": 10.0
}
Example:
python test_api.py send dashboard.getTimeRange
Project file and configuration management:
Project file I/O is exposed as runtime API commands:
project.new,project.open, andproject.save(with an optionalfilePathfor a headless save-as), plusproject.loadJsonto replace the in-memory model. The GUI is one of several entry points. Programmatic project authoring can also useproject.exportJson(read) plus theproject.{group,dataset,action,workspace}.*mutators (write) on the in-memory model.
project.getStatusGet project info.
Returns:
{
"title": "My Project",
"filePath": "/path/to/project.json",
"modified": false,
"groupCount": 3,
"datasetCount": 12
}
project.group.addAdd new group.
Parameters:
title (string): Group titlewidgetType (int): Widget type (0-8): 0=DataGrid, 1=Accelerometer,
2=Gyroscope, 3=GPS, 4=MultiPlot, 5=NoGroupWidget, 6=Plot3D, 7=ImageView,
8=Painterproject.group.deleteDelete current group.
Parameters: None
project.group.duplicateDuplicate current group.
Parameters: None
project.dataset.addAdd new dataset.
Parameters:
options (int): Dataset options (bit flags 0-127): 1=Plot, 2=FFT, 4=Bar,
8=Gauge, 16=Compass, 32=LED, 64=Waterfallproject.dataset.deleteDelete current dataset.
Parameters: None
project.dataset.duplicateDuplicate current dataset.
Parameters: None
project.dataset.setOptionToggle dataset option.
Parameters:
option (int): Option flagenabled (bool): Enable or disableproject.action.addAdd new action.
Parameters: None
project.action.deleteDelete current action.
Parameters: None
project.action.duplicateDuplicate current action.
Parameters: None
project.frameParser.setCodeSet frame parser code.
Parameters:
code (string): Frame parser source codelanguage (int, optional): 0=JavaScript, 1=Lua, 2=Built-In. Pass it to lock in the runtime engine; a mismatch silently fails to compile.project.frameParser.getCodeGet frame parser code.
Returns:
{
"sourceId": 0,
"language": 0,
"code": "function parse(frame) { ... }",
"codeLength": 256
}
Built-In (language: 2) sources also return template and params, and code carries the JSON descriptor.
project.group.listList all groups.
Returns:
{
"groups": [
{
"groupId": 0,
"title": "Sensors",
"widget": "MultiPlot",
"datasetCount": 5
}
],
"groupCount": 1
}
project.dataset.listList all datasets.
Returns:
{
"datasets": [
{
"groupId": 0,
"groupTitle": "Sensors",
"index": 0,
"title": "Temperature",
"units": "°C",
"widget": "bar",
"value": "25.3"
}
],
"datasetCount": 5
}
project.action.listList all actions.
Returns:
{
"actions": [],
"actionCount": 0
}
Note: These commands require a Serial Studio Pro license.
io.modbus.getConfigGet current Modbus configuration.
Parameters: None
io.modbus.listProtocolsGet list of supported Modbus protocols.
Returns:
{
"protocolList": [
{"index": 0, "name": "Modbus RTU"},
{"index": 1, "name": "Modbus TCP"}
]
}
io.modbus.setProtocolIndexSet Modbus protocol.
Parameters:
protocolIndex (int): 0=RTU, 1=TCPio.modbus.setSlaveAddressSet Modbus slave address.
Parameters:
address (int): Slave address (1-247)io.modbus.setPollIntervalSet polling interval.
Parameters:
intervalMs (int): Interval in milliseconds (minimum 10)io.modbus.setHostSet Modbus TCP host address.
Parameters:
host (string): IP address or hostnameio.modbus.setPortSet Modbus TCP port.
Parameters:
port (int): Port number (1-65535)io.modbus.setSerialPortIndexSet RTU serial port.
Parameters:
portIndex (int): Serial port indexio.modbus.setBaudRateSet RTU baud rate.
Parameters:
baudRate (int): Baud rateio.modbus.setParityIndexSet RTU parity.
Parameters:
parityIndex (int): Parity indexio.modbus.setDataBitsIndexSet RTU data bits.
Parameters:
dataBitsIndex (int): Data bits indexio.modbus.setStopBitsIndexSet RTU stop bits.
Parameters:
stopBitsIndex (int): Stop bits indexio.modbus.addRegisterGroupAdd a register group to poll.
Parameters:
type (int): Register type (0=Holding, 1=Input, 2=Coils, 3=Discrete)startAddress (int): Starting register address (0-65535)count (int): Number of registers to read (1-125)Example:
python test_api.py send io.modbus.addRegisterGroup -p type=2 startAddress=0 count=10
io.modbus.removeRegisterGroupRemove a register group.
Parameters:
groupIndex (int): Group index to removeio.modbus.clearRegisterGroupsClear all register groups.
Parameters: None
io.modbus.listSerialPortsio.modbus.listParitiesio.modbus.listDataBitsio.modbus.listStopBitsio.modbus.listBaudRatesio.modbus.listRegisterTypesio.modbus.listRegisterGroupsNote: These commands require a Serial Studio Pro license.
io.canbus.getConfigGet current CAN bus configuration.
Parameters: None
io.canbus.listPluginsGet list of available CAN plugins.
Returns:
{
"pluginList": [
{"index": 0, "name": "socketcan", "displayName": "SocketCAN"},
{"index": 1, "name": "peakcan", "displayName": "PEAK PCAN"}
]
}
io.canbus.listInterfacesGet list of available CAN interfaces.
Returns:
{
"interfaceList": [
{"index": 0, "name": "can0"},
{"index": 1, "name": "can1"}
]
}
io.canbus.listBitratesGet list of supported bitrates.
Returns:
{
"bitrateList": ["10000", "20000", "50000", "100000", "125000", "250000", "500000", "800000", "1000000"]
}
io.canbus.getInterfaceErrorGet interface error message if any.
Parameters: None
io.canbus.setPluginIndexSelect CAN plugin.
Parameters:
pluginIndex (int): Plugin index from listPluginsio.canbus.setInterfaceIndexSelect CAN interface.
Parameters:
interfaceIndex (int): Interface index from listInterfacesio.canbus.setBitrateSet CAN bitrate.
Parameters:
bitrate (int): Bitrate in bits/second (e.g., 250000)io.canbus.setCanFdEnable or disable CAN FD.
Parameters:
enabled (bool): true to enable CAN FD, false for standard CANNote: These commands require a Serial Studio Pro license.
MQTT is split into two independent surfaces, each configured with a single
patch-style setConfig command instead of one command per field. The
publisher forwards dashboard data to a broker and runs alongside any data
source. The subscriber is the MQTT data-source driver: configure it here,
then open it with io.setBusType + io.connect like any other driver.
Shared rules for both setConfig commands:
password requires username in the same call. The pair is stored
in the encrypted credential vault, never in the project file, and is never
returned by getConfig (check hasCredentials instead). Pass empty strings
for both to clear the stored pair.mqttVersion, sslProtocol, peerVerifyMode) take
integer indices; getConfig returns the canonical lookup tables
(mqttVersions, sslProtocols, peerVerifyModes).project.mqtt.publisher.getConfigRead the publisher configuration (broker, mode, TLS). Includes the enum lookup
tables and hasCredentials.
Parameters: None
project.mqtt.publisher.setConfigPatch one or more publisher fields. Setting enabled: true starts publishing.
Parameters (all optional):
enabled (bool): Start or stop publishinghostname (string), port (int): Broker endpointclientId (string), customClientId (bool): Client identity; with
customClientId: false the ID regenerates automaticallyusername, password (string): Credential pair (vault rules above)topicBase (string): Publish topic rootmode (int): 0=RawRxData, 1=ScriptDriven, 2=DashboardCsv, 3=DashboardJsonpublishFrequency (int): Publish rate in Hz (1-30)publishNotifications (bool), notificationTopic (string): Forward app
notifications to MQTTcleanSession (bool), keepAlive (int): Session settingsmqttVersion, sslEnabled, sslProtocol, peerVerifyMode,
peerVerifyDepth: Protocol and TLS settingsproject.mqtt.publisher.getStatusSnapshot of publisher live state (connected, messagesSent, broker
endpoint). Does not trigger a connection attempt.
Parameters: None
project.mqtt.subscriber.getConfigRead the subscriber driver configuration, as used the next time io.connect
runs with the MQTT bus type. Password is never returned.
Parameters: None
project.mqtt.subscriber.setConfigPatch one or more subscriber driver fields. Changing fields while connected schedules a reconnect.
Parameters (all optional):
hostname (string), port (int): Broker endpointclientId (string): Client identityusername, password (string): Credential pair (vault rules above)topicFilter (string): Subscribe filter; + and # wildcards supportedcleanSession (bool), keepAlive (int), autoKeepAlive (bool): Session
settingsmqttVersion, sslEnabled, sslProtocol, peerVerifyMode,
peerVerifyDepth: Protocol and TLS settingsproject.mqtt.subscriber.getStatusSnapshot of subscriber driver live state (isOpen, hostname, port).
Parameters: None
Note: These commands require a Serial Studio Pro license.
mdf4Export.getStatusGet MDF4 export status.
Parameters: None
Returns:
{
"enabled": false,
"isOpen": false
}
mdf4Export.setEnabledEnable or disable MDF4 export.
Parameters:
enabled (bool): true to enable, false to disablemdf4Export.closeClose current MDF4 file.
Parameters: None
MDF4 file playback control (same interface as CSV Player):
mdf4Player.openOpen MDF4/MF4 file for playback.
Parameters:
filePath (string): Path to MDF4 fileExample:
python test_api.py send mdf4Player.open -p filePath=/path/to/data.mf4
mdf4Player.closeClose current MDF4 file.
Parameters: None
mdf4Player.playStart playback.
Parameters: None
mdf4Player.pausePause playback.
Parameters: None
mdf4Player.toggleToggle play/pause state.
Parameters: None
mdf4Player.nextFrameAdvance to next frame.
Parameters: None
mdf4Player.previousFrameGo to previous frame.
Parameters: None
mdf4Player.setProgressSeek to position in file.
Parameters:
progress (double): Position from 0.0 to 1.0Example:
python test_api.py send mdf4Player.setProgress -p progress=0.25
mdf4Player.getStatusGet player status.
Returns:
{
"isOpen": true,
"isPlaying": true,
"frameCount": 5000,
"framePosition": 1250,
"progress": 0.25,
"timestamp": "00:01:15.678",
"filename": "data.mf4"
}
Note: These commands require a Serial Studio Pro license.
io.audio.setInputDeviceSelect audio input device.
Parameters:
deviceIndex (int): Device indexio.audio.setOutputDeviceSelect audio output device.
Parameters:
deviceIndex (int): Device indexio.audio.setSampleRateSet sample rate.
Parameters:
rateIndex (int): Sample rate indexio.audio.setInputSampleFormatSet input sample format.
Parameters:
formatIndex (int): Format indexio.audio.setInputChannelConfigSet input channel configuration.
Parameters:
channelIndex (int): Channel config indexio.audio.setOutputSampleFormatSet output sample format.
Parameters:
formatIndex (int): Format indexio.audio.setOutputChannelConfigSet output channel configuration.
Parameters:
channelIndex (int): Channel config indexio.audio.listInputDevicesGet list of input devices.
Returns:
{
"devices": ["Microphone", "Line In"],
"selectedIndex": 0
}
io.audio.listOutputDevicesGet list of output devices.
Returns:
{
"devices": ["Speakers", "Headphones"],
"selectedIndex": 0
}
io.audio.listSampleRatesGet list of sample rates.
Returns:
{
"sampleRates": ["8000", "44100", "48000"],
"selectedIndex": 2
}
io.audio.listInputFormatsGet list of input sample formats.
Returns:
{
"formats": ["Unsigned 8-bit", "Signed 16-bit", "Signed 24-bit", "Signed 32-bit", "Float 32-bit"],
"selectedIndex": 0
}
io.audio.listOutputFormatsGet list of output sample formats.
Returns:
{
"formats": ["Unsigned 8-bit", "Signed 16-bit", "Signed 24-bit", "Signed 32-bit", "Float 32-bit"],
"selectedIndex": 0
}
io.audio.getConfigGet complete audio configuration.
Returns:
{
"selectedInputDevice": 0,
"selectedOutputDevice": 0,
"selectedSampleRate": 2,
"selectedInputSampleFormat": 0,
"selectedInputChannelConfig": 0,
"selectedOutputSampleFormat": 0,
"selectedOutputChannelConfig": 0
}
Request:
{
"type": "command",
"id": "status-1",
"command": "io.getStatus"
}
Response:
{
"type": "response",
"id": "status-1",
"success": true,
"result": {
"isConnected": false,
"paused": false,
"busType": 0,
"configurationOk": false
}
}
Request (Batch):
{
"type": "batch",
"id": "uart-setup",
"commands": [
{"command": "io.setBusType", "id": "1", "params": {"busType": 0}},
{"command": "io.uart.setBaudRate", "id": "2", "params": {"baudRate": 115200}},
{"command": "io.uart.setParity", "id": "3", "params": {"parityIndex": 0}},
{"command": "io.uart.setDataBits", "id": "4", "params": {"dataBitsIndex": 3}},
{"command": "io.uart.setStopBits", "id": "5", "params": {"stopBitsIndex": 0}},
{"command": "io.uart.setPortIndex", "id": "6", "params": {"portIndex": 0}},
{"command": "io.connect", "id": "7"}
]
}
First, Base64-encode your data:
echo -n "Hello World" | base64
# Output: SGVsbG8gV29ybGQ=
Request:
{
"type": "command",
"id": "send-1",
"command": "io.writeData",
"params": {
"data": "SGVsbG8gV29ybGQ="
}
}
{
"type": "batch",
"id": "network-setup",
"commands": [
{"command": "io.setBusType", "id": "1", "params": {"busType": 1}},
{"command": "io.network.setSocketType", "id": "2", "params": {"socketTypeIndex": 0}},
{"command": "io.network.setRemoteAddress", "id": "3", "params": {"address": "192.168.1.100"}},
{"command": "io.network.setTcpPort", "id": "4", "params": {"port": 8080}},
{"command": "io.connect", "id": "5"}
]
}
{
"type": "command",
"id": "csv-1",
"command": "csvExport.setEnabled",
"params": {
"enabled": true
}
}
Request (Batch):
{
"type": "batch",
"id": "dashboard-setup",
"commands": [
{"command": "dashboard.setOperationMode", "id": "1", "params": {"mode": 1}},
{"command": "dashboard.setFps", "id": "2", "params": {"fps": 60}},
{"command": "dashboard.setTimeRange", "id": "3", "params": {"seconds": 10}},
{"command": "dashboard.getStatus", "id": "4"}
]
}
Shell Example:
python test_api.py send dashboard.setOperationMode -p mode=1
python test_api.py send dashboard.setFps -p fps=60
python test_api.py send dashboard.setTimeRange -p seconds=10
python test_api.py send dashboard.getStatus
{
"type": "command",
"id": "list-1",
"command": "api.getCommands"
}
Returns:
{
"type": "response",
"id": "list-1",
"success": true,
"result": {
"commands": [
{"name": "io.connect", "description": "Open the configured connection"},
{"name": "io.uart.setBaudRate", "description": "Set UART baud rate"}
]
}
}
Over MCP, the equivalent request is {"jsonrpc": "2.0", "id": 1, "method": "tools/list"} for the same surface plus input schemas.
Configure UART Connection:
python test_api.py send io.setBusType -p busType=0
python test_api.py send io.uart.setBaudRate -p baudRate=115200
python test_api.py send io.uart.setPortIndex -p portIndex=0
python test_api.py send io.connect
Configure Network (TCP) Connection:
python test_api.py send io.setBusType -p busType=1
python test_api.py send io.network.setSocketType -p socketTypeIndex=0
python test_api.py send io.network.setRemoteAddress -p address=192.168.1.100
python test_api.py send io.network.setTcpPort -p port=8080
python test_api.py send io.connect
Enable Data Export:
python test_api.py send csvExport.setEnabled -p enabled=true
Configure Dashboard Settings:
python test_api.py send dashboard.setOperationMode -p mode=1
python test_api.py send dashboard.setFps -p fps=60
python test_api.py send dashboard.setTimeRange -p seconds=10
python test_api.py send dashboard.getStatus
The examples/API Test/test_api.py script provides a full-featured client.
Location: examples/API Test/test_api.py
Features:
Usage:
# Single command
python test_api.py send io.getStatus
# With parameters
python test_api.py send io.uart.setBaudRate -p baudRate=115200
# Interactive mode
python test_api.py interactive
# Run tests
python test_api.py test
# List all commands
python test_api.py list
Installation:
cd examples/API\ Test/
python test_api.py --help
#!/usr/bin/env python3
import socket
import json
import time
class SerialStudioAPI:
def __init__(self, host="127.0.0.1", port=7777):
self.host = host
self.port = port
def send_command(self, command, params=None):
sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
sock.connect((self.host, self.port))
msg = {
"type": "command",
"id": f"cmd-{time.time()}",
"command": command
}
if params:
msg["params"] = params
sock.sendall((json.dumps(msg) + "\n").encode())
response = json.loads(sock.recv(65536).decode())
sock.close()
return response
def connect_uart(self, baud=115200, port_index=0):
self.send_command("io.setBusType", {"busType": 0})
self.send_command("io.uart.setBaudRate", {"baudRate": baud})
self.send_command("io.uart.setPortIndex", {"portIndex": port_index})
return self.send_command("io.connect")
# Usage
api = SerialStudioAPI()
status = api.send_command("io.getStatus")
print(f"Connected: {status['result']['isConnected']}")
const net = require('net');
class SerialStudioAPI {
constructor(host = '127.0.0.1', port = 7777) {
this.host = host;
this.port = port;
}
sendCommand(command, params = {}) {
return new Promise((resolve, reject) => {
const client = net.createConnection({ host: this.host, port: this.port });
const msg = {
type: 'command',
id: `cmd-${Date.now()}`,
command: command,
params: params
};
client.on('connect', () => {
client.write(JSON.stringify(msg) + '\n');
});
client.on('data', (data) => {
const response = JSON.parse(data.toString());
client.end();
resolve(response);
});
client.on('error', (err) => {
reject(err);
});
});
}
}
// Usage
const api = new SerialStudioAPI();
api.sendCommand('io.getStatus')
.then(response => console.log(response))
.catch(err => console.error(err));
#!/bin/bash
API_HOST="127.0.0.1"
API_PORT="7777"
send_command() {
local command=$1
local params=${2:-"{}"}
local msg=$(cat <<EOF
{
"type": "command",
"id": "bash-cmd",
"command": "$command",
"params": $params
}
EOF
)
echo "$msg" | nc $API_HOST $API_PORT
}
# Usage
send_command "io.getStatus"
send_command "io.uart.setBaudRate" '{"baudRate": 115200}'
# Using netcat
echo '{"type":"command","id":"1","command":"io.getStatus"}' | nc localhost 7777
# Using curl (if supported)
curl -X POST http://localhost:7777 \
-H "Content-Type: application/json" \
-d '{"type":"command","id":"1","command":"io.getStatus"}'
import socket
import json
sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
sock.connect(("127.0.0.1", 7777))
request = {
"type": "command",
"id": "test-1",
"command": "io.getStatus"
}
sock.sendall((json.dumps(request) + "\n").encode())
response = json.loads(sock.recv(65536).decode())
print(response)
sock.close()
using System;
using System.Net.Sockets;
using System.Text;
using System.Text.Json;
var client = new TcpClient("127.0.0.1", 7777);
var stream = client.GetStream();
var request = new {
type = "command",
id = "test-1",
command = "io.getStatus"
};
var json = JsonSerializer.Serialize(request) + "\n";
var data = Encoding.UTF8.GetBytes(json);
stream.Write(data, 0, data.Length);
var buffer = new byte[65536];
var bytes = stream.Read(buffer, 0, buffer.Length);
var response = Encoding.UTF8.GetString(buffer, 0, bytes);
Console.WriteLine(response);
client.Close();
✅ DO:
❌ DON'T:
Good:
status = api.send_command("io.getStatus")
if not status["result"]["isConnected"]:
api.send_command("io.connect")
# Bad - assuming connection state
api.send_command("io.writeData", {"data": "..."})
Use batch commands when executing multiple related operations:
Good (Batch):
{
"type": "batch",
"commands": [
{"command": "io.setBusType", "id": "1", "params": {"busType": 0}},
{"command": "io.uart.setBaudRate", "id": "2", "params": {"baudRate": 115200}},
{"command": "io.connect", "id": "3"}
]
}
Less Efficient (Sequential):
# Three separate TCP connections
send_command("io.setBusType", {"busType": 0})
send_command("io.uart.setBaudRate", {"baudRate": 115200})
send_command("io.connect")
Always check for errors in responses:
# Good
response = api.send_command("io.connect")
if not response.get("success"):
error = response.get("error", {})
code = error.get("code")
message = error.get("message")
if code == "EXECUTION_ERROR":
# Handle connection failure
print(f"Connection failed: {message}")
else:
# Handle other errors
print(f"Error {code}: {message}")
else:
print("Connected successfully")
# Bad - ignoring errors
api.send_command("io.connect")
# Continue without checking...
Validate parameters before sending:
# Good
def set_baud_rate(rate):
valid_rates = [1200, 2400, 4800, 9600, 19200, 38400, 57600, 115200]
if rate not in valid_rates:
raise ValueError(f"Invalid baud rate: {rate}")
return api.send_command("io.uart.setBaudRate", {"baudRate": rate})
# Bad - sending unchecked values
set_baud_rate(user_input) # Could be anything!
Track connection state in your client:
class SerialStudioClient:
def __init__(self):
self.connected = False
self.bus_type = None
def connect(self):
response = self.send_command("io.connect")
if response.get("success"):
self.connected = True
return response
def disconnect(self):
response = self.send_command("io.disconnect")
if response.get("success"):
self.connected = False
return response
# Good
try:
api.send_command("io.connect")
api.send_command("csvExport.setEnabled", {"enabled": True})
# Do work...
finally:
api.send_command("csvExport.close")
api.send_command("io.disconnect")
# Bad - leaving resources open
api.send_command("io.connect")
# Exit without cleanup
# Good - keep connection open for monitoring
sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
sock.connect(("127.0.0.1", 7777))
while monitoring:
msg = {"type": "command", "command": "io.getStatus"}
sock.sendall((json.dumps(msg) + "\n").encode())
response = sock.recv(65536)
# Process response
time.sleep(1)
sock.close()
# Bad - reconnecting every time
while monitoring:
response = api.send_command("io.getStatus") # New connection each time!
time.sleep(1)
Problem: Connection refused or timeout
Solutions:
telnet localhost 7777 or nc localhost 7777Problem: UNKNOWN_COMMAND or INVALID_PARAM
Solutions:
python test_api.py listpython test_api.py list against the live serverlistBaudRates, getPortList, etc. to see valid valuesProblem: All commands in batch fail
Solutions:
id fieldcommands is an arrayProblem: Connection closes unexpectedly
Solutions:
Problem: Response ID differs from request ID
Solutions:
Problem: UNKNOWN_COMMAND for Modbus/CAN/MQTT commands
Solutions:
Problem: EXECUTION_ERROR when command fails
Solutions:
Connection Pooling:
class ConnectionPool:
def __init__(self, size=5):
self.connections = [create_connection() for _ in range(size)]
self.available = self.connections.copy()
def get(self):
return self.available.pop() if self.available else None
def release(self, conn):
self.available.append(conn)
Pipelining Commands:
# Send multiple commands without waiting for responses
for cmd in commands:
send_async(cmd)
# Then collect all responses
responses = [receive() for _ in commands]
LabVIEW Integration: Use LabVIEW's TCP/IP VIs to communicate with the API Server.
MATLAB Integration:
% Connect to Serial Studio
t = tcpclient('127.0.0.1', 7777);
% Send command
request = struct('type', 'command', 'id', 'matlab-1', 'command', 'io.getStatus');
json = jsonencode(request);
write(t, [json, newline]);
% Read response
response = read(t);
data = jsondecode(char(response));
% Close
clear t;
Docker/Container Usage:
# Expose host's Serial Studio to container
docker run -it --network host my-automation-script
# Inside container, connect to 127.0.0.1:7777
Build language-specific wrappers for easier use:
class SerialStudio:
def __init__(self, host='127.0.0.1', port=7777):
self.api = SerialStudioAPI(host, port)
def uart(self):
return UARTDriver(self.api)
def network(self):
return NetworkDriver(self.api)
class UARTDriver:
def __init__(self, api):
self.api = api
def set_baud_rate(self, rate):
return self.api.send("io.uart.setBaudRate", {"baudRate": rate})
def get_ports(self):
response = self.api.send("io.uart.listPorts")
return response.get("result", {}).get("portList", [])
# Usage
ss = SerialStudio()
ss.uart().set_baud_rate(115200)
ports = ss.uart().get_ports()
Serial Studio includes a built-in MCP (Model Context Protocol) server that exposes the API Server functionality to AI models like Claude and ChatGPT. AI assistants can control Serial Studio directly (connecting to devices, reading sensor data, sending commands, and managing exports) through natural language instructions.
The MCP handler wraps the Serial Studio TCP API (port 7777) in an MCP-compliant interface. Any MCP-capable AI client can discover and call all 300+ API commands as tools.
See the MCP Client example in the examples directory for a complete working client implementation.
examples/API Test/ directory (client, REPL, and smoke tests in test_api.py)examples/API Test/test_api.py testexamples/MCP Client/ directorydashboard.getStatus - Get all dashboard settingsdashboard.setOperationMode / dashboard.getOperationMode - Control operation modedashboard.setFps / dashboard.getFps - Control visualization refresh ratedashboard.setPoints / dashboard.getPoints - Control plot data pointsThe Serial Studio API Server is dual-licensed:
See the main LICENSE file for details.
Found a bug or have a suggestion?
For security issues, please contact privately rather than creating a public issue.
Total Commands: 300+ — the registry grows with every release; enumerate the live surface with api.getCommands.
Made with ❤️ by the Serial Studio team
For questions and support, visit the Serial Studio GitHub repository.