**********************
Node-Red Noble Connect
**********************

A Node-Red node that will scan for and connect to BlueTooth Low-Energy devices.

Installation
============

Dependencies
------------

Besides the dependencies listed in ``package.json``, you will want to install the following, manually:

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

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 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 ``dev-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