homebridge-eufy-security 2.0.1 → 2.1.0-beta.11

package/CHANGELOG.md

@@ -1,5 +1,70 @@
 # Change Log
 
+You can find the complete detailled changelog for every beta release [here](https://github.com/homebridge-eufy-security/plugin/releases).
+
+## 2.1.0-beta.11 (20/07/2022) - latest changes
+
+### Changed
+
+- Use just one ffmpeg process for rtsp streaming
+- Updated repo funding details (Readme.md and package.json)
+- Cleaned up dependencies
+- Improved readablity of the changelog (i hope)
+
+### Fixed
+
+- Bug where an error saying 'talkback will not work with rtsp setting enabled' was displayed even though one of theses settings was not available (see [here](https://github.com/homebridge-eufy-security/plugin/issues/103#issuecomment-1189244061))
+- plugin crashed if dependencies were stored in in non default places by npm (see [here](https://github.com/homebridge-eufy-security/plugin/issues/72#issuecomment-1189144152))
+
+## 2.1.0 (beta) - complete changes of the beta so far (19/07/2022)
+
+### Added
+
+- Talkback support #103
+- Improved snapshot handling: 3 different snapshot methods
+- Feature to improve camera snapshots at night (night vision)
+- Feature to automatically generate camera snapshots a given period of time, so that snapshots are more up-to-date
+- Feature allowing enabling and disabling motion detection throug switch if camera is used as a motion sensor only
+- Feature allowing enabling and disabling the camera throug switch even if camera is used as a motion sensor only
+- Control Station alarm through HomeKit (reset the alarm and even trigger it with HomeKit automations. You can now trigger the alarm even with third party accessories - e.g. with devices from vendors other than eufy) - see #26
+- Setting to disable log file storage to disk (possible fix for #93)
+
+### Changed
+
+- Complete redesign of the config ui screen
+- RTSP setting is now only avaiable on compatible devices
+- Plugin will use two separate ffmpeg process for audio and video to increase stability (exception: rtsp streams)
+- Updated to latest version of eufy-security-client (2.1.1) (fix for #72 and #38)
+- Refactored whole project structure to resemble the new workspace layout (plugin + custom ui)
+- Reimplementation of device discovery algorithm to better reflect best practices mentioned in [this comment](https://github.com/bropat/eufy-security-client/issues/167#issuecomment-1155388624)
+- Added timeouts for guard mode changes. If these fail HomeKit will no longer get stuck, trying to change the guard mode and an error will be written to the log output (see #39)
+- Limit value for maximum streaming duration to prevent unexpected behaviour (see #111)
+- Additional debug messages to help with issues
+- Updated repo funding details (Readme.md and package.json)
+- Cleaned up dependencies
+
+### Fixed
+
+- Plugin crash if guard modes were configured incorrectly (see #52)
+- Plugin crashed if station was disarmed with certain configured guard modes
+- Config ui crash due to a wrong node version requirement (#44)
+- Livestream could not be started if previous local livestream cache was not shut down correctly (e.g. #43)
+- Livestream was not working if videoconfig was populated with empty values
+- Plugin may have crashed due to a race condition regarding log file rotation (see #56)
+- Motion events were not reseted correctly in some cases. So new events would not be recognized
+- Push notifications stopped working if the configuration editor was opened and the plugin not restarted aftwerwards (see #59)
+- Options enableCamera and enableMotion were not working in specific configuration situations (see #48)
+- Unbridge setting was not working for doorbell cameras (see #79)
+- Fixed #81
+- Fixed all lint warnings and errors
+- Fixed npm warnings
+- Smart lock states could be wrong on plugin startup (further improvements needed for smartlocks)
+
+## 2.0.1 (20.06.2022)
+
+### Fixed
+- locked dependency version to prevent breaking changes
+
 ## 2.0 (25/05/2022)
 
 ### Added

package/README.md

@@ -26,7 +26,7 @@ Homebridge plugin to control certain Eufy Security devices
 ### Prerequisites
 
 - To use this plugin, you will need to already have [Homebridge](https://homebridge.io) (at least v1.3.4)  installed. Refer to the links for more information and installation instructions.
-- It is recommended to use the current LTS version of Node, currently v14, however Node v12 is also supported.
+- It is recommended to use the current LTS version of Node, currently v16, however Node v12 is also supported.
 
 ### Setup
 
@@ -49,11 +49,21 @@ Homebridge plugin to control certain Eufy Security devices
 
 ### Supporting
 
--   **[samemory](https://github.com/samemory)**
--   **[schliemann](https://github.com/schliemann)**
--   **[lenoxys](https://github.com/lenoxys)**
+If you appreciate this plugin and want to support the work we do, you can use one of the following links:
 
-Big thanks to **[bropat](https://github.com/bropat)** who made this possible. Please consider buying a coffee for him over here: https://ko-fi.com/bropat
+**Active Contributors**
+
+- **[lenoxys](https://github.com/sponsors/lenoxys)**
+- **[schliemann](https://github.com/schliemann)**
+- **[thieren](https://ko-fi.com/thieren)**
+
+**The guy who started it all**
+
+- **[samemory](https://ko-fi.com/S6S24XCVJ)**
+
+**And also**
+
+Big thanks to **[bropat](https://github.com/bropat)** who made this possible. You can support him [here](https://ko-fi.com/bropat)
 
 ### Disclaimer
 

package/config.schema.json

@@ -2,589 +2,5 @@
   "pluginAlias": "EufySecurity",
   "pluginType": "platform",
   "singular": true,
-  "customUi": true,
-  "schema": {
-    "type": "object",
-    "properties": {
-      "username": {
-        "title": "Eufy username",
-        "type": "string",
-        "required": true,
-        "description": "Eufy username/email"
-      },
-      "password": {
-        "title": "Eufy Password",
-        "type": "string",
-        "required": true,
-        "description": "Eufy password"
-      },
-      "enableDetailedLogging": {
-        "title": "Enable Detailed Logging?",
-        "type": "number",
-        "default": 0,
-        "oneOf": [
-          {
-            "title": "Normal",
-            "enum": [
-              0
-            ]
-          },
-          {
-            "title": "Debug",
-            "enum": [
-              1
-            ]
-          },
-          {
-            "title": "Insane",
-            "enum": [
-              2
-            ]
-          }
-        ],
-        "description": "Becarefull Debug and Insane may contain credential and personnal information which could be use to login into your Eufy Account",
-        "required": true
-      },
-      "enableCamera": {
-        "title": "Camera device seen as Camera",
-        "description": "Camera seen as Motion Sensor by default, enable this setting to transform as Camera",
-        "type": "boolean",
-        "required": false
-      },
-      "CameraMaxLivestreamDuration": {
-        "title": "Camera Max Livestream Duration (in seconds) ",
-        "type": "number",
-        "required": false
-      },
-      "pollingIntervalMinutes": {
-        "title": "Polling Interval (in minutes) ",
-        "type": "number",
-        "required": false
-      },
-      "enableButton": {
-        "title": "Display homekit button to switch on/off camera",
-        "description": "When disabling theses buttons you might need to clear accessory cache (homebridge settings) so it can take effect into homekit.",
-        "type": "boolean",
-        "default": true,
-        "required": false
-      },
-      "motionButton": {
-        "title": "Display homekit button to switch on/off motion camera",
-        "description": "When disabling theses buttons you might need to clear accessory cache (homebridge settings) so it can take effect into homekit.",
-        "type": "boolean",
-        "default": true,
-        "required": false
-      },
-      "ignoreStations": {
-        "title": "Ignoring stations",
-        "type": "array",
-        "required": false,
-        "items": {
-          "type": "string"
-        }
-      },
-      "ignoreDevices": {
-        "title": "Ignoring devices",
-        "type": "array",
-        "required": false,
-        "items": {
-          "type": "string"
-        }
-      },
-      "hkHome": {
-        "title": "HomeKit Home",
-        "type": "number",
-        "default": 1,
-        "oneOf": [
-          {
-            "title": "Home",
-            "enum": [
-              1
-            ]
-          },
-          {
-            "title": "Away",
-            "enum": [
-              0
-            ]
-          },
-          {
-            "title": "Schedule",
-            "enum": [
-              2
-            ]
-          },
-          {
-            "title": "Custom 1",
-            "enum": [
-              3
-            ]
-          },
-          {
-            "title": "Custom 2",
-            "enum": [
-              4
-            ]
-          },
-          {
-            "title": "Custom 3",
-            "enum": [
-              5
-            ]
-          },
-          {
-            "title": "Geofencing",
-            "enum": [
-              47
-            ]
-          },
-          {
-            "title": "Disarmed",
-            "enum": [
-              63
-            ]
-          }
-        ],
-        "required": false
-      },
-      "hkAway": {
-        "title": "HomeKit Away",
-        "type": "number",
-        "default": 0,
-        "oneOf": [
-          {
-            "title": "Home",
-            "enum": [
-              1
-            ]
-          },
-          {
-            "title": "Away",
-            "enum": [
-              0
-            ]
-          },
-          {
-            "title": "Schedule",
-            "enum": [
-              2
-            ]
-          },
-          {
-            "title": "Custom 1",
-            "enum": [
-              3
-            ]
-          },
-          {
-            "title": "Custom 2",
-            "enum": [
-              4
-            ]
-          },
-          {
-            "title": "Custom 3",
-            "enum": [
-              5
-            ]
-          },
-          {
-            "title": "Geofencing",
-            "enum": [
-              47
-            ]
-          },
-          {
-            "title": "Disarmed",
-            "enum": [
-              63
-            ]
-          }
-        ],
-        "required": false
-      },
-      "hkNight": {
-        "title": "HomeKit Night",
-        "type": "number",
-        "default": 3,
-        "oneOf": [
-          {
-            "title": "Home",
-            "enum": [
-              1
-            ]
-          },
-          {
-            "title": "Away",
-            "enum": [
-              0
-            ]
-          },
-          {
-            "title": "Schedule",
-            "enum": [
-              2
-            ]
-          },
-          {
-            "title": "Custom 1",
-            "enum": [
-              3
-            ]
-          },
-          {
-            "title": "Custom 2",
-            "enum": [
-              4
-            ]
-          },
-          {
-            "title": "Custom 3",
-            "enum": [
-              5
-            ]
-          },
-          {
-            "title": "Geofencing",
-            "enum": [
-              47
-            ]
-          },
-          {
-            "title": "Disarmed",
-            "enum": [
-              63
-            ]
-          }
-        ],
-        "required": false
-      },
-      "hkOff": {
-        "title": "HomeKit Off",
-        "type": "number",
-        "default": 63,
-        "oneOf": [
-          {
-            "title": "Home",
-            "enum": [
-              1
-            ]
-          },
-          {
-            "title": "Away",
-            "enum": [
-              0
-            ]
-          },
-          {
-            "title": "Schedule",
-            "enum": [
-              2
-            ]
-          },
-          {
-            "title": "Custom 1",
-            "enum": [
-              3
-            ]
-          },
-          {
-            "title": "Custom 2",
-            "enum": [
-              4
-            ]
-          },
-          {
-            "title": "Custom 3",
-            "enum": [
-              5
-            ]
-          },
-          {
-            "title": "Geofencing",
-            "enum": [
-              47
-            ]
-          },
-          {
-            "title": "Disarmed",
-            "enum": [
-              63
-            ]
-          }
-        ],
-        "required": false
-      },
-      "country": {
-        "title": "Eufy Country",
-        "type": "string",
-        "required": false,
-        "discription": "Eufy Country selection"
-      },
-      "cameras": {
-        "type": "array",
-        "items": {
-          "title": "Cameras",
-          "type": "object",
-          "properties": {
-            "serialNumber": {
-              "name": "Serial Number",
-              "type": "string",
-              "placeholder": "SerialNumber",
-              "description": "Set the serial number for display in the Home app."
-            },
-            "videoConfig": {
-              "title": "Video Configuration",
-              "type": "object",
-              "properties": {
-                "readRate": {
-                  "title": "Read Rate",
-                  "type": "boolean",
-                  "description": "Read input at native frame rate (-re)."
-                },
-                "analyzeDuration": {
-                  "title": "Analyze Duration",
-                  "type": "integer",
-                  "description": "Specify how many microseconds are analyzed to probe the input. A higher value will enable detecting more accurate information, but will increase latency. It defaults to 5,000,000 microseconds = 5 seconds (-analyzeduration)."
-                },
-                "probeSize": {
-                  "title": "Probe Size",
-                  "type": "integer",
-                  "description": "Set probing size in bytes, i.e. the size of the data to analyze to get stream information. A higher value will enable detecting more information in case it is dispersed into the stream, but will increase latency. Must be an integer not lesser than 32. It is 5000000 by default (-probesize)."
-                },
-                "reorderQueueSize": {
-                  "title": "Reorder Queue Size (Jitter buffer size)",
-                  "type": "integer",
-                  "description": "Packets may be received out of order, so before they can be passed onwards, they need to be reordered. Default jitter buffer size is 500. This option allows you to specify it manually. Higher values will lead to greater latency. Only applicable for reception over UDP (-reorder_queue_size)."
-                },
-                "maxDelay": {
-                  "title": "Max Delay",
-                  "type": "integer",
-                  "description": "When receiving data over UDP, the demuxer tries to reorder received packets (since they may arrive out of order, or packets may get lost totally). This can be disabled by setting the maximum demuxing delay to zero (-max_delay)."
-                },
-                "maxStreams": {
-                  "title": "Maximum Concurrent Streams",
-                  "type": "integer",
-                  "default": 2,
-                  "minimum": 1,
-                  "description": "The maximum number of streams that will be allowed at once to this camera."
-                },
-                "maxFPS": {
-                  "title": "Maximum Framerate",
-                  "type": "integer",
-                  "placeholder": 20,
-                  "minimum": 0,
-                  "description": "The maximum frame rate used for video streamed to HomeKit. If set to 0, the framerate of the source is used. If not set, will use any framerate HomeKit requests (-r)."
-                },
-                "maxBitrate": {
-                  "title": "Maximum Bitrate",
-                  "type": "integer",
-                  "placeholder": 299,
-                  "minimum": 0,
-                  "description": "The maximum bitrate used for video stream, in kbit/s. If not set, will use any bitrate HomeKit requests (-b:v)."
-                },
-                "forceMax": {
-                  "title": "Force Maximums",
-                  "type": "boolean",
-                  "description": "If set, the settings requested by HomeKit will be overridden with any 'maximum' values defined in this config."
-                },
-                "vcodec": {
-                  "title": "Video Codec",
-                  "type": "string",
-                  "default": "copy",
-                  "typeahead": {
-                    "source": [
-                      "libx264",
-                      "h264_omx",
-                      "h264_videotoolbox",
-                      "copy"
-                    ]
-                  },
-                  "description": "Set the codec used for encoding video sent to HomeKit, must be H.264-based. You can change to a hardware accelerated video codec with this option, if one is available (-vcodec)."
-                },
-                "acodec": {
-                  "title": "Audio Codec",
-                  "type": "string",
-                  "default": "libfdk_aac",
-                  "typeahead": {
-                    "source": [
-                      "libfdk_aac",
-                      "copy"
-                    ]
-                  },
-                  "description": "Set the codec used for encoding audio sent to HomeKit for HSV, must be AAC-based (-acodec)."
-                },
-                "packetSize": {
-                  "title": "Packet Size",
-                  "type": "number",
-                  "placeholder": 1316,
-                  "multipleOf": 188,
-                  "minimum": 188,
-                  "description": "If audio or video is choppy try a smaller value."
-                },
-                "stimeout": {
-                  "title": "Socket Timeout",
-                  "type": "number",
-                  "description": "Socket TCP I/O timeout in seconds. If you have problems with hanging FFmpeg processes in the background, you can enter any value here to stop the process automatically after the entered time, if no response comes (-stimeout).",
-                  "minimum": 0,
-                  "maximum": 60
-                },
-                "videoFilter": {
-                  "title": "Additional Video Filters",
-                  "type": "string",
-                  "description": "Comma-delimited list of additional video filters for FFmpeg to run on the video. If 'none' is included, the default video filters are disabled (-filter:v)."
-                },
-                "encoderOptions": {
-                  "title": "Encoder Options",
-                  "type": "string",
-                  "placeholder": "-preset ultrafast -tune zerolatency",
-                  "description": "Options to be passed to the video encoder."
-                },
-                "mapvideo": {
-                  "type": "string",
-                  "title": "Video Stream",
-                  "description": "Selects the stream used for video (-map)."
-                },
-                "mapaudio": {
-                  "type": "string",
-                  "title": "Audio Stream",
-                  "description": "Selects the stream used for audio (-map)."
-                }
-              }
-            }
-          }
-        }
-      }
-    }
-  },
-  "layout": [
-    {
-      "type": "flex",
-      "flex-flow": "row wrap",
-      "items": [
-        "username",
-        {
-          "key": "password",
-          "type": "password"
-        }
-      ]
-    },
-    {
-      "type": "fieldset",
-      "title": "Cameras",
-      "expandable": true,
-      "expanded": false,
-      "items": [
-        {
-          "key": "cameras",
-          "type": "tabarray",
-          "title": "{{ value.serialNumber || 'new Camera' }}",
-          "items": [
-            "cameras[].serialNumber",
-            {
-              "key": "cameras[]",
-              "type": "section",
-              "title": "Stream Configuration",
-              "expandable": true,
-              "expanded": false,
-              "items": [
-                "cameras[].videoConfig.maxStreams",
-                "cameras[].videoConfig.maxFPS",
-                "cameras[].videoConfig.maxBitrate",
-                "cameras[].videoConfig.forceMax"
-              ]
-            },
-            {
-              "key": "cameras[]",
-              "type": "section",
-              "title": "Advanced Stream Configuration",
-              "expandable": true,
-              "expanded": false,
-              "items": [
-                "cameras[].videoConfig.readRate",
-                "cameras[].videoConfig.acodec",
-                "cameras[].videoConfig.vcodec",
-                "cameras[].videoConfig.analyzeDuration",
-                "cameras[].videoConfig.probeSize",
-                "cameras[].videoConfig.reorderQueueSize",
-                "cameras[].videoConfig.maxDelay",
-                "cameras[].videoConfig.stimeout",
-                "cameras[].videoConfig.packetSize",
-                "cameras[].videoConfig.mapvideo",
-                "cameras[].videoConfig.mapaudio",
-                "cameras[].videoConfig.videoFilter",
-                "cameras[].videoConfig.encoderOptions"
-              ]
-            }
-          ]
-        }
-      ]
-    },
-    {
-      "type": "section",
-      "title": "HomeKit Security Mode Settings",
-      "description": "Change how each mode in the HomeKit security system is mapped to the modes in the Eufy App",
-      "expandable": true,
-      "expanded": false,
-      "items": [
-        "hkHome",
-        "hkAway",
-        "hkNight",
-        "hkOff"
-      ]
-    },
-    {
-      "type": "section",
-      "title": "Optional Settings",
-      "expandable": true,
-      "expanded": false,
-      "items": [
-        "enableDetailedLogging",
-        "enableCamera",
-        "enableButton",
-        "motionButton",
-        "CameraMaxLivestreamDuration",
-        "pollingIntervalMinutes",
-        "country",
-        "codec",
-        "ffmpegdebug",
-        {
-          "key": "ignoreStations",
-          "add": "Add Another Device ID",
-          "type": "array",
-          "items": [
-            {
-              "type": "div",
-              "displayFlex": true,
-              "flex-direction": "row",
-              "items": [
-                {
-                  "key": "ignoreStations[]",
-                  "placeholder": "Device ID"
-                }
-              ]
-            }
-          ]
-        },
-        {
-          "key": "ignoreDevices",
-          "add": "Add Another Device ID",
-          "type": "array",
-          "items": [
-            {
-              "type": "div",
-              "displayFlex": true,
-              "flex-direction": "row",
-              "items": [
-                {
-                  "key": "ignoreDevices[]",
-                  "placeholder": "Device ID"
-                }
-              ]
-            }
-          ]
-        }
-      ]
-    }
-  ]
+  "customUi": true
 }