The Orange Button Solar Taxonomy is defined within Master-OB-OpenAPI.json. The taxonomy is compliant with OpenAPI 3.0.
Contributing
To report a bug, error or to describe a new feature, please open an Issue. To contribute comments or propose changes to the taxonomy, for those with git skills, please feel free to fork this repository and then submit a pull request with your suggested changes. For those without git skills but wanting contribute, the Orange Button Technical Workgroup meets regularly and welcomes new participants. Contact the workgroup at membership@sunspec.org
Using the taxonomy
The Orange Button Solar Taxonomy is free to use consistent with the terms of its license. A webapp is available to explore and edit a copy of Master-OB-OpenAPI.json. You can find an instance of this editor that is free for you to use at https://obeditor.sunspec.org.
Code for the editor is open source and available on GitHub here. Issues, feature requests and contributions are welcome.
Versioning
The Orange Button Solar Taxonomy uses calendar versioning, following the pattern YYMM.mm.pp, where YY is a two-digit year, MM is a zero-padded month, mm is a minor release integer, and pp is a patch integer. New major versions are anticipated to be released at 6 month intervals.
Major releases are not intended to be backward compatible, where minor releases are backward compatible. Patches are intended to replace their parent major/minor release.
Changes to the taxonomy are organized according to table below.
| Type of Change | Type of Release |
|---|---|
| Change a term name | Major |
| Remove a term from an object | Major |
| Change or delete a unit | Major |
| Delete a term or object | Major |
| Change a term's unit | Major |
| Add a new term | Minor |
| Add a term to an object | Minor |
| Add a new object | Minor |
| Add a new unit or enumerated value | Minor |
| Change a term description or sample value | Minor |
| Correct an error that causes problems for users | Patch |
If anything is unclear or you have any questions, please feel free to email us at: support@sunspec.org