Skip to content

Commit 06bbbed

Browse files
committed
Updated README and Changelog
1 parent 542c05a commit 06bbbed

File tree

2 files changed

+67
-5
lines changed

2 files changed

+67
-5
lines changed

README.md

Lines changed: 25 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,13 +17,34 @@ It currently implements the OpenADR 2.0b specification.
1717
You can find documentation here: https://openleadr.org/docs.
1818

1919

20-
## Credits
20+
## Getting started
2121

22-
OpenLEADR would not have been possible without the support from ElaadNL Foundation and the Linux Foundation Energy. Click the logos below to learn more about them.
22+
We have cool 1-minute starting examples for both [VEN](https://openleadr.org/docs/client.html#example-ven) and [VTN](https://openleadr.org/docs/server.html#minute-vtn-example). Please check them out and take a look at the rest of the documentation.
2323

24-
[![ElaadNL Logo](https://openleadr.org/images/elaad-logo.png)](https://elaad.nl)
2524

26-
[![LF Energy Logo](https://openleadr.org/images/lf-energy-logo.png)](https://lfenergy.org)
25+
## Feature Completeness
26+
27+
At the moment, you can do basic Registration, Telemetry Reports and Events over a secured connection using signed messages. This covers many use-cases that allow for demand response to be coordinated. Below is a more extensive list of OpenADR features and their current implementation status in OpenLEADR:
28+
29+
The following is an overview of OpenADR 2.0b features that are implemented in OpenADR:
30+
31+
| Feature | Implemented | Remarks |
32+
|------------------------|-------------|--------------------------------------------------|
33+
| **Transport** |
34+
| HTTP Pull Method | ✔️ | Most-used method, allows VEN to be behind NAT |
35+
| HTTP Push Method || |
36+
| XMPP Transport || |
37+
| Message Signing | ✔️ | Official OpenADR Alliance Root Cert not included |
38+
| **Registration** |
39+
| Registration procedure | ✔️ | |
40+
| **Reporting** |
41+
| Telemetry Reports | ✔️ | |
42+
| Status Reports || Work is in progress, see #108 |
43+
| History Reports || |
44+
| **Events** |
45+
| Events | ✔️ | |
46+
| EiOpt || |
47+
2748

2849
## Contributing
2950

docs/roadmap.rst

Lines changed: 42 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,48 @@ Version Main features
2121
Changelog
2222
---------
2323

24+
openleadr 0.5.26
25+
~~~~~~~~~~~~~~~~
26+
27+
Released: 2 May 2022
28+
29+
This release fixes a problem where the VTN would not parse a
30+
single pending report correctly.
31+
32+
Bug fixes:
33+
- VTN ability to parse a single report
34+
35+
openleadr 0.5.25
36+
~~~~~~~~~~~~~~~~
37+
38+
Released: 9 April 2022
39+
40+
This version contains many fixes that were suggested by community
41+
members. Thank you so much for taking the time to find these and
42+
for reporting them.
43+
44+
Bug fixes:
45+
- Implemented Registration Cancellations
46+
- The VEN will now stop if the VTN did not accept the registration
47+
- The XML messages will now be logged more consistently if debugging is enabled
48+
- Fixed a deprecation warning from tzlocal (from apscheduler)
49+
- The VEN will now not re-send its report registrations after it was re-registered itself
50+
- VEN: Added duration to metadata reports
51+
- VEN: Removed eiReportID from metadata reports
52+
- VEN: Added dtStart to outgoing reports
53+
- VTN: Update the created_date_time anytime the Event's status changes
54+
55+
openleadr 0.5.24
56+
~~~~~~~~~~~~~~~~
57+
58+
Released: 17 June 2021
59+
60+
Bug Fixes:
61+
- Modification Numbers could be incorrect when responding to multiple Events
62+
- Correction to an example in the documentation on reporting
63+
- Fixed an error in the default on_updated_event handler
64+
- Added support for PEM certificates that don't contain a newline at the end
65+
2466
openleadr 0.5.23
2567
~~~~~~~~~~~~~~~~
2668

@@ -29,7 +71,6 @@ Released: 22 March 2021
2971
Bug fixes:
3072
- Fixed a bug in the on_created_event default handler when using the external polling method.
3173

32-
3374
openleadr 0.5.22
3475
~~~~~~~~~~~~~~~~
3576

0 commit comments

Comments
 (0)