User guide

Guide to Visualising Data Using Node-RED

Prerequisites

  • Pressac EnOcean Gateway Ethernet (E) or Ethernet, LTE and WiFi (ELW) running firmware version 0.4.1.7 or above.
  • Pressac EnOcean device compatible with the Pressac EnOcean Gateway e.g. CO2, Temperature and Humidity Sensor (EnOcean Radio Protocol Version).
  • Computer running either Windows or OSX
  • Suitable web browser to connect to both Node-RED and the Pressac EnOcean Gateway configuration pages.

Step 1: Setting up the Pressac EnOcean Gateway

Plug in one end of the Ethernet cable into your network point and plug the opposite end of the cable into the Ethernet port on the Pressac EnOcean gateway.

Connect the EnOcean antenna along by screwing it onto the connection on the Pressac EnOcean Gateway taking care not to cross thread or bend. If your gateway supports LTE and WiFi attach the antennas for these as well.

Connect your Pressac EnOcean Gateway’s power supply, connecting the power supply will boot up the Pressac EnOcean Gateway and you will see the products LED start blinking. The Pressac EnOcean Gateway will take a few seconds to initialise.

Next you need to find the IP Address of the Pressac EnOcean Gateway the most common way of doing this is to check your routers list of connected devices. If this is not possible the following alternative methods can be used.

  1. Windows: The Pressac EnOcean Gateway announces itself over Universal Plug and Play (UPnP) and can be found in the “Gateways” or “Other Devices” section of the Windows Network area to find this area click “Start” search for “Network” and click “View network connected computers and devices”. Double clicking a gateway from here will open up the web-ui.
  2. Mac: The Pressac EnOcean Gateway can be discovered using Bonjour. One of the easiest ways of using this method is to open “Safari” go to “Preferences” then “Advanced” and tick “Include Bonjour in the Bookmarks menu” close Preferences navigate to “Bookmarks” and you will now see all your networked Bonjour devices including the Pressac EnOcean Gateway.

Now you have the IP Address you can use it to access the Pressac EnOcean Gateways web interface launch your chosen web browser and type http://<your-ip> e.g. http://192.168.1.188
This will display the Pressac EnOcean Gateway’s first boot wizard. Follow the steps on the wizard to set up your Pressac EnOcean Gateway for the first time.

pressac-visualising-data-using-node-red1

Step 2: Add Your Devices to the Pressac EnOcean Gateway

To learn-in a new device click “– Add Devices” in the EnOcean sub-menu on the Pressac EnOcean Gateway web-interface and then click “Start”.

pressac-visualising-data-using-node-red2

This will initiate a 60 second countdown, during these 60 seconds the Pressac EnOcean Gateway will listen for the learn telegrams of devices in range of the Pressac EnOcean Gateway. This process can be cancelled by clicking “Cancel” and re-started for another 60 second duration by clicking “Search” again.

Ensure the Pressac EnOcean Gateway is listening for learn telegrams and press the “Learn” button on your Pressac device to locate the learn button for your device please consult your individual device manual. Once pressed a new device entry will now appear in a table with the following columns

Last Seen – The Date and Time the Pressac EnOcean Gateway last received a telegram from the device

Device ID – The unique identification number of the device

EEP – EnOcean Equipment Profile used by the device.

Security – Security enabled on the device Yes / No

dBm – Signasl strength of the device to the gateway

Action – The action column contains a menu containing options to EDIT AND ADD and DELETE the device.

pressac-visualising-data-using-node-red3

Click on “Edit and add” from the menu under the Action column as shown in the above image to edit the device a new screen will appear as shown in the image below.

pressac-visualising-data-using-node-red4

The only required field is the device name, it is advised to use a device name which resembles the function and location of the device. e.g. If your device is a CO2, Temperature and Humidity Sensor and it is situated in Classroom 1, your Device Name could be “Classroom1-CO2-Temperature-Humidity”.

Other optional properties include the location of your physical device. Please note that only characters A-Z, numbers, ‘_’ and ‘-‘ are permitted to be used in any of these fields.

Once you have specified your desired device name and any of the other optional properties click “Save” at the bottom of the screen to save the entry.

You can now navigate to the devices page and see the device along with its last state. Repeat step 2 until all your desired devices are learnt-in to the Pressac EnOcean Gateway.

Step 3: Enabling and Launching Node-RED

To enable Node-RED click “- Node-RED” in the Applications sub-menu on the Pressac EnOcean Gateway web-interface and then change the Node-RED option from “Disabled” to “Enabled”.

pressac-visualising-data-using-node-red5

Once you have selected “Enable” click “Save” the Node-RED status will now change to “Active” and a “Launch Node-RED” button will appear.

pressac-visualising-data-using-node-red6

If you would like to change the Username and Password used to login to Node-RED or the port Node-RED is available on this can be done from here. Change to your liking click “Save” and then finally click the “Launch Node-RED” button. Node-RED will open http://<your-gateway-ip>:<nodered-port> e.g. http://192.168.1.188:1880.

Step 4: Creating a Node-RED Dashboard Flow

Login to Node-RED using the username and password you configured on the Node-RED settings page. Default username and password are “admin” and “pressac”.

pressac-visualising-data-using-node-red7

Once logged in the Node-RED user interface will appear. Now we can begin to create our Node-RED dashboard flow.

