Developer Benefits

• Ready-to-use taxonomy and data models, 1,000’s of defined terms for operational use cases
• Easy to adopt Apache 2.0 license
• Active work group that meets weekly
• Reference apps that show how its done
• Harmonization with international standards including IEEE, IEC, SAE, and SunSpec

Showcase

Orange Button Product Registry

The Product Registry is a web app and API, based on Orange Button, that identifies solar and storage product SKUs and provides a set of standardized data elements about these products. Published by SunSpec Alliance and available in open source. Read more

The Open Orange Button Editor is tool for developing taxonomy elements and data models and for exporting unique sets of data models for your application. Orange Button is OpenAPI-compliant and fully interoperable with Swaggerhub.

Accessing Orange Button Taxonomy and Data Models With OB Editor

To access the Orange Button taxonomy and data models for the first time:

1. Download Orange Button Taxonomy from GitHub and save it to your system.
2. Go to https://openobeditor.sunspec.org/#/ 
3. Click the “+” sign and open the Orange Button Taxonomy file (Master-OB-OpenAPI.json) from your system.
4. Explore data model and taxonomy elements by clicking on them. Doing so will open an editing window that displays the attributes and current values of the object.
5. After identifying data models that are appropriate for you application, select them and click the “Create Sample JSON” button to download.
6. If you want to create new taxonomy elements and data models, either submit a GitHub Issue or come to the Orange Button Work Group on Tuesday.

The Orange Button Work Group meets every week to ensure that the Orange Button taxonomy, data models, and API continue to address the most compelling use cases in the Distributed Energy (solar + storage) data exchange realm and that the Orange Button web service API continues to evolve to meet the needs of the software development community.

Meeting Time

Every Tuesday
11:00 am 11:50 am PST

Join Zoom Meeting
ID: 97629797015

(US) +1 301-715-8592‬

Joining instructions

Code Contribution

Orange Button is developed as open source on github. Follow the steps outlined below to submit a code contribution.

How to Commit to an Open Source Project

Highlighting some key points as described here.

1. Identify the OpenOrangeButton GitHub project of interest.
2. Create a fork of the GitHub project and clone it locally.
3. Add the forked repository as “origin” and the original repository as “upstream”.
4. Create a branch in the clone and make edits in the clone files. Make sure to follow the projects contributing guidelines.
5. Save your changes to the clone files.
6. Add your changes in git and commit them to the branch. Push the branch to your fork.
7. Create a pull request, from your fork, in the appropriate branch.

Product Registry

The Orange Button Product Registry contains registered product code strings allowing them to be standardized throughout the industry. The registry holds name and identifier information regarding entities and their products. The registry standardizes the naming schema for consistency and easy accessibility. These registered identifiers can be used to uniquely identify products in a human-readable form.

The registry is made available as a cloud-based web service that has a RESTful Application Programming Interface (API). The API can be easily integrated with existing systems to access information in the registry.

We also have a handy web portal for easy interactive use for when you want to explore the product registry manually.

Explore the Product Registry now!

About