Welcome to Homebase documentation!

Homebase is a physical device which forwards on-site measured data into cloud server infrastructure. The data are measured by sensors and send via radio protocol called Chirp. Homebase receives Chirp packets and resends them via standard MQTT protocol to server.

More informations about MQTT:

• MQTT specification.

• Wikipedia page.

Table of Contents

• Provisioning Configuration
  • Resources
• MQTT Configuration
  • Authentication
  • Configuration
• Payload Format
  • Overview
  • Basic structure
  • Examples for real sensors
• Sensors supported by application
• Payload Encryption
  • Principles
  • MQTT clock
• Security Considerations
  • Remote updates
  • Sending measured data

Overview

After power-up or reset the Homebase runs DHCP to get all network settings (IP address, etc…). Then firmware update (if needed) and configuration is downloaded from Energomonitor’s provisioning server. Different Homebase generations use different protocols for downloading firmware updates and configuration:

• The older generation EWG0 and EWG3 downloads firmware via TFTP on port 6969 and configuration via HTTP on port 80.

• New generation EWG6 uses HTTP on port 80 for both firmware and configuration.

Configuration contains IP address and port of server where Homebase will send measured data. This server can be Energomonitor’s cluster or any server with compatible input API.

Terminology

There are several specific words used in this document.

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

• Provisioning – server coordinating manufacturing, firmware updates and configuration of all Homebases.

• 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.

• Pairing – assigning Homebase to cluster. When Homebase is paired, it starts to send data.

• Trap – packet type send from paired sensors via Chirp radio protocol. These packets contains measured data.

Changelog

• 9. October 2017 – defined format version 3.

• 7. September 2017 – collector version 3.0 supports broadcast packets.

• 5. April 2017 – details about MQTT credentials in configuration section.

• 5. April 2017 – payload encryption marked as obsolete and is not supported anymore.

• 5. April 2017 – removed support for MessagePack, only JSON can be used for configuration.

• 23. February 2017 – nec configuration parameter stop in collector app.

• 27. January 2017 – new payload format version 2.

• 4. August 2016 – initial release.