Skip to content

Home

Jump to bottom
Dan-in-CA edited this page Aug 28, 2023 · 9 revisions

Documentation for SIP Node-red Extension

About the NODE-Red Extension

The node-red Extension is a SIP plugin designed to integrate node-red with SIP so that node-red flows can easily interact with SIP.
You can create flows to add features such as a simple timer to turn on lights at night: lights-flow
You could experiment with weather based irrigation management algorythms or whatever you like.
The extension uses HTTP POST requests to send commands to SIP and HTTP GET requests to receive data from SIP.

Getting started

You must have node-red installed. It can be on the Raspberry pi running SIP (recomemended) or another system on your local network.
If node-red is not already installed visit the NODE-red website and follow the instructions found there.

With node red runnning you can add the SIP nodes to the node-red palette.

  1. Open the ☰ menu and select Manage palette
  2. click the Install tab and search for SIP or irrigation.
  3. You should find an module named @sip-irrigation/node-red-sip-irrigation-nodes
  4. click install

Once the SIP nodes are installed you can optionally import the example flows for some or all SIP nodes.

  1. From the ☰ menu select import
  2. In the import nodes window that opens click Examples
  3. Expand the @sip-irrigation/node-red-sip-irrigation-nodes flow by clicking it.
  4. Choose current flow or new flow near the bottom of the window.
  5. Select an example you wish to import and click Import

Note: Some of the SIP examples include Dashboard nodes. To use those examples you should have the node-red-dashboard nodes installed.

If node-red is running on a system other than the raspberry Pi that SIP in on

  1. You will need to edit the http request nodes in the examples and replace localhost/jsin in the URL field with [URL of SIP]/jsin.

  2. you will need to edit the Node-red URL field at the bottom of the NODE-RED SETTINGS page on the SIP system. it should be in the form:
    http://[URL of the system nod-red in running on]:1880/node-red
    This will allow SIP to send messages to node-red.

For easy communication with sensors and other devices you may also find an MQTT broker such as Mosquitto to be very useful.

For advanced users

It is possible to use node-red to read and write most of SIP's control variables. This is detailed on the advanced_help page.

Clone this wiki locally