Homebase API¶
Provisioning has several API endpoint for Homebases. Each manufactured Homebase has provisioning address stored in non-volatile memory and after each power up or reset it requests for firmware update and/or configuration.
There are several generations of Homebases, each with different capabilities.
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.
Note
Homebase does not send any measured customer’s data to provisioning. This server is for firmware upgrades and configuration only.
Resources¶
This is only brief description of HTTP API used in Homebases.
All API endpoints described below has address provisioning.energomonitor.com/api/...,
both HTTP and HTTPS is allowed. This is only one exception where plaintext
HTTP is used.
GET /device/{SN}/upgrade/¶
Get firmware binary if upgrade is prepared for Homebase with serial number
{SN}. If no upgrade is ready, the response has HTTP status code404.
GET /device/{SN}/boot/¶
If Homebase with serial number
{SN}}is paired to some cluster, the response contains IP address and port of that cluster. Otherwise the status code is409. If upgrade is prepared for Homebase, the status code is202.This endpoint is used as heartbeat. All Homebases sends this request in two hours interval.