@blockbax/node-red-contrib-blockbax 0.0.8

A set of Node-RED nodes to interact with the Blockbax Platform

npm install @blockbax/node-red-contrib-blockbax

A set of Node-RED nodes to interact with the Blockbax Platform. Please read our documentation for more information.

Install

Run the following command in the root directory of your Node-RED install:

npm install -s @blockbax/node-red-contrib-blockbax

Usage

There are a number of different nodes available. The first node can be used to parse measurement data to a common format which can be used by the other nodes. Once this is done, you can use nodes to aggregate the resulting measurements and send this data to our platform.

Parse

Takes a msg from another node and creates a new object that can be used by the other Blockbax nodes. You can configure what message properties represent the date, the value and the ingestion ID. There is also an option to generate a timestamp on input if the message has no timestamp property. The Parse node adds a series property to the message and sends it on input. The node has three configurable properties besides the Name property:

  • Use Ingestion ID: Checked to true by default, uncheck to construct an 'Ingestion ID' from a 'Subject External ID' and a 'Metric External ID'. The 'Ingestion ID' will be constructed like this: <Subject External ID>$<Metric External ID>
  • Ingestion ID: Can either be a static or a dynamic by changing the type to msg.
  • Subject External ID: only when Use Ingestion ID is unchecked, Can either be a static or a dynamic by changing the type to msg.
  • Metric External ID: only when Use Ingestion ID is unchecked, Can either be a static or a dynamic by changing the type to msg.
  • Date: Can either be a msg property or it can be set to use the current date.
  • Value: Measurement value. Usually values are stored in the msg.payload property.
  • Data type: Data type. Choose either Number, Location or Text. Can be dynamically set by changing the type to msg.

Aggregate

This node applies an aggregate function over a a specified time period. The available functions are: maximum, minimum, sum, average, downsample (using the Ramer–Douglas–Peucker algorithm). The node has three configurable properties besides the Name property:

  • Function : Aggregation function to apply.
  • Period : Time period to aggregate over.

Send

The send node can either be used to batch and send measurements to the HTTP and MQTT endpoints or send data to a inbound connector. When used to send to an inbound connector messages are directly send to the inbound connector without batching. otherwise this node will sends batches of measurements upon a specified time interval. The minimal frequency at which data can be sent is 1 second. The available send options are:

  • HTTP: Recommended if irregular batches of data are being collected.
  • MQTT: Recommended if the incoming data is a frequent and regular stream of data points.

The node has three configurable properties besides the Name property:

  • Project: Configuration of your project ID and access token information. You can also check the 'Use environment variables' checkbox to use the environment variables PROJECT_ID, ACCESS_TOKEN_PUBLIC_ID and ACCESS_TOKEN_SECRET instead.
  • Use Inbound Connector: Checked to false by default, check to send to a inbound connector.
  • Auto Create Subjects: Checked to false by default, check to auto create subjects.
  • Inbound Connector ID: Only when Use Inbound Connector is checked, set to the ID of the inbound connector.
  • Type: Type of connection used.
  • Batch Period: Only when Use Inbound Connector is unchecked, period for which measurements are batched before they are being send.

Node Info

Version: 0.0.8
Updated 2 months ago
License: MIT
Rating: 3.0 2

Actions

Rate:

Downloads

4 in the last week

Nodes

  • Parse
  • Send
  • Aggregate
  • Project

Keywords

  • node-red
  • blockbax
  • iot
  • edge
  • sensors
  • data