kipe / enocean

Python library for EnOcean serial protocol
MIT License
71 stars 102 forks source link

Print the profile parameters as defined in the xml #25

Closed TheMeaningfulEngineer closed 8 years ago

TheMeaningfulEngineer commented 8 years ago

When new people are exploring EnOcean and the library it would be very practical if the print of p.parsed would align to the order in the xml. And the xml to follow the order specified in the protocol documentation :)

kipe commented 8 years ago

This should be easy enough fix, by changing the Packet.parsed to use OrderedDict. As for the XML following the protocol documentation ordering, that has always been my goal and should be done that way. If you find issues regarding this, PRs are always welcome :)

kipe commented 8 years ago

Oh, another thing I thought of but couldn't remember when writing the previous comment. We could (and should) create a XML -> Markdown -generator, which would create SUPPORTED_PROFILES.md, allowing easier browsing of profiles through Github. In my opinion it should create something similar to the official documentation. Maybe leave out the bits, offsets etc, as they shouldn't be something the end-user ever touches (at least in the long run)...

kipe commented 8 years ago

Started work on this in issue_25. Come to think of it, this is actually quite a good request. It can be used enforce the order of the XML by removing sorted when checking the return values in tests. So adding label unit tests required, closing and merging the branch once all tests are updated.

kipe commented 8 years ago

Closed by 10cc345. Separated SUPPORTED_PROFILES.md to separate issue #32.