Connecting the Pressac Gateway to an MQTT Server
Step 1: Prerequisites
You should have the following items/actions ready before beginning the process:
- MQTT Broker / Server set-up and configured
- 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 AWS IoT Core and the Pressac EnOcean Gateway configuration pages.
Step 2: Prepare your Device
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:
- 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.
- 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”. Then 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.
Step 3: 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”.
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 – Signal strength of the device to the gateway
Action – The action column contains a menu containing options to EDIT AND ADD and DELETE the device.
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.
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 4: Configure the Pressac EnOcean Gateways MQTT Settings
Navigate to the MQTT connection page by clicking “- MQTT” in the Connections sub-menu on the Pressac EnOcean Gateway web-interface.
Now you will need to input your Default Client ID, Root Topic, Device Identifier and select the data you would like to be included in the payload.
Default Client ID – This is the default MQTT client identifier the gateway will use when publishing to an MQTT server. This value will be used to identify the gateway to the MQTT server it should be unique to each MQTT server the gateway is connecting to.
Root Topic – The root topic will be used at the start of all device MQTT topics followed by the device identifier. Each level of topic should be separated by a /.
Device Identifier – What the device will appear as at the end of an MQTT topic. When set to ‘Device Name’ the device name will be used and when set to ‘Device ID’ the unique device ID will be used. e.g. ‘roottopic/co2sensor’ or ‘roottopic/050C0745’.
Now we need to configure the Pressac EnOcean Gateways connection to your MQTT Server. Start by ticking ‘Enable’ in the top left corner of the MQTT connection and giving this connection a name, this name will only be used to identify the connection.
Next, we need to give the connection a client ID, this is the unique name used to identify the gateway to this MQTT server. It can be any string value and should be unique to the MQTT server you are connecting to. Ticking the ‘Use Default’ option will force the connection to use the ‘Default Client ID’ you provided previously in MQTT Settings.
You can now fill in the hostname of the MQTT server you are connecting too. You can use the TLS radio buttons to turn ON or OFF secure communication between the gateway and MQTT server.