Overview

This guide will show you how to setup a development environment for OpenEMS by getting a local copy of the source code and setting up your preferred IDE. You can then compile and run the project.

1. Prerequisites

OpenEMS uses git as a version control system and GitHub for hosting the source code. You can use git either from the command line, from a dedicated GUI, or from inside your IDE. This guide assumes that you have git installed on your system and have some basic familiarity with it. If you are new to git, there are a number of great tutorials out there to get you started.

OpenEMS is written in Java. This guide also assumes that you are familiar with Java and its related tools. You need to have the correct version of the Java Development Kit (JDK) installed on your system. As of writing, the current version used by OpenEMS is 21. We recommend using Eclipse Temurin by Adoptium

2. Clone the OpenEMS git repository

Use git to obtain a local copy of the OpenEMS source code.

  1. open a console

  2. change to the target directory

  3. execute git clone https://github.com/OpenEMS/openems.git

3. Setup your preferred IDE

You can use any IDE suitable for Java development to work on OpenEMS. Currently, we provide instructions on how to use Eclipse and IntelliJ IDEA.

Eclipse IDE is the recommended development environment for newcomers to OpenEMS.

4. Next steps

Now that you setup a complete development environment and have a working instance of OpenEMS Edge, OpenEMS Backend an OpenEMS UI, you can continue implementing your first device driver in OpenEMS. We provide a tutorial that explains the steps to implement an electric meter in OpenEMS Edge that is connected via Modbus/TCP.

The meter itself is simulated using a small Modbus slave application, so no external hardware is required for this guide. → Implementing a Device