vacuum-music is a pair of scripts that enable your vacuum robot to play music! All you have to do is pick the right song!
There exist two scripts:
play-music
runs on your robot and acts as a middleman between it and your computer, allowing you to stream music.send-music
runs on your PC and spins up a temporary web server, which provides the music files.
The main script is written in Bash, thus only GNU/Linux (and probably WSL) is supported. It would require a complete rewrite for cross-platform support to be added.
Before using the scripts, make sure that your vacuum robot is reachable via SSH on the default port (22), the SSH keys on your computer are stored in ~/.ssh and you are able to connect without specifying a login password.
Then, proceed to install the following packages from your distribution's repositories:
NOTE: It is recommended that you install all the packages listed below.
Package name | Features gained | Required |
---|---|---|
ffmpeg | Track import | ✔️ |
python3 | Web server | ✔️ |
git | Persistent settings | ❌ |
yt-dlp | Online music downloading | ❌ |
Finally, clone this repository and run the script:
$ git clone https://github.com/lefterisgar/vacuum-music ~/vacuum-music
$ cd ~/vacuum-music && ./send-music.sh
-i, --import |
Launch the track import wizard |
-s, --sort |
Reorder tracks |