Merge branch 'develop' of https://github.com/CANDY-LINE/node-red-contrib-generic-ble into develop

* 'develop' of https://github.com/CANDY-LINE/node-red-contrib-generic-ble: (153 commits)
  Add a new file for change logs
  Update README
  Strip HCI dump instruction as this node no longer uses HCI socket
  Throw an error when a peripheral is not connected on read/write/subscribe oeprations
  Update example flow
  Fix an issue where this would be undefined as _addDashes was unbound
  Fix an issue where connectPeripheral() failed to return a value
  Add support for 16bit uuid translation
  Loose the condition to replace the device name
  Prepend _ for internal function
  Suppress DoesNotExist error
  Swallow an exception while emitting characteristicsDiscover event
  Fix an issue where characteristic discovery request was never interrupted when an peripheral device was missing
  Refactor error handler
  Strip NodeCache
  Rename variable
  Strip unused resources
  Show error while receiving error event
  Add missing status support and permission error alerting
  Add error event handler
  ...

Author: Daisuke Baba

.babelrc

@@ -0,0 +1,19 @@
+{
+  "presets": [
+    [
+      "@babel/preset-env",
+      {
+        "targets": {
+          "node": "current"
+        }
+      }
+    ]
+  ],
+  "env": {
+    "test": {
+      "plugins": [
+        "@babel/plugin-transform-modules-commonjs"
+      ]
+    }
+  }
+}

.eslintrc.js

@@ -0,0 +1,25 @@
+module.exports = {
+  root: true,
+  env: {
+    browser: false,
+    node: true,
+    es6: true,
+    mocha: true,
+    jest: true
+  },
+  parserOptions: {
+    parser: 'babel-eslint',
+    sourceType: 'module',
+    ecmaVersion: 9
+  },
+  extends: [
+    'plugin:prettier/recommended',
+    'prettier',
+    'eslint:recommended',
+  ],
+  plugins: [
+    'prettier'
+  ],
+  rules: {
+  }
+}

.jshintrc

@@ -0,0 +1,4 @@
+{
+  "semi": true,
+  "singleQuote": true
+}

.prettierrc

