smithtek-node-red-duty-standby

Node-RED SmithTek Node

This is a Node-RED node used to interact with the SmithTek service.

Installation --

npm install smithtek-node-red-duty-standby or install using pallete manager

The smithtek-nodered node for Node-RED is available as an npm package. We recommend you to read Node-RED documentation if you have any doubts installing nodes in the platform.

Usage

There are 4 different nodes: One for controlling the pumps, and 3 for formatting input msg.payload into the command format for that controller.

Smithtek Duty/Standby Controller

This Node will control two pumps, turning on and off the pumps in a 2 to 1 ratio, with the ability to specify the primary pump. The controller will attempt to start a pump and if it doesn't receive a sense flow signal in the specified time out, will attempt to switch pumps.

These are the properties you should configure, by double clicking the node:

• Flow Sense Delay: This amount of time to wait for the flow sense signal before switching pumps.
• Primary Pump: Which pump is primary (will run twice and then run the secondary once)

Commands

There are three commands that this node takes as input.

• startStop: This is the command to start and stop the pump. It has the format of:

{
  payload: {
    cmd:"startStop",
    value: true/false or 1/0
  }
}

• senseFlow: This is the command to indicate that flow has been sensed. True indicates flow has been detected. It has the format of:

{
  payload:{
    cmd:"senseFlow",
    flow: true/false or 1/0
  }
}

• pumpTrip: This is the command to lock/clear a pump. True will lock the pump, False will clear the lock. It has the format of:

{
  payload:{
    cmd:"pumpTrip",
    value:{
      pump: 1 or 2,
      trip: true/false or 1/0
    }
  }
}

Outputs

• pump 1: Output to control pump 1
• pump 2: Output to control pump 2
• no flow 1: True indicates no flow detected while running pump 1
• no flow 2: True indicates no flow detected while running pump 2

SmithTek startStop Formatter

This node is used to format the msg.payload on the input into the startStop command above. The incoming payload will become the value on the command.

SmithTek senseFlow Formatter

This node is used to format the msg.payload on the input into the senseFlow command above. The incoming payload will become the flow on the command.

SmithTek pumpTrip Formatter

This node is used to format the msg.payload on the input into the pumpTrip command above. The incoming payload will become the value.trip on the command.

These are the properties you should configure, by double clicking the node:

• Pump Number: Which pump is this for, it will become the value.pump in the output command.

Development

If you want to modify this extension, you just have to run npm install or yarn install to fetch and install the dependencies.

To install the development version and use it on your Node-RED instance, you can execute npm link on this folder and then execute npm link smithtek-nodered in your ~/.nodered folder.

License

Copyright (c) 2020 www.smithtek.com.au Licenced under the terms of the GPLv3

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL DAMIEN CLARK BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. Acknowledgements

We would like to thank the following people for their hard word, time and effort. For without them this node would not be possible � sensorhub.tech � Nick O'Leary and Dave Conway-Jones for creating Node-Red