Serial Protocol & Command Reference
Serial Protocol
The software uses a simple text-based serial protocol to communicate.
Baud Rate:
115200(default)Line Ending: Newline or carriage return
Startup: Prints
READYwhen the board boots upSuccess: Prints
okwhen a command finishesErrors: Prints
Error: <message>if you send a bad commandEmergency: Prints
ALARM:ESTOPif an emergency stop happens
Supported Commands
Motion and Modes
Command |
Description |
|---|---|
|
Linear move command (Joint-space or Cartesian) |
|
Dwell command (utilizes non-blocking wait loops) |
|
Initiate homing sequence at specified speed |
|
Set absolute positioning mode (Cartesian) |
|
Set relative positioning mode (Cartesian) |
G0/G1 Parameters:
Joint Moves:
T1<deg>,T2<deg>,T3<deg>Cartesian Moves:
X,Y,Z(in millimeters)Speed:
F<deg/s>(Controls how fast the main motors turn)
Motor Power and Diagnostics
Command |
Description |
|---|---|
|
Energize all arm stepper drivers |
|
De-energize all arm stepper drivers |
|
Query current Cartesian and joint-space state |
|
Query the active logic states of all endstops |
|
Query or modify the motion smoothing parameters |
|
Block serial processing until motion queue empties |
|
Display a compact command reference table |
Gripper Control
Emergency Halts
Command |
Description |
|---|---|
|
Immediate software emergency stop |
|
Instantaneous alias for |
Note: Sending the Ctrl-X (0x18) byte over serial will instantly trigger an emergency stop, even if the robot is busy doing something else.