@rfnovo/iobroker.eusec v0.8.6

ioBroker.euSec

Tests: Windows:

This is an ioBroker adapter that uses the eufy-security-client library to comunicate with Eufy devices.

If you appreciate my work and progress and want to support me, you can do it here:

This project is not affiliated with Anker and Eufy (Eufy Security). It is a personal project that is maintained in spare time.

Description

This adapter allows to control Eufy security devices by connecting to the Eufy cloud servers and local/remote stations.

You need to provide your Cloud login credentials. The adapter connects to your cloud account and polls for all device data via HTTPS. Now a local or remote P2P connection to the Eufy stations/devices is also supported. However, a connection to the Eufy Cloud is always a prerequisite.

One Adapter instance will show all devices from one Eufy Cloud account and allows to control them.

Features

• Supports local and remote p2p connection to station
• Two factor authentication
• Livestream as HLS stream (supports all platforms, but introduce a latency)
• Last HLS live stream is always saved for later viewing
• Downloads event video when push notification is received (async)
• Takes jpeg thumbnail of the livestream or downloaded video
• Base station:
  • States:
    • Configured Guard mode
    • Current Guard mode
    • Name
    • Model
    • Serial number
    • Software version
    • Hardware version
    • MAC address
    • LAN ip address
  • Actions:
    • Change guard mode
    • Trigger alarm sound
    • Reset alarm sound
    • Reboot station
  • Events:
    • Alarm mode change
• Camera:
  • States:
    • Online / offline etc.
    • Battery %
    • Battery temperature
    • Name
    • Model
    • Serial number
    • Software version
    • Hardware version
    • MAC address
    • Wifi RSSI
    • Filtered false events since last charge
    • Saved/Recorded events since last charge
    • Total events since last charge
    • Used days since last charge
    • And lot's more...
  • Actions:
    • Start livestream (hls; supports also local livestream)
    • Stop livestream (hls)
    • Enable/disable device
    • Enable/disable auto night vision
    • Enable/disable led (only camera 2 products, indoor cameras, floodlight camera, solo cameras and doorbells)
    • Enable/disable anti-theft detection (only camera 2 products)
    • Enable/disable motion detection
    • Enable/disable pet detection (only indoor cameras)
    • Enable/disable sound detection (only indoor cameras)
    • Enable/disable RTSP stream (only camera2 products, indoor cameras and solo cameras)
    • Change video watermark setting
    • And lot's more...
  • Events:
    • Motion detected
    • Person detected
    • Ringing (only Doorbell)
    • Crying detected (only Indoor cameras)
    • Sound detected (only Indoor cameras)
    • Pet detected (only Indoor cameras)
• Sensor:
  • Entry sensor:
    • States:
      • Online / offline etc.
      • Low battery
      • Name
      • Model
      • Serial number
      • Software version
      • Hardware version
    • Events:
      • Open / closed
  • Motion sensor:
    • States:
      • Online / offline etc.
      • Low battery
      • Name
      • Model
      • Serial number
      • Software version
      • Hardware version
    • Events:
      • Motion detected
• Keypad:
  • States:
    • Online / offline etc.
    • Low battery
    • Name
    • Model
    • Serial number
    • Software version
    • Hardware version
• Lock:
  • States:
    • Online / offline etc.
    • Battery %
    • Lock status
    • Name
    • Model
    • Serial number
    • Software version
    • Hardware version
    • Wifi RSSI
  • Actions:
    • Lock/unlock
• more to come...

Documentation

Look here

Known working devices

Information about supported devices can be found here.

How to report issues and feature requests

Please use GitHub issues for this.

Best is to set the adapter to Debug log mode (see here). Then please get the logfile from disk (subdirectory "log" in ioBroker installation directory and not from Admin because Admin cuts the lines).

Changelog

0.8.5 (2022-02-12)

• (bropat) Fixed issue #222
• (bropat) Updated version of the package eufy-security-client (1.6.6)
• (bropat) Further details can be found in the changelog of eufy-security-client (1.6.6)

0.8.4 (2022-02-08)

