Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
d-rowe committed Nov 21, 2024
1 parent 1f60117 commit 933640a
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,13 @@
OpenSandbot is an open-source robotic kinetic art table. It has four components: parts, hardware, firmware, and app.

### Firmware
This firmware is written in rust for the $4 Raspberry Pi Pico and provides a UART API on [UART0](https://pico.pinout.xyz/) to control the sandbot.
This firmware is written in rust for the $4 Raspberry Pi Pico (RP2040) and provides a UART API on [UART0](https://pico.pinout.xyz/) to control the sandbot.

### API
The API expects messages to be formatted as `METHOD[ ARG0][ ARG1]\n`. All messages (rx and tx) expect the new line character (`\n`) to signal the end of message.
The API expects messages to be formatted as `METHOD[ ARG0][ ARG1]\n`. All messages (rx and tx) expect the new line character (`\n`) at the end of each message.

- Movement: Ex. `MOVE 1.2 0.5` would move to theta 1.2 rho 0.5.
- Movement: Ex. `MOVE 1.2 0.5` would move to theta 1.2 rho 0.5.

The API also emits the status messages
- `STATUS IDLE`: the sandbot is not currently moving
- `STATUS MOVING` the sandbot is currently moving to a target position. You may still queue more coordinates at this time.
- `STATUS IDLE`: the sandbot is idle and not currently moving
- `STATUS MOVING` the sandbot is currently moving to a target position

0 comments on commit 933640a

Please sign in to comment.