Installation and Configuration - homebridge-plugins/homebridge-eufy-security GitHub Wiki

Installation and Configuration

1. Prerequisites

  • Homebridge: Version >=1.9.0. Install from homebridge.io.
  • Homebridge UI: Highly recommended. Mandatory if you have 2FA enabled on your Eufy account.
  • Node.js: Version 20, 22, or 24. See Node.js Compatibility for streaming-compatible versions.
  • Dedicated Admin Account: You must create a separate Eufy account for the plugin (see below).

2. Create a Dedicated Admin Account

Using the same account for both the Eufy App and the plugin can cause unexpected issues (concurrent session conflicts). Create a dedicated admin account before installing.

Note: In the eufySecurity app (v4.0+), there are two methods to share access: Share Home and Share Device. For certain devices, you can also share directly from the product settings page.

Step-by-Step

  1. Create a New Account

  2. Invite the New Account

    • Log in with your main account.
    • Choose one of these methods:
      • Share Home: Side Menu > Share Management > Share Home > Invite > Enter the new email address
      • Share Device: Side Menu > Share Management > Share Device > Invite > Choose Admin > Select devices > Enter the new email address
  3. Assign Admin Rights

    • You must grant the new account admin rights, not guest rights. Guest rights will cause errors.
  4. Accept the Invitation

    • The plugin automatically accepts invitation requests. The new account is ready to use.

Important Notes

  • Shared Account Limit: Eufy allows up to 5 shared accounts. Only the primary account can share access.
  • Invitation Issues: If the invited account only receives an email but no in-app notification, contact Eufy support. Ensure 2FA is turned off for the shared account during setup.
  • Region Matching: Both accounts must be in the same login environment. Check: App > Side Menu > Settings > Region.
  • No spaces in email: Ensure there are no leading/trailing spaces when entering the email address.

3. Installation

Via Homebridge UI

  1. Navigate to the 'Plugins' page.
  2. Search for homebridge-eufy-security or @homebridge-plugins/homebridge-eufy-security.
  3. Click 'Install'.

Manual Installation

sudo npm i @homebridge-plugins/homebridge-eufy-security -g

4. Configuration

First Setup / Login

After installation, a configuration popup will automatically appear. If it does not, go to the 'Plugins' page and click 'Settings' on the plugin tile.

Enter your eufy credentials for the dedicated admin account you created above. It is important to choose the same country that you have set up in your eufy account.

Login Screen

If you have enabled 2FA, the config UI will guide you through the process. After successfully logging in, you should see an overview of the eufy devices connected to your account.

Device Overview

Plugin Settings

Plugin Settings

Here you can change settings for the overall behaviour of the plugin, download log files, or clear stored data. See Reset/Clear for more information.

Device Settings

Click on any device icon to edit its settings. The available settings depend on the device type.

Tips to get started:

  • New cameras default to motion sensor only mode. You must enable camera mode in the device settings. (Doorbells are always cameras by default.)
  • Audio is not enabled by default.
  • Consider unbridging devices where available — this improves stability. See Bridged and Unbridged Mode.
  • Low-end hardware (Raspberry Pi) may struggle with simultaneous streaming, snapshots, and HKSV recording.
  • Some devices appear multiple times in the overview because they act as both camera and station.

For streaming settings, see Streaming. For HKSV, see HomeKit Secure Video.

5. Eufy App Settings

Although the plugin handles a lot of functionality, some settings can only be configured in the official Eufy app:

  • Stream quality: The input stream quality affects what the plugin receives for encoding. See Streaming.
  • Push notifications: Required for real-time device updates (motion events, sensor status). See Common Issues.
  • Motion detection sensitivity and zones

6. Supported Devices

This plugin depends on the eufy-security-client library. We convert device capabilities to HomeKit as closely as possible, but some features may not yet be available through the underlying library.

Supported devices list: eufy-security-client Supported Devices

7. Manual Configuration (advanced)

If 2FA is enabled or there is a CAPTCHA request during login, you must use the Homebridge UI configuration screen. Manual JSON config cannot handle 2FA/CAPTCHA.

Required Settings

{
  "platform": "EufySecurity",
  "username": "[email protected]",
  "password": "your-password"
}
  • The "platform": "EufySecurity" value must not be changed.
  • We recommend enabling 2FA on the dedicated account.

Optional Settings

Setting Type Default Description
pollingIntervalMinutes number 10 How often (in minutes) the plugin refreshes device data from the eufy cloud. Normal updates come through push notifications.
CameraMaxLivestreamDuration number 30 How long (in seconds) before a livestream is automatically ended.
enableDetailedLogging boolean false Enable debug messages in the log output. See Troubleshooting.
ignoreStations array [] Serial numbers of stations to exclude from HomeKit.
ignoreDevices array [] Serial numbers of devices to exclude from HomeKit.
hkHome number 1 HomeKit Home mode → Eufy guard mode mapping.
hkAway number 0 HomeKit Away mode → Eufy guard mode mapping.
hkNight number 3 HomeKit Night mode → Eufy guard mode mapping.
hkOff number 63 HomeKit Off mode → Eufy guard mode mapping.
country string US Your Eufy account country. Must match what you set in the Eufy app.

Guard Mode Mapping Values

Value Eufy Mode
0 Away
1 Home
2 Schedule
3 Night / Custom 1
4 Custom 2
5 Custom 3
6 Off
63 Disarmed

Full Example

{
    "platform": "EufySecurity",
    "username": "[email protected]",
    "password": "your-password",
    "pollingIntervalMinutes": 30,
    "hkHome": 1,
    "hkAway": 0,
    "hkNight": 3,
    "hkOff": 63,
    "enableDetailedLogging": false,
    "ignoreStations": [],
    "ignoreDevices": [],
    "country": "US",
    "CameraMaxLivestreamDuration": 30
}

8. Restart

Restart Homebridge after completing the configuration. Your supported Eufy Security devices should now appear in HomeKit.

⚠️ **GitHub.com Fallback** ⚠️