Skip to content

Commit 3bc5565

Browse files
committed
readme: use "DotBot", drop pip install --pre
AI-assisted: Claude Opus 4.7
1 parent e72327f commit 3bc5565

1 file changed

Lines changed: 17 additions & 16 deletions

File tree

‎README.md‎

Lines changed: 17 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,8 @@
99
The control plane for the [DotBot](http://www.dotbots.org) - a small wireless
1010
wheeled robot built to operate in large swarms, for research and education.
1111

12-
PyDotBot allows you to flash a robot and control a whole fleet over the air,
13-
from one bot to a thousand.
12+
PyDotBot allows you to flash a DotBot and control a whole fleet over the air,
13+
from one DotBot to a thousand.
1414

1515
[▶️ Click to see a DotBot swarm in action](https://www.youtube.com/watch?v=pXGTLqafReU)
1616

@@ -25,8 +25,8 @@ from one bot to a thousand.
2525

2626
**What you can do**
2727

28-
- 🕹️ Drive one bot or a whole fleet from a **web UI** (live map + joystick) or your own **Python** code
29-
- 📡 Flash the swarm **over the air** - one command, hundreds of bots at once
28+
- 🕹️ Drive one DotBot or a whole fleet from a **web UI** (live map + joystick) or your own **Python** code
29+
- 📡 Flash the swarm **over the air** - one command, hundreds of DotBots at once
3030
- 🛰️ Get real-world **(x, y) positions** with Lighthouse 2 localization
3131
- 🧪 Try it all with **zero hardware** using the built-in simulator
3232
- 🛠️ One `dotbot` CLI takes you from build → flash → run
@@ -36,7 +36,7 @@ from one bot to a thousand.
3636
PyDotBot is available on [PyPi](https://pypi.org/project/pydotbot/), install it with:
3737

3838
```bash
39-
pip install --pre pydotbot
39+
pip install pydotbot
4040
```
4141

4242
Then, check your installation with `dotbot --version` and learn what's possible with `dotbot --help`.
@@ -50,10 +50,11 @@ See the whole thing run with nothing but Python!
5050
The command below will run a simulated swarm, which you can observe in a web UI at http://localhost:8000/PyDotBot/ :
5151

5252
```bash
53-
dotbot run simulator -w
53+
dotbot run simulator
5454
```
5555

56-
Drive the simulated bots from the UI, or run a bundled demo in a
56+
The web UI opens automatically; pass `--headless` to suppress it (it's still
57+
served). Drive the simulated DotBots from the UI, or run a bundled demo in a
5758
second terminal:
5859

5960
```bash
@@ -132,31 +133,31 @@ dotbot swarm flash ~/.dotbot/artifacts/dotbot-firmware-1.22.0rc1/dotbot-sandbox-
132133
Observe and control your swarm from a web interface:
133134

134135
```bash
135-
dotbot run controller -w # will open a webpage at http://localhost:8000/PyDotBot/
136+
dotbot run controller # opens a webpage at http://localhost:8000/PyDotBot/
136137
```
137138

138139
Full walkthrough of fleet operations - status, OTA flash, start/stop, monitor -
139140
is in the [`swarm` reference][swarm-doc].
140141

141142
### Calibrate positions (optional)
142143

143-
Give the bots real-world `(x, y)` with Lighthouse 2 - capture once from any bot
144-
over the air, then push the result to the whole fleet (needs the `[calibrate]`
145-
extra, below):
144+
Give the DotBots real-world `(x, y)` with Lighthouse 2 - capture once from any
145+
DotBot over the air, then push the result to the whole fleet (needs the
146+
`[calibrate]` extra, below):
146147

147148
```bash
148-
dotbot swarm stop # bots must be idle to capture
149+
dotbot swarm stop # DotBots must be idle to capture
149150
dotbot swarm lh2-calibration collect --device <addr> -d 500 # capture + solve + save
150-
dotbot swarm lh2-calibration push ~/.dotbot/calibration-<UTC>.toml # apply to every bot
151+
dotbot swarm lh2-calibration push ~/.dotbot/calibration-<UTC>.toml # apply to every DotBot
151152
```
152153

153-
`-d` is your reference square's side, in mm (one bot's capture calibrates the
154+
`-d` is your reference square's side, in mm (one DotBot's capture calibrates the
154155
whole arena). Full walkthrough - arena sizing and the cabled alternative - is in
155156
the [LH2 calibration guide][lh2-doc].
156157

157158
## Going further
158159

159-
- **Drive a single bot** end to end - build, flash, and control one DotBot:
160+
- **Drive a single DotBot** end to end - build, flash, and control one DotBot:
160161
the [one-bot guide][one-bot-doc].
161162
- **Position tracking with Lighthouse 2** - give the fleet real-world `(x, y)`,
162163
calibrated over the air: the [LH2 calibration guide][lh2-doc] (a cabled
@@ -178,7 +179,7 @@ the [LH2 calibration guide][lh2-doc].
178179
Most of `dotbot` is in the base install; only LH2 calibration needs an extra:
179180

180181
```bash
181-
pip install --pre 'pydotbot[calibrate]' # opencv (the LH2 homography solve)
182+
pip install 'pydotbot[calibrate]' # opencv (the LH2 homography solve)
182183
```
183184

184185
Hitting a snag (e.g. the web UI not loading in Firefox)? See

0 commit comments

Comments
 (0)