node-red-contrib-scx-ibmiotapp

ibmiotapp

This is a Node-RED node meant for connecting to both the Quickstart and Registered flows in IBM Watson IoT Platform. This Node-RED node replaces the node-red-iotcloudshapeshift. This Node-RED node can be used within, as well as, outside the IBM Bluemix environment.

In case it is used within the IBM Bluemix environment, the node is smart enough to detect whether an IoT service is bound to this application and provides the respective drop-down options. In case no IoT service is bound to this application, the drop-down, for authentication, does not contain "Bluemix Service".

Install

Install from npm

npm install node-red-contrib-scx-ibmiotapp

Supported Features

Feature	Supported?	Description
Application connectivity	✔	Connect your application(s) to Watson IoT Platform with ease using this library. Click here for detailed information on how applications can subscribe to device events and publish commands to devices.
SSL/TLS support	✔	By default, this library connects your applications securely to Watson IoT Platform registered service. Ports 8883(default one) and 443 support secure connections using TLS with the MQTT and HTTP protocol. Also, note that the library uses port 1883(unsecured) to connect to the Quickstart service.
Auto reconnect	✔	Enables device and gateway to automatically reconnect to Watson IoT Platform while they are in a disconnected state. Further details here.
Multi-format support	✔	JSON, Buffer, Number String, Boolean and Other types.
Websocket	✘	Currently not supported.

Usage

IoT App In Node

In case of Registered flow, the App In node can be used to

• Receive device events,
• Reveive device state update events,
• Receive device state error events,
• Receive rule trigger events,
• Receive rule error events,
• Receive device status,
• Receive device commands, on the behalf of a device, and
• Receive application status.

In case of Quickstart flow, the App In node can be used to

• Receive device events,
• Receive device status and
• Receive application status.

IoT App Out Node

In case of registered flow, the App Out node can be used to

• Send device commands and
• Send device events, on the behalf of a device.

In case of quickstart flow, the App Out node can be used to

• Send device events, on the behalf of a device.

Usage outside IBM Bluemix environment

In case the out and in nodes need to run outside the IBM Bluemix environment, use the API Key dropdown option

• On selecting the API Key, API Key and API Token options are made available
• The API Key and Token can be shared across multiple nodes

Supported formats

• JSON,
• buffer,
• number
• String
• boolean and Other types.

JSON

When the format is specified as json, one can send the JSON object or the Stringify version of the JSON object using the App Out Node. Upon receiving from the Watson IoT Platform, the App In Node parses and sends the JSON object to the output.

Buffer

The buffer should be sent as is without doing any conversion. Upon receiving it, the App In Node forwards the buffer as is without any conversion.

Other types

Similar to buffer, the IoT App Out Node sends the payload as is in the case of number, string, boolean and other types. Upon receiving them, the App In Node forwards the values as Strings.

Note

For Device Id, this node ignores any character other than alphanumeric, the period symbol, hyphen and the underscore character.

Authors

Amit M Mangalvedkar (@amitmangalvedka)
Jeffrey Dare (@jeffdare)

Copyright and license

Copyright 2014, 2016 IBM Corp. under the Apache 2.0 license.

=======