Skip to content

Commit 2ad1971

Browse files
committed
dotbot: document which app acts on wheel velocity and its stop timeout
AI-assisted: Claude Opus 5.5
1 parent 40369df commit 2ad1971

2 files changed

Lines changed: 7 additions & 2 deletions

File tree

‎doc/reference/rest.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ DotBot id; `{application}` is `0` (DotBot) or `1` (SailBot).
4343
| `GET` | `/controller/map_size` | Controller map size |
4444
| `GET` | `/controller/background_map` | Background map image (base64) |
4545
| `PUT` | `/controller/dotbots/{address}/{application}/move_raw` | Drive the motors |
46-
| `PUT` | `/controller/dotbots/{address}/{application}/wheel_velocity` | Set each wheel's speed: `left_mm_s` / `right_mm_s`, in mm/s, within ±800 |
46+
| `PUT` | `/controller/dotbots/{address}/{application}/wheel_velocity` | Set each wheel's speed: `left_mm_s` / `right_mm_s`, in mm/s, within ±700. Only the `dotbot-next` firmware app acts on it (other apps ignore it), and it stops the wheels about 500 ms after the last command, so resend faster than 2 Hz |
4747
| `PUT` | `/controller/dotbots/{address}/{application}/rgb_led` | Set the RGB LED |
4848
| `PUT` | `/controller/dotbots/{address}/{application}/waypoints` | Set navigation waypoints |
4949
| `DELETE` | `/controller/dotbots/{address}/positions` | Clear position history |

‎dotbot/server.py‎

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -159,7 +159,12 @@ def _dotbots_move_raw(address: str, command: DotBotMoveRawCommandModel):
159159
async def dotbots_wheel_velocity(
160160
address: str, application: int, command: DotBotWheelVelocityCommandModel
161161
):
162-
"""Hand the DotBot's wheel speeds to its onboard wheel loop."""
162+
"""Hand the DotBot's wheel speeds to its onboard wheel loop.
163+
164+
Only the dotbot-next firmware app acts on this command; other apps accept
165+
the frame and ignore it. dotbot-next stops the wheels about 500 ms after
166+
the last command, so a caller must resend faster than 2 Hz.
167+
"""
163168
if address not in api.controller.dotbots:
164169
raise HTTPException(status_code=404, detail="No matching dotbot found")
165170
api.controller.send_payload(

0 commit comments

Comments
 (0)