homebridge-arlo - npm Package Compare versions

Comparing version 0.0.3 to 1.0.0

package.json

 {
-    "name": "homebridge-arlo",
-    "version": "0.0.3",
-    "author": "David Parry <[e-mail]>",
-    "description": "Arlo platform plugin for homebridge",
-    "repository": {
-        "type": "git",
-        "url": "git://github.com/devbobo/homebridge-arlo.git"
-    },
-    "engines": {
-        "node": ">=6",
-        "homebridge": ">=0.4.29"
-    },
+  "displayName": "Homebridge Arlo",
+  "name": "homebridge-arlo",
+  "version": "1.0.0",
+  "description": "Arlo plugin for homebridge",
+  "author": "homebridge-plugins",
+  "main": "index.js",
+  "scripts": {
+    "developer": "DEBUG=arlo homebridge -D -U `pwd` -P `pwd`",
+    "lint": "jshint package.json *.js",
+    "watch": "nodemon"
+  },
+  "license": "ISC",
   "keywords": [
-        "homebridge-plugin",
-        "arlo"
-    ],
-    "dependencies": {
-        "node-arlo": ">=0.0.7"
-    }
+    "homebridge-plugin",
+    "arlo",
+    "homebridge"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git://github.com/homebridge-plugins/homebridge-arlo.git"
+  },
+  "bugs": {
+    "url": "http://github.com/homebridge-plugins/homebridge-arlo/issues"
+  },
+  "engines": {
+    "node": ">=8.15.1",
+    "homebridge": ">=1.0.0"
+  },
+  "devDependencies": {
+    "nodemon": ">=2.0.2"
+  },
+  "dependencies": {
+    "debug": "^4.1.1",
+    "ffmpeg-for-homebridge": "0.0.5",
+    "node-arlo": ">=0.0.7"
+  }
 }

README.md

@@ -1,21 +0,23 @@
-# homebridge-arlo
+<span align="center">
 
