https://github.com/rand256/valetudo
Valetudo RE - experimental vacuum software, cloud free
https://github.com/rand256/valetudo
Last synced: about 1 month ago
JSON representation
Valetudo RE - experimental vacuum software, cloud free
- Host: GitHub
- URL: https://github.com/rand256/valetudo
- Owner: rand256
- License: apache-2.0
- Created: 2019-05-25T15:43:19.000Z (almost 6 years ago)
- Default Branch: testing
- Last Pushed: 2023-09-19T18:34:05.000Z (over 1 year ago)
- Last Synced: 2024-11-01T17:36:52.230Z (6 months ago)
- Language: JavaScript
- Homepage:
- Size: 7 MB
- Stars: 670
- Watchers: 27
- Forks: 74
- Open Issues: 36
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
Free your vacuum from the cloud
Fully supported devices: Roborock S5 and Xiaomi Mi Robot Vacuum Cleaner (v1)
Preliminary supported devices: Roborock S6 and other III-generation Roborock vacuums
----
### Preamble:
This is a fork of [Valetudo by Hypfer](https://github.com/Hypfer/Valetudo), created by me since I found too many features missing in the original package when I've tried to use it for the first time.
Features added lately:
* Preliminary support for Roborock gen3 devices;
* MQTT: Tracking the time when the dustbin was last emptied or for how long it was in use;
* MQTT: Possibility of playing sound files on the device by issuing a mqtt command;
* Optional ability to see a live map on the Remote Control tab;
And this is a quick list of features first appeared here:
* Ability to select multiple saved zones at once;
* Selected zones optionally shown at the map tab to see and edit what's actually going to be cleaned;
* Configurable virtual walls and forbidden zones (requires Gen2);
* Ability to see the actual map of cleanings that were finished recently;
* Scheduled zoned cleaning - when you do not need to clean the whole house;
* Scheduled rooms cleaning - the same thing for newer firmware of Gen2;
* Ability to specify the number of iterations to clean the same zone multiple times;
* Display device's status on the map, as well as a set of quick action buttons that are dynamically switching at state changes;
* Multilanguage support, currently available in bg/ca/cz/de/en/es/fi/fr/hu/it/lv/nl/ru/sv/pl;
* A telegram bot software for controlling the vacuum from the outside world;
* Experimental ability to SAVE and RESTORE the main map (with per-map list of saved zones and spots);
* Full support of room cleaning (requires Gen2 with firmware 2008+);
* Cleaning queue, allowing the use of zoned cleaning with more than 5 zones via enqueuing any number of additional cleanups at once;
* Possibility to enqueue additional zones and segments during cleaning or additional goto spots during the movement;
* Ability to run Goto + Spot cleaning (by long pressing "Goto" button on the map tab);
* Selecting the destination for the device to go when the cleaning is finished (configured globally in settings or per-cleaning by long pressing "Start" button on the map tab);
* Visual preview and edit of zones and rooms for corresponding scheduled cleaning.
You can add or improve your own native language support by using ./client/locales/en.json template as an example and sending a PR.
----
### Installing
Check [deployment section](/deployment) or [this wiki page](https://github.com/rand256/valetudo/wiki/Installation-process) on how to install Valetudo onto your device.
### Screenshots of this mod:
View screenshots
----
----
----
### Getting map picture for integrations
* [valetudo-mapper](https://github.com/rand256/valetudo-mapper) - a companion service for generating PNG maps;
* You can also try to request a simple map from Valetudo RE itself via http at `/api/simple_map`, but it shouldn't be called too often since resources of the vacuum are limited.