mirrors
/
Valetudo
mirror of https://github.com/Hypfer/Valetudo.git
0
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
Cloud replacement for vacuum robots enabling local-only operation
2,195 Commits 3 Branches 67 Tags 221 MiB
JavaScript 66.1%
TypeScript 32.6%
Kaitai Struct 0.8%
HTML 0.3%
CSS 0.2%
Go to file
Sören Beye c19f9c2812 docs: Media & Content Creators 2024-11-17 13:01:33 +01:00
.github chore: Update PR template 2024-08-26 12:28:05 +02:00
assets docs: Misc Update 2024-11-09 07:57:07 +01:00
backend feat(mqtt): Optionally expose PetObstacleAvoidance, CarpetModeControl and CarpetSensorModeControl capabilities 2024-11-16 16:34:52 +01:00
build_dependencies/pkg/v3.5 chore(build): Bump to NodeJS v20.10.0 2023-12-06 18:28:51 +01:00
docs docs: Media & Content Creators 2024-11-17 13:01:33 +01:00
frontend feat(ui): Trim host field inputs 2024-11-16 16:40:49 +01:00
util feat(mqtt): Publish Dock Status to MQTT 2024-11-16 15:57:57 +01:00
.automated_overrides.eslintrc.json chore: Minor misc cleanups 2022-07-24 09:17:29 +02:00
.eslintrc.json chore: Bump dependencies 2024-09-23 19:21:02 +02:00
.gitignore refactor: Bake-in specifically crafted build_metadata file instead of random other files 2024-11-01 09:05:15 +01:00
.npmrc chore: Bump dependencies 2022-05-22 18:03:11 +02:00
.pedantic_overrides.eslintrc.json chore: Minor misc cleanups 2022-07-24 09:17:29 +02:00
CONTRIBUTING.md docs: Misc 2024-01-06 10:49:31 +01:00
LICENSE chore: Update license 2021-09-23 19:28:33 +02:00
README.md docs: Misc update 2024-08-06 17:31:10 +02:00
package-lock.json chore(release): 2024.11.0 2024-11-09 07:58:15 +01:00
package.json chore(release): 2024.11.0 2024-11-09 07:58:15 +01:00

README.md

valetudo

Free your vacuum from the cloud

Valetudo is a cloud replacement for vacuum robots enabling local-only operation. It is not a custom firmware.
Here's a diagram illustrating the core operation principle:

Because Valetudo is not a custom firmware, it cannot change anything about how the robot operates.
What it can do however is protect your data and enable you to connect your robot to your home automation system without having to detour through a vendor cloud, which, apart from the whole data problematic, might not be reachable due to your internet connection being down or some servers in the datacenter being on fire.

Not having to leave your local network of course also benefits the latency of commands, status reports etc.

Valetudo aims to be proof that easy to use and reliable smart appliances are possible without any cloud and/or account requirements. Maybe at some point it might help convince vendors that there is another way of doing things.

By default, Valetudo provides control over your vacuum robot via a responsive webinterface that works on all of your devices. It can be used on phones, tablets as well as your desktop computer.

Furthermore, there's a REST-interface documented with Swagger UI as well as MQTT. With support for both Homie and Home Assistant Autodiscovery for MQTT, you should be able to connect Valetudo to the open-source smarthome software of your choice.

For more information, check out the newcomer guide, the getting started guide and also the docs in general at https://valetudo.cloud

There, you will find a list of supported robots.

Screenshots

Phone/Mobile

Tablet/Desktop

image

image

image

image

Further questions?

Valetudo Telegram group

Contributing

Make sure to familiarize yourself with the ./CONTRIBUTING.md

Honourable mentions

Valetudo and its companion applications are developed using JetBrains IDEs such as WebStorm. Licenses for those have been provided for free by JetBrains to the project in context of their open source support program since multiple years now.

Thanks a lot for that!