@switchbot/homebridge-switchbot - npm Package Compare versions

Comparing version 0.0.2-beta.19 to 0.1.0

CHANGELOG.md

@@ -12,8 +12,8 @@ # Changelog
 
-## [Version 0.1.0](https://github.com/OpenWonderLabs/homebridge-switchbot/releases/tag/v1.0.0) (2020-XX-XX)
+## [Version 0.1.0](https://github.com/OpenWonderLabs/homebridge-switchbot/releases/tag/v1.0.0) (2020-09-10)
 
 ### Changes
 
-- Initial release of homebridge-Switchbot.
+- Initial release of homebridge-switchbot.
 - Adds Motion & Contact Sensors
-- Adds Water Level to Humidifer
+- Adds Water Level to Humidifier

package.json

 {
-    "displayName": "Homebridge SwitchBot",
-    "name": "@switchbot/homebridge-switchbot",
-    "version": "0.0.2-beta.19",
-    "description": "The [Homebridge](https://homebridge.io) SwitchBot plugin allows you to access your [SwitchBot](https://www.switch-bot.com) device(s) from HomeKit.",
-    "author": "SwitchBot <[e-mail]> (https://github.com/SwitchBot)",
-    "license": "ISC",
-    "repository": {
-        "type": "git",
-        "url": "git://github.com/OpenWonderLabs/homebridge-switchbot.git"
-    },
-    "bugs": {
-        "url": "https://github.com/OpenWonderLabs/homebridge-switchbot/issues"
-    },
-    "engines": {
-        "node": ">=14.17.4",
-        "homebridge": ">=1.3.4"
-    },
-    "main": "dist/index.js",
-    "scripts": {
-        "check": "npm install && npm outdated",
-        "update": "ncu -u && npm update && npm install",
-        "lint": "eslint src/**.ts",
-        "watch": "npm run build && npm link && nodemon",
-        "build": "rimraf ./dist && tsc",
-        "prepublishOnly": "npm run lint && npm run build"
-    },
-    "funding": [
-        {
-            "type": "Paypal",
-            "url": "https://www.paypal.me/donavanbecker"
-        }
-    ],
-    "publishConfig": {
-        "access": "public"
-    },
-    "keywords": [
-        "homebridge-plugin",
-        "switchbot",
-        "humidifier",
-        "humidity",
-        "temperature",
-        "bot",
-        "curtains",
-        "windows",
-        "ble",
-        "ir"
-    ],
-    "dependencies": {
-        "axios": "^0.21.4",
-        "rxjs": "^7.3.0",
-        "node-switchbot": "^1.0.6",
-        "@homebridge/plugin-ui-utils": "^0.0.19"
-    },
-    "devDependencies": {
-        "@types/node": "^16.9.1",
-        "@typescript-eslint/eslint-plugin": "^4.31.0",
-        "@typescript-eslint/parser": "^4.31.0",
-        "eslint": "^7.32.0",
-        "homebridge": "^1.3.4",
-        "nodemon": "^2.0.12",
-        "rimraf": "^3.0.2",
-        "ts-node": "^10.2.1",
-        "typescript": "^4.4.3",
-        "typescript-axios-wb": "^1.0.3",
-        "npm-check-updates": "^11.8.5"
+  "displayName": "Homebridge SwitchBot",
+  "name": "@switchbot/homebridge-switchbot",
+  "version": "0.1.0",
+  "description": "The [Homebridge](https://homebridge.io) SwitchBot plugin allows you to access your [SwitchBot](https://www.switch-bot.com) device(s) from HomeKit.",
+  "author": "SwitchBot <[e-mail]> (https://github.com/SwitchBot)",
+  "license": "ISC",
+  "repository": {
+    "type": "git",
+    "url": "git://github.com/OpenWonderLabs/homebridge-switchbot.git"
+  },
+  "bugs": {
+    "url": "https://github.com/OpenWonderLabs/homebridge-switchbot/issues"
+  },
+  "engines": {
+    "node": ">=14.17.4",
+    "homebridge": ">=1.3.4"
+  },
+  "main": "dist/index.js",
+  "scripts": {
+    "check": "npm install && npm outdated",
+    "update": "ncu -u && npm update && npm install",
+    "lint": "eslint src/**.ts",
+    "watch": "npm run build && npm link && nodemon",
+    "build": "rimraf ./dist && tsc",
+    "prepublishOnly": "npm run lint && npm run build"
+  },
+  "funding": [
+    {
+      "type": "Paypal",
+      "url": "https://www.paypal.me/donavanbecker"
     }
-}
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "keywords": [
+    "homebridge-plugin",
+    "switchbot",
+    "humidifier",
+    "humidity",
+    "temperature",
+    "bot",
+    "curtains",
+    "windows",
+    "ble",
+    "ir"
+  ],
+  "dependencies": {
+    "axios": "^0.21.4",
+    "rxjs": "^7.3.0",
+    "node-switchbot": "^1.0.6",
+    "@homebridge/plugin-ui-utils": "^0.0.19"
+  },
+  "devDependencies": {
+    "@types/node": "^16.9.1",
+    "@typescript-eslint/eslint-plugin": "^4.31.0",
+    "@typescript-eslint/parser": "^4.31.0",
+    "eslint": "^7.32.0",
+    "homebridge": "^1.3.4",
+    "nodemon": "^2.0.12",
+    "rimraf": "^3.0.2",
+    "ts-node": "^10.2.1",
+    "typescript": "^4.4.3",
+    "typescript-axios-wb": "^1.0.3",
+    "npm-check-updates": "^11.8.5"
+  }
+}

README.md

@@ -9,3 +9,105 @@ <span align="center">
 [![npm downloads](https://badgen.net/npm/dt/@switchbot/homebridge-switchbot)](https://www.npmjs.com/package/@switchbot/homebridge-switchbot)
+[![discord-switchbot](https://badgen.net/discord/online-members/5wYTbwP4ha?icon=discord&label=discord)](https://discord.gg/5wYTbwP4ha)
 
+<p>The Homebridge <a href="https://www.switch-bot.com">SwitchBot</a>  OpenAPI
+plugin allows you to access your SwitchBot Device(s) from HomeKit with
+  <a href="https://homebridge.io">Homebridge</a>. 
+</p>
+
 </span>
+
+## Installation
+
+1. Search for "SwitchBot" on the plugin screen of [Homebridge Config UI X](https://github.com/oznu/homebridge-config-ui-x)
+2. Find: `@switchbot/homebridge-switchbot`
+3. Click **Install**
+
+## Configuration
+
+1. Download SwitchBot App on App Store or Google Play Store
+2. Register a SwitchBot account and log in into your account
+3. Generate an Open Token within the App
+    - Click Bottom Profile Tab
+    - Click Preference
+    - Click App version 10 Times, this will enable Developer Options
+    - Click Developer Options
+    - Click Copy to Clipboard
+4. Input your `Token` into the config paramter
+
+<p align="center">
+
+<img src="" width="1px">
+
+</p>
+
+## Supported SwitchBot Devices
+
+- [SwitchBot Humidifier](https://www.switch-bot.com/products/switchbot-smart-humidifier)
+- [SwitchBot Meter](https://www.switch-bot.com/products/switchbot-meter)
+    - [SwitchBot Hub Mini](https://www.switch-bot.com/products/switchbot-hub-mini) or [SwitchBot Hub Plus](https://www.switch-bot.com/products/switchbot-hub-plus) Required
+    - Enable Cloud Services for Device on SwitchBot App
+- [SwitchBot Motion Sensor](https://www.switch-bot.com/products/motion-sensor)
+    - [SwitchBot Hub Mini](https://www.switch-bot.com/products/switchbot-hub-mini) or [SwitchBot Hub Plus](https://www.switch-bot.com/products/switchbot-hub-plus) Required
+    - Enable Cloud Services for Device on SwitchBot App
+- [SwitchBot Contact Sensor](https://www.switch-bot.com/products/contact-sensor)
+    - [SwitchBot Hub Mini](https://www.switch-bot.com/products/switchbot-hub-mini) or [SwitchBot Hub Plus](https://www.switch-bot.com/products/switchbot-hub-plus) Required
+    - Enable Cloud Services for Device on SwitchBot App    
+- [SwitchBot Curtain](https://www.switch-bot.com/products/switchbot-curtain)
+    - [SwitchBot Hub Mini](https://www.switch-bot.com/products/switchbot-hub-mini) or [SwitchBot Hub Plus](https://www.switch-bot.com/products/switchbot-hub-plus) Required
+    - Enable Cloud Services for Device on SwitchBot App
+- [SwitchBot Bot](https://www.switch-bot.com/products/switchbot-bot)
+    - [SwitchBot Hub Mini](https://www.switch-bot.com/products/switchbot-hub-mini) or [SwitchBot Hub Plus](https://www.switch-bot.com/products/switchbot-hub-plus) Required
+    - Enable Cloud Services for Device on SwitchBot App
+    - You must set your Bot's Device ID in the Press Mode or Switch Mode Bot Settings (Advanced Settings > Bot Settings)
+        - Press Mode - Turns on then instantly turn it off
+        - Switch Mode - Turns on and keep it on until it is turned off
+            - This can get out of sync, since API doesn't give me a status
+            - To Correct you must go into the SwitchBot App and correct the status of either `On` or `Off`
+- SwitchBot Plug
+
+## Supported IR Devices
+### _(All IR Devices require [Hub Plus](https://www.switch-bot.com/products/switchbot-hub-plus) or [Hub Mini](https://www.switch-bot.com/products/switchbot-hub-mini))_
+
+- TV
+    - Allows for On/Off and Volume Controls
+- Projector (Displayed as TV)
+    - Allows for On/Off and Volume Controls
+- Set Top Box  (Displayed as Set Top Box)
+    - Allows for On/Off and Volume Controls
+- DVD  (Displayed as Set Top Box)
+    - Allows for On/Off and Volume Controls
+- Streamer  (Displayed as Streaming Stick)
+    - Allows for On/Off and Volume Controls
+- Speaker  (Displayed as Speaker)
+    - Allows for On/Off and Volume Controls
+- Fans
+    - Allows for On/Off Controls
+    - Optional Rotation Speed
+    - Optional Swing Mode
+- Lights    
+    - Allows for On/Off Controls
+- Air Purifiers
+    - Allows for On/Off Controls
+- Air Conditioners
+    - Allows for On/Off, Tempeture, and Mode Controls
+    - Optional Disable Auto Mode
+- Cameras    
+    - Allows for On/Off Controls
+- Vacuum Cleaners    
+    - Allows for On/Off Controls
+- Water Heaters    
+    - Allows for On/Off Controls  
+- Others 
+    - Option to Dispaly as differenet Device Type
+        - Supports Fan Device Type
+    - Allows for On/Off Controls           
+
+## SwitchBotAPI
+
+- [OpenWonderLabs/SwitchBotAPI](https://github.com/OpenWonderLabs/SwitchBotAPI)
+
+## Community
+
+* [SwitchBot (Official website)](https://www.switch-bot.com/)
+* [Facebook @SwitchBotRobot](https://www.facebook.com/SwitchBotRobot/) 
+* [Twitter @SwitchBot](https://twitter.com/switchbot) 

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

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

Improved metrics

Total package byte prevSize

1004729

increased by0.44%

Number of lines in readme file

113

increased by927.27%

No dependency changes