node-red-contrib-heatweb

A set of nodes for working with Heatweb.

Usage no npm install needed!

<script type="module">
  import nodeRedContribHeatweb from 'https://cdn.skypack.dev/node-red-contrib-heatweb';
</script>

README

node-red-contrib-heatweb

A Node-RED set of nodes for interacting with Heatweb systems, handling message topics, and data storage.

Pre-requisites

There are no pre-requisites.

Install

Run the following command in the root directory of your Node-RED install. This is usually ~/.node-red

    npm install node-red-contrib-heatweb

Usage

Heatweb Connect Node

A single connect node should be used for establishing a link to the Heatweb server, and for initialising global variables.

Global Variables

  • readings - A nested object containing all message data.
  • node - A unique alpha-numeric identifier for the instance.
  • networkId - A unique alpha-numeric external identifier for the network.
  • localNetworkId - An alpha-numeric internal identifier for the network.
  • topics - A nested object containing the dictionary for interpreting messages.

Message Handling Node

Messages (data) fed into a handling node are stored in memory under the global readings object, and appended with additional relevant data extracted from the global topics object, such as a description and units of measurement.

Message topics are conditioned to match the standard 5 level Heatweb MQTT protocol:

network / publisher / device / data type / data key

About

Heatweb is a brand name of Thermal Integration Ltd. Heatweb.co.uk