pressac-visualising-data-using-node-red8

We have created three pre-made Node-RED flows which create dashboards to display Energy, Environment or Occupancy data. To import a pre-made Node-RED flow click the hamburger menu in the top right of the Node-RED interface, navigate to import and then select clipboard.

pressac-visualising-data-using-node-red9

An import nodes window will appear from here you can import your node from the clipboard or import from a file.

pressac-visualising-data-using-node-red10

Below you will find the code to copy to your clipboard along with a link to download files to create your chosen dashboard.

Energy Dashboard (Double-click code below to open)

[{“id”:”55fb34d9.2ebeac”,”type”:”tab”,”label”:”Energy”,”disabled”:false,”info”:””},{“id”:”94b7a433.ea45e8″,”type”:”function”,”z”:”55fb34d9.2ebeac”,”name”:”channel 2″,”func”:”msg.payload=msg.payload.current2\nreturn msg;”,”outputs”:1,”noerr”:0,”x”:440,”y”:140,”wires”:[[“c46dc8a0.0a4308”]]},{“id”:”c46dc8a0.0a4308″,”type”:”ui_gauge”,”z”:”55fb34d9.2ebeac”,”name”:”CT Channel 2″,”group”:”c424d60e.6d7ce8″,”order”:2,”width”:0,”height”:0,”gtype”:”gage”,”title”:”CT Channel “”lbl””””f””{{l}}””””””””l”[“b””””

Download as a file – energy-dashboard-pressac-node-red.json

Environment Dashboard (Double-click code below to open)

[{“id”:”55fb34d9.2ebeac”,”type”:”tab”,”label”:”Energy”,”disabled”:false,”info”:””},{“id”:”94b7a433.ea45e8″,”type”:”function”,”z”:”55fb34d9.2ebeac”,”name”:”channel 2″,”func”:”msg.payload=msg.payload.current2\nreturn msg;”,”outputs”:1,”noerr”:0,”x”:440,”y”:140,”wires”:[[“c46dc8a0.0a4308”]]},{“id”:”c46dc8a0.0a4308″,”type”:”ui_gauge”,”z”:”55fb34d9.2ebeac”,”name”:”CT Channel 2″,”group”:”c424d60e.6d7ce8″,”order”:2,”width”:0,”height”:0,”gtype”:”gage”,”title”:”CT Channel “”lbl””””f””{{l}}””””””””l”[“b””””

Download as a file – environment-dashboard-pressac-node-red.json

Occupancy Dashboard (Double-click code below to open)

[{“id”:”55fb34d9.2ebeac”,”type”:”tab”,”label”:”Energy”,”disabled”:false,”info”:””},{“id”:”94b7a433.ea45e8″,”type”:”function”,”z”:”55fb34d9.2ebeac”,”name”:”channel 2″,”func”:”msg.payload=msg.payload.current2\nreturn msg;”,”outputs”:1,”noerr”:0,”x”:440,”y”:140,”wires”:[[“c46dc8a0.0a4308”]]},{“id”:”c46dc8a0.0a4308″,”type”:”ui_gauge”,”z”:”55fb34d9.2ebeac”,”name”:”CT Channel 2″,”group”:”c424d60e.6d7ce8″,”order”:2,”width”:0,”height”:0,”gtype”:”gage”,”title”:”CT Channel “”lbl””””f””{{l}}””””””””l”[“b””””

Download as a file – occupancy-dashboard-pressac-node-red.json

Once you have pasted the code or imported the file click the import button.

pressac-visualising-data-using-node-red11

You will now see the imported Node-RED flow of your chosen dashboard.

pressac-visualising-data-using-node-red12

This flow will now require some configuration, first we need to set-up the nodes connection to the Pressac EnOcean Gateway. To do this double click a Pressac sensor node to edit it.

pressac-visualising-data-using-node-red13

Inside the edit screen click the small pencil at the side of the Gateway dropdown to begin setting up the connection to the gateway. Here you will need to provide the connection details for your gateway.

  • Name: Name of the gateway you are connecting to. E.g. Local
  • IP Address: IP address of the gateway you are connecting to, if you are connecting to the same gateway running Node-RED the default 127.0.0.1 will suffice.
  • Password: This is the same password you use to login to the gateway you are connecting to.

Once you have added your connection details click ‘Add’ in the top right corner of the edit window.

pressac-visualising-data-using-node-red14

After configuring the gateway click the search button at the side of the Sensors DropDown. This will populate the DropDown with a list of the devices currently learnt-in to your Pressac EnOcean Gateway. Select your device and click the Done button.

pressac-visualising-data-using-node-red15

You can now configure the rest of your Pressac sensor nodes by double clicking them and selecting the Gateway and sensor required.

pressac-visualising-data-using-node-red16

Once you have configured all your nodes you will need to deploy your Node-RED flow. This can be done by clicking the ‘Deploy’ button in the top right corner of the screen. After deploying all your Pressac sensor nodes will now show the status of connected below them.

pressac-visualising-data-using-node-red17

Step 5: Node-RED Dashboard

Your Node-RED dashboard will now be available on http://<your-gateway-ip>:<nodered-port>/ui e.g. http://192.168.1.188:1880/ui

pressac-visualising-data-using-node-red18