node-red-contrib-blynk-ws - npm Package Compare versions

Comparing version 0.4.0 to 0.5.0

CHANGELOG.md

@@ -9,2 +9,33 @@ # Changelog
 
+## [0.5.0] - 2018-04-14
+### Added
+- Blynk protocol - Handle any number of Blynk commands (virtualWrite(), setProperty(), etc.) in a row see [Blynk Library 0.5.0](https://community.blynk.cc/t/beta-blynk-library-v0-5-0/19841)
+- Control max lenght of message and max number of commands in a single message 
+- Config node - Option to enable "Multiple blynk command in single message"  (blynk cloud or local server >= v0.34.0) 
+- Config node - Implemented server proxy configuration
+- Config node - Option to log protocol "sync" and "bridge" messages type
+- Node - *Bridge* - New node that implements the functionality of sending commands to other blynk devices.
+- Node - *Sync* - New node that implements the "syncAll" and "syncVirtual" blynk commands
+- Node - *Set Property* - Implemented "step" for Step Widget  (blynk cloud or local server >= v0.32.2)
+- Node - *Set Property* - Implemented "url" for Video Straming Widget (blynk cloud or local server >= v0.28.7)
+- Node - *Set Property* / *LCD* / *Table* - Send multiple blynk command in a single message
+- Node - *Read Event* - Option to receive all pins events
+- Node - *Write Event* - Option to receive all pins events
+- Node - *Write Event* - Added pin number that generate event in msg.pin variable
+- Initial support to [Internationalisation](https://nodered.org/docs/creating-nodes/i18n)
+
+### Changed
+- Better handle of configuration node error, now blocks child nodes if some parameter is missing.
+- More check on "pin" parameter before send message
+- The PING command is only sent if no data has been sent or received in the "heart beat" time
+- Hide "Auth token" - from all log message
+- Config node - Rename "Private key" to "Auth token" and better help message
+- Split every node on single file
+- Removed dependency from "DataView" package
+- Code clean
+
+### Fixed
+- Rightly handles the reception of the BRIDGE type commands.
+- Websocket SSL connection error on nodejs > 8.6.0 see ([ws iusse #1227](https://github.com/websockets/ws/issues/1227))
+
 ## [0.4.0] - 2018-03-09
@@ -54,7 +85,8 @@ ### Added
 ### Changed
-- Blynk Protocol - Rewritten send and receive message functions, with more options, like 'Blynk-library-js'
+- Blynk Protocol - Rewritten send and receive message functions, with more options, like [vshymanskyy/blynk-library-js](https://github.com/vshymanskyy/blynk-library-js)
 - Heartbeat once 10 seconds
 - Max virtual pin allowed 128
 
-[Unreleased]: https://github.com/gablau/node-red-contrib-blynk-ws/compare/0.4.0...HEAD
+[Unreleased]: https://github.com/gablau/node-red-contrib-blynk-ws/compare/0.5.0...HEAD
+[0.5.0]: https://github.com/gablau/node-red-contrib-blynk-ws/compare/0.4.0...0.5.0
 [0.4.0]: https://github.com/gablau/node-red-contrib-blynk-ws/compare/0.3.0...0.4.0
@@ -61,0 +93,0 @@ [0.3.0]: https://github.com/gablau/node-red-contrib-blynk-ws/compare/0.2.0...0.3.0

package.json

 {
   "name": "node-red-contrib-blynk-ws",
-  "version": "0.4.0",
+  "version": "0.5.0",
   "description": "Node Red integration with Blynk App and Server through websockets",
-  "main": "blynk-ws.js",
   "scripts": {
@@ -26,10 +25,23 @@ "test": "echo \"Error: no test specified\" && exit 1"
   "dependencies": {
-    "buffer-dataview": ">=0.0.2",
-    "ws": ">=1.0.1"
+    "ws": ">=1.0.1",
+    "https-proxy-agent": ">=2.0.0",
+    "secure-random-string": ">=1.1.0",
+    "compare-versions": ">=3.1.0"
   },
   "node-red": {
     "nodes": {
-      "blynk": "blynk-ws.js"
+      "blynk-ws-client": "nodes/blynk-ws-client.js",
+      "blynk-ws-in-app": "nodes/blynk-ws-in-app.js",
+      "blynk-ws-in-read": "nodes/blynk-ws-in-read.js",
+      "blynk-ws-in-write": "nodes/blynk-ws-in-write.js",
+      "blynk-ws-out-write": "nodes/blynk-ws-out-write.js",
+      "blynk-ws-out-set-property": "nodes/blynk-ws-out-set-property.js",
+      "blynk-ws-out-sync": "nodes/blynk-ws-out-sync.js",
+      "blynk-ws-out-bridge": "nodes/blynk-ws-out-bridge.js",
+      "blynk-ws-out-email": "nodes/blynk-ws-out-email.js",
+      "blynk-ws-out-lcd": "nodes/blynk-ws-out-lcd.js",
+      "blynk-ws-out-notify": "nodes/blynk-ws-out-notify.js",
+      "blynk-ws-out-table": "nodes/blynk-ws-out-table.js"
     }
   }
 }

README.md

@@ -0,9 +1,28 @@
+[![npm version](https://img.shields.io/npm/v/node-red-contrib-blynk-ws.svg)](https://www.npmjs.com/package/node-red-contrib-blynk-ws)
+[![Npm download](https://img.shields.io/npm/dm/node-red-contrib-blynk-ws.svg)](https://www.npmjs.com/package/node-red-contrib-blynk-ws)
+[![GitHub stars](https://img.shields.io/github/stars/gablau/node-red-contrib-blynk-ws.svg)](https://github.com/gablau/node-red-contrib-blynk-ws/stargazers)
+[![GitHub issues](https://img.shields.io/github/issues/gablau/node-red-contrib-blynk-ws.svg)](https://github.com/gablau/node-red-contrib-blynk-ws/issues)
+[![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/gablau/node-red-contrib-blynk-ws/blob/master/LICENSE)
+
+[![NPM](https://nodei.co/npm/node-red-contrib-blynk-ws.png?downloads=true&downloadRank=true&stars=true)](https://www.npmjs.com/package/node-red-contrib-blynk-ws)
+
+__________
+
+
 # node-red-contrib-blynk-ws
-Blynk app integration with Node Red using WebSockets protocol
+Blynk library implementation for [Node-RED](https://nodered.org/) using WebSockets
 
-[![NPM](https://nodei.co/npm/node-red-contrib-blynk-ws.png?mini=true)](https://npmjs.org/package/node-red-contrib-blynk-ws)
-[![npm version](https://badge.fury.io/js/node-red-contrib-blynk-ws.svg)](https://badge.fury.io/js/node-red-contrib-blynk-ws)
+## What is Blynk?
+Blynk is a platform with iOS and Android apps to control Arduino, Raspberry Pi and the likes over the Internet.
+You can easily build graphic interfaces for all your projects by simply dragging and dropping widgets.
+If you need more information, please follow these links:
 
-## Websockets version
-This works for both local and cloud Blynk servers.
+* [Kickstarter campaign](https://www.kickstarter.com/projects/167134865/blynk-build-an-app-for-your-arduino-project-in-5-m/description)
+* [Blynk downloads, docs, tutorials](http://www.blynk.cc)
+* [Blynk community](http://community.blynk.cc)
+* [Facebook](http://www.fb.com/blynkapp)
+* [Twitter](http://twitter.com/blynk_app)
+
+## Node-RED blynk Websockets version
+This library supports both SSL (wss://) and non secure (ws://) connection to local server and Blynk cloud server.
 For local server, wss:// works only if you ve got a certificate installed.
@@ -15,6 +34,4 @@ For Blynk cloud server, you can use **ws://blynk-cloud.com/websockets** or with SSL **wss://blynk-cloud.com/websockets** as the server url.
 
-Supports both SSL wss:// and non secure ws:// connection to local server and Blynk cloud server.
+### Supported events, commands and widgets
 
-### Supported events and widgets
-
 - read event
@@ -24,5 +41,7 @@ - write event
 - write command
-- set property
-- emails
-- notify
+- bridge command
+- sync command
+- set property command
+- emails widget
+- notify widget
 - LCD widget
@@ -33,4 +52,8 @@ - Table widget
 
-[Detailed changelog](CHANGELOG.md)
+See the [changelog](CHANGELOG.md) for all the details of each releases
 
+### Node-RED palette
+
+![Available Nodes](./docs/img/blynk-palette.png)
+
 ### Blynk App Settings
@@ -42,9 +65,12 @@
 
-See help of every nodes
+See information panel on every nodes
+![Information Panel](./docs/img/readme-info-panel.png)
 
 ### Debug
 
-Use the verbose `-v` flag when starting Node-Red to get more information
+Use the verbose `-v` flag when starting Node-RED to get more information
 or use `node-red-log` and enable log on Configuration Node as needed
+![Log settings](./docs/img/readme-log-settings.png)
 
+
 ### Compatibility
@@ -60,2 +86,14 @@
 
+__________
+
+### Implementations for other platforms
+* [Arduino](https://github.com/blynkkk/blynk-library)
+* [Node.js, Espruino, Browsers](https://github.com/vshymanskyy/blynk-library-js)
+* [Particle](https://github.com/vshymanskyy/blynk-library-spark)
+* [Python, MicroPython](https://github.com/vshymanskyy/blynk-library-python)
+* [OpenWrt](https://github.com/vshymanskyy/blynk-library-openwrt)
+* [MBED](https://developer.mbed.org/users/vshymanskyy/code/Blynk/)
+* [LabVIEW](https://github.com/juncaofish/NI-LabVIEWInterfaceforBlynk)
+* [C#](https://github.com/sverrefroy/BlynkLibrary)
+
 ### Attributions
@@ -66,3 +104,5 @@
 Some javascripts code was derived from **blynk-library-js**:   
-     [https://github.com/vshymanskyy/blynk-library-js](https://github.com/vshymanskyy/blynk-library-js)  
-    MIT licence
+     [https://github.com/vshymanskyy/blynk-library-js](https://github.com/vshymanskyy/blynk-library-js) 
+
+### License
+This project is released under The MIT License (MIT)

New alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Network access

Supply chain risk

This module accesses the network.

Found 1 instance in 1 package

Environment variable access

Supply chain risk

Package accesses environment variables, which may be a sign of credential stuffing or data theft.

Found 1 instance in 1 package

Fixed alerts

Mixed license

License

(Experimental) Package contains multiple licenses.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

124388

increased by39.07%

Number of package files

48

increased by336.36%

Number of low license alerts

0

decreased by-100%

Lines of code

1879

increased by61.15%

Number of lines in readme file

103

increased by63.49%

Worsened metrics

Dependency count

4

increased by100%

Number of low supply chain risk alerts

1

increased byInfinity%

Number of medium supply chain risk alerts

2

increased byInfinity%

Dependency changes

• + Addedcompare-versions@>=3.1.0

• + Addedhttps-proxy-agent@>=2.0.0

• + Addedsecure-random-string@>=1.1.0

• + Addedagent-base@7.1.3(transitive)

• + Addedcompare-versions@6.1.1(transitive)

• + Addeddebug@4.4.0(transitive)

• + Addedhttps-proxy-agent@7.0.6(transitive)

• + Addedms@2.1.3(transitive)

• + Addedsecure-random-string@1.1.4(transitive)

• - Removedbuffer-dataview@>=0.0.2

• - Removedbuffer-dataview@0.0.2(transitive)