An application that communicates with external APIs to retrieve their data automatically at certain intervals (NOTE: as of now it is not automatic and will happen via a Console interface)
The idea is to get the data and make the accumulated data available in different formats (such as a .csv, .json or .xml file). This can then be used in e.g. an Excel sheet.
This project is still in its infancy and thus only has very limited functionality exposed via a console UI. At the time of writing it can:
- Automatically fetch new data access tokens (provided an eloverblik api key)
- Fetch MeterData (electricity usage and generation) from the El Overblik API as .csv file from yesterday
- Fetch MeterData from the El Overblik API as .csv file in custom period.
This section is split in two:
- How to install the application from a distribution .zip file (
electricity-data-consolidator-x-distribution.zip
) - Making a distribution file from source code
- Download the .zip file (
electricity-data-consolidator-x-distribution.zip
) with x being version of the app. - Get API key for ElOverblikAPI for your user account
- Open /config folder
- Make a file called
api-key.conf
with content similar to:api-key=your.api.key.all.in.one-line
- Alternatively copy the
example-api-key.conf
and rename it toapi-key.conf
with your api-key in it.
- Alternatively copy the
- Now you can go to Usage to find out how to use the app.
Prerequisite: Maven v3.9.2 or later and a Java 17 JDK
The distribution file is made via the maven-assembly-plugin and a custom assembly descriptor located at /src/assembly/custom-maven-assembly-descriptor.xml.
It should be every simple, assuming Maven can fetch dependencies from its default location.
Simply run the below maven command to make the distribution.zip file:
- Run
mvn clean install -DisMavenSurefireTesting=true
This should make a /target directory, containing the compiled code along with some .jar file and a .zip file.
The one we're interested in is called electricity-data-consolidator-{version}-distribution.zip
(version comes from pom.xml).
- Use the
electricity-data-consolidator-{version}-distribution.zip
as you want.
Prerequisites: Java 17 or later.
Simply open the application via start.cmd
(if using Windows) or start.sh
(on Linux/Mac) and you should
see a screen similar to below:
Then you simply select an option from the list by writing the associate number in the brackets, e.g. [1] for option 1. and press ENTER to confirm your choice.