Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

homebridge-arlo-v2

wo-d219ISC2.1.12TypeScript support: included

Arlo plugin for homebridge

homebridge-plugin, arlo, homebridge

readme

Homebridge-Arlo

CircleCI

Homebridge plugin for Arlo. Includes email MFA support. Please read the underlying library arlo-api's README for information about configuring MFA correctly.

Feel free to fork or make pull requests with additional features.

Caveats

  • Library only supports Doorbell events.
  • Extremely nascent implementation. There may be unrecoverable states which require restart.
    • When a login occurs to Arlo they close any other open connection. This poses a problem as the underlying library must maintain a connection to listen for events.

Installation

This varies by homebridge installation and gui.

Development

Debugging

Install homebridge locally to development machine.

Update homebridge configuration file. Default location in Windows C:\Users\{username}\.homebridge\config.json

{
  "bridge": {
    "name": "test bridge",
    "username": "AA:AA:AA:AA:AA:AA",
    "port": 51826,
    "pin": "111-11-111"
  },
  "platforms": [
    {
      "name": "Config",
      "port": 8581,
      "auth": "form",
      "theme": "auto",
      "tempUnits": "c",
      "lang": "auto",
      "log": {
        "method": "file",
        "path": "C:\\Users\\{username}\\.homebridge\\homebridge.log"
      },
      "platform": "config"
    },
    {
      "arloUser": "user",
      "arloPassword": "pw",
      "emailUser": "email@gmail.com",
      "emailPassword": "pw",
      "emailServer": "imap.gmail.com",
      "emailImapPort": 993,
      "debug": true,
      "enableRetry": true,
      "retryInterval": 5,
      "platform": "Arlo v2"
    }
  ],
  "accessories": []
}

Included is a VSCode launch profile for debugging the plugin. Courtesy of jeff-winn. Attach some breakpoints and run the Launch profile.

changelog

Change Log

All notable changes to this project will be documented in this file. This project uses Semantic Versioning.

v2.1.0 (2020-06-16)

Changes

  • Add Streaming Options to config.schema.json.
  • Enhanced Camera Streaming. Camera Streaming still not working as expected though.

v2.0.1 (2020-06-12)

Changes

  • Fixed config.schema.json not working.

v2.0.0 (2020-06-12)

Breaking Changes

  • Updating plugin version to remove Update Available.

Other Changes

  • Add option to disable cameras.
  • Fix config.schema.json config type.

v1.1.0 (2020-06-12)

Changes

  • Added easy config for Config UI X.

v1.0.0 (2020-06-12)

Breaking Changes

  • Homebridge dependency has changed to v1.0.0 or greater.