Skip to content

Green Button Client

dfcoffin edited this page Mar 4, 2013 · 5 revisions

OpenESPI-GreenButton Client DOAP

Short Description

The mission of the OpenESPI Green Button Client project is to provide an open source, public licensed implementation of a multi-screen Green Button Client. The goal is to establish client application framework that establishes simple patterns of engagement with both Third Party and Data Custodian servers and supports basic user experiences for the Retail Customer. [jat] a comment.

Long Description

The OpenESPI Green Button Client implementation consists primarily of Third Party and Data Custodian views (in the MVC sense) and a css3/html5 based implementation of client presentation and interaction. The goal is to select an existing open source framework and to extend that base to support Green Button Download My Data and Connect My Data client facing message patterns.

The primary patterns of interest are:

  1. Authentication -- patterns used implementing the OAuth2 authentication mechanism
  2. Presentation of EUI -- used for simple graphical presentation of EUI information on console, mobile, and tablet devices
  3. Context and Management -- patterns that convey Retail Customer choices for UsagePoint, MeterReading, and IntervalBlock/IntervalReading selection and management
  4. Device Experience -- Retail Customer interactions with devices (e.g. thermostats and loads)
  5. Test Orchestration -- a test interface that can direct the code to implement scripted good and bad behavior designed to test the interface.
It is the stated goal of this development to lead the ecosystem in the establishment of server.x.client interactions, at the RESTful level. The provisioning of an Open Framework for these interactions is anticipated further enage Green Button within the Open Data community and to provide common frameworks for Retail Customer experience. The selection of the suitable Open Data client framework is intended to guide this effort.

The OpenESPI Green Button Client project is anticipated to have four sub-projects:

  • Green Button Mobile – The code base that implements Retail Customer support on Mobile and Tablet devices.
  • Green Button Social – The components that focus on the integration of Green Button use-cases within popular social frameworks such as Facebook and Google+.
  • Green Button Desktop – The Testing Harness and test vectors that develop and support testing plans for Client Applications