Welcome to Forwarder documentation!

Forwarder is a service designated for sending measured data from customer’s Homebases to defined URL via HTTPS. It is part of Energomonitor’s backend infrastructure and can be configured by customer.

Table of Contents

• Forwarder’s HTTP API
  • Authorization
  • Resources
• Data Format
• Device Support

Overview

All Homebases use MQTT network protocol to send data to Energomonitor’s backend servers. Forwarder service can be used to collect those data and send all data points to customer’s server. According to settings in Forwarder, data are collected as is or processed and send in bulk to HTTP server after defined time interval.

HTTP POST request sent to customer’s server contains all received data in JSON format. The request is secured by TLS – HTTPS is used. Customer’s server has to have valid HTTPS certificate.

More information on how to configure URL and time interval can be found in section Forwarder’s HTTP API. Output format is described in section Data Format.

Terminology

There are several specific words used in this document.

• Homebase – physical device directly connected to the internet, gateway between sensors and server.

• Sensor – measures electricity, water, gas or any other medium. Sends data to Homebase via radio protocol.

• Cluster – any server with compatible input API where Homebase sends measured data.

• Serial number – unique 16 characters long serial number identifying Homebase.

• UNIQ – unique 8 characters long serial number identifying a sensor.