NAV Navbar
python java
  • MQTT Smart Meter Integration API
  • Connecting and Publishing Example
  • Message Format

    • MQTT Smart Meter Integration API

    This integration is a tool for third parties to integrate their smart meter data to enable the services the Voltaware Platform provides.

    This API is a message bus that allows devices to publish electrical readings using the MQTT protocol and our specific JSON data format.

    The messages must be exactly in the described format otherwise they will be discarded.

    The messages must be published to the exact topic otherwise they will be discarded.

    You can have multiple concurrent publishers.

    Connecting and Publishing Example

    Example of how to connect

    # Dependency [paho-mqtt](https://www.eclipse.org/paho) Version: 1.5.0

import paho.mqtt.client as paho
import ssl

broker = "test-partner-broker.voltaware.com"
port = 8883
client_id = "python-example-client"
username = "<your username>"
passwd = "<your password>"
message_topic = "<your topic>"
message_json = "<json event format>"

def on_publish(client,userdata,result):
    if result == 1:
        print("Data published!")
    else:
        print("Message not acknowledged!")

def on_connect(client, userdata, flags, rc):
    if rc == 0:
        print("Connected!")
        client1.publish(message_topic, message_json, 2)
    else:
        print("Connection failed!")

client1= paho.Client(client_id)
client1.on_publish = on_publish
client1.on_connect = on_connect
client1.tls_set_context(ssl.create_default_context())
client1.username_pw_set(username, passwd)
client1.connect(broker, port)

try:
    rc = 0
    while rc == 0:
        rc = client1.loop()
    print("rc: " + str(rc))
except KeyboardInterrupt:
    print("Exit")

    // Dependency [mqtt-client](https://mvnrepository.com/artifact/org.eclipse.paho/org.eclipse.paho.client.mqttv3/1.2.2)

import java.security.KeyManagementException;
import java.security.NoSuchAlgorithmException;

import javax.net.ssl.SSLContext;

import org.eclipse.paho.client.mqttv3.MqttClient;
import org.eclipse.paho.client.mqttv3.MqttConnectOptions;
import org.eclipse.paho.client.mqttv3.MqttException;
import org.eclipse.paho.client.mqttv3.MqttMessage;
import org.eclipse.paho.client.mqttv3.persist.MemoryPersistence;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

public class PublisherExample {

    private static final Logger LOGGER = LoggerFactory.getLogger(PublisherExample.class);

    public static void main(String[] args) throws NoSuchAlgorithmException, KeyManagementException, MqttException {

        final String broker = "ssl://test-partner-broker.voltaware.com:8883";
        final String clientId = "java-example-client";
        final String userName = "<your username>";
        final String passwd = "<your password>";
        final String topic = "<your topic>";
        final String messageJson = "<json event format>";

        final MqttClient mqttClient = new MqttClient(broker, clientId, new MemoryPersistence());

        try {

            final MqttConnectOptions mqttConnectionOptions = new MqttConnectOptions();
            mqttConnectionOptions.setKeepAliveInterval(30);
            mqttConnectionOptions.setCleanSession(true);
            mqttConnectionOptions.setUserName(userName);
            mqttConnectionOptions.setPassword(passwd.toCharArray());
            mqttConnectionOptions.setConnectionTimeout(5);
            final SSLContext sslContext = SSLContext.getInstance("TLSv1.2");
            sslContext.init(null, null, null);
            mqttConnectionOptions.setSocketFactory(sslContext.getSocketFactory());
            mqttClient.connect(mqttConnectionOptions);

            final MqttMessage mqttMessage = new MqttMessage(messageJson.getBytes());
            mqttMessage.setQos(2);
            mqttClient.publish(topic, mqttMessage);
            LOGGER.info("Message sent");

        } catch (final MqttException e) {
            LOGGER.error("Error to send to the topic!", e);
        } finally {
            mqttClient.disconnect();
            mqttClient.close();
        }

    }

}

    You need these parameters to connect to the RabbitMQ Voltaware broker.

    See code samples.

    Message Format

    {
  "deviceId": "6ede44a4-ea21-4c17-b5c4-37eb3875e554",
  "dataFrequencyMins": 15,
  "date": "2022-03-01",
  "electricReadings": [
    {
      "timestampUtcEpochSecs": 1646092800,
      "consumptionKwh": 0.111
    },
    { ... }
  ]
}

    Ingestion expects that all readings for a day are sent in a single message, and there needs to be a separate message for each day.

    The ideal frequency for data ingestion is daily; however, weekly and monthly submissions are also acceptable. It largely depends on when the data is available on your side, but we strongly recommend sending data daily if possible.

    Historical data spanning several months is accepted as well, but if the period exceeds three months, disaggregation will not be triggered automatically. In such cases, please contact us to initiate the process.

    All message fields are required.

    Field name Description
    deviceId string Unique identifier for your device. This will be the same identifier that must be used in the HTTP API to retrieve the disaggregation results.
    dataFrequencyMins int Frequency of consumption read, it must be one of these values: 15, 30 or 60.
    date ISO date Date from where all electrical readings belong, such as 2023-11-21.
    electricReadings[] array Array with all electrical readings for the given date. For example, if the reading interval is 30 minutes it must contain 48 records.
    electricReadings[].timestampUtcEpochSecs long UTC reading timestamp in seconds from Epoch.
    electricReadings[].consumptionKwh float Consumption in kilowatthours.
    python java