hov3rcraft / homebridge-eufy-robovac

Homebridge plugin for Eufy RoboVac
MIT License
9 stars 0 forks source link

homebridge-eufy-robovac

Homebridge plugin for Eufy RoboVac

About this Fork

A full rewrite of apexad/homebridge-eufy-robovac to

Features

Get Device ID & Local Key

To access your RoboVac, you need both the deviceId/localKey. To get the deviceId/localKey use the eufy-clean-local-key-grabber repository. In the README of that project it says they are not sure if it still works, but I can confirm that it still works as of August 2024.

Configuration

This easiest way to use this plugin is to use homebridge-config-ui-x.
To configure manually, add to the platform section of homebridge's config.json after installing the plugin.

Command: npm install -g @hov3rcraft/homebridge-eufy-robovac

Config:

    {
      "devices": [
        {
          "name": "<deviceName, required>",
          "deviceId": "<deviceId, required>",
          "localKey": "<localKey, required>",
          "deviceIp": "<deviceIp, defaults to undefined>",
          "useSwitchService": "<true | false, defaults to false>",
          "findButtonEnabled": "<true | false, defaults to true>",
          "batteryInformationEnabled": "<true | false, defaults to true>",
          "errorSensorEnabled": "<true | false, defaults to true>"
        }
      ],
      "debugLog": "<true | false, defaults to false>",
      "platform": "EufyRobovac"
    }

You can add multiple RoboVacs under devices.

Thank You

Development

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