From 933640a10be41edb9fb7195b4e65936aea822f7e Mon Sep 17 00:00:00 2001 From: Daniel Rowe Date: Wed, 20 Nov 2024 21:42:02 -0800 Subject: [PATCH] update readme --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index a268f63..b620a97 100644 --- a/README.md +++ b/README.md @@ -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