Javascript real-time SDK
iotflows-js npm package https://www.npmjs.com/package/@iotflows/iotflows-js
IoTFlows Open Source JavaScript WebSocket SDK.
With this tool you can:
  1. 1.
    Publish secure real-time data streams.
  2. 2.
    Subscribe to the data streams and access real-time data on your web/mobile/IoT apps.
  3. 3.
    Publish alerts to the alert channels with a defined severity level. Subscribers will get notified in the form of SMS/Email/Push.
  4. 4.
    Define cloud actions that can be called from other IoT devices/web applications.

Installation

Use npm to install the iotflows.js module:
1
npm install @iotflows/iotflows-js
Copied!

Usage

loadIoTFlows

This function will create and initialize an IoTFlows instance. This is an async function and you would need to use 'await' to ensure proper initialization.
1
const {loadIoTFlows} = require('@iotflows/iotflows-js')
2
var iotflows = await loadIoTFlows('API_KEY_USERNAME', 'API_KEY_PASSWORD');
Copied!
Make sure to change API_KEY_USERNAME and API_KEY_PASSWORD with the proper credentials obtained from IoTFlows console. These credentials can be either one of these options:
  1. 1.
    A Device API Key that has permission to interact with the resources available in its project, or
  2. 2.
    An Organization IoT API Key that can have read-only or read/write permissions to the entire organization resources
  3. 3.
    A User Client that is authorized to interact with the permitted resources of the user. This option is most useful when you need to build a web or mobile app. For this option, you need to register your Application in IoTFlows and authenticate users using OAuth2. With the obtained JWT, you can perform a Basic authentication HTTP request to generate a User Client.

Publish data stream

To publish a real-time data stream, you need to pass these parameters in a json object:
  • data_stream_uuid: the uuid of the data stream
  • data: the data to be published to the data stream
Read more:
Example:
1
await iotflows.publish({
2
data_stream_uuid: 'ds_xxxxxxxxxxxxxxxxxxxxxxx',
3
data: '81'
4
})
Copied!

Subscribe to data stream

To listen to real-time data streams that are published, you need to define the following parameters in a json object:
  • data_stream_uuid: data stream uuid
  • qos (optional): quality of service 0, 1, or 2 (0: At most once, 1: At least once, 2: Exactly once)
  • callback: handler function to be called when data received
Example:
1
await iotflows.subscribe({
2
data_stream_uuid: 'ds_xxxxxxxxxxxxxxxxxxxxxxx',
3
callback: function handler(topic, payload){
4
console.log("New message received!")
5
console.log(payload)
6
}
7
})
Copied!

Publish an alert

To publish an alert, you need to pass these parameters in a json object:
  • alert_channel_uuid: the uuid of the alert channel
  • severity: the severity of the alert. It can be MAJOR, MINOR or INFORMATIVE
  • subject: the subject of the alert
  • description: the description/message of the alert
Read more:
Example:
1
await iotflows.alert({
2
alert_channel_uuid: 'ac_xxxxxxxxxxxxxxxxxxxxxxxx',
3
severity: 'MINOR',
4
subject: 'Water Leak',
5
description: 'Water leackage detected in Site A.'
6
})
Copied!

Define a cloud action

To define a cloud action that can be called from other IoT/web applications, you need to define the following parameters in a json object:
  • action_uuid action uuid
  • qos (optional): quality of service 0, 1, or 2 (0: At most once, 1: At least once, 2: Exactly once)
  • callback: handler function to be called when action gets executed
Read more:
Example:
1
await iotflows.defineAction({
2
action_uuid: 'da_xxxxxxxxxxxxxxxxxxxxxxxxx',
3
callback: function handler(topic, payload){
4
console.log("New command received!")
5
console.log(payload)
6
}
7
})
Copied!

Call/Execute a cloud action

To publish an alert, you need to pass these parameters in a json object:
  • action_uuid: the uuid of the action
  • payload: the payload to be published to the action
Example:
1
await iotflows.callAction({
2
action_uuid: 'da_xxxxxxxxxxxxxxxxxxxxxxxxx',
3
payload: false
4
})
Copied!

Publish a generic MQTT message

To publish an MQTT message with a defined topic, you need to pass these parameters:
  • topic: the mqtt topic
  • payload: the message payload to be sent
Example:
1
await iotflows.publishMQTT(
2
'v1/organizations/92c2ddd58730dc9b4e9bb620e7ebcaf5/projects/e9531cc1d542999c0bf081c4147c206a/devices/8d786feef417aeb398f8076fecbe0242/data-streams/7ea022531d23b8d4a6622e3725b5fba2',
3
'Hello!'
4
)
Copied!

Subscribe to a generic MQTT topic

To subscribe to a generic MQTT topic, you need to define the following parameters:
  • topic: the mqtt topic
  • callback: the callback handler function that gets triggered once a message is received
Example:
1
iotflows.subscribeMQTT(
2
'v1/organizations/92c2ddd58730dc9b4e9bb620e7ebcaf5/#',
3
function handler(topic, payload){
4
console.log("New message received!")
5
console.log(topic)
6
console.log(payload)
7
}
8
)
Copied!
Last modified 2mo ago