roadmap.rst 4.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174
  1. .. _roadmap:
  2. ==========================
  3. Project Roadmap
  4. ==========================
  5. OpenLEADR is under development. The current version is |release|.
  6. Upcoming releases
  7. -----------------
  8. ======= ================================== ====================
  9. Version Main features Target timeframe
  10. ======= ================================== ====================
  11. 0.6.0 Implement XMPP transport Januari 2020
  12. 1.0.0 Certification by OpenADR Alliance T.B.A.
  13. ======= ================================== ====================
  14. Changelog
  15. ---------
  16. openleadr 0.5.11
  17. ~~~~~~~~~~~~~~~~
  18. Released: 3 december 2020
  19. New features:
  20. - This update makes the list of Targets available as a dictionary of targets grouped by their type.
  21. - You can now add Targets to events in multiple ways (``target``, ``targets``, and ``targets_by_type``).
  22. Changes:
  23. - The member names of the 'measurement' objects or dicts have been changed to be consistent everywhere:
  24. - item_name -> name
  25. - item_description -> description
  26. - item_units -> unit
  27. - si_scale_code -> scale
  28. This way, the parameters to client.add_report() are consistent with the Measurement object and the dicts that are passed around.
  29. Additionally, there is extra validation to prevent sending invalid measurements, and hints to correct any mistakes.
  30. openleadr 0.5.10
  31. ~~~~~~~~~~~~~~~~
  32. Released: 1 december 2020
  33. Bug fixes:
  34. - The on_created_event handler is now expected to receive the parameters (ven_id, event_id, opt_type). This was already in the docs, but not yet in the actual implementation. This has now been fixed.
  35. openleadr 0.5.9
  36. ~~~~~~~~~~~~~~~
  37. Released: 1 december 2020
  38. New features:
  39. - Added the ven fingerprint to the registration_info dict for the ``on_create_party_registration`` handler. This allows the VTN to verify the fingerprint upon registration, even when the VEN does not have a venID yet.
  40. Changes:
  41. - Converted the OpenADRServer.add_raw_event method to a normal (synchronous) method.
  42. Bug fixes:
  43. - The EiResponse.response_code would not always show up correctly, this is now fixed.
  44. openleadr 0.5.8
  45. ~~~~~~~~~~~~~~~
  46. Released: 30 november 2020
  47. New features:
  48. - Added the ``ven_id`` to the list of parameters for the ``on_register_report`` handler, so that this handler can know which VEN is registering reports
  49. - Updated documentation to reflect the current API of OpenLEADR
  50. openleadr 0.5.7
  51. ~~~~~~~~~~~~~~~
  52. Released: 27 november 2020
  53. Bugs fixed:
  54. - Fixed a typo in the EventService.on_created_event placeholder function
  55. openleadr 0.5.5
  56. ~~~~~~~~~~~~~~~
  57. Released: 23 november 2020
  58. New features:
  59. - Message signing now uses the correct C14n algorithm, as required by OpenADR
  60. - Preliminary VEN support for multiple events in one DistributeEvent message
  61. openleadr 0.5.4
  62. ~~~~~~~~~~~~~~~
  63. Released: 23 november 2020
  64. New features:
  65. - Preliminary support for TELEMETRY_STATUS reports
  66. - Changed the server.add_event to be a normal function (not a coroutine), which allows you to call it from a synchronous function if needed.
  67. openleadr 0.5.3
  68. ~~~~~~~~~~~~~~~
  69. Released: 20 november 2020
  70. New features:
  71. - Support for custom units in Reports is back, and is now compliant with the XML Schema.
  72. - Support for specifying the measurement (unit) in an EventSignal is added, and builds on the work of the report units.
  73. openleadr 0.5.2
  74. ~~~~~~~~~~~~~~~
  75. Released: 19 november 2020
  76. Bug fixes:
  77. - The 'full' report data collection mode now works correctly
  78. - Various codestyle improvements and cleanup
  79. Known issues:
  80. - The support for out-of-schema measurements in repors has been removed, because they would not pass XML validation. We are exploring solutions to this problem. Track the progress here: `Issue #20 <https://github.com/OpenLEADR/openleadr-python/issues/20>`_
  81. openleadr 0.5.1
  82. ~~~~~~~~~~~~~~~
  83. Released: 19 november 2020
  84. New features:
  85. - When using SSL connections, the client will provide server side SSL certificates. The VTN will verify the fingerprint of these certificates against the known fingerprint for that ven. This should complete the VEN authentication process.
  86. Bug fixes:
  87. - Report messages now validate according to the XML schema. A few corrections were made to the templates from version 0.5.0.
  88. Known issues:
  89. - The support for out-of-schema measurements in repors has been removed, because they would not pass XML validation. We are exploring solutions to this problem. Track the progress here: `Issue #20 <https://github.com/OpenLEADR/openleadr-python/issues/20>`_
  90. openleadr 0.5.0
  91. ~~~~~~~~~~~~~~~
  92. Released: 16 november 2020
  93. First release to pypi.org.
  94. New features:
  95. - This release implements reporting functionality into the client and the server. This is a major new area of functionality for OpenLEADR.
  96. openleadr 0.4.0
  97. ~~~~~~~~~~~~~~~
  98. Released: 16 november 2020
  99. Only released to git.
  100. New features:
  101. - This release implements XML Message Signing for client and servers.