feat: cleanup interface and leverage inheritance #51
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The initial implementation tried to separate the low-level interface to the EMC2101's functionality from the high-level interface (PWM & DAC) control. This lead to a lot of code duplication between EMC2101_Core and EMC2101_PWM. This would only get worse once EMC2101_DAC will be added. The redesigned interface scraps that distinction and instead leverages inheritance to remove code duplication. This should result in a cleaner and easier to manage code base. notable changes: - remove code duplication between EMC2101_Core and EMC2101_PWM - rework the initialization logic for the low-level implementation - rename 'chip' and 'external' sensore to 'its' and 'ets' (the external temperature sensor had many different names - these have been cleaned up) - redesign lookup table into a low-level and an extended implementation (The low-level implementation exclusively supports steps and has no concept of a percentage or RPM. PWM and DAC implementation need to provide the required logic to convert Percentage and RPM into steps.) - eliminate no longer required intermediate functionality
feeph
pushed a commit
that referenced
this pull request
Aug 25, 2024
## [0.3.0](v0.2.2...v0.3.0) (2024-08-25) ### Features * cleanup interface and leverage inheritance ([#51](#51)) ([5ae941d](5ae941d)) --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please). Co-authored-by: release-please[bot] <55107282+release-please[bot]@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The initial implementation tried to separate the low-level interface to
the EMC2101's functionality from the high-level interfaces (PWM & DAC).
This lead to significant code duplication between EMC2101_Core and
EMC2101_PWM. This duplication would only get worse once EMC2101_DAC is
added.
The redesigned interface scraps that distinction and instead leverages
inheritance to remove code duplication. This is expected to result in a
cleaner and easier to manage code base.
notable changes:
(the external temperature sensor had many different names - these
have been cleaned up)
(The low-level implementation exclusively supports steps and has no
concept of a percentage or RPM. PWM and DAC implementation need to
provide the required logic to convert Percentage and RPM into steps.)