Wattics api-client-java

Java library for the Wattics platform.

Quick Start

This guide gets you started with the library with a simple working example.

Download & build

You’ll need a local copy of the example code to work through this quickstart. Download the code from our Github repository:

$ git clone https://github.com/Wattics/api-client-java
$ cd api-client-java
$ gradle install

At this point you will have the library available as a maven dependency, so you can embed this snippet in your pom.xml:

    <dependency>
      <groupId>com.wattics</groupId>
      <artifactId>api-client</artifactId>
      <version>0.2.0</version>
    </dependency>

Example code

Here's some basic code to get started with the library:

import com.wattics.*;

import static com.wattics.Config.Environment.DEVELOPMENT;
import static java.time.LocalDateTime.now;

public class Main {
    public static void main(String[] args) {
        Agent agent = Agent.getInstance();
        agent.addMeasurementSentHandler((measurement, httpResponse) -> {
            System.out.println(measurement);
            System.out.println(httpResponse);
        });

        // Config config = new Config(PRODUCTION, "username", "password");
        Config config = new Config(DEVELOPMENT, "username", "password");

        SimpleMeasurement simpleMeasurement = new SimpleMeasurement();
        simpleMeasurement.setId("meter-id-01");
        simpleMeasurement.setTimestamp(now());
        simpleMeasurement.setValue(12.5);
        agent.send(simpleMeasurement, config);

        ElectricityMeasurement electricityMeasurement = new ElectricityMeasurement();
        electricityMeasurement.setId("meter-id-02");
        electricityMeasurement.setTimestamp(now());
        electricityMeasurement.setActivePowerPhaseA(5.12);
        electricityMeasurement.setActiveEnergyPhaseA(1.5);
        // ...
        agent.send(electricityMeasurement, config);
    }
}

Groups of measurements

You may also want send groups of measurements.

List<Measurement> measurements = new ArrayList<Measurement>();
measurements.add(simpleMeasurement1);
measurements.add(electricityMeasurement1);
measurements.add(simpleMeasurement2);

agent.send(measurements, config);

Handlers for callbacks

After sending the data you may want to check if it was sent correctly. For this you have access to measurement and httpResponse. You can set different handlers for the callbacks using addMeasurementSentHandler. You can set as many handlers as you like.

Priting to the console and saving to a file.

agent.addMeasurementSentHandler((measurement, httpResponse) -> {
            System.out.println(measurement);
            System.out.println(httpResponse);
        });


PrintWriter out = new PrintWriter("results.txt");
agent.addMeasurementSentHandler((measurement, httpResponse) -> {
            out.println(measurement);
            out.println(httpResponse);
        });

Parallel Sends

When running agent.getInstance, it will spin twice as many as virtual processors as system has available. Ex. If your system is a dual core, and has 4 virtual processors, the gem will spin up 8 parallel send processes for maximum performance.

In some cases you may want to limit how many processes are created. You can specify this when creating an instance of the agent. agent.getInstance(number of processors) In case you exceed the maximum limit, it will set for to the default maximum.

# Limiting send processes to two.

Agent agent = Agent.getInstance(2)