-[![npm package](https://nodei.co/npm/homebridge-arlo.png?downloads=true&downloadRank=true&stars=true)](https://nodei.co/npm/homebridge-arlo/)
+<a href="https://arlo.com"><img alt="homebridge-arlo" src="https://raw.githubusercontent.com/homebridge-plugins/homebridge-arlo/update/arlo/arlo.png" width="140px"></a>
 
-[![donate](https://img.shields.io/badge/%24-Buy%20me%20a%20coffee-ff69b4.svg)](https://www.buymeacoffee.com/devbobo)
-[![Slack Channel](https://img.shields.io/badge/slack-homebridge--arlo-e01563.svg)](https://homebridgeteam.slack.com/messages/C5C0Z6XPW)
+# Homebridge-Arlo
 
-Arlo platform plugin for [Homebridge](https://github.com/nfarina/homebridge).
+<a href="https://www.npmjs.com/package/homebridge-arlo"><img title="npm version" src="https://badgen.net/npm/v/homebridge-arlo" ></a>
+<a href="https://www.npmjs.com/package/homebridge-arlo"><img title="npm downloads" src="https://badgen.net/npm/dt/homebridge-arlo" ></a>
 
-# Installation
+<p><a href="https://www.arlo.com/">Arlo</a> plugin for 
+  <a href="https://homebridge.io">Homebridge</a>. 
+  
+</p>
 
-1. Install homebridge using: npm install -g homebridge
-2. Install this plugin using: npm install -g homebridge-arlo
-3. Update your configuration file. See the sample below.
+</span>
 
-# Updating
+## Installation
+* Install [config-ui-x](https://github.com/oznu/homebridge-config-ui-x).
+* Search for "Arlo" on the Plugin Screen of [config-ui-x](https://github.com/oznu/homebridge-config-ui-x) .
+* Click Install on Homebridge Arlo.
 
-- `npm update -g homebridge-arlo`
-
-# Setup
+## Configuration
 Arlo only allows a single login to each account at a time, as a result, if you
@@ -25,62 +27,7 @@ are running Homebridge and the Arlo on the same account... logging in on your
 
-Therefore, I **highly recommend** creating an additional account in Arlo, just
+Therefore, It is **highly recommend** to creating an [additional account](https://my.arlo.com/#/registration) in Arlo, just
 for homebridge access.
 
-# Limitations
-This plugin currently only support Base Stations, not cameras. This is mainly
-because I haven't gotten video streaming to work yet.
+## Manual Setup
 
-# Configuration
-
- ```javascript
-"platforms": [
-    {
-        "platform": "Arlo",
-        "name": "Arlo",
-        "email": "<insert arlo account email address>",
-        "password": "<insert arlo account password>"
-        "interval": 6000 
-    }
-]
-
-```
-NOTE: interval time is in milliseconds - e.g. 6000 ms are 10 sec
-
-## Optional parameters
-By default, Arlo only provides two modes (**armed** and **disarmed**). Since
-HomeKit allows a security system to have 4 states (**away**, **home**,
-**night** and **off**), we provide two config parameters to enable support for
-the additional 2 states. If these configuration parameters aren't provided
-setting the state to **home** or **night** will result in the state being set
-to **away**, i.e. **armed**.
-
-Arlo uses the string `modeX` to identify each mode, with `mode0` used for the
-default **disarmed** state and `mode1` used for the default **armed** state.
-To determine the correct `modeX` string for your custom state, login to the
-[Arlo web console](https://arlo.netgear.com) and click the "Edit Mode"  button.
-The URL will show the ` modeX` string for that custom state, e.g.
- https\://arlo.netgear.com/#/modes/`<USER_ID>`/edit/**mode2**
-
-Once you've determined the `modeX` string of your custom mode(s), you can
-configure `homebridge-arlo` to use those for the additional modes available
-via HomeKit:
-
-* `stay_arm` - The `modeX` label for the custom mode created in Arlo for the
-**home** or **stay** state.
-* `night_arm` - The `modeX` label for the custom mode created in Arlo for the
-**night** state.
-
-
-### Sample Configuration with Optional Parameters
-
- ```javascript
-"platforms": [
-    {
-        "platform": "Arlo",
-        "name": "Arlo",
-        "email": "<insert arlo account email address>",
-        "password": "<insert arlo account password>",
-        "stay_arm": "mode2",
-        "night_arm": "mode3"
-    }
-]
+  Visit Manual Setup [Wiki](https://github.com/homebridge-plugins/homebridge-arlo/wiki/Manual-Setup).

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Shell access

Supply chain risk

This module accesses the system shell. Accessing the system shell increases the risk of executing arbitrary code.

Found 1 instance in 1 package

Filesystem access

Supply chain risk

Accesses the file system, and could potentially read sensitive data.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

No bug tracker

Maintenance

Package does not have a linked bug tracker in package.json.

Found 1 instance in 1 package

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

74922

increased by132.72%

Number of package files

16

increased by300%

Lines of code

692

increased by4.37%

Number of low maintenance alerts

0

decreased by-100%

Number of low quality alerts

1

decreased by-50%

Worsened metrics

Dependency count

3

increased by200%

Dev dependency count

1

increased byInfinity%

Number of lines in readme file

33

decreased by-61.63%

Number of low supply chain risk alerts

1

increased byInfinity%

Number of medium supply chain risk alerts

1

increased byInfinity%

Dependency changes

• + Addeddebug@^4.1.1

• + Addedffmpeg-for-homebridge@0.0.5

• + Addedchownr@2.0.0(transitive)

• + Addeddecompress-response@4.2.1(transitive)

• + Addeddetect-libc@1.0.3(transitive)

• + Addeddotenv@8.6.0(transitive)

• + Addedffmpeg-for-homebridge@0.0.5(transitive)

• + Addedfs-minipass@2.1.0(transitive)

• + Addedmimic-response@2.1.0(transitive)

• + Addedminipass@3.3.65.0.0(transitive)

• + Addedminizlib@2.1.2(transitive)

• + Addedmkdirp@1.0.4(transitive)

• + Addedonce@1.4.0(transitive)

• + Addedsimple-concat@1.0.1(transitive)

• + Addedsimple-get@3.1.1(transitive)

• + Addedtar@6.2.1(transitive)

• + Addedwrappy@1.0.2(transitive)

• + Addedyallist@4.0.0(transitive)