CHANGELOG.md

Changelog

All notable changes to this project will be documented in this file. See standard-version for commit guidelines.

9.17.0 (2021-04-17)

Features

• api: add support for enabling location modes (#612) (055e5f0)

9.16.0 (2021-04-09)

Features

• support outdoor smart plug (79b28fb)

Bug Fixes

• update dependencies (9210476)

9.15.6 (2021-04-02)

Bug Fixes

• more reliable port reservation for streams (16d6866)
• update dependencies (e8534da)

9.15.5 (2021-03-19)

Bug Fixes

• homebridge: prevent empty image buffer warnings (1f64c4e), closes #594 #592
• update dependencies (e9d4fe0)

9.15.4 (2021-03-04)

Bug Fixes

• homebridge: less snapshot logging (264fe5d), closes #587
• update dependencies (b27d1a1)

9.15.3 (2021-02-21)

Bug Fixes

• homebridge: avoid logging intentionally hidden accessories (75eb3bc)
• homebridge: store system id on disk to avoid random session id (8662b0c), closes #521
• ignore notYetParticipatingInMode when determining location modes support (de61bc5), closes #565

9.15.2 (2021-02-20)

Bug Fixes

• update dependencies (1964c8f)
• api: allow camera.getEvents() with no options (03fd4e5)
• homebridge: cache snapshot longer for battery cams with avoidSnapshotBatteryDrain (e5a65e8), closes #502

9.15.1 (2021-02-15)

Bug Fixes

• homebridge: use Service.BatteryService instead of Service.Battery (2228a05)

9.15.0 (2021-02-15)

Features

• remove snapshot restrictions for battery cams in wired mode (bc8e2cc), closes #502
• homebridge: show charging status for battery cams (#571) (06fdf1c)

Bug Fixes

• update dependencies (885da2e)

9.14.2 (2021-01-29)

Bug Fixes

• homebridge: allow 0 for locationModePollingSeconds in config-ui (3e63b7a), closes #561
• log wiki link for NGHTTP2_ENHANCE_YOUR_CALM error (d26052a), closes #560
• require specific versions of node lts to avoid http2 errors (18ca92d)
• update dependencies (5e717be)

9.14.1 (2021-01-11)

Bug Fixes

• log an error when opening websocket on node 15 (abe2036), closes #539
• homebridge: log all location ids before fetching devices (b6e0eef), closes #541
• remove keepalive and dns caching in favor of http2 (fcfd2a6), closes #497
• update dependencies (83f0090)

9.14.0 (2021-01-04)

Features

• Flush DNS cache after EHOSTUNREACH (#543) (b71bf33)

Bug Fixes

• lock node versions to 10, 12, and 14 (d000d62)

9.13.0 (2021-01-01)

Features

• api: add camera.setSettings() (0abe39b), closes #525

Bug Fixes

• reset dns cache after ENETUNREACH (c28b368), closes #523
• update dependencies (e2899f1)
• homebridge: increase simultaneous stream limit (6d985c4), closes #518

9.12.8 (2020-12-05)

Bug Fixes

• use systeminformation to get unique hardware id (25d48c3)

9.12.7 (2020-12-03)

Bug Fixes

• prevent camera websocket sessions from blocking api (53d7d61)

9.12.6 (2020-11-22)

Bug Fixes

• dependency bump (fc7e9e7)

9.12.5 (2020-11-20)

Bug Fixes

• stop using http2 as workaround for recent errors (9c5f4eb)

9.12.4 (2020-11-13)

Bug Fixes

• revert socket.io client version (abd6e4a)

9.12.3 (2020-11-13)

9.12.2 (2020-10-31)

Bug Fixes

• homebridge: live stream for more than 30 seconds on most cameras (66b3eb7), closes #479

9.12.1 (2020-10-23)

Bug Fixes

• homebridge: correct audio params if audio isn't supported (c7d4a14), closes #478
• homebridge: use custom ffmpegPath when checking libfdk_aac support (68af136)

9.12.0 (2020-10-17)

Features

• support new media servers with rtp latching (9825974), closes #447

9.11.0 (2020-10-12)

Features

• homebridge: sendDoorbellMotionNotificationsToTv option for tvOS 14 (7e1c315), closes #469
• avoidSnapshotBatteryDrain option (7d1b530), closes #427

9.10.0 (2020-10-01)

Features

• homebridge: option to expose regular cameras as doorbell to show tvOS 14 notifications (114d868)
• homebridge: support tilt sensor (f9ac587)

Bug Fixes

• hard dns cache reset on failure (75dba2f), closes #449

9.9.0 (2020-08-28)

Features

• homebridge: support generic zwave sensors (9e3356d), closes #442

Bug Fixes

• updated camera models (c5031a2)

9.8.2 (2020-08-20)

Bug Fixes

• explicitly enable camera speaker for return audio (1f0a3ed), closes #431
• request SAVPF to force ice candidates (f31f6fa), closes #438

9.8.1 (2020-08-18)

Bug Fixes

• homebridge: allow video-only streams without ffmpeg (2e39797)

9.8.0 (2020-08-16)

Features

• faster and more reliable stream connections using stun (8299ec9)

9.7.3 (2020-08-09)

Bug Fixes

• clearer error message when snapshot fails for battery cams (ac63e05)
• homebridge: respect request for ipv6 address in live stream (a826256)

9.7.2 (2020-08-08)

Bug Fixes

• use default interface for local ip address (bab2d66), closes #424

9.7.1 (2020-08-07)

9.7.0 (2020-08-03)

Features

• additional ring data types (590e1cd)

Bug Fixes

• better logging when live streams are blocked by modes settings (ae809f5), closes #414
• determine host ip without ip module (15d2ace)

9.6.0 (2020-07-12)

Features

• add amazon key locks to device discovery tool (4bbbb02), closes #384
• api: api.disconnect() to unsubscribe current instance (add754f), closes #378

9.5.0 (2020-07-11)

Features

• homebridge: add onlyDeviceTypes option (f9c1c1b), closes #394

Bug Fixes

• handle EREFUSED dns errors (8c33921), closes #397
• log error from auth request (f7caabd)

9.4.1 (2020-07-06)

Bug Fixes

• catch errors from dns query logging (cfd68da), closes #374 #393

9.4.0 (2020-07-04)

Features

• remove life time restrictions on snapshots (0c7f226)
• api: api.getProfile to fetch user profile (6af8874), closes #389

Bug Fixes

• prevent new session from being created on each restart (8c21ca0), closes #389
• api: prevent ding-loop when streaming from onNewDing (#390) (0980b33)

9.3.6 (2020-07-01)

Bug Fixes

• homebridge: clear dns cache after ENOTFOUND (14edaa3), closes #374

9.3.5 (2020-06-29)

Bug Fixes

• homebridge: allow snapshots to be fetched after a failure (84e97d2), closes #383

9.3.4 (2020-06-28)

Bug Fixes

• homebridge: remove 'fetching snapshot' placeholder image (ff39dce)
• homebridge: split rtcp for incoming and return audio (55fbaec)
• log an error if locationIds config is empty (8dfc49a)
• throw error if user has no locations (c988a66), closes #375

9.3.3 (2020-06-21)

Bug Fixes

• add user agent to requests (19ab0e6), closes #373
• homebridge: remove -re flag for return audio (db951a7)

9.3.2 (2020-06-17)

Bug Fixes

• remove dns caching for oauth requests (3cd95e0)

9.3.1 (2020-06-17)

Bug Fixes

• remove keepalive for oauth requests (e37b823)

9.3.0 (2020-06-17)

Features

• homebridge: allow devices to be hidden by id (f28c0ca)

9.2.0 (2020-06-17)

Features

• api: ring chime support (#309) (8870d35)
• api: video search and periodic footage (f71584e)
• homebridge: chime with snooze, play sounds, and volume (3581178)

Bug Fixes

• try for snapshots for 35 seconds (a274d48)
• homebridge: center text for fetching snapshot placeholder (28c2f33)
• improved detection of battery vs wired camera (405423f)

9.1.1 (2020-06-07)

Bug Fixes

• homebridge: cache snapshots for 2 minutes (d671ea8), closes #350

9.1.0 (2020-06-06)

Features

• add doorbell 3 (6017a6c), closes #346
• homebridge: placeholder image if snapshots are unavailable (425454d), closes #318

Bug Fixes

• log full http error in debug mode (f1a3884)

9.0.1 (2020-06-05)

Bug Fixes

• log error message when request fails without response (d22de47)

9.0.0 (2020-06-04)

⚠ BREAKING CHANGES

• homebridge: Night Mode can now be configured as a way to bypass contact sensors for either Home or Away mode. Night Mode previously activated Home mode only. By default, Night Mode will be hidden in HomeKit.
• Night mode is no longer an option for Ring Alarm and Location Modes. Any automations that made use of Night mode will need to use Home mode instead.
• UPnP and NAT-PMP hole punching has been removed in favor of RTP latching. This should lead to a successful live stream, regardless of network configuration, network settings, and NAT type
• ffmpeg is now required for live streams. See https://github.com/dgreif/ring/wiki/FFmpeg for details

Features

• homebridge: configure night mode to bypass contact sensors (24183c4), closes #215
• add support for z-wave thermostats via ring alarm (#331) (3daa1f1)
• more reliable live streams regardless of nat type (09a78c9)
• use random srtp key/value for all live streams (082567a)

Bug Fixes

• homebridge: detect and stop inactive live streams (3a5a007)
• homebridge: set light as primary service for beams (b33233d)
• homebridge: set security system as primary service for alarm (a888bd1)
• remove night mode from alarm and location modes (63ff8a0)

8.2.0 (2020-05-17)

Features

• homebridge: 2-way audio (0bdb154), closes #237

8.1.0 (2020-05-11)

Features

• homebridge: water sensor accessory (569fed7), closes #316

Bug Fixes

• homebridge: cache snapshots to avoid blocking homebridge accessories (eb75a46), closes #311 #293

8.0.1 (2020-05-09)

Bug Fixes

• skip external camera cleanup if cleanupAccessoryData is not available (e80f832), closes #315

8.0.0 (2020-05-03)

Features

• homebridge: clean up persist files from old external cameras (054691c)
• homebridge: explicit error if using cameras without homebridge 1+ (21702da)
• homebridge: bridged cameras and homebridge 1+ (01ac0ec)

Bug Fixes

• homebridge: hide double and long press for doorbell programmable switch (e8be8fb), closes #288

⚠ BREAKING CHANGES

• homebridge: homebridge >=1.0.0 is now required
• homebridge: Cameras are now bridged instead of being created as external accessories in homebridge. Once you update, you will see two copies of each of your cameras. You will need to manually remove the old cameras from HomeKit by going into the cameras settings and choosing "Remove Camera from Home". The new bridged cameras will not have this option, and will instead have a "Bridge" button. You will also need to copy over any automations that you had tied to your cameras, such as motion detection, button presses, and lighting/siren activations. Please note, this change should significantly reduce complexity while setting up homebridge-ring cameras, but will not change live streaming in any way. If you had issues with live streams before, you will continue to have issues with live streams after this update.

7.2.2 (2020-04-05)

7.2.1 (2020-03-07)

Bug Fixes

• homebridge: allow 0 for polling options to disable polling (c89c977), closes #260 #266

7.2.0 (2020-02-26)

Features

• homebridge: use pre-built ffmpeg binary (3911d52), closes #259

Bug Fixes

• homebridge: hide location modes in more scenarios (72d8db4), closes #260

7.1.0 (2020-02-22)

Features

• homebridge: location mode switch (defe995), closes #200

7.0.0 (2020-02-21)

⚠ BREAKING CHANGES

• email/password auth via the api is no longer supported. Ring now requires 2fa or verification codes for all account logins, so refreshTokens are now the only way for the api to authenticate

Features

• homebridge: retrofit alarm zones as contact sensors (a32b6e6), closes #192 #248
• homebridge: temperature sensors (96502cc), closes #227
• custom device name for Control Center in Ring app (46ea3cf), closes #257

Bug Fixes

• log 2fa code rate limiting (64a5b70)
• log wiki link for ffmpeg errors (c453462)
• remove email/password auth from api and homebridge config options (2957416)

6.2.0-alpha.0 (2020-02-04)

Features

• homebridge: retrofit alarm zones as contact sensors (a32b6e6), closes #192 #248
• homebridge: temperature sensors (96502cc), closes #227

Bug Fixes

• log 2fa code rate limiting (64a5b70)
• log wiki link for ffmpeg errors (c453462)

6.1.1 (2020-01-24)

Bug Fixes

• use lower of dual battery values instead of average (3109ff2), closes #206

6.1.0 (2020-01-21)

Features

• handle cameras with two battery slots (0f6b0c5)

6.0.3 (2020-01-18)

Bug Fixes

• better logging for common errors (74b94dc)

6.0.2 (2020-01-17)

6.0.1 (2020-01-17)

Bug Fixes

• remove dotenv/config from cli tools (c3f169e)

6.0.0 (2020-01-17)

⚠ BREAKING CHANGES

• homebridge: Conversion step to change from homebridge-ring-alarm to homebridge-ring has been removed. If you are updating from v2, please first upgrade to version 5.13.1 before upgrading to version 6+
• api: api.getHistory has been removed in favor of location.getCameraEvents
• api: location.getEvents has been replaced with location.getCameraEvents
• api: camera.getHistory has been replaced with camera.getEvents
• api: camera.getRecording has been renamed to camera.getRecordingUrl and takes a second optional param { transcoded: true } instead of true. This allows for additional options if we decide to add any down the road
• Node.js 10+ now required

Features

• ring-device-data-cli for discovering new device types and data structures (de3c23a)

• api: updated history/event methods for locations and cameras (e415605)

• homebridge: remove v3 conversion step to update homebridge plugin name (c6c6057)

• update dependencies (3e9ce7e)

5.13.1 (2020-01-15)

Bug Fixes

• handle delayed and expired dings when starting live video (b6c4460), closes #211 #157 #106
• handle live stream for battery cameras (8c74a23)

5.13.0 (2020-01-11)

Bug Fixes

• automatically subscribe cameras to motion and dings (7bf4260), closes #210
• get or create active ding via new live_view endpoint (4fb837e)

5.13.0-alpha.0 (2020-01-05)

Features

• configurable external port range (a5255f8)

5.12.1 (2020-01-02)

Bug Fixes

• use default gateway when opening live stream port (be2cfe1), closes #191

5.12.0 (2019-12-20)

Features

• api: option to get transcoded recordings (10a85da), closes #204

5.11.0 (2019-12-20)

Bug Fixes

• homebridge: use occupancy sensor for freeze sensors (c488820)

5.11.0-alpha.1 (2019-12-18)

Features

• homebridge: log hidden accessories (ae841fb)

5.11.0-alpha.0 (2019-12-13)

Features

• homebridge: flood/freeze and freeze sensors (5ae4367)

5.10.0 (2019-11-30)

Features

• hideUnsupportedServices option (3c9e456), closes #169 #187

Bug Fixes

• remove overlapping service check except during debug (b7390dc), closes #175 #190

5.9.1 (2019-11-01)

Bug Fixes

• homebridge: prevent overlapping camera switch services (c59623e)

5.9.0 (2019-10-16)

Bug Fixes

• homebridge: change email & password field types in config.schema.json (c065449)

Features

• homebridge: in-home doorbell switch for equipped doorbell cameras (#152) (3537646)

5.8.2 (2019-10-04)

Bug Fixes

• additional logging on auth failure (45ed068)

5.8.1 (2019-10-04)

Bug Fixes

• correctly handle unknown model with battery (d2da0f2)

5.8.0 (2019-10-03)

Features

• add new camera models (b5e3591)
• fallback check for camera battery if unknown model (5910524)
• homebridge: add logging for camera motion/doorbell events (b4af8a0)

5.7.0 (2019-09-17)

Features

• api: location.getAlarmMode() to get current alarm mode (248fccc)

5.6.2 (2019-09-05)

Bug Fixes

• use consistent hardware_id to avoid breaking Ring app session (75f4b4a)

5.6.1 (2019-08-24)

Bug Fixes

• homebridge: keep refreshToken up to date in config.json (6719e4a), closes #109
• remove ffmpeg listeners with node 8 compatible method (96c27ac)

5.6.0 (2019-08-24)

Features

• homebridge: audio in camera streams (22ed836)

5.5.1 (2019-08-10)

Bug Fixes

• homebridge: remove debug code that removes all devices (d4cce8a)

5.5.0 (2019-08-10)

Features

• homebridge: panic buttons for burglar and fire (c87a83a), closes #83

5.4.1 (2019-08-10)

Bug Fixes

• improved snapshot timing for battery cameras (8fabd14)

5.4.0 (2019-08-08)

Bug Fixes

• homebridge: automatically prune unused services (6496aa1)

Features

• homebridge: add support for fans (#94) (15cca9a)

5.3.1 (2019-08-07)

Bug Fixes

• homebridge: handle missing snapshots and offline cameras (adc08f6), closes #92

5.3.0 (2019-08-01)

Features

• homebridge: more detailed logging (6c2021e)

5.2.0 (2019-08-01)

Features

• homebridge: include changelog for homebridge ui (46387a5), closes #86

5.1.0 (2019-08-01)

Features

• homebridge: config schema for homebridge settings ui (56011e3), closes #86

5.0.0 (2019-08-01)

Build System

• conventional github releases (907fc73)

Features

• negotiate port mappings to get through more NAT setups (2f1899b)
• sip streaming api (#88) (a00fe31)

BREAKING CHANGES

• SipSession api has changed and now exposes Observables for RTP packets on audioStream and videoStream

4.5.2 (2019-07-29)

Bug Fixes

• homebridge: add https fallback for getting public ip (916014c), closes #81

4.5.1 (2019-07-29)

Bug Fixes

• homebridge: use correct service for on/off switch (edba85c), closes #75

4.5.0 (2019-07-28)

Features

• homebridge: inform HomeKit of failure to arm if bypass required (e53d317), closes #1

4.4.1 (2019-07-28)

Bug Fixes

• use correct to for sip response to keep stream alive (c205ab2)

4.4.0 (2019-07-27)

Features

• homebridge: add single-level switch (18f817a), closes #75

4.3.2 (2019-07-27)

Bug Fixes

• homebridge: return stale snapshots for battery cameras immediately (2482788), closes #38
• homebridge: use stun as fallback for getting public ip (5f8c3f5)

4.3.1 (2019-07-26)

Bug Fixes

• homebridge: log errors from stream prep (9c268b8)
• homebridge: use random open ports for RTP proxy (f55b1ee)

4.3.0 (2019-07-26)

Features

• live camera streams (229f621), closes #35

4.2.3 (2019-07-22)

Bug Fixes

• revert snapshot resizing (4a024e3), closes #73

4.2.2 (2019-07-21)

4.2.1 (2019-07-17)

Bug Fixes

• handle 401 response for sessions (49b7f38)

4.2.0 (2019-07-16)

Features

• ring-auth-cli for 2fa refresh token (69c6a3e), closes #39

4.1.0 (2019-07-16)

Features

• homebridge: hideCameraSirenSwitch option (12fddbf), closes #66

4.0.7 (2019-07-15)

Bug Fixes

• homebridge: handle charging battery status for base station (d22ccac), closes #65

4.0.6 (2019-07-15)

Bug Fixes

• homebridge: correct charging and battery level for base station (e7beb8b), closes #65

4.0.5 (2019-07-15)

Bug Fixes

• better snapshot waiting logic (9e97fec), closes #64

4.0.4 (2019-07-15)

Bug Fixes

• avoid creating new sessions unless necessary (7b76147)

4.0.3 (2019-07-14)

Bug Fixes

• homebridge: assume slow snapshots for all battery camera models (9f4b9d1)

4.0.2 (2019-07-12)

Bug Fixes

• expect slow snapshots for Door View Cam (2bed6aa), closes #56

Build System

• deps: bump lodash from 4.17.11 to 4.17.14 (42f654f)
• deps: bump lodash.template from 4.4.0 to 4.5.0 (199b346)

4.0.1 (2019-07-12)

Bug Fixes

• update dependencies to remove lodash vulnerability (fb88070)

4.0.0 (2019-07-12)

Bug Fixes

• match ring app 2fa headers (237e651)
• match ring app polling delay for dings (b567be7)

Features

• rename npm modules to match functionality (8e7c387)

BREAKING CHANGES

• homebridge-ring-alarm renamed to homebridge-ring. The config for homebridge should now be "platform": "Ring" instead of "platform": "RingAlarm". This config change will happen automatically the first time you start homebridge with the new version, but it will cause homebridge to error out after the config is changed. You will see a log that the config has changed and you can restart homebridge.
• @dgreif/ring-alarm renamed to ring-client-api. The exported class is now RingApi instead of RingAlarmApi. Proper usage now looks like import { RingApi } from "ring-client-api".

3.9.0 (2019-07-07)

Features

• 2fa support (8e3cb7f), closes #26 #39
• refresh tokens (4e78cb5)

3.8.1 (2019-07-05)

Bug Fixes

• homebridge: correctly remove existing services based on hide config (50b9937)

3.8.0 (2019-07-05)

Features

• homebridge: hideCameraMotionSensor option (94735cf), closes #54

3.7.2 (2019-07-05)

Bug Fixes

• identify authorized_doorbots as doorbell cameras (1fd8f03)

3.7.1 (2019-07-03)

Bug Fixes

• homebridge: allow stale snapshots for doorbell_v3 cameras (66f5fe4)