iotschema-node-red

iot.schema.org interactions implemented as Node-RED Nodes.

Quick Start

The Node-RED nodes can be installed in one of several ways:

1. Installing via Docker (recommended)
2. Building the Docker image manually and installing
3. Installing via npm to a preexisting Node-RED instance
4. Manual install (advanced)

Installing via Docker (recommended)

The latest iot.schema.org Node-RED nodes as well as the associated Ubuntu Docker instance can be issued from the Docker hub with the following command:

docker pull iotschema/iotschema-node-red

Building the Docker image manually and installing

You can also elect to manually build the Docker image and install from there rather than using the Docker hub. To do this, follow the steps below:

1. Check out the current Github repo
2. Navigate to /src/Docker
3. Issue the docker build command with your desired arguments

docker build --tag iotschema-node-red:1.0 .

4. Run the image with your desired arguments

docker run --publish 1880:1880 --publish 8080:8080 --detach --name iotschema-node-red iotschema-node-red:1.0

Installing via npm to a preexisting Node-RED instance

If you already have a running Node-RED instance (or if you do not wish to use Docker), The nodes can also be separately installed from npm.

• To install all available iot.schema.org nodes, use

npm install @iotschema/iotschema-capability

• The install the utility nodes for TD generation, TD configuration/persistence and match making, use

npm install @iotschema/iotschema-utilitynodes

• Individual nodes can also be installed rather than installing the umbrella packages, for example:

npm install @iotschema/binaryswitch

Manual install (advanced)

1. Install Node-RED:

sudo npm install -g --unsafe-perm node-red

2. Install iot.schema.org Node-RED Nodes:

cd $NODE_RED_HOME

3. Install adaptor Node-RED Nodes:

npm install iotschema-node-red/nodes/adaptors/*

4. Install Node-RED Nodes to run the Temperature Control example (Running Example 1):

npm install iotschema-node-red/nodes/examples/*
npm install node-red-contrib-coap

5. Install Node-RED Node to generate a W3C Web of Things (WoT) Thing Description:

npm install iotschema-node-red/nodes/TDGenerator

6. Install Node-RED Node for W3C Web of Things (WoT) Thing Directory to store Thing Description:

npm install iotschema-node-red/nodes/TDConfigureNode

See Running Example 2 to learn more about how to use "TDGenerator" and "TDconfigureNode" Nodes to generate and store a Thing Description.

Running Example 1

This flow (Recipe) controls ambient air temperature, by using iot.schema.org TemperatureSensing and Thermostat Capabilities.

1. Start Node-RED:

node-red

2. Copy the content of TemperatureControl.json from:

cd iotschema-node-red/lib/examples/

to your clipboard

3. Open Node-RED in Browser and import the flow:

Open <http://localhost:1880>
Menu > Import > Clipboard

4. Deploy the flow, and see the result in system console.

For details about the running example, see the documentation.

Running Example 2

This flow (Thing Description Generation) generates a W3C WoT Thing Description for the Temperature device by using iot.schema.org TemperatureSensing Capability and TDGenerator node. Then it stores the generated TD in Thing Directory using Thing Directory config node in Node-RED.

1. Start Node-RED:

node-red

2. Copy the content of TemperatureTDGeneration.json from:

cd iotschema-node-red/lib/examples/

to your clipboard

3. Open Node-RED in Browser and import the flow:

Open <http://localhost:1880>
Menu > Import > Clipboard

4. Deploy the flow. "TDGenerator" node generates semantically enriched Thing Description for Temperature device using iotschema TemperatureSensing capability.

5. Open the Thing Directory configuration node (as shown in the Figure:https://github.com/iot-schema-collab/iotschema-node-red/blob/master/images/TemperatureTDGeneration.PNG)

6. Start Thing Directory (by clicking "Start" button), store Thing Description by selecting (Store TD/ Recipe option)

7. Click on "Store/Retrieve" button to store the Thing Description in Thing Directory.