• (bropat) Fixed regression in authentication flow
• (bropat) Fixed issue #228
• (bropat) Updated version of the package eufy-security-client (1.6.5)
• (bropat) Further details can be found in the changelog of eufy-security-client (1.6.5)

0.8.3 (2022-02-07)

• (bropat) Updated version of the package eufy-security-client (1.6.4)
• (bropat) Further details can be found in the changelog of eufy-security-client (1.6.4)
• (bropat) Fixed issue #222
• (bropat) Fixed issue #224
• (bropat) Fixed issue #225

Note: Selecting the correct country in ioBroker is essential for the devices to be found (should match the setting in the Eufy app).

0.8.2 (2022-02-06)

• (bropat) Renamed Adapter to ioBroker.euSec
• (bropat) Updated version of the package eufy-security-client (1.6.3)
• (bropat) Further details can be found in the changelog of eufy-security-client (1.6.3)
• (bropat) Fixed issue #221

0.8.1 (2022-02-05)

• (bropat) Fixed MQTT connection issue (error: 5; #219)
• (bropat) Updated version of the package eufy-security-client (1.6.2)
• (bropat) Further details can be found in the changelog of eufy-security-client (1.6.2)

0.8.0 (2022-02-05)

• (bropat) Added support for Smart Lock Touch & Wifi (T8520; #138)
• (bropat) Added option to enable/disable "Automatically download video" (#180; #203)
• (bropat) Added new state to retrieve received captcha in HTML format "received_captcha_html" (#210)
• (bropat) Updated version of the package eufy-security-client (1.6.1)
• (bropat) Further details can be found in the changelog of eufy-security-client (1.6.1)
• (bropat) Updated versions of the package dependencies
• (bropat) Fixed issue #199
• (bropat) Fixed issue #217
• (bropat) Some other small bugfixes

0.7.5 (2021-12-05)

• (bropat) Fixed issue #195
• (bropat) Fixed issue #202

0.7.4 (2021-11-22)

• (bropat) Implemented captcha authentication mechanism (API v2)
• (bropat) Updated version of the package eufy-security-client (1.4.0)

0.7.3 (2021-11-20)

• (bropat) Implemented new encrypted authentication mechanism (API v2)
• (bropat) Dropped old plaintext authentication mechanism (API v1)
• (bropat) Fixed issue #191
• (bropat) Updated version of the package eufy-security-client (1.3.0)

Note: If you have 2FA enabled, you will need to authenticate again after this update.

0.7.2 (2021-11-16)

• (bropat) Updated version of the package eufy-security-client (1.2.3)
• (bropat) Further details can be found in the changelog of eufy-security-client (1.2.3)
• (bropat) Changed ioBroker.admin dependency to ">=4.0.10"
• (bropat) Updated versions of the package dependencies

0.7.1 (2021-10-23)

• (bropat) Updated version of the package eufy-security-client (1.2.1)
• (bropat) Further details can be found in the changelog of eufy-security-client (1.2.1)

0.7.0 (2021-10-17)

• (bropat) Added support for Floodlight T8422
• (bropat) Added support for SoloCam E40 (T8131)
• (bropat) Added new properties for solo cameras: battery, batteryTemperature, wifiSignalLevel, state, chargingStatus, lastChargingDays, lastChargingRecordedEvents, lastChargingTotalEvents, batteryUsageLastWeek
• (bropat) Fixed issue #169
• (bropat) Fixed issue #167
• (bropat) Fixed issue #151
• (bropat) Fixed push notifications for solo cameras (motion and person detection)
• (bropat) Updated version of the package eufy-security-client (1.2.0)
• (bropat) Updated versions of the package dependencies
• (bropat) Further details can be found in the changelog of eufy-security-client (1.2.0)

0.6.2 (2021-08-19)

• (bropat) Updated version of the package eufy-security-client (1.1.2)

0.6.1 (2021-08-19)

• (bropat) Fixed issue in the function responsible for the version upgrade (non-updatable states; issue #159)
• (bropat) Tried to fix issue #157 and issue #140

0.6.0 (2021-08-13)

• (bropat) Breaking Changes Switched to the new managed driver class - All states will be dropped and recreated (Note: some states where renamed)
• (bropat) Supports Admin 5
• (bropat) Added new adapter setting "Accept incoming invitations" to automatically accept device invitations
• (bropat) Added new adapter setting "Alarm sound duration (sec)" used for triggering alarm sound on supported devices/stations (#76)
• (bropat) Added enable/disable led setting for camera 1 products
• (bropat) Added motion detection sensitivity setting for camera 1 products and wired doorbell
• (bropat) Added motion detection type setting for camera 1 products
• (bropat) Added motion audio recording setting for camera 1 products and wired doorbell
• (bropat) Added ringtone volume setting for wired doorbell
• (bropat) Added enable/disable indoor chime setting for wired doorbell (#100)
• (bropat) Added notification ring setting for wired doorbell
• (bropat) Added notification motion setting for wired doorbell
• (bropat) Added video streaming quality setting for wired doorbell
• (bropat) Added video recording quality setting for wired doorbell
• (bropat) Added video HDR setting for wired doorbell
• (bropat) Added video distortion correction setting for wired doorbell
• (bropat) Added video ring recording setting for wired doorbell
• (bropat) Added notification type setting for camera 1 products, solo cameras and wired doorbell
• (bropat) Added chirp volume setting for entry sensor
• (bropat) Added chirp tone setting for entry sensor
• (bropat) Added pan an tilt functionality to supported indoor cameras (#129)
• (bropat) Added error detection if stopping or starting stream that isn't running or already running
• (bropat) Added new setting "acceptInvitations" to "EufySecurity" to accept invitations automatically
• (bropat) Added floodlight camera light switch (#133)
• (bropat) Added motion detection sensitivity for indoor cameras, solo cameras, floodlight cameras, camera 2 products and battery doorbells (#133)
• (bropat) Added motion detection type for indoor cameras, solo cameras, floodlight cameras, camera 2 products and battery doorbells (#133)
• (bropat) Added motion tracking for indoor camera pan & tilt cameras
• (bropat) Added video stream quality setting for indoor cameras, solo cameras, floodlight cameras and battery doorbell (#133)
• (bropat) Added video recording quality setting for indoor cameras
• (bropat) Added WDR setting for battery doorbells
• (bropat) Added microphone mute setting for indoor cameras, solo cameras, floodlight cameras, camera 2 products and battery doorbells (#133)
• (bropat) Added audio recording setting for indoor cameras, solo cameras, floodlight cameras, camera 2 products and battery doorbells (#133)
• (bropat) Added enable/disable speaker setting for indoor cameras, solo cameras, floodlight cameras, camera 2 products (#133)
• (bropat) Added speaker volume setting for indoor cameras, solo cameras, floodlight cameras, camera 2 products and battery doorbells (#133)
• (bropat) Added power source setting for camera 2 products cameras, eufy cameras and eufy E cameras
• (bropat) Added power working mode setting for solo cameras, camera 2 products, battery doorbells, eufy cameras and eufy E cameras
• (bropat) Added power custom working mode recording clip length setting for solo cameras, floodlight cameras, camera 2 products, battery doorbells, eufy cameras and eufy E cameras (#133)
• (bropat) Added power custom working mode recording retrigger interval setting for solo cameras, floodlight cameras, camera 2 products, battery doorbells, eufy cameras and eufy E cameras (#133)
• (bropat) Added power custom working mode recording ends if motion stops setting for solo cameras, floodlight cameras, camera 2 products, battery doorbells, eufy cameras and eufy E cameras (#133)
• (bropat) Added video streaming quality setting for indoor cameras, solo cameras, floodlight cameras, 2c pro cameras and battery doorbells (#133)
• (bropat) Added video recording quality setting for indoor 2k cameras and 2c pro cameras
• (bropat) Added motion detection sensitivity setting for indoor cameras, floodlight cameras and camera 2 products (#133)
• (bropat) Added enable/disable motion tracking setting for indoor pan & tilt cameras
• (bropat) Added motion detection type setting for indoor cameras, solo cameras, floodlight cameras, camera 2 products and battery doorbells (#133)
• (bropat) Added enable/disable WDR setting for battery doorbells
• (bropat) Added ringtone volume setting for battery doorbells
• (bropat) Added enable/disable chime indoor setting for battery doorbells (#100)
• (bropat) Added enable/disable chime homebase setting for battery doorbells (#100)
• (bropat) Added chime homebase ringtone volume setting for battery doorbells
• (bropat) Added chime homebase ringtone type setting for battery doorbells
• (bropat) Added notification type setting for solo cameras, floodlight cameras, camera 2 products, battery doorbells, eufy cameras and eufy E cameras (#133)
• (bropat) Added enable/disable person notification setting for indoor cameras
• (bropat) Added enable/disable pet notification setting for indoor cameras
• (bropat) Added enable/disable all other motion notification setting for indoor cameras
• (bropat) Added enable/disable all sound notification setting for indoor cameras
• (bropat) Added enable/disable crying notification setting for indoor cameras
• (bropat) Added enable/disable motion notification setting for battery doorbells
• (bropat) Added enable/disable ring notification setting for battery doorbells
• (bropat) Added trigger alarm sound for camera 2 products, indoor cameras, solo cameras (incl. new) and floodlight cameras (#76)
• (bropat) Added reset alarm sound for camera 2 products, indoor cameras, solo cameras (incl. new) and floodlight cameras (#76)
• (bropat) Added trigger alarm sound for homebase 1+2 (#76)
• (bropat) Added reset alarm sound for homebase 1+2 (#76)
• (bropat) Added alarm tone setting for homebase 1+2
• (bropat) Added alarm volume setting for homebase 1+2
• (bropat) Added prompt volume setting for homebase 1+2
• (bropat) Added time format setting for homebase 1+2
• (bropat) Added enable/disable switch mode app notification setting for homebase 1+2
• (bropat) Added enable/disable switch mode geofence notification setting for homebase 1+2
• (bropat) Added enable/disable switch mode schedule notification setting for homebase 1+2
• (bropat) Added enable/disable switch mode keypad notification setting for homebase 1+2
• (bropat) Added enable/disable start alarm delay notification setting for homebase 1+2
• (bropat) Added new floodlight, solo and outdoor cameras (untested!)
• (bropat) Added brightness light setting for 2c/2c pro cameras, new solo cameras and new outdoor cameras
• (bropat) Added enable/disable light setting for 2c/2c pro cameras, new solo cameras and new outdoor cameras
• (bropat) Added battery charging state for keypad devices
• (bropat) Added wifi rssi state for keypad devices
• (bropat) Added nightvision setting for devices supporting the "light" nightvision mode
• (bropat) Added enable disable "switch mode with access code" for station with registered keypad
• (bropat) Added enable disable "auto end alarm" for station with registered keypad
• (bropat) Added enable disable "turn off alarm with button" for station with registered keypad
• (bropat) Fixed issue #98
• (bropat) Fixed issue #140
• (bropat) Fixed issue #146
• (bropat) Fixed issue #117
• (bropat) Many small bugfixes
• (bropat) Updated versions of the package dependencies

0.5.5 (2021-06-01)

• (bropat) Fixed regression in p2p protocol

0.5.4 (2021-05-26)

• (bropat) Fixed issue with video corruption in p2p livestream
• (bropat) Updated versions of the package dependencies

0.5.3 (2021-05-14)

• (bropat) Fixed issue #121
• (bropat) Fixed push notification for indoor and floodlight cams (issue #130)
• (bropat) Fixed refresh of properties/settings of standalone devices (issue #130)
• (bropat) Updated versions of the package dependencies

0.5.2 (2021-04-02)

• (bropat) Try to add support for FreeBSD - issue #106
• (bropat) Updated package dependency ffmpeg-static for FreeBSD support

0.5.1 (2021-04-01)

• (bropat) Fixed issue #105

0.5.0 (2021-03-30)

• (bropat) Added support for smart lock products
• (bropat) Added new P2P feature: lock/unlock smart lock products
• (bropat) Optimized speed of P2P connection establishment
• (bropat) New setting: P2P connection setup preference: local prefered, local only or quickest connection
• (bropat) Dropped support for NodeJS 10.x (min. requirement 12)
• (bropat) Updated versions of the package dependencies

0.4.3 (2021-03-19)

• (bropat) Code enhancements for publishing the adapter to the central repository
• (bropat) Updated versions of the package dependencies

0.4.2 (2021-03-14)

• (bropat) Fixed roles of states according to ioBroker documentation

0.4.1 (2021-03-14)

• (bropat) Removed legacy password encryption support for admin adapter (requires admin adapter >= 4.0.9)
• (bropat) Added admin adapter as global dependency
• (bropat) Updated license

0.4.0 (2021-03-11)

• (bropat) Added handling of adapter updates with breaking changes
• (bropat) Added new P2P feature: enable/disable pet detection for indoor cameras
• (bropat) Added new P2P feature: enable/disable sound detection for indoor cameras
• (bropat) Added new P2P feature: enable/disable led for wired doorbell
• (bropat) Unlocked state: last_event_video_url
• (bropat) Fixed parsing of push notification to download video events for battery doorbells and indoor cameras
• (bropat) Fixed enable/disable device (for wired doorbells, indoor cameras, floodlight camera and solo cameras)
• (bropat) Fixed enable/disable led (for battery doorbells, indoor cameras, floodlight camera and solo cameras)
• (bropat) Fixed enable/disable motion detection (for indoor cameras, floodlight camera and solo cameras)
• (bropat) Fixed change video watermark setting (for indoor cameras and floodlight camera)
• (bropat) Updated versions of the package dependencies

0.3.1 (2021-03-06)

• (bropat) Fixed regression on livestream with h265 codec

0.3.0 (2021-03-05)

• (bropat) Implemented feature request #88: Enable/disable motion detection for camera products
• (bropat) Implemented feature request #81: Enable/disable RTSP stream (added also RTSP stream url)
• (bropat) Implemented asynchronous download of event videos when receiving a push notification
• (bropat) Optimized ffmpeg implementation to only muxing video data to HLS
• (bropat) Optimized HLS livestream video start delay (10-15 sec.)
• (bropat) Fixed possible race condition with ffmpeg when using fallback to Eufy RTMP live stream
• (bropat) Fixed issue with livestream when p2p connection is lost
• (bropat) Updated versions of the package dependencies

0.2.5 (2021-02-20)

• (bropat) Fixed possible race condition that brokes sometime the livestream
• (bropat) Updated versions of the package dependencies

0.2.4 (2021-02-20)

• (bropat) Fixed issue #86
• (bropat) Fixed not correctly identifying if the livestream is still active or not

0.2.3 (2021-02-17)

• (bropat) Fixed wired doorbell p2p livestream (should fix also indoor, floodlight and solo cameras)
• (bropat) Fixed issue that treats known push notifications as unknown
• (bropat) Fixed relative path for state last_event_pic_url
• (bropat) Updated versions of the package dependencies

0.2.2 (2021-02-16)

• (bropat) Fixed web extension settings for serving videos and pictures (issue #79)

0.2.1 (2021-02-15)

• (bropat) Fixed device_enable state
• (bropat) Fixed battery doorbell start livestream over p2p (issue #78)
• (bropat) Implemented fallback for failed P2P livestream to RTMP livestream

0.2.0 (2021-02-14)

• (bropat) Implemented P2P livestream over HLS
• (bropat) Last livestream is always saved and is still available later
• (bropat) Implemented device and station parameter refresh over P2P
• (bropat) Revised push notification implementation
• (bropat) Fixed issue #71 by implementing retry mechanism on HTTP error 404 (max. 5 retries with increasing delay)
• (bropat) Fixed issue #12
• (bropat) Eufy client library extracted as standalone library and adapters ported to new shared library: eufy-security-client
• (bropat) Removed following states: last_captured_pic_url, last_captured_pic_html
• (bropat) Updated versions of the package dependencies

0.1.5 (2021-01-14)

• (bropat) Fixed issue #50 and #53
• (bropat) Updated versions of the package dependencies

0.1.4 (2021-01-05)

• (bropat) Fixed: Accept only valid modes for station guard mode (for invalid mode, an error is logged)
• (bropat) Fixed reset of an event (motion, ringing, etc.)
• (bropat) Updated versions of the package dependencies

0.1.3 (2021-01-02)

• (bropat) Fixed issue #37 and #41
• (bropat) Updated versions of the package dependencies

0.1.2 (2021-01-02)

• (bropat) Revised captured_pic_url state (renamed to last_captured_pic_url and added last_captured_pic_html)
• (bropat) Fixed p2p issue passing wrong user id (action_user_id instead of admin_user_id)
• (bropat) Revised push notification to properly support doorbell notifications
• (bropat) Updated versions of the package dependencies

0.1.1 (2020-12-29)

• (bropat) Fixed issue #37
• (bropat) Fixed version numbering
• (bropat) Updated versions of the package dependencies

0.0.9 (2020-12-28)

• (bropat) Finished implementation for feature request: #1
• (bropat) Little progress for feature request: #5
• (bropat) Now supports also cloud P2P communication if local P2P comunication isn't possible
• (bropat) Implemented set Guard Mode with CMD_SET_PAYLOAD for certain devices
• (bropat) Added back USA ip addresses for P2P cloud discovery
• (bropat) Using the correct local time zone for communication with the Eufy Cloud
• (bropat) HUB filtering by device type 0 (station) removed
• (bropat) Added documentation for 2FA
• (bropat) Updated versions of the package dependencies

0.0.8 (2020-12-13)

• (bropat) Fixed issue #16
• (bropat) P2P communication revisited
• (bropat) Added reconnect functionality for P2P communication
• (bropat) Added heartbeat for P2P communication
• (bropat) Added local caching of last event picture as image url or html image (removed old state: last_camera_url)
• (bropat) Updated versions of the package dependencies

0.0.7 (2020-12-08)

• (bropat) Fixed issue #11

0.0.6 (2020-12-06)

• (bropat) Fixed issue #13

0.0.5 (2020-12-05)

• (bropat) Added event states for camera (motion detected, person detected)
• (bropat) Added event states for entry sensor (open/closed)
• (bropat) Added event states for motion sensor (motion detected)
• (bropat) Added event states for doorbell (motion detected, person detected, ringing)
• (bropat) Added event states for indoor camera (motion detected, person detected, crying detected, sound detected, pet detected)
• (bropat) Added entry sensor state (online, offline, etc.)
• (bropat) Added entry sensor low battery
• (bropat) Added motion sensor state (online, offline, etc.)
• (bropat) Added motion sensor low battery
• (bropat) Added keypad state (online, offline, etc.)
• (bropat) Added keypad low battery

0.0.4 (2020-12-03)

• (bropat) Better exception handling
• (bropat) Fixed push token handling
• (bropat) Added push connection retry mechanism
• (bropat) Added camera state (online, offline, etc.)
• (bropat) Added camera wifi RSSI
• (bropat) Added camera total events since last charge
• (bropat) Added camera saved/recorded events since last charge
• (bropat) Added camera filtered false events since last charge
• (bropat) Added camera used days since last charge
• (bropat) Added camera battery temperature

0.0.3 (2020-11-21)

• (bropat) Fixed issue with push notification credentials initialization

0.0.2 (2020-11-21)

• (bropat) Added push notification support for event notification (raw notifications!)
• (bropat) Added 2FA (token renewal needs manual intervention)
• (bropat) Added P2P communication with station (event: Alarm mode change)
• (bropat) Added more device classes (sensors, locks, keypads) with no actions (at the moment! WIP!)
• (bropat) Added all eufy camera devices release to date
• (bropat) Added battery state to eufy cameras

0.0.1 (2020-10-04)

• (bropat) initial release

License

MIT License

Copyright (c) 2022 bropat patrick.broetto@gmail.com

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.