Commit 6f68ccaf authored by David Mondou's avatar David Mondou
Browse files

Merge branch 'examples/dependencies' into 'master'

Examples/dependencies

See merge request vesta/node-red-contrib-noble-connect!5
parents f866487d 9f1901de
......@@ -7,16 +7,30 @@ A Node-Red node that will scan for and connect to BlueTooth Low-Energy devices.
Installation
============
Per https://nodered.org/docs/creating-nodes/packaging#testing-a-node-module-locally, run the following commands
Dependencies
------------
.. code-block:: console
Besides the dependencies listed in ``package.json``, you will want to install the following, manually:
$ cd <path to node-red-contrib-noble-connect>
$ npm link
...
$ cd ~/.node-red
$ npm link node-red-contrib-noble-connect
...
.. code-block:: console
$ npm install -g node-red node-red-dashboard node-red-contrib-aws
It's also possible some of the dependencies listed in ``package.json`` will need to be installed globally. There seems to be an issue on some systems where a package installed both locally and globally will cause bugs. For best results, manually install the ``package.json`` dependencies globally.
Linking
-------
Once dependencies are installed, link the package with the following commands:
.. code-block:: console
$ cd <path to node-red-contrib-noble-connect>
$ npm link
...
$ cd ~/.node-red
$ npm link node-red-contrib-noble-connect
...
Running
=======
......@@ -26,7 +40,7 @@ Once the node is linked, it should be available once you start Node-RED. With No
Examples
========
This node includes an example flow. To access it, open the settings menu at the top right corner of the page. Hover over "Import", then "Examples", then "noble connect".
This node includes example flows. To access them, open the settings menu at the top right corner of the page. Hover over "Import", then "Examples", then "noble connect".
- The ``demo-kit`` example flow will use a noble-connect node to scan for and connect to Nordic Thingy\:52 devices. It will show the Thingy data on a dashboard (accessible at ``/ui`` from the Node-RED URL), as well as optionally sending it to an Amazon Lambda.
- The ``sensorkit-to-dynamodb`` example flow will use a ``node-red-contrib-noble`` node to scan for nearby devices. It will use their broadcast data and push it up to a configured DynamoDB instance. For more information about this flow, see Rigado's tutorial documentation at https://developer.rigado.com/docsets/Working-with-the-Rigado-Vesta-Gateway/v1.0.5/tutorials/node-red.html
......@@ -703,7 +703,7 @@
"name": "Rigado Demo Kit Lambda",
"method": "POST",
"ret": "obj",
"url": "https://staug8zev0.execute-api.us-west-2.amazonaws.com/staging/datapoint/",
"url": "https://staug8zev0.execute-api.us-west-2.amazonaws.com/prod/datapoint/",
"tls": "",
"x": 970,
"y": 540,
......
......@@ -17,10 +17,10 @@
"license": "All rights reserved",
"dependencies": {
"async": "^2.5.0",
"bindings": "^1.3.0",
"bluetooth-hci-socket": "^0.5.1",
"noble": "^1.8.1",
"os": "^0.1.1",
"semaphore": "^1.1.0",
"bindings": "^1.3.0",
"bluetooth-hci-socket": "^0.5.1"
"semaphore": "^1.1.0"
}
}
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment