https://github.com/hypfer/valetudo

Cloud replacement for vacuum robots enabling local-only operation
https://github.com/hypfer/valetudo

cloud-free dreame roborock robot-vacuum smarthome valetudo xiaomi

Last synced: 5 days ago
JSON representation

Cloud replacement for vacuum robots enabling local-only operation

• Host: GitHub
• URL: https://github.com/hypfer/valetudo
• Owner: Hypfer
• License: apache-2.0
• Created: 2018-07-12T07:07:43.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2024-12-08T15:39:58.000Z (14 days ago)
• Last Synced: 2024-12-08T16:28:10.230Z (14 days ago)
• Topics: cloud-free, dreame, roborock, robot-vacuum, smarthome, valetudo, xiaomi
• Language: JavaScript
• Homepage: https://valetudo.cloud
• Size: 216 MB
• Stars: 6,794
• Watchers: 98
• Forks: 397
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        


    

    


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:

[](https://github.com/Hypfer/valetudo/raw/master/docs/_pages/general/img/operation_principle.png)

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](https://valetudo.cloud/pages/general/newcomer-guide.html),

the [getting started guide](https://valetudo.cloud/pages/general/getting-started.html) 

and also the docs in general at [https://valetudo.cloud](https://valetudo.cloud)

There, you will find a list of [supported robots](https://valetudo.cloud/pages/general/supported-robots.html).

## Screenshots

### Phone/Mobile

 

 

### Tablet/Desktop

![image](https://github.com/user-attachments/assets/dc18723f-b15f-4500-907b-bad6d7dd1a4f)

![image](https://user-images.githubusercontent.com/974410/211155836-9199616a-efde-4238-91c4-24158ba67677.png)

![image](https://user-images.githubusercontent.com/974410/211155860-9926b126-d1fe-41b1-8c83-1af21bf8caf2.png)

![image](https://user-images.githubusercontent.com/974410/211155880-ff184776-86fe-4c2f-9556-4d556cfa12f4.png)

## Further questions?

[Valetudo Telegram group](https://t.me/+k-ukcsX2ZYg5MDky)

## Contributing

Make sure to familiarize yourself with the [./CONTRIBUTING.md](./CONTRIBUTING.md)

## Honourable mentions

Valetudo and its companion applications are developed using JetBrains IDEs such as [WebStorm](https://www.jetbrains.com/webstorm/).

Licenses for those have been provided for free by JetBrains to the project in context of [their open source support program](https://jb.gg/OpenSourceSupport) since multiple years now.

Thanks a lot for that!