@@ -0,0 +1,67 @@
+# Revision History
+
+* 4.0.0
+  - The node category is now Network rather than Input and Output.
+  - Improve stability on Linux by introducing BlueZ 5 D-Bus API
+    - On Linux, this node no longer depends on HCI socket library.
+    - Note that when Node-RED process is run by non-root user, add the user to `bluetooth` group so to access BlueZ D-Bus API. For example, run `sudo usermod -G bluetooth -a pi` prior to starting the process if it's run by `pi` user.
+    - BlueZ's BLE scanning seems to detect devices having `random` address type. But not sure if such devices work with this node properly.
+    - Tested on Raspbian (4.19.97-v7l+) and Raspberry Pi 3/4.
+      - With the following packages
+        - bluez 5.50-1.2~deb10u1
+        - bluez-firmware 1.2-4+rpt2
+  - Improve BLE Device Scanning UI/UX
+    - Check `BLE Scanning` in order to start scanning, and `Scan Result` select box will be fullfilled automatically whenever devices are found. The update will be performed every 10 seconds. The first scan result will appear after 5 seconds since the scanning starts. See the updated README document for detail.
+  - `GENERIC_BLE_TRACE` environment variable is no longer working. Use `DEBUG` environment variable instead.
+    - `DEBUG=node-red-contrib-generic-ble:index` is compatible with `GENERIC_BLE_TRACE=true`.
+    - `DEBUG=node-red-contrib-generic-ble:*` will output all trace logs within the project.
+    - `DEBUG=node-red-contrib-generic-ble:index:api` will output all API endpoint access logs.
+    - `DEBUG=node-red-contrib-generic-ble:noble:*` will output all trace logs under `src/noble` modules.
+
+* 3.1.0
+  - Support Node.js v10.x LTS (Fix #14 and #17)
+
+* 3.0.0
+  - Refactor entire architecture
+  - Peripheral connections are retained until it disconnects
+  - Characteristic subscriptions are retained while the ongoing flows are running (will be unsubscribed on stopping them though)
+  - The max number of concurrent BLE connections is 5 or 6 according to [this document](https://github.com/noble/noble#maximum-simultaneous-connections)
+
+* 2.0.4
+  - Fix an issue where this node don't work with [email protected]
+
+* 2.0.3
+  - Fix an issue where noble looses a reference to a peripheral after it is disconnected
+
+* 2.0.2
+  - Fix an issue where Write operation cannot be performed properly (#4)
+
+* 2.0.1
+  - Fix an issue where `Select from scan result` failed to list characteristics
+
+* 2.0.0
+  - Add `Poll Notify Events` message support so that Generic BLE out node can start to subscribe the given characteristic events
+  - Support characteristic query by one or more uuids
+  - Add `Mute Notify Events` to `Generic BLE` config node for this node to avoid unnecessary device connection for event subscription
+  - Replace `RED.log` functions with node logging functions as possible to offer precise logging control via UI
+  - Add `Operation Timeout` to `Generic BLE` config node to set the waiting time for Read/Write/Notify response **per characteristic** rather than per device
+  - `GENERIC_BLE_OPERATION_WAIT_MS` is introduced for default `Operation Timeout` value
+  - Remove `Listening Period` from `Generic BLE` config node
+  - `GENERIC_BLE_NOTIFY_WAIT_MS` is removed
+
+* 1.0.2
+  - Improve README
+  - Add an example flow file available from the editor UI
+
+* 1.0.1
+  - Fix an issue where custom characteristics cannot be listed on the Generic BLE config node dialog
+
+* 1.0.0
+  - Fix an issue where some devices cannot be discovered within a specific time window even after they can be connected
+  - Fix an issue where the Scan Result select widget didn't show the same item as the stored device info
+  - Update Scan Result option list whenever Local Name is resolved
+  - Improve stability by fixing minor bugs
+
+* 0.1.0
+  - Initial Release (alpha)
+  - `node-red` keyword is not yet added

CHANGELOG.md

@@ -1,7 +1,9 @@
 node-red-contrib-generic-ble
 ===
 
-A Node-RED node for providing access to generic BLE devices via GATT.
+A Node-RED node for providing access to generic BLE peripheral devices via GATT.
+
+As of v4.0.0, this node is optmized for Linux with BlueZ 5.
 
 Supported operations are as follows:
 
@@ -10,9 +12,18 @@ Supported operations are as follows:
 - Write without Response
 - Notify
 
+In this version, the node status values are as follows:
+
+- `missing` the configured BLE peripheral device is missing.　When the device is discovered, the state transitions to `disconnected`. The `disconnected` device may transiton to `missing` again when RSSI is invalidated (Linux only)
+- `disconnected` when the configured BLE peripheral device is found but not conncted
+- `connecting` when the configured BLE peripheral device is being connecting
+- `connected` when the configured BLE peripheral device is connected
+- `disconnecting` when the configured BLE peripheral device is being disconnecting
+- `error` when unexpected error occurs
+
 # How to use
 
-## How to configure a new BLE peripheral
+## How to configure a new BLE peripheral device
 
 At first, drag either a `generic ble in` node or a `generic ble out` node to the workspace from the node palette and double-click the node. And you can find the following dialog. Here, click the pencil icon (`1`) to add a new BLE peripheral or edit the existing one.
 
@@ -149,11 +160,22 @@ See `info` tab for detail on the editor UI.
 
 # Example Flow
 
-You can import [the example flow](examples/01-read-write.json) on Node-RED UI. You need to change Generic BLE config node named `nRF5x` or add a new config node for your device.
+You can import [the example flow](examples/01-read-write.json) on Node-RED UI.
+
+# Installation Note (Linux)
+
+The Node-RED process owner must belong to `bluetooth` group.
+For example, if you're going to run the process by `pi` user, run the following command.
+
+```
+sudo usermod -G bluetooth -a pi
+```
 
-# How to install
+Then reboot the OS so that the policy changes take effect.
 
-This will take approx. 3 minutes on Raspberry Pi 3.
+```
+sudo reboot
+```
 
 ## Node-RED users
 
@@ -189,70 +211,3 @@ $ NODE_ENV=development npm run build
 # package
 $ NODE_ENV=development npm pack
 ```
-
-## HCI Dump Debugging (Raspbian/Ubuntu/Debian)
-
-```
-sudo apt-get update
-sudo apt-get install bluez-hcidump
-```
-
-then
-
-```
-sudo hcidump -t -x
-```
-
-## Enabling trace log
-
-Set `GENERIC_BLE_TRACE=true` on starting Node-RED and you can find the precise log in `/var/log/syslog`.
-
-# Revision History
-
-* 3.1.0
-  - Support Node.js v10.x LTS (Fix #14 and #17)
-
-* 3.0.0
-  - Refactor entire architecture
-  - Peripheral connections are retained until it disconnects
-  - Characteristic subscriptions are retained while the ongoing flows are running (will be unsubscribed on stopping them though)
-  - The max number of concurrent BLE connections is 5 or 6 according to [this document](https://github.com/noble/noble#maximum-simultaneous-connections)
-
-* 2.0.4
-  - Fix an issue where this node don't work with [email protected]
-
-* 2.0.3
-  - Fix an issue where noble looses a reference to a peripheral after it is disconnected
-
-* 2.0.2
-  - Fix an issue where Write operation cannot be performed properly (#4)
-
-* 2.0.1
-  - Fix an issue where `Select from scan result` failed to list characteristics
-
-* 2.0.0
-  - Add `Poll Notify Events` message support so that Generic BLE out node can start to subscribe the given characteristic events
-  - Support characteristic query by one or more uuids
-  - Add `Mute Notify Events` to `Generic BLE` config node for this node to avoid unnecessary device connection for event subscription
-  - Replace `RED.log` functions with node logging functions as possible to offer precise logging control via UI
-  - Add `Operation Timeout` to `Generic BLE` config node to set the waiting time for Read/Write/Notify response **per characteristic** rather than per device
-  - `GENERIC_BLE_OPERATION_WAIT_MS` is introduced for default `Operation Timeout` value
-  - Remove `Listening Period` from `Generic BLE` config node
-  - `GENERIC_BLE_NOTIFY_WAIT_MS` is removed
-
-* 1.0.2
-  - Improve README
-  - Add an example flow file available from the editor UI
-
-* 1.0.1
-  - Fix an issue where custom characteristics cannot be listed on the Generic BLE config node dialog
-
-* 1.0.0
-  - Fix an issue where some devices cannot be discovered within a specific time window even after they can be connected
-  - Fix an issue where the Scan Result select widget didn't show the same item as the stored device info
-  - Update Scan Result option list whenever Local Name is resolved
-  - Improve stability by fixing minor bugs
-
-* 0.1.0
-  - Initial Release (alpha)
-  - `node-red` keyword is not yet added