Giter VIP home page Giter VIP logo

ha-vacuum's Introduction

Vacuum Homeassistant Integration with Google Assistant for Roborock Robots

This project allows to integrate basic features of a Roborock vacuum into Homeassistant via Google Home.

Roborock is really bad at providing an open API. They only provide Alexa and Google Home integration.

There are, however, options to extract authorization keys from Xiaomi's home app but this usually ends in not being able to use the robot in the Roborock app anymore.

The approach of this project takes another angle. Instead of communicating with the robot directly, we use Google Home as a middle man. We send commands, that you would normally send via voice, by text to the Google Home API endpoint and interpret the result. The results are mapped to Home Assistants vacuum mqtt integration Home Assistant Vacuum State Configuration.

Tested Robots

  • Roborock S6 MaxV

Supported Features

  • Cleaning
  • Selective room cleaning
  • Pausing/Stopping cleaning
  • Send to charger
  • Robot state (cleaning, idle, docked, returning)
  • Locating (robot say's hi)

Unsupported features

  • Map cannot be shown in HA
  • Battery state is not available
  • Fan speed adjustment

Installation

Get Google credentials

First we have to get credentials to authenticate towards our Google account's Google Home

Set up virtual environment

We now build a virtual environment with all dependencies using python's venv module.

python3 -m venv .venv

We need to load the virtual env

source .venv/bin/activate

Now we can install the dependencies into the virutal environment using pip.

pip install -r requirements.txt

Run the integration

Now we can run the service.

python ha-vacuum.py

If everything is correctly set up, Home Assistant should automatically show the robot as a vacuum and a list of rooms to clean. Home Assistant Integration

TODO

  • Fix documentation, there is details missing how to configure the service
  • Add parameters to the docker container
  • Add documentation how to use the docker version

ha-vacuum's People

Contributors

peteh avatar

Stargazers

Michel van de Wetering avatar

Watchers

Michel van de Wetering avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.