Index: README.md =================================================================== diff -u -rc6596d42d995bed3789849bd85c83da5a3837fac -r3e3666a02c3b5a57feb1debcf852670e82ba33e5 --- README.md (.../README.md) (revision c6596d42d995bed3789849bd85c83da5a3837fac) +++ README.md (.../README.md) (revision 3e3666a02c3b5a57feb1debcf852670e82ba33e5) @@ -15,6 +15,7 @@ Please understand that the structure of this repository is still under review and the architecture is likely to change as improvements are made. +This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). ## Using the API @@ -146,3 +147,9 @@ ``` $ ./build.sh ``` + +[Changelog](./changelog.md) + +[LICENSE](./LICENSE) + + Index: changelog.md =================================================================== diff -u --- changelog.md (revision 0) +++ changelog.md (revision 3e3666a02c3b5a57feb1debcf852670e82ba33e5) @@ -0,0 +1,63 @@ +# Dialin Changelog + +All notable changes to this project will be documented in this file. + + +### [0.2.0] - 2020-06-30 +#### Added +- Ability to attach / detach multiple observers +- `dialin.base.AbstractObserver` class +- `dialin.base._AbstractSubSystem` class +- `dialin.base._publish` decorator +- Getter functions for all publicly accessible variables +- Branch and commit hash to docs +- Data publishing from all subsystem classes (using the `@_publish` decorator) +- Demo tests +- Alarm simulation +- `CAN-ONLY` logging with candump styled output + +#### Changed +- Parent class for all submodules +- Dialin version configuration and integration with sphinx, pip +- Documentation now generated by sphinx instead of Doxygen +- Handler functions are private +- README + +#### Removed +- Doxygen configuration + +#### Fixed +- DG valves rate test +- Alarms initialization +- Valves bit masking +- Documentation cleanup +- Logging isolation +- Ultrafiltration test script +- Copyrights + +### [0.1.0] - 2020-05-28 +#### Added +- Submodules: hd, dg, utils, and protocols +- Setup dialin as a python package +- Internal API Logging +- Copyright headers +- Unit test to import classes +- HD demo test script +- HD / DG integration tests + +#### Changed +- Ensure PEP8 Compliance +- Ensure snake case is used for all variables and functions +- README +- HD / UI messaging +- Split up HD / DG subclasses into separate files + +#### Removed +- Softlinks +- Deprecated code + +#### Fixed +- Doxygen output + + +