README.rst 1.57 KB
Newer Older
David Mondou's avatar
David Mondou committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
**********************
Node-Red Noble Connect
**********************

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

.. code-block:: console

   $ cd <path to node-red-contrib-noble-connect>
   $ npm link
   ...
   $ cd ~/.node-red
   $ npm link node-red-contrib-noble-connect
   ...

Running
=======

Once the node is linked, it should be available once you start Node-RED. With Node-RED installed globally, you should be able to run ``node-red`` from the command-line. If Node-RED is only installed locally to your project directory, you will need to run ``node node_modules/node-red/red.js``.

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".

-  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