OpenESPI-DataCustodian -- Archived July 1, 2025

^^NOTE: This repository is no longer maintained. The original OpenESPI project has been archived and is no longer being maintained. The original code is being migrated to Spring Boot 3.5 with a modernized architecture. The new code is being developed in the OpenESPI-GreenButton-Java, as a monorepo that contains the Data Custodian, Third Party, Common, and OAuth2 Authorization Server modules.**

The Open Energy Services Provider Interface (ESPI) Data Custodian Repository Providing implementations of the interface used to provide energy usage information to retail customers and third parties.

An operational sandbox with these services operating may be found at: sandbox.greenbuttonalliance.org:8443

Setup

First clone the project from github:

git clone https://github.com/greenbuttonalliance/OpenESPI-Common-java.git
cd OpenESPI-Common

Then install the OpenESPI-Common JAR in your local repository:

# The JUnit test have not been maintained since the original creation of the repository. 
# Any errors encountered here are due to not including the "-Dmaven.test.skip=true" portion of the command.
mvn -Dmaven.test.skip=true clean install

# or for a specific profile
mvn -P <profile name> -Dmaven.test.skip=true clean install

IDE Setup

Eclipse Setup

Open Eclipse and import a Maven project (File > Import... > Maven > Existing Maven Projects).

Spring Tool Suite Setup

Open Spring Tool Suite and import a Maven project (File > Import... > Maven > Existing Maven Projects).

IntelliJ Setup

Open IntelliJ and open the project (File > Open...).

Testing

All testing of OpenESPI is performed using the Test Harness project. See the README file for instructions.