UlTriX / homebridge-eufy-robovac

Homebridge plugin for Eufy RoboVac

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

homebridge-eufy-robovac

Homebridge plugin for Eufy RoboVac

Features

  • Switch on / off. When off, it will returning to charging dock automatically.

  • Display battery level, and notify on low battery.

  • Display battery charging state.

  • Find robot

Installation

  1. Install required packages.

    npm install -g homebridge-eufy-robovac
    
  2. Add these values to config.json.

      "accessories": [
        {
          "accessory": "Eufy RoboVac",
          "name": "Vacuum Cleaner",
          "ip": "<optional ip address, this or deviceId must be set>",
          "deviceId": "<optional deviceId, this or ip must be set>",
          "localKey": "<localKey>"
        }
      ]
    

    You can find out more about the deviceId/localKey here

  3. Restart Homebridge, and your Eufy RoboVac will be added to Home app.

Thank You

  • mitchellrj - Did most of the legwork in figuring out how to talk to the Eufy
  • seikan - Provided a great example for how to expose a vacuum cleaner in homebridge/homekit

Development

This plugin is written in TypeScript. You should just need to run npm run build after making changes in the src/ directory.

Also this plugin is dependant on eufy-robovac so you will probably want to fork that repo as well.

About

Homebridge plugin for Eufy RoboVac

License:MIT License


Languages

Language:TypeScript 92.5%Language:JavaScript 7.5%