MIROBO(1)

📦
version 0.5.12 · 5 versions
, in debian trixie, ubuntu questing

💖 MIROBO 💖

okay bestie, so mirobo is the manual page for — drumroll please — a tool to command Xiaomi Vacuum robot. yes. your little floor-sweeping bestie can be bossed around from the terminal and honestly? iconic. 👑

✨ SYNOPSIS ✨

mirobo [OPTIONS] COMMAND [ARGS]...

like. that's it. that's the whole shape of it. options first, then a command, then whatever args that command wants. periodt.

🌸 DESCRIPTION 🌸

A tool to command Xiaomi Vacuum robot. 🧹💫

that's the vibe. you talk, it vacuums, everybody wins.

🎀 OPTIONS 🎀

  • --ip TEXT — hand over the robot's IP as text, bestie.
  • --token TEXT — and here's the token, also text. 🔑
  • -d, --debug — turn on debug mode so you can see what's actually going on under the hood. ngl, lowkey essential when things get weird. 👀
  • --id-file FILE — point it at a FILE for the id. yes, a file. a whole file. slay.
  • --version — Show the version and exit. quick lil peek, then she's gone. 💅
  • --help — Show this message and exit. the classic. the moment. the legend. ✨

🦋 COMMANDS 🦋

okay this is the good part. look at this list. LOOK at it. every single one is here, no skips, no cuts:

  • carpet-cleaning-mode — Query or set the carpet cleaning/avoidance mode. 🧶
  • carpet-mode — Query or set the carpet mode.
  • cleaning-history — Query the cleaning history. receipts!! 🧾
  • configure-wifi — Configure the wifi settings. 📶
  • consumables — Return consumables status. (the brushes, the filters, the lil guys that wear out 😭)
  • discover — Search for robots in the network. where u at bestie 🔍
  • dnd — Query and adjust do-not-disturb mode. do not perceive me 😴
  • fanspeed — Query and adjust the fan speed. 🌬️
  • find — Find the robot. it's under the couch. it's always under the couch.
  • goto — Go to specific target. 📍
  • home — Return home. 🏠
  • info — Return device information.
  • install-sound — Install a sound. 🔊
  • manual — Control the robot manually. take the wheel, main character 🎮
  • map — Return the map token.
  • pause — Pause cleaning. she's taking a lil break 🫶
  • raw-command — Run a raw command. no filter, no chill, just raw. 💀
  • reset-consumable — Reset consumable state.
  • serial-number — Query serial number.
  • sound — Query and change sound settings.
  • spot — Start spot cleaning. little circle, big energy ⭕
  • start — Start cleaning. GO GO GO 🔥
  • status — Returns the state information. vibe check fr fr
  • stop — Stop cleaning. ✋
  • timer — List and modify existing timers. ⏰
  • timezone — Query or set the timezone. 🌍
  • update-firmware — Update device firmware. glow up time ⭐
  • update-status — Return update state and progress.
  • zoned-clean — Clean zone. 🗺️

and that's the whole page, bestie. every flag, every command, every lil description — nothing dropped, nothing invented, all facts intact. 💜

this was mirobo 0.5.12, dated December 2024. 🎀 thanks for reading, ily, go vacuum something. ✨🧹💖

📦 where this page comes from